Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1476
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1476 ! raeburn 4: # $Id: lonnet.pm,v 1.1475 2021/12/19 02:45:48 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 '')) {
988: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
989: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
990: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
991: $remotesessions = $udomdefaults{'remotesessions'};
992: }
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.1451 raeburn 1026: my $alias = &Apache::lonnet::use_proxy_alias($r,$spare_server);
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 =
1214: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1215: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1216: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1217: $cachetime);
1218: }
1219: }
1220: }
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);
1326: if (!$uhome) {
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");
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.1073 raeburn 1381: sub can_host_session {
1.1074 raeburn 1382: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1383: my $canhost = 1;
1.1074 raeburn 1384: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1385: if (ref($remotesessions) eq 'HASH') {
1386: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1387: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1388: $canhost = 0;
1389: } else {
1390: $canhost = 1;
1391: }
1392: }
1393: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1394: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1395: $canhost = 1;
1396: } else {
1397: $canhost = 0;
1398: }
1399: }
1400: if ($canhost) {
1401: if ($remotesessions->{'version'} ne '') {
1402: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1403: if ($reqmajor ne '' && $reqminor ne '') {
1404: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1405: my $major = $1;
1406: my $minor = $2;
1407: if (($major < $reqmajor ) ||
1408: (($major == $reqmajor) && ($minor < $reqminor))) {
1409: $canhost = 0;
1410: }
1411: } else {
1412: $canhost = 0;
1413: }
1414: }
1415: }
1416: }
1417: }
1418: if ($canhost) {
1419: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1420: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1421: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1422: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1423: if (($uint_dom ne '') &&
1424: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1425: $canhost = 0;
1426: } else {
1427: $canhost = 1;
1428: }
1429: }
1430: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1431: if (($uint_dom ne '') &&
1432: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1433: $canhost = 1;
1434: } else {
1435: $canhost = 0;
1436: }
1437: }
1438: }
1439: }
1440: return $canhost;
1441: }
1442:
1.1083 raeburn 1443: sub spare_can_host {
1444: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1445: my $canhost=1;
1.1279 raeburn 1446: my $try_server_hostname = &hostname($try_server);
1447: my $serverhomeID = &get_server_homeID($try_server_hostname);
1448: my $serverhomedom = &host_domain($serverhomeID);
1449: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1450: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1451: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1452: $canhost = 0;
1453: }
1454: }
1.1439 raeburn 1455: if ($canhost) {
1456: if (ref($defdomdefaults{'offloadoth'}) eq 'HASH') {
1457: if ($defdomdefaults{'offloadoth'}{$try_server}) {
1458: unless (&shared_institution($udom,$try_server)) {
1459: $canhost = 0;
1460: }
1461: }
1462: }
1463: }
1.1279 raeburn 1464: if (($canhost) && ($uint_dom)) {
1465: my @intdoms;
1466: my $internet_names = &get_internet_names($try_server);
1467: if (ref($internet_names) eq 'ARRAY') {
1468: @intdoms = @{$internet_names};
1469: }
1470: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1471: my $remoterev = &get_server_loncaparev(undef,$try_server);
1472: $canhost = &can_host_session($udom,$try_server,$remoterev,
1473: $remotesessions,
1474: $defdomdefaults{'hostedsessions'});
1475: }
1.1083 raeburn 1476: }
1477: return $canhost;
1478: }
1479:
1.1123 raeburn 1480: sub this_host_spares {
1481: my ($dom) = @_;
1.1126 raeburn 1482: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1483: my @hosts = ¤t_machine_ids();
1484: foreach my $lonhost (@hosts) {
1485: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1486: $dom_in_use = $dom;
1487: $lonhost_in_use = $lonhost;
1.1123 raeburn 1488: last;
1489: }
1490: }
1.1126 raeburn 1491: if ($dom_in_use ne '') {
1492: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1493: }
1494: if (ref($result) ne 'HASH') {
1495: $lonhost_in_use = $perlvar{'lonHostID'};
1496: $dom_in_use = &host_domain($lonhost_in_use);
1497: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1498: if (ref($result) ne 'HASH') {
1499: $result = \%spareid;
1500: }
1501: }
1502: return $result;
1503: }
1504:
1505: sub spares_for_offload {
1506: my ($dom_in_use,$lonhost_in_use) = @_;
1507: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1508: if (defined($cached)) {
1509: return $result;
1510: } else {
1.1126 raeburn 1511: my $cachetime = 60*60*24;
1512: my %domconfig =
1513: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1514: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1515: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1516: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1517: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1518: }
1519: }
1520: }
1521: }
1.1126 raeburn 1522: return;
1.1123 raeburn 1523: }
1524:
1.1129 raeburn 1525: sub get_lonbalancer_config {
1526: my ($servers) = @_;
1527: my ($currbalancer,$currtargets);
1528: if (ref($servers) eq 'HASH') {
1529: foreach my $server (keys(%{$servers})) {
1530: my %what = (
1531: spareid => 1,
1532: perlvar => 1,
1533: );
1534: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1535: if ($result eq 'ok') {
1536: if (ref($returnhash) eq 'HASH') {
1537: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1538: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1539: $currbalancer = $server;
1540: $currtargets = {};
1541: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1542: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1543: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1544: }
1545: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1546: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1547: }
1548: }
1549: last;
1550: }
1551: }
1552: }
1553: }
1554: }
1555: }
1556: return ($currbalancer,$currtargets);
1557: }
1558:
1559: sub check_loadbalancing {
1.1331 raeburn 1560: my ($uname,$udom,$caller) = @_;
1.1191 raeburn 1561: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1.1391 raeburn 1562: $rule_in_effect,$offloadto,$otherserver,$setcookie,$dom_balancers);
1.1129 raeburn 1563: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1564: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1565: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1566: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1567: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1568: my $serverhomedom = &host_domain($lonhost);
1.1307 raeburn 1569: my $domneedscache;
1.1129 raeburn 1570: my $cachetime = 60*60*24;
1571:
1572: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1573: $dom_in_use = $udom;
1574: $homeintdom = 1;
1575: } else {
1576: $dom_in_use = $serverhomedom;
1577: }
1578: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1579: unless (defined($cached)) {
1580: my %domconfig =
1581: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1582: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1583: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1307 raeburn 1584: } else {
1585: $domneedscache = $dom_in_use;
1.1129 raeburn 1586: }
1587: }
1588: if (ref($result) eq 'HASH') {
1.1391 raeburn 1589: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1590: &check_balancer_result($result,@hosts);
1.1129 raeburn 1591: if ($is_balancer) {
1592: if (ref($currrules) eq 'HASH') {
1593: if ($homeintdom) {
1594: if ($uname ne '') {
1595: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1596: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1597: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1598: $rule_in_effect = $currrules->{'_LC_author'};
1599: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1600: $rule_in_effect = $currrules->{'_LC_adv'}
1601: }
1602: }
1603: if ($rule_in_effect eq '') {
1604: my %userenv = &userenvironment($udom,$uname,'inststatus');
1605: if ($userenv{'inststatus'} ne '') {
1606: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1607: my ($othertitle,$usertypes,$types) =
1608: &Apache::loncommon::sorted_inst_types($udom);
1609: if (ref($types) eq 'ARRAY') {
1610: foreach my $type (@{$types}) {
1611: if (grep(/^\Q$type\E$/,@statuses)) {
1612: if (exists($currrules->{$type})) {
1613: $rule_in_effect = $currrules->{$type};
1614: }
1615: }
1616: }
1617: }
1618: } else {
1619: if (exists($currrules->{'default'})) {
1620: $rule_in_effect = $currrules->{'default'};
1621: }
1622: }
1623: }
1624: } else {
1625: if (exists($currrules->{'default'})) {
1626: $rule_in_effect = $currrules->{'default'};
1627: }
1628: }
1629: } else {
1630: if ($currrules->{'_LC_external'} ne '') {
1631: $rule_in_effect = $currrules->{'_LC_external'};
1632: }
1633: }
1634: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1635: $uname,$udom);
1636: }
1637: }
1638: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1239 raeburn 1639: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1640: unless (defined($cached)) {
1641: my %domconfig =
1642: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1643: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1307 raeburn 1644: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1645: } else {
1646: $domneedscache = $serverhomedom;
1.1129 raeburn 1647: }
1648: }
1649: if (ref($result) eq 'HASH') {
1.1391 raeburn 1650: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1651: &check_balancer_result($result,@hosts);
1652: if ($is_balancer) {
1.1129 raeburn 1653: if (ref($currrules) eq 'HASH') {
1654: if ($currrules->{'_LC_internetdom'} ne '') {
1655: $rule_in_effect = $currrules->{'_LC_internetdom'};
1656: }
1657: }
1658: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1659: $uname,$udom);
1660: }
1661: } else {
1662: if ($perlvar{'lonBalancer'} eq 'yes') {
1663: $is_balancer = 1;
1664: $offloadto = &this_host_spares($dom_in_use);
1665: }
1.1307 raeburn 1666: unless (defined($cached)) {
1667: $domneedscache = $serverhomedom;
1668: }
1.1129 raeburn 1669: }
1670: } else {
1671: if ($perlvar{'lonBalancer'} eq 'yes') {
1672: $is_balancer = 1;
1673: $offloadto = &this_host_spares($dom_in_use);
1674: }
1.1307 raeburn 1675: unless (defined($cached)) {
1676: $domneedscache = $serverhomedom;
1677: }
1678: }
1679: if ($domneedscache) {
1680: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129 raeburn 1681: }
1.1430 raeburn 1682: if (($is_balancer) && ($caller ne 'switchserver')) {
1.1176 raeburn 1683: my $lowest_load = 30000;
1684: if (ref($offloadto) eq 'HASH') {
1685: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1686: foreach my $try_server (@{$offloadto->{'primary'}}) {
1687: ($otherserver,$lowest_load) =
1688: &compare_server_load($try_server,$otherserver,$lowest_load);
1689: }
1.1129 raeburn 1690: }
1.1176 raeburn 1691: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1692:
1.1176 raeburn 1693: if (!$found_server) {
1694: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1695: foreach my $try_server (@{$offloadto->{'default'}}) {
1696: ($otherserver,$lowest_load) =
1697: &compare_server_load($try_server,$otherserver,$lowest_load);
1698: }
1699: }
1700: }
1701: } elsif (ref($offloadto) eq 'ARRAY') {
1702: if (@{$offloadto} == 1) {
1703: $otherserver = $offloadto->[0];
1704: } elsif (@{$offloadto} > 1) {
1705: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1706: ($otherserver,$lowest_load) =
1707: &compare_server_load($try_server,$otherserver,$lowest_load);
1708: }
1709: }
1710: }
1.1331 raeburn 1711: unless ($caller eq 'login') {
1712: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1713: $is_balancer = 0;
1714: if ($uname ne '' && $udom ne '') {
1715: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1.1389 raeburn 1716: &appenv({'user.loadbalexempt' => $lonhost,
1.1331 raeburn 1717: 'user.loadbalcheck.time' => time});
1718: }
1.1176 raeburn 1719: }
1.1129 raeburn 1720: }
1721: }
1.1430 raeburn 1722: }
1723: if (($is_balancer) && (!$homeintdom)) {
1724: undef($setcookie);
1.1129 raeburn 1725: }
1.1391 raeburn 1726: return ($is_balancer,$otherserver,$setcookie,$offloadto,$dom_balancers);
1.1129 raeburn 1727: }
1728:
1.1191 raeburn 1729: sub check_balancer_result {
1730: my ($result,@hosts) = @_;
1.1391 raeburn 1731: my ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 1732: if (ref($result) eq 'HASH') {
1733: if ($result->{'lonhost'} ne '') {
1734: my $currbalancer = $result->{'lonhost'};
1735: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1736: $is_balancer = 1;
1737: $currtargets = $result->{'targets'};
1738: $currrules = $result->{'rules'};
1739: }
1.1391 raeburn 1740: $dom_balancers = $currbalancer;
1.1191 raeburn 1741: } else {
1.1391 raeburn 1742: if (keys(%{$result})) {
1743: foreach my $key (keys(%{$result})) {
1744: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1745: (ref($result->{$key}) eq 'HASH')) {
1746: $is_balancer = 1;
1747: $currrules = $result->{$key}{'rules'};
1748: $currtargets = $result->{$key}{'targets'};
1749: $setcookie = $result->{$key}{'cookie'};
1750: last;
1751: }
1.1191 raeburn 1752: }
1.1391 raeburn 1753: $dom_balancers = join(',',sort(keys(%{$result})));
1.1191 raeburn 1754: }
1755: }
1756: }
1.1391 raeburn 1757: return ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 1758: }
1759:
1.1129 raeburn 1760: sub get_loadbalancer_targets {
1761: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1762: my $offloadto;
1.1175 raeburn 1763: if ($rule_in_effect eq 'none') {
1764: return [$perlvar{'lonHostID'}];
1765: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1766: $offloadto = $currtargets;
1767: } else {
1768: if ($rule_in_effect eq 'homeserver') {
1769: my $homeserver = &homeserver($uname,$udom);
1770: if ($homeserver ne 'no_host') {
1771: $offloadto = [$homeserver];
1772: }
1773: } elsif ($rule_in_effect eq 'externalbalancer') {
1774: my %domconfig =
1775: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1776: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1777: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1778: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1779: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1780: }
1781: }
1782: } else {
1.1178 raeburn 1783: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1784: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1785: if (&hostname($remotebalancer) ne '') {
1786: $offloadto = [$remotebalancer];
1787: }
1788: }
1789: } elsif (&hostname($rule_in_effect) ne '') {
1790: $offloadto = [$rule_in_effect];
1791: }
1792: }
1793: return $offloadto;
1794: }
1795:
1.1127 raeburn 1796: sub internet_dom_servers {
1797: my ($dom) = @_;
1798: my (%uniqservers,%servers);
1799: my $primaryserver = &hostname(&domain($dom,'primary'));
1800: my @machinedoms = &machine_domains($primaryserver);
1801: foreach my $mdom (@machinedoms) {
1802: my %currservers = %servers;
1803: my %server = &get_servers($mdom);
1804: %servers = (%currservers,%server);
1805: }
1806: my %by_hostname;
1807: foreach my $id (keys(%servers)) {
1808: push(@{$by_hostname{$servers{$id}}},$id);
1809: }
1810: foreach my $hostname (sort(keys(%by_hostname))) {
1811: if (@{$by_hostname{$hostname}} > 1) {
1812: my $match = 0;
1813: foreach my $id (@{$by_hostname{$hostname}}) {
1814: if (&host_domain($id) eq $dom) {
1815: $uniqservers{$id} = $hostname;
1816: $match = 1;
1817: }
1818: }
1819: unless ($match) {
1820: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1821: }
1822: } else {
1823: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1824: }
1825: }
1826: return %uniqservers;
1827: }
1828:
1.1347 raeburn 1829: sub trusted_domains {
1830: my ($cmdtype,$calldom) = @_;
1.1349 raeburn 1831: my ($trusted,$untrusted);
1.1347 raeburn 1832: if (&domain($calldom) eq '') {
1.1349 raeburn 1833: return ($trusted,$untrusted);
1.1347 raeburn 1834: }
1.1395 raeburn 1835: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|othcoau|domroles|catalog|reqcrs|msg)$/) {
1.1349 raeburn 1836: return ($trusted,$untrusted);
1.1347 raeburn 1837: }
1838: my $callprimary = &domain($calldom,'primary');
1839: my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
1840: if ($intcalldom eq '') {
1.1349 raeburn 1841: return ($trusted,$untrusted);
1.1347 raeburn 1842: }
1843:
1844: my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
1845: unless (defined($cached)) {
1846: my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
1847: &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1848: $trustconfig = $domconfig{'trust'};
1849: }
1850: if (ref($trustconfig)) {
1851: my (%possexc,%possinc,@allexc,@allinc);
1852: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1853: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1854: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1855: }
1856: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1.1395 raeburn 1857: $possinc{$intcalldom} = 1;
1.1347 raeburn 1858: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1859: }
1860: }
1861: if (keys(%possexc)) {
1862: if (keys(%possinc)) {
1863: foreach my $key (sort(keys(%possexc))) {
1864: next if ($key eq $intcalldom);
1865: unless ($possinc{$key}) {
1866: push(@allexc,$key);
1867: }
1868: }
1869: } else {
1870: @allexc = sort(keys(%possexc));
1871: }
1872: }
1873: if (keys(%possinc)) {
1874: $possinc{$intcalldom} = 1;
1875: @allinc = sort(keys(%possinc));
1876: }
1877: if ((@allexc > 0) || (@allinc > 0)) {
1878: my %doms_by_intdom;
1879: my %allintdoms = &all_host_intdom();
1880: my %alldoms = &all_host_domain();
1881: foreach my $key (%allintdoms) {
1882: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1883: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1884: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1885: }
1886: } else {
1887: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1888: }
1889: }
1890: foreach my $exc (@allexc) {
1891: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1.1395 raeburn 1892: push(@{$untrusted},@{$doms_by_intdom{$exc}});
1.1347 raeburn 1893: }
1894: }
1895: foreach my $inc (@allinc) {
1896: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1.1395 raeburn 1897: push(@{$trusted},@{$doms_by_intdom{$inc}});
1.1347 raeburn 1898: }
1899: }
1900: }
1901: }
1.1349 raeburn 1902: return ($trusted,$untrusted);
1.1347 raeburn 1903: }
1904:
1905: sub will_trust {
1906: my ($cmdtype,$domain,$possdom) = @_;
1907: return 1 if ($domain eq $possdom);
1908: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1909: my $willtrust;
1910: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1911: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1912: $willtrust = 1;
1913: }
1914: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1915: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1916: $willtrust = 1;
1917: }
1918: } else {
1919: $willtrust = 1;
1920: }
1921: return $willtrust;
1922: }
1923:
1.1 albertel 1924: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1925:
1.599 albertel 1926: my %homecache;
1.1 albertel 1927: sub homeserver {
1.230 stredwic 1928: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1929: my $index="$uname:$udom";
1.426 albertel 1930:
1.599 albertel 1931: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1932:
1933: my %servers = &get_servers($udom,'library');
1934: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1935: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1936: exists($badServerCache{$tryserver}));
1.841 albertel 1937:
1938: my $answer=reply("home:$udom:$uname",$tryserver);
1939: if ($answer eq 'found') {
1940: delete($badServerCache{$tryserver});
1941: return $homecache{$index}=$tryserver;
1942: } elsif ($answer eq 'no_host') {
1943: $badServerCache{$tryserver}=1;
1944: }
1.1 albertel 1945: }
1946: return 'no_host';
1.70 www 1947: }
1948:
1.1300 raeburn 1949: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1.70 www 1950:
1951: sub idget {
1.1300 raeburn 1952: my ($udom,$idsref,$namespace)=@_;
1.70 www 1953: my %returnhash=();
1.1300 raeburn 1954: my @ids=();
1955: if (ref($idsref) eq 'ARRAY') {
1956: @ids = @{$idsref};
1957: } else {
1958: return %returnhash;
1959: }
1960: if ($namespace eq '') {
1961: $namespace = 'ids';
1962: }
1.70 www 1963:
1.841 albertel 1964: my %servers = &get_servers($udom,'library');
1965: foreach my $tryserver (keys(%servers)) {
1.1299 raeburn 1966: my $idlist=join('&', map { &escape($_); } @ids);
1.1300 raeburn 1967: if ($namespace eq 'ids') {
1968: $idlist=~tr/A-Z/a-z/;
1969: }
1970: my $reply;
1971: if ($namespace eq 'ids') {
1972: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1973: } else {
1974: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1975: }
1.841 albertel 1976: my @answer=();
1977: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1978: @answer=split(/\&/,$reply);
1979: } ;
1980: my $i;
1981: for ($i=0;$i<=$#ids;$i++) {
1982: if ($answer[$i]) {
1.1299 raeburn 1983: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1.1300 raeburn 1984: }
1.841 albertel 1985: }
1.1300 raeburn 1986: }
1.70 www 1987: return %returnhash;
1988: }
1989:
1990: # ------------------------------------- Find the IDs behind a list of usernames
1991:
1992: sub idrget {
1993: my ($udom,@unames)=@_;
1994: my %returnhash=();
1.800 albertel 1995: foreach my $uname (@unames) {
1996: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1997: }
1.70 www 1998: return %returnhash;
1999: }
2000:
1.1300 raeburn 2001: # Store away a list of names and associated student/employee IDs or clicker IDs
1.70 www 2002:
2003: sub idput {
1.1300 raeburn 2004: my ($udom,$idsref,$uhom,$namespace)=@_;
1.70 www 2005: my %servers=();
1.1300 raeburn 2006: my %ids=();
2007: my %byid = ();
2008: if (ref($idsref) eq 'HASH') {
2009: %ids=%{$idsref};
2010: }
2011: if ($namespace eq '') {
2012: $namespace = 'ids';
2013: }
1.800 albertel 2014: foreach my $uname (keys(%ids)) {
2015: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1.1300 raeburn 2016: if ($uhom eq '') {
2017: $uhom=&homeserver($uname,$udom);
2018: }
1.70 www 2019: if ($uhom ne 'no_host') {
1.800 albertel 2020: my $esc_unam=&escape($uname);
1.1300 raeburn 2021: if ($namespace eq 'ids') {
2022: my $id=&escape($ids{$uname});
2023: $id=~tr/A-Z/a-z/;
2024: my $esc_unam=&escape($uname);
2025: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1.70 www 2026: } else {
1.1300 raeburn 2027: my @currids = split(/,/,$ids{$uname});
2028: foreach my $id (@currids) {
2029: $byid{$uhom}{$id} .= $uname.',';
2030: }
2031: }
2032: }
2033: }
2034: if ($namespace eq 'clickers') {
2035: foreach my $server (keys(%byid)) {
2036: if (ref($byid{$server}) eq 'HASH') {
2037: foreach my $id (keys(%{$byid{$server}})) {
2038: $byid{$server} =~ s/,$//;
2039: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
2040: }
1.70 www 2041: }
2042: }
1.191 harris41 2043: }
1.800 albertel 2044: foreach my $server (keys(%servers)) {
1.1300 raeburn 2045: $servers{$server} =~ s/\&$//;
2046: if ($namespace eq 'ids') {
2047: &critical('idput:'.$udom.':'.$servers{$server},$server);
2048: } else {
2049: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
2050: }
1.191 harris41 2051: }
1.344 www 2052: }
2053:
1.1300 raeburn 2054: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1.1231 raeburn 2055:
2056: sub iddel {
1.1300 raeburn 2057: my ($udom,$idshashref,$uhome,$namespace)=@_;
1.1231 raeburn 2058: my %result=();
1.1300 raeburn 2059: my %ids=();
2060: my %byid = ();
2061: if (ref($idshashref) eq 'HASH') {
2062: %ids=%{$idshashref};
2063: } else {
1.1231 raeburn 2064: return %result;
2065: }
1.1300 raeburn 2066: if ($namespace eq '') {
2067: $namespace = 'ids';
2068: }
1.1231 raeburn 2069: my %servers=();
1.1300 raeburn 2070: while (my ($id,$unamestr) = each(%ids)) {
2071: if ($namespace eq 'ids') {
2072: my $uhom = $uhome;
2073: if ($uhom eq '') {
2074: $uhom=&homeserver($unamestr,$udom);
2075: }
2076: if ($uhom ne 'no_host') {
2077: $servers{$uhom}.='&'.&escape($id);
2078: }
2079: } else {
2080: my @curritems = split(/,/,$ids{$id});
2081: foreach my $uname (@curritems) {
2082: my $uhom = $uhome;
2083: if ($uhom eq '') {
2084: $uhom=&homeserver($uname,$udom);
2085: }
2086: if ($uhom ne 'no_host') {
2087: $byid{$uhom}{$id} .= $uname.',';
2088: }
2089: }
1.1231 raeburn 2090: }
1.1300 raeburn 2091: }
2092: if ($namespace eq 'clickers') {
2093: foreach my $server (keys(%byid)) {
2094: if (ref($byid{$server}) eq 'HASH') {
2095: foreach my $id (keys(%{$byid{$server}})) {
2096: $byid{$server}{$id} =~ s/,$//;
2097: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
2098: }
1.1231 raeburn 2099: }
2100: }
2101: }
2102: foreach my $server (keys(%servers)) {
1.1300 raeburn 2103: $servers{$server} =~ s/\&$//;
2104: if ($namespace eq 'ids') {
2105: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
2106: } elsif ($namespace eq 'clickers') {
2107: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
2108: }
1.1231 raeburn 2109: }
2110: return %result;
2111: }
2112:
1.1300 raeburn 2113: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
2114:
2115: sub updateclickers {
2116: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
2117: my %clickers;
2118: if (ref($idshashref) eq 'HASH') {
2119: %clickers=%{$idshashref};
2120: } else {
2121: return;
2122: }
2123: my $items='';
2124: foreach my $item (keys(%clickers)) {
2125: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
2126: }
2127: $items=~s/\&$//;
2128: my $request = "updateclickers:$udom:$action:$items";
2129: if ($critical) {
2130: return &critical($request,$uhome);
2131: } else {
2132: return &reply($request,$uhome);
2133: }
2134: }
2135:
1.1023 raeburn 2136: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 2137: sub dump_dom {
1.1165 droeschl 2138: my ($namespace, $udom, $regexp) = @_;
2139:
2140: $udom ||= $env{'user.domain'};
2141:
2142: return () unless $udom;
2143:
2144: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 2145: }
2146:
1.1023 raeburn 2147: # ------------------------------------------ get items from domain db files
1.806 raeburn 2148:
2149: sub get_dom {
1.1462 raeburn 2150: my ($namespace,$storearr,$udom,$uhome,$encrypt)=@_;
1.1267 raeburn 2151: return if ($udom eq 'public');
1.806 raeburn 2152: my $items='';
2153: foreach my $item (@$storearr) {
2154: $items.=&escape($item).'&';
2155: }
2156: $items=~s/\&$//;
1.860 raeburn 2157: if (!$udom) {
2158: $udom=$env{'user.domain'};
1.1267 raeburn 2159: return if ($udom eq 'public');
1.860 raeburn 2160: if (defined(&domain($udom,'primary'))) {
2161: $uhome=&domain($udom,'primary');
2162: } else {
1.874 albertel 2163: undef($uhome);
1.860 raeburn 2164: }
2165: } else {
2166: if (!$uhome) {
2167: if (defined(&domain($udom,'primary'))) {
2168: $uhome=&domain($udom,'primary');
2169: }
2170: }
2171: }
2172: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.1344 raeburn 2173: my $rep;
1.1442 raeburn 2174: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
2175: # domain information is hosted on this machine
1.1462 raeburn 2176: $rep = &LONCAPA::Lond::get_dom("getdom:$udom:$namespace:$items");
1.1344 raeburn 2177: } else {
1.1462 raeburn 2178: if ($encrypt) {
1.1442 raeburn 2179: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
2180: } else {
2181: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
2182: }
1.1344 raeburn 2183: }
1.866 raeburn 2184: my %returnhash;
1.875 albertel 2185: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 2186: return %returnhash;
2187: }
1.806 raeburn 2188: my @pairs=split(/\&/,$rep);
2189: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2190: return @pairs;
2191: }
2192: my $i=0;
2193: foreach my $item (@$storearr) {
2194: $returnhash{$item}=&thaw_unescape($pairs[$i]);
2195: $i++;
2196: }
2197: return %returnhash;
2198: } else {
1.880 banghart 2199: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 2200: }
2201: }
2202:
2203: # -------------------------------------------- put items in domain db files
2204:
2205: sub put_dom {
1.1462 raeburn 2206: my ($namespace,$storehash,$udom,$uhome,$encrypt)=@_;
1.860 raeburn 2207: if (!$udom) {
2208: $udom=$env{'user.domain'};
2209: if (defined(&domain($udom,'primary'))) {
2210: $uhome=&domain($udom,'primary');
2211: } else {
1.874 albertel 2212: undef($uhome);
1.860 raeburn 2213: }
2214: } else {
2215: if (!$uhome) {
2216: if (defined(&domain($udom,'primary'))) {
2217: $uhome=&domain($udom,'primary');
2218: }
2219: }
2220: }
2221: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 2222: my $items='';
2223: foreach my $item (keys(%$storehash)) {
2224: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2225: }
2226: $items=~s/\&$//;
1.1462 raeburn 2227: if ($encrypt) {
1.1344 raeburn 2228: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2229: } else {
2230: return &reply("putdom:$udom:$namespace:$items",$uhome);
2231: }
1.806 raeburn 2232: } else {
1.860 raeburn 2233: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 2234: }
2235: }
2236:
1.1023 raeburn 2237: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 2238: sub newput_dom {
1.1023 raeburn 2239: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 2240: my $result;
2241: if (!$udom) {
2242: $udom=$env{'user.domain'};
2243: }
1.1023 raeburn 2244: if ($udom) {
2245: my $uname = &get_domainconfiguser($udom);
2246: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 2247: }
2248: return $result;
2249: }
2250:
1.1023 raeburn 2251: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 2252: sub del_dom {
1.1023 raeburn 2253: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 2254: if (ref($storearr) eq 'ARRAY') {
2255: if (!$udom) {
2256: $udom=$env{'user.domain'};
2257: }
1.1023 raeburn 2258: if ($udom) {
2259: my $uname = &get_domainconfiguser($udom);
2260: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 2261: }
2262: }
2263: }
2264:
1.1023 raeburn 2265: # ----------------------------------construct domainconfig user for a domain
2266: sub get_domainconfiguser {
2267: my ($udom) = @_;
2268: return $udom.'-domainconfig';
2269: }
2270:
1.837 raeburn 2271: sub retrieve_inst_usertypes {
2272: my ($udom) = @_;
2273: my (%returnhash,@order);
1.989 raeburn 2274: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
2275: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2276: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256 raeburn 2277: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 2278: } else {
2279: if (defined(&domain($udom,'primary'))) {
2280: my $uhome=&domain($udom,'primary');
2281: my $rep=&reply("inst_usertypes:$udom",$uhome);
2282: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1256 raeburn 2283: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 2284: return (\%returnhash,\@order);
2285: }
2286: my ($hashitems,$orderitems) = split(/:/,$rep);
2287: my @pairs=split(/\&/,$hashitems);
2288: foreach my $item (@pairs) {
2289: my ($key,$value)=split(/=/,$item,2);
2290: $key = &unescape($key);
2291: next if ($key =~ /^error: 2 /);
2292: $returnhash{$key}=&thaw_unescape($value);
2293: }
2294: my @esc_order = split(/\&/,$orderitems);
2295: foreach my $item (@esc_order) {
2296: push(@order,&unescape($item));
2297: }
2298: } else {
1.1256 raeburn 2299: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 2300: }
1.1256 raeburn 2301: return (\%returnhash,\@order);
1.837 raeburn 2302: }
2303: }
2304:
1.868 raeburn 2305: sub is_domainimage {
2306: my ($url) = @_;
1.1468 raeburn 2307: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo|login)/+[^/]-) {
1.868 raeburn 2308: if (&domain($1) ne '') {
2309: return '1';
2310: }
2311: }
2312: return;
2313: }
2314:
1.899 raeburn 2315: sub inst_directory_query {
2316: my ($srch) = @_;
2317: my $udom = $srch->{'srchdomain'};
2318: my %results;
2319: my $homeserver = &domain($udom,'primary');
1.909 raeburn 2320: my $outcome;
1.899 raeburn 2321: if ($homeserver ne '') {
1.1357 raeburn 2322: unless ($homeserver eq $perlvar{'lonHostID'}) {
2323: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2324: my $lcrev = &get_server_loncaparev($udom,$homeserver);
1.1357 raeburn 2325: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2326: if (($major eq '' && $minor eq '') || ($major < 2) ||
2327: (($major == 2) && ($minor < 12))) {
2328: return;
2329: }
2330: }
2331: }
1.904 albertel 2332: my $queryid=&reply("querysend:instdirsearch:".
2333: &escape($srch->{'srchby'}).':'.
2334: &escape($srch->{'srchterm'}).':'.
2335: &escape($srch->{'srchtype'}),$homeserver);
2336: my $host=&hostname($homeserver);
2337: if ($queryid !~/^\Q$host\E\_/) {
1.1343 raeburn 2338: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
1.904 albertel 2339: return;
2340: }
2341: my $response = &get_query_reply($queryid);
2342: my $maxtries = 5;
2343: my $tries = 1;
2344: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2345: $response = &get_query_reply($queryid);
2346: $tries ++;
2347: }
2348:
2349: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 2350: if ($response eq 'unavailable') {
2351: $outcome = $response;
2352: } else {
2353: $outcome = 'ok';
2354: my @matches = split(/\n/,$response);
2355: foreach my $match (@matches) {
2356: my ($key,$value) = split(/=/,$match);
2357: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2358: }
1.899 raeburn 2359: }
2360: }
2361: }
1.909 raeburn 2362: return ($outcome,%results);
1.899 raeburn 2363: }
2364:
2365: sub usersearch {
2366: my ($srch) = @_;
2367: my $dom = $srch->{'srchdomain'};
2368: my %results;
2369: my %libserv = &all_library();
2370: my $query = 'usersearch';
2371: foreach my $tryserver (keys(%libserv)) {
2372: if (&host_domain($tryserver) eq $dom) {
1.1357 raeburn 2373: unless ($tryserver eq $perlvar{'lonHostID'}) {
2374: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2375: my $lcrev = &get_server_loncaparev($dom,$tryserver);
1.1357 raeburn 2376: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2377: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2378: (($major == 2) && ($minor < 12)));
2379: }
2380: }
1.899 raeburn 2381: my $host=&hostname($tryserver);
2382: my $queryid=
1.911 raeburn 2383: &reply("querysend:".&escape($query).':'.
2384: &escape($srch->{'srchby'}).':'.
1.899 raeburn 2385: &escape($srch->{'srchtype'}).':'.
2386: &escape($srch->{'srchterm'}),$tryserver);
2387: if ($queryid !~/^\Q$host\E\_/) {
2388: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 2389: next;
1.899 raeburn 2390: }
2391: my $reply = &get_query_reply($queryid);
2392: my $maxtries = 1;
2393: my $tries = 1;
2394: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2395: $reply = &get_query_reply($queryid);
2396: $tries ++;
2397: }
2398: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2399: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2400: } else {
1.911 raeburn 2401: my @matches;
2402: if ($reply =~ /\n/) {
2403: @matches = split(/\n/,$reply);
2404: } else {
2405: @matches = split(/\&/,$reply);
2406: }
1.899 raeburn 2407: foreach my $match (@matches) {
2408: my ($uname,$udom,%userhash);
1.911 raeburn 2409: foreach my $entry (split(/:/,$match)) {
2410: my ($key,$value) =
2411: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 2412: $userhash{$key} = $value;
2413: if ($key eq 'username') {
2414: $uname = $value;
2415: } elsif ($key eq 'domain') {
2416: $udom = $value;
1.911 raeburn 2417: }
1.899 raeburn 2418: }
2419: $results{$uname.':'.$udom} = \%userhash;
2420: }
2421: }
2422: }
2423: }
2424: return %results;
2425: }
2426:
1.912 raeburn 2427: sub get_instuser {
2428: my ($udom,$uname,$id) = @_;
2429: my $homeserver = &domain($udom,'primary');
2430: my ($outcome,%results);
2431: if ($homeserver ne '') {
2432: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2433: &escape($id).':'.&escape($udom),$homeserver);
2434: my $host=&hostname($homeserver);
2435: if ($queryid !~/^\Q$host\E\_/) {
2436: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2437: return;
2438: }
2439: my $response = &get_query_reply($queryid);
2440: my $maxtries = 5;
2441: my $tries = 1;
2442: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2443: $response = &get_query_reply($queryid);
2444: $tries ++;
2445: }
2446: if (!&error($response) && $response ne 'refused') {
2447: if ($response eq 'unavailable') {
2448: $outcome = $response;
2449: } else {
2450: $outcome = 'ok';
2451: my @matches = split(/\n/,$response);
2452: foreach my $match (@matches) {
2453: my ($key,$value) = split(/=/,$match);
2454: $results{&unescape($key)} = &thaw_unescape($value);
2455: }
2456: }
2457: }
2458: }
2459: my %userinfo;
2460: if (ref($results{$uname}) eq 'HASH') {
2461: %userinfo = %{$results{$uname}};
2462: }
2463: return ($outcome,%userinfo);
2464: }
2465:
1.1290 raeburn 2466: sub get_multiple_instusers {
2467: my ($udom,$users,$caller) = @_;
2468: my ($outcome,$results);
2469: if (ref($users) eq 'HASH') {
2470: my $count = keys(%{$users});
2471: my $requested = &freeze_escape($users);
2472: my $homeserver = &domain($udom,'primary');
2473: if ($homeserver ne '') {
2474: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2475: my $host=&hostname($homeserver);
2476: if ($queryid !~/^\Q$host\E\_/) {
2477: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2478: ' for host: '.$homeserver.'in domain '.$udom);
2479: return ($outcome,$results);
2480: }
2481: my $response = &get_query_reply($queryid);
2482: my $maxtries = 5;
2483: if ($count > 100) {
2484: $maxtries = 1+int($count/20);
2485: }
2486: my $tries = 1;
2487: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2488: $response = &get_query_reply($queryid);
2489: $tries ++;
2490: }
2491: if ($response eq '') {
2492: $results = {};
2493: foreach my $key (keys(%{$users})) {
2494: my ($uname,$id);
2495: if ($caller eq 'id') {
2496: $id = $key;
2497: } else {
2498: $uname = $key;
2499: }
2500: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1.1291 raeburn 2501: $outcome = $resp;
1.1290 raeburn 2502: if ($resp eq 'ok') {
2503: %{$results} = (%{$results}, %info);
2504: } else {
2505: last;
2506: }
2507: }
2508: } elsif(!&error($response) && ($response ne 'refused')) {
2509: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2510: $outcome = $response;
2511: } else {
1.1291 raeburn 2512: ($outcome,my $userdata) = split(/=/,$response,2);
1.1290 raeburn 2513: if ($outcome eq 'ok') {
2514: $results = &thaw_unescape($userdata);
2515: }
2516: }
2517: }
2518: }
2519: }
2520: return ($outcome,$results);
2521: }
2522:
1.912 raeburn 2523: sub inst_rulecheck {
1.923 raeburn 2524: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 2525: my %returnhash;
2526: if ($udom ne '') {
2527: if (ref($rules) eq 'ARRAY') {
2528: @{$rules} = map {&escape($_);} (@{$rules});
2529: my $rulestr = join(':',@{$rules});
2530: my $homeserver=&domain($udom,'primary');
2531: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2532: my $response;
2533: if ($item eq 'username') {
2534: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2535: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2536: $homeserver));
1.923 raeburn 2537: } elsif ($item eq 'id') {
2538: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2539: ':'.&escape($id).':'.$rulestr,
2540: $homeserver));
1.945 raeburn 2541: } elsif ($item eq 'selfcreate') {
2542: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2543: &escape($udom).':'.&escape($uname).
2544: ':'.$rulestr,$homeserver));
1.923 raeburn 2545: }
1.912 raeburn 2546: if ($response ne 'refused') {
2547: my @pairs=split(/\&/,$response);
2548: foreach my $item (@pairs) {
2549: my ($key,$value)=split(/=/,$item,2);
2550: $key = &unescape($key);
2551: next if ($key =~ /^error: 2 /);
2552: $returnhash{$key}=&thaw_unescape($value);
2553: }
2554: }
2555: }
2556: }
2557: }
2558: return %returnhash;
2559: }
2560:
2561: sub inst_userrules {
1.923 raeburn 2562: my ($udom,$check) = @_;
1.912 raeburn 2563: my (%ruleshash,@ruleorder);
2564: if ($udom ne '') {
2565: my $homeserver=&domain($udom,'primary');
2566: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2567: my $response;
2568: if ($check eq 'id') {
2569: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2570: $homeserver);
1.943 raeburn 2571: } elsif ($check eq 'email') {
2572: $response=&reply('instemailrules:'.&escape($udom),
2573: $homeserver);
1.923 raeburn 2574: } else {
2575: $response=&reply('instuserrules:'.&escape($udom),
2576: $homeserver);
2577: }
1.912 raeburn 2578: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2579: ($response ne 'unknown_cmd') &&
1.912 raeburn 2580: ($response ne 'no_such_host')) {
2581: my ($hashitems,$orderitems) = split(/:/,$response);
2582: my @pairs=split(/\&/,$hashitems);
2583: foreach my $item (@pairs) {
2584: my ($key,$value)=split(/=/,$item,2);
2585: $key = &unescape($key);
2586: next if ($key =~ /^error: 2 /);
2587: $ruleshash{$key}=&thaw_unescape($value);
2588: }
2589: my @esc_order = split(/\&/,$orderitems);
2590: foreach my $item (@esc_order) {
2591: push(@ruleorder,&unescape($item));
2592: }
2593: }
2594: }
2595: }
2596: return (\%ruleshash,\@ruleorder);
2597: }
2598:
1.976 raeburn 2599: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2600:
2601: sub get_domain_defaults {
1.1240 raeburn 2602: my ($domain,$ignore_cache) = @_;
1.1242 raeburn 2603: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2604: my $cachetime = 60*60*24;
1.1240 raeburn 2605: unless ($ignore_cache) {
2606: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2607: if (defined($cached)) {
2608: if (ref($result) eq 'HASH') {
2609: return %{$result};
2610: }
1.943 raeburn 2611: }
2612: }
2613: my %domdefaults;
2614: my %domconfig =
1.989 raeburn 2615: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2616: 'requestcourses','inststatus',
1.1183 raeburn 2617: 'coursedefaults','usersessions',
1.1258 raeburn 2618: 'requestauthor','selfenrollment',
1.1320 raeburn 2619: 'coursecategories','ssl','autoenroll',
1.1434 raeburn 2620: 'trust','helpsettings','wafproxy'],$domain);
1.1305 raeburn 2621: my @coursetypes = ('official','unofficial','community','textbook','placement');
1.943 raeburn 2622: if (ref($domconfig{'defaults'}) eq 'HASH') {
2623: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2624: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2625: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2626: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2627: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2628: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.1340 raeburn 2629: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2630: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2631: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.943 raeburn 2632: } else {
2633: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2634: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2635: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2636: }
1.976 raeburn 2637: if (ref($domconfig{'quotas'}) eq 'HASH') {
2638: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2639: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2640: } else {
2641: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2642: }
1.1177 raeburn 2643: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2644: foreach my $item (@usertools) {
2645: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2646: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2647: }
2648: }
1.1229 raeburn 2649: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2650: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2651: }
1.976 raeburn 2652: }
1.985 raeburn 2653: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1305 raeburn 2654: foreach my $item ('official','unofficial','community','textbook','placement') {
1.985 raeburn 2655: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2656: }
2657: }
1.1183 raeburn 2658: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2659: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2660: }
1.989 raeburn 2661: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256 raeburn 2662: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2663: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2664: }
2665: }
1.1047 raeburn 2666: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2667: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277 raeburn 2668: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
1.1476 ! raeburn 2669: $domdefaults{'inline_chem'} = $domconfig{'coursedefaults'}{'inline_chem'};
1.1277 raeburn 2670: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2671: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2672: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2673: }
1.1254 raeburn 2674: foreach my $type (@coursetypes) {
2675: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2676: unless ($type eq 'community') {
2677: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2678: }
2679: }
2680: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2681: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2682: }
1.1277 raeburn 2683: if ($domdefaults{'postsubmit'} eq 'on') {
2684: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2685: $domdefaults{$type.'postsubtimeout'} =
2686: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2687: }
2688: }
1.1230 raeburn 2689: }
1.1286 raeburn 2690: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2691: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2692: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2693: if (@clonecodes) {
2694: $domdefaults{'canclone'} = join('+',@clonecodes);
2695: }
2696: }
2697: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2698: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2699: }
1.1356 raeburn 2700: if ($domconfig{'coursedefaults'}{'texengine'}) {
2701: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
2702: }
1.1047 raeburn 2703: }
1.1073 raeburn 2704: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2705: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2706: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2707: }
2708: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2709: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2710: }
1.1279 raeburn 2711: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2712: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2713: }
1.1440 raeburn 2714: if (ref($domconfig{'usersessions'}{'offloadoth'}) eq 'HASH') {
1.1439 raeburn 2715: $domdefaults{'offloadoth'} = $domconfig{'usersessions'}{'offloadoth'};
2716: }
1.1073 raeburn 2717: }
1.1254 raeburn 2718: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2719: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2720: my @settings = ('types','registered','enroll_dates','access_dates','section',
2721: 'approval','limit');
2722: foreach my $type (@coursetypes) {
2723: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2724: my @mgrdc = ();
2725: foreach my $item (@settings) {
2726: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2727: push(@mgrdc,$item);
2728: }
2729: }
2730: if (@mgrdc) {
2731: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2732: }
2733: }
2734: }
2735: }
2736: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2737: foreach my $type (@coursetypes) {
2738: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2739: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2740: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2741: }
2742: }
2743: }
2744: }
2745: }
1.1258 raeburn 2746: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2747: $domdefaults{'catauth'} = 'std';
2748: $domdefaults{'catunauth'} = 'std';
1.1413 raeburn 2749: if ($domconfig{'coursecategories'}{'auth'}) {
1.1258 raeburn 2750: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2751: }
2752: if ($domconfig{'coursecategories'}{'unauth'}) {
2753: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2754: }
2755: }
1.1315 raeburn 2756: if (ref($domconfig{'ssl'}) eq 'HASH') {
2757: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2758: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2759: }
1.1338 raeburn 2760: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2761: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2762: }
2763: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2764: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
1.1315 raeburn 2765: }
2766: }
1.1320 raeburn 2767: if (ref($domconfig{'trust'}) eq 'HASH') {
2768: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2769: foreach my $prefix (@prefixes) {
2770: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2771: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2772: }
2773: }
2774: }
1.1314 raeburn 2775: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2776: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2777: }
1.1332 raeburn 2778: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2779: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2780: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2781: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2782: }
2783: }
1.1434 raeburn 2784: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
1.1449 raeburn 2785: foreach my $item ('ipheader','trusted','vpnint','vpnext','sslopt') {
1.1434 raeburn 2786: if ($domconfig{'wafproxy'}{$item}) {
2787: $domdefaults{'waf_'.$item} = $domconfig{'wafproxy'}{$item};
2788: }
2789: }
2790: }
1.1219 raeburn 2791: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2792: return %domdefaults;
2793: }
2794:
1.1412 raeburn 2795: sub get_dom_cats {
2796: my ($dom) = @_;
2797: return unless (&domain($dom));
2798: my ($cats,$cached)=&is_cached_new('cats',$dom);
2799: unless (defined($cached)) {
2800: my %domconfig = &get_dom('configuration',['coursecategories'],$dom);
2801: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2802: if (ref($domconfig{'coursecategories'}{'cats'}) eq 'HASH') {
2803: %{$cats} = %{$domconfig{'coursecategories'}{'cats'}};
2804: } else {
2805: $cats = {};
2806: }
2807: } else {
2808: $cats = {};
2809: }
2810: &Apache::lonnet::do_cache_new('cats',$dom,$cats,3600);
2811: }
1.1413 raeburn 2812: return $cats;
2813: }
2814:
2815: sub get_dom_instcats {
2816: my ($dom) = @_;
2817: return unless (&domain($dom));
2818: my ($instcats,$cached)=&is_cached_new('instcats',$dom);
2819: unless (defined($cached)) {
2820: my (%coursecodes,%codes,@codetitles,%cat_titles,%cat_order);
2821: my $totcodes = &retrieve_instcodes(\%coursecodes,$dom);
2822: if ($totcodes > 0) {
2823: my $caller = 'global';
2824: if (&auto_instcode_format($caller,$dom,\%coursecodes,\%codes,
2825: \@codetitles,\%cat_titles,\%cat_order) eq 'ok') {
2826: $instcats = {
2827: codes => \%codes,
2828: codetitles => \@codetitles,
2829: cat_titles => \%cat_titles,
2830: cat_order => \%cat_order,
2831: };
2832: &do_cache_new('instcats',$dom,$instcats,3600);
2833: }
2834: }
2835: }
2836: return $instcats;
2837: }
2838:
2839: sub retrieve_instcodes {
2840: my ($coursecodes,$dom) = @_;
2841: my $totcodes;
2842: my %courses = &courseiddump($dom,'.',1,'.','.','.',undef,undef,'Course');
2843: foreach my $course (keys(%courses)) {
2844: if (ref($courses{$course}) eq 'HASH') {
2845: if ($courses{$course}{'inst_code'} ne '') {
2846: $$coursecodes{$course} = $courses{$course}{'inst_code'};
2847: $totcodes ++;
2848: }
2849: }
2850: }
2851: return $totcodes;
1.1412 raeburn 2852: }
2853:
1.1311 raeburn 2854: sub course_portal_url {
1.1451 raeburn 2855: my ($cnum,$cdom,$r) = @_;
1.1311 raeburn 2856: my $chome = &homeserver($cnum,$cdom);
2857: my $hostname = &hostname($chome);
2858: my $protocol = $protocol{$chome};
2859: $protocol = 'http' if ($protocol ne 'https');
2860: my %domdefaults = &get_domain_defaults($cdom);
2861: my $firsturl;
2862: if ($domdefaults{'portal_def'}) {
2863: $firsturl = $domdefaults{'portal_def'};
2864: } else {
1.1451 raeburn 2865: my $alias = &Apache::lonnet::use_proxy_alias($r,$chome);
2866: $hostname = $alias if ($alias ne '');
1.1311 raeburn 2867: $firsturl = $protocol.'://'.$hostname;
2868: }
2869: return $firsturl;
2870: }
2871:
1.1407 raeburn 2872: # --------------------------------------------- Get domain config for passwords
2873:
2874: sub get_passwdconf {
2875: my ($dom) = @_;
2876: my (%passwdconf,$gotconf,$lookup);
2877: my ($result,$cached)=&is_cached_new('passwdconf',$dom);
2878: if (defined($cached)) {
2879: if (ref($result) eq 'HASH') {
2880: %passwdconf = %{$result};
2881: $gotconf = 1;
2882: }
2883: }
2884: unless ($gotconf) {
2885: my %domconfig = &get_dom('configuration',['passwords'],$dom);
2886: if (ref($domconfig{'passwords'}) eq 'HASH') {
2887: %passwdconf = %{$domconfig{'passwords'}};
2888: }
2889: my $cachetime = 24*60*60;
2890: &do_cache_new('passwdconf',$dom,\%passwdconf,$cachetime);
2891: }
2892: return %passwdconf;
2893: }
2894:
1.344 www 2895: # --------------------------------------------------- Assign a key to a student
2896:
2897: sub assign_access_key {
1.364 www 2898: #
2899: # a valid key looks like uname:udom#comments
2900: # comments are being appended
2901: #
1.498 www 2902: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2903: $kdom=
1.620 albertel 2904: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2905: $knum=
1.620 albertel 2906: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2907: $cdom=
1.620 albertel 2908: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2909: $cnum=
1.620 albertel 2910: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2911: $udom=$env{'user.name'} unless (defined($udom));
2912: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2913: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2914: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2915: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2916: # assigned to this person
2917: # - this should not happen,
1.345 www 2918: # unless something went wrong
2919: # the first time around
2920: # ready to assign
1.364 www 2921: $logentry=$1.'; '.$logentry;
1.496 www 2922: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2923: $kdom,$knum) eq 'ok') {
1.345 www 2924: # key now belongs to user
1.346 www 2925: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2926: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2927: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2928: return 'ok';
2929: } else {
2930: return
2931: 'error: Count not permanently assign key, will need to be re-entered later.';
2932: }
2933: } else {
2934: return 'error: Could not assign key, try again later.';
2935: }
1.364 www 2936: } elsif (!$existing{$ckey}) {
1.345 www 2937: # the key does not exist
2938: return 'error: The key does not exist';
2939: } else {
2940: # the key is somebody else's
2941: return 'error: The key is already in use';
2942: }
1.344 www 2943: }
2944:
1.364 www 2945: # ------------------------------------------ put an additional comment on a key
2946:
2947: sub comment_access_key {
2948: #
2949: # a valid key looks like uname:udom#comments
2950: # comments are being appended
2951: #
2952: my ($ckey,$cdom,$cnum,$logentry)=@_;
2953: $cdom=
1.620 albertel 2954: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2955: $cnum=
1.620 albertel 2956: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2957: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2958: if ($existing{$ckey}) {
2959: $existing{$ckey}.='; '.$logentry;
2960: # ready to assign
1.367 www 2961: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2962: $cdom,$cnum) eq 'ok') {
2963: return 'ok';
2964: } else {
2965: return 'error: Count not store comment.';
2966: }
2967: } else {
2968: # the key does not exist
2969: return 'error: The key does not exist';
2970: }
2971: }
2972:
1.344 www 2973: # ------------------------------------------------------ Generate a set of keys
2974:
2975: sub generate_access_keys {
1.364 www 2976: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2977: $cdom=
1.620 albertel 2978: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2979: $cnum=
1.620 albertel 2980: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2981: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2982: unless (($cdom) && ($cnum)) { return 0; }
2983: if ($number>10000) { return 0; }
2984: sleep(2); # make sure don't get same seed twice
2985: srand(time()^($$+($$<<15))); # from "Programming Perl"
2986: my $total=0;
2987: for (my $i=1;$i<=$number;$i++) {
2988: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2989: sprintf("%lx",int(100000*rand)).'-'.
2990: sprintf("%lx",int(100000*rand));
2991: $newkey=~s/1/g/g; # folks mix up 1 and l
2992: $newkey=~s/0/h/g; # and also 0 and O
2993: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2994: if ($existing{$newkey}) {
2995: $i--;
2996: } else {
1.364 www 2997: if (&put('accesskeys',
2998: { $newkey => '# generated '.localtime().
1.620 albertel 2999: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 3000: '; '.$logentry },
3001: $cdom,$cnum) eq 'ok') {
1.344 www 3002: $total++;
3003: }
3004: }
3005: }
1.620 albertel 3006: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 3007: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
3008: return $total;
3009: }
3010:
3011: # ------------------------------------------------------- Validate an accesskey
3012:
3013: sub validate_access_key {
3014: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
3015: $cdom=
1.620 albertel 3016: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3017: $cnum=
1.620 albertel 3018: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3019: $udom=$env{'user.domain'} unless (defined($udom));
3020: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 3021: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 3022: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 3023: }
3024:
3025: # ------------------------------------- Find the section of student in a course
1.652 albertel 3026: sub devalidate_getsection_cache {
3027: my ($udom,$unam,$courseid)=@_;
3028: my $hashid="$udom:$unam:$courseid";
3029: &devalidate_cache_new('getsection',$hashid);
3030: }
1.298 matthew 3031:
1.815 albertel 3032: sub courseid_to_courseurl {
3033: my ($courseid) = @_;
3034: #already url style courseid
3035: return $courseid if ($courseid =~ m{^/});
3036:
3037: if (exists($env{'course.'.$courseid.'.num'})) {
3038: my $cnum = $env{'course.'.$courseid.'.num'};
3039: my $cdom = $env{'course.'.$courseid.'.domain'};
3040: return "/$cdom/$cnum";
3041: }
3042:
3043: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
3044: if (exists($courseinfo{'num'})) {
3045: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
3046: }
3047:
3048: return undef;
3049: }
3050:
1.298 matthew 3051: sub getsection {
3052: my ($udom,$unam,$courseid)=@_;
1.599 albertel 3053: my $cachetime=1800;
1.551 albertel 3054:
3055: my $hashid="$udom:$unam:$courseid";
1.599 albertel 3056: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 3057: if (defined($cached)) { return $result; }
3058:
1.298 matthew 3059: my %Pending;
3060: my %Expired;
3061: #
3062: # Each role can either have not started yet (pending), be active,
3063: # or have expired.
3064: #
3065: # If there is an active role, we are done.
3066: #
3067: # If there is more than one role which has not started yet,
3068: # choose the one which will start sooner
3069: # If there is one role which has not started yet, return it.
3070: #
3071: # If there is more than one expired role, choose the one which ended last.
3072: # If there is a role which has expired, return it.
3073: #
1.815 albertel 3074: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 3075: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 3076: foreach my $key (keys(%roleshash)) {
1.479 albertel 3077: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 3078: my $section=$1;
3079: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 3080: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 3081: my $now=time;
1.548 albertel 3082: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 3083: $Expired{$end}=$section;
3084: next;
3085: }
1.548 albertel 3086: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 3087: $Pending{$start}=$section;
3088: next;
3089: }
1.599 albertel 3090: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 3091: }
3092: #
3093: # Presumedly there will be few matching roles from the above
3094: # loop and the sorting time will be negligible.
3095: if (scalar(keys(%Pending))) {
3096: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 3097: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 3098: }
3099: if (scalar(keys(%Expired))) {
3100: my @sorted = sort {$a <=> $b} keys(%Expired);
3101: my $time = pop(@sorted);
1.599 albertel 3102: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 3103: }
1.599 albertel 3104: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 3105: }
1.70 www 3106:
1.599 albertel 3107: sub save_cache {
3108: &purge_remembered();
1.722 albertel 3109: #&Apache::loncommon::validate_page();
1.620 albertel 3110: undef(%env);
1.780 albertel 3111: undef($env_loaded);
1.599 albertel 3112: }
1.452 albertel 3113:
1.599 albertel 3114: my $to_remember=-1;
3115: my %remembered;
3116: my %accessed;
3117: my $kicks=0;
3118: my $hits=0;
1.849 albertel 3119: sub make_key {
3120: my ($name,$id) = @_;
1.872 albertel 3121: if (length($id) > 65
3122: && length(&escape($id)) > 200) {
3123: $id=length($id).':'.&Digest::MD5::md5_hex($id);
3124: }
1.849 albertel 3125: return &escape($name.':'.$id);
3126: }
3127:
1.599 albertel 3128: sub devalidate_cache_new {
3129: my ($name,$id,$debug) = @_;
3130: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1319 damieng 3131: my $remembered_id=$name.':'.$id;
1.849 albertel 3132: $id=&make_key($name,$id);
1.599 albertel 3133: $memcache->delete($id);
1.1319 damieng 3134: delete($remembered{$remembered_id});
3135: delete($accessed{$remembered_id});
1.599 albertel 3136: }
3137:
3138: sub is_cached_new {
3139: my ($name,$id,$debug) = @_;
1.1319 damieng 3140: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
3141: if (exists($remembered{$remembered_id})) {
3142: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
3143: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3144: $hits++;
1.1319 damieng 3145: return ($remembered{$remembered_id},1);
1.599 albertel 3146: }
1.1319 damieng 3147: $id=&make_key($name,$id);
1.599 albertel 3148: my $value = $memcache->get($id);
3149: if (!(defined($value))) {
3150: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 3151: return (undef,undef);
1.416 albertel 3152: }
1.599 albertel 3153: if ($value eq '__undef__') {
3154: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
3155: $value=undef;
3156: }
1.1319 damieng 3157: &make_room($remembered_id,$value,$debug);
1.599 albertel 3158: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
3159: return ($value,1);
3160: }
3161:
3162: sub do_cache_new {
3163: my ($name,$id,$value,$time,$debug) = @_;
1.1319 damieng 3164: my $remembered_id=$name.':'.$id;
1.849 albertel 3165: $id=&make_key($name,$id);
1.599 albertel 3166: my $setvalue=$value;
3167: if (!defined($setvalue)) {
3168: $setvalue='__undef__';
3169: }
1.623 albertel 3170: if (!defined($time) ) {
3171: $time=600;
3172: }
1.599 albertel 3173: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 3174: my $result = $memcache->set($id,$setvalue,$time);
3175: if (! $result) {
1.872 albertel 3176: &logthis("caching of id -> $id failed");
1.910 albertel 3177: $memcache->disconnect_all();
1.872 albertel 3178: }
1.600 albertel 3179: # need to make a copy of $value
1.1319 damieng 3180: &make_room($remembered_id,$value,$debug);
1.599 albertel 3181: return $value;
3182: }
3183:
3184: sub make_room {
1.1319 damieng 3185: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 3186:
1.1319 damieng 3187: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 3188: : $value;
1.599 albertel 3189: if ($to_remember<0) { return; }
1.1319 damieng 3190: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3191: if (scalar(keys(%remembered)) <= $to_remember) { return; }
3192: my $to_kick;
3193: my $max_time=0;
3194: foreach my $other (keys(%accessed)) {
3195: if (&tv_interval($accessed{$other}) > $max_time) {
3196: $to_kick=$other;
3197: $max_time=&tv_interval($accessed{$other});
3198: }
3199: }
3200: delete($remembered{$to_kick});
3201: delete($accessed{$to_kick});
3202: $kicks++;
3203: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 3204: return;
3205: }
3206:
1.599 albertel 3207: sub purge_remembered {
1.604 albertel 3208: #&logthis("Tossing ".scalar(keys(%remembered)));
3209: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 3210: undef(%remembered);
3211: undef(%accessed);
1.428 albertel 3212: }
1.70 www 3213: # ------------------------------------- Read an entry from a user's environment
3214:
3215: sub userenvironment {
3216: my ($udom,$unam,@what)=@_;
1.976 raeburn 3217: my $items;
3218: foreach my $item (@what) {
3219: $items.=&escape($item).'&';
3220: }
3221: $items=~s/\&$//;
1.70 www 3222: my %returnhash=();
1.1009 raeburn 3223: my $uhome = &homeserver($unam,$udom);
3224: unless ($uhome eq 'no_host') {
3225: my @answer=split(/\&/,
3226: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 3227: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
3228: return %returnhash;
3229: }
1.1009 raeburn 3230: my $i;
3231: for ($i=0;$i<=$#what;$i++) {
3232: $returnhash{$what[$i]}=&unescape($answer[$i]);
3233: }
1.70 www 3234: }
3235: return %returnhash;
1.1 albertel 3236: }
3237:
1.617 albertel 3238: # ---------------------------------------------------------- Get a studentphoto
3239: sub studentphoto {
3240: my ($udom,$unam,$ext) = @_;
3241: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 3242: if (defined($env{'request.course.id'})) {
1.708 raeburn 3243: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 3244: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
3245: return(&retrievestudentphoto($udom,$unam,$ext));
3246: } else {
3247: my ($result,$perm_reqd)=
1.707 albertel 3248: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 3249: if ($result eq 'ok') {
3250: if (!($perm_reqd eq 'yes')) {
3251: return(&retrievestudentphoto($udom,$unam,$ext));
3252: }
3253: }
3254: }
3255: }
3256: } else {
3257: my ($result,$perm_reqd) =
1.707 albertel 3258: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 3259: if ($result eq 'ok') {
3260: if (!($perm_reqd eq 'yes')) {
3261: return(&retrievestudentphoto($udom,$unam,$ext));
3262: }
3263: }
3264: }
3265: return '/adm/lonKaputt/lonlogo_broken.gif';
3266: }
3267:
3268: sub retrievestudentphoto {
3269: my ($udom,$unam,$ext,$type) = @_;
3270: my $home=&Apache::lonnet::homeserver($unam,$udom);
3271: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
3272: if ($ret eq 'ok') {
3273: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
3274: if ($type eq 'thumbnail') {
3275: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
3276: }
3277: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
3278: return $tokenurl;
3279: } else {
3280: if ($type eq 'thumbnail') {
3281: return '/adm/lonKaputt/genericstudent_tn.gif';
3282: } else {
3283: return '/adm/lonKaputt/lonlogo_broken.gif';
3284: }
1.617 albertel 3285: }
3286: }
3287:
1.263 www 3288: # -------------------------------------------------------------------- New chat
3289:
3290: sub chatsend {
1.724 raeburn 3291: my ($newentry,$anon,$group)=@_;
1.620 albertel 3292: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
3293: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3294: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 3295: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 3296: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 3297: &escape($newentry)).':'.$group,$chome);
1.292 www 3298: }
3299:
3300: # ------------------------------------------ Find current version of a resource
3301:
3302: sub getversion {
3303: my $fname=&clutter(shift);
1.1189 raeburn 3304: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 3305: return ¤tversion(&filelocation('',$fname));
3306: }
3307:
3308: sub currentversion {
3309: my $fname=shift;
3310: my $author=$fname;
3311: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3312: my ($udom,$uname)=split(/\//,$author);
1.1112 www 3313: my $home=&homeserver($uname,$udom);
1.292 www 3314: if ($home eq 'no_host') {
3315: return -1;
3316: }
1.1112 www 3317: my $answer=&reply("currentversion:$fname",$home);
1.292 www 3318: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3319: return -1;
3320: }
1.1112 www 3321: return $answer;
1.263 www 3322: }
3323:
1.1111 www 3324: #
3325: # Return special version number of resource if set by override, empty otherwise
3326: #
3327: sub usedversion {
3328: my $fname=shift;
3329: unless ($fname) { $fname=$env{'request.uri'}; }
3330: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3331: if ($urlversion) { return $urlversion; }
3332: return '';
3333: }
3334:
1.1 albertel 3335: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 3336:
1.1 albertel 3337: sub subscribe {
3338: my $fname=shift;
1.761 raeburn 3339: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 3340: $fname=~s/[\n\r]//g;
1.1 albertel 3341: my $author=$fname;
3342: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3343: my ($udom,$uname)=split(/\//,$author);
3344: my $home=homeserver($uname,$udom);
1.335 albertel 3345: if ($home eq 'no_host') {
3346: return 'not_found';
1.1 albertel 3347: }
3348: my $answer=reply("sub:$fname",$home);
1.64 www 3349: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3350: $answer.=' by '.$home;
3351: }
1.1 albertel 3352: return $answer;
3353: }
3354:
1.8 www 3355: # -------------------------------------------------------------- Replicate file
3356:
3357: sub repcopy {
3358: my $filename=shift;
1.23 www 3359: $filename=~s/\/+/\//g;
1.1142 raeburn 3360: my $londocroot = $perlvar{'lonDocRoot'};
3361: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 3362: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 3363: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3364: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 3365: return &repcopy_userfile($filename);
3366: }
1.532 albertel 3367: $filename=~s/[\n\r]//g;
1.8 www 3368: my $transname="$filename.in.transfer";
1.828 www 3369: # FIXME: this should flock
1.607 raeburn 3370: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 3371: my $remoteurl=subscribe($filename);
1.64 www 3372: if ($remoteurl =~ /^con_lost by/) {
3373: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3374: return 'unavailable';
1.8 www 3375: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 3376: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 3377: return 'not_found';
1.64 www 3378: } elsif ($remoteurl =~ /^rejected by/) {
3379: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3380: return 'forbidden';
1.20 www 3381: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 3382: return 'ok';
1.8 www 3383: } else {
1.290 www 3384: my $author=$filename;
3385: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3386: my ($udom,$uname)=split(/\//,$author);
3387: my $home=homeserver($uname,$udom);
3388: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 3389: my @parts=split(/\//,$filename);
3390: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 3391: if ($path ne "$londocroot/res") {
1.8 www 3392: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 3393: return 'bad_request';
1.8 www 3394: }
3395: my $count;
3396: for ($count=5;$count<$#parts;$count++) {
3397: $path.="/$parts[$count]";
3398: if ((-e $path)!=1) {
3399: mkdir($path,0777);
3400: }
3401: }
3402: my $request=new HTTP::Request('GET',"$remoteurl");
1.1345 raeburn 3403: my $response;
3404: if ($remoteurl =~ m{/raw/}) {
3405: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3406: } else {
3407: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3408: }
1.8 www 3409: if ($response->is_error()) {
3410: unlink($transname);
3411: my $message=$response->status_line;
1.672 albertel 3412: &logthis("<font color=\"blue\">WARNING:"
1.12 www 3413: ." LWP get: $message: $filename</font>");
1.607 raeburn 3414: return 'unavailable';
1.8 www 3415: } else {
1.16 www 3416: if ($remoteurl!~/\.meta$/) {
3417: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1.1345 raeburn 3418: my $mresponse;
3419: if ($remoteurl =~ m{/raw/}) {
3420: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3421: } else {
3422: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3423: }
1.16 www 3424: if ($mresponse->is_error()) {
3425: unlink($filename.'.meta');
3426: &logthis(
1.672 albertel 3427: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 3428: }
3429: }
1.8 www 3430: rename($transname,$filename);
1.607 raeburn 3431: return 'ok';
1.8 www 3432: }
1.290 www 3433: }
1.8 www 3434: }
1.330 www 3435: }
3436:
1.1422 raeburn 3437: # ------------------------------------------------- Unsubscribe from a resource
3438:
3439: sub unsubscribe {
3440: my ($fname) = @_;
3441: my $answer;
3442: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return $answer; }
3443: $fname=~s/[\n\r]//g;
3444: my $author=$fname;
3445: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3446: my ($udom,$uname)=split(/\//,$author);
3447: my $home=homeserver($uname,$udom);
3448: if ($home eq 'no_host') {
3449: $answer = 'no_host';
3450: } elsif (grep { $_ eq $home } ¤t_machine_ids()) {
3451: $answer = 'home';
3452: } else {
3453: my $defdom = $perlvar{'lonDefDomain'};
3454: if (&will_trust('content',$defdom,$udom)) {
3455: $answer = reply("unsub:$fname",$home);
3456: } else {
3457: $answer = 'untrusted';
3458: }
3459: }
3460: return $answer;
3461: }
3462:
1.330 www 3463: # ------------------------------------------------ Get server side include body
3464: sub ssi_body {
1.381 albertel 3465: my ($filelink,%form)=@_;
1.606 matthew 3466: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3467: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3468: }
1.953 www 3469: my $output='';
3470: my $response;
1.980 raeburn 3471: if ($filelink=~/^https?\:/) {
1.954 raeburn 3472: ($output,$response)=&externalssi($filelink);
1.953 www 3473: } else {
1.1004 droeschl 3474: $filelink .= $filelink=~/\?/ ? '&' : '?';
3475: $filelink .= 'inhibitmenu=yes';
1.953 www 3476: ($output,$response)=&ssi($filelink,%form);
3477: }
1.778 albertel 3478: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 3479: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 3480: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 3481: if (wantarray) {
3482: return ($output, $response);
3483: } else {
3484: return $output;
3485: }
1.8 www 3486: }
3487:
1.15 www 3488: # --------------------------------------------------------- Server Side Include
3489:
1.782 albertel 3490: sub absolute_url {
1.1447 raeburn 3491: my ($host_name,$unalias,$keep_proto) = @_;
1.782 albertel 3492: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3493: if ($host_name eq '') {
3494: $host_name = $ENV{'SERVER_NAME'};
3495: }
1.1447 raeburn 3496: if ($unalias) {
3497: my $alias = &get_proxy_alias();
3498: if ($alias eq $host_name) {
3499: my $lonhost = $perlvar{'lonHostID'};
3500: my $hostname = &hostname($lonhost);
3501: my $lcproto;
3502: if (($keep_proto) || ($hostname eq '')) {
3503: $lcproto = $protocol;
3504: } else {
3505: $lcproto = $protocol{$lonhost};
3506: $lcproto = 'http' if ($lcproto ne 'https');
3507: $lcproto .= '://';
3508: }
3509: unless ($hostname eq '') {
3510: return $lcproto.$hostname;
3511: }
3512: }
3513: }
1.782 albertel 3514: return $protocol.$host_name;
3515: }
3516:
1.942 foxr 3517: #
3518: # Server side include.
3519: # Parameters:
3520: # fn Possibly encrypted resource name/id.
3521: # form Hash that describes how the rendering should be done
3522: # and other things.
1.944 foxr 3523: # Returns:
1.950 raeburn 3524: # Scalar context: The content of the response.
3525: # Array context: 2 element list of the content and the full response object.
1.942 foxr 3526: #
1.15 www 3527: sub ssi {
3528:
1.944 foxr 3529: my ($fn,%form)=@_;
1.1447 raeburn 3530: my ($host,$request,$response);
3531: $host = &absolute_url('',1);
1.711 albertel 3532:
3533: $form{'no_update_last_known'}=1;
1.895 albertel 3534: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 3535: if (%form) {
1.1447 raeburn 3536: $request=new HTTP::Request('POST',$host.$fn);
1.1272 droeschl 3537: $request->content(join('&',map {
3538: my $name = escape($_);
3539: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3540: ? join("&$name=", map {escape($_) } @{$form{$_}})
3541: : &escape($form{$_}) );
3542: } keys(%form)));
1.23 www 3543: } else {
1.1447 raeburn 3544: $request=new HTTP::Request('GET',$host.$fn);
1.23 www 3545: }
3546:
1.15 www 3547: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1345 raeburn 3548: my $lonhost = $perlvar{'lonHostID'};
1.1385 raeburn 3549: my $islocal;
3550: if (($env{'request.course.id'}) &&
3551: ($form{'grade_courseid'} eq $env{'request.course.id'}) &&
3552: ($form{'grade_username'} ne '') && ($form{'grade_domain'} ne '') &&
3553: ($form{'grade_symb'} ne '') &&
3554: (&Apache::lonnet::allowed('mgr',$env{'request.course.id'}.
3555: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')))) {
3556: $islocal = 1;
3557: }
1.1447 raeburn 3558: $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,
3559: '','','',$islocal);
1.1182 foxr 3560:
1.944 foxr 3561: if (wantarray) {
1.1345 raeburn 3562: return ($response->content, $response);
1.944 foxr 3563: } else {
1.1345 raeburn 3564: return $response->content;
1.942 foxr 3565: }
1.324 www 3566: }
3567:
3568: sub externalssi {
3569: my ($url)=@_;
3570: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 3571: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
1.954 raeburn 3572: if (wantarray) {
3573: return ($response->content, $response);
3574: } else {
3575: return $response->content;
3576: }
1.15 www 3577: }
1.254 www 3578:
1.1354 raeburn 3579:
3580: # If the local copy of a replicated resource is outdated, trigger a
3581: # connection from the homeserver to flush the delayed queue. If no update
3582: # happens, remove local copies of outdated resource (and corresponding
3583: # metadata file).
3584:
1.1352 raeburn 3585: sub remove_stale_resfile {
3586: my ($url) = @_;
1.1354 raeburn 3587: my $removed;
1.1352 raeburn 3588: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3589: my $audom = $1;
3590: my $auname = $2;
1.1353 raeburn 3591: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
1.1352 raeburn 3592: my $homeserver = &homeserver($auname,$audom);
3593: unless (($homeserver eq 'no_host') ||
3594: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3595: my $fname = &filelocation('',$url);
3596: if (-e $fname) {
3597: my $hostname = &hostname($homeserver);
3598: if ($hostname) {
1.1397 raeburn 3599: my $protocol = $protocol{$homeserver};
3600: $protocol = 'http' if ($protocol ne 'https');
1.1352 raeburn 3601: my $uri = &declutter($url);
3602: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3603: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3604: if ($response->is_success()) {
3605: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3606: my $locmodtime = (stat($fname))[9];
3607: if ($locmodtime < $remmodtime) {
1.1354 raeburn 3608: my $stale;
3609: my $answer = &reply('pong',$homeserver);
3610: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3611: sleep(0.2);
3612: $locmodtime = (stat($fname))[9];
3613: if ($locmodtime < $remmodtime) {
3614: my $posstransfer = $fname.'.in.transfer';
3615: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3616: $removed = 1;
3617: } else {
3618: $stale = 1;
3619: }
3620: } else {
3621: $removed = 1;
3622: }
3623: } else {
3624: $stale = 1;
3625: }
3626: if ($stale) {
1.1421 raeburn 3627: if (unlink($fname)) {
3628: if ($uri!~/\.meta$/) {
3629: if (-e $fname.'.meta') {
3630: unlink($fname.'.meta');
3631: }
3632: }
1.1422 raeburn 3633: my $unsubresult = &unsubscribe($fname);
3634: unless ($unsubresult eq 'ok') {
3635: &logthis("no unsub of $fname from $homeserver, reason: $unsubresult");
3636: }
1.1421 raeburn 3637: $removed = 1;
1.1354 raeburn 3638: }
1.1352 raeburn 3639: }
3640: }
3641: }
3642: }
3643: }
3644: }
3645: }
3646: }
1.1354 raeburn 3647: return $removed;
1.1352 raeburn 3648: }
3649:
1.492 albertel 3650: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3651:
3652: sub allowuploaded {
3653: my ($srcurl,$url)=@_;
3654: $url=&clutter(&declutter($url));
3655: my $dir=$url;
3656: $dir=~s/\/[^\/]+$//;
3657: my %httpref=();
3658: my $httpurl=&hreflocation('',$url);
3659: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 3660: &Apache::lonnet::appenv(\%httpref);
1.254 www 3661: }
1.477 raeburn 3662:
1.1193 raeburn 3663: #
3664: # Determine if the current user should be able to edit a particular resource,
3665: # when viewing in course context.
3666: # (a) When viewing resource used to determine if "Edit" item is included in
3667: # Functions.
3668: # (b) When displaying folder contents in course editor, used to determine if
3669: # "Edit" link will be displayed alongside resource.
3670: #
1.1196 raeburn 3671: # input: six args -- filename (decluttered), course number, course domain,
3672: # url, symb (if registered) and group (if this is a group
3673: # item -- e.g., bulletin board, group page etc.).
3674: # output: array of five scalars --
1.1193 raeburn 3675: # $cfile -- url for file editing if editable on current server
3676: # $home -- homeserver of resource (i.e., for author if published,
3677: # or course if uploaded.).
3678: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 3679: # $forceedit -- 1 if icon/link should be to go to edit mode
3680: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 3681: #
3682:
3683: sub can_edit_resource {
1.1194 raeburn 3684: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3685: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3686: #
3687: # For aboutme pages user can only edit his/her own.
3688: #
1.1199 raeburn 3689: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 3690: my ($sdom,$sname) = ($1,$2);
3691: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3692: $home = $env{'user.home'};
3693: $cfile = $resurl;
3694: if ($env{'form.forceedit'}) {
3695: $forceview = 1;
3696: } else {
3697: $forceedit = 1;
3698: }
3699: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3700: } else {
3701: return;
3702: }
3703: }
3704:
3705: if ($env{'request.course.id'}) {
3706: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3707: if ($group ne '') {
3708: # if this is a group homepage or group bulletin board, check group privs
3709: my $allowed = 0;
1.1197 raeburn 3710: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3711: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 3712: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 3713: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3714: $allowed = 1;
3715: }
1.1197 raeburn 3716: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3717: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3718: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 3719: $allowed = 1;
3720: }
3721: }
3722: if ($allowed) {
3723: $home=&homeserver($cnum,$cdom);
3724: if ($env{'form.forceedit'}) {
3725: $forceview = 1;
3726: } else {
3727: $forceedit = 1;
3728: }
3729: $cfile = $resurl;
3730: } else {
3731: return;
3732: }
3733: } else {
1.1208 raeburn 3734: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3735: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3736: return;
3737: }
3738: } elsif (!$crsedit) {
1.1194 raeburn 3739: #
3740: # No edit allowed where CC has switched to student role.
3741: #
3742: return;
3743: }
3744: }
3745: }
3746:
1.1193 raeburn 3747: if ($file ne '') {
3748: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 3749: if (&is_course_upload($file,$cnum,$cdom)) {
3750: $uploaded = 1;
3751: $incourse = 1;
1.1193 raeburn 3752: if ($file =~/\.(htm|html|css|js|txt)$/) {
3753: $cfile = &hreflocation('',$file);
1.1201 raeburn 3754: if ($env{'form.forceedit'}) {
3755: $forceview = 1;
3756: } else {
3757: $forceedit = 1;
3758: }
1.1194 raeburn 3759: }
3760: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3761: $incourse = 1;
3762: if ($env{'form.forceedit'}) {
3763: $forceview = 1;
3764: } else {
3765: $forceedit = 1;
3766: }
3767: $cfile = $resurl;
3768: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3769: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3770: $incourse = 1;
3771: if ($env{'form.forceedit'}) {
3772: $forceview = 1;
3773: } else {
3774: $forceedit = 1;
3775: }
3776: $cfile = $resurl;
1.1199 raeburn 3777: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 3778: $incourse = 1;
3779: $cfile = $resurl.'/smpedit';
1.1199 raeburn 3780: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 3781: $incourse = 1;
1.1199 raeburn 3782: if ($env{'form.forceedit'}) {
3783: $forceview = 1;
3784: } else {
3785: $forceedit = 1;
3786: }
3787: $cfile = $resurl;
1.1419 raeburn 3788: } elsif (($resurl =~ m{^/ext/}) && ($symb ne '')) {
3789: my ($map,$id,$res) = &decode_symb($symb);
3790: if ($map =~ /\.page$/) {
3791: $incourse = 1;
3792: if ($env{'form.forceedit'}) {
3793: $forceview = 1;
3794: $cfile = $map;
3795: } else {
3796: $forceedit = 1;
3797: $cfile = '/adm/wrapper'.$resurl;
3798: }
3799: }
1.1343 raeburn 3800: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3801: $incourse = 1;
3802: if ($env{'form.forceedit'}) {
3803: $forceview = 1;
3804: } else {
3805: $forceedit = 1;
3806: }
3807: $cfile = $resurl;
1.1208 raeburn 3808: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3809: $incourse = 1;
3810: if ($env{'form.forceedit'}) {
3811: $forceview = 1;
3812: } else {
3813: $forceedit = 1;
3814: }
3815: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 3816: }
3817: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3818: my $template = '/res/lib/templates/simpleproblem.problem';
3819: if (&is_on_map($template)) {
3820: $incourse = 1;
3821: $forceview = 1;
3822: $cfile = $template;
1.1193 raeburn 3823: }
1.1199 raeburn 3824: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1418 raeburn 3825: $incourse = 1;
3826: if ($env{'form.forceedit'}) {
3827: $forceview = 1;
3828: } else {
3829: $forceedit = 1;
3830: }
3831: $cfile = $resurl;
1.1343 raeburn 3832: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1298 raeburn 3833: $incourse = 1;
3834: if ($env{'form.forceedit'}) {
3835: $forceview = 1;
3836: } else {
3837: $forceedit = 1;
3838: }
3839: $cfile = $resurl;
1.1199 raeburn 3840: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3841: $incourse = 1;
3842: $forceview = 1;
3843: if ($symb) {
3844: my ($map,$id,$res)=&decode_symb($symb);
3845: $env{'request.symb'} = $symb;
3846: $cfile = &clutter($res);
3847: } else {
3848: $cfile = $env{'form.suppurl'};
1.1298 raeburn 3849: my $escfile = &unescape($cfile);
1.1343 raeburn 3850: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3851: $cfile = '/adm/wrapper'.$escfile;
3852: } else {
3853: $escfile =~ s{^http://}{};
3854: $cfile = &escape("/adm/wrapper/ext/$escfile");
3855: }
1.1199 raeburn 3856: }
1.1234 raeburn 3857: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3858: if ($env{'form.forceedit'}) {
3859: $forceview = 1;
3860: } else {
3861: $forceedit = 1;
3862: }
3863: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 3864: }
3865: }
1.1194 raeburn 3866: if ($uploaded || $incourse) {
3867: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 3868: } elsif ($file !~ m{/$}) {
1.1193 raeburn 3869: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3870: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3871: # Check that the user has permission to edit this resource
3872: my $setpriv = 1;
3873: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3874: if (defined($cfudom)) {
3875: $home=&homeserver($cfuname,$cfudom);
3876: $cfile=$file;
3877: }
3878: }
1.1194 raeburn 3879: if (($cfile ne '') && (!$incourse || $uploaded) &&
3880: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 3881: my @ids=¤t_machine_ids();
3882: unless (grep(/^\Q$home\E$/,@ids)) {
3883: $switchserver=1;
3884: }
3885: }
3886: }
1.1194 raeburn 3887: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 3888: }
3889:
3890: sub is_course_upload {
3891: my ($file,$cnum,$cdom) = @_;
3892: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3893: $uploadpath =~ s{^\/}{};
1.1201 raeburn 3894: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3895: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 3896: return 1;
3897: }
3898: return;
3899: }
3900:
1.1194 raeburn 3901: sub in_course {
1.1195 raeburn 3902: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3903: if ($hideprivileged) {
3904: my $skipuser;
1.1219 raeburn 3905: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3906: my @possdoms = ($cdom);
3907: if ($coursehash{'checkforpriv'}) {
3908: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3909: }
3910: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 3911: $skipuser = 1;
3912: if ($coursehash{'nothideprivileged'}) {
3913: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3914: my $user;
3915: if ($item =~ /:/) {
3916: $user = $item;
3917: } else {
3918: $user = join(':',split(/[\@]/,$item));
3919: }
3920: if ($user eq $uname.':'.$udom) {
3921: undef($skipuser);
3922: last;
3923: }
3924: }
3925: }
3926: if ($skipuser) {
3927: return 0;
3928: }
3929: }
3930: }
1.1194 raeburn 3931: $type ||= 'any';
3932: if (!defined($cdom) || !defined($cnum)) {
3933: my $cid = $env{'request.course.id'};
3934: $cdom = $env{'course.'.$cid.'.domain'};
3935: $cnum = $env{'course.'.$cid.'.num'};
3936: }
3937: my $typesref;
1.1195 raeburn 3938: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 3939: $typesref = ['active','previous','future'];
3940: } elsif ($type eq 'previous' || $type eq 'future') {
3941: $typesref = [$type];
3942: }
3943: my %roles = &get_my_roles($uname,$udom,'userroles',
3944: $typesref,undef,[$cdom]);
3945: my ($tmp) = keys(%roles);
3946: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3947: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3948: if (@course_roles > 0) {
3949: return 1;
3950: }
3951: return 0;
3952: }
3953:
1.478 albertel 3954: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 3955: # input: action, courseID, current domain, intended
1.637 raeburn 3956: # path to file, source of file, instruction to parse file for objects,
3957: # ref to hash for embedded objects,
3958: # ref to hash for codebase of java objects.
1.1095 raeburn 3959: # reference to scalar to accommodate mime type determined
3960: # from File::MMagic if $parser = parse.
1.637 raeburn 3961: #
1.485 raeburn 3962: # output: url to file (if action was uploaddoc),
3963: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 3964: #
1.478 albertel 3965: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3966: # course.
1.477 raeburn 3967: #
1.478 albertel 3968: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3969: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3970: # course's home server.
1.477 raeburn 3971: #
1.478 albertel 3972: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3973: # be copied from $source (current location) to
3974: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3975: # and will then be copied to
3976: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3977: # course's home server.
1.485 raeburn 3978: #
1.481 raeburn 3979: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 3980: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 3981: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3982: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3983: # in course's home server.
1.637 raeburn 3984: #
1.477 raeburn 3985:
3986: sub process_coursefile {
1.1095 raeburn 3987: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3988: $mimetype)=@_;
1.477 raeburn 3989: my $fetchresult;
1.638 albertel 3990: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 3991: if ($action eq 'propagate') {
1.638 albertel 3992: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3993: $home);
1.481 raeburn 3994: } else {
1.477 raeburn 3995: my $fpath = '';
3996: my $fname = $file;
1.478 albertel 3997: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 3998: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 3999: my $filepath = &build_filepath($fpath);
1.481 raeburn 4000: if ($action eq 'copy') {
4001: if ($source eq '') {
4002: $fetchresult = 'no source file';
4003: return $fetchresult;
4004: } else {
4005: my $destination = $filepath.'/'.$fname;
4006: rename($source,$destination);
4007: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4008: $home);
1.481 raeburn 4009: }
4010: } elsif ($action eq 'uploaddoc') {
1.1359 raeburn 4011: open(my $fh,'>',$filepath.'/'.$fname);
1.620 albertel 4012: print $fh $env{'form.'.$source};
1.481 raeburn 4013: close($fh);
1.637 raeburn 4014: if ($parser eq 'parse') {
1.1024 raeburn 4015: my $mm = new File::MMagic;
1.1095 raeburn 4016: my $type = $mm->checktype_filename($filepath.'/'.$fname);
4017: if ($type eq 'text/html') {
1.1024 raeburn 4018: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
4019: unless ($parse_result eq 'ok') {
4020: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
4021: }
1.637 raeburn 4022: }
1.1095 raeburn 4023: if (ref($mimetype)) {
4024: $$mimetype = $type;
4025: }
1.637 raeburn 4026: }
1.477 raeburn 4027: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4028: $home);
1.481 raeburn 4029: if ($fetchresult eq 'ok') {
4030: return '/uploaded/'.$fpath.'/'.$fname;
4031: } else {
4032: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4033: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 4034: return '/adm/notfound.html';
4035: }
1.477 raeburn 4036: }
4037: }
1.485 raeburn 4038: unless ( $fetchresult eq 'ok') {
1.477 raeburn 4039: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4040: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 4041: }
4042: return $fetchresult;
4043: }
4044:
1.637 raeburn 4045: sub build_filepath {
4046: my ($fpath) = @_;
4047: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
4048: unless ($fpath eq '') {
4049: my @parts=split('/',$fpath);
4050: foreach my $part (@parts) {
4051: $filepath.= '/'.$part;
4052: if ((-e $filepath)!=1) {
4053: mkdir($filepath,0777);
4054: }
4055: }
4056: }
4057: return $filepath;
4058: }
4059:
4060: sub store_edited_file {
1.638 albertel 4061: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 4062: my $file = $primary_url;
4063: $file =~ s#^/uploaded/$docudom/$docuname/##;
4064: my $fpath = '';
4065: my $fname = $file;
4066: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
4067: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
4068: my $filepath = &build_filepath($fpath);
1.1359 raeburn 4069: open(my $fh,'>',$filepath.'/'.$fname);
1.637 raeburn 4070: print $fh $content;
4071: close($fh);
1.638 albertel 4072: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 4073: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4074: $home);
1.637 raeburn 4075: if ($$fetchresult eq 'ok') {
4076: return '/uploaded/'.$fpath.'/'.$fname;
4077: } else {
1.638 albertel 4078: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
4079: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 4080: return '/adm/notfound.html';
4081: }
4082: }
4083:
1.531 albertel 4084: sub clean_filename {
1.831 albertel 4085: my ($fname,$args)=@_;
1.315 www 4086: # Replace Windows backslashes by forward slashes
1.257 www 4087: $fname=~s/\\/\//g;
1.831 albertel 4088: if (!$args->{'keep_path'}) {
4089: # Get rid of everything but the actual filename
4090: $fname=~s/^.*\/([^\/]+)$/$1/;
4091: }
1.315 www 4092: # Replace spaces by underscores
4093: $fname=~s/\s+/\_/g;
1.1406 raeburn 4094: # Transliterate non-ascii text to ascii
4095: my $lang = &Apache::lonlocal::current_language();
4096: $fname = &LONCAPA::transliterate::fname_to_ascii($fname,$lang);
1.315 www 4097: # Replace all other weird characters by nothing
1.831 albertel 4098: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 4099: # Replace all .\d. sequences with _\d. so they no longer look like version
4100: # numbers
4101: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.1443 raeburn 4102: # Replace three or more adjacent underscores with one for consistency
4103: # with loncfile::filename_check() so complete url can be extracted by
4104: # lonnet::decode_symb()
4105: $fname=~s/_{3,}/_/g;
1.531 albertel 4106: return $fname;
4107: }
1.1406 raeburn 4108:
1.1051 raeburn 4109: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
4110: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
4111: # image with the same aspect ratio as the original, but with dimensions which do
4112: # not exceed $resizewidth and $resizeheight.
4113:
1.984 neumanie 4114: sub resizeImage {
1.1051 raeburn 4115: my ($img_path,$resizewidth,$resizeheight) = @_;
4116: my $ima = Image::Magick->new;
4117: my $resized;
4118: if (-e $img_path) {
4119: $ima->Read($img_path);
4120: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
4121: my $width = $ima->Get('width');
4122: my $height = $ima->Get('height');
4123: if ($width > $resizewidth) {
4124: my $factor = $width/$resizewidth;
4125: my $newheight = $height/$factor;
4126: $ima->Scale(width=>$resizewidth,height=>$newheight);
4127: $resized = 1;
4128: }
4129: }
4130: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
4131: my $width = $ima->Get('width');
4132: my $height = $ima->Get('height');
4133: if ($height > $resizeheight) {
4134: my $factor = $height/$resizeheight;
4135: my $newwidth = $width/$factor;
4136: $ima->Scale(width=>$newwidth,height=>$resizeheight);
4137: $resized = 1;
4138: }
4139: }
4140: if ($resized) {
4141: $ima->Write($img_path);
4142: }
4143: }
4144: return;
1.977 amueller 4145: }
4146:
1.608 albertel 4147: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 4148: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 4149: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 4150: # $context - possible values: coursedoc, existingfile, overwrite,
1.1401 raeburn 4151: # canceloverwrite, scantron or ''.
1.1090 raeburn 4152: # if 'coursedoc': upload to the current course
4153: # if 'existingfile': write file to tmp/overwrites directory
4154: # if 'canceloverwrite': delete file written to tmp/overwrites directory
4155: # $context is passed as argument to &finishuserfileupload
1.686 albertel 4156: # $subdir - directory in userfile to store the file into
1.1401 raeburn 4157: # $parser - instruction to parse file for objects ($parser = parse) or
4158: # if context is 'scantron', $parser is hashref of csv column mapping
4159: # (e.g.,{ PaperID => 0, LastName => 1, FirstName => 2, ID => 3,
4160: # Section => 4, CODE => 5, FirstQuestion => 9 }).
1.858 raeburn 4161: # $allfiles - reference to hash for embedded objects
4162: # $codebase - reference to hash for codebase of java objects
4163: # $desuname - username for permanent storage of uploaded file
4164: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 4165: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
4166: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 4167: # $resizewidth - width (pixels) to which to resize uploaded image
4168: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 4169: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 4170: # from File::MMagic.
1.858 raeburn 4171: #
1.686 albertel 4172: # output: url of file in userspace, or error: <message>
4173: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 4174:
1.531 albertel 4175: sub userfileupload {
1.1090 raeburn 4176: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 4177: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 4178: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 4179: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 4180: $fname=&clean_filename($fname);
1.1090 raeburn 4181: # See if there is anything left
1.257 www 4182: unless ($fname) { return 'error: no uploaded file'; }
1.1406 raeburn 4183: # If filename now begins with a . prepend unix timestamp _ milliseconds
4184: if ($fname =~ /^\./) {
4185: my ($s,$usec) = &gettimeofday();
4186: while (length($usec) < 6) {
4187: $usec = '0'.$usec;
4188: }
4189: $fname = $s.'_'.substr($usec,0,3).$fname;
4190: }
1.1090 raeburn 4191: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
4192: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
4193: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
4194: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 4195: my $now = time;
1.1090 raeburn 4196: my $filepath;
1.1095 raeburn 4197: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 4198: $filepath = 'tmp/helprequests/'.$now;
4199: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
4200: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
4201: '_'.$env{'user.domain'}.'/pending';
4202: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
4203: my ($docuname,$docudom);
1.1350 raeburn 4204: if ($destudom =~ /^$match_domain$/) {
1.1090 raeburn 4205: $docudom = $destudom;
4206: } else {
4207: $docudom = $env{'user.domain'};
4208: }
1.1350 raeburn 4209: if ($destuname =~ /^$match_username$/) {
1.1090 raeburn 4210: $docuname = $destuname;
4211: } else {
4212: $docuname = $env{'user.name'};
4213: }
4214: if (exists($env{'form.group'})) {
4215: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4216: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4217: }
4218: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
4219: if ($context eq 'canceloverwrite') {
4220: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
4221: if (-e $tempfile) {
4222: my @info = stat($tempfile);
4223: if ($info[9] eq $env{'form.timestamp'}) {
4224: unlink($tempfile);
4225: }
4226: }
4227: return;
1.523 raeburn 4228: }
4229: }
1.1090 raeburn 4230: # Create the directory if not present
1.741 raeburn 4231: my @parts=split(/\//,$filepath);
4232: my $fullpath = $perlvar{'lonDaemons'};
4233: for (my $i=0;$i<@parts;$i++) {
4234: $fullpath .= '/'.$parts[$i];
4235: if ((-e $fullpath)!=1) {
4236: mkdir($fullpath,0777);
4237: }
4238: }
1.1359 raeburn 4239: open(my $fh,'>',$fullpath.'/'.$fname);
1.741 raeburn 4240: print $fh $env{'form.'.$formname};
4241: close($fh);
1.1090 raeburn 4242: if ($context eq 'existingfile') {
4243: my @info = stat($fullpath.'/'.$fname);
4244: return ($fullpath.'/'.$fname,$info[9]);
4245: } else {
4246: return $fullpath.'/'.$fname;
4247: }
1.523 raeburn 4248: }
1.995 raeburn 4249: if ($subdir eq 'scantron') {
4250: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 4251: } else {
1.995 raeburn 4252: $fname="$subdir/$fname";
4253: }
1.1090 raeburn 4254: if ($context eq 'coursedoc') {
1.638 albertel 4255: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4256: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 4257: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 4258: return &finishuserfileupload($docuname,$docudom,
4259: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 4260: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 4261: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 4262: } else {
1.1218 raeburn 4263: if ($env{'form.folder'}) {
4264: $fname=$env{'form.folder'}.'/'.$fname;
4265: }
1.638 albertel 4266: return &process_coursefile('uploaddoc',$docuname,$docudom,
4267: $fname,$formname,$parser,
1.1095 raeburn 4268: $allfiles,$codebase,$mimetype);
1.481 raeburn 4269: }
1.719 banghart 4270: } elsif (defined($destuname)) {
4271: my $docuname=$destuname;
4272: my $docudom=$destudom;
1.860 raeburn 4273: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4274: $parser,$allfiles,$codebase,
1.1051 raeburn 4275: $thumbwidth,$thumbheight,
1.1095 raeburn 4276: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4277: } else {
1.638 albertel 4278: my $docuname=$env{'user.name'};
4279: my $docudom=$env{'user.domain'};
1.1220 raeburn 4280: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 4281: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4282: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4283: }
1.860 raeburn 4284: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4285: $parser,$allfiles,$codebase,
1.1051 raeburn 4286: $thumbwidth,$thumbheight,
1.1095 raeburn 4287: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4288: }
1.271 www 4289: }
4290:
4291: sub finishuserfileupload {
1.860 raeburn 4292: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 4293: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 4294: my $path=$docudom.'/'.$docuname.'/';
1.258 www 4295: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 4296:
1.860 raeburn 4297: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 4298: $file=$fname;
4299: if ($fname=~m|/|) {
4300: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
4301: $path.=$fnamepath.'/';
4302: }
1.259 www 4303: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 4304: my $count;
4305: for ($count=4;$count<=$#parts;$count++) {
4306: $filepath.="/$parts[$count]";
4307: if ((-e $filepath)!=1) {
4308: mkdir($filepath,0777);
4309: }
4310: }
1.984 neumanie 4311:
1.258 www 4312: # Save the file
4313: {
1.1359 raeburn 4314: if (!open(FH,'>',$filepath.'/'.$file)) {
1.701 albertel 4315: &logthis('Failed to create '.$filepath.'/'.$file);
4316: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
4317: return '/adm/notfound.html';
4318: }
1.1090 raeburn 4319: if ($context eq 'overwrite') {
1.1117 foxr 4320: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 4321: my $target = $filepath.'/'.$file;
4322: if (-e $source) {
4323: my @info = stat($source);
4324: if ($info[9] eq $env{'form.timestamp'}) {
4325: unless (&File::Copy::move($source,$target)) {
4326: &logthis('Failed to overwrite '.$filepath.'/'.$file);
4327: return "Moving from $source failed";
4328: }
4329: } else {
4330: return "Temporary file: $source had unexpected date/time for last modification";
4331: }
4332: } else {
4333: return "Temporary file: $source missing";
4334: }
4335: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 4336: &logthis('Failed to write to '.$filepath.'/'.$file);
4337: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
4338: return '/adm/notfound.html';
4339: }
1.570 albertel 4340: close(FH);
1.1051 raeburn 4341: if ($resizewidth && $resizeheight) {
4342: my $mm = new File::MMagic;
4343: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
4344: if ($mime_type =~ m{^image/}) {
4345: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
4346: }
1.977 amueller 4347: }
1.258 www 4348: }
1.1152 raeburn 4349: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
4350: if (ref($mimetype)) {
4351: if ($$mimetype eq '') {
4352: my $mm = new File::MMagic;
4353: my $type = $mm->checktype_filename($filepath.'/'.$file);
4354: $$mimetype = $type;
4355: }
4356: }
4357: }
1.1401 raeburn 4358: if (($context ne 'scantron') && ($parser eq 'parse')) {
1.1152 raeburn 4359: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 4360: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
4361: $allfiles,$codebase);
4362: unless ($parse_result eq 'ok') {
4363: &logthis('Failed to parse '.$filepath.$file.
4364: ' for embedded media: '.$parse_result);
4365: }
1.637 raeburn 4366: }
1.1401 raeburn 4367: } elsif (($context eq 'scantron') && (ref($parser) eq 'HASH')) {
4368: my $format = $env{'form.scantron_format'};
4369: &bubblesheet_converter($docudom,$filepath.'/'.$file,$parser,$format);
1.637 raeburn 4370: }
1.860 raeburn 4371: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
4372: my $input = $filepath.'/'.$file;
4373: my $output = $filepath.'/'.'tn-'.$file;
4374: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1.1359 raeburn 4375: my @args = ('convert','-sample',$thumbsize,$input,$output);
4376: system({$args[0]} @args);
1.860 raeburn 4377: if (-e $filepath.'/'.'tn-'.$file) {
4378: $fetchthumb = 1;
4379: }
4380: }
1.858 raeburn 4381:
1.259 www 4382: # Notify homeserver to grep it
4383: #
1.984 neumanie 4384: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 4385: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 4386: if ($fetchresult eq 'ok') {
1.860 raeburn 4387: if ($fetchthumb) {
4388: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
4389: if ($thumbresult ne 'ok') {
4390: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
4391: $docuhome.': '.$thumbresult);
4392: }
4393: }
1.259 www 4394: #
1.258 www 4395: # Return the URL to it
1.494 albertel 4396: return '/uploaded/'.$path.$file;
1.263 www 4397: } else {
1.494 albertel 4398: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
4399: ': '.$fetchresult);
1.263 www 4400: return '/adm/notfound.html';
1.858 raeburn 4401: }
1.493 albertel 4402: }
4403:
1.637 raeburn 4404: sub extract_embedded_items {
1.961 raeburn 4405: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 4406: my @state = ();
1.1164 raeburn 4407: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 4408: my %javafiles = (
4409: codebase => '',
4410: code => '',
4411: archive => ''
4412: );
4413: my %mediafiles = (
4414: src => '',
4415: movie => '',
4416: );
1.648 raeburn 4417: my $p;
4418: if ($content) {
4419: $p = HTML::LCParser->new($content);
4420: } else {
1.961 raeburn 4421: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 4422: }
1.641 albertel 4423: while (my $t=$p->get_token()) {
1.640 albertel 4424: if ($t->[0] eq 'S') {
4425: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 4426: push(@state, $tagname);
1.648 raeburn 4427: if (lc($tagname) eq 'allow') {
4428: &add_filetype($allfiles,$attr->{'src'},'src');
4429: }
1.640 albertel 4430: if (lc($tagname) eq 'img') {
4431: &add_filetype($allfiles,$attr->{'src'},'src');
4432: }
1.886 albertel 4433: if (lc($tagname) eq 'a') {
1.1222 raeburn 4434: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 4435: &add_filetype($allfiles,$attr->{'href'},'href');
4436: }
1.886 albertel 4437: }
1.645 raeburn 4438: if (lc($tagname) eq 'script') {
1.1164 raeburn 4439: my $src;
1.645 raeburn 4440: if ($attr->{'archive'} =~ /\.jar$/i) {
4441: &add_filetype($allfiles,$attr->{'archive'},'archive');
4442: } else {
1.1164 raeburn 4443: if ($attr->{'src'} ne '') {
4444: $src = $attr->{'src'};
4445: &add_filetype($allfiles,$src,'src');
4446: }
4447: }
4448: my $text = $p->get_trimmed_text();
4449: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4450: my @swfargs = split(/,/,$1);
4451: foreach my $item (@swfargs) {
4452: $item =~ s/["']//g;
4453: $item =~ s/^\s+//;
4454: $item =~ s/\s+$//;
4455: }
4456: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4457: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4458: push(@{$related{$swfargs[0]}},$swfargs[2]);
4459: } else {
4460: $related{$swfargs[0]} = [$swfargs[2]];
4461: }
4462: }
1.645 raeburn 4463: }
4464: }
4465: if (lc($tagname) eq 'link') {
4466: if (lc($attr->{'rel'}) eq 'stylesheet') {
4467: &add_filetype($allfiles,$attr->{'href'},'href');
4468: }
4469: }
1.640 albertel 4470: if (lc($tagname) eq 'object' ||
4471: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4472: foreach my $item (keys(%javafiles)) {
4473: $javafiles{$item} = '';
4474: }
1.1164 raeburn 4475: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4476: $lastids{lc($tagname)} = $attr->{'id'};
4477: }
1.640 albertel 4478: }
4479: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4480: my $name = lc($attr->{'name'});
4481: foreach my $item (keys(%javafiles)) {
4482: if ($name eq $item) {
4483: $javafiles{$item} = $attr->{'value'};
4484: last;
4485: }
4486: }
1.1164 raeburn 4487: my $pathfrom;
1.640 albertel 4488: foreach my $item (keys(%mediafiles)) {
4489: if ($name eq $item) {
1.1164 raeburn 4490: $pathfrom = $attr->{'value'};
4491: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4492: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 4493: last;
4494: }
4495: }
1.1164 raeburn 4496: if ($name eq 'flashvars') {
4497: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4498: }
4499: if ($pathfrom ne '') {
4500: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4501: $pathfrom);
4502: }
1.640 albertel 4503: }
4504: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4505: foreach my $item (keys(%javafiles)) {
4506: if ($attr->{$item}) {
4507: $javafiles{$item} = $attr->{$item};
4508: last;
4509: }
4510: }
4511: foreach my $item (keys(%mediafiles)) {
4512: if ($attr->{$item}) {
4513: &add_filetype($allfiles,$attr->{$item},$item);
4514: last;
4515: }
4516: }
1.1164 raeburn 4517: if (lc($tagname) eq 'embed') {
4518: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4519: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4520: $attr->{'src'});
4521: }
4522: }
1.640 albertel 4523: }
1.1243 raeburn 4524: if (lc($tagname) eq 'iframe') {
4525: my $src = $attr->{'src'} ;
4526: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4527: &add_filetype($allfiles,$src,'src');
4528: } elsif ($src =~ m{^/}) {
4529: if ($env{'request.course.id'}) {
4530: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4531: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4532: my $url = &hreflocation('',$fullpath);
4533: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4534: my $relpath = $1;
4535: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4536: &add_filetype($allfiles,$1,'src');
4537: }
4538: }
4539: }
4540: }
4541: }
1.1164 raeburn 4542: if ($t->[4] =~ m{/>$}) {
1.1243 raeburn 4543: pop(@state);
1.1164 raeburn 4544: }
1.640 albertel 4545: } elsif ($t->[0] eq 'E') {
4546: my ($tagname) = ($t->[1]);
4547: if ($javafiles{'codebase'} ne '') {
4548: $javafiles{'codebase'} .= '/';
4549: }
4550: if (lc($tagname) eq 'applet' ||
4551: lc($tagname) eq 'object' ||
4552: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4553: ) {
4554: foreach my $item (keys(%javafiles)) {
4555: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4556: my $file=$javafiles{'codebase'}.$javafiles{$item};
4557: &add_filetype($allfiles,$file,$item);
4558: }
4559: }
4560: }
4561: pop @state;
4562: }
4563: }
1.1164 raeburn 4564: foreach my $id (sort(keys(%flashvars))) {
4565: if ($shockwave{$id} ne '') {
4566: my @pairs = split(/\&/,$flashvars{$id});
4567: foreach my $pair (@pairs) {
4568: my ($key,$value) = split(/\=/,$pair);
4569: if ($key eq 'thumb') {
4570: &add_filetype($allfiles,$value,$key);
4571: } elsif ($key eq 'content') {
4572: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4573: my ($ext) = ($value =~ /\.([^.]+)$/);
4574: if ($ext ne '') {
4575: &add_filetype($allfiles,$path.$value,$ext);
4576: }
4577: }
4578: }
4579: }
4580: }
1.637 raeburn 4581: return 'ok';
4582: }
4583:
1.639 albertel 4584: sub add_filetype {
4585: my ($allfiles,$file,$type)=@_;
4586: if (exists($allfiles->{$file})) {
4587: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4588: push(@{$allfiles->{$file}}, &escape($type));
4589: }
4590: } else {
4591: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 4592: }
4593: }
4594:
1.1164 raeburn 4595: sub embedded_dependency {
4596: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4597: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4598: if (($identifier ne '') &&
4599: (ref($related->{$identifier}) eq 'ARRAY') &&
4600: ($pathfrom ne '')) {
4601: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4602: foreach my $dep (@{$related->{$identifier}}) {
4603: &add_filetype($allfiles,$path.$dep,'object');
4604: }
4605: }
4606: }
4607: return;
4608: }
4609:
1.1401 raeburn 4610: sub bubblesheet_converter {
4611: my ($cdom,$fullpath,$config,$format) = @_;
4612: if ((&domain($cdom) ne '') &&
1.1403 raeburn 4613: ($fullpath =~ m{^\Q$perlvar{'lonDocRoot'}/userfiles/$cdom/\E$match_courseid/scantron_orig}) &&
1.1401 raeburn 4614: (-e $fullpath) && (ref($config) eq 'HASH') && ($format ne '')) {
1.1404 raeburn 4615: my (%csvcols,%csvoptions);
4616: if (ref($config->{'fields'}) eq 'HASH') {
4617: %csvcols = %{$config->{'fields'}};
4618: }
4619: if (ref($config->{'options'}) eq 'HASH') {
4620: %csvoptions = %{$config->{'options'}};
4621: }
1.1401 raeburn 4622: my %csvbynum = reverse(%csvcols);
4623: my %scantronconf = &get_scantron_config($format,$cdom);
4624: if (keys(%scantronconf)) {
4625: my %bynum = (
4626: $scantronconf{CODEstart} => 'CODEstart',
4627: $scantronconf{IDstart} => 'IDstart',
4628: $scantronconf{PaperID} => 'PaperID',
4629: $scantronconf{FirstName} => 'FirstName',
4630: $scantronconf{LastName} => 'LastName',
4631: $scantronconf{Qstart} => 'Qstart',
4632: );
4633: my @ordered;
4634: foreach my $item (sort { $a <=> $b } keys(%bynum)) {
1.1403 raeburn 4635: push(@ordered,$bynum{$item});
1.1401 raeburn 4636: }
4637: my %mapstart = (
4638: CODEstart => 'CODE',
4639: IDstart => 'ID',
4640: PaperID => 'PaperID',
4641: FirstName => 'FirstName',
4642: LastName => 'LastName',
4643: Qstart => 'FirstQuestion',
4644: );
4645: my %maplength = (
4646: CODEstart => 'CODElength',
4647: IDstart => 'IDlength',
4648: PaperID => 'PaperIDlength',
4649: FirstName => 'FirstNamelength',
4650: LastName => 'LastNamelength',
4651: );
4652: if (open(my $fh,'<',$fullpath)) {
4653: my $output;
1.1403 raeburn 4654: my %lettdig = &letter_to_digits();
4655: my %diglett = reverse(%lettdig);
4656: my $numletts = scalar(keys(%lettdig));
1.1404 raeburn 4657: my $num = 0;
1.1401 raeburn 4658: while (my $line=<$fh>) {
1.1404 raeburn 4659: $num ++;
4660: next if (($num == 1) && ($csvoptions{'hdr'} == 1));
1.1401 raeburn 4661: $line =~ s{[\r\n]+$}{};
4662: my %found;
1.1475 raeburn 4663: my @values = split(/,/,$line,-1);
1.1401 raeburn 4664: my ($qstart,$record);
4665: for (my $i=0; $i<@values; $i++) {
1.1403 raeburn 4666: if ((($qstart ne '') && ($i > $qstart)) ||
4667: ($csvbynum{$i} eq 'FirstQuestion')) {
4668: if ($values[$i] eq '') {
4669: $values[$i] = $scantronconf{'Qoff'};
4670: } elsif ($scantronconf{'Qon'} eq 'number') {
4671: if ($values[$i] =~ /^[A-Ja-j]$/) {
4672: $values[$i] = $lettdig{uc($values[$i])};
4673: }
4674: } elsif ($scantronconf{'Qon'} eq 'letter') {
4675: if ($values[$i] =~ /^[0-9]$/) {
4676: $values[$i] = $diglett{$values[$i]};
4677: }
4678: } else {
4679: if ($values[$i] =~ /^[0-9A-Ja-j]$/) {
4680: my $digit;
4681: if ($values[$i] =~ /^[A-Ja-j]$/) {
4682: $digit = $lettdig{uc($values[$i])}-1;
4683: if ($values[$i] eq 'J') {
4684: $digit += $numletts;
4685: }
4686: } elsif ($values[$i] =~ /^[0-9]$/) {
4687: $digit = $values[$i]-1;
4688: if ($values[$i] eq '0') {
4689: $digit += $numletts;
4690: }
4691: }
4692: my $qval='';
4693: for (my $j=0; $j<$scantronconf{'Qlength'}; $j++) {
4694: if ($j == $digit) {
4695: $qval .= $scantronconf{'Qon'};
4696: } else {
4697: $qval .= $scantronconf{'Qoff'};
4698: }
4699: }
4700: $values[$i] = $qval;
4701: }
4702: }
4703: if (length($values[$i]) > $scantronconf{'Qlength'}) {
4704: $values[$i] = substr($values[$i],0,$scantronconf{'Qlength'});
4705: }
4706: my $numblank = $scantronconf{'Qlength'} - length($values[$i]);
4707: if ($numblank > 0) {
4708: $values[$i] .= ($scantronconf{'Qoff'} x $numblank);
4709: }
1.1401 raeburn 4710: if ($csvbynum{$i} eq 'FirstQuestion') {
4711: $qstart = $i;
1.1403 raeburn 4712: $found{$csvbynum{$i}} = $values[$i];
1.1401 raeburn 4713: } else {
1.1403 raeburn 4714: $found{'FirstQuestion'} .= $values[$i];
4715: }
4716: } elsif (exists($csvbynum{$i})) {
1.1404 raeburn 4717: if ($csvoptions{'rem'}) {
4718: $values[$i] =~ s/^\s+//;
4719: }
4720: if (($csvbynum{$i} eq 'PaperID') && ($csvoptions{'pad'})) {
1.1403 raeburn 4721: while (length($values[$i]) < $scantronconf{$maplength{$csvbynum{$i}}}) {
4722: $values[$i] = '0'.$values[$i];
1.1401 raeburn 4723: }
4724: }
4725: $found{$csvbynum{$i}} = $values[$i];
4726: }
4727: }
4728: foreach my $item (@ordered) {
4729: my $currlength = 1+length($record);
4730: my $numspaces = $scantronconf{$item} - $currlength;
4731: if ($numspaces > 0) {
4732: $record .= (' ' x $numspaces);
4733: }
4734: if (($mapstart{$item} ne '') && (exists($found{$mapstart{$item}}))) {
4735: unless ($item eq 'Qstart') {
4736: if (length($found{$mapstart{$item}}) > $scantronconf{$maplength{$item}}) {
4737: $found{$mapstart{$item}} = substr($found{$mapstart{$item}},0,$scantronconf{$maplength{$item}});
4738: }
4739: }
4740: $record .= $found{$mapstart{$item}};
4741: }
4742: }
4743: $output .= "$record\n";
4744: }
4745: close($fh);
4746: if ($output) {
4747: if (open(my $fh,'>',$fullpath)) {
4748: print $fh $output;
4749: close($fh);
4750: }
4751: }
4752: }
4753: }
4754: return;
4755: }
4756: }
4757:
1.1403 raeburn 4758: sub letter_to_digits {
4759: my %lettdig = (
4760: A => 1,
4761: B => 2,
4762: C => 3,
4763: D => 4,
4764: E => 5,
4765: F => 6,
4766: G => 7,
4767: H => 8,
4768: I => 9,
4769: J => 0,
4770: );
4771: return %lettdig;
4772: }
4773:
1.1401 raeburn 4774: sub get_scantron_config {
4775: my ($which,$cdom) = @_;
4776: my @lines = &get_scantronformat_file($cdom);
4777: my %config;
4778: #FIXME probably should move to XML it has already gotten a bit much now
4779: foreach my $line (@lines) {
4780: my ($name,$descrip)=split(/:/,$line);
4781: if ($name ne $which ) { next; }
4782: chomp($line);
4783: my @config=split(/:/,$line);
4784: $config{'name'}=$config[0];
4785: $config{'description'}=$config[1];
4786: $config{'CODElocation'}=$config[2];
4787: $config{'CODEstart'}=$config[3];
4788: $config{'CODElength'}=$config[4];
4789: $config{'IDstart'}=$config[5];
4790: $config{'IDlength'}=$config[6];
4791: $config{'Qstart'}=$config[7];
4792: $config{'Qlength'}=$config[8];
4793: $config{'Qoff'}=$config[9];
4794: $config{'Qon'}=$config[10];
4795: $config{'PaperID'}=$config[11];
4796: $config{'PaperIDlength'}=$config[12];
4797: $config{'FirstName'}=$config[13];
4798: $config{'FirstNamelength'}=$config[14];
4799: $config{'LastName'}=$config[15];
4800: $config{'LastNamelength'}=$config[16];
4801: $config{'BubblesPerRow'}=$config[17];
4802: last;
4803: }
4804: return %config;
4805: }
4806:
4807: sub get_scantronformat_file {
4808: my ($cdom) = @_;
4809: if ($cdom eq '') {
4810: $cdom= $env{'course.'.$env{'request.course.id'}.'.domain'};
4811: }
4812: my %domconfig = &get_dom('configuration',['scantron'],$cdom);
4813: my $gottab = 0;
4814: my @lines;
4815: if (ref($domconfig{'scantron'}) eq 'HASH') {
4816: if ($domconfig{'scantron'}{'scantronformat'} ne '') {
4817: my $formatfile = &getfile($perlvar{'lonDocRoot'}.$domconfig{'scantron'}{'scantronformat'});
4818: if ($formatfile ne '-1') {
4819: @lines = split("\n",$formatfile,-1);
4820: $gottab = 1;
4821: }
4822: }
4823: }
4824: if (!$gottab) {
4825: my $confname = $cdom.'-domainconfig';
4826: my $default = $perlvar{'lonDocRoot'}.'/res/'.$cdom.'/'.$confname.'/default.tab';
4827: my $formatfile = &getfile($default);
4828: if ($formatfile ne '-1') {
4829: @lines = split("\n",$formatfile,-1);
4830: $gottab = 1;
4831: }
4832: }
4833: if (!$gottab) {
4834: my @domains = ¤t_machine_domains();
4835: if (grep(/^\Q$cdom\E$/,@domains)) {
4836: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/scantronformat.tab')) {
4837: @lines = <$fh>;
4838: close($fh);
1.1403 raeburn 4839: }
1.1401 raeburn 4840: } else {
4841: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/default_scantronformat.tab')) {
4842: @lines = <$fh>;
4843: close($fh);
4844: }
4845: }
4846: }
4847: return @lines;
4848: }
4849:
1.493 albertel 4850: sub removeuploadedurl {
1.984 neumanie 4851: my ($url)=@_;
4852: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 4853: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 4854: }
4855:
4856: sub removeuserfile {
4857: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 4858: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4859: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 4860: if ($result eq 'ok') {
1.798 raeburn 4861: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
4862: my $metafile = $fname.'.meta';
4863: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 4864: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 4865: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4866: my $sqlresult =
1.823 albertel 4867: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4868: 'portfolio_metadata',$group,
4869: 'delete');
1.798 raeburn 4870: }
4871: }
4872: return $result;
1.257 www 4873: }
1.15 www 4874:
1.530 albertel 4875: sub mkdiruserfile {
4876: my ($docuname,$docudom,$dir)=@_;
4877: my $home=&homeserver($docuname,$docudom);
4878: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
4879: }
4880:
1.531 albertel 4881: sub renameuserfile {
4882: my ($docuname,$docudom,$old,$new)=@_;
4883: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4884: my $result = &reply("renameuserfile:$docudom:$docuname:".
4885: &escape("$old").':'.&escape("$new"),$home);
4886: if ($result eq 'ok') {
4887: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
4888: my $oldmeta = $old.'.meta';
4889: my $newmeta = $new.'.meta';
4890: my $metaresult =
4891: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 4892: my $url = "/uploaded/$docudom/$docuname/$old";
4893: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4894: my $sqlresult =
1.823 albertel 4895: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4896: 'portfolio_metadata',$group,
4897: 'delete');
1.798 raeburn 4898: }
4899: }
4900: return $result;
1.531 albertel 4901: }
4902:
1.14 www 4903: # ------------------------------------------------------------------------- Log
4904:
4905: sub log {
4906: my ($dom,$nam,$hom,$what)=@_;
1.47 www 4907: return critical("log:$dom:$nam:$what",$hom);
1.157 www 4908: }
4909:
4910: # ------------------------------------------------------------------ Course Log
1.352 www 4911: #
4912: # This routine flushes several buffers of non-mission-critical nature
4913: #
1.157 www 4914:
4915: sub flushcourselogs {
1.352 www 4916: &logthis('Flushing log buffers');
4917: #
4918: # course logs
4919: # This is a log of all transactions in a course, which can be used
4920: # for data mining purposes
4921: #
4922: # It also collects the courseid database, which lists last transaction
4923: # times and course titles for all courseids
4924: #
4925: my %courseidbuffer=();
1.921 raeburn 4926: foreach my $crsid (keys(%courselogs)) {
1.352 www 4927: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 4928: &escape($courselogs{$crsid}),
4929: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 4930: delete $courselogs{$crsid};
4931: } else {
4932: &logthis('Failed to flush log buffer for '.$crsid);
4933: if (length($courselogs{$crsid})>40000) {
1.672 albertel 4934: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 4935: " exceeded maximum size, deleting.</font>");
4936: delete $courselogs{$crsid};
4937: }
1.352 www 4938: }
1.920 raeburn 4939: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 4940: 'description' => $coursedescrbuf{$crsid},
4941: 'inst_code' => $courseinstcodebuf{$crsid},
4942: 'type' => $coursetypebuf{$crsid},
4943: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 4944: };
1.191 harris41 4945: }
1.352 www 4946: #
4947: # Write course id database (reverse lookup) to homeserver of courses
4948: # Is used in pickcourse
4949: #
1.840 albertel 4950: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 4951: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 4952: $courseidbuffer{$crs_home},
4953: $crs_home,'timeonly');
1.352 www 4954: }
4955: #
4956: # File accesses
4957: # Writes to the dynamic metadata of resources to get hit counts, etc.
4958: #
1.449 matthew 4959: foreach my $entry (keys(%accesshash)) {
1.458 matthew 4960: if ($entry =~ /___count$/) {
4961: my ($dom,$name);
1.807 albertel 4962: ($dom,$name,undef)=
1.811 albertel 4963: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 4964: if (! defined($dom) || $dom eq '' ||
4965: ! defined($name) || $name eq '') {
1.620 albertel 4966: my $cid = $env{'request.course.id'};
1.1472 raeburn 4967: #
4968: # FIXME 11/29/2021
4969: # Typo in rev. 1.458 (2003/12/09)??
4970: # These should likely by $env{'course.'.$cid.'.domain'} and $env{'course.'.$cid.'.num'}
4971: #
4972: # While these ramain as $env{'request.'.$cid.'.domain'} and $env{'request.'.$cid.'.num'}
4973: # $dom and $name will always be null, so the &inc() call will default to storing this data
4974: # in a nohist_accesscount.db file for the user rather than the course.
4975: #
4976: # That said there is a lot of noise in the data being stored.
4977: # So counts for prtspool/ and adm/ etc. are recorded.
4978: #
4979: # A review of which items ending '___count' are written to %accesshash should likely be
4980: # made before deciding whether to set these to 'course.' instead of 'request.'
4981: #
4982: # Under the current scheme each user receives a nohist_accesscount.db file listing
4983: # accesses for things which are not published resources, regardless of course, and
4984: # there is not a nohist_accesscount.db file in a course, which might log accesses from
4985: # anyone in the course for things which are not published resources.
4986: #
4987: # For an author, nohist_accesscount.db ends up having records for other items
4988: # mixed up with the legitimate access counts for the author's published resources.
4989: #
1.620 albertel 4990: $dom = $env{'request.'.$cid.'.domain'};
4991: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 4992: }
1.450 matthew 4993: my $value = $accesshash{$entry};
4994: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4995: my %temphash=($url => $value);
1.449 matthew 4996: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4997: if ($result eq 'ok') {
4998: delete $accesshash{$entry};
4999: }
5000: } else {
1.811 albertel 5001: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 5002: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 5003: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 5004: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
5005: delete $accesshash{$entry};
5006: }
1.185 www 5007: }
1.191 harris41 5008: }
1.352 www 5009: #
5010: # Roles
5011: # Reverse lookup of user roles for course faculty/staff and co-authorship
5012: #
1.800 albertel 5013: foreach my $entry (keys(%userrolehash)) {
1.351 www 5014: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 5015: split(/\:/,$entry);
5016: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 5017: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 5018: $rudom,$runame) eq 'ok') {
5019: delete $userrolehash{$entry};
5020: }
5021: }
1.662 raeburn 5022: #
1.1334 raeburn 5023: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 5024: #
5025: my %domrolebuffer = ();
1.1000 raeburn 5026: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 5027: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 5028: if ($domrolebuffer{$rudom}) {
5029: $domrolebuffer{$rudom}.='&'.&escape($entry).
5030: '='.&escape($domainrolehash{$entry});
5031: } else {
5032: $domrolebuffer{$rudom}.=&escape($entry).
5033: '='.&escape($domainrolehash{$entry});
5034: }
5035: delete $domainrolehash{$entry};
5036: }
5037: foreach my $dom (keys(%domrolebuffer)) {
1.1324 raeburn 5038: my %servers;
5039: if (defined(&domain($dom,'primary'))) {
5040: my $primary=&domain($dom,'primary');
5041: my $hostname=&hostname($primary);
5042: $servers{$primary} = $hostname;
5043: } else {
5044: %servers = &get_servers($dom,'library');
5045: }
1.841 albertel 5046: foreach my $tryserver (keys(%servers)) {
1.1324 raeburn 5047: if (&reply('domroleput:'.$dom.':'.
5048: $domrolebuffer{$dom},$tryserver) eq 'ok') {
5049: last;
5050: } else {
1.841 albertel 5051: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
5052: }
1.662 raeburn 5053: }
5054: }
1.186 www 5055: $dumpcount++;
1.157 www 5056: }
5057:
5058: sub courselog {
5059: my $what=shift;
1.158 www 5060: $what=time.':'.$what;
1.620 albertel 5061: unless ($env{'request.course.id'}) { return ''; }
5062: $coursedombuf{$env{'request.course.id'}}=
5063: $env{'course.'.$env{'request.course.id'}.'.domain'};
5064: $coursenumbuf{$env{'request.course.id'}}=
5065: $env{'course.'.$env{'request.course.id'}.'.num'};
5066: $coursehombuf{$env{'request.course.id'}}=
5067: $env{'course.'.$env{'request.course.id'}.'.home'};
5068: $coursedescrbuf{$env{'request.course.id'}}=
5069: $env{'course.'.$env{'request.course.id'}.'.description'};
5070: $courseinstcodebuf{$env{'request.course.id'}}=
5071: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
5072: $courseownerbuf{$env{'request.course.id'}}=
5073: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 5074: $coursetypebuf{$env{'request.course.id'}}=
5075: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 5076: if (defined $courselogs{$env{'request.course.id'}}) {
5077: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 5078: } else {
1.620 albertel 5079: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 5080: }
1.620 albertel 5081: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 5082: &flushcourselogs();
5083: }
1.158 www 5084: }
5085:
5086: sub courseacclog {
5087: my $fnsymb=shift;
1.620 albertel 5088: unless ($env{'request.course.id'}) { return ''; }
5089: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 5090: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 5091: $what.=':POST';
1.583 matthew 5092: # FIXME: Probably ought to escape things....
1.800 albertel 5093: foreach my $key (keys(%env)) {
5094: if ($key=~/^form\.(.*)/) {
1.975 raeburn 5095: my $formitem = $1;
5096: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
5097: $what.=':'.$formitem.'='.$env{$key};
5098: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
1.1432 raeburn 5099: if ($formitem eq 'proctorpassword') {
1.1433 raeburn 5100: $what.=':'.$formitem.'=' . '*' x length($env{$key});
1.1432 raeburn 5101: } else {
5102: $what.=':'.$formitem.'='.$env{$key};
5103: }
1.975 raeburn 5104: }
1.158 www 5105: }
1.191 harris41 5106: }
1.583 matthew 5107: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
5108: # FIXME: We should not be depending on a form parameter that someone
5109: # editing lonsearchcat.pm might change in the future.
1.620 albertel 5110: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 5111: $what.= ':POST';
5112: # FIXME: Probably ought to escape things....
5113: foreach my $element ('courseexp','crsfulltext','crsrelated',
5114: 'crsdiscuss') {
1.620 albertel 5115: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 5116: }
5117: }
1.158 www 5118: }
5119: &courselog($what);
1.149 www 5120: }
5121:
1.185 www 5122: sub countacc {
5123: my $url=&declutter(shift);
1.458 matthew 5124: return if (! defined($url) || $url eq '');
1.620 albertel 5125: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 5126: #
5127: # Mark that this url was used in this course
5128: #
1.620 albertel 5129: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 5130: #
5131: # Increase the access count for this resource in this child process
5132: #
1.281 www 5133: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 5134: $accesshash{$key}++;
1.185 www 5135: }
1.349 www 5136:
1.361 www 5137: sub linklog {
5138: my ($from,$to)=@_;
5139: $from=&declutter($from);
5140: $to=&declutter($to);
5141: $accesshash{$from.'___'.$to.'___comefrom'}=1;
5142: $accesshash{$to.'___'.$from.'___goto'}=1;
5143: }
1.1160 www 5144:
5145: sub statslog {
5146: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
5147: if ($users<2) { return; }
5148: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
5149: 'course' => $env{'request.course.id'},
5150: 'sections' => '"all"',
5151: 'num_students' => $users,
5152: 'part' => $part,
5153: 'symb' => $symb,
5154: 'mean_tries' => $av_attempts,
5155: 'deg_of_diff' => $degdiff});
5156: foreach my $key (keys(%dynstore)) {
5157: $accesshash{$key}=$dynstore{$key};
5158: }
5159: }
1.361 www 5160:
1.349 www 5161: sub userrolelog {
5162: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 5163: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 5164: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5165: $userrolehash
5166: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 5167: =$tend.':'.$tstart;
1.662 raeburn 5168: }
1.1169 droeschl 5169: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 5170: $userrolehash
5171: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
5172: =$tend.':'.$tstart;
5173: }
1.1334 raeburn 5174: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 5175: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5176: $domainrolehash
5177: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
5178: = $tend.':'.$tstart;
5179: }
1.351 www 5180: }
5181:
1.957 raeburn 5182: sub courserolelog {
5183: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184 raeburn 5184: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
5185: my $cdom = $1;
5186: my $cnum = $2;
5187: my $sec = $3;
5188: my $namespace = 'rolelog';
5189: my %storehash = (
5190: role => $trole,
5191: start => $tstart,
5192: end => $tend,
5193: selfenroll => $selfenroll,
5194: context => $context,
5195: );
5196: if ($trole eq 'gr') {
5197: $namespace = 'groupslog';
5198: $storehash{'group'} = $sec;
5199: } else {
5200: $storehash{'section'} = $sec;
5201: }
1.1188 raeburn 5202: &write_log('course',$namespace,\%storehash,$delflag,$username,
5203: $domain,$cnum,$cdom);
1.1184 raeburn 5204: if (($trole ne 'st') || ($sec ne '')) {
5205: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 5206: }
5207: }
5208: return;
5209: }
5210:
1.1184 raeburn 5211: sub domainrolelog {
5212: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5213: if ($area =~ m{^/($match_domain)/$}) {
5214: my $cdom = $1;
5215: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
5216: my $namespace = 'rolelog';
5217: my %storehash = (
5218: role => $trole,
5219: start => $tstart,
5220: end => $tend,
5221: context => $context,
5222: );
1.1188 raeburn 5223: &write_log('domain',$namespace,\%storehash,$delflag,$username,
5224: $domain,$domconfiguser,$cdom);
1.1184 raeburn 5225: }
5226: return;
5227:
5228: }
5229:
5230: sub coauthorrolelog {
5231: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5232: if ($area =~ m{^/($match_domain)/($match_username)$}) {
5233: my $audom = $1;
5234: my $auname = $2;
5235: my $namespace = 'rolelog';
5236: my %storehash = (
5237: role => $trole,
5238: start => $tstart,
5239: end => $tend,
5240: context => $context,
5241: );
1.1188 raeburn 5242: &write_log('author',$namespace,\%storehash,$delflag,$username,
5243: $domain,$auname,$audom);
1.1184 raeburn 5244: }
5245: return;
5246: }
5247:
1.351 www 5248: sub get_course_adv_roles {
1.948 raeburn 5249: my ($cid,$codes) = @_;
1.620 albertel 5250: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 5251: my %coursehash=&coursedescription($cid);
1.988 raeburn 5252: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 5253: my %nothide=();
1.800 albertel 5254: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 5255: if ($user !~ /:/) {
5256: $nothide{join(':',split(/[\@]/,$user))}=1;
5257: } else {
5258: $nothide{$user}=1;
5259: }
1.470 www 5260: }
1.1219 raeburn 5261: my @possdoms = ($coursehash{'domain'});
5262: if ($coursehash{'checkforpriv'}) {
5263: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
5264: }
1.351 www 5265: my %returnhash=();
5266: my %dumphash=
5267: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
5268: my $now=time;
1.997 raeburn 5269: my %privileged;
1.1000 raeburn 5270: foreach my $entry (keys(%dumphash)) {
1.800 albertel 5271: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 5272: if (($tstart) && ($tstart<0)) { next; }
5273: if (($tend) && ($tend<$now)) { next; }
5274: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 5275: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 5276: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 5277: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 5278: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 5279: if ($role eq 'cr') { next; }
1.948 raeburn 5280: if ($codes) {
5281: if ($section) { $role .= ':'.$section; }
5282: if ($returnhash{$role}) {
5283: $returnhash{$role}.=','.$username.':'.$domain;
5284: } else {
5285: $returnhash{$role}=$username.':'.$domain;
5286: }
1.351 www 5287: } else {
1.988 raeburn 5288: my $key=&plaintext($role,$crstype);
1.973 bisitz 5289: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 5290: if ($returnhash{$key}) {
5291: $returnhash{$key}.=','.$username.':'.$domain;
5292: } else {
5293: $returnhash{$key}=$username.':'.$domain;
5294: }
1.351 www 5295: }
1.948 raeburn 5296: }
1.400 www 5297: return %returnhash;
5298: }
5299:
5300: sub get_my_roles {
1.937 raeburn 5301: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 5302: unless (defined($uname)) { $uname=$env{'user.name'}; }
5303: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 5304: my (%dumphash,%nothide);
1.1086 raeburn 5305: if ($context eq 'userroles') {
1.1166 raeburn 5306: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 5307: } else {
1.1219 raeburn 5308: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 5309: if ($hidepriv) {
5310: my %coursehash=&coursedescription($udom.'_'.$uname);
5311: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5312: if ($user !~ /:/) {
5313: $nothide{join(':',split(/[\@]/,$user))} = 1;
5314: } else {
5315: $nothide{$user} = 1;
5316: }
5317: }
5318: }
1.858 raeburn 5319: }
1.400 www 5320: my %returnhash=();
5321: my $now=time;
1.999 raeburn 5322: my %privileged;
1.800 albertel 5323: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 5324: my ($role,$tend,$tstart);
5325: if ($context eq 'userroles') {
1.1149 raeburn 5326: next if ($entry =~ /^rolesdef/);
1.867 raeburn 5327: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
5328: } else {
5329: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
5330: }
1.400 www 5331: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 5332: my $status = 'active';
1.939 raeburn 5333: if (($tend) && ($tend<=$now)) {
1.832 raeburn 5334: $status = 'previous';
5335: }
5336: if (($tstart) && ($now<$tstart)) {
5337: $status = 'future';
5338: }
5339: if (ref($types) eq 'ARRAY') {
5340: if (!grep(/^\Q$status\E$/,@{$types})) {
5341: next;
5342: }
5343: } else {
5344: if ($status ne 'active') {
5345: next;
5346: }
5347: }
1.867 raeburn 5348: my ($rolecode,$username,$domain,$section,$area);
5349: if ($context eq 'userroles') {
1.1186 raeburn 5350: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 5351: (undef,$domain,$username,$section) = split(/\//,$area);
5352: } else {
5353: ($role,$username,$domain,$section) = split(/\:/,$entry);
5354: }
1.832 raeburn 5355: if (ref($roledoms) eq 'ARRAY') {
5356: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
5357: next;
5358: }
5359: }
5360: if (ref($roles) eq 'ARRAY') {
5361: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 5362: if ($role =~ /^cr\//) {
5363: if (!grep(/^cr$/,@{$roles})) {
5364: next;
5365: }
1.1104 raeburn 5366: } elsif ($role =~ /^gr\//) {
5367: if (!grep(/^gr$/,@{$roles})) {
5368: next;
5369: }
1.922 raeburn 5370: } else {
5371: next;
5372: }
1.832 raeburn 5373: }
1.867 raeburn 5374: }
1.937 raeburn 5375: if ($hidepriv) {
1.1219 raeburn 5376: my @privroles = ('dc','su');
1.999 raeburn 5377: if ($context eq 'userroles') {
1.1219 raeburn 5378: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 5379: } else {
1.1219 raeburn 5380: my $possdoms = [$domain];
5381: if (ref($roledoms) eq 'ARRAY') {
5382: push(@{$possdoms},@{$roledoms});
1.999 raeburn 5383: }
1.1219 raeburn 5384: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 5385: if (!$nothide{$username.':'.$domain}) {
5386: next;
5387: }
5388: }
1.937 raeburn 5389: }
5390: }
1.933 raeburn 5391: if ($withsec) {
5392: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
5393: $tstart.':'.$tend;
5394: } else {
5395: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
5396: }
1.832 raeburn 5397: }
1.373 www 5398: return %returnhash;
1.399 www 5399: }
5400:
1.1333 raeburn 5401: sub get_all_adhocroles {
5402: my ($dom) = @_;
5403: my @roles_by_num = ();
5404: my %domdefaults = &get_domain_defaults($dom);
5405: my (%description,%access_in_dom,%access_info);
5406: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
5407: my $count = 0;
5408: my %domcurrent = %{$domdefaults{'adhocroles'}};
5409: my %ordered;
5410: foreach my $role (sort(keys(%domcurrent))) {
5411: my ($order,$desc,$access_in_dom);
5412: if (ref($domcurrent{$role}) eq 'HASH') {
5413: $order = $domcurrent{$role}{'order'};
5414: $desc = $domcurrent{$role}{'desc'};
5415: $access_in_dom{$role} = $domcurrent{$role}{'access'};
5416: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
5417: }
5418: if ($order eq '') {
5419: $order = $count;
5420: }
5421: $ordered{$order} = $role;
5422: if ($desc ne '') {
5423: $description{$role} = $desc;
5424: } else {
5425: $description{$role}= $role;
5426: }
5427: $count++;
5428: }
5429: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
5430: push(@roles_by_num,$ordered{$item});
5431: }
5432: }
5433: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
5434: }
5435:
1.1332 raeburn 5436: sub get_my_adhocroles {
1.1333 raeburn 5437: my ($cid,$checkreg) = @_;
5438: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
5439: if ($env{'request.course.id'} eq $cid) {
5440: $cdom = $env{'course.'.$cid.'.domain'};
5441: $cnum = $env{'course.'.$cid.'.num'};
5442: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
5443: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
5444: $cdom = $1;
5445: $cnum = $2;
5446: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
5447: $cdom,$cnum);
5448: }
5449: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
5450: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5451: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
5452: if ($rosterhash{$user} ne '') {
5453: my $type = (split(/:/,$rosterhash{$user}))[5];
5454: return ([],{}) if ($type eq 'auto');
5455: }
5456: }
5457: if (($cdom ne '') && ($cnum ne '')) {
1.1334 raeburn 5458: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1332 raeburn 5459: my $then=$env{'user.login.time'};
5460: my $update=$env{'user.update.time'};
1.1335 raeburn 5461: if (!$update) {
5462: $update = $then;
5463: }
5464: my @liveroles;
1.1334 raeburn 5465: foreach my $role ('dh','da') {
5466: if ($env{"user.role.$role./$cdom/"}) {
1.1335 raeburn 5467: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
1.1334 raeburn 5468: my $limit = $update;
5469: if ($env{'request.role'} eq "$role./$cdom/") {
5470: $limit = $then;
5471: }
1.1335 raeburn 5472: my $activerole = 1;
5473: if ($tstart && $tstart>$limit) { $activerole = 0; }
5474: if ($tend && $tend <$limit) { $activerole = 0; }
5475: if ($activerole) {
5476: push(@liveroles,$role);
5477: }
1.1334 raeburn 5478: }
1.1332 raeburn 5479: }
1.1335 raeburn 5480: if (@liveroles) {
1.1332 raeburn 5481: if (&homeserver($cnum,$cdom) ne 'no_host') {
1.1333 raeburn 5482: my ($accessref,$accessinfo,%access_in_dom);
5483: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
5484: if (ref($roles_by_num) eq 'ARRAY') {
5485: if (@{$roles_by_num}) {
1.1332 raeburn 5486: my %settings;
5487: if ($env{'request.course.id'} eq $cid) {
5488: foreach my $envkey (keys(%env)) {
5489: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
5490: $settings{$1} = $env{$envkey};
5491: }
5492: }
5493: } else {
5494: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
5495: }
5496: my %setincrs;
5497: if ($settings{'internal.adhocaccess'}) {
5498: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
5499: }
5500: my @statuses;
5501: if ($env{'environment.inststatus'}) {
5502: @statuses = split(/,/,$env{'environment.inststatus'});
5503: }
5504: my $user = $env{'user.name'}.':'.$env{'user.domain'};
1.1333 raeburn 5505: if (ref($accessref) eq 'HASH') {
5506: %access_in_dom = %{$accessref};
5507: }
5508: foreach my $role (@{$roles_by_num}) {
1.1332 raeburn 5509: my ($curraccess,@okstatus,@personnel);
5510: if ($setincrs{$role}) {
5511: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
5512: if ($curraccess eq 'status') {
5513: @okstatus = split(/\&/,$rest);
5514: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5515: @personnel = split(/\&/,$rest);
5516: }
5517: } else {
5518: $curraccess = $access_in_dom{$role};
1.1333 raeburn 5519: if (ref($accessinfo) eq 'HASH') {
5520: if ($curraccess eq 'status') {
5521: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5522: @okstatus = @{$accessinfo->{$role}};
5523: }
5524: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5525: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5526: @personnel = @{$accessinfo->{$role}};
5527: }
1.1332 raeburn 5528: }
5529: }
5530: }
5531: if ($curraccess eq 'none') {
5532: next;
5533: } elsif ($curraccess eq 'all') {
5534: push(@possroles,$role);
1.1336 raeburn 5535: } elsif ($curraccess eq 'dh') {
1.1335 raeburn 5536: if (grep(/^dh$/,@liveroles)) {
5537: push(@possroles,$role);
5538: } else {
5539: next;
5540: }
1.1336 raeburn 5541: } elsif ($curraccess eq 'da') {
1.1335 raeburn 5542: if (grep(/^da$/,@liveroles)) {
5543: push(@possroles,$role);
5544: } else {
5545: next;
5546: }
1.1332 raeburn 5547: } elsif ($curraccess eq 'status') {
5548: if (@okstatus) {
5549: if (!@statuses) {
5550: if (grep(/^default$/,@okstatus)) {
5551: push(@possroles,$role);
5552: }
5553: } else {
5554: foreach my $status (@okstatus) {
5555: if (grep(/^\Q$status\E$/,@statuses)) {
5556: push(@possroles,$role);
5557: last;
5558: }
5559: }
5560: }
5561: }
5562: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5563: if (grep(/^\Q$user\E$/,@personnel)) {
5564: if ($curraccess eq 'exc') {
5565: push(@possroles,$role);
5566: }
5567: } elsif ($curraccess eq 'inc') {
5568: push(@possroles,$role);
5569: }
5570: }
5571: }
5572: }
5573: }
5574: }
5575: }
5576: }
5577: }
1.1333 raeburn 5578: unless (ref($description) eq 'HASH') {
5579: if (ref($roles_by_num) eq 'ARRAY') {
5580: my %desc;
5581: map { $desc{$_} = $_; } (@{$roles_by_num});
5582: $description = \%desc;
5583: } else {
5584: $description = {};
5585: }
5586: }
5587: return (\@possroles,$description);
1.1332 raeburn 5588: }
5589:
1.399 www 5590: # ----------------------------------------------------- Frontpage Announcements
5591: #
5592: #
5593:
5594: sub postannounce {
5595: my ($server,$text)=@_;
1.844 albertel 5596: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 5597: unless ($text=~/\w/) { $text=''; }
5598: return &reply('setannounce:'.&escape($text),$server);
5599: }
5600:
5601: sub getannounce {
1.448 albertel 5602:
1.1359 raeburn 5603: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 5604: my $announcement='';
1.800 albertel 5605: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 5606: close($fh);
1.399 www 5607: if ($announcement=~/\w/) {
5608: return
5609: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 5610: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 5611: } else {
5612: return '';
5613: }
5614: } else {
5615: return '';
5616: }
1.351 www 5617: }
1.353 www 5618:
5619: # ---------------------------------------------------------- Course ID routines
5620: # Deal with domain's nohist_courseid.db files
5621: #
5622:
5623: sub courseidput {
1.921 raeburn 5624: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 5625: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 5626: my $outcome;
5627: if ($caller eq 'timeonly') {
5628: my $cids = '';
5629: foreach my $item (keys(%$storehash)) {
5630: $cids.=&escape($item).'&';
5631: }
5632: $cids=~s/\&$//;
5633: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
5634: $coursehome);
5635: } else {
5636: my $items = '';
5637: foreach my $item (keys(%$storehash)) {
5638: $items.= &escape($item).'='.
5639: &freeze_escape($$storehash{$item}).'&';
5640: }
5641: $items=~s/\&$//;
5642: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
5643: $coursehome);
1.918 raeburn 5644: }
5645: if ($outcome eq 'unknown_cmd') {
5646: my $what;
5647: foreach my $cid (keys(%$storehash)) {
5648: $what .= &escape($cid).'=';
1.921 raeburn 5649: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 5650: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 5651: }
5652: $what =~ s/\:$/&/;
5653: }
5654: $what =~ s/\&$//;
5655: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
5656: } else {
5657: return $outcome;
5658: }
1.353 www 5659: }
5660:
5661: sub courseiddump {
1.921 raeburn 5662: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 5663: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 5664: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247 raeburn 5665: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287 raeburn 5666: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 5667: my $as_hash = 1;
5668: my %returnhash;
5669: if (!$domfilter) { $domfilter=''; }
1.845 albertel 5670: my %libserv = &all_library();
5671: foreach my $tryserver (keys(%libserv)) {
5672: if ( ( $hostidflag == 1
5673: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
5674: || (!defined($hostidflag)) ) {
5675:
1.918 raeburn 5676: if (($domfilter eq '') ||
5677: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 5678: my $rep;
5679: if (grep { $_ eq $tryserver } current_machine_ids()) {
5680: $rep = LONCAPA::Lond::dump_course_id_handler(
5681: join(":", (&host_domain($tryserver), $sincefilter,
5682: &escape($descfilter), &escape($instcodefilter),
5683: &escape($ownerfilter), &escape($coursefilter),
5684: &escape($typefilter), &escape($regexp_ok),
5685: $as_hash, &escape($selfenrollonly),
5686: &escape($catfilter), $showhidden, $caller,
5687: &escape($cloner), &escape($cc_clone), $cloneonly,
5688: &escape($createdbefore), &escape($createdafter),
1.1287 raeburn 5689: &escape($creationcontext),$domcloner,$hasuniquecode,
5690: $reqcrsdom,&escape($reqinstcode))));
1.1180 droeschl 5691: } else {
5692: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5693: $sincefilter.':'.&escape($descfilter).':'.
5694: &escape($instcodefilter).':'.&escape($ownerfilter).
5695: ':'.&escape($coursefilter).':'.&escape($typefilter).
5696: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5697: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5698: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5699: &escape($cc_clone).':'.$cloneonly.':'.
5700: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287 raeburn 5701: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5702: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180 droeschl 5703: }
5704:
1.918 raeburn 5705: my @pairs=split(/\&/,$rep);
5706: foreach my $item (@pairs) {
5707: my ($key,$value)=split(/\=/,$item,2);
5708: $key = &unescape($key);
5709: next if ($key =~ /^error: 2 /);
5710: my $result = &thaw_unescape($value);
5711: if (ref($result) eq 'HASH') {
5712: $returnhash{$key}=$result;
5713: } else {
1.921 raeburn 5714: my @responses = split(/:/,$value);
5715: my @items = ('description','inst_code','owner','type');
1.918 raeburn 5716: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 5717: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 5718: }
1.1008 raeburn 5719: }
1.353 www 5720: }
5721: }
5722: }
5723: }
5724: return %returnhash;
5725: }
5726:
1.1055 raeburn 5727: sub courselastaccess {
5728: my ($cdom,$cnum,$hostidref) = @_;
5729: my %returnhash;
5730: if ($cdom && $cnum) {
5731: my $chome = &homeserver($cnum,$cdom);
5732: if ($chome ne 'no_host') {
5733: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5734: &extract_lastaccess(\%returnhash,$rep);
5735: }
5736: } else {
5737: if (!$cdom) { $cdom=''; }
5738: my %libserv = &all_library();
5739: foreach my $tryserver (keys(%libserv)) {
5740: if (ref($hostidref) eq 'ARRAY') {
5741: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5742: }
5743: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5744: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5745: &extract_lastaccess(\%returnhash,$rep);
5746: }
5747: }
5748: }
5749: return %returnhash;
5750: }
5751:
5752: sub extract_lastaccess {
5753: my ($returnhash,$rep) = @_;
5754: if (ref($returnhash) eq 'HASH') {
5755: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5756: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5757: $rep eq '') {
5758: my @pairs=split(/\&/,$rep);
5759: foreach my $item (@pairs) {
5760: my ($key,$value)=split(/\=/,$item,2);
5761: $key = &unescape($key);
5762: next if ($key =~ /^error: 2 /);
5763: $returnhash->{$key} = &thaw_unescape($value);
5764: }
5765: }
5766: }
5767: return;
5768: }
5769:
1.658 raeburn 5770: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 5771:
5772: sub dcmailput {
1.685 raeburn 5773: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 5774: my $status = &Apache::lonnet::critical(
1.740 www 5775: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5776: &escape($message),$server);
1.662 raeburn 5777: return $status;
5778: }
5779:
1.658 raeburn 5780: sub dcmaildump {
5781: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 5782: my %returnhash=();
1.846 albertel 5783:
5784: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 5785: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5786: &escape($enddate).':';
5787: my @esc_senders=map { &escape($_)} @$senders;
5788: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 5789: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 5790: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 5791: if (($key) && ($value)) {
5792: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 5793: }
5794: }
5795: }
5796: return %returnhash;
5797: }
1.662 raeburn 5798: # ---------------------------------------------------------- Domain roles
5799:
5800: sub get_domain_roles {
5801: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 5802: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 5803: $startdate = '.';
5804: }
1.1018 raeburn 5805: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 5806: $enddate = '.';
5807: }
1.922 raeburn 5808: my $rolelist;
5809: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 5810: $rolelist = join('&',@{$roles});
1.922 raeburn 5811: }
1.662 raeburn 5812: my %personnel = ();
1.841 albertel 5813:
5814: my %servers = &get_servers($dom,'library');
5815: foreach my $tryserver (keys(%servers)) {
5816: %{$personnel{$tryserver}}=();
5817: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5818: &escape($startdate).':'.
5819: &escape($enddate).':'.
5820: &escape($rolelist), $tryserver))) {
5821: my ($key,$value) = split(/\=/,$line,2);
5822: if (($key) && ($value)) {
5823: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5824: }
5825: }
1.662 raeburn 5826: }
5827: return %personnel;
5828: }
1.658 raeburn 5829:
1.1332 raeburn 5830: sub get_active_domroles {
5831: my ($dom,$roles) = @_;
5832: return () unless (ref($roles) eq 'ARRAY');
5833: my $now = time;
5834: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
5835: my %domroles;
5836: foreach my $server (keys(%dompersonnel)) {
5837: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
5838: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
5839: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
5840: }
5841: }
5842: return %domroles;
5843: }
5844:
1.1057 www 5845: # ----------------------------------------------------------- Interval timing
1.149 www 5846:
1.1153 www 5847: {
5848: # Caches needed for speedup of navmaps
5849: # We don't want to cache this for very long at all (5 seconds at most)
5850: #
5851: # The user for whom we cache
5852: my $cachedkey='';
5853: # The cached times for this user
5854: my %cachedtimes=();
5855: # When this was last done
1.1282 raeburn 5856: my $cachedtime='';
1.1153 www 5857:
5858: sub load_all_first_access {
1.1308 raeburn 5859: my ($uname,$udom,$ignorecache)=@_;
1.1156 www 5860: if (($cachedkey eq $uname.':'.$udom) &&
1.1308 raeburn 5861: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
5862: (!$ignorecache)) {
1.1154 raeburn 5863: return;
5864: }
5865: $cachedtime=time;
5866: $cachedkey=$uname.':'.$udom;
5867: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 5868: }
5869:
1.504 albertel 5870: sub get_first_access {
1.1308 raeburn 5871: my ($type,$argsymb,$argmap,$ignorecache)=@_;
1.790 albertel 5872: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5873: if ($argsymb) { $symb=$argsymb; }
5874: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 5875: if ($argmap) { $map = $argmap; }
1.926 albertel 5876: if ($type eq 'course') {
5877: $res='course';
5878: } elsif ($type eq 'map') {
1.588 albertel 5879: $res=&symbread($map);
5880: } else {
5881: $res=$symb;
5882: }
1.1308 raeburn 5883: &load_all_first_access($uname,$udom,$ignorecache);
1.1153 www 5884: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 5885: }
5886:
5887: sub set_first_access {
1.1162 raeburn 5888: my ($type,$interval)=@_;
1.790 albertel 5889: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5890: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 5891: if ($type eq 'course') {
5892: $res='course';
5893: } elsif ($type eq 'map') {
1.588 albertel 5894: $res=&symbread($map);
5895: } else {
5896: $res=$symb;
5897: }
1.1153 www 5898: $cachedkey='';
1.1162 raeburn 5899: my $firstaccess=&get_first_access($type,$symb,$map);
1.1386 raeburn 5900: if ($firstaccess) {
5901: &logthis("First access time already set ($firstaccess) when attempting ".
1.1393 raeburn 5902: "to set new value (type: $type, extent: $res) for $uname:$udom ".
5903: "in $courseid");
1.1386 raeburn 5904: return 'already_set';
5905: } else {
1.1162 raeburn 5906: my $start = time;
5907: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
5908: $udom,$uname);
5909: if ($putres eq 'ok') {
5910: &put('timerinterval',{"$courseid\0$res"=>$interval},
5911: $udom,$uname);
5912: &appenv(
5913: {
5914: 'course.'.$courseid.'.firstaccess.'.$res => $start,
5915: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
5916: }
5917: );
1.1365 raeburn 5918: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
5919: $cachedtimes{"$courseid\0$res"} = $start;
5920: }
1.1386 raeburn 5921: } elsif ($putres ne 'refused') {
5922: &logthis("Result: $putres when attempting to set first access time ".
5923: "(type: $type, extent: $res) for $uname:$udom in $courseid");
1.1162 raeburn 5924: }
5925: return $putres;
1.505 albertel 5926: }
5927: return 'already_set';
1.504 albertel 5928: }
1.1153 www 5929: }
1.1282 raeburn 5930:
1.110 www 5931: # --------------------------------------------- Set Expire Date for Spreadsheet
5932:
5933: sub expirespread {
5934: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 5935: my $cid=$env{'request.course.id'};
1.110 www 5936: if ($cid) {
5937: my $now=time;
5938: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 5939: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
5940: $env{'course.'.$cid.'.num'}.
1.110 www 5941: ':nohist_expirationdates:'.
5942: &escape($key).'='.$now,
1.620 albertel 5943: $env{'course.'.$cid.'.home'})
1.110 www 5944: }
5945: return 'ok';
1.14 www 5946: }
5947:
1.109 www 5948: # ----------------------------------------------------- Devalidate Spreadsheets
5949:
5950: sub devalidate {
1.325 www 5951: my ($symb,$uname,$udom)=@_;
1.620 albertel 5952: my $cid=$env{'request.course.id'};
1.109 www 5953: if ($cid) {
1.391 matthew 5954: # delete the stored spreadsheets for
5955: # - the student level sheet of this user in course's homespace
5956: # - the assessment level sheet for this resource
5957: # for this user in user's homespace
1.553 albertel 5958: # - current conditional state info
1.325 www 5959: my $key=$uname.':'.$udom.':';
1.109 www 5960: my $status=
1.299 matthew 5961: &del('nohist_calculatedsheets',
1.391 matthew 5962: [$key.'studentcalc:'],
1.620 albertel 5963: $env{'course.'.$cid.'.domain'},
5964: $env{'course.'.$cid.'.num'})
1.133 albertel 5965: .' '.
5966: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 5967: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 5968: unless ($status eq 'ok ok') {
5969: &logthis('Could not devalidate spreadsheet '.
1.325 www 5970: $uname.' at '.$udom.' for '.
1.109 www 5971: $symb.': '.$status);
1.133 albertel 5972: }
1.553 albertel 5973: &delenv('user.state.'.$cid);
1.109 www 5974: }
5975: }
5976:
1.265 albertel 5977: sub get_scalar {
5978: my ($string,$end) = @_;
5979: my $value;
5980: if ($$string =~ s/^([^&]*?)($end)/$2/) {
5981: $value = $1;
5982: } elsif ($$string =~ s/^([^&]*?)&//) {
5983: $value = $1;
5984: }
5985: return &unescape($value);
5986: }
5987:
5988: sub array2str {
5989: my (@array) = @_;
5990: my $result=&arrayref2str(\@array);
5991: $result=~s/^__ARRAY_REF__//;
5992: $result=~s/__END_ARRAY_REF__$//;
5993: return $result;
5994: }
5995:
1.204 albertel 5996: sub arrayref2str {
5997: my ($arrayref) = @_;
1.265 albertel 5998: my $result='__ARRAY_REF__';
1.204 albertel 5999: foreach my $elem (@$arrayref) {
1.265 albertel 6000: if(ref($elem) eq 'ARRAY') {
6001: $result.=&arrayref2str($elem).'&';
6002: } elsif(ref($elem) eq 'HASH') {
6003: $result.=&hashref2str($elem).'&';
6004: } elsif(ref($elem)) {
6005: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 6006: } else {
6007: $result.=&escape($elem).'&';
6008: }
6009: }
6010: $result=~s/\&$//;
1.265 albertel 6011: $result .= '__END_ARRAY_REF__';
1.204 albertel 6012: return $result;
6013: }
6014:
1.168 albertel 6015: sub hash2str {
1.204 albertel 6016: my (%hash) = @_;
6017: my $result=&hashref2str(\%hash);
1.265 albertel 6018: $result=~s/^__HASH_REF__//;
6019: $result=~s/__END_HASH_REF__$//;
1.204 albertel 6020: return $result;
6021: }
6022:
6023: sub hashref2str {
6024: my ($hashref)=@_;
1.265 albertel 6025: my $result='__HASH_REF__';
1.800 albertel 6026: foreach my $key (sort(keys(%$hashref))) {
6027: if (ref($key) eq 'ARRAY') {
6028: $result.=&arrayref2str($key).'=';
6029: } elsif (ref($key) eq 'HASH') {
6030: $result.=&hashref2str($key).'=';
6031: } elsif (ref($key)) {
1.265 albertel 6032: $result.='=';
1.800 albertel 6033: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 6034: } else {
1.1132 raeburn 6035: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 6036: }
6037:
1.800 albertel 6038: if(ref($hashref->{$key}) eq 'ARRAY') {
6039: $result.=&arrayref2str($hashref->{$key}).'&';
6040: } elsif(ref($hashref->{$key}) eq 'HASH') {
6041: $result.=&hashref2str($hashref->{$key}).'&';
6042: } elsif(ref($hashref->{$key})) {
1.265 albertel 6043: $result.='&';
1.800 albertel 6044: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 6045: } else {
1.800 albertel 6046: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 6047: }
6048: }
1.168 albertel 6049: $result=~s/\&$//;
1.265 albertel 6050: $result .= '__END_HASH_REF__';
1.168 albertel 6051: return $result;
6052: }
6053:
6054: sub str2hash {
1.265 albertel 6055: my ($string)=@_;
6056: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
6057: return %$hash;
6058: }
6059:
6060: sub str2hashref {
1.168 albertel 6061: my ($string) = @_;
1.265 albertel 6062:
6063: my %hash;
6064:
6065: if($string !~ /^__HASH_REF__/) {
6066: if (! ($string eq '' || !defined($string))) {
6067: $hash{'error'}='Not hash reference';
6068: }
6069: return (\%hash, $string);
6070: }
6071:
6072: $string =~ s/^__HASH_REF__//;
6073:
6074: while($string !~ /^__END_HASH_REF__/) {
6075: #key
6076: my $key='';
6077: if($string =~ /^__HASH_REF__/) {
6078: ($key, $string)=&str2hashref($string);
6079: if(defined($key->{'error'})) {
6080: $hash{'error'}='Bad data';
6081: return (\%hash, $string);
6082: }
6083: } elsif($string =~ /^__ARRAY_REF__/) {
6084: ($key, $string)=&str2arrayref($string);
6085: if($key->[0] eq 'Array reference error') {
6086: $hash{'error'}='Bad data';
6087: return (\%hash, $string);
6088: }
6089: } else {
6090: $string =~ s/^(.*?)=//;
1.267 albertel 6091: $key=&unescape($1);
1.265 albertel 6092: }
6093: $string =~ s/^=//;
6094:
6095: #value
6096: my $value='';
6097: if($string =~ /^__HASH_REF__/) {
6098: ($value, $string)=&str2hashref($string);
6099: if(defined($value->{'error'})) {
6100: $hash{'error'}='Bad data';
6101: return (\%hash, $string);
6102: }
6103: } elsif($string =~ /^__ARRAY_REF__/) {
6104: ($value, $string)=&str2arrayref($string);
6105: if($value->[0] eq 'Array reference error') {
6106: $hash{'error'}='Bad data';
6107: return (\%hash, $string);
6108: }
6109: } else {
6110: $value=&get_scalar(\$string,'__END_HASH_REF__');
6111: }
6112: $string =~ s/^&//;
6113:
6114: $hash{$key}=$value;
1.204 albertel 6115: }
1.265 albertel 6116:
6117: $string =~ s/^__END_HASH_REF__//;
6118:
6119: return (\%hash, $string);
1.204 albertel 6120: }
6121:
6122: sub str2array {
1.265 albertel 6123: my ($string)=@_;
6124: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
6125: return @$array;
6126: }
6127:
6128: sub str2arrayref {
1.204 albertel 6129: my ($string) = @_;
1.265 albertel 6130: my @array;
6131:
6132: if($string !~ /^__ARRAY_REF__/) {
6133: if (! ($string eq '' || !defined($string))) {
6134: $array[0]='Array reference error';
6135: }
6136: return (\@array, $string);
6137: }
6138:
6139: $string =~ s/^__ARRAY_REF__//;
6140:
6141: while($string !~ /^__END_ARRAY_REF__/) {
6142: my $value='';
6143: if($string =~ /^__HASH_REF__/) {
6144: ($value, $string)=&str2hashref($string);
6145: if(defined($value->{'error'})) {
6146: $array[0] ='Array reference error';
6147: return (\@array, $string);
6148: }
6149: } elsif($string =~ /^__ARRAY_REF__/) {
6150: ($value, $string)=&str2arrayref($string);
6151: if($value->[0] eq 'Array reference error') {
6152: $array[0] ='Array reference error';
6153: return (\@array, $string);
6154: }
6155: } else {
6156: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
6157: }
6158: $string =~ s/^&//;
6159:
6160: push(@array, $value);
1.191 harris41 6161: }
1.265 albertel 6162:
6163: $string =~ s/^__END_ARRAY_REF__//;
6164:
6165: return (\@array, $string);
1.168 albertel 6166: }
6167:
1.167 albertel 6168: # -------------------------------------------------------------------Temp Store
6169:
1.168 albertel 6170: sub tmpreset {
6171: my ($symb,$namespace,$domain,$stuname) = @_;
6172: if (!$symb) {
6173: $symb=&symbread();
1.620 albertel 6174: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6175: }
6176: $symb=escape($symb);
6177:
1.620 albertel 6178: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 6179: $namespace=~s/\//\_/g;
6180: $namespace=~s/\W//g;
6181:
1.620 albertel 6182: if (!$domain) { $domain=$env{'user.domain'}; }
6183: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6184: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6185: $stuname=&get_requestor_ip();
1.591 albertel 6186: }
1.1117 foxr 6187: my $path=LONCAPA::tempdir();
1.168 albertel 6188: my %hash;
6189: if (tie(%hash,'GDBM_File',
6190: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6191: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 6192: foreach my $key (keys(%hash)) {
1.180 albertel 6193: if ($key=~ /:$symb/) {
1.168 albertel 6194: delete($hash{$key});
6195: }
6196: }
6197: }
6198: }
6199:
1.167 albertel 6200: sub tmpstore {
1.168 albertel 6201: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
6202:
6203: if (!$symb) {
6204: $symb=&symbread();
1.620 albertel 6205: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6206: }
6207: $symb=escape($symb);
6208:
6209: if (!$namespace) {
6210: # I don't think we would ever want to store this for a course.
6211: # it seems this will only be used if we don't have a course.
1.620 albertel 6212: #$namespace=$env{'request.course.id'};
1.168 albertel 6213: #if (!$namespace) {
1.620 albertel 6214: $namespace=$env{'request.state'};
1.168 albertel 6215: #}
6216: }
6217: $namespace=~s/\//\_/g;
6218: $namespace=~s/\W//g;
1.620 albertel 6219: if (!$domain) { $domain=$env{'user.domain'}; }
6220: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6221: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6222: $stuname=&get_requestor_ip();
1.591 albertel 6223: }
1.168 albertel 6224: my $now=time;
6225: my %hash;
1.1117 foxr 6226: my $path=LONCAPA::tempdir();
1.168 albertel 6227: if (tie(%hash,'GDBM_File',
6228: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6229: &GDBM_WRCREAT(),0640)) {
1.168 albertel 6230: $hash{"version:$symb"}++;
6231: my $version=$hash{"version:$symb"};
6232: my $allkeys='';
6233: foreach my $key (keys(%$storehash)) {
6234: $allkeys.=$key.':';
1.591 albertel 6235: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 6236: }
6237: $hash{"$version:$symb:timestamp"}=$now;
6238: $allkeys.='timestamp';
6239: $hash{"$version:keys:$symb"}=$allkeys;
6240: if (untie(%hash)) {
6241: return 'ok';
6242: } else {
6243: return "error:$!";
6244: }
6245: } else {
6246: return "error:$!";
6247: }
6248: }
1.167 albertel 6249:
1.168 albertel 6250: # -----------------------------------------------------------------Temp Restore
1.167 albertel 6251:
1.168 albertel 6252: sub tmprestore {
6253: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 6254:
1.168 albertel 6255: if (!$symb) {
6256: $symb=&symbread();
1.620 albertel 6257: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6258: }
6259: $symb=escape($symb);
6260:
1.620 albertel 6261: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 6262:
1.620 albertel 6263: if (!$domain) { $domain=$env{'user.domain'}; }
6264: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6265: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6266: $stuname=&get_requestor_ip();
1.591 albertel 6267: }
1.168 albertel 6268: my %returnhash;
6269: $namespace=~s/\//\_/g;
6270: $namespace=~s/\W//g;
6271: my %hash;
1.1117 foxr 6272: my $path=LONCAPA::tempdir();
1.168 albertel 6273: if (tie(%hash,'GDBM_File',
6274: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6275: &GDBM_READER(),0640)) {
1.168 albertel 6276: my $version=$hash{"version:$symb"};
6277: $returnhash{'version'}=$version;
6278: my $scope;
6279: for ($scope=1;$scope<=$version;$scope++) {
6280: my $vkeys=$hash{"$scope:keys:$symb"};
6281: my @keys=split(/:/,$vkeys);
6282: my $key;
6283: $returnhash{"$scope:keys"}=$vkeys;
6284: foreach $key (@keys) {
1.591 albertel 6285: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6286: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 6287: }
6288: }
1.168 albertel 6289: if (!(untie(%hash))) {
6290: return "error:$!";
6291: }
6292: } else {
6293: return "error:$!";
6294: }
6295: return %returnhash;
1.167 albertel 6296: }
6297:
1.9 www 6298: # ----------------------------------------------------------------------- Store
6299:
6300: sub store {
1.1269 raeburn 6301: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6302: my $home='';
6303:
1.168 albertel 6304: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6305:
1.213 www 6306: $symb=&symbclean($symb);
1.122 albertel 6307: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6308:
1.620 albertel 6309: if (!$domain) { $domain=$env{'user.domain'}; }
6310: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6311:
6312: &devalidate($symb,$stuname,$domain);
1.109 www 6313:
6314: $symb=escape($symb);
1.187 www 6315: if (!$namespace) {
1.620 albertel 6316: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6317: return '';
6318: }
6319: }
1.620 albertel 6320: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6321:
1.1434 raeburn 6322: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6323: $$storehash{'host'}=$perlvar{'lonHostID'};
6324:
1.12 www 6325: my $namevalue='';
1.800 albertel 6326: foreach my $key (keys(%$storehash)) {
6327: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6328: }
1.12 www 6329: $namevalue=~s/\&$//;
1.187 www 6330: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269 raeburn 6331: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 6332: }
6333:
1.47 www 6334: # -------------------------------------------------------------- Critical Store
6335:
6336: sub cstore {
1.1269 raeburn 6337: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6338: my $home='';
6339:
1.168 albertel 6340: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6341:
1.213 www 6342: $symb=&symbclean($symb);
1.122 albertel 6343: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6344:
1.620 albertel 6345: if (!$domain) { $domain=$env{'user.domain'}; }
6346: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6347:
6348: &devalidate($symb,$stuname,$domain);
1.109 www 6349:
6350: $symb=escape($symb);
1.187 www 6351: if (!$namespace) {
1.620 albertel 6352: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6353: return '';
6354: }
6355: }
1.620 albertel 6356: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6357:
1.1434 raeburn 6358: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6359: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 6360:
1.47 www 6361: my $namevalue='';
1.800 albertel 6362: foreach my $key (keys(%$storehash)) {
6363: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6364: }
1.47 www 6365: $namevalue=~s/\&$//;
1.187 www 6366: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 6367: return critical
1.1269 raeburn 6368: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 6369: }
6370:
1.9 www 6371: # --------------------------------------------------------------------- Restore
6372:
6373: sub restore {
1.124 www 6374: my ($symb,$namespace,$domain,$stuname) = @_;
6375: my $home='';
6376:
1.168 albertel 6377: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6378:
1.122 albertel 6379: if (!$symb) {
1.1224 raeburn 6380: return if ($namespace eq 'courserequests');
6381: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 6382: } else {
1.1224 raeburn 6383: unless ($namespace eq 'courserequests') {
6384: $symb=&escape(&symbclean($symb));
6385: }
1.122 albertel 6386: }
1.188 www 6387: if (!$namespace) {
1.620 albertel 6388: unless ($namespace=$env{'request.course.id'}) {
1.188 www 6389: return '';
6390: }
6391: }
1.620 albertel 6392: if (!$domain) { $domain=$env{'user.domain'}; }
6393: if (!$stuname) { $stuname=$env{'user.name'}; }
6394: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 6395: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
6396:
1.12 www 6397: my %returnhash=();
1.800 albertel 6398: foreach my $line (split(/\&/,$answer)) {
6399: my ($name,$value)=split(/\=/,$line);
1.591 albertel 6400: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 6401: }
1.75 www 6402: my $version;
6403: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 6404: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
6405: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 6406: }
1.75 www 6407: }
1.13 www 6408: return %returnhash;
1.34 www 6409: }
6410:
6411: # ---------------------------------------------------------- Course Description
1.1118 foxr 6412: #
6413: #
1.34 www 6414:
6415: sub coursedescription {
1.731 albertel 6416: my ($courseid,$args)=@_;
1.34 www 6417: $courseid=~s/^\///;
1.49 www 6418: $courseid=~s/\_/\//g;
1.34 www 6419: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 6420: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 6421: my $normalid=$cdomain.'_'.$cnum;
6422: # need to always cache even if we get errors otherwise we keep
6423: # trying and trying and trying to get the course description.
6424: my %envhash=();
6425: my %returnhash=();
1.731 albertel 6426:
6427: my $expiretime=600;
6428: if ($env{'request.course.id'} eq $normalid) {
6429: $expiretime=120;
6430: }
6431:
6432: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
6433: if (!$args->{'freshen_cache'}
6434: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
6435: foreach my $key (keys(%env)) {
6436: next if ($key !~ /^\Q$prefix\E(.*)/);
6437: my ($setting) = $1;
6438: $returnhash{$setting} = $env{$key};
6439: }
6440: return %returnhash;
6441: }
6442:
1.1118 foxr 6443: # get the data again
6444:
1.731 albertel 6445: if (!$args->{'one_time'}) {
6446: $envhash{'course.'.$normalid.'.last_cache'}=time;
6447: }
1.811 albertel 6448:
1.34 www 6449: if ($chome ne 'no_host') {
1.302 albertel 6450: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 6451: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 6452: my $username = $env{'user.name'}; # Defult username
6453: if(defined $args->{'user'}) {
6454: $username = $args->{'user'};
6455: }
1.129 albertel 6456: $returnhash{'home'}= $chome;
6457: $returnhash{'domain'} = $cdomain;
6458: $returnhash{'num'} = $cnum;
1.741 raeburn 6459: if (!defined($returnhash{'type'})) {
6460: $returnhash{'type'} = 'Course';
6461: }
1.130 albertel 6462: while (my ($name,$value) = each %returnhash) {
1.53 www 6463: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 6464: }
1.270 www 6465: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 6466: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 6467: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 6468: $envhash{'course.'.$normalid.'.home'}=$chome;
6469: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
6470: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 6471: }
6472: }
1.731 albertel 6473: if (!$args->{'one_time'}) {
1.949 raeburn 6474: &appenv(\%envhash);
1.731 albertel 6475: }
1.302 albertel 6476: return %returnhash;
1.461 www 6477: }
6478:
1.1080 raeburn 6479: sub update_released_required {
6480: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
6481: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
6482: $cid = $env{'request.course.id'};
6483: $cdom = $env{'course.'.$cid.'.domain'};
6484: $cnum = $env{'course.'.$cid.'.num'};
6485: $chome = $env{'course.'.$cid.'.home'};
6486: }
6487: if ($needsrelease) {
6488: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
6489: my $needsupdate;
6490: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
6491: $needsupdate = 1;
6492: } else {
6493: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
6494: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
6495: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
6496: $needsupdate = 1;
6497: }
6498: }
6499: if ($needsupdate) {
6500: my %needshash = (
6501: 'internal.releaserequired' => $needsrelease,
6502: );
6503: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
6504: if ($putresult eq 'ok') {
6505: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
6506: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6507: if (ref($crsinfo{$cid}) eq 'HASH') {
6508: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
6509: &courseidput($cdom,\%crsinfo,$chome,'notime');
6510: }
6511: }
6512: }
6513: }
6514: return;
6515: }
6516:
1.461 www 6517: # -------------------------------------------------See if a user is privileged
6518:
6519: sub privileged {
1.1219 raeburn 6520: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 6521: my $now = time;
1.1219 raeburn 6522: my $roles;
6523: if (ref($possroles) eq 'ARRAY') {
6524: $roles = $possroles;
6525: } else {
6526: $roles = ['dc','su'];
6527: }
6528: if (ref($possdomains) eq 'ARRAY') {
6529: my %privileged = &privileged_by_domain($possdomains,$roles);
6530: foreach my $dom (@{$possdomains}) {
6531: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
6532: (ref($privileged{$dom}) eq 'HASH')) {
6533: foreach my $role (@{$roles}) {
6534: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6535: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
6536: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
6537: return 1 unless (($end && $end < $now) ||
6538: ($start && $start > $now));
6539: }
6540: }
6541: }
6542: }
6543: }
6544: } else {
6545: my %rolesdump = &dump("roles", $domain, $username) or return 0;
6546: my $now = time;
1.1170 droeschl 6547:
1.1275 musolffc 6548: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 6549: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 6550: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 6551: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 6552: or ($tstart && $tstart > $now);
1.1170 droeschl 6553: }
1.1219 raeburn 6554: }
6555: }
6556: return 0;
6557: }
1.1170 droeschl 6558:
1.1219 raeburn 6559: sub privileged_by_domain {
6560: my ($domains,$roles) = @_;
6561: my %privileged = ();
6562: my $cachetime = 60*60*24;
6563: my $now = time;
6564: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
6565: return %privileged;
6566: }
6567: foreach my $dom (@{$domains}) {
6568: next if (ref($privileged{$dom}) eq 'HASH');
6569: my $needroles;
6570: foreach my $role (@{$roles}) {
6571: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
6572: if (defined($cached)) {
6573: if (ref($result) eq 'HASH') {
6574: $privileged{$dom}{$role} = $result;
6575: }
6576: } else {
6577: $needroles = 1;
6578: }
6579: }
6580: if ($needroles) {
6581: my %dompersonnel = &get_domain_roles($dom,$roles);
6582: $privileged{$dom} = {};
6583: foreach my $server (keys(%dompersonnel)) {
6584: if (ref($dompersonnel{$server}) eq 'HASH') {
6585: foreach my $item (keys(%{$dompersonnel{$server}})) {
6586: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
6587: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
6588: next if ($end && $end < $now);
6589: $privileged{$dom}{$trole}{$uname.':'.$udom} =
6590: $dompersonnel{$server}{$item};
6591: }
6592: }
6593: }
6594: if (ref($privileged{$dom}) eq 'HASH') {
6595: foreach my $role (@{$roles}) {
6596: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6597: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
6598: } else {
6599: my %hash = ();
6600: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
6601: }
6602: }
6603: }
6604: }
6605: }
6606: return %privileged;
1.9 www 6607: }
1.1 albertel 6608:
1.103 harris41 6609: # -------------------------------------------------------- Get user privileges
1.11 www 6610:
6611: sub rolesinit {
1.1169 droeschl 6612: my ($domain, $username) = @_;
6613: my %userroles = ('user.login.time' => time);
6614: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
6615:
6616: # firstaccess and timerinterval are related to timed maps/resources.
6617: # also, blocking can be triggered by an activating timer
6618: # it's saved in the user's %env.
6619: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
6620: my %timerinterval = &dump('timerinterval', $domain, $username);
6621: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
6622: %timerintchk, %timerintenv);
6623:
1.1162 raeburn 6624: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 6625: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 6626: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
6627: }
1.1169 droeschl 6628:
1.1162 raeburn 6629: foreach my $key (keys(%timerinterval)) {
6630: my ($cid,$rest) = split(/\0/,$key);
6631: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
6632: }
1.1169 droeschl 6633:
1.11 www 6634: my %allroles=();
1.1162 raeburn 6635: my %allgroups=();
1.11 www 6636:
1.1274 raeburn 6637: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 6638: my $role = $rolesdump{$area};
6639: $area =~ s/\_\w\w$//;
6640:
6641: my ($trole, $tend, $tstart, $group_privs);
6642:
6643: if ($role =~ /^cr/) {
6644: # Custom role, defined by a user
6645: # e.g., user.role.cr/msu/smith/mynewrole
6646: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
6647: $trole = $1;
6648: ($tend, $tstart) = split('_', $2);
6649: } else {
6650: $trole = $role;
6651: }
6652: } elsif ($role =~ m|^gr/|) {
6653: # Role of member in a group, defined within a course/community
6654: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
6655: ($trole, $tend, $tstart) = split(/_/, $role);
6656: next if $tstart eq '-1';
6657: ($trole, $group_privs) = split(/\//, $trole);
6658: $group_privs = &unescape($group_privs);
6659: } else {
6660: # Just a normal role, defined in roles.tab
6661: ($trole, $tend, $tstart) = split(/_/,$role);
6662: }
6663:
6664: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
6665: $username);
6666: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
6667:
6668: # role expired or not available yet?
6669: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
6670: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
6671:
6672: next if $area eq '' or $trole eq '';
6673:
6674: my $spec = "$trole.$area";
6675: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
6676:
6677: if ($trole =~ /^cr\//) {
6678: # Custom role, defined by a user
6679: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6680: } elsif ($trole eq 'gr') {
6681: # Role of a member in a group, defined within a course/community
6682: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
6683: next;
6684: } else {
6685: # Normal role, defined in roles.tab
6686: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6687: }
6688:
6689: my $cid = $tdomain.'_'.$trest;
6690: unless ($firstaccchk{$cid}) {
6691: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6692: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6693: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6694: $coursetimerstarts{$cid}{$item};
6695: }
6696: }
6697: $firstaccchk{$cid} = 1;
6698: }
6699: unless ($timerintchk{$cid}) {
6700: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6701: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6702: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6703: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 6704: }
1.12 www 6705: }
1.1169 droeschl 6706: $timerintchk{$cid} = 1;
1.191 harris41 6707: }
1.11 www 6708: }
1.1169 droeschl 6709:
1.1341 raeburn 6710: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6711: \%allroles, \%allgroups);
1.1169 droeschl 6712: $env{'user.adv'} = $userroles{'user.adv'};
1.1341 raeburn 6713: $env{'user.rar'} = $userroles{'user.rar'};
1.1169 droeschl 6714:
1.1162 raeburn 6715: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 6716: }
6717:
1.567 raeburn 6718: sub set_arearole {
1.1215 raeburn 6719: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6720: unless ($nolog) {
1.567 raeburn 6721: # log the associated role with the area
1.1215 raeburn 6722: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6723: }
1.743 albertel 6724: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 6725: }
6726:
6727: sub custom_roleprivs {
6728: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6729: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250 raeburn 6730: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 6731: if (&hostname($homsvr) ne '') {
1.567 raeburn 6732: my ($rdummy,$roledef)=
6733: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6734: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6735: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6736: if (defined($syspriv)) {
1.1043 raeburn 6737: if ($trest =~ /^$match_community$/) {
6738: $syspriv =~ s/bre\&S//;
6739: }
1.567 raeburn 6740: $$allroles{'cm./'}.=':'.$syspriv;
6741: $$allroles{$spec.'./'}.=':'.$syspriv;
6742: }
6743: if ($tdomain ne '') {
6744: if (defined($dompriv)) {
6745: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6746: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6747: }
6748: if (($trest ne '') && (defined($coursepriv))) {
1.1332 raeburn 6749: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6750: my $rolename = $1;
6751: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6752: }
1.567 raeburn 6753: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6754: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6755: }
6756: }
6757: }
6758: }
6759: }
6760:
1.1332 raeburn 6761: sub course_adhocrole_privs {
6762: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6763: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6764: if ($overrides{"internal.adhocpriv.$rolename"}) {
6765: my (%currprivs,%storeprivs);
6766: foreach my $item (split(/:/,$coursepriv)) {
6767: my ($priv,$restrict) = split(/\&/,$item);
6768: $currprivs{$priv} = $restrict;
6769: }
6770: my (%possadd,%possremove,%full);
6771: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6772: my ($priv,$restrict)=split(/\&/,$item);
6773: $full{$priv} = $restrict;
6774: }
6775: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
6776: next if ($item eq '');
6777: my ($rule,$rest) = split(/=/,$item);
6778: next unless (($rule eq 'off') || ($rule eq 'on'));
6779: foreach my $priv (split(/:/,$rest)) {
6780: if ($priv ne '') {
6781: if ($rule eq 'off') {
6782: $possremove{$priv} = 1;
6783: } else {
6784: $possadd{$priv} = 1;
6785: }
6786: }
6787: }
6788: }
6789: foreach my $priv (sort(keys(%full))) {
6790: if (exists($currprivs{$priv})) {
6791: unless (exists($possremove{$priv})) {
6792: $storeprivs{$priv} = $currprivs{$priv};
6793: }
6794: } elsif (exists($possadd{$priv})) {
6795: $storeprivs{$priv} = $full{$priv};
6796: }
6797: }
6798: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6799: }
6800: return $coursepriv;
6801: }
6802:
1.678 raeburn 6803: sub group_roleprivs {
6804: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6805: my $access = 1;
6806: my $now = time;
6807: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6808: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6809: if ($access) {
1.811 albertel 6810: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 6811: $$allgroups{$course}{$group} .=':'.$group_privs;
6812: }
6813: }
1.567 raeburn 6814:
6815: sub standard_roleprivs {
6816: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6817: if (defined($pr{$trole.':s'})) {
6818: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6819: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6820: }
6821: if ($tdomain ne '') {
6822: if (defined($pr{$trole.':d'})) {
6823: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6824: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6825: }
6826: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6827: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6828: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
6829: }
6830: }
6831: }
6832:
6833: sub set_userprivs {
1.1064 raeburn 6834: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 6835: my $author=0;
6836: my $adv=0;
1.1341 raeburn 6837: my $rar=0;
1.678 raeburn 6838: my %grouproles = ();
6839: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 6840: my @groupkeys;
1.1000 raeburn 6841: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 6842: push(@groupkeys,$role);
6843: }
6844: if (ref($groups_roles) eq 'HASH') {
6845: foreach my $key (keys(%{$groups_roles})) {
6846: unless (grep(/^\Q$key\E$/,@groupkeys)) {
6847: push(@groupkeys,$key);
6848: }
6849: }
6850: }
6851: if (@groupkeys > 0) {
6852: foreach my $role (@groupkeys) {
6853: my ($trole,$area,$sec,$extendedarea);
6854: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
6855: $trole = $1;
6856: $area = $2;
6857: $sec = $3;
6858: $extendedarea = $area.$sec;
6859: if (exists($$allgroups{$area})) {
6860: foreach my $group (keys(%{$$allgroups{$area}})) {
6861: my $spec = $trole.'.'.$extendedarea;
6862: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 6863: $$allgroups{$area}{$group};
1.1064 raeburn 6864: }
1.678 raeburn 6865: }
6866: }
6867: }
6868: }
6869: }
1.800 albertel 6870: foreach my $group (keys(%grouproles)) {
6871: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 6872: }
1.800 albertel 6873: foreach my $role (keys(%{$allroles})) {
6874: my %thesepriv;
1.941 raeburn 6875: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 6876: foreach my $item (split(/:/,$$allroles{$role})) {
6877: if ($item ne '') {
6878: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 6879: if ($restrictions eq '') {
6880: $thesepriv{$privilege}='F';
6881: } elsif ($thesepriv{$privilege} ne 'F') {
6882: $thesepriv{$privilege}.=$restrictions;
6883: }
6884: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1341 raeburn 6885: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567 raeburn 6886: }
6887: }
6888: my $thesestr='';
1.1104 raeburn 6889: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 6890: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
6891: }
6892: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 6893: }
1.1341 raeburn 6894: return ($author,$adv,$rar);
1.567 raeburn 6895: }
6896:
1.994 raeburn 6897: sub role_status {
1.1104 raeburn 6898: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 6899: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250 raeburn 6900: my ($one,$two) = split(m{\./},$rolekey,2);
6901: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 6902: unless (!defined($$role) || $$role eq '') {
1.1251 raeburn 6903: $$where = '/'.$two;
1.994 raeburn 6904: $$trolecode=$$role.'.'.$$where;
6905: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
6906: $$tstatus='is';
1.1104 raeburn 6907: if ($$tstart && $$tstart>$update) {
1.994 raeburn 6908: $$tstatus='future';
1.1034 raeburn 6909: if ($$tstart<$now) {
6910: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 6911: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 6912: my (%allroles,%allgroups,$group_privs,
6913: %groups_roles,@rolecodes);
1.1002 raeburn 6914: my %userroles = (
6915: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
6916: );
1.1064 raeburn 6917: @rolecodes = ('cm');
1.1002 raeburn 6918: my $spec=$$role.'.'.$$where;
6919: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
6920: if ($$role =~ /^cr\//) {
6921: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 6922: push(@rolecodes,'cr');
1.1002 raeburn 6923: } elsif ($$role eq 'gr') {
1.1064 raeburn 6924: push(@rolecodes,$$role);
1.1002 raeburn 6925: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
6926: $env{'user.name'});
1.1064 raeburn 6927: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 6928: (undef,my $group_privs) = split(/\//,$trole);
6929: $group_privs = &unescape($group_privs);
6930: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 6931: 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 6932: &get_groups_roles($tdomain,$trest,
6933: \%course_roles,\@rolecodes,
6934: \%groups_roles);
1.1002 raeburn 6935: } else {
1.1064 raeburn 6936: push(@rolecodes,$$role);
1.1002 raeburn 6937: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
6938: }
1.1341 raeburn 6939: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
6940: \%groups_roles);
1.1064 raeburn 6941: &appenv(\%userroles,\@rolecodes);
1.1342 raeburn 6942: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002 raeburn 6943: }
6944: }
1.1034 raeburn 6945: $$tstatus = 'is';
1.1002 raeburn 6946: }
1.994 raeburn 6947: }
6948: if ($$tend) {
1.1104 raeburn 6949: if ($$tend<$update) {
1.994 raeburn 6950: $$tstatus='expired';
6951: } elsif ($$tend<$now) {
6952: $$tstatus='will_not';
6953: }
6954: }
6955: }
6956: }
6957: }
6958:
1.1104 raeburn 6959: sub get_groups_roles {
6960: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
6961: return unless((ref($cdom_courseroles) eq 'HASH') &&
6962: (ref($rolecodes) eq 'ARRAY') &&
6963: (ref($groups_roles) eq 'HASH'));
6964: if (keys(%{$cdom_courseroles}) > 0) {
6965: my ($cnum) = ($rest =~ /^($match_courseid)/);
6966: if ($cdom ne '' && $cnum ne '') {
6967: foreach my $key (keys(%{$cdom_courseroles})) {
6968: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
6969: my $crsrole = $1;
6970: my $crssec = $2;
6971: if ($crsrole =~ /^cr/) {
6972: unless (grep(/^cr$/,@{$rolecodes})) {
6973: push(@{$rolecodes},'cr');
6974: }
6975: } else {
6976: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
6977: push(@{$rolecodes},$crsrole);
6978: }
6979: }
6980: my $rolekey = "$crsrole./$cdom/$cnum";
6981: if ($crssec ne '') {
6982: $rolekey .= "/$crssec";
6983: }
6984: $rolekey .= './';
6985: $groups_roles->{$rolekey} = $rolecodes;
6986: }
6987: }
6988: }
6989: }
6990: return;
6991: }
6992:
6993: sub delete_env_groupprivs {
6994: my ($where,$courseroles,$possroles) = @_;
6995: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
6996: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
6997: unless (ref($courseroles->{$udom}) eq 'HASH') {
6998: %{$courseroles->{$udom}} =
6999: &get_my_roles('','','userroles',['active'],
7000: $possroles,[$udom],1);
7001: }
7002: if (ref($courseroles->{$udom}) eq 'HASH') {
7003: foreach my $item (keys(%{$courseroles->{$udom}})) {
7004: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
7005: my $area = '/'.$cdom.'/'.$cnum;
7006: my $privkey = "user.priv.$crsrole.$area";
7007: if ($crssec ne '') {
7008: $privkey .= '/'.$crssec;
7009: }
7010: $privkey .= ".$area/$group";
7011: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
7012: }
7013: }
7014: return;
7015: }
7016:
1.994 raeburn 7017: sub check_adhoc_privs {
1.1329 raeburn 7018: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 7019: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1329 raeburn 7020: if ($sec) {
7021: $cckey .= '/'.$sec;
7022: }
1.1185 raeburn 7023: my $setprivs;
1.994 raeburn 7024: if ($env{$cckey}) {
7025: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 7026: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 7027: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1329 raeburn 7028: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7029: $setprivs = 1;
1.994 raeburn 7030: }
7031: } else {
1.1330 raeburn 7032: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7033: $setprivs = 1;
1.994 raeburn 7034: }
1.1185 raeburn 7035: return $setprivs;
1.994 raeburn 7036: }
7037:
7038: sub set_adhoc_privileges {
1.1326 raeburn 7039: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1329 raeburn 7040: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 7041: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1329 raeburn 7042: if ($sec ne '') {
7043: $area .= '/'.$sec;
7044: }
1.994 raeburn 7045: my $spec = $role.'.'.$area;
7046: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 7047: $env{'user.name'},1);
1.1326 raeburn 7048: my %rolehash = ();
1.1332 raeburn 7049: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
7050: my $rolename = $1;
1.1326 raeburn 7051: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1332 raeburn 7052: my %domdef = &get_domain_defaults($dcdom);
7053: if (ref($domdef{'adhocroles'}) eq 'HASH') {
7054: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
7055: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
7056: }
7057: }
1.1326 raeburn 7058: } else {
7059: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
7060: }
1.1341 raeburn 7061: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 7062: &appenv(\%userroles,[$role,'cm']);
1.1342 raeburn 7063: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1402 raeburn 7064: unless (($caller eq 'constructaccess' && $env{'request.course.id'}) ||
7065: ($caller eq 'tiny')) {
1.1088 raeburn 7066: &appenv( {'request.role' => $spec,
7067: 'request.role.domain' => $dcdom,
1.1332 raeburn 7068: 'request.course.sec' => $sec,
1.1088 raeburn 7069: }
7070: );
7071: my $tadv=0;
7072: if (&allowed('adv') eq 'F') { $tadv=1; }
7073: &appenv({'request.role.adv' => $tadv});
7074: }
1.994 raeburn 7075: }
7076:
1.12 www 7077: # --------------------------------------------------------------- get interface
7078:
7079: sub get {
1.131 albertel 7080: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7081: my $items='';
1.800 albertel 7082: foreach my $item (@$storearr) {
7083: $items.=&escape($item).'&';
1.191 harris41 7084: }
1.12 www 7085: $items=~s/\&$//;
1.620 albertel 7086: if (!$udomain) { $udomain=$env{'user.domain'}; }
7087: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 7088: my $uhome=&homeserver($uname,$udomain);
7089:
1.133 albertel 7090: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7091: my @pairs=split(/\&/,$rep);
1.273 albertel 7092: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
7093: return @pairs;
7094: }
1.15 www 7095: my %returnhash=();
1.42 www 7096: my $i=0;
1.800 albertel 7097: foreach my $item (@$storearr) {
7098: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7099: $i++;
1.191 harris41 7100: }
1.15 www 7101: return %returnhash;
1.27 www 7102: }
7103:
7104: # --------------------------------------------------------------- del interface
7105:
7106: sub del {
1.133 albertel 7107: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 7108: my $items='';
1.800 albertel 7109: foreach my $item (@$storearr) {
7110: $items.=&escape($item).'&';
1.191 harris41 7111: }
1.984 neumanie 7112:
1.27 www 7113: $items=~s/\&$//;
1.620 albertel 7114: if (!$udomain) { $udomain=$env{'user.domain'}; }
7115: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7116: my $uhome=&homeserver($uname,$udomain);
7117: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7118: }
7119:
7120: # -------------------------------------------------------------- dump interface
7121:
1.1180 droeschl 7122: sub unserialize {
7123: my ($rep, $escapedkeys) = @_;
7124:
7125: return {} if $rep =~ /^error/;
7126:
7127: my %returnhash=();
1.1252 raeburn 7128: foreach my $item (split(/\&/,$rep)) {
1.1180 droeschl 7129: my ($key, $value) = split(/=/, $item, 2);
7130: $key = unescape($key) unless $escapedkeys;
7131: next if $key =~ /^error: 2 /;
1.1252 raeburn 7132: $returnhash{$key} = &thaw_unescape($value);
1.1180 droeschl 7133: }
7134: #return %returnhash;
7135: return \%returnhash;
7136: }
7137:
7138: # see Lond::dump_with_regexp
7139: # if $escapedkeys hash keys won't get unescaped.
1.15 www 7140: sub dump {
1.1462 raeburn 7141: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys,$encrypt)=@_;
1.755 albertel 7142: if (!$udomain) { $udomain=$env{'user.domain'}; }
7143: if (!$uname) { $uname=$env{'user.name'}; }
7144: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 7145:
1.1266 raeburn 7146: if ($regexp) {
7147: $regexp=&escape($regexp);
7148: } else {
7149: $regexp='.';
7150: }
1.1180 droeschl 7151: if (grep { $_ eq $uhome } current_machine_ids()) {
7152: # user is hosted on this machine
1.1266 raeburn 7153: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 7154: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 7155: return %{unserialize($reply, $escapedkeys)};
7156: }
1.1462 raeburn 7157: my $rep;
7158: if ($encrypt) {
7159: $rep=&reply("encrypt:edump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.1463 raeburn 7160: } else {
1.1462 raeburn 7161: $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
7162: }
1.755 albertel 7163: my @pairs=split(/\&/,$rep);
7164: my %returnhash=();
1.1098 foxr 7165: if (!($rep =~ /^error/ )) {
7166: foreach my $item (@pairs) {
7167: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 7168: $key = unescape($key) unless $escapedkeys;
7169: #$key = &unescape($key);
1.1098 foxr 7170: next if ($key =~ /^error: 2 /);
7171: $returnhash{$key}=&thaw_unescape($value);
7172: }
1.755 albertel 7173: }
7174: return %returnhash;
1.407 www 7175: }
7176:
1.1098 foxr 7177:
1.717 albertel 7178: # --------------------------------------------------------- dumpstore interface
7179:
7180: sub dumpstore {
7181: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 7182: # same as dump but keys must be escaped. They may contain colon separated
7183: # lists of values that may themself contain colons (e.g. symbs).
7184: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 7185: }
7186:
1.407 www 7187: # -------------------------------------------------------------- keys interface
7188:
7189: sub getkeys {
7190: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 7191: if (!$udomain) { $udomain=$env{'user.domain'}; }
7192: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 7193: my $uhome=&homeserver($uname,$udomain);
7194: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
7195: my @keyarray=();
1.800 albertel 7196: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 7197: next if ($key =~ /^error: 2 /);
1.800 albertel 7198: push(@keyarray,&unescape($key));
1.407 www 7199: }
7200: return @keyarray;
1.318 matthew 7201: }
7202:
1.319 matthew 7203: # --------------------------------------------------------------- currentdump
7204: sub currentdump {
1.328 matthew 7205: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 7206: $courseid = $env{'request.course.id'} if (! defined($courseid));
7207: $sdom = $env{'user.domain'} if (! defined($sdom));
7208: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 7209: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 7210: my $rep;
7211:
7212: if (grep { $_ eq $uhome } current_machine_ids()) {
7213: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
7214: $courseid)));
7215: } else {
7216: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
7217: }
7218:
1.318 matthew 7219: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 7220: #
1.318 matthew 7221: my %returnhash=();
1.319 matthew 7222: #
1.1343 raeburn 7223: if ($rep eq 'unknown_cmd') {
1.319 matthew 7224: # an old lond will not know currentdump
7225: # Do a dump and make it look like a currentdump
1.822 albertel 7226: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 7227: return if ($tmp[0] =~ /^(error:|no_such_host)/);
7228: my %hash = @tmp;
7229: @tmp=();
1.424 matthew 7230: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 7231: } else {
7232: my @pairs=split(/\&/,$rep);
1.800 albertel 7233: foreach my $pair (@pairs) {
7234: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 7235: my ($symb,$param) = split(/:/,$key);
7236: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 7237: &thaw_unescape($value);
1.319 matthew 7238: }
1.191 harris41 7239: }
1.12 www 7240: return %returnhash;
1.424 matthew 7241: }
7242:
7243: sub convert_dump_to_currentdump{
7244: my %hash = %{shift()};
7245: my %returnhash;
7246: # Code ripped from lond, essentially. The only difference
7247: # here is the unescaping done by lonnet::dump(). Conceivably
7248: # we might run in to problems with parameter names =~ /^v\./
7249: while (my ($key,$value) = each(%hash)) {
7250: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 7251: $symb = &unescape($symb);
7252: $param = &unescape($param);
1.424 matthew 7253: next if ($v eq 'version' || $symb eq 'keys');
7254: next if (exists($returnhash{$symb}) &&
7255: exists($returnhash{$symb}->{$param}) &&
7256: $returnhash{$symb}->{'v.'.$param} > $v);
7257: $returnhash{$symb}->{$param}=$value;
7258: $returnhash{$symb}->{'v.'.$param}=$v;
7259: }
7260: #
7261: # Remove all of the keys in the hashes which keep track of
7262: # the version of the parameter.
7263: while (my ($symb,$param_hash) = each(%returnhash)) {
7264: # use a foreach because we are going to delete from the hash.
7265: foreach my $key (keys(%$param_hash)) {
7266: delete($param_hash->{$key}) if ($key =~ /^v\./);
7267: }
7268: }
7269: return \%returnhash;
1.12 www 7270: }
7271:
1.627 albertel 7272: # ------------------------------------------------------ critical inc interface
7273:
7274: sub cinc {
7275: return &inc(@_,'critical');
7276: }
7277:
1.449 matthew 7278: # --------------------------------------------------------------- inc interface
7279:
7280: sub inc {
1.627 albertel 7281: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 7282: if (!$udomain) { $udomain=$env{'user.domain'}; }
7283: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 7284: my $uhome=&homeserver($uname,$udomain);
7285: my $items='';
7286: if (! ref($store)) {
7287: # got a single value, so use that instead
7288: $items = &escape($store).'=&';
7289: } elsif (ref($store) eq 'SCALAR') {
7290: $items = &escape($$store).'=&';
7291: } elsif (ref($store) eq 'ARRAY') {
7292: $items = join('=&',map {&escape($_);} @{$store});
7293: } elsif (ref($store) eq 'HASH') {
7294: while (my($key,$value) = each(%{$store})) {
7295: $items.= &escape($key).'='.&escape($value).'&';
7296: }
7297: }
7298: $items=~s/\&$//;
1.627 albertel 7299: if ($critical) {
7300: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
7301: } else {
7302: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
7303: }
1.449 matthew 7304: }
7305:
1.12 www 7306: # --------------------------------------------------------------- put interface
7307:
7308: sub put {
1.1462 raeburn 7309: my ($namespace,$storehash,$udomain,$uname,$encrypt)=@_;
1.620 albertel 7310: if (!$udomain) { $udomain=$env{'user.domain'}; }
7311: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7312: my $uhome=&homeserver($uname,$udomain);
1.12 www 7313: my $items='';
1.800 albertel 7314: foreach my $item (keys(%$storehash)) {
7315: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7316: }
1.12 www 7317: $items=~s/\&$//;
1.1462 raeburn 7318: if ($encrypt) {
7319: return &reply("encrypt:put:$udomain:$uname:$namespace:$items",$uhome);
7320: } else {
7321: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
7322: }
1.47 www 7323: }
7324:
1.631 albertel 7325: # ------------------------------------------------------------ newput interface
7326:
7327: sub newput {
7328: my ($namespace,$storehash,$udomain,$uname)=@_;
7329: if (!$udomain) { $udomain=$env{'user.domain'}; }
7330: if (!$uname) { $uname=$env{'user.name'}; }
7331: my $uhome=&homeserver($uname,$udomain);
7332: my $items='';
7333: foreach my $key (keys(%$storehash)) {
7334: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7335: }
7336: $items=~s/\&$//;
7337: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
7338: }
7339:
7340: # --------------------------------------------------------- putstore interface
7341:
1.524 raeburn 7342: sub putstore {
1.1269 raeburn 7343: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 7344: if (!$udomain) { $udomain=$env{'user.domain'}; }
7345: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 7346: my $uhome=&homeserver($uname,$udomain);
7347: my $items='';
1.715 albertel 7348: foreach my $key (keys(%$storehash)) {
7349: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 7350: }
1.715 albertel 7351: $items=~s/\&$//;
1.716 albertel 7352: my $esc_symb=&escape($symb);
7353: my $esc_v=&escape($version);
1.715 albertel 7354: my $reply =
1.716 albertel 7355: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 7356: $uhome);
1.1269 raeburn 7357: if (($tolog) && ($reply eq 'ok')) {
7358: my $namevalue='';
7359: foreach my $key (keys(%{$storehash})) {
7360: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7361: }
1.1434 raeburn 7362: my $ip = &get_requestor_ip();
7363: $namevalue .= 'ip='.&escape($ip).
1.1269 raeburn 7364: '&host='.&escape($perlvar{'lonHostID'}).
7365: '&version='.$esc_v.
7366: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
7367: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
7368: }
1.715 albertel 7369: if ($reply eq 'unknown_cmd') {
1.716 albertel 7370: # gfall back to way things use to be done
1.715 albertel 7371: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
7372: $uname);
1.524 raeburn 7373: }
1.715 albertel 7374: return $reply;
7375: }
7376:
7377: sub old_putstore {
1.716 albertel 7378: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
7379: if (!$udomain) { $udomain=$env{'user.domain'}; }
7380: if (!$uname) { $uname=$env{'user.name'}; }
7381: my $uhome=&homeserver($uname,$udomain);
7382: my %newstorehash;
1.800 albertel 7383: foreach my $item (keys(%$storehash)) {
7384: my $key = $version.':'.&escape($symb).':'.$item;
7385: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 7386: }
7387: my $items='';
7388: my %allitems = ();
1.800 albertel 7389: foreach my $item (keys(%newstorehash)) {
7390: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 7391: my $key = $1.':keys:'.$2;
7392: $allitems{$key} .= $3.':';
7393: }
1.800 albertel 7394: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 7395: }
1.800 albertel 7396: foreach my $item (keys(%allitems)) {
7397: $allitems{$item} =~ s/\:$//;
7398: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 7399: }
7400: $items=~s/\&$//;
7401: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 7402: }
7403:
1.47 www 7404: # ------------------------------------------------------ critical put interface
7405:
7406: sub cput {
1.134 albertel 7407: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 7408: if (!$udomain) { $udomain=$env{'user.domain'}; }
7409: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7410: my $uhome=&homeserver($uname,$udomain);
1.47 www 7411: my $items='';
1.800 albertel 7412: foreach my $item (keys(%$storehash)) {
7413: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7414: }
1.47 www 7415: $items=~s/\&$//;
1.134 albertel 7416: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7417: }
7418:
7419: # -------------------------------------------------------------- eget interface
7420:
7421: sub eget {
1.133 albertel 7422: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7423: my $items='';
1.800 albertel 7424: foreach my $item (@$storearr) {
7425: $items.=&escape($item).'&';
1.191 harris41 7426: }
1.12 www 7427: $items=~s/\&$//;
1.620 albertel 7428: if (!$udomain) { $udomain=$env{'user.domain'}; }
7429: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7430: my $uhome=&homeserver($uname,$udomain);
7431: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7432: my @pairs=split(/\&/,$rep);
7433: my %returnhash=();
1.42 www 7434: my $i=0;
1.800 albertel 7435: foreach my $item (@$storearr) {
7436: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7437: $i++;
1.191 harris41 7438: }
1.12 www 7439: return %returnhash;
7440: }
7441:
1.667 albertel 7442: # ------------------------------------------------------------ tmpput interface
7443: sub tmpput {
1.802 raeburn 7444: my ($storehash,$server,$context)=@_;
1.667 albertel 7445: my $items='';
1.800 albertel 7446: foreach my $item (keys(%$storehash)) {
7447: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 7448: }
7449: $items=~s/\&$//;
1.802 raeburn 7450: if (defined($context)) {
7451: $items .= ':'.&escape($context);
7452: }
1.667 albertel 7453: return &reply("tmpput:$items",$server);
7454: }
7455:
7456: # ------------------------------------------------------------ tmpget interface
7457: sub tmpget {
1.688 albertel 7458: my ($token,$server)=@_;
7459: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7460: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 7461: my %returnhash;
1.1328 raeburn 7462: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
7463: return %returnhash;
7464: }
1.667 albertel 7465: foreach my $item (split(/\&/,$rep)) {
7466: my ($key,$value)=split(/=/,$item);
7467: $returnhash{&unescape($key)}=&thaw_unescape($value);
7468: }
7469: return %returnhash;
7470: }
7471:
1.1113 raeburn 7472: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 7473: sub tmpdel {
7474: my ($token,$server)=@_;
7475: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7476: return &reply("tmpdel:$token",$server);
7477: }
7478:
1.1198 raeburn 7479: # ------------------------------------------------------------ get_timebased_id
7480:
7481: sub get_timebased_id {
7482: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
7483: $maxtries) = @_;
7484: my ($newid,$error,$dellock);
7485: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
7486: return ('','ok','invalid call to get suffix');
7487: }
7488:
7489: # set defaults for any optional args for which values were not supplied
7490: if ($who eq '') {
7491: $who = $env{'user.name'}.':'.$env{'user.domain'};
7492: }
7493: if (!$locktries) {
7494: $locktries = 3;
7495: }
7496: if (!$maxtries) {
7497: $maxtries = 10;
7498: }
7499:
7500: if (($cdom eq '') || ($cnum eq '')) {
7501: if ($env{'request.course.id'}) {
7502: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7503: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7504: }
7505: if (($cdom eq '') || ($cnum eq '')) {
7506: return ('','ok','call to get suffix not in course context');
7507: }
7508: }
7509:
7510: # construct locking item
7511: my $lockhash = {
7512: $prefix."\0".'locked_'.$keyid => $who,
7513: };
7514: my $tries = 0;
7515:
7516: # attempt to get lock on nohist_$namespace file
7517: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7518: while (($gotlock ne 'ok') && $tries <$locktries) {
7519: $tries ++;
7520: sleep 1;
7521: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7522: }
7523:
7524: # attempt to get unique identifier, based on current timestamp
7525: if ($gotlock eq 'ok') {
7526: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
7527: my $id = time;
7528: $newid = $id;
1.1268 raeburn 7529: if ($idtype eq 'addcode') {
7530: $newid .= &sixnum_code();
7531: }
1.1198 raeburn 7532: my $idtries = 0;
7533: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
7534: if ($idtype eq 'concat') {
7535: $newid = $id.$idtries;
1.1268 raeburn 7536: } elsif ($idtype eq 'addcode') {
7537: $newid = $newid.&sixnum_code();
1.1198 raeburn 7538: } else {
7539: $newid ++;
7540: }
7541: $idtries ++;
7542: }
7543: if (!exists($inuse{$prefix."\0".$newid})) {
7544: my %new_item = (
7545: $prefix."\0".$newid => $who,
7546: );
7547: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
7548: $cdom,$cnum);
7549: if ($putresult ne 'ok') {
7550: undef($newid);
7551: $error = 'error saving new item: '.$putresult;
7552: }
7553: } else {
1.1268 raeburn 7554: undef($newid);
1.1198 raeburn 7555: $error = ('error: no unique suffix available for the new item ');
7556: }
7557: # remove lock
7558: my @del_lock = ($prefix."\0".'locked_'.$keyid);
7559: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
7560: } else {
7561: $error = "error: could not obtain lockfile\n";
7562: $dellock = 'ok';
1.1276 raeburn 7563: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
7564: $dellock = 'nolock';
7565: }
1.1198 raeburn 7566: }
7567: return ($newid,$dellock,$error);
7568: }
7569:
1.1268 raeburn 7570: sub sixnum_code {
7571: my $code;
7572: for (0..6) {
7573: $code .= int( rand(9) );
7574: }
7575: return $code;
7576: }
7577:
1.765 albertel 7578: # -------------------------------------------------- portfolio access checking
7579:
7580: sub portfolio_access {
1.1270 raeburn 7581: my ($requrl,$clientip) = @_;
1.765 albertel 7582: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270 raeburn 7583: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 7584: if ($result) {
7585: my %setters;
7586: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
1.1473 raeburn 7587: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
7588: &Apache::loncommon::blockcheck(\%setters,'port',$clientip,$unum,$udom);
7589: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 7590: return 'B';
7591: }
7592: } else {
1.1473 raeburn 7593: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
7594: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
7595: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 7596: return 'B';
7597: }
7598: }
7599: }
1.765 albertel 7600: if ($result eq 'ok') {
1.766 albertel 7601: return 'F';
1.765 albertel 7602: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 7603: return 'A';
1.765 albertel 7604: }
1.766 albertel 7605: return '';
1.765 albertel 7606: }
7607:
7608: sub get_portfolio_access {
1.1270 raeburn 7609: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 7610:
7611: if (!ref($access_hash)) {
7612: my $current_perms = &get_portfile_permissions($udom,$unum);
7613: my %access_controls = &get_access_controls($current_perms,$group,
7614: $file_name);
7615: $access_hash = $access_controls{$file_name};
7616: }
7617:
1.1270 raeburn 7618: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 7619: my $now = time;
7620: if (ref($access_hash) eq 'HASH') {
7621: foreach my $key (keys(%{$access_hash})) {
7622: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7623: if ($start > $now) {
7624: next;
7625: }
7626: if ($end && $end<$now) {
7627: next;
7628: }
7629: if ($scope eq 'public') {
7630: $public = $key;
7631: last;
7632: } elsif ($scope eq 'guest') {
7633: $guest = $key;
7634: } elsif ($scope eq 'domains') {
7635: push(@domains,$key);
7636: } elsif ($scope eq 'users') {
7637: push(@users,$key);
7638: } elsif ($scope eq 'course') {
7639: push(@courses,$key);
7640: } elsif ($scope eq 'group') {
7641: push(@groups,$key);
1.1270 raeburn 7642: } elsif ($scope eq 'ip') {
7643: push(@ips,$key);
1.765 albertel 7644: }
7645: }
7646: if ($public) {
7647: return 'ok';
1.1270 raeburn 7648: } elsif (@ips > 0) {
7649: my $allowed;
7650: foreach my $ipkey (@ips) {
7651: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
7652: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
7653: $allowed = 1;
7654: last;
7655: }
7656: }
7657: }
7658: if ($allowed) {
7659: return 'ok';
7660: }
1.765 albertel 7661: }
7662: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7663: if ($guest) {
7664: return $guest;
7665: }
7666: } else {
7667: if (@domains > 0) {
7668: foreach my $domkey (@domains) {
7669: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
7670: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
7671: return 'ok';
7672: }
7673: }
7674: }
7675: }
7676: if (@users > 0) {
7677: foreach my $userkey (@users) {
1.865 raeburn 7678: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
7679: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
7680: if (ref($item) eq 'HASH') {
7681: if (($item->{'uname'} eq $env{'user.name'}) &&
7682: ($item->{'udom'} eq $env{'user.domain'})) {
7683: return 'ok';
7684: }
7685: }
7686: }
7687: }
1.765 albertel 7688: }
7689: }
7690: my %roleshash;
7691: my @courses_and_groups = @courses;
7692: push(@courses_and_groups,@groups);
7693: if (@courses_and_groups > 0) {
7694: my (%allgroups,%allroles);
7695: my ($start,$end,$role,$sec,$group);
7696: foreach my $envkey (%env) {
1.1060 raeburn 7697: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7698: my $cid = $2.'_'.$3;
7699: if ($1 eq 'gr') {
7700: $group = $4;
7701: $allgroups{$cid}{$group} = $env{$envkey};
7702: } else {
7703: if ($4 eq '') {
7704: $sec = 'none';
7705: } else {
7706: $sec = $4;
7707: }
7708: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7709: }
1.811 albertel 7710: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7711: my $cid = $2.'_'.$3;
7712: if ($4 eq '') {
7713: $sec = 'none';
7714: } else {
7715: $sec = $4;
7716: }
7717: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7718: }
7719: }
7720: if (keys(%allroles) == 0) {
7721: return;
7722: }
7723: foreach my $key (@courses_and_groups) {
7724: my %content = %{$$access_hash{$key}};
7725: my $cnum = $content{'number'};
7726: my $cdom = $content{'domain'};
7727: my $cid = $cdom.'_'.$cnum;
7728: if (!exists($allroles{$cid})) {
7729: next;
7730: }
7731: foreach my $role_id (keys(%{$content{'roles'}})) {
7732: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7733: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7734: my @status = @{$content{'roles'}{$role_id}{'access'}};
7735: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7736: foreach my $role (keys(%{$allroles{$cid}})) {
7737: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7738: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7739: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7740: if (grep/^all$/,@sections) {
7741: return 'ok';
7742: } else {
7743: if (grep/^$sec$/,@sections) {
7744: return 'ok';
7745: }
7746: }
7747: }
7748: }
7749: if (keys(%{$allgroups{$cid}}) == 0) {
7750: if (grep/^none$/,@groups) {
7751: return 'ok';
7752: }
7753: } else {
7754: if (grep/^all$/,@groups) {
7755: return 'ok';
7756: }
7757: foreach my $group (keys(%{$allgroups{$cid}})) {
7758: if (grep/^$group$/,@groups) {
7759: return 'ok';
7760: }
7761: }
7762: }
7763: }
7764: }
7765: }
7766: }
7767: }
7768: if ($guest) {
7769: return $guest;
7770: }
7771: }
7772: }
7773: return;
7774: }
7775:
7776: sub course_group_datechecker {
7777: my ($dates,$now,$status) = @_;
7778: my ($start,$end) = split(/\./,$dates);
7779: if (!$start && !$end) {
7780: return 'ok';
7781: }
7782: if (grep/^active$/,@{$status}) {
7783: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7784: return 'ok';
7785: }
7786: }
7787: if (grep/^previous$/,@{$status}) {
7788: if ($end > $now ) {
7789: return 'ok';
7790: }
7791: }
7792: if (grep/^future$/,@{$status}) {
7793: if ($start > $now) {
7794: return 'ok';
7795: }
7796: }
7797: return;
7798: }
7799:
7800: sub parse_portfolio_url {
7801: my ($url) = @_;
7802:
7803: my ($type,$udom,$unum,$group,$file_name);
7804:
1.823 albertel 7805: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 7806: $type = 1;
7807: $udom = $1;
7808: $unum = $2;
7809: $file_name = $3;
1.823 albertel 7810: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 7811: $type = 2;
7812: $udom = $1;
7813: $unum = $2;
7814: $group = $3;
7815: $file_name = $3.'/'.$4;
7816: }
7817: if (wantarray) {
7818: return ($type,$udom,$unum,$file_name,$group);
7819: }
7820: return $type;
7821: }
7822:
7823: sub is_portfolio_url {
7824: my ($url) = @_;
7825: return scalar(&parse_portfolio_url($url));
7826: }
7827:
1.798 raeburn 7828: sub is_portfolio_file {
7829: my ($file) = @_;
1.820 raeburn 7830: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 7831: return 1;
7832: }
7833: return;
7834: }
7835:
1.976 raeburn 7836: sub usertools_access {
1.1084 raeburn 7837: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 7838: my ($access,%tools);
7839: if ($context eq '') {
7840: $context = 'tools';
7841: }
7842: if ($context eq 'requestcourses') {
7843: %tools = (
7844: official => 1,
7845: unofficial => 1,
1.1006 raeburn 7846: community => 1,
1.1246 raeburn 7847: textbook => 1,
1.1305 raeburn 7848: placement => 1,
1.1368 raeburn 7849: lti => 1,
1.985 raeburn 7850: );
1.1183 raeburn 7851: } elsif ($context eq 'requestauthor') {
7852: %tools = (
7853: requestauthor => 1,
7854: );
1.985 raeburn 7855: } else {
7856: %tools = (
7857: aboutme => 1,
7858: blog => 1,
1.1177 raeburn 7859: webdav => 1,
1.985 raeburn 7860: portfolio => 1,
7861: );
7862: }
1.976 raeburn 7863: return if (!defined($tools{$tool}));
7864:
1.1242 raeburn 7865: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 7866: $udom = $env{'user.domain'};
7867: $uname = $env{'user.name'};
7868: }
7869:
1.978 raeburn 7870: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7871: if ($action ne 'reload') {
1.985 raeburn 7872: if ($context eq 'requestcourses') {
7873: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 7874: } elsif ($context eq 'requestauthor') {
7875: return $env{'environment.canrequest.author'};
1.985 raeburn 7876: } else {
7877: return $env{'environment.availabletools.'.$tool};
7878: }
7879: }
1.976 raeburn 7880: }
7881:
1.1183 raeburn 7882: my ($toolstatus,$inststatus,$envkey);
7883: if ($context eq 'requestauthor') {
7884: $envkey = $context;
7885: } else {
7886: $envkey = $context.'.'.$tool;
7887: }
1.976 raeburn 7888:
1.985 raeburn 7889: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
7890: ($action ne 'reload')) {
1.1183 raeburn 7891: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 7892: $inststatus = $env{'environment.inststatus'};
7893: } else {
1.1084 raeburn 7894: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 7895: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 7896: $inststatus = $userenvref->{'inststatus'};
7897: } else {
1.1183 raeburn 7898: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
7899: $toolstatus = $userenv{$envkey};
1.1084 raeburn 7900: $inststatus = $userenv{'inststatus'};
7901: }
1.976 raeburn 7902: }
7903:
7904: if ($toolstatus ne '') {
7905: if ($toolstatus) {
7906: $access = 1;
7907: } else {
7908: $access = 0;
7909: }
7910: return $access;
7911: }
7912:
1.1084 raeburn 7913: my ($is_adv,%domdef);
7914: if (ref($is_advref) eq 'HASH') {
7915: $is_adv = $is_advref->{'is_adv'};
7916: } else {
7917: $is_adv = &is_advanced_user($udom,$uname);
7918: }
7919: if (ref($domdefref) eq 'HASH') {
7920: %domdef = %{$domdefref};
7921: } else {
7922: %domdef = &get_domain_defaults($udom);
7923: }
1.976 raeburn 7924: if (ref($domdef{$tool}) eq 'HASH') {
7925: if ($is_adv) {
7926: if ($domdef{$tool}{'_LC_adv'} ne '') {
7927: if ($domdef{$tool}{'_LC_adv'}) {
7928: $access = 1;
7929: } else {
7930: $access = 0;
7931: }
7932: return $access;
7933: }
7934: }
7935: if ($inststatus ne '') {
7936: my ($hasaccess,$hasnoaccess);
7937: foreach my $affiliation (split(/:/,$inststatus)) {
7938: if ($domdef{$tool}{$affiliation} ne '') {
7939: if ($domdef{$tool}{$affiliation}) {
7940: $hasaccess = 1;
7941: } else {
7942: $hasnoaccess = 1;
7943: }
7944: }
7945: }
7946: if ($hasaccess || $hasnoaccess) {
7947: if ($hasaccess) {
7948: $access = 1;
7949: } elsif ($hasnoaccess) {
7950: $access = 0;
7951: }
7952: return $access;
7953: }
7954: } else {
7955: if ($domdef{$tool}{'default'} ne '') {
7956: if ($domdef{$tool}{'default'}) {
7957: $access = 1;
7958: } elsif ($domdef{$tool}{'default'} == 0) {
7959: $access = 0;
7960: }
7961: return $access;
7962: }
7963: }
7964: } else {
1.1177 raeburn 7965: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 7966: $access = 1;
7967: } else {
7968: $access = 0;
7969: }
1.976 raeburn 7970: return $access;
7971: }
7972: }
7973:
1.1050 raeburn 7974: sub is_course_owner {
7975: my ($cdom,$cnum,$udom,$uname) = @_;
7976: if (($udom eq '') || ($uname eq '')) {
7977: $udom = $env{'user.domain'};
7978: $uname = $env{'user.name'};
7979: }
7980: unless (($udom eq '') || ($uname eq '')) {
7981: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
7982: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
7983: return 1;
7984: } else {
7985: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
7986: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
7987: return 1;
7988: }
7989: }
7990: }
7991: }
7992: return;
7993: }
7994:
1.976 raeburn 7995: sub is_advanced_user {
7996: my ($udom,$uname) = @_;
1.1085 raeburn 7997: if ($udom ne '' && $uname ne '') {
7998: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 7999: if (wantarray) {
8000: return ($env{'user.adv'},$env{'user.author'});
8001: } else {
8002: return $env{'user.adv'};
8003: }
1.1085 raeburn 8004: }
8005: }
1.976 raeburn 8006: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
8007: my %allroles;
1.1128 raeburn 8008: my ($is_adv,$is_author);
1.976 raeburn 8009: foreach my $role (keys(%roleshash)) {
8010: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
8011: my $area = '/'.$tdomain.'/'.$trest;
8012: if ($sec ne '') {
8013: $area .= '/'.$sec;
8014: }
8015: if (($area ne '') && ($trole ne '')) {
8016: my $spec=$trole.'.'.$area;
8017: if ($trole =~ /^cr\//) {
8018: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
8019: } elsif ($trole ne 'gr') {
8020: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
8021: }
1.1128 raeburn 8022: if ($trole eq 'au') {
8023: $is_author = 1;
8024: }
1.976 raeburn 8025: }
8026: }
8027: foreach my $role (keys(%allroles)) {
8028: last if ($is_adv);
8029: foreach my $item (split(/:/,$allroles{$role})) {
8030: if ($item ne '') {
8031: my ($privilege,$restrictions)=split(/&/,$item);
8032: if ($privilege eq 'adv') {
8033: $is_adv = 1;
8034: last;
8035: }
8036: }
8037: }
8038: }
1.1128 raeburn 8039: if (wantarray) {
8040: return ($is_adv,$is_author);
8041: }
1.976 raeburn 8042: return $is_adv;
8043: }
1.798 raeburn 8044:
1.1035 raeburn 8045: sub check_can_request {
1.1368 raeburn 8046: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
1.1035 raeburn 8047: my $canreq = 0;
1.1368 raeburn 8048: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8049: $uname = $env{'user.name'};
8050: $udom = $env{'user.domain'};
8051: }
1.1035 raeburn 8052: my ($types,$typename) = &Apache::loncommon::course_types();
8053: my @options = ('approval','validate','autolimit');
8054: my $optregex = join('|',@options);
8055: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
8056: foreach my $type (@{$types}) {
1.1368 raeburn 8057: if (&usertools_access($uname,$udom,$type,undef,
8058: 'requestcourses')) {
1.1035 raeburn 8059: $canreq ++;
1.1036 raeburn 8060: if (ref($request_domains) eq 'HASH') {
1.1368 raeburn 8061: push(@{$request_domains->{$type}},$udom);
1.1036 raeburn 8062: }
1.1368 raeburn 8063: if ($dom eq $udom) {
1.1035 raeburn 8064: $can_request->{$type} = 1;
8065: }
8066: }
1.1368 raeburn 8067: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
8068: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
1.1035 raeburn 8069: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
8070: if (@curr > 0) {
1.1036 raeburn 8071: foreach my $item (@curr) {
8072: if (ref($request_domains) eq 'HASH') {
8073: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
8074: if ($otherdom ne '') {
8075: if (ref($request_domains->{$type}) eq 'ARRAY') {
8076: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
8077: push(@{$request_domains->{$type}},$otherdom);
8078: }
8079: } else {
8080: push(@{$request_domains->{$type}},$otherdom);
8081: }
8082: }
8083: }
8084: }
1.1368 raeburn 8085: unless ($dom eq $env{'user.domain'}) {
1.1036 raeburn 8086: $canreq ++;
1.1035 raeburn 8087: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
8088: $can_request->{$type} = 1;
8089: }
8090: }
8091: }
8092: }
8093: }
8094: }
8095: return $canreq;
8096: }
8097:
1.341 www 8098: # ---------------------------------------------- Custom access rule evaluation
8099:
8100: sub customaccess {
8101: my ($priv,$uri)=@_;
1.807 albertel 8102: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 8103: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 8104: $udom = &LONCAPA::clean_domain($udom);
8105: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 8106: my $access=0;
1.800 albertel 8107: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 8108: my ($effect,$realm,$role,$type)=split(/\:/,$right);
8109: if ($type eq 'user') {
8110: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 8111: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 8112: if ($tdom) {
8113: if ($tdom ne $env{'user.domain'}) { next; }
8114: }
1.896 albertel 8115: if ($tuname) {
8116: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 8117: }
8118: $access=($effect eq 'allow');
8119: last;
8120: }
8121: } else {
8122: if ($role) {
8123: if ($role ne $urole) { next; }
8124: }
8125: foreach my $scope (split(/\s*\,\s*/,$realm)) {
8126: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
8127: if ($tdom) {
8128: if ($tdom ne $udom) { next; }
8129: }
8130: if ($tcrs) {
8131: if ($tcrs ne $ucrs) { next; }
8132: }
8133: if ($tsec) {
8134: if ($tsec ne $usec) { next; }
8135: }
8136: $access=($effect eq 'allow');
8137: last;
8138: }
8139: if ($realm eq '' && $role eq '') {
8140: $access=($effect eq 'allow');
8141: }
1.402 bowersj2 8142: }
1.341 www 8143: }
8144: return $access;
8145: }
8146:
1.103 harris41 8147: # ------------------------------------------------- Check for a user privilege
1.12 www 8148:
8149: sub allowed {
1.1461 raeburn 8150: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck,$ignorecache,$nodeeplinkcheck,$nodeeplinkout)=@_;
1.705 albertel 8151: my $ver_orguri=$uri;
1.439 www 8152: $uri=&deversion($uri);
1.152 www 8153: my $orguri=$uri;
1.52 www 8154: $uri=&declutter($uri);
1.809 raeburn 8155:
1.810 raeburn 8156: if ($priv eq 'evb') {
8157: # Evade communication block restrictions for specified role in a course
8158: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
8159: return $1;
8160: } else {
8161: return;
8162: }
8163: }
8164:
1.620 albertel 8165: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 8166: # Free bre access to adm and meta resources
1.1436 raeburn 8167: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|viewclasslist|aboutme|ext\.tool)$}))
1.769 albertel 8168: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
8169: && ($priv eq 'bre')) {
1.14 www 8170: return 'F';
1.159 www 8171: }
8172:
1.545 banghart 8173: # Free bre access to user's own portfolio contents
1.714 raeburn 8174: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 8175: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 8176: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 8177: my %setters;
1.1473 raeburn 8178: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
8179: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
8180: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 8181: return 'B';
8182: } else {
8183: return 'F';
8184: }
1.545 banghart 8185: }
8186:
1.762 raeburn 8187: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 8188: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
8189: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
8190: if (exists($env{'request.course.id'})) {
8191: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8192: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8193: if (($domain eq $cdom) && ($name eq $cnum)) {
8194: my $courseprivid=$env{'request.course.id'};
8195: $courseprivid=~s/\_/\//;
8196: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
8197: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
8198: return $1;
1.762 raeburn 8199: } else {
8200: if ($env{'request.course.sec'}) {
8201: $courseprivid.='/'.$env{'request.course.sec'};
8202: }
8203: if ($env{'user.priv.'.$env{'request.role'}.'./'.
8204: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
8205: return $2;
8206: }
1.714 raeburn 8207: }
8208: }
8209: }
8210: }
8211:
1.159 www 8212: # Free bre to public access
8213:
8214: if ($priv eq 'bre') {
1.1362 raeburn 8215: my $copyright;
8216: unless ($uri =~ /ext\.tool/) {
8217: $copyright=&metadata($uri,'copyright');
8218: }
1.620 albertel 8219: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 8220: return 'F';
8221: }
1.238 www 8222: if ($copyright eq 'priv') {
8223: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8224: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 8225: return '';
8226: }
8227: }
8228: if ($copyright eq 'domain') {
8229: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8230: unless (($env{'user.domain'} eq $1) ||
8231: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 8232: return '';
8233: }
1.262 matthew 8234: }
1.620 albertel 8235: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 8236: # Library role, so allow browsing of resources in this domain.
8237: return 'F';
1.238 www 8238: }
1.341 www 8239: if ($copyright eq 'custom') {
8240: unless (&customaccess($priv,$uri)) { return ''; }
8241: }
1.14 www 8242: }
1.264 matthew 8243: # Domain coordinator is trying to create a course
1.620 albertel 8244: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 8245: # uri is the requested domain in this case.
8246: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 8247: # a role of dc for the domain in question.
1.620 albertel 8248: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 8249: }
1.29 www 8250:
1.52 www 8251: my $thisallowed='';
8252: my $statecond=0;
8253: my $courseprivid='';
8254:
1.1039 raeburn 8255: my $ownaccess;
1.1043 raeburn 8256: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 8257: if (($priv eq 'bro') && ($env{'user.author'})) {
8258: if ($uri eq '') {
8259: $ownaccess = 1;
8260: } else {
8261: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
8262: my $udom = $env{'user.domain'};
8263: my $uname = $env{'user.name'};
8264: if ($uri =~ m{^\Q$udom\E/?$}) {
8265: $ownaccess = 1;
1.1040 raeburn 8266: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 8267: unless ($uri =~ m{\.\./}) {
8268: $ownaccess = 1;
8269: }
8270: } elsif (($udom ne 'public') && ($uname ne 'public')) {
8271: my $now = time;
8272: if ($uri =~ m{^([^/]+)/?$}) {
8273: my $adom = $1;
8274: foreach my $key (keys(%env)) {
1.1042 raeburn 8275: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1452 raeburn 8276: my ($start,$end) = split(/\./,$env{$key});
8277: if (($now >= $start) && (!$end || $end > $now)) {
1.1039 raeburn 8278: $ownaccess = 1;
8279: last;
8280: }
8281: }
8282: }
8283: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
8284: my $adom = $1;
8285: my $aname = $2;
1.1042 raeburn 8286: foreach my $role ('ca','aa') {
8287: if ($env{"user.role.$role./$adom/$aname"}) {
8288: my ($start,$end) =
1.1452 raeburn 8289: split(/\./,$env{"user.role.$role./$adom/$aname"});
8290: if (($now >= $start) && (!$end || $end > $now)) {
1.1042 raeburn 8291: $ownaccess = 1;
8292: last;
8293: }
1.1039 raeburn 8294: }
8295: }
8296: }
8297: }
8298: }
8299: }
8300: }
8301:
1.52 www 8302: # Course
8303:
1.620 albertel 8304: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8305: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8306: $thisallowed.=$1;
8307: }
1.52 www 8308: }
1.29 www 8309:
1.52 www 8310: # Domain
8311:
1.620 albertel 8312: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 8313: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8314: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8315: $thisallowed.=$1;
8316: }
1.12 www 8317: }
1.52 www 8318:
1.1141 raeburn 8319: # User who is not author or co-author might still be able to edit
8320: # resource of an author in the domain (e.g., if Domain Coordinator).
8321: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
8322: (&allowed('mdc',$env{'request.course.id'}))) {
8323: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
8324: $thisallowed.=$1;
8325: }
8326: }
8327:
1.52 www 8328: # Course: uri itself is a course
1.66 www 8329: my $courseuri=$uri;
8330: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 8331: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 8332:
1.620 albertel 8333: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 8334: =~/\Q$priv\E\&([^\:]*)/) {
1.1409 raeburn 8335: if ($priv eq 'mip') {
8336: my $rem = $1;
8337: if (($uri ne '') && ($env{'request.course.id'} eq $uri) &&
8338: ($env{'course.'.$env{'request.course.id'}.'.internal.courseowner'} eq $env{'user.name'}.':'.$env{'user.domain'})) {
8339: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8340: if ($cdom ne '') {
1.1410 raeburn 8341: my %passwdconf = &get_passwdconf($cdom);
8342: if (ref($passwdconf{'crsownerchg'}) eq 'HASH') {
8343: if (ref($passwdconf{'crsownerchg'}{'by'}) eq 'ARRAY') {
8344: if (@{$passwdconf{'crsownerchg'}{'by'}}) {
8345: my @inststatuses = split(':',$env{'environment.inststatus'});
8346: unless (@inststatuses) {
8347: @inststatuses = ('default');
8348: }
8349: foreach my $status (@inststatuses) {
8350: if (grep(/^\Q$status\E$/,@{$passwdconf{'crsownerchg'}{'by'}})) {
8351: $thisallowed.=$rem;
8352: }
8353: }
8354: }
8355: }
1.1409 raeburn 8356: }
8357: }
8358: }
8359: } else {
8360: unless (($priv eq 'bro') && (!$ownaccess)) {
8361: $thisallowed.=$1;
8362: }
1.1039 raeburn 8363: }
1.12 www 8364: }
1.29 www 8365:
1.665 albertel 8366: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 8367: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 8368: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 8369: $thisallowed='';
1.671 raeburn 8370: my ($match)=&is_on_map($uri);
8371: if ($match) {
8372: if ($env{'user.priv.'.$env{'request.role'}.'./'}
8373: =~/\Q$priv\E\&([^\:]*)/) {
1.1281 raeburn 8374: my $value = $1;
1.1461 raeburn 8375: my $deeplinkblock;
8376: unless ($nodeeplinkcheck) {
8377: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8378: }
1.1402 raeburn 8379: if ($deeplinkblock) {
8380: $thisallowed='D';
8381: } elsif ($noblockcheck) {
1.1281 raeburn 8382: $thisallowed.=$value;
1.1162 raeburn 8383: } else {
1.1424 raeburn 8384: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8385: if (@blockers > 0) {
8386: $thisallowed = 'B';
8387: } else {
8388: $thisallowed.=$value;
8389: }
1.1162 raeburn 8390: }
1.671 raeburn 8391: }
8392: } else {
1.705 albertel 8393: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 8394: if ($refuri) {
8395: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 8396: $thisallowed='F';
1.671 raeburn 8397: } else {
8398: $refuri=&declutter($refuri);
8399: my ($match) = &is_on_map($refuri);
8400: if ($match) {
1.1461 raeburn 8401: my $deeplinkblock;
8402: unless ($nodeeplinkcheck) {
8403: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8404: }
1.1402 raeburn 8405: if ($deeplinkblock) {
8406: $thisallowed='D';
8407: } elsif ($noblockcheck) {
1.1281 raeburn 8408: $thisallowed='F';
1.1162 raeburn 8409: } else {
1.1426 raeburn 8410: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 8411: if (@blockers > 0) {
8412: $thisallowed = 'B';
8413: } else {
8414: $thisallowed='F';
8415: }
1.1162 raeburn 8416: }
1.671 raeburn 8417: }
1.669 raeburn 8418: }
1.671 raeburn 8419: }
8420: }
1.314 www 8421: }
1.492 albertel 8422:
1.766 albertel 8423: if ($priv eq 'bre'
8424: && $thisallowed ne 'F'
8425: && $thisallowed ne '2'
8426: && &is_portfolio_url($uri)) {
1.1270 raeburn 8427: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 8428: }
1.1250 raeburn 8429:
1.52 www 8430: # Full access at system, domain or course-wide level? Exit.
1.29 www 8431: if ($thisallowed=~/F/) {
8432: return 'F';
8433: }
8434:
1.52 www 8435: # If this is generating or modifying users, exit with special codes
1.29 www 8436:
1.643 www 8437: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
8438: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 8439: my ($audom,$auname)=split('/',$uri);
1.643 www 8440: # no author name given, so this just checks on the general right to make a co-author in this domain
8441: unless ($auname) { return $thisallowed; }
8442: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 8443: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
8444: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
8445: ($audom ne $env{'request.role.domain'}))) { return ''; }
8446: }
1.52 www 8447: return $thisallowed;
8448: }
8449: #
1.103 harris41 8450: # Gathered so far: system, domain and course wide privileges
1.52 www 8451: #
8452: # Course: See if uri or referer is an individual resource that is part of
8453: # the course
8454:
1.620 albertel 8455: if ($env{'request.course.id'}) {
1.232 www 8456:
1.1409 raeburn 8457: # If this is modifying password (internal auth) domains must match for user and user's role.
8458:
8459: if ($priv eq 'mip') {
8460: if ($env{'user.domain'} eq $env{'request.role.domain'}) {
8461: return $thisallowed;
8462: } else {
8463: return '';
8464: }
8465: }
8466:
1.620 albertel 8467: $courseprivid=$env{'request.course.id'};
8468: if ($env{'request.course.sec'}) {
8469: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 8470: }
8471: $courseprivid=~s/\_/\//;
8472: my $checkreferer=1;
1.232 www 8473: my ($match,$cond)=&is_on_map($uri);
8474: if ($match) {
8475: $statecond=$cond;
1.620 albertel 8476: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 8477: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 8478: my $value = $1;
8479: if ($priv eq 'bre') {
1.1461 raeburn 8480: my $deeplinkblock;
8481: unless ($nodeeplinkcheck) {
8482: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8483: }
1.1458 raeburn 8484: if ($deeplinkblock) {
8485: $thisallowed = 'D';
8486: } elsif ($noblockcheck) {
1.1281 raeburn 8487: $thisallowed.=$value;
1.1162 raeburn 8488: } else {
1.1424 raeburn 8489: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8490: if (@blockers > 0) {
8491: $thisallowed = 'B';
8492: } else {
8493: $thisallowed.=$value;
8494: }
1.1162 raeburn 8495: }
8496: } else {
8497: $thisallowed.=$value;
8498: }
1.52 www 8499: $checkreferer=0;
8500: }
1.29 www 8501: }
1.1424 raeburn 8502:
1.148 www 8503: if ($checkreferer) {
1.620 albertel 8504: my $refuri=$env{'httpref.'.$orguri};
1.148 www 8505: unless ($refuri) {
1.800 albertel 8506: foreach my $key (keys(%env)) {
8507: if ($key=~/^httpref\..*\*/) {
8508: my $pattern=$key;
1.156 www 8509: $pattern=~s/^httpref\.\/res\///;
1.148 www 8510: $pattern=~s/\*/\[\^\/\]\+/g;
8511: $pattern=~s/\//\\\//g;
1.152 www 8512: if ($orguri=~/$pattern/) {
1.800 albertel 8513: $refuri=$env{$key};
1.148 www 8514: }
8515: }
1.191 harris41 8516: }
1.148 www 8517: }
1.232 www 8518:
1.148 www 8519: if ($refuri) {
1.152 www 8520: $refuri=&declutter($refuri);
1.232 www 8521: my ($match,$cond)=&is_on_map($refuri);
8522: if ($match) {
8523: my $refstatecond=$cond;
1.620 albertel 8524: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 8525: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 8526: my $value = $1;
8527: if ($priv eq 'bre') {
1.1461 raeburn 8528: my $deeplinkblock;
8529: unless ($nodeeplinkcheck) {
8530: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8531: }
1.1402 raeburn 8532: if ($deeplinkblock) {
8533: $thisallowed = 'D';
8534: } elsif ($noblockcheck) {
1.1281 raeburn 8535: $thisallowed.=$value;
1.1162 raeburn 8536: } else {
1.1426 raeburn 8537: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 8538: if (@blockers > 0) {
8539: $thisallowed = 'B';
8540: } else {
8541: $thisallowed.=$value;
8542: }
1.1162 raeburn 8543: }
8544: } else {
8545: $thisallowed.=$value;
8546: }
1.53 www 8547: $uri=$refuri;
8548: $statecond=$refstatecond;
1.52 www 8549: }
8550: }
1.148 www 8551: }
1.29 www 8552: }
1.52 www 8553: }
1.29 www 8554:
1.52 www 8555: #
1.103 harris41 8556: # Gathered now: all privileges that could apply, and condition number
1.52 www 8557: #
8558: #
8559: # Full or no access?
8560: #
1.29 www 8561:
1.52 www 8562: if ($thisallowed=~/F/) {
8563: return 'F';
8564: }
1.29 www 8565:
1.52 www 8566: unless ($thisallowed) {
8567: return '';
8568: }
1.29 www 8569:
1.52 www 8570: # Restrictions exist, deal with them
8571: #
8572: # C:according to course preferences
8573: # R:according to resource settings
8574: # L:unless locked
8575: # X:according to user session state
8576: #
8577:
8578: # Possibly locked functionality, check all courses
1.1454 raeburn 8579: # In roles.tab, L (unless locked) available for bre, pch, plc, pac and sma.
1.54 www 8580: # Locks might take effect only after 10 minutes cache expiration for other
1.1454 raeburn 8581: # courses, and 2 minutes for current course, in which user has st or ta role
8582: # which is neither expired nor a future role (unless current course).
1.52 www 8583:
1.1454 raeburn 8584: my ($needlockcheck,$now,$crsonly);
1.52 www 8585: if ($thisallowed=~/L/) {
1.1454 raeburn 8586: $now = time;
8587: if ($priv eq 'bre') {
8588: if ($uri ne '') {
8589: if ($orguri =~ m{^/+res/}) {
8590: if ($uri =~ m{^lib/templates/}) {
8591: if ($env{'request.course.id'}) {
8592: $crsonly = 1;
8593: $needlockcheck = 1;
8594: }
8595: } else {
8596: $needlockcheck = 1;
8597: }
8598: } elsif ($env{'request.course.id'}) {
8599: my ($crsdom,$crsnum) = split('_',$env{'request.course.id'});
8600: if (($uri =~ m{^(adm|uploaded|public)/$crsdom/$crsnum/}) ||
8601: ($uri =~ m{^adm/$match_domain/$match_username/\d+/(smppg|bulletinboard)$})) {
8602: $crsonly = 1;
8603: }
8604: $needlockcheck = 1;
8605: }
8606: }
8607: } elsif (($priv eq 'pch') || ($priv eq 'plc') || ($priv eq 'pac') || ($priv eq 'sma')) {
8608: $needlockcheck = 1;
8609: }
8610: }
8611: if ($needlockcheck) {
1.1453 raeburn 8612: foreach my $envkey (keys(%env)) {
1.54 www 8613: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
8614: my $courseid=$2;
8615: my $roleid=$1.'.'.$2;
1.92 www 8616: $courseid=~s/^\///;
1.1453 raeburn 8617: unless ($env{'request.role'} eq $roleid) {
8618: my ($start,$end) = split(/\./,$env{$envkey});
8619: next unless (($now >= $start) && (!$end || $end > $now));
8620: }
1.54 www 8621: my $expiretime=600;
1.620 albertel 8622: if ($env{'request.role'} eq $roleid) {
1.54 www 8623: $expiretime=120;
8624: }
8625: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
8626: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 8627: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 8628: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 8629: }
1.620 albertel 8630: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
8631: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
8632: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
8633: &log($env{'user.domain'},$env{'user.name'},
8634: $env{'user.home'},
1.57 www 8635: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 8636: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 8637: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 8638: return '';
8639: }
8640: }
1.620 albertel 8641: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
8642: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1.1455 raeburn 8643: if ($env{$prefix.'priv.'.$priv.'.lock.expire'}>time) {
1.620 albertel 8644: &log($env{'user.domain'},$env{'user.name'},
8645: $env{'user.home'},
1.57 www 8646: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 8647: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 8648: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 8649: return '';
8650: }
8651: }
8652: }
1.29 www 8653: }
1.52 www 8654: }
1.1424 raeburn 8655:
1.52 www 8656: #
8657: # Rest of the restrictions depend on selected course
8658: #
8659:
1.620 albertel 8660: unless ($env{'request.course.id'}) {
1.766 albertel 8661: if ($thisallowed eq 'A') {
8662: return 'A';
1.814 raeburn 8663: } elsif ($thisallowed eq 'B') {
8664: return 'B';
1.766 albertel 8665: } else {
8666: return '1';
8667: }
1.52 www 8668: }
1.29 www 8669:
1.52 www 8670: #
8671: # Now user is definitely in a course
8672: #
1.53 www 8673:
8674:
8675: # Course preferences
8676:
8677: if ($thisallowed=~/C/) {
1.620 albertel 8678: my $rolecode=(split(/\./,$env{'request.role'}))[0];
8679: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
8680: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 8681: =~/\Q$rolecode\E/) {
1.1304 raeburn 8682: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 8683: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8684: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
8685: $env{'request.course.id'});
8686: }
1.237 www 8687: return '';
8688: }
8689:
1.620 albertel 8690: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 8691: =~/\Q$unamedom\E/) {
1.1304 raeburn 8692: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 8693: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
8694: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
8695: $env{'request.course.id'});
8696: }
1.54 www 8697: return '';
8698: }
1.53 www 8699: }
8700:
8701: # Resource preferences
8702:
8703: if ($thisallowed=~/R/) {
1.620 albertel 8704: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 8705: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 8706: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 8707: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8708: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
8709: }
8710: return '';
1.54 www 8711: }
1.53 www 8712: }
1.30 www 8713:
1.1461 raeburn 8714: # Restricted for deeplinked session?
8715:
8716: if ($env{'request.deeplink.login'}) {
8717: if ($env{'acc.deeplinkout'} && !$nodeeplinkout) {
8718: if (!$symb) { $symb=&symbread($uri,1); }
8719: if (($symb) && ($env{'acc.deeplinkout'}=~/\&\Q$symb\E\&/)) {
8720: return '';
8721: }
8722: }
8723: }
8724:
1.246 www 8725: # Restricted by state or randomout?
1.30 www 8726:
1.52 www 8727: if ($thisallowed=~/X/) {
1.620 albertel 8728: if ($env{'acc.randomout'}) {
1.579 albertel 8729: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 8730: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 8731: return '';
8732: }
1.247 www 8733: }
8734: if (&condval($statecond)) {
1.52 www 8735: return '2';
8736: } else {
8737: return '';
8738: }
8739: }
1.30 www 8740:
1.766 albertel 8741: if ($thisallowed eq 'A') {
8742: return 'A';
1.814 raeburn 8743: } elsif ($thisallowed eq 'B') {
8744: return 'B';
1.1402 raeburn 8745: } elsif ($thisallowed eq 'D') {
8746: return 'D';
1.766 albertel 8747: }
1.52 www 8748: return 'F';
1.232 www 8749: }
1.1162 raeburn 8750:
1.1192 raeburn 8751: # ------------------------------------------- Check construction space access
8752:
8753: sub constructaccess {
8754: my ($url,$setpriv)=@_;
8755:
8756: # We do not allow editing of previous versions of files
8757: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
8758:
8759: # Get username and domain from URL
8760: my ($ownername,$ownerdomain,$ownerhome);
8761:
8762: ($ownerdomain,$ownername) =
1.1325 raeburn 8763: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
1.1192 raeburn 8764:
8765: # The URL does not really point to any authorspace, forget it
8766: unless (($ownername) && ($ownerdomain)) { return ''; }
8767:
8768: # Now we need to see if the user has access to the authorspace of
8769: # $ownername at $ownerdomain
8770:
8771: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
8772: # Real author for this?
8773: $ownerhome = $env{'user.home'};
8774: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
8775: return ($ownername,$ownerdomain,$ownerhome);
8776: }
8777: } else {
8778: # Co-author for this?
8779: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
8780: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
8781: $ownerhome = &homeserver($ownername,$ownerdomain);
8782: return ($ownername,$ownerdomain,$ownerhome);
8783: }
1.1312 raeburn 8784: if ($env{'request.course.id'}) {
8785: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
8786: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
8787: if (&allowed('mdc',$env{'request.course.id'})) {
8788: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
8789: return ($ownername,$ownerdomain,$ownerhome);
8790: }
8791: }
8792: }
1.1192 raeburn 8793: }
8794:
8795: # We don't have any access right now. If we are not possibly going to do anything about this,
8796: # we might as well leave
8797: unless ($setpriv) { return ''; }
8798:
8799: # Backdoor access?
8800: my $allowed=&allowed('eco',$ownerdomain);
8801: # Nope
8802: unless ($allowed) { return ''; }
8803: # Looks like we may have access, but could be locked by the owner of the construction space
8804: if ($allowed eq 'U') {
8805: my %blocked=&get('environment',['domcoord.author'],
8806: $ownerdomain,$ownername);
8807: # Is blocked by owner
8808: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
8809: }
8810: if (($allowed eq 'F') || ($allowed eq 'U')) {
8811: # Grant temporary access
8812: my $then=$env{'user.login.time'};
1.1209 raeburn 8813: my $update=$env{'user.update.time'};
1.1192 raeburn 8814: if (!$update) { $update = $then; }
8815: my $refresh=$env{'user.refresh.time'};
8816: if (!$refresh) { $refresh = $update; }
8817: my $now = time;
8818: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
8819: $now,'ca','constructaccess');
8820: $ownerhome = &homeserver($ownername,$ownerdomain);
8821: return($ownername,$ownerdomain,$ownerhome);
8822: }
8823: # No business here
8824: return '';
8825: }
8826:
1.1282 raeburn 8827: # ----------------------------------------------------------- Content Blocking
8828:
8829: {
8830: # Caches for faster Course Contents display where content blocking
8831: # is in operation (i.e., interval param set) for timed quiz.
8832: #
8833: # User for whom data are being temporarily cached.
8834: my $cacheduser='';
1.1424 raeburn 8835: # Course for which data are being temporarily cached.
8836: my $cachedcid='';
1.1282 raeburn 8837: # Cached blockers for this user (a hash of blocking items).
8838: my %cachedblockers=();
8839: # When the data were last cached.
8840: my $cachedlast='';
8841:
8842: sub load_all_blockers {
1.1427 raeburn 8843: my ($uname,$udom)=@_;
1.1282 raeburn 8844: if (($uname ne '') && ($udom ne '')) {
8845: if (($cacheduser eq $uname.':'.$udom) &&
1.1424 raeburn 8846: ($cachedcid eq $env{'request.course.id'}) &&
1.1427 raeburn 8847: (abs($cachedlast-time)<5)) {
1.1282 raeburn 8848: return;
8849: }
8850: }
8851: $cachedlast=time;
8852: $cacheduser=$uname.':'.$udom;
1.1424 raeburn 8853: $cachedcid=$env{'request.course.id'};
1.1427 raeburn 8854: %cachedblockers = &get_commblock_resources();
1.1424 raeburn 8855: return;
1.1282 raeburn 8856: }
8857:
1.1162 raeburn 8858: sub get_comm_blocks {
8859: my ($cdom,$cnum) = @_;
8860: if ($cdom eq '' || $cnum eq '') {
8861: return unless ($env{'request.course.id'});
8862: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8863: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8864: }
8865: my %commblocks;
8866: my $hashid=$cdom.'_'.$cnum;
8867: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
8868: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
8869: %commblocks = %{$blocksref};
8870: } else {
8871: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
8872: my $cachetime = 600;
8873: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
8874: }
8875: return %commblocks;
8876: }
8877:
1.1282 raeburn 8878: sub get_commblock_resources {
8879: my ($blocks) = @_;
8880: my %blockers = ();
8881: return %blockers unless ($env{'request.course.id'});
1.1470 raeburn 8882: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
8883: if ($env{'request.course.sec'}) {
8884: $courseurl .= '/'.$env{'request.course.sec'};
8885: }
8886: return %blockers if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
1.1162 raeburn 8887: my %commblocks;
8888: if (ref($blocks) eq 'HASH') {
8889: %commblocks = %{$blocks};
8890: } else {
8891: %commblocks = &get_comm_blocks();
8892: }
1.1282 raeburn 8893: return %blockers unless (keys(%commblocks) > 0);
8894: my $navmap = Apache::lonnavmaps::navmap->new();
8895: return %blockers unless (ref($navmap));
1.1162 raeburn 8896: my $now = time;
8897: foreach my $block (keys(%commblocks)) {
8898: if ($block =~ /^(\d+)____(\d+)$/) {
8899: my ($start,$end) = ($1,$2);
8900: if ($start <= $now && $end >= $now) {
8901: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8902: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8903: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282 raeburn 8904: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8905: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 8906: }
8907: }
8908: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282 raeburn 8909: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8910: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 8911: }
8912: }
8913: }
8914: }
8915: }
8916: } elsif ($block =~ /^firstaccess____(.+)$/) {
8917: my $item = $1;
8918: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8919: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1471 raeburn 8920: my (@interval,$mapname);
1.1282 raeburn 8921: my $type = 'map';
8922: if ($item eq 'course') {
8923: $type = 'course';
8924: @interval=&EXT("resource.0.interval");
8925: } else {
8926: if ($item =~ /___\d+___/) {
8927: $type = 'resource';
8928: @interval=&EXT("resource.0.interval",$item);
1.1162 raeburn 8929: } else {
1.1471 raeburn 8930: $mapname = &deversion($item);
8931: if (ref($navmap)) {
8932: my $timelimit = $navmap->get_mapparam(undef,$mapname,'0.interval');
8933: @interval = ($timelimit,'map');
1.1162 raeburn 8934: }
8935: }
1.1282 raeburn 8936: }
1.1310 raeburn 8937: if ($interval[0] =~ /^(\d+)/) {
1.1308 raeburn 8938: my $timelimit = $1;
1.1282 raeburn 8939: my $first_access;
8940: if ($type eq 'resource') {
8941: $first_access=&get_first_access($interval[1],$item);
8942: } elsif ($type eq 'map') {
8943: $first_access=&get_first_access($interval[1],undef,$item);
8944: } else {
8945: $first_access=&get_first_access($interval[1]);
8946: }
8947: if ($first_access) {
1.1292 raeburn 8948: my $timesup = $first_access+$timelimit;
1.1282 raeburn 8949: if ($timesup > $now) {
8950: my $activeblock;
1.1471 raeburn 8951: if ($type eq 'resource') {
8952: if (ref($navmap)) {
8953: my $res = $navmap->getBySymb($item);
8954: if ($res->answerable()) {
8955: $activeblock = 1;
8956: }
8957: }
8958: } elsif ($type eq 'map') {
8959: my $mapsymb = &symbread($mapname,1);
8960: if (($mapsymb) && (ref($navmap))) {
8961: my $mapres = $navmap->getBySymb($mapsymb);
8962: if (ref($mapres)) {
8963: my $first = $mapres->map_start();
8964: my $finish = $mapres->map_finish();
8965: my $it = $navmap->getIterator($first,$finish,undef,0,0);
8966: if (ref($it)) {
8967: my $res;
8968: while ($res = $it->next(undef,1)) {
8969: next unless (ref($res));
8970: my $symb = $res->symb();
8971: next if (($symb eq $mapsymb) || ($symb eq ''));
8972: @interval=&EXT("resource.0.interval",$symb);
8973: if ($interval[1] eq 'map') {
8974: if ($res->answerable()) {
8975: $activeblock = 1;
8976: last;
8977: }
8978: }
8979: }
8980: }
8981: }
1.1282 raeburn 8982: }
8983: }
8984: if ($activeblock) {
8985: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8986: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8987: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8988: }
8989: }
8990: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8991: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8992: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 8993: }
1.1162 raeburn 8994: }
8995: }
8996: }
8997: }
8998: }
8999: }
9000: }
9001: }
9002: }
1.1282 raeburn 9003: return %blockers;
1.1162 raeburn 9004: }
9005:
1.1282 raeburn 9006: sub has_comm_blocking {
1.1427 raeburn 9007: my ($priv,$symb,$uri,$ignoresymbdb,$noenccheck,$blocked,$blocks) = @_;
1.1282 raeburn 9008: my @blockers;
9009: return unless ($env{'request.course.id'});
9010: return unless ($priv eq 'bre');
9011: return if ($env{'request.state'} eq 'construct');
1.1470 raeburn 9012: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
9013: if ($env{'request.course.sec'}) {
9014: $courseurl .= '/'.$env{'request.course.sec'};
9015: }
9016: return if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
1.1427 raeburn 9017: my %blockinfo;
9018: if (ref($blocks) eq 'HASH') {
9019: %blockinfo = &get_commblock_resources($blocks);
9020: } else {
9021: &load_all_blockers($env{'user.name'},$env{'user.domain'});
9022: %blockinfo = %cachedblockers;
9023: }
9024: return unless (keys(%blockinfo) > 0);
1.1282 raeburn 9025: my (%possibles,@symbs);
9026: if (!$symb) {
1.1427 raeburn 9027: $symb = &symbread($uri,1,1,1,\%possibles,$ignoresymbdb,$noenccheck);
1.1162 raeburn 9028: }
1.1282 raeburn 9029: if ($symb) {
9030: @symbs = ($symb);
9031: } elsif (keys(%possibles)) {
9032: @symbs = keys(%possibles);
9033: }
9034: my $noblock;
9035: foreach my $symb (@symbs) {
9036: last if ($noblock);
9037: my ($map,$resid,$resurl)=&decode_symb($symb);
1.1427 raeburn 9038: foreach my $block (keys(%blockinfo)) {
1.1282 raeburn 9039: if ($block =~ /^firstaccess____(.+)$/) {
9040: my $item = $1;
1.1424 raeburn 9041: unless ($blocked) {
9042: if (($item eq $map) || ($item eq $symb)) {
9043: $noblock = 1;
9044: last;
9045: }
1.1282 raeburn 9046: }
9047: }
1.1427 raeburn 9048: if (ref($blockinfo{$block}) eq 'HASH') {
9049: if (ref($blockinfo{$block}{'resources'}) eq 'HASH') {
9050: if ($blockinfo{$block}{'resources'}{$symb}) {
1.1282 raeburn 9051: unless (grep(/^\Q$block\E$/,@blockers)) {
9052: push(@blockers,$block);
9053: }
9054: }
9055: }
1.1427 raeburn 9056: if (ref($blockinfo{$block}{'maps'}) eq 'HASH') {
9057: if ($blockinfo{$block}{'maps'}{$map}) {
1.1424 raeburn 9058: unless (grep(/^\Q$block\E$/,@blockers)) {
9059: push(@blockers,$block);
9060: }
1.1282 raeburn 9061: }
9062: }
1.1162 raeburn 9063: }
9064: }
9065: }
1.1424 raeburn 9066: unless ($noblock) {
9067: return @blockers;
9068: }
9069: return;
1.1282 raeburn 9070: }
1.1162 raeburn 9071: }
9072:
1.1402 raeburn 9073: sub deeplink_check {
9074: my ($priv,$symb,$uri) = @_;
9075: return unless ($env{'request.course.id'});
9076: return unless ($priv eq 'bre');
9077: return if ($env{'request.state'} eq 'construct');
9078: return if ($env{'request.role.adv'});
9079: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9080: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9081: my (%possibles,@symbs);
9082: if (!$symb) {
9083: $symb = &symbread($uri,1,1,1,\%possibles);
9084: }
9085: if ($symb) {
9086: @symbs = ($symb);
9087: } elsif (keys(%possibles)) {
9088: @symbs = keys(%possibles);
9089: }
9090:
1.1461 raeburn 9091: my ($deeplink_symb,$allow);
9092: if ($env{'request.deeplink.login'}) {
9093: $deeplink_symb = &Apache::loncommon::deeplink_login_symb($cnum,$cdom);
1.1402 raeburn 9094: }
9095: foreach my $symb (@symbs) {
9096: last if ($allow);
9097: my $deeplink = &EXT("resource.0.deeplink",$symb);
9098: if ($deeplink eq '') {
9099: $allow = 1;
9100: } else {
1.1463 raeburn 9101: my ($state,$others,$listed,$scope,$protect) = split(/,/,$deeplink);
9102: if ($state ne 'only') {
1.1402 raeburn 9103: $allow = 1;
1.1463 raeburn 9104: } else {
9105: my $check_deeplink_entry;
9106: if ($protect ne 'none') {
9107: my ($acctype,$item) = split(/:/,$protect);
9108: if (($acctype eq 'ltic') && ($env{'user.linkprotector'})) {
9109: if (grep(/^\Q$item\Ec$/,split(/,/,$env{'user.linkprotector'}))) {
9110: $check_deeplink_entry = 1
9111: }
9112: } elsif (($acctype eq 'ltid') && ($env{'user.linkprotector'})) {
9113: if (grep(/^\Q$item\Ed$/,split(/,/,$env{'user.linkprotector'}))) {
9114: $check_deeplink_entry = 1;
9115: }
9116: } elsif (($acctype eq 'key') && ($env{'user.deeplinkkey'})) {
9117: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.deeplinkkey'}))) {
9118: $check_deeplink_entry = 1;
9119: }
9120: }
9121: }
9122: if (($protect eq 'none') || ($check_deeplink_entry)) {
1.1402 raeburn 9123: if ($scope eq 'res') {
1.1461 raeburn 9124: if ($symb eq $deeplink_symb) {
1.1402 raeburn 9125: $allow = 1;
9126: }
1.1459 raeburn 9127: } elsif (($scope eq 'map') || ($scope eq 'rec')) {
1.1463 raeburn 9128: my ($map_from_symb,$map_from_login);
1.1461 raeburn 9129: $map_from_symb = &deversion((&decode_symb($symb))[0]);
9130: if ($deeplink_symb =~ /\.(page|sequence)$/) {
9131: $map_from_login = &deversion((&decode_symb($deeplink_symb))[2]);
9132: } else {
9133: $map_from_login = &deversion((&decode_symb($deeplink_symb))[0]);
9134: }
1.1459 raeburn 9135: if (($map_from_symb) && ($map_from_login)) {
9136: if ($map_from_symb eq $map_from_login) {
9137: $allow = 1;
9138: } elsif ($scope eq 'rec') {
9139: my @recurseup = &get_map_hierarchy($map_from_symb,$env{'request.course.id'});
9140: if (grep(/^\Q$map_from_login\E$/,@recurseup)) {
9141: $allow = 1;
9142: }
9143: }
9144: }
1.1402 raeburn 9145: }
9146: }
9147: }
9148: }
9149: }
9150: return if ($allow);
9151: return 1;
9152: }
9153:
1.1282 raeburn 9154: # -------------------------------- Deversion and split uri into path an filename
9155:
1.1133 foxr 9156: #
1.1282 raeburn 9157: # Removes the version from a URI and
1.1133 foxr 9158: # splits it in to its filename and path to the filename.
9159: # Seems like File::Basename could have done this more clearly.
9160: # Parameters:
9161: # $uri - input URI
9162: # Returns:
9163: # Two element list consisting of
9164: # $pathname - the URI up to and excluding the trailing /
9165: # $filename - The part of the URI following the last /
9166: # NOTE:
9167: # Another realization of this is simply:
9168: # use File::Basename;
9169: # ...
9170: # $uri = shift;
9171: # $filename = basename($uri);
9172: # $path = dirname($uri);
9173: # return ($filename, $path);
9174: #
9175: # The implementation below is probably faster however.
9176: #
1.710 albertel 9177: sub split_uri_for_cond {
9178: my $uri=&deversion(&declutter(shift));
9179: my @uriparts=split(/\//,$uri);
9180: my $filename=pop(@uriparts);
9181: my $pathname=join('/',@uriparts);
9182: return ($pathname,$filename);
9183: }
1.232 www 9184: # --------------------------------------------------- Is a resource on the map?
9185:
9186: sub is_on_map {
1.710 albertel 9187: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 9188: #Trying to find the conditional for the file
1.620 albertel 9189: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 9190: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 9191: if ($match) {
1.289 bowersj2 9192: return (1,$1);
9193: } else {
1.434 www 9194: return (0,0);
1.289 bowersj2 9195: }
1.12 www 9196: }
9197:
1.427 www 9198: # --------------------------------------------------------- Get symb from alias
9199:
9200: sub get_symb_from_alias {
9201: my $symb=shift;
9202: my ($map,$resid,$url)=&decode_symb($symb);
9203: # Already is a symb
9204: if ($url) { return $symb; }
9205: # Must be an alias
9206: my $aliassymb='';
9207: my %bighash;
1.620 albertel 9208: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 9209: &GDBM_READER(),0640)) {
9210: my $rid=$bighash{'mapalias_'.$symb};
9211: if ($rid) {
9212: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 9213: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
9214: $resid,$bighash{'src_'.$rid});
1.427 www 9215: }
9216: untie %bighash;
9217: }
9218: return $aliassymb;
9219: }
9220:
1.12 www 9221: # ----------------------------------------------------------------- Define Role
9222:
9223: sub definerole {
9224: if (allowed('mcr','/')) {
1.1326 raeburn 9225: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 9226: foreach my $role (split(':',$sysrole)) {
9227: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9228: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
9229: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
9230: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9231: return "refused:s:$crole&$cqual";
9232: }
9233: }
1.191 harris41 9234: }
1.800 albertel 9235: foreach my $role (split(':',$domrole)) {
9236: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9237: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
9238: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
9239: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 9240: return "refused:d:$crole&$cqual";
9241: }
9242: }
1.191 harris41 9243: }
1.800 albertel 9244: foreach my $role (split(':',$courole)) {
9245: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9246: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
9247: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
9248: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9249: return "refused:c:$crole&$cqual";
9250: }
9251: }
1.191 harris41 9252: }
1.1326 raeburn 9253: my $uhome;
9254: if (($uname ne '') && ($udom ne '')) {
9255: $uhome = &homeserver($uname,$udom);
9256: return $uhome if ($uhome eq 'no_host');
9257: } else {
9258: $uname = $env{'user.name'};
9259: $udom = $env{'user.domain'};
9260: $uhome = $env{'user.home'};
9261: }
1.620 albertel 9262: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1326 raeburn 9263: "$udom:$uname:rolesdef_$rolename=".
1.21 www 9264: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1326 raeburn 9265: return reply($command,$uhome);
1.12 www 9266: } else {
9267: return 'refused';
9268: }
1.105 harris41 9269: }
9270:
9271: # ---------------- Make a metadata query against the network of library servers
9272:
9273: sub metadata_query {
1.1237 raeburn 9274: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 9275: my %rhash;
1.845 albertel 9276: my %libserv = &all_library();
1.244 matthew 9277: my @server_list = (defined($server_array) ? @$server_array
9278: : keys(%libserv) );
9279: for my $server (@server_list) {
1.1237 raeburn 9280: my $domains = '';
9281: if (ref($domains_hash) eq 'HASH') {
9282: $domains = $domains_hash->{$server};
9283: }
1.118 harris41 9284: unless ($custom or $customshow) {
1.1237 raeburn 9285: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 9286: $rhash{$server}=$reply;
9287: }
9288: else {
9289: my $reply=&reply("querysend:".&escape($query).':'.
1.1237 raeburn 9290: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 9291: $server);
9292: $rhash{$server}=$reply;
9293: }
1.112 harris41 9294: }
1.118 harris41 9295: return \%rhash;
1.240 www 9296: }
9297:
9298: # ----------------------------------------- Send log queries and wait for reply
9299:
9300: sub log_query {
9301: my ($uname,$udom,$query,%filters)=@_;
9302: my $uhome=&homeserver($uname,$udom);
9303: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 9304: my $uhost=&hostname($uhome);
1.800 albertel 9305: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 9306: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
9307: $uhome);
1.479 albertel 9308: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 9309: return get_query_reply($queryid);
9310: }
9311:
1.818 raeburn 9312: # -------------------------- Update MySQL table for portfolio file
9313:
9314: sub update_portfolio_table {
1.821 raeburn 9315: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 9316: if ($group ne '') {
9317: $file_name =~s /^\Q$group\E//;
9318: }
1.818 raeburn 9319: my $homeserver = &homeserver($uname,$udom);
9320: my $queryid=
1.821 raeburn 9321: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
9322: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 9323: my $reply = &get_query_reply($queryid);
9324: return $reply;
9325: }
9326:
1.899 raeburn 9327: # -------------------------- Update MySQL allusers table
9328:
9329: sub update_allusers_table {
9330: my ($uname,$udom,$names) = @_;
9331: my $homeserver = &homeserver($uname,$udom);
9332: my $queryid=
9333: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
9334: 'lastname='.&escape($names->{'lastname'}).'%%'.
9335: 'firstname='.&escape($names->{'firstname'}).'%%'.
9336: 'middlename='.&escape($names->{'middlename'}).'%%'.
9337: 'generation='.&escape($names->{'generation'}).'%%'.
9338: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
9339: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 9340: return;
1.899 raeburn 9341: }
9342:
1.508 raeburn 9343: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 9344:
9345: sub fetch_enrollment_query {
1.511 raeburn 9346: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1317 raeburn 9347: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 9348: my $maxtries = 1;
1.508 raeburn 9349: if ($context eq 'automated') {
9350: $homeserver = $perlvar{'lonHostID'};
1.1317 raeburn 9351: $sleep = 2;
9352: $loopmax = 100;
1.547 raeburn 9353: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 9354: } else {
9355: $homeserver = &homeserver($cnum,$dom);
9356: }
1.838 albertel 9357: my $host=&hostname($homeserver);
1.506 raeburn 9358: my $cmd = '';
1.1000 raeburn 9359: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 9360: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 9361: }
9362: $cmd =~ s/%%$//;
9363: $cmd = &escape($cmd);
9364: my $query = 'fetchenrollment';
1.620 albertel 9365: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 9366: unless ($queryid=~/^\Q$host\E\_/) {
9367: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
9368: return 'error: '.$queryid;
9369: }
1.1317 raeburn 9370: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9371: my $tries = 1;
9372: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1317 raeburn 9373: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9374: $tries ++;
9375: }
1.526 raeburn 9376: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 9377: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 9378: } else {
1.901 albertel 9379: my @responses = split(/:/,$reply);
1.1322 raeburn 9380: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 9381: foreach my $line (@responses) {
9382: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 9383: $$replyref{$key} = $value;
9384: }
9385: } else {
1.1117 foxr 9386: my $pathname = LONCAPA::tempdir();
1.800 albertel 9387: foreach my $line (@responses) {
9388: my ($key,$value) = split(/=/,$line);
1.506 raeburn 9389: $$replyref{$key} = $value;
9390: if ($value > 0) {
1.800 albertel 9391: foreach my $item (@{$$affiliatesref{$key}}) {
9392: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 9393: my $destname = $pathname.'/'.$filename;
9394: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 9395: if ($xml_classlist =~ /^error/) {
9396: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
9397: } else {
1.1359 raeburn 9398: if ( open(FILE,">",$destname) ) {
1.506 raeburn 9399: print FILE &unescape($xml_classlist);
9400: close(FILE);
1.526 raeburn 9401: } else {
9402: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 9403: }
9404: }
9405: }
9406: }
9407: }
9408: }
9409: return 'ok';
9410: }
9411: return 'error';
9412: }
9413:
1.242 www 9414: sub get_query_reply {
1.1471 raeburn 9415: my ($queryid,$sleep,$loopmax) = @_;
1.1317 raeburn 9416: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
9417: $sleep = 0.2;
9418: }
9419: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
9420: $loopmax = 100;
9421: }
1.1117 foxr 9422: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 9423: my $reply='';
1.1317 raeburn 9424: for (1..$loopmax) {
9425: sleep($sleep);
1.240 www 9426: if (-e $replyfile.'.end') {
1.1359 raeburn 9427: if (open(my $fh,"<",$replyfile)) {
1.904 albertel 9428: $reply = join('',<$fh>);
9429: close($fh);
1.240 www 9430: } else { return 'error: reply_file_error'; }
1.242 www 9431: return &unescape($reply);
9432: }
1.240 www 9433: }
1.242 www 9434: return 'timeout:'.$queryid;
1.240 www 9435: }
9436:
9437: sub courselog_query {
1.241 www 9438: #
9439: # possible filters:
9440: # url: url or symb
9441: # username
9442: # domain
9443: # action: view, submit, grade
9444: # start: timestamp
9445: # end: timestamp
9446: #
1.240 www 9447: my (%filters)=@_;
1.620 albertel 9448: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 9449: if ($filters{'url'}) {
9450: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
9451: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
9452: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
9453: }
1.620 albertel 9454: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
9455: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 9456: return &log_query($cname,$cdom,'courselog',%filters);
9457: }
9458:
9459: sub userlog_query {
1.858 raeburn 9460: #
9461: # possible filters:
9462: # action: log check role
9463: # start: timestamp
9464: # end: timestamp
9465: #
1.240 www 9466: my ($uname,$udom,%filters)=@_;
9467: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 9468: }
9469:
1.506 raeburn 9470: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
9471:
9472: sub auto_run {
1.508 raeburn 9473: my ($cnum,$cdom) = @_;
1.876 raeburn 9474: my $response = 0;
9475: my $settings;
9476: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
9477: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
9478: $settings = $domconfig{'autoenroll'};
9479: if ($settings->{'run'} eq '1') {
9480: $response = 1;
9481: }
9482: } else {
1.934 raeburn 9483: my $homeserver;
9484: if (&is_course($cdom,$cnum)) {
9485: $homeserver = &homeserver($cnum,$cdom);
9486: } else {
9487: $homeserver = &domain($cdom,'primary');
9488: }
9489: if ($homeserver ne 'no_host') {
9490: $response = &reply('autorun:'.$cdom,$homeserver);
9491: }
1.876 raeburn 9492: }
1.506 raeburn 9493: return $response;
9494: }
1.776 albertel 9495:
1.506 raeburn 9496: sub auto_get_sections {
1.508 raeburn 9497: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 9498: my $homeserver;
9499: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9500: $homeserver = &homeserver($cnum,$cdom);
9501: }
9502: if (!defined($homeserver)) {
9503: if ($cdom =~ /^$match_domain$/) {
9504: $homeserver = &domain($cdom,'primary');
9505: }
9506: }
9507: my @secs;
9508: if (defined($homeserver)) {
9509: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
9510: unless ($response eq 'refused') {
9511: @secs = split(/:/,$response);
9512: }
1.506 raeburn 9513: }
9514: return @secs;
9515: }
1.776 albertel 9516:
1.506 raeburn 9517: sub auto_new_course {
1.1099 raeburn 9518: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 9519: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 9520: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 9521: return $response;
9522: }
1.776 albertel 9523:
1.506 raeburn 9524: sub auto_validate_courseID {
1.508 raeburn 9525: my ($cnum,$cdom,$inst_course_id) = @_;
9526: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 9527: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 9528: return $response;
9529: }
1.776 albertel 9530:
1.1007 raeburn 9531: sub auto_validate_instcode {
1.1020 raeburn 9532: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 9533: my ($homeserver,$response);
9534: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9535: $homeserver = &homeserver($cnum,$cdom);
9536: }
9537: if (!defined($homeserver)) {
9538: if ($cdom =~ /^$match_domain$/) {
9539: $homeserver = &domain($cdom,'primary');
9540: }
9541: }
1.1065 raeburn 9542: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
9543: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 9544: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
9545: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 9546: }
9547:
1.1444 raeburn 9548: sub auto_validate_inst_crosslist {
9549: my ($cnum,$cdom,$instcode,$inst_xlist,$coowner) = @_;
9550: my ($homeserver,$response);
9551: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9552: $homeserver = &homeserver($cnum,$cdom);
9553: }
9554: if (!defined($homeserver)) {
9555: if ($cdom =~ /^$match_domain$/) {
9556: $homeserver = &domain($cdom,'primary');
9557: }
9558: }
9559: unless (($homeserver eq '') || ($homeserver eq 'no_host')) {
9560: $response=&reply('autovalidateinstcrosslist:'.$cdom.':'.
9561: &escape($instcode).':'.&escape($inst_xlist).':'.
1.1445 raeburn 9562: &escape($coowner),$homeserver);
1.1444 raeburn 9563: }
9564: return $response;
9565: }
9566:
1.506 raeburn 9567: sub auto_create_password {
1.873 raeburn 9568: my ($cnum,$cdom,$authparam,$udom) = @_;
9569: my ($homeserver,$response);
1.506 raeburn 9570: my $create_passwd = 0;
9571: my $authchk = '';
1.873 raeburn 9572: if ($udom =~ /^$match_domain$/) {
9573: $homeserver = &domain($udom,'primary');
9574: }
9575: if ($homeserver eq '') {
9576: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9577: $homeserver = &homeserver($cnum,$cdom);
9578: }
9579: }
9580: if ($homeserver eq '') {
9581: $authchk = 'nodomain';
1.506 raeburn 9582: } else {
1.873 raeburn 9583: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
9584: if ($response eq 'refused') {
9585: $authchk = 'refused';
9586: } else {
1.901 albertel 9587: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 9588: }
1.506 raeburn 9589: }
9590: return ($authparam,$create_passwd,$authchk);
9591: }
9592:
1.706 raeburn 9593: sub auto_photo_permission {
9594: my ($cnum,$cdom,$students) = @_;
9595: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 9596: my ($outcome,$perm_reqd,$conditions) =
9597: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 9598: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9599: return (undef,undef);
9600: }
1.706 raeburn 9601: return ($outcome,$perm_reqd,$conditions);
9602: }
9603:
9604: sub auto_checkphotos {
9605: my ($uname,$udom,$pid) = @_;
9606: my $homeserver = &homeserver($uname,$udom);
9607: my ($result,$resulttype);
9608: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 9609: &escape($uname).':'.&escape($pid),
9610: $homeserver));
1.709 albertel 9611: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9612: return (undef,undef);
9613: }
1.706 raeburn 9614: if ($outcome) {
9615: ($result,$resulttype) = split(/:/,$outcome);
9616: }
9617: return ($result,$resulttype);
9618: }
9619:
9620: sub auto_photochoice {
9621: my ($cnum,$cdom) = @_;
9622: my $homeserver = &homeserver($cnum,$cdom);
9623: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 9624: &escape($cdom),
9625: $homeserver)));
1.709 albertel 9626: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9627: return (undef,undef);
9628: }
1.706 raeburn 9629: return ($update,$comment);
9630: }
9631:
9632: sub auto_photoupdate {
9633: my ($affiliatesref,$dom,$cnum,$photo) = @_;
9634: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 9635: my $host=&hostname($homeserver);
1.706 raeburn 9636: my $cmd = '';
9637: my $maxtries = 1;
1.800 albertel 9638: foreach my $affiliate (keys(%{$affiliatesref})) {
9639: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 9640: }
9641: $cmd =~ s/%%$//;
9642: $cmd = &escape($cmd);
9643: my $query = 'institutionalphotos';
9644: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
9645: unless ($queryid=~/^\Q$host\E\_/) {
9646: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
9647: return 'error: '.$queryid;
9648: }
9649: my $reply = &get_query_reply($queryid);
9650: my $tries = 1;
9651: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
9652: $reply = &get_query_reply($queryid);
9653: $tries ++;
9654: }
9655: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
9656: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
9657: } else {
9658: my @responses = split(/:/,$reply);
9659: my $outcome = shift(@responses);
9660: foreach my $item (@responses) {
9661: my ($key,$value) = split(/=/,$item);
9662: $$photo{$key} = $value;
9663: }
9664: return $outcome;
9665: }
9666: return 'error';
9667: }
9668:
1.521 raeburn 9669: sub auto_instcode_format {
1.793 albertel 9670: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
9671: $cat_order) = @_;
1.521 raeburn 9672: my $courses = '';
1.772 raeburn 9673: my @homeservers;
1.521 raeburn 9674: if ($caller eq 'global') {
1.841 albertel 9675: my %servers = &get_servers($codedom,'library');
9676: foreach my $tryserver (keys(%servers)) {
9677: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9678: push(@homeservers,$tryserver);
9679: }
1.584 raeburn 9680: }
1.1022 raeburn 9681: } elsif ($caller eq 'requests') {
9682: if ($codedom =~ /^$match_domain$/) {
9683: my $chome = &domain($codedom,'primary');
9684: unless ($chome eq 'no_host') {
9685: push(@homeservers,$chome);
9686: }
9687: }
1.521 raeburn 9688: } else {
1.772 raeburn 9689: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 9690: }
1.793 albertel 9691: foreach my $code (keys(%{$instcodes})) {
9692: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 9693: }
9694: chop($courses);
1.772 raeburn 9695: my $ok_response = 0;
9696: my $response;
9697: while (@homeservers > 0 && $ok_response == 0) {
9698: my $server = shift(@homeservers);
9699: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
9700: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
9701: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 9702: split(/:/,$response);
1.772 raeburn 9703: %{$codes} = (%{$codes},&str2hash($codes_str));
9704: push(@{$codetitles},&str2array($codetitles_str));
9705: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
9706: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
9707: $ok_response = 1;
9708: }
9709: }
9710: if ($ok_response) {
1.521 raeburn 9711: return 'ok';
1.772 raeburn 9712: } else {
9713: return $response;
1.521 raeburn 9714: }
9715: }
9716:
1.792 raeburn 9717: sub auto_instcode_defaults {
9718: my ($domain,$returnhash,$code_order) = @_;
9719: my @homeservers;
1.841 albertel 9720:
9721: my %servers = &get_servers($domain,'library');
9722: foreach my $tryserver (keys(%servers)) {
9723: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9724: push(@homeservers,$tryserver);
9725: }
1.792 raeburn 9726: }
1.841 albertel 9727:
1.792 raeburn 9728: my $response;
1.841 albertel 9729: foreach my $server (@homeservers) {
1.792 raeburn 9730: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 9731: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
9732:
9733: foreach my $pair (split(/\&/,$response)) {
9734: my ($name,$value)=split(/\=/,$pair);
9735: if ($name eq 'code_order') {
9736: @{$code_order} = split(/\&/,&unescape($value));
9737: } else {
9738: $returnhash->{&unescape($name)}=&unescape($value);
9739: }
9740: }
9741: return 'ok';
1.792 raeburn 9742: }
1.841 albertel 9743:
9744: return $response;
1.1003 raeburn 9745: }
9746:
9747: sub auto_possible_instcodes {
1.1007 raeburn 9748: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
9749: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
9750: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9751: return;
9752: }
1.1003 raeburn 9753: my (@homeservers,$uhome);
9754: if (defined(&domain($domain,'primary'))) {
9755: $uhome=&domain($domain,'primary');
9756: push(@homeservers,&domain($domain,'primary'));
9757: } else {
9758: my %servers = &get_servers($domain,'library');
9759: foreach my $tryserver (keys(%servers)) {
9760: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9761: push(@homeservers,$tryserver);
9762: }
9763: }
9764: }
9765: my $response;
9766: foreach my $server (@homeservers) {
9767: $response=&reply('autopossibleinstcodes:'.$domain,$server);
9768: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 9769: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
9770: split(':',$response);
9771: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
9772: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 9773: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 9774: my ($name,$value)=split('=',$item);
9775: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 9776: }
9777: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 9778: my ($name,$value)=split('=',$item);
9779: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 9780: }
9781: return 'ok';
9782: }
9783: return $response;
9784: }
1.792 raeburn 9785:
1.1010 raeburn 9786: sub auto_courserequest_checks {
9787: my ($dom) = @_;
1.1020 raeburn 9788: my ($homeserver,%validations);
9789: if ($dom =~ /^$match_domain$/) {
9790: $homeserver = &domain($dom,'primary');
9791: }
9792: unless ($homeserver eq 'no_host') {
9793: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
9794: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9795: my @items = split(/&/,$response);
9796: foreach my $item (@items) {
9797: my ($key,$value) = split('=',$item);
9798: $validations{&unescape($key)} = &thaw_unescape($value);
9799: }
9800: }
9801: }
1.1010 raeburn 9802: return %validations;
9803: }
9804:
1.1020 raeburn 9805: sub auto_courserequest_validation {
1.1255 raeburn 9806: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 9807: my ($homeserver,$response);
9808: if ($dom =~ /^$match_domain$/) {
9809: $homeserver = &domain($dom,'primary');
9810: }
1.1255 raeburn 9811: unless ($homeserver eq 'no_host') {
9812: my $customdata;
9813: if (ref($custominfo) eq 'HASH') {
9814: $customdata = &freeze_escape($custominfo);
9815: }
1.1020 raeburn 9816: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 9817: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255 raeburn 9818: ':'.&escape($instcode).':'.&escape($instseclist).':'.
9819: $customdata,$homeserver));
1.1020 raeburn 9820: }
9821: return $response;
9822: }
9823:
1.777 albertel 9824: sub auto_validate_class_sec {
1.918 raeburn 9825: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 9826: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 9827: my $ownerlist;
9828: if (ref($owners) eq 'ARRAY') {
9829: $ownerlist = join(',',@{$owners});
9830: } else {
9831: $ownerlist = $owners;
9832: }
1.773 raeburn 9833: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 9834: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 9835: return $response;
9836: }
9837:
1.1460 raeburn 9838: sub auto_instsec_reformat {
9839: my ($cdom,$action,$instsecref) = @_;
9840: return unless(($action eq 'clutter') || ($action eq 'declutter'));
9841: my @homeservers;
9842: if (defined(&domain($cdom,'primary'))) {
9843: push(@homeservers,&domain($cdom,'primary'));
9844: } else {
9845: my %servers = &get_servers($cdom,'library');
9846: foreach my $tryserver (keys(%servers)) {
9847: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9848: push(@homeservers,$tryserver);
9849: }
9850: }
9851: }
9852: my $response;
9853: my %reformatted = %{$instsecref};
9854: foreach my $server (@homeservers) {
9855: if (ref($instsecref) eq 'HASH') {
9856: my $info = &freeze_escape($instsecref);
9857: my $response=&reply('autoinstsecreformat:'.$cdom.':'.
9858: $action.':'.$info,$server);
9859: next if ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/);
9860: my @items = split(/&/,$response);
9861: foreach my $item (@items) {
9862: my ($key,$value) = split(/=/,$item);
9863: $reformatted{&unescape($key)} = &thaw_unescape($value);
9864: }
9865: }
9866: }
9867: return %reformatted;
9868: }
9869:
1.1367 raeburn 9870: sub auto_validate_instclasses {
9871: my ($cdom,$cnum,$owners,$classesref) = @_;
9872: my ($homeserver,%validations);
9873: $homeserver = &homeserver($cnum,$cdom);
9874: unless ($homeserver eq 'no_host') {
9875: my $ownerlist;
9876: if (ref($owners) eq 'ARRAY') {
9877: $ownerlist = join(',',@{$owners});
9878: } else {
9879: $ownerlist = $owners;
9880: }
9881: if (ref($classesref) eq 'HASH') {
9882: my $classes = &freeze_escape($classesref);
9883: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
9884: ':'.$cdom.':'.$classes,$homeserver);
9885: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9886: my @items = split(/&/,$response);
9887: foreach my $item (@items) {
9888: my ($key,$value) = split('=',$item);
9889: $validations{&unescape($key)} = &thaw_unescape($value);
9890: }
9891: }
9892: }
9893: }
9894: return %validations;
9895: }
9896:
1.1248 raeburn 9897: sub auto_crsreq_update {
9898: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257 raeburn 9899: $code,$accessstart,$accessend,$inbound) = @_;
1.1248 raeburn 9900: my ($homeserver,%crsreqresponse);
9901: if ($cdom =~ /^$match_domain$/) {
9902: $homeserver = &domain($cdom,'primary');
9903: }
9904: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
9905: my $info;
9906: if (ref($inbound) eq 'HASH') {
9907: $info = &freeze_escape($inbound);
9908: }
9909: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
9910: ':'.&escape($action).':'.&escape($ownername).':'.
9911: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257 raeburn 9912: &escape($title).':'.&escape($code).':'.
9913: &escape($accessstart).':'.&escape($accessend).':'.$info,
9914: $homeserver);
1.1248 raeburn 9915: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9916: my @items = split(/&/,$response);
9917: foreach my $item (@items) {
9918: my ($key,$value) = split('=',$item);
9919: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
9920: }
9921: }
9922: }
9923: return \%crsreqresponse;
9924: }
9925:
1.1305 raeburn 9926: sub auto_export_grades {
1.1309 raeburn 9927: my ($cdom,$cnum,$inforef,$gradesref) = @_;
9928: my ($homeserver,%exportresponse);
9929: if ($cdom =~ /^$match_domain$/) {
9930: $homeserver = &domain($cdom,'primary');
9931: }
9932: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
9933: my $info;
9934: if (ref($inforef) eq 'HASH') {
9935: $info = &freeze_escape($inforef);
9936: }
9937: if (ref($gradesref) eq 'HASH') {
9938: my $grades = &freeze_escape($gradesref);
9939: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
9940: $info.':'.$grades,$homeserver);
9941: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
9942: my @items = split(/&/,$response);
9943: foreach my $item (@items) {
9944: my ($key,$value) = split('=',$item);
9945: $exportresponse{&unescape($key)} = &thaw_unescape($value);
9946: }
9947: }
9948: }
9949: }
9950: return \%exportresponse;
1.1305 raeburn 9951: }
9952:
1.1287 raeburn 9953: sub check_instcode_cloning {
9954: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
9955: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9956: return;
9957: }
9958: my $canclone;
9959: if (@{$code_order} > 0) {
9960: my $instcoderegexp ='^';
9961: my @clonecodes = split(/\&/,$cloner);
9962: foreach my $item (@{$code_order}) {
9963: if (grep(/^\Q$item\E=/,@clonecodes)) {
9964: foreach my $pair (@clonecodes) {
9965: my ($key,$val) = split(/\=/,$pair,2);
9966: $val = &unescape($val);
9967: if ($key eq $item) {
9968: $instcoderegexp .= '('.$val.')';
9969: last;
9970: }
9971: }
9972: } else {
9973: $instcoderegexp .= $codedefaults->{$item};
9974: }
9975: }
9976: $instcoderegexp .= '$';
9977: my (@from,@to);
9978: eval {
9979: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9980: (@to) = ($clonetocode =~ /$instcoderegexp/);
9981: };
9982: if ((@from > 0) && (@to > 0)) {
9983: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9984: if (!@diffs) {
9985: $canclone = 1;
9986: }
9987: }
9988: }
9989: return $canclone;
9990: }
9991:
9992: sub default_instcode_cloning {
9993: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
9994: my (%codedefaults,@code_order,$canclone);
9995: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
9996: %codedefaults = %{$codedefaultsref};
9997: @code_order = @{$codeorderref};
9998: } elsif ($clonedom) {
9999: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
10000: }
10001: if (($domdefclone) && (@code_order)) {
10002: my @clonecodes = split(/\+/,$domdefclone);
10003: my $instcoderegexp ='^';
10004: foreach my $item (@code_order) {
10005: if (grep(/^\Q$item\E$/,@clonecodes)) {
10006: $instcoderegexp .= '('.$codedefaults{$item}.')';
10007: } else {
10008: $instcoderegexp .= $codedefaults{$item};
10009: }
10010: }
10011: $instcoderegexp .= '$';
10012: my (@from,@to);
10013: eval {
10014: (@from) = ($clonefromcode =~ /$instcoderegexp/);
10015: (@to) = ($clonetocode =~ /$instcoderegexp/);
10016: };
10017: if ((@from > 0) && (@to > 0)) {
10018: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
10019: if (!@diffs) {
10020: $canclone = 1;
10021: }
10022: }
10023: }
10024: return $canclone;
10025: }
10026:
1.679 raeburn 10027: # ------------------------------------------------------- Course Group routines
10028:
10029: sub get_coursegroups {
1.809 raeburn 10030: my ($cdom,$cnum,$group,$namespace) = @_;
10031: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 10032: }
10033:
1.679 raeburn 10034: sub modify_coursegroup {
10035: my ($cdom,$cnum,$groupsettings) = @_;
10036: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
10037: }
10038:
1.809 raeburn 10039: sub toggle_coursegroup_status {
10040: my ($cdom,$cnum,$group,$action) = @_;
10041: my ($from_namespace,$to_namespace);
10042: if ($action eq 'delete') {
10043: $from_namespace = 'coursegroups';
10044: $to_namespace = 'deleted_groups';
10045: } else {
10046: $from_namespace = 'deleted_groups';
10047: $to_namespace = 'coursegroups';
10048: }
10049: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 10050: if (my $tmp = &error(%curr_group)) {
10051: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
10052: return ('read error',$tmp);
10053: } else {
10054: my %savedsettings = %curr_group;
1.809 raeburn 10055: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 10056: my $deloutcome;
10057: if ($result eq 'ok') {
1.809 raeburn 10058: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 10059: } else {
10060: return ('write error',$result);
10061: }
10062: if ($deloutcome eq 'ok') {
10063: return 'ok';
10064: } else {
10065: return ('delete error',$deloutcome);
10066: }
10067: }
10068: }
10069:
1.679 raeburn 10070: sub modify_group_roles {
1.957 raeburn 10071: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 10072: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
10073: my $role = 'gr/'.&escape($userprivs);
10074: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 10075: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 10076: if ($result eq 'ok') {
10077: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
10078: }
1.679 raeburn 10079: return $result;
10080: }
10081:
10082: sub modify_coursegroup_membership {
10083: my ($cdom,$cnum,$membership) = @_;
10084: my $result = &put('groupmembership',$membership,$cdom,$cnum);
10085: return $result;
10086: }
10087:
1.682 raeburn 10088: sub get_active_groups {
10089: my ($udom,$uname,$cdom,$cnum) = @_;
10090: my $now = time;
10091: my %groups = ();
10092: foreach my $key (keys(%env)) {
1.811 albertel 10093: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 10094: my ($start,$end) = split(/\./,$env{$key});
10095: if (($end!=0) && ($end<$now)) { next; }
10096: if (($start!=0) && ($start>$now)) { next; }
10097: if ($1 eq $cdom && $2 eq $cnum) {
10098: $groups{$3} = $env{$key} ;
10099: }
10100: }
10101: }
10102: return %groups;
10103: }
10104:
1.683 raeburn 10105: sub get_group_membership {
10106: my ($cdom,$cnum,$group) = @_;
10107: return(&dump('groupmembership',$cdom,$cnum,$group));
10108: }
10109:
10110: sub get_users_groups {
10111: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 10112: my @usersgroups;
1.683 raeburn 10113: my $cachetime=1800;
10114:
10115: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 10116: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
10117: if (defined($cached)) {
1.734 albertel 10118: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 10119: } else {
10120: $grouplist = '';
1.816 raeburn 10121: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 10122: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 10123: my $access_end = $env{'course.'.$courseid.
10124: '.default_enrollment_end_date'};
10125: my $now = time;
10126: foreach my $key (keys(%roleshash)) {
10127: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
10128: my $group = $1;
10129: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
10130: my $start = $2;
10131: my $end = $1;
10132: if ($start == -1) { next; } # deleted from group
10133: if (($start!=0) && ($start>$now)) { next; }
10134: if (($end!=0) && ($end<$now)) {
10135: if ($access_end && $access_end < $now) {
10136: if ($access_end - $end < 86400) {
10137: push(@usersgroups,$group);
1.733 raeburn 10138: }
10139: }
1.817 raeburn 10140: next;
1.733 raeburn 10141: }
1.817 raeburn 10142: push(@usersgroups,$group);
1.683 raeburn 10143: }
10144: }
10145: }
1.817 raeburn 10146: @usersgroups = &sort_course_groups($courseid,@usersgroups);
10147: $grouplist = join(':',@usersgroups);
10148: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 10149: }
1.733 raeburn 10150: return @usersgroups;
1.683 raeburn 10151: }
10152:
10153: sub devalidate_getgroups_cache {
10154: my ($udom,$uname,$cdom,$cnum)=@_;
10155: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 10156:
1.683 raeburn 10157: my $hashid="$udom:$uname:$courseid";
10158: &devalidate_cache_new('getgroups',$hashid);
10159: }
10160:
1.12 www 10161: # ------------------------------------------------------------------ Plain Text
10162:
10163: sub plaintext {
1.988 raeburn 10164: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 10165: if ($short =~ m{^cr/}) {
1.758 albertel 10166: return (split('/',$short))[-1];
10167: }
1.742 raeburn 10168: if (!defined($cid)) {
10169: $cid = $env{'request.course.id'};
10170: }
10171: my %rolenames = (
1.1008 raeburn 10172: Course => 'std',
10173: Community => 'alt1',
1.1305 raeburn 10174: Placement => 'std',
1.742 raeburn 10175: );
1.1037 raeburn 10176: if ($cid ne '') {
10177: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
10178: unless ($forcedefault) {
10179: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
10180: &Apache::lonlocal::mt_escape(\$roletext);
10181: return &Apache::lonlocal::mt($roletext);
10182: }
10183: }
10184: }
10185: if ((defined($type)) && (defined($rolenames{$type})) &&
10186: (defined($rolenames{$type})) &&
10187: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 10188: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 10189: } elsif ($cid ne '') {
10190: my $crstype = $env{'course.'.$cid.'.type'};
10191: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
10192: (defined($prp{$short}{$rolenames{$crstype}}))) {
10193: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
10194: }
1.742 raeburn 10195: }
1.1037 raeburn 10196: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 10197: }
10198:
10199: # ----------------------------------------------------------------- Assign Role
10200:
10201: sub assignrole {
1.957 raeburn 10202: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
10203: $context)=@_;
1.21 www 10204: my $mrole;
10205: if ($role =~ /^cr\//) {
1.393 www 10206: my $cwosec=$url;
1.811 albertel 10207: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 10208: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 10209: my $refused = 1;
10210: if ($context eq 'requestcourses') {
10211: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
10212: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
10213: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
10214: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
10215: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10216: if ($crsenv{'internal.courseowner'} eq
10217: $env{'user.name'}.':'.$env{'user.domain'}) {
10218: $refused = '';
10219: }
10220: }
10221: }
10222: }
10223: }
10224: if ($refused) {
10225: &logthis('Refused custom assignrole: '.
10226: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
10227: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
10228: return 'refused';
10229: }
1.104 www 10230: }
1.21 www 10231: $mrole='cr';
1.678 raeburn 10232: } elsif ($role =~ /^gr\//) {
10233: my $cwogrp=$url;
1.811 albertel 10234: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 10235: unless (&allowed('mdg',$cwogrp)) {
10236: &logthis('Refused group assignrole: '.
10237: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
10238: $env{'user.name'}.' at '.$env{'user.domain'});
10239: return 'refused';
10240: }
10241: $mrole='gr';
1.21 www 10242: } else {
1.82 www 10243: my $cwosec=$url;
1.811 albertel 10244: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 10245: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
10246: my $refused;
10247: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
10248: if (!(&allowed('c'.$role,$url))) {
10249: $refused = 1;
10250: }
10251: } else {
10252: $refused = 1;
10253: }
1.947 raeburn 10254: if ($refused) {
1.1045 raeburn 10255: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
1.1377 raeburn 10256: if (!$selfenroll && (($context eq 'course') || ($context eq 'ltienroll' && $env{'request.lti.login'}))) {
1.1045 raeburn 10257: my %crsenv;
10258: if ($role eq 'cc' || $role eq 'co') {
10259: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10260: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
10261: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
10262: if ($crsenv{'internal.courseowner'} eq
10263: $env{'user.name'}.':'.$env{'user.domain'}) {
10264: $refused = '';
10265: }
10266: }
10267: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
10268: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
10269: if ($crsenv{'internal.courseowner'} eq
10270: $env{'user.name'}.':'.$env{'user.domain'}) {
10271: $refused = '';
10272: }
10273: }
10274: }
10275: }
1.1368 raeburn 10276: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
10277: if ($role eq 'st') {
10278: $refused = '';
1.1377 raeburn 10279: } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
1.1368 raeburn 10280: $refused = '';
10281: }
1.1017 raeburn 10282: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 10283: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 10284: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 10285: my $wrongcc;
10286: if ($cnum =~ /^$match_community$/) {
10287: $wrongcc = 1 if ($role eq 'cc');
10288: } else {
10289: $wrongcc = 1 if ($role eq 'co');
10290: }
10291: unless ($wrongcc) {
10292: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10293: if ($crsenv{'internal.courseowner'} eq
10294: $env{'user.name'}.':'.$env{'user.domain'}) {
10295: $refused = '';
10296: }
1.1017 raeburn 10297: }
10298: }
1.1183 raeburn 10299: } elsif ($context eq 'requestauthor') {
10300: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
10301: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
10302: if ($env{'environment.requestauthor'} eq 'automatic') {
10303: $refused = '';
10304: } else {
10305: my %domdefaults = &get_domain_defaults($udom);
10306: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
10307: my $checkbystatus;
10308: if ($env{'user.adv'}) {
10309: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
10310: if ($disposition eq 'automatic') {
10311: $refused = '';
10312: } elsif ($disposition eq '') {
10313: $checkbystatus = 1;
10314: }
10315: } else {
10316: $checkbystatus = 1;
10317: }
10318: if ($checkbystatus) {
10319: if ($env{'environment.inststatus'}) {
10320: my @inststatuses = split(/,/,$env{'environment.inststatus'});
10321: foreach my $type (@inststatuses) {
10322: if (($type ne '') &&
10323: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
10324: $refused = '';
10325: }
10326: }
10327: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
10328: $refused = '';
10329: }
10330: }
10331: }
10332: }
10333: }
1.1017 raeburn 10334: }
10335: if ($refused) {
1.947 raeburn 10336: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
10337: ' '.$role.' '.$end.' '.$start.' by '.
10338: $env{'user.name'}.' at '.$env{'user.domain'});
10339: return 'refused';
10340: }
1.932 raeburn 10341: }
1.1131 raeburn 10342: } elsif ($role eq 'au') {
10343: if ($url ne '/'.$udom.'/') {
10344: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
10345: ' to assign author role for '.$uname.':'.$udom.
10346: ' in domain: '.$url.' refused (wrong domain).');
10347: return 'refused';
10348: }
1.104 www 10349: }
1.21 www 10350: $mrole=$role;
10351: }
1.620 albertel 10352: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 10353: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 10354: if ($end) { $command.='_'.$end; }
1.21 www 10355: if ($start) {
10356: if ($end) {
1.81 www 10357: $command.='_'.$start;
1.21 www 10358: } else {
1.81 www 10359: $command.='_0_'.$start;
1.21 www 10360: }
10361: }
1.739 raeburn 10362: my $origstart = $start;
10363: my $origend = $end;
1.957 raeburn 10364: my $delflag;
1.357 www 10365: # actually delete
10366: if ($deleteflag) {
1.373 www 10367: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 10368: # modify command to delete the role
1.620 albertel 10369: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 10370: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 10371: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 10372: # set start and finish to negative values for userrolelog
10373: $start=-1;
10374: $end=-1;
1.957 raeburn 10375: $delflag = 1;
1.357 www 10376: }
10377: }
10378: # send command
1.349 www 10379: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 10380: # log new user role if status is ok
1.349 www 10381: if ($answer eq 'ok') {
1.663 raeburn 10382: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 10383: if (($role eq 'cc') || ($role eq 'in') ||
10384: ($role eq 'ep') || ($role eq 'ad') ||
10385: ($role eq 'ta') || ($role eq 'st') ||
10386: ($role=~/^cr/) || ($role eq 'gr') ||
10387: ($role eq 'co')) {
1.1200 raeburn 10388: # for course roles, perform group memberships changes triggered by role change.
10389: unless ($role =~ /^gr/) {
10390: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
10391: $origstart,$selfenroll,$context);
10392: }
1.1184 raeburn 10393: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10394: $selfenroll,$context);
10395: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1334 raeburn 10396: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
10397: ($role eq 'da')) {
1.1184 raeburn 10398: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10399: $context);
10400: } elsif (($role eq 'ca') || ($role eq 'aa')) {
10401: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10402: $context);
10403: }
1.1053 raeburn 10404: if ($role eq 'cc') {
10405: &autoupdate_coowners($url,$end,$start,$uname,$udom);
10406: }
1.349 www 10407: }
10408: return $answer;
1.169 harris41 10409: }
10410:
1.1053 raeburn 10411: sub autoupdate_coowners {
10412: my ($url,$end,$start,$uname,$udom) = @_;
10413: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
10414: if (($cdom ne '') && ($cnum ne '')) {
10415: my $now = time;
10416: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
10417: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
10418: my %coursehash = &coursedescription($cdom.'_'.$cnum);
10419: my $instcode = $coursehash{'internal.coursecode'};
1.1444 raeburn 10420: my $xlists = $coursehash{'internal.crosslistings'};
1.1053 raeburn 10421: if ($instcode ne '') {
1.1056 raeburn 10422: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
10423: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 10424: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 10425: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
1.1444 raeburn 10426: unless ($result eq 'valid') {
10427: if ($xlists ne '') {
10428: foreach my $xlist (split(',',$xlists)) {
10429: my ($inst_crosslist,$lcsec) = split(':',$xlist);
10430: $result =
1.1446 raeburn 10431: &auto_validate_inst_crosslist($cnum,$cdom,$instcode,
10432: $inst_crosslist,$uname.':'.$udom);
10433: last if ($result eq 'valid');
1.1444 raeburn 10434: }
10435: }
10436: }
1.1056 raeburn 10437: if ($result eq 'valid') {
10438: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 10439: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10440: push(@newcoowners,$coowner);
10441: }
10442: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
10443: push(@newcoowners,$uname.':'.$udom);
10444: }
10445: @newcoowners = sort(@newcoowners);
10446: } else {
10447: push(@newcoowners,$uname.':'.$udom);
10448: }
1.1444 raeburn 10449: } elsif ($coursehash{'internal.co-owners'}) {
10450: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10451: unless ($coowner eq $uname.':'.$udom) {
10452: push(@newcoowners,$coowner);
1.1053 raeburn 10453: }
1.1444 raeburn 10454: }
10455: unless (@newcoowners > 0) {
10456: $delcoowners = 1;
10457: $coowners = '';
1.1053 raeburn 10458: }
10459: }
10460: if (@newcoowners || $delcoowners) {
10461: &store_coowners($cdom,$cnum,$coursehash{'home'},
10462: $delcoowners,@newcoowners);
10463: }
10464: }
10465: }
10466: }
10467: }
10468: }
10469: }
10470:
10471: sub store_coowners {
10472: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
10473: my $cid = $cdom.'_'.$cnum;
10474: my ($coowners,$delresult,$putresult);
10475: if (@newcoowners) {
10476: $coowners = join(',',@newcoowners);
10477: my %coownershash = (
10478: 'internal.co-owners' => $coowners,
10479: );
10480: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
10481: if ($putresult eq 'ok') {
10482: if ($env{'course.'.$cid.'.num'} eq $cnum) {
10483: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
10484: }
10485: }
10486: }
10487: if ($delcoowners) {
10488: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
10489: if ($delresult eq 'ok') {
10490: if ($env{'course.'.$cid.'.internal.co-owners'}) {
10491: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
10492: }
10493: }
10494: }
10495: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
10496: my %crsinfo =
10497: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
10498: if (ref($crsinfo{$cid}) eq 'HASH') {
10499: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
10500: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
10501: }
10502: }
10503: }
10504:
1.169 harris41 10505: # -------------------------------------------------- Modify user authentication
1.197 www 10506: # Overrides without validation
10507:
1.169 harris41 10508: sub modifyuserauth {
10509: my ($udom,$uname,$umode,$upass)=@_;
10510: my $uhome=&homeserver($uname,$udom);
1.1409 raeburn 10511: my $allowed;
10512: if (&allowed('mau',$udom)) {
10513: $allowed = 1;
10514: } elsif (($umode eq 'internal') && ($udom eq $env{'user.domain'}) &&
10515: ($env{'request.course.id'}) && (&allowed('mip',$env{'request.course.id'})) &&
10516: (!$env{'course.'.$env{'request.course.id'}.'.internal.nopasswdchg'})) {
10517: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10518: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10519: if (($cdom ne '') && ($cnum ne '')) {
10520: my $is_owner = &is_course_owner($cdom,$cnum);
10521: if ($is_owner) {
10522: $allowed = 1;
10523: }
10524: }
10525: }
10526: unless ($allowed) { return 'refused'; }
1.197 www 10527: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 10528: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10529: ' in domain '.$env{'request.role.domain'});
1.169 harris41 10530: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
10531: &escape($upass),$uhome);
1.1434 raeburn 10532: my $ip = &get_requestor_ip();
1.620 albertel 10533: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 10534: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
1.1434 raeburn 10535: '(Remote '.$ip.'): '.$reply);
1.197 www 10536: &log($udom,,$uname,$uhome,
1.620 albertel 10537: 'Authentication changed by '.$env{'user.domain'}.', '.
10538: $env{'user.name'}.', '.$umode.
1.1435 raeburn 10539: '(Remote '.$ip.'): '.$reply);
1.169 harris41 10540: unless ($reply eq 'ok') {
1.197 www 10541: &logthis('Authentication mode error: '.$reply);
1.169 harris41 10542: return 'error: '.$reply;
10543: }
1.170 harris41 10544: return 'ok';
1.80 www 10545: }
10546:
1.81 www 10547: # --------------------------------------------------------------- Modify a user
1.80 www 10548:
1.81 www 10549: sub modifyuser {
1.206 matthew 10550: my ($udom, $uname, $uid,
10551: $umode, $upass, $first,
10552: $middle, $last, $gene,
1.1058 raeburn 10553: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 10554: $udom= &LONCAPA::clean_domain($udom);
10555: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 10556: my $showcandelete = 'none';
10557: if (ref($candelete) eq 'ARRAY') {
10558: if (@{$candelete} > 0) {
10559: $showcandelete = join(', ',@{$candelete});
10560: }
10561: }
1.81 www 10562: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 10563: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 10564: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 10565: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
10566: ' desiredhome not specified').
1.620 albertel 10567: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10568: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 10569: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 10570: my $newuser;
10571: if ($uhome eq 'no_host') {
10572: $newuser = 1;
1.1368 raeburn 10573: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
10574: ($umode eq 'lti')) {
10575: return 'error: more information needed to create new user';
10576: }
1.1075 raeburn 10577: }
1.80 www 10578: # ----------------------------------------------------------------- Create User
1.406 albertel 10579: if (($uhome eq 'no_host') &&
1.1368 raeburn 10580: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
1.80 www 10581: my $unhome='';
1.844 albertel 10582: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 10583: $unhome = $desiredhome;
1.620 albertel 10584: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
10585: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 10586: } else { # load balancing routine for determining $unhome
1.81 www 10587: my $loadm=10000000;
1.841 albertel 10588: my %servers = &get_servers($udom,'library');
10589: foreach my $tryserver (keys(%servers)) {
10590: my $answer=reply('load',$tryserver);
10591: if (($answer=~/\d+/) && ($answer<$loadm)) {
10592: $loadm=$answer;
10593: $unhome=$tryserver;
10594: }
1.80 www 10595: }
10596: }
10597: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 10598: return 'error: unable to find a home server for '.$uname.
10599: ' in domain '.$udom;
1.80 www 10600: }
10601: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
10602: &escape($upass),$unhome);
10603: unless ($reply eq 'ok') {
10604: return 'error: '.$reply;
10605: }
1.230 stredwic 10606: $uhome=&homeserver($uname,$udom,'true');
1.80 www 10607: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 10608: return 'error: unable verify users home machine.';
1.80 www 10609: }
1.209 matthew 10610: } # End of creation of new user
1.80 www 10611: # ---------------------------------------------------------------------- Add ID
10612: if ($uid) {
10613: $uid=~tr/A-Z/a-z/;
10614: my %uidhash=&idrget($udom,$uname);
1.196 www 10615: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
10616: && (!$forceid)) {
1.80 www 10617: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 10618: return 'error: user id "'.$uid.'" does not match '.
10619: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 10620: }
10621: } else {
1.1300 raeburn 10622: &idput($udom,{$uname => $uid},$uhome,'ids');
1.80 www 10623: }
10624: }
10625: # -------------------------------------------------------------- Add names, etc
1.313 matthew 10626: my @tmp=&get('environment',
1.899 raeburn 10627: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 10628: 'permanentemail','inststatus'],
1.134 albertel 10629: $udom,$uname);
1.1075 raeburn 10630: my (%names,%oldnames);
1.313 matthew 10631: if ($tmp[0] =~ m/^error:.*/) {
10632: %names=();
10633: } else {
10634: %names = @tmp;
1.1075 raeburn 10635: %oldnames = %names;
1.313 matthew 10636: }
1.388 www 10637: #
1.1058 raeburn 10638: # If name, email and/or uid are blank (e.g., because an uploaded file
10639: # of users did not contain them), do not overwrite existing values
10640: # unless field is in $candelete array ref.
10641: #
10642:
10643: my @fields = ('firstname','middlename','lastname','generation',
10644: 'permanentemail','id');
10645: my %newvalues;
10646: if (ref($candelete) eq 'ARRAY') {
10647: foreach my $field (@fields) {
10648: if (grep(/^\Q$field\E$/,@{$candelete})) {
10649: if ($field eq 'firstname') {
10650: $names{$field} = $first;
10651: } elsif ($field eq 'middlename') {
10652: $names{$field} = $middle;
10653: } elsif ($field eq 'lastname') {
10654: $names{$field} = $last;
10655: } elsif ($field eq 'generation') {
10656: $names{$field} = $gene;
10657: } elsif ($field eq 'permanentemail') {
10658: $names{$field} = $email;
10659: } elsif ($field eq 'id') {
10660: $names{$field} = $uid;
10661: }
10662: }
10663: }
10664: }
1.388 www 10665: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 10666: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 10667: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 10668: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 10669: if ($email) {
10670: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 10671: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 10672: }
1.899 raeburn 10673: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 10674: if (defined($inststatus)) {
10675: $names{'inststatus'} = '';
10676: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
10677: if (ref($usertypes) eq 'HASH') {
10678: my @okstatuses;
10679: foreach my $item (split(/:/,$inststatus)) {
10680: if (defined($usertypes->{$item})) {
10681: push(@okstatuses,$item);
10682: }
10683: }
10684: if (@okstatuses) {
10685: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
10686: }
10687: }
10688: }
1.1075 raeburn 10689: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 10690: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 10691: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 10692: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
10693: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
10694: } else {
10695: $logmsg .= ' during self creation';
10696: }
1.1075 raeburn 10697: my $changed;
10698: if ($newuser) {
10699: $changed = 1;
10700: } else {
10701: foreach my $field (@fields) {
10702: if ($names{$field} ne $oldnames{$field}) {
10703: $changed = 1;
10704: last;
10705: }
10706: }
10707: }
10708: unless ($changed) {
10709: $logmsg = 'No changes in user information needed for: '.$logmsg;
10710: &logthis($logmsg);
10711: return 'ok';
10712: }
10713: my $reply = &put('environment', \%names, $udom,$uname);
10714: if ($reply ne 'ok') {
10715: return 'error: '.$reply;
10716: }
1.1087 raeburn 10717: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
10718: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
10719: }
1.1075 raeburn 10720: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
10721: &devalidate_cache_new('namescache',$uname.':'.$udom);
10722: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 10723: &logthis($logmsg);
1.134 albertel 10724: return 'ok';
1.80 www 10725: }
10726:
1.81 www 10727: # -------------------------------------------------------------- Modify student
1.80 www 10728:
1.81 www 10729: sub modifystudent {
10730: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 10731: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1314 raeburn 10732: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 10733: if (!$cid) {
1.620 albertel 10734: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 10735: return 'not_in_class';
10736: }
1.80 www 10737: }
10738: # --------------------------------------------------------------- Make the user
1.81 www 10739: my $reply=&modifyuser
1.209 matthew 10740: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 10741: $desiredhome,$email,$inststatus);
1.80 www 10742: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 10743: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 10744: # student's environment
1.297 matthew 10745: $uid = undef if (!$forceid);
1.455 albertel 10746: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 10747: $gene,$usec,$end,$start,$type,$locktype,
1.1314 raeburn 10748: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 10749: return $reply;
10750: }
10751:
10752: sub modify_student_enrollment {
1.1216 raeburn 10753: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1314 raeburn 10754: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455 albertel 10755: my ($cdom,$cnum,$chome);
10756: if (!$cid) {
1.620 albertel 10757: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 10758: return 'not_in_class';
10759: }
1.620 albertel 10760: $cdom=$env{'course.'.$cid.'.domain'};
10761: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 10762: } else {
10763: ($cdom,$cnum)=split(/_/,$cid);
10764: }
1.620 albertel 10765: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 10766: if (!$chome) {
1.457 raeburn 10767: $chome=&homeserver($cnum,$cdom);
1.297 matthew 10768: }
1.455 albertel 10769: if (!$chome) { return 'unknown_course'; }
1.297 matthew 10770: # Make sure the user exists
1.81 www 10771: my $uhome=&homeserver($uname,$udom);
10772: if (($uhome eq '') || ($uhome eq 'no_host')) {
10773: return 'error: no such user';
10774: }
1.297 matthew 10775: # Get student data if we were not given enough information
10776: if (!defined($first) || $first eq '' ||
10777: !defined($last) || $last eq '' ||
10778: !defined($uid) || $uid eq '' ||
10779: !defined($middle) || $middle eq '' ||
10780: !defined($gene) || $gene eq '') {
1.294 matthew 10781: # They did not supply us with enough data to enroll the student, so
10782: # we need to pick up more information.
1.297 matthew 10783: my %tmp = &get('environment',
1.294 matthew 10784: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 10785: ,$udom,$uname);
10786:
1.800 albertel 10787: #foreach my $key (keys(%tmp)) {
10788: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 10789: #}
1.294 matthew 10790: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
10791: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
10792: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 10793: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 10794: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
10795: }
1.556 albertel 10796: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 10797: my $user = "$uname:$udom";
10798: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 10799: my $reply=cput('classlist',
1.1148 raeburn 10800: {$user =>
1.1314 raeburn 10801: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 10802: $cdom,$cnum);
1.1148 raeburn 10803: if (($reply eq 'ok') || ($reply eq 'delayed')) {
10804: &devalidate_getsection_cache($udom,$uname,$cid);
10805: } else {
1.81 www 10806: return 'error: '.$reply;
10807: }
1.297 matthew 10808: # Add student role to user
1.83 www 10809: my $uurl='/'.$cid;
1.81 www 10810: $uurl=~s/\_/\//g;
10811: if ($usec) {
10812: $uurl.='/'.$usec;
10813: }
1.1148 raeburn 10814: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
10815: $selfenroll,$context);
10816: if ($result ne 'ok') {
10817: if ($old_entry{$user} ne '') {
10818: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
10819: } else {
10820: $reply = &del('classlist',[$user],$cdom,$cnum);
10821: }
10822: }
10823: return $result;
1.21 www 10824: }
10825:
1.556 albertel 10826: sub format_name {
10827: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
10828: my $name;
10829: if ($first ne 'lastname') {
10830: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
10831: } else {
10832: if ($lastname=~/\S/) {
10833: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
10834: $name=~s/\s+,/,/;
10835: } else {
10836: $name.= $firstname.' '.$middlename.' '.$generation;
10837: }
10838: }
10839: $name=~s/^\s+//;
10840: $name=~s/\s+$//;
10841: $name=~s/\s+/ /g;
10842: return $name;
10843: }
10844:
1.84 www 10845: # ------------------------------------------------- Write to course preferences
10846:
10847: sub writecoursepref {
10848: my ($courseid,%prefs)=@_;
10849: $courseid=~s/^\///;
10850: $courseid=~s/\_/\//g;
10851: my ($cdomain,$cnum)=split(/\//,$courseid);
10852: my $chome=homeserver($cnum,$cdomain);
10853: if (($chome eq '') || ($chome eq 'no_host')) {
10854: return 'error: no such course';
10855: }
10856: my $cstring='';
1.800 albertel 10857: foreach my $pref (keys(%prefs)) {
10858: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 10859: }
1.84 www 10860: $cstring=~s/\&$//;
10861: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
10862: }
10863:
10864: # ---------------------------------------------------------- Make/modify course
10865:
10866: sub createcourse {
1.741 raeburn 10867: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1423 raeburn 10868: $course_owner,$crstype,$cnum,$context,$category,$callercontext)=@_;
1.84 www 10869: $url=&declutter($url);
10870: my $cid='';
1.1028 raeburn 10871: if ($context eq 'requestcourses') {
10872: my $can_create = 0;
10873: my ($ownername,$ownerdom) = split(':',$course_owner);
10874: if ($udom eq $ownerdom) {
1.1423 raeburn 10875: my $reload;
10876: if (($callercontext eq 'auto') &&
10877: ($ownerdom eq $env{'user.domain'}) && ($ownername eq $env{'user.name'})) {
10878: $reload = 'reload';
10879: }
10880: if (&usertools_access($ownername,$ownerdom,$category,$reload,
1.1028 raeburn 10881: $context)) {
10882: $can_create = 1;
10883: }
10884: } else {
10885: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
10886: $category);
10887: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
10888: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
10889: if (@curr > 0) {
10890: my @options = qw(approval validate autolimit);
10891: my $optregex = join('|',@options);
10892: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
10893: $can_create = 1;
10894: }
10895: }
10896: }
10897: }
10898: if ($can_create) {
10899: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
10900: unless (&allowed('ccc',$udom)) {
10901: return 'refused';
10902: }
1.1017 raeburn 10903: }
10904: } else {
10905: return 'refused';
10906: }
1.1028 raeburn 10907: } elsif (!&allowed('ccc',$udom)) {
10908: return 'refused';
1.84 www 10909: }
1.1011 raeburn 10910: # --------------------------------------------------------------- Get Unique ID
10911: my $uname;
10912: if ($cnum =~ /^$match_courseid$/) {
10913: my $chome=&homeserver($cnum,$udom,'true');
10914: if (($chome eq '') || ($chome eq 'no_host')) {
10915: $uname = $cnum;
10916: } else {
1.1038 raeburn 10917: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 10918: }
10919: } else {
1.1038 raeburn 10920: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 10921: }
10922: return $uname if ($uname =~ /^error/);
10923: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 10924: if (!defined($course_server)) {
10925: if (defined(&domain($udom,'primary'))) {
10926: $course_server = &domain($udom,'primary');
10927: } else {
10928: $course_server = $env{'user.home'};
10929: }
10930: }
10931: my %host_servers =
10932: &Apache::lonnet::get_servers($udom,'library');
10933: unless ($host_servers{$course_server}) {
10934: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 10935: }
1.84 www 10936: # ------------------------------------------------------------- Make the course
10937: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 10938: $course_server);
1.84 www 10939: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 10940: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 10941: if (($uhome eq '') || ($uhome eq 'no_host')) {
10942: return 'error: no such course';
10943: }
1.271 www 10944: # ----------------------------------------------------------------- Course made
1.516 raeburn 10945: # log existence
1.1029 raeburn 10946: my $now = time;
1.918 raeburn 10947: my $newcourse = {
10948: $udom.'_'.$uname => {
1.921 raeburn 10949: description => $description,
10950: inst_code => $inst_code,
10951: owner => $course_owner,
10952: type => $crstype,
1.1029 raeburn 10953: creator => $env{'user.name'}.':'.
10954: $env{'user.domain'},
10955: created => $now,
10956: context => $context,
1.918 raeburn 10957: },
10958: };
1.921 raeburn 10959: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 10960: # set toplevel url
1.271 www 10961: my $topurl=$url;
10962: unless ($nonstandard) {
10963: # ------------------------------------------ For standard courses, make top url
10964: my $mapurl=&clutter($url);
1.278 www 10965: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 10966: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 10967: <map>
10968: <resource id="1" type="start"></resource>
10969: <resource id="2" src="$mapurl"></resource>
10970: <resource id="3" type="finish"></resource>
10971: <link index="1" from="1" to="2"></link>
10972: <link index="2" from="2" to="3"></link>
10973: </map>
10974: ENDINITMAP
10975: $topurl=&declutter(
1.638 albertel 10976: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 10977: );
10978: }
10979: # ----------------------------------------------------------- Write preferences
1.84 www 10980: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 10981: ('description' => $description,
10982: 'url' => $topurl,
10983: 'internal.creator' => $env{'user.name'}.':'.
10984: $env{'user.domain'},
10985: 'internal.created' => $now,
10986: 'internal.creationcontext' => $context)
10987: );
1.84 www 10988: return '/'.$udom.'/'.$uname;
10989: }
10990:
1.1011 raeburn 10991: # ------------------------------------------------------------------- Create ID
10992: sub generate_coursenum {
1.1038 raeburn 10993: my ($udom,$crstype) = @_;
1.1011 raeburn 10994: my $domdesc = &domain($udom);
10995: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 10996: my $first;
10997: if ($crstype eq 'Community') {
10998: $first = '0';
10999: } else {
11000: $first = int(1+rand(9));
11001: }
11002: my $uname=$first.
1.1011 raeburn 11003: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11004: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11005: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11006: # ----------------------------------------------- Make sure that does not exist
11007: my $uhome=&homeserver($uname,$udom,'true');
11008: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 11009: if ($crstype eq 'Community') {
11010: $first = '0';
11011: } else {
11012: $first = int(1+rand(9));
11013: }
11014: $uname=$first.
1.1011 raeburn 11015: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11016: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11017: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11018: $uhome=&homeserver($uname,$udom,'true');
11019: unless (($uhome eq '') || ($uhome eq 'no_host')) {
11020: return 'error: unable to generate unique course-ID';
11021: }
11022: }
11023: return $uname;
11024: }
11025:
1.813 albertel 11026: sub is_course {
1.1167 droeschl 11027: my ($cdom, $cnum) = scalar(@_) == 1 ?
11028: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
11029:
1.1381 raeburn 11030: return unless (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/));
11031: my $uhome=&homeserver($cnum,$cdom);
11032: my $iscourse;
11033: if (grep { $_ eq $uhome } current_machine_ids()) {
1.1382 raeburn 11034: $iscourse = &LONCAPA::Lond::is_course($cdom,$cnum);
1.1381 raeburn 11035: } else {
11036: my $hashid = $cdom.':'.$cnum;
11037: ($iscourse,my $cached) = &is_cached_new('iscourse',$hashid);
11038: unless (defined($cached)) {
11039: my %courses = &courseiddump($cdom, '.', 1, '.', '.',
11040: $cnum,undef,undef,'.');
11041: $iscourse = 0;
11042: if (exists($courses{$cdom.'_'.$cnum})) {
11043: $iscourse = 1;
11044: }
11045: &do_cache_new('iscourse',$hashid,$iscourse,3600);
11046: }
11047: }
11048: return unless ($iscourse);
1.1167 droeschl 11049: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 11050: }
11051:
1.1015 raeburn 11052: sub store_userdata {
11053: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 11054: my $result;
1.1016 raeburn 11055: if ($datakey ne '') {
1.1013 raeburn 11056: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 11057: if ($udom eq '' || $uname eq '') {
11058: $udom = $env{'user.domain'};
11059: $uname = $env{'user.name'};
11060: }
11061: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 11062: if (($uhome eq '') || ($uhome eq 'no_host')) {
11063: $result = 'error: no_host';
11064: } else {
1.1434 raeburn 11065: $storehash->{'ip'} = &get_requestor_ip();
1.1013 raeburn 11066: $storehash->{'host'} = $perlvar{'lonHostID'};
11067:
11068: my $namevalue='';
11069: foreach my $key (keys(%{$storehash})) {
11070: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
11071: }
11072: $namevalue=~s/\&$//;
1.1224 raeburn 11073: unless ($namespace eq 'courserequests') {
11074: $datakey = &escape($datakey);
11075: }
1.1105 raeburn 11076: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
11077: $namevalue,$uhome);
1.1013 raeburn 11078: }
11079: } else {
11080: $result = 'error: data to store was not a hash reference';
11081: }
11082: } else {
11083: $result= 'error: invalid requestkey';
11084: }
11085: return $result;
11086: }
11087:
1.21 www 11088: # ---------------------------------------------------------- Assign Custom Role
11089:
11090: sub assigncustomrole {
1.957 raeburn 11091: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11092: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 11093: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 11094: }
11095:
11096: # ----------------------------------------------------------------- Revoke Role
11097:
11098: sub revokerole {
1.957 raeburn 11099: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11100: my $now=time;
1.965 raeburn 11101: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 11102: }
11103:
11104: # ---------------------------------------------------------- Revoke Custom Role
11105:
11106: sub revokecustomrole {
1.957 raeburn 11107: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11108: my $now=time;
1.357 www 11109: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 11110: $deleteflag,$selfenroll,$context);
1.17 www 11111: }
11112:
1.533 banghart 11113: # ------------------------------------------------------------ Disk usage
1.535 albertel 11114: sub diskusage {
1.955 raeburn 11115: my ($udom,$uname,$directorypath,$getpropath)=@_;
11116: $directorypath =~ s/\/$//;
11117: my $listing=&reply('du2:'.&escape($directorypath).':'
11118: .&escape($getpropath).':'.&escape($uname).':'
11119: .&escape($udom),homeserver($uname,$udom));
11120: if ($listing eq 'unknown_cmd') {
11121: if ($getpropath) {
11122: $directorypath = &propath($udom,$uname).'/'.$directorypath;
11123: }
11124: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
11125: }
1.514 albertel 11126: return $listing;
1.512 banghart 11127: }
11128:
1.566 banghart 11129: sub is_locked {
1.1096 raeburn 11130: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 11131: my @check;
11132: my $is_locked;
1.1093 raeburn 11133: push (@check,$file_name);
1.613 albertel 11134: my %locked = &get('file_permissions',\@check,
1.620 albertel 11135: $env{'user.domain'},$env{'user.name'});
1.615 albertel 11136: my ($tmp)=keys(%locked);
11137: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 11138:
1.566 banghart 11139: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 11140: $is_locked = 'false';
11141: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 11142: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 11143: $is_locked = 'true';
1.1096 raeburn 11144: if (ref($which) eq 'ARRAY') {
11145: push(@{$which},$entry);
11146: } else {
11147: last;
11148: }
1.745 raeburn 11149: }
11150: }
1.566 banghart 11151: } else {
11152: $is_locked = 'false';
11153: }
1.1093 raeburn 11154: return $is_locked;
1.566 banghart 11155: }
11156:
1.759 albertel 11157: sub declutter_portfile {
11158: my ($file) = @_;
1.833 albertel 11159: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 11160: return $file;
11161: }
11162:
1.559 banghart 11163: # ------------------------------------------------------------- Mark as Read Only
11164:
11165: sub mark_as_readonly {
11166: my ($domain,$user,$files,$what) = @_;
1.613 albertel 11167: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11168: my ($tmp)=keys(%current_permissions);
11169: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 11170: foreach my $file (@{$files}) {
1.759 albertel 11171: $file = &declutter_portfile($file);
1.561 banghart 11172: push(@{$current_permissions{$file}},$what);
1.559 banghart 11173: }
1.613 albertel 11174: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 11175: return;
11176: }
11177:
1.572 banghart 11178: # ------------------------------------------------------------Save Selected Files
11179:
11180: sub save_selected_files {
11181: my ($user, $path, @files) = @_;
11182: my $filename = $user."savedfiles";
1.573 banghart 11183: my @other_files = &files_not_in_path($user, $path);
1.1359 raeburn 11184: open (OUT,'>',LONCAPA::tempdir().$filename);
1.573 banghart 11185: foreach my $file (@files) {
1.620 albertel 11186: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 11187: }
11188: foreach my $file (@other_files) {
1.574 banghart 11189: print (OUT $file."\n");
1.572 banghart 11190: }
1.574 banghart 11191: close (OUT);
1.572 banghart 11192: return 'ok';
11193: }
11194:
1.574 banghart 11195: sub clear_selected_files {
11196: my ($user) = @_;
11197: my $filename = $user."savedfiles";
1.1359 raeburn 11198: open (OUT,'>',LONCAPA::tempdir().$filename);
1.574 banghart 11199: print (OUT undef);
11200: close (OUT);
11201: return ("ok");
11202: }
11203:
1.572 banghart 11204: sub files_in_path {
11205: my ($user, $path) = @_;
11206: my $filename = $user."savedfiles";
11207: my %return_files;
1.1359 raeburn 11208: open (IN,'<',LONCAPA::tempdir().$filename);
1.573 banghart 11209: while (my $line_in = <IN>) {
1.574 banghart 11210: chomp ($line_in);
11211: my @paths_and_file = split (m!/!, $line_in);
11212: my $file_part = pop (@paths_and_file);
11213: my $path_part = join ('/', @paths_and_file);
1.573 banghart 11214: $path_part.='/';
11215: my $path_and_file = $path_part.$file_part;
11216: if ($path_part eq $path) {
11217: $return_files{$file_part}= 'selected';
11218: }
11219: }
1.574 banghart 11220: close (IN);
11221: return (\%return_files);
1.572 banghart 11222: }
11223:
11224: # called in portfolio select mode, to show files selected NOT in current directory
11225: sub files_not_in_path {
11226: my ($user, $path) = @_;
11227: my $filename = $user."savedfiles";
11228: my @return_files;
11229: my $path_part;
1.1359 raeburn 11230: open(IN, '<',LONCAPA::tempdir().$filename);
1.800 albertel 11231: while (my $line = <IN>) {
1.572 banghart 11232: #ok, I know it's clunky, but I want it to work
1.800 albertel 11233: my @paths_and_file = split(m|/|, $line);
11234: my $file_part = pop(@paths_and_file);
11235: chomp($file_part);
11236: my $path_part = join('/', @paths_and_file);
1.572 banghart 11237: $path_part .= '/';
11238: my $path_and_file = $path_part.$file_part;
11239: if ($path_part ne $path) {
1.800 albertel 11240: push(@return_files, ($path_and_file));
1.572 banghart 11241: }
11242: }
1.800 albertel 11243: close(OUT);
1.574 banghart 11244: return (@return_files);
1.572 banghart 11245: }
11246:
1.1273 raeburn 11247: #------------------------------Submitted/Handedback Portfolio Files Versioning
11248:
11249: sub portfiles_versioning {
11250: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
11251: my $portfolio_root = '/userfiles/portfolio';
11252: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
11253: foreach my $file (@{$portfiles}) {
11254: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
11255: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
11256: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
11257: my $getpropath = 1;
11258: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
11259: $stu_name,$getpropath);
11260: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
11261: my $new_answer =
11262: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
11263: if ($new_answer ne 'problem getting file') {
11264: push(@{$versioned_portfiles}, $directory.$new_answer);
11265: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
11266: [$symb,$env{'request.course.id'},'graded']);
11267: }
11268: }
11269: }
11270:
11271: sub get_next_version {
11272: my ($answer_name, $answer_ext, $dir_list) = @_;
11273: my $version;
11274: if (ref($dir_list) eq 'ARRAY') {
11275: foreach my $row (@{$dir_list}) {
11276: my ($file) = split(/\&/,$row,2);
11277: my ($file_name,$file_version,$file_ext) =
11278: &file_name_version_ext($file);
11279: if (($file_name eq $answer_name) &&
11280: ($file_ext eq $answer_ext)) {
11281: # gets here if filename and extension match,
11282: # regardless of version
11283: if ($file_version ne '') {
11284: # a versioned file is found so save it for later
11285: if ($file_version > $version) {
11286: $version = $file_version;
11287: }
11288: }
11289: }
11290: }
11291: }
11292: $version ++;
11293: return($version);
11294: }
11295:
11296: sub version_selected_portfile {
11297: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
11298: my ($answer_name,$answer_ver,$answer_ext) =
11299: &file_name_version_ext($file_name);
11300: my $new_answer;
11301: $env{'form.copy'} =
11302: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
11303: if($env{'form.copy'} eq '-1') {
11304: $new_answer = 'problem getting file';
11305: } else {
11306: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
11307: my $copy_result =
11308: &finishuserfileupload($stu_name,$domain,'copy',
11309: '/portfolio'.$directory.$new_answer);
11310: }
11311: undef($env{'form.copy'});
11312: return ($new_answer);
11313: }
11314:
11315: sub file_name_version_ext {
11316: my ($file)=@_;
11317: my @file_parts = split(/\./, $file);
11318: my ($name,$version,$ext);
11319: if (@file_parts > 1) {
11320: $ext=pop(@file_parts);
11321: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
11322: $version=pop(@file_parts);
11323: }
11324: $name=join('.',@file_parts);
11325: } else {
11326: $name=join('.',@file_parts);
11327: }
11328: return($name,$version,$ext);
11329: }
11330:
1.745 raeburn 11331: #----------------------------------------------Get portfolio file permissions
1.629 banghart 11332:
1.745 raeburn 11333: sub get_portfile_permissions {
11334: my ($domain,$user) = @_;
1.613 albertel 11335: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11336: my ($tmp)=keys(%current_permissions);
11337: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 11338: return \%current_permissions;
11339: }
11340:
11341: #---------------------------------------------Get portfolio file access controls
11342:
1.749 raeburn 11343: sub get_access_controls {
1.745 raeburn 11344: my ($current_permissions,$group,$file) = @_;
1.769 albertel 11345: my %access;
11346: my $real_file = $file;
11347: $file =~ s/\.meta$//;
1.745 raeburn 11348: if (defined($file)) {
1.749 raeburn 11349: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
11350: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 11351: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 11352: }
11353: }
1.745 raeburn 11354: } else {
1.749 raeburn 11355: foreach my $key (keys(%{$current_permissions})) {
11356: if ($key =~ /\0accesscontrol$/) {
11357: if (defined($group)) {
11358: if ($key !~ m-^\Q$group\E/-) {
11359: next;
11360: }
11361: }
11362: my ($fullpath) = split(/\0/,$key);
11363: if (ref($$current_permissions{$key}) eq 'HASH') {
11364: foreach my $control (keys(%{$$current_permissions{$key}})) {
11365: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
11366: }
11367: }
11368: }
11369: }
11370: }
11371: return %access;
11372: }
11373:
11374: sub modify_access_controls {
11375: my ($file_name,$changes,$domain,$user)=@_;
11376: my ($outcome,$deloutcome);
11377: my %store_permissions;
11378: my %new_values;
11379: my %new_control;
11380: my %translation;
11381: my @deletions = ();
11382: my $now = time;
11383: if (exists($$changes{'activate'})) {
11384: if (ref($$changes{'activate'}) eq 'HASH') {
11385: my @newitems = sort(keys(%{$$changes{'activate'}}));
11386: my $numnew = scalar(@newitems);
11387: for (my $i=0; $i<$numnew; $i++) {
11388: my $newkey = $newitems[$i];
11389: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 11390: if ($newkey =~ /^\d+:/) {
11391: $newkey =~ s/^(\d+)/$newid/;
11392: $translation{$1} = $newid;
11393: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
11394: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
11395: $translation{$1} = $newid;
11396: }
1.749 raeburn 11397: $new_values{$file_name."\0".$newkey} =
11398: $$changes{'activate'}{$newitems[$i]};
11399: $new_control{$newkey} = $now;
11400: }
11401: }
11402: }
11403: my %todelete;
11404: my %changed_items;
11405: foreach my $action ('delete','update') {
11406: if (exists($$changes{$action})) {
11407: if (ref($$changes{$action}) eq 'HASH') {
11408: foreach my $key (keys(%{$$changes{$action}})) {
11409: my ($itemnum) = ($key =~ /^([^:]+):/);
11410: if ($action eq 'delete') {
11411: $todelete{$itemnum} = 1;
11412: } else {
11413: $changed_items{$itemnum} = $key;
11414: }
11415: }
1.745 raeburn 11416: }
11417: }
1.749 raeburn 11418: }
11419: # get lock on access controls for file.
11420: my $lockhash = {
11421: $file_name."\0".'locked_access_records' => $env{'user.name'}.
11422: ':'.$env{'user.domain'},
11423: };
11424: my $tries = 0;
11425: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11426:
1.1288 damieng 11427: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 11428: $tries ++;
1.1289 damieng 11429: sleep(0.1);
1.749 raeburn 11430: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11431: }
11432: if ($gotlock eq 'ok') {
11433: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
11434: my ($tmp)=keys(%curr_permissions);
11435: if ($tmp=~/^error:/) { undef(%curr_permissions); }
11436: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
11437: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
11438: if (ref($curr_controls) eq 'HASH') {
11439: foreach my $control_item (keys(%{$curr_controls})) {
11440: my ($itemnum) = ($control_item =~ /^([^:]+):/);
11441: if (defined($todelete{$itemnum})) {
11442: push(@deletions,$file_name."\0".$control_item);
11443: } else {
11444: if (defined($changed_items{$itemnum})) {
11445: $new_control{$changed_items{$itemnum}} = $now;
11446: push(@deletions,$file_name."\0".$control_item);
11447: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
11448: } else {
11449: $new_control{$control_item} = $$curr_controls{$control_item};
11450: }
11451: }
1.745 raeburn 11452: }
11453: }
11454: }
1.970 raeburn 11455: my ($group);
11456: if (&is_course($domain,$user)) {
11457: ($group,my $file) = split(/\//,$file_name,2);
11458: }
1.749 raeburn 11459: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
11460: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
11461: $outcome = &put('file_permissions',\%new_values,$domain,$user);
11462: # remove lock
11463: my @del_lock = ($file_name."\0".'locked_access_records');
11464: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 11465: my $sqlresult =
1.970 raeburn 11466: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 11467: $group);
1.749 raeburn 11468: } else {
11469: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 11470: }
1.749 raeburn 11471: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 11472: }
11473:
1.827 raeburn 11474: sub make_public_indefinitely {
1.1271 raeburn 11475: my (@requrl) = @_;
11476: return &automated_portfile_access('public',\@requrl);
11477: }
11478:
11479: sub automated_portfile_access {
11480: my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273 raeburn 11481: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
11482: return 'invalid';
11483: }
1.1271 raeburn 11484: my %urls;
11485: if (ref($addsref) eq 'ARRAY') {
11486: foreach my $requrl (@{$addsref}) {
11487: if (&is_portfolio_url($requrl)) {
11488: unless (exists($urls{$requrl})) {
11489: $urls{$requrl} = 'add';
11490: }
11491: }
11492: }
11493: }
11494: if (ref($delsref) eq 'ARRAY') {
11495: foreach my $requrl (@{$delsref}) {
11496: if (&is_portfolio_url($requrl)) {
11497: unless (exists($urls{$requrl})) {
11498: $urls{$requrl} = 'delete';
11499: }
11500: }
11501: }
11502: }
11503: unless (keys(%urls)) {
11504: return 'invalid';
11505: }
11506: my $ip;
11507: if ($accesstype eq 'ip') {
11508: if (ref($info) eq 'HASH') {
11509: if ($info->{'ip'} ne '') {
11510: $ip = $info->{'ip'};
11511: }
11512: }
11513: if ($ip eq '') {
11514: return 'invalid';
11515: }
11516: }
11517: my $errors;
1.827 raeburn 11518: my $now = time;
1.1271 raeburn 11519: my %current_perms;
11520: foreach my $requrl (sort(keys(%urls))) {
11521: my $action;
11522: if ($urls{$requrl} eq 'add') {
11523: $action = 'activate';
11524: } else {
11525: $action = 'none';
11526: }
11527: my $aclnum = 0;
1.827 raeburn 11528: my (undef,$udom,$unum,$file_name,$group) =
11529: &parse_portfolio_url($requrl);
1.1271 raeburn 11530: unless (exists($current_perms{$unum.':'.$udom})) {
11531: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
11532: }
11533: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827 raeburn 11534: $group,$file_name);
11535: foreach my $key (keys(%{$access_controls{$file_name}})) {
11536: my ($num,$scope,$end,$start) =
11537: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271 raeburn 11538: if ($scope eq $accesstype) {
11539: if (($start <= $now) && ($end == 0)) {
11540: if ($accesstype eq 'ip') {
11541: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
11542: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
11543: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
11544: if ($urls{$requrl} eq 'add') {
11545: $action = 'none';
11546: last;
11547: } else {
11548: $action = 'delete';
11549: $aclnum = $num;
11550: last;
11551: }
11552: }
11553: }
11554: }
11555: } elsif ($accesstype eq 'public') {
11556: if ($urls{$requrl} eq 'add') {
11557: $action = 'none';
11558: last;
11559: } else {
11560: $action = 'delete';
11561: $aclnum = $num;
11562: last;
11563: }
11564: }
11565: } elsif ($accesstype eq 'public') {
1.827 raeburn 11566: $action = 'update';
11567: $aclnum = $num;
1.1271 raeburn 11568: last;
1.827 raeburn 11569: }
11570: }
11571: }
11572: if ($action eq 'none') {
1.1271 raeburn 11573: next;
1.827 raeburn 11574: } else {
11575: my %changes;
11576: my $newend = 0;
11577: my $newstart = $now;
1.1271 raeburn 11578: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827 raeburn 11579: $changes{$action}{$newkey} = {
1.1271 raeburn 11580: type => $accesstype,
1.827 raeburn 11581: time => {
11582: start => $newstart,
11583: end => $newend,
11584: },
11585: };
1.1271 raeburn 11586: if ($accesstype eq 'ip') {
11587: $changes{$action}{$newkey}{'ip'} = [$ip];
11588: }
1.827 raeburn 11589: my ($outcome,$deloutcome,$new_values,$translation) =
11590: &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271 raeburn 11591: unless ($outcome eq 'ok') {
11592: $errors .= $outcome.' ';
11593: }
1.827 raeburn 11594: }
1.1271 raeburn 11595: }
11596: if ($errors) {
11597: $errors =~ s/\s$//;
11598: return $errors;
1.827 raeburn 11599: } else {
1.1271 raeburn 11600: return 'ok';
1.827 raeburn 11601: }
11602: }
11603:
1.745 raeburn 11604: #------------------------------------------------------Get Marked as Read Only
11605:
11606: sub get_marked_as_readonly {
11607: my ($domain,$user,$what,$group) = @_;
11608: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 11609: my @readonly_files;
1.629 banghart 11610: my $cmp1=$what;
11611: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 11612: while (my ($file_name,$value) = each(%{$current_permissions})) {
11613: if (defined($group)) {
11614: if ($file_name !~ m-^\Q$group\E/-) {
11615: next;
11616: }
11617: }
1.561 banghart 11618: if (ref($value) eq "ARRAY"){
11619: foreach my $stored_what (@{$value}) {
1.629 banghart 11620: my $cmp2=$stored_what;
1.759 albertel 11621: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 11622: $cmp2=join('',@{$stored_what});
1.745 raeburn 11623: }
1.629 banghart 11624: if ($cmp1 eq $cmp2) {
1.561 banghart 11625: push(@readonly_files, $file_name);
1.745 raeburn 11626: last;
1.563 banghart 11627: } elsif (!defined($what)) {
11628: push(@readonly_files, $file_name);
1.745 raeburn 11629: last;
1.561 banghart 11630: }
11631: }
1.745 raeburn 11632: }
1.561 banghart 11633: }
11634: return @readonly_files;
11635: }
1.577 banghart 11636: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 11637:
1.577 banghart 11638: sub get_marked_as_readonly_hash {
1.745 raeburn 11639: my ($current_permissions,$group,$what) = @_;
1.577 banghart 11640: my %readonly_files;
1.745 raeburn 11641: while (my ($file_name,$value) = each(%{$current_permissions})) {
11642: if (defined($group)) {
11643: if ($file_name !~ m-^\Q$group\E/-) {
11644: next;
11645: }
11646: }
1.577 banghart 11647: if (ref($value) eq "ARRAY"){
11648: foreach my $stored_what (@{$value}) {
1.745 raeburn 11649: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 11650: foreach my $lock_descriptor(@{$stored_what}) {
11651: if ($lock_descriptor eq 'graded') {
11652: $readonly_files{$file_name} = 'graded';
11653: } elsif ($lock_descriptor eq 'handback') {
11654: $readonly_files{$file_name} = 'handback';
11655: } else {
11656: if (!exists($readonly_files{$file_name})) {
11657: $readonly_files{$file_name} = 'locked';
11658: }
11659: }
1.745 raeburn 11660: }
1.750 banghart 11661: }
1.577 banghart 11662: }
11663: }
11664: }
11665: return %readonly_files;
11666: }
1.559 banghart 11667: # ------------------------------------------------------------ Unmark as Read Only
11668:
11669: sub unmark_as_readonly {
1.629 banghart 11670: # unmarks $file_name (if $file_name is defined), or all files locked by $what
11671: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 11672: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 11673: $file_name = &declutter_portfile($file_name);
1.634 albertel 11674: my $symb_crs = $what;
11675: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 11676: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 11677: my ($tmp)=keys(%current_permissions);
11678: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 11679: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 11680: foreach my $file (@readonly_files) {
1.759 albertel 11681: my $clean_file = &declutter_portfile($file);
11682: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 11683: my $current_locks = $current_permissions{$file};
1.563 banghart 11684: my @new_locks;
11685: my @del_keys;
11686: if (ref($current_locks) eq "ARRAY"){
11687: foreach my $locker (@{$current_locks}) {
1.632 albertel 11688: my $compare=$locker;
1.749 raeburn 11689: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 11690: $compare=join('',@{$locker});
1.746 raeburn 11691: if ($compare ne $symb_crs) {
11692: push(@new_locks, $locker);
11693: }
1.563 banghart 11694: }
11695: }
1.650 albertel 11696: if (scalar(@new_locks) > 0) {
1.563 banghart 11697: $current_permissions{$file} = \@new_locks;
11698: } else {
11699: push(@del_keys, $file);
1.613 albertel 11700: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 11701: delete($current_permissions{$file});
1.563 banghart 11702: }
11703: }
1.561 banghart 11704: }
1.613 albertel 11705: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 11706: return;
11707: }
1.512 banghart 11708:
1.17 www 11709: # ------------------------------------------------------------ Directory lister
11710:
11711: sub dirlist {
1.955 raeburn 11712: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 11713: $uri=~s/^\///;
11714: $uri=~s/\/$//;
1.253 stredwic 11715: my ($udom, $uname);
1.955 raeburn 11716: if ($getuserdir) {
1.253 stredwic 11717: $udom = $userdomain;
11718: $uname = $username;
1.955 raeburn 11719: } else {
11720: (undef,$udom,$uname)=split(/\//,$uri);
11721: if(defined($userdomain)) {
11722: $udom = $userdomain;
11723: }
11724: if(defined($username)) {
11725: $uname = $username;
11726: }
1.253 stredwic 11727: }
1.955 raeburn 11728: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 11729:
1.955 raeburn 11730: $dirRoot = $perlvar{'lonDocRoot'};
11731: if (defined($getpropath)) {
11732: $dirRoot = &propath($udom,$uname);
1.253 stredwic 11733: $dirRoot =~ s/\/$//;
1.955 raeburn 11734: } elsif (defined($getuserdir)) {
11735: my $subdir=$uname.'__';
11736: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
11737: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
11738: ."/$udom/$subdir/$uname";
11739: } elsif (defined($alternateRoot)) {
11740: $dirRoot = $alternateRoot;
1.751 banghart 11741: }
1.253 stredwic 11742:
11743: if($udom) {
11744: if($uname) {
1.1135 raeburn 11745: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 11746: if ($uhome eq 'no_host') {
11747: return ([],'no_host');
11748: }
1.955 raeburn 11749: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 11750: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 11751: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 11752: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 11753: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 11754: } else {
11755: @listing_results = map { &unescape($_); } split(/:/,$listing);
11756: }
1.605 matthew 11757: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 11758: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 11759: @listing_results = split(/:/,$listing);
11760: } else {
11761: @listing_results = map { &unescape($_); } split(/:/,$listing);
11762: }
1.1135 raeburn 11763: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 11764: ($listing eq 'rejected') || ($listing eq 'refused') ||
11765: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11766: return ([],$listing);
11767: } else {
11768: return (\@listing_results);
1.1135 raeburn 11769: }
1.955 raeburn 11770: } elsif(!$alternateRoot) {
1.1136 raeburn 11771: my (%allusers,%listerror);
1.841 albertel 11772: my %servers = &get_servers($udom,'library');
1.955 raeburn 11773: foreach my $tryserver (keys(%servers)) {
11774: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
11775: &escape($udom),$tryserver);
11776: if ($listing eq 'unknown_cmd') {
11777: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
11778: $udom, $tryserver);
11779: } else {
11780: @listing_results = map { &unescape($_); } split(/:/,$listing);
11781: }
1.841 albertel 11782: if ($listing eq 'unknown_cmd') {
11783: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
11784: $udom, $tryserver);
11785: @listing_results = split(/:/,$listing);
11786: } else {
11787: @listing_results =
11788: map { &unescape($_); } split(/:/,$listing);
11789: }
1.1136 raeburn 11790: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
11791: ($listing eq 'rejected') || ($listing eq 'refused') ||
11792: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11793: $listerror{$tryserver} = $listing;
11794: } else {
1.841 albertel 11795: foreach my $line (@listing_results) {
11796: my ($entry) = split(/&/,$line,2);
11797: $allusers{$entry} = 1;
11798: }
11799: }
1.253 stredwic 11800: }
1.1136 raeburn 11801: my @alluserslist=();
1.800 albertel 11802: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 11803: push(@alluserslist,$user.'&user');
1.253 stredwic 11804: }
1.1318 droeschl 11805:
11806: if (!%listerror) {
11807: # no errors
11808: return (\@alluserslist);
11809: } elsif (scalar(keys(%servers)) == 1) {
11810: # one library server, one error
11811: my ($key) = keys(%listerror);
11812: return (\@alluserslist, $listerror{$key});
11813: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
11814: # con_lost indicates that we might miss data from at least one
11815: # library server
11816: return (\@alluserslist, 'con_lost');
11817: } else {
11818: # multiple library servers and no con_lost -> data should be
11819: # complete.
11820: return (\@alluserslist);
11821: }
11822:
1.253 stredwic 11823: } else {
1.1136 raeburn 11824: return ([],'missing username');
1.253 stredwic 11825: }
1.955 raeburn 11826: } elsif(!defined($getpropath)) {
1.1136 raeburn 11827: my $path = $perlvar{'lonDocRoot'}.'/res/';
11828: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
11829: return (\@all_domains);
1.955 raeburn 11830: } else {
1.1136 raeburn 11831: return ([],'missing domain');
1.275 stredwic 11832: }
11833: }
11834:
11835: # --------------------------------------------- GetFileTimestamp
11836: # This function utilizes dirlist and returns the date stamp for
11837: # when it was last modified. It will also return an error of -1
11838: # if an error occurs
11839:
11840: sub GetFileTimestamp {
1.955 raeburn 11841: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 11842: $studentDomain = &LONCAPA::clean_domain($studentDomain);
11843: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 11844: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
11845: undef,$getuserdir);
11846: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
11847: return -1;
11848: }
11849: if (ref($fileref) eq 'ARRAY') {
11850: my @stats = split('&',$fileref->[0]);
1.375 matthew 11851: # @stats contains first the filename, then the stat output
11852: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 11853: } else {
11854: return -1;
1.253 stredwic 11855: }
1.26 www 11856: }
11857:
1.712 albertel 11858: sub stat_file {
11859: my ($uri) = @_;
1.787 albertel 11860: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 11861:
1.955 raeburn 11862: my ($udom,$uname,$file);
1.712 albertel 11863: if ($uri =~ m-^/(uploaded|editupload)/-) {
11864: ($udom,$uname,$file) =
1.811 albertel 11865: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 11866: $file = 'userfiles/'.$file;
11867: }
11868: if ($uri =~ m-^/res/-) {
11869: ($udom,$uname) =
1.807 albertel 11870: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 11871: $file = $uri;
11872: }
11873:
11874: if (!$udom || !$uname || !$file) {
11875: # unable to handle the uri
11876: return ();
11877: }
1.956 raeburn 11878: my $getpropath;
11879: if ($file =~ /^userfiles\//) {
11880: $getpropath = 1;
11881: }
1.1136 raeburn 11882: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
11883: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
11884: return ();
11885: } else {
11886: if (ref($listref) eq 'ARRAY') {
11887: my @stats = split('&',$listref->[0]);
11888: shift(@stats); #filename is first
11889: return @stats;
11890: }
1.712 albertel 11891: }
11892: return ();
11893: }
11894:
1.1313 raeburn 11895: # --------------------------------------------------------- recursedirs
11896: # Recursive function to traverse either a specific user's Authoring Space
11897: # or corresponding Published Resource Space, and populate the hash ref:
11898: # $dirhashref with URLs of all directories, and if $filehashref hash
11899: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
11900: # or .rights files in resource space, and .meta, .save, .log, and .bak
11901: # files in Authoring Space.
11902: #
11903: # Inputs:
11904: #
11905: # $is_home - true if current server is home server for user's space
11906: # $context - either: priv, or res respectively for Authoring or Resource Space.
11907: # $docroot - Document root (i.e., /home/httpd/html
11908: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
11909: # $relpath - Current path (relative to top level).
11910: # $dirhashref - reference to hash to populate with URLs of directories (Required)
11911: # $filehashref - reference to hash to populate with URLs of files (Optional)
11912: #
11913: # Returns: nothing
11914: #
11915: # Side Effects: populates $dirhashref, and $filehashref (if provided).
11916: #
11917: # Currently used by interface/londocs.pm to create linked select boxes for
11918: # directory and filename to import a Course "Author" resource into a course, and
11919: # also to create linked select boxes for Authoring Space and Directory to choose
11920: # save location for creation of a new "standard" problem from the Course Editor.
11921: #
11922:
11923: sub recursedirs {
11924: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
11925: return unless (ref($dirhashref) eq 'HASH');
11926: my $currpath = $docroot.$toppath;
11927: if ($relpath) {
11928: $currpath .= "/$relpath";
11929: }
11930: my $savefile;
11931: if (ref($filehashref)) {
11932: $savefile = 1;
11933: }
11934: if ($is_home) {
11935: if (opendir(my $dirh,$currpath)) {
11936: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
11937: next if ($item eq '');
11938: if (-d "$currpath/$item") {
11939: my $newpath;
11940: if ($relpath) {
11941: $newpath = "$relpath/$item";
11942: } else {
11943: $newpath = $item;
11944: }
11945: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
11946: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
11947: } elsif ($savefile) {
11948: if ($context eq 'priv') {
11949: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
11950: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
11951: }
11952: } else {
11953: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
11954: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
11955: }
11956: }
11957: }
11958: }
11959: closedir($dirh);
11960: }
11961: } else {
11962: my ($dirlistref,$listerror) =
11963: &dirlist($toppath.$relpath);
11964: my @dir_lines;
11965: my $dirptr=16384;
11966: if (ref($dirlistref) eq 'ARRAY') {
11967: foreach my $dir_line (sort
11968: {
11969: my ($afile)=split('&',$a,2);
11970: my ($bfile)=split('&',$b,2);
11971: return (lc($afile) cmp lc($bfile));
11972: } (@{$dirlistref})) {
11973: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
11974: split(/\&/,$dir_line,16);
11975: $item =~ s/\s+$//;
11976: next if (($item =~ /^\.\.?$/) || ($obs));
11977: if ($dirptr&$testdir) {
11978: my $newpath;
11979: if ($relpath) {
11980: $newpath = "$relpath/$item";
11981: } else {
11982: $relpath = '/';
11983: $newpath = $item;
11984: }
11985: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
11986: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
11987: } elsif ($savefile) {
11988: if ($context eq 'priv') {
11989: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
11990: $filehashref->{$relpath}{$item} = 1;
11991: }
11992: } else {
11993: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
11994: $filehashref->{$relpath}{$item} = 1;
11995: }
11996: }
11997: }
11998: }
11999: }
12000: }
12001: return;
12002: }
12003:
1.26 www 12004: # -------------------------------------------------------- Value of a Condition
12005:
1.713 albertel 12006: # gets the value of a specific preevaluated condition
12007: # stored in the string $env{user.state.<cid>}
12008: # or looks up a condition reference in the bighash and if if hasn't
12009: # already been evaluated recurses into docondval to get the value of
12010: # the condition, then memoizing it to
12011: # $env{user.state.<cid>.<condition>}
1.40 www 12012: sub directcondval {
12013: my $number=shift;
1.620 albertel 12014: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 12015: &Apache::lonuserstate::evalstate();
12016: }
1.713 albertel 12017: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
12018: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
12019: } elsif ($number =~ /^_/) {
12020: my $sub_condition;
12021: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12022: &GDBM_READER(),0640)) {
12023: $sub_condition=$bighash{'conditions'.$number};
12024: untie(%bighash);
12025: }
12026: my $value = &docondval($sub_condition);
1.949 raeburn 12027: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 12028: return $value;
12029: }
1.620 albertel 12030: if ($env{'user.state.'.$env{'request.course.id'}}) {
12031: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 12032: } else {
12033: return 2;
12034: }
12035: }
12036:
1.713 albertel 12037: # get the collection of conditions for this resource
1.26 www 12038: sub condval {
12039: my $condidx=shift;
1.54 www 12040: my $allpathcond='';
1.713 albertel 12041: foreach my $cond (split(/\|/,$condidx)) {
12042: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
12043: $allpathcond.=
12044: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
12045: }
1.191 harris41 12046: }
1.54 www 12047: $allpathcond=~s/\|$//;
1.713 albertel 12048: return &docondval($allpathcond);
12049: }
12050:
12051: #evaluates an expression of conditions
12052: sub docondval {
12053: my ($allpathcond) = @_;
12054: my $result=0;
12055: if ($env{'request.course.id'}
12056: && defined($allpathcond)) {
12057: my $operand='|';
12058: my @stack;
12059: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
12060: if ($chunk eq '(') {
12061: push @stack,($operand,$result);
12062: } elsif ($chunk eq ')') {
12063: my $before=pop @stack;
12064: if (pop @stack eq '&') {
12065: $result=$result>$before?$before:$result;
12066: } else {
12067: $result=$result>$before?$result:$before;
12068: }
12069: } elsif (($chunk eq '&') || ($chunk eq '|')) {
12070: $operand=$chunk;
12071: } else {
12072: my $new=directcondval($chunk);
12073: if ($operand eq '&') {
12074: $result=$result>$new?$new:$result;
12075: } else {
12076: $result=$result>$new?$result:$new;
12077: }
12078: }
12079: }
1.26 www 12080: }
12081: return $result;
1.421 albertel 12082: }
12083:
12084: # ---------------------------------------------------- Devalidate courseresdata
12085:
12086: sub devalidatecourseresdata {
12087: my ($coursenum,$coursedomain)=@_;
12088: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12089: &devalidate_cache_new('courseres',$hashid);
1.28 www 12090: }
12091:
1.763 www 12092:
1.200 www 12093: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 12094: #
12095: # Parameters:
12096: # $coursenum - Number of the course.
12097: # $coursedomain - Domain at which the course was created.
12098: # Returns:
12099: # A hash of the course parameters along (I think) with timestamps
12100: # and version info.
1.877 foxr 12101:
1.624 albertel 12102: sub get_courseresdata {
12103: my ($coursenum,$coursedomain)=@_;
1.200 www 12104: my $coursehom=&homeserver($coursenum,$coursedomain);
12105: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12106: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 12107: my %dumpreply;
1.417 albertel 12108: unless (defined($cached)) {
1.624 albertel 12109: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 12110: $result=\%dumpreply;
1.251 albertel 12111: my ($tmp) = keys(%dumpreply);
12112: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 12113: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 12114: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
12115: return $tmp;
1.416 albertel 12116: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 12117: $result=undef;
1.599 albertel 12118: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 12119: }
12120: }
1.624 albertel 12121: return $result;
12122: }
12123:
1.633 albertel 12124: sub devalidateuserresdata {
12125: my ($uname,$udom)=@_;
12126: my $hashid="$udom:$uname";
12127: &devalidate_cache_new('userres',$hashid);
12128: }
12129:
1.624 albertel 12130: sub get_userresdata {
12131: my ($uname,$udom)=@_;
12132: #most student don\'t have any data set, check if there is some data
12133: if (&EXT_cache_status($udom,$uname)) { return undef; }
12134:
12135: my $hashid="$udom:$uname";
12136: my ($result,$cached)=&is_cached_new('userres',$hashid);
12137: if (!defined($cached)) {
12138: my %resourcedata=&dump('resourcedata',$udom,$uname);
12139: $result=\%resourcedata;
12140: &do_cache_new('userres',$hashid,$result,600);
12141: }
12142: my ($tmp)=keys(%$result);
12143: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
12144: return $result;
12145: }
12146: #error 2 occurs when the .db doesn't exist
12147: if ($tmp!~/error: 2 /) {
1.1294 raeburn 12148: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
12149: &logthis("<font color=\"blue\">WARNING:".
12150: " Trying to get resource data for ".
12151: $uname." at ".$udom.": ".
12152: $tmp."</font>");
12153: }
1.624 albertel 12154: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 12155: #&EXT_cache_set($udom,$uname);
12156: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 12157: undef($tmp); # not really an error so don't send it back
1.624 albertel 12158: }
12159: return $tmp;
12160: }
1.879 foxr 12161: #----------------------------------------------- resdata - return resource data
12162: # Purpose:
12163: # Return resource data for either users or for a course.
12164: # Parameters:
12165: # $name - Course/user name.
12166: # $domain - Name of the domain the user/course is registered on.
1.1311 raeburn 12167: # $type - Type of thing $name is (must be 'course' or 'user')
1.1301 raeburn 12168: # $mapp - decluttered URL of enclosing map
12169: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
12170: # $recurseup - Ref to array of map URLs, starting with map containing
12171: # $mapp up through hierarchy of nested maps to top level map.
12172: # $courseid - CourseID (first part of param identifier).
12173: # $modifier - Middle part of param identifier.
12174: # $what - Last part of param identifier.
1.879 foxr 12175: # @which - Array of names of resources desired.
12176: # Returns:
12177: # The value of the first reasource in @which that is found in the
12178: # resource hash.
12179: # Exceptional Conditions:
12180: # If the $type passed in is not valid (not the string 'course' or
12181: # 'user', an undefined reference is returned.
12182: # If none of the resources are found, an undef is returned
1.624 albertel 12183: sub resdata {
1.1301 raeburn 12184: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
12185: $modifier,$what,@which)=@_;
1.624 albertel 12186: my $result;
12187: if ($type eq 'course') {
12188: $result=&get_courseresdata($name,$domain);
12189: } elsif ($type eq 'user') {
12190: $result=&get_userresdata($name,$domain);
12191: }
12192: if (!ref($result)) { return $result; }
1.251 albertel 12193: foreach my $item (@which) {
1.1301 raeburn 12194: if ($item->[1] eq 'course') {
12195: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
12196: unless ($$recursed) {
1.1302 raeburn 12197: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
1.1301 raeburn 12198: $$recursed = 1;
12199: }
12200: foreach my $item (@${recurseup}) {
12201: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
12202: last if (defined($result->{$norecursechk}));
12203: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
12204: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
12205: }
12206: }
12207: }
12208: if (defined($result->{$item->[0]})) {
1.927 albertel 12209: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 12210: }
1.250 albertel 12211: }
1.291 albertel 12212: return undef;
1.200 www 12213: }
12214:
1.1360 raeburn 12215: sub get_domain_lti {
12216: my ($cdom,$context) = @_;
12217: my ($name,%lti);
12218: if ($context eq 'consumer') {
12219: $name = 'ltitools';
12220: } elsif ($context eq 'provider') {
12221: $name = 'lti';
12222: } else {
12223: return %lti;
12224: }
12225: my ($result,$cached)=&is_cached_new($name,$cdom);
1.1298 raeburn 12226: if (defined($cached)) {
12227: if (ref($result) eq 'HASH') {
1.1360 raeburn 12228: %lti = %{$result};
1.1298 raeburn 12229: }
12230: } else {
1.1360 raeburn 12231: my %domconfig = &get_dom('configuration',[$name],$cdom);
12232: if (ref($domconfig{$name}) eq 'HASH') {
12233: %lti = %{$domconfig{$name}};
1.1462 raeburn 12234: my %encdomconfig = &get_dom('encconfig',[$name],$cdom,undef,1);
1.1360 raeburn 12235: if (ref($encdomconfig{$name}) eq 'HASH') {
12236: foreach my $id (keys(%lti)) {
12237: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
1.1344 raeburn 12238: foreach my $item ('key','secret') {
1.1360 raeburn 12239: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
1.1344 raeburn 12240: }
12241: }
12242: }
12243: }
1.1298 raeburn 12244: }
12245: my $cachetime = 24*60*60;
1.1360 raeburn 12246: &do_cache_new($name,$cdom,\%lti,$cachetime);
1.1298 raeburn 12247: }
1.1360 raeburn 12248: return %lti;
1.1298 raeburn 12249: }
12250:
1.1463 raeburn 12251: sub get_course_lti {
12252: my ($cnum,$cdom) = @_;
12253: my $hashid=$cdom.'_'.$cnum;
12254: my %courselti;
12255: my ($result,$cached)=&is_cached_new('courselti',$hashid);
12256: if (defined($cached)) {
12257: if (ref($result) eq 'HASH') {
12258: %courselti = %{$result};
12259: }
12260: } else {
12261: %courselti = &dump('lti',$cdom,$cnum,undef,undef,undef,1);
12262: my $cachetime = 24*60*60;
12263: &do_cache_new('courselti',$hashid,\%courselti,$cachetime);
12264: }
12265: return %courselti;
12266: }
12267:
1.1236 raeburn 12268: sub get_numsuppfiles {
12269: my ($cnum,$cdom,$ignorecache)=@_;
12270: my $hashid=$cnum.':'.$cdom;
12271: my ($suppcount,$cached);
12272: unless ($ignorecache) {
12273: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
12274: }
12275: unless (defined($cached)) {
12276: my $chome=&homeserver($cnum,$cdom);
12277: unless ($chome eq 'no_host') {
1.1366 raeburn 12278: ($suppcount,my $supptools,my $errors) = (0,0,0);
1.1236 raeburn 12279: my $suppmap = 'supplemental.sequence';
1.1366 raeburn 12280: ($suppcount,$supptools,$errors) =
12281: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,
12282: $supptools,$errors);
1.1236 raeburn 12283: }
12284: &do_cache_new('suppcount',$hashid,$suppcount,600);
12285: }
12286: return $suppcount;
12287: }
12288:
1.379 matthew 12289: #
12290: # EXT resource caching routines
12291: #
12292:
1.1302 raeburn 12293: {
12294: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
12295: #
12296: # The course for which we cache
12297: my $cachedmapkey='';
12298: # The cached recursive maps for this course
12299: my %cachedmaps=();
12300: # When this was last done
12301: my $cachedmaptime='';
12302:
1.379 matthew 12303: sub clear_EXT_cache_status {
1.383 albertel 12304: &delenv('cache.EXT.');
1.379 matthew 12305: }
12306:
12307: sub EXT_cache_status {
12308: my ($target_domain,$target_user) = @_;
1.383 albertel 12309: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 12310: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 12311: # We know already the user has no data
12312: return 1;
12313: } else {
12314: return 0;
12315: }
12316: }
12317:
12318: sub EXT_cache_set {
12319: my ($target_domain,$target_user) = @_;
1.383 albertel 12320: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 12321: #&appenv({$cachename => time});
1.379 matthew 12322: }
12323:
1.28 www 12324: # --------------------------------------------------------- Value of a Variable
1.58 www 12325: sub EXT {
1.715 albertel 12326:
1.1461 raeburn 12327: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid,$recurseupref)=@_;
1.68 www 12328: unless ($varname) { return ''; }
1.218 albertel 12329: #get real user name/domain, courseid and symb
12330: my $courseid;
1.359 albertel 12331: my $publicuser;
1.427 www 12332: if ($symbparm) {
12333: $symbparm=&get_symb_from_alias($symbparm);
12334: }
1.218 albertel 12335: if (!($uname && $udom)) {
1.790 albertel 12336: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 12337: if (!$symbparm) { $symbparm=$cursymb; }
12338: } else {
1.620 albertel 12339: $courseid=$env{'request.course.id'};
1.218 albertel 12340: }
1.48 www 12341: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
12342: my $rest;
1.320 albertel 12343: if (defined($therest[0])) {
1.48 www 12344: $rest=join('.',@therest);
12345: } else {
12346: $rest='';
12347: }
1.320 albertel 12348:
1.57 www 12349: my $qualifierrest=$qualifier;
12350: if ($rest) { $qualifierrest.='.'.$rest; }
12351: my $spacequalifierrest=$space;
12352: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 12353: if ($realm eq 'user') {
1.48 www 12354: # --------------------------------------------------------------- user.resource
12355: if ($space eq 'resource') {
1.651 albertel 12356: if ( (defined($Apache::lonhomework::parsing_a_problem)
12357: || defined($Apache::lonhomework::parsing_a_task))
12358: &&
1.1469 raeburn 12359: ($symbparm eq &symbread()) ) {
1.744 albertel 12360: # if we are in the middle of processing the resource the
12361: # get the value we are planning on committing
12362: if (defined($Apache::lonhomework::results{$qualifierrest})) {
12363: return $Apache::lonhomework::results{$qualifierrest};
12364: } else {
12365: return $Apache::lonhomework::history{$qualifierrest};
12366: }
1.335 albertel 12367: } else {
1.359 albertel 12368: my %restored;
1.620 albertel 12369: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 12370: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
12371: } else {
12372: %restored=&restore($symbparm,$courseid,$udom,$uname);
12373: }
1.335 albertel 12374: return $restored{$qualifierrest};
12375: }
1.48 www 12376: # ----------------------------------------------------------------- user.access
12377: } elsif ($space eq 'access') {
1.218 albertel 12378: # FIXME - not supporting calls for a specific user
1.48 www 12379: return &allowed($qualifier,$rest);
12380: # ------------------------------------------ user.preferences, user.environment
12381: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 12382: if (($uname eq $env{'user.name'}) &&
12383: ($udom eq $env{'user.domain'})) {
12384: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 12385: } else {
1.359 albertel 12386: my %returnhash;
12387: if (!$publicuser) {
12388: %returnhash=&userenvironment($udom,$uname,
12389: $qualifierrest);
12390: }
1.218 albertel 12391: return $returnhash{$qualifierrest};
12392: }
1.48 www 12393: # ----------------------------------------------------------------- user.course
12394: } elsif ($space eq 'course') {
1.218 albertel 12395: # FIXME - not supporting calls for a specific user
1.620 albertel 12396: return $env{join('.',('request.course',$qualifier))};
1.48 www 12397: # ------------------------------------------------------------------- user.role
12398: } elsif ($space eq 'role') {
1.218 albertel 12399: # FIXME - not supporting calls for a specific user
1.620 albertel 12400: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 12401: if ($qualifier eq 'value') {
12402: return $role;
12403: } elsif ($qualifier eq 'extent') {
12404: return $where;
12405: }
12406: # ----------------------------------------------------------------- user.domain
12407: } elsif ($space eq 'domain') {
1.218 albertel 12408: return $udom;
1.48 www 12409: # ------------------------------------------------------------------- user.name
12410: } elsif ($space eq 'name') {
1.218 albertel 12411: return $uname;
1.48 www 12412: # ---------------------------------------------------- Any other user namespace
1.29 www 12413: } else {
1.359 albertel 12414: my %reply;
12415: if (!$publicuser) {
12416: %reply=&get($space,[$qualifierrest],$udom,$uname);
12417: }
12418: return $reply{$qualifierrest};
1.48 www 12419: }
1.236 www 12420: } elsif ($realm eq 'query') {
12421: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 12422: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
12423: [$spacequalifierrest]);
1.620 albertel 12424: return $env{'form.'.$spacequalifierrest};
1.236 www 12425: } elsif ($realm eq 'request') {
1.48 www 12426: # ------------------------------------------------------------- request.browser
12427: if ($space eq 'browser') {
1.1145 bisitz 12428: return $env{'browser.'.$qualifier};
1.57 www 12429: # ------------------------------------------------------------ request.filename
12430: } else {
1.620 albertel 12431: return $env{'request.'.$spacequalifierrest};
1.29 www 12432: }
1.28 www 12433: } elsif ($realm eq 'course') {
1.48 www 12434: # ---------------------------------------------------------- course.description
1.620 albertel 12435: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 12436: } elsif ($realm eq 'resource') {
1.165 www 12437:
1.620 albertel 12438: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 12439: if (!$symbparm) { $symbparm=&symbread(); }
12440: }
1.693 albertel 12441:
1.1232 raeburn 12442: if ($qualifier eq '') {
12443: if ($space eq 'title') {
12444: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
12445: return &gettitle($symbparm);
12446: }
1.693 albertel 12447:
1.1232 raeburn 12448: if ($space eq 'map') {
12449: my ($map) = &decode_symb($symbparm);
12450: return &symbread($map);
12451: }
12452: if ($space eq 'maptitle') {
12453: my ($map) = &decode_symb($symbparm);
12454: return &gettitle($map);
12455: }
12456: if ($space eq 'filename') {
12457: if ($symbparm) {
12458: return &clutter((&decode_symb($symbparm))[2]);
12459: }
12460: return &hreflocation('',$env{'request.filename'});
1.905 albertel 12461: }
1.1232 raeburn 12462:
1.1233 raeburn 12463: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
12464: if ($space eq 'visibleparts') {
12465: my $navmap = Apache::lonnavmaps::navmap->new();
12466: my $item;
12467: if (ref($navmap)) {
12468: my $res = $navmap->getBySymb($symbparm);
12469: my $parts = $res->parts();
12470: if (ref($parts) eq 'ARRAY') {
12471: $item = join(',',@{$parts});
12472: }
12473: undef($navmap);
1.1232 raeburn 12474: }
1.1233 raeburn 12475: return $item;
1.1232 raeburn 12476: }
12477: }
12478: }
1.693 albertel 12479:
1.1301 raeburn 12480: my ($section, $group, @groups, @recurseup, $recursed);
1.1461 raeburn 12481: if (ref($recurseupref) eq 'ARRAY') {
12482: @recurseup = @{$recurseupref};
12483: $recursed = 1;
12484: }
1.1301 raeburn 12485: my ($courselevelm,$courseleveli,$courselevel,$mapp);
1.1228 raeburn 12486: if (($courseid eq '') && ($cid)) {
12487: $courseid = $cid;
12488: }
12489: if (($symbparm && $courseid) &&
12490: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 12491:
1.218 albertel 12492: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 12493:
1.60 www 12494: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 12495: my $symbp=$symbparm;
1.1301 raeburn 12496: $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 12497: my $symbparm=$symbp.'.'.$spacequalifierrest;
1.1301 raeburn 12498: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
1.218 albertel 12499: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.620 albertel 12500: if (($env{'user.name'} eq $uname) &&
12501: ($env{'user.domain'} eq $udom)) {
12502: $section=$env{'request.course.sec'};
1.733 raeburn 12503: @groups = split(/:/,$env{'request.course.groups'});
12504: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 12505: } else {
1.539 albertel 12506: if (! defined($usection)) {
1.551 albertel 12507: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 12508: } else {
12509: $section = $usection;
12510: }
1.733 raeburn 12511: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 12512: }
12513:
12514: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
12515: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
1.1301 raeburn 12516: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
1.218 albertel 12517: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
12518:
1.593 albertel 12519: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 12520: my $courselevelr=$courseid.'.'.$symbparm;
1.1301 raeburn 12521: $courseleveli=$courseid.'.'.$recurseparm;
1.593 albertel 12522: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 12523:
1.60 www 12524: # ----------------------------------------------------------- first, check user
1.624 albertel 12525:
1.1301 raeburn 12526: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
12527: \@recurseup,$courseid,'.',$spacequalifierrest,
1.927 albertel 12528: ([$courselevelr,'resource'],
12529: [$courselevelm,'map' ],
1.1301 raeburn 12530: [$courseleveli,'map' ],
1.927 albertel 12531: [$courselevel, 'course' ]));
1.931 albertel 12532: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 12533:
1.594 albertel 12534: # ------------------------------------------------ second, check some of course
1.684 raeburn 12535: my $coursereply;
1.691 raeburn 12536: if (@groups > 0) {
12537: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
1.1301 raeburn 12538: $recurseparm,$mapparm,$spacequalifierrest,
12539: $mapp,\$recursed,\@recurseup);
12540: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 12541: }
1.96 www 12542:
1.684 raeburn 12543: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 12544: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 12545: 'course',$mapp,\$recursed,\@recurseup,
12546: $courseid,'.['.$section.'].',$spacequalifierrest,
1.927 albertel 12547: ([$seclevelr, 'resource'],
12548: [$seclevelm, 'map' ],
1.1301 raeburn 12549: [$secleveli, 'map' ],
1.927 albertel 12550: [$seclevel, 'course' ],
12551: [$courselevelr,'resource']));
12552: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 12553:
1.60 www 12554: # ------------------------------------------------------ third, check map parms
1.218 albertel 12555: my %parmhash=();
12556: my $thisparm='';
12557: if (tie(%parmhash,'GDBM_File',
1.620 albertel 12558: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 12559: &GDBM_READER(),0640)) {
1.218 albertel 12560: $thisparm=$parmhash{$symbparm};
12561: untie(%parmhash);
12562: }
1.927 albertel 12563: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 12564: }
1.594 albertel 12565: # ------------------------------------------ fourth, look in resource metadata
1.1301 raeburn 12566:
12567: my $what = $spacequalifierrest;
12568: $what=~s/\./\_/;
1.282 albertel 12569: my $filename;
12570: if (!$symbparm) { $symbparm=&symbread(); }
12571: if ($symbparm) {
1.409 www 12572: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 12573: } else {
1.620 albertel 12574: $filename=$env{'request.filename'};
1.282 albertel 12575: }
1.1362 raeburn 12576: my $toolsymb;
12577: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
12578: $toolsymb = $symbparm;
12579: }
12580: my $metadata=&metadata($filename,$what,$toolsymb);
1.927 albertel 12581: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.1362 raeburn 12582: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
1.927 albertel 12583: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 12584:
1.1301 raeburn 12585: # ----------------------------------------------- fifth, look in rest of course
1.593 albertel 12586: if ($symbparm && defined($courseid) &&
1.620 albertel 12587: $courseid eq $env{'request.course.id'}) {
1.624 albertel 12588: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
12589: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 12590: 'course',$mapp,\$recursed,\@recurseup,
12591: $courseid,'.',$spacequalifierrest,
1.927 albertel 12592: ([$courselevelm,'map' ],
1.1301 raeburn 12593: [$courseleveli,'map' ],
1.927 albertel 12594: [$courselevel, 'course']));
12595: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 12596: }
1.145 www 12597: # ------------------------------------------------------------------ Cascade up
1.218 albertel 12598: unless ($space eq '0') {
1.336 albertel 12599: my @parts=split(/_/,$space);
12600: my $id=pop(@parts);
12601: my $part=join('_',@parts);
12602: if ($part eq '') { $part='0'; }
1.927 albertel 12603: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 12604: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 12605: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 12606: }
1.395 albertel 12607: if ($recurse) { return undef; }
1.1362 raeburn 12608: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
1.927 albertel 12609: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 12610: # ---------------------------------------------------- Any other user namespace
12611: } elsif ($realm eq 'environment') {
12612: # ----------------------------------------------------------------- environment
1.620 albertel 12613: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
12614: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 12615: } else {
1.770 albertel 12616: if ($uname eq 'anonymous' && $udom eq '') {
12617: return '';
12618: }
1.219 albertel 12619: my %returnhash=&userenvironment($udom,$uname,
12620: $spacequalifierrest);
12621: return $returnhash{$spacequalifierrest};
12622: }
1.28 www 12623: } elsif ($realm eq 'system') {
1.48 www 12624: # ----------------------------------------------------------------- system.time
12625: if ($space eq 'time') {
12626: return time;
12627: }
1.696 albertel 12628: } elsif ($realm eq 'server') {
12629: # ----------------------------------------------------------------- system.time
12630: if ($space eq 'name') {
12631: return $ENV{'SERVER_NAME'};
12632: }
1.1415 raeburn 12633: } elsif ($realm eq 'client') {
12634: if ($space eq 'remote_addr') {
1.1441 raeburn 12635: return &get_requestor_ip();
1.1415 raeburn 12636: }
1.28 www 12637: }
1.48 www 12638: return '';
1.61 www 12639: }
12640:
1.927 albertel 12641: sub get_reply {
12642: my ($reply_value) = @_;
1.940 raeburn 12643: if (ref($reply_value) eq 'ARRAY') {
12644: if (wantarray) {
12645: return @$reply_value;
12646: }
12647: return $reply_value->[0];
12648: } else {
12649: return $reply_value;
1.927 albertel 12650: }
12651: }
12652:
1.691 raeburn 12653: sub check_group_parms {
1.1301 raeburn 12654: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
12655: $recursed,$recurseupref) = @_;
12656: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
12657: [$what,'course']);
12658: my $coursereply;
1.691 raeburn 12659: foreach my $group (@{$groups}) {
1.1301 raeburn 12660: my @groupitems = ();
1.691 raeburn 12661: foreach my $level (@levels) {
1.927 albertel 12662: my $item = $courseid.'.['.$group.'].'.$level->[0];
12663: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 12664: }
1.1301 raeburn 12665: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
12666: $env{'course.'.$courseid.'.domain'},
12667: 'course',$mapp,$recursed,$recurseupref,
12668: $courseid,'.['.$group.'].',$what,
12669: @groupitems);
12670: last if (defined($coursereply));
1.691 raeburn 12671: }
12672: return $coursereply;
12673: }
12674:
1.1301 raeburn 12675: sub get_map_hierarchy {
1.1302 raeburn 12676: my ($mapname,$courseid) = @_;
12677: my @recurseup = ();
1.1301 raeburn 12678: if ($mapname) {
1.1302 raeburn 12679: if (($cachedmapkey eq $courseid) &&
12680: (abs($cachedmaptime-time)<5)) {
12681: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
12682: return @{$cachedmaps{$mapname}};
12683: }
12684: }
1.1301 raeburn 12685: my $navmap = Apache::lonnavmaps::navmap->new();
12686: if (ref($navmap)) {
12687: @recurseup = $navmap->recurseup_maps($mapname);
12688: undef($navmap);
1.1302 raeburn 12689: $cachedmaps{$mapname} = \@recurseup;
12690: $cachedmaptime=time;
12691: $cachedmapkey=$courseid;
1.1301 raeburn 12692: }
12693: }
12694: return @recurseup;
12695: }
12696:
1.1302 raeburn 12697: }
12698:
1.691 raeburn 12699: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 12700: my ($courseid,@groups) = @_;
12701: @groups = sort(@groups);
1.691 raeburn 12702: return @groups;
12703: }
12704:
1.395 albertel 12705: sub packages_tab_default {
1.1362 raeburn 12706: my ($uri,$varname,$toolsymb)=@_;
1.395 albertel 12707: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 12708:
12709: my (@extension,@specifics,$do_default);
1.1362 raeburn 12710: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
1.395 albertel 12711: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 12712: if ($pack_type eq 'default') {
12713: $do_default=1;
12714: } elsif ($pack_type eq 'extension') {
12715: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 12716: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 12717: # only look at packages defaults for packages that this id is
1.738 albertel 12718: push(@specifics,[$package,$pack_type,$pack_part]);
12719: }
12720: }
12721: # first look for a package that matches the requested part id
12722: foreach my $package (@specifics) {
12723: my (undef,$pack_type,$pack_part)=@{$package};
12724: next if ($pack_part ne $part);
12725: if (defined($packagetab{"$pack_type&$name&default"})) {
12726: return $packagetab{"$pack_type&$name&default"};
12727: }
12728: }
12729: # look for any possible matching non extension_ package
12730: foreach my $package (@specifics) {
12731: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 12732: if (defined($packagetab{"$pack_type&$name&default"})) {
12733: return $packagetab{"$pack_type&$name&default"};
12734: }
1.585 albertel 12735: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 12736: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
12737: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 12738: }
12739: }
1.738 albertel 12740: # look for any posible extension_ match
12741: foreach my $package (@extension) {
12742: my ($package,$pack_type)=@{$package};
12743: if (defined($packagetab{"$pack_type&$name&default"})) {
12744: return $packagetab{"$pack_type&$name&default"};
12745: }
12746: if (defined($packagetab{$package."&$name&default"})) {
12747: return $packagetab{$package."&$name&default"};
12748: }
12749: }
12750: # look for a global default setting
12751: if ($do_default && defined($packagetab{"default&$name&default"})) {
12752: return $packagetab{"default&$name&default"};
12753: }
1.395 albertel 12754: return undef;
12755: }
12756:
1.334 albertel 12757: sub add_prefix_and_part {
12758: my ($prefix,$part)=@_;
12759: my $keyroot;
12760: if (defined($prefix) && $prefix !~ /^__/) {
12761: # prefix that has a part already
12762: $keyroot=$prefix;
12763: } elsif (defined($prefix)) {
12764: # prefix that is missing a part
12765: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
12766: } else {
12767: # no prefix at all
12768: if (defined($part)) { $keyroot='_'.$part; }
12769: }
12770: return $keyroot;
12771: }
12772:
1.71 www 12773: # ---------------------------------------------------------------- Get metadata
12774:
1.599 albertel 12775: my %metaentry;
1.1070 www 12776: my %importedpartids;
1.1369 raeburn 12777: my %importedrespids;
1.71 www 12778: sub metadata {
1.1362 raeburn 12779: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
1.71 www 12780: $uri=&declutter($uri);
1.288 albertel 12781: # if it is a non metadata possible uri return quickly
1.529 albertel 12782: if (($uri eq '') ||
12783: (($uri =~ m|^/*adm/|) &&
1.1343 raeburn 12784: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
1.1108 raeburn 12785: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 12786: return undef;
12787: }
1.1261 raeburn 12788: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 12789: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 12790: return undef;
1.288 albertel 12791: }
1.73 www 12792: my $filename=$uri;
12793: $uri=~s/\.meta$//;
1.172 www 12794: #
12795: # Is the metadata already cached?
1.177 www 12796: # Look at timestamp of caching
1.172 www 12797: # Everything is cached by the main uri, libraries are never directly cached
12798: #
1.428 albertel 12799: if (!defined($liburi)) {
1.599 albertel 12800: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 12801: if (defined($cached)) { return $result->{':'.$what}; }
12802: }
1.1362 raeburn 12803:
12804: #
12805: # If the uri is for an external tool the file from
12806: # which metadata should be retrieved depends on whether
12807: # the tool had been configured to be gradable (set in the Course
12808: # Editor or Resource Editor).
12809: #
12810: # If a valid symb has been included as the third arg in the call
12811: # to &metadata() that can be used to retrieve the value of
12812: # parameter_0_gradable set for the resource, and included in the
12813: # uploaded map containing the tool. The value is retrieved via
12814: # &EXT(), if a valid symb is available. Otherwise the value of
12815: # gradable in the exttool_$marker.db file for the tool instance
1.1364 raeburn 12816: # is retrieved via &get().
12817: #
12818: # When lonuserstate::traceroute() calls lonnet::EXT() for
12819: # hiddenresource and encrypturl (during course initialization)
12820: # the map-level parameter for resource.0.gradable included in the
12821: # uploaded map containing the tool will not yet have been stored
12822: # in the user_course_parms.db file for the user's session, so in
12823: # this case fall back to retrieving gradable status from the
12824: # exttool_$marker.db file.
1.1362 raeburn 12825: #
12826: # In order to avoid an infinite loop, &metadata() will return
12827: # before a call to &EXT(), if the uri is for an external tool
12828: # and the $what for which metadata is being requested is
12829: # parameter_0_gradable or 0_gradable.
12830: #
12831:
12832: if ($uri =~ /ext\.tool$/) {
12833: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
12834: return;
12835: } else {
12836: my ($checked,$use_passback);
12837: if ($toolsymb ne '') {
12838: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
1.1364 raeburn 12839: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
1.1362 raeburn 12840: $checked = 1;
12841: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
12842: $use_passback = 1;
12843: }
12844: }
12845: }
12846: unless ($checked) {
12847: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
12848: $marker=~s/\D//g;
1.1363 raeburn 12849: if ($marker) {
1.1362 raeburn 12850: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
12851: $use_passback = $toolsettings{'gradable'};
12852: }
12853: }
12854: if ($use_passback) {
12855: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
12856: } else {
12857: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
12858: }
12859: }
12860: }
12861:
1.428 albertel 12862: {
1.1069 www 12863: # Imported parts would go here
1.1369 raeburn 12864: my @origfiletagids=();
1.1069 www 12865: my $importedparts=0;
1.1369 raeburn 12866:
12867: # Imported responseids would go here
12868: my $importedresponses=0;
1.172 www 12869: #
12870: # Is this a recursive call for a library?
12871: #
1.599 albertel 12872: # if (! exists($metacache{$uri})) {
12873: # $metacache{$uri}={};
12874: # }
1.924 albertel 12875: my $cachetime = 60*60;
1.171 www 12876: if ($liburi) {
12877: $liburi=&declutter($liburi);
12878: $filename=$liburi;
1.401 bowersj2 12879: } else {
1.599 albertel 12880: &devalidate_cache_new('meta',$uri);
12881: undef(%metaentry);
1.401 bowersj2 12882: }
1.140 www 12883: my %metathesekeys=();
1.73 www 12884: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 12885: my $metastring;
1.1140 www 12886: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 12887: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 12888: $metastring =
1.929 albertel 12889: &Apache::lonnet::ssi_body($which,
1.924 albertel 12890: ('grade_target' => 'meta'));
12891: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 12892: } elsif (($uri !~ m -^(editupload)/-) &&
12893: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 12894: my $file=&filelocation('',&clutter($filename));
1.599 albertel 12895: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 12896: $metastring=&getfile($file);
1.489 albertel 12897: }
1.208 albertel 12898: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 12899: my $token;
1.140 www 12900: undef %metathesekeys;
1.71 www 12901: while ($token=$parser->get_token) {
1.339 albertel 12902: if ($token->[0] eq 'S') {
12903: if (defined($token->[2]->{'package'})) {
1.172 www 12904: #
12905: # This is a package - get package info
12906: #
1.339 albertel 12907: my $package=$token->[2]->{'package'};
12908: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
12909: if (defined($token->[2]->{'id'})) {
12910: $keyroot.='_'.$token->[2]->{'id'};
12911: }
1.599 albertel 12912: if ($metaentry{':packages'}) {
12913: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 12914: } else {
1.599 albertel 12915: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 12916: }
1.736 albertel 12917: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 12918: my $part=$keyroot;
12919: $part=~s/^\_//;
1.736 albertel 12920: if ($pack_entry=~/^\Q$package\E\&/ ||
12921: $pack_entry=~/^\Q$package\E_0\&/) {
12922: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 12923: # ignore package.tab specified default values
12924: # here &package_tab_default() will fetch those
12925: if ($subp eq 'default') { next; }
1.736 albertel 12926: my $value=$packagetab{$pack_entry};
1.432 albertel 12927: my $unikey;
12928: if ($pack =~ /_0$/) {
12929: $unikey='parameter_0_'.$name;
12930: $part=0;
12931: } else {
12932: $unikey='parameter'.$keyroot.'_'.$name;
12933: }
1.339 albertel 12934: if ($subp eq 'display') {
12935: $value.=' [Part: '.$part.']';
12936: }
1.599 albertel 12937: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 12938: $metathesekeys{$unikey}=1;
1.599 albertel 12939: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
12940: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 12941: }
1.599 albertel 12942: if (defined($metaentry{':'.$unikey.'.default'})) {
12943: $metaentry{':'.$unikey}=
12944: $metaentry{':'.$unikey.'.default'};
1.356 albertel 12945: }
1.339 albertel 12946: }
12947: }
12948: } else {
1.172 www 12949: #
12950: # This is not a package - some other kind of start tag
1.339 albertel 12951: #
12952: my $entry=$token->[1];
1.1068 www 12953: my $unikey='';
1.175 www 12954:
1.339 albertel 12955: if ($entry eq 'import') {
1.175 www 12956: #
12957: # Importing a library here
1.339 albertel 12958: #
1.1067 www 12959: my $location=$parser->get_text('/import');
12960: my $dir=$filename;
12961: $dir=~s|[^/]*$||;
12962: $location=&filelocation($dir,$location);
1.1369 raeburn 12963:
12964: my $importid=$token->[2]->{'id'};
1.1068 www 12965: my $importmode=$token->[2]->{'importmode'};
1.1369 raeburn 12966: #
12967: # Check metadata for imported file to
12968: # see if it contained response items
12969: #
1.1372 raeburn 12970: my ($origfile,@libfilekeys);
1.1370 raeburn 12971: my %currmetaentry = %metaentry;
1.1372 raeburn 12972: @libfilekeys = split(/,/,&metadata($location,'keys',undef,undef,undef,
12973: $depthcount+1));
12974: if (grep(/^responseorder$/,@libfilekeys)) {
12975: my $libresponseorder = &metadata($location,'responseorder',undef,undef,
12976: undef,$depthcount+1);
12977: if ($libresponseorder ne '') {
12978: if ($#origfiletagids<0) {
12979: undef(%importedrespids);
12980: undef(%importedpartids);
12981: }
1.1373 raeburn 12982: my @respids = split(/\s*,\s*/,$libresponseorder);
12983: if (@respids) {
12984: $importedrespids{$importid} = join(',',map { $importid.'_'.$_ } @respids);
12985: }
12986: if ($importedrespids{$importid} ne '') {
1.1372 raeburn 12987: $importedresponses = 1;
1.1369 raeburn 12988: # We need to get the original file and the imported file to get the response order correct
12989: # Load and inspect original file
1.1372 raeburn 12990: if ($#origfiletagids<0) {
12991: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
12992: $origfile=&getfile($origfilelocation);
12993: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12994: }
1.1369 raeburn 12995: }
12996: }
12997: }
1.1370 raeburn 12998: # Do not overwrite contents of %metaentry hash for resource itself with
12999: # hash populated for imported library file
13000: %metaentry = %currmetaentry;
13001: undef(%currmetaentry);
1.1374 raeburn 13002: if ($importmode eq 'part') {
1.1068 www 13003: # Import as part(s)
1.1069 www 13004: $importedparts=1;
13005: # We need to get the original file and the imported file to get the part order correct
13006: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
1.1369 raeburn 13007: # Load and inspect original file if we didn't do that already
13008: if ($#origfiletagids<0) {
13009: undef(%importedrespids);
13010: undef(%importedpartids);
13011: if ($origfile eq '') {
13012: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
13013: $origfile=&getfile($origfilelocation);
13014: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13015: }
1.1070 www 13016: }
1.1372 raeburn 13017: my @impfilepartids;
13018: # If <partorder> tag is included in metadata for the imported file
13019: # get the parts in the imported file from that.
13020: if (grep(/^partorder$/,@libfilekeys)) {
13021: %currmetaentry = %metaentry;
13022: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13023: $depthcount+1);
13024: %metaentry = %currmetaentry;
13025: undef(%currmetaentry);
13026: if ($libpartorder ne '') {
13027: @impfilepartids=split(/\s*,\s*/,$libpartorder);
13028: }
13029: } else {
13030: # If no <partorder> tag available, load and inspect imported file
13031: my $impfile=&getfile($location);
13032: @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13033: }
1.1069 www 13034: if ($#impfilepartids>=0) {
13035: # This problem had parts
1.1070 www 13036: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 13037: } else {
13038: # Importing by turning a single problem into a problem part
13039: # It gets the import-tags ID as part-ID
13040: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 13041: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 13042: }
1.1068 www 13043: } else {
1.1374 raeburn 13044: # Import as problem or as normal import
13045: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
13046: unless ($importmode eq 'problem') {
1.1068 www 13047: # Normal import
1.1374 raeburn 13048: if (defined($token->[2]->{'id'})) {
13049: $unikey.='_'.$token->[2]->{'id'};
13050: }
13051: }
13052: # Check metadata for imported file to
13053: # see if it contained parts
13054: if (grep(/^partorder$/,@libfilekeys)) {
13055: %currmetaentry = %metaentry;
13056: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13057: $depthcount+1);
13058: %metaentry = %currmetaentry;
13059: undef(%currmetaentry);
13060: if ($libpartorder ne '') {
13061: $importedparts = 1;
13062: $importedpartids{$token->[2]->{'id'}}=$libpartorder;
13063: }
13064: }
1.1067 www 13065: }
1.339 albertel 13066: if ($depthcount<20) {
1.736 albertel 13067: my $metadata =
1.1362 raeburn 13068: &metadata($uri,'keys',$toolsymb,$location,$unikey,
1.736 albertel 13069: $depthcount+1);
13070: foreach my $meta (split(',',$metadata)) {
13071: $metaentry{':'.$meta}=$metaentry{':'.$meta};
13072: $metathesekeys{$meta}=1;
1.339 albertel 13073: }
1.1068 www 13074: }
1.1067 www 13075: } else {
13076: #
13077: # Not importing, some other kind of non-package, non-library start tag
13078: #
13079: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
13080: if (defined($token->[2]->{'id'})) {
13081: $unikey.='_'.$token->[2]->{'id'};
13082: }
1.339 albertel 13083: if (defined($token->[2]->{'name'})) {
13084: $unikey.='_'.$token->[2]->{'name'};
13085: }
13086: $metathesekeys{$unikey}=1;
1.736 albertel 13087: foreach my $param (@{$token->[3]}) {
13088: $metaentry{':'.$unikey.'.'.$param} =
13089: $token->[2]->{$param};
1.339 albertel 13090: }
13091: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 13092: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 13093: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
13094: # only ws inside the tag, and not in default, so use default
13095: # as value
1.599 albertel 13096: $metaentry{':'.$unikey}=$default;
1.908 albertel 13097: } elsif ( $internaltext =~ /\S/ ) {
13098: # something interesting inside the tag
13099: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 13100: } else {
1.908 albertel 13101: # no interesting values, don't set a default
1.339 albertel 13102: }
1.172 www 13103: # end of not-a-package not-a-library import
1.339 albertel 13104: }
1.172 www 13105: # end of not-a-package start tag
1.339 albertel 13106: }
1.172 www 13107: # the next is the end of "start tag"
1.339 albertel 13108: }
13109: }
1.483 albertel 13110: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 13111: $extension = lc($extension);
13112: if ($extension eq 'htm') { $extension='html'; }
13113:
1.737 albertel 13114: foreach my $key (keys(%packagetab)) {
1.483 albertel 13115: #no specific packages #how's our extension
13116: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 13117: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 13118: \%metathesekeys);
13119: }
1.883 albertel 13120:
13121: if (!exists($metaentry{':packages'})
13122: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 13123: foreach my $key (keys(%packagetab)) {
1.483 albertel 13124: #no specific packages well let's get default then
13125: if ($key!~/^default&/) { next; }
1.488 albertel 13126: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 13127: \%metathesekeys);
13128: }
13129: }
1.338 www 13130: # are there custom rights to evaluate
1.599 albertel 13131: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 13132:
1.338 www 13133: #
13134: # Importing a rights file here
1.339 albertel 13135: #
13136: unless ($depthcount) {
1.599 albertel 13137: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 13138: my $dir=$filename;
13139: $dir=~s|[^/]*$||;
13140: $location=&filelocation($dir,$location);
1.736 albertel 13141: my $rights_metadata =
1.1362 raeburn 13142: &metadata($uri,'keys',$toolsymb,$location,'_rights',
1.736 albertel 13143: $depthcount+1);
13144: foreach my $rights (split(',',$rights_metadata)) {
13145: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
13146: $metathesekeys{$rights}=1;
1.339 albertel 13147: }
13148: }
13149: }
1.737 albertel 13150: # uniqifiy package listing
13151: my %seen;
13152: my @uniq_packages =
13153: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
13154: $metaentry{':packages'} = join(',',@uniq_packages);
13155:
1.1369 raeburn 13156: if (($importedresponses) || ($importedparts)) {
13157: if ($importedparts) {
1.1070 www 13158: # We had imported parts and need to rebuild partorder
1.1369 raeburn 13159: $metaentry{':partorder'}='';
13160: $metathesekeys{'partorder'}=1;
13161: }
13162: if ($importedresponses) {
13163: # We had imported responses and need to rebuil responseorder
13164: $metaentry{':responseorder'}='';
13165: $metathesekeys{'responseorder'}=1;
13166: }
13167: for (my $index=0;$index<$#origfiletagids;$index+=2) {
13168: my $origid = $origfiletagids[$index+1];
13169: if ($origfiletagids[$index] eq 'part') {
13170: # Original part, part of the problem
13171: if ($importedparts) {
13172: $metaentry{':partorder'}.=','.$origid;
13173: }
13174: } elsif ($origfiletagids[$index] eq 'import') {
13175: if ($importedparts) {
13176: # We have imported parts at this position
1.1373 raeburn 13177: if ($importedpartids{$origid} ne '') {
13178: $metaentry{':partorder'}.=','.$importedpartids{$origid};
13179: }
1.1369 raeburn 13180: }
13181: if ($importedresponses) {
13182: # We have imported responses at this position
1.1373 raeburn 13183: if ($importedrespids{$origid} ne '') {
13184: $metaentry{':responseorder'}.=','.$importedrespids{$origid};
1.1369 raeburn 13185: }
13186: }
13187: } else {
13188: # Original response item, part of the problem
13189: if ($importedresponses) {
13190: $metaentry{':responseorder'}.=','.$origid;
13191: }
13192: }
13193: }
13194: if ($importedparts) {
13195: $metaentry{':partorder'}=~s/^\,//;
13196: }
13197: if ($importedresponses) {
13198: $metaentry{':responseorder'}=~s/^\,//;
13199: }
1.1070 www 13200: }
1.737 albertel 13201: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 13202: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274 raeburn 13203: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.1371 raeburn 13204: unless ($liburi) {
13205: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
13206: }
1.177 www 13207: # this is the end of "was not already recently cached
1.71 www 13208: }
1.599 albertel 13209: return $metaentry{':'.$what};
1.261 albertel 13210: }
13211:
1.488 albertel 13212: sub metadata_create_package_def {
1.483 albertel 13213: my ($uri,$key,$package,$metathesekeys)=@_;
13214: my ($pack,$name,$subp)=split(/\&/,$key);
13215: if ($subp eq 'default') { next; }
13216:
1.599 albertel 13217: if (defined($metaentry{':packages'})) {
13218: $metaentry{':packages'}.=','.$package;
1.483 albertel 13219: } else {
1.599 albertel 13220: $metaentry{':packages'}=$package;
1.483 albertel 13221: }
13222: my $value=$packagetab{$key};
13223: my $unikey;
13224: $unikey='parameter_0_'.$name;
1.599 albertel 13225: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 13226: $$metathesekeys{$unikey}=1;
1.599 albertel 13227: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
13228: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 13229: }
1.599 albertel 13230: if (defined($metaentry{':'.$unikey.'.default'})) {
13231: $metaentry{':'.$unikey}=
13232: $metaentry{':'.$unikey.'.default'};
1.483 albertel 13233: }
13234: }
13235:
1.261 albertel 13236: sub metadata_generate_part0 {
13237: my ($metadata,$metacache,$uri) = @_;
13238: my %allnames;
1.737 albertel 13239: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 13240: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 13241: my $part=$$metacache{':'.$metakey.'.part'};
13242: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 13243: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 13244: $allnames{$name}=$part;
13245: }
13246: }
13247: }
13248: foreach my $name (keys(%allnames)) {
13249: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 13250: my $key=":parameter_0_$name";
1.261 albertel 13251: $$metacache{"$key.part"}='0';
13252: $$metacache{"$key.name"}=$name;
1.428 albertel 13253: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 13254: $allnames{$name}.'_'.$name.
13255: '.type'};
1.428 albertel 13256: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 13257: '.display'};
1.644 www 13258: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 13259: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 13260: $$metacache{"$key.display"}=$olddis;
13261: }
1.71 www 13262: }
13263:
1.764 albertel 13264: # ------------------------------------------------------ Devalidate title cache
13265:
13266: sub devalidate_title_cache {
13267: my ($url)=@_;
13268: if (!$env{'request.course.id'}) { return; }
13269: my $symb=&symbread($url);
13270: if (!$symb) { return; }
13271: my $key=$env{'request.course.id'}."\0".$symb;
13272: &devalidate_cache_new('title',$key);
13273: }
13274:
1.1014 droeschl 13275: # ------------------------------------------------- Get the title of a course
13276:
13277: sub current_course_title {
13278: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
13279: }
1.301 www 13280: # ------------------------------------------------- Get the title of a resource
13281:
13282: sub gettitle {
13283: my $urlsymb=shift;
13284: my $symb=&symbread($urlsymb);
1.534 albertel 13285: if ($symb) {
1.620 albertel 13286: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 13287: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 13288: if (defined($cached)) {
13289: return $result;
13290: }
1.534 albertel 13291: my ($map,$resid,$url)=&decode_symb($symb);
13292: my $title='';
1.907 albertel 13293: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
13294: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
13295: } else {
13296: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13297: &GDBM_READER(),0640)) {
13298: my $mapid=$bighash{'map_pc_'.&clutter($map)};
13299: $title=$bighash{'title_'.$mapid.'.'.$resid};
13300: untie(%bighash);
13301: }
1.534 albertel 13302: }
13303: $title=~s/\&colon\;/\:/gs;
13304: if ($title) {
1.1159 www 13305: # Remember both $symb and $title for dynamic metadata
13306: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 13307: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 13308: # Cache this title and then return it
1.599 albertel 13309: return &do_cache_new('title',$key,$title,600);
1.534 albertel 13310: }
13311: $urlsymb=$url;
13312: }
13313: my $title=&metadata($urlsymb,'title');
13314: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
13315: return $title;
1.301 www 13316: }
1.613 albertel 13317:
1.614 albertel 13318: sub get_slot {
13319: my ($which,$cnum,$cdom)=@_;
13320: if (!$cnum || !$cdom) {
1.790 albertel 13321: (undef,my $courseid)=&whichuser();
1.620 albertel 13322: $cdom=$env{'course.'.$courseid.'.domain'};
13323: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 13324: }
1.703 albertel 13325: my $key=join("\0",'slots',$cdom,$cnum,$which);
13326: my %slotinfo;
13327: if (exists($remembered{$key})) {
13328: $slotinfo{$which} = $remembered{$key};
13329: } else {
13330: %slotinfo=&get('slots',[$which],$cdom,$cnum);
13331: &Apache::lonhomework::showhash(%slotinfo);
13332: my ($tmp)=keys(%slotinfo);
13333: if ($tmp=~/^error:/) { return (); }
13334: $remembered{$key} = $slotinfo{$which};
13335: }
1.616 albertel 13336: if (ref($slotinfo{$which}) eq 'HASH') {
13337: return %{$slotinfo{$which}};
13338: }
13339: return $slotinfo{$which};
1.614 albertel 13340: }
1.1150 raeburn 13341:
13342: sub get_reservable_slots {
13343: my ($cnum,$cdom,$uname,$udom) = @_;
13344: my $now = time;
13345: my $reservable_info;
13346: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
13347: if (exists($remembered{$key})) {
13348: $reservable_info = $remembered{$key};
13349: } else {
13350: my %resv;
13351: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
13352: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
13353: $reservable_info = \%resv;
13354: $remembered{$key} = $reservable_info;
13355: }
13356: return $reservable_info;
13357: }
13358:
13359: sub get_course_slots {
13360: my ($cnum,$cdom) = @_;
13361: my $hashid=$cnum.':'.$cdom;
13362: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
13363: if (defined($cached)) {
13364: if (ref($result) eq 'HASH') {
13365: return %{$result};
13366: }
13367: } else {
13368: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
13369: my ($tmp) = keys(%slots);
13370: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 13371: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 13372: return %slots;
13373: }
13374: }
13375: return;
13376: }
13377:
13378: sub devalidate_slots_cache {
13379: my ($cnum,$cdom)=@_;
13380: my $hashid=$cnum.':'.$cdom;
13381: &devalidate_cache_new('allslots',$hashid);
13382: }
13383:
1.1181 raeburn 13384: sub get_coursechange {
13385: my ($cdom,$cnum) = @_;
13386: if ($cdom eq '' || $cnum eq '') {
13387: return unless ($env{'request.course.id'});
13388: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
13389: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
13390: }
13391: my $hashid=$cdom.'_'.$cnum;
13392: my ($change,$cached)=&is_cached_new('crschange',$hashid);
13393: if ((defined($cached)) && ($change ne '')) {
13394: return $change;
13395: } else {
13396: my %crshash;
13397: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
13398: if ($crshash{'internal.contentchange'} eq '') {
13399: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
13400: if ($change eq '') {
13401: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
13402: $change = $crshash{'internal.created'};
13403: }
13404: } else {
13405: $change = $crshash{'internal.contentchange'};
13406: }
13407: my $cachetime = 600;
13408: &do_cache_new('crschange',$hashid,$change,$cachetime);
13409: }
13410: return $change;
13411: }
13412:
13413: sub devalidate_coursechange_cache {
13414: my ($cnum,$cdom)=@_;
13415: my $hashid=$cnum.':'.$cdom;
13416: &devalidate_cache_new('crschange',$hashid);
13417: }
13418:
1.31 www 13419: # ------------------------------------------------- Update symbolic store links
13420:
13421: sub symblist {
13422: my ($mapname,%newhash)=@_;
1.438 www 13423: $mapname=&deversion(&declutter($mapname));
1.31 www 13424: my %hash;
1.620 albertel 13425: if (($env{'request.course.fn'}) && (%newhash)) {
13426: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 13427: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 13428: foreach my $url (keys(%newhash)) {
1.711 albertel 13429: next if ($url eq 'last_known'
13430: && $env{'form.no_update_last_known'});
13431: $hash{declutter($url)}=&encode_symb($mapname,
13432: $newhash{$url}->[1],
13433: $newhash{$url}->[0]);
1.191 harris41 13434: }
1.31 www 13435: if (untie(%hash)) {
13436: return 'ok';
13437: }
13438: }
13439: }
13440: return 'error';
1.212 www 13441: }
13442:
13443: # --------------------------------------------------------------- Verify a symb
13444:
13445: sub symbverify {
1.1190 raeburn 13446: my ($symb,$thisurl,$encstate)=@_;
1.510 www 13447: my $thisfn=$thisurl;
1.439 www 13448: $thisfn=&declutter($thisfn);
1.215 www 13449: # direct jump to resource in page or to a sequence - will construct own symbs
13450: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
13451: # check URL part
1.409 www 13452: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 13453:
1.431 www 13454: unless ($url eq $thisfn) { return 0; }
1.213 www 13455:
1.216 www 13456: $symb=&symbclean($symb);
1.510 www 13457: $thisurl=&deversion($thisurl);
1.439 www 13458: $thisfn=&deversion($thisfn);
1.213 www 13459:
13460: my %bighash;
13461: my $okay=0;
1.431 www 13462:
1.620 albertel 13463: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 13464: &GDBM_READER(),0640)) {
1.1032 raeburn 13465: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
13466: $thisurl =~ s/\?.+$//;
1.1204 raeburn 13467: if ($map =~ m{^uploaded/.+\.page$}) {
13468: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
13469: $thisurl =~ s{^\Qhttp://https://\E}{https://};
13470: }
13471: }
13472: my $ids;
1.1419 raeburn 13473: if ($map =~ m{^uploaded/.+\.page$}) {
13474: $ids=$bighash{'ids_'.&clutter_with_no_wrapper($thisurl)};
1.1204 raeburn 13475: } else {
13476: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 13477: }
1.1102 raeburn 13478: unless ($ids) {
13479: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
13480: $ids=$bighash{$idkey};
1.216 www 13481: }
13482: if ($ids) {
13483: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 13484: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 13485: $symb =~ s/\?.+$//;
1.1202 raeburn 13486: }
1.800 albertel 13487: foreach my $id (split(/\,/,$ids)) {
13488: my ($mapid,$resid)=split(/\./,$id);
1.216 www 13489: if (
13490: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 13491: eq $symb) {
13492: if (ref($encstate)) {
13493: $$encstate = $bighash{'encrypted_'.$id};
13494: }
1.620 albertel 13495: if (($env{'request.role.adv'}) ||
1.1101 raeburn 13496: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
13497: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 13498: $okay=1;
1.1202 raeburn 13499: last;
1.582 albertel 13500: }
13501: }
1.216 www 13502: }
13503: }
1.213 www 13504: untie(%bighash);
13505: }
13506: return $okay;
1.31 www 13507: }
13508:
1.210 www 13509: # --------------------------------------------------------------- Clean-up symb
13510:
13511: sub symbclean {
13512: my $symb=shift;
1.568 albertel 13513: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 13514: # remove version from map
13515: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 13516:
1.210 www 13517: # remove version from URL
13518: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 13519:
1.507 www 13520: # remove wrapper
13521:
1.510 www 13522: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 13523: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 13524: return $symb;
1.409 www 13525: }
13526:
13527: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 13528:
13529: sub encode_symb {
13530: my ($map,$resid,$url)=@_;
13531: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
13532: }
1.409 www 13533:
13534: sub decode_symb {
1.568 albertel 13535: my $symb=shift;
13536: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
13537: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 13538: return (&fixversion($map),$resid,&fixversion($url));
13539: }
13540:
13541: sub fixversion {
13542: my $fn=shift;
1.609 banghart 13543: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 13544: my %bighash;
13545: my $uri=&clutter($fn);
1.620 albertel 13546: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 13547: # is this cached?
1.599 albertel 13548: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 13549: if (defined($cached)) { return $result; }
13550: # unfortunately not cached, or expired
1.620 albertel 13551: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 13552: &GDBM_READER(),0640)) {
13553: if ($bighash{'version_'.$uri}) {
13554: my $version=$bighash{'version_'.$uri};
1.444 www 13555: unless (($version eq 'mostrecent') ||
13556: ($version==&getversion($uri))) {
1.440 www 13557: $uri=~s/\.(\w+)$/\.$version\.$1/;
13558: }
13559: }
13560: untie %bighash;
1.413 www 13561: }
1.599 albertel 13562: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 13563: }
13564:
13565: sub deversion {
13566: my $url=shift;
13567: $url=~s/\.\d+\.(\w+)$/\.$1/;
13568: return $url;
1.210 www 13569: }
13570:
1.31 www 13571: # ------------------------------------------------------ Return symb list entry
13572:
13573: sub symbread {
1.1424 raeburn 13574: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles,
1.1427 raeburn 13575: $ignoresymbdb,$noenccheck)=@_;
1.1265 raeburn 13576: my $cache_str='request.symbread.cached.'.$thisfn;
1.1427 raeburn 13577: if (defined($env{$cache_str})) {
1.1424 raeburn 13578: unless (ref($possibles) eq 'HASH') {
13579: if ($ignorecachednull) {
13580: return $env{$cache_str} unless ($env{$cache_str} eq '');
13581: } else {
13582: return $env{$cache_str};
13583: }
1.1282 raeburn 13584: }
13585: }
1.242 www 13586: # no filename provided? try from environment
1.1265 raeburn 13587: unless ($thisfn) {
1.620 albertel 13588: if ($env{'request.symb'}) {
1.1427 raeburn 13589: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 13590: }
1.620 albertel 13591: $thisfn=$env{'request.filename'};
1.44 www 13592: }
1.569 albertel 13593: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 13594: # is that filename actually a symb? Verify, clean, and return
13595: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 13596: if (&symbverify($thisfn,$1)) {
1.1427 raeburn 13597: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 13598: }
1.242 www 13599: }
1.44 www 13600: $thisfn=declutter($thisfn);
1.31 www 13601: my %hash;
1.37 www 13602: my %bighash;
13603: my $syval='';
1.620 albertel 13604: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 13605: my $targetfn = $thisfn;
1.609 banghart 13606: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 13607: $targetfn = 'adm/wrapper/'.$thisfn;
13608: }
1.687 albertel 13609: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
13610: $targetfn=$1;
13611: }
1.1427 raeburn 13612: unless ($ignoresymbdb) {
1.1424 raeburn 13613: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
13614: &GDBM_READER(),0640)) {
13615: $syval=$hash{$targetfn};
13616: untie(%hash);
13617: }
1.1427 raeburn 13618: if ($syval && $checkforblock) {
13619: my @blockers = &has_comm_blocking('bre',$syval,$thisfn,$ignoresymbdb,$noenccheck);
1.1424 raeburn 13620: if (@blockers) {
13621: $syval='';
13622: }
13623: }
1.37 www 13624: }
13625: # ---------------------------------------------------------- There was an entry
13626: if ($syval) {
1.601 albertel 13627: #unless ($syval=~/\_\d+$/) {
1.620 albertel 13628: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 13629: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 13630: #return $env{$cache_str}='';
1.601 albertel 13631: #}
13632: #$syval.=$1;
13633: #}
1.37 www 13634: } else {
13635: # ------------------------------------------------------- Was not in symb table
1.620 albertel 13636: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 13637: &GDBM_READER(),0640)) {
1.37 www 13638: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 13639: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 13640: unless ($ids) {
13641: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 13642: }
13643: unless ($ids) {
13644: # alias?
13645: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 13646: }
1.37 www 13647: if ($ids) {
13648: # ------------------------------------------------------------------- Has ID(s)
13649: my @possibilities=split(/\,/,$ids);
1.39 www 13650: if ($#possibilities==0) {
13651: # ----------------------------------------------- There is only one possibility
1.37 www 13652: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 13653: $syval=&encode_symb($bighash{'map_id_'.$mapid},
13654: $resid,$thisfn);
1.1282 raeburn 13655: if (ref($possibles) eq 'HASH') {
1.1424 raeburn 13656: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
13657: $possibles->{$syval} = 1;
13658: }
1.1282 raeburn 13659: }
13660: if ($checkforblock) {
1.1424 raeburn 13661: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
1.1426 raeburn 13662: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids},'',$noenccheck);
1.1424 raeburn 13663: if (@blockers) {
13664: $syval = '';
1.1425 raeburn 13665: untie(%bighash);
13666: return $env{$cache_str}='';
1.1424 raeburn 13667: }
1.1282 raeburn 13668: }
13669: }
13670: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 13671: # ------------------------------------------ There is more than one possibility
13672: my $realpossible=0;
1.800 albertel 13673: foreach my $id (@possibilities) {
13674: my $file=$bighash{'src_'.$id};
1.1282 raeburn 13675: my $canaccess;
13676: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
13677: $canaccess = 1;
13678: } else {
13679: $canaccess = &allowed('bre',$file);
13680: }
13681: if ($canaccess) {
13682: my ($mapid,$resid)=split(/\./,$id);
13683: if ($bighash{'map_type_'.$mapid} ne 'page') {
13684: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
13685: $resid,$thisfn);
1.1424 raeburn 13686: next if ($bighash{'randomout_'.$id} && !$env{'request.role.adv'});
1.1426 raeburn 13687: next unless (($noenccheck) || ($bighash{'encrypted_'.$id} eq $env{'request.enc'}));
1.1282 raeburn 13688: if ($checkforblock) {
1.1426 raeburn 13689: my @blockers = &has_comm_blocking('bre',$poss_syval,$file,'',$noenccheck);
1.1424 raeburn 13690: if (@blockers > 0) {
13691: $syval = '';
13692: } else {
1.1282 raeburn 13693: $syval = $poss_syval;
13694: $realpossible++;
13695: }
13696: } else {
13697: $syval = $poss_syval;
13698: $realpossible++;
13699: }
1.1424 raeburn 13700: if ($syval) {
13701: if (ref($possibles) eq 'HASH') {
13702: $possibles->{$syval} = 1;
13703: }
13704: }
1.1282 raeburn 13705: }
1.39 www 13706: }
1.191 harris41 13707: }
1.39 www 13708: if ($realpossible!=1) { $syval=''; }
1.249 www 13709: } else {
13710: $syval='';
1.37 www 13711: }
13712: }
1.1282 raeburn 13713: untie(%bighash);
1.481 raeburn 13714: }
1.31 www 13715: }
1.62 www 13716: if ($syval) {
1.1427 raeburn 13717: return $env{$cache_str}=$syval;
1.62 www 13718: }
1.31 www 13719: }
1.949 raeburn 13720: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 13721: return $env{$cache_str}='';
1.31 www 13722: }
13723:
13724: # ---------------------------------------------------------- Return random seed
13725:
1.32 www 13726: sub numval {
13727: my $txt=shift;
13728: $txt=~tr/A-J/0-9/;
13729: $txt=~tr/a-j/0-9/;
13730: $txt=~tr/K-T/0-9/;
13731: $txt=~tr/k-t/0-9/;
13732: $txt=~tr/U-Z/0-5/;
13733: $txt=~tr/u-z/0-5/;
13734: $txt=~s/\D//g;
1.564 albertel 13735: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 13736: return int($txt);
1.368 albertel 13737: }
13738:
1.484 albertel 13739: sub numval2 {
13740: my $txt=shift;
13741: $txt=~tr/A-J/0-9/;
13742: $txt=~tr/a-j/0-9/;
13743: $txt=~tr/K-T/0-9/;
13744: $txt=~tr/k-t/0-9/;
13745: $txt=~tr/U-Z/0-5/;
13746: $txt=~tr/u-z/0-5/;
13747: $txt=~s/\D//g;
13748: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13749: my $total;
13750: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 13751: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 13752: return int($total);
13753: }
13754:
1.575 albertel 13755: sub numval3 {
13756: use integer;
13757: my $txt=shift;
13758: $txt=~tr/A-J/0-9/;
13759: $txt=~tr/a-j/0-9/;
13760: $txt=~tr/K-T/0-9/;
13761: $txt=~tr/k-t/0-9/;
13762: $txt=~tr/U-Z/0-5/;
13763: $txt=~tr/u-z/0-5/;
13764: $txt=~s/\D//g;
13765: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13766: my $total;
13767: foreach my $val (@txts) { $total+=$val; }
13768: if ($_64bit) { $total=(($total<<32)>>32); }
13769: return $total;
13770: }
13771:
1.675 albertel 13772: sub digest {
13773: my ($data)=@_;
13774: my $digest=&Digest::MD5::md5($data);
13775: my ($a,$b,$c,$d)=unpack("iiii",$digest);
13776: my ($e,$f);
13777: {
13778: use integer;
13779: $e=($a+$b);
13780: $f=($c+$d);
13781: if ($_64bit) {
13782: $e=(($e<<32)>>32);
13783: $f=(($f<<32)>>32);
13784: }
13785: }
13786: if (wantarray) {
13787: return ($e,$f);
13788: } else {
13789: my $g;
13790: {
13791: use integer;
13792: $g=($e+$f);
13793: if ($_64bit) {
13794: $g=(($g<<32)>>32);
13795: }
13796: }
13797: return $g;
13798: }
13799: }
13800:
1.368 albertel 13801: sub latest_rnd_algorithm_id {
1.675 albertel 13802: return '64bit5';
1.366 albertel 13803: }
1.32 www 13804:
1.503 albertel 13805: sub get_rand_alg {
13806: my ($courseid)=@_;
1.790 albertel 13807: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 13808: if ($courseid) {
1.620 albertel 13809: return $env{"course.$courseid.rndseed"};
1.503 albertel 13810: }
13811: return &latest_rnd_algorithm_id();
13812: }
13813:
1.562 albertel 13814: sub validCODE {
13815: my ($CODE)=@_;
13816: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
13817: return 0;
13818: }
13819:
1.491 albertel 13820: sub getCODE {
1.620 albertel 13821: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 13822: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
13823: defined($Apache::lonhomework::parsing_a_task) ) &&
13824: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 13825: return $Apache::lonhomework::history{'resource.CODE'};
13826: }
13827: return undef;
13828: }
1.1133 foxr 13829: #
13830: # Determines the random seed for a specific context:
13831: #
13832: # parameters:
13833: # symb - in course context the symb for the seed.
13834: # course_id - The course id of the form domain_coursenum.
13835: # domain - Domain for the user.
13836: # course - Course for the user.
13837: # cenv - environment of the course.
13838: #
13839: # NOTE:
13840: # All parameters are picked out of the environment if missing
13841: # or not defined.
13842: # If a symb cannot be determined the current time is used instead.
13843: #
13844: # For a given well defined symb, courside, domain, username,
13845: # and course environment, the seed is reproducible.
13846: #
1.31 www 13847: sub rndseed {
1.1133 foxr 13848: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 13849: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 13850: if (!defined($symb)) {
1.366 albertel 13851: unless ($symb=$wsymb) { return time; }
13852: }
1.1146 foxr 13853: if (!defined $courseid) {
13854: $courseid=$wcourseid;
13855: }
13856: if (!defined $domain) { $domain=$wdomain; }
13857: if (!defined $username) { $username=$wusername }
1.1133 foxr 13858:
13859: my $which;
13860: if (defined($cenv->{'rndseed'})) {
13861: $which = $cenv->{'rndseed'};
13862: } else {
13863: $which =&get_rand_alg($courseid);
13864: }
1.491 albertel 13865: if (defined(&getCODE())) {
1.1133 foxr 13866:
1.675 albertel 13867: if ($which eq '64bit5') {
13868: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
13869: } elsif ($which eq '64bit4') {
1.575 albertel 13870: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
13871: } else {
13872: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
13873: }
1.675 albertel 13874: } elsif ($which eq '64bit5') {
13875: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 13876: } elsif ($which eq '64bit4') {
13877: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 13878: } elsif ($which eq '64bit3') {
13879: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 13880: } elsif ($which eq '64bit2') {
13881: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 13882: } elsif ($which eq '64bit') {
13883: return &rndseed_64bit($symb,$courseid,$domain,$username);
13884: }
13885: return &rndseed_32bit($symb,$courseid,$domain,$username);
13886: }
13887:
13888: sub rndseed_32bit {
13889: my ($symb,$courseid,$domain,$username)=@_;
13890: {
13891: use integer;
13892: my $symbchck=unpack("%32C*",$symb) << 27;
13893: my $symbseed=numval($symb) << 22;
13894: my $namechck=unpack("%32C*",$username) << 17;
13895: my $nameseed=numval($username) << 12;
13896: my $domainseed=unpack("%32C*",$domain) << 7;
13897: my $courseseed=unpack("%32C*",$courseid);
13898: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 13899: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13900: #&logthis("rndseed :$num:$symb");
1.564 albertel 13901: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 13902: return $num;
13903: }
13904: }
13905:
13906: sub rndseed_64bit {
13907: my ($symb,$courseid,$domain,$username)=@_;
13908: {
13909: use integer;
13910: my $symbchck=unpack("%32S*",$symb) << 21;
13911: my $symbseed=numval($symb) << 10;
13912: my $namechck=unpack("%32S*",$username);
13913:
13914: my $nameseed=numval($username) << 21;
13915: my $domainseed=unpack("%32S*",$domain) << 10;
13916: my $courseseed=unpack("%32S*",$courseid);
13917:
13918: my $num1=$symbchck+$symbseed+$namechck;
13919: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13920: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13921: #&logthis("rndseed :$num:$symb");
1.564 albertel 13922: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 13923: return "$num1,$num2";
1.155 albertel 13924: }
1.366 albertel 13925: }
13926:
1.443 albertel 13927: sub rndseed_64bit2 {
13928: my ($symb,$courseid,$domain,$username)=@_;
13929: {
13930: use integer;
13931: # strings need to be an even # of cahracters long, it it is odd the
13932: # last characters gets thrown away
13933: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13934: my $symbseed=numval($symb) << 10;
13935: my $namechck=unpack("%32S*",$username.' ');
13936:
13937: my $nameseed=numval($username) << 21;
1.501 albertel 13938: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13939: my $courseseed=unpack("%32S*",$courseid.' ');
13940:
13941: my $num1=$symbchck+$symbseed+$namechck;
13942: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13943: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13944: #&logthis("rndseed :$num:$symb");
1.803 albertel 13945: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 13946: return "$num1,$num2";
13947: }
13948: }
13949:
13950: sub rndseed_64bit3 {
13951: my ($symb,$courseid,$domain,$username)=@_;
13952: {
13953: use integer;
13954: # strings need to be an even # of cahracters long, it it is odd the
13955: # last characters gets thrown away
13956: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13957: my $symbseed=numval2($symb) << 10;
13958: my $namechck=unpack("%32S*",$username.' ');
13959:
13960: my $nameseed=numval2($username) << 21;
1.443 albertel 13961: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13962: my $courseseed=unpack("%32S*",$courseid.' ');
13963:
13964: my $num1=$symbchck+$symbseed+$namechck;
13965: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13966: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13967: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 13968: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 13969:
1.503 albertel 13970: return "$num1:$num2";
1.443 albertel 13971: }
13972: }
13973:
1.575 albertel 13974: sub rndseed_64bit4 {
13975: my ($symb,$courseid,$domain,$username)=@_;
13976: {
13977: use integer;
13978: # strings need to be an even # of cahracters long, it it is odd the
13979: # last characters gets thrown away
13980: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13981: my $symbseed=numval3($symb) << 10;
13982: my $namechck=unpack("%32S*",$username.' ');
13983:
13984: my $nameseed=numval3($username) << 21;
13985: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13986: my $courseseed=unpack("%32S*",$courseid.' ');
13987:
13988: my $num1=$symbchck+$symbseed+$namechck;
13989: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13990: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13991: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 13992: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 13993:
1.575 albertel 13994: return "$num1:$num2";
13995: }
13996: }
13997:
1.675 albertel 13998: sub rndseed_64bit5 {
13999: my ($symb,$courseid,$domain,$username)=@_;
14000: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
14001: return "$num1:$num2";
14002: }
14003:
1.366 albertel 14004: sub rndseed_CODE_64bit {
14005: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 14006: {
1.366 albertel 14007: use integer;
1.443 albertel 14008: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 14009: my $symbseed=numval2($symb);
1.491 albertel 14010: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14011: my $CODEseed=numval(&getCODE());
1.443 albertel 14012: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 14013: my $num1=$symbseed+$CODEchck;
14014: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 14015: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14016: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 14017: if ($_64bit) { $num1=(($num1<<32)>>32); }
14018: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 14019: return "$num1:$num2";
1.366 albertel 14020: }
14021: }
14022:
1.575 albertel 14023: sub rndseed_CODE_64bit4 {
14024: my ($symb,$courseid,$domain,$username)=@_;
14025: {
14026: use integer;
14027: my $symbchck=unpack("%32S*",$symb.' ') << 16;
14028: my $symbseed=numval3($symb);
14029: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14030: my $CODEseed=numval3(&getCODE());
14031: my $courseseed=unpack("%32S*",$courseid.' ');
14032: my $num1=$symbseed+$CODEchck;
14033: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 14034: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14035: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 14036: if ($_64bit) { $num1=(($num1<<32)>>32); }
14037: if ($_64bit) { $num2=(($num2<<32)>>32); }
14038: return "$num1:$num2";
14039: }
14040: }
14041:
1.675 albertel 14042: sub rndseed_CODE_64bit5 {
14043: my ($symb,$courseid,$domain,$username)=@_;
14044: my $code = &getCODE();
14045: my ($num1,$num2)=&digest("$symb,$courseid,$code");
14046: return "$num1:$num2";
14047: }
14048:
1.366 albertel 14049: sub setup_random_from_rndseed {
14050: my ($rndseed)=@_;
1.503 albertel 14051: if ($rndseed =~/([,:])/) {
1.1262 raeburn 14052: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
14053: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
14054: &Math::Random::random_set_seed_from_phrase($rndseed);
14055: } else {
14056: &Math::Random::random_set_seed($num1,$num2);
14057: }
1.366 albertel 14058: } else {
14059: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 14060: }
1.36 albertel 14061: }
14062:
1.474 albertel 14063: sub latest_receipt_algorithm_id {
1.835 albertel 14064: return 'receipt3';
1.474 albertel 14065: }
14066:
1.480 www 14067: sub recunique {
14068: my $fucourseid=shift;
14069: my $unique;
1.835 albertel 14070: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
14071: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 14072: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 14073: } else {
14074: $unique=$perlvar{'lonReceipt'};
14075: }
14076: return unpack("%32C*",$unique);
14077: }
14078:
14079: sub recprefix {
14080: my $fucourseid=shift;
14081: my $prefix;
1.835 albertel 14082: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
14083: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 14084: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 14085: } else {
14086: $prefix=$perlvar{'lonHostID'};
14087: }
14088: return unpack("%32C*",$prefix);
14089: }
14090:
1.76 www 14091: sub ireceipt {
1.474 albertel 14092: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 14093:
14094: my $return =&recprefix($fucourseid).'-';
14095:
14096: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
14097: $env{'request.state'} eq 'construct') {
14098: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
14099: return $return;
14100: }
14101:
1.76 www 14102: my $cuname=unpack("%32C*",$funame);
14103: my $cudom=unpack("%32C*",$fudom);
14104: my $cucourseid=unpack("%32C*",$fucourseid);
14105: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 14106: my $cunique=&recunique($fucourseid);
1.474 albertel 14107: my $cpart=unpack("%32S*",$part);
1.835 albertel 14108: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
14109:
1.790 albertel 14110: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 14111:
14112: $return.= ($cunique%$cuname+
14113: $cunique%$cudom+
14114: $cusymb%$cuname+
14115: $cusymb%$cudom+
14116: $cucourseid%$cuname+
14117: $cucourseid%$cudom+
14118: $cpart%$cuname+
14119: $cpart%$cudom);
14120: } else {
14121: $return.= ($cunique%$cuname+
14122: $cunique%$cudom+
14123: $cusymb%$cuname+
14124: $cusymb%$cudom+
14125: $cucourseid%$cuname+
14126: $cucourseid%$cudom);
14127: }
14128: return $return;
1.76 www 14129: }
14130:
14131: sub receipt {
1.474 albertel 14132: my ($part)=@_;
1.790 albertel 14133: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 14134: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 14135: }
1.260 ng 14136:
1.790 albertel 14137: sub whichuser {
14138: my ($passedsymb)=@_;
14139: my ($symb,$courseid,$domain,$name,$publicuser);
14140: if (defined($env{'form.grade_symb'})) {
14141: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
14142: my $allowed=&allowed('vgr',$tmp_courseid);
14143: if (!$allowed &&
14144: exists($env{'request.course.sec'}) &&
14145: $env{'request.course.sec'} !~ /^\s*$/) {
14146: $allowed=&allowed('vgr',$tmp_courseid.
14147: '/'.$env{'request.course.sec'});
14148: }
14149: if ($allowed) {
14150: ($symb)=&get_env_multiple('form.grade_symb');
14151: $courseid=$tmp_courseid;
14152: ($domain)=&get_env_multiple('form.grade_domain');
14153: ($name)=&get_env_multiple('form.grade_username');
14154: return ($symb,$courseid,$domain,$name,$publicuser);
14155: }
14156: }
14157: if (!$passedsymb) {
14158: $symb=&symbread();
14159: } else {
14160: $symb=$passedsymb;
14161: }
14162: $courseid=$env{'request.course.id'};
14163: $domain=$env{'user.domain'};
14164: $name=$env{'user.name'};
14165: if ($name eq 'public' && $domain eq 'public') {
14166: if (!defined($env{'form.username'})) {
14167: $env{'form.username'}.=time.rand(10000000);
14168: }
14169: $name.=$env{'form.username'};
14170: }
14171: return ($symb,$courseid,$domain,$name,$publicuser);
14172:
14173: }
14174:
1.36 albertel 14175: # ------------------------------------------------------------ Serves up a file
1.472 albertel 14176: # returns either the contents of the file or
14177: # -1 if the file doesn't exist
1.481 raeburn 14178: #
14179: # if the target is a file that was uploaded via DOCS,
14180: # a check will be made to see if a current copy exists on the local server,
14181: # if it does this will be served, otherwise a copy will be retrieved from
14182: # the home server for the course and stored in /home/httpd/html/userfiles on
14183: # the local server.
1.472 albertel 14184:
1.36 albertel 14185: sub getfile {
1.538 albertel 14186: my ($file) = @_;
1.609 banghart 14187: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 14188: &repcopy($file);
14189: return &readfile($file);
14190: }
14191:
14192: sub repcopy_userfile {
14193: my ($file)=@_;
1.1142 raeburn 14194: my $londocroot = $perlvar{'lonDocRoot'};
14195: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 14196: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 14197: my ($cdom,$cnum,$filename) =
1.811 albertel 14198: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 14199: my $uri="/uploaded/$cdom/$cnum/$filename";
14200: if (-e "$file") {
1.828 www 14201: # we already have a local copy, check it out
1.538 albertel 14202: my @fileinfo = stat($file);
1.828 www 14203: my $rtncode;
14204: my $info;
1.538 albertel 14205: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 14206: if ($lwpresp ne 'ok') {
1.828 www 14207: # there is no such file anymore, even though we had a local copy
1.482 albertel 14208: if ($rtncode eq '404') {
1.538 albertel 14209: unlink($file);
1.482 albertel 14210: }
14211: return -1;
14212: }
14213: if ($info < $fileinfo[9]) {
1.828 www 14214: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 14215: return 'ok';
1.828 www 14216: } else {
14217: # the file is outdated, get rid of it
14218: unlink($file);
1.482 albertel 14219: }
1.828 www 14220: }
14221: # one way or the other, at this point, we don't have the file
14222: # construct the correct path for the file
14223: my @parts = ($cdom,$cnum);
14224: if ($filename =~ m|^(.+)/[^/]+$|) {
14225: push @parts, split(/\//,$1);
14226: }
14227: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
14228: foreach my $part (@parts) {
14229: $path .= '/'.$part;
14230: if (!-e $path) {
14231: mkdir($path,0770);
1.482 albertel 14232: }
14233: }
1.828 www 14234: # now the path exists for sure
14235: # get a user agent
14236: my $transferfile=$file.'.in.transfer';
14237: # FIXME: this should flock
14238: if (-e $transferfile) { return 'ok'; }
14239: my $request;
14240: $uri=~s/^\///;
1.980 raeburn 14241: my $homeserver = &homeserver($cnum,$cdom);
1.1398 raeburn 14242: my $hostname = &hostname($homeserver);
1.980 raeburn 14243: my $protocol = $protocol{$homeserver};
14244: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14245: $request=new HTTP::Request('GET',$protocol.'://'.$hostname.'/raw/'.$uri);
1.1345 raeburn 14246: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
1.828 www 14247: # did it work?
14248: if ($response->is_error()) {
14249: unlink($transferfile);
14250: &logthis("Userfile repcopy failed for $uri");
14251: return -1;
14252: }
14253: # worked, rename the transfer file
14254: rename($transferfile,$file);
1.607 raeburn 14255: return 'ok';
1.481 raeburn 14256: }
14257:
1.517 albertel 14258: sub tokenwrapper {
14259: my $uri=shift;
1.980 raeburn 14260: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 14261: $uri=~s|^/||;
1.620 albertel 14262: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 14263: my $token=$1;
1.552 albertel 14264: my (undef,$udom,$uname,$file)=split('/',$uri,4);
14265: if ($udom && $uname && $file) {
14266: $file=~s|(\?\.*)*$||;
1.949 raeburn 14267: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 14268: my $homeserver = &homeserver($uname,$udom);
1.1397 raeburn 14269: my $hostname = &hostname($homeserver);
1.980 raeburn 14270: my $protocol = $protocol{$homeserver};
14271: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14272: return $protocol.'://'.$hostname.'/'.$uri.
1.517 albertel 14273: (($uri=~/\?/)?'&':'?').'token='.$token.
14274: '&tokenissued='.$perlvar{'lonHostID'};
14275: } else {
14276: return '/adm/notfound.html';
14277: }
14278: }
14279:
1.828 www 14280: # call with reqtype HEAD: get last modification time
14281: # call with reqtype GET: get the file contents
14282: # Do not call this with reqtype GET for large files! It loads everything into memory
14283: #
1.481 raeburn 14284: sub getuploaded {
14285: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
14286: $uri=~s/^\///;
1.980 raeburn 14287: my $homeserver = &homeserver($cnum,$cdom);
1.1397 raeburn 14288: my $hostname = &hostname($homeserver);
1.980 raeburn 14289: my $protocol = $protocol{$homeserver};
14290: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14291: $uri = $protocol.'://'.$hostname.'/raw/'.$uri;
1.481 raeburn 14292: my $request=new HTTP::Request($reqtype,$uri);
1.1345 raeburn 14293: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
1.481 raeburn 14294: $$rtncode = $response->code;
1.482 albertel 14295: if (! $response->is_success()) {
14296: return 'failed';
14297: }
14298: if ($reqtype eq 'HEAD') {
1.486 www 14299: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 14300: } elsif ($reqtype eq 'GET') {
14301: $$info = $response->content;
1.472 albertel 14302: }
1.482 albertel 14303: return 'ok';
1.36 albertel 14304: }
14305:
1.481 raeburn 14306: sub readfile {
14307: my $file = shift;
14308: if ( (! -e $file ) || ($file eq '') ) { return -1; };
14309: my $fh;
1.1359 raeburn 14310: open($fh,"<",$file);
1.481 raeburn 14311: my $a='';
1.800 albertel 14312: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 14313: return $a;
14314: }
14315:
1.36 albertel 14316: sub filelocation {
1.590 banghart 14317: my ($dir,$file) = @_;
14318: my $location;
14319: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 14320:
14321: if ($file =~ m-^/adm/-) {
14322: $file=~s-^/adm/wrapper/-/-;
14323: $file=~s-^/adm/coursedocs/showdoc/-/-;
14324: }
1.882 albertel 14325:
1.1139 www 14326: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 14327: $location = $file;
1.609 banghart 14328: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 14329: my ($udom,$uname,$filename)=
1.811 albertel 14330: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 14331: my $home=&homeserver($uname,$udom);
14332: my $is_me=0;
14333: my @ids=¤t_machine_ids();
14334: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
14335: if ($is_me) {
1.1117 foxr 14336: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 14337: } else {
14338: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
14339: $udom.'/'.$uname.'/'.$filename;
14340: }
1.882 albertel 14341: } elsif ($file =~ m-^/adm/-) {
14342: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 14343: } else {
14344: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 14345: $file=~s:^/(res|priv)/:/:;
14346: my $space=$1;
1.590 banghart 14347: if ( !( $file =~ m:^/:) ) {
14348: $location = $dir. '/'.$file;
14349: } else {
1.1142 raeburn 14350: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 14351: }
1.59 albertel 14352: }
1.590 banghart 14353: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 14354: while ($location=~m{/\.\./}) {
14355: if ($location =~ m{/[^/]+/\.\./}) {
14356: $location=~ s{/[^/]+/\.\./}{/}g;
14357: } else {
14358: $location=~ s{/\.\./}{/}g;
14359: }
14360: } #remove dir/..
1.590 banghart 14361: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
14362: return $location;
1.46 www 14363: }
1.36 albertel 14364:
1.46 www 14365: sub hreflocation {
14366: my ($dir,$file)=@_;
1.980 raeburn 14367: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 14368: $file=filelocation($dir,$file);
1.700 albertel 14369: } elsif ($file=~m-^/adm/-) {
14370: $file=~s-^/adm/wrapper/-/-;
14371: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 14372: }
14373: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
14374: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
14375: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 14376: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
14377: {/uploaded/$1/$2/}x;
1.46 www 14378: }
1.913 albertel 14379: if ($file=~ m{^/userfiles/}) {
14380: $file =~ s{^/userfiles/}{/uploaded/};
14381: }
1.462 albertel 14382: return $file;
1.465 albertel 14383: }
14384:
1.1139 www 14385:
14386:
14387:
14388:
1.465 albertel 14389: sub current_machine_domains {
1.853 albertel 14390: return &machine_domains(&hostname($perlvar{'lonHostID'}));
14391: }
14392:
14393: sub machine_domains {
14394: my ($hostname) = @_;
1.465 albertel 14395: my @domains;
1.838 albertel 14396: my %hostname = &all_hostnames();
1.465 albertel 14397: while( my($id, $name) = each(%hostname)) {
1.467 matthew 14398: # &logthis("-$id-$name-$hostname-");
1.465 albertel 14399: if ($hostname eq $name) {
1.844 albertel 14400: push(@domains,&host_domain($id));
1.465 albertel 14401: }
14402: }
14403: return @domains;
14404: }
14405:
14406: sub current_machine_ids {
1.853 albertel 14407: return &machine_ids(&hostname($perlvar{'lonHostID'}));
14408: }
14409:
14410: sub machine_ids {
14411: my ($hostname) = @_;
14412: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 14413: my @ids;
1.888 albertel 14414: my %name_to_host = &all_names();
1.889 albertel 14415: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
14416: return @{ $name_to_host{$hostname} };
14417: }
14418: return;
1.31 www 14419: }
14420:
1.824 raeburn 14421: sub additional_machine_domains {
14422: my @domains;
1.1466 raeburn 14423: if (-e "$perlvar{'lonTabDir'}/expected_domains.tab") {
14424: if (open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab")) {
14425: while (my $line = <$fh>) {
14426: chomp($line);
14427: $line =~ s/\s//g;
14428: push(@domains,$line);
14429: }
14430: close($fh);
14431: }
1.824 raeburn 14432: }
14433: return @domains;
14434: }
14435:
14436: sub default_login_domain {
14437: my $domain = $perlvar{'lonDefDomain'};
14438: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
14439: foreach my $posdom (¤t_machine_domains(),
14440: &additional_machine_domains()) {
14441: if (lc($posdom) eq lc($testdomain)) {
14442: $domain=$posdom;
14443: last;
14444: }
14445: }
14446: return $domain;
14447: }
14448:
1.1414 raeburn 14449: sub shared_institution {
1.1439 raeburn 14450: my ($dom,$lonhost) = @_;
14451: if ($lonhost eq '') {
14452: $lonhost = $perlvar{'lonHostID'};
14453: }
1.1414 raeburn 14454: my $same_intdom;
1.1439 raeburn 14455: my $hostintdom = &internet_dom($lonhost);
1.1414 raeburn 14456: if ($hostintdom ne '') {
14457: my %iphost = &get_iphost();
14458: my $primary_id = &domain($dom,'primary');
14459: my $primary_ip = &get_host_ip($primary_id);
14460: if (ref($iphost{$primary_ip}) eq 'ARRAY') {
14461: foreach my $id (@{$iphost{$primary_ip}}) {
14462: my $intdom = &internet_dom($id);
14463: if ($intdom eq $hostintdom) {
14464: $same_intdom = 1;
14465: last;
14466: }
14467: }
14468: }
14469: }
14470: return $same_intdom;
14471: }
14472:
1.1398 raeburn 14473: sub uses_sts {
14474: my ($ignore_cache) = @_;
14475: my $lonhost = $perlvar{'lonHostID'};
14476: my $hostname = &hostname($lonhost);
14477: my $sts_on;
14478: if ($protocol{$lonhost} eq 'https') {
14479: my $cachetime = 12*3600;
14480: if (!$ignore_cache) {
14481: ($sts_on,my $cached)=&is_cached_new('stspolicy',$lonhost);
14482: if (defined($cached)) {
14483: return $sts_on;
14484: }
14485: }
14486: my $url = $protocol{$lonhost}.'://'.$hostname.'/index.html';
14487: my $request=new HTTP::Request('HEAD',$url);
14488: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,'','','',1);
14489: if ($response->is_success) {
14490: my $has_sts = $response->header('Strict-Transport-Security');
14491: if ($has_sts eq '') {
14492: $sts_on = 0;
14493: } else {
14494: if ($has_sts =~ /\Qmax-age=\E(\d+)/) {
14495: my $maxage = $1;
14496: if ($maxage) {
14497: $sts_on = 1;
14498: } else {
14499: $sts_on = 0;
14500: }
14501: } else {
14502: $sts_on = 0;
14503: }
14504: }
14505: return &do_cache_new('stspolicy',$lonhost,$sts_on,$cachetime);
14506: }
14507: }
14508: return;
14509: }
14510:
1.1449 raeburn 14511: sub waf_allssl {
14512: my ($host_name) = @_;
14513: my $alias = &get_proxy_alias();
14514: if ($host_name eq '') {
14515: $host_name = $ENV{'SERVER_NAME'};
14516: }
14517: if (($host_name ne '') && ($alias eq $host_name)) {
14518: my $serverhomedom = &host_domain($perlvar{'lonHostID'});
14519: my %defdomdefaults = &get_domain_defaults($serverhomedom);
14520: if ($defdomdefaults{'waf_sslopt'}) {
14521: return $defdomdefaults{'waf_sslopt'};
14522: }
14523: }
14524: return;
14525: }
14526:
1.1434 raeburn 14527: sub get_requestor_ip {
14528: my ($r,$nolookup,$noproxy) = @_;
14529: my $from_ip;
14530: if (ref($r)) {
1.1447 raeburn 14531: if ($r->can('useragent_ip')) {
14532: if ($noproxy && $r->can('client_ip')) {
14533: $from_ip = $r->client_ip();
14534: } else {
14535: $from_ip = $r->useragent_ip();
14536: }
14537: } elsif ($r->connection->can('remote_ip')) {
14538: $from_ip = $r->connection->remote_ip();
14539: } else {
14540: $from_ip = $r->get_remote_host($nolookup);
14541: }
1.1434 raeburn 14542: } else {
14543: $from_ip = $ENV{'REMOTE_ADDR'};
14544: }
14545: return $from_ip if ($noproxy);
14546: # Who controls proxy settings for server
14547: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
14548: my $proxyinfo = &get_proxy_settings($dom_in_use);
14549: if ((ref($proxyinfo) eq 'HASH') && ($from_ip)) {
1.1437 raeburn 14550: if ($proxyinfo->{'vpnint'}) {
14551: if (&ip_match($from_ip,$proxyinfo->{'vpnint'})) {
1.1434 raeburn 14552: return $from_ip;
14553: }
14554: }
14555: if ($proxyinfo->{'trusted'}) {
14556: if (&ip_match($from_ip,$proxyinfo->{'trusted'})) {
14557: my $ipheader = $proxyinfo->{'ipheader'};
14558: my ($ip,$xfor);
14559: if (ref($r)) {
14560: if ($ipheader) {
14561: $ip = $r->headers_in->{$ipheader};
14562: }
14563: $xfor = $r->headers_in->{'X-Forwarded-For'};
14564: } else {
14565: if ($ipheader) {
14566: $ip = $ENV{'HTTP_'.uc($ipheader)};
14567: }
14568: $xfor = $ENV{'HTTP_X_FORWARDED_FOR'};
14569: }
14570: if (($ip eq '') && ($xfor ne '')) {
14571: foreach my $poss_ip (reverse(split(/\s*,\s*/,$xfor))) {
14572: unless (&ip_match($poss_ip,$proxyinfo->{'trusted'})) {
14573: $ip = $poss_ip;
1.1435 raeburn 14574: last;
1.1434 raeburn 14575: }
14576: }
14577: }
14578: if ($ip ne '') {
14579: return $ip;
14580: }
14581: }
14582: }
14583: }
14584: return $from_ip;
14585: }
14586:
14587: sub get_proxy_settings {
14588: my ($dom_in_use) = @_;
14589: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom_in_use);
14590: my $proxyinfo = {
14591: ipheader => $domdefaults{'waf_ipheader'},
14592: trusted => $domdefaults{'waf_trusted'},
1.1437 raeburn 14593: vpnint => $domdefaults{'waf_vpnint'},
1.1438 raeburn 14594: vpnext => $domdefaults{'waf_vpnext'},
1.1449 raeburn 14595: sslopt => $domdefaults{'waf_sslopt'},
1.1434 raeburn 14596: };
14597: return $proxyinfo;
14598: }
14599:
14600: sub ip_match {
14601: my ($ip,$pattern_str) = @_;
14602: $ip=Net::CIDR::cidrvalidate($ip);
14603: if ($ip) {
14604: return Net::CIDR::cidrlookup($ip,split(/\s*,\s*/,$pattern_str));
14605: }
14606: return;
14607: }
14608:
14609: sub get_proxy_alias {
1.1450 raeburn 14610: my ($lonid) = @_;
14611: if ($lonid eq '') {
14612: $lonid = $perlvar{'lonHostID'};
14613: }
14614: if (!defined(&hostname($lonid))) {
14615: return;
14616: }
14617: if ($lonid ne '') {
14618: my ($alias,$cached) = &is_cached_new('proxyalias',$lonid);
1.1434 raeburn 14619: if ($cached) {
14620: return $alias;
14621: }
1.1450 raeburn 14622: my $dom = &Apache::lonnet::host_domain($lonid);
1.1434 raeburn 14623: if ($dom ne '') {
14624: my $cachetime = 60*60*24;
14625: my %domconfig =
1.1437 raeburn 14626: &Apache::lonnet::get_dom('configuration',['wafproxy'],$dom);
14627: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
14628: if (ref($domconfig{'wafproxy'}{'alias'}) eq 'HASH') {
1.1450 raeburn 14629: $alias = $domconfig{'wafproxy'}{'alias'}{$lonid};
14630: }
14631: }
14632: return &do_cache_new('proxyalias',$lonid,$alias,$cachetime);
14633: }
14634: }
14635: return;
14636: }
14637:
14638: sub use_proxy_alias {
14639: my ($r,$lonid) = @_;
14640: my $alias = &get_proxy_alias($lonid);
14641: if ($alias) {
14642: my $dom = &host_domain($lonid);
14643: if ($dom ne '') {
1.1467 raeburn 14644: my $proxyinfo = &get_proxy_settings($dom);
1.1450 raeburn 14645: my ($vpnint,$remote_ip);
14646: if (ref($proxyinfo) eq 'HASH') {
14647: $vpnint = $proxyinfo->{'vpnint'};
14648: if ($vpnint) {
14649: $remote_ip = &get_requestor_ip($r,1,1);
1.1434 raeburn 14650: }
14651: }
1.1450 raeburn 14652: unless ($vpnint && &ip_match($remote_ip,$vpnint)) {
14653: return $alias;
14654: }
1.1434 raeburn 14655: }
14656: }
14657: return;
14658: }
14659:
1.1474 raeburn 14660: sub alias_sso {
1.1467 raeburn 14661: my ($lonid) = @_;
14662: if ($lonid eq '') {
14663: $lonid = $perlvar{'lonHostID'};
14664: }
14665: if (!defined(&hostname($lonid))) {
14666: return;
14667: }
14668: if ($lonid ne '') {
14669: my ($use_alias,$cached) = &is_cached_new('proxysaml',$lonid);
14670: if ($cached) {
14671: return $use_alias;
14672: }
14673: my $dom = &Apache::lonnet::host_domain($lonid);
14674: if ($dom ne '') {
14675: my $cachetime = 60*60*24;
14676: my %domconfig =
14677: &Apache::lonnet::get_dom('configuration',['wafproxy'],$dom);
14678: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
14679: if (ref($domconfig{'wafproxy'}{'saml'}) eq 'HASH') {
14680: $use_alias = $domconfig{'wafproxy'}{'saml'}{$lonid};
14681: }
14682: }
14683: return &do_cache_new('proxysaml',$lonid,$use_alias,$cachetime);
14684: }
14685: }
14686: return;
14687: }
14688:
1.1465 raeburn 14689: sub get_saml_landing {
14690: my ($lonid) = @_;
14691: if ($lonid eq '') {
14692: my $defdom = &default_login_domain();
14693: my @hosts = ¤t_machine_ids();
14694: if (@hosts > 1) {
14695: foreach my $hostid (@hosts) {
14696: if (&host_domain($hostid) eq $defdom) {
14697: $lonid = $hostid;
14698: last;
14699: }
14700: }
14701: } else {
14702: $lonid = $perlvar{'lonHostID'};
14703: }
14704: if ($lonid) {
14705: unless (&Apache::lonnet::host_domain($lonid) eq $defdom) {
14706: return;
14707: }
14708: } else {
14709: return;
14710: }
14711: } elsif (!defined(&hostname($lonid))) {
14712: return;
14713: }
14714: my ($landing,$cached) = &is_cached_new('samllanding',$lonid);
14715: if ($cached) {
14716: return $landing;
14717: }
14718: my $dom = &Apache::lonnet::host_domain($lonid);
14719: if ($dom ne '') {
14720: my $cachetime = 60*60*24;
14721: my %domconfig =
14722: &Apache::lonnet::get_dom('configuration',['login'],$dom);
14723: if (ref($domconfig{'login'}) eq 'HASH') {
14724: if (ref($domconfig{'login'}{'saml'}) eq 'HASH') {
14725: if (ref($domconfig{'login'}{'saml'}{$lonid}) eq 'HASH') {
14726: $landing = 1;
14727: }
14728: }
14729: }
14730: return &do_cache_new('samllanding',$lonid,$landing,$cachetime);
14731: }
14732: return;
14733: }
14734:
1.31 www 14735: # ------------------------------------------------------------- Declutters URLs
14736:
14737: sub declutter {
14738: my $thisfn=shift;
1.569 albertel 14739: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261 raeburn 14740: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
14741: $thisfn=~s{^/home/httpd/html}{};
14742: }
1.31 www 14743: $thisfn=~s/^\///;
1.697 albertel 14744: $thisfn=~s|^adm/wrapper/||;
14745: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 14746: $thisfn=~s/^res\///;
1.1172 bisitz 14747: $thisfn=~s/^priv\///;
1.1032 raeburn 14748: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
14749: $thisfn=~s/\?.+$//;
14750: }
1.268 www 14751: return $thisfn;
14752: }
14753:
14754: # ------------------------------------------------------------- Clutter up URLs
14755:
14756: sub clutter {
14757: my $thisfn='/'.&declutter(shift);
1.887 albertel 14758: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 14759: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 14760: $thisfn='/res'.$thisfn;
14761: }
1.1031 raeburn 14762: if ($thisfn !~m|^/adm|) {
14763: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 14764: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 14765: } else {
14766: my ($ext) = ($thisfn =~ /\.(\w+)$/);
14767: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 14768: if ($embstyle eq 'ssi'
14769: || ($embstyle eq 'hdn')
14770: || ($embstyle eq 'rat')
14771: || ($embstyle eq 'prv')
14772: || ($embstyle eq 'ign')) {
14773: #do nothing with these
14774: } elsif (($embstyle eq 'img')
1.695 albertel 14775: || ($embstyle eq 'emb')
14776: || ($embstyle eq 'wrp')) {
14777: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 14778: } elsif ($embstyle eq 'unk'
14779: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 14780: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 14781: } else {
1.718 www 14782: # &logthis("Got a blank emb style");
1.695 albertel 14783: }
1.694 albertel 14784: }
1.1343 raeburn 14785: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
1.1298 raeburn 14786: $thisfn='/adm/wrapper'.$thisfn;
1.694 albertel 14787: }
1.31 www 14788: return $thisfn;
1.12 www 14789: }
14790:
1.787 albertel 14791: sub clutter_with_no_wrapper {
14792: my $uri = &clutter(shift);
14793: if ($uri =~ m-^/adm/-) {
14794: $uri =~ s-^/adm/wrapper/-/-;
14795: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
14796: }
14797: return $uri;
14798: }
14799:
1.557 albertel 14800: sub freeze_escape {
14801: my ($value)=@_;
14802: if (ref($value)) {
14803: $value=&nfreeze($value);
14804: return '__FROZEN__'.&escape($value);
14805: }
14806: return &escape($value);
14807: }
14808:
1.11 www 14809:
1.557 albertel 14810: sub thaw_unescape {
14811: my ($value)=@_;
14812: if ($value =~ /^__FROZEN__/) {
14813: substr($value,0,10,undef);
14814: $value=&unescape($value);
14815: return &thaw($value);
14816: }
14817: return &unescape($value);
14818: }
14819:
1.436 albertel 14820: sub correct_line_ends {
14821: my ($result)=@_;
14822: $$result =~s/\r\n/\n/mg;
14823: $$result =~s/\r/\n/mg;
1.415 albertel 14824: }
1.1 albertel 14825: # ================================================================ Main Program
14826:
1.184 www 14827: sub goodbye {
1.204 albertel 14828: &logthis("Starting Shut down");
1.443 albertel 14829: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 14830: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 14831: #converted
1.599 albertel 14832: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 14833: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
14834: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
14835: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 14836: #1.1 only
1.870 albertel 14837: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
14838: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
14839: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
14840: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
14841: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 14842: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
14843: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 14844: &flushcourselogs();
14845: &logthis("Shutting down");
14846: }
14847:
1.852 albertel 14848: sub get_dns {
1.1210 raeburn 14849: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 14850: if (!$ignore_cache) {
14851: my ($content,$cached)=
14852: &Apache::lonnet::is_cached_new('dns',$url);
14853: if ($cached) {
1.1210 raeburn 14854: &$func($content,$hashref);
1.869 albertel 14855: return;
14856: }
14857: }
14858:
14859: my %alldns;
1.1379 raeburn 14860: if (open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab")) {
14861: foreach my $dns (<$config>) {
14862: next if ($dns !~ /^\^(\S*)/x);
14863: my $line = $1;
14864: my ($host,$protocol) = split(/:/,$line);
14865: if ($protocol ne 'https') {
14866: $protocol = 'http';
14867: }
14868: $alldns{$host} = $protocol;
1.979 raeburn 14869: }
1.1379 raeburn 14870: close($config);
1.869 albertel 14871: }
14872: while (%alldns) {
1.1263 raeburn 14873: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.1456 raeburn 14874: my ($contents,@content);
14875: if ($dns eq Sys::Hostname::FQDN::fqdn()) {
14876: my $command = (split('/',$url))[3];
14877: my ($dir,$file) = &parse_getdns_url($command,$url);
14878: delete($alldns{$dns});
14879: next if (($dir eq '') || ($file eq ''));
14880: if (open(my $config,'<',"$dir/$file")) {
1.1457 raeburn 14881: @content = <$config>;
1.1456 raeburn 14882: close($config);
14883: }
14884: if ($url eq '/adm/dns/loncapaCRL') {
14885: $contents = join('',@content);
14886: }
14887: } else {
14888: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
14889: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
14890: delete($alldns{$dns});
14891: next if ($response->is_error());
14892: if ($url eq '/adm/dns/loncapaCRL') {
14893: $contents = $response->content;
14894: } else {
14895: @content = split("\n",$response->content);
14896: }
14897: }
1.1379 raeburn 14898: if ($url eq '/adm/dns/loncapaCRL') {
1.1456 raeburn 14899: return &$func($contents);
1.1379 raeburn 14900: } else {
14901: unless ($nocache) {
14902: &do_cache_new('dns',$url,\@content,30*24*60*60);
14903: }
14904: &$func(\@content,$hashref);
14905: return;
14906: }
14907: }
14908: my $which = (split('/',$url,4))[3];
14909: if ($which eq 'loncapaCRL') {
14910: my $diskfile = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
14911: if (-e $diskfile) {
14912: &logthis("unable to contact DNS, on disk file $diskfile not updated");
14913: } else {
14914: &logthis("unable to contact DNS, no on disk file $diskfile available");
14915: }
14916: } else {
14917: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
14918: if (open(my $config,"<","$perlvar{'lonTabDir'}/dns_$which.tab")) {
14919: my @content = <$config>;
14920: close($config);
14921: &$func(\@content,$hashref);
14922: }
1.852 albertel 14923: }
1.1210 raeburn 14924: return;
14925: }
14926:
14927: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 14928: sub parse_dns_checksums_tab {
1.1210 raeburn 14929: my ($lines,$hashref) = @_;
1.1264 raeburn 14930: my $lonhost = $perlvar{'lonHostID'};
14931: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1210 raeburn 14932: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264 raeburn 14933: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
14934: my $webconfdir = '/etc/httpd/conf';
14935: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
14936: $webconfdir = '/etc/apache2';
14937: } elsif ($distro =~ /^sles(\d+)$/) {
14938: if ($1 >= 10) {
14939: $webconfdir = '/etc/apache2';
14940: }
14941: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
14942: if ($1 >= 10.0) {
14943: $webconfdir = '/etc/apache2';
14944: }
14945: }
1.1210 raeburn 14946: my ($release,$timestamp) = split(/\-/,$loncaparev);
14947: my (%chksum,%revnum);
14948: if (ref($lines) eq 'ARRAY') {
14949: chomp(@{$lines});
1.1238 raeburn 14950: my $version = shift(@{$lines});
14951: if ($version eq $release) {
1.1210 raeburn 14952: foreach my $line (@{$lines}) {
1.1238 raeburn 14953: my ($file,$version,$shasum) = split(/,/,$line);
1.1264 raeburn 14954: if ($file =~ m{^/etc/httpd/conf}) {
14955: if ($webconfdir eq '/etc/apache2') {
14956: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
14957: }
14958: }
1.1238 raeburn 14959: $chksum{$file} = $shasum;
14960: $revnum{$file} = $version;
1.1210 raeburn 14961: }
14962: if (ref($hashref) eq 'HASH') {
14963: %{$hashref} = (
14964: sums => \%chksum,
14965: versions => \%revnum,
14966: );
14967: }
14968: }
14969: }
1.869 albertel 14970: return;
1.852 albertel 14971: }
1.1210 raeburn 14972:
14973: sub fetch_dns_checksums {
1.1238 raeburn 14974: my %checksums;
14975: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1260 raeburn 14976: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238 raeburn 14977: my ($release,$timestamp) = split(/\-/,$loncaparev);
14978: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211 raeburn 14979: \%checksums);
1.1210 raeburn 14980: return \%checksums;
14981: }
14982:
1.1379 raeburn 14983: sub fetch_crl_pemfile {
14984: return &get_dns("/adm/dns/loncapaCRL",\&save_crl_pem,1,1);
14985: }
14986:
14987: sub save_crl_pem {
1.1456 raeburn 14988: my ($content) = @_;
1.1380 raeburn 14989: my ($msg,$hadchanges);
1.1456 raeburn 14990: if ($content ne '') {
1.1379 raeburn 14991: my $now = time;
14992: my $lonca = $perlvar{'lonCertificateDirectory'}.'/'.$perlvar{'lonnetCertificateAuthority'};
14993: my $tmpcrl = $tmpdir.'/'.$perlvar{'lonnetCertRevocationList'}.'_'.$now.'.'.$$.'.tmp';
14994: if (open(my $fh,'>',"$tmpcrl")) {
1.1456 raeburn 14995: print $fh $content;
1.1379 raeburn 14996: close($fh);
14997: if (-e $lonca) {
14998: if (open(PIPE,"openssl crl -in $tmpcrl -inform pem -CAfile $lonca -noout 2>&1 |")) {
14999: my $check = <PIPE>;
15000: close(PIPE);
15001: chomp($check);
15002: if ($check eq 'verify OK') {
15003: my $dest = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
1.1380 raeburn 15004: my $backup;
1.1379 raeburn 15005: if (-e $dest) {
1.1380 raeburn 15006: if (&File::Copy::move($dest,"$dest.bak")) {
15007: $backup = 'ok';
15008: }
1.1379 raeburn 15009: }
15010: if (&File::Copy::move($tmpcrl,$dest)) {
15011: $msg = 'ok';
1.1380 raeburn 15012: if ($backup) {
15013: my (%oldnums,%newnums);
15014: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest.bak |grep 'Serial Number' |")) {
15015: while (<PIPE>) {
15016: $oldnums{(split(/:/))[1]} = 1;
15017: }
15018: close(PIPE);
15019: }
15020: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest |grep 'Serial Number' |")) {
15021: while(<PIPE>) {
15022: $newnums{(split(/:/))[1]} = 1;
15023: }
15024: close(PIPE);
15025: }
15026: foreach my $key (sort {$b <=> $a } (keys(%newnums))) {
15027: unless (exists($oldnums{$key})) {
15028: $hadchanges = 1;
15029: last;
15030: }
15031: }
15032: unless ($hadchanges) {
15033: foreach my $key (sort {$b <=> $a } (keys(%oldnums))) {
15034: unless (exists($newnums{$key})) {
15035: $hadchanges = 1;
15036: last;
15037: }
15038: }
15039: }
15040: }
1.1379 raeburn 15041: }
15042: } else {
15043: unlink($tmpcrl);
15044: }
15045: } else {
15046: unlink($tmpcrl);
15047: }
15048: } else {
15049: unlink($tmpcrl);
15050: }
15051: }
15052: }
1.1380 raeburn 15053: return ($msg,$hadchanges);
1.1379 raeburn 15054: }
15055:
1.1456 raeburn 15056: sub parse_getdns_url {
15057: my ($command,$url) = @_;
15058: my $dir = $perlvar{'lonTabDir'};
15059: my $file;
15060: if ($command eq 'hosts') {
15061: $file = 'dns_hosts.tab';
15062: } elsif ($command eq 'domain') {
15063: $file = 'dns_domain.tab';
15064: } elsif ($command eq 'checksums') {
15065: my $version = (split('/',$url))[4];
15066: $file = "dns_checksums/$version.tab",
15067: } elsif ($command eq 'loncapaCRL') {
15068: $dir = $perlvar{'lonCertificateDirectory'};
15069: $file = $perlvar{'lonnetCertRevocationList'};
15070: }
15071: return ($dir,$file);
15072: }
15073:
1.327 albertel 15074: # ------------------------------------------------------------ Read domain file
15075: {
1.852 albertel 15076: my $loaded;
1.846 albertel 15077: my %domain;
15078:
1.852 albertel 15079: sub parse_domain_tab {
15080: my ($lines) = @_;
15081: foreach my $line (@$lines) {
15082: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 15083:
1.846 albertel 15084: chomp($line);
1.852 albertel 15085: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 15086: my %this_domain;
15087: foreach my $field ('description', 'auth_def', 'auth_arg_def',
15088: 'lang_def', 'city', 'longi', 'lati',
15089: 'primary') {
15090: $this_domain{$field} = shift(@elements);
15091: }
15092: $domain{$name} = \%this_domain;
1.852 albertel 15093: }
15094: }
1.864 albertel 15095:
15096: sub reset_domain_info {
15097: undef($loaded);
15098: undef(%domain);
15099: }
15100:
1.852 albertel 15101: sub load_domain_tab {
1.1293 raeburn 15102: my ($ignore_cache,$nocache) = @_;
15103: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 15104: my $fh;
1.1359 raeburn 15105: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
1.852 albertel 15106: my @lines = <$fh>;
15107: &parse_domain_tab(\@lines);
1.448 albertel 15108: }
1.852 albertel 15109: close($fh);
15110: $loaded = 1;
1.327 albertel 15111: }
1.846 albertel 15112:
15113: sub domain {
1.852 albertel 15114: &load_domain_tab() if (!$loaded);
15115:
1.846 albertel 15116: my ($name,$what) = @_;
15117: return if ( !exists($domain{$name}) );
15118:
15119: if (!$what) {
15120: return $domain{$name}{'description'};
15121: }
15122: return $domain{$name}{$what};
15123: }
1.974 raeburn 15124:
15125: sub domain_info {
15126: &load_domain_tab() if (!$loaded);
15127: return %domain;
15128: }
15129:
1.327 albertel 15130: }
15131:
15132:
1.1 albertel 15133: # ------------------------------------------------------------- Read hosts file
15134: {
1.838 albertel 15135: my %hostname;
1.844 albertel 15136: my %hostdom;
1.845 albertel 15137: my %libserv;
1.852 albertel 15138: my $loaded;
1.888 albertel 15139: my %name_to_host;
1.1074 raeburn 15140: my %internetdom;
1.1107 raeburn 15141: my %LC_dns_serv;
1.852 albertel 15142:
15143: sub parse_hosts_tab {
15144: my ($file) = @_;
15145: foreach my $configline (@$file) {
15146: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 15147: chomp($configline);
15148: if ($configline =~ /^\^/) {
15149: if ($configline =~ /^\^([\w.\-]+)/) {
15150: $LC_dns_serv{$1} = 1;
15151: }
15152: next;
15153: }
1.1074 raeburn 15154: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 15155: $name=~s/\s//g;
15156: if ($id && $domain && $role && $name) {
1.1351 raeburn 15157: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
15158: my $curr = $hostname{$id};
15159: my $skip;
15160: if (ref($name_to_host{$curr}) eq 'ARRAY') {
15161: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
15162: $skip = 1;
15163: } else {
15164: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
15165: }
15166: }
15167: unless ($skip) {
15168: push(@{$name_to_host{$name}},$id);
15169: }
15170: } else {
15171: push(@{$name_to_host{$name}},$id);
15172: }
1.852 albertel 15173: $hostname{$id}=$name;
15174: $hostdom{$id}=$domain;
15175: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 15176: if (defined($protocol)) {
15177: if ($protocol eq 'https') {
15178: $protocol{$id} = $protocol;
15179: } else {
15180: $protocol{$id} = 'http';
15181: }
1.968 raeburn 15182: } else {
1.969 raeburn 15183: $protocol{$id} = 'http';
1.968 raeburn 15184: }
1.1074 raeburn 15185: if (defined($intdom)) {
15186: $internetdom{$id} = $intdom;
15187: }
1.852 albertel 15188: }
15189: }
15190: }
1.864 albertel 15191:
15192: sub reset_hosts_info {
1.897 albertel 15193: &purge_remembered();
1.864 albertel 15194: &reset_domain_info();
15195: &reset_hosts_ip_info();
1.1339 raeburn 15196: undef(%internetdom);
1.892 albertel 15197: undef(%name_to_host);
1.864 albertel 15198: undef(%hostname);
15199: undef(%hostdom);
15200: undef(%libserv);
15201: undef($loaded);
15202: }
1.1 albertel 15203:
1.852 albertel 15204: sub load_hosts_tab {
1.1293 raeburn 15205: my ($ignore_cache,$nocache) = @_;
15206: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.1359 raeburn 15207: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852 albertel 15208: my @config = <$config>;
15209: &parse_hosts_tab(\@config);
15210: close($config);
15211: $loaded=1;
1.1 albertel 15212: }
1.852 albertel 15213:
1.838 albertel 15214: sub hostname {
1.852 albertel 15215: &load_hosts_tab() if (!$loaded);
15216:
1.838 albertel 15217: my ($lonid) = @_;
15218: return $hostname{$lonid};
15219: }
1.845 albertel 15220:
1.838 albertel 15221: sub all_hostnames {
1.852 albertel 15222: &load_hosts_tab() if (!$loaded);
15223:
1.838 albertel 15224: return %hostname;
15225: }
1.845 albertel 15226:
1.888 albertel 15227: sub all_names {
1.1293 raeburn 15228: my ($ignore_cache,$nocache) = @_;
15229: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 15230:
15231: return %name_to_host;
15232: }
15233:
1.974 raeburn 15234: sub all_host_domain {
15235: &load_hosts_tab() if (!$loaded);
15236: return %hostdom;
15237: }
15238:
1.1339 raeburn 15239: sub all_host_intdom {
15240: &load_hosts_tab() if (!$loaded);
15241: return %internetdom;
15242: }
15243:
1.845 albertel 15244: sub is_library {
1.852 albertel 15245: &load_hosts_tab() if (!$loaded);
15246:
1.845 albertel 15247: return exists($libserv{$_[0]});
15248: }
15249:
15250: sub all_library {
1.852 albertel 15251: &load_hosts_tab() if (!$loaded);
15252:
1.845 albertel 15253: return %libserv;
15254: }
15255:
1.1062 droeschl 15256: sub unique_library {
15257: #2x reverse removes all hostnames that appear more than once
15258: my %unique = reverse &all_library();
15259: return reverse %unique;
15260: }
15261:
1.841 albertel 15262: sub get_servers {
1.852 albertel 15263: &load_hosts_tab() if (!$loaded);
15264:
1.841 albertel 15265: my ($domain,$type) = @_;
15266: my %possible_hosts = ($type eq 'library') ? %libserv
15267: : %hostname;
15268: my %result;
1.842 albertel 15269: if (ref($domain) eq 'ARRAY') {
15270: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 15271: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 15272: $result{$host} = $hostname;
15273: }
15274: }
15275: } else {
15276: while ( my ($host,$hostname) = each(%possible_hosts)) {
15277: if ($hostdom{$host} eq $domain) {
15278: $result{$host} = $hostname;
15279: }
1.841 albertel 15280: }
15281: }
15282: return %result;
15283: }
1.845 albertel 15284:
1.1062 droeschl 15285: sub get_unique_servers {
15286: my %unique = reverse &get_servers(@_);
15287: return reverse %unique;
15288: }
15289:
1.844 albertel 15290: sub host_domain {
1.852 albertel 15291: &load_hosts_tab() if (!$loaded);
15292:
1.844 albertel 15293: my ($lonid) = @_;
15294: return $hostdom{$lonid};
15295: }
15296:
1.841 albertel 15297: sub all_domains {
1.852 albertel 15298: &load_hosts_tab() if (!$loaded);
15299:
1.841 albertel 15300: my %seen;
15301: my @uniq = grep(!$seen{$_}++, values(%hostdom));
15302: return @uniq;
15303: }
1.1074 raeburn 15304:
15305: sub internet_dom {
15306: &load_hosts_tab() if (!$loaded);
15307:
15308: my ($lonid) = @_;
15309: return $internetdom{$lonid};
15310: }
1.1107 raeburn 15311:
15312: sub is_LC_dns {
15313: &load_hosts_tab() if (!$loaded);
15314:
15315: my ($hostname) = @_;
15316: return exists($LC_dns_serv{$hostname});
15317: }
15318:
1.1 albertel 15319: }
15320:
1.847 albertel 15321: {
15322: my %iphost;
1.856 albertel 15323: my %name_to_ip;
15324: my %lonid_to_ip;
1.869 albertel 15325:
1.847 albertel 15326: sub get_hosts_from_ip {
15327: my ($ip) = @_;
15328: my %iphosts = &get_iphost();
15329: if (ref($iphosts{$ip})) {
15330: return @{$iphosts{$ip}};
15331: }
15332: return;
1.839 albertel 15333: }
1.864 albertel 15334:
15335: sub reset_hosts_ip_info {
15336: undef(%iphost);
15337: undef(%name_to_ip);
15338: undef(%lonid_to_ip);
15339: }
1.856 albertel 15340:
15341: sub get_host_ip {
15342: my ($lonid) = @_;
15343: if (exists($lonid_to_ip{$lonid})) {
15344: return $lonid_to_ip{$lonid};
15345: }
15346: my $name=&hostname($lonid);
15347: my $ip = gethostbyname($name);
15348: return if (!$ip || length($ip) ne 4);
15349: $ip=inet_ntoa($ip);
15350: $name_to_ip{$name} = $ip;
15351: $lonid_to_ip{$lonid} = $ip;
15352: return $ip;
15353: }
1.847 albertel 15354:
15355: sub get_iphost {
1.1293 raeburn 15356: my ($ignore_cache,$nocache) = @_;
1.894 albertel 15357:
1.869 albertel 15358: if (!$ignore_cache) {
15359: if (%iphost) {
15360: return %iphost;
15361: }
15362: my ($ip_info,$cached)=
15363: &Apache::lonnet::is_cached_new('iphost','iphost');
15364: if ($cached) {
15365: %iphost = %{$ip_info->[0]};
15366: %name_to_ip = %{$ip_info->[1]};
15367: %lonid_to_ip = %{$ip_info->[2]};
15368: return %iphost;
15369: }
15370: }
1.894 albertel 15371:
15372: # get yesterday's info for fallback
15373: my %old_name_to_ip;
15374: my ($ip_info,$cached)=
15375: &Apache::lonnet::is_cached_new('iphost','iphost');
15376: if ($cached) {
15377: %old_name_to_ip = %{$ip_info->[1]};
15378: }
15379:
1.1293 raeburn 15380: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 15381: foreach my $name (keys(%name_to_host)) {
1.847 albertel 15382: my $ip;
15383: if (!exists($name_to_ip{$name})) {
15384: $ip = gethostbyname($name);
15385: if (!$ip || length($ip) ne 4) {
1.894 albertel 15386: if (defined($old_name_to_ip{$name})) {
15387: $ip = $old_name_to_ip{$name};
15388: &logthis("Can't find $name defaulting to old $ip");
15389: } else {
15390: &logthis("Name $name no IP found");
15391: next;
15392: }
15393: } else {
15394: $ip=inet_ntoa($ip);
1.847 albertel 15395: }
15396: $name_to_ip{$name} = $ip;
15397: } else {
15398: $ip = $name_to_ip{$name};
1.653 albertel 15399: }
1.888 albertel 15400: foreach my $id (@{ $name_to_host{$name} }) {
15401: $lonid_to_ip{$id} = $ip;
15402: }
15403: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 15404: }
1.1293 raeburn 15405: unless ($nocache) {
15406: &do_cache_new('iphost','iphost',
15407: [\%iphost,\%name_to_ip,\%lonid_to_ip],
15408: 48*60*60);
15409: }
1.869 albertel 15410:
1.847 albertel 15411: return %iphost;
1.598 albertel 15412: }
15413:
1.992 raeburn 15414: #
15415: # Given a DNS returns the loncapa host name for that DNS
15416: #
15417: sub host_from_dns {
15418: my ($dns) = @_;
15419: my @hosts;
15420: my $ip;
15421:
1.993 raeburn 15422: if (exists($name_to_ip{$dns})) {
1.992 raeburn 15423: $ip = $name_to_ip{$dns};
15424: }
15425: if (!$ip) {
15426: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
15427: if (length($ip) == 4) {
15428: $ip = &IO::Socket::inet_ntoa($ip);
15429: }
15430: }
15431: if ($ip) {
15432: @hosts = get_hosts_from_ip($ip);
15433: return $hosts[0];
15434: }
15435: return undef;
1.986 foxr 15436: }
1.992 raeburn 15437:
1.1074 raeburn 15438: sub get_internet_names {
15439: my ($lonid) = @_;
15440: return if ($lonid eq '');
15441: my ($idnref,$cached)=
15442: &Apache::lonnet::is_cached_new('internetnames',$lonid);
15443: if ($cached) {
15444: return $idnref;
15445: }
15446: my $ip = &get_host_ip($lonid);
15447: my @hosts = &get_hosts_from_ip($ip);
15448: my %iphost = &get_iphost();
15449: my (@idns,%seen);
15450: foreach my $id (@hosts) {
15451: my $dom = &host_domain($id);
15452: my $prim_id = &domain($dom,'primary');
15453: my $prim_ip = &get_host_ip($prim_id);
15454: next if ($seen{$prim_ip});
15455: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
15456: foreach my $id (@{$iphost{$prim_ip}}) {
15457: my $intdom = &internet_dom($id);
15458: unless (grep(/^\Q$intdom\E$/,@idns)) {
15459: push(@idns,$intdom);
15460: }
15461: }
15462: }
15463: $seen{$prim_ip} = 1;
15464: }
1.1219 raeburn 15465: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 15466: }
15467:
1.986 foxr 15468: }
15469:
1.1079 raeburn 15470: sub all_loncaparevs {
1.1249 raeburn 15471: 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 15472: }
15473:
1.1227 raeburn 15474: # ---------------------------------------------------------- Read loncaparev table
15475: {
15476: sub load_loncaparevs {
15477: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
1.1359 raeburn 15478: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
1.1227 raeburn 15479: while (my $configline=<$config>) {
15480: chomp($configline);
15481: my ($hostid,$loncaparev)=split(/:/,$configline);
15482: $loncaparevs{$hostid}=$loncaparev;
15483: }
15484: close($config);
15485: }
15486: }
15487: }
15488: }
15489:
15490: # ---------------------------------------------------------- Read serverhostID table
15491: {
15492: sub load_serverhomeIDs {
15493: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
1.1359 raeburn 15494: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
1.1227 raeburn 15495: while (my $configline=<$config>) {
15496: chomp($configline);
15497: my ($name,$id)=split(/:/,$configline);
15498: $serverhomeIDs{$name}=$id;
15499: }
15500: close($config);
15501: }
15502: }
15503: }
15504: }
15505:
15506:
1.862 albertel 15507: BEGIN {
15508:
15509: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
15510: unless ($readit) {
15511: {
15512: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
15513: %perlvar = (%perlvar,%{$configvars});
15514: }
15515:
15516:
1.1 albertel 15517: # ------------------------------------------------------ Read spare server file
15518: {
1.1359 raeburn 15519: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 15520:
15521: while (my $configline=<$config>) {
15522: chomp($configline);
1.284 matthew 15523: if ($configline) {
1.784 albertel 15524: my ($host,$type) = split(':',$configline,2);
1.785 albertel 15525: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 15526: push(@{ $spareid{$type} }, $host);
1.1 albertel 15527: }
15528: }
1.448 albertel 15529: close($config);
1.1 albertel 15530: }
1.11 www 15531: # ------------------------------------------------------------ Read permissions
15532: {
1.1359 raeburn 15533: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
1.11 www 15534:
15535: while (my $configline=<$config>) {
1.448 albertel 15536: chomp($configline);
15537: if ($configline) {
15538: my ($role,$perm)=split(/ /,$configline);
15539: if ($perm ne '') { $pr{$role}=$perm; }
15540: }
1.11 www 15541: }
1.448 albertel 15542: close($config);
1.11 www 15543: }
15544:
15545: # -------------------------------------------- Read plain texts for permissions
15546: {
1.1359 raeburn 15547: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 15548:
15549: while (my $configline=<$config>) {
1.448 albertel 15550: chomp($configline);
15551: if ($configline) {
1.742 raeburn 15552: my ($short,@plain)=split(/:/,$configline);
15553: %{$prp{$short}} = ();
15554: if (@plain > 0) {
15555: $prp{$short}{'std'} = $plain[0];
15556: for (my $i=1; $i<@plain; $i++) {
15557: $prp{$short}{'alt'.$i} = $plain[$i];
15558: }
15559: }
1.448 albertel 15560: }
1.135 www 15561: }
1.448 albertel 15562: close($config);
1.135 www 15563: }
15564:
15565: # ---------------------------------------------------------- Read package table
15566: {
1.1359 raeburn 15567: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
1.135 www 15568:
15569: while (my $configline=<$config>) {
1.483 albertel 15570: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 15571: chomp($configline);
15572: my ($short,$plain)=split(/:/,$configline);
15573: my ($pack,$name)=split(/\&/,$short);
15574: if ($plain ne '') {
15575: $packagetab{$pack.'&'.$name.'&name'}=$name;
15576: $packagetab{$short}=$plain;
15577: }
1.11 www 15578: }
1.448 albertel 15579: close($config);
1.329 matthew 15580: }
15581:
1.1073 raeburn 15582: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 15583:
15584: &load_loncaparevs();
1.1073 raeburn 15585:
1.1074 raeburn 15586: # ---------------------------------------------------------- Read serverhostID table
15587:
1.1227 raeburn 15588: &load_serverhomeIDs();
15589:
15590: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 15591: {
15592: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
15593: if (-e $file) {
15594: my $parser = HTML::LCParser->new($file);
15595: while (my $token = $parser->get_token()) {
15596: if ($token->[0] eq 'S') {
15597: my $item = $token->[1];
15598: my $name = $token->[2]{'name'};
15599: my $value = $token->[2]{'value'};
1.1285 raeburn 15600: my $valuematch = $token->[2]{'valuematch'};
1.1303 raeburn 15601: my $namematch = $token->[2]{'namematch'};
15602: if ($item eq 'parameter') {
15603: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
15604: my $release = $parser->get_text();
15605: $release =~ s/(^\s*|\s*$ )//gx;
15606: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
15607: }
15608: } elsif ($item ne '' && $name ne '') {
1.1079 raeburn 15609: my $release = $parser->get_text();
15610: $release =~ s/(^\s*|\s*$ )//gx;
1.1303 raeburn 15611: $needsrelease{$item.':'.$name.':'.$value} = $release;
1.1079 raeburn 15612: }
15613: }
15614: }
15615: }
1.1073 raeburn 15616: }
15617:
1.1138 raeburn 15618: # ---------------------------------------------------------- Read managers table
15619: {
15620: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
1.1359 raeburn 15621: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
1.1138 raeburn 15622: while (my $configline=<$config>) {
15623: chomp($configline);
15624: next if ($configline =~ /^\#/);
15625: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
15626: $managerstab{$configline} = 1;
15627: }
15628: }
15629: close($config);
15630: }
15631: }
15632: }
15633:
1.329 matthew 15634: # ------------- set up temporary directory
15635: {
1.1117 foxr 15636: $tmpdir = LONCAPA::tempdir();
1.329 matthew 15637:
1.11 www 15638: }
15639:
1.1405 raeburn 15640: # ------------- set default texengine (domain default overrides this)
15641: {
15642: $deftex = LONCAPA::texengine();
15643: }
15644:
1.1416 raeburn 15645: # ------------- set default minimum length for passwords for internal auth users
15646: {
15647: $passwdmin = LONCAPA::passwd_min();
15648: }
15649:
1.794 albertel 15650: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
15651: 'compress_threshold'=> 20_000,
15652: });
1.185 www 15653:
1.281 www 15654: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 15655: $dumpcount=0;
1.958 www 15656: $locknum=0;
1.22 www 15657:
1.163 harris41 15658: &logtouch();
1.672 albertel 15659: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 15660: $readit=1;
1.564 albertel 15661: {
15662: use integer;
15663: my $test=(2**32)+1;
1.568 albertel 15664: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 15665: &logthis(" Detected 64bit platform ($_64bit)");
15666: }
1.195 www 15667: }
1.1 albertel 15668: }
1.179 www 15669:
1.1 albertel 15670: 1;
1.191 harris41 15671: __END__
15672:
1.243 albertel 15673: =pod
15674:
1.191 harris41 15675: =head1 NAME
15676:
1.243 albertel 15677: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 15678:
15679: =head1 SYNOPSIS
15680:
1.243 albertel 15681: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 15682:
15683: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
15684:
1.243 albertel 15685: Common parameters:
15686:
15687: =over 4
15688:
15689: =item *
15690:
15691: $uname : an internal username (if $cname expecting a course Id specifically)
15692:
15693: =item *
15694:
15695: $udom : a domain (if $cdom expecting a course's domain specifically)
15696:
15697: =item *
15698:
15699: $symb : a resource instance identifier
15700:
15701: =item *
15702:
15703: $namespace : the name of a .db file that contains the data needed or
15704: being set.
15705:
15706: =back
15707:
1.394 bowersj2 15708: =head1 OVERVIEW
1.191 harris41 15709:
1.394 bowersj2 15710: lonnet provides subroutines which interact with the
15711: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
15712: about classes, users, and resources.
1.243 albertel 15713:
15714: For many of these objects you can also use this to store data about
15715: them or modify them in various ways.
1.191 harris41 15716:
1.394 bowersj2 15717: =head2 Symbs
1.191 harris41 15718:
1.394 bowersj2 15719: To identify a specific instance of a resource, LON-CAPA uses symbols
15720: or "symbs"X<symb>. These identifiers are built from the URL of the
15721: map, the resource number of the resource in the map, and the URL of
15722: the resource itself. The latter is somewhat redundant, but might help
15723: if maps change.
15724:
15725: An example is
15726:
15727: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
15728:
15729: The respective map entry is
15730:
15731: <resource id="19" src="/res/msu/korte/tests/part12.problem"
15732: title="Problem 2">
15733: </resource>
15734:
15735: Symbs are used by the random number generator, as well as to store and
15736: restore data specific to a certain instance of for example a problem.
15737:
15738: =head2 Storing And Retrieving Data
15739:
15740: X<store()>X<cstore()>X<restore()>Three of the most important functions
15741: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
15742: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
15743: is is the non-critical message twin of cstore. These functions are for
15744: handlers to store a perl hash to a user's permanent data space in an
15745: easy manner, and to retrieve it again on another call. It is expected
15746: that a handler would use this once at the beginning to retrieve data,
15747: and then again once at the end to send only the new data back.
15748:
15749: The data is stored in the user's data directory on the user's
15750: homeserver under the ID of the course.
15751:
15752: The hash that is returned by restore will have all of the previous
15753: value for all of the elements of the hash.
15754:
15755: Example:
15756:
15757: #creating a hash
15758: my %hash;
15759: $hash{'foo'}='bar';
15760:
15761: #storing it
15762: &Apache::lonnet::cstore(\%hash);
15763:
15764: #changing a value
15765: $hash{'foo'}='notbar';
15766:
15767: #adding a new value
15768: $hash{'bar'}='foo';
15769: &Apache::lonnet::cstore(\%hash);
15770:
15771: #retrieving the hash
15772: my %history=&Apache::lonnet::restore();
15773:
15774: #print the hash
15775: foreach my $key (sort(keys(%history))) {
15776: print("\%history{$key} = $history{$key}");
15777: }
15778:
15779: Will print out:
1.191 harris41 15780:
1.394 bowersj2 15781: %history{1:foo} = bar
15782: %history{1:keys} = foo:timestamp
15783: %history{1:timestamp} = 990455579
15784: %history{2:bar} = foo
15785: %history{2:foo} = notbar
15786: %history{2:keys} = foo:bar:timestamp
15787: %history{2:timestamp} = 990455580
15788: %history{bar} = foo
15789: %history{foo} = notbar
15790: %history{timestamp} = 990455580
15791: %history{version} = 2
15792:
15793: Note that the special hash entries C<keys>, C<version> and
15794: C<timestamp> were added to the hash. C<version> will be equal to the
15795: total number of versions of the data that have been stored. The
15796: C<timestamp> attribute will be the UNIX time the hash was
15797: stored. C<keys> is available in every historical section to list which
15798: keys were added or changed at a specific historical revision of a
15799: hash.
15800:
15801: B<Warning>: do not store the hash that restore returns directly. This
15802: will cause a mess since it will restore the historical keys as if the
15803: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 15804:
1.394 bowersj2 15805: Calling convention:
1.191 harris41 15806:
1.1225 raeburn 15807: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269 raeburn 15808: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 15809:
1.394 bowersj2 15810: For more detailed information, see lonnet specific documentation.
1.191 harris41 15811:
1.394 bowersj2 15812: =head1 RETURN MESSAGES
1.191 harris41 15813:
1.394 bowersj2 15814: =over 4
1.191 harris41 15815:
1.394 bowersj2 15816: =item * B<con_lost>: unable to contact remote host
1.191 harris41 15817:
1.394 bowersj2 15818: =item * B<con_delayed>: unable to contact remote host, message will be delivered
15819: when the connection is brought back up
1.191 harris41 15820:
1.394 bowersj2 15821: =item * B<con_failed>: unable to contact remote host and unable to save message
15822: for later delivery
1.191 harris41 15823:
1.967 bisitz 15824: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 15825:
1.394 bowersj2 15826: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 15827: that was requested
1.191 harris41 15828:
1.243 albertel 15829: =back
1.191 harris41 15830:
1.243 albertel 15831: =head1 PUBLIC SUBROUTINES
1.191 harris41 15832:
1.243 albertel 15833: =head2 Session Environment Functions
1.191 harris41 15834:
1.243 albertel 15835: =over 4
1.191 harris41 15836:
1.394 bowersj2 15837: =item *
15838: X<appenv()>
1.949 raeburn 15839: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 15840: the user envirnoment file, and will be restored for each access this
1.620 albertel 15841: user makes during this session, also modifies the %env for the current
1.949 raeburn 15842: process. Optional rolesarrayref - if defined contains a reference to an array
15843: of roles which are exempt from the restriction on modifying user.role entries
15844: in the user's environment.db and in %env.
1.191 harris41 15845:
15846: =item *
1.394 bowersj2 15847: X<delenv()>
1.987 raeburn 15848: B<delenv($delthis,$regexp)>: removes all items from the session
15849: environment file that begin with $delthis. If the
15850: optional second arg - $regexp - is true, $delthis is treated as a
15851: regular expression, otherwise \Q$delthis\E is used.
15852: The values are also deleted from the current processes %env.
1.191 harris41 15853:
1.795 albertel 15854: =item * get_env_multiple($name)
15855:
15856: gets $name from the %env hash, it seemlessly handles the cases where multiple
15857: values may be defined and end up as an array ref.
15858:
15859: returns an array of values
15860:
1.243 albertel 15861: =back
15862:
15863: =head2 User Information
1.191 harris41 15864:
1.243 albertel 15865: =over 4
1.191 harris41 15866:
15867: =item *
1.394 bowersj2 15868: X<queryauthenticate()>
15869: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 15870: authentication scheme
15871:
15872: =item *
1.394 bowersj2 15873: X<authenticate()>
1.1073 raeburn 15874: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 15875: authenticate user from domain's lib servers (first use the current
15876: one). C<$upass> should be the users password.
1.1073 raeburn 15877: $checkdefauth is optional (value is 1 if a check should be made to
15878: authenticate user using default authentication method, and allow
15879: account creation if username does not have account in the domain).
15880: $clientcancheckhost is optional (value is 1 if checking whether the
15881: server can host will occur on the client side in lonauth.pm).
1.191 harris41 15882:
15883: =item *
1.394 bowersj2 15884: X<homeserver()>
15885: B<homeserver($uname,$udom)>: find the server which has
15886: the user's directory and files (there must be only one), this caches
15887: the answer, and also caches if there is a borken connection.
1.191 harris41 15888:
15889: =item *
1.394 bowersj2 15890: X<idget()>
1.1300 raeburn 15891: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
15892: a list of student/employee IDs or clicker IDs
15893: (student/employee IDs are a unique resource in a domain, there must be
15894: only 1 ID per username, and only 1 username per ID in a specific domain).
15895: clickerIDs are not necessarily unique, as students might share clickers.
15896: (returns hash: id=>name,id=>name)
1.191 harris41 15897:
15898: =item *
1.394 bowersj2 15899: X<idrget()>
15900: B<idrget($udom,@unames)>: find the IDs behind a list of
15901: usernames (returns hash: name=>id,name=>id)
1.191 harris41 15902:
15903: =item *
1.394 bowersj2 15904: X<idput()>
1.1300 raeburn 15905: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
15906: names and associated student/employee IDs or clicker IDs.
15907:
15908: =item *
15909: X<iddel()>
15910: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
15911: student/employee ID or clicker ID username look-ups from domain.
15912: The homeserver ($uhome) and namespace ($namespace) are optional.
15913: If no $uhome is provided, it will be determined usig &homeserver()
15914: for each user. If no $namespace is provided, the default is ids.
15915:
15916: =item *
15917: X<updateclickers()>
15918: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
15919: clicker ID-to-username look-ups in clickers.db on library server.
15920: Permitted actions are add or del (i.e., add or delete). The
15921: clickers.db contains clickerID as keys (escaped), and each corresponding
15922: value is an escaped comma-separated list of usernames (for whom the
15923: library server is the homeserver), who registered that particular ID.
15924: If $critical is true, the update will be sent via &critical, otherwise
15925: &reply() will be used.
1.191 harris41 15926:
15927: =item *
1.394 bowersj2 15928: X<rolesinit()>
1.1169 droeschl 15929: B<rolesinit($udom,$username)>: get user privileges.
15930: returns user role, first access and timer interval hashes
1.243 albertel 15931:
15932: =item *
1.1171 droeschl 15933: X<privileged()>
15934: B<privileged($username,$domain)>: returns a true if user has a
15935: privileged and active role (i.e. su or dc), false otherwise.
15936:
15937: =item *
1.551 albertel 15938: X<getsection()>
15939: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 15940: course $cname, return section name/number or '' for "not in course"
15941: and '-1' for "no section"
15942:
15943: =item *
1.394 bowersj2 15944: X<userenvironment()>
15945: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 15946: passed in @what from the requested user's environment, returns a hash
15947:
1.858 raeburn 15948: =item *
15949: X<userlog_query()>
1.859 albertel 15950: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
15951: activity.log file. %filters defines filters applied when parsing the
15952: log file. These can be start or end timestamps, or the type of action
15953: - log to look for Login or Logout events, check for Checkin or
15954: Checkout, role for role selection. The response is in the form
15955: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
15956: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 15957:
1.243 albertel 15958: =back
15959:
15960: =head2 User Roles
15961:
15962: =over 4
15963:
15964: =item *
15965:
1.1284 raeburn 15966: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
15967: returns codes for allowed actions.
15968:
15969: The first argument is required, all others are optional.
15970:
15971: $priv is the privilege being checked.
15972: $uri contains additional information about what is being checked for access (e.g.,
15973: URL, course ID etc.).
15974: $symb is the unique resource instance identifier in a course; if needed,
15975: but not provided, it will be retrieved via a call to &symbread().
15976: $role is the role for which a priv is being checked (only used if priv is evb).
15977: $clientip is the user's IP address (only used when checking for access to portfolio
15978: files).
15979: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
15980: prevents recursive calls to &allowed.
15981:
1.243 albertel 15982: F: full access
15983: U,I,K: authentication modes (cxx only)
15984: '': forbidden
15985: 1: user needs to choose course
15986: 2: browse allowed
1.766 albertel 15987: A: passphrase authentication needed
1.1284 raeburn 15988: B: access temporarily blocked because of a blocking event in a course.
1.1402 raeburn 15989: D: access blocked because access is required via session initiated via deep-link
1.243 albertel 15990:
15991: =item *
15992:
1.1192 raeburn 15993: constructaccess($url,$setpriv) : check for access to construction space URL
15994:
15995: See if the owner domain and name in the URL match those in the
15996: expected environment. If so, return three element list
15997: ($ownername,$ownerdomain,$ownerhome).
15998:
15999: Otherwise return the null string.
16000:
16001: If second argument 'setpriv' is true, it assigns the privileges,
16002: and returns the same three element list, unless the owner has
16003: blocked "ad hoc" Domain Coordinator access to the Author Space,
16004: in which case the null string is returned.
16005:
16006: =item *
16007:
1.1326 raeburn 16008: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
16009: define a custom role rolename set privileges in format of lonTabs/roles.tab
16010: for system, domain, and course level. $uname and $udom are optional (current
16011: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 16012:
16013: =item *
16014:
1.988 raeburn 16015: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
16016: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 16017: $type is Course (default) or Community.
1.988 raeburn 16018: If $forcedefault evaluates to true, text returned will be default
16019: text for $type. Otherwise, if this is a course, the text returned
16020: will be a custom name for the role (if defined in the course's
16021: environment). If no custom name is defined the default is returned.
16022:
1.832 raeburn 16023: =item *
16024:
1.1219 raeburn 16025: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 16026: All arguments are optional. Returns a hash of a roles, either for
16027: co-author/assistant author roles for a user's Construction Space
1.906 albertel 16028: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 16029: In the hash, keys are set to colon-separated $uname,$udom,$role, and
16030: (optionally) if $withsec is true, a fourth colon-separated item - $section.
16031: For each key, value is set to colon-separated start and end times for
16032: the role. If no username and domain are specified, will default to
1.934 raeburn 16033: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 16034: of role statuses (active, future or previous), roles
16035: (e.g., cc,in, st etc.) and domains of the roles which can be used
16036: to restrict the list of roles reported. If no array ref is
16037: provided for types, will default to return only active roles.
1.834 albertel 16038:
1.1195 raeburn 16039: =item *
16040:
16041: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 16042: user: $uname:$udom has a role in the course: $cdom_$cnum.
16043:
16044: Additional optional arguments are: $type (if role checking is to be restricted
16045: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 16046: available roles) or future (roles available in the future), and
16047: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 16048: have active Domain Coordinator role in course's domain or in additional
16049: domains (specified in 'Domains to check for privileged users' in course
16050: environment -- set via: Course Settings -> Classlists and staff listing).
16051:
16052: =item *
16053:
16054: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
16055: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
16056: $possdomains and $possroles are optional array refs -- to domains to check and
16057: roles to check. If $possdomains is not specified, a dump will be done of the
16058: users' roles.db to check for a dc or su role in any domain. This can be
16059: time consuming if &privileged is called repeatedly (e.g., when displaying a
16060: classlist), so in such cases, supplying a $possdomains array is preferred, as
16061: this then allows &privileged_by_domain() to be used, which caches the identity
16062: of privileged users, eliminating the need for repeated calls to &dump().
16063:
16064: =item *
16065:
16066: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
16067: where the outer hash keys are domains specified in the $possdomains array ref,
16068: next inner hash keys are privileged roles specified in the $roles array ref,
16069: and the innermost hash contains key = value pairs for username:domain = end:start
16070: for active or future "privileged" users with that role in that domain. To avoid
16071: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
16072: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 16073:
1.243 albertel 16074: =back
16075:
16076: =head2 User Modification
16077:
16078: =over 4
16079:
16080: =item *
16081:
1.957 raeburn 16082: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 16083: user for the level given by URL. Optional start and end dates (leave empty
16084: string or zero for "no date")
1.191 harris41 16085:
16086: =item *
16087:
1.243 albertel 16088: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
16089: change a users, password, possible return values are: ok,
16090: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
16091: refused
1.191 harris41 16092:
16093: =item *
16094:
1.243 albertel 16095: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 16096:
16097: =item *
16098:
1.1058 raeburn 16099: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
16100: $forceid,$desiredhome,$email,$inststatus,$candelete) :
16101:
16102: will update user information (firstname,middlename,lastname,generation,
16103: permanentemail), and if forceid is true, student/employee ID also.
16104: A user's institutional affiliation(s) can also be updated.
16105: User information fields will not be overwritten with empty entries
16106: unless the field is included in the $candelete array reference.
16107: This array is included when a single user is modified via "Manage Users",
16108: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 16109:
16110: =item *
16111:
1.286 matthew 16112: modifystudent
16113:
1.957 raeburn 16114: modify a student's enrollment and identification information.
1.1235 raeburn 16115: The course id is resolved based on the current user's environment.
16116: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 16117: associated with a course.
16118:
1.297 matthew 16119: This call is essentially a wrapper for lonnet::modifyuser and
16120: lonnet::modify_student_enrollment
1.286 matthew 16121:
16122: Inputs:
16123:
16124: =over 4
16125:
1.957 raeburn 16126: =item B<$udom> Student's loncapa domain
1.286 matthew 16127:
1.957 raeburn 16128: =item B<$uname> Student's loncapa login name
1.286 matthew 16129:
1.964 bisitz 16130: =item B<$uid> Student/Employee ID
1.286 matthew 16131:
1.957 raeburn 16132: =item B<$umode> Student's authentication mode
1.286 matthew 16133:
1.957 raeburn 16134: =item B<$upass> Student's password
1.286 matthew 16135:
1.957 raeburn 16136: =item B<$first> Student's first name
1.286 matthew 16137:
1.957 raeburn 16138: =item B<$middle> Student's middle name
1.286 matthew 16139:
1.957 raeburn 16140: =item B<$last> Student's last name
1.286 matthew 16141:
1.957 raeburn 16142: =item B<$gene> Student's generation
1.286 matthew 16143:
1.957 raeburn 16144: =item B<$usec> Student's section in course
1.286 matthew 16145:
16146: =item B<$end> Unix time of the roles expiration
16147:
16148: =item B<$start> Unix time of the roles start date
16149:
16150: =item B<$forceid> If defined, allow $uid to be changed
16151:
16152: =item B<$desiredhome> server to use as home server for student
16153:
1.957 raeburn 16154: =item B<$email> Student's permanent e-mail address
16155:
16156: =item B<$type> Type of enrollment (auto or manual)
16157:
1.963 raeburn 16158: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
16159:
16160: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 16161:
1.963 raeburn 16162: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 16163:
1.963 raeburn 16164: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 16165:
1.1216 raeburn 16166: =item B<$inststatus> institutional status of user - : separated string of escaped status types
16167:
16168: =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 16169:
1.286 matthew 16170: =back
1.297 matthew 16171:
16172: =item *
16173:
16174: modify_student_enrollment
16175:
1.1235 raeburn 16176: Change a student's enrollment status in a class. The environment variable
1.297 matthew 16177: 'role.request.course' must be defined for this function to proceed.
16178:
16179: Inputs:
16180:
16181: =over 4
16182:
1.1235 raeburn 16183: =item $udom, student's domain
1.297 matthew 16184:
1.1235 raeburn 16185: =item $uname, student's name
1.297 matthew 16186:
1.1235 raeburn 16187: =item $uid, student's user id
1.297 matthew 16188:
1.1235 raeburn 16189: =item $first, student's first name
1.297 matthew 16190:
16191: =item $middle
16192:
16193: =item $last
16194:
16195: =item $gene
16196:
16197: =item $usec
16198:
16199: =item $end
16200:
16201: =item $start
16202:
1.957 raeburn 16203: =item $type
16204:
16205: =item $locktype
16206:
16207: =item $cid
16208:
16209: =item $selfenroll
16210:
16211: =item $context
16212:
1.1216 raeburn 16213: =item $credits, number of credits student will earn from this class
16214:
1.1314 raeburn 16215: =item $instsec, institutional course section code for student
16216:
1.297 matthew 16217: =back
16218:
1.191 harris41 16219:
16220: =item *
16221:
1.243 albertel 16222: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
16223: custom role; give a custom role to a user for the level given by URL. Specify
16224: name and domain of role author, and role name
1.191 harris41 16225:
16226: =item *
16227:
1.243 albertel 16228: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 16229:
16230: =item *
16231:
1.243 albertel 16232: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
16233:
16234: =back
16235:
16236: =head2 Course Infomation
16237:
16238: =over 4
1.191 harris41 16239:
16240: =item *
16241:
1.1118 foxr 16242: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 16243: specified course id, including all environment settings for the
16244: course, the description of the course will be in the hash under the
16245: key 'description'
1.191 harris41 16246:
1.1118 foxr 16247: $options is an optional parameter that if supplied is a hash reference that controls
16248: what how this function works. It has the following key/values:
16249:
16250: =over 4
16251:
16252: =item freshen_cache
16253:
16254: If defined, and the environment cache for the course is valid, it is
16255: returned in the returned hash.
16256:
16257: =item one_time
16258:
16259: If defined, the last cache time is set to _now_
16260:
16261: =item user
16262:
16263: If defined, the supplied username is used instead of the current user.
16264:
16265:
16266: =back
16267:
1.191 harris41 16268: =item *
16269:
1.624 albertel 16270: resdata($name,$domain,$type,@which) : request for current parameter
16271: setting for a specific $type, where $type is either 'course' or 'user',
16272: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 16273: answers for 10 minutes.
1.243 albertel 16274:
1.877 foxr 16275: =item *
16276:
16277: get_courseresdata($courseid, $domain) : dump the entire course resource
16278: data base, returning a hash that is keyed by the resource name and has
16279: values that are the resource value. I believe that the timestamps and
16280: versions are also returned.
16281:
1.1236 raeburn 16282: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
16283: supplemental content area. This routine caches the number of files for
16284: 10 minutes.
16285:
1.243 albertel 16286: =back
16287:
16288: =head2 Course Modification
16289:
16290: =over 4
1.191 harris41 16291:
16292: =item *
16293:
1.243 albertel 16294: writecoursepref($courseid,%prefs) : write preferences (environment
16295: database) for a course
1.191 harris41 16296:
16297: =item *
16298:
1.1011 raeburn 16299: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
16300:
16301: =item *
16302:
1.1038 raeburn 16303: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 16304:
1.1167 droeschl 16305: =item *
16306:
16307: is_course($courseid), is_course($cdom, $cnum)
16308:
16309: Accepts either a combined $courseid (in the form of domain_courseid) or the
16310: two component version $cdom, $cnum. It checks if the specified course exists.
16311:
16312: Returns:
16313: undef if the course doesn't exist, otherwise
16314: in scalar context the combined courseid.
16315: in list context the two components of the course identifier, domain and
16316: courseid.
16317:
1.243 albertel 16318: =back
16319:
1.1401 raeburn 16320: =head2 Bubblesheet Configuration
16321:
16322: =over 4
16323:
16324: =item *
16325:
16326: get_scantron_config($which)
16327:
16328: $which - the name of the configuration to parse from the file.
16329:
16330: Parses and returns the bubblesheet configuration line selected as a
16331: hash of configuration file fields.
16332:
16333:
16334: Returns:
16335: If the named configuration is not in the file, an empty
16336: hash is returned.
16337:
16338: a hash with the fields
16339: name - internal name for the this configuration setup
16340: description - text to display to operator that describes this config
16341: CODElocation - if 0 or the string 'none'
16342: - no CODE exists for this config
16343: if -1 || the string 'letter'
16344: - a CODE exists for this config and is
16345: a string of letters
16346: Unsupported value (but planned for future support)
16347: if a positive integer
16348: - The CODE exists as the first n items from
16349: the question section of the form
16350: if the string 'number'
16351: - The CODE exists for this config and is
16352: a string of numbers
16353: CODEstart - (only matter if a CODE exists) column in the line where
16354: the CODE starts
16355: CODElength - length of the CODE
16356: IDstart - column where the student/employee ID starts
16357: IDlength - length of the student/employee ID info
16358: Qstart - column where the information from the bubbled
16359: 'questions' start
16360: Qlength - number of columns comprising a single bubble line from
16361: the sheet. (usually either 1 or 10)
16362: Qon - either a single character representing the character used
16363: to signal a bubble was chosen in the positional setup, or
16364: the string 'letter' if the letter of the chosen bubble is
16365: in the final, or 'number' if a number representing the
16366: chosen bubble is in the file (1->A 0->J)
16367: Qoff - the character used to represent that a bubble was
16368: left blank
16369: PaperID - if the scanning process generates a unique number for each
16370: sheet scanned the column that this ID number starts in
16371: PaperIDlength - number of columns that comprise the unique ID number
16372: for the sheet of paper
16373: FirstName - column that the first name starts in
16374: FirstNameLength - number of columns that the first name spans
16375: LastName - column that the last name starts in
16376: LastNameLength - number of columns that the last name spans
16377: BubblesPerRow - number of bubbles available in each row used to
16378: bubble an answer. (If not specified, 10 assumed).
16379:
16380:
16381: =item *
16382:
16383: get_scantronformat_file($cdom)
16384:
16385: $cdom - the course's domain (optional); if not supplied, uses
16386: domain for current $env{'request.course.id'}.
16387:
16388: Returns an array containing lines from the scantron format file for
16389: the domain of the course.
16390:
16391: If a url for a custom.tab file is listed in domain's configuration.db,
16392: lines are from this file.
16393:
16394: Otherwise, if a default.tab has been published in RES space by the
16395: domainconfig user, lines are from this file.
16396:
16397: Otherwise, fall back to getting lines from the legacy file on the
16398: local server: /home/httpd/lonTabs/default_scantronformat.tab
16399:
16400: =back
16401:
1.243 albertel 16402: =head2 Resource Subroutines
16403:
16404: =over 4
1.191 harris41 16405:
16406: =item *
16407:
1.243 albertel 16408: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 16409:
16410: =item *
16411:
1.243 albertel 16412: repcopy($filename) : subscribes to the requested file, and attempts to
16413: replicate from the owning library server, Might return
1.607 raeburn 16414: 'unavailable', 'not_found', 'forbidden', 'ok', or
16415: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 16416: resource. Expects the local filesystem pathname
16417: (/home/httpd/html/res/....)
16418:
16419: =back
16420:
16421: =head2 Resource Information
16422:
16423: =over 4
1.191 harris41 16424:
16425: =item *
16426:
1.1228 raeburn 16427: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
16428: and returns the value of a variety of different possible values,
16429: $varname should be a request string, and the other parameters can be
16430: used to specify who and what one is asking about. Ordinarily, $cid
16431: does not need to be specified, as it is retrived from
16432: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
16433: within lonuserstate::loadmap() when initializing a course, before
16434: $env{'request.course.id'} has been set, so it needs to be provided
16435: in that one case.
1.243 albertel 16436:
16437: Possible values for $varname are environment.lastname (or other item
16438: from the envirnment hash), user.name (or someother aspect about the
16439: user), resource.0.maxtries (or some other part and parameter of a
16440: resource)
1.204 albertel 16441:
16442: =item *
16443:
1.243 albertel 16444: directcondval($number) : get current value of a condition; reads from a state
16445: string
1.204 albertel 16446:
16447: =item *
16448:
1.243 albertel 16449: condval($condidx) : value of condition index based on state
1.204 albertel 16450:
16451: =item *
16452:
1.1362 raeburn 16453: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
1.243 albertel 16454: resource's metadata, $what should be either a specific key, or either
16455: 'keys' (to get a list of possible keys) or 'packages' to get a list of
1.1362 raeburn 16456: packages that this resource currently uses, the last 3 arguments are
16457: only used internally for recursive metadata.
16458:
16459: the toolsymb is only used where the uri is for an external tool (for which
16460: the uri as well as the symb are guaranteed to be unique).
1.243 albertel 16461:
1.1371 raeburn 16462: this function automatically caches all requests except any made recursively
16463: to retrieve a list of metadata keys for an imported library file ($liburi is
16464: defined).
1.191 harris41 16465:
16466: =item *
16467:
1.243 albertel 16468: metadata_query($query,$custom,$customshow) : make a metadata query against the
16469: network of library servers; returns file handle of where SQL and regex results
16470: will be stored for query
1.191 harris41 16471:
16472: =item *
16473:
1.1282 raeburn 16474: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
16475: return symbolic list entry (all arguments optional).
16476:
16477: Args: filename is the filename (including path) for the file for which a symb
16478: is required; donotrecurse, if true will prevent calls to allowed() being made
16479: to check access status if more than one resource was found in the bighash
16480: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
16481: a randompick); ignorecachednull, if true will prevent a symb of '' being
16482: returned if $env{$cache_str} is defined as ''; checkforblock if true will
16483: cause possible symbs to be checked to determine if they are subject to content
16484: blocking, if so they will not be included as possible symbs; possibles is a
16485: ref to a hash, which, as a side effect, will be populated with all possible
16486: symbs (content blocking not tested).
16487:
1.243 albertel 16488: returns the data handle
1.191 harris41 16489:
16490: =item *
16491:
1.1190 raeburn 16492: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
16493: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 16494: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 16495: on failure, user must be in a course, as it assumes the existence of
16496: the course initial hash, and uses $env('request.course.id'}. The third
16497: arg is an optional reference to a scalar. If this arg is passed in the
16498: call to symbverify, it will be set to 1 if the symb has been set to be
16499: encrypted; otherwise it will be null.
1.191 harris41 16500:
16501: =item *
16502:
1.243 albertel 16503: symbclean($symb) : removes versions numbers from a symb, returns the
16504: cleaned symb
1.191 harris41 16505:
16506: =item *
16507:
1.243 albertel 16508: is_on_map($uri) : checks if the $uri is somewhere on the current
16509: course map, user must be in a course for it to work.
1.191 harris41 16510:
16511: =item *
16512:
1.243 albertel 16513: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 16514:
16515: =item *
16516:
1.243 albertel 16517: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
16518: a random seed, all arguments are optional, if they aren't sent it uses the
16519: environment to derive them. Note: if symb isn't sent and it can't get one
16520: from &symbread it will use the current time as its return value
1.191 harris41 16521:
16522: =item *
16523:
1.243 albertel 16524: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
16525: unfakeable, receipt
1.191 harris41 16526:
16527: =item *
16528:
1.620 albertel 16529: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 16530:
16531: =item *
16532:
1.243 albertel 16533: countacc($url) : count the number of accesses to a given URL
1.191 harris41 16534:
16535: =item *
16536:
1.243 albertel 16537: 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 16538:
16539: =item *
16540:
1.243 albertel 16541: 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 16542:
16543: =item *
16544:
1.243 albertel 16545: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 16546:
16547: =item *
16548:
1.243 albertel 16549: devalidate($symb) : devalidate temporary spreadsheet calculations,
16550: forcing spreadsheet to reevaluate the resource scores next time.
16551:
1.1195 raeburn 16552: =item *
16553:
1.1196 raeburn 16554: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
16555: when viewing in course context.
1.1195 raeburn 16556:
1.1196 raeburn 16557: input: six args -- filename (decluttered), course number, course domain,
16558: url, symb (if registered) and group (if this is a
16559: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 16560:
1.1196 raeburn 16561: output: array of five scalars --
1.1195 raeburn 16562: $cfile -- url for file editing if editable on current server
16563: $home -- homeserver of resource (i.e., for author if published,
16564: or course if uploaded.).
16565: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 16566: $forceedit -- 1 if icon/link should be to go to edit mode
16567: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 16568:
16569: =item *
16570:
16571: is_course_upload($file,$cnum,$cdom)
16572:
16573: Used in course context to determine if current file was uploaded to
16574: the course (i.e., would be found in /userfiles/docs on the course's
16575: homeserver.
16576:
16577: input: 3 args -- filename (decluttered), course number and course domain.
16578: output: boolean -- 1 if file was uploaded.
16579:
1.243 albertel 16580: =back
16581:
16582: =head2 Storing/Retreiving Data
16583:
16584: =over 4
1.191 harris41 16585:
16586: =item *
16587:
1.1269 raeburn 16588: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
16589: permanently for this url; hashref needs to be given and should be a \%hashname;
16590: the remaining args aren't required and if they aren't passed or are '' they will
16591: be derived from the env (with the exception of $laststore, which is an
16592: optional arg used when a user's submission is stored in grading).
16593: $laststore is $version=$timestamp, where $version is the most recent version
16594: number retrieved for the corresponding $symb in the $namespace db file, and
16595: $timestamp is the timestamp for that transaction (UNIX time).
16596: $laststore is currently only passed when cstore() is called by
16597: structuretags::finalize_storage().
1.191 harris41 16598:
16599: =item *
16600:
1.1269 raeburn 16601: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
16602: but uses critical subroutine
1.191 harris41 16603:
16604: =item *
16605:
1.243 albertel 16606: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
16607: all args are optional
1.191 harris41 16608:
16609: =item *
16610:
1.717 albertel 16611: dumpstore($namespace,$udom,$uname,$regexp,$range) :
16612: dumps the complete (or key matching regexp) namespace into a hash
16613: ($udom, $uname, $regexp, $range are optional) for a namespace that is
16614: normally &store()ed into
16615:
16616: $range should be either an integer '100' (give me the first 100
16617: matching records)
16618: or be two integers sperated by a - with no spaces
16619: '30-50' (give me the 30th through the 50th matching
16620: records)
16621:
16622:
16623: =item *
16624:
1.1269 raeburn 16625: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 16626: replaces a &store() version of data with a replacement set of data
16627: for a particular resource in a namespace passed in the $storehash hash
1.1269 raeburn 16628: reference. If $tolog is true, the transaction is logged in the courselog
16629: with an action=PUTSTORE.
1.717 albertel 16630:
16631: =item *
16632:
1.243 albertel 16633: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
16634: works very similar to store/cstore, but all data is stored in a
16635: temporary location and can be reset using tmpreset, $storehash should
16636: be a hash reference, returns nothing on success
1.191 harris41 16637:
16638: =item *
16639:
1.243 albertel 16640: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
16641: similar to restore, but all data is stored in a temporary location and
16642: can be reset using tmpreset. Returns a hash of values on success,
16643: error string otherwise.
1.191 harris41 16644:
16645: =item *
16646:
1.243 albertel 16647: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
16648: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 16649:
16650: =item *
16651:
1.243 albertel 16652: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
16653: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 16654:
16655: =item *
16656:
1.243 albertel 16657: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
16658: namesp ($udom and $uname are optional)
1.191 harris41 16659:
16660: =item *
16661:
1.702 albertel 16662: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 16663: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 16664: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 16665:
1.702 albertel 16666: $range should be either an integer '100' (give me the first 100
16667: matching records)
16668: or be two integers sperated by a - with no spaces
16669: '30-50' (give me the 30th through the 50th matching
16670: records)
1.449 matthew 16671: =item *
16672:
16673: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
16674: $store can be a scalar, an array reference, or if the amount to be
16675: incremented is > 1, a hash reference.
16676:
16677: ($udom and $uname are optional)
1.191 harris41 16678:
16679: =item *
16680:
1.243 albertel 16681: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
16682: ($udom and $uname are optional)
1.191 harris41 16683:
16684: =item *
16685:
1.243 albertel 16686: cput($namespace,$storehash,$udom,$uname) : critical put
16687: ($udom and $uname are optional)
1.191 harris41 16688:
16689: =item *
16690:
1.748 albertel 16691: newput($namespace,$storehash,$udom,$uname) :
16692:
16693: Attempts to store the items in the $storehash, but only if they don't
16694: currently exist, if this succeeds you can be certain that you have
16695: successfully created a new key value pair in the $namespace db.
16696:
16697:
16698: Args:
16699: $namespace: name of database to store values to
16700: $storehash: hashref to store to the db
16701: $udom: (optional) domain of user containing the db
16702: $uname: (optional) name of user caontaining the db
16703:
16704: Returns:
16705: 'ok' -> succeeded in storing all keys of $storehash
16706: 'key_exists: <key>' -> failed to anything out of $storehash, as at
16707: least <key> already existed in the db (other
16708: requested keys may also already exist)
1.967 bisitz 16709: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 16710: 'con_lost' -> unable to contact request server
16711: 'refused' -> action was not allowed by remote machine
16712:
16713:
16714: =item *
16715:
1.243 albertel 16716: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
16717: reference filled in from namesp (encrypts the return communication)
16718: ($udom and $uname are optional)
1.191 harris41 16719:
16720: =item *
16721:
1.243 albertel 16722: log($udom,$name,$home,$message) : write to permanent log for user; use
16723: critical subroutine
16724:
1.806 raeburn 16725: =item *
16726:
1.860 raeburn 16727: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
16728: array reference filled in from namespace found in domain level on either
16729: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 16730:
16731: =item *
16732:
1.860 raeburn 16733: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
16734: domain level either on specified domain server ($uhome) or primary domain
16735: server ($udom and $uhome are optional)
1.806 raeburn 16736:
1.943 raeburn 16737: =item *
16738:
1.1240 raeburn 16739: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
16740: for: authentication, language, quotas, timezone, date locale, and portal URL in
16741: the target domain.
16742:
16743: May also include additional key => value pairs for the following groups:
16744:
16745: =over
16746:
16747: =item
16748: disk quotas (MB allocated by default to portfolios and authoring spaces).
16749:
16750: =over
16751:
16752: =item defaultquota, authorquota
16753:
16754: =back
16755:
16756: =item
16757: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
16758: portfolio for users).
16759:
16760: =over
16761:
16762: =item
16763: aboutme, blog, webdav, portfolio
16764:
16765: =back
16766:
16767: =item
16768: requestcourses: ability to request courses, and how requests are processed.
16769:
16770: =over
16771:
16772: =item
1.1305 raeburn 16773: official, unofficial, community, textbook, placement
1.1240 raeburn 16774:
16775: =back
16776:
16777: =item
16778: inststatus: types of institutional affiliation, and order in which they are displayed.
16779:
16780: =over
16781:
16782: =item
1.1256 raeburn 16783: inststatustypes, inststatusorder, inststatusguest
1.1240 raeburn 16784:
16785: =back
16786:
16787: =item
16788: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
16789: for course's uploaded content.
16790:
16791: =over
16792:
16793: =item
1.1246 raeburn 16794: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
1.1305 raeburn 16795: communityquota, textbookquota, placementquota
1.1240 raeburn 16796:
16797: =back
16798:
16799: =item
16800: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
16801: on your servers.
16802:
16803: =over
16804:
16805: =item
16806: remotesessions, hostedsessions
16807:
16808: =back
16809:
16810: =back
16811:
16812: In cases where a domain coordinator has never used the "Set Domain Configuration"
16813: utility to create a configuration.db file on a domain's primary library server
16814: only the following domain defaults: auth_def, auth_arg_def, lang_def
16815: -- corresponding values are authentication type (internal, krb4, krb5,
16816: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
16817: will be available. Values are retrieved from cache (if current), unless the
16818: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
16819: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
16820:
16821: Typical usage:
1.943 raeburn 16822:
1.1240 raeburn 16823: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 16824:
1.243 albertel 16825: =back
16826:
16827: =head2 Network Status Functions
16828:
16829: =over 4
1.191 harris41 16830:
16831: =item *
16832:
1.1137 raeburn 16833: dirlist() : return directory list based on URI (first arg).
16834:
16835: Inputs: 1 required, 5 optional.
16836:
16837: =over
16838:
16839: =item
16840: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
16841:
16842: =item
16843: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
16844:
16845: =item
16846: $username - username of user/course to be listed. Extracted from $uri if absent.
16847:
16848: =item
16849: $getpropath - boolean: 1 if prepend path using &propath().
16850:
16851: =item
16852: $getuserdir - boolean: 1 if prepend path for "userfiles".
16853:
16854: =item
16855: $alternateRoot - path to prepend in place of path from $uri.
16856:
16857: =back
16858:
16859: Returns: Array of up to two items.
16860:
16861: =over
16862:
16863: a reference to an array of files/subdirectories
16864:
16865: =over
16866:
16867: Each element in the array of files/subdirectories is a & separated list of
16868: item name and the result of running stat on the item. If dirlist was requested
16869: for a file instead of a directory, the item name will be ''. For a directory
16870: listing, if the item is a metadata file, the element will end &N&M
16871: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
16872: default copyright set (1).
16873:
16874: =back
16875:
16876: a scalar containing error condition (if encountered).
16877:
16878: =over
16879:
16880: =item
16881: no_host (no homeserver identified for $username:$domain).
16882:
16883: =item
16884: no_such_host (server contacted for listing not identified as valid host).
16885:
16886: =item
16887: con_lost (connection to remote server failed).
16888:
16889: =item
16890: refused (invalid $username:$domain received on lond side).
16891:
16892: =item
16893: no_such_dir (directory at specified path on lond side does not exist).
16894:
16895: =item
16896: empty (directory at specified path on lond side is empty).
16897:
16898: =over
16899:
16900: This is currently not encountered because the &ls3, &ls2,
16901: &ls (_handler) routines on the lond side do not filter out
16902: . and .. from a directory listing.
16903:
16904: =back
16905:
16906: =back
16907:
16908: =back
1.191 harris41 16909:
16910: =item *
16911:
1.243 albertel 16912: spareserver() : find server with least workload from spare.tab
16913:
1.986 foxr 16914:
16915: =item *
16916:
16917: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
16918: if there is no corresponding loncapa host.
16919:
1.243 albertel 16920: =back
16921:
1.986 foxr 16922:
1.243 albertel 16923: =head2 Apache Request
16924:
16925: =over 4
1.191 harris41 16926:
16927: =item *
16928:
1.243 albertel 16929: ssi($url,%hash) : server side include, does a complete request cycle on url to
16930: localhost, posts hash
16931:
16932: =back
16933:
16934: =head2 Data to String to Data
16935:
16936: =over 4
1.191 harris41 16937:
16938: =item *
16939:
1.243 albertel 16940: hash2str(%hash) : convert a hash into a string complete with escaping and '='
16941: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 16942:
16943: =item *
16944:
1.243 albertel 16945: hashref2str($hashref) : convert a hashref into a string complete with
16946: escaping and '=' and '&' separators, supports elements that are
16947: arrayrefs and hashrefs
1.191 harris41 16948:
16949: =item *
16950:
1.243 albertel 16951: arrayref2str($arrayref) : convert an arrayref into a string complete
16952: with escaping and '&' separators, supports elements that are arrayrefs
16953: and hashrefs
1.191 harris41 16954:
16955: =item *
16956:
1.243 albertel 16957: str2hash($string) : convert string to hash using unescaping and
16958: splitting on '=' and '&', supports elements that are arrayrefs and
16959: hashrefs
1.191 harris41 16960:
16961: =item *
16962:
1.243 albertel 16963: str2array($string) : convert string to hash using unescaping and
16964: splitting on '&', supports elements that are arrayrefs and hashrefs
16965:
16966: =back
16967:
16968: =head2 Logging Routines
16969:
16970:
16971: These routines allow one to make log messages in the lonnet.log and
16972: lonnet.perm logfiles.
1.191 harris41 16973:
1.1119 foxr 16974: =over 4
16975:
1.191 harris41 16976: =item *
16977:
1.243 albertel 16978: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 16979:
16980: =item *
16981:
1.243 albertel 16982: logthis() : append message to the normal lonnet.log file, it gets
16983: preiodically rolled over and deleted.
1.191 harris41 16984:
16985: =item *
16986:
1.243 albertel 16987: logperm() : append a permanent message to lonnet.perm.log, this log
16988: file never gets deleted by any automated portion of the system, only
16989: messages of critical importance should go in here.
16990:
1.1119 foxr 16991:
1.243 albertel 16992: =back
16993:
16994: =head2 General File Helper Routines
16995:
16996: =over 4
1.191 harris41 16997:
16998: =item *
16999:
1.481 raeburn 17000: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
17001: (a) files in /uploaded
17002: (i) If a local copy of the file exists -
17003: compares modification date of local copy with last-modified date for
17004: definitive version stored on home server for course. If local copy is
17005: stale, requests a new version from the home server and stores it.
17006: If the original has been removed from the home server, then local copy
17007: is unlinked.
17008: (ii) If local copy does not exist -
17009: requests the file from the home server and stores it.
17010:
17011: If $caller is 'uploadrep':
17012: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
17013: for request for files originally uploaded via DOCS.
17014: - returns 'ok' if fresh local copy now available, -1 otherwise.
17015:
17016: Otherwise:
17017: This indicates a call from the content generation phase of the request.
17018: - returns the entire contents of the file or -1.
17019:
17020: (b) files in /res
17021: - returns the entire contents of a file or -1;
17022: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 17023:
1.712 albertel 17024:
17025: =item *
17026:
17027: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
17028: reference
17029:
17030: returns either a stat() list of data about the file or an empty list
17031: if the file doesn't exist or couldn't find out about it (connection
17032: problems or user unknown)
17033:
1.191 harris41 17034: =item *
17035:
1.243 albertel 17036: filelocation($dir,$file) : returns file system location of a file
17037: based on URI; meant to be "fairly clean" absolute reference, $dir is a
17038: directory that relative $file lookups are to looked in ($dir of /a/dir
17039: and a file of ../bob will become /a/bob)
1.191 harris41 17040:
17041: =item *
17042:
17043: hreflocation($dir,$file) : returns file system location or a URL; same as
17044: filelocation except for hrefs
17045:
17046: =item *
17047:
1.1261 raeburn 17048: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
17049: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 17050:
1.243 albertel 17051: =back
17052:
1.608 albertel 17053: =head2 Usererfile file routines (/uploaded*)
17054:
17055: =over 4
17056:
17057: =item *
17058:
17059: userfileupload(): main rotine for putting a file in a user or course's
17060: filespace, arguments are,
17061:
1.620 albertel 17062: formname - required - this is the name of the element in $env where the
1.608 albertel 17063: filename, and the contents of the file to create/modifed exist
1.620 albertel 17064: the filename is in $env{'form.'.$formname.'.filename'} and the
17065: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 17066: context - if coursedoc, store the file in the course of the active role
17067: of the current user;
17068: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
17069: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 17070: subdir - required - subdirectory to put the file in under ../userfiles/
17071: if undefined, it will be placed in "unknown"
17072:
17073: (This routine calls clean_filename() to remove any dangerous
17074: characters from the filename, and then calls finuserfileupload() to
17075: complete the transaction)
17076:
17077: returns either the url of the uploaded file (/uploaded/....) if successful
17078: and /adm/notfound.html if unsuccessful
17079:
17080: =item *
17081:
17082: clean_filename(): routine for cleaing a filename up for storage in
17083: userfile space, argument is:
17084:
17085: filename - proposed filename
17086:
17087: returns: the new clean filename
17088:
17089: =item *
17090:
1.1090 raeburn 17091: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 17092: userspace, probably shouldn't be called directly
17093:
17094: docuname: username or courseid of destination for the file
17095: docudom: domain of user/course of destination for the file
17096: formname: same as for userfileupload()
1.1090 raeburn 17097: fname: filename (including subdirectories) for the file
17098: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
1.1401 raeburn 17099: if hashref, and context is scantron, will convert csv format to standard format
1.1090 raeburn 17100: allfiles: reference to hash used to store objects found by parser
17101: codebase: reference to hash used for codebases of java objects found by parser
17102: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
17103: thumbheight: height (pixels) of thumbnail to be created for uploaded image
17104: resizewidth: width to be used to resize image using resizeImage from ImageMagick
17105: resizeheight: height to be used to resize image using resizeImage from ImageMagick
17106: context: if 'overwrite', will move the uploaded file from its temporary location to
17107: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 17108: mimetype: reference to scalar to accommodate mime type determined
17109: from File::MMagic if $parser = parse.
1.608 albertel 17110:
17111: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 17112: and /adm/notfound.html if unsuccessful (or an error message if context
17113: was 'overwrite').
17114:
1.608 albertel 17115:
17116: =item *
17117:
17118: renameuserfile(): renames an existing userfile to a new name
17119:
17120: Args:
17121: docuname: username or courseid of destination for the file
17122: docudom: domain of user/course of destination for the file
17123: old: current file name (including any subdirs under userfiles)
17124: new: desired file name (including any subdirs under userfiles)
17125:
17126: =item *
17127:
17128: mkdiruserfile(): creates a directory is a userfiles dir
17129:
17130: Args:
17131: docuname: username or courseid of destination for the file
17132: docudom: domain of user/course of destination for the file
17133: dir: dir to create (including any subdirs under userfiles)
17134:
17135: =item *
17136:
17137: removeuserfile(): removes a file that exists in userfiles
17138:
17139: Args:
17140: docuname: username or courseid of destination for the file
17141: docudom: domain of user/course of destination for the file
17142: fname: filname to delete (including any subdirs under userfiles)
17143:
17144: =item *
17145:
17146: removeuploadedurl(): convience function for removeuserfile()
17147:
17148: Args:
17149: url: a full /uploaded/... url to delete
17150:
1.747 albertel 17151: =item *
17152:
17153: get_portfile_permissions():
17154: Args:
17155: domain: domain of user or course contain the portfolio files
17156: user: name of user or num of course contain the portfolio files
17157: Returns:
17158: hashref of a dump of the proper file_permissions.db
17159:
17160:
17161: =item *
17162:
17163: get_access_controls():
17164:
17165: Args:
17166: current_permissions: the hash ref returned from get_portfile_permissions()
17167: group: (optional) the group you want the files associated with
17168: file: (optional) the file you want access info on
17169:
17170: Returns:
1.749 raeburn 17171: a hash (keys are file names) of hashes containing
17172: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
17173: values are XML containing access control settings (see below)
1.747 albertel 17174:
17175: Internal notes:
17176:
1.749 raeburn 17177: access controls are stored in file_permissions.db as key=value pairs.
17178: key -> path to file/file_name\0uniqueID:scope_end_start
17179: where scope -> public,guest,course,group,domains or users.
17180: end -> UNIX time for end of access (0 -> no end date)
17181: start -> UNIX time for start of access
17182:
17183: value -> XML description of access control
17184: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
17185: <start></start>
17186: <end></end>
17187:
17188: <password></password> for scope type = guest
17189:
17190: <domain></domain> for scope type = course or group
17191: <number></number>
17192: <roles id="">
17193: <role></role>
17194: <access></access>
17195: <section></section>
17196: <group></group>
17197: </roles>
17198:
17199: <dom></dom> for scope type = domains
17200:
17201: <users> for scope type = users
17202: <user>
17203: <uname></uname>
17204: <udom></udom>
17205: </user>
17206: </users>
17207: </scope>
17208:
17209: Access data is also aggregated for each file in an additional key=value pair:
17210: key -> path to file/file_name\0accesscontrol
17211: value -> reference to hash
17212: hash contains key = value pairs
17213: where key = uniqueID:scope_end_start
17214: value = UNIX time record was last updated
17215:
17216: Used to improve speed of look-ups of access controls for each file.
17217:
17218: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
17219:
1.1198 raeburn 17220: =item *
17221:
1.749 raeburn 17222: modify_access_controls():
17223:
17224: Modifies access controls for a portfolio file
17225: Args
17226: 1. file name
17227: 2. reference to hash of required changes,
17228: 3. domain
17229: 4. username
17230: where domain,username are the domain of the portfolio owner
17231: (either a user or a course)
17232:
17233: Returns:
17234: 1. result of additions or updates ('ok' or 'error', with error message).
17235: 2. result of deletions ('ok' or 'error', with error message).
17236: 3. reference to hash of any new or updated access controls.
17237: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
17238: key = integer (inbound ID)
1.1198 raeburn 17239: value = uniqueID
17240:
17241: =item *
17242:
17243: get_timebased_id():
17244:
17245: Attempts to get a unique timestamp-based suffix for use with items added to a
17246: course via the Course Editor (e.g., folders, composite pages,
17247: group bulletin boards).
17248:
17249: Args: (first three required; six others optional)
17250:
17251: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
17252: docssequence, or name of group
17253:
17254: 2. keyid (alphanumeric): name of temporary locking key in hash,
17255: e.g., num, boardids
17256:
17257: 3. namespace: name of gdbm file used to store suffixes already assigned;
17258: file will be named nohist_namespace.db
17259:
17260: 4. cdom: domain of course; default is current course domain from %env
17261:
17262: 5. cnum: course number; default is current course number from %env
17263:
17264: 6. idtype: set to concat if an additional digit is to be appended to the
17265: unix timestamp to form the suffix, if the plain timestamp is already
17266: in use. Default is to not do this, but simply increment the unix
17267: timestamp by 1 until a unique key is obtained.
17268:
17269: 7. who: holder of locking key; defaults to user:domain for user.
17270:
17271: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
17272: retrying); default is 3.
17273:
17274: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
17275:
17276: Returns:
17277:
17278: 1. suffix obtained (numeric)
17279:
17280: 2. result of deleting locking key (ok if deleted, or lock never obtained)
17281:
17282: 3. error: contains (localized) error message if an error occurred.
17283:
1.747 albertel 17284:
1.608 albertel 17285: =back
17286:
1.243 albertel 17287: =head2 HTTP Helper Routines
17288:
17289: =over 4
17290:
1.191 harris41 17291: =item *
17292:
17293: escape() : unpack non-word characters into CGI-compatible hex codes
17294:
17295: =item *
17296:
17297: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
17298:
1.243 albertel 17299: =back
17300:
17301: =head1 PRIVATE SUBROUTINES
17302:
17303: =head2 Underlying communication routines (Shouldn't call)
17304:
17305: =over 4
17306:
17307: =item *
17308:
17309: subreply() : tries to pass a message to lonc, returns con_lost if incapable
17310:
17311: =item *
17312:
17313: reply() : uses subreply to send a message to remote machine, logs all failures
17314:
17315: =item *
17316:
17317: critical() : passes a critical message to another server; if cannot
17318: get through then place message in connection buffer directory and
17319: returns con_delayed, if incapable of saving message, returns
17320: con_failed
17321:
17322: =item *
17323:
17324: reconlonc() : tries to reconnect lonc client processes.
17325:
17326: =back
17327:
17328: =head2 Resource Access Logging
17329:
17330: =over 4
17331:
17332: =item *
17333:
17334: flushcourselogs() : flush (save) buffer logs and access logs
17335:
17336: =item *
17337:
17338: courselog($what) : save message for course in hash
17339:
17340: =item *
17341:
17342: courseacclog($what) : save message for course using &courselog(). Perform
17343: special processing for specific resource types (problems, exams, quizzes, etc).
17344:
1.191 harris41 17345: =item *
17346:
17347: goodbye() : flush course logs and log shutting down; it is called in srm.conf
17348: as a PerlChildExitHandler
1.243 albertel 17349:
17350: =back
17351:
17352: =head2 Other
17353:
17354: =over 4
17355:
17356: =item *
17357:
17358: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 17359:
17360: =back
17361:
17362: =cut
1.877 foxr 17363:
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