Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1458
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1458 ! raeburn 4: # $Id: lonnet.pm,v 1.1457 2021/06/06 23:18:59 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') ||
471: ($subcmd eq 'putdom') || ($subcmd eq 'autoexportgrades')) {
472: (undef,undef,my @rest) = split(/:/,$cmd);
473: if (($subcmd eq 'auth') || ($subcmd eq 'putdom')) {
474: splice(@rest,2,1,'Hidden');
475: } elsif ($subcmd eq 'passwd') {
476: splice(@rest,2,2,('Hidden','Hidden'));
477: } elsif (($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
478: ($subcmd eq 'autoexportgrades')) {
479: splice(@rest,3,1,'Hidden');
480: }
481: $logged = join(':',('encrypt:'.$subcmd,@rest));
482: }
483: }
484: &logthis("<font color=\"blue\">WARNING:".
485: " $logged to $server returned $answer</font>");
1.12 www 486: }
1.1 albertel 487: return $answer;
488: }
489:
490: # ----------------------------------------------------------- Send USR1 to lonc
491:
492: sub reconlonc {
1.891 albertel 493: my ($lonid) = @_;
494: if ($lonid) {
1.1295 raeburn 495: my $hostname = &hostname($lonid);
1.891 albertel 496: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
497: if ($hostname && -e $peerfile) {
498: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
499: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
500: Type => SOCK_STREAM,
501: Timeout => 10);
502: if ($client) {
503: print $client ("reset_retries\n");
504: my $answer=<$client>;
505: #reset just this one.
506: }
507: }
508: return;
509: }
510:
1.836 www 511: &logthis("Trying to reconnect lonc");
1.1 albertel 512: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.1359 raeburn 513: if (open(my $fh,"<",$loncfile)) {
1.1 albertel 514: my $loncpid=<$fh>;
515: chomp($loncpid);
516: if (kill 0 => $loncpid) {
517: &logthis("lonc at pid $loncpid responding, sending USR1");
518: kill USR1 => $loncpid;
519: sleep 1;
1.1295 raeburn 520: } else {
1.12 www 521: &logthis(
1.672 albertel 522: "<font color=\"blue\">WARNING:".
1.12 www 523: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 524: }
525: } else {
1.836 www 526: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 527: }
528: }
529:
530: # ------------------------------------------------------ Critical communication
1.12 www 531:
1.1 albertel 532: sub critical {
533: my ($cmd,$server)=@_;
1.838 albertel 534: unless (&hostname($server)) {
1.672 albertel 535: &logthis("<font color=\"blue\">WARNING:".
1.89 www 536: " Critical message to unknown server ($server)</font>");
537: return 'no_such_host';
538: }
1.1 albertel 539: my $answer=reply($cmd,$server);
540: if ($answer eq 'con_lost') {
1.1295 raeburn 541: &reconlonc($server);
1.589 albertel 542: my $answer=reply($cmd,$server);
1.1 albertel 543: if ($answer eq 'con_lost') {
544: my $now=time;
545: my $middlename=$cmd;
1.5 www 546: $middlename=substr($middlename,0,16);
1.1 albertel 547: $middlename=~s/\W//g;
548: my $dfilename=
1.305 www 549: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
550: $dumpcount++;
1.1 albertel 551: {
1.448 albertel 552: my $dfh;
1.1359 raeburn 553: if (open($dfh,">",$dfilename)) {
1.448 albertel 554: print $dfh "$cmd\n";
555: close($dfh);
556: }
1.1 albertel 557: }
1.1288 damieng 558: sleep 1;
1.1 albertel 559: my $wcmd='';
560: {
1.448 albertel 561: my $dfh;
1.1359 raeburn 562: if (open($dfh,"<",$dfilename)) {
1.448 albertel 563: $wcmd=<$dfh>;
564: close($dfh);
565: }
1.1 albertel 566: }
567: chomp($wcmd);
1.7 www 568: if ($wcmd eq $cmd) {
1.672 albertel 569: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 570: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 571: &logperm("D:$server:$cmd");
572: return 'con_delayed';
573: } else {
1.672 albertel 574: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 575: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 576: &logperm("F:$server:$cmd");
577: return 'con_failed';
578: }
579: }
580: }
581: return $answer;
1.405 albertel 582: }
583:
1.755 albertel 584: # ------------------------------------------- check if return value is an error
585:
586: sub error {
587: my ($result) = @_;
1.756 albertel 588: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 589: if ($2 == 2) { return undef; }
590: return $1;
591: }
592: return undef;
593: }
594:
1.783 albertel 595: sub convert_and_load_session_env {
596: my ($lonidsdir,$handle)=@_;
597: my @profile;
598: {
1.917 albertel 599: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
600: if (!$opened) {
1.915 albertel 601: return 0;
602: }
1.783 albertel 603: flock($idf,LOCK_SH);
604: @profile=<$idf>;
605: close($idf);
606: }
607: my %temp_env;
608: foreach my $line (@profile) {
1.786 albertel 609: if ($line !~ m/=/) {
610: return 0;
611: }
1.783 albertel 612: chomp($line);
613: my ($envname,$envvalue)=split(/=/,$line,2);
614: $temp_env{&unescape($envname)} = &unescape($envvalue);
615: }
616: unlink("$lonidsdir/$handle.id");
617: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
618: 0640)) {
619: %disk_env = %temp_env;
620: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
621: untie(%disk_env);
622: }
1.786 albertel 623: return 1;
1.783 albertel 624: }
625:
1.374 www 626: # ------------------------------------------- Transfer profile into environment
1.780 albertel 627: my $env_loaded;
628: sub transfer_profile_to_env {
1.788 albertel 629: my ($lonidsdir,$handle,$force_transfer) = @_;
630: if (!$force_transfer && $env_loaded) { return; }
1.374 www 631:
1.720 albertel 632: if (!defined($lonidsdir)) {
633: $lonidsdir = $perlvar{'lonIDsDir'};
634: }
635: if (!defined($handle)) {
636: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
637: }
638:
1.786 albertel 639: my $convert;
640: {
1.917 albertel 641: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
642: if (!$opened) {
1.915 albertel 643: return;
644: }
1.786 albertel 645: flock($idf,LOCK_SH);
646: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
647: &GDBM_READER(),0640)) {
648: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
649: untie(%disk_env);
650: } else {
651: $convert = 1;
652: }
653: }
654: if ($convert) {
655: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
656: &logthis("Failed to load session, or convert session.");
657: }
1.374 www 658: }
1.783 albertel 659:
1.786 albertel 660: my %remove;
1.783 albertel 661: while ( my $envname = each(%env) ) {
1.433 matthew 662: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
663: if ($time < time-300) {
1.783 albertel 664: $remove{$key}++;
1.433 matthew 665: }
666: }
667: }
1.783 albertel 668:
1.619 albertel 669: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 670: $env_loaded=1;
1.783 albertel 671: foreach my $expired_key (keys(%remove)) {
1.433 matthew 672: &delenv($expired_key);
1.374 www 673: }
1.1 albertel 674: }
675:
1.916 albertel 676: # ---------------------------------------------------- Check for valid session
677: sub check_for_valid_session {
1.1355 raeburn 678: my ($r,$name,$userhashref,$domref) = @_;
1.916 albertel 679: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1378 raeburn 680: my ($lonidsdir,$linkname,$pubname,$secure,$lonid);
681: if ($name eq 'lonDAV') {
682: $lonidsdir=$r->dir_config('lonDAVsessDir');
683: } else {
684: $lonidsdir=$r->dir_config('lonIDsDir');
685: if ($name eq '') {
686: $name = 'lonID';
687: }
688: }
689: if ($name eq 'lonID') {
690: $secure = 'lonSID';
1.1337 raeburn 691: $linkname = 'lonLinkID';
692: $pubname = 'lonPubID';
1.1378 raeburn 693: if (exists($cookies{$secure})) {
694: $lonid=$cookies{$secure};
695: } elsif (exists($cookies{$name})) {
696: $lonid=$cookies{$name};
1.1400 raeburn 697: } elsif ((exists($cookies{$linkname})) && ($ENV{'SERVER_PORT'} != 443)) {
1.1337 raeburn 698: $lonid=$cookies{$linkname};
1.1378 raeburn 699: } elsif (exists($cookies{$pubname})) {
700: $lonid=$cookies{$pubname};
1.1337 raeburn 701: }
1.1378 raeburn 702: } else {
703: $lonid=$cookies{$name};
1.1337 raeburn 704: }
1.916 albertel 705: return undef if (!$lonid);
706:
707: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1378 raeburn 708: if (-l "$lonidsdir/$handle.id") {
709: my $link = readlink("$lonidsdir/$handle.id");
710: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
711: $handle = $1;
712: }
1.1155 raeburn 713: }
1.1355 raeburn 714: if (!-e "$lonidsdir/$handle.id") {
715: if ((ref($domref)) && ($name eq 'lonID') &&
716: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
717: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
718: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
719: $$domref = $possudom;
720: }
721: }
722: return undef;
723: }
1.916 albertel 724:
1.917 albertel 725: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
726: return undef if (!$opened);
1.916 albertel 727:
728: flock($idf,LOCK_SH);
729: my %disk_env;
730: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
731: &GDBM_READER(),0640)) {
732: return undef;
733: }
734:
735: if (!defined($disk_env{'user.name'})
736: || !defined($disk_env{'user.domain'})) {
1.1394 raeburn 737: untie(%disk_env);
1.916 albertel 738: return undef;
739: }
1.1245 raeburn 740:
741: if (ref($userhashref) eq 'HASH') {
742: $userhashref->{'name'} = $disk_env{'user.name'};
743: $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1448 raeburn 744: if ($disk_env{'request.role'}) {
745: $userhashref->{'role'} = $disk_env{'request.role'};
746: }
1.1361 raeburn 747: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
1.1375 raeburn 748: if ($userhashref->{'lti'}) {
749: $userhashref->{'ltitarget'} = $disk_env{'request.lti.target'};
750: $userhashref->{'ltiuri'} = $disk_env{'request.lti.uri'};
751: }
1.1212 raeburn 752: }
1.1394 raeburn 753: untie(%disk_env);
1.1245 raeburn 754:
1.916 albertel 755: return $handle;
756: }
757:
1.830 albertel 758: sub timed_flock {
759: my ($file,$lock_type) = @_;
760: my $failed=0;
761: eval {
762: local $SIG{__DIE__}='DEFAULT';
763: local $SIG{ALRM}=sub {
764: $failed=1;
765: die("failed lock");
766: };
767: alarm(13);
768: flock($file,$lock_type);
769: alarm(0);
770: };
771: if ($failed) {
772: return undef;
773: } else {
774: return 1;
775: }
776: }
777:
1.1392 raeburn 778: sub get_sessionfile_vars {
779: my ($handle,$lonidsdir,$storearr) = @_;
780: my %returnhash;
781: unless (ref($storearr) eq 'ARRAY') {
782: return %returnhash;
783: }
784: if (-l "$lonidsdir/$handle.id") {
785: my $link = readlink("$lonidsdir/$handle.id");
786: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
787: $handle = $1;
788: }
789: }
790: if ((-e "$lonidsdir/$handle.id") &&
791: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
792: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
793: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
794: if (open(my $idf,'+<',"$lonidsdir/$handle.id")) {
795: flock($idf,LOCK_SH);
796: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
797: &GDBM_READER(),0640)) {
798: foreach my $item (@{$storearr}) {
799: $returnhash{$item} = $disk_env{$item};
800: }
801: untie(%disk_env);
802: }
803: }
804: }
805: }
806: return %returnhash;
807: }
808:
1.5 www 809: # ---------------------------------------------------------- Append Environment
810:
811: sub appenv {
1.949 raeburn 812: my ($newenv,$roles) = @_;
813: if (ref($newenv) eq 'HASH') {
814: foreach my $key (keys(%{$newenv})) {
815: my $refused = 0;
816: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
817: $refused = 1;
818: if (ref($roles) eq 'ARRAY') {
1.1250 raeburn 819: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949 raeburn 820: if (grep(/^\Q$role\E$/,@{$roles})) {
821: $refused = 0;
822: }
823: }
824: }
825: if ($refused) {
826: &logthis("<font color=\"blue\">WARNING: ".
827: "Attempt to modify environment ".$key." to ".$newenv->{$key}
828: .'</font>');
829: delete($newenv->{$key});
830: } else {
831: $env{$key}=$newenv->{$key};
832: }
833: }
1.1376 raeburn 834: my $lonids = $perlvar{'lonIDsDir'};
835: if ($env{'user.environment'} =~ m{^\Q$lonids/\E$match_username\_\d+\_$match_domain\_[\w\-.]+\.id$}) {
836: my $opened = open(my $env_file,'+<',$env{'user.environment'});
837: if ($opened
838: && &timed_flock($env_file,LOCK_EX)
839: &&
840: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
841: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
842: while (my ($key,$value) = each(%{$newenv})) {
843: $disk_env{$key} = $value;
844: }
845: untie(%disk_env);
846: }
1.35 www 847: }
1.191 harris41 848: }
1.56 www 849: return 'ok';
850: }
851: # ----------------------------------------------------- Delete from Environment
852:
853: sub delenv {
1.1104 raeburn 854: my ($delthis,$regexp,$roles) = @_;
855: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
856: my $refused = 1;
857: if (ref($roles) eq 'ARRAY') {
858: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
859: if (grep(/^\Q$role\E$/,@{$roles})) {
860: $refused = 0;
861: }
862: }
863: if ($refused) {
864: &logthis("<font color=\"blue\">WARNING: ".
865: "Attempt to delete from environment ".$delthis);
866: return 'error';
867: }
1.56 www 868: }
1.917 albertel 869: my $opened = open(my $env_file,'+<',$env{'user.environment'});
870: if ($opened
1.915 albertel 871: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 872: &&
873: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
874: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 875: foreach my $key (keys(%disk_env)) {
1.987 raeburn 876: if ($regexp) {
877: if ($key=~/^$delthis/) {
878: delete($env{$key});
879: delete($disk_env{$key});
880: }
881: } else {
882: if ($key=~/^\Q$delthis\E/) {
883: delete($env{$key});
884: delete($disk_env{$key});
885: }
886: }
1.448 albertel 887: }
1.783 albertel 888: untie(%disk_env);
1.5 www 889: }
890: return 'ok';
1.369 albertel 891: }
892:
1.790 albertel 893: sub get_env_multiple {
894: my ($name) = @_;
895: my @values;
896: if (defined($env{$name})) {
897: # exists is it an array
898: if (ref($env{$name})) {
899: @values=@{ $env{$name} };
900: } else {
901: $values[0]=$env{$name};
902: }
903: }
904: return(@values);
905: }
906:
1.958 www 907: # ------------------------------------------------------------------- Locking
908:
909: sub set_lock {
910: my ($text)=@_;
911: $locknum++;
912: my $id=$$.'-'.$locknum;
913: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
914: 'session.lock.'.$id => $text});
915: return $id;
916: }
917:
918: sub get_locks {
919: my $num=0;
920: my %texts=();
921: foreach my $lock (split(/\,/,$env{'session.locks'})) {
922: if ($lock=~/\w/) {
923: $num++;
924: $texts{$lock}=$env{'session.lock.'.$lock};
925: }
926: }
927: return ($num,%texts);
928: }
929:
930: sub remove_lock {
931: my ($id)=@_;
932: my $newlocks='';
933: foreach my $lock (split(/\,/,$env{'session.locks'})) {
934: if (($lock=~/\w/) && ($lock ne $id)) {
935: $newlocks.=','.$lock;
936: }
937: }
938: &appenv({'session.locks' => $newlocks});
939: &delenv('session.lock.'.$id);
940: }
941:
942: sub remove_all_locks {
943: my $activelocks=$env{'session.locks'};
944: foreach my $lock (split(/\,/,$env{'session.locks'})) {
945: if ($lock=~/\w/) {
946: &remove_lock($lock);
947: }
948: }
949: }
950:
951:
1.369 albertel 952: # ------------------------------------------ Find out current server userload
953: sub userload {
954: my $numusers=0;
955: {
956: opendir(LONIDS,$perlvar{'lonIDsDir'});
957: my $filename;
958: my $curtime=time;
959: while ($filename=readdir(LONIDS)) {
1.925 albertel 960: next if ($filename eq '.' || $filename eq '..');
961: next if ($filename =~ /publicuser_\d+\.id/);
1.1390 raeburn 962: next if ($filename =~ /^[a-f0-9]+_linked\.id$/);
1.404 albertel 963: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 964: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 965: }
966: closedir(LONIDS);
967: }
968: my $userloadpercent=0;
969: my $maxuserload=$perlvar{'lonUserLoadLim'};
970: if ($maxuserload) {
1.371 albertel 971: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 972: }
1.372 albertel 973: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 974: return $userloadpercent;
1.283 www 975: }
976:
1.1 albertel 977: # ------------------------------ Find server with least workload from spare.tab
1.11 www 978:
1.1 albertel 979: sub spareserver {
1.1451 raeburn 980: my ($r,$loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 981: my $spare_server;
1.370 albertel 982: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 983: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
984: : $userloadpercent;
1.1083 raeburn 985: my ($uint_dom,$remotesessions);
986: if (($udom ne '') && (&domain($udom) ne '')) {
987: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
988: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
989: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
990: $remotesessions = $udomdefaults{'remotesessions'};
991: }
1.1123 raeburn 992: my $spareshash = &this_host_spares($udom);
993: if (ref($spareshash) eq 'HASH') {
994: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
995: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1.1279 raeburn 996: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
997: $try_server));
1.1123 raeburn 998: ($spare_server, $lowest_load) =
999: &compare_server_load($try_server, $spare_server, $lowest_load);
1000: }
1.1083 raeburn 1001: }
1.784 albertel 1002:
1.1123 raeburn 1003: my $found_server = ($spare_server ne '' && $lowest_load < 100);
1004:
1005: if (!$found_server) {
1006: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1007: foreach my $try_server (@{ $spareshash->{'default'} }) {
1.1279 raeburn 1008: next unless (&spare_can_host($udom,$uint_dom,
1009: $remotesessions,$try_server));
1.1123 raeburn 1010: ($spare_server, $lowest_load) =
1011: &compare_server_load($try_server, $spare_server, $lowest_load);
1012: }
1013: }
1014: }
1.784 albertel 1015: }
1016:
1017: if (!$want_server_name) {
1.1001 raeburn 1018: if (defined($spare_server)) {
1019: my $hostname = &hostname($spare_server);
1.1083 raeburn 1020: if (defined($hostname)) {
1.1397 raeburn 1021: my $protocol = 'http';
1022: if ($protocol{$spare_server} eq 'https') {
1023: $protocol = $protocol{$spare_server};
1024: }
1.1451 raeburn 1025: my $alias = &Apache::lonnet::use_proxy_alias($r,$spare_server);
1026: $hostname = $alias if ($alias ne '');
1.1001 raeburn 1027: $spare_server = $protocol.'://'.$hostname;
1028: }
1029: }
1.784 albertel 1030: }
1031: return $spare_server;
1032: }
1033:
1034: sub compare_server_load {
1.1253 raeburn 1035: my ($try_server, $spare_server, $lowest_load, $required) = @_;
1036:
1037: if ($required) {
1038: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
1039: my $remoterev = &get_server_loncaparev(undef,$try_server);
1040: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
1041: if (($major eq '' && $minor eq '') ||
1042: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
1043: return ($spare_server,$lowest_load);
1044: }
1045: }
1.784 albertel 1046:
1047: my $loadans = &reply('load', $try_server);
1048: my $userloadans = &reply('userload',$try_server);
1049:
1050: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 1051: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 1052: }
1053:
1054: my $load;
1055: if ($loadans =~ /\d/) {
1056: if ($userloadans =~ /\d/) {
1057: #both are numbers, pick the bigger one
1058: $load = ($loadans > $userloadans) ? $loadans
1059: : $userloadans;
1.411 albertel 1060: } else {
1.784 albertel 1061: $load = $loadans;
1.411 albertel 1062: }
1.784 albertel 1063: } else {
1064: $load = $userloadans;
1065: }
1066:
1067: if (($load =~ /\d/) && ($load < $lowest_load)) {
1068: $spare_server = $try_server;
1069: $lowest_load = $load;
1.370 albertel 1070: }
1.784 albertel 1071: return ($spare_server,$lowest_load);
1.202 matthew 1072: }
1.914 albertel 1073:
1074: # --------------------------- ask offload servers if user already has a session
1075: sub find_existing_session {
1076: my ($udom,$uname) = @_;
1.1123 raeburn 1077: my $spareshash = &this_host_spares($udom);
1078: if (ref($spareshash) eq 'HASH') {
1079: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1080: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1081: return $try_server if (&has_user_session($try_server, $udom, $uname));
1082: }
1083: }
1084: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1085: foreach my $try_server (@{ $spareshash->{'default'} }) {
1086: return $try_server if (&has_user_session($try_server, $udom, $uname));
1087: }
1088: }
1.914 albertel 1089: }
1090: return;
1091: }
1092:
1.1411 raeburn 1093: sub delusersession {
1094: my ($lonid,$udom,$uname) = @_;
1095: my $uprimary_id = &domain($udom,'primary');
1096: my $uintdom = &internet_dom($uprimary_id);
1097: my $intdom = &internet_dom($lonid);
1098: my $serverhomedom = &host_domain($lonid);
1099: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1100: return &reply(join(':','delusersession',
1101: map {&escape($_)} ($udom,$uname)),$lonid);
1102: }
1103: return;
1104: }
1105:
1.1389 raeburn 1106: # check if user's browser sent load balancer cookie and server still has session
1107: # and is not overloaded.
1108: sub check_for_balancer_cookie {
1109: my ($r,$update_mtime) = @_;
1110: my ($otherserver,$cookie);
1111: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1112: if (exists($cookies{'balanceID'})) {
1113: my $balid = $cookies{'balanceID'};
1114: $cookie=&LONCAPA::clean_handle($balid->value);
1115: my $balancedir=$r->dir_config('lonBalanceDir');
1116: if ((-d $balancedir) && (-e "$balancedir/$cookie.id")) {
1117: if ($cookie =~ /^($match_domain)_($match_username)_[a-f0-9]+$/) {
1118: my ($possudom,$possuname) = ($1,$2);
1119: my $has_session = 0;
1120: if ((&domain($possudom) ne '') &&
1121: (&homeserver($possuname,$possudom) ne 'no_host')) {
1122: my $try_server;
1123: my $opened = open(my $idf,'+<',"$balancedir/$cookie.id");
1124: if ($opened) {
1125: flock($idf,LOCK_SH);
1126: while (my $line = <$idf>) {
1127: chomp($line);
1128: if (&hostname($line) ne '') {
1129: $try_server = $line;
1130: last;
1131: }
1132: }
1133: close($idf);
1134: if (($try_server) &&
1135: (&has_user_session($try_server,$possudom,$possuname))) {
1136: my $lowest_load = 30000;
1137: ($otherserver,$lowest_load) =
1138: &compare_server_load($try_server,undef,$lowest_load);
1139: if ($otherserver ne '' && $lowest_load < 100) {
1140: $has_session = 1;
1141: } else {
1142: undef($otherserver);
1143: }
1144: }
1145: }
1146: }
1147: if ($has_session) {
1148: if ($update_mtime) {
1149: my $atime = my $mtime = time;
1150: utime($atime,$mtime,"$balancedir/$cookie.id");
1151: }
1152: } else {
1153: unlink("$balancedir/$cookie.id");
1154: }
1155: }
1156: }
1157: }
1158: return ($otherserver,$cookie);
1159: }
1160:
1.1431 raeburn 1161: sub updatebalcookie {
1162: my ($cookie,$balancer,$lastentry)=@_;
1163: if ($cookie =~ /^($match_domain)\_($match_username)\_[a-f0-9]{32}$/) {
1164: my ($udom,$uname) = ($1,$2);
1165: my $uprimary_id = &domain($udom,'primary');
1166: my $uintdom = &internet_dom($uprimary_id);
1167: my $intdom = &internet_dom($balancer);
1168: my $serverhomedom = &host_domain($balancer);
1169: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1170: return &reply('updatebalcookie:'.&escape($cookie).':'.&escape($lastentry),$balancer);
1171: }
1172: }
1173: return;
1174: }
1175:
1.1389 raeburn 1176: sub delbalcookie {
1177: my ($cookie,$balancer) =@_;
1178: if ($cookie =~ /^($match_domain)\_($match_username)\_[a-f0-9]{32}$/) {
1179: my ($udom,$uname) = ($1,$2);
1180: my $uprimary_id = &domain($udom,'primary');
1181: my $uintdom = &internet_dom($uprimary_id);
1182: my $intdom = &internet_dom($balancer);
1183: my $serverhomedom = &host_domain($balancer);
1184: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1.1431 raeburn 1185: return &reply('delbalcookie:'.&escape($cookie),$balancer);
1.1389 raeburn 1186: }
1187: }
1188: }
1189:
1.914 albertel 1190: # -------------------------------- ask if server already has a session for user
1191: sub has_user_session {
1192: my ($lonid,$udom,$uname) = @_;
1193: my $result = &reply(join(':','userhassession',
1194: map {&escape($_)} ($udom,$uname)),$lonid);
1195: return 1 if ($result eq 'ok');
1196:
1197: return 0;
1198: }
1199:
1.1076 raeburn 1200: # --------- determine least loaded server in a user's domain which allows login
1201:
1202: sub choose_server {
1.1259 raeburn 1203: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076 raeburn 1204: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 1205: my %servers = &get_servers($udom);
1.1076 raeburn 1206: my $lowest_load = 30000;
1.1259 raeburn 1207: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1208: if ($skiploadbal) {
1209: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1210: unless (defined($cached)) {
1211: my $cachetime = 60*60*24;
1212: my %domconfig =
1213: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1214: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1215: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1216: $cachetime);
1217: }
1218: }
1219: }
1.1076 raeburn 1220: foreach my $lonhost (keys(%servers)) {
1.1259 raeburn 1221: if ($skiploadbal) {
1222: if (ref($balancers) eq 'HASH') {
1223: next if (exists($balancers->{$lonhost}));
1224: }
1.1389 raeburn 1225: }
1.1115 raeburn 1226: my $loginvia;
1227: if ($checkloginvia) {
1228: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 1229: if ($loginvia) {
1230: my ($server,$path) = split(/:/,$loginvia);
1231: ($login_host, $lowest_load) =
1.1253 raeburn 1232: &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116 raeburn 1233: if ($login_host eq $server) {
1234: $portal_path = $path;
1.1151 raeburn 1235: $isredirect = 1;
1.1116 raeburn 1236: }
1237: } else {
1238: ($login_host, $lowest_load) =
1.1253 raeburn 1239: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116 raeburn 1240: if ($login_host eq $lonhost) {
1241: $portal_path = '';
1.1151 raeburn 1242: $isredirect = '';
1.1116 raeburn 1243: }
1244: }
1245: } else {
1.1076 raeburn 1246: ($login_host, $lowest_load) =
1.1253 raeburn 1247: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076 raeburn 1248: }
1249: }
1250: if ($login_host ne '') {
1.1116 raeburn 1251: $hostname = &hostname($login_host);
1.1076 raeburn 1252: }
1.1331 raeburn 1253: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1.1076 raeburn 1254: }
1255:
1.1420 raeburn 1256: sub get_course_sessions {
1257: my ($cnum,$cdom,$lastactivity) = @_;
1258: my %servers = &internet_dom_servers($cdom);
1259: my %returnhash;
1260: foreach my $server (sort(keys(%servers))) {
1261: my $rep = &reply("coursesessions:$cdom:$cnum:$lastactivity",$server);
1262: my @pairs=split(/\&/,$rep);
1263: unless (($rep eq 'unknown_cmd') || ($rep =~ /^error/)) {
1264: foreach my $item (@pairs) {
1265: my ($key,$value)=split(/=/,$item,2);
1266: $key = &unescape($key);
1267: next if ($key =~ /^error: 2 /);
1268: if (exists($returnhash{$key})) {
1269: next if ($value < $returnhash{$key});
1270: }
1271: $returnhash{$key}=$value;
1272: }
1273: }
1274: }
1275: return %returnhash;
1276: }
1277:
1.202 matthew 1278: # --------------------------------------------- Try to change a user's password
1279:
1280: sub changepass {
1.799 raeburn 1281: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 1282: $currentpass = &escape($currentpass);
1283: $newpass = &escape($newpass);
1.1030 raeburn 1284: my $lonhost = $perlvar{'lonHostID'};
1285: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 1286: $server);
1287: if (! $answer) {
1288: &logthis("No reply on password change request to $server ".
1289: "by $uname in domain $udom.");
1290: } elsif ($answer =~ "^ok") {
1291: &logthis("$uname in $udom successfully changed their password ".
1292: "on $server.");
1293: } elsif ($answer =~ "^pwchange_failure") {
1294: &logthis("$uname in $udom was unable to change their password ".
1295: "on $server. The action was blocked by either lcpasswd ".
1296: "or pwchange");
1297: } elsif ($answer =~ "^non_authorized") {
1298: &logthis("$uname in $udom did not get their password correct when ".
1299: "attempting to change it on $server.");
1300: } elsif ($answer =~ "^auth_mode_error") {
1301: &logthis("$uname in $udom attempted to change their password despite ".
1302: "not being locally or internally authenticated on $server.");
1303: } elsif ($answer =~ "^unknown_user") {
1304: &logthis("$uname in $udom attempted to change their password ".
1305: "on $server but were unable to because $server is not ".
1306: "their home server.");
1307: } elsif ($answer =~ "^refused") {
1308: &logthis("$server refused to change $uname in $udom password because ".
1309: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1310: } elsif ($answer =~ "invalid_client") {
1311: &logthis("$server refused to change $uname in $udom password because ".
1312: "it was a reset by e-mail originating from an invalid server.");
1.1408 raeburn 1313: } elsif ($answer =~ "^prioruse") {
1314: &logthis("$server refused to change $uname in $udom password because ".
1315: "the password had been used before");
1.202 matthew 1316: }
1317: return $answer;
1.1 albertel 1318: }
1319:
1.169 harris41 1320: # ----------------------- Try to determine user's current authentication scheme
1321:
1322: sub queryauthenticate {
1323: my ($uname,$udom)=@_;
1.456 albertel 1324: my $uhome=&homeserver($uname,$udom);
1325: if (!$uhome) {
1326: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1327: return 'no_host';
1328: }
1329: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1330: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1331: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1332: }
1.456 albertel 1333: return $answer;
1.169 harris41 1334: }
1335:
1.1 albertel 1336: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1337:
1.1 albertel 1338: sub authenticate {
1.1073 raeburn 1339: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1340: $upass=&escape($upass);
1341: $uname= &LONCAPA::clean_username($uname);
1.836 www 1342: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1343: my $newhome;
1.836 www 1344: if ((!$uhome) || ($uhome eq 'no_host')) {
1345: # Maybe the machine was offline and only re-appeared again recently?
1346: &reconlonc();
1347: # One more
1.952 raeburn 1348: $uhome=&homeserver($uname,$udom,1);
1349: if (($uhome eq 'no_host') && $checkdefauth) {
1350: if (defined(&domain($udom,'primary'))) {
1351: $newhome=&domain($udom,'primary');
1352: }
1353: if ($newhome ne '') {
1354: $uhome = $newhome;
1355: }
1356: }
1.836 www 1357: if ((!$uhome) || ($uhome eq 'no_host')) {
1358: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1359: return 'no_host';
1360: }
1.1 albertel 1361: }
1.1073 raeburn 1362: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1363: if ($answer eq 'authorized') {
1.952 raeburn 1364: if ($newhome) {
1365: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1366: return 'no_account_on_host';
1367: } else {
1368: &logthis("User $uname at $udom authorized by $uhome");
1369: return $uhome;
1370: }
1.471 albertel 1371: }
1372: if ($answer eq 'non_authorized') {
1373: &logthis("User $uname at $udom rejected by $uhome");
1374: return 'no_host';
1.9 www 1375: }
1.471 albertel 1376: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1377: return 'no_host';
1378: }
1379:
1.1073 raeburn 1380: sub can_host_session {
1.1074 raeburn 1381: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1382: my $canhost = 1;
1.1074 raeburn 1383: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1384: if (ref($remotesessions) eq 'HASH') {
1385: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1386: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1387: $canhost = 0;
1388: } else {
1389: $canhost = 1;
1390: }
1391: }
1392: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1393: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1394: $canhost = 1;
1395: } else {
1396: $canhost = 0;
1397: }
1398: }
1399: if ($canhost) {
1400: if ($remotesessions->{'version'} ne '') {
1401: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1402: if ($reqmajor ne '' && $reqminor ne '') {
1403: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1404: my $major = $1;
1405: my $minor = $2;
1406: if (($major < $reqmajor ) ||
1407: (($major == $reqmajor) && ($minor < $reqminor))) {
1408: $canhost = 0;
1409: }
1410: } else {
1411: $canhost = 0;
1412: }
1413: }
1414: }
1415: }
1416: }
1417: if ($canhost) {
1418: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1419: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1420: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1421: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1422: if (($uint_dom ne '') &&
1423: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1424: $canhost = 0;
1425: } else {
1426: $canhost = 1;
1427: }
1428: }
1429: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1430: if (($uint_dom ne '') &&
1431: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1432: $canhost = 1;
1433: } else {
1434: $canhost = 0;
1435: }
1436: }
1437: }
1438: }
1439: return $canhost;
1440: }
1441:
1.1083 raeburn 1442: sub spare_can_host {
1443: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1444: my $canhost=1;
1.1279 raeburn 1445: my $try_server_hostname = &hostname($try_server);
1446: my $serverhomeID = &get_server_homeID($try_server_hostname);
1447: my $serverhomedom = &host_domain($serverhomeID);
1448: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1449: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1450: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1451: $canhost = 0;
1452: }
1453: }
1.1439 raeburn 1454: if ($canhost) {
1455: if (ref($defdomdefaults{'offloadoth'}) eq 'HASH') {
1456: if ($defdomdefaults{'offloadoth'}{$try_server}) {
1457: unless (&shared_institution($udom,$try_server)) {
1458: $canhost = 0;
1459: }
1460: }
1461: }
1462: }
1.1279 raeburn 1463: if (($canhost) && ($uint_dom)) {
1464: my @intdoms;
1465: my $internet_names = &get_internet_names($try_server);
1466: if (ref($internet_names) eq 'ARRAY') {
1467: @intdoms = @{$internet_names};
1468: }
1469: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1470: my $remoterev = &get_server_loncaparev(undef,$try_server);
1471: $canhost = &can_host_session($udom,$try_server,$remoterev,
1472: $remotesessions,
1473: $defdomdefaults{'hostedsessions'});
1474: }
1.1083 raeburn 1475: }
1476: return $canhost;
1477: }
1478:
1.1123 raeburn 1479: sub this_host_spares {
1480: my ($dom) = @_;
1.1126 raeburn 1481: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1482: my @hosts = ¤t_machine_ids();
1483: foreach my $lonhost (@hosts) {
1484: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1485: $dom_in_use = $dom;
1486: $lonhost_in_use = $lonhost;
1.1123 raeburn 1487: last;
1488: }
1489: }
1.1126 raeburn 1490: if ($dom_in_use ne '') {
1491: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1492: }
1493: if (ref($result) ne 'HASH') {
1494: $lonhost_in_use = $perlvar{'lonHostID'};
1495: $dom_in_use = &host_domain($lonhost_in_use);
1496: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1497: if (ref($result) ne 'HASH') {
1498: $result = \%spareid;
1499: }
1500: }
1501: return $result;
1502: }
1503:
1504: sub spares_for_offload {
1505: my ($dom_in_use,$lonhost_in_use) = @_;
1506: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1507: if (defined($cached)) {
1508: return $result;
1509: } else {
1.1126 raeburn 1510: my $cachetime = 60*60*24;
1511: my %domconfig =
1512: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1513: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1514: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1515: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1516: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1517: }
1518: }
1519: }
1520: }
1.1126 raeburn 1521: return;
1.1123 raeburn 1522: }
1523:
1.1129 raeburn 1524: sub get_lonbalancer_config {
1525: my ($servers) = @_;
1526: my ($currbalancer,$currtargets);
1527: if (ref($servers) eq 'HASH') {
1528: foreach my $server (keys(%{$servers})) {
1529: my %what = (
1530: spareid => 1,
1531: perlvar => 1,
1532: );
1533: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1534: if ($result eq 'ok') {
1535: if (ref($returnhash) eq 'HASH') {
1536: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1537: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1538: $currbalancer = $server;
1539: $currtargets = {};
1540: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1541: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1542: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1543: }
1544: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1545: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1546: }
1547: }
1548: last;
1549: }
1550: }
1551: }
1552: }
1553: }
1554: }
1555: return ($currbalancer,$currtargets);
1556: }
1557:
1558: sub check_loadbalancing {
1.1331 raeburn 1559: my ($uname,$udom,$caller) = @_;
1.1191 raeburn 1560: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1.1391 raeburn 1561: $rule_in_effect,$offloadto,$otherserver,$setcookie,$dom_balancers);
1.1129 raeburn 1562: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1563: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1564: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1565: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1566: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1567: my $serverhomedom = &host_domain($lonhost);
1.1307 raeburn 1568: my $domneedscache;
1.1129 raeburn 1569: my $cachetime = 60*60*24;
1570:
1571: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1572: $dom_in_use = $udom;
1573: $homeintdom = 1;
1574: } else {
1575: $dom_in_use = $serverhomedom;
1576: }
1577: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1578: unless (defined($cached)) {
1579: my %domconfig =
1580: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1581: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1582: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1307 raeburn 1583: } else {
1584: $domneedscache = $dom_in_use;
1.1129 raeburn 1585: }
1586: }
1587: if (ref($result) eq 'HASH') {
1.1391 raeburn 1588: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1589: &check_balancer_result($result,@hosts);
1.1129 raeburn 1590: if ($is_balancer) {
1591: if (ref($currrules) eq 'HASH') {
1592: if ($homeintdom) {
1593: if ($uname ne '') {
1594: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1595: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1596: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1597: $rule_in_effect = $currrules->{'_LC_author'};
1598: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1599: $rule_in_effect = $currrules->{'_LC_adv'}
1600: }
1601: }
1602: if ($rule_in_effect eq '') {
1603: my %userenv = &userenvironment($udom,$uname,'inststatus');
1604: if ($userenv{'inststatus'} ne '') {
1605: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1606: my ($othertitle,$usertypes,$types) =
1607: &Apache::loncommon::sorted_inst_types($udom);
1608: if (ref($types) eq 'ARRAY') {
1609: foreach my $type (@{$types}) {
1610: if (grep(/^\Q$type\E$/,@statuses)) {
1611: if (exists($currrules->{$type})) {
1612: $rule_in_effect = $currrules->{$type};
1613: }
1614: }
1615: }
1616: }
1617: } else {
1618: if (exists($currrules->{'default'})) {
1619: $rule_in_effect = $currrules->{'default'};
1620: }
1621: }
1622: }
1623: } else {
1624: if (exists($currrules->{'default'})) {
1625: $rule_in_effect = $currrules->{'default'};
1626: }
1627: }
1628: } else {
1629: if ($currrules->{'_LC_external'} ne '') {
1630: $rule_in_effect = $currrules->{'_LC_external'};
1631: }
1632: }
1633: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1634: $uname,$udom);
1635: }
1636: }
1637: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1239 raeburn 1638: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1639: unless (defined($cached)) {
1640: my %domconfig =
1641: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1642: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1307 raeburn 1643: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1644: } else {
1645: $domneedscache = $serverhomedom;
1.1129 raeburn 1646: }
1647: }
1648: if (ref($result) eq 'HASH') {
1.1391 raeburn 1649: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1650: &check_balancer_result($result,@hosts);
1651: if ($is_balancer) {
1.1129 raeburn 1652: if (ref($currrules) eq 'HASH') {
1653: if ($currrules->{'_LC_internetdom'} ne '') {
1654: $rule_in_effect = $currrules->{'_LC_internetdom'};
1655: }
1656: }
1657: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1658: $uname,$udom);
1659: }
1660: } else {
1661: if ($perlvar{'lonBalancer'} eq 'yes') {
1662: $is_balancer = 1;
1663: $offloadto = &this_host_spares($dom_in_use);
1664: }
1.1307 raeburn 1665: unless (defined($cached)) {
1666: $domneedscache = $serverhomedom;
1667: }
1.1129 raeburn 1668: }
1669: } else {
1670: if ($perlvar{'lonBalancer'} eq 'yes') {
1671: $is_balancer = 1;
1672: $offloadto = &this_host_spares($dom_in_use);
1673: }
1.1307 raeburn 1674: unless (defined($cached)) {
1675: $domneedscache = $serverhomedom;
1676: }
1677: }
1678: if ($domneedscache) {
1679: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129 raeburn 1680: }
1.1430 raeburn 1681: if (($is_balancer) && ($caller ne 'switchserver')) {
1.1176 raeburn 1682: my $lowest_load = 30000;
1683: if (ref($offloadto) eq 'HASH') {
1684: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1685: foreach my $try_server (@{$offloadto->{'primary'}}) {
1686: ($otherserver,$lowest_load) =
1687: &compare_server_load($try_server,$otherserver,$lowest_load);
1688: }
1.1129 raeburn 1689: }
1.1176 raeburn 1690: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1691:
1.1176 raeburn 1692: if (!$found_server) {
1693: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1694: foreach my $try_server (@{$offloadto->{'default'}}) {
1695: ($otherserver,$lowest_load) =
1696: &compare_server_load($try_server,$otherserver,$lowest_load);
1697: }
1698: }
1699: }
1700: } elsif (ref($offloadto) eq 'ARRAY') {
1701: if (@{$offloadto} == 1) {
1702: $otherserver = $offloadto->[0];
1703: } elsif (@{$offloadto} > 1) {
1704: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1705: ($otherserver,$lowest_load) =
1706: &compare_server_load($try_server,$otherserver,$lowest_load);
1707: }
1708: }
1709: }
1.1331 raeburn 1710: unless ($caller eq 'login') {
1711: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1712: $is_balancer = 0;
1713: if ($uname ne '' && $udom ne '') {
1714: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1.1389 raeburn 1715: &appenv({'user.loadbalexempt' => $lonhost,
1.1331 raeburn 1716: 'user.loadbalcheck.time' => time});
1717: }
1.1176 raeburn 1718: }
1.1129 raeburn 1719: }
1720: }
1.1430 raeburn 1721: }
1722: if (($is_balancer) && (!$homeintdom)) {
1723: undef($setcookie);
1.1129 raeburn 1724: }
1.1391 raeburn 1725: return ($is_balancer,$otherserver,$setcookie,$offloadto,$dom_balancers);
1.1129 raeburn 1726: }
1727:
1.1191 raeburn 1728: sub check_balancer_result {
1729: my ($result,@hosts) = @_;
1.1391 raeburn 1730: my ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 1731: if (ref($result) eq 'HASH') {
1732: if ($result->{'lonhost'} ne '') {
1733: my $currbalancer = $result->{'lonhost'};
1734: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1735: $is_balancer = 1;
1736: $currtargets = $result->{'targets'};
1737: $currrules = $result->{'rules'};
1738: }
1.1391 raeburn 1739: $dom_balancers = $currbalancer;
1.1191 raeburn 1740: } else {
1.1391 raeburn 1741: if (keys(%{$result})) {
1742: foreach my $key (keys(%{$result})) {
1743: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1744: (ref($result->{$key}) eq 'HASH')) {
1745: $is_balancer = 1;
1746: $currrules = $result->{$key}{'rules'};
1747: $currtargets = $result->{$key}{'targets'};
1748: $setcookie = $result->{$key}{'cookie'};
1749: last;
1750: }
1.1191 raeburn 1751: }
1.1391 raeburn 1752: $dom_balancers = join(',',sort(keys(%{$result})));
1.1191 raeburn 1753: }
1754: }
1755: }
1.1391 raeburn 1756: return ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 1757: }
1758:
1.1129 raeburn 1759: sub get_loadbalancer_targets {
1760: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1761: my $offloadto;
1.1175 raeburn 1762: if ($rule_in_effect eq 'none') {
1763: return [$perlvar{'lonHostID'}];
1764: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1765: $offloadto = $currtargets;
1766: } else {
1767: if ($rule_in_effect eq 'homeserver') {
1768: my $homeserver = &homeserver($uname,$udom);
1769: if ($homeserver ne 'no_host') {
1770: $offloadto = [$homeserver];
1771: }
1772: } elsif ($rule_in_effect eq 'externalbalancer') {
1773: my %domconfig =
1774: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1775: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1776: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1777: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1778: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1779: }
1780: }
1781: } else {
1.1178 raeburn 1782: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1783: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1784: if (&hostname($remotebalancer) ne '') {
1785: $offloadto = [$remotebalancer];
1786: }
1787: }
1788: } elsif (&hostname($rule_in_effect) ne '') {
1789: $offloadto = [$rule_in_effect];
1790: }
1791: }
1792: return $offloadto;
1793: }
1794:
1.1127 raeburn 1795: sub internet_dom_servers {
1796: my ($dom) = @_;
1797: my (%uniqservers,%servers);
1798: my $primaryserver = &hostname(&domain($dom,'primary'));
1799: my @machinedoms = &machine_domains($primaryserver);
1800: foreach my $mdom (@machinedoms) {
1801: my %currservers = %servers;
1802: my %server = &get_servers($mdom);
1803: %servers = (%currservers,%server);
1804: }
1805: my %by_hostname;
1806: foreach my $id (keys(%servers)) {
1807: push(@{$by_hostname{$servers{$id}}},$id);
1808: }
1809: foreach my $hostname (sort(keys(%by_hostname))) {
1810: if (@{$by_hostname{$hostname}} > 1) {
1811: my $match = 0;
1812: foreach my $id (@{$by_hostname{$hostname}}) {
1813: if (&host_domain($id) eq $dom) {
1814: $uniqservers{$id} = $hostname;
1815: $match = 1;
1816: }
1817: }
1818: unless ($match) {
1819: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1820: }
1821: } else {
1822: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1823: }
1824: }
1825: return %uniqservers;
1826: }
1827:
1.1347 raeburn 1828: sub trusted_domains {
1829: my ($cmdtype,$calldom) = @_;
1.1349 raeburn 1830: my ($trusted,$untrusted);
1.1347 raeburn 1831: if (&domain($calldom) eq '') {
1.1349 raeburn 1832: return ($trusted,$untrusted);
1.1347 raeburn 1833: }
1.1395 raeburn 1834: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|othcoau|domroles|catalog|reqcrs|msg)$/) {
1.1349 raeburn 1835: return ($trusted,$untrusted);
1.1347 raeburn 1836: }
1837: my $callprimary = &domain($calldom,'primary');
1838: my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
1839: if ($intcalldom eq '') {
1.1349 raeburn 1840: return ($trusted,$untrusted);
1.1347 raeburn 1841: }
1842:
1843: my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
1844: unless (defined($cached)) {
1845: my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
1846: &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1847: $trustconfig = $domconfig{'trust'};
1848: }
1849: if (ref($trustconfig)) {
1850: my (%possexc,%possinc,@allexc,@allinc);
1851: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1852: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1853: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1854: }
1855: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1.1395 raeburn 1856: $possinc{$intcalldom} = 1;
1.1347 raeburn 1857: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1858: }
1859: }
1860: if (keys(%possexc)) {
1861: if (keys(%possinc)) {
1862: foreach my $key (sort(keys(%possexc))) {
1863: next if ($key eq $intcalldom);
1864: unless ($possinc{$key}) {
1865: push(@allexc,$key);
1866: }
1867: }
1868: } else {
1869: @allexc = sort(keys(%possexc));
1870: }
1871: }
1872: if (keys(%possinc)) {
1873: $possinc{$intcalldom} = 1;
1874: @allinc = sort(keys(%possinc));
1875: }
1876: if ((@allexc > 0) || (@allinc > 0)) {
1877: my %doms_by_intdom;
1878: my %allintdoms = &all_host_intdom();
1879: my %alldoms = &all_host_domain();
1880: foreach my $key (%allintdoms) {
1881: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1882: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1883: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1884: }
1885: } else {
1886: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1887: }
1888: }
1889: foreach my $exc (@allexc) {
1890: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1.1395 raeburn 1891: push(@{$untrusted},@{$doms_by_intdom{$exc}});
1.1347 raeburn 1892: }
1893: }
1894: foreach my $inc (@allinc) {
1895: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1.1395 raeburn 1896: push(@{$trusted},@{$doms_by_intdom{$inc}});
1.1347 raeburn 1897: }
1898: }
1899: }
1900: }
1.1349 raeburn 1901: return ($trusted,$untrusted);
1.1347 raeburn 1902: }
1903:
1904: sub will_trust {
1905: my ($cmdtype,$domain,$possdom) = @_;
1906: return 1 if ($domain eq $possdom);
1907: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1908: my $willtrust;
1909: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1910: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1911: $willtrust = 1;
1912: }
1913: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1914: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1915: $willtrust = 1;
1916: }
1917: } else {
1918: $willtrust = 1;
1919: }
1920: return $willtrust;
1921: }
1922:
1.1 albertel 1923: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1924:
1.599 albertel 1925: my %homecache;
1.1 albertel 1926: sub homeserver {
1.230 stredwic 1927: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1928: my $index="$uname:$udom";
1.426 albertel 1929:
1.599 albertel 1930: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1931:
1932: my %servers = &get_servers($udom,'library');
1933: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1934: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1935: exists($badServerCache{$tryserver}));
1.841 albertel 1936:
1937: my $answer=reply("home:$udom:$uname",$tryserver);
1938: if ($answer eq 'found') {
1939: delete($badServerCache{$tryserver});
1940: return $homecache{$index}=$tryserver;
1941: } elsif ($answer eq 'no_host') {
1942: $badServerCache{$tryserver}=1;
1943: }
1.1 albertel 1944: }
1945: return 'no_host';
1.70 www 1946: }
1947:
1.1300 raeburn 1948: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1.70 www 1949:
1950: sub idget {
1.1300 raeburn 1951: my ($udom,$idsref,$namespace)=@_;
1.70 www 1952: my %returnhash=();
1.1300 raeburn 1953: my @ids=();
1954: if (ref($idsref) eq 'ARRAY') {
1955: @ids = @{$idsref};
1956: } else {
1957: return %returnhash;
1958: }
1959: if ($namespace eq '') {
1960: $namespace = 'ids';
1961: }
1.70 www 1962:
1.841 albertel 1963: my %servers = &get_servers($udom,'library');
1964: foreach my $tryserver (keys(%servers)) {
1.1299 raeburn 1965: my $idlist=join('&', map { &escape($_); } @ids);
1.1300 raeburn 1966: if ($namespace eq 'ids') {
1967: $idlist=~tr/A-Z/a-z/;
1968: }
1969: my $reply;
1970: if ($namespace eq 'ids') {
1971: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1972: } else {
1973: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1974: }
1.841 albertel 1975: my @answer=();
1976: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1977: @answer=split(/\&/,$reply);
1978: } ;
1979: my $i;
1980: for ($i=0;$i<=$#ids;$i++) {
1981: if ($answer[$i]) {
1.1299 raeburn 1982: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1.1300 raeburn 1983: }
1.841 albertel 1984: }
1.1300 raeburn 1985: }
1.70 www 1986: return %returnhash;
1987: }
1988:
1989: # ------------------------------------- Find the IDs behind a list of usernames
1990:
1991: sub idrget {
1992: my ($udom,@unames)=@_;
1993: my %returnhash=();
1.800 albertel 1994: foreach my $uname (@unames) {
1995: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1996: }
1.70 www 1997: return %returnhash;
1998: }
1999:
1.1300 raeburn 2000: # Store away a list of names and associated student/employee IDs or clicker IDs
1.70 www 2001:
2002: sub idput {
1.1300 raeburn 2003: my ($udom,$idsref,$uhom,$namespace)=@_;
1.70 www 2004: my %servers=();
1.1300 raeburn 2005: my %ids=();
2006: my %byid = ();
2007: if (ref($idsref) eq 'HASH') {
2008: %ids=%{$idsref};
2009: }
2010: if ($namespace eq '') {
2011: $namespace = 'ids';
2012: }
1.800 albertel 2013: foreach my $uname (keys(%ids)) {
2014: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1.1300 raeburn 2015: if ($uhom eq '') {
2016: $uhom=&homeserver($uname,$udom);
2017: }
1.70 www 2018: if ($uhom ne 'no_host') {
1.800 albertel 2019: my $esc_unam=&escape($uname);
1.1300 raeburn 2020: if ($namespace eq 'ids') {
2021: my $id=&escape($ids{$uname});
2022: $id=~tr/A-Z/a-z/;
2023: my $esc_unam=&escape($uname);
2024: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1.70 www 2025: } else {
1.1300 raeburn 2026: my @currids = split(/,/,$ids{$uname});
2027: foreach my $id (@currids) {
2028: $byid{$uhom}{$id} .= $uname.',';
2029: }
2030: }
2031: }
2032: }
2033: if ($namespace eq 'clickers') {
2034: foreach my $server (keys(%byid)) {
2035: if (ref($byid{$server}) eq 'HASH') {
2036: foreach my $id (keys(%{$byid{$server}})) {
2037: $byid{$server} =~ s/,$//;
2038: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
2039: }
1.70 www 2040: }
2041: }
1.191 harris41 2042: }
1.800 albertel 2043: foreach my $server (keys(%servers)) {
1.1300 raeburn 2044: $servers{$server} =~ s/\&$//;
2045: if ($namespace eq 'ids') {
2046: &critical('idput:'.$udom.':'.$servers{$server},$server);
2047: } else {
2048: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
2049: }
1.191 harris41 2050: }
1.344 www 2051: }
2052:
1.1300 raeburn 2053: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1.1231 raeburn 2054:
2055: sub iddel {
1.1300 raeburn 2056: my ($udom,$idshashref,$uhome,$namespace)=@_;
1.1231 raeburn 2057: my %result=();
1.1300 raeburn 2058: my %ids=();
2059: my %byid = ();
2060: if (ref($idshashref) eq 'HASH') {
2061: %ids=%{$idshashref};
2062: } else {
1.1231 raeburn 2063: return %result;
2064: }
1.1300 raeburn 2065: if ($namespace eq '') {
2066: $namespace = 'ids';
2067: }
1.1231 raeburn 2068: my %servers=();
1.1300 raeburn 2069: while (my ($id,$unamestr) = each(%ids)) {
2070: if ($namespace eq 'ids') {
2071: my $uhom = $uhome;
2072: if ($uhom eq '') {
2073: $uhom=&homeserver($unamestr,$udom);
2074: }
2075: if ($uhom ne 'no_host') {
2076: $servers{$uhom}.='&'.&escape($id);
2077: }
2078: } else {
2079: my @curritems = split(/,/,$ids{$id});
2080: foreach my $uname (@curritems) {
2081: my $uhom = $uhome;
2082: if ($uhom eq '') {
2083: $uhom=&homeserver($uname,$udom);
2084: }
2085: if ($uhom ne 'no_host') {
2086: $byid{$uhom}{$id} .= $uname.',';
2087: }
2088: }
1.1231 raeburn 2089: }
1.1300 raeburn 2090: }
2091: if ($namespace eq 'clickers') {
2092: foreach my $server (keys(%byid)) {
2093: if (ref($byid{$server}) eq 'HASH') {
2094: foreach my $id (keys(%{$byid{$server}})) {
2095: $byid{$server}{$id} =~ s/,$//;
2096: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
2097: }
1.1231 raeburn 2098: }
2099: }
2100: }
2101: foreach my $server (keys(%servers)) {
1.1300 raeburn 2102: $servers{$server} =~ s/\&$//;
2103: if ($namespace eq 'ids') {
2104: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
2105: } elsif ($namespace eq 'clickers') {
2106: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
2107: }
1.1231 raeburn 2108: }
2109: return %result;
2110: }
2111:
1.1300 raeburn 2112: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
2113:
2114: sub updateclickers {
2115: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
2116: my %clickers;
2117: if (ref($idshashref) eq 'HASH') {
2118: %clickers=%{$idshashref};
2119: } else {
2120: return;
2121: }
2122: my $items='';
2123: foreach my $item (keys(%clickers)) {
2124: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
2125: }
2126: $items=~s/\&$//;
2127: my $request = "updateclickers:$udom:$action:$items";
2128: if ($critical) {
2129: return &critical($request,$uhome);
2130: } else {
2131: return &reply($request,$uhome);
2132: }
2133: }
2134:
1.1023 raeburn 2135: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 2136: sub dump_dom {
1.1165 droeschl 2137: my ($namespace, $udom, $regexp) = @_;
2138:
2139: $udom ||= $env{'user.domain'};
2140:
2141: return () unless $udom;
2142:
2143: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 2144: }
2145:
1.1023 raeburn 2146: # ------------------------------------------ get items from domain db files
1.806 raeburn 2147:
2148: sub get_dom {
1.860 raeburn 2149: my ($namespace,$storearr,$udom,$uhome)=@_;
1.1267 raeburn 2150: return if ($udom eq 'public');
1.806 raeburn 2151: my $items='';
2152: foreach my $item (@$storearr) {
2153: $items.=&escape($item).'&';
2154: }
2155: $items=~s/\&$//;
1.860 raeburn 2156: if (!$udom) {
2157: $udom=$env{'user.domain'};
1.1267 raeburn 2158: return if ($udom eq 'public');
1.860 raeburn 2159: if (defined(&domain($udom,'primary'))) {
2160: $uhome=&domain($udom,'primary');
2161: } else {
1.874 albertel 2162: undef($uhome);
1.860 raeburn 2163: }
2164: } else {
2165: if (!$uhome) {
2166: if (defined(&domain($udom,'primary'))) {
2167: $uhome=&domain($udom,'primary');
2168: }
2169: }
2170: }
2171: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.1344 raeburn 2172: my $rep;
1.1442 raeburn 2173: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
2174: # domain information is hosted on this machine
2175: my $cmd = 'getdom';
2176: if ($namespace =~ /^enc/) {
2177: $cmd = 'egetdom';
2178: }
2179: $rep = &LONCAPA::Lond::get_dom("$cmd:$udom:$namespace:$items");
1.1344 raeburn 2180: } else {
1.1442 raeburn 2181: if ($namespace =~ /^enc/) {
2182: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
2183: } else {
2184: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
2185: }
1.1344 raeburn 2186: }
1.866 raeburn 2187: my %returnhash;
1.875 albertel 2188: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 2189: return %returnhash;
2190: }
1.806 raeburn 2191: my @pairs=split(/\&/,$rep);
2192: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2193: return @pairs;
2194: }
2195: my $i=0;
2196: foreach my $item (@$storearr) {
2197: $returnhash{$item}=&thaw_unescape($pairs[$i]);
2198: $i++;
2199: }
2200: return %returnhash;
2201: } else {
1.880 banghart 2202: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 2203: }
2204: }
2205:
2206: # -------------------------------------------- put items in domain db files
2207:
2208: sub put_dom {
1.860 raeburn 2209: my ($namespace,$storehash,$udom,$uhome)=@_;
2210: if (!$udom) {
2211: $udom=$env{'user.domain'};
2212: if (defined(&domain($udom,'primary'))) {
2213: $uhome=&domain($udom,'primary');
2214: } else {
1.874 albertel 2215: undef($uhome);
1.860 raeburn 2216: }
2217: } else {
2218: if (!$uhome) {
2219: if (defined(&domain($udom,'primary'))) {
2220: $uhome=&domain($udom,'primary');
2221: }
2222: }
2223: }
2224: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 2225: my $items='';
2226: foreach my $item (keys(%$storehash)) {
2227: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2228: }
2229: $items=~s/\&$//;
1.1344 raeburn 2230: if ($namespace =~ /^enc/) {
2231: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2232: } else {
2233: return &reply("putdom:$udom:$namespace:$items",$uhome);
2234: }
1.806 raeburn 2235: } else {
1.860 raeburn 2236: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 2237: }
2238: }
2239:
1.1023 raeburn 2240: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 2241: sub newput_dom {
1.1023 raeburn 2242: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 2243: my $result;
2244: if (!$udom) {
2245: $udom=$env{'user.domain'};
2246: }
1.1023 raeburn 2247: if ($udom) {
2248: my $uname = &get_domainconfiguser($udom);
2249: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 2250: }
2251: return $result;
2252: }
2253:
1.1023 raeburn 2254: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 2255: sub del_dom {
1.1023 raeburn 2256: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 2257: if (ref($storearr) eq 'ARRAY') {
2258: if (!$udom) {
2259: $udom=$env{'user.domain'};
2260: }
1.1023 raeburn 2261: if ($udom) {
2262: my $uname = &get_domainconfiguser($udom);
2263: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 2264: }
2265: }
2266: }
2267:
1.1023 raeburn 2268: # ----------------------------------construct domainconfig user for a domain
2269: sub get_domainconfiguser {
2270: my ($udom) = @_;
2271: return $udom.'-domainconfig';
2272: }
2273:
1.837 raeburn 2274: sub retrieve_inst_usertypes {
2275: my ($udom) = @_;
2276: my (%returnhash,@order);
1.989 raeburn 2277: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
2278: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2279: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256 raeburn 2280: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 2281: } else {
2282: if (defined(&domain($udom,'primary'))) {
2283: my $uhome=&domain($udom,'primary');
2284: my $rep=&reply("inst_usertypes:$udom",$uhome);
2285: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1256 raeburn 2286: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 2287: return (\%returnhash,\@order);
2288: }
2289: my ($hashitems,$orderitems) = split(/:/,$rep);
2290: my @pairs=split(/\&/,$hashitems);
2291: foreach my $item (@pairs) {
2292: my ($key,$value)=split(/=/,$item,2);
2293: $key = &unescape($key);
2294: next if ($key =~ /^error: 2 /);
2295: $returnhash{$key}=&thaw_unescape($value);
2296: }
2297: my @esc_order = split(/\&/,$orderitems);
2298: foreach my $item (@esc_order) {
2299: push(@order,&unescape($item));
2300: }
2301: } else {
1.1256 raeburn 2302: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 2303: }
1.1256 raeburn 2304: return (\%returnhash,\@order);
1.837 raeburn 2305: }
2306: }
2307:
1.868 raeburn 2308: sub is_domainimage {
2309: my ($url) = @_;
1.1306 raeburn 2310: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1.868 raeburn 2311: if (&domain($1) ne '') {
2312: return '1';
2313: }
2314: }
2315: return;
2316: }
2317:
1.899 raeburn 2318: sub inst_directory_query {
2319: my ($srch) = @_;
2320: my $udom = $srch->{'srchdomain'};
2321: my %results;
2322: my $homeserver = &domain($udom,'primary');
1.909 raeburn 2323: my $outcome;
1.899 raeburn 2324: if ($homeserver ne '') {
1.1357 raeburn 2325: unless ($homeserver eq $perlvar{'lonHostID'}) {
2326: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2327: my $lcrev = &get_server_loncaparev($udom,$homeserver);
1.1357 raeburn 2328: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2329: if (($major eq '' && $minor eq '') || ($major < 2) ||
2330: (($major == 2) && ($minor < 12))) {
2331: return;
2332: }
2333: }
2334: }
1.904 albertel 2335: my $queryid=&reply("querysend:instdirsearch:".
2336: &escape($srch->{'srchby'}).':'.
2337: &escape($srch->{'srchterm'}).':'.
2338: &escape($srch->{'srchtype'}),$homeserver);
2339: my $host=&hostname($homeserver);
2340: if ($queryid !~/^\Q$host\E\_/) {
1.1343 raeburn 2341: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
1.904 albertel 2342: return;
2343: }
2344: my $response = &get_query_reply($queryid);
2345: my $maxtries = 5;
2346: my $tries = 1;
2347: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2348: $response = &get_query_reply($queryid);
2349: $tries ++;
2350: }
2351:
2352: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 2353: if ($response eq 'unavailable') {
2354: $outcome = $response;
2355: } else {
2356: $outcome = 'ok';
2357: my @matches = split(/\n/,$response);
2358: foreach my $match (@matches) {
2359: my ($key,$value) = split(/=/,$match);
2360: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2361: }
1.899 raeburn 2362: }
2363: }
2364: }
1.909 raeburn 2365: return ($outcome,%results);
1.899 raeburn 2366: }
2367:
2368: sub usersearch {
2369: my ($srch) = @_;
2370: my $dom = $srch->{'srchdomain'};
2371: my %results;
2372: my %libserv = &all_library();
2373: my $query = 'usersearch';
2374: foreach my $tryserver (keys(%libserv)) {
2375: if (&host_domain($tryserver) eq $dom) {
1.1357 raeburn 2376: unless ($tryserver eq $perlvar{'lonHostID'}) {
2377: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2378: my $lcrev = &get_server_loncaparev($dom,$tryserver);
1.1357 raeburn 2379: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2380: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2381: (($major == 2) && ($minor < 12)));
2382: }
2383: }
1.899 raeburn 2384: my $host=&hostname($tryserver);
2385: my $queryid=
1.911 raeburn 2386: &reply("querysend:".&escape($query).':'.
2387: &escape($srch->{'srchby'}).':'.
1.899 raeburn 2388: &escape($srch->{'srchtype'}).':'.
2389: &escape($srch->{'srchterm'}),$tryserver);
2390: if ($queryid !~/^\Q$host\E\_/) {
2391: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 2392: next;
1.899 raeburn 2393: }
2394: my $reply = &get_query_reply($queryid);
2395: my $maxtries = 1;
2396: my $tries = 1;
2397: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2398: $reply = &get_query_reply($queryid);
2399: $tries ++;
2400: }
2401: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2402: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2403: } else {
1.911 raeburn 2404: my @matches;
2405: if ($reply =~ /\n/) {
2406: @matches = split(/\n/,$reply);
2407: } else {
2408: @matches = split(/\&/,$reply);
2409: }
1.899 raeburn 2410: foreach my $match (@matches) {
2411: my ($uname,$udom,%userhash);
1.911 raeburn 2412: foreach my $entry (split(/:/,$match)) {
2413: my ($key,$value) =
2414: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 2415: $userhash{$key} = $value;
2416: if ($key eq 'username') {
2417: $uname = $value;
2418: } elsif ($key eq 'domain') {
2419: $udom = $value;
1.911 raeburn 2420: }
1.899 raeburn 2421: }
2422: $results{$uname.':'.$udom} = \%userhash;
2423: }
2424: }
2425: }
2426: }
2427: return %results;
2428: }
2429:
1.912 raeburn 2430: sub get_instuser {
2431: my ($udom,$uname,$id) = @_;
2432: my $homeserver = &domain($udom,'primary');
2433: my ($outcome,%results);
2434: if ($homeserver ne '') {
2435: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2436: &escape($id).':'.&escape($udom),$homeserver);
2437: my $host=&hostname($homeserver);
2438: if ($queryid !~/^\Q$host\E\_/) {
2439: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2440: return;
2441: }
2442: my $response = &get_query_reply($queryid);
2443: my $maxtries = 5;
2444: my $tries = 1;
2445: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2446: $response = &get_query_reply($queryid);
2447: $tries ++;
2448: }
2449: if (!&error($response) && $response ne 'refused') {
2450: if ($response eq 'unavailable') {
2451: $outcome = $response;
2452: } else {
2453: $outcome = 'ok';
2454: my @matches = split(/\n/,$response);
2455: foreach my $match (@matches) {
2456: my ($key,$value) = split(/=/,$match);
2457: $results{&unescape($key)} = &thaw_unescape($value);
2458: }
2459: }
2460: }
2461: }
2462: my %userinfo;
2463: if (ref($results{$uname}) eq 'HASH') {
2464: %userinfo = %{$results{$uname}};
2465: }
2466: return ($outcome,%userinfo);
2467: }
2468:
1.1290 raeburn 2469: sub get_multiple_instusers {
2470: my ($udom,$users,$caller) = @_;
2471: my ($outcome,$results);
2472: if (ref($users) eq 'HASH') {
2473: my $count = keys(%{$users});
2474: my $requested = &freeze_escape($users);
2475: my $homeserver = &domain($udom,'primary');
2476: if ($homeserver ne '') {
2477: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2478: my $host=&hostname($homeserver);
2479: if ($queryid !~/^\Q$host\E\_/) {
2480: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2481: ' for host: '.$homeserver.'in domain '.$udom);
2482: return ($outcome,$results);
2483: }
2484: my $response = &get_query_reply($queryid);
2485: my $maxtries = 5;
2486: if ($count > 100) {
2487: $maxtries = 1+int($count/20);
2488: }
2489: my $tries = 1;
2490: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2491: $response = &get_query_reply($queryid);
2492: $tries ++;
2493: }
2494: if ($response eq '') {
2495: $results = {};
2496: foreach my $key (keys(%{$users})) {
2497: my ($uname,$id);
2498: if ($caller eq 'id') {
2499: $id = $key;
2500: } else {
2501: $uname = $key;
2502: }
2503: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1.1291 raeburn 2504: $outcome = $resp;
1.1290 raeburn 2505: if ($resp eq 'ok') {
2506: %{$results} = (%{$results}, %info);
2507: } else {
2508: last;
2509: }
2510: }
2511: } elsif(!&error($response) && ($response ne 'refused')) {
2512: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2513: $outcome = $response;
2514: } else {
1.1291 raeburn 2515: ($outcome,my $userdata) = split(/=/,$response,2);
1.1290 raeburn 2516: if ($outcome eq 'ok') {
2517: $results = &thaw_unescape($userdata);
2518: }
2519: }
2520: }
2521: }
2522: }
2523: return ($outcome,$results);
2524: }
2525:
1.912 raeburn 2526: sub inst_rulecheck {
1.923 raeburn 2527: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 2528: my %returnhash;
2529: if ($udom ne '') {
2530: if (ref($rules) eq 'ARRAY') {
2531: @{$rules} = map {&escape($_);} (@{$rules});
2532: my $rulestr = join(':',@{$rules});
2533: my $homeserver=&domain($udom,'primary');
2534: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2535: my $response;
2536: if ($item eq 'username') {
2537: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2538: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2539: $homeserver));
1.923 raeburn 2540: } elsif ($item eq 'id') {
2541: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2542: ':'.&escape($id).':'.$rulestr,
2543: $homeserver));
1.945 raeburn 2544: } elsif ($item eq 'selfcreate') {
2545: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2546: &escape($udom).':'.&escape($uname).
2547: ':'.$rulestr,$homeserver));
1.923 raeburn 2548: }
1.912 raeburn 2549: if ($response ne 'refused') {
2550: my @pairs=split(/\&/,$response);
2551: foreach my $item (@pairs) {
2552: my ($key,$value)=split(/=/,$item,2);
2553: $key = &unescape($key);
2554: next if ($key =~ /^error: 2 /);
2555: $returnhash{$key}=&thaw_unescape($value);
2556: }
2557: }
2558: }
2559: }
2560: }
2561: return %returnhash;
2562: }
2563:
2564: sub inst_userrules {
1.923 raeburn 2565: my ($udom,$check) = @_;
1.912 raeburn 2566: my (%ruleshash,@ruleorder);
2567: if ($udom ne '') {
2568: my $homeserver=&domain($udom,'primary');
2569: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2570: my $response;
2571: if ($check eq 'id') {
2572: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2573: $homeserver);
1.943 raeburn 2574: } elsif ($check eq 'email') {
2575: $response=&reply('instemailrules:'.&escape($udom),
2576: $homeserver);
1.923 raeburn 2577: } else {
2578: $response=&reply('instuserrules:'.&escape($udom),
2579: $homeserver);
2580: }
1.912 raeburn 2581: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2582: ($response ne 'unknown_cmd') &&
1.912 raeburn 2583: ($response ne 'no_such_host')) {
2584: my ($hashitems,$orderitems) = split(/:/,$response);
2585: my @pairs=split(/\&/,$hashitems);
2586: foreach my $item (@pairs) {
2587: my ($key,$value)=split(/=/,$item,2);
2588: $key = &unescape($key);
2589: next if ($key =~ /^error: 2 /);
2590: $ruleshash{$key}=&thaw_unescape($value);
2591: }
2592: my @esc_order = split(/\&/,$orderitems);
2593: foreach my $item (@esc_order) {
2594: push(@ruleorder,&unescape($item));
2595: }
2596: }
2597: }
2598: }
2599: return (\%ruleshash,\@ruleorder);
2600: }
2601:
1.976 raeburn 2602: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2603:
2604: sub get_domain_defaults {
1.1240 raeburn 2605: my ($domain,$ignore_cache) = @_;
1.1242 raeburn 2606: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2607: my $cachetime = 60*60*24;
1.1240 raeburn 2608: unless ($ignore_cache) {
2609: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2610: if (defined($cached)) {
2611: if (ref($result) eq 'HASH') {
2612: return %{$result};
2613: }
1.943 raeburn 2614: }
2615: }
2616: my %domdefaults;
2617: my %domconfig =
1.989 raeburn 2618: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2619: 'requestcourses','inststatus',
1.1183 raeburn 2620: 'coursedefaults','usersessions',
1.1258 raeburn 2621: 'requestauthor','selfenrollment',
1.1320 raeburn 2622: 'coursecategories','ssl','autoenroll',
1.1434 raeburn 2623: 'trust','helpsettings','wafproxy'],$domain);
1.1305 raeburn 2624: my @coursetypes = ('official','unofficial','community','textbook','placement');
1.943 raeburn 2625: if (ref($domconfig{'defaults'}) eq 'HASH') {
2626: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2627: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2628: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2629: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2630: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2631: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.1340 raeburn 2632: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2633: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2634: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.943 raeburn 2635: } else {
2636: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2637: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2638: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2639: }
1.976 raeburn 2640: if (ref($domconfig{'quotas'}) eq 'HASH') {
2641: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2642: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2643: } else {
2644: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2645: }
1.1177 raeburn 2646: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2647: foreach my $item (@usertools) {
2648: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2649: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2650: }
2651: }
1.1229 raeburn 2652: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2653: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2654: }
1.976 raeburn 2655: }
1.985 raeburn 2656: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1305 raeburn 2657: foreach my $item ('official','unofficial','community','textbook','placement') {
1.985 raeburn 2658: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2659: }
2660: }
1.1183 raeburn 2661: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2662: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2663: }
1.989 raeburn 2664: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256 raeburn 2665: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2666: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2667: }
2668: }
1.1047 raeburn 2669: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2670: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277 raeburn 2671: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2672: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2673: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2674: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2675: }
1.1254 raeburn 2676: foreach my $type (@coursetypes) {
2677: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2678: unless ($type eq 'community') {
2679: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2680: }
2681: }
2682: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2683: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2684: }
1.1277 raeburn 2685: if ($domdefaults{'postsubmit'} eq 'on') {
2686: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2687: $domdefaults{$type.'postsubtimeout'} =
2688: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2689: }
2690: }
1.1230 raeburn 2691: }
1.1286 raeburn 2692: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2693: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2694: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2695: if (@clonecodes) {
2696: $domdefaults{'canclone'} = join('+',@clonecodes);
2697: }
2698: }
2699: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2700: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2701: }
1.1356 raeburn 2702: if ($domconfig{'coursedefaults'}{'texengine'}) {
2703: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
2704: }
1.1047 raeburn 2705: }
1.1073 raeburn 2706: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2707: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2708: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2709: }
2710: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2711: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2712: }
1.1279 raeburn 2713: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2714: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2715: }
1.1440 raeburn 2716: if (ref($domconfig{'usersessions'}{'offloadoth'}) eq 'HASH') {
1.1439 raeburn 2717: $domdefaults{'offloadoth'} = $domconfig{'usersessions'}{'offloadoth'};
2718: }
1.1073 raeburn 2719: }
1.1254 raeburn 2720: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2721: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2722: my @settings = ('types','registered','enroll_dates','access_dates','section',
2723: 'approval','limit');
2724: foreach my $type (@coursetypes) {
2725: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2726: my @mgrdc = ();
2727: foreach my $item (@settings) {
2728: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2729: push(@mgrdc,$item);
2730: }
2731: }
2732: if (@mgrdc) {
2733: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2734: }
2735: }
2736: }
2737: }
2738: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2739: foreach my $type (@coursetypes) {
2740: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2741: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2742: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2743: }
2744: }
2745: }
2746: }
2747: }
1.1258 raeburn 2748: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2749: $domdefaults{'catauth'} = 'std';
2750: $domdefaults{'catunauth'} = 'std';
1.1413 raeburn 2751: if ($domconfig{'coursecategories'}{'auth'}) {
1.1258 raeburn 2752: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2753: }
2754: if ($domconfig{'coursecategories'}{'unauth'}) {
2755: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2756: }
2757: }
1.1315 raeburn 2758: if (ref($domconfig{'ssl'}) eq 'HASH') {
2759: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2760: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2761: }
1.1338 raeburn 2762: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2763: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2764: }
2765: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2766: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
1.1315 raeburn 2767: }
2768: }
1.1320 raeburn 2769: if (ref($domconfig{'trust'}) eq 'HASH') {
2770: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2771: foreach my $prefix (@prefixes) {
2772: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2773: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2774: }
2775: }
2776: }
1.1314 raeburn 2777: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2778: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2779: }
1.1332 raeburn 2780: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2781: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2782: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2783: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2784: }
2785: }
1.1434 raeburn 2786: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
1.1449 raeburn 2787: foreach my $item ('ipheader','trusted','vpnint','vpnext','sslopt') {
1.1434 raeburn 2788: if ($domconfig{'wafproxy'}{$item}) {
2789: $domdefaults{'waf_'.$item} = $domconfig{'wafproxy'}{$item};
2790: }
2791: }
2792: }
1.1219 raeburn 2793: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2794: return %domdefaults;
2795: }
2796:
1.1412 raeburn 2797: sub get_dom_cats {
2798: my ($dom) = @_;
2799: return unless (&domain($dom));
2800: my ($cats,$cached)=&is_cached_new('cats',$dom);
2801: unless (defined($cached)) {
2802: my %domconfig = &get_dom('configuration',['coursecategories'],$dom);
2803: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2804: if (ref($domconfig{'coursecategories'}{'cats'}) eq 'HASH') {
2805: %{$cats} = %{$domconfig{'coursecategories'}{'cats'}};
2806: } else {
2807: $cats = {};
2808: }
2809: } else {
2810: $cats = {};
2811: }
2812: &Apache::lonnet::do_cache_new('cats',$dom,$cats,3600);
2813: }
1.1413 raeburn 2814: return $cats;
2815: }
2816:
2817: sub get_dom_instcats {
2818: my ($dom) = @_;
2819: return unless (&domain($dom));
2820: my ($instcats,$cached)=&is_cached_new('instcats',$dom);
2821: unless (defined($cached)) {
2822: my (%coursecodes,%codes,@codetitles,%cat_titles,%cat_order);
2823: my $totcodes = &retrieve_instcodes(\%coursecodes,$dom);
2824: if ($totcodes > 0) {
2825: my $caller = 'global';
2826: if (&auto_instcode_format($caller,$dom,\%coursecodes,\%codes,
2827: \@codetitles,\%cat_titles,\%cat_order) eq 'ok') {
2828: $instcats = {
2829: codes => \%codes,
2830: codetitles => \@codetitles,
2831: cat_titles => \%cat_titles,
2832: cat_order => \%cat_order,
2833: };
2834: &do_cache_new('instcats',$dom,$instcats,3600);
2835: }
2836: }
2837: }
2838: return $instcats;
2839: }
2840:
2841: sub retrieve_instcodes {
2842: my ($coursecodes,$dom) = @_;
2843: my $totcodes;
2844: my %courses = &courseiddump($dom,'.',1,'.','.','.',undef,undef,'Course');
2845: foreach my $course (keys(%courses)) {
2846: if (ref($courses{$course}) eq 'HASH') {
2847: if ($courses{$course}{'inst_code'} ne '') {
2848: $$coursecodes{$course} = $courses{$course}{'inst_code'};
2849: $totcodes ++;
2850: }
2851: }
2852: }
2853: return $totcodes;
1.1412 raeburn 2854: }
2855:
1.1311 raeburn 2856: sub course_portal_url {
1.1451 raeburn 2857: my ($cnum,$cdom,$r) = @_;
1.1311 raeburn 2858: my $chome = &homeserver($cnum,$cdom);
2859: my $hostname = &hostname($chome);
2860: my $protocol = $protocol{$chome};
2861: $protocol = 'http' if ($protocol ne 'https');
2862: my %domdefaults = &get_domain_defaults($cdom);
2863: my $firsturl;
2864: if ($domdefaults{'portal_def'}) {
2865: $firsturl = $domdefaults{'portal_def'};
2866: } else {
1.1451 raeburn 2867: my $alias = &Apache::lonnet::use_proxy_alias($r,$chome);
2868: $hostname = $alias if ($alias ne '');
1.1311 raeburn 2869: $firsturl = $protocol.'://'.$hostname;
2870: }
2871: return $firsturl;
2872: }
2873:
1.1407 raeburn 2874: # --------------------------------------------- Get domain config for passwords
2875:
2876: sub get_passwdconf {
2877: my ($dom) = @_;
2878: my (%passwdconf,$gotconf,$lookup);
2879: my ($result,$cached)=&is_cached_new('passwdconf',$dom);
2880: if (defined($cached)) {
2881: if (ref($result) eq 'HASH') {
2882: %passwdconf = %{$result};
2883: $gotconf = 1;
2884: }
2885: }
2886: unless ($gotconf) {
2887: my %domconfig = &get_dom('configuration',['passwords'],$dom);
2888: if (ref($domconfig{'passwords'}) eq 'HASH') {
2889: %passwdconf = %{$domconfig{'passwords'}};
2890: }
2891: my $cachetime = 24*60*60;
2892: &do_cache_new('passwdconf',$dom,\%passwdconf,$cachetime);
2893: }
2894: return %passwdconf;
2895: }
2896:
1.344 www 2897: # --------------------------------------------------- Assign a key to a student
2898:
2899: sub assign_access_key {
1.364 www 2900: #
2901: # a valid key looks like uname:udom#comments
2902: # comments are being appended
2903: #
1.498 www 2904: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2905: $kdom=
1.620 albertel 2906: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2907: $knum=
1.620 albertel 2908: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2909: $cdom=
1.620 albertel 2910: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2911: $cnum=
1.620 albertel 2912: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2913: $udom=$env{'user.name'} unless (defined($udom));
2914: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2915: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2916: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2917: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2918: # assigned to this person
2919: # - this should not happen,
1.345 www 2920: # unless something went wrong
2921: # the first time around
2922: # ready to assign
1.364 www 2923: $logentry=$1.'; '.$logentry;
1.496 www 2924: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2925: $kdom,$knum) eq 'ok') {
1.345 www 2926: # key now belongs to user
1.346 www 2927: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2928: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2929: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2930: return 'ok';
2931: } else {
2932: return
2933: 'error: Count not permanently assign key, will need to be re-entered later.';
2934: }
2935: } else {
2936: return 'error: Could not assign key, try again later.';
2937: }
1.364 www 2938: } elsif (!$existing{$ckey}) {
1.345 www 2939: # the key does not exist
2940: return 'error: The key does not exist';
2941: } else {
2942: # the key is somebody else's
2943: return 'error: The key is already in use';
2944: }
1.344 www 2945: }
2946:
1.364 www 2947: # ------------------------------------------ put an additional comment on a key
2948:
2949: sub comment_access_key {
2950: #
2951: # a valid key looks like uname:udom#comments
2952: # comments are being appended
2953: #
2954: my ($ckey,$cdom,$cnum,$logentry)=@_;
2955: $cdom=
1.620 albertel 2956: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2957: $cnum=
1.620 albertel 2958: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2959: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2960: if ($existing{$ckey}) {
2961: $existing{$ckey}.='; '.$logentry;
2962: # ready to assign
1.367 www 2963: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2964: $cdom,$cnum) eq 'ok') {
2965: return 'ok';
2966: } else {
2967: return 'error: Count not store comment.';
2968: }
2969: } else {
2970: # the key does not exist
2971: return 'error: The key does not exist';
2972: }
2973: }
2974:
1.344 www 2975: # ------------------------------------------------------ Generate a set of keys
2976:
2977: sub generate_access_keys {
1.364 www 2978: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2979: $cdom=
1.620 albertel 2980: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2981: $cnum=
1.620 albertel 2982: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2983: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2984: unless (($cdom) && ($cnum)) { return 0; }
2985: if ($number>10000) { return 0; }
2986: sleep(2); # make sure don't get same seed twice
2987: srand(time()^($$+($$<<15))); # from "Programming Perl"
2988: my $total=0;
2989: for (my $i=1;$i<=$number;$i++) {
2990: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2991: sprintf("%lx",int(100000*rand)).'-'.
2992: sprintf("%lx",int(100000*rand));
2993: $newkey=~s/1/g/g; # folks mix up 1 and l
2994: $newkey=~s/0/h/g; # and also 0 and O
2995: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2996: if ($existing{$newkey}) {
2997: $i--;
2998: } else {
1.364 www 2999: if (&put('accesskeys',
3000: { $newkey => '# generated '.localtime().
1.620 albertel 3001: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 3002: '; '.$logentry },
3003: $cdom,$cnum) eq 'ok') {
1.344 www 3004: $total++;
3005: }
3006: }
3007: }
1.620 albertel 3008: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 3009: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
3010: return $total;
3011: }
3012:
3013: # ------------------------------------------------------- Validate an accesskey
3014:
3015: sub validate_access_key {
3016: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
3017: $cdom=
1.620 albertel 3018: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3019: $cnum=
1.620 albertel 3020: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3021: $udom=$env{'user.domain'} unless (defined($udom));
3022: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 3023: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 3024: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 3025: }
3026:
3027: # ------------------------------------- Find the section of student in a course
1.652 albertel 3028: sub devalidate_getsection_cache {
3029: my ($udom,$unam,$courseid)=@_;
3030: my $hashid="$udom:$unam:$courseid";
3031: &devalidate_cache_new('getsection',$hashid);
3032: }
1.298 matthew 3033:
1.815 albertel 3034: sub courseid_to_courseurl {
3035: my ($courseid) = @_;
3036: #already url style courseid
3037: return $courseid if ($courseid =~ m{^/});
3038:
3039: if (exists($env{'course.'.$courseid.'.num'})) {
3040: my $cnum = $env{'course.'.$courseid.'.num'};
3041: my $cdom = $env{'course.'.$courseid.'.domain'};
3042: return "/$cdom/$cnum";
3043: }
3044:
3045: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
3046: if (exists($courseinfo{'num'})) {
3047: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
3048: }
3049:
3050: return undef;
3051: }
3052:
1.298 matthew 3053: sub getsection {
3054: my ($udom,$unam,$courseid)=@_;
1.599 albertel 3055: my $cachetime=1800;
1.551 albertel 3056:
3057: my $hashid="$udom:$unam:$courseid";
1.599 albertel 3058: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 3059: if (defined($cached)) { return $result; }
3060:
1.298 matthew 3061: my %Pending;
3062: my %Expired;
3063: #
3064: # Each role can either have not started yet (pending), be active,
3065: # or have expired.
3066: #
3067: # If there is an active role, we are done.
3068: #
3069: # If there is more than one role which has not started yet,
3070: # choose the one which will start sooner
3071: # If there is one role which has not started yet, return it.
3072: #
3073: # If there is more than one expired role, choose the one which ended last.
3074: # If there is a role which has expired, return it.
3075: #
1.815 albertel 3076: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 3077: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 3078: foreach my $key (keys(%roleshash)) {
1.479 albertel 3079: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 3080: my $section=$1;
3081: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 3082: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 3083: my $now=time;
1.548 albertel 3084: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 3085: $Expired{$end}=$section;
3086: next;
3087: }
1.548 albertel 3088: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 3089: $Pending{$start}=$section;
3090: next;
3091: }
1.599 albertel 3092: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 3093: }
3094: #
3095: # Presumedly there will be few matching roles from the above
3096: # loop and the sorting time will be negligible.
3097: if (scalar(keys(%Pending))) {
3098: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 3099: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 3100: }
3101: if (scalar(keys(%Expired))) {
3102: my @sorted = sort {$a <=> $b} keys(%Expired);
3103: my $time = pop(@sorted);
1.599 albertel 3104: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 3105: }
1.599 albertel 3106: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 3107: }
1.70 www 3108:
1.599 albertel 3109: sub save_cache {
3110: &purge_remembered();
1.722 albertel 3111: #&Apache::loncommon::validate_page();
1.620 albertel 3112: undef(%env);
1.780 albertel 3113: undef($env_loaded);
1.599 albertel 3114: }
1.452 albertel 3115:
1.599 albertel 3116: my $to_remember=-1;
3117: my %remembered;
3118: my %accessed;
3119: my $kicks=0;
3120: my $hits=0;
1.849 albertel 3121: sub make_key {
3122: my ($name,$id) = @_;
1.872 albertel 3123: if (length($id) > 65
3124: && length(&escape($id)) > 200) {
3125: $id=length($id).':'.&Digest::MD5::md5_hex($id);
3126: }
1.849 albertel 3127: return &escape($name.':'.$id);
3128: }
3129:
1.599 albertel 3130: sub devalidate_cache_new {
3131: my ($name,$id,$debug) = @_;
3132: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1319 damieng 3133: my $remembered_id=$name.':'.$id;
1.849 albertel 3134: $id=&make_key($name,$id);
1.599 albertel 3135: $memcache->delete($id);
1.1319 damieng 3136: delete($remembered{$remembered_id});
3137: delete($accessed{$remembered_id});
1.599 albertel 3138: }
3139:
3140: sub is_cached_new {
3141: my ($name,$id,$debug) = @_;
1.1319 damieng 3142: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
3143: if (exists($remembered{$remembered_id})) {
3144: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
3145: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3146: $hits++;
1.1319 damieng 3147: return ($remembered{$remembered_id},1);
1.599 albertel 3148: }
1.1319 damieng 3149: $id=&make_key($name,$id);
1.599 albertel 3150: my $value = $memcache->get($id);
3151: if (!(defined($value))) {
3152: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 3153: return (undef,undef);
1.416 albertel 3154: }
1.599 albertel 3155: if ($value eq '__undef__') {
3156: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
3157: $value=undef;
3158: }
1.1319 damieng 3159: &make_room($remembered_id,$value,$debug);
1.599 albertel 3160: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
3161: return ($value,1);
3162: }
3163:
3164: sub do_cache_new {
3165: my ($name,$id,$value,$time,$debug) = @_;
1.1319 damieng 3166: my $remembered_id=$name.':'.$id;
1.849 albertel 3167: $id=&make_key($name,$id);
1.599 albertel 3168: my $setvalue=$value;
3169: if (!defined($setvalue)) {
3170: $setvalue='__undef__';
3171: }
1.623 albertel 3172: if (!defined($time) ) {
3173: $time=600;
3174: }
1.599 albertel 3175: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 3176: my $result = $memcache->set($id,$setvalue,$time);
3177: if (! $result) {
1.872 albertel 3178: &logthis("caching of id -> $id failed");
1.910 albertel 3179: $memcache->disconnect_all();
1.872 albertel 3180: }
1.600 albertel 3181: # need to make a copy of $value
1.1319 damieng 3182: &make_room($remembered_id,$value,$debug);
1.599 albertel 3183: return $value;
3184: }
3185:
3186: sub make_room {
1.1319 damieng 3187: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 3188:
1.1319 damieng 3189: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 3190: : $value;
1.599 albertel 3191: if ($to_remember<0) { return; }
1.1319 damieng 3192: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3193: if (scalar(keys(%remembered)) <= $to_remember) { return; }
3194: my $to_kick;
3195: my $max_time=0;
3196: foreach my $other (keys(%accessed)) {
3197: if (&tv_interval($accessed{$other}) > $max_time) {
3198: $to_kick=$other;
3199: $max_time=&tv_interval($accessed{$other});
3200: }
3201: }
3202: delete($remembered{$to_kick});
3203: delete($accessed{$to_kick});
3204: $kicks++;
3205: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 3206: return;
3207: }
3208:
1.599 albertel 3209: sub purge_remembered {
1.604 albertel 3210: #&logthis("Tossing ".scalar(keys(%remembered)));
3211: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 3212: undef(%remembered);
3213: undef(%accessed);
1.428 albertel 3214: }
1.70 www 3215: # ------------------------------------- Read an entry from a user's environment
3216:
3217: sub userenvironment {
3218: my ($udom,$unam,@what)=@_;
1.976 raeburn 3219: my $items;
3220: foreach my $item (@what) {
3221: $items.=&escape($item).'&';
3222: }
3223: $items=~s/\&$//;
1.70 www 3224: my %returnhash=();
1.1009 raeburn 3225: my $uhome = &homeserver($unam,$udom);
3226: unless ($uhome eq 'no_host') {
3227: my @answer=split(/\&/,
3228: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 3229: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
3230: return %returnhash;
3231: }
1.1009 raeburn 3232: my $i;
3233: for ($i=0;$i<=$#what;$i++) {
3234: $returnhash{$what[$i]}=&unescape($answer[$i]);
3235: }
1.70 www 3236: }
3237: return %returnhash;
1.1 albertel 3238: }
3239:
1.617 albertel 3240: # ---------------------------------------------------------- Get a studentphoto
3241: sub studentphoto {
3242: my ($udom,$unam,$ext) = @_;
3243: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 3244: if (defined($env{'request.course.id'})) {
1.708 raeburn 3245: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 3246: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
3247: return(&retrievestudentphoto($udom,$unam,$ext));
3248: } else {
3249: my ($result,$perm_reqd)=
1.707 albertel 3250: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 3251: if ($result eq 'ok') {
3252: if (!($perm_reqd eq 'yes')) {
3253: return(&retrievestudentphoto($udom,$unam,$ext));
3254: }
3255: }
3256: }
3257: }
3258: } else {
3259: my ($result,$perm_reqd) =
1.707 albertel 3260: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 3261: if ($result eq 'ok') {
3262: if (!($perm_reqd eq 'yes')) {
3263: return(&retrievestudentphoto($udom,$unam,$ext));
3264: }
3265: }
3266: }
3267: return '/adm/lonKaputt/lonlogo_broken.gif';
3268: }
3269:
3270: sub retrievestudentphoto {
3271: my ($udom,$unam,$ext,$type) = @_;
3272: my $home=&Apache::lonnet::homeserver($unam,$udom);
3273: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
3274: if ($ret eq 'ok') {
3275: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
3276: if ($type eq 'thumbnail') {
3277: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
3278: }
3279: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
3280: return $tokenurl;
3281: } else {
3282: if ($type eq 'thumbnail') {
3283: return '/adm/lonKaputt/genericstudent_tn.gif';
3284: } else {
3285: return '/adm/lonKaputt/lonlogo_broken.gif';
3286: }
1.617 albertel 3287: }
3288: }
3289:
1.263 www 3290: # -------------------------------------------------------------------- New chat
3291:
3292: sub chatsend {
1.724 raeburn 3293: my ($newentry,$anon,$group)=@_;
1.620 albertel 3294: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
3295: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3296: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 3297: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 3298: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 3299: &escape($newentry)).':'.$group,$chome);
1.292 www 3300: }
3301:
3302: # ------------------------------------------ Find current version of a resource
3303:
3304: sub getversion {
3305: my $fname=&clutter(shift);
1.1189 raeburn 3306: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 3307: return ¤tversion(&filelocation('',$fname));
3308: }
3309:
3310: sub currentversion {
3311: my $fname=shift;
3312: my $author=$fname;
3313: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3314: my ($udom,$uname)=split(/\//,$author);
1.1112 www 3315: my $home=&homeserver($uname,$udom);
1.292 www 3316: if ($home eq 'no_host') {
3317: return -1;
3318: }
1.1112 www 3319: my $answer=&reply("currentversion:$fname",$home);
1.292 www 3320: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3321: return -1;
3322: }
1.1112 www 3323: return $answer;
1.263 www 3324: }
3325:
1.1111 www 3326: #
3327: # Return special version number of resource if set by override, empty otherwise
3328: #
3329: sub usedversion {
3330: my $fname=shift;
3331: unless ($fname) { $fname=$env{'request.uri'}; }
3332: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3333: if ($urlversion) { return $urlversion; }
3334: return '';
3335: }
3336:
1.1 albertel 3337: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 3338:
1.1 albertel 3339: sub subscribe {
3340: my $fname=shift;
1.761 raeburn 3341: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 3342: $fname=~s/[\n\r]//g;
1.1 albertel 3343: my $author=$fname;
3344: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3345: my ($udom,$uname)=split(/\//,$author);
3346: my $home=homeserver($uname,$udom);
1.335 albertel 3347: if ($home eq 'no_host') {
3348: return 'not_found';
1.1 albertel 3349: }
3350: my $answer=reply("sub:$fname",$home);
1.64 www 3351: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3352: $answer.=' by '.$home;
3353: }
1.1 albertel 3354: return $answer;
3355: }
3356:
1.8 www 3357: # -------------------------------------------------------------- Replicate file
3358:
3359: sub repcopy {
3360: my $filename=shift;
1.23 www 3361: $filename=~s/\/+/\//g;
1.1142 raeburn 3362: my $londocroot = $perlvar{'lonDocRoot'};
3363: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 3364: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 3365: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3366: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 3367: return &repcopy_userfile($filename);
3368: }
1.532 albertel 3369: $filename=~s/[\n\r]//g;
1.8 www 3370: my $transname="$filename.in.transfer";
1.828 www 3371: # FIXME: this should flock
1.607 raeburn 3372: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 3373: my $remoteurl=subscribe($filename);
1.64 www 3374: if ($remoteurl =~ /^con_lost by/) {
3375: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3376: return 'unavailable';
1.8 www 3377: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 3378: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 3379: return 'not_found';
1.64 www 3380: } elsif ($remoteurl =~ /^rejected by/) {
3381: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3382: return 'forbidden';
1.20 www 3383: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 3384: return 'ok';
1.8 www 3385: } else {
1.290 www 3386: my $author=$filename;
3387: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3388: my ($udom,$uname)=split(/\//,$author);
3389: my $home=homeserver($uname,$udom);
3390: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 3391: my @parts=split(/\//,$filename);
3392: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 3393: if ($path ne "$londocroot/res") {
1.8 www 3394: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 3395: return 'bad_request';
1.8 www 3396: }
3397: my $count;
3398: for ($count=5;$count<$#parts;$count++) {
3399: $path.="/$parts[$count]";
3400: if ((-e $path)!=1) {
3401: mkdir($path,0777);
3402: }
3403: }
3404: my $request=new HTTP::Request('GET',"$remoteurl");
1.1345 raeburn 3405: my $response;
3406: if ($remoteurl =~ m{/raw/}) {
3407: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3408: } else {
3409: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3410: }
1.8 www 3411: if ($response->is_error()) {
3412: unlink($transname);
3413: my $message=$response->status_line;
1.672 albertel 3414: &logthis("<font color=\"blue\">WARNING:"
1.12 www 3415: ." LWP get: $message: $filename</font>");
1.607 raeburn 3416: return 'unavailable';
1.8 www 3417: } else {
1.16 www 3418: if ($remoteurl!~/\.meta$/) {
3419: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1.1345 raeburn 3420: my $mresponse;
3421: if ($remoteurl =~ m{/raw/}) {
3422: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3423: } else {
3424: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3425: }
1.16 www 3426: if ($mresponse->is_error()) {
3427: unlink($filename.'.meta');
3428: &logthis(
1.672 albertel 3429: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 3430: }
3431: }
1.8 www 3432: rename($transname,$filename);
1.607 raeburn 3433: return 'ok';
1.8 www 3434: }
1.290 www 3435: }
1.8 www 3436: }
1.330 www 3437: }
3438:
1.1422 raeburn 3439: # ------------------------------------------------- Unsubscribe from a resource
3440:
3441: sub unsubscribe {
3442: my ($fname) = @_;
3443: my $answer;
3444: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return $answer; }
3445: $fname=~s/[\n\r]//g;
3446: my $author=$fname;
3447: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3448: my ($udom,$uname)=split(/\//,$author);
3449: my $home=homeserver($uname,$udom);
3450: if ($home eq 'no_host') {
3451: $answer = 'no_host';
3452: } elsif (grep { $_ eq $home } ¤t_machine_ids()) {
3453: $answer = 'home';
3454: } else {
3455: my $defdom = $perlvar{'lonDefDomain'};
3456: if (&will_trust('content',$defdom,$udom)) {
3457: $answer = reply("unsub:$fname",$home);
3458: } else {
3459: $answer = 'untrusted';
3460: }
3461: }
3462: return $answer;
3463: }
3464:
1.330 www 3465: # ------------------------------------------------ Get server side include body
3466: sub ssi_body {
1.381 albertel 3467: my ($filelink,%form)=@_;
1.606 matthew 3468: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3469: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3470: }
1.953 www 3471: my $output='';
3472: my $response;
1.980 raeburn 3473: if ($filelink=~/^https?\:/) {
1.954 raeburn 3474: ($output,$response)=&externalssi($filelink);
1.953 www 3475: } else {
1.1004 droeschl 3476: $filelink .= $filelink=~/\?/ ? '&' : '?';
3477: $filelink .= 'inhibitmenu=yes';
1.953 www 3478: ($output,$response)=&ssi($filelink,%form);
3479: }
1.778 albertel 3480: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 3481: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 3482: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 3483: if (wantarray) {
3484: return ($output, $response);
3485: } else {
3486: return $output;
3487: }
1.8 www 3488: }
3489:
1.15 www 3490: # --------------------------------------------------------- Server Side Include
3491:
1.782 albertel 3492: sub absolute_url {
1.1447 raeburn 3493: my ($host_name,$unalias,$keep_proto) = @_;
1.782 albertel 3494: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3495: if ($host_name eq '') {
3496: $host_name = $ENV{'SERVER_NAME'};
3497: }
1.1447 raeburn 3498: if ($unalias) {
3499: my $alias = &get_proxy_alias();
3500: if ($alias eq $host_name) {
3501: my $lonhost = $perlvar{'lonHostID'};
3502: my $hostname = &hostname($lonhost);
3503: my $lcproto;
3504: if (($keep_proto) || ($hostname eq '')) {
3505: $lcproto = $protocol;
3506: } else {
3507: $lcproto = $protocol{$lonhost};
3508: $lcproto = 'http' if ($lcproto ne 'https');
3509: $lcproto .= '://';
3510: }
3511: unless ($hostname eq '') {
3512: return $lcproto.$hostname;
3513: }
3514: }
3515: }
1.782 albertel 3516: return $protocol.$host_name;
3517: }
3518:
1.942 foxr 3519: #
3520: # Server side include.
3521: # Parameters:
3522: # fn Possibly encrypted resource name/id.
3523: # form Hash that describes how the rendering should be done
3524: # and other things.
1.944 foxr 3525: # Returns:
1.950 raeburn 3526: # Scalar context: The content of the response.
3527: # Array context: 2 element list of the content and the full response object.
1.942 foxr 3528: #
1.15 www 3529: sub ssi {
3530:
1.944 foxr 3531: my ($fn,%form)=@_;
1.1447 raeburn 3532: my ($host,$request,$response);
3533: $host = &absolute_url('',1);
1.711 albertel 3534:
3535: $form{'no_update_last_known'}=1;
1.895 albertel 3536: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 3537: if (%form) {
1.1447 raeburn 3538: $request=new HTTP::Request('POST',$host.$fn);
1.1272 droeschl 3539: $request->content(join('&',map {
3540: my $name = escape($_);
3541: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3542: ? join("&$name=", map {escape($_) } @{$form{$_}})
3543: : &escape($form{$_}) );
3544: } keys(%form)));
1.23 www 3545: } else {
1.1447 raeburn 3546: $request=new HTTP::Request('GET',$host.$fn);
1.23 www 3547: }
3548:
1.15 www 3549: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1345 raeburn 3550: my $lonhost = $perlvar{'lonHostID'};
1.1385 raeburn 3551: my $islocal;
3552: if (($env{'request.course.id'}) &&
3553: ($form{'grade_courseid'} eq $env{'request.course.id'}) &&
3554: ($form{'grade_username'} ne '') && ($form{'grade_domain'} ne '') &&
3555: ($form{'grade_symb'} ne '') &&
3556: (&Apache::lonnet::allowed('mgr',$env{'request.course.id'}.
3557: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')))) {
3558: $islocal = 1;
3559: }
1.1447 raeburn 3560: $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,
3561: '','','',$islocal);
1.1182 foxr 3562:
1.944 foxr 3563: if (wantarray) {
1.1345 raeburn 3564: return ($response->content, $response);
1.944 foxr 3565: } else {
1.1345 raeburn 3566: return $response->content;
1.942 foxr 3567: }
1.324 www 3568: }
3569:
3570: sub externalssi {
3571: my ($url)=@_;
3572: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 3573: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
1.954 raeburn 3574: if (wantarray) {
3575: return ($response->content, $response);
3576: } else {
3577: return $response->content;
3578: }
1.15 www 3579: }
1.254 www 3580:
1.1354 raeburn 3581:
3582: # If the local copy of a replicated resource is outdated, trigger a
3583: # connection from the homeserver to flush the delayed queue. If no update
3584: # happens, remove local copies of outdated resource (and corresponding
3585: # metadata file).
3586:
1.1352 raeburn 3587: sub remove_stale_resfile {
3588: my ($url) = @_;
1.1354 raeburn 3589: my $removed;
1.1352 raeburn 3590: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3591: my $audom = $1;
3592: my $auname = $2;
1.1353 raeburn 3593: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
1.1352 raeburn 3594: my $homeserver = &homeserver($auname,$audom);
3595: unless (($homeserver eq 'no_host') ||
3596: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3597: my $fname = &filelocation('',$url);
3598: if (-e $fname) {
3599: my $hostname = &hostname($homeserver);
3600: if ($hostname) {
1.1397 raeburn 3601: my $protocol = $protocol{$homeserver};
3602: $protocol = 'http' if ($protocol ne 'https');
1.1352 raeburn 3603: my $uri = &declutter($url);
3604: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3605: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3606: if ($response->is_success()) {
3607: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3608: my $locmodtime = (stat($fname))[9];
3609: if ($locmodtime < $remmodtime) {
1.1354 raeburn 3610: my $stale;
3611: my $answer = &reply('pong',$homeserver);
3612: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3613: sleep(0.2);
3614: $locmodtime = (stat($fname))[9];
3615: if ($locmodtime < $remmodtime) {
3616: my $posstransfer = $fname.'.in.transfer';
3617: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3618: $removed = 1;
3619: } else {
3620: $stale = 1;
3621: }
3622: } else {
3623: $removed = 1;
3624: }
3625: } else {
3626: $stale = 1;
3627: }
3628: if ($stale) {
1.1421 raeburn 3629: if (unlink($fname)) {
3630: if ($uri!~/\.meta$/) {
3631: if (-e $fname.'.meta') {
3632: unlink($fname.'.meta');
3633: }
3634: }
1.1422 raeburn 3635: my $unsubresult = &unsubscribe($fname);
3636: unless ($unsubresult eq 'ok') {
3637: &logthis("no unsub of $fname from $homeserver, reason: $unsubresult");
3638: }
1.1421 raeburn 3639: $removed = 1;
1.1354 raeburn 3640: }
1.1352 raeburn 3641: }
3642: }
3643: }
3644: }
3645: }
3646: }
3647: }
3648: }
1.1354 raeburn 3649: return $removed;
1.1352 raeburn 3650: }
3651:
1.492 albertel 3652: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3653:
3654: sub allowuploaded {
3655: my ($srcurl,$url)=@_;
3656: $url=&clutter(&declutter($url));
3657: my $dir=$url;
3658: $dir=~s/\/[^\/]+$//;
3659: my %httpref=();
3660: my $httpurl=&hreflocation('',$url);
3661: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 3662: &Apache::lonnet::appenv(\%httpref);
1.254 www 3663: }
1.477 raeburn 3664:
1.1193 raeburn 3665: #
3666: # Determine if the current user should be able to edit a particular resource,
3667: # when viewing in course context.
3668: # (a) When viewing resource used to determine if "Edit" item is included in
3669: # Functions.
3670: # (b) When displaying folder contents in course editor, used to determine if
3671: # "Edit" link will be displayed alongside resource.
3672: #
1.1196 raeburn 3673: # input: six args -- filename (decluttered), course number, course domain,
3674: # url, symb (if registered) and group (if this is a group
3675: # item -- e.g., bulletin board, group page etc.).
3676: # output: array of five scalars --
1.1193 raeburn 3677: # $cfile -- url for file editing if editable on current server
3678: # $home -- homeserver of resource (i.e., for author if published,
3679: # or course if uploaded.).
3680: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 3681: # $forceedit -- 1 if icon/link should be to go to edit mode
3682: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 3683: #
3684:
3685: sub can_edit_resource {
1.1194 raeburn 3686: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3687: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3688: #
3689: # For aboutme pages user can only edit his/her own.
3690: #
1.1199 raeburn 3691: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 3692: my ($sdom,$sname) = ($1,$2);
3693: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3694: $home = $env{'user.home'};
3695: $cfile = $resurl;
3696: if ($env{'form.forceedit'}) {
3697: $forceview = 1;
3698: } else {
3699: $forceedit = 1;
3700: }
3701: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3702: } else {
3703: return;
3704: }
3705: }
3706:
3707: if ($env{'request.course.id'}) {
3708: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3709: if ($group ne '') {
3710: # if this is a group homepage or group bulletin board, check group privs
3711: my $allowed = 0;
1.1197 raeburn 3712: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3713: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 3714: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 3715: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3716: $allowed = 1;
3717: }
1.1197 raeburn 3718: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3719: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3720: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 3721: $allowed = 1;
3722: }
3723: }
3724: if ($allowed) {
3725: $home=&homeserver($cnum,$cdom);
3726: if ($env{'form.forceedit'}) {
3727: $forceview = 1;
3728: } else {
3729: $forceedit = 1;
3730: }
3731: $cfile = $resurl;
3732: } else {
3733: return;
3734: }
3735: } else {
1.1208 raeburn 3736: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3737: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3738: return;
3739: }
3740: } elsif (!$crsedit) {
1.1194 raeburn 3741: #
3742: # No edit allowed where CC has switched to student role.
3743: #
3744: return;
3745: }
3746: }
3747: }
3748:
1.1193 raeburn 3749: if ($file ne '') {
3750: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 3751: if (&is_course_upload($file,$cnum,$cdom)) {
3752: $uploaded = 1;
3753: $incourse = 1;
1.1193 raeburn 3754: if ($file =~/\.(htm|html|css|js|txt)$/) {
3755: $cfile = &hreflocation('',$file);
1.1201 raeburn 3756: if ($env{'form.forceedit'}) {
3757: $forceview = 1;
3758: } else {
3759: $forceedit = 1;
3760: }
1.1194 raeburn 3761: }
3762: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3763: $incourse = 1;
3764: if ($env{'form.forceedit'}) {
3765: $forceview = 1;
3766: } else {
3767: $forceedit = 1;
3768: }
3769: $cfile = $resurl;
3770: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3771: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3772: $incourse = 1;
3773: if ($env{'form.forceedit'}) {
3774: $forceview = 1;
3775: } else {
3776: $forceedit = 1;
3777: }
3778: $cfile = $resurl;
1.1199 raeburn 3779: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 3780: $incourse = 1;
3781: $cfile = $resurl.'/smpedit';
1.1199 raeburn 3782: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 3783: $incourse = 1;
1.1199 raeburn 3784: if ($env{'form.forceedit'}) {
3785: $forceview = 1;
3786: } else {
3787: $forceedit = 1;
3788: }
3789: $cfile = $resurl;
1.1419 raeburn 3790: } elsif (($resurl =~ m{^/ext/}) && ($symb ne '')) {
3791: my ($map,$id,$res) = &decode_symb($symb);
3792: if ($map =~ /\.page$/) {
3793: $incourse = 1;
3794: if ($env{'form.forceedit'}) {
3795: $forceview = 1;
3796: $cfile = $map;
3797: } else {
3798: $forceedit = 1;
3799: $cfile = '/adm/wrapper'.$resurl;
3800: }
3801: }
1.1343 raeburn 3802: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3803: $incourse = 1;
3804: if ($env{'form.forceedit'}) {
3805: $forceview = 1;
3806: } else {
3807: $forceedit = 1;
3808: }
3809: $cfile = $resurl;
1.1208 raeburn 3810: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3811: $incourse = 1;
3812: if ($env{'form.forceedit'}) {
3813: $forceview = 1;
3814: } else {
3815: $forceedit = 1;
3816: }
3817: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 3818: }
3819: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3820: my $template = '/res/lib/templates/simpleproblem.problem';
3821: if (&is_on_map($template)) {
3822: $incourse = 1;
3823: $forceview = 1;
3824: $cfile = $template;
1.1193 raeburn 3825: }
1.1199 raeburn 3826: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1418 raeburn 3827: $incourse = 1;
3828: if ($env{'form.forceedit'}) {
3829: $forceview = 1;
3830: } else {
3831: $forceedit = 1;
3832: }
3833: $cfile = $resurl;
1.1343 raeburn 3834: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1298 raeburn 3835: $incourse = 1;
3836: if ($env{'form.forceedit'}) {
3837: $forceview = 1;
3838: } else {
3839: $forceedit = 1;
3840: }
3841: $cfile = $resurl;
1.1199 raeburn 3842: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3843: $incourse = 1;
3844: $forceview = 1;
3845: if ($symb) {
3846: my ($map,$id,$res)=&decode_symb($symb);
3847: $env{'request.symb'} = $symb;
3848: $cfile = &clutter($res);
3849: } else {
3850: $cfile = $env{'form.suppurl'};
1.1298 raeburn 3851: my $escfile = &unescape($cfile);
1.1343 raeburn 3852: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3853: $cfile = '/adm/wrapper'.$escfile;
3854: } else {
3855: $escfile =~ s{^http://}{};
3856: $cfile = &escape("/adm/wrapper/ext/$escfile");
3857: }
1.1199 raeburn 3858: }
1.1234 raeburn 3859: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3860: if ($env{'form.forceedit'}) {
3861: $forceview = 1;
3862: } else {
3863: $forceedit = 1;
3864: }
3865: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 3866: }
3867: }
1.1194 raeburn 3868: if ($uploaded || $incourse) {
3869: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 3870: } elsif ($file !~ m{/$}) {
1.1193 raeburn 3871: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3872: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3873: # Check that the user has permission to edit this resource
3874: my $setpriv = 1;
3875: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3876: if (defined($cfudom)) {
3877: $home=&homeserver($cfuname,$cfudom);
3878: $cfile=$file;
3879: }
3880: }
1.1194 raeburn 3881: if (($cfile ne '') && (!$incourse || $uploaded) &&
3882: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 3883: my @ids=¤t_machine_ids();
3884: unless (grep(/^\Q$home\E$/,@ids)) {
3885: $switchserver=1;
3886: }
3887: }
3888: }
1.1194 raeburn 3889: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 3890: }
3891:
3892: sub is_course_upload {
3893: my ($file,$cnum,$cdom) = @_;
3894: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3895: $uploadpath =~ s{^\/}{};
1.1201 raeburn 3896: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3897: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 3898: return 1;
3899: }
3900: return;
3901: }
3902:
1.1194 raeburn 3903: sub in_course {
1.1195 raeburn 3904: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3905: if ($hideprivileged) {
3906: my $skipuser;
1.1219 raeburn 3907: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3908: my @possdoms = ($cdom);
3909: if ($coursehash{'checkforpriv'}) {
3910: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3911: }
3912: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 3913: $skipuser = 1;
3914: if ($coursehash{'nothideprivileged'}) {
3915: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3916: my $user;
3917: if ($item =~ /:/) {
3918: $user = $item;
3919: } else {
3920: $user = join(':',split(/[\@]/,$item));
3921: }
3922: if ($user eq $uname.':'.$udom) {
3923: undef($skipuser);
3924: last;
3925: }
3926: }
3927: }
3928: if ($skipuser) {
3929: return 0;
3930: }
3931: }
3932: }
1.1194 raeburn 3933: $type ||= 'any';
3934: if (!defined($cdom) || !defined($cnum)) {
3935: my $cid = $env{'request.course.id'};
3936: $cdom = $env{'course.'.$cid.'.domain'};
3937: $cnum = $env{'course.'.$cid.'.num'};
3938: }
3939: my $typesref;
1.1195 raeburn 3940: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 3941: $typesref = ['active','previous','future'];
3942: } elsif ($type eq 'previous' || $type eq 'future') {
3943: $typesref = [$type];
3944: }
3945: my %roles = &get_my_roles($uname,$udom,'userroles',
3946: $typesref,undef,[$cdom]);
3947: my ($tmp) = keys(%roles);
3948: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3949: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3950: if (@course_roles > 0) {
3951: return 1;
3952: }
3953: return 0;
3954: }
3955:
1.478 albertel 3956: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 3957: # input: action, courseID, current domain, intended
1.637 raeburn 3958: # path to file, source of file, instruction to parse file for objects,
3959: # ref to hash for embedded objects,
3960: # ref to hash for codebase of java objects.
1.1095 raeburn 3961: # reference to scalar to accommodate mime type determined
3962: # from File::MMagic if $parser = parse.
1.637 raeburn 3963: #
1.485 raeburn 3964: # output: url to file (if action was uploaddoc),
3965: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 3966: #
1.478 albertel 3967: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3968: # course.
1.477 raeburn 3969: #
1.478 albertel 3970: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3971: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3972: # course's home server.
1.477 raeburn 3973: #
1.478 albertel 3974: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3975: # be copied from $source (current location) to
3976: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3977: # and will then be copied to
3978: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3979: # course's home server.
1.485 raeburn 3980: #
1.481 raeburn 3981: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 3982: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 3983: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3984: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3985: # in course's home server.
1.637 raeburn 3986: #
1.477 raeburn 3987:
3988: sub process_coursefile {
1.1095 raeburn 3989: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3990: $mimetype)=@_;
1.477 raeburn 3991: my $fetchresult;
1.638 albertel 3992: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 3993: if ($action eq 'propagate') {
1.638 albertel 3994: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3995: $home);
1.481 raeburn 3996: } else {
1.477 raeburn 3997: my $fpath = '';
3998: my $fname = $file;
1.478 albertel 3999: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 4000: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 4001: my $filepath = &build_filepath($fpath);
1.481 raeburn 4002: if ($action eq 'copy') {
4003: if ($source eq '') {
4004: $fetchresult = 'no source file';
4005: return $fetchresult;
4006: } else {
4007: my $destination = $filepath.'/'.$fname;
4008: rename($source,$destination);
4009: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4010: $home);
1.481 raeburn 4011: }
4012: } elsif ($action eq 'uploaddoc') {
1.1359 raeburn 4013: open(my $fh,'>',$filepath.'/'.$fname);
1.620 albertel 4014: print $fh $env{'form.'.$source};
1.481 raeburn 4015: close($fh);
1.637 raeburn 4016: if ($parser eq 'parse') {
1.1024 raeburn 4017: my $mm = new File::MMagic;
1.1095 raeburn 4018: my $type = $mm->checktype_filename($filepath.'/'.$fname);
4019: if ($type eq 'text/html') {
1.1024 raeburn 4020: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
4021: unless ($parse_result eq 'ok') {
4022: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
4023: }
1.637 raeburn 4024: }
1.1095 raeburn 4025: if (ref($mimetype)) {
4026: $$mimetype = $type;
4027: }
1.637 raeburn 4028: }
1.477 raeburn 4029: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4030: $home);
1.481 raeburn 4031: if ($fetchresult eq 'ok') {
4032: return '/uploaded/'.$fpath.'/'.$fname;
4033: } else {
4034: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4035: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 4036: return '/adm/notfound.html';
4037: }
1.477 raeburn 4038: }
4039: }
1.485 raeburn 4040: unless ( $fetchresult eq 'ok') {
1.477 raeburn 4041: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4042: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 4043: }
4044: return $fetchresult;
4045: }
4046:
1.637 raeburn 4047: sub build_filepath {
4048: my ($fpath) = @_;
4049: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
4050: unless ($fpath eq '') {
4051: my @parts=split('/',$fpath);
4052: foreach my $part (@parts) {
4053: $filepath.= '/'.$part;
4054: if ((-e $filepath)!=1) {
4055: mkdir($filepath,0777);
4056: }
4057: }
4058: }
4059: return $filepath;
4060: }
4061:
4062: sub store_edited_file {
1.638 albertel 4063: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 4064: my $file = $primary_url;
4065: $file =~ s#^/uploaded/$docudom/$docuname/##;
4066: my $fpath = '';
4067: my $fname = $file;
4068: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
4069: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
4070: my $filepath = &build_filepath($fpath);
1.1359 raeburn 4071: open(my $fh,'>',$filepath.'/'.$fname);
1.637 raeburn 4072: print $fh $content;
4073: close($fh);
1.638 albertel 4074: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 4075: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4076: $home);
1.637 raeburn 4077: if ($$fetchresult eq 'ok') {
4078: return '/uploaded/'.$fpath.'/'.$fname;
4079: } else {
1.638 albertel 4080: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
4081: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 4082: return '/adm/notfound.html';
4083: }
4084: }
4085:
1.531 albertel 4086: sub clean_filename {
1.831 albertel 4087: my ($fname,$args)=@_;
1.315 www 4088: # Replace Windows backslashes by forward slashes
1.257 www 4089: $fname=~s/\\/\//g;
1.831 albertel 4090: if (!$args->{'keep_path'}) {
4091: # Get rid of everything but the actual filename
4092: $fname=~s/^.*\/([^\/]+)$/$1/;
4093: }
1.315 www 4094: # Replace spaces by underscores
4095: $fname=~s/\s+/\_/g;
1.1406 raeburn 4096: # Transliterate non-ascii text to ascii
4097: my $lang = &Apache::lonlocal::current_language();
4098: $fname = &LONCAPA::transliterate::fname_to_ascii($fname,$lang);
1.315 www 4099: # Replace all other weird characters by nothing
1.831 albertel 4100: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 4101: # Replace all .\d. sequences with _\d. so they no longer look like version
4102: # numbers
4103: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.1443 raeburn 4104: # Replace three or more adjacent underscores with one for consistency
4105: # with loncfile::filename_check() so complete url can be extracted by
4106: # lonnet::decode_symb()
4107: $fname=~s/_{3,}/_/g;
1.531 albertel 4108: return $fname;
4109: }
1.1406 raeburn 4110:
1.1051 raeburn 4111: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
4112: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
4113: # image with the same aspect ratio as the original, but with dimensions which do
4114: # not exceed $resizewidth and $resizeheight.
4115:
1.984 neumanie 4116: sub resizeImage {
1.1051 raeburn 4117: my ($img_path,$resizewidth,$resizeheight) = @_;
4118: my $ima = Image::Magick->new;
4119: my $resized;
4120: if (-e $img_path) {
4121: $ima->Read($img_path);
4122: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
4123: my $width = $ima->Get('width');
4124: my $height = $ima->Get('height');
4125: if ($width > $resizewidth) {
4126: my $factor = $width/$resizewidth;
4127: my $newheight = $height/$factor;
4128: $ima->Scale(width=>$resizewidth,height=>$newheight);
4129: $resized = 1;
4130: }
4131: }
4132: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
4133: my $width = $ima->Get('width');
4134: my $height = $ima->Get('height');
4135: if ($height > $resizeheight) {
4136: my $factor = $height/$resizeheight;
4137: my $newwidth = $width/$factor;
4138: $ima->Scale(width=>$newwidth,height=>$resizeheight);
4139: $resized = 1;
4140: }
4141: }
4142: if ($resized) {
4143: $ima->Write($img_path);
4144: }
4145: }
4146: return;
1.977 amueller 4147: }
4148:
1.608 albertel 4149: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 4150: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 4151: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 4152: # $context - possible values: coursedoc, existingfile, overwrite,
1.1401 raeburn 4153: # canceloverwrite, scantron or ''.
1.1090 raeburn 4154: # if 'coursedoc': upload to the current course
4155: # if 'existingfile': write file to tmp/overwrites directory
4156: # if 'canceloverwrite': delete file written to tmp/overwrites directory
4157: # $context is passed as argument to &finishuserfileupload
1.686 albertel 4158: # $subdir - directory in userfile to store the file into
1.1401 raeburn 4159: # $parser - instruction to parse file for objects ($parser = parse) or
4160: # if context is 'scantron', $parser is hashref of csv column mapping
4161: # (e.g.,{ PaperID => 0, LastName => 1, FirstName => 2, ID => 3,
4162: # Section => 4, CODE => 5, FirstQuestion => 9 }).
1.858 raeburn 4163: # $allfiles - reference to hash for embedded objects
4164: # $codebase - reference to hash for codebase of java objects
4165: # $desuname - username for permanent storage of uploaded file
4166: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 4167: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
4168: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 4169: # $resizewidth - width (pixels) to which to resize uploaded image
4170: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 4171: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 4172: # from File::MMagic.
1.858 raeburn 4173: #
1.686 albertel 4174: # output: url of file in userspace, or error: <message>
4175: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 4176:
1.531 albertel 4177: sub userfileupload {
1.1090 raeburn 4178: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 4179: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 4180: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 4181: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 4182: $fname=&clean_filename($fname);
1.1090 raeburn 4183: # See if there is anything left
1.257 www 4184: unless ($fname) { return 'error: no uploaded file'; }
1.1406 raeburn 4185: # If filename now begins with a . prepend unix timestamp _ milliseconds
4186: if ($fname =~ /^\./) {
4187: my ($s,$usec) = &gettimeofday();
4188: while (length($usec) < 6) {
4189: $usec = '0'.$usec;
4190: }
4191: $fname = $s.'_'.substr($usec,0,3).$fname;
4192: }
1.1090 raeburn 4193: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
4194: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
4195: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
4196: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 4197: my $now = time;
1.1090 raeburn 4198: my $filepath;
1.1095 raeburn 4199: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 4200: $filepath = 'tmp/helprequests/'.$now;
4201: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
4202: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
4203: '_'.$env{'user.domain'}.'/pending';
4204: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
4205: my ($docuname,$docudom);
1.1350 raeburn 4206: if ($destudom =~ /^$match_domain$/) {
1.1090 raeburn 4207: $docudom = $destudom;
4208: } else {
4209: $docudom = $env{'user.domain'};
4210: }
1.1350 raeburn 4211: if ($destuname =~ /^$match_username$/) {
1.1090 raeburn 4212: $docuname = $destuname;
4213: } else {
4214: $docuname = $env{'user.name'};
4215: }
4216: if (exists($env{'form.group'})) {
4217: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4218: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4219: }
4220: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
4221: if ($context eq 'canceloverwrite') {
4222: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
4223: if (-e $tempfile) {
4224: my @info = stat($tempfile);
4225: if ($info[9] eq $env{'form.timestamp'}) {
4226: unlink($tempfile);
4227: }
4228: }
4229: return;
1.523 raeburn 4230: }
4231: }
1.1090 raeburn 4232: # Create the directory if not present
1.741 raeburn 4233: my @parts=split(/\//,$filepath);
4234: my $fullpath = $perlvar{'lonDaemons'};
4235: for (my $i=0;$i<@parts;$i++) {
4236: $fullpath .= '/'.$parts[$i];
4237: if ((-e $fullpath)!=1) {
4238: mkdir($fullpath,0777);
4239: }
4240: }
1.1359 raeburn 4241: open(my $fh,'>',$fullpath.'/'.$fname);
1.741 raeburn 4242: print $fh $env{'form.'.$formname};
4243: close($fh);
1.1090 raeburn 4244: if ($context eq 'existingfile') {
4245: my @info = stat($fullpath.'/'.$fname);
4246: return ($fullpath.'/'.$fname,$info[9]);
4247: } else {
4248: return $fullpath.'/'.$fname;
4249: }
1.523 raeburn 4250: }
1.995 raeburn 4251: if ($subdir eq 'scantron') {
4252: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 4253: } else {
1.995 raeburn 4254: $fname="$subdir/$fname";
4255: }
1.1090 raeburn 4256: if ($context eq 'coursedoc') {
1.638 albertel 4257: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4258: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 4259: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 4260: return &finishuserfileupload($docuname,$docudom,
4261: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 4262: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 4263: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 4264: } else {
1.1218 raeburn 4265: if ($env{'form.folder'}) {
4266: $fname=$env{'form.folder'}.'/'.$fname;
4267: }
1.638 albertel 4268: return &process_coursefile('uploaddoc',$docuname,$docudom,
4269: $fname,$formname,$parser,
1.1095 raeburn 4270: $allfiles,$codebase,$mimetype);
1.481 raeburn 4271: }
1.719 banghart 4272: } elsif (defined($destuname)) {
4273: my $docuname=$destuname;
4274: my $docudom=$destudom;
1.860 raeburn 4275: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4276: $parser,$allfiles,$codebase,
1.1051 raeburn 4277: $thumbwidth,$thumbheight,
1.1095 raeburn 4278: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4279: } else {
1.638 albertel 4280: my $docuname=$env{'user.name'};
4281: my $docudom=$env{'user.domain'};
1.1220 raeburn 4282: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 4283: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4284: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4285: }
1.860 raeburn 4286: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4287: $parser,$allfiles,$codebase,
1.1051 raeburn 4288: $thumbwidth,$thumbheight,
1.1095 raeburn 4289: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4290: }
1.271 www 4291: }
4292:
4293: sub finishuserfileupload {
1.860 raeburn 4294: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 4295: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 4296: my $path=$docudom.'/'.$docuname.'/';
1.258 www 4297: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 4298:
1.860 raeburn 4299: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 4300: $file=$fname;
4301: if ($fname=~m|/|) {
4302: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
4303: $path.=$fnamepath.'/';
4304: }
1.259 www 4305: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 4306: my $count;
4307: for ($count=4;$count<=$#parts;$count++) {
4308: $filepath.="/$parts[$count]";
4309: if ((-e $filepath)!=1) {
4310: mkdir($filepath,0777);
4311: }
4312: }
1.984 neumanie 4313:
1.258 www 4314: # Save the file
4315: {
1.1359 raeburn 4316: if (!open(FH,'>',$filepath.'/'.$file)) {
1.701 albertel 4317: &logthis('Failed to create '.$filepath.'/'.$file);
4318: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
4319: return '/adm/notfound.html';
4320: }
1.1090 raeburn 4321: if ($context eq 'overwrite') {
1.1117 foxr 4322: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 4323: my $target = $filepath.'/'.$file;
4324: if (-e $source) {
4325: my @info = stat($source);
4326: if ($info[9] eq $env{'form.timestamp'}) {
4327: unless (&File::Copy::move($source,$target)) {
4328: &logthis('Failed to overwrite '.$filepath.'/'.$file);
4329: return "Moving from $source failed";
4330: }
4331: } else {
4332: return "Temporary file: $source had unexpected date/time for last modification";
4333: }
4334: } else {
4335: return "Temporary file: $source missing";
4336: }
4337: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 4338: &logthis('Failed to write to '.$filepath.'/'.$file);
4339: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
4340: return '/adm/notfound.html';
4341: }
1.570 albertel 4342: close(FH);
1.1051 raeburn 4343: if ($resizewidth && $resizeheight) {
4344: my $mm = new File::MMagic;
4345: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
4346: if ($mime_type =~ m{^image/}) {
4347: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
4348: }
1.977 amueller 4349: }
1.258 www 4350: }
1.1152 raeburn 4351: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
4352: if (ref($mimetype)) {
4353: if ($$mimetype eq '') {
4354: my $mm = new File::MMagic;
4355: my $type = $mm->checktype_filename($filepath.'/'.$file);
4356: $$mimetype = $type;
4357: }
4358: }
4359: }
1.1401 raeburn 4360: if (($context ne 'scantron') && ($parser eq 'parse')) {
1.1152 raeburn 4361: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 4362: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
4363: $allfiles,$codebase);
4364: unless ($parse_result eq 'ok') {
4365: &logthis('Failed to parse '.$filepath.$file.
4366: ' for embedded media: '.$parse_result);
4367: }
1.637 raeburn 4368: }
1.1401 raeburn 4369: } elsif (($context eq 'scantron') && (ref($parser) eq 'HASH')) {
4370: my $format = $env{'form.scantron_format'};
4371: &bubblesheet_converter($docudom,$filepath.'/'.$file,$parser,$format);
1.637 raeburn 4372: }
1.860 raeburn 4373: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
4374: my $input = $filepath.'/'.$file;
4375: my $output = $filepath.'/'.'tn-'.$file;
4376: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1.1359 raeburn 4377: my @args = ('convert','-sample',$thumbsize,$input,$output);
4378: system({$args[0]} @args);
1.860 raeburn 4379: if (-e $filepath.'/'.'tn-'.$file) {
4380: $fetchthumb = 1;
4381: }
4382: }
1.858 raeburn 4383:
1.259 www 4384: # Notify homeserver to grep it
4385: #
1.984 neumanie 4386: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 4387: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 4388: if ($fetchresult eq 'ok') {
1.860 raeburn 4389: if ($fetchthumb) {
4390: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
4391: if ($thumbresult ne 'ok') {
4392: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
4393: $docuhome.': '.$thumbresult);
4394: }
4395: }
1.259 www 4396: #
1.258 www 4397: # Return the URL to it
1.494 albertel 4398: return '/uploaded/'.$path.$file;
1.263 www 4399: } else {
1.494 albertel 4400: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
4401: ': '.$fetchresult);
1.263 www 4402: return '/adm/notfound.html';
1.858 raeburn 4403: }
1.493 albertel 4404: }
4405:
1.637 raeburn 4406: sub extract_embedded_items {
1.961 raeburn 4407: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 4408: my @state = ();
1.1164 raeburn 4409: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 4410: my %javafiles = (
4411: codebase => '',
4412: code => '',
4413: archive => ''
4414: );
4415: my %mediafiles = (
4416: src => '',
4417: movie => '',
4418: );
1.648 raeburn 4419: my $p;
4420: if ($content) {
4421: $p = HTML::LCParser->new($content);
4422: } else {
1.961 raeburn 4423: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 4424: }
1.641 albertel 4425: while (my $t=$p->get_token()) {
1.640 albertel 4426: if ($t->[0] eq 'S') {
4427: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 4428: push(@state, $tagname);
1.648 raeburn 4429: if (lc($tagname) eq 'allow') {
4430: &add_filetype($allfiles,$attr->{'src'},'src');
4431: }
1.640 albertel 4432: if (lc($tagname) eq 'img') {
4433: &add_filetype($allfiles,$attr->{'src'},'src');
4434: }
1.886 albertel 4435: if (lc($tagname) eq 'a') {
1.1222 raeburn 4436: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 4437: &add_filetype($allfiles,$attr->{'href'},'href');
4438: }
1.886 albertel 4439: }
1.645 raeburn 4440: if (lc($tagname) eq 'script') {
1.1164 raeburn 4441: my $src;
1.645 raeburn 4442: if ($attr->{'archive'} =~ /\.jar$/i) {
4443: &add_filetype($allfiles,$attr->{'archive'},'archive');
4444: } else {
1.1164 raeburn 4445: if ($attr->{'src'} ne '') {
4446: $src = $attr->{'src'};
4447: &add_filetype($allfiles,$src,'src');
4448: }
4449: }
4450: my $text = $p->get_trimmed_text();
4451: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4452: my @swfargs = split(/,/,$1);
4453: foreach my $item (@swfargs) {
4454: $item =~ s/["']//g;
4455: $item =~ s/^\s+//;
4456: $item =~ s/\s+$//;
4457: }
4458: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4459: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4460: push(@{$related{$swfargs[0]}},$swfargs[2]);
4461: } else {
4462: $related{$swfargs[0]} = [$swfargs[2]];
4463: }
4464: }
1.645 raeburn 4465: }
4466: }
4467: if (lc($tagname) eq 'link') {
4468: if (lc($attr->{'rel'}) eq 'stylesheet') {
4469: &add_filetype($allfiles,$attr->{'href'},'href');
4470: }
4471: }
1.640 albertel 4472: if (lc($tagname) eq 'object' ||
4473: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4474: foreach my $item (keys(%javafiles)) {
4475: $javafiles{$item} = '';
4476: }
1.1164 raeburn 4477: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4478: $lastids{lc($tagname)} = $attr->{'id'};
4479: }
1.640 albertel 4480: }
4481: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4482: my $name = lc($attr->{'name'});
4483: foreach my $item (keys(%javafiles)) {
4484: if ($name eq $item) {
4485: $javafiles{$item} = $attr->{'value'};
4486: last;
4487: }
4488: }
1.1164 raeburn 4489: my $pathfrom;
1.640 albertel 4490: foreach my $item (keys(%mediafiles)) {
4491: if ($name eq $item) {
1.1164 raeburn 4492: $pathfrom = $attr->{'value'};
4493: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4494: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 4495: last;
4496: }
4497: }
1.1164 raeburn 4498: if ($name eq 'flashvars') {
4499: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4500: }
4501: if ($pathfrom ne '') {
4502: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4503: $pathfrom);
4504: }
1.640 albertel 4505: }
4506: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4507: foreach my $item (keys(%javafiles)) {
4508: if ($attr->{$item}) {
4509: $javafiles{$item} = $attr->{$item};
4510: last;
4511: }
4512: }
4513: foreach my $item (keys(%mediafiles)) {
4514: if ($attr->{$item}) {
4515: &add_filetype($allfiles,$attr->{$item},$item);
4516: last;
4517: }
4518: }
1.1164 raeburn 4519: if (lc($tagname) eq 'embed') {
4520: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4521: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4522: $attr->{'src'});
4523: }
4524: }
1.640 albertel 4525: }
1.1243 raeburn 4526: if (lc($tagname) eq 'iframe') {
4527: my $src = $attr->{'src'} ;
4528: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4529: &add_filetype($allfiles,$src,'src');
4530: } elsif ($src =~ m{^/}) {
4531: if ($env{'request.course.id'}) {
4532: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4533: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4534: my $url = &hreflocation('',$fullpath);
4535: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4536: my $relpath = $1;
4537: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4538: &add_filetype($allfiles,$1,'src');
4539: }
4540: }
4541: }
4542: }
4543: }
1.1164 raeburn 4544: if ($t->[4] =~ m{/>$}) {
1.1243 raeburn 4545: pop(@state);
1.1164 raeburn 4546: }
1.640 albertel 4547: } elsif ($t->[0] eq 'E') {
4548: my ($tagname) = ($t->[1]);
4549: if ($javafiles{'codebase'} ne '') {
4550: $javafiles{'codebase'} .= '/';
4551: }
4552: if (lc($tagname) eq 'applet' ||
4553: lc($tagname) eq 'object' ||
4554: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4555: ) {
4556: foreach my $item (keys(%javafiles)) {
4557: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4558: my $file=$javafiles{'codebase'}.$javafiles{$item};
4559: &add_filetype($allfiles,$file,$item);
4560: }
4561: }
4562: }
4563: pop @state;
4564: }
4565: }
1.1164 raeburn 4566: foreach my $id (sort(keys(%flashvars))) {
4567: if ($shockwave{$id} ne '') {
4568: my @pairs = split(/\&/,$flashvars{$id});
4569: foreach my $pair (@pairs) {
4570: my ($key,$value) = split(/\=/,$pair);
4571: if ($key eq 'thumb') {
4572: &add_filetype($allfiles,$value,$key);
4573: } elsif ($key eq 'content') {
4574: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4575: my ($ext) = ($value =~ /\.([^.]+)$/);
4576: if ($ext ne '') {
4577: &add_filetype($allfiles,$path.$value,$ext);
4578: }
4579: }
4580: }
4581: }
4582: }
1.637 raeburn 4583: return 'ok';
4584: }
4585:
1.639 albertel 4586: sub add_filetype {
4587: my ($allfiles,$file,$type)=@_;
4588: if (exists($allfiles->{$file})) {
4589: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4590: push(@{$allfiles->{$file}}, &escape($type));
4591: }
4592: } else {
4593: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 4594: }
4595: }
4596:
1.1164 raeburn 4597: sub embedded_dependency {
4598: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4599: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4600: if (($identifier ne '') &&
4601: (ref($related->{$identifier}) eq 'ARRAY') &&
4602: ($pathfrom ne '')) {
4603: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4604: foreach my $dep (@{$related->{$identifier}}) {
4605: &add_filetype($allfiles,$path.$dep,'object');
4606: }
4607: }
4608: }
4609: return;
4610: }
4611:
1.1401 raeburn 4612: sub bubblesheet_converter {
4613: my ($cdom,$fullpath,$config,$format) = @_;
4614: if ((&domain($cdom) ne '') &&
1.1403 raeburn 4615: ($fullpath =~ m{^\Q$perlvar{'lonDocRoot'}/userfiles/$cdom/\E$match_courseid/scantron_orig}) &&
1.1401 raeburn 4616: (-e $fullpath) && (ref($config) eq 'HASH') && ($format ne '')) {
1.1404 raeburn 4617: my (%csvcols,%csvoptions);
4618: if (ref($config->{'fields'}) eq 'HASH') {
4619: %csvcols = %{$config->{'fields'}};
4620: }
4621: if (ref($config->{'options'}) eq 'HASH') {
4622: %csvoptions = %{$config->{'options'}};
4623: }
1.1401 raeburn 4624: my %csvbynum = reverse(%csvcols);
4625: my %scantronconf = &get_scantron_config($format,$cdom);
4626: if (keys(%scantronconf)) {
4627: my %bynum = (
4628: $scantronconf{CODEstart} => 'CODEstart',
4629: $scantronconf{IDstart} => 'IDstart',
4630: $scantronconf{PaperID} => 'PaperID',
4631: $scantronconf{FirstName} => 'FirstName',
4632: $scantronconf{LastName} => 'LastName',
4633: $scantronconf{Qstart} => 'Qstart',
4634: );
4635: my @ordered;
4636: foreach my $item (sort { $a <=> $b } keys(%bynum)) {
1.1403 raeburn 4637: push(@ordered,$bynum{$item});
1.1401 raeburn 4638: }
4639: my %mapstart = (
4640: CODEstart => 'CODE',
4641: IDstart => 'ID',
4642: PaperID => 'PaperID',
4643: FirstName => 'FirstName',
4644: LastName => 'LastName',
4645: Qstart => 'FirstQuestion',
4646: );
4647: my %maplength = (
4648: CODEstart => 'CODElength',
4649: IDstart => 'IDlength',
4650: PaperID => 'PaperIDlength',
4651: FirstName => 'FirstNamelength',
4652: LastName => 'LastNamelength',
4653: );
4654: if (open(my $fh,'<',$fullpath)) {
4655: my $output;
1.1403 raeburn 4656: my %lettdig = &letter_to_digits();
4657: my %diglett = reverse(%lettdig);
4658: my $numletts = scalar(keys(%lettdig));
1.1404 raeburn 4659: my $num = 0;
1.1401 raeburn 4660: while (my $line=<$fh>) {
1.1404 raeburn 4661: $num ++;
4662: next if (($num == 1) && ($csvoptions{'hdr'} == 1));
1.1401 raeburn 4663: $line =~ s{[\r\n]+$}{};
4664: my %found;
4665: my @values = split(/,/,$line);
4666: my ($qstart,$record);
4667: for (my $i=0; $i<@values; $i++) {
1.1403 raeburn 4668: if ((($qstart ne '') && ($i > $qstart)) ||
4669: ($csvbynum{$i} eq 'FirstQuestion')) {
4670: if ($values[$i] eq '') {
4671: $values[$i] = $scantronconf{'Qoff'};
4672: } elsif ($scantronconf{'Qon'} eq 'number') {
4673: if ($values[$i] =~ /^[A-Ja-j]$/) {
4674: $values[$i] = $lettdig{uc($values[$i])};
4675: }
4676: } elsif ($scantronconf{'Qon'} eq 'letter') {
4677: if ($values[$i] =~ /^[0-9]$/) {
4678: $values[$i] = $diglett{$values[$i]};
4679: }
4680: } else {
4681: if ($values[$i] =~ /^[0-9A-Ja-j]$/) {
4682: my $digit;
4683: if ($values[$i] =~ /^[A-Ja-j]$/) {
4684: $digit = $lettdig{uc($values[$i])}-1;
4685: if ($values[$i] eq 'J') {
4686: $digit += $numletts;
4687: }
4688: } elsif ($values[$i] =~ /^[0-9]$/) {
4689: $digit = $values[$i]-1;
4690: if ($values[$i] eq '0') {
4691: $digit += $numletts;
4692: }
4693: }
4694: my $qval='';
4695: for (my $j=0; $j<$scantronconf{'Qlength'}; $j++) {
4696: if ($j == $digit) {
4697: $qval .= $scantronconf{'Qon'};
4698: } else {
4699: $qval .= $scantronconf{'Qoff'};
4700: }
4701: }
4702: $values[$i] = $qval;
4703: }
4704: }
4705: if (length($values[$i]) > $scantronconf{'Qlength'}) {
4706: $values[$i] = substr($values[$i],0,$scantronconf{'Qlength'});
4707: }
4708: my $numblank = $scantronconf{'Qlength'} - length($values[$i]);
4709: if ($numblank > 0) {
4710: $values[$i] .= ($scantronconf{'Qoff'} x $numblank);
4711: }
1.1401 raeburn 4712: if ($csvbynum{$i} eq 'FirstQuestion') {
4713: $qstart = $i;
1.1403 raeburn 4714: $found{$csvbynum{$i}} = $values[$i];
1.1401 raeburn 4715: } else {
1.1403 raeburn 4716: $found{'FirstQuestion'} .= $values[$i];
4717: }
4718: } elsif (exists($csvbynum{$i})) {
1.1404 raeburn 4719: if ($csvoptions{'rem'}) {
4720: $values[$i] =~ s/^\s+//;
4721: }
4722: if (($csvbynum{$i} eq 'PaperID') && ($csvoptions{'pad'})) {
1.1403 raeburn 4723: while (length($values[$i]) < $scantronconf{$maplength{$csvbynum{$i}}}) {
4724: $values[$i] = '0'.$values[$i];
1.1401 raeburn 4725: }
4726: }
4727: $found{$csvbynum{$i}} = $values[$i];
4728: }
4729: }
4730: foreach my $item (@ordered) {
4731: my $currlength = 1+length($record);
4732: my $numspaces = $scantronconf{$item} - $currlength;
4733: if ($numspaces > 0) {
4734: $record .= (' ' x $numspaces);
4735: }
4736: if (($mapstart{$item} ne '') && (exists($found{$mapstart{$item}}))) {
4737: unless ($item eq 'Qstart') {
4738: if (length($found{$mapstart{$item}}) > $scantronconf{$maplength{$item}}) {
4739: $found{$mapstart{$item}} = substr($found{$mapstart{$item}},0,$scantronconf{$maplength{$item}});
4740: }
4741: }
4742: $record .= $found{$mapstart{$item}};
4743: }
4744: }
4745: $output .= "$record\n";
4746: }
4747: close($fh);
4748: if ($output) {
4749: if (open(my $fh,'>',$fullpath)) {
4750: print $fh $output;
4751: close($fh);
4752: }
4753: }
4754: }
4755: }
4756: return;
4757: }
4758: }
4759:
1.1403 raeburn 4760: sub letter_to_digits {
4761: my %lettdig = (
4762: A => 1,
4763: B => 2,
4764: C => 3,
4765: D => 4,
4766: E => 5,
4767: F => 6,
4768: G => 7,
4769: H => 8,
4770: I => 9,
4771: J => 0,
4772: );
4773: return %lettdig;
4774: }
4775:
1.1401 raeburn 4776: sub get_scantron_config {
4777: my ($which,$cdom) = @_;
4778: my @lines = &get_scantronformat_file($cdom);
4779: my %config;
4780: #FIXME probably should move to XML it has already gotten a bit much now
4781: foreach my $line (@lines) {
4782: my ($name,$descrip)=split(/:/,$line);
4783: if ($name ne $which ) { next; }
4784: chomp($line);
4785: my @config=split(/:/,$line);
4786: $config{'name'}=$config[0];
4787: $config{'description'}=$config[1];
4788: $config{'CODElocation'}=$config[2];
4789: $config{'CODEstart'}=$config[3];
4790: $config{'CODElength'}=$config[4];
4791: $config{'IDstart'}=$config[5];
4792: $config{'IDlength'}=$config[6];
4793: $config{'Qstart'}=$config[7];
4794: $config{'Qlength'}=$config[8];
4795: $config{'Qoff'}=$config[9];
4796: $config{'Qon'}=$config[10];
4797: $config{'PaperID'}=$config[11];
4798: $config{'PaperIDlength'}=$config[12];
4799: $config{'FirstName'}=$config[13];
4800: $config{'FirstNamelength'}=$config[14];
4801: $config{'LastName'}=$config[15];
4802: $config{'LastNamelength'}=$config[16];
4803: $config{'BubblesPerRow'}=$config[17];
4804: last;
4805: }
4806: return %config;
4807: }
4808:
4809: sub get_scantronformat_file {
4810: my ($cdom) = @_;
4811: if ($cdom eq '') {
4812: $cdom= $env{'course.'.$env{'request.course.id'}.'.domain'};
4813: }
4814: my %domconfig = &get_dom('configuration',['scantron'],$cdom);
4815: my $gottab = 0;
4816: my @lines;
4817: if (ref($domconfig{'scantron'}) eq 'HASH') {
4818: if ($domconfig{'scantron'}{'scantronformat'} ne '') {
4819: my $formatfile = &getfile($perlvar{'lonDocRoot'}.$domconfig{'scantron'}{'scantronformat'});
4820: if ($formatfile ne '-1') {
4821: @lines = split("\n",$formatfile,-1);
4822: $gottab = 1;
4823: }
4824: }
4825: }
4826: if (!$gottab) {
4827: my $confname = $cdom.'-domainconfig';
4828: my $default = $perlvar{'lonDocRoot'}.'/res/'.$cdom.'/'.$confname.'/default.tab';
4829: my $formatfile = &getfile($default);
4830: if ($formatfile ne '-1') {
4831: @lines = split("\n",$formatfile,-1);
4832: $gottab = 1;
4833: }
4834: }
4835: if (!$gottab) {
4836: my @domains = ¤t_machine_domains();
4837: if (grep(/^\Q$cdom\E$/,@domains)) {
4838: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/scantronformat.tab')) {
4839: @lines = <$fh>;
4840: close($fh);
1.1403 raeburn 4841: }
1.1401 raeburn 4842: } else {
4843: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/default_scantronformat.tab')) {
4844: @lines = <$fh>;
4845: close($fh);
4846: }
4847: }
4848: }
4849: return @lines;
4850: }
4851:
1.493 albertel 4852: sub removeuploadedurl {
1.984 neumanie 4853: my ($url)=@_;
4854: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 4855: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 4856: }
4857:
4858: sub removeuserfile {
4859: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 4860: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4861: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 4862: if ($result eq 'ok') {
1.798 raeburn 4863: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
4864: my $metafile = $fname.'.meta';
4865: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 4866: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 4867: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4868: my $sqlresult =
1.823 albertel 4869: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4870: 'portfolio_metadata',$group,
4871: 'delete');
1.798 raeburn 4872: }
4873: }
4874: return $result;
1.257 www 4875: }
1.15 www 4876:
1.530 albertel 4877: sub mkdiruserfile {
4878: my ($docuname,$docudom,$dir)=@_;
4879: my $home=&homeserver($docuname,$docudom);
4880: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
4881: }
4882:
1.531 albertel 4883: sub renameuserfile {
4884: my ($docuname,$docudom,$old,$new)=@_;
4885: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4886: my $result = &reply("renameuserfile:$docudom:$docuname:".
4887: &escape("$old").':'.&escape("$new"),$home);
4888: if ($result eq 'ok') {
4889: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
4890: my $oldmeta = $old.'.meta';
4891: my $newmeta = $new.'.meta';
4892: my $metaresult =
4893: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 4894: my $url = "/uploaded/$docudom/$docuname/$old";
4895: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4896: my $sqlresult =
1.823 albertel 4897: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4898: 'portfolio_metadata',$group,
4899: 'delete');
1.798 raeburn 4900: }
4901: }
4902: return $result;
1.531 albertel 4903: }
4904:
1.14 www 4905: # ------------------------------------------------------------------------- Log
4906:
4907: sub log {
4908: my ($dom,$nam,$hom,$what)=@_;
1.47 www 4909: return critical("log:$dom:$nam:$what",$hom);
1.157 www 4910: }
4911:
4912: # ------------------------------------------------------------------ Course Log
1.352 www 4913: #
4914: # This routine flushes several buffers of non-mission-critical nature
4915: #
1.157 www 4916:
4917: sub flushcourselogs {
1.352 www 4918: &logthis('Flushing log buffers');
4919: #
4920: # course logs
4921: # This is a log of all transactions in a course, which can be used
4922: # for data mining purposes
4923: #
4924: # It also collects the courseid database, which lists last transaction
4925: # times and course titles for all courseids
4926: #
4927: my %courseidbuffer=();
1.921 raeburn 4928: foreach my $crsid (keys(%courselogs)) {
1.352 www 4929: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 4930: &escape($courselogs{$crsid}),
4931: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 4932: delete $courselogs{$crsid};
4933: } else {
4934: &logthis('Failed to flush log buffer for '.$crsid);
4935: if (length($courselogs{$crsid})>40000) {
1.672 albertel 4936: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 4937: " exceeded maximum size, deleting.</font>");
4938: delete $courselogs{$crsid};
4939: }
1.352 www 4940: }
1.920 raeburn 4941: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 4942: 'description' => $coursedescrbuf{$crsid},
4943: 'inst_code' => $courseinstcodebuf{$crsid},
4944: 'type' => $coursetypebuf{$crsid},
4945: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 4946: };
1.191 harris41 4947: }
1.352 www 4948: #
4949: # Write course id database (reverse lookup) to homeserver of courses
4950: # Is used in pickcourse
4951: #
1.840 albertel 4952: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 4953: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 4954: $courseidbuffer{$crs_home},
4955: $crs_home,'timeonly');
1.352 www 4956: }
4957: #
4958: # File accesses
4959: # Writes to the dynamic metadata of resources to get hit counts, etc.
4960: #
1.449 matthew 4961: foreach my $entry (keys(%accesshash)) {
1.458 matthew 4962: if ($entry =~ /___count$/) {
4963: my ($dom,$name);
1.807 albertel 4964: ($dom,$name,undef)=
1.811 albertel 4965: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 4966: if (! defined($dom) || $dom eq '' ||
4967: ! defined($name) || $name eq '') {
1.620 albertel 4968: my $cid = $env{'request.course.id'};
4969: $dom = $env{'request.'.$cid.'.domain'};
4970: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 4971: }
1.450 matthew 4972: my $value = $accesshash{$entry};
4973: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4974: my %temphash=($url => $value);
1.449 matthew 4975: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4976: if ($result eq 'ok') {
4977: delete $accesshash{$entry};
4978: }
4979: } else {
1.811 albertel 4980: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 4981: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 4982: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 4983: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
4984: delete $accesshash{$entry};
4985: }
1.185 www 4986: }
1.191 harris41 4987: }
1.352 www 4988: #
4989: # Roles
4990: # Reverse lookup of user roles for course faculty/staff and co-authorship
4991: #
1.800 albertel 4992: foreach my $entry (keys(%userrolehash)) {
1.351 www 4993: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 4994: split(/\:/,$entry);
4995: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 4996: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 4997: $rudom,$runame) eq 'ok') {
4998: delete $userrolehash{$entry};
4999: }
5000: }
1.662 raeburn 5001: #
1.1334 raeburn 5002: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 5003: #
5004: my %domrolebuffer = ();
1.1000 raeburn 5005: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 5006: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 5007: if ($domrolebuffer{$rudom}) {
5008: $domrolebuffer{$rudom}.='&'.&escape($entry).
5009: '='.&escape($domainrolehash{$entry});
5010: } else {
5011: $domrolebuffer{$rudom}.=&escape($entry).
5012: '='.&escape($domainrolehash{$entry});
5013: }
5014: delete $domainrolehash{$entry};
5015: }
5016: foreach my $dom (keys(%domrolebuffer)) {
1.1324 raeburn 5017: my %servers;
5018: if (defined(&domain($dom,'primary'))) {
5019: my $primary=&domain($dom,'primary');
5020: my $hostname=&hostname($primary);
5021: $servers{$primary} = $hostname;
5022: } else {
5023: %servers = &get_servers($dom,'library');
5024: }
1.841 albertel 5025: foreach my $tryserver (keys(%servers)) {
1.1324 raeburn 5026: if (&reply('domroleput:'.$dom.':'.
5027: $domrolebuffer{$dom},$tryserver) eq 'ok') {
5028: last;
5029: } else {
1.841 albertel 5030: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
5031: }
1.662 raeburn 5032: }
5033: }
1.186 www 5034: $dumpcount++;
1.157 www 5035: }
5036:
5037: sub courselog {
5038: my $what=shift;
1.158 www 5039: $what=time.':'.$what;
1.620 albertel 5040: unless ($env{'request.course.id'}) { return ''; }
5041: $coursedombuf{$env{'request.course.id'}}=
5042: $env{'course.'.$env{'request.course.id'}.'.domain'};
5043: $coursenumbuf{$env{'request.course.id'}}=
5044: $env{'course.'.$env{'request.course.id'}.'.num'};
5045: $coursehombuf{$env{'request.course.id'}}=
5046: $env{'course.'.$env{'request.course.id'}.'.home'};
5047: $coursedescrbuf{$env{'request.course.id'}}=
5048: $env{'course.'.$env{'request.course.id'}.'.description'};
5049: $courseinstcodebuf{$env{'request.course.id'}}=
5050: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
5051: $courseownerbuf{$env{'request.course.id'}}=
5052: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 5053: $coursetypebuf{$env{'request.course.id'}}=
5054: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 5055: if (defined $courselogs{$env{'request.course.id'}}) {
5056: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 5057: } else {
1.620 albertel 5058: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 5059: }
1.620 albertel 5060: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 5061: &flushcourselogs();
5062: }
1.158 www 5063: }
5064:
5065: sub courseacclog {
5066: my $fnsymb=shift;
1.620 albertel 5067: unless ($env{'request.course.id'}) { return ''; }
5068: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 5069: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 5070: $what.=':POST';
1.583 matthew 5071: # FIXME: Probably ought to escape things....
1.800 albertel 5072: foreach my $key (keys(%env)) {
5073: if ($key=~/^form\.(.*)/) {
1.975 raeburn 5074: my $formitem = $1;
5075: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
5076: $what.=':'.$formitem.'='.$env{$key};
5077: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
1.1432 raeburn 5078: if ($formitem eq 'proctorpassword') {
1.1433 raeburn 5079: $what.=':'.$formitem.'=' . '*' x length($env{$key});
1.1432 raeburn 5080: } else {
5081: $what.=':'.$formitem.'='.$env{$key};
5082: }
1.975 raeburn 5083: }
1.158 www 5084: }
1.191 harris41 5085: }
1.583 matthew 5086: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
5087: # FIXME: We should not be depending on a form parameter that someone
5088: # editing lonsearchcat.pm might change in the future.
1.620 albertel 5089: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 5090: $what.= ':POST';
5091: # FIXME: Probably ought to escape things....
5092: foreach my $element ('courseexp','crsfulltext','crsrelated',
5093: 'crsdiscuss') {
1.620 albertel 5094: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 5095: }
5096: }
1.158 www 5097: }
5098: &courselog($what);
1.149 www 5099: }
5100:
1.185 www 5101: sub countacc {
5102: my $url=&declutter(shift);
1.458 matthew 5103: return if (! defined($url) || $url eq '');
1.620 albertel 5104: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 5105: #
5106: # Mark that this url was used in this course
5107: #
1.620 albertel 5108: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 5109: #
5110: # Increase the access count for this resource in this child process
5111: #
1.281 www 5112: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 5113: $accesshash{$key}++;
1.185 www 5114: }
1.349 www 5115:
1.361 www 5116: sub linklog {
5117: my ($from,$to)=@_;
5118: $from=&declutter($from);
5119: $to=&declutter($to);
5120: $accesshash{$from.'___'.$to.'___comefrom'}=1;
5121: $accesshash{$to.'___'.$from.'___goto'}=1;
5122: }
1.1160 www 5123:
5124: sub statslog {
5125: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
5126: if ($users<2) { return; }
5127: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
5128: 'course' => $env{'request.course.id'},
5129: 'sections' => '"all"',
5130: 'num_students' => $users,
5131: 'part' => $part,
5132: 'symb' => $symb,
5133: 'mean_tries' => $av_attempts,
5134: 'deg_of_diff' => $degdiff});
5135: foreach my $key (keys(%dynstore)) {
5136: $accesshash{$key}=$dynstore{$key};
5137: }
5138: }
1.361 www 5139:
1.349 www 5140: sub userrolelog {
5141: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 5142: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 5143: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5144: $userrolehash
5145: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 5146: =$tend.':'.$tstart;
1.662 raeburn 5147: }
1.1169 droeschl 5148: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 5149: $userrolehash
5150: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
5151: =$tend.':'.$tstart;
5152: }
1.1334 raeburn 5153: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 5154: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5155: $domainrolehash
5156: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
5157: = $tend.':'.$tstart;
5158: }
1.351 www 5159: }
5160:
1.957 raeburn 5161: sub courserolelog {
5162: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184 raeburn 5163: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
5164: my $cdom = $1;
5165: my $cnum = $2;
5166: my $sec = $3;
5167: my $namespace = 'rolelog';
5168: my %storehash = (
5169: role => $trole,
5170: start => $tstart,
5171: end => $tend,
5172: selfenroll => $selfenroll,
5173: context => $context,
5174: );
5175: if ($trole eq 'gr') {
5176: $namespace = 'groupslog';
5177: $storehash{'group'} = $sec;
5178: } else {
5179: $storehash{'section'} = $sec;
5180: }
1.1188 raeburn 5181: &write_log('course',$namespace,\%storehash,$delflag,$username,
5182: $domain,$cnum,$cdom);
1.1184 raeburn 5183: if (($trole ne 'st') || ($sec ne '')) {
5184: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 5185: }
5186: }
5187: return;
5188: }
5189:
1.1184 raeburn 5190: sub domainrolelog {
5191: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5192: if ($area =~ m{^/($match_domain)/$}) {
5193: my $cdom = $1;
5194: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
5195: my $namespace = 'rolelog';
5196: my %storehash = (
5197: role => $trole,
5198: start => $tstart,
5199: end => $tend,
5200: context => $context,
5201: );
1.1188 raeburn 5202: &write_log('domain',$namespace,\%storehash,$delflag,$username,
5203: $domain,$domconfiguser,$cdom);
1.1184 raeburn 5204: }
5205: return;
5206:
5207: }
5208:
5209: sub coauthorrolelog {
5210: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
5211: if ($area =~ m{^/($match_domain)/($match_username)$}) {
5212: my $audom = $1;
5213: my $auname = $2;
5214: my $namespace = 'rolelog';
5215: my %storehash = (
5216: role => $trole,
5217: start => $tstart,
5218: end => $tend,
5219: context => $context,
5220: );
1.1188 raeburn 5221: &write_log('author',$namespace,\%storehash,$delflag,$username,
5222: $domain,$auname,$audom);
1.1184 raeburn 5223: }
5224: return;
5225: }
5226:
1.351 www 5227: sub get_course_adv_roles {
1.948 raeburn 5228: my ($cid,$codes) = @_;
1.620 albertel 5229: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 5230: my %coursehash=&coursedescription($cid);
1.988 raeburn 5231: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 5232: my %nothide=();
1.800 albertel 5233: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 5234: if ($user !~ /:/) {
5235: $nothide{join(':',split(/[\@]/,$user))}=1;
5236: } else {
5237: $nothide{$user}=1;
5238: }
1.470 www 5239: }
1.1219 raeburn 5240: my @possdoms = ($coursehash{'domain'});
5241: if ($coursehash{'checkforpriv'}) {
5242: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
5243: }
1.351 www 5244: my %returnhash=();
5245: my %dumphash=
5246: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
5247: my $now=time;
1.997 raeburn 5248: my %privileged;
1.1000 raeburn 5249: foreach my $entry (keys(%dumphash)) {
1.800 albertel 5250: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 5251: if (($tstart) && ($tstart<0)) { next; }
5252: if (($tend) && ($tend<$now)) { next; }
5253: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 5254: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 5255: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 5256: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 5257: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 5258: if ($role eq 'cr') { next; }
1.948 raeburn 5259: if ($codes) {
5260: if ($section) { $role .= ':'.$section; }
5261: if ($returnhash{$role}) {
5262: $returnhash{$role}.=','.$username.':'.$domain;
5263: } else {
5264: $returnhash{$role}=$username.':'.$domain;
5265: }
1.351 www 5266: } else {
1.988 raeburn 5267: my $key=&plaintext($role,$crstype);
1.973 bisitz 5268: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 5269: if ($returnhash{$key}) {
5270: $returnhash{$key}.=','.$username.':'.$domain;
5271: } else {
5272: $returnhash{$key}=$username.':'.$domain;
5273: }
1.351 www 5274: }
1.948 raeburn 5275: }
1.400 www 5276: return %returnhash;
5277: }
5278:
5279: sub get_my_roles {
1.937 raeburn 5280: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 5281: unless (defined($uname)) { $uname=$env{'user.name'}; }
5282: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 5283: my (%dumphash,%nothide);
1.1086 raeburn 5284: if ($context eq 'userroles') {
1.1166 raeburn 5285: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 5286: } else {
1.1219 raeburn 5287: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 5288: if ($hidepriv) {
5289: my %coursehash=&coursedescription($udom.'_'.$uname);
5290: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5291: if ($user !~ /:/) {
5292: $nothide{join(':',split(/[\@]/,$user))} = 1;
5293: } else {
5294: $nothide{$user} = 1;
5295: }
5296: }
5297: }
1.858 raeburn 5298: }
1.400 www 5299: my %returnhash=();
5300: my $now=time;
1.999 raeburn 5301: my %privileged;
1.800 albertel 5302: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 5303: my ($role,$tend,$tstart);
5304: if ($context eq 'userroles') {
1.1149 raeburn 5305: next if ($entry =~ /^rolesdef/);
1.867 raeburn 5306: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
5307: } else {
5308: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
5309: }
1.400 www 5310: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 5311: my $status = 'active';
1.939 raeburn 5312: if (($tend) && ($tend<=$now)) {
1.832 raeburn 5313: $status = 'previous';
5314: }
5315: if (($tstart) && ($now<$tstart)) {
5316: $status = 'future';
5317: }
5318: if (ref($types) eq 'ARRAY') {
5319: if (!grep(/^\Q$status\E$/,@{$types})) {
5320: next;
5321: }
5322: } else {
5323: if ($status ne 'active') {
5324: next;
5325: }
5326: }
1.867 raeburn 5327: my ($rolecode,$username,$domain,$section,$area);
5328: if ($context eq 'userroles') {
1.1186 raeburn 5329: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 5330: (undef,$domain,$username,$section) = split(/\//,$area);
5331: } else {
5332: ($role,$username,$domain,$section) = split(/\:/,$entry);
5333: }
1.832 raeburn 5334: if (ref($roledoms) eq 'ARRAY') {
5335: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
5336: next;
5337: }
5338: }
5339: if (ref($roles) eq 'ARRAY') {
5340: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 5341: if ($role =~ /^cr\//) {
5342: if (!grep(/^cr$/,@{$roles})) {
5343: next;
5344: }
1.1104 raeburn 5345: } elsif ($role =~ /^gr\//) {
5346: if (!grep(/^gr$/,@{$roles})) {
5347: next;
5348: }
1.922 raeburn 5349: } else {
5350: next;
5351: }
1.832 raeburn 5352: }
1.867 raeburn 5353: }
1.937 raeburn 5354: if ($hidepriv) {
1.1219 raeburn 5355: my @privroles = ('dc','su');
1.999 raeburn 5356: if ($context eq 'userroles') {
1.1219 raeburn 5357: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 5358: } else {
1.1219 raeburn 5359: my $possdoms = [$domain];
5360: if (ref($roledoms) eq 'ARRAY') {
5361: push(@{$possdoms},@{$roledoms});
1.999 raeburn 5362: }
1.1219 raeburn 5363: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 5364: if (!$nothide{$username.':'.$domain}) {
5365: next;
5366: }
5367: }
1.937 raeburn 5368: }
5369: }
1.933 raeburn 5370: if ($withsec) {
5371: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
5372: $tstart.':'.$tend;
5373: } else {
5374: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
5375: }
1.832 raeburn 5376: }
1.373 www 5377: return %returnhash;
1.399 www 5378: }
5379:
1.1333 raeburn 5380: sub get_all_adhocroles {
5381: my ($dom) = @_;
5382: my @roles_by_num = ();
5383: my %domdefaults = &get_domain_defaults($dom);
5384: my (%description,%access_in_dom,%access_info);
5385: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
5386: my $count = 0;
5387: my %domcurrent = %{$domdefaults{'adhocroles'}};
5388: my %ordered;
5389: foreach my $role (sort(keys(%domcurrent))) {
5390: my ($order,$desc,$access_in_dom);
5391: if (ref($domcurrent{$role}) eq 'HASH') {
5392: $order = $domcurrent{$role}{'order'};
5393: $desc = $domcurrent{$role}{'desc'};
5394: $access_in_dom{$role} = $domcurrent{$role}{'access'};
5395: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
5396: }
5397: if ($order eq '') {
5398: $order = $count;
5399: }
5400: $ordered{$order} = $role;
5401: if ($desc ne '') {
5402: $description{$role} = $desc;
5403: } else {
5404: $description{$role}= $role;
5405: }
5406: $count++;
5407: }
5408: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
5409: push(@roles_by_num,$ordered{$item});
5410: }
5411: }
5412: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
5413: }
5414:
1.1332 raeburn 5415: sub get_my_adhocroles {
1.1333 raeburn 5416: my ($cid,$checkreg) = @_;
5417: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
5418: if ($env{'request.course.id'} eq $cid) {
5419: $cdom = $env{'course.'.$cid.'.domain'};
5420: $cnum = $env{'course.'.$cid.'.num'};
5421: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
5422: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
5423: $cdom = $1;
5424: $cnum = $2;
5425: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
5426: $cdom,$cnum);
5427: }
5428: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
5429: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5430: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
5431: if ($rosterhash{$user} ne '') {
5432: my $type = (split(/:/,$rosterhash{$user}))[5];
5433: return ([],{}) if ($type eq 'auto');
5434: }
5435: }
5436: if (($cdom ne '') && ($cnum ne '')) {
1.1334 raeburn 5437: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1332 raeburn 5438: my $then=$env{'user.login.time'};
5439: my $update=$env{'user.update.time'};
1.1335 raeburn 5440: if (!$update) {
5441: $update = $then;
5442: }
5443: my @liveroles;
1.1334 raeburn 5444: foreach my $role ('dh','da') {
5445: if ($env{"user.role.$role./$cdom/"}) {
1.1335 raeburn 5446: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
1.1334 raeburn 5447: my $limit = $update;
5448: if ($env{'request.role'} eq "$role./$cdom/") {
5449: $limit = $then;
5450: }
1.1335 raeburn 5451: my $activerole = 1;
5452: if ($tstart && $tstart>$limit) { $activerole = 0; }
5453: if ($tend && $tend <$limit) { $activerole = 0; }
5454: if ($activerole) {
5455: push(@liveroles,$role);
5456: }
1.1334 raeburn 5457: }
1.1332 raeburn 5458: }
1.1335 raeburn 5459: if (@liveroles) {
1.1332 raeburn 5460: if (&homeserver($cnum,$cdom) ne 'no_host') {
1.1333 raeburn 5461: my ($accessref,$accessinfo,%access_in_dom);
5462: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
5463: if (ref($roles_by_num) eq 'ARRAY') {
5464: if (@{$roles_by_num}) {
1.1332 raeburn 5465: my %settings;
5466: if ($env{'request.course.id'} eq $cid) {
5467: foreach my $envkey (keys(%env)) {
5468: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
5469: $settings{$1} = $env{$envkey};
5470: }
5471: }
5472: } else {
5473: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
5474: }
5475: my %setincrs;
5476: if ($settings{'internal.adhocaccess'}) {
5477: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
5478: }
5479: my @statuses;
5480: if ($env{'environment.inststatus'}) {
5481: @statuses = split(/,/,$env{'environment.inststatus'});
5482: }
5483: my $user = $env{'user.name'}.':'.$env{'user.domain'};
1.1333 raeburn 5484: if (ref($accessref) eq 'HASH') {
5485: %access_in_dom = %{$accessref};
5486: }
5487: foreach my $role (@{$roles_by_num}) {
1.1332 raeburn 5488: my ($curraccess,@okstatus,@personnel);
5489: if ($setincrs{$role}) {
5490: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
5491: if ($curraccess eq 'status') {
5492: @okstatus = split(/\&/,$rest);
5493: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5494: @personnel = split(/\&/,$rest);
5495: }
5496: } else {
5497: $curraccess = $access_in_dom{$role};
1.1333 raeburn 5498: if (ref($accessinfo) eq 'HASH') {
5499: if ($curraccess eq 'status') {
5500: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5501: @okstatus = @{$accessinfo->{$role}};
5502: }
5503: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5504: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5505: @personnel = @{$accessinfo->{$role}};
5506: }
1.1332 raeburn 5507: }
5508: }
5509: }
5510: if ($curraccess eq 'none') {
5511: next;
5512: } elsif ($curraccess eq 'all') {
5513: push(@possroles,$role);
1.1336 raeburn 5514: } elsif ($curraccess eq 'dh') {
1.1335 raeburn 5515: if (grep(/^dh$/,@liveroles)) {
5516: push(@possroles,$role);
5517: } else {
5518: next;
5519: }
1.1336 raeburn 5520: } elsif ($curraccess eq 'da') {
1.1335 raeburn 5521: if (grep(/^da$/,@liveroles)) {
5522: push(@possroles,$role);
5523: } else {
5524: next;
5525: }
1.1332 raeburn 5526: } elsif ($curraccess eq 'status') {
5527: if (@okstatus) {
5528: if (!@statuses) {
5529: if (grep(/^default$/,@okstatus)) {
5530: push(@possroles,$role);
5531: }
5532: } else {
5533: foreach my $status (@okstatus) {
5534: if (grep(/^\Q$status\E$/,@statuses)) {
5535: push(@possroles,$role);
5536: last;
5537: }
5538: }
5539: }
5540: }
5541: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5542: if (grep(/^\Q$user\E$/,@personnel)) {
5543: if ($curraccess eq 'exc') {
5544: push(@possroles,$role);
5545: }
5546: } elsif ($curraccess eq 'inc') {
5547: push(@possroles,$role);
5548: }
5549: }
5550: }
5551: }
5552: }
5553: }
5554: }
5555: }
5556: }
1.1333 raeburn 5557: unless (ref($description) eq 'HASH') {
5558: if (ref($roles_by_num) eq 'ARRAY') {
5559: my %desc;
5560: map { $desc{$_} = $_; } (@{$roles_by_num});
5561: $description = \%desc;
5562: } else {
5563: $description = {};
5564: }
5565: }
5566: return (\@possroles,$description);
1.1332 raeburn 5567: }
5568:
1.399 www 5569: # ----------------------------------------------------- Frontpage Announcements
5570: #
5571: #
5572:
5573: sub postannounce {
5574: my ($server,$text)=@_;
1.844 albertel 5575: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 5576: unless ($text=~/\w/) { $text=''; }
5577: return &reply('setannounce:'.&escape($text),$server);
5578: }
5579:
5580: sub getannounce {
1.448 albertel 5581:
1.1359 raeburn 5582: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 5583: my $announcement='';
1.800 albertel 5584: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 5585: close($fh);
1.399 www 5586: if ($announcement=~/\w/) {
5587: return
5588: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 5589: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 5590: } else {
5591: return '';
5592: }
5593: } else {
5594: return '';
5595: }
1.351 www 5596: }
1.353 www 5597:
5598: # ---------------------------------------------------------- Course ID routines
5599: # Deal with domain's nohist_courseid.db files
5600: #
5601:
5602: sub courseidput {
1.921 raeburn 5603: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 5604: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 5605: my $outcome;
5606: if ($caller eq 'timeonly') {
5607: my $cids = '';
5608: foreach my $item (keys(%$storehash)) {
5609: $cids.=&escape($item).'&';
5610: }
5611: $cids=~s/\&$//;
5612: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
5613: $coursehome);
5614: } else {
5615: my $items = '';
5616: foreach my $item (keys(%$storehash)) {
5617: $items.= &escape($item).'='.
5618: &freeze_escape($$storehash{$item}).'&';
5619: }
5620: $items=~s/\&$//;
5621: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
5622: $coursehome);
1.918 raeburn 5623: }
5624: if ($outcome eq 'unknown_cmd') {
5625: my $what;
5626: foreach my $cid (keys(%$storehash)) {
5627: $what .= &escape($cid).'=';
1.921 raeburn 5628: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 5629: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 5630: }
5631: $what =~ s/\:$/&/;
5632: }
5633: $what =~ s/\&$//;
5634: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
5635: } else {
5636: return $outcome;
5637: }
1.353 www 5638: }
5639:
5640: sub courseiddump {
1.921 raeburn 5641: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 5642: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 5643: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247 raeburn 5644: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287 raeburn 5645: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 5646: my $as_hash = 1;
5647: my %returnhash;
5648: if (!$domfilter) { $domfilter=''; }
1.845 albertel 5649: my %libserv = &all_library();
5650: foreach my $tryserver (keys(%libserv)) {
5651: if ( ( $hostidflag == 1
5652: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
5653: || (!defined($hostidflag)) ) {
5654:
1.918 raeburn 5655: if (($domfilter eq '') ||
5656: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 5657: my $rep;
5658: if (grep { $_ eq $tryserver } current_machine_ids()) {
5659: $rep = LONCAPA::Lond::dump_course_id_handler(
5660: join(":", (&host_domain($tryserver), $sincefilter,
5661: &escape($descfilter), &escape($instcodefilter),
5662: &escape($ownerfilter), &escape($coursefilter),
5663: &escape($typefilter), &escape($regexp_ok),
5664: $as_hash, &escape($selfenrollonly),
5665: &escape($catfilter), $showhidden, $caller,
5666: &escape($cloner), &escape($cc_clone), $cloneonly,
5667: &escape($createdbefore), &escape($createdafter),
1.1287 raeburn 5668: &escape($creationcontext),$domcloner,$hasuniquecode,
5669: $reqcrsdom,&escape($reqinstcode))));
1.1180 droeschl 5670: } else {
5671: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5672: $sincefilter.':'.&escape($descfilter).':'.
5673: &escape($instcodefilter).':'.&escape($ownerfilter).
5674: ':'.&escape($coursefilter).':'.&escape($typefilter).
5675: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5676: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5677: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5678: &escape($cc_clone).':'.$cloneonly.':'.
5679: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287 raeburn 5680: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5681: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180 droeschl 5682: }
5683:
1.918 raeburn 5684: my @pairs=split(/\&/,$rep);
5685: foreach my $item (@pairs) {
5686: my ($key,$value)=split(/\=/,$item,2);
5687: $key = &unescape($key);
5688: next if ($key =~ /^error: 2 /);
5689: my $result = &thaw_unescape($value);
5690: if (ref($result) eq 'HASH') {
5691: $returnhash{$key}=$result;
5692: } else {
1.921 raeburn 5693: my @responses = split(/:/,$value);
5694: my @items = ('description','inst_code','owner','type');
1.918 raeburn 5695: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 5696: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 5697: }
1.1008 raeburn 5698: }
1.353 www 5699: }
5700: }
5701: }
5702: }
5703: return %returnhash;
5704: }
5705:
1.1055 raeburn 5706: sub courselastaccess {
5707: my ($cdom,$cnum,$hostidref) = @_;
5708: my %returnhash;
5709: if ($cdom && $cnum) {
5710: my $chome = &homeserver($cnum,$cdom);
5711: if ($chome ne 'no_host') {
5712: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5713: &extract_lastaccess(\%returnhash,$rep);
5714: }
5715: } else {
5716: if (!$cdom) { $cdom=''; }
5717: my %libserv = &all_library();
5718: foreach my $tryserver (keys(%libserv)) {
5719: if (ref($hostidref) eq 'ARRAY') {
5720: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5721: }
5722: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5723: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5724: &extract_lastaccess(\%returnhash,$rep);
5725: }
5726: }
5727: }
5728: return %returnhash;
5729: }
5730:
5731: sub extract_lastaccess {
5732: my ($returnhash,$rep) = @_;
5733: if (ref($returnhash) eq 'HASH') {
5734: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5735: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5736: $rep eq '') {
5737: my @pairs=split(/\&/,$rep);
5738: foreach my $item (@pairs) {
5739: my ($key,$value)=split(/\=/,$item,2);
5740: $key = &unescape($key);
5741: next if ($key =~ /^error: 2 /);
5742: $returnhash->{$key} = &thaw_unescape($value);
5743: }
5744: }
5745: }
5746: return;
5747: }
5748:
1.658 raeburn 5749: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 5750:
5751: sub dcmailput {
1.685 raeburn 5752: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 5753: my $status = &Apache::lonnet::critical(
1.740 www 5754: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5755: &escape($message),$server);
1.662 raeburn 5756: return $status;
5757: }
5758:
1.658 raeburn 5759: sub dcmaildump {
5760: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 5761: my %returnhash=();
1.846 albertel 5762:
5763: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 5764: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5765: &escape($enddate).':';
5766: my @esc_senders=map { &escape($_)} @$senders;
5767: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 5768: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 5769: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 5770: if (($key) && ($value)) {
5771: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 5772: }
5773: }
5774: }
5775: return %returnhash;
5776: }
1.662 raeburn 5777: # ---------------------------------------------------------- Domain roles
5778:
5779: sub get_domain_roles {
5780: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 5781: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 5782: $startdate = '.';
5783: }
1.1018 raeburn 5784: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 5785: $enddate = '.';
5786: }
1.922 raeburn 5787: my $rolelist;
5788: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 5789: $rolelist = join('&',@{$roles});
1.922 raeburn 5790: }
1.662 raeburn 5791: my %personnel = ();
1.841 albertel 5792:
5793: my %servers = &get_servers($dom,'library');
5794: foreach my $tryserver (keys(%servers)) {
5795: %{$personnel{$tryserver}}=();
5796: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5797: &escape($startdate).':'.
5798: &escape($enddate).':'.
5799: &escape($rolelist), $tryserver))) {
5800: my ($key,$value) = split(/\=/,$line,2);
5801: if (($key) && ($value)) {
5802: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5803: }
5804: }
1.662 raeburn 5805: }
5806: return %personnel;
5807: }
1.658 raeburn 5808:
1.1332 raeburn 5809: sub get_active_domroles {
5810: my ($dom,$roles) = @_;
5811: return () unless (ref($roles) eq 'ARRAY');
5812: my $now = time;
5813: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
5814: my %domroles;
5815: foreach my $server (keys(%dompersonnel)) {
5816: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
5817: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
5818: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
5819: }
5820: }
5821: return %domroles;
5822: }
5823:
1.1057 www 5824: # ----------------------------------------------------------- Interval timing
1.149 www 5825:
1.1153 www 5826: {
5827: # Caches needed for speedup of navmaps
5828: # We don't want to cache this for very long at all (5 seconds at most)
5829: #
5830: # The user for whom we cache
5831: my $cachedkey='';
5832: # The cached times for this user
5833: my %cachedtimes=();
5834: # When this was last done
1.1282 raeburn 5835: my $cachedtime='';
1.1153 www 5836:
5837: sub load_all_first_access {
1.1308 raeburn 5838: my ($uname,$udom,$ignorecache)=@_;
1.1156 www 5839: if (($cachedkey eq $uname.':'.$udom) &&
1.1308 raeburn 5840: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
5841: (!$ignorecache)) {
1.1154 raeburn 5842: return;
5843: }
5844: $cachedtime=time;
5845: $cachedkey=$uname.':'.$udom;
5846: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 5847: }
5848:
1.504 albertel 5849: sub get_first_access {
1.1308 raeburn 5850: my ($type,$argsymb,$argmap,$ignorecache)=@_;
1.790 albertel 5851: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5852: if ($argsymb) { $symb=$argsymb; }
5853: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 5854: if ($argmap) { $map = $argmap; }
1.926 albertel 5855: if ($type eq 'course') {
5856: $res='course';
5857: } elsif ($type eq 'map') {
1.588 albertel 5858: $res=&symbread($map);
5859: } else {
5860: $res=$symb;
5861: }
1.1308 raeburn 5862: &load_all_first_access($uname,$udom,$ignorecache);
1.1153 www 5863: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 5864: }
5865:
5866: sub set_first_access {
1.1162 raeburn 5867: my ($type,$interval)=@_;
1.790 albertel 5868: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5869: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 5870: if ($type eq 'course') {
5871: $res='course';
5872: } elsif ($type eq 'map') {
1.588 albertel 5873: $res=&symbread($map);
5874: } else {
5875: $res=$symb;
5876: }
1.1153 www 5877: $cachedkey='';
1.1162 raeburn 5878: my $firstaccess=&get_first_access($type,$symb,$map);
1.1386 raeburn 5879: if ($firstaccess) {
5880: &logthis("First access time already set ($firstaccess) when attempting ".
1.1393 raeburn 5881: "to set new value (type: $type, extent: $res) for $uname:$udom ".
5882: "in $courseid");
1.1386 raeburn 5883: return 'already_set';
5884: } else {
1.1162 raeburn 5885: my $start = time;
5886: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
5887: $udom,$uname);
5888: if ($putres eq 'ok') {
5889: &put('timerinterval',{"$courseid\0$res"=>$interval},
5890: $udom,$uname);
5891: &appenv(
5892: {
5893: 'course.'.$courseid.'.firstaccess.'.$res => $start,
5894: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
5895: }
5896: );
1.1365 raeburn 5897: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
5898: $cachedtimes{"$courseid\0$res"} = $start;
5899: }
1.1386 raeburn 5900: } elsif ($putres ne 'refused') {
5901: &logthis("Result: $putres when attempting to set first access time ".
5902: "(type: $type, extent: $res) for $uname:$udom in $courseid");
1.1162 raeburn 5903: }
5904: return $putres;
1.505 albertel 5905: }
5906: return 'already_set';
1.504 albertel 5907: }
1.1153 www 5908: }
1.1282 raeburn 5909:
1.110 www 5910: # --------------------------------------------- Set Expire Date for Spreadsheet
5911:
5912: sub expirespread {
5913: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 5914: my $cid=$env{'request.course.id'};
1.110 www 5915: if ($cid) {
5916: my $now=time;
5917: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 5918: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
5919: $env{'course.'.$cid.'.num'}.
1.110 www 5920: ':nohist_expirationdates:'.
5921: &escape($key).'='.$now,
1.620 albertel 5922: $env{'course.'.$cid.'.home'})
1.110 www 5923: }
5924: return 'ok';
1.14 www 5925: }
5926:
1.109 www 5927: # ----------------------------------------------------- Devalidate Spreadsheets
5928:
5929: sub devalidate {
1.325 www 5930: my ($symb,$uname,$udom)=@_;
1.620 albertel 5931: my $cid=$env{'request.course.id'};
1.109 www 5932: if ($cid) {
1.391 matthew 5933: # delete the stored spreadsheets for
5934: # - the student level sheet of this user in course's homespace
5935: # - the assessment level sheet for this resource
5936: # for this user in user's homespace
1.553 albertel 5937: # - current conditional state info
1.325 www 5938: my $key=$uname.':'.$udom.':';
1.109 www 5939: my $status=
1.299 matthew 5940: &del('nohist_calculatedsheets',
1.391 matthew 5941: [$key.'studentcalc:'],
1.620 albertel 5942: $env{'course.'.$cid.'.domain'},
5943: $env{'course.'.$cid.'.num'})
1.133 albertel 5944: .' '.
5945: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 5946: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 5947: unless ($status eq 'ok ok') {
5948: &logthis('Could not devalidate spreadsheet '.
1.325 www 5949: $uname.' at '.$udom.' for '.
1.109 www 5950: $symb.': '.$status);
1.133 albertel 5951: }
1.553 albertel 5952: &delenv('user.state.'.$cid);
1.109 www 5953: }
5954: }
5955:
1.265 albertel 5956: sub get_scalar {
5957: my ($string,$end) = @_;
5958: my $value;
5959: if ($$string =~ s/^([^&]*?)($end)/$2/) {
5960: $value = $1;
5961: } elsif ($$string =~ s/^([^&]*?)&//) {
5962: $value = $1;
5963: }
5964: return &unescape($value);
5965: }
5966:
5967: sub array2str {
5968: my (@array) = @_;
5969: my $result=&arrayref2str(\@array);
5970: $result=~s/^__ARRAY_REF__//;
5971: $result=~s/__END_ARRAY_REF__$//;
5972: return $result;
5973: }
5974:
1.204 albertel 5975: sub arrayref2str {
5976: my ($arrayref) = @_;
1.265 albertel 5977: my $result='__ARRAY_REF__';
1.204 albertel 5978: foreach my $elem (@$arrayref) {
1.265 albertel 5979: if(ref($elem) eq 'ARRAY') {
5980: $result.=&arrayref2str($elem).'&';
5981: } elsif(ref($elem) eq 'HASH') {
5982: $result.=&hashref2str($elem).'&';
5983: } elsif(ref($elem)) {
5984: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 5985: } else {
5986: $result.=&escape($elem).'&';
5987: }
5988: }
5989: $result=~s/\&$//;
1.265 albertel 5990: $result .= '__END_ARRAY_REF__';
1.204 albertel 5991: return $result;
5992: }
5993:
1.168 albertel 5994: sub hash2str {
1.204 albertel 5995: my (%hash) = @_;
5996: my $result=&hashref2str(\%hash);
1.265 albertel 5997: $result=~s/^__HASH_REF__//;
5998: $result=~s/__END_HASH_REF__$//;
1.204 albertel 5999: return $result;
6000: }
6001:
6002: sub hashref2str {
6003: my ($hashref)=@_;
1.265 albertel 6004: my $result='__HASH_REF__';
1.800 albertel 6005: foreach my $key (sort(keys(%$hashref))) {
6006: if (ref($key) eq 'ARRAY') {
6007: $result.=&arrayref2str($key).'=';
6008: } elsif (ref($key) eq 'HASH') {
6009: $result.=&hashref2str($key).'=';
6010: } elsif (ref($key)) {
1.265 albertel 6011: $result.='=';
1.800 albertel 6012: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 6013: } else {
1.1132 raeburn 6014: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 6015: }
6016:
1.800 albertel 6017: if(ref($hashref->{$key}) eq 'ARRAY') {
6018: $result.=&arrayref2str($hashref->{$key}).'&';
6019: } elsif(ref($hashref->{$key}) eq 'HASH') {
6020: $result.=&hashref2str($hashref->{$key}).'&';
6021: } elsif(ref($hashref->{$key})) {
1.265 albertel 6022: $result.='&';
1.800 albertel 6023: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 6024: } else {
1.800 albertel 6025: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 6026: }
6027: }
1.168 albertel 6028: $result=~s/\&$//;
1.265 albertel 6029: $result .= '__END_HASH_REF__';
1.168 albertel 6030: return $result;
6031: }
6032:
6033: sub str2hash {
1.265 albertel 6034: my ($string)=@_;
6035: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
6036: return %$hash;
6037: }
6038:
6039: sub str2hashref {
1.168 albertel 6040: my ($string) = @_;
1.265 albertel 6041:
6042: my %hash;
6043:
6044: if($string !~ /^__HASH_REF__/) {
6045: if (! ($string eq '' || !defined($string))) {
6046: $hash{'error'}='Not hash reference';
6047: }
6048: return (\%hash, $string);
6049: }
6050:
6051: $string =~ s/^__HASH_REF__//;
6052:
6053: while($string !~ /^__END_HASH_REF__/) {
6054: #key
6055: my $key='';
6056: if($string =~ /^__HASH_REF__/) {
6057: ($key, $string)=&str2hashref($string);
6058: if(defined($key->{'error'})) {
6059: $hash{'error'}='Bad data';
6060: return (\%hash, $string);
6061: }
6062: } elsif($string =~ /^__ARRAY_REF__/) {
6063: ($key, $string)=&str2arrayref($string);
6064: if($key->[0] eq 'Array reference error') {
6065: $hash{'error'}='Bad data';
6066: return (\%hash, $string);
6067: }
6068: } else {
6069: $string =~ s/^(.*?)=//;
1.267 albertel 6070: $key=&unescape($1);
1.265 albertel 6071: }
6072: $string =~ s/^=//;
6073:
6074: #value
6075: my $value='';
6076: if($string =~ /^__HASH_REF__/) {
6077: ($value, $string)=&str2hashref($string);
6078: if(defined($value->{'error'})) {
6079: $hash{'error'}='Bad data';
6080: return (\%hash, $string);
6081: }
6082: } elsif($string =~ /^__ARRAY_REF__/) {
6083: ($value, $string)=&str2arrayref($string);
6084: if($value->[0] eq 'Array reference error') {
6085: $hash{'error'}='Bad data';
6086: return (\%hash, $string);
6087: }
6088: } else {
6089: $value=&get_scalar(\$string,'__END_HASH_REF__');
6090: }
6091: $string =~ s/^&//;
6092:
6093: $hash{$key}=$value;
1.204 albertel 6094: }
1.265 albertel 6095:
6096: $string =~ s/^__END_HASH_REF__//;
6097:
6098: return (\%hash, $string);
1.204 albertel 6099: }
6100:
6101: sub str2array {
1.265 albertel 6102: my ($string)=@_;
6103: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
6104: return @$array;
6105: }
6106:
6107: sub str2arrayref {
1.204 albertel 6108: my ($string) = @_;
1.265 albertel 6109: my @array;
6110:
6111: if($string !~ /^__ARRAY_REF__/) {
6112: if (! ($string eq '' || !defined($string))) {
6113: $array[0]='Array reference error';
6114: }
6115: return (\@array, $string);
6116: }
6117:
6118: $string =~ s/^__ARRAY_REF__//;
6119:
6120: while($string !~ /^__END_ARRAY_REF__/) {
6121: my $value='';
6122: if($string =~ /^__HASH_REF__/) {
6123: ($value, $string)=&str2hashref($string);
6124: if(defined($value->{'error'})) {
6125: $array[0] ='Array reference error';
6126: return (\@array, $string);
6127: }
6128: } elsif($string =~ /^__ARRAY_REF__/) {
6129: ($value, $string)=&str2arrayref($string);
6130: if($value->[0] eq 'Array reference error') {
6131: $array[0] ='Array reference error';
6132: return (\@array, $string);
6133: }
6134: } else {
6135: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
6136: }
6137: $string =~ s/^&//;
6138:
6139: push(@array, $value);
1.191 harris41 6140: }
1.265 albertel 6141:
6142: $string =~ s/^__END_ARRAY_REF__//;
6143:
6144: return (\@array, $string);
1.168 albertel 6145: }
6146:
1.167 albertel 6147: # -------------------------------------------------------------------Temp Store
6148:
1.168 albertel 6149: sub tmpreset {
6150: my ($symb,$namespace,$domain,$stuname) = @_;
6151: if (!$symb) {
6152: $symb=&symbread();
1.620 albertel 6153: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6154: }
6155: $symb=escape($symb);
6156:
1.620 albertel 6157: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 6158: $namespace=~s/\//\_/g;
6159: $namespace=~s/\W//g;
6160:
1.620 albertel 6161: if (!$domain) { $domain=$env{'user.domain'}; }
6162: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6163: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6164: $stuname=&get_requestor_ip();
1.591 albertel 6165: }
1.1117 foxr 6166: my $path=LONCAPA::tempdir();
1.168 albertel 6167: my %hash;
6168: if (tie(%hash,'GDBM_File',
6169: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6170: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 6171: foreach my $key (keys(%hash)) {
1.180 albertel 6172: if ($key=~ /:$symb/) {
1.168 albertel 6173: delete($hash{$key});
6174: }
6175: }
6176: }
6177: }
6178:
1.167 albertel 6179: sub tmpstore {
1.168 albertel 6180: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
6181:
6182: if (!$symb) {
6183: $symb=&symbread();
1.620 albertel 6184: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6185: }
6186: $symb=escape($symb);
6187:
6188: if (!$namespace) {
6189: # I don't think we would ever want to store this for a course.
6190: # it seems this will only be used if we don't have a course.
1.620 albertel 6191: #$namespace=$env{'request.course.id'};
1.168 albertel 6192: #if (!$namespace) {
1.620 albertel 6193: $namespace=$env{'request.state'};
1.168 albertel 6194: #}
6195: }
6196: $namespace=~s/\//\_/g;
6197: $namespace=~s/\W//g;
1.620 albertel 6198: if (!$domain) { $domain=$env{'user.domain'}; }
6199: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6200: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6201: $stuname=&get_requestor_ip();
1.591 albertel 6202: }
1.168 albertel 6203: my $now=time;
6204: my %hash;
1.1117 foxr 6205: my $path=LONCAPA::tempdir();
1.168 albertel 6206: if (tie(%hash,'GDBM_File',
6207: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6208: &GDBM_WRCREAT(),0640)) {
1.168 albertel 6209: $hash{"version:$symb"}++;
6210: my $version=$hash{"version:$symb"};
6211: my $allkeys='';
6212: foreach my $key (keys(%$storehash)) {
6213: $allkeys.=$key.':';
1.591 albertel 6214: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 6215: }
6216: $hash{"$version:$symb:timestamp"}=$now;
6217: $allkeys.='timestamp';
6218: $hash{"$version:keys:$symb"}=$allkeys;
6219: if (untie(%hash)) {
6220: return 'ok';
6221: } else {
6222: return "error:$!";
6223: }
6224: } else {
6225: return "error:$!";
6226: }
6227: }
1.167 albertel 6228:
1.168 albertel 6229: # -----------------------------------------------------------------Temp Restore
1.167 albertel 6230:
1.168 albertel 6231: sub tmprestore {
6232: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 6233:
1.168 albertel 6234: if (!$symb) {
6235: $symb=&symbread();
1.620 albertel 6236: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6237: }
6238: $symb=escape($symb);
6239:
1.620 albertel 6240: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 6241:
1.620 albertel 6242: if (!$domain) { $domain=$env{'user.domain'}; }
6243: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6244: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6245: $stuname=&get_requestor_ip();
1.591 albertel 6246: }
1.168 albertel 6247: my %returnhash;
6248: $namespace=~s/\//\_/g;
6249: $namespace=~s/\W//g;
6250: my %hash;
1.1117 foxr 6251: my $path=LONCAPA::tempdir();
1.168 albertel 6252: if (tie(%hash,'GDBM_File',
6253: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6254: &GDBM_READER(),0640)) {
1.168 albertel 6255: my $version=$hash{"version:$symb"};
6256: $returnhash{'version'}=$version;
6257: my $scope;
6258: for ($scope=1;$scope<=$version;$scope++) {
6259: my $vkeys=$hash{"$scope:keys:$symb"};
6260: my @keys=split(/:/,$vkeys);
6261: my $key;
6262: $returnhash{"$scope:keys"}=$vkeys;
6263: foreach $key (@keys) {
1.591 albertel 6264: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6265: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 6266: }
6267: }
1.168 albertel 6268: if (!(untie(%hash))) {
6269: return "error:$!";
6270: }
6271: } else {
6272: return "error:$!";
6273: }
6274: return %returnhash;
1.167 albertel 6275: }
6276:
1.9 www 6277: # ----------------------------------------------------------------------- Store
6278:
6279: sub store {
1.1269 raeburn 6280: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6281: my $home='';
6282:
1.168 albertel 6283: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6284:
1.213 www 6285: $symb=&symbclean($symb);
1.122 albertel 6286: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6287:
1.620 albertel 6288: if (!$domain) { $domain=$env{'user.domain'}; }
6289: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6290:
6291: &devalidate($symb,$stuname,$domain);
1.109 www 6292:
6293: $symb=escape($symb);
1.187 www 6294: if (!$namespace) {
1.620 albertel 6295: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6296: return '';
6297: }
6298: }
1.620 albertel 6299: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6300:
1.1434 raeburn 6301: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6302: $$storehash{'host'}=$perlvar{'lonHostID'};
6303:
1.12 www 6304: my $namevalue='';
1.800 albertel 6305: foreach my $key (keys(%$storehash)) {
6306: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6307: }
1.12 www 6308: $namevalue=~s/\&$//;
1.187 www 6309: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269 raeburn 6310: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 6311: }
6312:
1.47 www 6313: # -------------------------------------------------------------- Critical Store
6314:
6315: sub cstore {
1.1269 raeburn 6316: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6317: my $home='';
6318:
1.168 albertel 6319: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6320:
1.213 www 6321: $symb=&symbclean($symb);
1.122 albertel 6322: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6323:
1.620 albertel 6324: if (!$domain) { $domain=$env{'user.domain'}; }
6325: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6326:
6327: &devalidate($symb,$stuname,$domain);
1.109 www 6328:
6329: $symb=escape($symb);
1.187 www 6330: if (!$namespace) {
1.620 albertel 6331: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6332: return '';
6333: }
6334: }
1.620 albertel 6335: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6336:
1.1434 raeburn 6337: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6338: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 6339:
1.47 www 6340: my $namevalue='';
1.800 albertel 6341: foreach my $key (keys(%$storehash)) {
6342: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6343: }
1.47 www 6344: $namevalue=~s/\&$//;
1.187 www 6345: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 6346: return critical
1.1269 raeburn 6347: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 6348: }
6349:
1.9 www 6350: # --------------------------------------------------------------------- Restore
6351:
6352: sub restore {
1.124 www 6353: my ($symb,$namespace,$domain,$stuname) = @_;
6354: my $home='';
6355:
1.168 albertel 6356: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6357:
1.122 albertel 6358: if (!$symb) {
1.1224 raeburn 6359: return if ($namespace eq 'courserequests');
6360: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 6361: } else {
1.1224 raeburn 6362: unless ($namespace eq 'courserequests') {
6363: $symb=&escape(&symbclean($symb));
6364: }
1.122 albertel 6365: }
1.188 www 6366: if (!$namespace) {
1.620 albertel 6367: unless ($namespace=$env{'request.course.id'}) {
1.188 www 6368: return '';
6369: }
6370: }
1.620 albertel 6371: if (!$domain) { $domain=$env{'user.domain'}; }
6372: if (!$stuname) { $stuname=$env{'user.name'}; }
6373: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 6374: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
6375:
1.12 www 6376: my %returnhash=();
1.800 albertel 6377: foreach my $line (split(/\&/,$answer)) {
6378: my ($name,$value)=split(/\=/,$line);
1.591 albertel 6379: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 6380: }
1.75 www 6381: my $version;
6382: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 6383: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
6384: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 6385: }
1.75 www 6386: }
1.13 www 6387: return %returnhash;
1.34 www 6388: }
6389:
6390: # ---------------------------------------------------------- Course Description
1.1118 foxr 6391: #
6392: #
1.34 www 6393:
6394: sub coursedescription {
1.731 albertel 6395: my ($courseid,$args)=@_;
1.34 www 6396: $courseid=~s/^\///;
1.49 www 6397: $courseid=~s/\_/\//g;
1.34 www 6398: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 6399: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 6400: my $normalid=$cdomain.'_'.$cnum;
6401: # need to always cache even if we get errors otherwise we keep
6402: # trying and trying and trying to get the course description.
6403: my %envhash=();
6404: my %returnhash=();
1.731 albertel 6405:
6406: my $expiretime=600;
6407: if ($env{'request.course.id'} eq $normalid) {
6408: $expiretime=120;
6409: }
6410:
6411: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
6412: if (!$args->{'freshen_cache'}
6413: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
6414: foreach my $key (keys(%env)) {
6415: next if ($key !~ /^\Q$prefix\E(.*)/);
6416: my ($setting) = $1;
6417: $returnhash{$setting} = $env{$key};
6418: }
6419: return %returnhash;
6420: }
6421:
1.1118 foxr 6422: # get the data again
6423:
1.731 albertel 6424: if (!$args->{'one_time'}) {
6425: $envhash{'course.'.$normalid.'.last_cache'}=time;
6426: }
1.811 albertel 6427:
1.34 www 6428: if ($chome ne 'no_host') {
1.302 albertel 6429: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 6430: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 6431: my $username = $env{'user.name'}; # Defult username
6432: if(defined $args->{'user'}) {
6433: $username = $args->{'user'};
6434: }
1.129 albertel 6435: $returnhash{'home'}= $chome;
6436: $returnhash{'domain'} = $cdomain;
6437: $returnhash{'num'} = $cnum;
1.741 raeburn 6438: if (!defined($returnhash{'type'})) {
6439: $returnhash{'type'} = 'Course';
6440: }
1.130 albertel 6441: while (my ($name,$value) = each %returnhash) {
1.53 www 6442: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 6443: }
1.270 www 6444: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 6445: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 6446: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 6447: $envhash{'course.'.$normalid.'.home'}=$chome;
6448: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
6449: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 6450: }
6451: }
1.731 albertel 6452: if (!$args->{'one_time'}) {
1.949 raeburn 6453: &appenv(\%envhash);
1.731 albertel 6454: }
1.302 albertel 6455: return %returnhash;
1.461 www 6456: }
6457:
1.1080 raeburn 6458: sub update_released_required {
6459: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
6460: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
6461: $cid = $env{'request.course.id'};
6462: $cdom = $env{'course.'.$cid.'.domain'};
6463: $cnum = $env{'course.'.$cid.'.num'};
6464: $chome = $env{'course.'.$cid.'.home'};
6465: }
6466: if ($needsrelease) {
6467: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
6468: my $needsupdate;
6469: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
6470: $needsupdate = 1;
6471: } else {
6472: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
6473: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
6474: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
6475: $needsupdate = 1;
6476: }
6477: }
6478: if ($needsupdate) {
6479: my %needshash = (
6480: 'internal.releaserequired' => $needsrelease,
6481: );
6482: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
6483: if ($putresult eq 'ok') {
6484: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
6485: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6486: if (ref($crsinfo{$cid}) eq 'HASH') {
6487: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
6488: &courseidput($cdom,\%crsinfo,$chome,'notime');
6489: }
6490: }
6491: }
6492: }
6493: return;
6494: }
6495:
1.461 www 6496: # -------------------------------------------------See if a user is privileged
6497:
6498: sub privileged {
1.1219 raeburn 6499: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 6500: my $now = time;
1.1219 raeburn 6501: my $roles;
6502: if (ref($possroles) eq 'ARRAY') {
6503: $roles = $possroles;
6504: } else {
6505: $roles = ['dc','su'];
6506: }
6507: if (ref($possdomains) eq 'ARRAY') {
6508: my %privileged = &privileged_by_domain($possdomains,$roles);
6509: foreach my $dom (@{$possdomains}) {
6510: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
6511: (ref($privileged{$dom}) eq 'HASH')) {
6512: foreach my $role (@{$roles}) {
6513: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6514: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
6515: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
6516: return 1 unless (($end && $end < $now) ||
6517: ($start && $start > $now));
6518: }
6519: }
6520: }
6521: }
6522: }
6523: } else {
6524: my %rolesdump = &dump("roles", $domain, $username) or return 0;
6525: my $now = time;
1.1170 droeschl 6526:
1.1275 musolffc 6527: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 6528: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 6529: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 6530: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 6531: or ($tstart && $tstart > $now);
1.1170 droeschl 6532: }
1.1219 raeburn 6533: }
6534: }
6535: return 0;
6536: }
1.1170 droeschl 6537:
1.1219 raeburn 6538: sub privileged_by_domain {
6539: my ($domains,$roles) = @_;
6540: my %privileged = ();
6541: my $cachetime = 60*60*24;
6542: my $now = time;
6543: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
6544: return %privileged;
6545: }
6546: foreach my $dom (@{$domains}) {
6547: next if (ref($privileged{$dom}) eq 'HASH');
6548: my $needroles;
6549: foreach my $role (@{$roles}) {
6550: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
6551: if (defined($cached)) {
6552: if (ref($result) eq 'HASH') {
6553: $privileged{$dom}{$role} = $result;
6554: }
6555: } else {
6556: $needroles = 1;
6557: }
6558: }
6559: if ($needroles) {
6560: my %dompersonnel = &get_domain_roles($dom,$roles);
6561: $privileged{$dom} = {};
6562: foreach my $server (keys(%dompersonnel)) {
6563: if (ref($dompersonnel{$server}) eq 'HASH') {
6564: foreach my $item (keys(%{$dompersonnel{$server}})) {
6565: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
6566: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
6567: next if ($end && $end < $now);
6568: $privileged{$dom}{$trole}{$uname.':'.$udom} =
6569: $dompersonnel{$server}{$item};
6570: }
6571: }
6572: }
6573: if (ref($privileged{$dom}) eq 'HASH') {
6574: foreach my $role (@{$roles}) {
6575: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6576: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
6577: } else {
6578: my %hash = ();
6579: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
6580: }
6581: }
6582: }
6583: }
6584: }
6585: return %privileged;
1.9 www 6586: }
1.1 albertel 6587:
1.103 harris41 6588: # -------------------------------------------------------- Get user privileges
1.11 www 6589:
6590: sub rolesinit {
1.1169 droeschl 6591: my ($domain, $username) = @_;
6592: my %userroles = ('user.login.time' => time);
6593: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
6594:
6595: # firstaccess and timerinterval are related to timed maps/resources.
6596: # also, blocking can be triggered by an activating timer
6597: # it's saved in the user's %env.
6598: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
6599: my %timerinterval = &dump('timerinterval', $domain, $username);
6600: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
6601: %timerintchk, %timerintenv);
6602:
1.1162 raeburn 6603: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 6604: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 6605: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
6606: }
1.1169 droeschl 6607:
1.1162 raeburn 6608: foreach my $key (keys(%timerinterval)) {
6609: my ($cid,$rest) = split(/\0/,$key);
6610: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
6611: }
1.1169 droeschl 6612:
1.11 www 6613: my %allroles=();
1.1162 raeburn 6614: my %allgroups=();
1.11 www 6615:
1.1274 raeburn 6616: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 6617: my $role = $rolesdump{$area};
6618: $area =~ s/\_\w\w$//;
6619:
6620: my ($trole, $tend, $tstart, $group_privs);
6621:
6622: if ($role =~ /^cr/) {
6623: # Custom role, defined by a user
6624: # e.g., user.role.cr/msu/smith/mynewrole
6625: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
6626: $trole = $1;
6627: ($tend, $tstart) = split('_', $2);
6628: } else {
6629: $trole = $role;
6630: }
6631: } elsif ($role =~ m|^gr/|) {
6632: # Role of member in a group, defined within a course/community
6633: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
6634: ($trole, $tend, $tstart) = split(/_/, $role);
6635: next if $tstart eq '-1';
6636: ($trole, $group_privs) = split(/\//, $trole);
6637: $group_privs = &unescape($group_privs);
6638: } else {
6639: # Just a normal role, defined in roles.tab
6640: ($trole, $tend, $tstart) = split(/_/,$role);
6641: }
6642:
6643: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
6644: $username);
6645: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
6646:
6647: # role expired or not available yet?
6648: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
6649: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
6650:
6651: next if $area eq '' or $trole eq '';
6652:
6653: my $spec = "$trole.$area";
6654: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
6655:
6656: if ($trole =~ /^cr\//) {
6657: # Custom role, defined by a user
6658: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6659: } elsif ($trole eq 'gr') {
6660: # Role of a member in a group, defined within a course/community
6661: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
6662: next;
6663: } else {
6664: # Normal role, defined in roles.tab
6665: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6666: }
6667:
6668: my $cid = $tdomain.'_'.$trest;
6669: unless ($firstaccchk{$cid}) {
6670: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6671: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6672: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6673: $coursetimerstarts{$cid}{$item};
6674: }
6675: }
6676: $firstaccchk{$cid} = 1;
6677: }
6678: unless ($timerintchk{$cid}) {
6679: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6680: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6681: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6682: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 6683: }
1.12 www 6684: }
1.1169 droeschl 6685: $timerintchk{$cid} = 1;
1.191 harris41 6686: }
1.11 www 6687: }
1.1169 droeschl 6688:
1.1341 raeburn 6689: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6690: \%allroles, \%allgroups);
1.1169 droeschl 6691: $env{'user.adv'} = $userroles{'user.adv'};
1.1341 raeburn 6692: $env{'user.rar'} = $userroles{'user.rar'};
1.1169 droeschl 6693:
1.1162 raeburn 6694: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 6695: }
6696:
1.567 raeburn 6697: sub set_arearole {
1.1215 raeburn 6698: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6699: unless ($nolog) {
1.567 raeburn 6700: # log the associated role with the area
1.1215 raeburn 6701: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6702: }
1.743 albertel 6703: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 6704: }
6705:
6706: sub custom_roleprivs {
6707: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6708: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250 raeburn 6709: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 6710: if (&hostname($homsvr) ne '') {
1.567 raeburn 6711: my ($rdummy,$roledef)=
6712: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6713: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6714: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6715: if (defined($syspriv)) {
1.1043 raeburn 6716: if ($trest =~ /^$match_community$/) {
6717: $syspriv =~ s/bre\&S//;
6718: }
1.567 raeburn 6719: $$allroles{'cm./'}.=':'.$syspriv;
6720: $$allroles{$spec.'./'}.=':'.$syspriv;
6721: }
6722: if ($tdomain ne '') {
6723: if (defined($dompriv)) {
6724: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6725: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6726: }
6727: if (($trest ne '') && (defined($coursepriv))) {
1.1332 raeburn 6728: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6729: my $rolename = $1;
6730: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6731: }
1.567 raeburn 6732: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6733: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6734: }
6735: }
6736: }
6737: }
6738: }
6739:
1.1332 raeburn 6740: sub course_adhocrole_privs {
6741: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6742: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6743: if ($overrides{"internal.adhocpriv.$rolename"}) {
6744: my (%currprivs,%storeprivs);
6745: foreach my $item (split(/:/,$coursepriv)) {
6746: my ($priv,$restrict) = split(/\&/,$item);
6747: $currprivs{$priv} = $restrict;
6748: }
6749: my (%possadd,%possremove,%full);
6750: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6751: my ($priv,$restrict)=split(/\&/,$item);
6752: $full{$priv} = $restrict;
6753: }
6754: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
6755: next if ($item eq '');
6756: my ($rule,$rest) = split(/=/,$item);
6757: next unless (($rule eq 'off') || ($rule eq 'on'));
6758: foreach my $priv (split(/:/,$rest)) {
6759: if ($priv ne '') {
6760: if ($rule eq 'off') {
6761: $possremove{$priv} = 1;
6762: } else {
6763: $possadd{$priv} = 1;
6764: }
6765: }
6766: }
6767: }
6768: foreach my $priv (sort(keys(%full))) {
6769: if (exists($currprivs{$priv})) {
6770: unless (exists($possremove{$priv})) {
6771: $storeprivs{$priv} = $currprivs{$priv};
6772: }
6773: } elsif (exists($possadd{$priv})) {
6774: $storeprivs{$priv} = $full{$priv};
6775: }
6776: }
6777: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6778: }
6779: return $coursepriv;
6780: }
6781:
1.678 raeburn 6782: sub group_roleprivs {
6783: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6784: my $access = 1;
6785: my $now = time;
6786: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6787: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6788: if ($access) {
1.811 albertel 6789: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 6790: $$allgroups{$course}{$group} .=':'.$group_privs;
6791: }
6792: }
1.567 raeburn 6793:
6794: sub standard_roleprivs {
6795: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6796: if (defined($pr{$trole.':s'})) {
6797: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6798: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6799: }
6800: if ($tdomain ne '') {
6801: if (defined($pr{$trole.':d'})) {
6802: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6803: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6804: }
6805: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6806: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6807: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
6808: }
6809: }
6810: }
6811:
6812: sub set_userprivs {
1.1064 raeburn 6813: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 6814: my $author=0;
6815: my $adv=0;
1.1341 raeburn 6816: my $rar=0;
1.678 raeburn 6817: my %grouproles = ();
6818: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 6819: my @groupkeys;
1.1000 raeburn 6820: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 6821: push(@groupkeys,$role);
6822: }
6823: if (ref($groups_roles) eq 'HASH') {
6824: foreach my $key (keys(%{$groups_roles})) {
6825: unless (grep(/^\Q$key\E$/,@groupkeys)) {
6826: push(@groupkeys,$key);
6827: }
6828: }
6829: }
6830: if (@groupkeys > 0) {
6831: foreach my $role (@groupkeys) {
6832: my ($trole,$area,$sec,$extendedarea);
6833: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
6834: $trole = $1;
6835: $area = $2;
6836: $sec = $3;
6837: $extendedarea = $area.$sec;
6838: if (exists($$allgroups{$area})) {
6839: foreach my $group (keys(%{$$allgroups{$area}})) {
6840: my $spec = $trole.'.'.$extendedarea;
6841: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 6842: $$allgroups{$area}{$group};
1.1064 raeburn 6843: }
1.678 raeburn 6844: }
6845: }
6846: }
6847: }
6848: }
1.800 albertel 6849: foreach my $group (keys(%grouproles)) {
6850: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 6851: }
1.800 albertel 6852: foreach my $role (keys(%{$allroles})) {
6853: my %thesepriv;
1.941 raeburn 6854: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 6855: foreach my $item (split(/:/,$$allroles{$role})) {
6856: if ($item ne '') {
6857: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 6858: if ($restrictions eq '') {
6859: $thesepriv{$privilege}='F';
6860: } elsif ($thesepriv{$privilege} ne 'F') {
6861: $thesepriv{$privilege}.=$restrictions;
6862: }
6863: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1341 raeburn 6864: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567 raeburn 6865: }
6866: }
6867: my $thesestr='';
1.1104 raeburn 6868: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 6869: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
6870: }
6871: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 6872: }
1.1341 raeburn 6873: return ($author,$adv,$rar);
1.567 raeburn 6874: }
6875:
1.994 raeburn 6876: sub role_status {
1.1104 raeburn 6877: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 6878: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250 raeburn 6879: my ($one,$two) = split(m{\./},$rolekey,2);
6880: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 6881: unless (!defined($$role) || $$role eq '') {
1.1251 raeburn 6882: $$where = '/'.$two;
1.994 raeburn 6883: $$trolecode=$$role.'.'.$$where;
6884: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
6885: $$tstatus='is';
1.1104 raeburn 6886: if ($$tstart && $$tstart>$update) {
1.994 raeburn 6887: $$tstatus='future';
1.1034 raeburn 6888: if ($$tstart<$now) {
6889: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 6890: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 6891: my (%allroles,%allgroups,$group_privs,
6892: %groups_roles,@rolecodes);
1.1002 raeburn 6893: my %userroles = (
6894: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
6895: );
1.1064 raeburn 6896: @rolecodes = ('cm');
1.1002 raeburn 6897: my $spec=$$role.'.'.$$where;
6898: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
6899: if ($$role =~ /^cr\//) {
6900: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 6901: push(@rolecodes,'cr');
1.1002 raeburn 6902: } elsif ($$role eq 'gr') {
1.1064 raeburn 6903: push(@rolecodes,$$role);
1.1002 raeburn 6904: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
6905: $env{'user.name'});
1.1064 raeburn 6906: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 6907: (undef,my $group_privs) = split(/\//,$trole);
6908: $group_privs = &unescape($group_privs);
6909: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 6910: 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 6911: &get_groups_roles($tdomain,$trest,
6912: \%course_roles,\@rolecodes,
6913: \%groups_roles);
1.1002 raeburn 6914: } else {
1.1064 raeburn 6915: push(@rolecodes,$$role);
1.1002 raeburn 6916: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
6917: }
1.1341 raeburn 6918: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
6919: \%groups_roles);
1.1064 raeburn 6920: &appenv(\%userroles,\@rolecodes);
1.1342 raeburn 6921: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002 raeburn 6922: }
6923: }
1.1034 raeburn 6924: $$tstatus = 'is';
1.1002 raeburn 6925: }
1.994 raeburn 6926: }
6927: if ($$tend) {
1.1104 raeburn 6928: if ($$tend<$update) {
1.994 raeburn 6929: $$tstatus='expired';
6930: } elsif ($$tend<$now) {
6931: $$tstatus='will_not';
6932: }
6933: }
6934: }
6935: }
6936: }
6937:
1.1104 raeburn 6938: sub get_groups_roles {
6939: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
6940: return unless((ref($cdom_courseroles) eq 'HASH') &&
6941: (ref($rolecodes) eq 'ARRAY') &&
6942: (ref($groups_roles) eq 'HASH'));
6943: if (keys(%{$cdom_courseroles}) > 0) {
6944: my ($cnum) = ($rest =~ /^($match_courseid)/);
6945: if ($cdom ne '' && $cnum ne '') {
6946: foreach my $key (keys(%{$cdom_courseroles})) {
6947: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
6948: my $crsrole = $1;
6949: my $crssec = $2;
6950: if ($crsrole =~ /^cr/) {
6951: unless (grep(/^cr$/,@{$rolecodes})) {
6952: push(@{$rolecodes},'cr');
6953: }
6954: } else {
6955: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
6956: push(@{$rolecodes},$crsrole);
6957: }
6958: }
6959: my $rolekey = "$crsrole./$cdom/$cnum";
6960: if ($crssec ne '') {
6961: $rolekey .= "/$crssec";
6962: }
6963: $rolekey .= './';
6964: $groups_roles->{$rolekey} = $rolecodes;
6965: }
6966: }
6967: }
6968: }
6969: return;
6970: }
6971:
6972: sub delete_env_groupprivs {
6973: my ($where,$courseroles,$possroles) = @_;
6974: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
6975: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
6976: unless (ref($courseroles->{$udom}) eq 'HASH') {
6977: %{$courseroles->{$udom}} =
6978: &get_my_roles('','','userroles',['active'],
6979: $possroles,[$udom],1);
6980: }
6981: if (ref($courseroles->{$udom}) eq 'HASH') {
6982: foreach my $item (keys(%{$courseroles->{$udom}})) {
6983: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
6984: my $area = '/'.$cdom.'/'.$cnum;
6985: my $privkey = "user.priv.$crsrole.$area";
6986: if ($crssec ne '') {
6987: $privkey .= '/'.$crssec;
6988: }
6989: $privkey .= ".$area/$group";
6990: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
6991: }
6992: }
6993: return;
6994: }
6995:
1.994 raeburn 6996: sub check_adhoc_privs {
1.1329 raeburn 6997: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 6998: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1329 raeburn 6999: if ($sec) {
7000: $cckey .= '/'.$sec;
7001: }
1.1185 raeburn 7002: my $setprivs;
1.994 raeburn 7003: if ($env{$cckey}) {
7004: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 7005: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 7006: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1329 raeburn 7007: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7008: $setprivs = 1;
1.994 raeburn 7009: }
7010: } else {
1.1330 raeburn 7011: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7012: $setprivs = 1;
1.994 raeburn 7013: }
1.1185 raeburn 7014: return $setprivs;
1.994 raeburn 7015: }
7016:
7017: sub set_adhoc_privileges {
1.1326 raeburn 7018: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1329 raeburn 7019: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 7020: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1329 raeburn 7021: if ($sec ne '') {
7022: $area .= '/'.$sec;
7023: }
1.994 raeburn 7024: my $spec = $role.'.'.$area;
7025: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 7026: $env{'user.name'},1);
1.1326 raeburn 7027: my %rolehash = ();
1.1332 raeburn 7028: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
7029: my $rolename = $1;
1.1326 raeburn 7030: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1332 raeburn 7031: my %domdef = &get_domain_defaults($dcdom);
7032: if (ref($domdef{'adhocroles'}) eq 'HASH') {
7033: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
7034: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
7035: }
7036: }
1.1326 raeburn 7037: } else {
7038: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
7039: }
1.1341 raeburn 7040: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 7041: &appenv(\%userroles,[$role,'cm']);
1.1342 raeburn 7042: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1402 raeburn 7043: unless (($caller eq 'constructaccess' && $env{'request.course.id'}) ||
7044: ($caller eq 'tiny')) {
1.1088 raeburn 7045: &appenv( {'request.role' => $spec,
7046: 'request.role.domain' => $dcdom,
1.1332 raeburn 7047: 'request.course.sec' => $sec,
1.1088 raeburn 7048: }
7049: );
7050: my $tadv=0;
7051: if (&allowed('adv') eq 'F') { $tadv=1; }
7052: &appenv({'request.role.adv' => $tadv});
7053: }
1.994 raeburn 7054: }
7055:
1.12 www 7056: # --------------------------------------------------------------- get interface
7057:
7058: sub get {
1.131 albertel 7059: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7060: my $items='';
1.800 albertel 7061: foreach my $item (@$storearr) {
7062: $items.=&escape($item).'&';
1.191 harris41 7063: }
1.12 www 7064: $items=~s/\&$//;
1.620 albertel 7065: if (!$udomain) { $udomain=$env{'user.domain'}; }
7066: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 7067: my $uhome=&homeserver($uname,$udomain);
7068:
1.133 albertel 7069: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7070: my @pairs=split(/\&/,$rep);
1.273 albertel 7071: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
7072: return @pairs;
7073: }
1.15 www 7074: my %returnhash=();
1.42 www 7075: my $i=0;
1.800 albertel 7076: foreach my $item (@$storearr) {
7077: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7078: $i++;
1.191 harris41 7079: }
1.15 www 7080: return %returnhash;
1.27 www 7081: }
7082:
7083: # --------------------------------------------------------------- del interface
7084:
7085: sub del {
1.133 albertel 7086: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 7087: my $items='';
1.800 albertel 7088: foreach my $item (@$storearr) {
7089: $items.=&escape($item).'&';
1.191 harris41 7090: }
1.984 neumanie 7091:
1.27 www 7092: $items=~s/\&$//;
1.620 albertel 7093: if (!$udomain) { $udomain=$env{'user.domain'}; }
7094: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7095: my $uhome=&homeserver($uname,$udomain);
7096: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7097: }
7098:
7099: # -------------------------------------------------------------- dump interface
7100:
1.1180 droeschl 7101: sub unserialize {
7102: my ($rep, $escapedkeys) = @_;
7103:
7104: return {} if $rep =~ /^error/;
7105:
7106: my %returnhash=();
1.1252 raeburn 7107: foreach my $item (split(/\&/,$rep)) {
1.1180 droeschl 7108: my ($key, $value) = split(/=/, $item, 2);
7109: $key = unescape($key) unless $escapedkeys;
7110: next if $key =~ /^error: 2 /;
1.1252 raeburn 7111: $returnhash{$key} = &thaw_unescape($value);
1.1180 droeschl 7112: }
7113: #return %returnhash;
7114: return \%returnhash;
7115: }
7116:
7117: # see Lond::dump_with_regexp
7118: # if $escapedkeys hash keys won't get unescaped.
1.15 www 7119: sub dump {
1.1180 droeschl 7120: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755 albertel 7121: if (!$udomain) { $udomain=$env{'user.domain'}; }
7122: if (!$uname) { $uname=$env{'user.name'}; }
7123: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 7124:
1.1266 raeburn 7125: if ($regexp) {
7126: $regexp=&escape($regexp);
7127: } else {
7128: $regexp='.';
7129: }
1.1180 droeschl 7130: if (grep { $_ eq $uhome } current_machine_ids()) {
7131: # user is hosted on this machine
1.1266 raeburn 7132: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 7133: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 7134: return %{unserialize($reply, $escapedkeys)};
7135: }
1.1166 raeburn 7136: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 7137: my @pairs=split(/\&/,$rep);
7138: my %returnhash=();
1.1098 foxr 7139: if (!($rep =~ /^error/ )) {
7140: foreach my $item (@pairs) {
7141: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 7142: $key = unescape($key) unless $escapedkeys;
7143: #$key = &unescape($key);
1.1098 foxr 7144: next if ($key =~ /^error: 2 /);
7145: $returnhash{$key}=&thaw_unescape($value);
7146: }
1.755 albertel 7147: }
7148: return %returnhash;
1.407 www 7149: }
7150:
1.1098 foxr 7151:
1.717 albertel 7152: # --------------------------------------------------------- dumpstore interface
7153:
7154: sub dumpstore {
7155: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 7156: # same as dump but keys must be escaped. They may contain colon separated
7157: # lists of values that may themself contain colons (e.g. symbs).
7158: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 7159: }
7160:
1.407 www 7161: # -------------------------------------------------------------- keys interface
7162:
7163: sub getkeys {
7164: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 7165: if (!$udomain) { $udomain=$env{'user.domain'}; }
7166: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 7167: my $uhome=&homeserver($uname,$udomain);
7168: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
7169: my @keyarray=();
1.800 albertel 7170: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 7171: next if ($key =~ /^error: 2 /);
1.800 albertel 7172: push(@keyarray,&unescape($key));
1.407 www 7173: }
7174: return @keyarray;
1.318 matthew 7175: }
7176:
1.319 matthew 7177: # --------------------------------------------------------------- currentdump
7178: sub currentdump {
1.328 matthew 7179: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 7180: $courseid = $env{'request.course.id'} if (! defined($courseid));
7181: $sdom = $env{'user.domain'} if (! defined($sdom));
7182: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 7183: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 7184: my $rep;
7185:
7186: if (grep { $_ eq $uhome } current_machine_ids()) {
7187: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
7188: $courseid)));
7189: } else {
7190: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
7191: }
7192:
1.318 matthew 7193: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 7194: #
1.318 matthew 7195: my %returnhash=();
1.319 matthew 7196: #
1.1343 raeburn 7197: if ($rep eq 'unknown_cmd') {
1.319 matthew 7198: # an old lond will not know currentdump
7199: # Do a dump and make it look like a currentdump
1.822 albertel 7200: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 7201: return if ($tmp[0] =~ /^(error:|no_such_host)/);
7202: my %hash = @tmp;
7203: @tmp=();
1.424 matthew 7204: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 7205: } else {
7206: my @pairs=split(/\&/,$rep);
1.800 albertel 7207: foreach my $pair (@pairs) {
7208: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 7209: my ($symb,$param) = split(/:/,$key);
7210: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 7211: &thaw_unescape($value);
1.319 matthew 7212: }
1.191 harris41 7213: }
1.12 www 7214: return %returnhash;
1.424 matthew 7215: }
7216:
7217: sub convert_dump_to_currentdump{
7218: my %hash = %{shift()};
7219: my %returnhash;
7220: # Code ripped from lond, essentially. The only difference
7221: # here is the unescaping done by lonnet::dump(). Conceivably
7222: # we might run in to problems with parameter names =~ /^v\./
7223: while (my ($key,$value) = each(%hash)) {
7224: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 7225: $symb = &unescape($symb);
7226: $param = &unescape($param);
1.424 matthew 7227: next if ($v eq 'version' || $symb eq 'keys');
7228: next if (exists($returnhash{$symb}) &&
7229: exists($returnhash{$symb}->{$param}) &&
7230: $returnhash{$symb}->{'v.'.$param} > $v);
7231: $returnhash{$symb}->{$param}=$value;
7232: $returnhash{$symb}->{'v.'.$param}=$v;
7233: }
7234: #
7235: # Remove all of the keys in the hashes which keep track of
7236: # the version of the parameter.
7237: while (my ($symb,$param_hash) = each(%returnhash)) {
7238: # use a foreach because we are going to delete from the hash.
7239: foreach my $key (keys(%$param_hash)) {
7240: delete($param_hash->{$key}) if ($key =~ /^v\./);
7241: }
7242: }
7243: return \%returnhash;
1.12 www 7244: }
7245:
1.627 albertel 7246: # ------------------------------------------------------ critical inc interface
7247:
7248: sub cinc {
7249: return &inc(@_,'critical');
7250: }
7251:
1.449 matthew 7252: # --------------------------------------------------------------- inc interface
7253:
7254: sub inc {
1.627 albertel 7255: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 7256: if (!$udomain) { $udomain=$env{'user.domain'}; }
7257: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 7258: my $uhome=&homeserver($uname,$udomain);
7259: my $items='';
7260: if (! ref($store)) {
7261: # got a single value, so use that instead
7262: $items = &escape($store).'=&';
7263: } elsif (ref($store) eq 'SCALAR') {
7264: $items = &escape($$store).'=&';
7265: } elsif (ref($store) eq 'ARRAY') {
7266: $items = join('=&',map {&escape($_);} @{$store});
7267: } elsif (ref($store) eq 'HASH') {
7268: while (my($key,$value) = each(%{$store})) {
7269: $items.= &escape($key).'='.&escape($value).'&';
7270: }
7271: }
7272: $items=~s/\&$//;
1.627 albertel 7273: if ($critical) {
7274: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
7275: } else {
7276: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
7277: }
1.449 matthew 7278: }
7279:
1.12 www 7280: # --------------------------------------------------------------- put interface
7281:
7282: sub put {
1.134 albertel 7283: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 7284: if (!$udomain) { $udomain=$env{'user.domain'}; }
7285: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7286: my $uhome=&homeserver($uname,$udomain);
1.12 www 7287: my $items='';
1.800 albertel 7288: foreach my $item (keys(%$storehash)) {
7289: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7290: }
1.12 www 7291: $items=~s/\&$//;
1.134 albertel 7292: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 7293: }
7294:
1.631 albertel 7295: # ------------------------------------------------------------ newput interface
7296:
7297: sub newput {
7298: my ($namespace,$storehash,$udomain,$uname)=@_;
7299: if (!$udomain) { $udomain=$env{'user.domain'}; }
7300: if (!$uname) { $uname=$env{'user.name'}; }
7301: my $uhome=&homeserver($uname,$udomain);
7302: my $items='';
7303: foreach my $key (keys(%$storehash)) {
7304: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7305: }
7306: $items=~s/\&$//;
7307: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
7308: }
7309:
7310: # --------------------------------------------------------- putstore interface
7311:
1.524 raeburn 7312: sub putstore {
1.1269 raeburn 7313: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 7314: if (!$udomain) { $udomain=$env{'user.domain'}; }
7315: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 7316: my $uhome=&homeserver($uname,$udomain);
7317: my $items='';
1.715 albertel 7318: foreach my $key (keys(%$storehash)) {
7319: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 7320: }
1.715 albertel 7321: $items=~s/\&$//;
1.716 albertel 7322: my $esc_symb=&escape($symb);
7323: my $esc_v=&escape($version);
1.715 albertel 7324: my $reply =
1.716 albertel 7325: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 7326: $uhome);
1.1269 raeburn 7327: if (($tolog) && ($reply eq 'ok')) {
7328: my $namevalue='';
7329: foreach my $key (keys(%{$storehash})) {
7330: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7331: }
1.1434 raeburn 7332: my $ip = &get_requestor_ip();
7333: $namevalue .= 'ip='.&escape($ip).
1.1269 raeburn 7334: '&host='.&escape($perlvar{'lonHostID'}).
7335: '&version='.$esc_v.
7336: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
7337: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
7338: }
1.715 albertel 7339: if ($reply eq 'unknown_cmd') {
1.716 albertel 7340: # gfall back to way things use to be done
1.715 albertel 7341: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
7342: $uname);
1.524 raeburn 7343: }
1.715 albertel 7344: return $reply;
7345: }
7346:
7347: sub old_putstore {
1.716 albertel 7348: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
7349: if (!$udomain) { $udomain=$env{'user.domain'}; }
7350: if (!$uname) { $uname=$env{'user.name'}; }
7351: my $uhome=&homeserver($uname,$udomain);
7352: my %newstorehash;
1.800 albertel 7353: foreach my $item (keys(%$storehash)) {
7354: my $key = $version.':'.&escape($symb).':'.$item;
7355: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 7356: }
7357: my $items='';
7358: my %allitems = ();
1.800 albertel 7359: foreach my $item (keys(%newstorehash)) {
7360: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 7361: my $key = $1.':keys:'.$2;
7362: $allitems{$key} .= $3.':';
7363: }
1.800 albertel 7364: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 7365: }
1.800 albertel 7366: foreach my $item (keys(%allitems)) {
7367: $allitems{$item} =~ s/\:$//;
7368: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 7369: }
7370: $items=~s/\&$//;
7371: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 7372: }
7373:
1.47 www 7374: # ------------------------------------------------------ critical put interface
7375:
7376: sub cput {
1.134 albertel 7377: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 7378: if (!$udomain) { $udomain=$env{'user.domain'}; }
7379: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7380: my $uhome=&homeserver($uname,$udomain);
1.47 www 7381: my $items='';
1.800 albertel 7382: foreach my $item (keys(%$storehash)) {
7383: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7384: }
1.47 www 7385: $items=~s/\&$//;
1.134 albertel 7386: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7387: }
7388:
7389: # -------------------------------------------------------------- eget interface
7390:
7391: sub eget {
1.133 albertel 7392: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7393: my $items='';
1.800 albertel 7394: foreach my $item (@$storearr) {
7395: $items.=&escape($item).'&';
1.191 harris41 7396: }
1.12 www 7397: $items=~s/\&$//;
1.620 albertel 7398: if (!$udomain) { $udomain=$env{'user.domain'}; }
7399: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7400: my $uhome=&homeserver($uname,$udomain);
7401: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7402: my @pairs=split(/\&/,$rep);
7403: my %returnhash=();
1.42 www 7404: my $i=0;
1.800 albertel 7405: foreach my $item (@$storearr) {
7406: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7407: $i++;
1.191 harris41 7408: }
1.12 www 7409: return %returnhash;
7410: }
7411:
1.667 albertel 7412: # ------------------------------------------------------------ tmpput interface
7413: sub tmpput {
1.802 raeburn 7414: my ($storehash,$server,$context)=@_;
1.667 albertel 7415: my $items='';
1.800 albertel 7416: foreach my $item (keys(%$storehash)) {
7417: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 7418: }
7419: $items=~s/\&$//;
1.802 raeburn 7420: if (defined($context)) {
7421: $items .= ':'.&escape($context);
7422: }
1.667 albertel 7423: return &reply("tmpput:$items",$server);
7424: }
7425:
7426: # ------------------------------------------------------------ tmpget interface
7427: sub tmpget {
1.688 albertel 7428: my ($token,$server)=@_;
7429: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7430: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 7431: my %returnhash;
1.1328 raeburn 7432: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
7433: return %returnhash;
7434: }
1.667 albertel 7435: foreach my $item (split(/\&/,$rep)) {
7436: my ($key,$value)=split(/=/,$item);
7437: $returnhash{&unescape($key)}=&thaw_unescape($value);
7438: }
7439: return %returnhash;
7440: }
7441:
1.1113 raeburn 7442: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 7443: sub tmpdel {
7444: my ($token,$server)=@_;
7445: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7446: return &reply("tmpdel:$token",$server);
7447: }
7448:
1.1198 raeburn 7449: # ------------------------------------------------------------ get_timebased_id
7450:
7451: sub get_timebased_id {
7452: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
7453: $maxtries) = @_;
7454: my ($newid,$error,$dellock);
7455: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
7456: return ('','ok','invalid call to get suffix');
7457: }
7458:
7459: # set defaults for any optional args for which values were not supplied
7460: if ($who eq '') {
7461: $who = $env{'user.name'}.':'.$env{'user.domain'};
7462: }
7463: if (!$locktries) {
7464: $locktries = 3;
7465: }
7466: if (!$maxtries) {
7467: $maxtries = 10;
7468: }
7469:
7470: if (($cdom eq '') || ($cnum eq '')) {
7471: if ($env{'request.course.id'}) {
7472: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7473: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7474: }
7475: if (($cdom eq '') || ($cnum eq '')) {
7476: return ('','ok','call to get suffix not in course context');
7477: }
7478: }
7479:
7480: # construct locking item
7481: my $lockhash = {
7482: $prefix."\0".'locked_'.$keyid => $who,
7483: };
7484: my $tries = 0;
7485:
7486: # attempt to get lock on nohist_$namespace file
7487: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7488: while (($gotlock ne 'ok') && $tries <$locktries) {
7489: $tries ++;
7490: sleep 1;
7491: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
7492: }
7493:
7494: # attempt to get unique identifier, based on current timestamp
7495: if ($gotlock eq 'ok') {
7496: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
7497: my $id = time;
7498: $newid = $id;
1.1268 raeburn 7499: if ($idtype eq 'addcode') {
7500: $newid .= &sixnum_code();
7501: }
1.1198 raeburn 7502: my $idtries = 0;
7503: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
7504: if ($idtype eq 'concat') {
7505: $newid = $id.$idtries;
1.1268 raeburn 7506: } elsif ($idtype eq 'addcode') {
7507: $newid = $newid.&sixnum_code();
1.1198 raeburn 7508: } else {
7509: $newid ++;
7510: }
7511: $idtries ++;
7512: }
7513: if (!exists($inuse{$prefix."\0".$newid})) {
7514: my %new_item = (
7515: $prefix."\0".$newid => $who,
7516: );
7517: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
7518: $cdom,$cnum);
7519: if ($putresult ne 'ok') {
7520: undef($newid);
7521: $error = 'error saving new item: '.$putresult;
7522: }
7523: } else {
1.1268 raeburn 7524: undef($newid);
1.1198 raeburn 7525: $error = ('error: no unique suffix available for the new item ');
7526: }
7527: # remove lock
7528: my @del_lock = ($prefix."\0".'locked_'.$keyid);
7529: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
7530: } else {
7531: $error = "error: could not obtain lockfile\n";
7532: $dellock = 'ok';
1.1276 raeburn 7533: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
7534: $dellock = 'nolock';
7535: }
1.1198 raeburn 7536: }
7537: return ($newid,$dellock,$error);
7538: }
7539:
1.1268 raeburn 7540: sub sixnum_code {
7541: my $code;
7542: for (0..6) {
7543: $code .= int( rand(9) );
7544: }
7545: return $code;
7546: }
7547:
1.765 albertel 7548: # -------------------------------------------------- portfolio access checking
7549:
7550: sub portfolio_access {
1.1270 raeburn 7551: my ($requrl,$clientip) = @_;
1.765 albertel 7552: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270 raeburn 7553: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 7554: if ($result) {
7555: my %setters;
7556: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7557: my ($startblock,$endblock) =
7558: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
7559: if ($startblock && $endblock) {
7560: return 'B';
7561: }
7562: } else {
7563: my ($startblock,$endblock) =
7564: &Apache::loncommon::blockcheck(\%setters,'port');
7565: if ($startblock && $endblock) {
7566: return 'B';
7567: }
7568: }
7569: }
1.765 albertel 7570: if ($result eq 'ok') {
1.766 albertel 7571: return 'F';
1.765 albertel 7572: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 7573: return 'A';
1.765 albertel 7574: }
1.766 albertel 7575: return '';
1.765 albertel 7576: }
7577:
7578: sub get_portfolio_access {
1.1270 raeburn 7579: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 7580:
7581: if (!ref($access_hash)) {
7582: my $current_perms = &get_portfile_permissions($udom,$unum);
7583: my %access_controls = &get_access_controls($current_perms,$group,
7584: $file_name);
7585: $access_hash = $access_controls{$file_name};
7586: }
7587:
1.1270 raeburn 7588: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 7589: my $now = time;
7590: if (ref($access_hash) eq 'HASH') {
7591: foreach my $key (keys(%{$access_hash})) {
7592: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7593: if ($start > $now) {
7594: next;
7595: }
7596: if ($end && $end<$now) {
7597: next;
7598: }
7599: if ($scope eq 'public') {
7600: $public = $key;
7601: last;
7602: } elsif ($scope eq 'guest') {
7603: $guest = $key;
7604: } elsif ($scope eq 'domains') {
7605: push(@domains,$key);
7606: } elsif ($scope eq 'users') {
7607: push(@users,$key);
7608: } elsif ($scope eq 'course') {
7609: push(@courses,$key);
7610: } elsif ($scope eq 'group') {
7611: push(@groups,$key);
1.1270 raeburn 7612: } elsif ($scope eq 'ip') {
7613: push(@ips,$key);
1.765 albertel 7614: }
7615: }
7616: if ($public) {
7617: return 'ok';
1.1270 raeburn 7618: } elsif (@ips > 0) {
7619: my $allowed;
7620: foreach my $ipkey (@ips) {
7621: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
7622: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
7623: $allowed = 1;
7624: last;
7625: }
7626: }
7627: }
7628: if ($allowed) {
7629: return 'ok';
7630: }
1.765 albertel 7631: }
7632: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
7633: if ($guest) {
7634: return $guest;
7635: }
7636: } else {
7637: if (@domains > 0) {
7638: foreach my $domkey (@domains) {
7639: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
7640: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
7641: return 'ok';
7642: }
7643: }
7644: }
7645: }
7646: if (@users > 0) {
7647: foreach my $userkey (@users) {
1.865 raeburn 7648: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
7649: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
7650: if (ref($item) eq 'HASH') {
7651: if (($item->{'uname'} eq $env{'user.name'}) &&
7652: ($item->{'udom'} eq $env{'user.domain'})) {
7653: return 'ok';
7654: }
7655: }
7656: }
7657: }
1.765 albertel 7658: }
7659: }
7660: my %roleshash;
7661: my @courses_and_groups = @courses;
7662: push(@courses_and_groups,@groups);
7663: if (@courses_and_groups > 0) {
7664: my (%allgroups,%allroles);
7665: my ($start,$end,$role,$sec,$group);
7666: foreach my $envkey (%env) {
1.1060 raeburn 7667: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7668: my $cid = $2.'_'.$3;
7669: if ($1 eq 'gr') {
7670: $group = $4;
7671: $allgroups{$cid}{$group} = $env{$envkey};
7672: } else {
7673: if ($4 eq '') {
7674: $sec = 'none';
7675: } else {
7676: $sec = $4;
7677: }
7678: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7679: }
1.811 albertel 7680: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7681: my $cid = $2.'_'.$3;
7682: if ($4 eq '') {
7683: $sec = 'none';
7684: } else {
7685: $sec = $4;
7686: }
7687: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7688: }
7689: }
7690: if (keys(%allroles) == 0) {
7691: return;
7692: }
7693: foreach my $key (@courses_and_groups) {
7694: my %content = %{$$access_hash{$key}};
7695: my $cnum = $content{'number'};
7696: my $cdom = $content{'domain'};
7697: my $cid = $cdom.'_'.$cnum;
7698: if (!exists($allroles{$cid})) {
7699: next;
7700: }
7701: foreach my $role_id (keys(%{$content{'roles'}})) {
7702: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7703: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7704: my @status = @{$content{'roles'}{$role_id}{'access'}};
7705: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7706: foreach my $role (keys(%{$allroles{$cid}})) {
7707: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7708: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7709: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7710: if (grep/^all$/,@sections) {
7711: return 'ok';
7712: } else {
7713: if (grep/^$sec$/,@sections) {
7714: return 'ok';
7715: }
7716: }
7717: }
7718: }
7719: if (keys(%{$allgroups{$cid}}) == 0) {
7720: if (grep/^none$/,@groups) {
7721: return 'ok';
7722: }
7723: } else {
7724: if (grep/^all$/,@groups) {
7725: return 'ok';
7726: }
7727: foreach my $group (keys(%{$allgroups{$cid}})) {
7728: if (grep/^$group$/,@groups) {
7729: return 'ok';
7730: }
7731: }
7732: }
7733: }
7734: }
7735: }
7736: }
7737: }
7738: if ($guest) {
7739: return $guest;
7740: }
7741: }
7742: }
7743: return;
7744: }
7745:
7746: sub course_group_datechecker {
7747: my ($dates,$now,$status) = @_;
7748: my ($start,$end) = split(/\./,$dates);
7749: if (!$start && !$end) {
7750: return 'ok';
7751: }
7752: if (grep/^active$/,@{$status}) {
7753: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7754: return 'ok';
7755: }
7756: }
7757: if (grep/^previous$/,@{$status}) {
7758: if ($end > $now ) {
7759: return 'ok';
7760: }
7761: }
7762: if (grep/^future$/,@{$status}) {
7763: if ($start > $now) {
7764: return 'ok';
7765: }
7766: }
7767: return;
7768: }
7769:
7770: sub parse_portfolio_url {
7771: my ($url) = @_;
7772:
7773: my ($type,$udom,$unum,$group,$file_name);
7774:
1.823 albertel 7775: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 7776: $type = 1;
7777: $udom = $1;
7778: $unum = $2;
7779: $file_name = $3;
1.823 albertel 7780: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 7781: $type = 2;
7782: $udom = $1;
7783: $unum = $2;
7784: $group = $3;
7785: $file_name = $3.'/'.$4;
7786: }
7787: if (wantarray) {
7788: return ($type,$udom,$unum,$file_name,$group);
7789: }
7790: return $type;
7791: }
7792:
7793: sub is_portfolio_url {
7794: my ($url) = @_;
7795: return scalar(&parse_portfolio_url($url));
7796: }
7797:
1.798 raeburn 7798: sub is_portfolio_file {
7799: my ($file) = @_;
1.820 raeburn 7800: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 7801: return 1;
7802: }
7803: return;
7804: }
7805:
1.976 raeburn 7806: sub usertools_access {
1.1084 raeburn 7807: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 7808: my ($access,%tools);
7809: if ($context eq '') {
7810: $context = 'tools';
7811: }
7812: if ($context eq 'requestcourses') {
7813: %tools = (
7814: official => 1,
7815: unofficial => 1,
1.1006 raeburn 7816: community => 1,
1.1246 raeburn 7817: textbook => 1,
1.1305 raeburn 7818: placement => 1,
1.1368 raeburn 7819: lti => 1,
1.985 raeburn 7820: );
1.1183 raeburn 7821: } elsif ($context eq 'requestauthor') {
7822: %tools = (
7823: requestauthor => 1,
7824: );
1.985 raeburn 7825: } else {
7826: %tools = (
7827: aboutme => 1,
7828: blog => 1,
1.1177 raeburn 7829: webdav => 1,
1.985 raeburn 7830: portfolio => 1,
7831: );
7832: }
1.976 raeburn 7833: return if (!defined($tools{$tool}));
7834:
1.1242 raeburn 7835: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 7836: $udom = $env{'user.domain'};
7837: $uname = $env{'user.name'};
7838: }
7839:
1.978 raeburn 7840: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7841: if ($action ne 'reload') {
1.985 raeburn 7842: if ($context eq 'requestcourses') {
7843: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 7844: } elsif ($context eq 'requestauthor') {
7845: return $env{'environment.canrequest.author'};
1.985 raeburn 7846: } else {
7847: return $env{'environment.availabletools.'.$tool};
7848: }
7849: }
1.976 raeburn 7850: }
7851:
1.1183 raeburn 7852: my ($toolstatus,$inststatus,$envkey);
7853: if ($context eq 'requestauthor') {
7854: $envkey = $context;
7855: } else {
7856: $envkey = $context.'.'.$tool;
7857: }
1.976 raeburn 7858:
1.985 raeburn 7859: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
7860: ($action ne 'reload')) {
1.1183 raeburn 7861: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 7862: $inststatus = $env{'environment.inststatus'};
7863: } else {
1.1084 raeburn 7864: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 7865: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 7866: $inststatus = $userenvref->{'inststatus'};
7867: } else {
1.1183 raeburn 7868: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
7869: $toolstatus = $userenv{$envkey};
1.1084 raeburn 7870: $inststatus = $userenv{'inststatus'};
7871: }
1.976 raeburn 7872: }
7873:
7874: if ($toolstatus ne '') {
7875: if ($toolstatus) {
7876: $access = 1;
7877: } else {
7878: $access = 0;
7879: }
7880: return $access;
7881: }
7882:
1.1084 raeburn 7883: my ($is_adv,%domdef);
7884: if (ref($is_advref) eq 'HASH') {
7885: $is_adv = $is_advref->{'is_adv'};
7886: } else {
7887: $is_adv = &is_advanced_user($udom,$uname);
7888: }
7889: if (ref($domdefref) eq 'HASH') {
7890: %domdef = %{$domdefref};
7891: } else {
7892: %domdef = &get_domain_defaults($udom);
7893: }
1.976 raeburn 7894: if (ref($domdef{$tool}) eq 'HASH') {
7895: if ($is_adv) {
7896: if ($domdef{$tool}{'_LC_adv'} ne '') {
7897: if ($domdef{$tool}{'_LC_adv'}) {
7898: $access = 1;
7899: } else {
7900: $access = 0;
7901: }
7902: return $access;
7903: }
7904: }
7905: if ($inststatus ne '') {
7906: my ($hasaccess,$hasnoaccess);
7907: foreach my $affiliation (split(/:/,$inststatus)) {
7908: if ($domdef{$tool}{$affiliation} ne '') {
7909: if ($domdef{$tool}{$affiliation}) {
7910: $hasaccess = 1;
7911: } else {
7912: $hasnoaccess = 1;
7913: }
7914: }
7915: }
7916: if ($hasaccess || $hasnoaccess) {
7917: if ($hasaccess) {
7918: $access = 1;
7919: } elsif ($hasnoaccess) {
7920: $access = 0;
7921: }
7922: return $access;
7923: }
7924: } else {
7925: if ($domdef{$tool}{'default'} ne '') {
7926: if ($domdef{$tool}{'default'}) {
7927: $access = 1;
7928: } elsif ($domdef{$tool}{'default'} == 0) {
7929: $access = 0;
7930: }
7931: return $access;
7932: }
7933: }
7934: } else {
1.1177 raeburn 7935: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 7936: $access = 1;
7937: } else {
7938: $access = 0;
7939: }
1.976 raeburn 7940: return $access;
7941: }
7942: }
7943:
1.1050 raeburn 7944: sub is_course_owner {
7945: my ($cdom,$cnum,$udom,$uname) = @_;
7946: if (($udom eq '') || ($uname eq '')) {
7947: $udom = $env{'user.domain'};
7948: $uname = $env{'user.name'};
7949: }
7950: unless (($udom eq '') || ($uname eq '')) {
7951: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
7952: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
7953: return 1;
7954: } else {
7955: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
7956: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
7957: return 1;
7958: }
7959: }
7960: }
7961: }
7962: return;
7963: }
7964:
1.976 raeburn 7965: sub is_advanced_user {
7966: my ($udom,$uname) = @_;
1.1085 raeburn 7967: if ($udom ne '' && $uname ne '') {
7968: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 7969: if (wantarray) {
7970: return ($env{'user.adv'},$env{'user.author'});
7971: } else {
7972: return $env{'user.adv'};
7973: }
1.1085 raeburn 7974: }
7975: }
1.976 raeburn 7976: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
7977: my %allroles;
1.1128 raeburn 7978: my ($is_adv,$is_author);
1.976 raeburn 7979: foreach my $role (keys(%roleshash)) {
7980: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
7981: my $area = '/'.$tdomain.'/'.$trest;
7982: if ($sec ne '') {
7983: $area .= '/'.$sec;
7984: }
7985: if (($area ne '') && ($trole ne '')) {
7986: my $spec=$trole.'.'.$area;
7987: if ($trole =~ /^cr\//) {
7988: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
7989: } elsif ($trole ne 'gr') {
7990: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
7991: }
1.1128 raeburn 7992: if ($trole eq 'au') {
7993: $is_author = 1;
7994: }
1.976 raeburn 7995: }
7996: }
7997: foreach my $role (keys(%allroles)) {
7998: last if ($is_adv);
7999: foreach my $item (split(/:/,$allroles{$role})) {
8000: if ($item ne '') {
8001: my ($privilege,$restrictions)=split(/&/,$item);
8002: if ($privilege eq 'adv') {
8003: $is_adv = 1;
8004: last;
8005: }
8006: }
8007: }
8008: }
1.1128 raeburn 8009: if (wantarray) {
8010: return ($is_adv,$is_author);
8011: }
1.976 raeburn 8012: return $is_adv;
8013: }
1.798 raeburn 8014:
1.1035 raeburn 8015: sub check_can_request {
1.1368 raeburn 8016: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
1.1035 raeburn 8017: my $canreq = 0;
1.1368 raeburn 8018: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8019: $uname = $env{'user.name'};
8020: $udom = $env{'user.domain'};
8021: }
1.1035 raeburn 8022: my ($types,$typename) = &Apache::loncommon::course_types();
8023: my @options = ('approval','validate','autolimit');
8024: my $optregex = join('|',@options);
8025: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
8026: foreach my $type (@{$types}) {
1.1368 raeburn 8027: if (&usertools_access($uname,$udom,$type,undef,
8028: 'requestcourses')) {
1.1035 raeburn 8029: $canreq ++;
1.1036 raeburn 8030: if (ref($request_domains) eq 'HASH') {
1.1368 raeburn 8031: push(@{$request_domains->{$type}},$udom);
1.1036 raeburn 8032: }
1.1368 raeburn 8033: if ($dom eq $udom) {
1.1035 raeburn 8034: $can_request->{$type} = 1;
8035: }
8036: }
1.1368 raeburn 8037: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
8038: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
1.1035 raeburn 8039: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
8040: if (@curr > 0) {
1.1036 raeburn 8041: foreach my $item (@curr) {
8042: if (ref($request_domains) eq 'HASH') {
8043: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
8044: if ($otherdom ne '') {
8045: if (ref($request_domains->{$type}) eq 'ARRAY') {
8046: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
8047: push(@{$request_domains->{$type}},$otherdom);
8048: }
8049: } else {
8050: push(@{$request_domains->{$type}},$otherdom);
8051: }
8052: }
8053: }
8054: }
1.1368 raeburn 8055: unless ($dom eq $env{'user.domain'}) {
1.1036 raeburn 8056: $canreq ++;
1.1035 raeburn 8057: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
8058: $can_request->{$type} = 1;
8059: }
8060: }
8061: }
8062: }
8063: }
8064: }
8065: return $canreq;
8066: }
8067:
1.341 www 8068: # ---------------------------------------------- Custom access rule evaluation
8069:
8070: sub customaccess {
8071: my ($priv,$uri)=@_;
1.807 albertel 8072: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 8073: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 8074: $udom = &LONCAPA::clean_domain($udom);
8075: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 8076: my $access=0;
1.800 albertel 8077: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 8078: my ($effect,$realm,$role,$type)=split(/\:/,$right);
8079: if ($type eq 'user') {
8080: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 8081: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 8082: if ($tdom) {
8083: if ($tdom ne $env{'user.domain'}) { next; }
8084: }
1.896 albertel 8085: if ($tuname) {
8086: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 8087: }
8088: $access=($effect eq 'allow');
8089: last;
8090: }
8091: } else {
8092: if ($role) {
8093: if ($role ne $urole) { next; }
8094: }
8095: foreach my $scope (split(/\s*\,\s*/,$realm)) {
8096: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
8097: if ($tdom) {
8098: if ($tdom ne $udom) { next; }
8099: }
8100: if ($tcrs) {
8101: if ($tcrs ne $ucrs) { next; }
8102: }
8103: if ($tsec) {
8104: if ($tsec ne $usec) { next; }
8105: }
8106: $access=($effect eq 'allow');
8107: last;
8108: }
8109: if ($realm eq '' && $role eq '') {
8110: $access=($effect eq 'allow');
8111: }
1.402 bowersj2 8112: }
1.341 www 8113: }
8114: return $access;
8115: }
8116:
1.103 harris41 8117: # ------------------------------------------------- Check for a user privilege
1.12 www 8118:
8119: sub allowed {
1.1424 raeburn 8120: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck,$ignorecache)=@_;
1.705 albertel 8121: my $ver_orguri=$uri;
1.439 www 8122: $uri=&deversion($uri);
1.152 www 8123: my $orguri=$uri;
1.52 www 8124: $uri=&declutter($uri);
1.809 raeburn 8125:
1.810 raeburn 8126: if ($priv eq 'evb') {
8127: # Evade communication block restrictions for specified role in a course
8128: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
8129: return $1;
8130: } else {
8131: return;
8132: }
8133: }
8134:
1.620 albertel 8135: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 8136: # Free bre access to adm and meta resources
1.1436 raeburn 8137: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|viewclasslist|aboutme|ext\.tool)$}))
1.769 albertel 8138: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
8139: && ($priv eq 'bre')) {
1.14 www 8140: return 'F';
1.159 www 8141: }
8142:
1.545 banghart 8143: # Free bre access to user's own portfolio contents
1.714 raeburn 8144: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 8145: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 8146: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 8147: my %setters;
8148: my ($startblock,$endblock) =
8149: &Apache::loncommon::blockcheck(\%setters,'port');
8150: if ($startblock && $endblock) {
8151: return 'B';
8152: } else {
8153: return 'F';
8154: }
1.545 banghart 8155: }
8156:
1.762 raeburn 8157: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 8158: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
8159: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
8160: if (exists($env{'request.course.id'})) {
8161: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8162: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8163: if (($domain eq $cdom) && ($name eq $cnum)) {
8164: my $courseprivid=$env{'request.course.id'};
8165: $courseprivid=~s/\_/\//;
8166: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
8167: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
8168: return $1;
1.762 raeburn 8169: } else {
8170: if ($env{'request.course.sec'}) {
8171: $courseprivid.='/'.$env{'request.course.sec'};
8172: }
8173: if ($env{'user.priv.'.$env{'request.role'}.'./'.
8174: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
8175: return $2;
8176: }
1.714 raeburn 8177: }
8178: }
8179: }
8180: }
8181:
1.159 www 8182: # Free bre to public access
8183:
8184: if ($priv eq 'bre') {
1.1362 raeburn 8185: my $copyright;
8186: unless ($uri =~ /ext\.tool/) {
8187: $copyright=&metadata($uri,'copyright');
8188: }
1.620 albertel 8189: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 8190: return 'F';
8191: }
1.238 www 8192: if ($copyright eq 'priv') {
8193: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8194: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 8195: return '';
8196: }
8197: }
8198: if ($copyright eq 'domain') {
8199: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8200: unless (($env{'user.domain'} eq $1) ||
8201: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 8202: return '';
8203: }
1.262 matthew 8204: }
1.620 albertel 8205: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 8206: # Library role, so allow browsing of resources in this domain.
8207: return 'F';
1.238 www 8208: }
1.341 www 8209: if ($copyright eq 'custom') {
8210: unless (&customaccess($priv,$uri)) { return ''; }
8211: }
1.14 www 8212: }
1.264 matthew 8213: # Domain coordinator is trying to create a course
1.620 albertel 8214: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 8215: # uri is the requested domain in this case.
8216: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 8217: # a role of dc for the domain in question.
1.620 albertel 8218: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 8219: }
1.29 www 8220:
1.52 www 8221: my $thisallowed='';
8222: my $statecond=0;
8223: my $courseprivid='';
8224:
1.1039 raeburn 8225: my $ownaccess;
1.1043 raeburn 8226: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 8227: if (($priv eq 'bro') && ($env{'user.author'})) {
8228: if ($uri eq '') {
8229: $ownaccess = 1;
8230: } else {
8231: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
8232: my $udom = $env{'user.domain'};
8233: my $uname = $env{'user.name'};
8234: if ($uri =~ m{^\Q$udom\E/?$}) {
8235: $ownaccess = 1;
1.1040 raeburn 8236: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 8237: unless ($uri =~ m{\.\./}) {
8238: $ownaccess = 1;
8239: }
8240: } elsif (($udom ne 'public') && ($uname ne 'public')) {
8241: my $now = time;
8242: if ($uri =~ m{^([^/]+)/?$}) {
8243: my $adom = $1;
8244: foreach my $key (keys(%env)) {
1.1042 raeburn 8245: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1452 raeburn 8246: my ($start,$end) = split(/\./,$env{$key});
8247: if (($now >= $start) && (!$end || $end > $now)) {
1.1039 raeburn 8248: $ownaccess = 1;
8249: last;
8250: }
8251: }
8252: }
8253: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
8254: my $adom = $1;
8255: my $aname = $2;
1.1042 raeburn 8256: foreach my $role ('ca','aa') {
8257: if ($env{"user.role.$role./$adom/$aname"}) {
8258: my ($start,$end) =
1.1452 raeburn 8259: split(/\./,$env{"user.role.$role./$adom/$aname"});
8260: if (($now >= $start) && (!$end || $end > $now)) {
1.1042 raeburn 8261: $ownaccess = 1;
8262: last;
8263: }
1.1039 raeburn 8264: }
8265: }
8266: }
8267: }
8268: }
8269: }
8270: }
8271:
1.52 www 8272: # Course
8273:
1.620 albertel 8274: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8275: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8276: $thisallowed.=$1;
8277: }
1.52 www 8278: }
1.29 www 8279:
1.52 www 8280: # Domain
8281:
1.620 albertel 8282: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 8283: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8284: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8285: $thisallowed.=$1;
8286: }
1.12 www 8287: }
1.52 www 8288:
1.1141 raeburn 8289: # User who is not author or co-author might still be able to edit
8290: # resource of an author in the domain (e.g., if Domain Coordinator).
8291: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
8292: (&allowed('mdc',$env{'request.course.id'}))) {
8293: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
8294: $thisallowed.=$1;
8295: }
8296: }
8297:
1.52 www 8298: # Course: uri itself is a course
1.66 www 8299: my $courseuri=$uri;
8300: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 8301: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 8302:
1.620 albertel 8303: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 8304: =~/\Q$priv\E\&([^\:]*)/) {
1.1409 raeburn 8305: if ($priv eq 'mip') {
8306: my $rem = $1;
8307: if (($uri ne '') && ($env{'request.course.id'} eq $uri) &&
8308: ($env{'course.'.$env{'request.course.id'}.'.internal.courseowner'} eq $env{'user.name'}.':'.$env{'user.domain'})) {
8309: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8310: if ($cdom ne '') {
1.1410 raeburn 8311: my %passwdconf = &get_passwdconf($cdom);
8312: if (ref($passwdconf{'crsownerchg'}) eq 'HASH') {
8313: if (ref($passwdconf{'crsownerchg'}{'by'}) eq 'ARRAY') {
8314: if (@{$passwdconf{'crsownerchg'}{'by'}}) {
8315: my @inststatuses = split(':',$env{'environment.inststatus'});
8316: unless (@inststatuses) {
8317: @inststatuses = ('default');
8318: }
8319: foreach my $status (@inststatuses) {
8320: if (grep(/^\Q$status\E$/,@{$passwdconf{'crsownerchg'}{'by'}})) {
8321: $thisallowed.=$rem;
8322: }
8323: }
8324: }
8325: }
1.1409 raeburn 8326: }
8327: }
8328: }
8329: } else {
8330: unless (($priv eq 'bro') && (!$ownaccess)) {
8331: $thisallowed.=$1;
8332: }
1.1039 raeburn 8333: }
1.12 www 8334: }
1.29 www 8335:
1.665 albertel 8336: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 8337: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 8338: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 8339: $thisallowed='';
1.671 raeburn 8340: my ($match)=&is_on_map($uri);
8341: if ($match) {
8342: if ($env{'user.priv.'.$env{'request.role'}.'./'}
8343: =~/\Q$priv\E\&([^\:]*)/) {
1.1281 raeburn 8344: my $value = $1;
1.1402 raeburn 8345: my $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8346: if ($deeplinkblock) {
8347: $thisallowed='D';
8348: } elsif ($noblockcheck) {
1.1281 raeburn 8349: $thisallowed.=$value;
1.1162 raeburn 8350: } else {
1.1424 raeburn 8351: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8352: if (@blockers > 0) {
8353: $thisallowed = 'B';
8354: } else {
8355: $thisallowed.=$value;
8356: }
1.1162 raeburn 8357: }
1.671 raeburn 8358: }
8359: } else {
1.705 albertel 8360: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 8361: if ($refuri) {
8362: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 8363: $thisallowed='F';
1.671 raeburn 8364: } else {
8365: $refuri=&declutter($refuri);
8366: my ($match) = &is_on_map($refuri);
8367: if ($match) {
1.1402 raeburn 8368: my $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8369: if ($deeplinkblock) {
8370: $thisallowed='D';
8371: } elsif ($noblockcheck) {
1.1281 raeburn 8372: $thisallowed='F';
1.1162 raeburn 8373: } else {
1.1426 raeburn 8374: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 8375: if (@blockers > 0) {
8376: $thisallowed = 'B';
8377: } else {
8378: $thisallowed='F';
8379: }
1.1162 raeburn 8380: }
1.671 raeburn 8381: }
1.669 raeburn 8382: }
1.671 raeburn 8383: }
8384: }
1.314 www 8385: }
1.492 albertel 8386:
1.766 albertel 8387: if ($priv eq 'bre'
8388: && $thisallowed ne 'F'
8389: && $thisallowed ne '2'
8390: && &is_portfolio_url($uri)) {
1.1270 raeburn 8391: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 8392: }
1.1250 raeburn 8393:
1.52 www 8394: # Full access at system, domain or course-wide level? Exit.
1.29 www 8395: if ($thisallowed=~/F/) {
8396: return 'F';
8397: }
8398:
1.52 www 8399: # If this is generating or modifying users, exit with special codes
1.29 www 8400:
1.643 www 8401: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
8402: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 8403: my ($audom,$auname)=split('/',$uri);
1.643 www 8404: # no author name given, so this just checks on the general right to make a co-author in this domain
8405: unless ($auname) { return $thisallowed; }
8406: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 8407: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
8408: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
8409: ($audom ne $env{'request.role.domain'}))) { return ''; }
8410: }
1.52 www 8411: return $thisallowed;
8412: }
8413: #
1.103 harris41 8414: # Gathered so far: system, domain and course wide privileges
1.52 www 8415: #
8416: # Course: See if uri or referer is an individual resource that is part of
8417: # the course
8418:
1.620 albertel 8419: if ($env{'request.course.id'}) {
1.232 www 8420:
1.1409 raeburn 8421: # If this is modifying password (internal auth) domains must match for user and user's role.
8422:
8423: if ($priv eq 'mip') {
8424: if ($env{'user.domain'} eq $env{'request.role.domain'}) {
8425: return $thisallowed;
8426: } else {
8427: return '';
8428: }
8429: }
8430:
1.620 albertel 8431: $courseprivid=$env{'request.course.id'};
8432: if ($env{'request.course.sec'}) {
8433: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 8434: }
8435: $courseprivid=~s/\_/\//;
8436: my $checkreferer=1;
1.232 www 8437: my ($match,$cond)=&is_on_map($uri);
8438: if ($match) {
8439: $statecond=$cond;
1.620 albertel 8440: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 8441: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 8442: my $value = $1;
8443: if ($priv eq 'bre') {
1.1458 ! raeburn 8444: my $deeplinkblock = &deeplink_check($priv,$symb,$uri);
! 8445: if ($deeplinkblock) {
! 8446: $thisallowed = 'D';
! 8447: } elsif ($noblockcheck) {
1.1281 raeburn 8448: $thisallowed.=$value;
1.1162 raeburn 8449: } else {
1.1424 raeburn 8450: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8451: if (@blockers > 0) {
8452: $thisallowed = 'B';
8453: } else {
8454: $thisallowed.=$value;
8455: }
1.1162 raeburn 8456: }
8457: } else {
8458: $thisallowed.=$value;
8459: }
1.52 www 8460: $checkreferer=0;
8461: }
1.29 www 8462: }
1.1424 raeburn 8463:
1.148 www 8464: if ($checkreferer) {
1.620 albertel 8465: my $refuri=$env{'httpref.'.$orguri};
1.148 www 8466: unless ($refuri) {
1.800 albertel 8467: foreach my $key (keys(%env)) {
8468: if ($key=~/^httpref\..*\*/) {
8469: my $pattern=$key;
1.156 www 8470: $pattern=~s/^httpref\.\/res\///;
1.148 www 8471: $pattern=~s/\*/\[\^\/\]\+/g;
8472: $pattern=~s/\//\\\//g;
1.152 www 8473: if ($orguri=~/$pattern/) {
1.800 albertel 8474: $refuri=$env{$key};
1.148 www 8475: }
8476: }
1.191 harris41 8477: }
1.148 www 8478: }
1.232 www 8479:
1.148 www 8480: if ($refuri) {
1.152 www 8481: $refuri=&declutter($refuri);
1.232 www 8482: my ($match,$cond)=&is_on_map($refuri);
8483: if ($match) {
8484: my $refstatecond=$cond;
1.620 albertel 8485: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 8486: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 8487: my $value = $1;
8488: if ($priv eq 'bre') {
1.1402 raeburn 8489: my $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8490: if ($deeplinkblock) {
8491: $thisallowed = 'D';
8492: } elsif ($noblockcheck) {
1.1281 raeburn 8493: $thisallowed.=$value;
1.1162 raeburn 8494: } else {
1.1426 raeburn 8495: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 8496: if (@blockers > 0) {
8497: $thisallowed = 'B';
8498: } else {
8499: $thisallowed.=$value;
8500: }
1.1162 raeburn 8501: }
8502: } else {
8503: $thisallowed.=$value;
8504: }
1.53 www 8505: $uri=$refuri;
8506: $statecond=$refstatecond;
1.52 www 8507: }
8508: }
1.148 www 8509: }
1.29 www 8510: }
1.52 www 8511: }
1.29 www 8512:
1.52 www 8513: #
1.103 harris41 8514: # Gathered now: all privileges that could apply, and condition number
1.52 www 8515: #
8516: #
8517: # Full or no access?
8518: #
1.29 www 8519:
1.52 www 8520: if ($thisallowed=~/F/) {
8521: return 'F';
8522: }
1.29 www 8523:
1.52 www 8524: unless ($thisallowed) {
8525: return '';
8526: }
1.29 www 8527:
1.52 www 8528: # Restrictions exist, deal with them
8529: #
8530: # C:according to course preferences
8531: # R:according to resource settings
8532: # L:unless locked
8533: # X:according to user session state
8534: #
8535:
8536: # Possibly locked functionality, check all courses
1.1454 raeburn 8537: # In roles.tab, L (unless locked) available for bre, pch, plc, pac and sma.
1.54 www 8538: # Locks might take effect only after 10 minutes cache expiration for other
1.1454 raeburn 8539: # courses, and 2 minutes for current course, in which user has st or ta role
8540: # which is neither expired nor a future role (unless current course).
1.52 www 8541:
1.1454 raeburn 8542: my ($needlockcheck,$now,$crsonly);
1.52 www 8543: if ($thisallowed=~/L/) {
1.1454 raeburn 8544: $now = time;
8545: if ($priv eq 'bre') {
8546: if ($uri ne '') {
8547: if ($orguri =~ m{^/+res/}) {
8548: if ($uri =~ m{^lib/templates/}) {
8549: if ($env{'request.course.id'}) {
8550: $crsonly = 1;
8551: $needlockcheck = 1;
8552: }
8553: } else {
8554: $needlockcheck = 1;
8555: }
8556: } elsif ($env{'request.course.id'}) {
8557: my ($crsdom,$crsnum) = split('_',$env{'request.course.id'});
8558: if (($uri =~ m{^(adm|uploaded|public)/$crsdom/$crsnum/}) ||
8559: ($uri =~ m{^adm/$match_domain/$match_username/\d+/(smppg|bulletinboard)$})) {
8560: $crsonly = 1;
8561: }
8562: $needlockcheck = 1;
8563: }
8564: }
8565: } elsif (($priv eq 'pch') || ($priv eq 'plc') || ($priv eq 'pac') || ($priv eq 'sma')) {
8566: $needlockcheck = 1;
8567: }
8568: }
8569: if ($needlockcheck) {
1.1453 raeburn 8570: foreach my $envkey (keys(%env)) {
1.54 www 8571: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
8572: my $courseid=$2;
8573: my $roleid=$1.'.'.$2;
1.92 www 8574: $courseid=~s/^\///;
1.1453 raeburn 8575: unless ($env{'request.role'} eq $roleid) {
8576: my ($start,$end) = split(/\./,$env{$envkey});
8577: next unless (($now >= $start) && (!$end || $end > $now));
8578: }
1.54 www 8579: my $expiretime=600;
1.620 albertel 8580: if ($env{'request.role'} eq $roleid) {
1.54 www 8581: $expiretime=120;
8582: }
8583: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
8584: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 8585: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 8586: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 8587: }
1.620 albertel 8588: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
8589: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
8590: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
8591: &log($env{'user.domain'},$env{'user.name'},
8592: $env{'user.home'},
1.57 www 8593: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 8594: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 8595: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 8596: return '';
8597: }
8598: }
1.620 albertel 8599: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
8600: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1.1455 raeburn 8601: if ($env{$prefix.'priv.'.$priv.'.lock.expire'}>time) {
1.620 albertel 8602: &log($env{'user.domain'},$env{'user.name'},
8603: $env{'user.home'},
1.57 www 8604: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 8605: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 8606: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 8607: return '';
8608: }
8609: }
8610: }
1.29 www 8611: }
1.52 www 8612: }
1.1424 raeburn 8613:
1.52 www 8614: #
8615: # Rest of the restrictions depend on selected course
8616: #
8617:
1.620 albertel 8618: unless ($env{'request.course.id'}) {
1.766 albertel 8619: if ($thisallowed eq 'A') {
8620: return 'A';
1.814 raeburn 8621: } elsif ($thisallowed eq 'B') {
8622: return 'B';
1.766 albertel 8623: } else {
8624: return '1';
8625: }
1.52 www 8626: }
1.29 www 8627:
1.52 www 8628: #
8629: # Now user is definitely in a course
8630: #
1.53 www 8631:
8632:
8633: # Course preferences
8634:
8635: if ($thisallowed=~/C/) {
1.620 albertel 8636: my $rolecode=(split(/\./,$env{'request.role'}))[0];
8637: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
8638: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 8639: =~/\Q$rolecode\E/) {
1.1304 raeburn 8640: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 8641: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8642: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
8643: $env{'request.course.id'});
8644: }
1.237 www 8645: return '';
8646: }
8647:
1.620 albertel 8648: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 8649: =~/\Q$unamedom\E/) {
1.1304 raeburn 8650: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 8651: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
8652: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
8653: $env{'request.course.id'});
8654: }
1.54 www 8655: return '';
8656: }
1.53 www 8657: }
8658:
8659: # Resource preferences
8660:
8661: if ($thisallowed=~/R/) {
1.620 albertel 8662: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 8663: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 8664: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 8665: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
8666: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
8667: }
8668: return '';
1.54 www 8669: }
1.53 www 8670: }
1.30 www 8671:
1.246 www 8672: # Restricted by state or randomout?
1.30 www 8673:
1.52 www 8674: if ($thisallowed=~/X/) {
1.620 albertel 8675: if ($env{'acc.randomout'}) {
1.579 albertel 8676: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 8677: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 8678: return '';
8679: }
1.247 www 8680: }
8681: if (&condval($statecond)) {
1.52 www 8682: return '2';
8683: } else {
8684: return '';
8685: }
8686: }
1.30 www 8687:
1.766 albertel 8688: if ($thisallowed eq 'A') {
8689: return 'A';
1.814 raeburn 8690: } elsif ($thisallowed eq 'B') {
8691: return 'B';
1.1402 raeburn 8692: } elsif ($thisallowed eq 'D') {
8693: return 'D';
1.766 albertel 8694: }
1.52 www 8695: return 'F';
1.232 www 8696: }
1.1162 raeburn 8697:
1.1192 raeburn 8698: # ------------------------------------------- Check construction space access
8699:
8700: sub constructaccess {
8701: my ($url,$setpriv)=@_;
8702:
8703: # We do not allow editing of previous versions of files
8704: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
8705:
8706: # Get username and domain from URL
8707: my ($ownername,$ownerdomain,$ownerhome);
8708:
8709: ($ownerdomain,$ownername) =
1.1325 raeburn 8710: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
1.1192 raeburn 8711:
8712: # The URL does not really point to any authorspace, forget it
8713: unless (($ownername) && ($ownerdomain)) { return ''; }
8714:
8715: # Now we need to see if the user has access to the authorspace of
8716: # $ownername at $ownerdomain
8717:
8718: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
8719: # Real author for this?
8720: $ownerhome = $env{'user.home'};
8721: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
8722: return ($ownername,$ownerdomain,$ownerhome);
8723: }
8724: } else {
8725: # Co-author for this?
8726: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
8727: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
8728: $ownerhome = &homeserver($ownername,$ownerdomain);
8729: return ($ownername,$ownerdomain,$ownerhome);
8730: }
1.1312 raeburn 8731: if ($env{'request.course.id'}) {
8732: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
8733: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
8734: if (&allowed('mdc',$env{'request.course.id'})) {
8735: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
8736: return ($ownername,$ownerdomain,$ownerhome);
8737: }
8738: }
8739: }
1.1192 raeburn 8740: }
8741:
8742: # We don't have any access right now. If we are not possibly going to do anything about this,
8743: # we might as well leave
8744: unless ($setpriv) { return ''; }
8745:
8746: # Backdoor access?
8747: my $allowed=&allowed('eco',$ownerdomain);
8748: # Nope
8749: unless ($allowed) { return ''; }
8750: # Looks like we may have access, but could be locked by the owner of the construction space
8751: if ($allowed eq 'U') {
8752: my %blocked=&get('environment',['domcoord.author'],
8753: $ownerdomain,$ownername);
8754: # Is blocked by owner
8755: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
8756: }
8757: if (($allowed eq 'F') || ($allowed eq 'U')) {
8758: # Grant temporary access
8759: my $then=$env{'user.login.time'};
1.1209 raeburn 8760: my $update=$env{'user.update.time'};
1.1192 raeburn 8761: if (!$update) { $update = $then; }
8762: my $refresh=$env{'user.refresh.time'};
8763: if (!$refresh) { $refresh = $update; }
8764: my $now = time;
8765: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
8766: $now,'ca','constructaccess');
8767: $ownerhome = &homeserver($ownername,$ownerdomain);
8768: return($ownername,$ownerdomain,$ownerhome);
8769: }
8770: # No business here
8771: return '';
8772: }
8773:
1.1282 raeburn 8774: # ----------------------------------------------------------- Content Blocking
8775:
8776: {
8777: # Caches for faster Course Contents display where content blocking
8778: # is in operation (i.e., interval param set) for timed quiz.
8779: #
8780: # User for whom data are being temporarily cached.
8781: my $cacheduser='';
1.1424 raeburn 8782: # Course for which data are being temporarily cached.
8783: my $cachedcid='';
1.1282 raeburn 8784: # Cached blockers for this user (a hash of blocking items).
8785: my %cachedblockers=();
8786: # When the data were last cached.
8787: my $cachedlast='';
8788:
8789: sub load_all_blockers {
1.1427 raeburn 8790: my ($uname,$udom)=@_;
1.1282 raeburn 8791: if (($uname ne '') && ($udom ne '')) {
8792: if (($cacheduser eq $uname.':'.$udom) &&
1.1424 raeburn 8793: ($cachedcid eq $env{'request.course.id'}) &&
1.1427 raeburn 8794: (abs($cachedlast-time)<5)) {
1.1282 raeburn 8795: return;
8796: }
8797: }
8798: $cachedlast=time;
8799: $cacheduser=$uname.':'.$udom;
1.1424 raeburn 8800: $cachedcid=$env{'request.course.id'};
1.1427 raeburn 8801: %cachedblockers = &get_commblock_resources();
1.1424 raeburn 8802: return;
1.1282 raeburn 8803: }
8804:
1.1162 raeburn 8805: sub get_comm_blocks {
8806: my ($cdom,$cnum) = @_;
8807: if ($cdom eq '' || $cnum eq '') {
8808: return unless ($env{'request.course.id'});
8809: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8810: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8811: }
8812: my %commblocks;
8813: my $hashid=$cdom.'_'.$cnum;
8814: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
8815: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
8816: %commblocks = %{$blocksref};
8817: } else {
8818: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
8819: my $cachetime = 600;
8820: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
8821: }
8822: return %commblocks;
8823: }
8824:
1.1282 raeburn 8825: sub get_commblock_resources {
8826: my ($blocks) = @_;
8827: my %blockers = ();
8828: return %blockers unless ($env{'request.course.id'});
8829: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
1.1162 raeburn 8830: my %commblocks;
8831: if (ref($blocks) eq 'HASH') {
8832: %commblocks = %{$blocks};
8833: } else {
8834: %commblocks = &get_comm_blocks();
8835: }
1.1282 raeburn 8836: return %blockers unless (keys(%commblocks) > 0);
8837: my $navmap = Apache::lonnavmaps::navmap->new();
8838: return %blockers unless (ref($navmap));
1.1162 raeburn 8839: my $now = time;
8840: foreach my $block (keys(%commblocks)) {
8841: if ($block =~ /^(\d+)____(\d+)$/) {
8842: my ($start,$end) = ($1,$2);
8843: if ($start <= $now && $end >= $now) {
8844: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8845: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8846: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282 raeburn 8847: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8848: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 8849: }
8850: }
8851: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282 raeburn 8852: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8853: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 8854: }
8855: }
8856: }
8857: }
8858: }
8859: } elsif ($block =~ /^firstaccess____(.+)$/) {
8860: my $item = $1;
1.1163 raeburn 8861: my @to_test;
1.1162 raeburn 8862: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8863: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1282 raeburn 8864: my @interval;
8865: my $type = 'map';
8866: if ($item eq 'course') {
8867: $type = 'course';
8868: @interval=&EXT("resource.0.interval");
8869: } else {
8870: if ($item =~ /___\d+___/) {
8871: $type = 'resource';
8872: @interval=&EXT("resource.0.interval",$item);
8873: if (ref($navmap)) {
8874: my $res = $navmap->getBySymb($item);
8875: push(@to_test,$res);
8876: }
1.1162 raeburn 8877: } else {
1.1282 raeburn 8878: my $mapsymb = &symbread($item,1);
8879: if ($mapsymb) {
8880: if (ref($navmap)) {
8881: my $mapres = $navmap->getBySymb($mapsymb);
1.1428 raeburn 8882: if (ref($mapres)) {
8883: my $first = $mapres->map_start();
8884: my $finish = $mapres->map_finish();
8885: my $it = $navmap->getIterator($first,$finish,undef,0,0);
1.1429 raeburn 8886: if (ref($it)) {
8887: my $res;
8888: while ($res = $it->next(undef,1)) {
8889: next unless (ref($res));
8890: my $symb = $res->symb();
8891: next if (($symb eq $mapsymb) || ($symb eq ''));
8892: @interval=&EXT("resource.0.interval",$symb);
8893: if ($interval[1] eq 'map') {
8894: if ($res->answerable()) {
8895: push(@to_test,$res);
8896: last;
8897: }
1.1428 raeburn 8898: }
1.1162 raeburn 8899: }
8900: }
8901: }
8902: }
8903: }
8904: }
1.1282 raeburn 8905: }
1.1310 raeburn 8906: if ($interval[0] =~ /^(\d+)/) {
1.1308 raeburn 8907: my $timelimit = $1;
1.1282 raeburn 8908: my $first_access;
8909: if ($type eq 'resource') {
8910: $first_access=&get_first_access($interval[1],$item);
8911: } elsif ($type eq 'map') {
8912: $first_access=&get_first_access($interval[1],undef,$item);
8913: } else {
8914: $first_access=&get_first_access($interval[1]);
8915: }
8916: if ($first_access) {
1.1292 raeburn 8917: my $timesup = $first_access+$timelimit;
1.1282 raeburn 8918: if ($timesup > $now) {
8919: my $activeblock;
8920: foreach my $res (@to_test) {
1.1283 raeburn 8921: if ($res->answerable()) {
1.1282 raeburn 8922: $activeblock = 1;
8923: last;
8924: }
8925: }
8926: if ($activeblock) {
8927: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8928: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8929: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8930: }
8931: }
8932: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8933: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8934: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 8935: }
1.1162 raeburn 8936: }
8937: }
8938: }
8939: }
8940: }
8941: }
8942: }
8943: }
8944: }
1.1282 raeburn 8945: return %blockers;
1.1162 raeburn 8946: }
8947:
1.1282 raeburn 8948: sub has_comm_blocking {
1.1427 raeburn 8949: my ($priv,$symb,$uri,$ignoresymbdb,$noenccheck,$blocked,$blocks) = @_;
1.1282 raeburn 8950: my @blockers;
8951: return unless ($env{'request.course.id'});
8952: return unless ($priv eq 'bre');
8953: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
8954: return if ($env{'request.state'} eq 'construct');
1.1427 raeburn 8955: my %blockinfo;
8956: if (ref($blocks) eq 'HASH') {
8957: %blockinfo = &get_commblock_resources($blocks);
8958: } else {
8959: &load_all_blockers($env{'user.name'},$env{'user.domain'});
8960: %blockinfo = %cachedblockers;
8961: }
8962: return unless (keys(%blockinfo) > 0);
1.1282 raeburn 8963: my (%possibles,@symbs);
8964: if (!$symb) {
1.1427 raeburn 8965: $symb = &symbread($uri,1,1,1,\%possibles,$ignoresymbdb,$noenccheck);
1.1162 raeburn 8966: }
1.1282 raeburn 8967: if ($symb) {
8968: @symbs = ($symb);
8969: } elsif (keys(%possibles)) {
8970: @symbs = keys(%possibles);
8971: }
8972: my $noblock;
8973: foreach my $symb (@symbs) {
8974: last if ($noblock);
8975: my ($map,$resid,$resurl)=&decode_symb($symb);
1.1427 raeburn 8976: foreach my $block (keys(%blockinfo)) {
1.1282 raeburn 8977: if ($block =~ /^firstaccess____(.+)$/) {
8978: my $item = $1;
1.1424 raeburn 8979: unless ($blocked) {
8980: if (($item eq $map) || ($item eq $symb)) {
8981: $noblock = 1;
8982: last;
8983: }
1.1282 raeburn 8984: }
8985: }
1.1427 raeburn 8986: if (ref($blockinfo{$block}) eq 'HASH') {
8987: if (ref($blockinfo{$block}{'resources'}) eq 'HASH') {
8988: if ($blockinfo{$block}{'resources'}{$symb}) {
1.1282 raeburn 8989: unless (grep(/^\Q$block\E$/,@blockers)) {
8990: push(@blockers,$block);
8991: }
8992: }
8993: }
1.1427 raeburn 8994: if (ref($blockinfo{$block}{'maps'}) eq 'HASH') {
8995: if ($blockinfo{$block}{'maps'}{$map}) {
1.1424 raeburn 8996: unless (grep(/^\Q$block\E$/,@blockers)) {
8997: push(@blockers,$block);
8998: }
1.1282 raeburn 8999: }
9000: }
1.1162 raeburn 9001: }
9002: }
9003: }
1.1424 raeburn 9004: unless ($noblock) {
9005: return @blockers;
9006: }
9007: return;
1.1282 raeburn 9008: }
1.1162 raeburn 9009: }
9010:
1.1402 raeburn 9011: sub deeplink_check {
9012: my ($priv,$symb,$uri) = @_;
9013: return unless ($env{'request.course.id'});
9014: return unless ($priv eq 'bre');
9015: return if ($env{'request.state'} eq 'construct');
9016: return if ($env{'request.role.adv'});
9017: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9018: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9019: my (%possibles,@symbs);
9020: if (!$symb) {
9021: $symb = &symbread($uri,1,1,1,\%possibles);
9022: }
9023: if ($symb) {
9024: @symbs = ($symb);
9025: } elsif (keys(%possibles)) {
9026: @symbs = keys(%possibles);
9027: }
9028:
9029: my ($login,$switchrole,$allow);
9030: if ($env{'request.deeplink.login'} =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
9031: my $key = $1;
9032: my $tinyurl;
9033: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
9034: if (defined($cached)) {
9035: $tinyurl = $result;
9036: } else {
9037: my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
9038: my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
9039: if ($currtiny{$key} ne '') {
9040: $tinyurl = $currtiny{$key};
9041: &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
9042: }
9043: }
9044: if ($tinyurl ne '') {
9045: my ($cnumreq,$posslogin) = split(/\&/,$tinyurl);
9046: if ($cnumreq eq $cnum) {
9047: $login = $posslogin;
9048: } else {
9049: $switchrole = 1;
9050: }
9051: }
9052: }
9053: foreach my $symb (@symbs) {
9054: last if ($allow);
9055: my $deeplink = &EXT("resource.0.deeplink",$symb);
9056: if ($deeplink eq '') {
9057: $allow = 1;
9058: } else {
9059: my ($listed,$scope,$access) = split(/,/,$deeplink);
9060: if ($access eq 'any') {
9061: $allow = 1;
9062: } elsif ($login) {
9063: if ($access eq 'only') {
9064: if ($scope eq 'res') {
9065: if ($symb eq $login) {
9066: $allow = 1;
9067: }
9068: } elsif ($scope eq 'map') {
9069: #FIXME Compare map for $env{'request.deeplink.login'} with map for $symb
9070: } elsif ($scope eq 'rec') {
9071: #FIXME Recurse up for $env{'request.deeplink.login'} with map for $symb
9072: }
9073: } else {
9074: my ($acctype,$item) = split(/:/,$access);
9075: if (($acctype eq 'lti') && ($env{'user.linkprotector'})) {
9076: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.linkprotector'}))) {
9077: my %tinyurls = &get('tiny',[$symb],$cdom,$cnum);
9078: if (grep(/\Q$tinyurls{$symb}\E$/,split(/,/,$env{'user.linkproturis'}))) {
9079: $allow = 1;
9080: }
9081: }
9082: } elsif (($acctype eq 'key') && ($env{'user.deeplinkkey'})) {
9083: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.deeplinkkey'}))) {
9084: my %tinyurls = &get('tiny',[$symb],$cdom,$cnum);
9085: if (grep(/\Q$tinyurls{$symb}\E$/,split(/,/,$env{'user.keyedlinkuri'}))) {
9086: $allow = 1;
9087: }
9088: }
9089: }
9090: }
9091: }
9092: }
9093: }
9094: return if ($allow);
9095: return 1;
9096: }
9097:
1.1282 raeburn 9098: # -------------------------------- Deversion and split uri into path an filename
9099:
1.1133 foxr 9100: #
1.1282 raeburn 9101: # Removes the version from a URI and
1.1133 foxr 9102: # splits it in to its filename and path to the filename.
9103: # Seems like File::Basename could have done this more clearly.
9104: # Parameters:
9105: # $uri - input URI
9106: # Returns:
9107: # Two element list consisting of
9108: # $pathname - the URI up to and excluding the trailing /
9109: # $filename - The part of the URI following the last /
9110: # NOTE:
9111: # Another realization of this is simply:
9112: # use File::Basename;
9113: # ...
9114: # $uri = shift;
9115: # $filename = basename($uri);
9116: # $path = dirname($uri);
9117: # return ($filename, $path);
9118: #
9119: # The implementation below is probably faster however.
9120: #
1.710 albertel 9121: sub split_uri_for_cond {
9122: my $uri=&deversion(&declutter(shift));
9123: my @uriparts=split(/\//,$uri);
9124: my $filename=pop(@uriparts);
9125: my $pathname=join('/',@uriparts);
9126: return ($pathname,$filename);
9127: }
1.232 www 9128: # --------------------------------------------------- Is a resource on the map?
9129:
9130: sub is_on_map {
1.710 albertel 9131: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 9132: #Trying to find the conditional for the file
1.620 albertel 9133: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 9134: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 9135: if ($match) {
1.289 bowersj2 9136: return (1,$1);
9137: } else {
1.434 www 9138: return (0,0);
1.289 bowersj2 9139: }
1.12 www 9140: }
9141:
1.427 www 9142: # --------------------------------------------------------- Get symb from alias
9143:
9144: sub get_symb_from_alias {
9145: my $symb=shift;
9146: my ($map,$resid,$url)=&decode_symb($symb);
9147: # Already is a symb
9148: if ($url) { return $symb; }
9149: # Must be an alias
9150: my $aliassymb='';
9151: my %bighash;
1.620 albertel 9152: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 9153: &GDBM_READER(),0640)) {
9154: my $rid=$bighash{'mapalias_'.$symb};
9155: if ($rid) {
9156: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 9157: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
9158: $resid,$bighash{'src_'.$rid});
1.427 www 9159: }
9160: untie %bighash;
9161: }
9162: return $aliassymb;
9163: }
9164:
1.12 www 9165: # ----------------------------------------------------------------- Define Role
9166:
9167: sub definerole {
9168: if (allowed('mcr','/')) {
1.1326 raeburn 9169: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 9170: foreach my $role (split(':',$sysrole)) {
9171: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9172: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
9173: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
9174: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9175: return "refused:s:$crole&$cqual";
9176: }
9177: }
1.191 harris41 9178: }
1.800 albertel 9179: foreach my $role (split(':',$domrole)) {
9180: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9181: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
9182: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
9183: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 9184: return "refused:d:$crole&$cqual";
9185: }
9186: }
1.191 harris41 9187: }
1.800 albertel 9188: foreach my $role (split(':',$courole)) {
9189: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9190: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
9191: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
9192: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9193: return "refused:c:$crole&$cqual";
9194: }
9195: }
1.191 harris41 9196: }
1.1326 raeburn 9197: my $uhome;
9198: if (($uname ne '') && ($udom ne '')) {
9199: $uhome = &homeserver($uname,$udom);
9200: return $uhome if ($uhome eq 'no_host');
9201: } else {
9202: $uname = $env{'user.name'};
9203: $udom = $env{'user.domain'};
9204: $uhome = $env{'user.home'};
9205: }
1.620 albertel 9206: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1326 raeburn 9207: "$udom:$uname:rolesdef_$rolename=".
1.21 www 9208: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1326 raeburn 9209: return reply($command,$uhome);
1.12 www 9210: } else {
9211: return 'refused';
9212: }
1.105 harris41 9213: }
9214:
9215: # ---------------- Make a metadata query against the network of library servers
9216:
9217: sub metadata_query {
1.1237 raeburn 9218: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 9219: my %rhash;
1.845 albertel 9220: my %libserv = &all_library();
1.244 matthew 9221: my @server_list = (defined($server_array) ? @$server_array
9222: : keys(%libserv) );
9223: for my $server (@server_list) {
1.1237 raeburn 9224: my $domains = '';
9225: if (ref($domains_hash) eq 'HASH') {
9226: $domains = $domains_hash->{$server};
9227: }
1.118 harris41 9228: unless ($custom or $customshow) {
1.1237 raeburn 9229: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 9230: $rhash{$server}=$reply;
9231: }
9232: else {
9233: my $reply=&reply("querysend:".&escape($query).':'.
1.1237 raeburn 9234: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 9235: $server);
9236: $rhash{$server}=$reply;
9237: }
1.112 harris41 9238: }
1.118 harris41 9239: return \%rhash;
1.240 www 9240: }
9241:
9242: # ----------------------------------------- Send log queries and wait for reply
9243:
9244: sub log_query {
9245: my ($uname,$udom,$query,%filters)=@_;
9246: my $uhome=&homeserver($uname,$udom);
9247: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 9248: my $uhost=&hostname($uhome);
1.800 albertel 9249: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 9250: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
9251: $uhome);
1.479 albertel 9252: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 9253: return get_query_reply($queryid);
9254: }
9255:
1.818 raeburn 9256: # -------------------------- Update MySQL table for portfolio file
9257:
9258: sub update_portfolio_table {
1.821 raeburn 9259: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 9260: if ($group ne '') {
9261: $file_name =~s /^\Q$group\E//;
9262: }
1.818 raeburn 9263: my $homeserver = &homeserver($uname,$udom);
9264: my $queryid=
1.821 raeburn 9265: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
9266: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 9267: my $reply = &get_query_reply($queryid);
9268: return $reply;
9269: }
9270:
1.899 raeburn 9271: # -------------------------- Update MySQL allusers table
9272:
9273: sub update_allusers_table {
9274: my ($uname,$udom,$names) = @_;
9275: my $homeserver = &homeserver($uname,$udom);
9276: my $queryid=
9277: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
9278: 'lastname='.&escape($names->{'lastname'}).'%%'.
9279: 'firstname='.&escape($names->{'firstname'}).'%%'.
9280: 'middlename='.&escape($names->{'middlename'}).'%%'.
9281: 'generation='.&escape($names->{'generation'}).'%%'.
9282: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
9283: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 9284: return;
1.899 raeburn 9285: }
9286:
1.508 raeburn 9287: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 9288:
9289: sub fetch_enrollment_query {
1.511 raeburn 9290: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1317 raeburn 9291: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 9292: my $maxtries = 1;
1.508 raeburn 9293: if ($context eq 'automated') {
9294: $homeserver = $perlvar{'lonHostID'};
1.1317 raeburn 9295: $sleep = 2;
9296: $loopmax = 100;
1.547 raeburn 9297: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 9298: } else {
9299: $homeserver = &homeserver($cnum,$dom);
9300: }
1.838 albertel 9301: my $host=&hostname($homeserver);
1.506 raeburn 9302: my $cmd = '';
1.1000 raeburn 9303: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 9304: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 9305: }
9306: $cmd =~ s/%%$//;
9307: $cmd = &escape($cmd);
9308: my $query = 'fetchenrollment';
1.620 albertel 9309: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 9310: unless ($queryid=~/^\Q$host\E\_/) {
9311: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
9312: return 'error: '.$queryid;
9313: }
1.1317 raeburn 9314: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9315: my $tries = 1;
9316: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1317 raeburn 9317: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9318: $tries ++;
9319: }
1.526 raeburn 9320: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 9321: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 9322: } else {
1.901 albertel 9323: my @responses = split(/:/,$reply);
1.1322 raeburn 9324: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 9325: foreach my $line (@responses) {
9326: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 9327: $$replyref{$key} = $value;
9328: }
9329: } else {
1.1117 foxr 9330: my $pathname = LONCAPA::tempdir();
1.800 albertel 9331: foreach my $line (@responses) {
9332: my ($key,$value) = split(/=/,$line);
1.506 raeburn 9333: $$replyref{$key} = $value;
9334: if ($value > 0) {
1.800 albertel 9335: foreach my $item (@{$$affiliatesref{$key}}) {
9336: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 9337: my $destname = $pathname.'/'.$filename;
9338: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 9339: if ($xml_classlist =~ /^error/) {
9340: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
9341: } else {
1.1359 raeburn 9342: if ( open(FILE,">",$destname) ) {
1.506 raeburn 9343: print FILE &unescape($xml_classlist);
9344: close(FILE);
1.526 raeburn 9345: } else {
9346: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 9347: }
9348: }
9349: }
9350: }
9351: }
9352: }
9353: return 'ok';
9354: }
9355: return 'error';
9356: }
9357:
1.242 www 9358: sub get_query_reply {
1.1317 raeburn 9359: my ($queryid,$sleep,$loopmax) = @_;;
9360: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
9361: $sleep = 0.2;
9362: }
9363: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
9364: $loopmax = 100;
9365: }
1.1117 foxr 9366: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 9367: my $reply='';
1.1317 raeburn 9368: for (1..$loopmax) {
9369: sleep($sleep);
1.240 www 9370: if (-e $replyfile.'.end') {
1.1359 raeburn 9371: if (open(my $fh,"<",$replyfile)) {
1.904 albertel 9372: $reply = join('',<$fh>);
9373: close($fh);
1.240 www 9374: } else { return 'error: reply_file_error'; }
1.242 www 9375: return &unescape($reply);
9376: }
1.240 www 9377: }
1.242 www 9378: return 'timeout:'.$queryid;
1.240 www 9379: }
9380:
9381: sub courselog_query {
1.241 www 9382: #
9383: # possible filters:
9384: # url: url or symb
9385: # username
9386: # domain
9387: # action: view, submit, grade
9388: # start: timestamp
9389: # end: timestamp
9390: #
1.240 www 9391: my (%filters)=@_;
1.620 albertel 9392: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 9393: if ($filters{'url'}) {
9394: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
9395: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
9396: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
9397: }
1.620 albertel 9398: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
9399: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 9400: return &log_query($cname,$cdom,'courselog',%filters);
9401: }
9402:
9403: sub userlog_query {
1.858 raeburn 9404: #
9405: # possible filters:
9406: # action: log check role
9407: # start: timestamp
9408: # end: timestamp
9409: #
1.240 www 9410: my ($uname,$udom,%filters)=@_;
9411: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 9412: }
9413:
1.506 raeburn 9414: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
9415:
9416: sub auto_run {
1.508 raeburn 9417: my ($cnum,$cdom) = @_;
1.876 raeburn 9418: my $response = 0;
9419: my $settings;
9420: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
9421: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
9422: $settings = $domconfig{'autoenroll'};
9423: if ($settings->{'run'} eq '1') {
9424: $response = 1;
9425: }
9426: } else {
1.934 raeburn 9427: my $homeserver;
9428: if (&is_course($cdom,$cnum)) {
9429: $homeserver = &homeserver($cnum,$cdom);
9430: } else {
9431: $homeserver = &domain($cdom,'primary');
9432: }
9433: if ($homeserver ne 'no_host') {
9434: $response = &reply('autorun:'.$cdom,$homeserver);
9435: }
1.876 raeburn 9436: }
1.506 raeburn 9437: return $response;
9438: }
1.776 albertel 9439:
1.506 raeburn 9440: sub auto_get_sections {
1.508 raeburn 9441: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 9442: my $homeserver;
9443: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9444: $homeserver = &homeserver($cnum,$cdom);
9445: }
9446: if (!defined($homeserver)) {
9447: if ($cdom =~ /^$match_domain$/) {
9448: $homeserver = &domain($cdom,'primary');
9449: }
9450: }
9451: my @secs;
9452: if (defined($homeserver)) {
9453: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
9454: unless ($response eq 'refused') {
9455: @secs = split(/:/,$response);
9456: }
1.506 raeburn 9457: }
9458: return @secs;
9459: }
1.776 albertel 9460:
1.506 raeburn 9461: sub auto_new_course {
1.1099 raeburn 9462: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 9463: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 9464: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 9465: return $response;
9466: }
1.776 albertel 9467:
1.506 raeburn 9468: sub auto_validate_courseID {
1.508 raeburn 9469: my ($cnum,$cdom,$inst_course_id) = @_;
9470: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 9471: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 9472: return $response;
9473: }
1.776 albertel 9474:
1.1007 raeburn 9475: sub auto_validate_instcode {
1.1020 raeburn 9476: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 9477: my ($homeserver,$response);
9478: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9479: $homeserver = &homeserver($cnum,$cdom);
9480: }
9481: if (!defined($homeserver)) {
9482: if ($cdom =~ /^$match_domain$/) {
9483: $homeserver = &domain($cdom,'primary');
9484: }
9485: }
1.1065 raeburn 9486: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
9487: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 9488: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
9489: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 9490: }
9491:
1.1444 raeburn 9492: sub auto_validate_inst_crosslist {
9493: my ($cnum,$cdom,$instcode,$inst_xlist,$coowner) = @_;
9494: my ($homeserver,$response);
9495: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9496: $homeserver = &homeserver($cnum,$cdom);
9497: }
9498: if (!defined($homeserver)) {
9499: if ($cdom =~ /^$match_domain$/) {
9500: $homeserver = &domain($cdom,'primary');
9501: }
9502: }
9503: unless (($homeserver eq '') || ($homeserver eq 'no_host')) {
9504: $response=&reply('autovalidateinstcrosslist:'.$cdom.':'.
9505: &escape($instcode).':'.&escape($inst_xlist).':'.
1.1445 raeburn 9506: &escape($coowner),$homeserver);
1.1444 raeburn 9507: }
9508: return $response;
9509: }
9510:
1.506 raeburn 9511: sub auto_create_password {
1.873 raeburn 9512: my ($cnum,$cdom,$authparam,$udom) = @_;
9513: my ($homeserver,$response);
1.506 raeburn 9514: my $create_passwd = 0;
9515: my $authchk = '';
1.873 raeburn 9516: if ($udom =~ /^$match_domain$/) {
9517: $homeserver = &domain($udom,'primary');
9518: }
9519: if ($homeserver eq '') {
9520: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
9521: $homeserver = &homeserver($cnum,$cdom);
9522: }
9523: }
9524: if ($homeserver eq '') {
9525: $authchk = 'nodomain';
1.506 raeburn 9526: } else {
1.873 raeburn 9527: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
9528: if ($response eq 'refused') {
9529: $authchk = 'refused';
9530: } else {
1.901 albertel 9531: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 9532: }
1.506 raeburn 9533: }
9534: return ($authparam,$create_passwd,$authchk);
9535: }
9536:
1.706 raeburn 9537: sub auto_photo_permission {
9538: my ($cnum,$cdom,$students) = @_;
9539: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 9540: my ($outcome,$perm_reqd,$conditions) =
9541: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 9542: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9543: return (undef,undef);
9544: }
1.706 raeburn 9545: return ($outcome,$perm_reqd,$conditions);
9546: }
9547:
9548: sub auto_checkphotos {
9549: my ($uname,$udom,$pid) = @_;
9550: my $homeserver = &homeserver($uname,$udom);
9551: my ($result,$resulttype);
9552: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 9553: &escape($uname).':'.&escape($pid),
9554: $homeserver));
1.709 albertel 9555: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9556: return (undef,undef);
9557: }
1.706 raeburn 9558: if ($outcome) {
9559: ($result,$resulttype) = split(/:/,$outcome);
9560: }
9561: return ($result,$resulttype);
9562: }
9563:
9564: sub auto_photochoice {
9565: my ($cnum,$cdom) = @_;
9566: my $homeserver = &homeserver($cnum,$cdom);
9567: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 9568: &escape($cdom),
9569: $homeserver)));
1.709 albertel 9570: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
9571: return (undef,undef);
9572: }
1.706 raeburn 9573: return ($update,$comment);
9574: }
9575:
9576: sub auto_photoupdate {
9577: my ($affiliatesref,$dom,$cnum,$photo) = @_;
9578: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 9579: my $host=&hostname($homeserver);
1.706 raeburn 9580: my $cmd = '';
9581: my $maxtries = 1;
1.800 albertel 9582: foreach my $affiliate (keys(%{$affiliatesref})) {
9583: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 9584: }
9585: $cmd =~ s/%%$//;
9586: $cmd = &escape($cmd);
9587: my $query = 'institutionalphotos';
9588: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
9589: unless ($queryid=~/^\Q$host\E\_/) {
9590: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
9591: return 'error: '.$queryid;
9592: }
9593: my $reply = &get_query_reply($queryid);
9594: my $tries = 1;
9595: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
9596: $reply = &get_query_reply($queryid);
9597: $tries ++;
9598: }
9599: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
9600: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
9601: } else {
9602: my @responses = split(/:/,$reply);
9603: my $outcome = shift(@responses);
9604: foreach my $item (@responses) {
9605: my ($key,$value) = split(/=/,$item);
9606: $$photo{$key} = $value;
9607: }
9608: return $outcome;
9609: }
9610: return 'error';
9611: }
9612:
1.521 raeburn 9613: sub auto_instcode_format {
1.793 albertel 9614: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
9615: $cat_order) = @_;
1.521 raeburn 9616: my $courses = '';
1.772 raeburn 9617: my @homeservers;
1.521 raeburn 9618: if ($caller eq 'global') {
1.841 albertel 9619: my %servers = &get_servers($codedom,'library');
9620: foreach my $tryserver (keys(%servers)) {
9621: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9622: push(@homeservers,$tryserver);
9623: }
1.584 raeburn 9624: }
1.1022 raeburn 9625: } elsif ($caller eq 'requests') {
9626: if ($codedom =~ /^$match_domain$/) {
9627: my $chome = &domain($codedom,'primary');
9628: unless ($chome eq 'no_host') {
9629: push(@homeservers,$chome);
9630: }
9631: }
1.521 raeburn 9632: } else {
1.772 raeburn 9633: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 9634: }
1.793 albertel 9635: foreach my $code (keys(%{$instcodes})) {
9636: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 9637: }
9638: chop($courses);
1.772 raeburn 9639: my $ok_response = 0;
9640: my $response;
9641: while (@homeservers > 0 && $ok_response == 0) {
9642: my $server = shift(@homeservers);
9643: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
9644: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
9645: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 9646: split(/:/,$response);
1.772 raeburn 9647: %{$codes} = (%{$codes},&str2hash($codes_str));
9648: push(@{$codetitles},&str2array($codetitles_str));
9649: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
9650: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
9651: $ok_response = 1;
9652: }
9653: }
9654: if ($ok_response) {
1.521 raeburn 9655: return 'ok';
1.772 raeburn 9656: } else {
9657: return $response;
1.521 raeburn 9658: }
9659: }
9660:
1.792 raeburn 9661: sub auto_instcode_defaults {
9662: my ($domain,$returnhash,$code_order) = @_;
9663: my @homeservers;
1.841 albertel 9664:
9665: my %servers = &get_servers($domain,'library');
9666: foreach my $tryserver (keys(%servers)) {
9667: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9668: push(@homeservers,$tryserver);
9669: }
1.792 raeburn 9670: }
1.841 albertel 9671:
1.792 raeburn 9672: my $response;
1.841 albertel 9673: foreach my $server (@homeservers) {
1.792 raeburn 9674: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 9675: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
9676:
9677: foreach my $pair (split(/\&/,$response)) {
9678: my ($name,$value)=split(/\=/,$pair);
9679: if ($name eq 'code_order') {
9680: @{$code_order} = split(/\&/,&unescape($value));
9681: } else {
9682: $returnhash->{&unescape($name)}=&unescape($value);
9683: }
9684: }
9685: return 'ok';
1.792 raeburn 9686: }
1.841 albertel 9687:
9688: return $response;
1.1003 raeburn 9689: }
9690:
9691: sub auto_possible_instcodes {
1.1007 raeburn 9692: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
9693: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
9694: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9695: return;
9696: }
1.1003 raeburn 9697: my (@homeservers,$uhome);
9698: if (defined(&domain($domain,'primary'))) {
9699: $uhome=&domain($domain,'primary');
9700: push(@homeservers,&domain($domain,'primary'));
9701: } else {
9702: my %servers = &get_servers($domain,'library');
9703: foreach my $tryserver (keys(%servers)) {
9704: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
9705: push(@homeservers,$tryserver);
9706: }
9707: }
9708: }
9709: my $response;
9710: foreach my $server (@homeservers) {
9711: $response=&reply('autopossibleinstcodes:'.$domain,$server);
9712: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 9713: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
9714: split(':',$response);
9715: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
9716: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 9717: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 9718: my ($name,$value)=split('=',$item);
9719: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 9720: }
9721: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 9722: my ($name,$value)=split('=',$item);
9723: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 9724: }
9725: return 'ok';
9726: }
9727: return $response;
9728: }
1.792 raeburn 9729:
1.1010 raeburn 9730: sub auto_courserequest_checks {
9731: my ($dom) = @_;
1.1020 raeburn 9732: my ($homeserver,%validations);
9733: if ($dom =~ /^$match_domain$/) {
9734: $homeserver = &domain($dom,'primary');
9735: }
9736: unless ($homeserver eq 'no_host') {
9737: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
9738: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9739: my @items = split(/&/,$response);
9740: foreach my $item (@items) {
9741: my ($key,$value) = split('=',$item);
9742: $validations{&unescape($key)} = &thaw_unescape($value);
9743: }
9744: }
9745: }
1.1010 raeburn 9746: return %validations;
9747: }
9748:
1.1020 raeburn 9749: sub auto_courserequest_validation {
1.1255 raeburn 9750: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 9751: my ($homeserver,$response);
9752: if ($dom =~ /^$match_domain$/) {
9753: $homeserver = &domain($dom,'primary');
9754: }
1.1255 raeburn 9755: unless ($homeserver eq 'no_host') {
9756: my $customdata;
9757: if (ref($custominfo) eq 'HASH') {
9758: $customdata = &freeze_escape($custominfo);
9759: }
1.1020 raeburn 9760: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 9761: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255 raeburn 9762: ':'.&escape($instcode).':'.&escape($instseclist).':'.
9763: $customdata,$homeserver));
1.1020 raeburn 9764: }
9765: return $response;
9766: }
9767:
1.777 albertel 9768: sub auto_validate_class_sec {
1.918 raeburn 9769: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 9770: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 9771: my $ownerlist;
9772: if (ref($owners) eq 'ARRAY') {
9773: $ownerlist = join(',',@{$owners});
9774: } else {
9775: $ownerlist = $owners;
9776: }
1.773 raeburn 9777: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 9778: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 9779: return $response;
9780: }
9781:
1.1367 raeburn 9782: sub auto_validate_instclasses {
9783: my ($cdom,$cnum,$owners,$classesref) = @_;
9784: my ($homeserver,%validations);
9785: $homeserver = &homeserver($cnum,$cdom);
9786: unless ($homeserver eq 'no_host') {
9787: my $ownerlist;
9788: if (ref($owners) eq 'ARRAY') {
9789: $ownerlist = join(',',@{$owners});
9790: } else {
9791: $ownerlist = $owners;
9792: }
9793: if (ref($classesref) eq 'HASH') {
9794: my $classes = &freeze_escape($classesref);
9795: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
9796: ':'.$cdom.':'.$classes,$homeserver);
9797: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9798: my @items = split(/&/,$response);
9799: foreach my $item (@items) {
9800: my ($key,$value) = split('=',$item);
9801: $validations{&unescape($key)} = &thaw_unescape($value);
9802: }
9803: }
9804: }
9805: }
9806: return %validations;
9807: }
9808:
1.1248 raeburn 9809: sub auto_crsreq_update {
9810: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257 raeburn 9811: $code,$accessstart,$accessend,$inbound) = @_;
1.1248 raeburn 9812: my ($homeserver,%crsreqresponse);
9813: if ($cdom =~ /^$match_domain$/) {
9814: $homeserver = &domain($cdom,'primary');
9815: }
9816: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
9817: my $info;
9818: if (ref($inbound) eq 'HASH') {
9819: $info = &freeze_escape($inbound);
9820: }
9821: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
9822: ':'.&escape($action).':'.&escape($ownername).':'.
9823: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257 raeburn 9824: &escape($title).':'.&escape($code).':'.
9825: &escape($accessstart).':'.&escape($accessend).':'.$info,
9826: $homeserver);
1.1248 raeburn 9827: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
9828: my @items = split(/&/,$response);
9829: foreach my $item (@items) {
9830: my ($key,$value) = split('=',$item);
9831: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
9832: }
9833: }
9834: }
9835: return \%crsreqresponse;
9836: }
9837:
1.1305 raeburn 9838: sub auto_export_grades {
1.1309 raeburn 9839: my ($cdom,$cnum,$inforef,$gradesref) = @_;
9840: my ($homeserver,%exportresponse);
9841: if ($cdom =~ /^$match_domain$/) {
9842: $homeserver = &domain($cdom,'primary');
9843: }
9844: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
9845: my $info;
9846: if (ref($inforef) eq 'HASH') {
9847: $info = &freeze_escape($inforef);
9848: }
9849: if (ref($gradesref) eq 'HASH') {
9850: my $grades = &freeze_escape($gradesref);
9851: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
9852: $info.':'.$grades,$homeserver);
9853: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
9854: my @items = split(/&/,$response);
9855: foreach my $item (@items) {
9856: my ($key,$value) = split('=',$item);
9857: $exportresponse{&unescape($key)} = &thaw_unescape($value);
9858: }
9859: }
9860: }
9861: }
9862: return \%exportresponse;
1.1305 raeburn 9863: }
9864:
1.1287 raeburn 9865: sub check_instcode_cloning {
9866: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
9867: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9868: return;
9869: }
9870: my $canclone;
9871: if (@{$code_order} > 0) {
9872: my $instcoderegexp ='^';
9873: my @clonecodes = split(/\&/,$cloner);
9874: foreach my $item (@{$code_order}) {
9875: if (grep(/^\Q$item\E=/,@clonecodes)) {
9876: foreach my $pair (@clonecodes) {
9877: my ($key,$val) = split(/\=/,$pair,2);
9878: $val = &unescape($val);
9879: if ($key eq $item) {
9880: $instcoderegexp .= '('.$val.')';
9881: last;
9882: }
9883: }
9884: } else {
9885: $instcoderegexp .= $codedefaults->{$item};
9886: }
9887: }
9888: $instcoderegexp .= '$';
9889: my (@from,@to);
9890: eval {
9891: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9892: (@to) = ($clonetocode =~ /$instcoderegexp/);
9893: };
9894: if ((@from > 0) && (@to > 0)) {
9895: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9896: if (!@diffs) {
9897: $canclone = 1;
9898: }
9899: }
9900: }
9901: return $canclone;
9902: }
9903:
9904: sub default_instcode_cloning {
9905: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
9906: my (%codedefaults,@code_order,$canclone);
9907: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
9908: %codedefaults = %{$codedefaultsref};
9909: @code_order = @{$codeorderref};
9910: } elsif ($clonedom) {
9911: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
9912: }
9913: if (($domdefclone) && (@code_order)) {
9914: my @clonecodes = split(/\+/,$domdefclone);
9915: my $instcoderegexp ='^';
9916: foreach my $item (@code_order) {
9917: if (grep(/^\Q$item\E$/,@clonecodes)) {
9918: $instcoderegexp .= '('.$codedefaults{$item}.')';
9919: } else {
9920: $instcoderegexp .= $codedefaults{$item};
9921: }
9922: }
9923: $instcoderegexp .= '$';
9924: my (@from,@to);
9925: eval {
9926: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9927: (@to) = ($clonetocode =~ /$instcoderegexp/);
9928: };
9929: if ((@from > 0) && (@to > 0)) {
9930: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9931: if (!@diffs) {
9932: $canclone = 1;
9933: }
9934: }
9935: }
9936: return $canclone;
9937: }
9938:
1.679 raeburn 9939: # ------------------------------------------------------- Course Group routines
9940:
9941: sub get_coursegroups {
1.809 raeburn 9942: my ($cdom,$cnum,$group,$namespace) = @_;
9943: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 9944: }
9945:
1.679 raeburn 9946: sub modify_coursegroup {
9947: my ($cdom,$cnum,$groupsettings) = @_;
9948: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
9949: }
9950:
1.809 raeburn 9951: sub toggle_coursegroup_status {
9952: my ($cdom,$cnum,$group,$action) = @_;
9953: my ($from_namespace,$to_namespace);
9954: if ($action eq 'delete') {
9955: $from_namespace = 'coursegroups';
9956: $to_namespace = 'deleted_groups';
9957: } else {
9958: $from_namespace = 'deleted_groups';
9959: $to_namespace = 'coursegroups';
9960: }
9961: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 9962: if (my $tmp = &error(%curr_group)) {
9963: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
9964: return ('read error',$tmp);
9965: } else {
9966: my %savedsettings = %curr_group;
1.809 raeburn 9967: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 9968: my $deloutcome;
9969: if ($result eq 'ok') {
1.809 raeburn 9970: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 9971: } else {
9972: return ('write error',$result);
9973: }
9974: if ($deloutcome eq 'ok') {
9975: return 'ok';
9976: } else {
9977: return ('delete error',$deloutcome);
9978: }
9979: }
9980: }
9981:
1.679 raeburn 9982: sub modify_group_roles {
1.957 raeburn 9983: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 9984: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
9985: my $role = 'gr/'.&escape($userprivs);
9986: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 9987: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 9988: if ($result eq 'ok') {
9989: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
9990: }
1.679 raeburn 9991: return $result;
9992: }
9993:
9994: sub modify_coursegroup_membership {
9995: my ($cdom,$cnum,$membership) = @_;
9996: my $result = &put('groupmembership',$membership,$cdom,$cnum);
9997: return $result;
9998: }
9999:
1.682 raeburn 10000: sub get_active_groups {
10001: my ($udom,$uname,$cdom,$cnum) = @_;
10002: my $now = time;
10003: my %groups = ();
10004: foreach my $key (keys(%env)) {
1.811 albertel 10005: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 10006: my ($start,$end) = split(/\./,$env{$key});
10007: if (($end!=0) && ($end<$now)) { next; }
10008: if (($start!=0) && ($start>$now)) { next; }
10009: if ($1 eq $cdom && $2 eq $cnum) {
10010: $groups{$3} = $env{$key} ;
10011: }
10012: }
10013: }
10014: return %groups;
10015: }
10016:
1.683 raeburn 10017: sub get_group_membership {
10018: my ($cdom,$cnum,$group) = @_;
10019: return(&dump('groupmembership',$cdom,$cnum,$group));
10020: }
10021:
10022: sub get_users_groups {
10023: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 10024: my @usersgroups;
1.683 raeburn 10025: my $cachetime=1800;
10026:
10027: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 10028: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
10029: if (defined($cached)) {
1.734 albertel 10030: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 10031: } else {
10032: $grouplist = '';
1.816 raeburn 10033: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 10034: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 10035: my $access_end = $env{'course.'.$courseid.
10036: '.default_enrollment_end_date'};
10037: my $now = time;
10038: foreach my $key (keys(%roleshash)) {
10039: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
10040: my $group = $1;
10041: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
10042: my $start = $2;
10043: my $end = $1;
10044: if ($start == -1) { next; } # deleted from group
10045: if (($start!=0) && ($start>$now)) { next; }
10046: if (($end!=0) && ($end<$now)) {
10047: if ($access_end && $access_end < $now) {
10048: if ($access_end - $end < 86400) {
10049: push(@usersgroups,$group);
1.733 raeburn 10050: }
10051: }
1.817 raeburn 10052: next;
1.733 raeburn 10053: }
1.817 raeburn 10054: push(@usersgroups,$group);
1.683 raeburn 10055: }
10056: }
10057: }
1.817 raeburn 10058: @usersgroups = &sort_course_groups($courseid,@usersgroups);
10059: $grouplist = join(':',@usersgroups);
10060: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 10061: }
1.733 raeburn 10062: return @usersgroups;
1.683 raeburn 10063: }
10064:
10065: sub devalidate_getgroups_cache {
10066: my ($udom,$uname,$cdom,$cnum)=@_;
10067: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 10068:
1.683 raeburn 10069: my $hashid="$udom:$uname:$courseid";
10070: &devalidate_cache_new('getgroups',$hashid);
10071: }
10072:
1.12 www 10073: # ------------------------------------------------------------------ Plain Text
10074:
10075: sub plaintext {
1.988 raeburn 10076: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 10077: if ($short =~ m{^cr/}) {
1.758 albertel 10078: return (split('/',$short))[-1];
10079: }
1.742 raeburn 10080: if (!defined($cid)) {
10081: $cid = $env{'request.course.id'};
10082: }
10083: my %rolenames = (
1.1008 raeburn 10084: Course => 'std',
10085: Community => 'alt1',
1.1305 raeburn 10086: Placement => 'std',
1.742 raeburn 10087: );
1.1037 raeburn 10088: if ($cid ne '') {
10089: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
10090: unless ($forcedefault) {
10091: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
10092: &Apache::lonlocal::mt_escape(\$roletext);
10093: return &Apache::lonlocal::mt($roletext);
10094: }
10095: }
10096: }
10097: if ((defined($type)) && (defined($rolenames{$type})) &&
10098: (defined($rolenames{$type})) &&
10099: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 10100: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 10101: } elsif ($cid ne '') {
10102: my $crstype = $env{'course.'.$cid.'.type'};
10103: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
10104: (defined($prp{$short}{$rolenames{$crstype}}))) {
10105: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
10106: }
1.742 raeburn 10107: }
1.1037 raeburn 10108: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 10109: }
10110:
10111: # ----------------------------------------------------------------- Assign Role
10112:
10113: sub assignrole {
1.957 raeburn 10114: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
10115: $context)=@_;
1.21 www 10116: my $mrole;
10117: if ($role =~ /^cr\//) {
1.393 www 10118: my $cwosec=$url;
1.811 albertel 10119: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 10120: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 10121: my $refused = 1;
10122: if ($context eq 'requestcourses') {
10123: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
10124: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
10125: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
10126: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
10127: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10128: if ($crsenv{'internal.courseowner'} eq
10129: $env{'user.name'}.':'.$env{'user.domain'}) {
10130: $refused = '';
10131: }
10132: }
10133: }
10134: }
10135: }
10136: if ($refused) {
10137: &logthis('Refused custom assignrole: '.
10138: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
10139: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
10140: return 'refused';
10141: }
1.104 www 10142: }
1.21 www 10143: $mrole='cr';
1.678 raeburn 10144: } elsif ($role =~ /^gr\//) {
10145: my $cwogrp=$url;
1.811 albertel 10146: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 10147: unless (&allowed('mdg',$cwogrp)) {
10148: &logthis('Refused group assignrole: '.
10149: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
10150: $env{'user.name'}.' at '.$env{'user.domain'});
10151: return 'refused';
10152: }
10153: $mrole='gr';
1.21 www 10154: } else {
1.82 www 10155: my $cwosec=$url;
1.811 albertel 10156: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 10157: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
10158: my $refused;
10159: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
10160: if (!(&allowed('c'.$role,$url))) {
10161: $refused = 1;
10162: }
10163: } else {
10164: $refused = 1;
10165: }
1.947 raeburn 10166: if ($refused) {
1.1045 raeburn 10167: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
1.1377 raeburn 10168: if (!$selfenroll && (($context eq 'course') || ($context eq 'ltienroll' && $env{'request.lti.login'}))) {
1.1045 raeburn 10169: my %crsenv;
10170: if ($role eq 'cc' || $role eq 'co') {
10171: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10172: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
10173: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
10174: if ($crsenv{'internal.courseowner'} eq
10175: $env{'user.name'}.':'.$env{'user.domain'}) {
10176: $refused = '';
10177: }
10178: }
10179: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
10180: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
10181: if ($crsenv{'internal.courseowner'} eq
10182: $env{'user.name'}.':'.$env{'user.domain'}) {
10183: $refused = '';
10184: }
10185: }
10186: }
10187: }
1.1368 raeburn 10188: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
10189: if ($role eq 'st') {
10190: $refused = '';
1.1377 raeburn 10191: } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
1.1368 raeburn 10192: $refused = '';
10193: }
1.1017 raeburn 10194: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 10195: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 10196: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 10197: my $wrongcc;
10198: if ($cnum =~ /^$match_community$/) {
10199: $wrongcc = 1 if ($role eq 'cc');
10200: } else {
10201: $wrongcc = 1 if ($role eq 'co');
10202: }
10203: unless ($wrongcc) {
10204: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10205: if ($crsenv{'internal.courseowner'} eq
10206: $env{'user.name'}.':'.$env{'user.domain'}) {
10207: $refused = '';
10208: }
1.1017 raeburn 10209: }
10210: }
1.1183 raeburn 10211: } elsif ($context eq 'requestauthor') {
10212: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
10213: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
10214: if ($env{'environment.requestauthor'} eq 'automatic') {
10215: $refused = '';
10216: } else {
10217: my %domdefaults = &get_domain_defaults($udom);
10218: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
10219: my $checkbystatus;
10220: if ($env{'user.adv'}) {
10221: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
10222: if ($disposition eq 'automatic') {
10223: $refused = '';
10224: } elsif ($disposition eq '') {
10225: $checkbystatus = 1;
10226: }
10227: } else {
10228: $checkbystatus = 1;
10229: }
10230: if ($checkbystatus) {
10231: if ($env{'environment.inststatus'}) {
10232: my @inststatuses = split(/,/,$env{'environment.inststatus'});
10233: foreach my $type (@inststatuses) {
10234: if (($type ne '') &&
10235: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
10236: $refused = '';
10237: }
10238: }
10239: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
10240: $refused = '';
10241: }
10242: }
10243: }
10244: }
10245: }
1.1017 raeburn 10246: }
10247: if ($refused) {
1.947 raeburn 10248: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
10249: ' '.$role.' '.$end.' '.$start.' by '.
10250: $env{'user.name'}.' at '.$env{'user.domain'});
10251: return 'refused';
10252: }
1.932 raeburn 10253: }
1.1131 raeburn 10254: } elsif ($role eq 'au') {
10255: if ($url ne '/'.$udom.'/') {
10256: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
10257: ' to assign author role for '.$uname.':'.$udom.
10258: ' in domain: '.$url.' refused (wrong domain).');
10259: return 'refused';
10260: }
1.104 www 10261: }
1.21 www 10262: $mrole=$role;
10263: }
1.620 albertel 10264: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 10265: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 10266: if ($end) { $command.='_'.$end; }
1.21 www 10267: if ($start) {
10268: if ($end) {
1.81 www 10269: $command.='_'.$start;
1.21 www 10270: } else {
1.81 www 10271: $command.='_0_'.$start;
1.21 www 10272: }
10273: }
1.739 raeburn 10274: my $origstart = $start;
10275: my $origend = $end;
1.957 raeburn 10276: my $delflag;
1.357 www 10277: # actually delete
10278: if ($deleteflag) {
1.373 www 10279: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 10280: # modify command to delete the role
1.620 albertel 10281: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 10282: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 10283: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 10284: # set start and finish to negative values for userrolelog
10285: $start=-1;
10286: $end=-1;
1.957 raeburn 10287: $delflag = 1;
1.357 www 10288: }
10289: }
10290: # send command
1.349 www 10291: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 10292: # log new user role if status is ok
1.349 www 10293: if ($answer eq 'ok') {
1.663 raeburn 10294: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 10295: if (($role eq 'cc') || ($role eq 'in') ||
10296: ($role eq 'ep') || ($role eq 'ad') ||
10297: ($role eq 'ta') || ($role eq 'st') ||
10298: ($role=~/^cr/) || ($role eq 'gr') ||
10299: ($role eq 'co')) {
1.1200 raeburn 10300: # for course roles, perform group memberships changes triggered by role change.
10301: unless ($role =~ /^gr/) {
10302: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
10303: $origstart,$selfenroll,$context);
10304: }
1.1184 raeburn 10305: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10306: $selfenroll,$context);
10307: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1334 raeburn 10308: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
10309: ($role eq 'da')) {
1.1184 raeburn 10310: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10311: $context);
10312: } elsif (($role eq 'ca') || ($role eq 'aa')) {
10313: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
10314: $context);
10315: }
1.1053 raeburn 10316: if ($role eq 'cc') {
10317: &autoupdate_coowners($url,$end,$start,$uname,$udom);
10318: }
1.349 www 10319: }
10320: return $answer;
1.169 harris41 10321: }
10322:
1.1053 raeburn 10323: sub autoupdate_coowners {
10324: my ($url,$end,$start,$uname,$udom) = @_;
10325: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
10326: if (($cdom ne '') && ($cnum ne '')) {
10327: my $now = time;
10328: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
10329: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
10330: my %coursehash = &coursedescription($cdom.'_'.$cnum);
10331: my $instcode = $coursehash{'internal.coursecode'};
1.1444 raeburn 10332: my $xlists = $coursehash{'internal.crosslistings'};
1.1053 raeburn 10333: if ($instcode ne '') {
1.1056 raeburn 10334: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
10335: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 10336: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 10337: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
1.1444 raeburn 10338: unless ($result eq 'valid') {
10339: if ($xlists ne '') {
10340: foreach my $xlist (split(',',$xlists)) {
10341: my ($inst_crosslist,$lcsec) = split(':',$xlist);
10342: $result =
1.1446 raeburn 10343: &auto_validate_inst_crosslist($cnum,$cdom,$instcode,
10344: $inst_crosslist,$uname.':'.$udom);
10345: last if ($result eq 'valid');
1.1444 raeburn 10346: }
10347: }
10348: }
1.1056 raeburn 10349: if ($result eq 'valid') {
10350: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 10351: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10352: push(@newcoowners,$coowner);
10353: }
10354: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
10355: push(@newcoowners,$uname.':'.$udom);
10356: }
10357: @newcoowners = sort(@newcoowners);
10358: } else {
10359: push(@newcoowners,$uname.':'.$udom);
10360: }
1.1444 raeburn 10361: } elsif ($coursehash{'internal.co-owners'}) {
10362: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
10363: unless ($coowner eq $uname.':'.$udom) {
10364: push(@newcoowners,$coowner);
1.1053 raeburn 10365: }
1.1444 raeburn 10366: }
10367: unless (@newcoowners > 0) {
10368: $delcoowners = 1;
10369: $coowners = '';
1.1053 raeburn 10370: }
10371: }
10372: if (@newcoowners || $delcoowners) {
10373: &store_coowners($cdom,$cnum,$coursehash{'home'},
10374: $delcoowners,@newcoowners);
10375: }
10376: }
10377: }
10378: }
10379: }
10380: }
10381: }
10382:
10383: sub store_coowners {
10384: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
10385: my $cid = $cdom.'_'.$cnum;
10386: my ($coowners,$delresult,$putresult);
10387: if (@newcoowners) {
10388: $coowners = join(',',@newcoowners);
10389: my %coownershash = (
10390: 'internal.co-owners' => $coowners,
10391: );
10392: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
10393: if ($putresult eq 'ok') {
10394: if ($env{'course.'.$cid.'.num'} eq $cnum) {
10395: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
10396: }
10397: }
10398: }
10399: if ($delcoowners) {
10400: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
10401: if ($delresult eq 'ok') {
10402: if ($env{'course.'.$cid.'.internal.co-owners'}) {
10403: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
10404: }
10405: }
10406: }
10407: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
10408: my %crsinfo =
10409: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
10410: if (ref($crsinfo{$cid}) eq 'HASH') {
10411: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
10412: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
10413: }
10414: }
10415: }
10416:
1.169 harris41 10417: # -------------------------------------------------- Modify user authentication
1.197 www 10418: # Overrides without validation
10419:
1.169 harris41 10420: sub modifyuserauth {
10421: my ($udom,$uname,$umode,$upass)=@_;
10422: my $uhome=&homeserver($uname,$udom);
1.1409 raeburn 10423: my $allowed;
10424: if (&allowed('mau',$udom)) {
10425: $allowed = 1;
10426: } elsif (($umode eq 'internal') && ($udom eq $env{'user.domain'}) &&
10427: ($env{'request.course.id'}) && (&allowed('mip',$env{'request.course.id'})) &&
10428: (!$env{'course.'.$env{'request.course.id'}.'.internal.nopasswdchg'})) {
10429: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10430: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10431: if (($cdom ne '') && ($cnum ne '')) {
10432: my $is_owner = &is_course_owner($cdom,$cnum);
10433: if ($is_owner) {
10434: $allowed = 1;
10435: }
10436: }
10437: }
10438: unless ($allowed) { return 'refused'; }
1.197 www 10439: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 10440: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10441: ' in domain '.$env{'request.role.domain'});
1.169 harris41 10442: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
10443: &escape($upass),$uhome);
1.1434 raeburn 10444: my $ip = &get_requestor_ip();
1.620 albertel 10445: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 10446: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
1.1434 raeburn 10447: '(Remote '.$ip.'): '.$reply);
1.197 www 10448: &log($udom,,$uname,$uhome,
1.620 albertel 10449: 'Authentication changed by '.$env{'user.domain'}.', '.
10450: $env{'user.name'}.', '.$umode.
1.1435 raeburn 10451: '(Remote '.$ip.'): '.$reply);
1.169 harris41 10452: unless ($reply eq 'ok') {
1.197 www 10453: &logthis('Authentication mode error: '.$reply);
1.169 harris41 10454: return 'error: '.$reply;
10455: }
1.170 harris41 10456: return 'ok';
1.80 www 10457: }
10458:
1.81 www 10459: # --------------------------------------------------------------- Modify a user
1.80 www 10460:
1.81 www 10461: sub modifyuser {
1.206 matthew 10462: my ($udom, $uname, $uid,
10463: $umode, $upass, $first,
10464: $middle, $last, $gene,
1.1058 raeburn 10465: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 10466: $udom= &LONCAPA::clean_domain($udom);
10467: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 10468: my $showcandelete = 'none';
10469: if (ref($candelete) eq 'ARRAY') {
10470: if (@{$candelete} > 0) {
10471: $showcandelete = join(', ',@{$candelete});
10472: }
10473: }
1.81 www 10474: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 10475: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 10476: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 10477: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
10478: ' desiredhome not specified').
1.620 albertel 10479: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
10480: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 10481: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 10482: my $newuser;
10483: if ($uhome eq 'no_host') {
10484: $newuser = 1;
1.1368 raeburn 10485: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
10486: ($umode eq 'lti')) {
10487: return 'error: more information needed to create new user';
10488: }
1.1075 raeburn 10489: }
1.80 www 10490: # ----------------------------------------------------------------- Create User
1.406 albertel 10491: if (($uhome eq 'no_host') &&
1.1368 raeburn 10492: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
1.80 www 10493: my $unhome='';
1.844 albertel 10494: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 10495: $unhome = $desiredhome;
1.620 albertel 10496: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
10497: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 10498: } else { # load balancing routine for determining $unhome
1.81 www 10499: my $loadm=10000000;
1.841 albertel 10500: my %servers = &get_servers($udom,'library');
10501: foreach my $tryserver (keys(%servers)) {
10502: my $answer=reply('load',$tryserver);
10503: if (($answer=~/\d+/) && ($answer<$loadm)) {
10504: $loadm=$answer;
10505: $unhome=$tryserver;
10506: }
1.80 www 10507: }
10508: }
10509: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 10510: return 'error: unable to find a home server for '.$uname.
10511: ' in domain '.$udom;
1.80 www 10512: }
10513: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
10514: &escape($upass),$unhome);
10515: unless ($reply eq 'ok') {
10516: return 'error: '.$reply;
10517: }
1.230 stredwic 10518: $uhome=&homeserver($uname,$udom,'true');
1.80 www 10519: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 10520: return 'error: unable verify users home machine.';
1.80 www 10521: }
1.209 matthew 10522: } # End of creation of new user
1.80 www 10523: # ---------------------------------------------------------------------- Add ID
10524: if ($uid) {
10525: $uid=~tr/A-Z/a-z/;
10526: my %uidhash=&idrget($udom,$uname);
1.196 www 10527: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
10528: && (!$forceid)) {
1.80 www 10529: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 10530: return 'error: user id "'.$uid.'" does not match '.
10531: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 10532: }
10533: } else {
1.1300 raeburn 10534: &idput($udom,{$uname => $uid},$uhome,'ids');
1.80 www 10535: }
10536: }
10537: # -------------------------------------------------------------- Add names, etc
1.313 matthew 10538: my @tmp=&get('environment',
1.899 raeburn 10539: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 10540: 'permanentemail','inststatus'],
1.134 albertel 10541: $udom,$uname);
1.1075 raeburn 10542: my (%names,%oldnames);
1.313 matthew 10543: if ($tmp[0] =~ m/^error:.*/) {
10544: %names=();
10545: } else {
10546: %names = @tmp;
1.1075 raeburn 10547: %oldnames = %names;
1.313 matthew 10548: }
1.388 www 10549: #
1.1058 raeburn 10550: # If name, email and/or uid are blank (e.g., because an uploaded file
10551: # of users did not contain them), do not overwrite existing values
10552: # unless field is in $candelete array ref.
10553: #
10554:
10555: my @fields = ('firstname','middlename','lastname','generation',
10556: 'permanentemail','id');
10557: my %newvalues;
10558: if (ref($candelete) eq 'ARRAY') {
10559: foreach my $field (@fields) {
10560: if (grep(/^\Q$field\E$/,@{$candelete})) {
10561: if ($field eq 'firstname') {
10562: $names{$field} = $first;
10563: } elsif ($field eq 'middlename') {
10564: $names{$field} = $middle;
10565: } elsif ($field eq 'lastname') {
10566: $names{$field} = $last;
10567: } elsif ($field eq 'generation') {
10568: $names{$field} = $gene;
10569: } elsif ($field eq 'permanentemail') {
10570: $names{$field} = $email;
10571: } elsif ($field eq 'id') {
10572: $names{$field} = $uid;
10573: }
10574: }
10575: }
10576: }
1.388 www 10577: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 10578: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 10579: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 10580: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 10581: if ($email) {
10582: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 10583: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 10584: }
1.899 raeburn 10585: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 10586: if (defined($inststatus)) {
10587: $names{'inststatus'} = '';
10588: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
10589: if (ref($usertypes) eq 'HASH') {
10590: my @okstatuses;
10591: foreach my $item (split(/:/,$inststatus)) {
10592: if (defined($usertypes->{$item})) {
10593: push(@okstatuses,$item);
10594: }
10595: }
10596: if (@okstatuses) {
10597: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
10598: }
10599: }
10600: }
1.1075 raeburn 10601: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 10602: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 10603: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 10604: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
10605: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
10606: } else {
10607: $logmsg .= ' during self creation';
10608: }
1.1075 raeburn 10609: my $changed;
10610: if ($newuser) {
10611: $changed = 1;
10612: } else {
10613: foreach my $field (@fields) {
10614: if ($names{$field} ne $oldnames{$field}) {
10615: $changed = 1;
10616: last;
10617: }
10618: }
10619: }
10620: unless ($changed) {
10621: $logmsg = 'No changes in user information needed for: '.$logmsg;
10622: &logthis($logmsg);
10623: return 'ok';
10624: }
10625: my $reply = &put('environment', \%names, $udom,$uname);
10626: if ($reply ne 'ok') {
10627: return 'error: '.$reply;
10628: }
1.1087 raeburn 10629: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
10630: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
10631: }
1.1075 raeburn 10632: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
10633: &devalidate_cache_new('namescache',$uname.':'.$udom);
10634: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 10635: &logthis($logmsg);
1.134 albertel 10636: return 'ok';
1.80 www 10637: }
10638:
1.81 www 10639: # -------------------------------------------------------------- Modify student
1.80 www 10640:
1.81 www 10641: sub modifystudent {
10642: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 10643: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1314 raeburn 10644: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 10645: if (!$cid) {
1.620 albertel 10646: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 10647: return 'not_in_class';
10648: }
1.80 www 10649: }
10650: # --------------------------------------------------------------- Make the user
1.81 www 10651: my $reply=&modifyuser
1.209 matthew 10652: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 10653: $desiredhome,$email,$inststatus);
1.80 www 10654: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 10655: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 10656: # student's environment
1.297 matthew 10657: $uid = undef if (!$forceid);
1.455 albertel 10658: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 10659: $gene,$usec,$end,$start,$type,$locktype,
1.1314 raeburn 10660: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 10661: return $reply;
10662: }
10663:
10664: sub modify_student_enrollment {
1.1216 raeburn 10665: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1314 raeburn 10666: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455 albertel 10667: my ($cdom,$cnum,$chome);
10668: if (!$cid) {
1.620 albertel 10669: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 10670: return 'not_in_class';
10671: }
1.620 albertel 10672: $cdom=$env{'course.'.$cid.'.domain'};
10673: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 10674: } else {
10675: ($cdom,$cnum)=split(/_/,$cid);
10676: }
1.620 albertel 10677: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 10678: if (!$chome) {
1.457 raeburn 10679: $chome=&homeserver($cnum,$cdom);
1.297 matthew 10680: }
1.455 albertel 10681: if (!$chome) { return 'unknown_course'; }
1.297 matthew 10682: # Make sure the user exists
1.81 www 10683: my $uhome=&homeserver($uname,$udom);
10684: if (($uhome eq '') || ($uhome eq 'no_host')) {
10685: return 'error: no such user';
10686: }
1.297 matthew 10687: # Get student data if we were not given enough information
10688: if (!defined($first) || $first eq '' ||
10689: !defined($last) || $last eq '' ||
10690: !defined($uid) || $uid eq '' ||
10691: !defined($middle) || $middle eq '' ||
10692: !defined($gene) || $gene eq '') {
1.294 matthew 10693: # They did not supply us with enough data to enroll the student, so
10694: # we need to pick up more information.
1.297 matthew 10695: my %tmp = &get('environment',
1.294 matthew 10696: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 10697: ,$udom,$uname);
10698:
1.800 albertel 10699: #foreach my $key (keys(%tmp)) {
10700: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 10701: #}
1.294 matthew 10702: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
10703: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
10704: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 10705: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 10706: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
10707: }
1.556 albertel 10708: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 10709: my $user = "$uname:$udom";
10710: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 10711: my $reply=cput('classlist',
1.1148 raeburn 10712: {$user =>
1.1314 raeburn 10713: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 10714: $cdom,$cnum);
1.1148 raeburn 10715: if (($reply eq 'ok') || ($reply eq 'delayed')) {
10716: &devalidate_getsection_cache($udom,$uname,$cid);
10717: } else {
1.81 www 10718: return 'error: '.$reply;
10719: }
1.297 matthew 10720: # Add student role to user
1.83 www 10721: my $uurl='/'.$cid;
1.81 www 10722: $uurl=~s/\_/\//g;
10723: if ($usec) {
10724: $uurl.='/'.$usec;
10725: }
1.1148 raeburn 10726: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
10727: $selfenroll,$context);
10728: if ($result ne 'ok') {
10729: if ($old_entry{$user} ne '') {
10730: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
10731: } else {
10732: $reply = &del('classlist',[$user],$cdom,$cnum);
10733: }
10734: }
10735: return $result;
1.21 www 10736: }
10737:
1.556 albertel 10738: sub format_name {
10739: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
10740: my $name;
10741: if ($first ne 'lastname') {
10742: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
10743: } else {
10744: if ($lastname=~/\S/) {
10745: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
10746: $name=~s/\s+,/,/;
10747: } else {
10748: $name.= $firstname.' '.$middlename.' '.$generation;
10749: }
10750: }
10751: $name=~s/^\s+//;
10752: $name=~s/\s+$//;
10753: $name=~s/\s+/ /g;
10754: return $name;
10755: }
10756:
1.84 www 10757: # ------------------------------------------------- Write to course preferences
10758:
10759: sub writecoursepref {
10760: my ($courseid,%prefs)=@_;
10761: $courseid=~s/^\///;
10762: $courseid=~s/\_/\//g;
10763: my ($cdomain,$cnum)=split(/\//,$courseid);
10764: my $chome=homeserver($cnum,$cdomain);
10765: if (($chome eq '') || ($chome eq 'no_host')) {
10766: return 'error: no such course';
10767: }
10768: my $cstring='';
1.800 albertel 10769: foreach my $pref (keys(%prefs)) {
10770: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 10771: }
1.84 www 10772: $cstring=~s/\&$//;
10773: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
10774: }
10775:
10776: # ---------------------------------------------------------- Make/modify course
10777:
10778: sub createcourse {
1.741 raeburn 10779: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1423 raeburn 10780: $course_owner,$crstype,$cnum,$context,$category,$callercontext)=@_;
1.84 www 10781: $url=&declutter($url);
10782: my $cid='';
1.1028 raeburn 10783: if ($context eq 'requestcourses') {
10784: my $can_create = 0;
10785: my ($ownername,$ownerdom) = split(':',$course_owner);
10786: if ($udom eq $ownerdom) {
1.1423 raeburn 10787: my $reload;
10788: if (($callercontext eq 'auto') &&
10789: ($ownerdom eq $env{'user.domain'}) && ($ownername eq $env{'user.name'})) {
10790: $reload = 'reload';
10791: }
10792: if (&usertools_access($ownername,$ownerdom,$category,$reload,
1.1028 raeburn 10793: $context)) {
10794: $can_create = 1;
10795: }
10796: } else {
10797: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
10798: $category);
10799: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
10800: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
10801: if (@curr > 0) {
10802: my @options = qw(approval validate autolimit);
10803: my $optregex = join('|',@options);
10804: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
10805: $can_create = 1;
10806: }
10807: }
10808: }
10809: }
10810: if ($can_create) {
10811: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
10812: unless (&allowed('ccc',$udom)) {
10813: return 'refused';
10814: }
1.1017 raeburn 10815: }
10816: } else {
10817: return 'refused';
10818: }
1.1028 raeburn 10819: } elsif (!&allowed('ccc',$udom)) {
10820: return 'refused';
1.84 www 10821: }
1.1011 raeburn 10822: # --------------------------------------------------------------- Get Unique ID
10823: my $uname;
10824: if ($cnum =~ /^$match_courseid$/) {
10825: my $chome=&homeserver($cnum,$udom,'true');
10826: if (($chome eq '') || ($chome eq 'no_host')) {
10827: $uname = $cnum;
10828: } else {
1.1038 raeburn 10829: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 10830: }
10831: } else {
1.1038 raeburn 10832: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 10833: }
10834: return $uname if ($uname =~ /^error/);
10835: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 10836: if (!defined($course_server)) {
10837: if (defined(&domain($udom,'primary'))) {
10838: $course_server = &domain($udom,'primary');
10839: } else {
10840: $course_server = $env{'user.home'};
10841: }
10842: }
10843: my %host_servers =
10844: &Apache::lonnet::get_servers($udom,'library');
10845: unless ($host_servers{$course_server}) {
10846: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 10847: }
1.84 www 10848: # ------------------------------------------------------------- Make the course
10849: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 10850: $course_server);
1.84 www 10851: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 10852: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 10853: if (($uhome eq '') || ($uhome eq 'no_host')) {
10854: return 'error: no such course';
10855: }
1.271 www 10856: # ----------------------------------------------------------------- Course made
1.516 raeburn 10857: # log existence
1.1029 raeburn 10858: my $now = time;
1.918 raeburn 10859: my $newcourse = {
10860: $udom.'_'.$uname => {
1.921 raeburn 10861: description => $description,
10862: inst_code => $inst_code,
10863: owner => $course_owner,
10864: type => $crstype,
1.1029 raeburn 10865: creator => $env{'user.name'}.':'.
10866: $env{'user.domain'},
10867: created => $now,
10868: context => $context,
1.918 raeburn 10869: },
10870: };
1.921 raeburn 10871: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 10872: # set toplevel url
1.271 www 10873: my $topurl=$url;
10874: unless ($nonstandard) {
10875: # ------------------------------------------ For standard courses, make top url
10876: my $mapurl=&clutter($url);
1.278 www 10877: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 10878: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 10879: <map>
10880: <resource id="1" type="start"></resource>
10881: <resource id="2" src="$mapurl"></resource>
10882: <resource id="3" type="finish"></resource>
10883: <link index="1" from="1" to="2"></link>
10884: <link index="2" from="2" to="3"></link>
10885: </map>
10886: ENDINITMAP
10887: $topurl=&declutter(
1.638 albertel 10888: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 10889: );
10890: }
10891: # ----------------------------------------------------------- Write preferences
1.84 www 10892: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 10893: ('description' => $description,
10894: 'url' => $topurl,
10895: 'internal.creator' => $env{'user.name'}.':'.
10896: $env{'user.domain'},
10897: 'internal.created' => $now,
10898: 'internal.creationcontext' => $context)
10899: );
1.84 www 10900: return '/'.$udom.'/'.$uname;
10901: }
10902:
1.1011 raeburn 10903: # ------------------------------------------------------------------- Create ID
10904: sub generate_coursenum {
1.1038 raeburn 10905: my ($udom,$crstype) = @_;
1.1011 raeburn 10906: my $domdesc = &domain($udom);
10907: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 10908: my $first;
10909: if ($crstype eq 'Community') {
10910: $first = '0';
10911: } else {
10912: $first = int(1+rand(9));
10913: }
10914: my $uname=$first.
1.1011 raeburn 10915: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10916: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10917: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10918: # ----------------------------------------------- Make sure that does not exist
10919: my $uhome=&homeserver($uname,$udom,'true');
10920: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 10921: if ($crstype eq 'Community') {
10922: $first = '0';
10923: } else {
10924: $first = int(1+rand(9));
10925: }
10926: $uname=$first.
1.1011 raeburn 10927: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10928: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10929: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10930: $uhome=&homeserver($uname,$udom,'true');
10931: unless (($uhome eq '') || ($uhome eq 'no_host')) {
10932: return 'error: unable to generate unique course-ID';
10933: }
10934: }
10935: return $uname;
10936: }
10937:
1.813 albertel 10938: sub is_course {
1.1167 droeschl 10939: my ($cdom, $cnum) = scalar(@_) == 1 ?
10940: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
10941:
1.1381 raeburn 10942: return unless (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/));
10943: my $uhome=&homeserver($cnum,$cdom);
10944: my $iscourse;
10945: if (grep { $_ eq $uhome } current_machine_ids()) {
1.1382 raeburn 10946: $iscourse = &LONCAPA::Lond::is_course($cdom,$cnum);
1.1381 raeburn 10947: } else {
10948: my $hashid = $cdom.':'.$cnum;
10949: ($iscourse,my $cached) = &is_cached_new('iscourse',$hashid);
10950: unless (defined($cached)) {
10951: my %courses = &courseiddump($cdom, '.', 1, '.', '.',
10952: $cnum,undef,undef,'.');
10953: $iscourse = 0;
10954: if (exists($courses{$cdom.'_'.$cnum})) {
10955: $iscourse = 1;
10956: }
10957: &do_cache_new('iscourse',$hashid,$iscourse,3600);
10958: }
10959: }
10960: return unless ($iscourse);
1.1167 droeschl 10961: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 10962: }
10963:
1.1015 raeburn 10964: sub store_userdata {
10965: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 10966: my $result;
1.1016 raeburn 10967: if ($datakey ne '') {
1.1013 raeburn 10968: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 10969: if ($udom eq '' || $uname eq '') {
10970: $udom = $env{'user.domain'};
10971: $uname = $env{'user.name'};
10972: }
10973: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 10974: if (($uhome eq '') || ($uhome eq 'no_host')) {
10975: $result = 'error: no_host';
10976: } else {
1.1434 raeburn 10977: $storehash->{'ip'} = &get_requestor_ip();
1.1013 raeburn 10978: $storehash->{'host'} = $perlvar{'lonHostID'};
10979:
10980: my $namevalue='';
10981: foreach my $key (keys(%{$storehash})) {
10982: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
10983: }
10984: $namevalue=~s/\&$//;
1.1224 raeburn 10985: unless ($namespace eq 'courserequests') {
10986: $datakey = &escape($datakey);
10987: }
1.1105 raeburn 10988: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
10989: $namevalue,$uhome);
1.1013 raeburn 10990: }
10991: } else {
10992: $result = 'error: data to store was not a hash reference';
10993: }
10994: } else {
10995: $result= 'error: invalid requestkey';
10996: }
10997: return $result;
10998: }
10999:
1.21 www 11000: # ---------------------------------------------------------- Assign Custom Role
11001:
11002: sub assigncustomrole {
1.957 raeburn 11003: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11004: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 11005: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 11006: }
11007:
11008: # ----------------------------------------------------------------- Revoke Role
11009:
11010: sub revokerole {
1.957 raeburn 11011: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11012: my $now=time;
1.965 raeburn 11013: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 11014: }
11015:
11016: # ---------------------------------------------------------- Revoke Custom Role
11017:
11018: sub revokecustomrole {
1.957 raeburn 11019: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11020: my $now=time;
1.357 www 11021: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 11022: $deleteflag,$selfenroll,$context);
1.17 www 11023: }
11024:
1.533 banghart 11025: # ------------------------------------------------------------ Disk usage
1.535 albertel 11026: sub diskusage {
1.955 raeburn 11027: my ($udom,$uname,$directorypath,$getpropath)=@_;
11028: $directorypath =~ s/\/$//;
11029: my $listing=&reply('du2:'.&escape($directorypath).':'
11030: .&escape($getpropath).':'.&escape($uname).':'
11031: .&escape($udom),homeserver($uname,$udom));
11032: if ($listing eq 'unknown_cmd') {
11033: if ($getpropath) {
11034: $directorypath = &propath($udom,$uname).'/'.$directorypath;
11035: }
11036: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
11037: }
1.514 albertel 11038: return $listing;
1.512 banghart 11039: }
11040:
1.566 banghart 11041: sub is_locked {
1.1096 raeburn 11042: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 11043: my @check;
11044: my $is_locked;
1.1093 raeburn 11045: push (@check,$file_name);
1.613 albertel 11046: my %locked = &get('file_permissions',\@check,
1.620 albertel 11047: $env{'user.domain'},$env{'user.name'});
1.615 albertel 11048: my ($tmp)=keys(%locked);
11049: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 11050:
1.566 banghart 11051: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 11052: $is_locked = 'false';
11053: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 11054: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 11055: $is_locked = 'true';
1.1096 raeburn 11056: if (ref($which) eq 'ARRAY') {
11057: push(@{$which},$entry);
11058: } else {
11059: last;
11060: }
1.745 raeburn 11061: }
11062: }
1.566 banghart 11063: } else {
11064: $is_locked = 'false';
11065: }
1.1093 raeburn 11066: return $is_locked;
1.566 banghart 11067: }
11068:
1.759 albertel 11069: sub declutter_portfile {
11070: my ($file) = @_;
1.833 albertel 11071: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 11072: return $file;
11073: }
11074:
1.559 banghart 11075: # ------------------------------------------------------------- Mark as Read Only
11076:
11077: sub mark_as_readonly {
11078: my ($domain,$user,$files,$what) = @_;
1.613 albertel 11079: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11080: my ($tmp)=keys(%current_permissions);
11081: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 11082: foreach my $file (@{$files}) {
1.759 albertel 11083: $file = &declutter_portfile($file);
1.561 banghart 11084: push(@{$current_permissions{$file}},$what);
1.559 banghart 11085: }
1.613 albertel 11086: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 11087: return;
11088: }
11089:
1.572 banghart 11090: # ------------------------------------------------------------Save Selected Files
11091:
11092: sub save_selected_files {
11093: my ($user, $path, @files) = @_;
11094: my $filename = $user."savedfiles";
1.573 banghart 11095: my @other_files = &files_not_in_path($user, $path);
1.1359 raeburn 11096: open (OUT,'>',LONCAPA::tempdir().$filename);
1.573 banghart 11097: foreach my $file (@files) {
1.620 albertel 11098: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 11099: }
11100: foreach my $file (@other_files) {
1.574 banghart 11101: print (OUT $file."\n");
1.572 banghart 11102: }
1.574 banghart 11103: close (OUT);
1.572 banghart 11104: return 'ok';
11105: }
11106:
1.574 banghart 11107: sub clear_selected_files {
11108: my ($user) = @_;
11109: my $filename = $user."savedfiles";
1.1359 raeburn 11110: open (OUT,'>',LONCAPA::tempdir().$filename);
1.574 banghart 11111: print (OUT undef);
11112: close (OUT);
11113: return ("ok");
11114: }
11115:
1.572 banghart 11116: sub files_in_path {
11117: my ($user, $path) = @_;
11118: my $filename = $user."savedfiles";
11119: my %return_files;
1.1359 raeburn 11120: open (IN,'<',LONCAPA::tempdir().$filename);
1.573 banghart 11121: while (my $line_in = <IN>) {
1.574 banghart 11122: chomp ($line_in);
11123: my @paths_and_file = split (m!/!, $line_in);
11124: my $file_part = pop (@paths_and_file);
11125: my $path_part = join ('/', @paths_and_file);
1.573 banghart 11126: $path_part.='/';
11127: my $path_and_file = $path_part.$file_part;
11128: if ($path_part eq $path) {
11129: $return_files{$file_part}= 'selected';
11130: }
11131: }
1.574 banghart 11132: close (IN);
11133: return (\%return_files);
1.572 banghart 11134: }
11135:
11136: # called in portfolio select mode, to show files selected NOT in current directory
11137: sub files_not_in_path {
11138: my ($user, $path) = @_;
11139: my $filename = $user."savedfiles";
11140: my @return_files;
11141: my $path_part;
1.1359 raeburn 11142: open(IN, '<',LONCAPA::tempdir().$filename);
1.800 albertel 11143: while (my $line = <IN>) {
1.572 banghart 11144: #ok, I know it's clunky, but I want it to work
1.800 albertel 11145: my @paths_and_file = split(m|/|, $line);
11146: my $file_part = pop(@paths_and_file);
11147: chomp($file_part);
11148: my $path_part = join('/', @paths_and_file);
1.572 banghart 11149: $path_part .= '/';
11150: my $path_and_file = $path_part.$file_part;
11151: if ($path_part ne $path) {
1.800 albertel 11152: push(@return_files, ($path_and_file));
1.572 banghart 11153: }
11154: }
1.800 albertel 11155: close(OUT);
1.574 banghart 11156: return (@return_files);
1.572 banghart 11157: }
11158:
1.1273 raeburn 11159: #------------------------------Submitted/Handedback Portfolio Files Versioning
11160:
11161: sub portfiles_versioning {
11162: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
11163: my $portfolio_root = '/userfiles/portfolio';
11164: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
11165: foreach my $file (@{$portfiles}) {
11166: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
11167: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
11168: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
11169: my $getpropath = 1;
11170: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
11171: $stu_name,$getpropath);
11172: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
11173: my $new_answer =
11174: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
11175: if ($new_answer ne 'problem getting file') {
11176: push(@{$versioned_portfiles}, $directory.$new_answer);
11177: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
11178: [$symb,$env{'request.course.id'},'graded']);
11179: }
11180: }
11181: }
11182:
11183: sub get_next_version {
11184: my ($answer_name, $answer_ext, $dir_list) = @_;
11185: my $version;
11186: if (ref($dir_list) eq 'ARRAY') {
11187: foreach my $row (@{$dir_list}) {
11188: my ($file) = split(/\&/,$row,2);
11189: my ($file_name,$file_version,$file_ext) =
11190: &file_name_version_ext($file);
11191: if (($file_name eq $answer_name) &&
11192: ($file_ext eq $answer_ext)) {
11193: # gets here if filename and extension match,
11194: # regardless of version
11195: if ($file_version ne '') {
11196: # a versioned file is found so save it for later
11197: if ($file_version > $version) {
11198: $version = $file_version;
11199: }
11200: }
11201: }
11202: }
11203: }
11204: $version ++;
11205: return($version);
11206: }
11207:
11208: sub version_selected_portfile {
11209: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
11210: my ($answer_name,$answer_ver,$answer_ext) =
11211: &file_name_version_ext($file_name);
11212: my $new_answer;
11213: $env{'form.copy'} =
11214: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
11215: if($env{'form.copy'} eq '-1') {
11216: $new_answer = 'problem getting file';
11217: } else {
11218: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
11219: my $copy_result =
11220: &finishuserfileupload($stu_name,$domain,'copy',
11221: '/portfolio'.$directory.$new_answer);
11222: }
11223: undef($env{'form.copy'});
11224: return ($new_answer);
11225: }
11226:
11227: sub file_name_version_ext {
11228: my ($file)=@_;
11229: my @file_parts = split(/\./, $file);
11230: my ($name,$version,$ext);
11231: if (@file_parts > 1) {
11232: $ext=pop(@file_parts);
11233: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
11234: $version=pop(@file_parts);
11235: }
11236: $name=join('.',@file_parts);
11237: } else {
11238: $name=join('.',@file_parts);
11239: }
11240: return($name,$version,$ext);
11241: }
11242:
1.745 raeburn 11243: #----------------------------------------------Get portfolio file permissions
1.629 banghart 11244:
1.745 raeburn 11245: sub get_portfile_permissions {
11246: my ($domain,$user) = @_;
1.613 albertel 11247: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11248: my ($tmp)=keys(%current_permissions);
11249: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 11250: return \%current_permissions;
11251: }
11252:
11253: #---------------------------------------------Get portfolio file access controls
11254:
1.749 raeburn 11255: sub get_access_controls {
1.745 raeburn 11256: my ($current_permissions,$group,$file) = @_;
1.769 albertel 11257: my %access;
11258: my $real_file = $file;
11259: $file =~ s/\.meta$//;
1.745 raeburn 11260: if (defined($file)) {
1.749 raeburn 11261: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
11262: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 11263: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 11264: }
11265: }
1.745 raeburn 11266: } else {
1.749 raeburn 11267: foreach my $key (keys(%{$current_permissions})) {
11268: if ($key =~ /\0accesscontrol$/) {
11269: if (defined($group)) {
11270: if ($key !~ m-^\Q$group\E/-) {
11271: next;
11272: }
11273: }
11274: my ($fullpath) = split(/\0/,$key);
11275: if (ref($$current_permissions{$key}) eq 'HASH') {
11276: foreach my $control (keys(%{$$current_permissions{$key}})) {
11277: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
11278: }
11279: }
11280: }
11281: }
11282: }
11283: return %access;
11284: }
11285:
11286: sub modify_access_controls {
11287: my ($file_name,$changes,$domain,$user)=@_;
11288: my ($outcome,$deloutcome);
11289: my %store_permissions;
11290: my %new_values;
11291: my %new_control;
11292: my %translation;
11293: my @deletions = ();
11294: my $now = time;
11295: if (exists($$changes{'activate'})) {
11296: if (ref($$changes{'activate'}) eq 'HASH') {
11297: my @newitems = sort(keys(%{$$changes{'activate'}}));
11298: my $numnew = scalar(@newitems);
11299: for (my $i=0; $i<$numnew; $i++) {
11300: my $newkey = $newitems[$i];
11301: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 11302: if ($newkey =~ /^\d+:/) {
11303: $newkey =~ s/^(\d+)/$newid/;
11304: $translation{$1} = $newid;
11305: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
11306: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
11307: $translation{$1} = $newid;
11308: }
1.749 raeburn 11309: $new_values{$file_name."\0".$newkey} =
11310: $$changes{'activate'}{$newitems[$i]};
11311: $new_control{$newkey} = $now;
11312: }
11313: }
11314: }
11315: my %todelete;
11316: my %changed_items;
11317: foreach my $action ('delete','update') {
11318: if (exists($$changes{$action})) {
11319: if (ref($$changes{$action}) eq 'HASH') {
11320: foreach my $key (keys(%{$$changes{$action}})) {
11321: my ($itemnum) = ($key =~ /^([^:]+):/);
11322: if ($action eq 'delete') {
11323: $todelete{$itemnum} = 1;
11324: } else {
11325: $changed_items{$itemnum} = $key;
11326: }
11327: }
1.745 raeburn 11328: }
11329: }
1.749 raeburn 11330: }
11331: # get lock on access controls for file.
11332: my $lockhash = {
11333: $file_name."\0".'locked_access_records' => $env{'user.name'}.
11334: ':'.$env{'user.domain'},
11335: };
11336: my $tries = 0;
11337: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11338:
1.1288 damieng 11339: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 11340: $tries ++;
1.1289 damieng 11341: sleep(0.1);
1.749 raeburn 11342: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
11343: }
11344: if ($gotlock eq 'ok') {
11345: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
11346: my ($tmp)=keys(%curr_permissions);
11347: if ($tmp=~/^error:/) { undef(%curr_permissions); }
11348: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
11349: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
11350: if (ref($curr_controls) eq 'HASH') {
11351: foreach my $control_item (keys(%{$curr_controls})) {
11352: my ($itemnum) = ($control_item =~ /^([^:]+):/);
11353: if (defined($todelete{$itemnum})) {
11354: push(@deletions,$file_name."\0".$control_item);
11355: } else {
11356: if (defined($changed_items{$itemnum})) {
11357: $new_control{$changed_items{$itemnum}} = $now;
11358: push(@deletions,$file_name."\0".$control_item);
11359: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
11360: } else {
11361: $new_control{$control_item} = $$curr_controls{$control_item};
11362: }
11363: }
1.745 raeburn 11364: }
11365: }
11366: }
1.970 raeburn 11367: my ($group);
11368: if (&is_course($domain,$user)) {
11369: ($group,my $file) = split(/\//,$file_name,2);
11370: }
1.749 raeburn 11371: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
11372: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
11373: $outcome = &put('file_permissions',\%new_values,$domain,$user);
11374: # remove lock
11375: my @del_lock = ($file_name."\0".'locked_access_records');
11376: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 11377: my $sqlresult =
1.970 raeburn 11378: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 11379: $group);
1.749 raeburn 11380: } else {
11381: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 11382: }
1.749 raeburn 11383: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 11384: }
11385:
1.827 raeburn 11386: sub make_public_indefinitely {
1.1271 raeburn 11387: my (@requrl) = @_;
11388: return &automated_portfile_access('public',\@requrl);
11389: }
11390:
11391: sub automated_portfile_access {
11392: my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273 raeburn 11393: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
11394: return 'invalid';
11395: }
1.1271 raeburn 11396: my %urls;
11397: if (ref($addsref) eq 'ARRAY') {
11398: foreach my $requrl (@{$addsref}) {
11399: if (&is_portfolio_url($requrl)) {
11400: unless (exists($urls{$requrl})) {
11401: $urls{$requrl} = 'add';
11402: }
11403: }
11404: }
11405: }
11406: if (ref($delsref) eq 'ARRAY') {
11407: foreach my $requrl (@{$delsref}) {
11408: if (&is_portfolio_url($requrl)) {
11409: unless (exists($urls{$requrl})) {
11410: $urls{$requrl} = 'delete';
11411: }
11412: }
11413: }
11414: }
11415: unless (keys(%urls)) {
11416: return 'invalid';
11417: }
11418: my $ip;
11419: if ($accesstype eq 'ip') {
11420: if (ref($info) eq 'HASH') {
11421: if ($info->{'ip'} ne '') {
11422: $ip = $info->{'ip'};
11423: }
11424: }
11425: if ($ip eq '') {
11426: return 'invalid';
11427: }
11428: }
11429: my $errors;
1.827 raeburn 11430: my $now = time;
1.1271 raeburn 11431: my %current_perms;
11432: foreach my $requrl (sort(keys(%urls))) {
11433: my $action;
11434: if ($urls{$requrl} eq 'add') {
11435: $action = 'activate';
11436: } else {
11437: $action = 'none';
11438: }
11439: my $aclnum = 0;
1.827 raeburn 11440: my (undef,$udom,$unum,$file_name,$group) =
11441: &parse_portfolio_url($requrl);
1.1271 raeburn 11442: unless (exists($current_perms{$unum.':'.$udom})) {
11443: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
11444: }
11445: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827 raeburn 11446: $group,$file_name);
11447: foreach my $key (keys(%{$access_controls{$file_name}})) {
11448: my ($num,$scope,$end,$start) =
11449: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271 raeburn 11450: if ($scope eq $accesstype) {
11451: if (($start <= $now) && ($end == 0)) {
11452: if ($accesstype eq 'ip') {
11453: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
11454: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
11455: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
11456: if ($urls{$requrl} eq 'add') {
11457: $action = 'none';
11458: last;
11459: } else {
11460: $action = 'delete';
11461: $aclnum = $num;
11462: last;
11463: }
11464: }
11465: }
11466: }
11467: } elsif ($accesstype eq 'public') {
11468: if ($urls{$requrl} eq 'add') {
11469: $action = 'none';
11470: last;
11471: } else {
11472: $action = 'delete';
11473: $aclnum = $num;
11474: last;
11475: }
11476: }
11477: } elsif ($accesstype eq 'public') {
1.827 raeburn 11478: $action = 'update';
11479: $aclnum = $num;
1.1271 raeburn 11480: last;
1.827 raeburn 11481: }
11482: }
11483: }
11484: if ($action eq 'none') {
1.1271 raeburn 11485: next;
1.827 raeburn 11486: } else {
11487: my %changes;
11488: my $newend = 0;
11489: my $newstart = $now;
1.1271 raeburn 11490: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827 raeburn 11491: $changes{$action}{$newkey} = {
1.1271 raeburn 11492: type => $accesstype,
1.827 raeburn 11493: time => {
11494: start => $newstart,
11495: end => $newend,
11496: },
11497: };
1.1271 raeburn 11498: if ($accesstype eq 'ip') {
11499: $changes{$action}{$newkey}{'ip'} = [$ip];
11500: }
1.827 raeburn 11501: my ($outcome,$deloutcome,$new_values,$translation) =
11502: &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271 raeburn 11503: unless ($outcome eq 'ok') {
11504: $errors .= $outcome.' ';
11505: }
1.827 raeburn 11506: }
1.1271 raeburn 11507: }
11508: if ($errors) {
11509: $errors =~ s/\s$//;
11510: return $errors;
1.827 raeburn 11511: } else {
1.1271 raeburn 11512: return 'ok';
1.827 raeburn 11513: }
11514: }
11515:
1.745 raeburn 11516: #------------------------------------------------------Get Marked as Read Only
11517:
11518: sub get_marked_as_readonly {
11519: my ($domain,$user,$what,$group) = @_;
11520: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 11521: my @readonly_files;
1.629 banghart 11522: my $cmp1=$what;
11523: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 11524: while (my ($file_name,$value) = each(%{$current_permissions})) {
11525: if (defined($group)) {
11526: if ($file_name !~ m-^\Q$group\E/-) {
11527: next;
11528: }
11529: }
1.561 banghart 11530: if (ref($value) eq "ARRAY"){
11531: foreach my $stored_what (@{$value}) {
1.629 banghart 11532: my $cmp2=$stored_what;
1.759 albertel 11533: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 11534: $cmp2=join('',@{$stored_what});
1.745 raeburn 11535: }
1.629 banghart 11536: if ($cmp1 eq $cmp2) {
1.561 banghart 11537: push(@readonly_files, $file_name);
1.745 raeburn 11538: last;
1.563 banghart 11539: } elsif (!defined($what)) {
11540: push(@readonly_files, $file_name);
1.745 raeburn 11541: last;
1.561 banghart 11542: }
11543: }
1.745 raeburn 11544: }
1.561 banghart 11545: }
11546: return @readonly_files;
11547: }
1.577 banghart 11548: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 11549:
1.577 banghart 11550: sub get_marked_as_readonly_hash {
1.745 raeburn 11551: my ($current_permissions,$group,$what) = @_;
1.577 banghart 11552: my %readonly_files;
1.745 raeburn 11553: while (my ($file_name,$value) = each(%{$current_permissions})) {
11554: if (defined($group)) {
11555: if ($file_name !~ m-^\Q$group\E/-) {
11556: next;
11557: }
11558: }
1.577 banghart 11559: if (ref($value) eq "ARRAY"){
11560: foreach my $stored_what (@{$value}) {
1.745 raeburn 11561: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 11562: foreach my $lock_descriptor(@{$stored_what}) {
11563: if ($lock_descriptor eq 'graded') {
11564: $readonly_files{$file_name} = 'graded';
11565: } elsif ($lock_descriptor eq 'handback') {
11566: $readonly_files{$file_name} = 'handback';
11567: } else {
11568: if (!exists($readonly_files{$file_name})) {
11569: $readonly_files{$file_name} = 'locked';
11570: }
11571: }
1.745 raeburn 11572: }
1.750 banghart 11573: }
1.577 banghart 11574: }
11575: }
11576: }
11577: return %readonly_files;
11578: }
1.559 banghart 11579: # ------------------------------------------------------------ Unmark as Read Only
11580:
11581: sub unmark_as_readonly {
1.629 banghart 11582: # unmarks $file_name (if $file_name is defined), or all files locked by $what
11583: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 11584: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 11585: $file_name = &declutter_portfile($file_name);
1.634 albertel 11586: my $symb_crs = $what;
11587: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 11588: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 11589: my ($tmp)=keys(%current_permissions);
11590: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 11591: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 11592: foreach my $file (@readonly_files) {
1.759 albertel 11593: my $clean_file = &declutter_portfile($file);
11594: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 11595: my $current_locks = $current_permissions{$file};
1.563 banghart 11596: my @new_locks;
11597: my @del_keys;
11598: if (ref($current_locks) eq "ARRAY"){
11599: foreach my $locker (@{$current_locks}) {
1.632 albertel 11600: my $compare=$locker;
1.749 raeburn 11601: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 11602: $compare=join('',@{$locker});
1.746 raeburn 11603: if ($compare ne $symb_crs) {
11604: push(@new_locks, $locker);
11605: }
1.563 banghart 11606: }
11607: }
1.650 albertel 11608: if (scalar(@new_locks) > 0) {
1.563 banghart 11609: $current_permissions{$file} = \@new_locks;
11610: } else {
11611: push(@del_keys, $file);
1.613 albertel 11612: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 11613: delete($current_permissions{$file});
1.563 banghart 11614: }
11615: }
1.561 banghart 11616: }
1.613 albertel 11617: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 11618: return;
11619: }
1.512 banghart 11620:
1.17 www 11621: # ------------------------------------------------------------ Directory lister
11622:
11623: sub dirlist {
1.955 raeburn 11624: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 11625: $uri=~s/^\///;
11626: $uri=~s/\/$//;
1.253 stredwic 11627: my ($udom, $uname);
1.955 raeburn 11628: if ($getuserdir) {
1.253 stredwic 11629: $udom = $userdomain;
11630: $uname = $username;
1.955 raeburn 11631: } else {
11632: (undef,$udom,$uname)=split(/\//,$uri);
11633: if(defined($userdomain)) {
11634: $udom = $userdomain;
11635: }
11636: if(defined($username)) {
11637: $uname = $username;
11638: }
1.253 stredwic 11639: }
1.955 raeburn 11640: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 11641:
1.955 raeburn 11642: $dirRoot = $perlvar{'lonDocRoot'};
11643: if (defined($getpropath)) {
11644: $dirRoot = &propath($udom,$uname);
1.253 stredwic 11645: $dirRoot =~ s/\/$//;
1.955 raeburn 11646: } elsif (defined($getuserdir)) {
11647: my $subdir=$uname.'__';
11648: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
11649: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
11650: ."/$udom/$subdir/$uname";
11651: } elsif (defined($alternateRoot)) {
11652: $dirRoot = $alternateRoot;
1.751 banghart 11653: }
1.253 stredwic 11654:
11655: if($udom) {
11656: if($uname) {
1.1135 raeburn 11657: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 11658: if ($uhome eq 'no_host') {
11659: return ([],'no_host');
11660: }
1.955 raeburn 11661: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 11662: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 11663: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 11664: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 11665: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 11666: } else {
11667: @listing_results = map { &unescape($_); } split(/:/,$listing);
11668: }
1.605 matthew 11669: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 11670: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 11671: @listing_results = split(/:/,$listing);
11672: } else {
11673: @listing_results = map { &unescape($_); } split(/:/,$listing);
11674: }
1.1135 raeburn 11675: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 11676: ($listing eq 'rejected') || ($listing eq 'refused') ||
11677: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11678: return ([],$listing);
11679: } else {
11680: return (\@listing_results);
1.1135 raeburn 11681: }
1.955 raeburn 11682: } elsif(!$alternateRoot) {
1.1136 raeburn 11683: my (%allusers,%listerror);
1.841 albertel 11684: my %servers = &get_servers($udom,'library');
1.955 raeburn 11685: foreach my $tryserver (keys(%servers)) {
11686: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
11687: &escape($udom),$tryserver);
11688: if ($listing eq 'unknown_cmd') {
11689: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
11690: $udom, $tryserver);
11691: } else {
11692: @listing_results = map { &unescape($_); } split(/:/,$listing);
11693: }
1.841 albertel 11694: if ($listing eq 'unknown_cmd') {
11695: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
11696: $udom, $tryserver);
11697: @listing_results = split(/:/,$listing);
11698: } else {
11699: @listing_results =
11700: map { &unescape($_); } split(/:/,$listing);
11701: }
1.1136 raeburn 11702: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
11703: ($listing eq 'rejected') || ($listing eq 'refused') ||
11704: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
11705: $listerror{$tryserver} = $listing;
11706: } else {
1.841 albertel 11707: foreach my $line (@listing_results) {
11708: my ($entry) = split(/&/,$line,2);
11709: $allusers{$entry} = 1;
11710: }
11711: }
1.253 stredwic 11712: }
1.1136 raeburn 11713: my @alluserslist=();
1.800 albertel 11714: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 11715: push(@alluserslist,$user.'&user');
1.253 stredwic 11716: }
1.1318 droeschl 11717:
11718: if (!%listerror) {
11719: # no errors
11720: return (\@alluserslist);
11721: } elsif (scalar(keys(%servers)) == 1) {
11722: # one library server, one error
11723: my ($key) = keys(%listerror);
11724: return (\@alluserslist, $listerror{$key});
11725: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
11726: # con_lost indicates that we might miss data from at least one
11727: # library server
11728: return (\@alluserslist, 'con_lost');
11729: } else {
11730: # multiple library servers and no con_lost -> data should be
11731: # complete.
11732: return (\@alluserslist);
11733: }
11734:
1.253 stredwic 11735: } else {
1.1136 raeburn 11736: return ([],'missing username');
1.253 stredwic 11737: }
1.955 raeburn 11738: } elsif(!defined($getpropath)) {
1.1136 raeburn 11739: my $path = $perlvar{'lonDocRoot'}.'/res/';
11740: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
11741: return (\@all_domains);
1.955 raeburn 11742: } else {
1.1136 raeburn 11743: return ([],'missing domain');
1.275 stredwic 11744: }
11745: }
11746:
11747: # --------------------------------------------- GetFileTimestamp
11748: # This function utilizes dirlist and returns the date stamp for
11749: # when it was last modified. It will also return an error of -1
11750: # if an error occurs
11751:
11752: sub GetFileTimestamp {
1.955 raeburn 11753: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 11754: $studentDomain = &LONCAPA::clean_domain($studentDomain);
11755: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 11756: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
11757: undef,$getuserdir);
11758: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
11759: return -1;
11760: }
11761: if (ref($fileref) eq 'ARRAY') {
11762: my @stats = split('&',$fileref->[0]);
1.375 matthew 11763: # @stats contains first the filename, then the stat output
11764: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 11765: } else {
11766: return -1;
1.253 stredwic 11767: }
1.26 www 11768: }
11769:
1.712 albertel 11770: sub stat_file {
11771: my ($uri) = @_;
1.787 albertel 11772: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 11773:
1.955 raeburn 11774: my ($udom,$uname,$file);
1.712 albertel 11775: if ($uri =~ m-^/(uploaded|editupload)/-) {
11776: ($udom,$uname,$file) =
1.811 albertel 11777: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 11778: $file = 'userfiles/'.$file;
11779: }
11780: if ($uri =~ m-^/res/-) {
11781: ($udom,$uname) =
1.807 albertel 11782: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 11783: $file = $uri;
11784: }
11785:
11786: if (!$udom || !$uname || !$file) {
11787: # unable to handle the uri
11788: return ();
11789: }
1.956 raeburn 11790: my $getpropath;
11791: if ($file =~ /^userfiles\//) {
11792: $getpropath = 1;
11793: }
1.1136 raeburn 11794: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
11795: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
11796: return ();
11797: } else {
11798: if (ref($listref) eq 'ARRAY') {
11799: my @stats = split('&',$listref->[0]);
11800: shift(@stats); #filename is first
11801: return @stats;
11802: }
1.712 albertel 11803: }
11804: return ();
11805: }
11806:
1.1313 raeburn 11807: # --------------------------------------------------------- recursedirs
11808: # Recursive function to traverse either a specific user's Authoring Space
11809: # or corresponding Published Resource Space, and populate the hash ref:
11810: # $dirhashref with URLs of all directories, and if $filehashref hash
11811: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
11812: # or .rights files in resource space, and .meta, .save, .log, and .bak
11813: # files in Authoring Space.
11814: #
11815: # Inputs:
11816: #
11817: # $is_home - true if current server is home server for user's space
11818: # $context - either: priv, or res respectively for Authoring or Resource Space.
11819: # $docroot - Document root (i.e., /home/httpd/html
11820: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
11821: # $relpath - Current path (relative to top level).
11822: # $dirhashref - reference to hash to populate with URLs of directories (Required)
11823: # $filehashref - reference to hash to populate with URLs of files (Optional)
11824: #
11825: # Returns: nothing
11826: #
11827: # Side Effects: populates $dirhashref, and $filehashref (if provided).
11828: #
11829: # Currently used by interface/londocs.pm to create linked select boxes for
11830: # directory and filename to import a Course "Author" resource into a course, and
11831: # also to create linked select boxes for Authoring Space and Directory to choose
11832: # save location for creation of a new "standard" problem from the Course Editor.
11833: #
11834:
11835: sub recursedirs {
11836: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
11837: return unless (ref($dirhashref) eq 'HASH');
11838: my $currpath = $docroot.$toppath;
11839: if ($relpath) {
11840: $currpath .= "/$relpath";
11841: }
11842: my $savefile;
11843: if (ref($filehashref)) {
11844: $savefile = 1;
11845: }
11846: if ($is_home) {
11847: if (opendir(my $dirh,$currpath)) {
11848: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
11849: next if ($item eq '');
11850: if (-d "$currpath/$item") {
11851: my $newpath;
11852: if ($relpath) {
11853: $newpath = "$relpath/$item";
11854: } else {
11855: $newpath = $item;
11856: }
11857: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
11858: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
11859: } elsif ($savefile) {
11860: if ($context eq 'priv') {
11861: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
11862: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
11863: }
11864: } else {
11865: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
11866: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
11867: }
11868: }
11869: }
11870: }
11871: closedir($dirh);
11872: }
11873: } else {
11874: my ($dirlistref,$listerror) =
11875: &dirlist($toppath.$relpath);
11876: my @dir_lines;
11877: my $dirptr=16384;
11878: if (ref($dirlistref) eq 'ARRAY') {
11879: foreach my $dir_line (sort
11880: {
11881: my ($afile)=split('&',$a,2);
11882: my ($bfile)=split('&',$b,2);
11883: return (lc($afile) cmp lc($bfile));
11884: } (@{$dirlistref})) {
11885: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
11886: split(/\&/,$dir_line,16);
11887: $item =~ s/\s+$//;
11888: next if (($item =~ /^\.\.?$/) || ($obs));
11889: if ($dirptr&$testdir) {
11890: my $newpath;
11891: if ($relpath) {
11892: $newpath = "$relpath/$item";
11893: } else {
11894: $relpath = '/';
11895: $newpath = $item;
11896: }
11897: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
11898: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
11899: } elsif ($savefile) {
11900: if ($context eq 'priv') {
11901: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
11902: $filehashref->{$relpath}{$item} = 1;
11903: }
11904: } else {
11905: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
11906: $filehashref->{$relpath}{$item} = 1;
11907: }
11908: }
11909: }
11910: }
11911: }
11912: }
11913: return;
11914: }
11915:
1.26 www 11916: # -------------------------------------------------------- Value of a Condition
11917:
1.713 albertel 11918: # gets the value of a specific preevaluated condition
11919: # stored in the string $env{user.state.<cid>}
11920: # or looks up a condition reference in the bighash and if if hasn't
11921: # already been evaluated recurses into docondval to get the value of
11922: # the condition, then memoizing it to
11923: # $env{user.state.<cid>.<condition>}
1.40 www 11924: sub directcondval {
11925: my $number=shift;
1.620 albertel 11926: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 11927: &Apache::lonuserstate::evalstate();
11928: }
1.713 albertel 11929: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
11930: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
11931: } elsif ($number =~ /^_/) {
11932: my $sub_condition;
11933: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11934: &GDBM_READER(),0640)) {
11935: $sub_condition=$bighash{'conditions'.$number};
11936: untie(%bighash);
11937: }
11938: my $value = &docondval($sub_condition);
1.949 raeburn 11939: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 11940: return $value;
11941: }
1.620 albertel 11942: if ($env{'user.state.'.$env{'request.course.id'}}) {
11943: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 11944: } else {
11945: return 2;
11946: }
11947: }
11948:
1.713 albertel 11949: # get the collection of conditions for this resource
1.26 www 11950: sub condval {
11951: my $condidx=shift;
1.54 www 11952: my $allpathcond='';
1.713 albertel 11953: foreach my $cond (split(/\|/,$condidx)) {
11954: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
11955: $allpathcond.=
11956: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
11957: }
1.191 harris41 11958: }
1.54 www 11959: $allpathcond=~s/\|$//;
1.713 albertel 11960: return &docondval($allpathcond);
11961: }
11962:
11963: #evaluates an expression of conditions
11964: sub docondval {
11965: my ($allpathcond) = @_;
11966: my $result=0;
11967: if ($env{'request.course.id'}
11968: && defined($allpathcond)) {
11969: my $operand='|';
11970: my @stack;
11971: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
11972: if ($chunk eq '(') {
11973: push @stack,($operand,$result);
11974: } elsif ($chunk eq ')') {
11975: my $before=pop @stack;
11976: if (pop @stack eq '&') {
11977: $result=$result>$before?$before:$result;
11978: } else {
11979: $result=$result>$before?$result:$before;
11980: }
11981: } elsif (($chunk eq '&') || ($chunk eq '|')) {
11982: $operand=$chunk;
11983: } else {
11984: my $new=directcondval($chunk);
11985: if ($operand eq '&') {
11986: $result=$result>$new?$new:$result;
11987: } else {
11988: $result=$result>$new?$result:$new;
11989: }
11990: }
11991: }
1.26 www 11992: }
11993: return $result;
1.421 albertel 11994: }
11995:
11996: # ---------------------------------------------------- Devalidate courseresdata
11997:
11998: sub devalidatecourseresdata {
11999: my ($coursenum,$coursedomain)=@_;
12000: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12001: &devalidate_cache_new('courseres',$hashid);
1.28 www 12002: }
12003:
1.763 www 12004:
1.200 www 12005: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 12006: #
12007: # Parameters:
12008: # $coursenum - Number of the course.
12009: # $coursedomain - Domain at which the course was created.
12010: # Returns:
12011: # A hash of the course parameters along (I think) with timestamps
12012: # and version info.
1.877 foxr 12013:
1.624 albertel 12014: sub get_courseresdata {
12015: my ($coursenum,$coursedomain)=@_;
1.200 www 12016: my $coursehom=&homeserver($coursenum,$coursedomain);
12017: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12018: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 12019: my %dumpreply;
1.417 albertel 12020: unless (defined($cached)) {
1.624 albertel 12021: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 12022: $result=\%dumpreply;
1.251 albertel 12023: my ($tmp) = keys(%dumpreply);
12024: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 12025: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 12026: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
12027: return $tmp;
1.416 albertel 12028: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 12029: $result=undef;
1.599 albertel 12030: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 12031: }
12032: }
1.624 albertel 12033: return $result;
12034: }
12035:
1.633 albertel 12036: sub devalidateuserresdata {
12037: my ($uname,$udom)=@_;
12038: my $hashid="$udom:$uname";
12039: &devalidate_cache_new('userres',$hashid);
12040: }
12041:
1.624 albertel 12042: sub get_userresdata {
12043: my ($uname,$udom)=@_;
12044: #most student don\'t have any data set, check if there is some data
12045: if (&EXT_cache_status($udom,$uname)) { return undef; }
12046:
12047: my $hashid="$udom:$uname";
12048: my ($result,$cached)=&is_cached_new('userres',$hashid);
12049: if (!defined($cached)) {
12050: my %resourcedata=&dump('resourcedata',$udom,$uname);
12051: $result=\%resourcedata;
12052: &do_cache_new('userres',$hashid,$result,600);
12053: }
12054: my ($tmp)=keys(%$result);
12055: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
12056: return $result;
12057: }
12058: #error 2 occurs when the .db doesn't exist
12059: if ($tmp!~/error: 2 /) {
1.1294 raeburn 12060: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
12061: &logthis("<font color=\"blue\">WARNING:".
12062: " Trying to get resource data for ".
12063: $uname." at ".$udom.": ".
12064: $tmp."</font>");
12065: }
1.624 albertel 12066: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 12067: #&EXT_cache_set($udom,$uname);
12068: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 12069: undef($tmp); # not really an error so don't send it back
1.624 albertel 12070: }
12071: return $tmp;
12072: }
1.879 foxr 12073: #----------------------------------------------- resdata - return resource data
12074: # Purpose:
12075: # Return resource data for either users or for a course.
12076: # Parameters:
12077: # $name - Course/user name.
12078: # $domain - Name of the domain the user/course is registered on.
1.1311 raeburn 12079: # $type - Type of thing $name is (must be 'course' or 'user')
1.1301 raeburn 12080: # $mapp - decluttered URL of enclosing map
12081: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
12082: # $recurseup - Ref to array of map URLs, starting with map containing
12083: # $mapp up through hierarchy of nested maps to top level map.
12084: # $courseid - CourseID (first part of param identifier).
12085: # $modifier - Middle part of param identifier.
12086: # $what - Last part of param identifier.
1.879 foxr 12087: # @which - Array of names of resources desired.
12088: # Returns:
12089: # The value of the first reasource in @which that is found in the
12090: # resource hash.
12091: # Exceptional Conditions:
12092: # If the $type passed in is not valid (not the string 'course' or
12093: # 'user', an undefined reference is returned.
12094: # If none of the resources are found, an undef is returned
1.624 albertel 12095: sub resdata {
1.1301 raeburn 12096: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
12097: $modifier,$what,@which)=@_;
1.624 albertel 12098: my $result;
12099: if ($type eq 'course') {
12100: $result=&get_courseresdata($name,$domain);
12101: } elsif ($type eq 'user') {
12102: $result=&get_userresdata($name,$domain);
12103: }
12104: if (!ref($result)) { return $result; }
1.251 albertel 12105: foreach my $item (@which) {
1.1301 raeburn 12106: if ($item->[1] eq 'course') {
12107: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
12108: unless ($$recursed) {
1.1302 raeburn 12109: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
1.1301 raeburn 12110: $$recursed = 1;
12111: }
12112: foreach my $item (@${recurseup}) {
12113: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
12114: last if (defined($result->{$norecursechk}));
12115: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
12116: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
12117: }
12118: }
12119: }
12120: if (defined($result->{$item->[0]})) {
1.927 albertel 12121: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 12122: }
1.250 albertel 12123: }
1.291 albertel 12124: return undef;
1.200 www 12125: }
12126:
1.1360 raeburn 12127: sub get_domain_lti {
12128: my ($cdom,$context) = @_;
12129: my ($name,%lti);
12130: if ($context eq 'consumer') {
12131: $name = 'ltitools';
12132: } elsif ($context eq 'provider') {
12133: $name = 'lti';
12134: } else {
12135: return %lti;
12136: }
12137: my ($result,$cached)=&is_cached_new($name,$cdom);
1.1298 raeburn 12138: if (defined($cached)) {
12139: if (ref($result) eq 'HASH') {
1.1360 raeburn 12140: %lti = %{$result};
1.1298 raeburn 12141: }
12142: } else {
1.1360 raeburn 12143: my %domconfig = &get_dom('configuration',[$name],$cdom);
12144: if (ref($domconfig{$name}) eq 'HASH') {
12145: %lti = %{$domconfig{$name}};
12146: my %encdomconfig = &get_dom('encconfig',[$name],$cdom);
12147: if (ref($encdomconfig{$name}) eq 'HASH') {
12148: foreach my $id (keys(%lti)) {
12149: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
1.1344 raeburn 12150: foreach my $item ('key','secret') {
1.1360 raeburn 12151: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
1.1344 raeburn 12152: }
12153: }
12154: }
12155: }
1.1298 raeburn 12156: }
12157: my $cachetime = 24*60*60;
1.1360 raeburn 12158: &do_cache_new($name,$cdom,\%lti,$cachetime);
1.1298 raeburn 12159: }
1.1360 raeburn 12160: return %lti;
1.1298 raeburn 12161: }
12162:
1.1236 raeburn 12163: sub get_numsuppfiles {
12164: my ($cnum,$cdom,$ignorecache)=@_;
12165: my $hashid=$cnum.':'.$cdom;
12166: my ($suppcount,$cached);
12167: unless ($ignorecache) {
12168: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
12169: }
12170: unless (defined($cached)) {
12171: my $chome=&homeserver($cnum,$cdom);
12172: unless ($chome eq 'no_host') {
1.1366 raeburn 12173: ($suppcount,my $supptools,my $errors) = (0,0,0);
1.1236 raeburn 12174: my $suppmap = 'supplemental.sequence';
1.1366 raeburn 12175: ($suppcount,$supptools,$errors) =
12176: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,
12177: $supptools,$errors);
1.1236 raeburn 12178: }
12179: &do_cache_new('suppcount',$hashid,$suppcount,600);
12180: }
12181: return $suppcount;
12182: }
12183:
1.379 matthew 12184: #
12185: # EXT resource caching routines
12186: #
12187:
1.1302 raeburn 12188: {
12189: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
12190: #
12191: # The course for which we cache
12192: my $cachedmapkey='';
12193: # The cached recursive maps for this course
12194: my %cachedmaps=();
12195: # When this was last done
12196: my $cachedmaptime='';
12197:
1.379 matthew 12198: sub clear_EXT_cache_status {
1.383 albertel 12199: &delenv('cache.EXT.');
1.379 matthew 12200: }
12201:
12202: sub EXT_cache_status {
12203: my ($target_domain,$target_user) = @_;
1.383 albertel 12204: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 12205: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 12206: # We know already the user has no data
12207: return 1;
12208: } else {
12209: return 0;
12210: }
12211: }
12212:
12213: sub EXT_cache_set {
12214: my ($target_domain,$target_user) = @_;
1.383 albertel 12215: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 12216: #&appenv({$cachename => time});
1.379 matthew 12217: }
12218:
1.28 www 12219: # --------------------------------------------------------- Value of a Variable
1.58 www 12220: sub EXT {
1.715 albertel 12221:
1.1228 raeburn 12222: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68 www 12223: unless ($varname) { return ''; }
1.218 albertel 12224: #get real user name/domain, courseid and symb
12225: my $courseid;
1.359 albertel 12226: my $publicuser;
1.427 www 12227: if ($symbparm) {
12228: $symbparm=&get_symb_from_alias($symbparm);
12229: }
1.218 albertel 12230: if (!($uname && $udom)) {
1.790 albertel 12231: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 12232: if (!$symbparm) { $symbparm=$cursymb; }
12233: } else {
1.620 albertel 12234: $courseid=$env{'request.course.id'};
1.218 albertel 12235: }
1.48 www 12236: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
12237: my $rest;
1.320 albertel 12238: if (defined($therest[0])) {
1.48 www 12239: $rest=join('.',@therest);
12240: } else {
12241: $rest='';
12242: }
1.320 albertel 12243:
1.57 www 12244: my $qualifierrest=$qualifier;
12245: if ($rest) { $qualifierrest.='.'.$rest; }
12246: my $spacequalifierrest=$space;
12247: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 12248: if ($realm eq 'user') {
1.48 www 12249: # --------------------------------------------------------------- user.resource
12250: if ($space eq 'resource') {
1.651 albertel 12251: if ( (defined($Apache::lonhomework::parsing_a_problem)
12252: || defined($Apache::lonhomework::parsing_a_task))
12253: &&
1.744 albertel 12254: ($symbparm eq &symbread()) ) {
12255: # if we are in the middle of processing the resource the
12256: # get the value we are planning on committing
12257: if (defined($Apache::lonhomework::results{$qualifierrest})) {
12258: return $Apache::lonhomework::results{$qualifierrest};
12259: } else {
12260: return $Apache::lonhomework::history{$qualifierrest};
12261: }
1.335 albertel 12262: } else {
1.359 albertel 12263: my %restored;
1.620 albertel 12264: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 12265: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
12266: } else {
12267: %restored=&restore($symbparm,$courseid,$udom,$uname);
12268: }
1.335 albertel 12269: return $restored{$qualifierrest};
12270: }
1.48 www 12271: # ----------------------------------------------------------------- user.access
12272: } elsif ($space eq 'access') {
1.218 albertel 12273: # FIXME - not supporting calls for a specific user
1.48 www 12274: return &allowed($qualifier,$rest);
12275: # ------------------------------------------ user.preferences, user.environment
12276: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 12277: if (($uname eq $env{'user.name'}) &&
12278: ($udom eq $env{'user.domain'})) {
12279: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 12280: } else {
1.359 albertel 12281: my %returnhash;
12282: if (!$publicuser) {
12283: %returnhash=&userenvironment($udom,$uname,
12284: $qualifierrest);
12285: }
1.218 albertel 12286: return $returnhash{$qualifierrest};
12287: }
1.48 www 12288: # ----------------------------------------------------------------- user.course
12289: } elsif ($space eq 'course') {
1.218 albertel 12290: # FIXME - not supporting calls for a specific user
1.620 albertel 12291: return $env{join('.',('request.course',$qualifier))};
1.48 www 12292: # ------------------------------------------------------------------- user.role
12293: } elsif ($space eq 'role') {
1.218 albertel 12294: # FIXME - not supporting calls for a specific user
1.620 albertel 12295: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 12296: if ($qualifier eq 'value') {
12297: return $role;
12298: } elsif ($qualifier eq 'extent') {
12299: return $where;
12300: }
12301: # ----------------------------------------------------------------- user.domain
12302: } elsif ($space eq 'domain') {
1.218 albertel 12303: return $udom;
1.48 www 12304: # ------------------------------------------------------------------- user.name
12305: } elsif ($space eq 'name') {
1.218 albertel 12306: return $uname;
1.48 www 12307: # ---------------------------------------------------- Any other user namespace
1.29 www 12308: } else {
1.359 albertel 12309: my %reply;
12310: if (!$publicuser) {
12311: %reply=&get($space,[$qualifierrest],$udom,$uname);
12312: }
12313: return $reply{$qualifierrest};
1.48 www 12314: }
1.236 www 12315: } elsif ($realm eq 'query') {
12316: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 12317: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
12318: [$spacequalifierrest]);
1.620 albertel 12319: return $env{'form.'.$spacequalifierrest};
1.236 www 12320: } elsif ($realm eq 'request') {
1.48 www 12321: # ------------------------------------------------------------- request.browser
12322: if ($space eq 'browser') {
1.1145 bisitz 12323: return $env{'browser.'.$qualifier};
1.57 www 12324: # ------------------------------------------------------------ request.filename
12325: } else {
1.620 albertel 12326: return $env{'request.'.$spacequalifierrest};
1.29 www 12327: }
1.28 www 12328: } elsif ($realm eq 'course') {
1.48 www 12329: # ---------------------------------------------------------- course.description
1.620 albertel 12330: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 12331: } elsif ($realm eq 'resource') {
1.165 www 12332:
1.620 albertel 12333: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 12334: if (!$symbparm) { $symbparm=&symbread(); }
12335: }
1.693 albertel 12336:
1.1232 raeburn 12337: if ($qualifier eq '') {
12338: if ($space eq 'title') {
12339: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
12340: return &gettitle($symbparm);
12341: }
1.693 albertel 12342:
1.1232 raeburn 12343: if ($space eq 'map') {
12344: my ($map) = &decode_symb($symbparm);
12345: return &symbread($map);
12346: }
12347: if ($space eq 'maptitle') {
12348: my ($map) = &decode_symb($symbparm);
12349: return &gettitle($map);
12350: }
12351: if ($space eq 'filename') {
12352: if ($symbparm) {
12353: return &clutter((&decode_symb($symbparm))[2]);
12354: }
12355: return &hreflocation('',$env{'request.filename'});
1.905 albertel 12356: }
1.1232 raeburn 12357:
1.1233 raeburn 12358: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
12359: if ($space eq 'visibleparts') {
12360: my $navmap = Apache::lonnavmaps::navmap->new();
12361: my $item;
12362: if (ref($navmap)) {
12363: my $res = $navmap->getBySymb($symbparm);
12364: my $parts = $res->parts();
12365: if (ref($parts) eq 'ARRAY') {
12366: $item = join(',',@{$parts});
12367: }
12368: undef($navmap);
1.1232 raeburn 12369: }
1.1233 raeburn 12370: return $item;
1.1232 raeburn 12371: }
12372: }
12373: }
1.693 albertel 12374:
1.1301 raeburn 12375: my ($section, $group, @groups, @recurseup, $recursed);
12376: my ($courselevelm,$courseleveli,$courselevel,$mapp);
1.1228 raeburn 12377: if (($courseid eq '') && ($cid)) {
12378: $courseid = $cid;
12379: }
12380: if (($symbparm && $courseid) &&
12381: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 12382:
1.218 albertel 12383: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 12384:
1.60 www 12385: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 12386: my $symbp=$symbparm;
1.1301 raeburn 12387: $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 12388: my $symbparm=$symbp.'.'.$spacequalifierrest;
1.1301 raeburn 12389: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
1.218 albertel 12390: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.620 albertel 12391: if (($env{'user.name'} eq $uname) &&
12392: ($env{'user.domain'} eq $udom)) {
12393: $section=$env{'request.course.sec'};
1.733 raeburn 12394: @groups = split(/:/,$env{'request.course.groups'});
12395: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 12396: } else {
1.539 albertel 12397: if (! defined($usection)) {
1.551 albertel 12398: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 12399: } else {
12400: $section = $usection;
12401: }
1.733 raeburn 12402: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 12403: }
12404:
12405: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
12406: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
1.1301 raeburn 12407: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
1.218 albertel 12408: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
12409:
1.593 albertel 12410: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 12411: my $courselevelr=$courseid.'.'.$symbparm;
1.1301 raeburn 12412: $courseleveli=$courseid.'.'.$recurseparm;
1.593 albertel 12413: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 12414:
1.60 www 12415: # ----------------------------------------------------------- first, check user
1.624 albertel 12416:
1.1301 raeburn 12417: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
12418: \@recurseup,$courseid,'.',$spacequalifierrest,
1.927 albertel 12419: ([$courselevelr,'resource'],
12420: [$courselevelm,'map' ],
1.1301 raeburn 12421: [$courseleveli,'map' ],
1.927 albertel 12422: [$courselevel, 'course' ]));
1.931 albertel 12423: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 12424:
1.594 albertel 12425: # ------------------------------------------------ second, check some of course
1.684 raeburn 12426: my $coursereply;
1.691 raeburn 12427: if (@groups > 0) {
12428: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
1.1301 raeburn 12429: $recurseparm,$mapparm,$spacequalifierrest,
12430: $mapp,\$recursed,\@recurseup);
12431: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 12432: }
1.96 www 12433:
1.684 raeburn 12434: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 12435: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 12436: 'course',$mapp,\$recursed,\@recurseup,
12437: $courseid,'.['.$section.'].',$spacequalifierrest,
1.927 albertel 12438: ([$seclevelr, 'resource'],
12439: [$seclevelm, 'map' ],
1.1301 raeburn 12440: [$secleveli, 'map' ],
1.927 albertel 12441: [$seclevel, 'course' ],
12442: [$courselevelr,'resource']));
12443: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 12444:
1.60 www 12445: # ------------------------------------------------------ third, check map parms
1.218 albertel 12446: my %parmhash=();
12447: my $thisparm='';
12448: if (tie(%parmhash,'GDBM_File',
1.620 albertel 12449: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 12450: &GDBM_READER(),0640)) {
1.218 albertel 12451: $thisparm=$parmhash{$symbparm};
12452: untie(%parmhash);
12453: }
1.927 albertel 12454: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 12455: }
1.594 albertel 12456: # ------------------------------------------ fourth, look in resource metadata
1.1301 raeburn 12457:
12458: my $what = $spacequalifierrest;
12459: $what=~s/\./\_/;
1.282 albertel 12460: my $filename;
12461: if (!$symbparm) { $symbparm=&symbread(); }
12462: if ($symbparm) {
1.409 www 12463: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 12464: } else {
1.620 albertel 12465: $filename=$env{'request.filename'};
1.282 albertel 12466: }
1.1362 raeburn 12467: my $toolsymb;
12468: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
12469: $toolsymb = $symbparm;
12470: }
12471: my $metadata=&metadata($filename,$what,$toolsymb);
1.927 albertel 12472: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.1362 raeburn 12473: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
1.927 albertel 12474: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 12475:
1.1301 raeburn 12476: # ----------------------------------------------- fifth, look in rest of course
1.593 albertel 12477: if ($symbparm && defined($courseid) &&
1.620 albertel 12478: $courseid eq $env{'request.course.id'}) {
1.624 albertel 12479: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
12480: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 12481: 'course',$mapp,\$recursed,\@recurseup,
12482: $courseid,'.',$spacequalifierrest,
1.927 albertel 12483: ([$courselevelm,'map' ],
1.1301 raeburn 12484: [$courseleveli,'map' ],
1.927 albertel 12485: [$courselevel, 'course']));
12486: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 12487: }
1.145 www 12488: # ------------------------------------------------------------------ Cascade up
1.218 albertel 12489: unless ($space eq '0') {
1.336 albertel 12490: my @parts=split(/_/,$space);
12491: my $id=pop(@parts);
12492: my $part=join('_',@parts);
12493: if ($part eq '') { $part='0'; }
1.927 albertel 12494: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 12495: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 12496: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 12497: }
1.395 albertel 12498: if ($recurse) { return undef; }
1.1362 raeburn 12499: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
1.927 albertel 12500: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 12501: # ---------------------------------------------------- Any other user namespace
12502: } elsif ($realm eq 'environment') {
12503: # ----------------------------------------------------------------- environment
1.620 albertel 12504: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
12505: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 12506: } else {
1.770 albertel 12507: if ($uname eq 'anonymous' && $udom eq '') {
12508: return '';
12509: }
1.219 albertel 12510: my %returnhash=&userenvironment($udom,$uname,
12511: $spacequalifierrest);
12512: return $returnhash{$spacequalifierrest};
12513: }
1.28 www 12514: } elsif ($realm eq 'system') {
1.48 www 12515: # ----------------------------------------------------------------- system.time
12516: if ($space eq 'time') {
12517: return time;
12518: }
1.696 albertel 12519: } elsif ($realm eq 'server') {
12520: # ----------------------------------------------------------------- system.time
12521: if ($space eq 'name') {
12522: return $ENV{'SERVER_NAME'};
12523: }
1.1415 raeburn 12524: } elsif ($realm eq 'client') {
12525: if ($space eq 'remote_addr') {
1.1441 raeburn 12526: return &get_requestor_ip();
1.1415 raeburn 12527: }
1.28 www 12528: }
1.48 www 12529: return '';
1.61 www 12530: }
12531:
1.927 albertel 12532: sub get_reply {
12533: my ($reply_value) = @_;
1.940 raeburn 12534: if (ref($reply_value) eq 'ARRAY') {
12535: if (wantarray) {
12536: return @$reply_value;
12537: }
12538: return $reply_value->[0];
12539: } else {
12540: return $reply_value;
1.927 albertel 12541: }
12542: }
12543:
1.691 raeburn 12544: sub check_group_parms {
1.1301 raeburn 12545: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
12546: $recursed,$recurseupref) = @_;
12547: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
12548: [$what,'course']);
12549: my $coursereply;
1.691 raeburn 12550: foreach my $group (@{$groups}) {
1.1301 raeburn 12551: my @groupitems = ();
1.691 raeburn 12552: foreach my $level (@levels) {
1.927 albertel 12553: my $item = $courseid.'.['.$group.'].'.$level->[0];
12554: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 12555: }
1.1301 raeburn 12556: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
12557: $env{'course.'.$courseid.'.domain'},
12558: 'course',$mapp,$recursed,$recurseupref,
12559: $courseid,'.['.$group.'].',$what,
12560: @groupitems);
12561: last if (defined($coursereply));
1.691 raeburn 12562: }
12563: return $coursereply;
12564: }
12565:
1.1301 raeburn 12566: sub get_map_hierarchy {
1.1302 raeburn 12567: my ($mapname,$courseid) = @_;
12568: my @recurseup = ();
1.1301 raeburn 12569: if ($mapname) {
1.1302 raeburn 12570: if (($cachedmapkey eq $courseid) &&
12571: (abs($cachedmaptime-time)<5)) {
12572: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
12573: return @{$cachedmaps{$mapname}};
12574: }
12575: }
1.1301 raeburn 12576: my $navmap = Apache::lonnavmaps::navmap->new();
12577: if (ref($navmap)) {
12578: @recurseup = $navmap->recurseup_maps($mapname);
12579: undef($navmap);
1.1302 raeburn 12580: $cachedmaps{$mapname} = \@recurseup;
12581: $cachedmaptime=time;
12582: $cachedmapkey=$courseid;
1.1301 raeburn 12583: }
12584: }
12585: return @recurseup;
12586: }
12587:
1.1302 raeburn 12588: }
12589:
1.691 raeburn 12590: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 12591: my ($courseid,@groups) = @_;
12592: @groups = sort(@groups);
1.691 raeburn 12593: return @groups;
12594: }
12595:
1.395 albertel 12596: sub packages_tab_default {
1.1362 raeburn 12597: my ($uri,$varname,$toolsymb)=@_;
1.395 albertel 12598: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 12599:
12600: my (@extension,@specifics,$do_default);
1.1362 raeburn 12601: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
1.395 albertel 12602: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 12603: if ($pack_type eq 'default') {
12604: $do_default=1;
12605: } elsif ($pack_type eq 'extension') {
12606: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 12607: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 12608: # only look at packages defaults for packages that this id is
1.738 albertel 12609: push(@specifics,[$package,$pack_type,$pack_part]);
12610: }
12611: }
12612: # first look for a package that matches the requested part id
12613: foreach my $package (@specifics) {
12614: my (undef,$pack_type,$pack_part)=@{$package};
12615: next if ($pack_part ne $part);
12616: if (defined($packagetab{"$pack_type&$name&default"})) {
12617: return $packagetab{"$pack_type&$name&default"};
12618: }
12619: }
12620: # look for any possible matching non extension_ package
12621: foreach my $package (@specifics) {
12622: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 12623: if (defined($packagetab{"$pack_type&$name&default"})) {
12624: return $packagetab{"$pack_type&$name&default"};
12625: }
1.585 albertel 12626: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 12627: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
12628: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 12629: }
12630: }
1.738 albertel 12631: # look for any posible extension_ match
12632: foreach my $package (@extension) {
12633: my ($package,$pack_type)=@{$package};
12634: if (defined($packagetab{"$pack_type&$name&default"})) {
12635: return $packagetab{"$pack_type&$name&default"};
12636: }
12637: if (defined($packagetab{$package."&$name&default"})) {
12638: return $packagetab{$package."&$name&default"};
12639: }
12640: }
12641: # look for a global default setting
12642: if ($do_default && defined($packagetab{"default&$name&default"})) {
12643: return $packagetab{"default&$name&default"};
12644: }
1.395 albertel 12645: return undef;
12646: }
12647:
1.334 albertel 12648: sub add_prefix_and_part {
12649: my ($prefix,$part)=@_;
12650: my $keyroot;
12651: if (defined($prefix) && $prefix !~ /^__/) {
12652: # prefix that has a part already
12653: $keyroot=$prefix;
12654: } elsif (defined($prefix)) {
12655: # prefix that is missing a part
12656: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
12657: } else {
12658: # no prefix at all
12659: if (defined($part)) { $keyroot='_'.$part; }
12660: }
12661: return $keyroot;
12662: }
12663:
1.71 www 12664: # ---------------------------------------------------------------- Get metadata
12665:
1.599 albertel 12666: my %metaentry;
1.1070 www 12667: my %importedpartids;
1.1369 raeburn 12668: my %importedrespids;
1.71 www 12669: sub metadata {
1.1362 raeburn 12670: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
1.71 www 12671: $uri=&declutter($uri);
1.288 albertel 12672: # if it is a non metadata possible uri return quickly
1.529 albertel 12673: if (($uri eq '') ||
12674: (($uri =~ m|^/*adm/|) &&
1.1343 raeburn 12675: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
1.1108 raeburn 12676: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 12677: return undef;
12678: }
1.1261 raeburn 12679: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 12680: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 12681: return undef;
1.288 albertel 12682: }
1.73 www 12683: my $filename=$uri;
12684: $uri=~s/\.meta$//;
1.172 www 12685: #
12686: # Is the metadata already cached?
1.177 www 12687: # Look at timestamp of caching
1.172 www 12688: # Everything is cached by the main uri, libraries are never directly cached
12689: #
1.428 albertel 12690: if (!defined($liburi)) {
1.599 albertel 12691: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 12692: if (defined($cached)) { return $result->{':'.$what}; }
12693: }
1.1362 raeburn 12694:
12695: #
12696: # If the uri is for an external tool the file from
12697: # which metadata should be retrieved depends on whether
12698: # the tool had been configured to be gradable (set in the Course
12699: # Editor or Resource Editor).
12700: #
12701: # If a valid symb has been included as the third arg in the call
12702: # to &metadata() that can be used to retrieve the value of
12703: # parameter_0_gradable set for the resource, and included in the
12704: # uploaded map containing the tool. The value is retrieved via
12705: # &EXT(), if a valid symb is available. Otherwise the value of
12706: # gradable in the exttool_$marker.db file for the tool instance
1.1364 raeburn 12707: # is retrieved via &get().
12708: #
12709: # When lonuserstate::traceroute() calls lonnet::EXT() for
12710: # hiddenresource and encrypturl (during course initialization)
12711: # the map-level parameter for resource.0.gradable included in the
12712: # uploaded map containing the tool will not yet have been stored
12713: # in the user_course_parms.db file for the user's session, so in
12714: # this case fall back to retrieving gradable status from the
12715: # exttool_$marker.db file.
1.1362 raeburn 12716: #
12717: # In order to avoid an infinite loop, &metadata() will return
12718: # before a call to &EXT(), if the uri is for an external tool
12719: # and the $what for which metadata is being requested is
12720: # parameter_0_gradable or 0_gradable.
12721: #
12722:
12723: if ($uri =~ /ext\.tool$/) {
12724: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
12725: return;
12726: } else {
12727: my ($checked,$use_passback);
12728: if ($toolsymb ne '') {
12729: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
1.1364 raeburn 12730: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
1.1362 raeburn 12731: $checked = 1;
12732: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
12733: $use_passback = 1;
12734: }
12735: }
12736: }
12737: unless ($checked) {
12738: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
12739: $marker=~s/\D//g;
1.1363 raeburn 12740: if ($marker) {
1.1362 raeburn 12741: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
12742: $use_passback = $toolsettings{'gradable'};
12743: }
12744: }
12745: if ($use_passback) {
12746: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
12747: } else {
12748: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
12749: }
12750: }
12751: }
12752:
1.428 albertel 12753: {
1.1069 www 12754: # Imported parts would go here
1.1369 raeburn 12755: my @origfiletagids=();
1.1069 www 12756: my $importedparts=0;
1.1369 raeburn 12757:
12758: # Imported responseids would go here
12759: my $importedresponses=0;
1.172 www 12760: #
12761: # Is this a recursive call for a library?
12762: #
1.599 albertel 12763: # if (! exists($metacache{$uri})) {
12764: # $metacache{$uri}={};
12765: # }
1.924 albertel 12766: my $cachetime = 60*60;
1.171 www 12767: if ($liburi) {
12768: $liburi=&declutter($liburi);
12769: $filename=$liburi;
1.401 bowersj2 12770: } else {
1.599 albertel 12771: &devalidate_cache_new('meta',$uri);
12772: undef(%metaentry);
1.401 bowersj2 12773: }
1.140 www 12774: my %metathesekeys=();
1.73 www 12775: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 12776: my $metastring;
1.1140 www 12777: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 12778: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 12779: $metastring =
1.929 albertel 12780: &Apache::lonnet::ssi_body($which,
1.924 albertel 12781: ('grade_target' => 'meta'));
12782: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 12783: } elsif (($uri !~ m -^(editupload)/-) &&
12784: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 12785: my $file=&filelocation('',&clutter($filename));
1.599 albertel 12786: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 12787: $metastring=&getfile($file);
1.489 albertel 12788: }
1.208 albertel 12789: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 12790: my $token;
1.140 www 12791: undef %metathesekeys;
1.71 www 12792: while ($token=$parser->get_token) {
1.339 albertel 12793: if ($token->[0] eq 'S') {
12794: if (defined($token->[2]->{'package'})) {
1.172 www 12795: #
12796: # This is a package - get package info
12797: #
1.339 albertel 12798: my $package=$token->[2]->{'package'};
12799: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
12800: if (defined($token->[2]->{'id'})) {
12801: $keyroot.='_'.$token->[2]->{'id'};
12802: }
1.599 albertel 12803: if ($metaentry{':packages'}) {
12804: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 12805: } else {
1.599 albertel 12806: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 12807: }
1.736 albertel 12808: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 12809: my $part=$keyroot;
12810: $part=~s/^\_//;
1.736 albertel 12811: if ($pack_entry=~/^\Q$package\E\&/ ||
12812: $pack_entry=~/^\Q$package\E_0\&/) {
12813: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 12814: # ignore package.tab specified default values
12815: # here &package_tab_default() will fetch those
12816: if ($subp eq 'default') { next; }
1.736 albertel 12817: my $value=$packagetab{$pack_entry};
1.432 albertel 12818: my $unikey;
12819: if ($pack =~ /_0$/) {
12820: $unikey='parameter_0_'.$name;
12821: $part=0;
12822: } else {
12823: $unikey='parameter'.$keyroot.'_'.$name;
12824: }
1.339 albertel 12825: if ($subp eq 'display') {
12826: $value.=' [Part: '.$part.']';
12827: }
1.599 albertel 12828: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 12829: $metathesekeys{$unikey}=1;
1.599 albertel 12830: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
12831: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 12832: }
1.599 albertel 12833: if (defined($metaentry{':'.$unikey.'.default'})) {
12834: $metaentry{':'.$unikey}=
12835: $metaentry{':'.$unikey.'.default'};
1.356 albertel 12836: }
1.339 albertel 12837: }
12838: }
12839: } else {
1.172 www 12840: #
12841: # This is not a package - some other kind of start tag
1.339 albertel 12842: #
12843: my $entry=$token->[1];
1.1068 www 12844: my $unikey='';
1.175 www 12845:
1.339 albertel 12846: if ($entry eq 'import') {
1.175 www 12847: #
12848: # Importing a library here
1.339 albertel 12849: #
1.1067 www 12850: my $location=$parser->get_text('/import');
12851: my $dir=$filename;
12852: $dir=~s|[^/]*$||;
12853: $location=&filelocation($dir,$location);
1.1369 raeburn 12854:
12855: my $importid=$token->[2]->{'id'};
1.1068 www 12856: my $importmode=$token->[2]->{'importmode'};
1.1369 raeburn 12857: #
12858: # Check metadata for imported file to
12859: # see if it contained response items
12860: #
1.1372 raeburn 12861: my ($origfile,@libfilekeys);
1.1370 raeburn 12862: my %currmetaentry = %metaentry;
1.1372 raeburn 12863: @libfilekeys = split(/,/,&metadata($location,'keys',undef,undef,undef,
12864: $depthcount+1));
12865: if (grep(/^responseorder$/,@libfilekeys)) {
12866: my $libresponseorder = &metadata($location,'responseorder',undef,undef,
12867: undef,$depthcount+1);
12868: if ($libresponseorder ne '') {
12869: if ($#origfiletagids<0) {
12870: undef(%importedrespids);
12871: undef(%importedpartids);
12872: }
1.1373 raeburn 12873: my @respids = split(/\s*,\s*/,$libresponseorder);
12874: if (@respids) {
12875: $importedrespids{$importid} = join(',',map { $importid.'_'.$_ } @respids);
12876: }
12877: if ($importedrespids{$importid} ne '') {
1.1372 raeburn 12878: $importedresponses = 1;
1.1369 raeburn 12879: # We need to get the original file and the imported file to get the response order correct
12880: # Load and inspect original file
1.1372 raeburn 12881: if ($#origfiletagids<0) {
12882: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
12883: $origfile=&getfile($origfilelocation);
12884: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12885: }
1.1369 raeburn 12886: }
12887: }
12888: }
1.1370 raeburn 12889: # Do not overwrite contents of %metaentry hash for resource itself with
12890: # hash populated for imported library file
12891: %metaentry = %currmetaentry;
12892: undef(%currmetaentry);
1.1374 raeburn 12893: if ($importmode eq 'part') {
1.1068 www 12894: # Import as part(s)
1.1069 www 12895: $importedparts=1;
12896: # We need to get the original file and the imported file to get the part order correct
12897: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
1.1369 raeburn 12898: # Load and inspect original file if we didn't do that already
12899: if ($#origfiletagids<0) {
12900: undef(%importedrespids);
12901: undef(%importedpartids);
12902: if ($origfile eq '') {
12903: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
12904: $origfile=&getfile($origfilelocation);
12905: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12906: }
1.1070 www 12907: }
1.1372 raeburn 12908: my @impfilepartids;
12909: # If <partorder> tag is included in metadata for the imported file
12910: # get the parts in the imported file from that.
12911: if (grep(/^partorder$/,@libfilekeys)) {
12912: %currmetaentry = %metaentry;
12913: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
12914: $depthcount+1);
12915: %metaentry = %currmetaentry;
12916: undef(%currmetaentry);
12917: if ($libpartorder ne '') {
12918: @impfilepartids=split(/\s*,\s*/,$libpartorder);
12919: }
12920: } else {
12921: # If no <partorder> tag available, load and inspect imported file
12922: my $impfile=&getfile($location);
12923: @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12924: }
1.1069 www 12925: if ($#impfilepartids>=0) {
12926: # This problem had parts
1.1070 www 12927: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 12928: } else {
12929: # Importing by turning a single problem into a problem part
12930: # It gets the import-tags ID as part-ID
12931: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 12932: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 12933: }
1.1068 www 12934: } else {
1.1374 raeburn 12935: # Import as problem or as normal import
12936: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
12937: unless ($importmode eq 'problem') {
1.1068 www 12938: # Normal import
1.1374 raeburn 12939: if (defined($token->[2]->{'id'})) {
12940: $unikey.='_'.$token->[2]->{'id'};
12941: }
12942: }
12943: # Check metadata for imported file to
12944: # see if it contained parts
12945: if (grep(/^partorder$/,@libfilekeys)) {
12946: %currmetaentry = %metaentry;
12947: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
12948: $depthcount+1);
12949: %metaentry = %currmetaentry;
12950: undef(%currmetaentry);
12951: if ($libpartorder ne '') {
12952: $importedparts = 1;
12953: $importedpartids{$token->[2]->{'id'}}=$libpartorder;
12954: }
12955: }
1.1067 www 12956: }
1.339 albertel 12957: if ($depthcount<20) {
1.736 albertel 12958: my $metadata =
1.1362 raeburn 12959: &metadata($uri,'keys',$toolsymb,$location,$unikey,
1.736 albertel 12960: $depthcount+1);
12961: foreach my $meta (split(',',$metadata)) {
12962: $metaentry{':'.$meta}=$metaentry{':'.$meta};
12963: $metathesekeys{$meta}=1;
1.339 albertel 12964: }
1.1068 www 12965: }
1.1067 www 12966: } else {
12967: #
12968: # Not importing, some other kind of non-package, non-library start tag
12969: #
12970: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
12971: if (defined($token->[2]->{'id'})) {
12972: $unikey.='_'.$token->[2]->{'id'};
12973: }
1.339 albertel 12974: if (defined($token->[2]->{'name'})) {
12975: $unikey.='_'.$token->[2]->{'name'};
12976: }
12977: $metathesekeys{$unikey}=1;
1.736 albertel 12978: foreach my $param (@{$token->[3]}) {
12979: $metaentry{':'.$unikey.'.'.$param} =
12980: $token->[2]->{$param};
1.339 albertel 12981: }
12982: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 12983: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 12984: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
12985: # only ws inside the tag, and not in default, so use default
12986: # as value
1.599 albertel 12987: $metaentry{':'.$unikey}=$default;
1.908 albertel 12988: } elsif ( $internaltext =~ /\S/ ) {
12989: # something interesting inside the tag
12990: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 12991: } else {
1.908 albertel 12992: # no interesting values, don't set a default
1.339 albertel 12993: }
1.172 www 12994: # end of not-a-package not-a-library import
1.339 albertel 12995: }
1.172 www 12996: # end of not-a-package start tag
1.339 albertel 12997: }
1.172 www 12998: # the next is the end of "start tag"
1.339 albertel 12999: }
13000: }
1.483 albertel 13001: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 13002: $extension = lc($extension);
13003: if ($extension eq 'htm') { $extension='html'; }
13004:
1.737 albertel 13005: foreach my $key (keys(%packagetab)) {
1.483 albertel 13006: #no specific packages #how's our extension
13007: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 13008: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 13009: \%metathesekeys);
13010: }
1.883 albertel 13011:
13012: if (!exists($metaentry{':packages'})
13013: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 13014: foreach my $key (keys(%packagetab)) {
1.483 albertel 13015: #no specific packages well let's get default then
13016: if ($key!~/^default&/) { next; }
1.488 albertel 13017: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 13018: \%metathesekeys);
13019: }
13020: }
1.338 www 13021: # are there custom rights to evaluate
1.599 albertel 13022: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 13023:
1.338 www 13024: #
13025: # Importing a rights file here
1.339 albertel 13026: #
13027: unless ($depthcount) {
1.599 albertel 13028: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 13029: my $dir=$filename;
13030: $dir=~s|[^/]*$||;
13031: $location=&filelocation($dir,$location);
1.736 albertel 13032: my $rights_metadata =
1.1362 raeburn 13033: &metadata($uri,'keys',$toolsymb,$location,'_rights',
1.736 albertel 13034: $depthcount+1);
13035: foreach my $rights (split(',',$rights_metadata)) {
13036: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
13037: $metathesekeys{$rights}=1;
1.339 albertel 13038: }
13039: }
13040: }
1.737 albertel 13041: # uniqifiy package listing
13042: my %seen;
13043: my @uniq_packages =
13044: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
13045: $metaentry{':packages'} = join(',',@uniq_packages);
13046:
1.1369 raeburn 13047: if (($importedresponses) || ($importedparts)) {
13048: if ($importedparts) {
1.1070 www 13049: # We had imported parts and need to rebuild partorder
1.1369 raeburn 13050: $metaentry{':partorder'}='';
13051: $metathesekeys{'partorder'}=1;
13052: }
13053: if ($importedresponses) {
13054: # We had imported responses and need to rebuil responseorder
13055: $metaentry{':responseorder'}='';
13056: $metathesekeys{'responseorder'}=1;
13057: }
13058: for (my $index=0;$index<$#origfiletagids;$index+=2) {
13059: my $origid = $origfiletagids[$index+1];
13060: if ($origfiletagids[$index] eq 'part') {
13061: # Original part, part of the problem
13062: if ($importedparts) {
13063: $metaentry{':partorder'}.=','.$origid;
13064: }
13065: } elsif ($origfiletagids[$index] eq 'import') {
13066: if ($importedparts) {
13067: # We have imported parts at this position
1.1373 raeburn 13068: if ($importedpartids{$origid} ne '') {
13069: $metaentry{':partorder'}.=','.$importedpartids{$origid};
13070: }
1.1369 raeburn 13071: }
13072: if ($importedresponses) {
13073: # We have imported responses at this position
1.1373 raeburn 13074: if ($importedrespids{$origid} ne '') {
13075: $metaentry{':responseorder'}.=','.$importedrespids{$origid};
1.1369 raeburn 13076: }
13077: }
13078: } else {
13079: # Original response item, part of the problem
13080: if ($importedresponses) {
13081: $metaentry{':responseorder'}.=','.$origid;
13082: }
13083: }
13084: }
13085: if ($importedparts) {
13086: $metaentry{':partorder'}=~s/^\,//;
13087: }
13088: if ($importedresponses) {
13089: $metaentry{':responseorder'}=~s/^\,//;
13090: }
1.1070 www 13091: }
1.737 albertel 13092: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 13093: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274 raeburn 13094: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.1371 raeburn 13095: unless ($liburi) {
13096: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
13097: }
1.177 www 13098: # this is the end of "was not already recently cached
1.71 www 13099: }
1.599 albertel 13100: return $metaentry{':'.$what};
1.261 albertel 13101: }
13102:
1.488 albertel 13103: sub metadata_create_package_def {
1.483 albertel 13104: my ($uri,$key,$package,$metathesekeys)=@_;
13105: my ($pack,$name,$subp)=split(/\&/,$key);
13106: if ($subp eq 'default') { next; }
13107:
1.599 albertel 13108: if (defined($metaentry{':packages'})) {
13109: $metaentry{':packages'}.=','.$package;
1.483 albertel 13110: } else {
1.599 albertel 13111: $metaentry{':packages'}=$package;
1.483 albertel 13112: }
13113: my $value=$packagetab{$key};
13114: my $unikey;
13115: $unikey='parameter_0_'.$name;
1.599 albertel 13116: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 13117: $$metathesekeys{$unikey}=1;
1.599 albertel 13118: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
13119: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 13120: }
1.599 albertel 13121: if (defined($metaentry{':'.$unikey.'.default'})) {
13122: $metaentry{':'.$unikey}=
13123: $metaentry{':'.$unikey.'.default'};
1.483 albertel 13124: }
13125: }
13126:
1.261 albertel 13127: sub metadata_generate_part0 {
13128: my ($metadata,$metacache,$uri) = @_;
13129: my %allnames;
1.737 albertel 13130: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 13131: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 13132: my $part=$$metacache{':'.$metakey.'.part'};
13133: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 13134: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 13135: $allnames{$name}=$part;
13136: }
13137: }
13138: }
13139: foreach my $name (keys(%allnames)) {
13140: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 13141: my $key=":parameter_0_$name";
1.261 albertel 13142: $$metacache{"$key.part"}='0';
13143: $$metacache{"$key.name"}=$name;
1.428 albertel 13144: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 13145: $allnames{$name}.'_'.$name.
13146: '.type'};
1.428 albertel 13147: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 13148: '.display'};
1.644 www 13149: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 13150: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 13151: $$metacache{"$key.display"}=$olddis;
13152: }
1.71 www 13153: }
13154:
1.764 albertel 13155: # ------------------------------------------------------ Devalidate title cache
13156:
13157: sub devalidate_title_cache {
13158: my ($url)=@_;
13159: if (!$env{'request.course.id'}) { return; }
13160: my $symb=&symbread($url);
13161: if (!$symb) { return; }
13162: my $key=$env{'request.course.id'}."\0".$symb;
13163: &devalidate_cache_new('title',$key);
13164: }
13165:
1.1014 droeschl 13166: # ------------------------------------------------- Get the title of a course
13167:
13168: sub current_course_title {
13169: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
13170: }
1.301 www 13171: # ------------------------------------------------- Get the title of a resource
13172:
13173: sub gettitle {
13174: my $urlsymb=shift;
13175: my $symb=&symbread($urlsymb);
1.534 albertel 13176: if ($symb) {
1.620 albertel 13177: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 13178: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 13179: if (defined($cached)) {
13180: return $result;
13181: }
1.534 albertel 13182: my ($map,$resid,$url)=&decode_symb($symb);
13183: my $title='';
1.907 albertel 13184: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
13185: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
13186: } else {
13187: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
13188: &GDBM_READER(),0640)) {
13189: my $mapid=$bighash{'map_pc_'.&clutter($map)};
13190: $title=$bighash{'title_'.$mapid.'.'.$resid};
13191: untie(%bighash);
13192: }
1.534 albertel 13193: }
13194: $title=~s/\&colon\;/\:/gs;
13195: if ($title) {
1.1159 www 13196: # Remember both $symb and $title for dynamic metadata
13197: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 13198: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 13199: # Cache this title and then return it
1.599 albertel 13200: return &do_cache_new('title',$key,$title,600);
1.534 albertel 13201: }
13202: $urlsymb=$url;
13203: }
13204: my $title=&metadata($urlsymb,'title');
13205: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
13206: return $title;
1.301 www 13207: }
1.613 albertel 13208:
1.614 albertel 13209: sub get_slot {
13210: my ($which,$cnum,$cdom)=@_;
13211: if (!$cnum || !$cdom) {
1.790 albertel 13212: (undef,my $courseid)=&whichuser();
1.620 albertel 13213: $cdom=$env{'course.'.$courseid.'.domain'};
13214: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 13215: }
1.703 albertel 13216: my $key=join("\0",'slots',$cdom,$cnum,$which);
13217: my %slotinfo;
13218: if (exists($remembered{$key})) {
13219: $slotinfo{$which} = $remembered{$key};
13220: } else {
13221: %slotinfo=&get('slots',[$which],$cdom,$cnum);
13222: &Apache::lonhomework::showhash(%slotinfo);
13223: my ($tmp)=keys(%slotinfo);
13224: if ($tmp=~/^error:/) { return (); }
13225: $remembered{$key} = $slotinfo{$which};
13226: }
1.616 albertel 13227: if (ref($slotinfo{$which}) eq 'HASH') {
13228: return %{$slotinfo{$which}};
13229: }
13230: return $slotinfo{$which};
1.614 albertel 13231: }
1.1150 raeburn 13232:
13233: sub get_reservable_slots {
13234: my ($cnum,$cdom,$uname,$udom) = @_;
13235: my $now = time;
13236: my $reservable_info;
13237: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
13238: if (exists($remembered{$key})) {
13239: $reservable_info = $remembered{$key};
13240: } else {
13241: my %resv;
13242: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
13243: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
13244: $reservable_info = \%resv;
13245: $remembered{$key} = $reservable_info;
13246: }
13247: return $reservable_info;
13248: }
13249:
13250: sub get_course_slots {
13251: my ($cnum,$cdom) = @_;
13252: my $hashid=$cnum.':'.$cdom;
13253: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
13254: if (defined($cached)) {
13255: if (ref($result) eq 'HASH') {
13256: return %{$result};
13257: }
13258: } else {
13259: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
13260: my ($tmp) = keys(%slots);
13261: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 13262: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 13263: return %slots;
13264: }
13265: }
13266: return;
13267: }
13268:
13269: sub devalidate_slots_cache {
13270: my ($cnum,$cdom)=@_;
13271: my $hashid=$cnum.':'.$cdom;
13272: &devalidate_cache_new('allslots',$hashid);
13273: }
13274:
1.1181 raeburn 13275: sub get_coursechange {
13276: my ($cdom,$cnum) = @_;
13277: if ($cdom eq '' || $cnum eq '') {
13278: return unless ($env{'request.course.id'});
13279: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
13280: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
13281: }
13282: my $hashid=$cdom.'_'.$cnum;
13283: my ($change,$cached)=&is_cached_new('crschange',$hashid);
13284: if ((defined($cached)) && ($change ne '')) {
13285: return $change;
13286: } else {
13287: my %crshash;
13288: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
13289: if ($crshash{'internal.contentchange'} eq '') {
13290: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
13291: if ($change eq '') {
13292: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
13293: $change = $crshash{'internal.created'};
13294: }
13295: } else {
13296: $change = $crshash{'internal.contentchange'};
13297: }
13298: my $cachetime = 600;
13299: &do_cache_new('crschange',$hashid,$change,$cachetime);
13300: }
13301: return $change;
13302: }
13303:
13304: sub devalidate_coursechange_cache {
13305: my ($cnum,$cdom)=@_;
13306: my $hashid=$cnum.':'.$cdom;
13307: &devalidate_cache_new('crschange',$hashid);
13308: }
13309:
1.31 www 13310: # ------------------------------------------------- Update symbolic store links
13311:
13312: sub symblist {
13313: my ($mapname,%newhash)=@_;
1.438 www 13314: $mapname=&deversion(&declutter($mapname));
1.31 www 13315: my %hash;
1.620 albertel 13316: if (($env{'request.course.fn'}) && (%newhash)) {
13317: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 13318: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 13319: foreach my $url (keys(%newhash)) {
1.711 albertel 13320: next if ($url eq 'last_known'
13321: && $env{'form.no_update_last_known'});
13322: $hash{declutter($url)}=&encode_symb($mapname,
13323: $newhash{$url}->[1],
13324: $newhash{$url}->[0]);
1.191 harris41 13325: }
1.31 www 13326: if (untie(%hash)) {
13327: return 'ok';
13328: }
13329: }
13330: }
13331: return 'error';
1.212 www 13332: }
13333:
13334: # --------------------------------------------------------------- Verify a symb
13335:
13336: sub symbverify {
1.1190 raeburn 13337: my ($symb,$thisurl,$encstate)=@_;
1.510 www 13338: my $thisfn=$thisurl;
1.439 www 13339: $thisfn=&declutter($thisfn);
1.215 www 13340: # direct jump to resource in page or to a sequence - will construct own symbs
13341: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
13342: # check URL part
1.409 www 13343: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 13344:
1.431 www 13345: unless ($url eq $thisfn) { return 0; }
1.213 www 13346:
1.216 www 13347: $symb=&symbclean($symb);
1.510 www 13348: $thisurl=&deversion($thisurl);
1.439 www 13349: $thisfn=&deversion($thisfn);
1.213 www 13350:
13351: my %bighash;
13352: my $okay=0;
1.431 www 13353:
1.620 albertel 13354: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 13355: &GDBM_READER(),0640)) {
1.1032 raeburn 13356: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
13357: $thisurl =~ s/\?.+$//;
1.1204 raeburn 13358: if ($map =~ m{^uploaded/.+\.page$}) {
13359: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
13360: $thisurl =~ s{^\Qhttp://https://\E}{https://};
13361: }
13362: }
13363: my $ids;
1.1419 raeburn 13364: if ($map =~ m{^uploaded/.+\.page$}) {
13365: $ids=$bighash{'ids_'.&clutter_with_no_wrapper($thisurl)};
1.1204 raeburn 13366: } else {
13367: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 13368: }
1.1102 raeburn 13369: unless ($ids) {
13370: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
13371: $ids=$bighash{$idkey};
1.216 www 13372: }
13373: if ($ids) {
13374: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 13375: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 13376: $symb =~ s/\?.+$//;
1.1202 raeburn 13377: }
1.800 albertel 13378: foreach my $id (split(/\,/,$ids)) {
13379: my ($mapid,$resid)=split(/\./,$id);
1.216 www 13380: if (
13381: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 13382: eq $symb) {
13383: if (ref($encstate)) {
13384: $$encstate = $bighash{'encrypted_'.$id};
13385: }
1.620 albertel 13386: if (($env{'request.role.adv'}) ||
1.1101 raeburn 13387: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
13388: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 13389: $okay=1;
1.1202 raeburn 13390: last;
1.582 albertel 13391: }
13392: }
1.216 www 13393: }
13394: }
1.213 www 13395: untie(%bighash);
13396: }
13397: return $okay;
1.31 www 13398: }
13399:
1.210 www 13400: # --------------------------------------------------------------- Clean-up symb
13401:
13402: sub symbclean {
13403: my $symb=shift;
1.568 albertel 13404: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 13405: # remove version from map
13406: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 13407:
1.210 www 13408: # remove version from URL
13409: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 13410:
1.507 www 13411: # remove wrapper
13412:
1.510 www 13413: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 13414: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 13415: return $symb;
1.409 www 13416: }
13417:
13418: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 13419:
13420: sub encode_symb {
13421: my ($map,$resid,$url)=@_;
13422: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
13423: }
1.409 www 13424:
13425: sub decode_symb {
1.568 albertel 13426: my $symb=shift;
13427: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
13428: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 13429: return (&fixversion($map),$resid,&fixversion($url));
13430: }
13431:
13432: sub fixversion {
13433: my $fn=shift;
1.609 banghart 13434: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 13435: my %bighash;
13436: my $uri=&clutter($fn);
1.620 albertel 13437: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 13438: # is this cached?
1.599 albertel 13439: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 13440: if (defined($cached)) { return $result; }
13441: # unfortunately not cached, or expired
1.620 albertel 13442: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 13443: &GDBM_READER(),0640)) {
13444: if ($bighash{'version_'.$uri}) {
13445: my $version=$bighash{'version_'.$uri};
1.444 www 13446: unless (($version eq 'mostrecent') ||
13447: ($version==&getversion($uri))) {
1.440 www 13448: $uri=~s/\.(\w+)$/\.$version\.$1/;
13449: }
13450: }
13451: untie %bighash;
1.413 www 13452: }
1.599 albertel 13453: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 13454: }
13455:
13456: sub deversion {
13457: my $url=shift;
13458: $url=~s/\.\d+\.(\w+)$/\.$1/;
13459: return $url;
1.210 www 13460: }
13461:
1.31 www 13462: # ------------------------------------------------------ Return symb list entry
13463:
13464: sub symbread {
1.1424 raeburn 13465: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles,
1.1427 raeburn 13466: $ignoresymbdb,$noenccheck)=@_;
1.1265 raeburn 13467: my $cache_str='request.symbread.cached.'.$thisfn;
1.1427 raeburn 13468: if (defined($env{$cache_str})) {
1.1424 raeburn 13469: unless (ref($possibles) eq 'HASH') {
13470: if ($ignorecachednull) {
13471: return $env{$cache_str} unless ($env{$cache_str} eq '');
13472: } else {
13473: return $env{$cache_str};
13474: }
1.1282 raeburn 13475: }
13476: }
1.242 www 13477: # no filename provided? try from environment
1.1265 raeburn 13478: unless ($thisfn) {
1.620 albertel 13479: if ($env{'request.symb'}) {
1.1427 raeburn 13480: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 13481: }
1.620 albertel 13482: $thisfn=$env{'request.filename'};
1.44 www 13483: }
1.569 albertel 13484: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 13485: # is that filename actually a symb? Verify, clean, and return
13486: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 13487: if (&symbverify($thisfn,$1)) {
1.1427 raeburn 13488: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 13489: }
1.242 www 13490: }
1.44 www 13491: $thisfn=declutter($thisfn);
1.31 www 13492: my %hash;
1.37 www 13493: my %bighash;
13494: my $syval='';
1.620 albertel 13495: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 13496: my $targetfn = $thisfn;
1.609 banghart 13497: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 13498: $targetfn = 'adm/wrapper/'.$thisfn;
13499: }
1.687 albertel 13500: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
13501: $targetfn=$1;
13502: }
1.1427 raeburn 13503: unless ($ignoresymbdb) {
1.1424 raeburn 13504: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
13505: &GDBM_READER(),0640)) {
13506: $syval=$hash{$targetfn};
13507: untie(%hash);
13508: }
1.1427 raeburn 13509: if ($syval && $checkforblock) {
13510: my @blockers = &has_comm_blocking('bre',$syval,$thisfn,$ignoresymbdb,$noenccheck);
1.1424 raeburn 13511: if (@blockers) {
13512: $syval='';
13513: }
13514: }
1.37 www 13515: }
13516: # ---------------------------------------------------------- There was an entry
13517: if ($syval) {
1.601 albertel 13518: #unless ($syval=~/\_\d+$/) {
1.620 albertel 13519: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 13520: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 13521: #return $env{$cache_str}='';
1.601 albertel 13522: #}
13523: #$syval.=$1;
13524: #}
1.37 www 13525: } else {
13526: # ------------------------------------------------------- Was not in symb table
1.620 albertel 13527: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 13528: &GDBM_READER(),0640)) {
1.37 www 13529: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 13530: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 13531: unless ($ids) {
13532: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 13533: }
13534: unless ($ids) {
13535: # alias?
13536: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 13537: }
1.37 www 13538: if ($ids) {
13539: # ------------------------------------------------------------------- Has ID(s)
13540: my @possibilities=split(/\,/,$ids);
1.39 www 13541: if ($#possibilities==0) {
13542: # ----------------------------------------------- There is only one possibility
1.37 www 13543: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 13544: $syval=&encode_symb($bighash{'map_id_'.$mapid},
13545: $resid,$thisfn);
1.1282 raeburn 13546: if (ref($possibles) eq 'HASH') {
1.1424 raeburn 13547: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
13548: $possibles->{$syval} = 1;
13549: }
1.1282 raeburn 13550: }
13551: if ($checkforblock) {
1.1424 raeburn 13552: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
1.1426 raeburn 13553: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids},'',$noenccheck);
1.1424 raeburn 13554: if (@blockers) {
13555: $syval = '';
1.1425 raeburn 13556: untie(%bighash);
13557: return $env{$cache_str}='';
1.1424 raeburn 13558: }
1.1282 raeburn 13559: }
13560: }
13561: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 13562: # ------------------------------------------ There is more than one possibility
13563: my $realpossible=0;
1.800 albertel 13564: foreach my $id (@possibilities) {
13565: my $file=$bighash{'src_'.$id};
1.1282 raeburn 13566: my $canaccess;
13567: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
13568: $canaccess = 1;
13569: } else {
13570: $canaccess = &allowed('bre',$file);
13571: }
13572: if ($canaccess) {
13573: my ($mapid,$resid)=split(/\./,$id);
13574: if ($bighash{'map_type_'.$mapid} ne 'page') {
13575: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
13576: $resid,$thisfn);
1.1424 raeburn 13577: next if ($bighash{'randomout_'.$id} && !$env{'request.role.adv'});
1.1426 raeburn 13578: next unless (($noenccheck) || ($bighash{'encrypted_'.$id} eq $env{'request.enc'}));
1.1282 raeburn 13579: if ($checkforblock) {
1.1426 raeburn 13580: my @blockers = &has_comm_blocking('bre',$poss_syval,$file,'',$noenccheck);
1.1424 raeburn 13581: if (@blockers > 0) {
13582: $syval = '';
13583: } else {
1.1282 raeburn 13584: $syval = $poss_syval;
13585: $realpossible++;
13586: }
13587: } else {
13588: $syval = $poss_syval;
13589: $realpossible++;
13590: }
1.1424 raeburn 13591: if ($syval) {
13592: if (ref($possibles) eq 'HASH') {
13593: $possibles->{$syval} = 1;
13594: }
13595: }
1.1282 raeburn 13596: }
1.39 www 13597: }
1.191 harris41 13598: }
1.39 www 13599: if ($realpossible!=1) { $syval=''; }
1.249 www 13600: } else {
13601: $syval='';
1.37 www 13602: }
13603: }
1.1282 raeburn 13604: untie(%bighash);
1.481 raeburn 13605: }
1.31 www 13606: }
1.62 www 13607: if ($syval) {
1.1427 raeburn 13608: return $env{$cache_str}=$syval;
1.62 www 13609: }
1.31 www 13610: }
1.949 raeburn 13611: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 13612: return $env{$cache_str}='';
1.31 www 13613: }
13614:
13615: # ---------------------------------------------------------- Return random seed
13616:
1.32 www 13617: sub numval {
13618: my $txt=shift;
13619: $txt=~tr/A-J/0-9/;
13620: $txt=~tr/a-j/0-9/;
13621: $txt=~tr/K-T/0-9/;
13622: $txt=~tr/k-t/0-9/;
13623: $txt=~tr/U-Z/0-5/;
13624: $txt=~tr/u-z/0-5/;
13625: $txt=~s/\D//g;
1.564 albertel 13626: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 13627: return int($txt);
1.368 albertel 13628: }
13629:
1.484 albertel 13630: sub numval2 {
13631: my $txt=shift;
13632: $txt=~tr/A-J/0-9/;
13633: $txt=~tr/a-j/0-9/;
13634: $txt=~tr/K-T/0-9/;
13635: $txt=~tr/k-t/0-9/;
13636: $txt=~tr/U-Z/0-5/;
13637: $txt=~tr/u-z/0-5/;
13638: $txt=~s/\D//g;
13639: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13640: my $total;
13641: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 13642: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 13643: return int($total);
13644: }
13645:
1.575 albertel 13646: sub numval3 {
13647: use integer;
13648: my $txt=shift;
13649: $txt=~tr/A-J/0-9/;
13650: $txt=~tr/a-j/0-9/;
13651: $txt=~tr/K-T/0-9/;
13652: $txt=~tr/k-t/0-9/;
13653: $txt=~tr/U-Z/0-5/;
13654: $txt=~tr/u-z/0-5/;
13655: $txt=~s/\D//g;
13656: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
13657: my $total;
13658: foreach my $val (@txts) { $total+=$val; }
13659: if ($_64bit) { $total=(($total<<32)>>32); }
13660: return $total;
13661: }
13662:
1.675 albertel 13663: sub digest {
13664: my ($data)=@_;
13665: my $digest=&Digest::MD5::md5($data);
13666: my ($a,$b,$c,$d)=unpack("iiii",$digest);
13667: my ($e,$f);
13668: {
13669: use integer;
13670: $e=($a+$b);
13671: $f=($c+$d);
13672: if ($_64bit) {
13673: $e=(($e<<32)>>32);
13674: $f=(($f<<32)>>32);
13675: }
13676: }
13677: if (wantarray) {
13678: return ($e,$f);
13679: } else {
13680: my $g;
13681: {
13682: use integer;
13683: $g=($e+$f);
13684: if ($_64bit) {
13685: $g=(($g<<32)>>32);
13686: }
13687: }
13688: return $g;
13689: }
13690: }
13691:
1.368 albertel 13692: sub latest_rnd_algorithm_id {
1.675 albertel 13693: return '64bit5';
1.366 albertel 13694: }
1.32 www 13695:
1.503 albertel 13696: sub get_rand_alg {
13697: my ($courseid)=@_;
1.790 albertel 13698: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 13699: if ($courseid) {
1.620 albertel 13700: return $env{"course.$courseid.rndseed"};
1.503 albertel 13701: }
13702: return &latest_rnd_algorithm_id();
13703: }
13704:
1.562 albertel 13705: sub validCODE {
13706: my ($CODE)=@_;
13707: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
13708: return 0;
13709: }
13710:
1.491 albertel 13711: sub getCODE {
1.620 albertel 13712: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 13713: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
13714: defined($Apache::lonhomework::parsing_a_task) ) &&
13715: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 13716: return $Apache::lonhomework::history{'resource.CODE'};
13717: }
13718: return undef;
13719: }
1.1133 foxr 13720: #
13721: # Determines the random seed for a specific context:
13722: #
13723: # parameters:
13724: # symb - in course context the symb for the seed.
13725: # course_id - The course id of the form domain_coursenum.
13726: # domain - Domain for the user.
13727: # course - Course for the user.
13728: # cenv - environment of the course.
13729: #
13730: # NOTE:
13731: # All parameters are picked out of the environment if missing
13732: # or not defined.
13733: # If a symb cannot be determined the current time is used instead.
13734: #
13735: # For a given well defined symb, courside, domain, username,
13736: # and course environment, the seed is reproducible.
13737: #
1.31 www 13738: sub rndseed {
1.1133 foxr 13739: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 13740: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 13741: if (!defined($symb)) {
1.366 albertel 13742: unless ($symb=$wsymb) { return time; }
13743: }
1.1146 foxr 13744: if (!defined $courseid) {
13745: $courseid=$wcourseid;
13746: }
13747: if (!defined $domain) { $domain=$wdomain; }
13748: if (!defined $username) { $username=$wusername }
1.1133 foxr 13749:
13750: my $which;
13751: if (defined($cenv->{'rndseed'})) {
13752: $which = $cenv->{'rndseed'};
13753: } else {
13754: $which =&get_rand_alg($courseid);
13755: }
1.491 albertel 13756: if (defined(&getCODE())) {
1.1133 foxr 13757:
1.675 albertel 13758: if ($which eq '64bit5') {
13759: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
13760: } elsif ($which eq '64bit4') {
1.575 albertel 13761: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
13762: } else {
13763: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
13764: }
1.675 albertel 13765: } elsif ($which eq '64bit5') {
13766: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 13767: } elsif ($which eq '64bit4') {
13768: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 13769: } elsif ($which eq '64bit3') {
13770: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 13771: } elsif ($which eq '64bit2') {
13772: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 13773: } elsif ($which eq '64bit') {
13774: return &rndseed_64bit($symb,$courseid,$domain,$username);
13775: }
13776: return &rndseed_32bit($symb,$courseid,$domain,$username);
13777: }
13778:
13779: sub rndseed_32bit {
13780: my ($symb,$courseid,$domain,$username)=@_;
13781: {
13782: use integer;
13783: my $symbchck=unpack("%32C*",$symb) << 27;
13784: my $symbseed=numval($symb) << 22;
13785: my $namechck=unpack("%32C*",$username) << 17;
13786: my $nameseed=numval($username) << 12;
13787: my $domainseed=unpack("%32C*",$domain) << 7;
13788: my $courseseed=unpack("%32C*",$courseid);
13789: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 13790: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13791: #&logthis("rndseed :$num:$symb");
1.564 albertel 13792: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 13793: return $num;
13794: }
13795: }
13796:
13797: sub rndseed_64bit {
13798: my ($symb,$courseid,$domain,$username)=@_;
13799: {
13800: use integer;
13801: my $symbchck=unpack("%32S*",$symb) << 21;
13802: my $symbseed=numval($symb) << 10;
13803: my $namechck=unpack("%32S*",$username);
13804:
13805: my $nameseed=numval($username) << 21;
13806: my $domainseed=unpack("%32S*",$domain) << 10;
13807: my $courseseed=unpack("%32S*",$courseid);
13808:
13809: my $num1=$symbchck+$symbseed+$namechck;
13810: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13811: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13812: #&logthis("rndseed :$num:$symb");
1.564 albertel 13813: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 13814: return "$num1,$num2";
1.155 albertel 13815: }
1.366 albertel 13816: }
13817:
1.443 albertel 13818: sub rndseed_64bit2 {
13819: my ($symb,$courseid,$domain,$username)=@_;
13820: {
13821: use integer;
13822: # strings need to be an even # of cahracters long, it it is odd the
13823: # last characters gets thrown away
13824: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13825: my $symbseed=numval($symb) << 10;
13826: my $namechck=unpack("%32S*",$username.' ');
13827:
13828: my $nameseed=numval($username) << 21;
1.501 albertel 13829: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13830: my $courseseed=unpack("%32S*",$courseid.' ');
13831:
13832: my $num1=$symbchck+$symbseed+$namechck;
13833: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13834: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13835: #&logthis("rndseed :$num:$symb");
1.803 albertel 13836: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 13837: return "$num1,$num2";
13838: }
13839: }
13840:
13841: sub rndseed_64bit3 {
13842: my ($symb,$courseid,$domain,$username)=@_;
13843: {
13844: use integer;
13845: # strings need to be an even # of cahracters long, it it is odd the
13846: # last characters gets thrown away
13847: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13848: my $symbseed=numval2($symb) << 10;
13849: my $namechck=unpack("%32S*",$username.' ');
13850:
13851: my $nameseed=numval2($username) << 21;
1.443 albertel 13852: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13853: my $courseseed=unpack("%32S*",$courseid.' ');
13854:
13855: my $num1=$symbchck+$symbseed+$namechck;
13856: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13857: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13858: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 13859: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 13860:
1.503 albertel 13861: return "$num1:$num2";
1.443 albertel 13862: }
13863: }
13864:
1.575 albertel 13865: sub rndseed_64bit4 {
13866: my ($symb,$courseid,$domain,$username)=@_;
13867: {
13868: use integer;
13869: # strings need to be an even # of cahracters long, it it is odd the
13870: # last characters gets thrown away
13871: my $symbchck=unpack("%32S*",$symb.' ') << 21;
13872: my $symbseed=numval3($symb) << 10;
13873: my $namechck=unpack("%32S*",$username.' ');
13874:
13875: my $nameseed=numval3($username) << 21;
13876: my $domainseed=unpack("%32S*",$domain.' ') << 10;
13877: my $courseseed=unpack("%32S*",$courseid.' ');
13878:
13879: my $num1=$symbchck+$symbseed+$namechck;
13880: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 13881: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
13882: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 13883: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 13884:
1.575 albertel 13885: return "$num1:$num2";
13886: }
13887: }
13888:
1.675 albertel 13889: sub rndseed_64bit5 {
13890: my ($symb,$courseid,$domain,$username)=@_;
13891: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
13892: return "$num1:$num2";
13893: }
13894:
1.366 albertel 13895: sub rndseed_CODE_64bit {
13896: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 13897: {
1.366 albertel 13898: use integer;
1.443 albertel 13899: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 13900: my $symbseed=numval2($symb);
1.491 albertel 13901: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
13902: my $CODEseed=numval(&getCODE());
1.443 albertel 13903: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 13904: my $num1=$symbseed+$CODEchck;
13905: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 13906: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
13907: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 13908: if ($_64bit) { $num1=(($num1<<32)>>32); }
13909: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 13910: return "$num1:$num2";
1.366 albertel 13911: }
13912: }
13913:
1.575 albertel 13914: sub rndseed_CODE_64bit4 {
13915: my ($symb,$courseid,$domain,$username)=@_;
13916: {
13917: use integer;
13918: my $symbchck=unpack("%32S*",$symb.' ') << 16;
13919: my $symbseed=numval3($symb);
13920: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
13921: my $CODEseed=numval3(&getCODE());
13922: my $courseseed=unpack("%32S*",$courseid.' ');
13923: my $num1=$symbseed+$CODEchck;
13924: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 13925: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
13926: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 13927: if ($_64bit) { $num1=(($num1<<32)>>32); }
13928: if ($_64bit) { $num2=(($num2<<32)>>32); }
13929: return "$num1:$num2";
13930: }
13931: }
13932:
1.675 albertel 13933: sub rndseed_CODE_64bit5 {
13934: my ($symb,$courseid,$domain,$username)=@_;
13935: my $code = &getCODE();
13936: my ($num1,$num2)=&digest("$symb,$courseid,$code");
13937: return "$num1:$num2";
13938: }
13939:
1.366 albertel 13940: sub setup_random_from_rndseed {
13941: my ($rndseed)=@_;
1.503 albertel 13942: if ($rndseed =~/([,:])/) {
1.1262 raeburn 13943: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
13944: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
13945: &Math::Random::random_set_seed_from_phrase($rndseed);
13946: } else {
13947: &Math::Random::random_set_seed($num1,$num2);
13948: }
1.366 albertel 13949: } else {
13950: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 13951: }
1.36 albertel 13952: }
13953:
1.474 albertel 13954: sub latest_receipt_algorithm_id {
1.835 albertel 13955: return 'receipt3';
1.474 albertel 13956: }
13957:
1.480 www 13958: sub recunique {
13959: my $fucourseid=shift;
13960: my $unique;
1.835 albertel 13961: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
13962: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 13963: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 13964: } else {
13965: $unique=$perlvar{'lonReceipt'};
13966: }
13967: return unpack("%32C*",$unique);
13968: }
13969:
13970: sub recprefix {
13971: my $fucourseid=shift;
13972: my $prefix;
1.835 albertel 13973: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
13974: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 13975: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 13976: } else {
13977: $prefix=$perlvar{'lonHostID'};
13978: }
13979: return unpack("%32C*",$prefix);
13980: }
13981:
1.76 www 13982: sub ireceipt {
1.474 albertel 13983: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 13984:
13985: my $return =&recprefix($fucourseid).'-';
13986:
13987: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
13988: $env{'request.state'} eq 'construct') {
13989: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
13990: return $return;
13991: }
13992:
1.76 www 13993: my $cuname=unpack("%32C*",$funame);
13994: my $cudom=unpack("%32C*",$fudom);
13995: my $cucourseid=unpack("%32C*",$fucourseid);
13996: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 13997: my $cunique=&recunique($fucourseid);
1.474 albertel 13998: my $cpart=unpack("%32S*",$part);
1.835 albertel 13999: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
14000:
1.790 albertel 14001: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 14002:
14003: $return.= ($cunique%$cuname+
14004: $cunique%$cudom+
14005: $cusymb%$cuname+
14006: $cusymb%$cudom+
14007: $cucourseid%$cuname+
14008: $cucourseid%$cudom+
14009: $cpart%$cuname+
14010: $cpart%$cudom);
14011: } else {
14012: $return.= ($cunique%$cuname+
14013: $cunique%$cudom+
14014: $cusymb%$cuname+
14015: $cusymb%$cudom+
14016: $cucourseid%$cuname+
14017: $cucourseid%$cudom);
14018: }
14019: return $return;
1.76 www 14020: }
14021:
14022: sub receipt {
1.474 albertel 14023: my ($part)=@_;
1.790 albertel 14024: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 14025: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 14026: }
1.260 ng 14027:
1.790 albertel 14028: sub whichuser {
14029: my ($passedsymb)=@_;
14030: my ($symb,$courseid,$domain,$name,$publicuser);
14031: if (defined($env{'form.grade_symb'})) {
14032: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
14033: my $allowed=&allowed('vgr',$tmp_courseid);
14034: if (!$allowed &&
14035: exists($env{'request.course.sec'}) &&
14036: $env{'request.course.sec'} !~ /^\s*$/) {
14037: $allowed=&allowed('vgr',$tmp_courseid.
14038: '/'.$env{'request.course.sec'});
14039: }
14040: if ($allowed) {
14041: ($symb)=&get_env_multiple('form.grade_symb');
14042: $courseid=$tmp_courseid;
14043: ($domain)=&get_env_multiple('form.grade_domain');
14044: ($name)=&get_env_multiple('form.grade_username');
14045: return ($symb,$courseid,$domain,$name,$publicuser);
14046: }
14047: }
14048: if (!$passedsymb) {
14049: $symb=&symbread();
14050: } else {
14051: $symb=$passedsymb;
14052: }
14053: $courseid=$env{'request.course.id'};
14054: $domain=$env{'user.domain'};
14055: $name=$env{'user.name'};
14056: if ($name eq 'public' && $domain eq 'public') {
14057: if (!defined($env{'form.username'})) {
14058: $env{'form.username'}.=time.rand(10000000);
14059: }
14060: $name.=$env{'form.username'};
14061: }
14062: return ($symb,$courseid,$domain,$name,$publicuser);
14063:
14064: }
14065:
1.36 albertel 14066: # ------------------------------------------------------------ Serves up a file
1.472 albertel 14067: # returns either the contents of the file or
14068: # -1 if the file doesn't exist
1.481 raeburn 14069: #
14070: # if the target is a file that was uploaded via DOCS,
14071: # a check will be made to see if a current copy exists on the local server,
14072: # if it does this will be served, otherwise a copy will be retrieved from
14073: # the home server for the course and stored in /home/httpd/html/userfiles on
14074: # the local server.
1.472 albertel 14075:
1.36 albertel 14076: sub getfile {
1.538 albertel 14077: my ($file) = @_;
1.609 banghart 14078: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 14079: &repcopy($file);
14080: return &readfile($file);
14081: }
14082:
14083: sub repcopy_userfile {
14084: my ($file)=@_;
1.1142 raeburn 14085: my $londocroot = $perlvar{'lonDocRoot'};
14086: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 14087: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 14088: my ($cdom,$cnum,$filename) =
1.811 albertel 14089: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 14090: my $uri="/uploaded/$cdom/$cnum/$filename";
14091: if (-e "$file") {
1.828 www 14092: # we already have a local copy, check it out
1.538 albertel 14093: my @fileinfo = stat($file);
1.828 www 14094: my $rtncode;
14095: my $info;
1.538 albertel 14096: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 14097: if ($lwpresp ne 'ok') {
1.828 www 14098: # there is no such file anymore, even though we had a local copy
1.482 albertel 14099: if ($rtncode eq '404') {
1.538 albertel 14100: unlink($file);
1.482 albertel 14101: }
14102: return -1;
14103: }
14104: if ($info < $fileinfo[9]) {
1.828 www 14105: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 14106: return 'ok';
1.828 www 14107: } else {
14108: # the file is outdated, get rid of it
14109: unlink($file);
1.482 albertel 14110: }
1.828 www 14111: }
14112: # one way or the other, at this point, we don't have the file
14113: # construct the correct path for the file
14114: my @parts = ($cdom,$cnum);
14115: if ($filename =~ m|^(.+)/[^/]+$|) {
14116: push @parts, split(/\//,$1);
14117: }
14118: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
14119: foreach my $part (@parts) {
14120: $path .= '/'.$part;
14121: if (!-e $path) {
14122: mkdir($path,0770);
1.482 albertel 14123: }
14124: }
1.828 www 14125: # now the path exists for sure
14126: # get a user agent
14127: my $transferfile=$file.'.in.transfer';
14128: # FIXME: this should flock
14129: if (-e $transferfile) { return 'ok'; }
14130: my $request;
14131: $uri=~s/^\///;
1.980 raeburn 14132: my $homeserver = &homeserver($cnum,$cdom);
1.1398 raeburn 14133: my $hostname = &hostname($homeserver);
1.980 raeburn 14134: my $protocol = $protocol{$homeserver};
14135: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14136: $request=new HTTP::Request('GET',$protocol.'://'.$hostname.'/raw/'.$uri);
1.1345 raeburn 14137: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
1.828 www 14138: # did it work?
14139: if ($response->is_error()) {
14140: unlink($transferfile);
14141: &logthis("Userfile repcopy failed for $uri");
14142: return -1;
14143: }
14144: # worked, rename the transfer file
14145: rename($transferfile,$file);
1.607 raeburn 14146: return 'ok';
1.481 raeburn 14147: }
14148:
1.517 albertel 14149: sub tokenwrapper {
14150: my $uri=shift;
1.980 raeburn 14151: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 14152: $uri=~s|^/||;
1.620 albertel 14153: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 14154: my $token=$1;
1.552 albertel 14155: my (undef,$udom,$uname,$file)=split('/',$uri,4);
14156: if ($udom && $uname && $file) {
14157: $file=~s|(\?\.*)*$||;
1.949 raeburn 14158: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 14159: my $homeserver = &homeserver($uname,$udom);
1.1397 raeburn 14160: my $hostname = &hostname($homeserver);
1.980 raeburn 14161: my $protocol = $protocol{$homeserver};
14162: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14163: return $protocol.'://'.$hostname.'/'.$uri.
1.517 albertel 14164: (($uri=~/\?/)?'&':'?').'token='.$token.
14165: '&tokenissued='.$perlvar{'lonHostID'};
14166: } else {
14167: return '/adm/notfound.html';
14168: }
14169: }
14170:
1.828 www 14171: # call with reqtype HEAD: get last modification time
14172: # call with reqtype GET: get the file contents
14173: # Do not call this with reqtype GET for large files! It loads everything into memory
14174: #
1.481 raeburn 14175: sub getuploaded {
14176: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
14177: $uri=~s/^\///;
1.980 raeburn 14178: my $homeserver = &homeserver($cnum,$cdom);
1.1397 raeburn 14179: my $hostname = &hostname($homeserver);
1.980 raeburn 14180: my $protocol = $protocol{$homeserver};
14181: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 14182: $uri = $protocol.'://'.$hostname.'/raw/'.$uri;
1.481 raeburn 14183: my $request=new HTTP::Request($reqtype,$uri);
1.1345 raeburn 14184: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
1.481 raeburn 14185: $$rtncode = $response->code;
1.482 albertel 14186: if (! $response->is_success()) {
14187: return 'failed';
14188: }
14189: if ($reqtype eq 'HEAD') {
1.486 www 14190: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 14191: } elsif ($reqtype eq 'GET') {
14192: $$info = $response->content;
1.472 albertel 14193: }
1.482 albertel 14194: return 'ok';
1.36 albertel 14195: }
14196:
1.481 raeburn 14197: sub readfile {
14198: my $file = shift;
14199: if ( (! -e $file ) || ($file eq '') ) { return -1; };
14200: my $fh;
1.1359 raeburn 14201: open($fh,"<",$file);
1.481 raeburn 14202: my $a='';
1.800 albertel 14203: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 14204: return $a;
14205: }
14206:
1.36 albertel 14207: sub filelocation {
1.590 banghart 14208: my ($dir,$file) = @_;
14209: my $location;
14210: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 14211:
14212: if ($file =~ m-^/adm/-) {
14213: $file=~s-^/adm/wrapper/-/-;
14214: $file=~s-^/adm/coursedocs/showdoc/-/-;
14215: }
1.882 albertel 14216:
1.1139 www 14217: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 14218: $location = $file;
1.609 banghart 14219: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 14220: my ($udom,$uname,$filename)=
1.811 albertel 14221: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 14222: my $home=&homeserver($uname,$udom);
14223: my $is_me=0;
14224: my @ids=¤t_machine_ids();
14225: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
14226: if ($is_me) {
1.1117 foxr 14227: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 14228: } else {
14229: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
14230: $udom.'/'.$uname.'/'.$filename;
14231: }
1.882 albertel 14232: } elsif ($file =~ m-^/adm/-) {
14233: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 14234: } else {
14235: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 14236: $file=~s:^/(res|priv)/:/:;
14237: my $space=$1;
1.590 banghart 14238: if ( !( $file =~ m:^/:) ) {
14239: $location = $dir. '/'.$file;
14240: } else {
1.1142 raeburn 14241: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 14242: }
1.59 albertel 14243: }
1.590 banghart 14244: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 14245: while ($location=~m{/\.\./}) {
14246: if ($location =~ m{/[^/]+/\.\./}) {
14247: $location=~ s{/[^/]+/\.\./}{/}g;
14248: } else {
14249: $location=~ s{/\.\./}{/}g;
14250: }
14251: } #remove dir/..
1.590 banghart 14252: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
14253: return $location;
1.46 www 14254: }
1.36 albertel 14255:
1.46 www 14256: sub hreflocation {
14257: my ($dir,$file)=@_;
1.980 raeburn 14258: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 14259: $file=filelocation($dir,$file);
1.700 albertel 14260: } elsif ($file=~m-^/adm/-) {
14261: $file=~s-^/adm/wrapper/-/-;
14262: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 14263: }
14264: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
14265: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
14266: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 14267: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
14268: {/uploaded/$1/$2/}x;
1.46 www 14269: }
1.913 albertel 14270: if ($file=~ m{^/userfiles/}) {
14271: $file =~ s{^/userfiles/}{/uploaded/};
14272: }
1.462 albertel 14273: return $file;
1.465 albertel 14274: }
14275:
1.1139 www 14276:
14277:
14278:
14279:
1.465 albertel 14280: sub current_machine_domains {
1.853 albertel 14281: return &machine_domains(&hostname($perlvar{'lonHostID'}));
14282: }
14283:
14284: sub machine_domains {
14285: my ($hostname) = @_;
1.465 albertel 14286: my @domains;
1.838 albertel 14287: my %hostname = &all_hostnames();
1.465 albertel 14288: while( my($id, $name) = each(%hostname)) {
1.467 matthew 14289: # &logthis("-$id-$name-$hostname-");
1.465 albertel 14290: if ($hostname eq $name) {
1.844 albertel 14291: push(@domains,&host_domain($id));
1.465 albertel 14292: }
14293: }
14294: return @domains;
14295: }
14296:
14297: sub current_machine_ids {
1.853 albertel 14298: return &machine_ids(&hostname($perlvar{'lonHostID'}));
14299: }
14300:
14301: sub machine_ids {
14302: my ($hostname) = @_;
14303: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 14304: my @ids;
1.888 albertel 14305: my %name_to_host = &all_names();
1.889 albertel 14306: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
14307: return @{ $name_to_host{$hostname} };
14308: }
14309: return;
1.31 www 14310: }
14311:
1.824 raeburn 14312: sub additional_machine_domains {
14313: my @domains;
1.1359 raeburn 14314: open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab");
1.824 raeburn 14315: while( my $line = <$fh>) {
14316: $line =~ s/\s//g;
14317: push(@domains,$line);
14318: }
14319: return @domains;
14320: }
14321:
14322: sub default_login_domain {
14323: my $domain = $perlvar{'lonDefDomain'};
14324: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
14325: foreach my $posdom (¤t_machine_domains(),
14326: &additional_machine_domains()) {
14327: if (lc($posdom) eq lc($testdomain)) {
14328: $domain=$posdom;
14329: last;
14330: }
14331: }
14332: return $domain;
14333: }
14334:
1.1414 raeburn 14335: sub shared_institution {
1.1439 raeburn 14336: my ($dom,$lonhost) = @_;
14337: if ($lonhost eq '') {
14338: $lonhost = $perlvar{'lonHostID'};
14339: }
1.1414 raeburn 14340: my $same_intdom;
1.1439 raeburn 14341: my $hostintdom = &internet_dom($lonhost);
1.1414 raeburn 14342: if ($hostintdom ne '') {
14343: my %iphost = &get_iphost();
14344: my $primary_id = &domain($dom,'primary');
14345: my $primary_ip = &get_host_ip($primary_id);
14346: if (ref($iphost{$primary_ip}) eq 'ARRAY') {
14347: foreach my $id (@{$iphost{$primary_ip}}) {
14348: my $intdom = &internet_dom($id);
14349: if ($intdom eq $hostintdom) {
14350: $same_intdom = 1;
14351: last;
14352: }
14353: }
14354: }
14355: }
14356: return $same_intdom;
14357: }
14358:
1.1398 raeburn 14359: sub uses_sts {
14360: my ($ignore_cache) = @_;
14361: my $lonhost = $perlvar{'lonHostID'};
14362: my $hostname = &hostname($lonhost);
14363: my $sts_on;
14364: if ($protocol{$lonhost} eq 'https') {
14365: my $cachetime = 12*3600;
14366: if (!$ignore_cache) {
14367: ($sts_on,my $cached)=&is_cached_new('stspolicy',$lonhost);
14368: if (defined($cached)) {
14369: return $sts_on;
14370: }
14371: }
14372: my $url = $protocol{$lonhost}.'://'.$hostname.'/index.html';
14373: my $request=new HTTP::Request('HEAD',$url);
14374: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,'','','',1);
14375: if ($response->is_success) {
14376: my $has_sts = $response->header('Strict-Transport-Security');
14377: if ($has_sts eq '') {
14378: $sts_on = 0;
14379: } else {
14380: if ($has_sts =~ /\Qmax-age=\E(\d+)/) {
14381: my $maxage = $1;
14382: if ($maxage) {
14383: $sts_on = 1;
14384: } else {
14385: $sts_on = 0;
14386: }
14387: } else {
14388: $sts_on = 0;
14389: }
14390: }
14391: return &do_cache_new('stspolicy',$lonhost,$sts_on,$cachetime);
14392: }
14393: }
14394: return;
14395: }
14396:
1.1449 raeburn 14397: sub waf_allssl {
14398: my ($host_name) = @_;
14399: my $alias = &get_proxy_alias();
14400: if ($host_name eq '') {
14401: $host_name = $ENV{'SERVER_NAME'};
14402: }
14403: if (($host_name ne '') && ($alias eq $host_name)) {
14404: my $serverhomedom = &host_domain($perlvar{'lonHostID'});
14405: my %defdomdefaults = &get_domain_defaults($serverhomedom);
14406: if ($defdomdefaults{'waf_sslopt'}) {
14407: return $defdomdefaults{'waf_sslopt'};
14408: }
14409: }
14410: return;
14411: }
14412:
1.1434 raeburn 14413: sub get_requestor_ip {
14414: my ($r,$nolookup,$noproxy) = @_;
14415: my $from_ip;
14416: if (ref($r)) {
1.1447 raeburn 14417: if ($r->can('useragent_ip')) {
14418: if ($noproxy && $r->can('client_ip')) {
14419: $from_ip = $r->client_ip();
14420: } else {
14421: $from_ip = $r->useragent_ip();
14422: }
14423: } elsif ($r->connection->can('remote_ip')) {
14424: $from_ip = $r->connection->remote_ip();
14425: } else {
14426: $from_ip = $r->get_remote_host($nolookup);
14427: }
1.1434 raeburn 14428: } else {
14429: $from_ip = $ENV{'REMOTE_ADDR'};
14430: }
14431: return $from_ip if ($noproxy);
14432: # Who controls proxy settings for server
14433: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
14434: my $proxyinfo = &get_proxy_settings($dom_in_use);
14435: if ((ref($proxyinfo) eq 'HASH') && ($from_ip)) {
1.1437 raeburn 14436: if ($proxyinfo->{'vpnint'}) {
14437: if (&ip_match($from_ip,$proxyinfo->{'vpnint'})) {
1.1434 raeburn 14438: return $from_ip;
14439: }
14440: }
14441: if ($proxyinfo->{'trusted'}) {
14442: if (&ip_match($from_ip,$proxyinfo->{'trusted'})) {
14443: my $ipheader = $proxyinfo->{'ipheader'};
14444: my ($ip,$xfor);
14445: if (ref($r)) {
14446: if ($ipheader) {
14447: $ip = $r->headers_in->{$ipheader};
14448: }
14449: $xfor = $r->headers_in->{'X-Forwarded-For'};
14450: } else {
14451: if ($ipheader) {
14452: $ip = $ENV{'HTTP_'.uc($ipheader)};
14453: }
14454: $xfor = $ENV{'HTTP_X_FORWARDED_FOR'};
14455: }
14456: if (($ip eq '') && ($xfor ne '')) {
14457: foreach my $poss_ip (reverse(split(/\s*,\s*/,$xfor))) {
14458: unless (&ip_match($poss_ip,$proxyinfo->{'trusted'})) {
14459: $ip = $poss_ip;
1.1435 raeburn 14460: last;
1.1434 raeburn 14461: }
14462: }
14463: }
14464: if ($ip ne '') {
14465: return $ip;
14466: }
14467: }
14468: }
14469: }
14470: return $from_ip;
14471: }
14472:
14473: sub get_proxy_settings {
14474: my ($dom_in_use) = @_;
14475: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom_in_use);
14476: my $proxyinfo = {
14477: ipheader => $domdefaults{'waf_ipheader'},
14478: trusted => $domdefaults{'waf_trusted'},
1.1437 raeburn 14479: vpnint => $domdefaults{'waf_vpnint'},
1.1438 raeburn 14480: vpnext => $domdefaults{'waf_vpnext'},
1.1449 raeburn 14481: sslopt => $domdefaults{'waf_sslopt'},
1.1434 raeburn 14482: };
14483: return $proxyinfo;
14484: }
14485:
14486: sub ip_match {
14487: my ($ip,$pattern_str) = @_;
14488: $ip=Net::CIDR::cidrvalidate($ip);
14489: if ($ip) {
14490: return Net::CIDR::cidrlookup($ip,split(/\s*,\s*/,$pattern_str));
14491: }
14492: return;
14493: }
14494:
14495: sub get_proxy_alias {
1.1450 raeburn 14496: my ($lonid) = @_;
14497: if ($lonid eq '') {
14498: $lonid = $perlvar{'lonHostID'};
14499: }
14500: if (!defined(&hostname($lonid))) {
14501: return;
14502: }
14503: if ($lonid ne '') {
14504: my ($alias,$cached) = &is_cached_new('proxyalias',$lonid);
1.1434 raeburn 14505: if ($cached) {
14506: return $alias;
14507: }
1.1450 raeburn 14508: my $dom = &Apache::lonnet::host_domain($lonid);
1.1434 raeburn 14509: if ($dom ne '') {
14510: my $cachetime = 60*60*24;
14511: my %domconfig =
1.1437 raeburn 14512: &Apache::lonnet::get_dom('configuration',['wafproxy'],$dom);
1.1434 raeburn 14513: my $alias;
1.1437 raeburn 14514: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
14515: if (ref($domconfig{'wafproxy'}{'alias'}) eq 'HASH') {
1.1450 raeburn 14516: $alias = $domconfig{'wafproxy'}{'alias'}{$lonid};
14517: }
14518: }
14519: return &do_cache_new('proxyalias',$lonid,$alias,$cachetime);
14520: }
14521: }
14522: return;
14523: }
14524:
14525: sub use_proxy_alias {
14526: my ($r,$lonid) = @_;
14527: my $alias = &get_proxy_alias($lonid);
14528: if ($alias) {
14529: my $dom = &host_domain($lonid);
14530: if ($dom ne '') {
14531: my $proxyinfo = &get_proxy_settings($dom );
14532: my ($vpnint,$remote_ip);
14533: if (ref($proxyinfo) eq 'HASH') {
14534: $vpnint = $proxyinfo->{'vpnint'};
14535: if ($vpnint) {
14536: $remote_ip = &get_requestor_ip($r,1,1);
1.1434 raeburn 14537: }
14538: }
1.1450 raeburn 14539: unless ($vpnint && &ip_match($remote_ip,$vpnint)) {
14540: return $alias;
14541: }
1.1434 raeburn 14542: }
14543: }
14544: return;
14545: }
14546:
1.31 www 14547: # ------------------------------------------------------------- Declutters URLs
14548:
14549: sub declutter {
14550: my $thisfn=shift;
1.569 albertel 14551: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261 raeburn 14552: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
14553: $thisfn=~s{^/home/httpd/html}{};
14554: }
1.31 www 14555: $thisfn=~s/^\///;
1.697 albertel 14556: $thisfn=~s|^adm/wrapper/||;
14557: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 14558: $thisfn=~s/^res\///;
1.1172 bisitz 14559: $thisfn=~s/^priv\///;
1.1032 raeburn 14560: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
14561: $thisfn=~s/\?.+$//;
14562: }
1.268 www 14563: return $thisfn;
14564: }
14565:
14566: # ------------------------------------------------------------- Clutter up URLs
14567:
14568: sub clutter {
14569: my $thisfn='/'.&declutter(shift);
1.887 albertel 14570: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 14571: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 14572: $thisfn='/res'.$thisfn;
14573: }
1.1031 raeburn 14574: if ($thisfn !~m|^/adm|) {
14575: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 14576: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 14577: } else {
14578: my ($ext) = ($thisfn =~ /\.(\w+)$/);
14579: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 14580: if ($embstyle eq 'ssi'
14581: || ($embstyle eq 'hdn')
14582: || ($embstyle eq 'rat')
14583: || ($embstyle eq 'prv')
14584: || ($embstyle eq 'ign')) {
14585: #do nothing with these
14586: } elsif (($embstyle eq 'img')
1.695 albertel 14587: || ($embstyle eq 'emb')
14588: || ($embstyle eq 'wrp')) {
14589: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 14590: } elsif ($embstyle eq 'unk'
14591: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 14592: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 14593: } else {
1.718 www 14594: # &logthis("Got a blank emb style");
1.695 albertel 14595: }
1.694 albertel 14596: }
1.1343 raeburn 14597: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
1.1298 raeburn 14598: $thisfn='/adm/wrapper'.$thisfn;
1.694 albertel 14599: }
1.31 www 14600: return $thisfn;
1.12 www 14601: }
14602:
1.787 albertel 14603: sub clutter_with_no_wrapper {
14604: my $uri = &clutter(shift);
14605: if ($uri =~ m-^/adm/-) {
14606: $uri =~ s-^/adm/wrapper/-/-;
14607: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
14608: }
14609: return $uri;
14610: }
14611:
1.557 albertel 14612: sub freeze_escape {
14613: my ($value)=@_;
14614: if (ref($value)) {
14615: $value=&nfreeze($value);
14616: return '__FROZEN__'.&escape($value);
14617: }
14618: return &escape($value);
14619: }
14620:
1.11 www 14621:
1.557 albertel 14622: sub thaw_unescape {
14623: my ($value)=@_;
14624: if ($value =~ /^__FROZEN__/) {
14625: substr($value,0,10,undef);
14626: $value=&unescape($value);
14627: return &thaw($value);
14628: }
14629: return &unescape($value);
14630: }
14631:
1.436 albertel 14632: sub correct_line_ends {
14633: my ($result)=@_;
14634: $$result =~s/\r\n/\n/mg;
14635: $$result =~s/\r/\n/mg;
1.415 albertel 14636: }
1.1 albertel 14637: # ================================================================ Main Program
14638:
1.184 www 14639: sub goodbye {
1.204 albertel 14640: &logthis("Starting Shut down");
1.443 albertel 14641: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 14642: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 14643: #converted
1.599 albertel 14644: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 14645: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
14646: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
14647: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 14648: #1.1 only
1.870 albertel 14649: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
14650: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
14651: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
14652: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
14653: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 14654: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
14655: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 14656: &flushcourselogs();
14657: &logthis("Shutting down");
14658: }
14659:
1.852 albertel 14660: sub get_dns {
1.1210 raeburn 14661: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 14662: if (!$ignore_cache) {
14663: my ($content,$cached)=
14664: &Apache::lonnet::is_cached_new('dns',$url);
14665: if ($cached) {
1.1210 raeburn 14666: &$func($content,$hashref);
1.869 albertel 14667: return;
14668: }
14669: }
14670:
14671: my %alldns;
1.1379 raeburn 14672: if (open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab")) {
14673: foreach my $dns (<$config>) {
14674: next if ($dns !~ /^\^(\S*)/x);
14675: my $line = $1;
14676: my ($host,$protocol) = split(/:/,$line);
14677: if ($protocol ne 'https') {
14678: $protocol = 'http';
14679: }
14680: $alldns{$host} = $protocol;
1.979 raeburn 14681: }
1.1379 raeburn 14682: close($config);
1.869 albertel 14683: }
14684: while (%alldns) {
1.1263 raeburn 14685: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.1456 raeburn 14686: my ($contents,@content);
14687: if ($dns eq Sys::Hostname::FQDN::fqdn()) {
14688: my $command = (split('/',$url))[3];
14689: my ($dir,$file) = &parse_getdns_url($command,$url);
14690: delete($alldns{$dns});
14691: next if (($dir eq '') || ($file eq ''));
14692: if (open(my $config,'<',"$dir/$file")) {
1.1457 raeburn 14693: @content = <$config>;
1.1456 raeburn 14694: close($config);
14695: }
14696: if ($url eq '/adm/dns/loncapaCRL') {
14697: $contents = join('',@content);
14698: }
14699: } else {
14700: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
14701: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
14702: delete($alldns{$dns});
14703: next if ($response->is_error());
14704: if ($url eq '/adm/dns/loncapaCRL') {
14705: $contents = $response->content;
14706: } else {
14707: @content = split("\n",$response->content);
14708: }
14709: }
1.1379 raeburn 14710: if ($url eq '/adm/dns/loncapaCRL') {
1.1456 raeburn 14711: return &$func($contents);
1.1379 raeburn 14712: } else {
14713: unless ($nocache) {
14714: &do_cache_new('dns',$url,\@content,30*24*60*60);
14715: }
14716: &$func(\@content,$hashref);
14717: return;
14718: }
14719: }
14720: my $which = (split('/',$url,4))[3];
14721: if ($which eq 'loncapaCRL') {
14722: my $diskfile = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
14723: if (-e $diskfile) {
14724: &logthis("unable to contact DNS, on disk file $diskfile not updated");
14725: } else {
14726: &logthis("unable to contact DNS, no on disk file $diskfile available");
14727: }
14728: } else {
14729: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
14730: if (open(my $config,"<","$perlvar{'lonTabDir'}/dns_$which.tab")) {
14731: my @content = <$config>;
14732: close($config);
14733: &$func(\@content,$hashref);
14734: }
1.852 albertel 14735: }
1.1210 raeburn 14736: return;
14737: }
14738:
14739: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 14740: sub parse_dns_checksums_tab {
1.1210 raeburn 14741: my ($lines,$hashref) = @_;
1.1264 raeburn 14742: my $lonhost = $perlvar{'lonHostID'};
14743: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1210 raeburn 14744: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264 raeburn 14745: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
14746: my $webconfdir = '/etc/httpd/conf';
14747: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
14748: $webconfdir = '/etc/apache2';
14749: } elsif ($distro =~ /^sles(\d+)$/) {
14750: if ($1 >= 10) {
14751: $webconfdir = '/etc/apache2';
14752: }
14753: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
14754: if ($1 >= 10.0) {
14755: $webconfdir = '/etc/apache2';
14756: }
14757: }
1.1210 raeburn 14758: my ($release,$timestamp) = split(/\-/,$loncaparev);
14759: my (%chksum,%revnum);
14760: if (ref($lines) eq 'ARRAY') {
14761: chomp(@{$lines});
1.1238 raeburn 14762: my $version = shift(@{$lines});
14763: if ($version eq $release) {
1.1210 raeburn 14764: foreach my $line (@{$lines}) {
1.1238 raeburn 14765: my ($file,$version,$shasum) = split(/,/,$line);
1.1264 raeburn 14766: if ($file =~ m{^/etc/httpd/conf}) {
14767: if ($webconfdir eq '/etc/apache2') {
14768: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
14769: }
14770: }
1.1238 raeburn 14771: $chksum{$file} = $shasum;
14772: $revnum{$file} = $version;
1.1210 raeburn 14773: }
14774: if (ref($hashref) eq 'HASH') {
14775: %{$hashref} = (
14776: sums => \%chksum,
14777: versions => \%revnum,
14778: );
14779: }
14780: }
14781: }
1.869 albertel 14782: return;
1.852 albertel 14783: }
1.1210 raeburn 14784:
14785: sub fetch_dns_checksums {
1.1238 raeburn 14786: my %checksums;
14787: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1260 raeburn 14788: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238 raeburn 14789: my ($release,$timestamp) = split(/\-/,$loncaparev);
14790: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211 raeburn 14791: \%checksums);
1.1210 raeburn 14792: return \%checksums;
14793: }
14794:
1.1379 raeburn 14795: sub fetch_crl_pemfile {
14796: return &get_dns("/adm/dns/loncapaCRL",\&save_crl_pem,1,1);
14797: }
14798:
14799: sub save_crl_pem {
1.1456 raeburn 14800: my ($content) = @_;
1.1380 raeburn 14801: my ($msg,$hadchanges);
1.1456 raeburn 14802: if ($content ne '') {
1.1379 raeburn 14803: my $now = time;
14804: my $lonca = $perlvar{'lonCertificateDirectory'}.'/'.$perlvar{'lonnetCertificateAuthority'};
14805: my $tmpcrl = $tmpdir.'/'.$perlvar{'lonnetCertRevocationList'}.'_'.$now.'.'.$$.'.tmp';
14806: if (open(my $fh,'>',"$tmpcrl")) {
1.1456 raeburn 14807: print $fh $content;
1.1379 raeburn 14808: close($fh);
14809: if (-e $lonca) {
14810: if (open(PIPE,"openssl crl -in $tmpcrl -inform pem -CAfile $lonca -noout 2>&1 |")) {
14811: my $check = <PIPE>;
14812: close(PIPE);
14813: chomp($check);
14814: if ($check eq 'verify OK') {
14815: my $dest = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
1.1380 raeburn 14816: my $backup;
1.1379 raeburn 14817: if (-e $dest) {
1.1380 raeburn 14818: if (&File::Copy::move($dest,"$dest.bak")) {
14819: $backup = 'ok';
14820: }
1.1379 raeburn 14821: }
14822: if (&File::Copy::move($tmpcrl,$dest)) {
14823: $msg = 'ok';
1.1380 raeburn 14824: if ($backup) {
14825: my (%oldnums,%newnums);
14826: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest.bak |grep 'Serial Number' |")) {
14827: while (<PIPE>) {
14828: $oldnums{(split(/:/))[1]} = 1;
14829: }
14830: close(PIPE);
14831: }
14832: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest |grep 'Serial Number' |")) {
14833: while(<PIPE>) {
14834: $newnums{(split(/:/))[1]} = 1;
14835: }
14836: close(PIPE);
14837: }
14838: foreach my $key (sort {$b <=> $a } (keys(%newnums))) {
14839: unless (exists($oldnums{$key})) {
14840: $hadchanges = 1;
14841: last;
14842: }
14843: }
14844: unless ($hadchanges) {
14845: foreach my $key (sort {$b <=> $a } (keys(%oldnums))) {
14846: unless (exists($newnums{$key})) {
14847: $hadchanges = 1;
14848: last;
14849: }
14850: }
14851: }
14852: }
1.1379 raeburn 14853: }
14854: } else {
14855: unlink($tmpcrl);
14856: }
14857: } else {
14858: unlink($tmpcrl);
14859: }
14860: } else {
14861: unlink($tmpcrl);
14862: }
14863: }
14864: }
1.1380 raeburn 14865: return ($msg,$hadchanges);
1.1379 raeburn 14866: }
14867:
1.1456 raeburn 14868: sub parse_getdns_url {
14869: my ($command,$url) = @_;
14870: my $dir = $perlvar{'lonTabDir'};
14871: my $file;
14872: if ($command eq 'hosts') {
14873: $file = 'dns_hosts.tab';
14874: } elsif ($command eq 'domain') {
14875: $file = 'dns_domain.tab';
14876: } elsif ($command eq 'checksums') {
14877: my $version = (split('/',$url))[4];
14878: $file = "dns_checksums/$version.tab",
14879: } elsif ($command eq 'loncapaCRL') {
14880: $dir = $perlvar{'lonCertificateDirectory'};
14881: $file = $perlvar{'lonnetCertRevocationList'};
14882: }
14883: return ($dir,$file);
14884: }
14885:
1.327 albertel 14886: # ------------------------------------------------------------ Read domain file
14887: {
1.852 albertel 14888: my $loaded;
1.846 albertel 14889: my %domain;
14890:
1.852 albertel 14891: sub parse_domain_tab {
14892: my ($lines) = @_;
14893: foreach my $line (@$lines) {
14894: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 14895:
1.846 albertel 14896: chomp($line);
1.852 albertel 14897: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 14898: my %this_domain;
14899: foreach my $field ('description', 'auth_def', 'auth_arg_def',
14900: 'lang_def', 'city', 'longi', 'lati',
14901: 'primary') {
14902: $this_domain{$field} = shift(@elements);
14903: }
14904: $domain{$name} = \%this_domain;
1.852 albertel 14905: }
14906: }
1.864 albertel 14907:
14908: sub reset_domain_info {
14909: undef($loaded);
14910: undef(%domain);
14911: }
14912:
1.852 albertel 14913: sub load_domain_tab {
1.1293 raeburn 14914: my ($ignore_cache,$nocache) = @_;
14915: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 14916: my $fh;
1.1359 raeburn 14917: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
1.852 albertel 14918: my @lines = <$fh>;
14919: &parse_domain_tab(\@lines);
1.448 albertel 14920: }
1.852 albertel 14921: close($fh);
14922: $loaded = 1;
1.327 albertel 14923: }
1.846 albertel 14924:
14925: sub domain {
1.852 albertel 14926: &load_domain_tab() if (!$loaded);
14927:
1.846 albertel 14928: my ($name,$what) = @_;
14929: return if ( !exists($domain{$name}) );
14930:
14931: if (!$what) {
14932: return $domain{$name}{'description'};
14933: }
14934: return $domain{$name}{$what};
14935: }
1.974 raeburn 14936:
14937: sub domain_info {
14938: &load_domain_tab() if (!$loaded);
14939: return %domain;
14940: }
14941:
1.327 albertel 14942: }
14943:
14944:
1.1 albertel 14945: # ------------------------------------------------------------- Read hosts file
14946: {
1.838 albertel 14947: my %hostname;
1.844 albertel 14948: my %hostdom;
1.845 albertel 14949: my %libserv;
1.852 albertel 14950: my $loaded;
1.888 albertel 14951: my %name_to_host;
1.1074 raeburn 14952: my %internetdom;
1.1107 raeburn 14953: my %LC_dns_serv;
1.852 albertel 14954:
14955: sub parse_hosts_tab {
14956: my ($file) = @_;
14957: foreach my $configline (@$file) {
14958: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 14959: chomp($configline);
14960: if ($configline =~ /^\^/) {
14961: if ($configline =~ /^\^([\w.\-]+)/) {
14962: $LC_dns_serv{$1} = 1;
14963: }
14964: next;
14965: }
1.1074 raeburn 14966: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 14967: $name=~s/\s//g;
14968: if ($id && $domain && $role && $name) {
1.1351 raeburn 14969: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
14970: my $curr = $hostname{$id};
14971: my $skip;
14972: if (ref($name_to_host{$curr}) eq 'ARRAY') {
14973: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
14974: $skip = 1;
14975: } else {
14976: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
14977: }
14978: }
14979: unless ($skip) {
14980: push(@{$name_to_host{$name}},$id);
14981: }
14982: } else {
14983: push(@{$name_to_host{$name}},$id);
14984: }
1.852 albertel 14985: $hostname{$id}=$name;
14986: $hostdom{$id}=$domain;
14987: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 14988: if (defined($protocol)) {
14989: if ($protocol eq 'https') {
14990: $protocol{$id} = $protocol;
14991: } else {
14992: $protocol{$id} = 'http';
14993: }
1.968 raeburn 14994: } else {
1.969 raeburn 14995: $protocol{$id} = 'http';
1.968 raeburn 14996: }
1.1074 raeburn 14997: if (defined($intdom)) {
14998: $internetdom{$id} = $intdom;
14999: }
1.852 albertel 15000: }
15001: }
15002: }
1.864 albertel 15003:
15004: sub reset_hosts_info {
1.897 albertel 15005: &purge_remembered();
1.864 albertel 15006: &reset_domain_info();
15007: &reset_hosts_ip_info();
1.1339 raeburn 15008: undef(%internetdom);
1.892 albertel 15009: undef(%name_to_host);
1.864 albertel 15010: undef(%hostname);
15011: undef(%hostdom);
15012: undef(%libserv);
15013: undef($loaded);
15014: }
1.1 albertel 15015:
1.852 albertel 15016: sub load_hosts_tab {
1.1293 raeburn 15017: my ($ignore_cache,$nocache) = @_;
15018: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.1359 raeburn 15019: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852 albertel 15020: my @config = <$config>;
15021: &parse_hosts_tab(\@config);
15022: close($config);
15023: $loaded=1;
1.1 albertel 15024: }
1.852 albertel 15025:
1.838 albertel 15026: sub hostname {
1.852 albertel 15027: &load_hosts_tab() if (!$loaded);
15028:
1.838 albertel 15029: my ($lonid) = @_;
15030: return $hostname{$lonid};
15031: }
1.845 albertel 15032:
1.838 albertel 15033: sub all_hostnames {
1.852 albertel 15034: &load_hosts_tab() if (!$loaded);
15035:
1.838 albertel 15036: return %hostname;
15037: }
1.845 albertel 15038:
1.888 albertel 15039: sub all_names {
1.1293 raeburn 15040: my ($ignore_cache,$nocache) = @_;
15041: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 15042:
15043: return %name_to_host;
15044: }
15045:
1.974 raeburn 15046: sub all_host_domain {
15047: &load_hosts_tab() if (!$loaded);
15048: return %hostdom;
15049: }
15050:
1.1339 raeburn 15051: sub all_host_intdom {
15052: &load_hosts_tab() if (!$loaded);
15053: return %internetdom;
15054: }
15055:
1.845 albertel 15056: sub is_library {
1.852 albertel 15057: &load_hosts_tab() if (!$loaded);
15058:
1.845 albertel 15059: return exists($libserv{$_[0]});
15060: }
15061:
15062: sub all_library {
1.852 albertel 15063: &load_hosts_tab() if (!$loaded);
15064:
1.845 albertel 15065: return %libserv;
15066: }
15067:
1.1062 droeschl 15068: sub unique_library {
15069: #2x reverse removes all hostnames that appear more than once
15070: my %unique = reverse &all_library();
15071: return reverse %unique;
15072: }
15073:
1.841 albertel 15074: sub get_servers {
1.852 albertel 15075: &load_hosts_tab() if (!$loaded);
15076:
1.841 albertel 15077: my ($domain,$type) = @_;
15078: my %possible_hosts = ($type eq 'library') ? %libserv
15079: : %hostname;
15080: my %result;
1.842 albertel 15081: if (ref($domain) eq 'ARRAY') {
15082: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 15083: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 15084: $result{$host} = $hostname;
15085: }
15086: }
15087: } else {
15088: while ( my ($host,$hostname) = each(%possible_hosts)) {
15089: if ($hostdom{$host} eq $domain) {
15090: $result{$host} = $hostname;
15091: }
1.841 albertel 15092: }
15093: }
15094: return %result;
15095: }
1.845 albertel 15096:
1.1062 droeschl 15097: sub get_unique_servers {
15098: my %unique = reverse &get_servers(@_);
15099: return reverse %unique;
15100: }
15101:
1.844 albertel 15102: sub host_domain {
1.852 albertel 15103: &load_hosts_tab() if (!$loaded);
15104:
1.844 albertel 15105: my ($lonid) = @_;
15106: return $hostdom{$lonid};
15107: }
15108:
1.841 albertel 15109: sub all_domains {
1.852 albertel 15110: &load_hosts_tab() if (!$loaded);
15111:
1.841 albertel 15112: my %seen;
15113: my @uniq = grep(!$seen{$_}++, values(%hostdom));
15114: return @uniq;
15115: }
1.1074 raeburn 15116:
15117: sub internet_dom {
15118: &load_hosts_tab() if (!$loaded);
15119:
15120: my ($lonid) = @_;
15121: return $internetdom{$lonid};
15122: }
1.1107 raeburn 15123:
15124: sub is_LC_dns {
15125: &load_hosts_tab() if (!$loaded);
15126:
15127: my ($hostname) = @_;
15128: return exists($LC_dns_serv{$hostname});
15129: }
15130:
1.1 albertel 15131: }
15132:
1.847 albertel 15133: {
15134: my %iphost;
1.856 albertel 15135: my %name_to_ip;
15136: my %lonid_to_ip;
1.869 albertel 15137:
1.847 albertel 15138: sub get_hosts_from_ip {
15139: my ($ip) = @_;
15140: my %iphosts = &get_iphost();
15141: if (ref($iphosts{$ip})) {
15142: return @{$iphosts{$ip}};
15143: }
15144: return;
1.839 albertel 15145: }
1.864 albertel 15146:
15147: sub reset_hosts_ip_info {
15148: undef(%iphost);
15149: undef(%name_to_ip);
15150: undef(%lonid_to_ip);
15151: }
1.856 albertel 15152:
15153: sub get_host_ip {
15154: my ($lonid) = @_;
15155: if (exists($lonid_to_ip{$lonid})) {
15156: return $lonid_to_ip{$lonid};
15157: }
15158: my $name=&hostname($lonid);
15159: my $ip = gethostbyname($name);
15160: return if (!$ip || length($ip) ne 4);
15161: $ip=inet_ntoa($ip);
15162: $name_to_ip{$name} = $ip;
15163: $lonid_to_ip{$lonid} = $ip;
15164: return $ip;
15165: }
1.847 albertel 15166:
15167: sub get_iphost {
1.1293 raeburn 15168: my ($ignore_cache,$nocache) = @_;
1.894 albertel 15169:
1.869 albertel 15170: if (!$ignore_cache) {
15171: if (%iphost) {
15172: return %iphost;
15173: }
15174: my ($ip_info,$cached)=
15175: &Apache::lonnet::is_cached_new('iphost','iphost');
15176: if ($cached) {
15177: %iphost = %{$ip_info->[0]};
15178: %name_to_ip = %{$ip_info->[1]};
15179: %lonid_to_ip = %{$ip_info->[2]};
15180: return %iphost;
15181: }
15182: }
1.894 albertel 15183:
15184: # get yesterday's info for fallback
15185: my %old_name_to_ip;
15186: my ($ip_info,$cached)=
15187: &Apache::lonnet::is_cached_new('iphost','iphost');
15188: if ($cached) {
15189: %old_name_to_ip = %{$ip_info->[1]};
15190: }
15191:
1.1293 raeburn 15192: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 15193: foreach my $name (keys(%name_to_host)) {
1.847 albertel 15194: my $ip;
15195: if (!exists($name_to_ip{$name})) {
15196: $ip = gethostbyname($name);
15197: if (!$ip || length($ip) ne 4) {
1.894 albertel 15198: if (defined($old_name_to_ip{$name})) {
15199: $ip = $old_name_to_ip{$name};
15200: &logthis("Can't find $name defaulting to old $ip");
15201: } else {
15202: &logthis("Name $name no IP found");
15203: next;
15204: }
15205: } else {
15206: $ip=inet_ntoa($ip);
1.847 albertel 15207: }
15208: $name_to_ip{$name} = $ip;
15209: } else {
15210: $ip = $name_to_ip{$name};
1.653 albertel 15211: }
1.888 albertel 15212: foreach my $id (@{ $name_to_host{$name} }) {
15213: $lonid_to_ip{$id} = $ip;
15214: }
15215: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 15216: }
1.1293 raeburn 15217: unless ($nocache) {
15218: &do_cache_new('iphost','iphost',
15219: [\%iphost,\%name_to_ip,\%lonid_to_ip],
15220: 48*60*60);
15221: }
1.869 albertel 15222:
1.847 albertel 15223: return %iphost;
1.598 albertel 15224: }
15225:
1.992 raeburn 15226: #
15227: # Given a DNS returns the loncapa host name for that DNS
15228: #
15229: sub host_from_dns {
15230: my ($dns) = @_;
15231: my @hosts;
15232: my $ip;
15233:
1.993 raeburn 15234: if (exists($name_to_ip{$dns})) {
1.992 raeburn 15235: $ip = $name_to_ip{$dns};
15236: }
15237: if (!$ip) {
15238: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
15239: if (length($ip) == 4) {
15240: $ip = &IO::Socket::inet_ntoa($ip);
15241: }
15242: }
15243: if ($ip) {
15244: @hosts = get_hosts_from_ip($ip);
15245: return $hosts[0];
15246: }
15247: return undef;
1.986 foxr 15248: }
1.992 raeburn 15249:
1.1074 raeburn 15250: sub get_internet_names {
15251: my ($lonid) = @_;
15252: return if ($lonid eq '');
15253: my ($idnref,$cached)=
15254: &Apache::lonnet::is_cached_new('internetnames',$lonid);
15255: if ($cached) {
15256: return $idnref;
15257: }
15258: my $ip = &get_host_ip($lonid);
15259: my @hosts = &get_hosts_from_ip($ip);
15260: my %iphost = &get_iphost();
15261: my (@idns,%seen);
15262: foreach my $id (@hosts) {
15263: my $dom = &host_domain($id);
15264: my $prim_id = &domain($dom,'primary');
15265: my $prim_ip = &get_host_ip($prim_id);
15266: next if ($seen{$prim_ip});
15267: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
15268: foreach my $id (@{$iphost{$prim_ip}}) {
15269: my $intdom = &internet_dom($id);
15270: unless (grep(/^\Q$intdom\E$/,@idns)) {
15271: push(@idns,$intdom);
15272: }
15273: }
15274: }
15275: $seen{$prim_ip} = 1;
15276: }
1.1219 raeburn 15277: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 15278: }
15279:
1.986 foxr 15280: }
15281:
1.1079 raeburn 15282: sub all_loncaparevs {
1.1249 raeburn 15283: 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 15284: }
15285:
1.1227 raeburn 15286: # ---------------------------------------------------------- Read loncaparev table
15287: {
15288: sub load_loncaparevs {
15289: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
1.1359 raeburn 15290: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
1.1227 raeburn 15291: while (my $configline=<$config>) {
15292: chomp($configline);
15293: my ($hostid,$loncaparev)=split(/:/,$configline);
15294: $loncaparevs{$hostid}=$loncaparev;
15295: }
15296: close($config);
15297: }
15298: }
15299: }
15300: }
15301:
15302: # ---------------------------------------------------------- Read serverhostID table
15303: {
15304: sub load_serverhomeIDs {
15305: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
1.1359 raeburn 15306: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
1.1227 raeburn 15307: while (my $configline=<$config>) {
15308: chomp($configline);
15309: my ($name,$id)=split(/:/,$configline);
15310: $serverhomeIDs{$name}=$id;
15311: }
15312: close($config);
15313: }
15314: }
15315: }
15316: }
15317:
15318:
1.862 albertel 15319: BEGIN {
15320:
15321: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
15322: unless ($readit) {
15323: {
15324: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
15325: %perlvar = (%perlvar,%{$configvars});
15326: }
15327:
15328:
1.1 albertel 15329: # ------------------------------------------------------ Read spare server file
15330: {
1.1359 raeburn 15331: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 15332:
15333: while (my $configline=<$config>) {
15334: chomp($configline);
1.284 matthew 15335: if ($configline) {
1.784 albertel 15336: my ($host,$type) = split(':',$configline,2);
1.785 albertel 15337: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 15338: push(@{ $spareid{$type} }, $host);
1.1 albertel 15339: }
15340: }
1.448 albertel 15341: close($config);
1.1 albertel 15342: }
1.11 www 15343: # ------------------------------------------------------------ Read permissions
15344: {
1.1359 raeburn 15345: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
1.11 www 15346:
15347: while (my $configline=<$config>) {
1.448 albertel 15348: chomp($configline);
15349: if ($configline) {
15350: my ($role,$perm)=split(/ /,$configline);
15351: if ($perm ne '') { $pr{$role}=$perm; }
15352: }
1.11 www 15353: }
1.448 albertel 15354: close($config);
1.11 www 15355: }
15356:
15357: # -------------------------------------------- Read plain texts for permissions
15358: {
1.1359 raeburn 15359: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 15360:
15361: while (my $configline=<$config>) {
1.448 albertel 15362: chomp($configline);
15363: if ($configline) {
1.742 raeburn 15364: my ($short,@plain)=split(/:/,$configline);
15365: %{$prp{$short}} = ();
15366: if (@plain > 0) {
15367: $prp{$short}{'std'} = $plain[0];
15368: for (my $i=1; $i<@plain; $i++) {
15369: $prp{$short}{'alt'.$i} = $plain[$i];
15370: }
15371: }
1.448 albertel 15372: }
1.135 www 15373: }
1.448 albertel 15374: close($config);
1.135 www 15375: }
15376:
15377: # ---------------------------------------------------------- Read package table
15378: {
1.1359 raeburn 15379: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
1.135 www 15380:
15381: while (my $configline=<$config>) {
1.483 albertel 15382: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 15383: chomp($configline);
15384: my ($short,$plain)=split(/:/,$configline);
15385: my ($pack,$name)=split(/\&/,$short);
15386: if ($plain ne '') {
15387: $packagetab{$pack.'&'.$name.'&name'}=$name;
15388: $packagetab{$short}=$plain;
15389: }
1.11 www 15390: }
1.448 albertel 15391: close($config);
1.329 matthew 15392: }
15393:
1.1073 raeburn 15394: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 15395:
15396: &load_loncaparevs();
1.1073 raeburn 15397:
1.1074 raeburn 15398: # ---------------------------------------------------------- Read serverhostID table
15399:
1.1227 raeburn 15400: &load_serverhomeIDs();
15401:
15402: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 15403: {
15404: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
15405: if (-e $file) {
15406: my $parser = HTML::LCParser->new($file);
15407: while (my $token = $parser->get_token()) {
15408: if ($token->[0] eq 'S') {
15409: my $item = $token->[1];
15410: my $name = $token->[2]{'name'};
15411: my $value = $token->[2]{'value'};
1.1285 raeburn 15412: my $valuematch = $token->[2]{'valuematch'};
1.1303 raeburn 15413: my $namematch = $token->[2]{'namematch'};
15414: if ($item eq 'parameter') {
15415: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
15416: my $release = $parser->get_text();
15417: $release =~ s/(^\s*|\s*$ )//gx;
15418: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
15419: }
15420: } elsif ($item ne '' && $name ne '') {
1.1079 raeburn 15421: my $release = $parser->get_text();
15422: $release =~ s/(^\s*|\s*$ )//gx;
1.1303 raeburn 15423: $needsrelease{$item.':'.$name.':'.$value} = $release;
1.1079 raeburn 15424: }
15425: }
15426: }
15427: }
1.1073 raeburn 15428: }
15429:
1.1138 raeburn 15430: # ---------------------------------------------------------- Read managers table
15431: {
15432: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
1.1359 raeburn 15433: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
1.1138 raeburn 15434: while (my $configline=<$config>) {
15435: chomp($configline);
15436: next if ($configline =~ /^\#/);
15437: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
15438: $managerstab{$configline} = 1;
15439: }
15440: }
15441: close($config);
15442: }
15443: }
15444: }
15445:
1.329 matthew 15446: # ------------- set up temporary directory
15447: {
1.1117 foxr 15448: $tmpdir = LONCAPA::tempdir();
1.329 matthew 15449:
1.11 www 15450: }
15451:
1.1405 raeburn 15452: # ------------- set default texengine (domain default overrides this)
15453: {
15454: $deftex = LONCAPA::texengine();
15455: }
15456:
1.1416 raeburn 15457: # ------------- set default minimum length for passwords for internal auth users
15458: {
15459: $passwdmin = LONCAPA::passwd_min();
15460: }
15461:
1.794 albertel 15462: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
15463: 'compress_threshold'=> 20_000,
15464: });
1.185 www 15465:
1.281 www 15466: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 15467: $dumpcount=0;
1.958 www 15468: $locknum=0;
1.22 www 15469:
1.163 harris41 15470: &logtouch();
1.672 albertel 15471: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 15472: $readit=1;
1.564 albertel 15473: {
15474: use integer;
15475: my $test=(2**32)+1;
1.568 albertel 15476: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 15477: &logthis(" Detected 64bit platform ($_64bit)");
15478: }
1.195 www 15479: }
1.1 albertel 15480: }
1.179 www 15481:
1.1 albertel 15482: 1;
1.191 harris41 15483: __END__
15484:
1.243 albertel 15485: =pod
15486:
1.191 harris41 15487: =head1 NAME
15488:
1.243 albertel 15489: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 15490:
15491: =head1 SYNOPSIS
15492:
1.243 albertel 15493: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 15494:
15495: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
15496:
1.243 albertel 15497: Common parameters:
15498:
15499: =over 4
15500:
15501: =item *
15502:
15503: $uname : an internal username (if $cname expecting a course Id specifically)
15504:
15505: =item *
15506:
15507: $udom : a domain (if $cdom expecting a course's domain specifically)
15508:
15509: =item *
15510:
15511: $symb : a resource instance identifier
15512:
15513: =item *
15514:
15515: $namespace : the name of a .db file that contains the data needed or
15516: being set.
15517:
15518: =back
15519:
1.394 bowersj2 15520: =head1 OVERVIEW
1.191 harris41 15521:
1.394 bowersj2 15522: lonnet provides subroutines which interact with the
15523: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
15524: about classes, users, and resources.
1.243 albertel 15525:
15526: For many of these objects you can also use this to store data about
15527: them or modify them in various ways.
1.191 harris41 15528:
1.394 bowersj2 15529: =head2 Symbs
1.191 harris41 15530:
1.394 bowersj2 15531: To identify a specific instance of a resource, LON-CAPA uses symbols
15532: or "symbs"X<symb>. These identifiers are built from the URL of the
15533: map, the resource number of the resource in the map, and the URL of
15534: the resource itself. The latter is somewhat redundant, but might help
15535: if maps change.
15536:
15537: An example is
15538:
15539: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
15540:
15541: The respective map entry is
15542:
15543: <resource id="19" src="/res/msu/korte/tests/part12.problem"
15544: title="Problem 2">
15545: </resource>
15546:
15547: Symbs are used by the random number generator, as well as to store and
15548: restore data specific to a certain instance of for example a problem.
15549:
15550: =head2 Storing And Retrieving Data
15551:
15552: X<store()>X<cstore()>X<restore()>Three of the most important functions
15553: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
15554: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
15555: is is the non-critical message twin of cstore. These functions are for
15556: handlers to store a perl hash to a user's permanent data space in an
15557: easy manner, and to retrieve it again on another call. It is expected
15558: that a handler would use this once at the beginning to retrieve data,
15559: and then again once at the end to send only the new data back.
15560:
15561: The data is stored in the user's data directory on the user's
15562: homeserver under the ID of the course.
15563:
15564: The hash that is returned by restore will have all of the previous
15565: value for all of the elements of the hash.
15566:
15567: Example:
15568:
15569: #creating a hash
15570: my %hash;
15571: $hash{'foo'}='bar';
15572:
15573: #storing it
15574: &Apache::lonnet::cstore(\%hash);
15575:
15576: #changing a value
15577: $hash{'foo'}='notbar';
15578:
15579: #adding a new value
15580: $hash{'bar'}='foo';
15581: &Apache::lonnet::cstore(\%hash);
15582:
15583: #retrieving the hash
15584: my %history=&Apache::lonnet::restore();
15585:
15586: #print the hash
15587: foreach my $key (sort(keys(%history))) {
15588: print("\%history{$key} = $history{$key}");
15589: }
15590:
15591: Will print out:
1.191 harris41 15592:
1.394 bowersj2 15593: %history{1:foo} = bar
15594: %history{1:keys} = foo:timestamp
15595: %history{1:timestamp} = 990455579
15596: %history{2:bar} = foo
15597: %history{2:foo} = notbar
15598: %history{2:keys} = foo:bar:timestamp
15599: %history{2:timestamp} = 990455580
15600: %history{bar} = foo
15601: %history{foo} = notbar
15602: %history{timestamp} = 990455580
15603: %history{version} = 2
15604:
15605: Note that the special hash entries C<keys>, C<version> and
15606: C<timestamp> were added to the hash. C<version> will be equal to the
15607: total number of versions of the data that have been stored. The
15608: C<timestamp> attribute will be the UNIX time the hash was
15609: stored. C<keys> is available in every historical section to list which
15610: keys were added or changed at a specific historical revision of a
15611: hash.
15612:
15613: B<Warning>: do not store the hash that restore returns directly. This
15614: will cause a mess since it will restore the historical keys as if the
15615: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 15616:
1.394 bowersj2 15617: Calling convention:
1.191 harris41 15618:
1.1225 raeburn 15619: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269 raeburn 15620: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 15621:
1.394 bowersj2 15622: For more detailed information, see lonnet specific documentation.
1.191 harris41 15623:
1.394 bowersj2 15624: =head1 RETURN MESSAGES
1.191 harris41 15625:
1.394 bowersj2 15626: =over 4
1.191 harris41 15627:
1.394 bowersj2 15628: =item * B<con_lost>: unable to contact remote host
1.191 harris41 15629:
1.394 bowersj2 15630: =item * B<con_delayed>: unable to contact remote host, message will be delivered
15631: when the connection is brought back up
1.191 harris41 15632:
1.394 bowersj2 15633: =item * B<con_failed>: unable to contact remote host and unable to save message
15634: for later delivery
1.191 harris41 15635:
1.967 bisitz 15636: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 15637:
1.394 bowersj2 15638: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 15639: that was requested
1.191 harris41 15640:
1.243 albertel 15641: =back
1.191 harris41 15642:
1.243 albertel 15643: =head1 PUBLIC SUBROUTINES
1.191 harris41 15644:
1.243 albertel 15645: =head2 Session Environment Functions
1.191 harris41 15646:
1.243 albertel 15647: =over 4
1.191 harris41 15648:
1.394 bowersj2 15649: =item *
15650: X<appenv()>
1.949 raeburn 15651: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 15652: the user envirnoment file, and will be restored for each access this
1.620 albertel 15653: user makes during this session, also modifies the %env for the current
1.949 raeburn 15654: process. Optional rolesarrayref - if defined contains a reference to an array
15655: of roles which are exempt from the restriction on modifying user.role entries
15656: in the user's environment.db and in %env.
1.191 harris41 15657:
15658: =item *
1.394 bowersj2 15659: X<delenv()>
1.987 raeburn 15660: B<delenv($delthis,$regexp)>: removes all items from the session
15661: environment file that begin with $delthis. If the
15662: optional second arg - $regexp - is true, $delthis is treated as a
15663: regular expression, otherwise \Q$delthis\E is used.
15664: The values are also deleted from the current processes %env.
1.191 harris41 15665:
1.795 albertel 15666: =item * get_env_multiple($name)
15667:
15668: gets $name from the %env hash, it seemlessly handles the cases where multiple
15669: values may be defined and end up as an array ref.
15670:
15671: returns an array of values
15672:
1.243 albertel 15673: =back
15674:
15675: =head2 User Information
1.191 harris41 15676:
1.243 albertel 15677: =over 4
1.191 harris41 15678:
15679: =item *
1.394 bowersj2 15680: X<queryauthenticate()>
15681: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 15682: authentication scheme
15683:
15684: =item *
1.394 bowersj2 15685: X<authenticate()>
1.1073 raeburn 15686: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 15687: authenticate user from domain's lib servers (first use the current
15688: one). C<$upass> should be the users password.
1.1073 raeburn 15689: $checkdefauth is optional (value is 1 if a check should be made to
15690: authenticate user using default authentication method, and allow
15691: account creation if username does not have account in the domain).
15692: $clientcancheckhost is optional (value is 1 if checking whether the
15693: server can host will occur on the client side in lonauth.pm).
1.191 harris41 15694:
15695: =item *
1.394 bowersj2 15696: X<homeserver()>
15697: B<homeserver($uname,$udom)>: find the server which has
15698: the user's directory and files (there must be only one), this caches
15699: the answer, and also caches if there is a borken connection.
1.191 harris41 15700:
15701: =item *
1.394 bowersj2 15702: X<idget()>
1.1300 raeburn 15703: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
15704: a list of student/employee IDs or clicker IDs
15705: (student/employee IDs are a unique resource in a domain, there must be
15706: only 1 ID per username, and only 1 username per ID in a specific domain).
15707: clickerIDs are not necessarily unique, as students might share clickers.
15708: (returns hash: id=>name,id=>name)
1.191 harris41 15709:
15710: =item *
1.394 bowersj2 15711: X<idrget()>
15712: B<idrget($udom,@unames)>: find the IDs behind a list of
15713: usernames (returns hash: name=>id,name=>id)
1.191 harris41 15714:
15715: =item *
1.394 bowersj2 15716: X<idput()>
1.1300 raeburn 15717: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
15718: names and associated student/employee IDs or clicker IDs.
15719:
15720: =item *
15721: X<iddel()>
15722: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
15723: student/employee ID or clicker ID username look-ups from domain.
15724: The homeserver ($uhome) and namespace ($namespace) are optional.
15725: If no $uhome is provided, it will be determined usig &homeserver()
15726: for each user. If no $namespace is provided, the default is ids.
15727:
15728: =item *
15729: X<updateclickers()>
15730: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
15731: clicker ID-to-username look-ups in clickers.db on library server.
15732: Permitted actions are add or del (i.e., add or delete). The
15733: clickers.db contains clickerID as keys (escaped), and each corresponding
15734: value is an escaped comma-separated list of usernames (for whom the
15735: library server is the homeserver), who registered that particular ID.
15736: If $critical is true, the update will be sent via &critical, otherwise
15737: &reply() will be used.
1.191 harris41 15738:
15739: =item *
1.394 bowersj2 15740: X<rolesinit()>
1.1169 droeschl 15741: B<rolesinit($udom,$username)>: get user privileges.
15742: returns user role, first access and timer interval hashes
1.243 albertel 15743:
15744: =item *
1.1171 droeschl 15745: X<privileged()>
15746: B<privileged($username,$domain)>: returns a true if user has a
15747: privileged and active role (i.e. su or dc), false otherwise.
15748:
15749: =item *
1.551 albertel 15750: X<getsection()>
15751: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 15752: course $cname, return section name/number or '' for "not in course"
15753: and '-1' for "no section"
15754:
15755: =item *
1.394 bowersj2 15756: X<userenvironment()>
15757: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 15758: passed in @what from the requested user's environment, returns a hash
15759:
1.858 raeburn 15760: =item *
15761: X<userlog_query()>
1.859 albertel 15762: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
15763: activity.log file. %filters defines filters applied when parsing the
15764: log file. These can be start or end timestamps, or the type of action
15765: - log to look for Login or Logout events, check for Checkin or
15766: Checkout, role for role selection. The response is in the form
15767: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
15768: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 15769:
1.243 albertel 15770: =back
15771:
15772: =head2 User Roles
15773:
15774: =over 4
15775:
15776: =item *
15777:
1.1284 raeburn 15778: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
15779: returns codes for allowed actions.
15780:
15781: The first argument is required, all others are optional.
15782:
15783: $priv is the privilege being checked.
15784: $uri contains additional information about what is being checked for access (e.g.,
15785: URL, course ID etc.).
15786: $symb is the unique resource instance identifier in a course; if needed,
15787: but not provided, it will be retrieved via a call to &symbread().
15788: $role is the role for which a priv is being checked (only used if priv is evb).
15789: $clientip is the user's IP address (only used when checking for access to portfolio
15790: files).
15791: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
15792: prevents recursive calls to &allowed.
15793:
1.243 albertel 15794: F: full access
15795: U,I,K: authentication modes (cxx only)
15796: '': forbidden
15797: 1: user needs to choose course
15798: 2: browse allowed
1.766 albertel 15799: A: passphrase authentication needed
1.1284 raeburn 15800: B: access temporarily blocked because of a blocking event in a course.
1.1402 raeburn 15801: D: access blocked because access is required via session initiated via deep-link
1.243 albertel 15802:
15803: =item *
15804:
1.1192 raeburn 15805: constructaccess($url,$setpriv) : check for access to construction space URL
15806:
15807: See if the owner domain and name in the URL match those in the
15808: expected environment. If so, return three element list
15809: ($ownername,$ownerdomain,$ownerhome).
15810:
15811: Otherwise return the null string.
15812:
15813: If second argument 'setpriv' is true, it assigns the privileges,
15814: and returns the same three element list, unless the owner has
15815: blocked "ad hoc" Domain Coordinator access to the Author Space,
15816: in which case the null string is returned.
15817:
15818: =item *
15819:
1.1326 raeburn 15820: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
15821: define a custom role rolename set privileges in format of lonTabs/roles.tab
15822: for system, domain, and course level. $uname and $udom are optional (current
15823: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 15824:
15825: =item *
15826:
1.988 raeburn 15827: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
15828: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 15829: $type is Course (default) or Community.
1.988 raeburn 15830: If $forcedefault evaluates to true, text returned will be default
15831: text for $type. Otherwise, if this is a course, the text returned
15832: will be a custom name for the role (if defined in the course's
15833: environment). If no custom name is defined the default is returned.
15834:
1.832 raeburn 15835: =item *
15836:
1.1219 raeburn 15837: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 15838: All arguments are optional. Returns a hash of a roles, either for
15839: co-author/assistant author roles for a user's Construction Space
1.906 albertel 15840: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 15841: In the hash, keys are set to colon-separated $uname,$udom,$role, and
15842: (optionally) if $withsec is true, a fourth colon-separated item - $section.
15843: For each key, value is set to colon-separated start and end times for
15844: the role. If no username and domain are specified, will default to
1.934 raeburn 15845: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 15846: of role statuses (active, future or previous), roles
15847: (e.g., cc,in, st etc.) and domains of the roles which can be used
15848: to restrict the list of roles reported. If no array ref is
15849: provided for types, will default to return only active roles.
1.834 albertel 15850:
1.1195 raeburn 15851: =item *
15852:
15853: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 15854: user: $uname:$udom has a role in the course: $cdom_$cnum.
15855:
15856: Additional optional arguments are: $type (if role checking is to be restricted
15857: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 15858: available roles) or future (roles available in the future), and
15859: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 15860: have active Domain Coordinator role in course's domain or in additional
15861: domains (specified in 'Domains to check for privileged users' in course
15862: environment -- set via: Course Settings -> Classlists and staff listing).
15863:
15864: =item *
15865:
15866: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
15867: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
15868: $possdomains and $possroles are optional array refs -- to domains to check and
15869: roles to check. If $possdomains is not specified, a dump will be done of the
15870: users' roles.db to check for a dc or su role in any domain. This can be
15871: time consuming if &privileged is called repeatedly (e.g., when displaying a
15872: classlist), so in such cases, supplying a $possdomains array is preferred, as
15873: this then allows &privileged_by_domain() to be used, which caches the identity
15874: of privileged users, eliminating the need for repeated calls to &dump().
15875:
15876: =item *
15877:
15878: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
15879: where the outer hash keys are domains specified in the $possdomains array ref,
15880: next inner hash keys are privileged roles specified in the $roles array ref,
15881: and the innermost hash contains key = value pairs for username:domain = end:start
15882: for active or future "privileged" users with that role in that domain. To avoid
15883: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
15884: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 15885:
1.243 albertel 15886: =back
15887:
15888: =head2 User Modification
15889:
15890: =over 4
15891:
15892: =item *
15893:
1.957 raeburn 15894: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 15895: user for the level given by URL. Optional start and end dates (leave empty
15896: string or zero for "no date")
1.191 harris41 15897:
15898: =item *
15899:
1.243 albertel 15900: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
15901: change a users, password, possible return values are: ok,
15902: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
15903: refused
1.191 harris41 15904:
15905: =item *
15906:
1.243 albertel 15907: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 15908:
15909: =item *
15910:
1.1058 raeburn 15911: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
15912: $forceid,$desiredhome,$email,$inststatus,$candelete) :
15913:
15914: will update user information (firstname,middlename,lastname,generation,
15915: permanentemail), and if forceid is true, student/employee ID also.
15916: A user's institutional affiliation(s) can also be updated.
15917: User information fields will not be overwritten with empty entries
15918: unless the field is included in the $candelete array reference.
15919: This array is included when a single user is modified via "Manage Users",
15920: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 15921:
15922: =item *
15923:
1.286 matthew 15924: modifystudent
15925:
1.957 raeburn 15926: modify a student's enrollment and identification information.
1.1235 raeburn 15927: The course id is resolved based on the current user's environment.
15928: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 15929: associated with a course.
15930:
1.297 matthew 15931: This call is essentially a wrapper for lonnet::modifyuser and
15932: lonnet::modify_student_enrollment
1.286 matthew 15933:
15934: Inputs:
15935:
15936: =over 4
15937:
1.957 raeburn 15938: =item B<$udom> Student's loncapa domain
1.286 matthew 15939:
1.957 raeburn 15940: =item B<$uname> Student's loncapa login name
1.286 matthew 15941:
1.964 bisitz 15942: =item B<$uid> Student/Employee ID
1.286 matthew 15943:
1.957 raeburn 15944: =item B<$umode> Student's authentication mode
1.286 matthew 15945:
1.957 raeburn 15946: =item B<$upass> Student's password
1.286 matthew 15947:
1.957 raeburn 15948: =item B<$first> Student's first name
1.286 matthew 15949:
1.957 raeburn 15950: =item B<$middle> Student's middle name
1.286 matthew 15951:
1.957 raeburn 15952: =item B<$last> Student's last name
1.286 matthew 15953:
1.957 raeburn 15954: =item B<$gene> Student's generation
1.286 matthew 15955:
1.957 raeburn 15956: =item B<$usec> Student's section in course
1.286 matthew 15957:
15958: =item B<$end> Unix time of the roles expiration
15959:
15960: =item B<$start> Unix time of the roles start date
15961:
15962: =item B<$forceid> If defined, allow $uid to be changed
15963:
15964: =item B<$desiredhome> server to use as home server for student
15965:
1.957 raeburn 15966: =item B<$email> Student's permanent e-mail address
15967:
15968: =item B<$type> Type of enrollment (auto or manual)
15969:
1.963 raeburn 15970: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
15971:
15972: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 15973:
1.963 raeburn 15974: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 15975:
1.963 raeburn 15976: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 15977:
1.1216 raeburn 15978: =item B<$inststatus> institutional status of user - : separated string of escaped status types
15979:
15980: =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 15981:
1.286 matthew 15982: =back
1.297 matthew 15983:
15984: =item *
15985:
15986: modify_student_enrollment
15987:
1.1235 raeburn 15988: Change a student's enrollment status in a class. The environment variable
1.297 matthew 15989: 'role.request.course' must be defined for this function to proceed.
15990:
15991: Inputs:
15992:
15993: =over 4
15994:
1.1235 raeburn 15995: =item $udom, student's domain
1.297 matthew 15996:
1.1235 raeburn 15997: =item $uname, student's name
1.297 matthew 15998:
1.1235 raeburn 15999: =item $uid, student's user id
1.297 matthew 16000:
1.1235 raeburn 16001: =item $first, student's first name
1.297 matthew 16002:
16003: =item $middle
16004:
16005: =item $last
16006:
16007: =item $gene
16008:
16009: =item $usec
16010:
16011: =item $end
16012:
16013: =item $start
16014:
1.957 raeburn 16015: =item $type
16016:
16017: =item $locktype
16018:
16019: =item $cid
16020:
16021: =item $selfenroll
16022:
16023: =item $context
16024:
1.1216 raeburn 16025: =item $credits, number of credits student will earn from this class
16026:
1.1314 raeburn 16027: =item $instsec, institutional course section code for student
16028:
1.297 matthew 16029: =back
16030:
1.191 harris41 16031:
16032: =item *
16033:
1.243 albertel 16034: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
16035: custom role; give a custom role to a user for the level given by URL. Specify
16036: name and domain of role author, and role name
1.191 harris41 16037:
16038: =item *
16039:
1.243 albertel 16040: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 16041:
16042: =item *
16043:
1.243 albertel 16044: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
16045:
16046: =back
16047:
16048: =head2 Course Infomation
16049:
16050: =over 4
1.191 harris41 16051:
16052: =item *
16053:
1.1118 foxr 16054: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 16055: specified course id, including all environment settings for the
16056: course, the description of the course will be in the hash under the
16057: key 'description'
1.191 harris41 16058:
1.1118 foxr 16059: $options is an optional parameter that if supplied is a hash reference that controls
16060: what how this function works. It has the following key/values:
16061:
16062: =over 4
16063:
16064: =item freshen_cache
16065:
16066: If defined, and the environment cache for the course is valid, it is
16067: returned in the returned hash.
16068:
16069: =item one_time
16070:
16071: If defined, the last cache time is set to _now_
16072:
16073: =item user
16074:
16075: If defined, the supplied username is used instead of the current user.
16076:
16077:
16078: =back
16079:
1.191 harris41 16080: =item *
16081:
1.624 albertel 16082: resdata($name,$domain,$type,@which) : request for current parameter
16083: setting for a specific $type, where $type is either 'course' or 'user',
16084: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 16085: answers for 10 minutes.
1.243 albertel 16086:
1.877 foxr 16087: =item *
16088:
16089: get_courseresdata($courseid, $domain) : dump the entire course resource
16090: data base, returning a hash that is keyed by the resource name and has
16091: values that are the resource value. I believe that the timestamps and
16092: versions are also returned.
16093:
1.1236 raeburn 16094: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
16095: supplemental content area. This routine caches the number of files for
16096: 10 minutes.
16097:
1.243 albertel 16098: =back
16099:
16100: =head2 Course Modification
16101:
16102: =over 4
1.191 harris41 16103:
16104: =item *
16105:
1.243 albertel 16106: writecoursepref($courseid,%prefs) : write preferences (environment
16107: database) for a course
1.191 harris41 16108:
16109: =item *
16110:
1.1011 raeburn 16111: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
16112:
16113: =item *
16114:
1.1038 raeburn 16115: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 16116:
1.1167 droeschl 16117: =item *
16118:
16119: is_course($courseid), is_course($cdom, $cnum)
16120:
16121: Accepts either a combined $courseid (in the form of domain_courseid) or the
16122: two component version $cdom, $cnum. It checks if the specified course exists.
16123:
16124: Returns:
16125: undef if the course doesn't exist, otherwise
16126: in scalar context the combined courseid.
16127: in list context the two components of the course identifier, domain and
16128: courseid.
16129:
1.243 albertel 16130: =back
16131:
1.1401 raeburn 16132: =head2 Bubblesheet Configuration
16133:
16134: =over 4
16135:
16136: =item *
16137:
16138: get_scantron_config($which)
16139:
16140: $which - the name of the configuration to parse from the file.
16141:
16142: Parses and returns the bubblesheet configuration line selected as a
16143: hash of configuration file fields.
16144:
16145:
16146: Returns:
16147: If the named configuration is not in the file, an empty
16148: hash is returned.
16149:
16150: a hash with the fields
16151: name - internal name for the this configuration setup
16152: description - text to display to operator that describes this config
16153: CODElocation - if 0 or the string 'none'
16154: - no CODE exists for this config
16155: if -1 || the string 'letter'
16156: - a CODE exists for this config and is
16157: a string of letters
16158: Unsupported value (but planned for future support)
16159: if a positive integer
16160: - The CODE exists as the first n items from
16161: the question section of the form
16162: if the string 'number'
16163: - The CODE exists for this config and is
16164: a string of numbers
16165: CODEstart - (only matter if a CODE exists) column in the line where
16166: the CODE starts
16167: CODElength - length of the CODE
16168: IDstart - column where the student/employee ID starts
16169: IDlength - length of the student/employee ID info
16170: Qstart - column where the information from the bubbled
16171: 'questions' start
16172: Qlength - number of columns comprising a single bubble line from
16173: the sheet. (usually either 1 or 10)
16174: Qon - either a single character representing the character used
16175: to signal a bubble was chosen in the positional setup, or
16176: the string 'letter' if the letter of the chosen bubble is
16177: in the final, or 'number' if a number representing the
16178: chosen bubble is in the file (1->A 0->J)
16179: Qoff - the character used to represent that a bubble was
16180: left blank
16181: PaperID - if the scanning process generates a unique number for each
16182: sheet scanned the column that this ID number starts in
16183: PaperIDlength - number of columns that comprise the unique ID number
16184: for the sheet of paper
16185: FirstName - column that the first name starts in
16186: FirstNameLength - number of columns that the first name spans
16187: LastName - column that the last name starts in
16188: LastNameLength - number of columns that the last name spans
16189: BubblesPerRow - number of bubbles available in each row used to
16190: bubble an answer. (If not specified, 10 assumed).
16191:
16192:
16193: =item *
16194:
16195: get_scantronformat_file($cdom)
16196:
16197: $cdom - the course's domain (optional); if not supplied, uses
16198: domain for current $env{'request.course.id'}.
16199:
16200: Returns an array containing lines from the scantron format file for
16201: the domain of the course.
16202:
16203: If a url for a custom.tab file is listed in domain's configuration.db,
16204: lines are from this file.
16205:
16206: Otherwise, if a default.tab has been published in RES space by the
16207: domainconfig user, lines are from this file.
16208:
16209: Otherwise, fall back to getting lines from the legacy file on the
16210: local server: /home/httpd/lonTabs/default_scantronformat.tab
16211:
16212: =back
16213:
1.243 albertel 16214: =head2 Resource Subroutines
16215:
16216: =over 4
1.191 harris41 16217:
16218: =item *
16219:
1.243 albertel 16220: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 16221:
16222: =item *
16223:
1.243 albertel 16224: repcopy($filename) : subscribes to the requested file, and attempts to
16225: replicate from the owning library server, Might return
1.607 raeburn 16226: 'unavailable', 'not_found', 'forbidden', 'ok', or
16227: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 16228: resource. Expects the local filesystem pathname
16229: (/home/httpd/html/res/....)
16230:
16231: =back
16232:
16233: =head2 Resource Information
16234:
16235: =over 4
1.191 harris41 16236:
16237: =item *
16238:
1.1228 raeburn 16239: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
16240: and returns the value of a variety of different possible values,
16241: $varname should be a request string, and the other parameters can be
16242: used to specify who and what one is asking about. Ordinarily, $cid
16243: does not need to be specified, as it is retrived from
16244: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
16245: within lonuserstate::loadmap() when initializing a course, before
16246: $env{'request.course.id'} has been set, so it needs to be provided
16247: in that one case.
1.243 albertel 16248:
16249: Possible values for $varname are environment.lastname (or other item
16250: from the envirnment hash), user.name (or someother aspect about the
16251: user), resource.0.maxtries (or some other part and parameter of a
16252: resource)
1.204 albertel 16253:
16254: =item *
16255:
1.243 albertel 16256: directcondval($number) : get current value of a condition; reads from a state
16257: string
1.204 albertel 16258:
16259: =item *
16260:
1.243 albertel 16261: condval($condidx) : value of condition index based on state
1.204 albertel 16262:
16263: =item *
16264:
1.1362 raeburn 16265: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
1.243 albertel 16266: resource's metadata, $what should be either a specific key, or either
16267: 'keys' (to get a list of possible keys) or 'packages' to get a list of
1.1362 raeburn 16268: packages that this resource currently uses, the last 3 arguments are
16269: only used internally for recursive metadata.
16270:
16271: the toolsymb is only used where the uri is for an external tool (for which
16272: the uri as well as the symb are guaranteed to be unique).
1.243 albertel 16273:
1.1371 raeburn 16274: this function automatically caches all requests except any made recursively
16275: to retrieve a list of metadata keys for an imported library file ($liburi is
16276: defined).
1.191 harris41 16277:
16278: =item *
16279:
1.243 albertel 16280: metadata_query($query,$custom,$customshow) : make a metadata query against the
16281: network of library servers; returns file handle of where SQL and regex results
16282: will be stored for query
1.191 harris41 16283:
16284: =item *
16285:
1.1282 raeburn 16286: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
16287: return symbolic list entry (all arguments optional).
16288:
16289: Args: filename is the filename (including path) for the file for which a symb
16290: is required; donotrecurse, if true will prevent calls to allowed() being made
16291: to check access status if more than one resource was found in the bighash
16292: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
16293: a randompick); ignorecachednull, if true will prevent a symb of '' being
16294: returned if $env{$cache_str} is defined as ''; checkforblock if true will
16295: cause possible symbs to be checked to determine if they are subject to content
16296: blocking, if so they will not be included as possible symbs; possibles is a
16297: ref to a hash, which, as a side effect, will be populated with all possible
16298: symbs (content blocking not tested).
16299:
1.243 albertel 16300: returns the data handle
1.191 harris41 16301:
16302: =item *
16303:
1.1190 raeburn 16304: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
16305: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 16306: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 16307: on failure, user must be in a course, as it assumes the existence of
16308: the course initial hash, and uses $env('request.course.id'}. The third
16309: arg is an optional reference to a scalar. If this arg is passed in the
16310: call to symbverify, it will be set to 1 if the symb has been set to be
16311: encrypted; otherwise it will be null.
1.191 harris41 16312:
16313: =item *
16314:
1.243 albertel 16315: symbclean($symb) : removes versions numbers from a symb, returns the
16316: cleaned symb
1.191 harris41 16317:
16318: =item *
16319:
1.243 albertel 16320: is_on_map($uri) : checks if the $uri is somewhere on the current
16321: course map, user must be in a course for it to work.
1.191 harris41 16322:
16323: =item *
16324:
1.243 albertel 16325: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 16326:
16327: =item *
16328:
1.243 albertel 16329: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
16330: a random seed, all arguments are optional, if they aren't sent it uses the
16331: environment to derive them. Note: if symb isn't sent and it can't get one
16332: from &symbread it will use the current time as its return value
1.191 harris41 16333:
16334: =item *
16335:
1.243 albertel 16336: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
16337: unfakeable, receipt
1.191 harris41 16338:
16339: =item *
16340:
1.620 albertel 16341: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 16342:
16343: =item *
16344:
1.243 albertel 16345: countacc($url) : count the number of accesses to a given URL
1.191 harris41 16346:
16347: =item *
16348:
1.243 albertel 16349: 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 16350:
16351: =item *
16352:
1.243 albertel 16353: 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 16354:
16355: =item *
16356:
1.243 albertel 16357: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 16358:
16359: =item *
16360:
1.243 albertel 16361: devalidate($symb) : devalidate temporary spreadsheet calculations,
16362: forcing spreadsheet to reevaluate the resource scores next time.
16363:
1.1195 raeburn 16364: =item *
16365:
1.1196 raeburn 16366: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
16367: when viewing in course context.
1.1195 raeburn 16368:
1.1196 raeburn 16369: input: six args -- filename (decluttered), course number, course domain,
16370: url, symb (if registered) and group (if this is a
16371: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 16372:
1.1196 raeburn 16373: output: array of five scalars --
1.1195 raeburn 16374: $cfile -- url for file editing if editable on current server
16375: $home -- homeserver of resource (i.e., for author if published,
16376: or course if uploaded.).
16377: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 16378: $forceedit -- 1 if icon/link should be to go to edit mode
16379: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 16380:
16381: =item *
16382:
16383: is_course_upload($file,$cnum,$cdom)
16384:
16385: Used in course context to determine if current file was uploaded to
16386: the course (i.e., would be found in /userfiles/docs on the course's
16387: homeserver.
16388:
16389: input: 3 args -- filename (decluttered), course number and course domain.
16390: output: boolean -- 1 if file was uploaded.
16391:
1.243 albertel 16392: =back
16393:
16394: =head2 Storing/Retreiving Data
16395:
16396: =over 4
1.191 harris41 16397:
16398: =item *
16399:
1.1269 raeburn 16400: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
16401: permanently for this url; hashref needs to be given and should be a \%hashname;
16402: the remaining args aren't required and if they aren't passed or are '' they will
16403: be derived from the env (with the exception of $laststore, which is an
16404: optional arg used when a user's submission is stored in grading).
16405: $laststore is $version=$timestamp, where $version is the most recent version
16406: number retrieved for the corresponding $symb in the $namespace db file, and
16407: $timestamp is the timestamp for that transaction (UNIX time).
16408: $laststore is currently only passed when cstore() is called by
16409: structuretags::finalize_storage().
1.191 harris41 16410:
16411: =item *
16412:
1.1269 raeburn 16413: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
16414: but uses critical subroutine
1.191 harris41 16415:
16416: =item *
16417:
1.243 albertel 16418: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
16419: all args are optional
1.191 harris41 16420:
16421: =item *
16422:
1.717 albertel 16423: dumpstore($namespace,$udom,$uname,$regexp,$range) :
16424: dumps the complete (or key matching regexp) namespace into a hash
16425: ($udom, $uname, $regexp, $range are optional) for a namespace that is
16426: normally &store()ed into
16427:
16428: $range should be either an integer '100' (give me the first 100
16429: matching records)
16430: or be two integers sperated by a - with no spaces
16431: '30-50' (give me the 30th through the 50th matching
16432: records)
16433:
16434:
16435: =item *
16436:
1.1269 raeburn 16437: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 16438: replaces a &store() version of data with a replacement set of data
16439: for a particular resource in a namespace passed in the $storehash hash
1.1269 raeburn 16440: reference. If $tolog is true, the transaction is logged in the courselog
16441: with an action=PUTSTORE.
1.717 albertel 16442:
16443: =item *
16444:
1.243 albertel 16445: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
16446: works very similar to store/cstore, but all data is stored in a
16447: temporary location and can be reset using tmpreset, $storehash should
16448: be a hash reference, returns nothing on success
1.191 harris41 16449:
16450: =item *
16451:
1.243 albertel 16452: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
16453: similar to restore, but all data is stored in a temporary location and
16454: can be reset using tmpreset. Returns a hash of values on success,
16455: error string otherwise.
1.191 harris41 16456:
16457: =item *
16458:
1.243 albertel 16459: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
16460: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 16461:
16462: =item *
16463:
1.243 albertel 16464: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
16465: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 16466:
16467: =item *
16468:
1.243 albertel 16469: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
16470: namesp ($udom and $uname are optional)
1.191 harris41 16471:
16472: =item *
16473:
1.702 albertel 16474: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 16475: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 16476: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 16477:
1.702 albertel 16478: $range should be either an integer '100' (give me the first 100
16479: matching records)
16480: or be two integers sperated by a - with no spaces
16481: '30-50' (give me the 30th through the 50th matching
16482: records)
1.449 matthew 16483: =item *
16484:
16485: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
16486: $store can be a scalar, an array reference, or if the amount to be
16487: incremented is > 1, a hash reference.
16488:
16489: ($udom and $uname are optional)
1.191 harris41 16490:
16491: =item *
16492:
1.243 albertel 16493: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
16494: ($udom and $uname are optional)
1.191 harris41 16495:
16496: =item *
16497:
1.243 albertel 16498: cput($namespace,$storehash,$udom,$uname) : critical put
16499: ($udom and $uname are optional)
1.191 harris41 16500:
16501: =item *
16502:
1.748 albertel 16503: newput($namespace,$storehash,$udom,$uname) :
16504:
16505: Attempts to store the items in the $storehash, but only if they don't
16506: currently exist, if this succeeds you can be certain that you have
16507: successfully created a new key value pair in the $namespace db.
16508:
16509:
16510: Args:
16511: $namespace: name of database to store values to
16512: $storehash: hashref to store to the db
16513: $udom: (optional) domain of user containing the db
16514: $uname: (optional) name of user caontaining the db
16515:
16516: Returns:
16517: 'ok' -> succeeded in storing all keys of $storehash
16518: 'key_exists: <key>' -> failed to anything out of $storehash, as at
16519: least <key> already existed in the db (other
16520: requested keys may also already exist)
1.967 bisitz 16521: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 16522: 'con_lost' -> unable to contact request server
16523: 'refused' -> action was not allowed by remote machine
16524:
16525:
16526: =item *
16527:
1.243 albertel 16528: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
16529: reference filled in from namesp (encrypts the return communication)
16530: ($udom and $uname are optional)
1.191 harris41 16531:
16532: =item *
16533:
1.243 albertel 16534: log($udom,$name,$home,$message) : write to permanent log for user; use
16535: critical subroutine
16536:
1.806 raeburn 16537: =item *
16538:
1.860 raeburn 16539: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
16540: array reference filled in from namespace found in domain level on either
16541: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 16542:
16543: =item *
16544:
1.860 raeburn 16545: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
16546: domain level either on specified domain server ($uhome) or primary domain
16547: server ($udom and $uhome are optional)
1.806 raeburn 16548:
1.943 raeburn 16549: =item *
16550:
1.1240 raeburn 16551: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
16552: for: authentication, language, quotas, timezone, date locale, and portal URL in
16553: the target domain.
16554:
16555: May also include additional key => value pairs for the following groups:
16556:
16557: =over
16558:
16559: =item
16560: disk quotas (MB allocated by default to portfolios and authoring spaces).
16561:
16562: =over
16563:
16564: =item defaultquota, authorquota
16565:
16566: =back
16567:
16568: =item
16569: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
16570: portfolio for users).
16571:
16572: =over
16573:
16574: =item
16575: aboutme, blog, webdav, portfolio
16576:
16577: =back
16578:
16579: =item
16580: requestcourses: ability to request courses, and how requests are processed.
16581:
16582: =over
16583:
16584: =item
1.1305 raeburn 16585: official, unofficial, community, textbook, placement
1.1240 raeburn 16586:
16587: =back
16588:
16589: =item
16590: inststatus: types of institutional affiliation, and order in which they are displayed.
16591:
16592: =over
16593:
16594: =item
1.1256 raeburn 16595: inststatustypes, inststatusorder, inststatusguest
1.1240 raeburn 16596:
16597: =back
16598:
16599: =item
16600: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
16601: for course's uploaded content.
16602:
16603: =over
16604:
16605: =item
1.1246 raeburn 16606: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
1.1305 raeburn 16607: communityquota, textbookquota, placementquota
1.1240 raeburn 16608:
16609: =back
16610:
16611: =item
16612: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
16613: on your servers.
16614:
16615: =over
16616:
16617: =item
16618: remotesessions, hostedsessions
16619:
16620: =back
16621:
16622: =back
16623:
16624: In cases where a domain coordinator has never used the "Set Domain Configuration"
16625: utility to create a configuration.db file on a domain's primary library server
16626: only the following domain defaults: auth_def, auth_arg_def, lang_def
16627: -- corresponding values are authentication type (internal, krb4, krb5,
16628: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
16629: will be available. Values are retrieved from cache (if current), unless the
16630: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
16631: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
16632:
16633: Typical usage:
1.943 raeburn 16634:
1.1240 raeburn 16635: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 16636:
1.243 albertel 16637: =back
16638:
16639: =head2 Network Status Functions
16640:
16641: =over 4
1.191 harris41 16642:
16643: =item *
16644:
1.1137 raeburn 16645: dirlist() : return directory list based on URI (first arg).
16646:
16647: Inputs: 1 required, 5 optional.
16648:
16649: =over
16650:
16651: =item
16652: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
16653:
16654: =item
16655: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
16656:
16657: =item
16658: $username - username of user/course to be listed. Extracted from $uri if absent.
16659:
16660: =item
16661: $getpropath - boolean: 1 if prepend path using &propath().
16662:
16663: =item
16664: $getuserdir - boolean: 1 if prepend path for "userfiles".
16665:
16666: =item
16667: $alternateRoot - path to prepend in place of path from $uri.
16668:
16669: =back
16670:
16671: Returns: Array of up to two items.
16672:
16673: =over
16674:
16675: a reference to an array of files/subdirectories
16676:
16677: =over
16678:
16679: Each element in the array of files/subdirectories is a & separated list of
16680: item name and the result of running stat on the item. If dirlist was requested
16681: for a file instead of a directory, the item name will be ''. For a directory
16682: listing, if the item is a metadata file, the element will end &N&M
16683: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
16684: default copyright set (1).
16685:
16686: =back
16687:
16688: a scalar containing error condition (if encountered).
16689:
16690: =over
16691:
16692: =item
16693: no_host (no homeserver identified for $username:$domain).
16694:
16695: =item
16696: no_such_host (server contacted for listing not identified as valid host).
16697:
16698: =item
16699: con_lost (connection to remote server failed).
16700:
16701: =item
16702: refused (invalid $username:$domain received on lond side).
16703:
16704: =item
16705: no_such_dir (directory at specified path on lond side does not exist).
16706:
16707: =item
16708: empty (directory at specified path on lond side is empty).
16709:
16710: =over
16711:
16712: This is currently not encountered because the &ls3, &ls2,
16713: &ls (_handler) routines on the lond side do not filter out
16714: . and .. from a directory listing.
16715:
16716: =back
16717:
16718: =back
16719:
16720: =back
1.191 harris41 16721:
16722: =item *
16723:
1.243 albertel 16724: spareserver() : find server with least workload from spare.tab
16725:
1.986 foxr 16726:
16727: =item *
16728:
16729: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
16730: if there is no corresponding loncapa host.
16731:
1.243 albertel 16732: =back
16733:
1.986 foxr 16734:
1.243 albertel 16735: =head2 Apache Request
16736:
16737: =over 4
1.191 harris41 16738:
16739: =item *
16740:
1.243 albertel 16741: ssi($url,%hash) : server side include, does a complete request cycle on url to
16742: localhost, posts hash
16743:
16744: =back
16745:
16746: =head2 Data to String to Data
16747:
16748: =over 4
1.191 harris41 16749:
16750: =item *
16751:
1.243 albertel 16752: hash2str(%hash) : convert a hash into a string complete with escaping and '='
16753: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 16754:
16755: =item *
16756:
1.243 albertel 16757: hashref2str($hashref) : convert a hashref into a string complete with
16758: escaping and '=' and '&' separators, supports elements that are
16759: arrayrefs and hashrefs
1.191 harris41 16760:
16761: =item *
16762:
1.243 albertel 16763: arrayref2str($arrayref) : convert an arrayref into a string complete
16764: with escaping and '&' separators, supports elements that are arrayrefs
16765: and hashrefs
1.191 harris41 16766:
16767: =item *
16768:
1.243 albertel 16769: str2hash($string) : convert string to hash using unescaping and
16770: splitting on '=' and '&', supports elements that are arrayrefs and
16771: hashrefs
1.191 harris41 16772:
16773: =item *
16774:
1.243 albertel 16775: str2array($string) : convert string to hash using unescaping and
16776: splitting on '&', supports elements that are arrayrefs and hashrefs
16777:
16778: =back
16779:
16780: =head2 Logging Routines
16781:
16782:
16783: These routines allow one to make log messages in the lonnet.log and
16784: lonnet.perm logfiles.
1.191 harris41 16785:
1.1119 foxr 16786: =over 4
16787:
1.191 harris41 16788: =item *
16789:
1.243 albertel 16790: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 16791:
16792: =item *
16793:
1.243 albertel 16794: logthis() : append message to the normal lonnet.log file, it gets
16795: preiodically rolled over and deleted.
1.191 harris41 16796:
16797: =item *
16798:
1.243 albertel 16799: logperm() : append a permanent message to lonnet.perm.log, this log
16800: file never gets deleted by any automated portion of the system, only
16801: messages of critical importance should go in here.
16802:
1.1119 foxr 16803:
1.243 albertel 16804: =back
16805:
16806: =head2 General File Helper Routines
16807:
16808: =over 4
1.191 harris41 16809:
16810: =item *
16811:
1.481 raeburn 16812: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
16813: (a) files in /uploaded
16814: (i) If a local copy of the file exists -
16815: compares modification date of local copy with last-modified date for
16816: definitive version stored on home server for course. If local copy is
16817: stale, requests a new version from the home server and stores it.
16818: If the original has been removed from the home server, then local copy
16819: is unlinked.
16820: (ii) If local copy does not exist -
16821: requests the file from the home server and stores it.
16822:
16823: If $caller is 'uploadrep':
16824: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
16825: for request for files originally uploaded via DOCS.
16826: - returns 'ok' if fresh local copy now available, -1 otherwise.
16827:
16828: Otherwise:
16829: This indicates a call from the content generation phase of the request.
16830: - returns the entire contents of the file or -1.
16831:
16832: (b) files in /res
16833: - returns the entire contents of a file or -1;
16834: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 16835:
1.712 albertel 16836:
16837: =item *
16838:
16839: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
16840: reference
16841:
16842: returns either a stat() list of data about the file or an empty list
16843: if the file doesn't exist or couldn't find out about it (connection
16844: problems or user unknown)
16845:
1.191 harris41 16846: =item *
16847:
1.243 albertel 16848: filelocation($dir,$file) : returns file system location of a file
16849: based on URI; meant to be "fairly clean" absolute reference, $dir is a
16850: directory that relative $file lookups are to looked in ($dir of /a/dir
16851: and a file of ../bob will become /a/bob)
1.191 harris41 16852:
16853: =item *
16854:
16855: hreflocation($dir,$file) : returns file system location or a URL; same as
16856: filelocation except for hrefs
16857:
16858: =item *
16859:
1.1261 raeburn 16860: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
16861: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 16862:
1.243 albertel 16863: =back
16864:
1.608 albertel 16865: =head2 Usererfile file routines (/uploaded*)
16866:
16867: =over 4
16868:
16869: =item *
16870:
16871: userfileupload(): main rotine for putting a file in a user or course's
16872: filespace, arguments are,
16873:
1.620 albertel 16874: formname - required - this is the name of the element in $env where the
1.608 albertel 16875: filename, and the contents of the file to create/modifed exist
1.620 albertel 16876: the filename is in $env{'form.'.$formname.'.filename'} and the
16877: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 16878: context - if coursedoc, store the file in the course of the active role
16879: of the current user;
16880: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
16881: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 16882: subdir - required - subdirectory to put the file in under ../userfiles/
16883: if undefined, it will be placed in "unknown"
16884:
16885: (This routine calls clean_filename() to remove any dangerous
16886: characters from the filename, and then calls finuserfileupload() to
16887: complete the transaction)
16888:
16889: returns either the url of the uploaded file (/uploaded/....) if successful
16890: and /adm/notfound.html if unsuccessful
16891:
16892: =item *
16893:
16894: clean_filename(): routine for cleaing a filename up for storage in
16895: userfile space, argument is:
16896:
16897: filename - proposed filename
16898:
16899: returns: the new clean filename
16900:
16901: =item *
16902:
1.1090 raeburn 16903: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 16904: userspace, probably shouldn't be called directly
16905:
16906: docuname: username or courseid of destination for the file
16907: docudom: domain of user/course of destination for the file
16908: formname: same as for userfileupload()
1.1090 raeburn 16909: fname: filename (including subdirectories) for the file
16910: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
1.1401 raeburn 16911: if hashref, and context is scantron, will convert csv format to standard format
1.1090 raeburn 16912: allfiles: reference to hash used to store objects found by parser
16913: codebase: reference to hash used for codebases of java objects found by parser
16914: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
16915: thumbheight: height (pixels) of thumbnail to be created for uploaded image
16916: resizewidth: width to be used to resize image using resizeImage from ImageMagick
16917: resizeheight: height to be used to resize image using resizeImage from ImageMagick
16918: context: if 'overwrite', will move the uploaded file from its temporary location to
16919: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 16920: mimetype: reference to scalar to accommodate mime type determined
16921: from File::MMagic if $parser = parse.
1.608 albertel 16922:
16923: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 16924: and /adm/notfound.html if unsuccessful (or an error message if context
16925: was 'overwrite').
16926:
1.608 albertel 16927:
16928: =item *
16929:
16930: renameuserfile(): renames an existing userfile to a new name
16931:
16932: Args:
16933: docuname: username or courseid of destination for the file
16934: docudom: domain of user/course of destination for the file
16935: old: current file name (including any subdirs under userfiles)
16936: new: desired file name (including any subdirs under userfiles)
16937:
16938: =item *
16939:
16940: mkdiruserfile(): creates a directory is a userfiles dir
16941:
16942: Args:
16943: docuname: username or courseid of destination for the file
16944: docudom: domain of user/course of destination for the file
16945: dir: dir to create (including any subdirs under userfiles)
16946:
16947: =item *
16948:
16949: removeuserfile(): removes a file that exists in userfiles
16950:
16951: Args:
16952: docuname: username or courseid of destination for the file
16953: docudom: domain of user/course of destination for the file
16954: fname: filname to delete (including any subdirs under userfiles)
16955:
16956: =item *
16957:
16958: removeuploadedurl(): convience function for removeuserfile()
16959:
16960: Args:
16961: url: a full /uploaded/... url to delete
16962:
1.747 albertel 16963: =item *
16964:
16965: get_portfile_permissions():
16966: Args:
16967: domain: domain of user or course contain the portfolio files
16968: user: name of user or num of course contain the portfolio files
16969: Returns:
16970: hashref of a dump of the proper file_permissions.db
16971:
16972:
16973: =item *
16974:
16975: get_access_controls():
16976:
16977: Args:
16978: current_permissions: the hash ref returned from get_portfile_permissions()
16979: group: (optional) the group you want the files associated with
16980: file: (optional) the file you want access info on
16981:
16982: Returns:
1.749 raeburn 16983: a hash (keys are file names) of hashes containing
16984: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
16985: values are XML containing access control settings (see below)
1.747 albertel 16986:
16987: Internal notes:
16988:
1.749 raeburn 16989: access controls are stored in file_permissions.db as key=value pairs.
16990: key -> path to file/file_name\0uniqueID:scope_end_start
16991: where scope -> public,guest,course,group,domains or users.
16992: end -> UNIX time for end of access (0 -> no end date)
16993: start -> UNIX time for start of access
16994:
16995: value -> XML description of access control
16996: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
16997: <start></start>
16998: <end></end>
16999:
17000: <password></password> for scope type = guest
17001:
17002: <domain></domain> for scope type = course or group
17003: <number></number>
17004: <roles id="">
17005: <role></role>
17006: <access></access>
17007: <section></section>
17008: <group></group>
17009: </roles>
17010:
17011: <dom></dom> for scope type = domains
17012:
17013: <users> for scope type = users
17014: <user>
17015: <uname></uname>
17016: <udom></udom>
17017: </user>
17018: </users>
17019: </scope>
17020:
17021: Access data is also aggregated for each file in an additional key=value pair:
17022: key -> path to file/file_name\0accesscontrol
17023: value -> reference to hash
17024: hash contains key = value pairs
17025: where key = uniqueID:scope_end_start
17026: value = UNIX time record was last updated
17027:
17028: Used to improve speed of look-ups of access controls for each file.
17029:
17030: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
17031:
1.1198 raeburn 17032: =item *
17033:
1.749 raeburn 17034: modify_access_controls():
17035:
17036: Modifies access controls for a portfolio file
17037: Args
17038: 1. file name
17039: 2. reference to hash of required changes,
17040: 3. domain
17041: 4. username
17042: where domain,username are the domain of the portfolio owner
17043: (either a user or a course)
17044:
17045: Returns:
17046: 1. result of additions or updates ('ok' or 'error', with error message).
17047: 2. result of deletions ('ok' or 'error', with error message).
17048: 3. reference to hash of any new or updated access controls.
17049: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
17050: key = integer (inbound ID)
1.1198 raeburn 17051: value = uniqueID
17052:
17053: =item *
17054:
17055: get_timebased_id():
17056:
17057: Attempts to get a unique timestamp-based suffix for use with items added to a
17058: course via the Course Editor (e.g., folders, composite pages,
17059: group bulletin boards).
17060:
17061: Args: (first three required; six others optional)
17062:
17063: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
17064: docssequence, or name of group
17065:
17066: 2. keyid (alphanumeric): name of temporary locking key in hash,
17067: e.g., num, boardids
17068:
17069: 3. namespace: name of gdbm file used to store suffixes already assigned;
17070: file will be named nohist_namespace.db
17071:
17072: 4. cdom: domain of course; default is current course domain from %env
17073:
17074: 5. cnum: course number; default is current course number from %env
17075:
17076: 6. idtype: set to concat if an additional digit is to be appended to the
17077: unix timestamp to form the suffix, if the plain timestamp is already
17078: in use. Default is to not do this, but simply increment the unix
17079: timestamp by 1 until a unique key is obtained.
17080:
17081: 7. who: holder of locking key; defaults to user:domain for user.
17082:
17083: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
17084: retrying); default is 3.
17085:
17086: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
17087:
17088: Returns:
17089:
17090: 1. suffix obtained (numeric)
17091:
17092: 2. result of deleting locking key (ok if deleted, or lock never obtained)
17093:
17094: 3. error: contains (localized) error message if an error occurred.
17095:
1.747 albertel 17096:
1.608 albertel 17097: =back
17098:
1.243 albertel 17099: =head2 HTTP Helper Routines
17100:
17101: =over 4
17102:
1.191 harris41 17103: =item *
17104:
17105: escape() : unpack non-word characters into CGI-compatible hex codes
17106:
17107: =item *
17108:
17109: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
17110:
1.243 albertel 17111: =back
17112:
17113: =head1 PRIVATE SUBROUTINES
17114:
17115: =head2 Underlying communication routines (Shouldn't call)
17116:
17117: =over 4
17118:
17119: =item *
17120:
17121: subreply() : tries to pass a message to lonc, returns con_lost if incapable
17122:
17123: =item *
17124:
17125: reply() : uses subreply to send a message to remote machine, logs all failures
17126:
17127: =item *
17128:
17129: critical() : passes a critical message to another server; if cannot
17130: get through then place message in connection buffer directory and
17131: returns con_delayed, if incapable of saving message, returns
17132: con_failed
17133:
17134: =item *
17135:
17136: reconlonc() : tries to reconnect lonc client processes.
17137:
17138: =back
17139:
17140: =head2 Resource Access Logging
17141:
17142: =over 4
17143:
17144: =item *
17145:
17146: flushcourselogs() : flush (save) buffer logs and access logs
17147:
17148: =item *
17149:
17150: courselog($what) : save message for course in hash
17151:
17152: =item *
17153:
17154: courseacclog($what) : save message for course using &courselog(). Perform
17155: special processing for specific resource types (problems, exams, quizzes, etc).
17156:
1.191 harris41 17157: =item *
17158:
17159: goodbye() : flush course logs and log shutting down; it is called in srm.conf
17160: as a PerlChildExitHandler
1.243 albertel 17161:
17162: =back
17163:
17164: =head2 Other
17165:
17166: =over 4
17167:
17168: =item *
17169:
17170: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 17171:
17172: =back
17173:
17174: =cut
1.877 foxr 17175:
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