Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1380
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1380 ! raeburn 4: # $Id: lonnet.pm,v 1.1379 2018/07/18 13:45:03 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;
76:
1.1182 foxr 77:
1.1173 foxr 78: use Encode;
79:
1.1245 raeburn 80: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.1138 raeburn 81: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
82: %managerstab);
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.807 albertel 99: use LONCAPA qw(:DEFAULT :match);
1.740 www 100: use LONCAPA::Configuration;
1.1160 www 101: use LONCAPA::lonmetadata;
1.1167 droeschl 102: use LONCAPA::Lond;
1.1345 raeburn 103: use LONCAPA::LWPReq;
1.1117 foxr 104:
1.1090 raeburn 105: use File::Copy;
1.676 albertel 106:
1.195 www 107: my $readit;
1.1288 damieng 108: my $max_connection_retries = 20; # Or some such value.
1.1 albertel 109:
1.619 albertel 110: require Exporter;
111:
112: our @ISA = qw (Exporter);
113: our @EXPORT = qw(%env);
114:
1.449 matthew 115:
1.1187 raeburn 116: # ------------------------------------ Logging (parameters, docs, slots, roles)
1.729 www 117: {
118: my $logid;
1.1187 raeburn 119: sub write_log {
1.1188 raeburn 120: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
1.1184 raeburn 121: if ($context eq 'course') {
122: if (($cnum eq '') || ($cdom eq '')) {
123: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
124: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
125: }
1.957 raeburn 126: }
1.1184 raeburn 127: $logid ++;
1.957 raeburn 128: my $now = time();
129: my $id=$now.'00000'.$$.'00000'.$logid;
1.1184 raeburn 130: my $logentry = {
131: $id => {
132: 'exe_uname' => $env{'user.name'},
133: 'exe_udom' => $env{'user.domain'},
134: 'exe_time' => $now,
135: 'exe_ip' => $ENV{'REMOTE_ADDR'},
136: 'delflag' => $delflag,
137: 'logentry' => $storehash,
138: 'uname' => $uname,
139: 'udom' => $udom,
140: }
141: };
142: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
1.729 www 143: }
144: }
1.1 albertel 145:
1.163 harris41 146: sub logtouch {
147: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 148: unless (-e "$execdir/logs/lonnet.log") {
1.1359 raeburn 149: open(my $fh,">>","$execdir/logs/lonnet.log");
1.163 harris41 150: close $fh;
151: }
152: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
153: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
154: }
155:
1.1 albertel 156: sub logthis {
157: my $message=shift;
158: my $execdir=$perlvar{'lonDaemons'};
159: my $now=time;
160: my $local=localtime($now);
1.1359 raeburn 161: if (open(my $fh,">>","$execdir/logs/lonnet.log")) {
1.986 foxr 162: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
163: print $fh $logstring;
1.448 albertel 164: close($fh);
165: }
1.1 albertel 166: return 1;
167: }
168:
169: sub logperm {
170: my $message=shift;
171: my $execdir=$perlvar{'lonDaemons'};
172: my $now=time;
173: my $local=localtime($now);
1.1359 raeburn 174: if (open(my $fh,">>","$execdir/logs/lonnet.perm.log")) {
1.448 albertel 175: print $fh "$now:$message:$local\n";
176: close($fh);
177: }
1.1 albertel 178: return 1;
179: }
180:
1.850 albertel 181: sub create_connection {
1.853 albertel 182: my ($hostname,$lonid) = @_;
1.851 albertel 183: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 184: Type => SOCK_STREAM,
185: Timeout => 10);
186: return 0 if (!$client);
1.890 albertel 187: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 188: my $result = <$client>;
189: chomp($result);
190: return 1 if ($result eq 'done');
191: return 0;
192: }
193:
1.983 raeburn 194: sub get_server_timezone {
195: my ($cnum,$cdom) = @_;
196: my $home=&homeserver($cnum,$cdom);
197: if ($home ne 'no_host') {
198: my $cachetime = 24*3600;
199: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
200: if (defined($cached)) {
201: return $timezone;
202: } else {
203: my $timezone = &reply('servertimezone',$home);
204: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
205: }
206: }
207: }
1.850 albertel 208:
1.1106 raeburn 209: sub get_server_distarch {
210: my ($lonhost,$ignore_cache) = @_;
211: if (defined($lonhost)) {
212: if (!defined(&hostname($lonhost))) {
213: return;
214: }
215: my $cachetime = 12*3600;
216: if (!$ignore_cache) {
217: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
218: if (defined($cached)) {
219: return $distarch;
220: }
221: }
222: my $rep = &reply('serverdistarch',$lonhost);
223: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
224: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
225: $rep eq '') {
226: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
227: }
228: }
229: return;
230: }
231:
1.1315 raeburn 232: sub get_servercerts_info {
233: my ($lonhost,$context) = @_;
234: my ($rep,$uselocal);
235: if (grep { $_ eq $lonhost } ¤t_machine_ids()) {
236: $uselocal = 1;
237: }
1.1316 raeburn 238: if (($context ne 'cgi') && ($uselocal)) {
1.1315 raeburn 239: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
1.1323 raeburn 240: if ($distro eq '') {
241: $uselocal = 0;
242: } elsif ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
1.1315 raeburn 243: if ($1 < 6) {
244: $uselocal = 0;
245: }
1.1346 raeburn 246: } elsif ($distro =~ /^(?:sles)(\d+)$/) {
247: if ($1 < 12) {
248: $uselocal = 0;
249: }
1.1315 raeburn 250: }
251: }
252: if ($uselocal) {
253: $rep = LONCAPA::Lond::server_certs(\%perlvar);
254: } else {
255: $rep=&reply('servercerts',$lonhost);
256: }
257: my ($result,%returnhash);
258: if (defined($lonhost)) {
259: if (!defined(&hostname($lonhost))) {
260: return;
261: }
262: }
263: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
264: ($rep eq 'unknown_cmd')) {
265: $result = $rep;
266: } else {
267: $result = 'ok';
268: my @pairs=split(/\&/,$rep);
269: foreach my $item (@pairs) {
270: my ($key,$value)=split(/=/,$item,2);
271: my $what = &unescape($key);
272: $returnhash{$what}=&thaw_unescape($value);
273: }
274: }
275: return ($result,\%returnhash);
276: }
277:
1.993 raeburn 278: sub get_server_loncaparev {
1.1073 raeburn 279: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
1.993 raeburn 280: if (defined($lonhost)) {
281: if (!defined(&hostname($lonhost))) {
282: undef($lonhost);
283: }
284: }
285: if (!defined($lonhost)) {
286: if (defined(&domain($dom,'primary'))) {
287: $lonhost=&domain($dom,'primary');
288: if ($lonhost eq 'no_host') {
289: undef($lonhost);
290: }
291: }
292: }
293: if (defined($lonhost)) {
1.1073 raeburn 294: my $cachetime = 12*3600;
295: if (!$ignore_cache) {
296: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
297: if (defined($cached)) {
298: return $loncaparev;
299: }
300: }
301: my ($answer,$loncaparev);
302: my @ids=¤t_machine_ids();
303: if (grep(/^\Q$lonhost\E$/,@ids)) {
304: $answer = $perlvar{'lonVersion'};
1.1081 raeburn 305: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 306: $loncaparev = $1;
307: }
308: } else {
309: $answer = &reply('serverloncaparev',$lonhost);
310: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
311: if ($caller eq 'loncron') {
312: my $protocol = $protocol{$lonhost};
313: $protocol = 'http' if ($protocol ne 'https');
314: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
315: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 316: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,4,1);
1.1073 raeburn 317: unless ($response->is_error()) {
318: my $content = $response->content;
1.1081 raeburn 319: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
1.1073 raeburn 320: $loncaparev = $1;
321: }
322: }
323: } else {
324: $loncaparev = $loncaparevs{$lonhost};
325: }
1.1081 raeburn 326: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 327: $loncaparev = $1;
328: }
1.993 raeburn 329: }
1.1073 raeburn 330: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
1.993 raeburn 331: }
332: }
333:
1.1074 raeburn 334: sub get_server_homeID {
335: my ($hostname,$ignore_cache,$caller) = @_;
336: unless ($ignore_cache) {
337: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
338: if (defined($cached)) {
339: return $serverhomeID;
340: }
341: }
342: my $cachetime = 12*3600;
343: my $serverhomeID;
344: if ($caller eq 'loncron') {
345: my @machine_ids = &machine_ids($hostname);
346: foreach my $id (@machine_ids) {
347: my $response = &reply('serverhomeID',$id);
348: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
349: $serverhomeID = $response;
350: last;
351: }
352: }
353: if ($serverhomeID eq '') {
354: $serverhomeID = $machine_ids[-1];
355: }
356: } else {
357: $serverhomeID = $serverhomeIDs{$hostname};
358: }
359: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
360: }
361:
1.1121 raeburn 362: sub get_remote_globals {
363: my ($lonhost,$whathash,$ignore_cache) = @_;
1.1125 raeburn 364: my ($result,%returnhash,%whatneeded);
365: if (ref($whathash) eq 'HASH') {
1.1121 raeburn 366: foreach my $what (sort(keys(%{$whathash}))) {
367: my $hashid = $lonhost.'-'.$what;
1.1125 raeburn 368: my ($response,$cached);
1.1121 raeburn 369: unless ($ignore_cache) {
1.1125 raeburn 370: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
1.1121 raeburn 371: }
372: if (defined($cached)) {
1.1125 raeburn 373: $returnhash{$what} = $response;
1.1121 raeburn 374: } else {
1.1125 raeburn 375: $whatneeded{$what} = 1;
1.1121 raeburn 376: }
377: }
1.1125 raeburn 378: if (keys(%whatneeded) == 0) {
379: $result = 'ok';
380: } else {
1.1121 raeburn 381: my $requested = &freeze_escape(\%whatneeded);
382: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
1.1125 raeburn 383: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
384: ($rep eq 'unknown_cmd')) {
385: $result = $rep;
386: } else {
387: $result = 'ok';
1.1121 raeburn 388: my @pairs=split(/\&/,$rep);
1.1125 raeburn 389: foreach my $item (@pairs) {
390: my ($key,$value)=split(/=/,$item,2);
391: my $what = &unescape($key);
392: my $hashid = $lonhost.'-'.$what;
393: $returnhash{$what}=&thaw_unescape($value);
394: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
1.1121 raeburn 395: }
396: }
397: }
398: }
1.1125 raeburn 399: return ($result,\%returnhash);
1.1121 raeburn 400: }
401:
1.1124 raeburn 402: sub remote_devalidate_cache {
1.1241 raeburn 403: my ($lonhost,$cachekeys) = @_;
404: my $items;
405: return unless (ref($cachekeys) eq 'ARRAY');
406: my $cachestr = join('&',@{$cachekeys});
407: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
1.1124 raeburn 408: return $response;
409: }
410:
1.1 albertel 411: # -------------------------------------------------- Non-critical communication
412: sub subreply {
413: my ($cmd,$server)=@_;
1.838 albertel 414: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 415: #
416: # With loncnew process trimming, there's a timing hole between lonc server
417: # process exit and the master server picking up the listen on the AF_UNIX
418: # socket. In that time interval, a lock file will exist:
419:
420: my $lockfile=$peerfile.".lock";
421: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
1.1289 damieng 422: sleep(0.1);
1.549 foxr 423: }
424: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 425: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 426: #
1.550 foxr 427: # We'll give the connection a few tries before abandoning it. If
428: # connection is not possible, we'll con_lost back to the client.
429: #
430: my $client;
431: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
432: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
433: Type => SOCK_STREAM,
434: Timeout => 10);
1.869 albertel 435: if ($client) {
1.550 foxr 436: last; # Connected!
1.850 albertel 437: } else {
1.853 albertel 438: &create_connection(&hostname($server),$server);
1.550 foxr 439: }
1.1289 damieng 440: sleep(0.1); # Try again later if failed connection.
1.550 foxr 441: }
442: my $answer;
443: if ($client) {
1.704 albertel 444: print $client "sethost:$server:$cmd\n";
1.550 foxr 445: $answer=<$client>;
446: if (!$answer) { $answer="con_lost"; }
447: chomp($answer);
448: } else {
449: $answer = 'con_lost'; # Failed connection.
450: }
1.1 albertel 451: return $answer;
452: }
453:
454: sub reply {
455: my ($cmd,$server)=@_;
1.838 albertel 456: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 457: my $answer=subreply($cmd,$server);
1.65 www 458: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 459: &logthis("<font color=\"blue\">WARNING:".
1.12 www 460: " $cmd to $server returned $answer</font>");
461: }
1.1 albertel 462: return $answer;
463: }
464:
465: # ----------------------------------------------------------- Send USR1 to lonc
466:
467: sub reconlonc {
1.891 albertel 468: my ($lonid) = @_;
469: if ($lonid) {
1.1295 raeburn 470: my $hostname = &hostname($lonid);
1.891 albertel 471: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
472: if ($hostname && -e $peerfile) {
473: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
474: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
475: Type => SOCK_STREAM,
476: Timeout => 10);
477: if ($client) {
478: print $client ("reset_retries\n");
479: my $answer=<$client>;
480: #reset just this one.
481: }
482: }
483: return;
484: }
485:
1.836 www 486: &logthis("Trying to reconnect lonc");
1.1 albertel 487: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.1359 raeburn 488: if (open(my $fh,"<",$loncfile)) {
1.1 albertel 489: my $loncpid=<$fh>;
490: chomp($loncpid);
491: if (kill 0 => $loncpid) {
492: &logthis("lonc at pid $loncpid responding, sending USR1");
493: kill USR1 => $loncpid;
494: sleep 1;
1.1295 raeburn 495: } else {
1.12 www 496: &logthis(
1.672 albertel 497: "<font color=\"blue\">WARNING:".
1.12 www 498: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 499: }
500: } else {
1.836 www 501: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 502: }
503: }
504:
505: # ------------------------------------------------------ Critical communication
1.12 www 506:
1.1 albertel 507: sub critical {
508: my ($cmd,$server)=@_;
1.838 albertel 509: unless (&hostname($server)) {
1.672 albertel 510: &logthis("<font color=\"blue\">WARNING:".
1.89 www 511: " Critical message to unknown server ($server)</font>");
512: return 'no_such_host';
513: }
1.1 albertel 514: my $answer=reply($cmd,$server);
515: if ($answer eq 'con_lost') {
1.1295 raeburn 516: &reconlonc($server);
1.589 albertel 517: my $answer=reply($cmd,$server);
1.1 albertel 518: if ($answer eq 'con_lost') {
519: my $now=time;
520: my $middlename=$cmd;
1.5 www 521: $middlename=substr($middlename,0,16);
1.1 albertel 522: $middlename=~s/\W//g;
523: my $dfilename=
1.305 www 524: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
525: $dumpcount++;
1.1 albertel 526: {
1.448 albertel 527: my $dfh;
1.1359 raeburn 528: if (open($dfh,">",$dfilename)) {
1.448 albertel 529: print $dfh "$cmd\n";
530: close($dfh);
531: }
1.1 albertel 532: }
1.1288 damieng 533: sleep 1;
1.1 albertel 534: my $wcmd='';
535: {
1.448 albertel 536: my $dfh;
1.1359 raeburn 537: if (open($dfh,"<",$dfilename)) {
1.448 albertel 538: $wcmd=<$dfh>;
539: close($dfh);
540: }
1.1 albertel 541: }
542: chomp($wcmd);
1.7 www 543: if ($wcmd eq $cmd) {
1.672 albertel 544: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 545: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 546: &logperm("D:$server:$cmd");
547: return 'con_delayed';
548: } else {
1.672 albertel 549: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 550: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 551: &logperm("F:$server:$cmd");
552: return 'con_failed';
553: }
554: }
555: }
556: return $answer;
1.405 albertel 557: }
558:
1.755 albertel 559: # ------------------------------------------- check if return value is an error
560:
561: sub error {
562: my ($result) = @_;
1.756 albertel 563: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 564: if ($2 == 2) { return undef; }
565: return $1;
566: }
567: return undef;
568: }
569:
1.783 albertel 570: sub convert_and_load_session_env {
571: my ($lonidsdir,$handle)=@_;
572: my @profile;
573: {
1.917 albertel 574: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
575: if (!$opened) {
1.915 albertel 576: return 0;
577: }
1.783 albertel 578: flock($idf,LOCK_SH);
579: @profile=<$idf>;
580: close($idf);
581: }
582: my %temp_env;
583: foreach my $line (@profile) {
1.786 albertel 584: if ($line !~ m/=/) {
585: return 0;
586: }
1.783 albertel 587: chomp($line);
588: my ($envname,$envvalue)=split(/=/,$line,2);
589: $temp_env{&unescape($envname)} = &unescape($envvalue);
590: }
591: unlink("$lonidsdir/$handle.id");
592: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
593: 0640)) {
594: %disk_env = %temp_env;
595: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
596: untie(%disk_env);
597: }
1.786 albertel 598: return 1;
1.783 albertel 599: }
600:
1.374 www 601: # ------------------------------------------- Transfer profile into environment
1.780 albertel 602: my $env_loaded;
603: sub transfer_profile_to_env {
1.788 albertel 604: my ($lonidsdir,$handle,$force_transfer) = @_;
605: if (!$force_transfer && $env_loaded) { return; }
1.374 www 606:
1.720 albertel 607: if (!defined($lonidsdir)) {
608: $lonidsdir = $perlvar{'lonIDsDir'};
609: }
610: if (!defined($handle)) {
611: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
612: }
613:
1.786 albertel 614: my $convert;
615: {
1.917 albertel 616: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
617: if (!$opened) {
1.915 albertel 618: return;
619: }
1.786 albertel 620: flock($idf,LOCK_SH);
621: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
622: &GDBM_READER(),0640)) {
623: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
624: untie(%disk_env);
625: } else {
626: $convert = 1;
627: }
628: }
629: if ($convert) {
630: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
631: &logthis("Failed to load session, or convert session.");
632: }
1.374 www 633: }
1.783 albertel 634:
1.786 albertel 635: my %remove;
1.783 albertel 636: while ( my $envname = each(%env) ) {
1.433 matthew 637: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
638: if ($time < time-300) {
1.783 albertel 639: $remove{$key}++;
1.433 matthew 640: }
641: }
642: }
1.783 albertel 643:
1.619 albertel 644: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 645: $env_loaded=1;
1.783 albertel 646: foreach my $expired_key (keys(%remove)) {
1.433 matthew 647: &delenv($expired_key);
1.374 www 648: }
1.1 albertel 649: }
650:
1.916 albertel 651: # ---------------------------------------------------- Check for valid session
652: sub check_for_valid_session {
1.1355 raeburn 653: my ($r,$name,$userhashref,$domref) = @_;
1.916 albertel 654: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1378 raeburn 655: my ($lonidsdir,$linkname,$pubname,$secure,$lonid);
656: if ($name eq 'lonDAV') {
657: $lonidsdir=$r->dir_config('lonDAVsessDir');
658: } else {
659: $lonidsdir=$r->dir_config('lonIDsDir');
660: if ($name eq '') {
661: $name = 'lonID';
662: }
663: }
664: if ($name eq 'lonID') {
665: $secure = 'lonSID';
1.1337 raeburn 666: $linkname = 'lonLinkID';
667: $pubname = 'lonPubID';
1.1378 raeburn 668: if (exists($cookies{$secure})) {
669: $lonid=$cookies{$secure};
670: } elsif (exists($cookies{$name})) {
671: $lonid=$cookies{$name};
672: } elsif (exists($cookies{$linkname})) {
1.1337 raeburn 673: $lonid=$cookies{$linkname};
1.1378 raeburn 674: } elsif (exists($cookies{$pubname})) {
675: $lonid=$cookies{$pubname};
1.1337 raeburn 676: }
1.1378 raeburn 677: } else {
678: $lonid=$cookies{$name};
1.1337 raeburn 679: }
1.916 albertel 680: return undef if (!$lonid);
681:
682: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1378 raeburn 683: if (-l "$lonidsdir/$handle.id") {
684: my $link = readlink("$lonidsdir/$handle.id");
685: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
686: $handle = $1;
687: }
1.1155 raeburn 688: }
1.1355 raeburn 689: if (!-e "$lonidsdir/$handle.id") {
690: if ((ref($domref)) && ($name eq 'lonID') &&
691: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
692: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
693: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
694: $$domref = $possudom;
695: }
696: }
697: return undef;
698: }
1.916 albertel 699:
1.917 albertel 700: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
701: return undef if (!$opened);
1.916 albertel 702:
703: flock($idf,LOCK_SH);
704: my %disk_env;
705: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
706: &GDBM_READER(),0640)) {
707: return undef;
708: }
709:
710: if (!defined($disk_env{'user.name'})
711: || !defined($disk_env{'user.domain'})) {
712: return undef;
713: }
1.1245 raeburn 714:
715: if (ref($userhashref) eq 'HASH') {
716: $userhashref->{'name'} = $disk_env{'user.name'};
717: $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1361 raeburn 718: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
1.1375 raeburn 719: if ($userhashref->{'lti'}) {
720: $userhashref->{'ltitarget'} = $disk_env{'request.lti.target'};
721: $userhashref->{'ltiuri'} = $disk_env{'request.lti.uri'};
722: }
1.1212 raeburn 723: }
1.1245 raeburn 724:
1.916 albertel 725: return $handle;
726: }
727:
1.830 albertel 728: sub timed_flock {
729: my ($file,$lock_type) = @_;
730: my $failed=0;
731: eval {
732: local $SIG{__DIE__}='DEFAULT';
733: local $SIG{ALRM}=sub {
734: $failed=1;
735: die("failed lock");
736: };
737: alarm(13);
738: flock($file,$lock_type);
739: alarm(0);
740: };
741: if ($failed) {
742: return undef;
743: } else {
744: return 1;
745: }
746: }
747:
1.5 www 748: # ---------------------------------------------------------- Append Environment
749:
750: sub appenv {
1.949 raeburn 751: my ($newenv,$roles) = @_;
752: if (ref($newenv) eq 'HASH') {
753: foreach my $key (keys(%{$newenv})) {
754: my $refused = 0;
755: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
756: $refused = 1;
757: if (ref($roles) eq 'ARRAY') {
1.1250 raeburn 758: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949 raeburn 759: if (grep(/^\Q$role\E$/,@{$roles})) {
760: $refused = 0;
761: }
762: }
763: }
764: if ($refused) {
765: &logthis("<font color=\"blue\">WARNING: ".
766: "Attempt to modify environment ".$key." to ".$newenv->{$key}
767: .'</font>');
768: delete($newenv->{$key});
769: } else {
770: $env{$key}=$newenv->{$key};
771: }
772: }
1.1376 raeburn 773: my $lonids = $perlvar{'lonIDsDir'};
774: if ($env{'user.environment'} =~ m{^\Q$lonids/\E$match_username\_\d+\_$match_domain\_[\w\-.]+\.id$}) {
775: my $opened = open(my $env_file,'+<',$env{'user.environment'});
776: if ($opened
777: && &timed_flock($env_file,LOCK_EX)
778: &&
779: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
780: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
781: while (my ($key,$value) = each(%{$newenv})) {
782: $disk_env{$key} = $value;
783: }
784: untie(%disk_env);
785: }
1.35 www 786: }
1.191 harris41 787: }
1.56 www 788: return 'ok';
789: }
790: # ----------------------------------------------------- Delete from Environment
791:
792: sub delenv {
1.1104 raeburn 793: my ($delthis,$regexp,$roles) = @_;
794: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
795: my $refused = 1;
796: if (ref($roles) eq 'ARRAY') {
797: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
798: if (grep(/^\Q$role\E$/,@{$roles})) {
799: $refused = 0;
800: }
801: }
802: if ($refused) {
803: &logthis("<font color=\"blue\">WARNING: ".
804: "Attempt to delete from environment ".$delthis);
805: return 'error';
806: }
1.56 www 807: }
1.917 albertel 808: my $opened = open(my $env_file,'+<',$env{'user.environment'});
809: if ($opened
1.915 albertel 810: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 811: &&
812: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
813: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 814: foreach my $key (keys(%disk_env)) {
1.987 raeburn 815: if ($regexp) {
816: if ($key=~/^$delthis/) {
817: delete($env{$key});
818: delete($disk_env{$key});
819: }
820: } else {
821: if ($key=~/^\Q$delthis\E/) {
822: delete($env{$key});
823: delete($disk_env{$key});
824: }
825: }
1.448 albertel 826: }
1.783 albertel 827: untie(%disk_env);
1.5 www 828: }
829: return 'ok';
1.369 albertel 830: }
831:
1.790 albertel 832: sub get_env_multiple {
833: my ($name) = @_;
834: my @values;
835: if (defined($env{$name})) {
836: # exists is it an array
837: if (ref($env{$name})) {
838: @values=@{ $env{$name} };
839: } else {
840: $values[0]=$env{$name};
841: }
842: }
843: return(@values);
844: }
845:
1.958 www 846: # ------------------------------------------------------------------- Locking
847:
848: sub set_lock {
849: my ($text)=@_;
850: $locknum++;
851: my $id=$$.'-'.$locknum;
852: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
853: 'session.lock.'.$id => $text});
854: return $id;
855: }
856:
857: sub get_locks {
858: my $num=0;
859: my %texts=();
860: foreach my $lock (split(/\,/,$env{'session.locks'})) {
861: if ($lock=~/\w/) {
862: $num++;
863: $texts{$lock}=$env{'session.lock.'.$lock};
864: }
865: }
866: return ($num,%texts);
867: }
868:
869: sub remove_lock {
870: my ($id)=@_;
871: my $newlocks='';
872: foreach my $lock (split(/\,/,$env{'session.locks'})) {
873: if (($lock=~/\w/) && ($lock ne $id)) {
874: $newlocks.=','.$lock;
875: }
876: }
877: &appenv({'session.locks' => $newlocks});
878: &delenv('session.lock.'.$id);
879: }
880:
881: sub remove_all_locks {
882: my $activelocks=$env{'session.locks'};
883: foreach my $lock (split(/\,/,$env{'session.locks'})) {
884: if ($lock=~/\w/) {
885: &remove_lock($lock);
886: }
887: }
888: }
889:
890:
1.369 albertel 891: # ------------------------------------------ Find out current server userload
892: sub userload {
893: my $numusers=0;
894: {
895: opendir(LONIDS,$perlvar{'lonIDsDir'});
896: my $filename;
897: my $curtime=time;
898: while ($filename=readdir(LONIDS)) {
1.925 albertel 899: next if ($filename eq '.' || $filename eq '..');
900: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 901: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 902: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 903: }
904: closedir(LONIDS);
905: }
906: my $userloadpercent=0;
907: my $maxuserload=$perlvar{'lonUserLoadLim'};
908: if ($maxuserload) {
1.371 albertel 909: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 910: }
1.372 albertel 911: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 912: return $userloadpercent;
1.283 www 913: }
914:
1.1 albertel 915: # ------------------------------ Find server with least workload from spare.tab
1.11 www 916:
1.1 albertel 917: sub spareserver {
1.1083 raeburn 918: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 919: my $spare_server;
1.370 albertel 920: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 921: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
922: : $userloadpercent;
1.1083 raeburn 923: my ($uint_dom,$remotesessions);
924: if (($udom ne '') && (&domain($udom) ne '')) {
925: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
926: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
927: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
928: $remotesessions = $udomdefaults{'remotesessions'};
929: }
1.1123 raeburn 930: my $spareshash = &this_host_spares($udom);
931: if (ref($spareshash) eq 'HASH') {
932: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
933: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1.1279 raeburn 934: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
935: $try_server));
1.1123 raeburn 936: ($spare_server, $lowest_load) =
937: &compare_server_load($try_server, $spare_server, $lowest_load);
938: }
1.1083 raeburn 939: }
1.784 albertel 940:
1.1123 raeburn 941: my $found_server = ($spare_server ne '' && $lowest_load < 100);
942:
943: if (!$found_server) {
944: if (ref($spareshash->{'default'}) eq 'ARRAY') {
945: foreach my $try_server (@{ $spareshash->{'default'} }) {
1.1279 raeburn 946: next unless (&spare_can_host($udom,$uint_dom,
947: $remotesessions,$try_server));
1.1123 raeburn 948: ($spare_server, $lowest_load) =
949: &compare_server_load($try_server, $spare_server, $lowest_load);
950: }
951: }
952: }
1.784 albertel 953: }
954:
955: if (!$want_server_name) {
1.968 raeburn 956: my $protocol = 'http';
957: if ($protocol{$spare_server} eq 'https') {
958: $protocol = $protocol{$spare_server};
959: }
1.1001 raeburn 960: if (defined($spare_server)) {
961: my $hostname = &hostname($spare_server);
1.1083 raeburn 962: if (defined($hostname)) {
1.1001 raeburn 963: $spare_server = $protocol.'://'.$hostname;
964: }
965: }
1.784 albertel 966: }
967: return $spare_server;
968: }
969:
970: sub compare_server_load {
1.1253 raeburn 971: my ($try_server, $spare_server, $lowest_load, $required) = @_;
972:
973: if ($required) {
974: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
975: my $remoterev = &get_server_loncaparev(undef,$try_server);
976: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
977: if (($major eq '' && $minor eq '') ||
978: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
979: return ($spare_server,$lowest_load);
980: }
981: }
1.784 albertel 982:
983: my $loadans = &reply('load', $try_server);
984: my $userloadans = &reply('userload',$try_server);
985:
986: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 987: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 988: }
989:
990: my $load;
991: if ($loadans =~ /\d/) {
992: if ($userloadans =~ /\d/) {
993: #both are numbers, pick the bigger one
994: $load = ($loadans > $userloadans) ? $loadans
995: : $userloadans;
1.411 albertel 996: } else {
1.784 albertel 997: $load = $loadans;
1.411 albertel 998: }
1.784 albertel 999: } else {
1000: $load = $userloadans;
1001: }
1002:
1003: if (($load =~ /\d/) && ($load < $lowest_load)) {
1004: $spare_server = $try_server;
1005: $lowest_load = $load;
1.370 albertel 1006: }
1.784 albertel 1007: return ($spare_server,$lowest_load);
1.202 matthew 1008: }
1.914 albertel 1009:
1010: # --------------------------- ask offload servers if user already has a session
1011: sub find_existing_session {
1012: my ($udom,$uname) = @_;
1.1123 raeburn 1013: my $spareshash = &this_host_spares($udom);
1014: if (ref($spareshash) eq 'HASH') {
1015: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1016: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1017: return $try_server if (&has_user_session($try_server, $udom, $uname));
1018: }
1019: }
1020: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1021: foreach my $try_server (@{ $spareshash->{'default'} }) {
1022: return $try_server if (&has_user_session($try_server, $udom, $uname));
1023: }
1024: }
1.914 albertel 1025: }
1026: return;
1027: }
1028:
1029: # -------------------------------- ask if server already has a session for user
1030: sub has_user_session {
1031: my ($lonid,$udom,$uname) = @_;
1032: my $result = &reply(join(':','userhassession',
1033: map {&escape($_)} ($udom,$uname)),$lonid);
1034: return 1 if ($result eq 'ok');
1035:
1036: return 0;
1037: }
1038:
1.1076 raeburn 1039: # --------- determine least loaded server in a user's domain which allows login
1040:
1041: sub choose_server {
1.1259 raeburn 1042: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076 raeburn 1043: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 1044: my %servers = &get_servers($udom);
1.1076 raeburn 1045: my $lowest_load = 30000;
1.1259 raeburn 1046: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1047: if ($skiploadbal) {
1048: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1049: unless (defined($cached)) {
1050: my $cachetime = 60*60*24;
1051: my %domconfig =
1052: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1053: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1054: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1055: $cachetime);
1056: }
1057: }
1058: }
1.1076 raeburn 1059: foreach my $lonhost (keys(%servers)) {
1.1259 raeburn 1060: if ($skiploadbal) {
1061: if (ref($balancers) eq 'HASH') {
1062: next if (exists($balancers->{$lonhost}));
1063: }
1064: }
1.1115 raeburn 1065: my $loginvia;
1066: if ($checkloginvia) {
1067: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 1068: if ($loginvia) {
1069: my ($server,$path) = split(/:/,$loginvia);
1070: ($login_host, $lowest_load) =
1.1253 raeburn 1071: &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116 raeburn 1072: if ($login_host eq $server) {
1073: $portal_path = $path;
1.1151 raeburn 1074: $isredirect = 1;
1.1116 raeburn 1075: }
1076: } else {
1077: ($login_host, $lowest_load) =
1.1253 raeburn 1078: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116 raeburn 1079: if ($login_host eq $lonhost) {
1080: $portal_path = '';
1.1151 raeburn 1081: $isredirect = '';
1.1116 raeburn 1082: }
1083: }
1084: } else {
1.1076 raeburn 1085: ($login_host, $lowest_load) =
1.1253 raeburn 1086: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076 raeburn 1087: }
1088: }
1089: if ($login_host ne '') {
1.1116 raeburn 1090: $hostname = &hostname($login_host);
1.1076 raeburn 1091: }
1.1331 raeburn 1092: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1.1076 raeburn 1093: }
1094:
1.202 matthew 1095: # --------------------------------------------- Try to change a user's password
1096:
1097: sub changepass {
1.799 raeburn 1098: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 1099: $currentpass = &escape($currentpass);
1100: $newpass = &escape($newpass);
1.1030 raeburn 1101: my $lonhost = $perlvar{'lonHostID'};
1102: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 1103: $server);
1104: if (! $answer) {
1105: &logthis("No reply on password change request to $server ".
1106: "by $uname in domain $udom.");
1107: } elsif ($answer =~ "^ok") {
1108: &logthis("$uname in $udom successfully changed their password ".
1109: "on $server.");
1110: } elsif ($answer =~ "^pwchange_failure") {
1111: &logthis("$uname in $udom was unable to change their password ".
1112: "on $server. The action was blocked by either lcpasswd ".
1113: "or pwchange");
1114: } elsif ($answer =~ "^non_authorized") {
1115: &logthis("$uname in $udom did not get their password correct when ".
1116: "attempting to change it on $server.");
1117: } elsif ($answer =~ "^auth_mode_error") {
1118: &logthis("$uname in $udom attempted to change their password despite ".
1119: "not being locally or internally authenticated on $server.");
1120: } elsif ($answer =~ "^unknown_user") {
1121: &logthis("$uname in $udom attempted to change their password ".
1122: "on $server but were unable to because $server is not ".
1123: "their home server.");
1124: } elsif ($answer =~ "^refused") {
1125: &logthis("$server refused to change $uname in $udom password because ".
1126: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1127: } elsif ($answer =~ "invalid_client") {
1128: &logthis("$server refused to change $uname in $udom password because ".
1129: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 1130: }
1131: return $answer;
1.1 albertel 1132: }
1133:
1.169 harris41 1134: # ----------------------- Try to determine user's current authentication scheme
1135:
1136: sub queryauthenticate {
1137: my ($uname,$udom)=@_;
1.456 albertel 1138: my $uhome=&homeserver($uname,$udom);
1139: if (!$uhome) {
1140: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1141: return 'no_host';
1142: }
1143: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1144: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1145: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1146: }
1.456 albertel 1147: return $answer;
1.169 harris41 1148: }
1149:
1.1 albertel 1150: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1151:
1.1 albertel 1152: sub authenticate {
1.1073 raeburn 1153: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1154: $upass=&escape($upass);
1155: $uname= &LONCAPA::clean_username($uname);
1.836 www 1156: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1157: my $newhome;
1.836 www 1158: if ((!$uhome) || ($uhome eq 'no_host')) {
1159: # Maybe the machine was offline and only re-appeared again recently?
1160: &reconlonc();
1161: # One more
1.952 raeburn 1162: $uhome=&homeserver($uname,$udom,1);
1163: if (($uhome eq 'no_host') && $checkdefauth) {
1164: if (defined(&domain($udom,'primary'))) {
1165: $newhome=&domain($udom,'primary');
1166: }
1167: if ($newhome ne '') {
1168: $uhome = $newhome;
1169: }
1170: }
1.836 www 1171: if ((!$uhome) || ($uhome eq 'no_host')) {
1172: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1173: return 'no_host';
1174: }
1.1 albertel 1175: }
1.1073 raeburn 1176: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1177: if ($answer eq 'authorized') {
1.952 raeburn 1178: if ($newhome) {
1179: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1180: return 'no_account_on_host';
1181: } else {
1182: &logthis("User $uname at $udom authorized by $uhome");
1183: return $uhome;
1184: }
1.471 albertel 1185: }
1186: if ($answer eq 'non_authorized') {
1187: &logthis("User $uname at $udom rejected by $uhome");
1188: return 'no_host';
1.9 www 1189: }
1.471 albertel 1190: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1191: return 'no_host';
1192: }
1193:
1.1073 raeburn 1194: sub can_host_session {
1.1074 raeburn 1195: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1196: my $canhost = 1;
1.1074 raeburn 1197: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1198: if (ref($remotesessions) eq 'HASH') {
1199: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1200: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1201: $canhost = 0;
1202: } else {
1203: $canhost = 1;
1204: }
1205: }
1206: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1207: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1208: $canhost = 1;
1209: } else {
1210: $canhost = 0;
1211: }
1212: }
1213: if ($canhost) {
1214: if ($remotesessions->{'version'} ne '') {
1215: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1216: if ($reqmajor ne '' && $reqminor ne '') {
1217: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1218: my $major = $1;
1219: my $minor = $2;
1220: if (($major < $reqmajor ) ||
1221: (($major == $reqmajor) && ($minor < $reqminor))) {
1222: $canhost = 0;
1223: }
1224: } else {
1225: $canhost = 0;
1226: }
1227: }
1228: }
1229: }
1230: }
1231: if ($canhost) {
1232: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1233: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1234: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1235: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1236: if (($uint_dom ne '') &&
1237: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1238: $canhost = 0;
1239: } else {
1240: $canhost = 1;
1241: }
1242: }
1243: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1244: if (($uint_dom ne '') &&
1245: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1246: $canhost = 1;
1247: } else {
1248: $canhost = 0;
1249: }
1250: }
1251: }
1252: }
1253: return $canhost;
1254: }
1255:
1.1083 raeburn 1256: sub spare_can_host {
1257: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1258: my $canhost=1;
1.1279 raeburn 1259: my $try_server_hostname = &hostname($try_server);
1260: my $serverhomeID = &get_server_homeID($try_server_hostname);
1261: my $serverhomedom = &host_domain($serverhomeID);
1262: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1263: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1264: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1265: $canhost = 0;
1266: }
1267: }
1268: if (($canhost) && ($uint_dom)) {
1269: my @intdoms;
1270: my $internet_names = &get_internet_names($try_server);
1271: if (ref($internet_names) eq 'ARRAY') {
1272: @intdoms = @{$internet_names};
1273: }
1274: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1275: my $remoterev = &get_server_loncaparev(undef,$try_server);
1276: $canhost = &can_host_session($udom,$try_server,$remoterev,
1277: $remotesessions,
1278: $defdomdefaults{'hostedsessions'});
1279: }
1.1083 raeburn 1280: }
1281: return $canhost;
1282: }
1283:
1.1123 raeburn 1284: sub this_host_spares {
1285: my ($dom) = @_;
1.1126 raeburn 1286: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1287: my @hosts = ¤t_machine_ids();
1288: foreach my $lonhost (@hosts) {
1289: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1290: $dom_in_use = $dom;
1291: $lonhost_in_use = $lonhost;
1.1123 raeburn 1292: last;
1293: }
1294: }
1.1126 raeburn 1295: if ($dom_in_use ne '') {
1296: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1297: }
1298: if (ref($result) ne 'HASH') {
1299: $lonhost_in_use = $perlvar{'lonHostID'};
1300: $dom_in_use = &host_domain($lonhost_in_use);
1301: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1302: if (ref($result) ne 'HASH') {
1303: $result = \%spareid;
1304: }
1305: }
1306: return $result;
1307: }
1308:
1309: sub spares_for_offload {
1310: my ($dom_in_use,$lonhost_in_use) = @_;
1311: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1312: if (defined($cached)) {
1313: return $result;
1314: } else {
1.1126 raeburn 1315: my $cachetime = 60*60*24;
1316: my %domconfig =
1317: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1318: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1319: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1320: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1321: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1322: }
1323: }
1324: }
1325: }
1.1126 raeburn 1326: return;
1.1123 raeburn 1327: }
1328:
1.1129 raeburn 1329: sub get_lonbalancer_config {
1330: my ($servers) = @_;
1331: my ($currbalancer,$currtargets);
1332: if (ref($servers) eq 'HASH') {
1333: foreach my $server (keys(%{$servers})) {
1334: my %what = (
1335: spareid => 1,
1336: perlvar => 1,
1337: );
1338: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1339: if ($result eq 'ok') {
1340: if (ref($returnhash) eq 'HASH') {
1341: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1342: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1343: $currbalancer = $server;
1344: $currtargets = {};
1345: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1346: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1347: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1348: }
1349: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1350: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1351: }
1352: }
1353: last;
1354: }
1355: }
1356: }
1357: }
1358: }
1359: }
1360: return ($currbalancer,$currtargets);
1361: }
1362:
1363: sub check_loadbalancing {
1.1331 raeburn 1364: my ($uname,$udom,$caller) = @_;
1.1191 raeburn 1365: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1366: $rule_in_effect,$offloadto,$otherserver);
1.1129 raeburn 1367: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1368: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1369: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1370: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1371: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1372: my $serverhomedom = &host_domain($lonhost);
1.1307 raeburn 1373: my $domneedscache;
1.1129 raeburn 1374: my $cachetime = 60*60*24;
1375:
1376: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1377: $dom_in_use = $udom;
1378: $homeintdom = 1;
1379: } else {
1380: $dom_in_use = $serverhomedom;
1381: }
1382: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1383: unless (defined($cached)) {
1384: my %domconfig =
1385: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1386: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1387: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1307 raeburn 1388: } else {
1389: $domneedscache = $dom_in_use;
1.1129 raeburn 1390: }
1391: }
1392: if (ref($result) eq 'HASH') {
1.1191 raeburn 1393: ($is_balancer,$currtargets,$currrules) =
1394: &check_balancer_result($result,@hosts);
1.1129 raeburn 1395: if ($is_balancer) {
1396: if (ref($currrules) eq 'HASH') {
1397: if ($homeintdom) {
1398: if ($uname ne '') {
1399: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1400: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1401: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1402: $rule_in_effect = $currrules->{'_LC_author'};
1403: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1404: $rule_in_effect = $currrules->{'_LC_adv'}
1405: }
1406: }
1407: if ($rule_in_effect eq '') {
1408: my %userenv = &userenvironment($udom,$uname,'inststatus');
1409: if ($userenv{'inststatus'} ne '') {
1410: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1411: my ($othertitle,$usertypes,$types) =
1412: &Apache::loncommon::sorted_inst_types($udom);
1413: if (ref($types) eq 'ARRAY') {
1414: foreach my $type (@{$types}) {
1415: if (grep(/^\Q$type\E$/,@statuses)) {
1416: if (exists($currrules->{$type})) {
1417: $rule_in_effect = $currrules->{$type};
1418: }
1419: }
1420: }
1421: }
1422: } else {
1423: if (exists($currrules->{'default'})) {
1424: $rule_in_effect = $currrules->{'default'};
1425: }
1426: }
1427: }
1428: } else {
1429: if (exists($currrules->{'default'})) {
1430: $rule_in_effect = $currrules->{'default'};
1431: }
1432: }
1433: } else {
1434: if ($currrules->{'_LC_external'} ne '') {
1435: $rule_in_effect = $currrules->{'_LC_external'};
1436: }
1437: }
1438: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1439: $uname,$udom);
1440: }
1441: }
1442: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1239 raeburn 1443: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1444: unless (defined($cached)) {
1445: my %domconfig =
1446: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1447: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1307 raeburn 1448: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1449: } else {
1450: $domneedscache = $serverhomedom;
1.1129 raeburn 1451: }
1452: }
1453: if (ref($result) eq 'HASH') {
1.1191 raeburn 1454: ($is_balancer,$currtargets,$currrules) =
1455: &check_balancer_result($result,@hosts);
1456: if ($is_balancer) {
1.1129 raeburn 1457: if (ref($currrules) eq 'HASH') {
1458: if ($currrules->{'_LC_internetdom'} ne '') {
1459: $rule_in_effect = $currrules->{'_LC_internetdom'};
1460: }
1461: }
1462: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1463: $uname,$udom);
1464: }
1465: } else {
1466: if ($perlvar{'lonBalancer'} eq 'yes') {
1467: $is_balancer = 1;
1468: $offloadto = &this_host_spares($dom_in_use);
1469: }
1.1307 raeburn 1470: unless (defined($cached)) {
1471: $domneedscache = $serverhomedom;
1472: }
1.1129 raeburn 1473: }
1474: } else {
1475: if ($perlvar{'lonBalancer'} eq 'yes') {
1476: $is_balancer = 1;
1477: $offloadto = &this_host_spares($dom_in_use);
1478: }
1.1307 raeburn 1479: unless (defined($cached)) {
1480: $domneedscache = $serverhomedom;
1481: }
1482: }
1483: if ($domneedscache) {
1484: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129 raeburn 1485: }
1.1176 raeburn 1486: if ($is_balancer) {
1487: my $lowest_load = 30000;
1488: if (ref($offloadto) eq 'HASH') {
1489: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1490: foreach my $try_server (@{$offloadto->{'primary'}}) {
1491: ($otherserver,$lowest_load) =
1492: &compare_server_load($try_server,$otherserver,$lowest_load);
1493: }
1.1129 raeburn 1494: }
1.1176 raeburn 1495: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1496:
1.1176 raeburn 1497: if (!$found_server) {
1498: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1499: foreach my $try_server (@{$offloadto->{'default'}}) {
1500: ($otherserver,$lowest_load) =
1501: &compare_server_load($try_server,$otherserver,$lowest_load);
1502: }
1503: }
1504: }
1505: } elsif (ref($offloadto) eq 'ARRAY') {
1506: if (@{$offloadto} == 1) {
1507: $otherserver = $offloadto->[0];
1508: } elsif (@{$offloadto} > 1) {
1509: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1510: ($otherserver,$lowest_load) =
1511: &compare_server_load($try_server,$otherserver,$lowest_load);
1512: }
1513: }
1514: }
1.1331 raeburn 1515: unless ($caller eq 'login') {
1516: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1517: $is_balancer = 0;
1518: if ($uname ne '' && $udom ne '') {
1519: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1.1176 raeburn 1520:
1.1331 raeburn 1521: &appenv({'user.loadbalexempt' => $lonhost,
1522: 'user.loadbalcheck.time' => time});
1523: }
1.1176 raeburn 1524: }
1.1129 raeburn 1525: }
1526: }
1527: }
1528: return ($is_balancer,$otherserver);
1529: }
1530:
1.1191 raeburn 1531: sub check_balancer_result {
1532: my ($result,@hosts) = @_;
1533: my ($is_balancer,$currtargets,$currrules);
1534: if (ref($result) eq 'HASH') {
1535: if ($result->{'lonhost'} ne '') {
1536: my $currbalancer = $result->{'lonhost'};
1537: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1538: $is_balancer = 1;
1539: $currtargets = $result->{'targets'};
1540: $currrules = $result->{'rules'};
1541: }
1542: } else {
1543: foreach my $key (keys(%{$result})) {
1544: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1545: (ref($result->{$key}) eq 'HASH')) {
1546: $is_balancer = 1;
1547: $currrules = $result->{$key}{'rules'};
1548: $currtargets = $result->{$key}{'targets'};
1549: last;
1550: }
1551: }
1552: }
1553: }
1554: return ($is_balancer,$currtargets,$currrules);
1555: }
1556:
1.1129 raeburn 1557: sub get_loadbalancer_targets {
1558: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1559: my $offloadto;
1.1175 raeburn 1560: if ($rule_in_effect eq 'none') {
1561: return [$perlvar{'lonHostID'}];
1562: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1563: $offloadto = $currtargets;
1564: } else {
1565: if ($rule_in_effect eq 'homeserver') {
1566: my $homeserver = &homeserver($uname,$udom);
1567: if ($homeserver ne 'no_host') {
1568: $offloadto = [$homeserver];
1569: }
1570: } elsif ($rule_in_effect eq 'externalbalancer') {
1571: my %domconfig =
1572: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1573: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1574: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1575: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1576: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1577: }
1578: }
1579: } else {
1.1178 raeburn 1580: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1581: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1582: if (&hostname($remotebalancer) ne '') {
1583: $offloadto = [$remotebalancer];
1584: }
1585: }
1586: } elsif (&hostname($rule_in_effect) ne '') {
1587: $offloadto = [$rule_in_effect];
1588: }
1589: }
1590: return $offloadto;
1591: }
1592:
1.1127 raeburn 1593: sub internet_dom_servers {
1594: my ($dom) = @_;
1595: my (%uniqservers,%servers);
1596: my $primaryserver = &hostname(&domain($dom,'primary'));
1597: my @machinedoms = &machine_domains($primaryserver);
1598: foreach my $mdom (@machinedoms) {
1599: my %currservers = %servers;
1600: my %server = &get_servers($mdom);
1601: %servers = (%currservers,%server);
1602: }
1603: my %by_hostname;
1604: foreach my $id (keys(%servers)) {
1605: push(@{$by_hostname{$servers{$id}}},$id);
1606: }
1607: foreach my $hostname (sort(keys(%by_hostname))) {
1608: if (@{$by_hostname{$hostname}} > 1) {
1609: my $match = 0;
1610: foreach my $id (@{$by_hostname{$hostname}}) {
1611: if (&host_domain($id) eq $dom) {
1612: $uniqservers{$id} = $hostname;
1613: $match = 1;
1614: }
1615: }
1616: unless ($match) {
1617: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1618: }
1619: } else {
1620: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1621: }
1622: }
1623: return %uniqservers;
1624: }
1625:
1.1347 raeburn 1626: sub trusted_domains {
1627: my ($cmdtype,$calldom) = @_;
1.1349 raeburn 1628: my ($trusted,$untrusted);
1.1347 raeburn 1629: if (&domain($calldom) eq '') {
1.1349 raeburn 1630: return ($trusted,$untrusted);
1.1347 raeburn 1631: }
1632: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|domroles|catalog|reqcrs|msg)$/) {
1.1349 raeburn 1633: return ($trusted,$untrusted);
1.1347 raeburn 1634: }
1635: my $callprimary = &domain($calldom,'primary');
1636: my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
1637: if ($intcalldom eq '') {
1.1349 raeburn 1638: return ($trusted,$untrusted);
1.1347 raeburn 1639: }
1640:
1641: my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
1642: unless (defined($cached)) {
1643: my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
1644: &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1645: $trustconfig = $domconfig{'trust'};
1646: }
1647: if (ref($trustconfig)) {
1648: my (%possexc,%possinc,@allexc,@allinc);
1649: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1650: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1651: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1652: }
1653: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1654: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1655: }
1656: }
1657: if (keys(%possexc)) {
1658: if (keys(%possinc)) {
1659: foreach my $key (sort(keys(%possexc))) {
1660: next if ($key eq $intcalldom);
1661: unless ($possinc{$key}) {
1662: push(@allexc,$key);
1663: }
1664: }
1665: } else {
1666: @allexc = sort(keys(%possexc));
1667: }
1668: }
1669: if (keys(%possinc)) {
1670: $possinc{$intcalldom} = 1;
1671: @allinc = sort(keys(%possinc));
1672: }
1673: if ((@allexc > 0) || (@allinc > 0)) {
1674: my %doms_by_intdom;
1675: my %allintdoms = &all_host_intdom();
1676: my %alldoms = &all_host_domain();
1677: foreach my $key (%allintdoms) {
1678: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1679: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1680: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1681: }
1682: } else {
1683: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1684: }
1685: }
1686: foreach my $exc (@allexc) {
1687: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1.1349 raeburn 1688: $untrusted = $doms_by_intdom{$exc};
1.1347 raeburn 1689: }
1690: }
1691: foreach my $inc (@allinc) {
1692: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1.1349 raeburn 1693: $trusted = $doms_by_intdom{$inc};
1.1347 raeburn 1694: }
1695: }
1696: }
1697: }
1.1349 raeburn 1698: return ($trusted,$untrusted);
1.1347 raeburn 1699: }
1700:
1701: sub will_trust {
1702: my ($cmdtype,$domain,$possdom) = @_;
1703: return 1 if ($domain eq $possdom);
1704: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1705: my $willtrust;
1706: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1707: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1708: $willtrust = 1;
1709: }
1710: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1711: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1712: $willtrust = 1;
1713: }
1714: } else {
1715: $willtrust = 1;
1716: }
1717: return $willtrust;
1718: }
1719:
1.1 albertel 1720: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1721:
1.599 albertel 1722: my %homecache;
1.1 albertel 1723: sub homeserver {
1.230 stredwic 1724: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1725: my $index="$uname:$udom";
1.426 albertel 1726:
1.599 albertel 1727: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1728:
1729: my %servers = &get_servers($udom,'library');
1730: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1731: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1732: exists($badServerCache{$tryserver}));
1.841 albertel 1733:
1734: my $answer=reply("home:$udom:$uname",$tryserver);
1735: if ($answer eq 'found') {
1736: delete($badServerCache{$tryserver});
1737: return $homecache{$index}=$tryserver;
1738: } elsif ($answer eq 'no_host') {
1739: $badServerCache{$tryserver}=1;
1740: }
1.1 albertel 1741: }
1742: return 'no_host';
1.70 www 1743: }
1744:
1.1300 raeburn 1745: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1.70 www 1746:
1747: sub idget {
1.1300 raeburn 1748: my ($udom,$idsref,$namespace)=@_;
1.70 www 1749: my %returnhash=();
1.1300 raeburn 1750: my @ids=();
1751: if (ref($idsref) eq 'ARRAY') {
1752: @ids = @{$idsref};
1753: } else {
1754: return %returnhash;
1755: }
1756: if ($namespace eq '') {
1757: $namespace = 'ids';
1758: }
1.70 www 1759:
1.841 albertel 1760: my %servers = &get_servers($udom,'library');
1761: foreach my $tryserver (keys(%servers)) {
1.1299 raeburn 1762: my $idlist=join('&', map { &escape($_); } @ids);
1.1300 raeburn 1763: if ($namespace eq 'ids') {
1764: $idlist=~tr/A-Z/a-z/;
1765: }
1766: my $reply;
1767: if ($namespace eq 'ids') {
1768: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1769: } else {
1770: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1771: }
1.841 albertel 1772: my @answer=();
1773: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1774: @answer=split(/\&/,$reply);
1775: } ;
1776: my $i;
1777: for ($i=0;$i<=$#ids;$i++) {
1778: if ($answer[$i]) {
1.1299 raeburn 1779: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1.1300 raeburn 1780: }
1.841 albertel 1781: }
1.1300 raeburn 1782: }
1.70 www 1783: return %returnhash;
1784: }
1785:
1786: # ------------------------------------- Find the IDs behind a list of usernames
1787:
1788: sub idrget {
1789: my ($udom,@unames)=@_;
1790: my %returnhash=();
1.800 albertel 1791: foreach my $uname (@unames) {
1792: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1793: }
1.70 www 1794: return %returnhash;
1795: }
1796:
1.1300 raeburn 1797: # Store away a list of names and associated student/employee IDs or clicker IDs
1.70 www 1798:
1799: sub idput {
1.1300 raeburn 1800: my ($udom,$idsref,$uhom,$namespace)=@_;
1.70 www 1801: my %servers=();
1.1300 raeburn 1802: my %ids=();
1803: my %byid = ();
1804: if (ref($idsref) eq 'HASH') {
1805: %ids=%{$idsref};
1806: }
1807: if ($namespace eq '') {
1808: $namespace = 'ids';
1809: }
1.800 albertel 1810: foreach my $uname (keys(%ids)) {
1811: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1.1300 raeburn 1812: if ($uhom eq '') {
1813: $uhom=&homeserver($uname,$udom);
1814: }
1.70 www 1815: if ($uhom ne 'no_host') {
1.800 albertel 1816: my $esc_unam=&escape($uname);
1.1300 raeburn 1817: if ($namespace eq 'ids') {
1818: my $id=&escape($ids{$uname});
1819: $id=~tr/A-Z/a-z/;
1820: my $esc_unam=&escape($uname);
1821: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1.70 www 1822: } else {
1.1300 raeburn 1823: my @currids = split(/,/,$ids{$uname});
1824: foreach my $id (@currids) {
1825: $byid{$uhom}{$id} .= $uname.',';
1826: }
1827: }
1828: }
1829: }
1830: if ($namespace eq 'clickers') {
1831: foreach my $server (keys(%byid)) {
1832: if (ref($byid{$server}) eq 'HASH') {
1833: foreach my $id (keys(%{$byid{$server}})) {
1834: $byid{$server} =~ s/,$//;
1835: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
1836: }
1.70 www 1837: }
1838: }
1.191 harris41 1839: }
1.800 albertel 1840: foreach my $server (keys(%servers)) {
1.1300 raeburn 1841: $servers{$server} =~ s/\&$//;
1842: if ($namespace eq 'ids') {
1843: &critical('idput:'.$udom.':'.$servers{$server},$server);
1844: } else {
1845: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
1846: }
1.191 harris41 1847: }
1.344 www 1848: }
1849:
1.1300 raeburn 1850: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1.1231 raeburn 1851:
1852: sub iddel {
1.1300 raeburn 1853: my ($udom,$idshashref,$uhome,$namespace)=@_;
1.1231 raeburn 1854: my %result=();
1.1300 raeburn 1855: my %ids=();
1856: my %byid = ();
1857: if (ref($idshashref) eq 'HASH') {
1858: %ids=%{$idshashref};
1859: } else {
1.1231 raeburn 1860: return %result;
1861: }
1.1300 raeburn 1862: if ($namespace eq '') {
1863: $namespace = 'ids';
1864: }
1.1231 raeburn 1865: my %servers=();
1.1300 raeburn 1866: while (my ($id,$unamestr) = each(%ids)) {
1867: if ($namespace eq 'ids') {
1868: my $uhom = $uhome;
1869: if ($uhom eq '') {
1870: $uhom=&homeserver($unamestr,$udom);
1871: }
1872: if ($uhom ne 'no_host') {
1873: $servers{$uhom}.='&'.&escape($id);
1874: }
1875: } else {
1876: my @curritems = split(/,/,$ids{$id});
1877: foreach my $uname (@curritems) {
1878: my $uhom = $uhome;
1879: if ($uhom eq '') {
1880: $uhom=&homeserver($uname,$udom);
1881: }
1882: if ($uhom ne 'no_host') {
1883: $byid{$uhom}{$id} .= $uname.',';
1884: }
1885: }
1.1231 raeburn 1886: }
1.1300 raeburn 1887: }
1888: if ($namespace eq 'clickers') {
1889: foreach my $server (keys(%byid)) {
1890: if (ref($byid{$server}) eq 'HASH') {
1891: foreach my $id (keys(%{$byid{$server}})) {
1892: $byid{$server}{$id} =~ s/,$//;
1893: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
1894: }
1.1231 raeburn 1895: }
1896: }
1897: }
1898: foreach my $server (keys(%servers)) {
1.1300 raeburn 1899: $servers{$server} =~ s/\&$//;
1900: if ($namespace eq 'ids') {
1901: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1902: } elsif ($namespace eq 'clickers') {
1903: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
1904: }
1.1231 raeburn 1905: }
1906: return %result;
1907: }
1908:
1.1300 raeburn 1909: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
1910:
1911: sub updateclickers {
1912: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
1913: my %clickers;
1914: if (ref($idshashref) eq 'HASH') {
1915: %clickers=%{$idshashref};
1916: } else {
1917: return;
1918: }
1919: my $items='';
1920: foreach my $item (keys(%clickers)) {
1921: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
1922: }
1923: $items=~s/\&$//;
1924: my $request = "updateclickers:$udom:$action:$items";
1925: if ($critical) {
1926: return &critical($request,$uhome);
1927: } else {
1928: return &reply($request,$uhome);
1929: }
1930: }
1931:
1.1023 raeburn 1932: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 1933: sub dump_dom {
1.1165 droeschl 1934: my ($namespace, $udom, $regexp) = @_;
1935:
1936: $udom ||= $env{'user.domain'};
1937:
1938: return () unless $udom;
1939:
1940: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 1941: }
1942:
1.1023 raeburn 1943: # ------------------------------------------ get items from domain db files
1.806 raeburn 1944:
1945: sub get_dom {
1.860 raeburn 1946: my ($namespace,$storearr,$udom,$uhome)=@_;
1.1267 raeburn 1947: return if ($udom eq 'public');
1.806 raeburn 1948: my $items='';
1949: foreach my $item (@$storearr) {
1950: $items.=&escape($item).'&';
1951: }
1952: $items=~s/\&$//;
1.860 raeburn 1953: if (!$udom) {
1954: $udom=$env{'user.domain'};
1.1267 raeburn 1955: return if ($udom eq 'public');
1.860 raeburn 1956: if (defined(&domain($udom,'primary'))) {
1957: $uhome=&domain($udom,'primary');
1958: } else {
1.874 albertel 1959: undef($uhome);
1.860 raeburn 1960: }
1961: } else {
1962: if (!$uhome) {
1963: if (defined(&domain($udom,'primary'))) {
1964: $uhome=&domain($udom,'primary');
1965: }
1966: }
1967: }
1968: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.1344 raeburn 1969: my $rep;
1970: if ($namespace =~ /^enc/) {
1971: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
1972: } else {
1973: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1974: }
1.866 raeburn 1975: my %returnhash;
1.875 albertel 1976: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1977: return %returnhash;
1978: }
1.806 raeburn 1979: my @pairs=split(/\&/,$rep);
1980: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1981: return @pairs;
1982: }
1983: my $i=0;
1984: foreach my $item (@$storearr) {
1985: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1986: $i++;
1987: }
1988: return %returnhash;
1989: } else {
1.880 banghart 1990: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1991: }
1992: }
1993:
1994: # -------------------------------------------- put items in domain db files
1995:
1996: sub put_dom {
1.860 raeburn 1997: my ($namespace,$storehash,$udom,$uhome)=@_;
1998: if (!$udom) {
1999: $udom=$env{'user.domain'};
2000: if (defined(&domain($udom,'primary'))) {
2001: $uhome=&domain($udom,'primary');
2002: } else {
1.874 albertel 2003: undef($uhome);
1.860 raeburn 2004: }
2005: } else {
2006: if (!$uhome) {
2007: if (defined(&domain($udom,'primary'))) {
2008: $uhome=&domain($udom,'primary');
2009: }
2010: }
2011: }
2012: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 2013: my $items='';
2014: foreach my $item (keys(%$storehash)) {
2015: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2016: }
2017: $items=~s/\&$//;
1.1344 raeburn 2018: if ($namespace =~ /^enc/) {
2019: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2020: } else {
2021: return &reply("putdom:$udom:$namespace:$items",$uhome);
2022: }
1.806 raeburn 2023: } else {
1.860 raeburn 2024: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 2025: }
2026: }
2027:
1.1023 raeburn 2028: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 2029: sub newput_dom {
1.1023 raeburn 2030: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 2031: my $result;
2032: if (!$udom) {
2033: $udom=$env{'user.domain'};
2034: }
1.1023 raeburn 2035: if ($udom) {
2036: my $uname = &get_domainconfiguser($udom);
2037: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 2038: }
2039: return $result;
2040: }
2041:
1.1023 raeburn 2042: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 2043: sub del_dom {
1.1023 raeburn 2044: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 2045: if (ref($storearr) eq 'ARRAY') {
2046: if (!$udom) {
2047: $udom=$env{'user.domain'};
2048: }
1.1023 raeburn 2049: if ($udom) {
2050: my $uname = &get_domainconfiguser($udom);
2051: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 2052: }
2053: }
2054: }
2055:
1.1023 raeburn 2056: # ----------------------------------construct domainconfig user for a domain
2057: sub get_domainconfiguser {
2058: my ($udom) = @_;
2059: return $udom.'-domainconfig';
2060: }
2061:
1.837 raeburn 2062: sub retrieve_inst_usertypes {
2063: my ($udom) = @_;
2064: my (%returnhash,@order);
1.989 raeburn 2065: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
2066: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2067: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256 raeburn 2068: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 2069: } else {
2070: if (defined(&domain($udom,'primary'))) {
2071: my $uhome=&domain($udom,'primary');
2072: my $rep=&reply("inst_usertypes:$udom",$uhome);
2073: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1256 raeburn 2074: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 2075: return (\%returnhash,\@order);
2076: }
2077: my ($hashitems,$orderitems) = split(/:/,$rep);
2078: my @pairs=split(/\&/,$hashitems);
2079: foreach my $item (@pairs) {
2080: my ($key,$value)=split(/=/,$item,2);
2081: $key = &unescape($key);
2082: next if ($key =~ /^error: 2 /);
2083: $returnhash{$key}=&thaw_unescape($value);
2084: }
2085: my @esc_order = split(/\&/,$orderitems);
2086: foreach my $item (@esc_order) {
2087: push(@order,&unescape($item));
2088: }
2089: } else {
1.1256 raeburn 2090: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 2091: }
1.1256 raeburn 2092: return (\%returnhash,\@order);
1.837 raeburn 2093: }
2094: }
2095:
1.868 raeburn 2096: sub is_domainimage {
2097: my ($url) = @_;
1.1306 raeburn 2098: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1.868 raeburn 2099: if (&domain($1) ne '') {
2100: return '1';
2101: }
2102: }
2103: return;
2104: }
2105:
1.899 raeburn 2106: sub inst_directory_query {
2107: my ($srch) = @_;
2108: my $udom = $srch->{'srchdomain'};
2109: my %results;
2110: my $homeserver = &domain($udom,'primary');
1.909 raeburn 2111: my $outcome;
1.899 raeburn 2112: if ($homeserver ne '') {
1.1357 raeburn 2113: unless ($homeserver eq $perlvar{'lonHostID'}) {
2114: if ($srch->{'srchby'} eq 'email') {
2115: my $lcrev = &get_server_loncaparev(undef,$homeserver);
2116: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2117: if (($major eq '' && $minor eq '') || ($major < 2) ||
2118: (($major == 2) && ($minor < 12))) {
2119: return;
2120: }
2121: }
2122: }
1.904 albertel 2123: my $queryid=&reply("querysend:instdirsearch:".
2124: &escape($srch->{'srchby'}).':'.
2125: &escape($srch->{'srchterm'}).':'.
2126: &escape($srch->{'srchtype'}),$homeserver);
2127: my $host=&hostname($homeserver);
2128: if ($queryid !~/^\Q$host\E\_/) {
1.1343 raeburn 2129: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
1.904 albertel 2130: return;
2131: }
2132: my $response = &get_query_reply($queryid);
2133: my $maxtries = 5;
2134: my $tries = 1;
2135: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2136: $response = &get_query_reply($queryid);
2137: $tries ++;
2138: }
2139:
2140: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 2141: if ($response eq 'unavailable') {
2142: $outcome = $response;
2143: } else {
2144: $outcome = 'ok';
2145: my @matches = split(/\n/,$response);
2146: foreach my $match (@matches) {
2147: my ($key,$value) = split(/=/,$match);
2148: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2149: }
1.899 raeburn 2150: }
2151: }
2152: }
1.909 raeburn 2153: return ($outcome,%results);
1.899 raeburn 2154: }
2155:
2156: sub usersearch {
2157: my ($srch) = @_;
2158: my $dom = $srch->{'srchdomain'};
2159: my %results;
2160: my %libserv = &all_library();
2161: my $query = 'usersearch';
2162: foreach my $tryserver (keys(%libserv)) {
2163: if (&host_domain($tryserver) eq $dom) {
1.1357 raeburn 2164: unless ($tryserver eq $perlvar{'lonHostID'}) {
2165: if ($srch->{'srchby'} eq 'email') {
2166: my $lcrev = &get_server_loncaparev(undef,$tryserver);
2167: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2168: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2169: (($major == 2) && ($minor < 12)));
2170: }
2171: }
1.899 raeburn 2172: my $host=&hostname($tryserver);
2173: my $queryid=
1.911 raeburn 2174: &reply("querysend:".&escape($query).':'.
2175: &escape($srch->{'srchby'}).':'.
1.899 raeburn 2176: &escape($srch->{'srchtype'}).':'.
2177: &escape($srch->{'srchterm'}),$tryserver);
2178: if ($queryid !~/^\Q$host\E\_/) {
2179: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 2180: next;
1.899 raeburn 2181: }
2182: my $reply = &get_query_reply($queryid);
2183: my $maxtries = 1;
2184: my $tries = 1;
2185: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2186: $reply = &get_query_reply($queryid);
2187: $tries ++;
2188: }
2189: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2190: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2191: } else {
1.911 raeburn 2192: my @matches;
2193: if ($reply =~ /\n/) {
2194: @matches = split(/\n/,$reply);
2195: } else {
2196: @matches = split(/\&/,$reply);
2197: }
1.899 raeburn 2198: foreach my $match (@matches) {
2199: my ($uname,$udom,%userhash);
1.911 raeburn 2200: foreach my $entry (split(/:/,$match)) {
2201: my ($key,$value) =
2202: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 2203: $userhash{$key} = $value;
2204: if ($key eq 'username') {
2205: $uname = $value;
2206: } elsif ($key eq 'domain') {
2207: $udom = $value;
1.911 raeburn 2208: }
1.899 raeburn 2209: }
2210: $results{$uname.':'.$udom} = \%userhash;
2211: }
2212: }
2213: }
2214: }
2215: return %results;
2216: }
2217:
1.912 raeburn 2218: sub get_instuser {
2219: my ($udom,$uname,$id) = @_;
2220: my $homeserver = &domain($udom,'primary');
2221: my ($outcome,%results);
2222: if ($homeserver ne '') {
2223: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2224: &escape($id).':'.&escape($udom),$homeserver);
2225: my $host=&hostname($homeserver);
2226: if ($queryid !~/^\Q$host\E\_/) {
2227: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2228: return;
2229: }
2230: my $response = &get_query_reply($queryid);
2231: my $maxtries = 5;
2232: my $tries = 1;
2233: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2234: $response = &get_query_reply($queryid);
2235: $tries ++;
2236: }
2237: if (!&error($response) && $response ne 'refused') {
2238: if ($response eq 'unavailable') {
2239: $outcome = $response;
2240: } else {
2241: $outcome = 'ok';
2242: my @matches = split(/\n/,$response);
2243: foreach my $match (@matches) {
2244: my ($key,$value) = split(/=/,$match);
2245: $results{&unescape($key)} = &thaw_unescape($value);
2246: }
2247: }
2248: }
2249: }
2250: my %userinfo;
2251: if (ref($results{$uname}) eq 'HASH') {
2252: %userinfo = %{$results{$uname}};
2253: }
2254: return ($outcome,%userinfo);
2255: }
2256:
1.1290 raeburn 2257: sub get_multiple_instusers {
2258: my ($udom,$users,$caller) = @_;
2259: my ($outcome,$results);
2260: if (ref($users) eq 'HASH') {
2261: my $count = keys(%{$users});
2262: my $requested = &freeze_escape($users);
2263: my $homeserver = &domain($udom,'primary');
2264: if ($homeserver ne '') {
2265: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2266: my $host=&hostname($homeserver);
2267: if ($queryid !~/^\Q$host\E\_/) {
2268: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2269: ' for host: '.$homeserver.'in domain '.$udom);
2270: return ($outcome,$results);
2271: }
2272: my $response = &get_query_reply($queryid);
2273: my $maxtries = 5;
2274: if ($count > 100) {
2275: $maxtries = 1+int($count/20);
2276: }
2277: my $tries = 1;
2278: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2279: $response = &get_query_reply($queryid);
2280: $tries ++;
2281: }
2282: if ($response eq '') {
2283: $results = {};
2284: foreach my $key (keys(%{$users})) {
2285: my ($uname,$id);
2286: if ($caller eq 'id') {
2287: $id = $key;
2288: } else {
2289: $uname = $key;
2290: }
2291: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1.1291 raeburn 2292: $outcome = $resp;
1.1290 raeburn 2293: if ($resp eq 'ok') {
2294: %{$results} = (%{$results}, %info);
2295: } else {
2296: last;
2297: }
2298: }
2299: } elsif(!&error($response) && ($response ne 'refused')) {
2300: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2301: $outcome = $response;
2302: } else {
1.1291 raeburn 2303: ($outcome,my $userdata) = split(/=/,$response,2);
1.1290 raeburn 2304: if ($outcome eq 'ok') {
2305: $results = &thaw_unescape($userdata);
2306: }
2307: }
2308: }
2309: }
2310: }
2311: return ($outcome,$results);
2312: }
2313:
1.912 raeburn 2314: sub inst_rulecheck {
1.923 raeburn 2315: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 2316: my %returnhash;
2317: if ($udom ne '') {
2318: if (ref($rules) eq 'ARRAY') {
2319: @{$rules} = map {&escape($_);} (@{$rules});
2320: my $rulestr = join(':',@{$rules});
2321: my $homeserver=&domain($udom,'primary');
2322: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2323: my $response;
2324: if ($item eq 'username') {
2325: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2326: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2327: $homeserver));
1.923 raeburn 2328: } elsif ($item eq 'id') {
2329: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2330: ':'.&escape($id).':'.$rulestr,
2331: $homeserver));
1.945 raeburn 2332: } elsif ($item eq 'selfcreate') {
2333: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2334: &escape($udom).':'.&escape($uname).
2335: ':'.$rulestr,$homeserver));
1.923 raeburn 2336: }
1.912 raeburn 2337: if ($response ne 'refused') {
2338: my @pairs=split(/\&/,$response);
2339: foreach my $item (@pairs) {
2340: my ($key,$value)=split(/=/,$item,2);
2341: $key = &unescape($key);
2342: next if ($key =~ /^error: 2 /);
2343: $returnhash{$key}=&thaw_unescape($value);
2344: }
2345: }
2346: }
2347: }
2348: }
2349: return %returnhash;
2350: }
2351:
2352: sub inst_userrules {
1.923 raeburn 2353: my ($udom,$check) = @_;
1.912 raeburn 2354: my (%ruleshash,@ruleorder);
2355: if ($udom ne '') {
2356: my $homeserver=&domain($udom,'primary');
2357: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2358: my $response;
2359: if ($check eq 'id') {
2360: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2361: $homeserver);
1.943 raeburn 2362: } elsif ($check eq 'email') {
2363: $response=&reply('instemailrules:'.&escape($udom),
2364: $homeserver);
1.923 raeburn 2365: } else {
2366: $response=&reply('instuserrules:'.&escape($udom),
2367: $homeserver);
2368: }
1.912 raeburn 2369: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2370: ($response ne 'unknown_cmd') &&
1.912 raeburn 2371: ($response ne 'no_such_host')) {
2372: my ($hashitems,$orderitems) = split(/:/,$response);
2373: my @pairs=split(/\&/,$hashitems);
2374: foreach my $item (@pairs) {
2375: my ($key,$value)=split(/=/,$item,2);
2376: $key = &unescape($key);
2377: next if ($key =~ /^error: 2 /);
2378: $ruleshash{$key}=&thaw_unescape($value);
2379: }
2380: my @esc_order = split(/\&/,$orderitems);
2381: foreach my $item (@esc_order) {
2382: push(@ruleorder,&unescape($item));
2383: }
2384: }
2385: }
2386: }
2387: return (\%ruleshash,\@ruleorder);
2388: }
2389:
1.976 raeburn 2390: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2391:
2392: sub get_domain_defaults {
1.1240 raeburn 2393: my ($domain,$ignore_cache) = @_;
1.1242 raeburn 2394: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2395: my $cachetime = 60*60*24;
1.1240 raeburn 2396: unless ($ignore_cache) {
2397: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2398: if (defined($cached)) {
2399: if (ref($result) eq 'HASH') {
2400: return %{$result};
2401: }
1.943 raeburn 2402: }
2403: }
2404: my %domdefaults;
2405: my %domconfig =
1.989 raeburn 2406: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2407: 'requestcourses','inststatus',
1.1183 raeburn 2408: 'coursedefaults','usersessions',
1.1258 raeburn 2409: 'requestauthor','selfenrollment',
1.1320 raeburn 2410: 'coursecategories','ssl','autoenroll',
1.1332 raeburn 2411: 'trust','helpsettings'],$domain);
1.1305 raeburn 2412: my @coursetypes = ('official','unofficial','community','textbook','placement');
1.943 raeburn 2413: if (ref($domconfig{'defaults'}) eq 'HASH') {
2414: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2415: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2416: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2417: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2418: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2419: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.1340 raeburn 2420: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2421: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2422: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.943 raeburn 2423: } else {
2424: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2425: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2426: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2427: }
1.976 raeburn 2428: if (ref($domconfig{'quotas'}) eq 'HASH') {
2429: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2430: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2431: } else {
2432: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2433: }
1.1177 raeburn 2434: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2435: foreach my $item (@usertools) {
2436: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2437: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2438: }
2439: }
1.1229 raeburn 2440: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2441: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2442: }
1.976 raeburn 2443: }
1.985 raeburn 2444: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1305 raeburn 2445: foreach my $item ('official','unofficial','community','textbook','placement') {
1.985 raeburn 2446: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2447: }
2448: }
1.1183 raeburn 2449: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2450: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2451: }
1.989 raeburn 2452: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256 raeburn 2453: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2454: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2455: }
2456: }
1.1047 raeburn 2457: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2458: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277 raeburn 2459: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2460: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2461: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2462: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2463: }
1.1254 raeburn 2464: foreach my $type (@coursetypes) {
2465: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2466: unless ($type eq 'community') {
2467: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2468: }
2469: }
2470: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2471: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2472: }
1.1277 raeburn 2473: if ($domdefaults{'postsubmit'} eq 'on') {
2474: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2475: $domdefaults{$type.'postsubtimeout'} =
2476: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2477: }
2478: }
1.1230 raeburn 2479: }
1.1286 raeburn 2480: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2481: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2482: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2483: if (@clonecodes) {
2484: $domdefaults{'canclone'} = join('+',@clonecodes);
2485: }
2486: }
2487: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2488: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2489: }
1.1356 raeburn 2490: if ($domconfig{'coursedefaults'}{'texengine'}) {
2491: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
2492: }
1.1047 raeburn 2493: }
1.1073 raeburn 2494: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2495: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2496: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2497: }
2498: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2499: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2500: }
1.1279 raeburn 2501: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2502: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2503: }
1.1073 raeburn 2504: }
1.1254 raeburn 2505: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2506: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2507: my @settings = ('types','registered','enroll_dates','access_dates','section',
2508: 'approval','limit');
2509: foreach my $type (@coursetypes) {
2510: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2511: my @mgrdc = ();
2512: foreach my $item (@settings) {
2513: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2514: push(@mgrdc,$item);
2515: }
2516: }
2517: if (@mgrdc) {
2518: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2519: }
2520: }
2521: }
2522: }
2523: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2524: foreach my $type (@coursetypes) {
2525: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2526: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2527: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2528: }
2529: }
2530: }
2531: }
2532: }
1.1258 raeburn 2533: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2534: $domdefaults{'catauth'} = 'std';
2535: $domdefaults{'catunauth'} = 'std';
2536: if ($domconfig{'coursecategories'}{'auth'}) {
2537: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2538: }
2539: if ($domconfig{'coursecategories'}{'unauth'}) {
2540: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2541: }
2542: }
1.1315 raeburn 2543: if (ref($domconfig{'ssl'}) eq 'HASH') {
2544: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2545: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2546: }
1.1338 raeburn 2547: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2548: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2549: }
2550: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2551: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
1.1315 raeburn 2552: }
2553: }
1.1320 raeburn 2554: if (ref($domconfig{'trust'}) eq 'HASH') {
2555: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2556: foreach my $prefix (@prefixes) {
2557: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2558: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2559: }
2560: }
2561: }
1.1314 raeburn 2562: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2563: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2564: }
1.1332 raeburn 2565: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2566: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2567: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2568: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2569: }
2570: }
1.1219 raeburn 2571: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2572: return %domdefaults;
2573: }
2574:
1.1311 raeburn 2575: sub course_portal_url {
2576: my ($cnum,$cdom) = @_;
2577: my $chome = &homeserver($cnum,$cdom);
2578: my $hostname = &hostname($chome);
2579: my $protocol = $protocol{$chome};
2580: $protocol = 'http' if ($protocol ne 'https');
2581: my %domdefaults = &get_domain_defaults($cdom);
2582: my $firsturl;
2583: if ($domdefaults{'portal_def'}) {
2584: $firsturl = $domdefaults{'portal_def'};
2585: } else {
2586: $firsturl = $protocol.'://'.$hostname;
2587: }
2588: return $firsturl;
2589: }
2590:
1.344 www 2591: # --------------------------------------------------- Assign a key to a student
2592:
2593: sub assign_access_key {
1.364 www 2594: #
2595: # a valid key looks like uname:udom#comments
2596: # comments are being appended
2597: #
1.498 www 2598: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2599: $kdom=
1.620 albertel 2600: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2601: $knum=
1.620 albertel 2602: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2603: $cdom=
1.620 albertel 2604: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2605: $cnum=
1.620 albertel 2606: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2607: $udom=$env{'user.name'} unless (defined($udom));
2608: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2609: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2610: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2611: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2612: # assigned to this person
2613: # - this should not happen,
1.345 www 2614: # unless something went wrong
2615: # the first time around
2616: # ready to assign
1.364 www 2617: $logentry=$1.'; '.$logentry;
1.496 www 2618: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2619: $kdom,$knum) eq 'ok') {
1.345 www 2620: # key now belongs to user
1.346 www 2621: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2622: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2623: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2624: return 'ok';
2625: } else {
2626: return
2627: 'error: Count not permanently assign key, will need to be re-entered later.';
2628: }
2629: } else {
2630: return 'error: Could not assign key, try again later.';
2631: }
1.364 www 2632: } elsif (!$existing{$ckey}) {
1.345 www 2633: # the key does not exist
2634: return 'error: The key does not exist';
2635: } else {
2636: # the key is somebody else's
2637: return 'error: The key is already in use';
2638: }
1.344 www 2639: }
2640:
1.364 www 2641: # ------------------------------------------ put an additional comment on a key
2642:
2643: sub comment_access_key {
2644: #
2645: # a valid key looks like uname:udom#comments
2646: # comments are being appended
2647: #
2648: my ($ckey,$cdom,$cnum,$logentry)=@_;
2649: $cdom=
1.620 albertel 2650: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2651: $cnum=
1.620 albertel 2652: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2653: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2654: if ($existing{$ckey}) {
2655: $existing{$ckey}.='; '.$logentry;
2656: # ready to assign
1.367 www 2657: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2658: $cdom,$cnum) eq 'ok') {
2659: return 'ok';
2660: } else {
2661: return 'error: Count not store comment.';
2662: }
2663: } else {
2664: # the key does not exist
2665: return 'error: The key does not exist';
2666: }
2667: }
2668:
1.344 www 2669: # ------------------------------------------------------ Generate a set of keys
2670:
2671: sub generate_access_keys {
1.364 www 2672: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2673: $cdom=
1.620 albertel 2674: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2675: $cnum=
1.620 albertel 2676: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2677: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2678: unless (($cdom) && ($cnum)) { return 0; }
2679: if ($number>10000) { return 0; }
2680: sleep(2); # make sure don't get same seed twice
2681: srand(time()^($$+($$<<15))); # from "Programming Perl"
2682: my $total=0;
2683: for (my $i=1;$i<=$number;$i++) {
2684: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2685: sprintf("%lx",int(100000*rand)).'-'.
2686: sprintf("%lx",int(100000*rand));
2687: $newkey=~s/1/g/g; # folks mix up 1 and l
2688: $newkey=~s/0/h/g; # and also 0 and O
2689: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2690: if ($existing{$newkey}) {
2691: $i--;
2692: } else {
1.364 www 2693: if (&put('accesskeys',
2694: { $newkey => '# generated '.localtime().
1.620 albertel 2695: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 2696: '; '.$logentry },
2697: $cdom,$cnum) eq 'ok') {
1.344 www 2698: $total++;
2699: }
2700: }
2701: }
1.620 albertel 2702: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 2703: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2704: return $total;
2705: }
2706:
2707: # ------------------------------------------------------- Validate an accesskey
2708:
2709: sub validate_access_key {
2710: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2711: $cdom=
1.620 albertel 2712: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2713: $cnum=
1.620 albertel 2714: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2715: $udom=$env{'user.domain'} unless (defined($udom));
2716: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 2717: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 2718: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 2719: }
2720:
2721: # ------------------------------------- Find the section of student in a course
1.652 albertel 2722: sub devalidate_getsection_cache {
2723: my ($udom,$unam,$courseid)=@_;
2724: my $hashid="$udom:$unam:$courseid";
2725: &devalidate_cache_new('getsection',$hashid);
2726: }
1.298 matthew 2727:
1.815 albertel 2728: sub courseid_to_courseurl {
2729: my ($courseid) = @_;
2730: #already url style courseid
2731: return $courseid if ($courseid =~ m{^/});
2732:
2733: if (exists($env{'course.'.$courseid.'.num'})) {
2734: my $cnum = $env{'course.'.$courseid.'.num'};
2735: my $cdom = $env{'course.'.$courseid.'.domain'};
2736: return "/$cdom/$cnum";
2737: }
2738:
2739: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2740: if (exists($courseinfo{'num'})) {
2741: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2742: }
2743:
2744: return undef;
2745: }
2746:
1.298 matthew 2747: sub getsection {
2748: my ($udom,$unam,$courseid)=@_;
1.599 albertel 2749: my $cachetime=1800;
1.551 albertel 2750:
2751: my $hashid="$udom:$unam:$courseid";
1.599 albertel 2752: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 2753: if (defined($cached)) { return $result; }
2754:
1.298 matthew 2755: my %Pending;
2756: my %Expired;
2757: #
2758: # Each role can either have not started yet (pending), be active,
2759: # or have expired.
2760: #
2761: # If there is an active role, we are done.
2762: #
2763: # If there is more than one role which has not started yet,
2764: # choose the one which will start sooner
2765: # If there is one role which has not started yet, return it.
2766: #
2767: # If there is more than one expired role, choose the one which ended last.
2768: # If there is a role which has expired, return it.
2769: #
1.815 albertel 2770: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 2771: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 2772: foreach my $key (keys(%roleshash)) {
1.479 albertel 2773: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 2774: my $section=$1;
2775: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 2776: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 2777: my $now=time;
1.548 albertel 2778: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 2779: $Expired{$end}=$section;
2780: next;
2781: }
1.548 albertel 2782: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 2783: $Pending{$start}=$section;
2784: next;
2785: }
1.599 albertel 2786: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 2787: }
2788: #
2789: # Presumedly there will be few matching roles from the above
2790: # loop and the sorting time will be negligible.
2791: if (scalar(keys(%Pending))) {
2792: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 2793: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 2794: }
2795: if (scalar(keys(%Expired))) {
2796: my @sorted = sort {$a <=> $b} keys(%Expired);
2797: my $time = pop(@sorted);
1.599 albertel 2798: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 2799: }
1.599 albertel 2800: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 2801: }
1.70 www 2802:
1.599 albertel 2803: sub save_cache {
2804: &purge_remembered();
1.722 albertel 2805: #&Apache::loncommon::validate_page();
1.620 albertel 2806: undef(%env);
1.780 albertel 2807: undef($env_loaded);
1.599 albertel 2808: }
1.452 albertel 2809:
1.599 albertel 2810: my $to_remember=-1;
2811: my %remembered;
2812: my %accessed;
2813: my $kicks=0;
2814: my $hits=0;
1.849 albertel 2815: sub make_key {
2816: my ($name,$id) = @_;
1.872 albertel 2817: if (length($id) > 65
2818: && length(&escape($id)) > 200) {
2819: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2820: }
1.849 albertel 2821: return &escape($name.':'.$id);
2822: }
2823:
1.599 albertel 2824: sub devalidate_cache_new {
2825: my ($name,$id,$debug) = @_;
2826: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1319 damieng 2827: my $remembered_id=$name.':'.$id;
1.849 albertel 2828: $id=&make_key($name,$id);
1.599 albertel 2829: $memcache->delete($id);
1.1319 damieng 2830: delete($remembered{$remembered_id});
2831: delete($accessed{$remembered_id});
1.599 albertel 2832: }
2833:
2834: sub is_cached_new {
2835: my ($name,$id,$debug) = @_;
1.1319 damieng 2836: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
2837: if (exists($remembered{$remembered_id})) {
2838: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
2839: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2840: $hits++;
1.1319 damieng 2841: return ($remembered{$remembered_id},1);
1.599 albertel 2842: }
1.1319 damieng 2843: $id=&make_key($name,$id);
1.599 albertel 2844: my $value = $memcache->get($id);
2845: if (!(defined($value))) {
2846: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 2847: return (undef,undef);
1.416 albertel 2848: }
1.599 albertel 2849: if ($value eq '__undef__') {
2850: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2851: $value=undef;
2852: }
1.1319 damieng 2853: &make_room($remembered_id,$value,$debug);
1.599 albertel 2854: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2855: return ($value,1);
2856: }
2857:
2858: sub do_cache_new {
2859: my ($name,$id,$value,$time,$debug) = @_;
1.1319 damieng 2860: my $remembered_id=$name.':'.$id;
1.849 albertel 2861: $id=&make_key($name,$id);
1.599 albertel 2862: my $setvalue=$value;
2863: if (!defined($setvalue)) {
2864: $setvalue='__undef__';
2865: }
1.623 albertel 2866: if (!defined($time) ) {
2867: $time=600;
2868: }
1.599 albertel 2869: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 2870: my $result = $memcache->set($id,$setvalue,$time);
2871: if (! $result) {
1.872 albertel 2872: &logthis("caching of id -> $id failed");
1.910 albertel 2873: $memcache->disconnect_all();
1.872 albertel 2874: }
1.600 albertel 2875: # need to make a copy of $value
1.1319 damieng 2876: &make_room($remembered_id,$value,$debug);
1.599 albertel 2877: return $value;
2878: }
2879:
2880: sub make_room {
1.1319 damieng 2881: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 2882:
1.1319 damieng 2883: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 2884: : $value;
1.599 albertel 2885: if ($to_remember<0) { return; }
1.1319 damieng 2886: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2887: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2888: my $to_kick;
2889: my $max_time=0;
2890: foreach my $other (keys(%accessed)) {
2891: if (&tv_interval($accessed{$other}) > $max_time) {
2892: $to_kick=$other;
2893: $max_time=&tv_interval($accessed{$other});
2894: }
2895: }
2896: delete($remembered{$to_kick});
2897: delete($accessed{$to_kick});
2898: $kicks++;
2899: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 2900: return;
2901: }
2902:
1.599 albertel 2903: sub purge_remembered {
1.604 albertel 2904: #&logthis("Tossing ".scalar(keys(%remembered)));
2905: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 2906: undef(%remembered);
2907: undef(%accessed);
1.428 albertel 2908: }
1.70 www 2909: # ------------------------------------- Read an entry from a user's environment
2910:
2911: sub userenvironment {
2912: my ($udom,$unam,@what)=@_;
1.976 raeburn 2913: my $items;
2914: foreach my $item (@what) {
2915: $items.=&escape($item).'&';
2916: }
2917: $items=~s/\&$//;
1.70 www 2918: my %returnhash=();
1.1009 raeburn 2919: my $uhome = &homeserver($unam,$udom);
2920: unless ($uhome eq 'no_host') {
2921: my @answer=split(/\&/,
2922: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 2923: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2924: return %returnhash;
2925: }
1.1009 raeburn 2926: my $i;
2927: for ($i=0;$i<=$#what;$i++) {
2928: $returnhash{$what[$i]}=&unescape($answer[$i]);
2929: }
1.70 www 2930: }
2931: return %returnhash;
1.1 albertel 2932: }
2933:
1.617 albertel 2934: # ---------------------------------------------------------- Get a studentphoto
2935: sub studentphoto {
2936: my ($udom,$unam,$ext) = @_;
2937: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 2938: if (defined($env{'request.course.id'})) {
1.708 raeburn 2939: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 2940: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2941: return(&retrievestudentphoto($udom,$unam,$ext));
2942: } else {
2943: my ($result,$perm_reqd)=
1.707 albertel 2944: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2945: if ($result eq 'ok') {
2946: if (!($perm_reqd eq 'yes')) {
2947: return(&retrievestudentphoto($udom,$unam,$ext));
2948: }
2949: }
2950: }
2951: }
2952: } else {
2953: my ($result,$perm_reqd) =
1.707 albertel 2954: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2955: if ($result eq 'ok') {
2956: if (!($perm_reqd eq 'yes')) {
2957: return(&retrievestudentphoto($udom,$unam,$ext));
2958: }
2959: }
2960: }
2961: return '/adm/lonKaputt/lonlogo_broken.gif';
2962: }
2963:
2964: sub retrievestudentphoto {
2965: my ($udom,$unam,$ext,$type) = @_;
2966: my $home=&Apache::lonnet::homeserver($unam,$udom);
2967: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2968: if ($ret eq 'ok') {
2969: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2970: if ($type eq 'thumbnail') {
2971: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2972: }
2973: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2974: return $tokenurl;
2975: } else {
2976: if ($type eq 'thumbnail') {
2977: return '/adm/lonKaputt/genericstudent_tn.gif';
2978: } else {
2979: return '/adm/lonKaputt/lonlogo_broken.gif';
2980: }
1.617 albertel 2981: }
2982: }
2983:
1.263 www 2984: # -------------------------------------------------------------------- New chat
2985:
2986: sub chatsend {
1.724 raeburn 2987: my ($newentry,$anon,$group)=@_;
1.620 albertel 2988: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2989: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2990: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 2991: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 2992: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 2993: &escape($newentry)).':'.$group,$chome);
1.292 www 2994: }
2995:
2996: # ------------------------------------------ Find current version of a resource
2997:
2998: sub getversion {
2999: my $fname=&clutter(shift);
1.1189 raeburn 3000: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 3001: return ¤tversion(&filelocation('',$fname));
3002: }
3003:
3004: sub currentversion {
3005: my $fname=shift;
3006: my $author=$fname;
3007: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3008: my ($udom,$uname)=split(/\//,$author);
1.1112 www 3009: my $home=&homeserver($uname,$udom);
1.292 www 3010: if ($home eq 'no_host') {
3011: return -1;
3012: }
1.1112 www 3013: my $answer=&reply("currentversion:$fname",$home);
1.292 www 3014: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3015: return -1;
3016: }
1.1112 www 3017: return $answer;
1.263 www 3018: }
3019:
1.1111 www 3020: #
3021: # Return special version number of resource if set by override, empty otherwise
3022: #
3023: sub usedversion {
3024: my $fname=shift;
3025: unless ($fname) { $fname=$env{'request.uri'}; }
3026: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3027: if ($urlversion) { return $urlversion; }
3028: return '';
3029: }
3030:
1.1 albertel 3031: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 3032:
1.1 albertel 3033: sub subscribe {
3034: my $fname=shift;
1.761 raeburn 3035: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 3036: $fname=~s/[\n\r]//g;
1.1 albertel 3037: my $author=$fname;
3038: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3039: my ($udom,$uname)=split(/\//,$author);
3040: my $home=homeserver($uname,$udom);
1.335 albertel 3041: if ($home eq 'no_host') {
3042: return 'not_found';
1.1 albertel 3043: }
3044: my $answer=reply("sub:$fname",$home);
1.64 www 3045: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3046: $answer.=' by '.$home;
3047: }
1.1 albertel 3048: return $answer;
3049: }
3050:
1.8 www 3051: # -------------------------------------------------------------- Replicate file
3052:
3053: sub repcopy {
3054: my $filename=shift;
1.23 www 3055: $filename=~s/\/+/\//g;
1.1142 raeburn 3056: my $londocroot = $perlvar{'lonDocRoot'};
3057: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 3058: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 3059: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3060: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 3061: return &repcopy_userfile($filename);
3062: }
1.532 albertel 3063: $filename=~s/[\n\r]//g;
1.8 www 3064: my $transname="$filename.in.transfer";
1.828 www 3065: # FIXME: this should flock
1.607 raeburn 3066: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 3067: my $remoteurl=subscribe($filename);
1.64 www 3068: if ($remoteurl =~ /^con_lost by/) {
3069: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3070: return 'unavailable';
1.8 www 3071: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 3072: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 3073: return 'not_found';
1.64 www 3074: } elsif ($remoteurl =~ /^rejected by/) {
3075: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3076: return 'forbidden';
1.20 www 3077: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 3078: return 'ok';
1.8 www 3079: } else {
1.290 www 3080: my $author=$filename;
3081: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3082: my ($udom,$uname)=split(/\//,$author);
3083: my $home=homeserver($uname,$udom);
3084: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 3085: my @parts=split(/\//,$filename);
3086: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 3087: if ($path ne "$londocroot/res") {
1.8 www 3088: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 3089: return 'bad_request';
1.8 www 3090: }
3091: my $count;
3092: for ($count=5;$count<$#parts;$count++) {
3093: $path.="/$parts[$count]";
3094: if ((-e $path)!=1) {
3095: mkdir($path,0777);
3096: }
3097: }
3098: my $request=new HTTP::Request('GET',"$remoteurl");
1.1345 raeburn 3099: my $response;
3100: if ($remoteurl =~ m{/raw/}) {
3101: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3102: } else {
3103: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3104: }
1.8 www 3105: if ($response->is_error()) {
3106: unlink($transname);
3107: my $message=$response->status_line;
1.672 albertel 3108: &logthis("<font color=\"blue\">WARNING:"
1.12 www 3109: ." LWP get: $message: $filename</font>");
1.607 raeburn 3110: return 'unavailable';
1.8 www 3111: } else {
1.16 www 3112: if ($remoteurl!~/\.meta$/) {
3113: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1.1345 raeburn 3114: my $mresponse;
3115: if ($remoteurl =~ m{/raw/}) {
3116: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3117: } else {
3118: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3119: }
1.16 www 3120: if ($mresponse->is_error()) {
3121: unlink($filename.'.meta');
3122: &logthis(
1.672 albertel 3123: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 3124: }
3125: }
1.8 www 3126: rename($transname,$filename);
1.607 raeburn 3127: return 'ok';
1.8 www 3128: }
1.290 www 3129: }
1.8 www 3130: }
1.330 www 3131: }
3132:
3133: # ------------------------------------------------ Get server side include body
3134: sub ssi_body {
1.381 albertel 3135: my ($filelink,%form)=@_;
1.606 matthew 3136: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3137: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3138: }
1.953 www 3139: my $output='';
3140: my $response;
1.980 raeburn 3141: if ($filelink=~/^https?\:/) {
1.954 raeburn 3142: ($output,$response)=&externalssi($filelink);
1.953 www 3143: } else {
1.1004 droeschl 3144: $filelink .= $filelink=~/\?/ ? '&' : '?';
3145: $filelink .= 'inhibitmenu=yes';
1.953 www 3146: ($output,$response)=&ssi($filelink,%form);
3147: }
1.778 albertel 3148: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 3149: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 3150: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 3151: if (wantarray) {
3152: return ($output, $response);
3153: } else {
3154: return $output;
3155: }
1.8 www 3156: }
3157:
1.15 www 3158: # --------------------------------------------------------- Server Side Include
3159:
1.782 albertel 3160: sub absolute_url {
3161: my ($host_name) = @_;
3162: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3163: if ($host_name eq '') {
3164: $host_name = $ENV{'SERVER_NAME'};
3165: }
3166: return $protocol.$host_name;
3167: }
3168:
1.942 foxr 3169: #
3170: # Server side include.
3171: # Parameters:
3172: # fn Possibly encrypted resource name/id.
3173: # form Hash that describes how the rendering should be done
3174: # and other things.
1.944 foxr 3175: # Returns:
1.950 raeburn 3176: # Scalar context: The content of the response.
3177: # Array context: 2 element list of the content and the full response object.
1.942 foxr 3178: #
1.15 www 3179: sub ssi {
3180:
1.944 foxr 3181: my ($fn,%form)=@_;
1.23 www 3182: my $request;
1.711 albertel 3183:
3184: $form{'no_update_last_known'}=1;
1.895 albertel 3185: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 3186: if (%form) {
1.782 albertel 3187: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1272 droeschl 3188: $request->content(join('&',map {
3189: my $name = escape($_);
3190: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3191: ? join("&$name=", map {escape($_) } @{$form{$_}})
3192: : &escape($form{$_}) );
3193: } keys(%form)));
1.23 www 3194: } else {
1.782 albertel 3195: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 3196: }
3197:
1.15 www 3198: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1345 raeburn 3199: my $lonhost = $perlvar{'lonHostID'};
3200: my $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar);
1.1182 foxr 3201:
1.944 foxr 3202: if (wantarray) {
1.1345 raeburn 3203: return ($response->content, $response);
1.944 foxr 3204: } else {
1.1345 raeburn 3205: return $response->content;
1.942 foxr 3206: }
1.324 www 3207: }
3208:
3209: sub externalssi {
3210: my ($url)=@_;
3211: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 3212: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
1.954 raeburn 3213: if (wantarray) {
3214: return ($response->content, $response);
3215: } else {
3216: return $response->content;
3217: }
1.15 www 3218: }
1.254 www 3219:
1.1354 raeburn 3220:
3221: # If the local copy of a replicated resource is outdated, trigger a
3222: # connection from the homeserver to flush the delayed queue. If no update
3223: # happens, remove local copies of outdated resource (and corresponding
3224: # metadata file).
3225:
1.1352 raeburn 3226: sub remove_stale_resfile {
3227: my ($url) = @_;
1.1354 raeburn 3228: my $removed;
1.1352 raeburn 3229: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3230: my $audom = $1;
3231: my $auname = $2;
1.1353 raeburn 3232: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
1.1352 raeburn 3233: my $homeserver = &homeserver($auname,$audom);
3234: unless (($homeserver eq 'no_host') ||
3235: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3236: my $fname = &filelocation('',$url);
3237: if (-e $fname) {
3238: my $protocol = $protocol{$homeserver};
3239: $protocol = 'http' if ($protocol ne 'https');
3240: my $hostname = &hostname($homeserver);
3241: if ($hostname) {
3242: my $uri = &declutter($url);
3243: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3244: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3245: if ($response->is_success()) {
3246: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3247: my $locmodtime = (stat($fname))[9];
3248: if ($locmodtime < $remmodtime) {
1.1354 raeburn 3249: my $stale;
3250: my $answer = &reply('pong',$homeserver);
3251: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3252: sleep(0.2);
3253: $locmodtime = (stat($fname))[9];
3254: if ($locmodtime < $remmodtime) {
3255: my $posstransfer = $fname.'.in.transfer';
3256: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3257: $removed = 1;
3258: } else {
3259: $stale = 1;
3260: }
3261: } else {
3262: $removed = 1;
3263: }
3264: } else {
3265: $stale = 1;
3266: }
3267: if ($stale) {
3268: unlink($fname);
3269: if ($uri!~/\.meta$/) {
3270: unlink($fname.'.meta');
3271: }
3272: &reply("unsub:$fname",$homeserver);
3273: $removed = 1;
1.1352 raeburn 3274: }
3275: }
3276: }
3277: }
3278: }
3279: }
3280: }
3281: }
1.1354 raeburn 3282: return $removed;
1.1352 raeburn 3283: }
3284:
1.492 albertel 3285: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3286:
3287: sub allowuploaded {
3288: my ($srcurl,$url)=@_;
3289: $url=&clutter(&declutter($url));
3290: my $dir=$url;
3291: $dir=~s/\/[^\/]+$//;
3292: my %httpref=();
3293: my $httpurl=&hreflocation('',$url);
3294: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 3295: &Apache::lonnet::appenv(\%httpref);
1.254 www 3296: }
1.477 raeburn 3297:
1.1193 raeburn 3298: #
3299: # Determine if the current user should be able to edit a particular resource,
3300: # when viewing in course context.
3301: # (a) When viewing resource used to determine if "Edit" item is included in
3302: # Functions.
3303: # (b) When displaying folder contents in course editor, used to determine if
3304: # "Edit" link will be displayed alongside resource.
3305: #
1.1196 raeburn 3306: # input: six args -- filename (decluttered), course number, course domain,
3307: # url, symb (if registered) and group (if this is a group
3308: # item -- e.g., bulletin board, group page etc.).
3309: # output: array of five scalars --
1.1193 raeburn 3310: # $cfile -- url for file editing if editable on current server
3311: # $home -- homeserver of resource (i.e., for author if published,
3312: # or course if uploaded.).
3313: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 3314: # $forceedit -- 1 if icon/link should be to go to edit mode
3315: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 3316: #
3317:
3318: sub can_edit_resource {
1.1194 raeburn 3319: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3320: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3321: #
3322: # For aboutme pages user can only edit his/her own.
3323: #
1.1199 raeburn 3324: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 3325: my ($sdom,$sname) = ($1,$2);
3326: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3327: $home = $env{'user.home'};
3328: $cfile = $resurl;
3329: if ($env{'form.forceedit'}) {
3330: $forceview = 1;
3331: } else {
3332: $forceedit = 1;
3333: }
3334: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3335: } else {
3336: return;
3337: }
3338: }
3339:
3340: if ($env{'request.course.id'}) {
3341: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3342: if ($group ne '') {
3343: # if this is a group homepage or group bulletin board, check group privs
3344: my $allowed = 0;
1.1197 raeburn 3345: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3346: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 3347: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 3348: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3349: $allowed = 1;
3350: }
1.1197 raeburn 3351: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3352: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3353: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 3354: $allowed = 1;
3355: }
3356: }
3357: if ($allowed) {
3358: $home=&homeserver($cnum,$cdom);
3359: if ($env{'form.forceedit'}) {
3360: $forceview = 1;
3361: } else {
3362: $forceedit = 1;
3363: }
3364: $cfile = $resurl;
3365: } else {
3366: return;
3367: }
3368: } else {
1.1208 raeburn 3369: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3370: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3371: return;
3372: }
3373: } elsif (!$crsedit) {
1.1194 raeburn 3374: #
3375: # No edit allowed where CC has switched to student role.
3376: #
3377: return;
3378: }
3379: }
3380: }
3381:
1.1193 raeburn 3382: if ($file ne '') {
3383: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 3384: if (&is_course_upload($file,$cnum,$cdom)) {
3385: $uploaded = 1;
3386: $incourse = 1;
1.1193 raeburn 3387: if ($file =~/\.(htm|html|css|js|txt)$/) {
3388: $cfile = &hreflocation('',$file);
1.1201 raeburn 3389: if ($env{'form.forceedit'}) {
3390: $forceview = 1;
3391: } else {
3392: $forceedit = 1;
3393: }
1.1194 raeburn 3394: }
3395: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3396: $incourse = 1;
3397: if ($env{'form.forceedit'}) {
3398: $forceview = 1;
3399: } else {
3400: $forceedit = 1;
3401: }
3402: $cfile = $resurl;
3403: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3404: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3405: $incourse = 1;
3406: if ($env{'form.forceedit'}) {
3407: $forceview = 1;
3408: } else {
3409: $forceedit = 1;
3410: }
3411: $cfile = $resurl;
1.1199 raeburn 3412: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 3413: $incourse = 1;
3414: $cfile = $resurl.'/smpedit';
1.1199 raeburn 3415: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 3416: $incourse = 1;
1.1199 raeburn 3417: if ($env{'form.forceedit'}) {
3418: $forceview = 1;
3419: } else {
3420: $forceedit = 1;
3421: }
3422: $cfile = $resurl;
1.1343 raeburn 3423: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3424: $incourse = 1;
3425: if ($env{'form.forceedit'}) {
3426: $forceview = 1;
3427: } else {
3428: $forceedit = 1;
3429: }
3430: $cfile = $resurl;
1.1208 raeburn 3431: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3432: $incourse = 1;
3433: if ($env{'form.forceedit'}) {
3434: $forceview = 1;
3435: } else {
3436: $forceedit = 1;
3437: }
3438: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 3439: }
3440: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3441: my $template = '/res/lib/templates/simpleproblem.problem';
3442: if (&is_on_map($template)) {
3443: $incourse = 1;
3444: $forceview = 1;
3445: $cfile = $template;
1.1193 raeburn 3446: }
1.1199 raeburn 3447: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3448: $incourse = 1;
3449: if ($env{'form.forceedit'}) {
3450: $forceview = 1;
3451: } else {
3452: $forceedit = 1;
3453: }
3454: $cfile = $resurl;
1.1343 raeburn 3455: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1298 raeburn 3456: $incourse = 1;
3457: if ($env{'form.forceedit'}) {
3458: $forceview = 1;
3459: } else {
3460: $forceedit = 1;
3461: }
3462: $cfile = $resurl;
1.1199 raeburn 3463: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3464: $incourse = 1;
3465: $forceview = 1;
3466: if ($symb) {
3467: my ($map,$id,$res)=&decode_symb($symb);
3468: $env{'request.symb'} = $symb;
3469: $cfile = &clutter($res);
3470: } else {
3471: $cfile = $env{'form.suppurl'};
1.1298 raeburn 3472: my $escfile = &unescape($cfile);
1.1343 raeburn 3473: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3474: $cfile = '/adm/wrapper'.$escfile;
3475: } else {
3476: $escfile =~ s{^http://}{};
3477: $cfile = &escape("/adm/wrapper/ext/$escfile");
3478: }
1.1199 raeburn 3479: }
1.1234 raeburn 3480: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3481: if ($env{'form.forceedit'}) {
3482: $forceview = 1;
3483: } else {
3484: $forceedit = 1;
3485: }
3486: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 3487: }
3488: }
1.1194 raeburn 3489: if ($uploaded || $incourse) {
3490: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 3491: } elsif ($file !~ m{/$}) {
1.1193 raeburn 3492: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3493: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3494: # Check that the user has permission to edit this resource
3495: my $setpriv = 1;
3496: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3497: if (defined($cfudom)) {
3498: $home=&homeserver($cfuname,$cfudom);
3499: $cfile=$file;
3500: }
3501: }
1.1194 raeburn 3502: if (($cfile ne '') && (!$incourse || $uploaded) &&
3503: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 3504: my @ids=¤t_machine_ids();
3505: unless (grep(/^\Q$home\E$/,@ids)) {
3506: $switchserver=1;
3507: }
3508: }
3509: }
1.1194 raeburn 3510: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 3511: }
3512:
3513: sub is_course_upload {
3514: my ($file,$cnum,$cdom) = @_;
3515: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3516: $uploadpath =~ s{^\/}{};
1.1201 raeburn 3517: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3518: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 3519: return 1;
3520: }
3521: return;
3522: }
3523:
1.1194 raeburn 3524: sub in_course {
1.1195 raeburn 3525: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3526: if ($hideprivileged) {
3527: my $skipuser;
1.1219 raeburn 3528: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3529: my @possdoms = ($cdom);
3530: if ($coursehash{'checkforpriv'}) {
3531: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3532: }
3533: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 3534: $skipuser = 1;
3535: if ($coursehash{'nothideprivileged'}) {
3536: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3537: my $user;
3538: if ($item =~ /:/) {
3539: $user = $item;
3540: } else {
3541: $user = join(':',split(/[\@]/,$item));
3542: }
3543: if ($user eq $uname.':'.$udom) {
3544: undef($skipuser);
3545: last;
3546: }
3547: }
3548: }
3549: if ($skipuser) {
3550: return 0;
3551: }
3552: }
3553: }
1.1194 raeburn 3554: $type ||= 'any';
3555: if (!defined($cdom) || !defined($cnum)) {
3556: my $cid = $env{'request.course.id'};
3557: $cdom = $env{'course.'.$cid.'.domain'};
3558: $cnum = $env{'course.'.$cid.'.num'};
3559: }
3560: my $typesref;
1.1195 raeburn 3561: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 3562: $typesref = ['active','previous','future'];
3563: } elsif ($type eq 'previous' || $type eq 'future') {
3564: $typesref = [$type];
3565: }
3566: my %roles = &get_my_roles($uname,$udom,'userroles',
3567: $typesref,undef,[$cdom]);
3568: my ($tmp) = keys(%roles);
3569: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3570: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3571: if (@course_roles > 0) {
3572: return 1;
3573: }
3574: return 0;
3575: }
3576:
1.478 albertel 3577: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 3578: # input: action, courseID, current domain, intended
1.637 raeburn 3579: # path to file, source of file, instruction to parse file for objects,
3580: # ref to hash for embedded objects,
3581: # ref to hash for codebase of java objects.
1.1095 raeburn 3582: # reference to scalar to accommodate mime type determined
3583: # from File::MMagic if $parser = parse.
1.637 raeburn 3584: #
1.485 raeburn 3585: # output: url to file (if action was uploaddoc),
3586: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 3587: #
1.478 albertel 3588: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3589: # course.
1.477 raeburn 3590: #
1.478 albertel 3591: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3592: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3593: # course's home server.
1.477 raeburn 3594: #
1.478 albertel 3595: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3596: # be copied from $source (current location) to
3597: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3598: # and will then be copied to
3599: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3600: # course's home server.
1.485 raeburn 3601: #
1.481 raeburn 3602: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 3603: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 3604: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3605: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3606: # in course's home server.
1.637 raeburn 3607: #
1.477 raeburn 3608:
3609: sub process_coursefile {
1.1095 raeburn 3610: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3611: $mimetype)=@_;
1.477 raeburn 3612: my $fetchresult;
1.638 albertel 3613: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 3614: if ($action eq 'propagate') {
1.638 albertel 3615: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3616: $home);
1.481 raeburn 3617: } else {
1.477 raeburn 3618: my $fpath = '';
3619: my $fname = $file;
1.478 albertel 3620: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 3621: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 3622: my $filepath = &build_filepath($fpath);
1.481 raeburn 3623: if ($action eq 'copy') {
3624: if ($source eq '') {
3625: $fetchresult = 'no source file';
3626: return $fetchresult;
3627: } else {
3628: my $destination = $filepath.'/'.$fname;
3629: rename($source,$destination);
3630: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3631: $home);
1.481 raeburn 3632: }
3633: } elsif ($action eq 'uploaddoc') {
1.1359 raeburn 3634: open(my $fh,'>',$filepath.'/'.$fname);
1.620 albertel 3635: print $fh $env{'form.'.$source};
1.481 raeburn 3636: close($fh);
1.637 raeburn 3637: if ($parser eq 'parse') {
1.1024 raeburn 3638: my $mm = new File::MMagic;
1.1095 raeburn 3639: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3640: if ($type eq 'text/html') {
1.1024 raeburn 3641: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3642: unless ($parse_result eq 'ok') {
3643: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3644: }
1.637 raeburn 3645: }
1.1095 raeburn 3646: if (ref($mimetype)) {
3647: $$mimetype = $type;
3648: }
1.637 raeburn 3649: }
1.477 raeburn 3650: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3651: $home);
1.481 raeburn 3652: if ($fetchresult eq 'ok') {
3653: return '/uploaded/'.$fpath.'/'.$fname;
3654: } else {
3655: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3656: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 3657: return '/adm/notfound.html';
3658: }
1.477 raeburn 3659: }
3660: }
1.485 raeburn 3661: unless ( $fetchresult eq 'ok') {
1.477 raeburn 3662: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3663: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 3664: }
3665: return $fetchresult;
3666: }
3667:
1.637 raeburn 3668: sub build_filepath {
3669: my ($fpath) = @_;
3670: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3671: unless ($fpath eq '') {
3672: my @parts=split('/',$fpath);
3673: foreach my $part (@parts) {
3674: $filepath.= '/'.$part;
3675: if ((-e $filepath)!=1) {
3676: mkdir($filepath,0777);
3677: }
3678: }
3679: }
3680: return $filepath;
3681: }
3682:
3683: sub store_edited_file {
1.638 albertel 3684: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 3685: my $file = $primary_url;
3686: $file =~ s#^/uploaded/$docudom/$docuname/##;
3687: my $fpath = '';
3688: my $fname = $file;
3689: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3690: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3691: my $filepath = &build_filepath($fpath);
1.1359 raeburn 3692: open(my $fh,'>',$filepath.'/'.$fname);
1.637 raeburn 3693: print $fh $content;
3694: close($fh);
1.638 albertel 3695: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 3696: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3697: $home);
1.637 raeburn 3698: if ($$fetchresult eq 'ok') {
3699: return '/uploaded/'.$fpath.'/'.$fname;
3700: } else {
1.638 albertel 3701: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3702: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 3703: return '/adm/notfound.html';
3704: }
3705: }
3706:
1.531 albertel 3707: sub clean_filename {
1.831 albertel 3708: my ($fname,$args)=@_;
1.315 www 3709: # Replace Windows backslashes by forward slashes
1.257 www 3710: $fname=~s/\\/\//g;
1.831 albertel 3711: if (!$args->{'keep_path'}) {
3712: # Get rid of everything but the actual filename
3713: $fname=~s/^.*\/([^\/]+)$/$1/;
3714: }
1.315 www 3715: # Replace spaces by underscores
3716: $fname=~s/\s+/\_/g;
3717: # Replace all other weird characters by nothing
1.831 albertel 3718: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 3719: # Replace all .\d. sequences with _\d. so they no longer look like version
3720: # numbers
3721: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 3722: return $fname;
3723: }
1.1051 raeburn 3724: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3725: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3726: # image with the same aspect ratio as the original, but with dimensions which do
3727: # not exceed $resizewidth and $resizeheight.
3728:
1.984 neumanie 3729: sub resizeImage {
1.1051 raeburn 3730: my ($img_path,$resizewidth,$resizeheight) = @_;
3731: my $ima = Image::Magick->new;
3732: my $resized;
3733: if (-e $img_path) {
3734: $ima->Read($img_path);
3735: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3736: my $width = $ima->Get('width');
3737: my $height = $ima->Get('height');
3738: if ($width > $resizewidth) {
3739: my $factor = $width/$resizewidth;
3740: my $newheight = $height/$factor;
3741: $ima->Scale(width=>$resizewidth,height=>$newheight);
3742: $resized = 1;
3743: }
3744: }
3745: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3746: my $width = $ima->Get('width');
3747: my $height = $ima->Get('height');
3748: if ($height > $resizeheight) {
3749: my $factor = $height/$resizeheight;
3750: my $newwidth = $width/$factor;
3751: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3752: $resized = 1;
3753: }
3754: }
3755: if ($resized) {
3756: $ima->Write($img_path);
3757: }
3758: }
3759: return;
1.977 amueller 3760: }
3761:
1.608 albertel 3762: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 3763: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 3764: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 3765: # $context - possible values: coursedoc, existingfile, overwrite,
3766: # canceloverwrite, or ''.
3767: # if 'coursedoc': upload to the current course
3768: # if 'existingfile': write file to tmp/overwrites directory
3769: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3770: # $context is passed as argument to &finishuserfileupload
1.686 albertel 3771: # $subdir - directory in userfile to store the file into
1.858 raeburn 3772: # $parser - instruction to parse file for objects ($parser = parse)
3773: # $allfiles - reference to hash for embedded objects
3774: # $codebase - reference to hash for codebase of java objects
3775: # $desuname - username for permanent storage of uploaded file
3776: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 3777: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3778: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 3779: # $resizewidth - width (pixels) to which to resize uploaded image
3780: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 3781: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 3782: # from File::MMagic.
1.858 raeburn 3783: #
1.686 albertel 3784: # output: url of file in userspace, or error: <message>
3785: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 3786:
1.531 albertel 3787: sub userfileupload {
1.1090 raeburn 3788: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 3789: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 3790: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 3791: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 3792: $fname=&clean_filename($fname);
1.1090 raeburn 3793: # See if there is anything left
1.257 www 3794: unless ($fname) { return 'error: no uploaded file'; }
1.1090 raeburn 3795: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3796: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3797: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3798: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 3799: my $now = time;
1.1090 raeburn 3800: my $filepath;
1.1095 raeburn 3801: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 3802: $filepath = 'tmp/helprequests/'.$now;
3803: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3804: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3805: '_'.$env{'user.domain'}.'/pending';
3806: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3807: my ($docuname,$docudom);
1.1350 raeburn 3808: if ($destudom =~ /^$match_domain$/) {
1.1090 raeburn 3809: $docudom = $destudom;
3810: } else {
3811: $docudom = $env{'user.domain'};
3812: }
1.1350 raeburn 3813: if ($destuname =~ /^$match_username$/) {
1.1090 raeburn 3814: $docuname = $destuname;
3815: } else {
3816: $docuname = $env{'user.name'};
3817: }
3818: if (exists($env{'form.group'})) {
3819: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3820: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3821: }
3822: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3823: if ($context eq 'canceloverwrite') {
3824: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3825: if (-e $tempfile) {
3826: my @info = stat($tempfile);
3827: if ($info[9] eq $env{'form.timestamp'}) {
3828: unlink($tempfile);
3829: }
3830: }
3831: return;
1.523 raeburn 3832: }
3833: }
1.1090 raeburn 3834: # Create the directory if not present
1.741 raeburn 3835: my @parts=split(/\//,$filepath);
3836: my $fullpath = $perlvar{'lonDaemons'};
3837: for (my $i=0;$i<@parts;$i++) {
3838: $fullpath .= '/'.$parts[$i];
3839: if ((-e $fullpath)!=1) {
3840: mkdir($fullpath,0777);
3841: }
3842: }
1.1359 raeburn 3843: open(my $fh,'>',$fullpath.'/'.$fname);
1.741 raeburn 3844: print $fh $env{'form.'.$formname};
3845: close($fh);
1.1090 raeburn 3846: if ($context eq 'existingfile') {
3847: my @info = stat($fullpath.'/'.$fname);
3848: return ($fullpath.'/'.$fname,$info[9]);
3849: } else {
3850: return $fullpath.'/'.$fname;
3851: }
1.523 raeburn 3852: }
1.995 raeburn 3853: if ($subdir eq 'scantron') {
3854: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 3855: } else {
1.995 raeburn 3856: $fname="$subdir/$fname";
3857: }
1.1090 raeburn 3858: if ($context eq 'coursedoc') {
1.638 albertel 3859: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3860: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 3861: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 3862: return &finishuserfileupload($docuname,$docudom,
3863: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 3864: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 3865: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 3866: } else {
1.1218 raeburn 3867: if ($env{'form.folder'}) {
3868: $fname=$env{'form.folder'}.'/'.$fname;
3869: }
1.638 albertel 3870: return &process_coursefile('uploaddoc',$docuname,$docudom,
3871: $fname,$formname,$parser,
1.1095 raeburn 3872: $allfiles,$codebase,$mimetype);
1.481 raeburn 3873: }
1.719 banghart 3874: } elsif (defined($destuname)) {
3875: my $docuname=$destuname;
3876: my $docudom=$destudom;
1.860 raeburn 3877: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3878: $parser,$allfiles,$codebase,
1.1051 raeburn 3879: $thumbwidth,$thumbheight,
1.1095 raeburn 3880: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3881: } else {
1.638 albertel 3882: my $docuname=$env{'user.name'};
3883: my $docudom=$env{'user.domain'};
1.1220 raeburn 3884: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 3885: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3886: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3887: }
1.860 raeburn 3888: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3889: $parser,$allfiles,$codebase,
1.1051 raeburn 3890: $thumbwidth,$thumbheight,
1.1095 raeburn 3891: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3892: }
1.271 www 3893: }
3894:
3895: sub finishuserfileupload {
1.860 raeburn 3896: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 3897: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 3898: my $path=$docudom.'/'.$docuname.'/';
1.258 www 3899: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 3900:
1.860 raeburn 3901: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 3902: $file=$fname;
3903: if ($fname=~m|/|) {
3904: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3905: $path.=$fnamepath.'/';
3906: }
1.259 www 3907: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 3908: my $count;
3909: for ($count=4;$count<=$#parts;$count++) {
3910: $filepath.="/$parts[$count]";
3911: if ((-e $filepath)!=1) {
3912: mkdir($filepath,0777);
3913: }
3914: }
1.984 neumanie 3915:
1.258 www 3916: # Save the file
3917: {
1.1359 raeburn 3918: if (!open(FH,'>',$filepath.'/'.$file)) {
1.701 albertel 3919: &logthis('Failed to create '.$filepath.'/'.$file);
3920: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3921: return '/adm/notfound.html';
3922: }
1.1090 raeburn 3923: if ($context eq 'overwrite') {
1.1117 foxr 3924: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 3925: my $target = $filepath.'/'.$file;
3926: if (-e $source) {
3927: my @info = stat($source);
3928: if ($info[9] eq $env{'form.timestamp'}) {
3929: unless (&File::Copy::move($source,$target)) {
3930: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3931: return "Moving from $source failed";
3932: }
3933: } else {
3934: return "Temporary file: $source had unexpected date/time for last modification";
3935: }
3936: } else {
3937: return "Temporary file: $source missing";
3938: }
3939: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 3940: &logthis('Failed to write to '.$filepath.'/'.$file);
3941: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3942: return '/adm/notfound.html';
3943: }
1.570 albertel 3944: close(FH);
1.1051 raeburn 3945: if ($resizewidth && $resizeheight) {
3946: my $mm = new File::MMagic;
3947: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3948: if ($mime_type =~ m{^image/}) {
3949: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3950: }
1.977 amueller 3951: }
1.258 www 3952: }
1.1152 raeburn 3953: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3954: if (ref($mimetype)) {
3955: if ($$mimetype eq '') {
3956: my $mm = new File::MMagic;
3957: my $type = $mm->checktype_filename($filepath.'/'.$file);
3958: $$mimetype = $type;
3959: }
3960: }
3961: }
1.637 raeburn 3962: if ($parser eq 'parse') {
1.1152 raeburn 3963: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 3964: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3965: $allfiles,$codebase);
3966: unless ($parse_result eq 'ok') {
3967: &logthis('Failed to parse '.$filepath.$file.
3968: ' for embedded media: '.$parse_result);
3969: }
1.637 raeburn 3970: }
3971: }
1.860 raeburn 3972: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3973: my $input = $filepath.'/'.$file;
3974: my $output = $filepath.'/'.'tn-'.$file;
3975: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1.1359 raeburn 3976: my @args = ('convert','-sample',$thumbsize,$input,$output);
3977: system({$args[0]} @args);
1.860 raeburn 3978: if (-e $filepath.'/'.'tn-'.$file) {
3979: $fetchthumb = 1;
3980: }
3981: }
1.858 raeburn 3982:
1.259 www 3983: # Notify homeserver to grep it
3984: #
1.984 neumanie 3985: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 3986: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 3987: if ($fetchresult eq 'ok') {
1.860 raeburn 3988: if ($fetchthumb) {
3989: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3990: if ($thumbresult ne 'ok') {
3991: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3992: $docuhome.': '.$thumbresult);
3993: }
3994: }
1.259 www 3995: #
1.258 www 3996: # Return the URL to it
1.494 albertel 3997: return '/uploaded/'.$path.$file;
1.263 www 3998: } else {
1.494 albertel 3999: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
4000: ': '.$fetchresult);
1.263 www 4001: return '/adm/notfound.html';
1.858 raeburn 4002: }
1.493 albertel 4003: }
4004:
1.637 raeburn 4005: sub extract_embedded_items {
1.961 raeburn 4006: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 4007: my @state = ();
1.1164 raeburn 4008: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 4009: my %javafiles = (
4010: codebase => '',
4011: code => '',
4012: archive => ''
4013: );
4014: my %mediafiles = (
4015: src => '',
4016: movie => '',
4017: );
1.648 raeburn 4018: my $p;
4019: if ($content) {
4020: $p = HTML::LCParser->new($content);
4021: } else {
1.961 raeburn 4022: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 4023: }
1.641 albertel 4024: while (my $t=$p->get_token()) {
1.640 albertel 4025: if ($t->[0] eq 'S') {
4026: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 4027: push(@state, $tagname);
1.648 raeburn 4028: if (lc($tagname) eq 'allow') {
4029: &add_filetype($allfiles,$attr->{'src'},'src');
4030: }
1.640 albertel 4031: if (lc($tagname) eq 'img') {
4032: &add_filetype($allfiles,$attr->{'src'},'src');
4033: }
1.886 albertel 4034: if (lc($tagname) eq 'a') {
1.1222 raeburn 4035: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 4036: &add_filetype($allfiles,$attr->{'href'},'href');
4037: }
1.886 albertel 4038: }
1.645 raeburn 4039: if (lc($tagname) eq 'script') {
1.1164 raeburn 4040: my $src;
1.645 raeburn 4041: if ($attr->{'archive'} =~ /\.jar$/i) {
4042: &add_filetype($allfiles,$attr->{'archive'},'archive');
4043: } else {
1.1164 raeburn 4044: if ($attr->{'src'} ne '') {
4045: $src = $attr->{'src'};
4046: &add_filetype($allfiles,$src,'src');
4047: }
4048: }
4049: my $text = $p->get_trimmed_text();
4050: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4051: my @swfargs = split(/,/,$1);
4052: foreach my $item (@swfargs) {
4053: $item =~ s/["']//g;
4054: $item =~ s/^\s+//;
4055: $item =~ s/\s+$//;
4056: }
4057: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4058: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4059: push(@{$related{$swfargs[0]}},$swfargs[2]);
4060: } else {
4061: $related{$swfargs[0]} = [$swfargs[2]];
4062: }
4063: }
1.645 raeburn 4064: }
4065: }
4066: if (lc($tagname) eq 'link') {
4067: if (lc($attr->{'rel'}) eq 'stylesheet') {
4068: &add_filetype($allfiles,$attr->{'href'},'href');
4069: }
4070: }
1.640 albertel 4071: if (lc($tagname) eq 'object' ||
4072: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4073: foreach my $item (keys(%javafiles)) {
4074: $javafiles{$item} = '';
4075: }
1.1164 raeburn 4076: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4077: $lastids{lc($tagname)} = $attr->{'id'};
4078: }
1.640 albertel 4079: }
4080: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4081: my $name = lc($attr->{'name'});
4082: foreach my $item (keys(%javafiles)) {
4083: if ($name eq $item) {
4084: $javafiles{$item} = $attr->{'value'};
4085: last;
4086: }
4087: }
1.1164 raeburn 4088: my $pathfrom;
1.640 albertel 4089: foreach my $item (keys(%mediafiles)) {
4090: if ($name eq $item) {
1.1164 raeburn 4091: $pathfrom = $attr->{'value'};
4092: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4093: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 4094: last;
4095: }
4096: }
1.1164 raeburn 4097: if ($name eq 'flashvars') {
4098: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4099: }
4100: if ($pathfrom ne '') {
4101: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4102: $pathfrom);
4103: }
1.640 albertel 4104: }
4105: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4106: foreach my $item (keys(%javafiles)) {
4107: if ($attr->{$item}) {
4108: $javafiles{$item} = $attr->{$item};
4109: last;
4110: }
4111: }
4112: foreach my $item (keys(%mediafiles)) {
4113: if ($attr->{$item}) {
4114: &add_filetype($allfiles,$attr->{$item},$item);
4115: last;
4116: }
4117: }
1.1164 raeburn 4118: if (lc($tagname) eq 'embed') {
4119: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4120: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4121: $attr->{'src'});
4122: }
4123: }
1.640 albertel 4124: }
1.1243 raeburn 4125: if (lc($tagname) eq 'iframe') {
4126: my $src = $attr->{'src'} ;
4127: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4128: &add_filetype($allfiles,$src,'src');
4129: } elsif ($src =~ m{^/}) {
4130: if ($env{'request.course.id'}) {
4131: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4132: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4133: my $url = &hreflocation('',$fullpath);
4134: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4135: my $relpath = $1;
4136: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4137: &add_filetype($allfiles,$1,'src');
4138: }
4139: }
4140: }
4141: }
4142: }
1.1164 raeburn 4143: if ($t->[4] =~ m{/>$}) {
1.1243 raeburn 4144: pop(@state);
1.1164 raeburn 4145: }
1.640 albertel 4146: } elsif ($t->[0] eq 'E') {
4147: my ($tagname) = ($t->[1]);
4148: if ($javafiles{'codebase'} ne '') {
4149: $javafiles{'codebase'} .= '/';
4150: }
4151: if (lc($tagname) eq 'applet' ||
4152: lc($tagname) eq 'object' ||
4153: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4154: ) {
4155: foreach my $item (keys(%javafiles)) {
4156: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4157: my $file=$javafiles{'codebase'}.$javafiles{$item};
4158: &add_filetype($allfiles,$file,$item);
4159: }
4160: }
4161: }
4162: pop @state;
4163: }
4164: }
1.1164 raeburn 4165: foreach my $id (sort(keys(%flashvars))) {
4166: if ($shockwave{$id} ne '') {
4167: my @pairs = split(/\&/,$flashvars{$id});
4168: foreach my $pair (@pairs) {
4169: my ($key,$value) = split(/\=/,$pair);
4170: if ($key eq 'thumb') {
4171: &add_filetype($allfiles,$value,$key);
4172: } elsif ($key eq 'content') {
4173: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4174: my ($ext) = ($value =~ /\.([^.]+)$/);
4175: if ($ext ne '') {
4176: &add_filetype($allfiles,$path.$value,$ext);
4177: }
4178: }
4179: }
4180: }
4181: }
1.637 raeburn 4182: return 'ok';
4183: }
4184:
1.639 albertel 4185: sub add_filetype {
4186: my ($allfiles,$file,$type)=@_;
4187: if (exists($allfiles->{$file})) {
4188: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4189: push(@{$allfiles->{$file}}, &escape($type));
4190: }
4191: } else {
4192: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 4193: }
4194: }
4195:
1.1164 raeburn 4196: sub embedded_dependency {
4197: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4198: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4199: if (($identifier ne '') &&
4200: (ref($related->{$identifier}) eq 'ARRAY') &&
4201: ($pathfrom ne '')) {
4202: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4203: foreach my $dep (@{$related->{$identifier}}) {
4204: &add_filetype($allfiles,$path.$dep,'object');
4205: }
4206: }
4207: }
4208: return;
4209: }
4210:
1.493 albertel 4211: sub removeuploadedurl {
1.984 neumanie 4212: my ($url)=@_;
4213: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 4214: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 4215: }
4216:
4217: sub removeuserfile {
4218: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 4219: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4220: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 4221: if ($result eq 'ok') {
1.798 raeburn 4222: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
4223: my $metafile = $fname.'.meta';
4224: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 4225: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 4226: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4227: my $sqlresult =
1.823 albertel 4228: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4229: 'portfolio_metadata',$group,
4230: 'delete');
1.798 raeburn 4231: }
4232: }
4233: return $result;
1.257 www 4234: }
1.15 www 4235:
1.530 albertel 4236: sub mkdiruserfile {
4237: my ($docuname,$docudom,$dir)=@_;
4238: my $home=&homeserver($docuname,$docudom);
4239: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
4240: }
4241:
1.531 albertel 4242: sub renameuserfile {
4243: my ($docuname,$docudom,$old,$new)=@_;
4244: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4245: my $result = &reply("renameuserfile:$docudom:$docuname:".
4246: &escape("$old").':'.&escape("$new"),$home);
4247: if ($result eq 'ok') {
4248: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
4249: my $oldmeta = $old.'.meta';
4250: my $newmeta = $new.'.meta';
4251: my $metaresult =
4252: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 4253: my $url = "/uploaded/$docudom/$docuname/$old";
4254: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4255: my $sqlresult =
1.823 albertel 4256: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4257: 'portfolio_metadata',$group,
4258: 'delete');
1.798 raeburn 4259: }
4260: }
4261: return $result;
1.531 albertel 4262: }
4263:
1.14 www 4264: # ------------------------------------------------------------------------- Log
4265:
4266: sub log {
4267: my ($dom,$nam,$hom,$what)=@_;
1.47 www 4268: return critical("log:$dom:$nam:$what",$hom);
1.157 www 4269: }
4270:
4271: # ------------------------------------------------------------------ Course Log
1.352 www 4272: #
4273: # This routine flushes several buffers of non-mission-critical nature
4274: #
1.157 www 4275:
4276: sub flushcourselogs {
1.352 www 4277: &logthis('Flushing log buffers');
4278: #
4279: # course logs
4280: # This is a log of all transactions in a course, which can be used
4281: # for data mining purposes
4282: #
4283: # It also collects the courseid database, which lists last transaction
4284: # times and course titles for all courseids
4285: #
4286: my %courseidbuffer=();
1.921 raeburn 4287: foreach my $crsid (keys(%courselogs)) {
1.352 www 4288: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 4289: &escape($courselogs{$crsid}),
4290: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 4291: delete $courselogs{$crsid};
4292: } else {
4293: &logthis('Failed to flush log buffer for '.$crsid);
4294: if (length($courselogs{$crsid})>40000) {
1.672 albertel 4295: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 4296: " exceeded maximum size, deleting.</font>");
4297: delete $courselogs{$crsid};
4298: }
1.352 www 4299: }
1.920 raeburn 4300: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 4301: 'description' => $coursedescrbuf{$crsid},
4302: 'inst_code' => $courseinstcodebuf{$crsid},
4303: 'type' => $coursetypebuf{$crsid},
4304: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 4305: };
1.191 harris41 4306: }
1.352 www 4307: #
4308: # Write course id database (reverse lookup) to homeserver of courses
4309: # Is used in pickcourse
4310: #
1.840 albertel 4311: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 4312: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 4313: $courseidbuffer{$crs_home},
4314: $crs_home,'timeonly');
1.352 www 4315: }
4316: #
4317: # File accesses
4318: # Writes to the dynamic metadata of resources to get hit counts, etc.
4319: #
1.449 matthew 4320: foreach my $entry (keys(%accesshash)) {
1.458 matthew 4321: if ($entry =~ /___count$/) {
4322: my ($dom,$name);
1.807 albertel 4323: ($dom,$name,undef)=
1.811 albertel 4324: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 4325: if (! defined($dom) || $dom eq '' ||
4326: ! defined($name) || $name eq '') {
1.620 albertel 4327: my $cid = $env{'request.course.id'};
4328: $dom = $env{'request.'.$cid.'.domain'};
4329: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 4330: }
1.450 matthew 4331: my $value = $accesshash{$entry};
4332: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4333: my %temphash=($url => $value);
1.449 matthew 4334: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4335: if ($result eq 'ok') {
4336: delete $accesshash{$entry};
4337: }
4338: } else {
1.811 albertel 4339: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 4340: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 4341: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 4342: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
4343: delete $accesshash{$entry};
4344: }
1.185 www 4345: }
1.191 harris41 4346: }
1.352 www 4347: #
4348: # Roles
4349: # Reverse lookup of user roles for course faculty/staff and co-authorship
4350: #
1.800 albertel 4351: foreach my $entry (keys(%userrolehash)) {
1.351 www 4352: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 4353: split(/\:/,$entry);
4354: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 4355: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 4356: $rudom,$runame) eq 'ok') {
4357: delete $userrolehash{$entry};
4358: }
4359: }
1.662 raeburn 4360: #
1.1334 raeburn 4361: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 4362: #
4363: my %domrolebuffer = ();
1.1000 raeburn 4364: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 4365: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 4366: if ($domrolebuffer{$rudom}) {
4367: $domrolebuffer{$rudom}.='&'.&escape($entry).
4368: '='.&escape($domainrolehash{$entry});
4369: } else {
4370: $domrolebuffer{$rudom}.=&escape($entry).
4371: '='.&escape($domainrolehash{$entry});
4372: }
4373: delete $domainrolehash{$entry};
4374: }
4375: foreach my $dom (keys(%domrolebuffer)) {
1.1324 raeburn 4376: my %servers;
4377: if (defined(&domain($dom,'primary'))) {
4378: my $primary=&domain($dom,'primary');
4379: my $hostname=&hostname($primary);
4380: $servers{$primary} = $hostname;
4381: } else {
4382: %servers = &get_servers($dom,'library');
4383: }
1.841 albertel 4384: foreach my $tryserver (keys(%servers)) {
1.1324 raeburn 4385: if (&reply('domroleput:'.$dom.':'.
4386: $domrolebuffer{$dom},$tryserver) eq 'ok') {
4387: last;
4388: } else {
1.841 albertel 4389: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
4390: }
1.662 raeburn 4391: }
4392: }
1.186 www 4393: $dumpcount++;
1.157 www 4394: }
4395:
4396: sub courselog {
4397: my $what=shift;
1.158 www 4398: $what=time.':'.$what;
1.620 albertel 4399: unless ($env{'request.course.id'}) { return ''; }
4400: $coursedombuf{$env{'request.course.id'}}=
4401: $env{'course.'.$env{'request.course.id'}.'.domain'};
4402: $coursenumbuf{$env{'request.course.id'}}=
4403: $env{'course.'.$env{'request.course.id'}.'.num'};
4404: $coursehombuf{$env{'request.course.id'}}=
4405: $env{'course.'.$env{'request.course.id'}.'.home'};
4406: $coursedescrbuf{$env{'request.course.id'}}=
4407: $env{'course.'.$env{'request.course.id'}.'.description'};
4408: $courseinstcodebuf{$env{'request.course.id'}}=
4409: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
4410: $courseownerbuf{$env{'request.course.id'}}=
4411: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 4412: $coursetypebuf{$env{'request.course.id'}}=
4413: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 4414: if (defined $courselogs{$env{'request.course.id'}}) {
4415: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 4416: } else {
1.620 albertel 4417: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 4418: }
1.620 albertel 4419: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 4420: &flushcourselogs();
4421: }
1.158 www 4422: }
4423:
4424: sub courseacclog {
4425: my $fnsymb=shift;
1.620 albertel 4426: unless ($env{'request.course.id'}) { return ''; }
4427: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 4428: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 4429: $what.=':POST';
1.583 matthew 4430: # FIXME: Probably ought to escape things....
1.800 albertel 4431: foreach my $key (keys(%env)) {
4432: if ($key=~/^form\.(.*)/) {
1.975 raeburn 4433: my $formitem = $1;
4434: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
4435: $what.=':'.$formitem.'='.$env{$key};
4436: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
4437: $what.=':'.$formitem.'='.$env{$key};
4438: }
1.158 www 4439: }
1.191 harris41 4440: }
1.583 matthew 4441: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4442: # FIXME: We should not be depending on a form parameter that someone
4443: # editing lonsearchcat.pm might change in the future.
1.620 albertel 4444: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 4445: $what.= ':POST';
4446: # FIXME: Probably ought to escape things....
4447: foreach my $element ('courseexp','crsfulltext','crsrelated',
4448: 'crsdiscuss') {
1.620 albertel 4449: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 4450: }
4451: }
1.158 www 4452: }
4453: &courselog($what);
1.149 www 4454: }
4455:
1.185 www 4456: sub countacc {
4457: my $url=&declutter(shift);
1.458 matthew 4458: return if (! defined($url) || $url eq '');
1.620 albertel 4459: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 4460: #
4461: # Mark that this url was used in this course
4462: #
1.620 albertel 4463: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 4464: #
4465: # Increase the access count for this resource in this child process
4466: #
1.281 www 4467: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 4468: $accesshash{$key}++;
1.185 www 4469: }
1.349 www 4470:
1.361 www 4471: sub linklog {
4472: my ($from,$to)=@_;
4473: $from=&declutter($from);
4474: $to=&declutter($to);
4475: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4476: $accesshash{$to.'___'.$from.'___goto'}=1;
4477: }
1.1160 www 4478:
4479: sub statslog {
4480: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4481: if ($users<2) { return; }
4482: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4483: 'course' => $env{'request.course.id'},
4484: 'sections' => '"all"',
4485: 'num_students' => $users,
4486: 'part' => $part,
4487: 'symb' => $symb,
4488: 'mean_tries' => $av_attempts,
4489: 'deg_of_diff' => $degdiff});
4490: foreach my $key (keys(%dynstore)) {
4491: $accesshash{$key}=$dynstore{$key};
4492: }
4493: }
1.361 www 4494:
1.349 www 4495: sub userrolelog {
4496: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 4497: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 4498: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4499: $userrolehash
4500: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 4501: =$tend.':'.$tstart;
1.662 raeburn 4502: }
1.1169 droeschl 4503: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 4504: $userrolehash
4505: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4506: =$tend.':'.$tstart;
4507: }
1.1334 raeburn 4508: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 4509: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4510: $domainrolehash
4511: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4512: = $tend.':'.$tstart;
4513: }
1.351 www 4514: }
4515:
1.957 raeburn 4516: sub courserolelog {
4517: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184 raeburn 4518: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4519: my $cdom = $1;
4520: my $cnum = $2;
4521: my $sec = $3;
4522: my $namespace = 'rolelog';
4523: my %storehash = (
4524: role => $trole,
4525: start => $tstart,
4526: end => $tend,
4527: selfenroll => $selfenroll,
4528: context => $context,
4529: );
4530: if ($trole eq 'gr') {
4531: $namespace = 'groupslog';
4532: $storehash{'group'} = $sec;
4533: } else {
4534: $storehash{'section'} = $sec;
4535: }
1.1188 raeburn 4536: &write_log('course',$namespace,\%storehash,$delflag,$username,
4537: $domain,$cnum,$cdom);
1.1184 raeburn 4538: if (($trole ne 'st') || ($sec ne '')) {
4539: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 4540: }
4541: }
4542: return;
4543: }
4544:
1.1184 raeburn 4545: sub domainrolelog {
4546: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4547: if ($area =~ m{^/($match_domain)/$}) {
4548: my $cdom = $1;
4549: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4550: my $namespace = 'rolelog';
4551: my %storehash = (
4552: role => $trole,
4553: start => $tstart,
4554: end => $tend,
4555: context => $context,
4556: );
1.1188 raeburn 4557: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4558: $domain,$domconfiguser,$cdom);
1.1184 raeburn 4559: }
4560: return;
4561:
4562: }
4563:
4564: sub coauthorrolelog {
4565: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4566: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4567: my $audom = $1;
4568: my $auname = $2;
4569: my $namespace = 'rolelog';
4570: my %storehash = (
4571: role => $trole,
4572: start => $tstart,
4573: end => $tend,
4574: context => $context,
4575: );
1.1188 raeburn 4576: &write_log('author',$namespace,\%storehash,$delflag,$username,
4577: $domain,$auname,$audom);
1.1184 raeburn 4578: }
4579: return;
4580: }
4581:
1.351 www 4582: sub get_course_adv_roles {
1.948 raeburn 4583: my ($cid,$codes) = @_;
1.620 albertel 4584: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 4585: my %coursehash=&coursedescription($cid);
1.988 raeburn 4586: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 4587: my %nothide=();
1.800 albertel 4588: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 4589: if ($user !~ /:/) {
4590: $nothide{join(':',split(/[\@]/,$user))}=1;
4591: } else {
4592: $nothide{$user}=1;
4593: }
1.470 www 4594: }
1.1219 raeburn 4595: my @possdoms = ($coursehash{'domain'});
4596: if ($coursehash{'checkforpriv'}) {
4597: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4598: }
1.351 www 4599: my %returnhash=();
4600: my %dumphash=
4601: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4602: my $now=time;
1.997 raeburn 4603: my %privileged;
1.1000 raeburn 4604: foreach my $entry (keys(%dumphash)) {
1.800 albertel 4605: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 4606: if (($tstart) && ($tstart<0)) { next; }
4607: if (($tend) && ($tend<$now)) { next; }
4608: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 4609: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 4610: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 4611: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 4612: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 4613: if ($role eq 'cr') { next; }
1.948 raeburn 4614: if ($codes) {
4615: if ($section) { $role .= ':'.$section; }
4616: if ($returnhash{$role}) {
4617: $returnhash{$role}.=','.$username.':'.$domain;
4618: } else {
4619: $returnhash{$role}=$username.':'.$domain;
4620: }
1.351 www 4621: } else {
1.988 raeburn 4622: my $key=&plaintext($role,$crstype);
1.973 bisitz 4623: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 4624: if ($returnhash{$key}) {
4625: $returnhash{$key}.=','.$username.':'.$domain;
4626: } else {
4627: $returnhash{$key}=$username.':'.$domain;
4628: }
1.351 www 4629: }
1.948 raeburn 4630: }
1.400 www 4631: return %returnhash;
4632: }
4633:
4634: sub get_my_roles {
1.937 raeburn 4635: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 4636: unless (defined($uname)) { $uname=$env{'user.name'}; }
4637: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 4638: my (%dumphash,%nothide);
1.1086 raeburn 4639: if ($context eq 'userroles') {
1.1166 raeburn 4640: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 4641: } else {
1.1219 raeburn 4642: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 4643: if ($hidepriv) {
4644: my %coursehash=&coursedescription($udom.'_'.$uname);
4645: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4646: if ($user !~ /:/) {
4647: $nothide{join(':',split(/[\@]/,$user))} = 1;
4648: } else {
4649: $nothide{$user} = 1;
4650: }
4651: }
4652: }
1.858 raeburn 4653: }
1.400 www 4654: my %returnhash=();
4655: my $now=time;
1.999 raeburn 4656: my %privileged;
1.800 albertel 4657: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 4658: my ($role,$tend,$tstart);
4659: if ($context eq 'userroles') {
1.1149 raeburn 4660: next if ($entry =~ /^rolesdef/);
1.867 raeburn 4661: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4662: } else {
4663: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4664: }
1.400 www 4665: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 4666: my $status = 'active';
1.939 raeburn 4667: if (($tend) && ($tend<=$now)) {
1.832 raeburn 4668: $status = 'previous';
4669: }
4670: if (($tstart) && ($now<$tstart)) {
4671: $status = 'future';
4672: }
4673: if (ref($types) eq 'ARRAY') {
4674: if (!grep(/^\Q$status\E$/,@{$types})) {
4675: next;
4676: }
4677: } else {
4678: if ($status ne 'active') {
4679: next;
4680: }
4681: }
1.867 raeburn 4682: my ($rolecode,$username,$domain,$section,$area);
4683: if ($context eq 'userroles') {
1.1186 raeburn 4684: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 4685: (undef,$domain,$username,$section) = split(/\//,$area);
4686: } else {
4687: ($role,$username,$domain,$section) = split(/\:/,$entry);
4688: }
1.832 raeburn 4689: if (ref($roledoms) eq 'ARRAY') {
4690: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4691: next;
4692: }
4693: }
4694: if (ref($roles) eq 'ARRAY') {
4695: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 4696: if ($role =~ /^cr\//) {
4697: if (!grep(/^cr$/,@{$roles})) {
4698: next;
4699: }
1.1104 raeburn 4700: } elsif ($role =~ /^gr\//) {
4701: if (!grep(/^gr$/,@{$roles})) {
4702: next;
4703: }
1.922 raeburn 4704: } else {
4705: next;
4706: }
1.832 raeburn 4707: }
1.867 raeburn 4708: }
1.937 raeburn 4709: if ($hidepriv) {
1.1219 raeburn 4710: my @privroles = ('dc','su');
1.999 raeburn 4711: if ($context eq 'userroles') {
1.1219 raeburn 4712: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 4713: } else {
1.1219 raeburn 4714: my $possdoms = [$domain];
4715: if (ref($roledoms) eq 'ARRAY') {
4716: push(@{$possdoms},@{$roledoms});
1.999 raeburn 4717: }
1.1219 raeburn 4718: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 4719: if (!$nothide{$username.':'.$domain}) {
4720: next;
4721: }
4722: }
1.937 raeburn 4723: }
4724: }
1.933 raeburn 4725: if ($withsec) {
4726: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4727: $tstart.':'.$tend;
4728: } else {
4729: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4730: }
1.832 raeburn 4731: }
1.373 www 4732: return %returnhash;
1.399 www 4733: }
4734:
1.1333 raeburn 4735: sub get_all_adhocroles {
4736: my ($dom) = @_;
4737: my @roles_by_num = ();
4738: my %domdefaults = &get_domain_defaults($dom);
4739: my (%description,%access_in_dom,%access_info);
4740: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
4741: my $count = 0;
4742: my %domcurrent = %{$domdefaults{'adhocroles'}};
4743: my %ordered;
4744: foreach my $role (sort(keys(%domcurrent))) {
4745: my ($order,$desc,$access_in_dom);
4746: if (ref($domcurrent{$role}) eq 'HASH') {
4747: $order = $domcurrent{$role}{'order'};
4748: $desc = $domcurrent{$role}{'desc'};
4749: $access_in_dom{$role} = $domcurrent{$role}{'access'};
4750: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
4751: }
4752: if ($order eq '') {
4753: $order = $count;
4754: }
4755: $ordered{$order} = $role;
4756: if ($desc ne '') {
4757: $description{$role} = $desc;
4758: } else {
4759: $description{$role}= $role;
4760: }
4761: $count++;
4762: }
4763: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
4764: push(@roles_by_num,$ordered{$item});
4765: }
4766: }
4767: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
4768: }
4769:
1.1332 raeburn 4770: sub get_my_adhocroles {
1.1333 raeburn 4771: my ($cid,$checkreg) = @_;
4772: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
4773: if ($env{'request.course.id'} eq $cid) {
4774: $cdom = $env{'course.'.$cid.'.domain'};
4775: $cnum = $env{'course.'.$cid.'.num'};
4776: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
4777: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
4778: $cdom = $1;
4779: $cnum = $2;
4780: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
4781: $cdom,$cnum);
4782: }
4783: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
4784: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4785: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
4786: if ($rosterhash{$user} ne '') {
4787: my $type = (split(/:/,$rosterhash{$user}))[5];
4788: return ([],{}) if ($type eq 'auto');
4789: }
4790: }
4791: if (($cdom ne '') && ($cnum ne '')) {
1.1334 raeburn 4792: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1332 raeburn 4793: my $then=$env{'user.login.time'};
4794: my $update=$env{'user.update.time'};
1.1335 raeburn 4795: if (!$update) {
4796: $update = $then;
4797: }
4798: my @liveroles;
1.1334 raeburn 4799: foreach my $role ('dh','da') {
4800: if ($env{"user.role.$role./$cdom/"}) {
1.1335 raeburn 4801: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
1.1334 raeburn 4802: my $limit = $update;
4803: if ($env{'request.role'} eq "$role./$cdom/") {
4804: $limit = $then;
4805: }
1.1335 raeburn 4806: my $activerole = 1;
4807: if ($tstart && $tstart>$limit) { $activerole = 0; }
4808: if ($tend && $tend <$limit) { $activerole = 0; }
4809: if ($activerole) {
4810: push(@liveroles,$role);
4811: }
1.1334 raeburn 4812: }
1.1332 raeburn 4813: }
1.1335 raeburn 4814: if (@liveroles) {
1.1332 raeburn 4815: if (&homeserver($cnum,$cdom) ne 'no_host') {
1.1333 raeburn 4816: my ($accessref,$accessinfo,%access_in_dom);
4817: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
4818: if (ref($roles_by_num) eq 'ARRAY') {
4819: if (@{$roles_by_num}) {
1.1332 raeburn 4820: my %settings;
4821: if ($env{'request.course.id'} eq $cid) {
4822: foreach my $envkey (keys(%env)) {
4823: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
4824: $settings{$1} = $env{$envkey};
4825: }
4826: }
4827: } else {
4828: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
4829: }
4830: my %setincrs;
4831: if ($settings{'internal.adhocaccess'}) {
4832: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
4833: }
4834: my @statuses;
4835: if ($env{'environment.inststatus'}) {
4836: @statuses = split(/,/,$env{'environment.inststatus'});
4837: }
4838: my $user = $env{'user.name'}.':'.$env{'user.domain'};
1.1333 raeburn 4839: if (ref($accessref) eq 'HASH') {
4840: %access_in_dom = %{$accessref};
4841: }
4842: foreach my $role (@{$roles_by_num}) {
1.1332 raeburn 4843: my ($curraccess,@okstatus,@personnel);
4844: if ($setincrs{$role}) {
4845: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
4846: if ($curraccess eq 'status') {
4847: @okstatus = split(/\&/,$rest);
4848: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4849: @personnel = split(/\&/,$rest);
4850: }
4851: } else {
4852: $curraccess = $access_in_dom{$role};
1.1333 raeburn 4853: if (ref($accessinfo) eq 'HASH') {
4854: if ($curraccess eq 'status') {
4855: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4856: @okstatus = @{$accessinfo->{$role}};
4857: }
4858: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4859: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4860: @personnel = @{$accessinfo->{$role}};
4861: }
1.1332 raeburn 4862: }
4863: }
4864: }
4865: if ($curraccess eq 'none') {
4866: next;
4867: } elsif ($curraccess eq 'all') {
4868: push(@possroles,$role);
1.1336 raeburn 4869: } elsif ($curraccess eq 'dh') {
1.1335 raeburn 4870: if (grep(/^dh$/,@liveroles)) {
4871: push(@possroles,$role);
4872: } else {
4873: next;
4874: }
1.1336 raeburn 4875: } elsif ($curraccess eq 'da') {
1.1335 raeburn 4876: if (grep(/^da$/,@liveroles)) {
4877: push(@possroles,$role);
4878: } else {
4879: next;
4880: }
1.1332 raeburn 4881: } elsif ($curraccess eq 'status') {
4882: if (@okstatus) {
4883: if (!@statuses) {
4884: if (grep(/^default$/,@okstatus)) {
4885: push(@possroles,$role);
4886: }
4887: } else {
4888: foreach my $status (@okstatus) {
4889: if (grep(/^\Q$status\E$/,@statuses)) {
4890: push(@possroles,$role);
4891: last;
4892: }
4893: }
4894: }
4895: }
4896: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4897: if (grep(/^\Q$user\E$/,@personnel)) {
4898: if ($curraccess eq 'exc') {
4899: push(@possroles,$role);
4900: }
4901: } elsif ($curraccess eq 'inc') {
4902: push(@possroles,$role);
4903: }
4904: }
4905: }
4906: }
4907: }
4908: }
4909: }
4910: }
4911: }
1.1333 raeburn 4912: unless (ref($description) eq 'HASH') {
4913: if (ref($roles_by_num) eq 'ARRAY') {
4914: my %desc;
4915: map { $desc{$_} = $_; } (@{$roles_by_num});
4916: $description = \%desc;
4917: } else {
4918: $description = {};
4919: }
4920: }
4921: return (\@possroles,$description);
1.1332 raeburn 4922: }
4923:
1.399 www 4924: # ----------------------------------------------------- Frontpage Announcements
4925: #
4926: #
4927:
4928: sub postannounce {
4929: my ($server,$text)=@_;
1.844 albertel 4930: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 4931: unless ($text=~/\w/) { $text=''; }
4932: return &reply('setannounce:'.&escape($text),$server);
4933: }
4934:
4935: sub getannounce {
1.448 albertel 4936:
1.1359 raeburn 4937: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 4938: my $announcement='';
1.800 albertel 4939: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 4940: close($fh);
1.399 www 4941: if ($announcement=~/\w/) {
4942: return
4943: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 4944: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 4945: } else {
4946: return '';
4947: }
4948: } else {
4949: return '';
4950: }
1.351 www 4951: }
1.353 www 4952:
4953: # ---------------------------------------------------------- Course ID routines
4954: # Deal with domain's nohist_courseid.db files
4955: #
4956:
4957: sub courseidput {
1.921 raeburn 4958: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 4959: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 4960: my $outcome;
4961: if ($caller eq 'timeonly') {
4962: my $cids = '';
4963: foreach my $item (keys(%$storehash)) {
4964: $cids.=&escape($item).'&';
4965: }
4966: $cids=~s/\&$//;
4967: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4968: $coursehome);
4969: } else {
4970: my $items = '';
4971: foreach my $item (keys(%$storehash)) {
4972: $items.= &escape($item).'='.
4973: &freeze_escape($$storehash{$item}).'&';
4974: }
4975: $items=~s/\&$//;
4976: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4977: $coursehome);
1.918 raeburn 4978: }
4979: if ($outcome eq 'unknown_cmd') {
4980: my $what;
4981: foreach my $cid (keys(%$storehash)) {
4982: $what .= &escape($cid).'=';
1.921 raeburn 4983: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 4984: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 4985: }
4986: $what =~ s/\:$/&/;
4987: }
4988: $what =~ s/\&$//;
4989: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4990: } else {
4991: return $outcome;
4992: }
1.353 www 4993: }
4994:
4995: sub courseiddump {
1.921 raeburn 4996: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 4997: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 4998: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247 raeburn 4999: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287 raeburn 5000: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 5001: my $as_hash = 1;
5002: my %returnhash;
5003: if (!$domfilter) { $domfilter=''; }
1.845 albertel 5004: my %libserv = &all_library();
5005: foreach my $tryserver (keys(%libserv)) {
5006: if ( ( $hostidflag == 1
5007: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
5008: || (!defined($hostidflag)) ) {
5009:
1.918 raeburn 5010: if (($domfilter eq '') ||
5011: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 5012: my $rep;
5013: if (grep { $_ eq $tryserver } current_machine_ids()) {
5014: $rep = LONCAPA::Lond::dump_course_id_handler(
5015: join(":", (&host_domain($tryserver), $sincefilter,
5016: &escape($descfilter), &escape($instcodefilter),
5017: &escape($ownerfilter), &escape($coursefilter),
5018: &escape($typefilter), &escape($regexp_ok),
5019: $as_hash, &escape($selfenrollonly),
5020: &escape($catfilter), $showhidden, $caller,
5021: &escape($cloner), &escape($cc_clone), $cloneonly,
5022: &escape($createdbefore), &escape($createdafter),
1.1287 raeburn 5023: &escape($creationcontext),$domcloner,$hasuniquecode,
5024: $reqcrsdom,&escape($reqinstcode))));
1.1180 droeschl 5025: } else {
5026: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5027: $sincefilter.':'.&escape($descfilter).':'.
5028: &escape($instcodefilter).':'.&escape($ownerfilter).
5029: ':'.&escape($coursefilter).':'.&escape($typefilter).
5030: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5031: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5032: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5033: &escape($cc_clone).':'.$cloneonly.':'.
5034: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287 raeburn 5035: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5036: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180 droeschl 5037: }
5038:
1.918 raeburn 5039: my @pairs=split(/\&/,$rep);
5040: foreach my $item (@pairs) {
5041: my ($key,$value)=split(/\=/,$item,2);
5042: $key = &unescape($key);
5043: next if ($key =~ /^error: 2 /);
5044: my $result = &thaw_unescape($value);
5045: if (ref($result) eq 'HASH') {
5046: $returnhash{$key}=$result;
5047: } else {
1.921 raeburn 5048: my @responses = split(/:/,$value);
5049: my @items = ('description','inst_code','owner','type');
1.918 raeburn 5050: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 5051: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 5052: }
1.1008 raeburn 5053: }
1.353 www 5054: }
5055: }
5056: }
5057: }
5058: return %returnhash;
5059: }
5060:
1.1055 raeburn 5061: sub courselastaccess {
5062: my ($cdom,$cnum,$hostidref) = @_;
5063: my %returnhash;
5064: if ($cdom && $cnum) {
5065: my $chome = &homeserver($cnum,$cdom);
5066: if ($chome ne 'no_host') {
5067: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5068: &extract_lastaccess(\%returnhash,$rep);
5069: }
5070: } else {
5071: if (!$cdom) { $cdom=''; }
5072: my %libserv = &all_library();
5073: foreach my $tryserver (keys(%libserv)) {
5074: if (ref($hostidref) eq 'ARRAY') {
5075: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5076: }
5077: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5078: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5079: &extract_lastaccess(\%returnhash,$rep);
5080: }
5081: }
5082: }
5083: return %returnhash;
5084: }
5085:
5086: sub extract_lastaccess {
5087: my ($returnhash,$rep) = @_;
5088: if (ref($returnhash) eq 'HASH') {
5089: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5090: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5091: $rep eq '') {
5092: my @pairs=split(/\&/,$rep);
5093: foreach my $item (@pairs) {
5094: my ($key,$value)=split(/\=/,$item,2);
5095: $key = &unescape($key);
5096: next if ($key =~ /^error: 2 /);
5097: $returnhash->{$key} = &thaw_unescape($value);
5098: }
5099: }
5100: }
5101: return;
5102: }
5103:
1.658 raeburn 5104: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 5105:
5106: sub dcmailput {
1.685 raeburn 5107: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 5108: my $status = &Apache::lonnet::critical(
1.740 www 5109: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5110: &escape($message),$server);
1.662 raeburn 5111: return $status;
5112: }
5113:
1.658 raeburn 5114: sub dcmaildump {
5115: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 5116: my %returnhash=();
1.846 albertel 5117:
5118: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 5119: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5120: &escape($enddate).':';
5121: my @esc_senders=map { &escape($_)} @$senders;
5122: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 5123: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 5124: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 5125: if (($key) && ($value)) {
5126: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 5127: }
5128: }
5129: }
5130: return %returnhash;
5131: }
1.662 raeburn 5132: # ---------------------------------------------------------- Domain roles
5133:
5134: sub get_domain_roles {
5135: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 5136: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 5137: $startdate = '.';
5138: }
1.1018 raeburn 5139: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 5140: $enddate = '.';
5141: }
1.922 raeburn 5142: my $rolelist;
5143: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 5144: $rolelist = join('&',@{$roles});
1.922 raeburn 5145: }
1.662 raeburn 5146: my %personnel = ();
1.841 albertel 5147:
5148: my %servers = &get_servers($dom,'library');
5149: foreach my $tryserver (keys(%servers)) {
5150: %{$personnel{$tryserver}}=();
5151: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5152: &escape($startdate).':'.
5153: &escape($enddate).':'.
5154: &escape($rolelist), $tryserver))) {
5155: my ($key,$value) = split(/\=/,$line,2);
5156: if (($key) && ($value)) {
5157: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5158: }
5159: }
1.662 raeburn 5160: }
5161: return %personnel;
5162: }
1.658 raeburn 5163:
1.1332 raeburn 5164: sub get_active_domroles {
5165: my ($dom,$roles) = @_;
5166: return () unless (ref($roles) eq 'ARRAY');
5167: my $now = time;
5168: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
5169: my %domroles;
5170: foreach my $server (keys(%dompersonnel)) {
5171: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
5172: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
5173: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
5174: }
5175: }
5176: return %domroles;
5177: }
5178:
1.1057 www 5179: # ----------------------------------------------------------- Interval timing
1.149 www 5180:
1.1153 www 5181: {
5182: # Caches needed for speedup of navmaps
5183: # We don't want to cache this for very long at all (5 seconds at most)
5184: #
5185: # The user for whom we cache
5186: my $cachedkey='';
5187: # The cached times for this user
5188: my %cachedtimes=();
5189: # When this was last done
1.1282 raeburn 5190: my $cachedtime='';
1.1153 www 5191:
5192: sub load_all_first_access {
1.1308 raeburn 5193: my ($uname,$udom,$ignorecache)=@_;
1.1156 www 5194: if (($cachedkey eq $uname.':'.$udom) &&
1.1308 raeburn 5195: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
5196: (!$ignorecache)) {
1.1154 raeburn 5197: return;
5198: }
5199: $cachedtime=time;
5200: $cachedkey=$uname.':'.$udom;
5201: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 5202: }
5203:
1.504 albertel 5204: sub get_first_access {
1.1308 raeburn 5205: my ($type,$argsymb,$argmap,$ignorecache)=@_;
1.790 albertel 5206: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5207: if ($argsymb) { $symb=$argsymb; }
5208: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 5209: if ($argmap) { $map = $argmap; }
1.926 albertel 5210: if ($type eq 'course') {
5211: $res='course';
5212: } elsif ($type eq 'map') {
1.588 albertel 5213: $res=&symbread($map);
5214: } else {
5215: $res=$symb;
5216: }
1.1308 raeburn 5217: &load_all_first_access($uname,$udom,$ignorecache);
1.1153 www 5218: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 5219: }
5220:
5221: sub set_first_access {
1.1162 raeburn 5222: my ($type,$interval)=@_;
1.790 albertel 5223: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5224: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 5225: if ($type eq 'course') {
5226: $res='course';
5227: } elsif ($type eq 'map') {
1.588 albertel 5228: $res=&symbread($map);
5229: } else {
5230: $res=$symb;
5231: }
1.1153 www 5232: $cachedkey='';
1.1162 raeburn 5233: my $firstaccess=&get_first_access($type,$symb,$map);
1.505 albertel 5234: if (!$firstaccess) {
1.1162 raeburn 5235: my $start = time;
5236: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
5237: $udom,$uname);
5238: if ($putres eq 'ok') {
5239: &put('timerinterval',{"$courseid\0$res"=>$interval},
5240: $udom,$uname);
5241: &appenv(
5242: {
5243: 'course.'.$courseid.'.firstaccess.'.$res => $start,
5244: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
5245: }
5246: );
1.1365 raeburn 5247: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
5248: $cachedtimes{"$courseid\0$res"} = $start;
5249: }
1.1162 raeburn 5250: }
5251: return $putres;
1.505 albertel 5252: }
5253: return 'already_set';
1.504 albertel 5254: }
1.1153 www 5255: }
1.1282 raeburn 5256:
1.110 www 5257: # --------------------------------------------- Set Expire Date for Spreadsheet
5258:
5259: sub expirespread {
5260: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 5261: my $cid=$env{'request.course.id'};
1.110 www 5262: if ($cid) {
5263: my $now=time;
5264: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 5265: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
5266: $env{'course.'.$cid.'.num'}.
1.110 www 5267: ':nohist_expirationdates:'.
5268: &escape($key).'='.$now,
1.620 albertel 5269: $env{'course.'.$cid.'.home'})
1.110 www 5270: }
5271: return 'ok';
1.14 www 5272: }
5273:
1.109 www 5274: # ----------------------------------------------------- Devalidate Spreadsheets
5275:
5276: sub devalidate {
1.325 www 5277: my ($symb,$uname,$udom)=@_;
1.620 albertel 5278: my $cid=$env{'request.course.id'};
1.109 www 5279: if ($cid) {
1.391 matthew 5280: # delete the stored spreadsheets for
5281: # - the student level sheet of this user in course's homespace
5282: # - the assessment level sheet for this resource
5283: # for this user in user's homespace
1.553 albertel 5284: # - current conditional state info
1.325 www 5285: my $key=$uname.':'.$udom.':';
1.109 www 5286: my $status=
1.299 matthew 5287: &del('nohist_calculatedsheets',
1.391 matthew 5288: [$key.'studentcalc:'],
1.620 albertel 5289: $env{'course.'.$cid.'.domain'},
5290: $env{'course.'.$cid.'.num'})
1.133 albertel 5291: .' '.
5292: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 5293: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 5294: unless ($status eq 'ok ok') {
5295: &logthis('Could not devalidate spreadsheet '.
1.325 www 5296: $uname.' at '.$udom.' for '.
1.109 www 5297: $symb.': '.$status);
1.133 albertel 5298: }
1.553 albertel 5299: &delenv('user.state.'.$cid);
1.109 www 5300: }
5301: }
5302:
1.265 albertel 5303: sub get_scalar {
5304: my ($string,$end) = @_;
5305: my $value;
5306: if ($$string =~ s/^([^&]*?)($end)/$2/) {
5307: $value = $1;
5308: } elsif ($$string =~ s/^([^&]*?)&//) {
5309: $value = $1;
5310: }
5311: return &unescape($value);
5312: }
5313:
5314: sub array2str {
5315: my (@array) = @_;
5316: my $result=&arrayref2str(\@array);
5317: $result=~s/^__ARRAY_REF__//;
5318: $result=~s/__END_ARRAY_REF__$//;
5319: return $result;
5320: }
5321:
1.204 albertel 5322: sub arrayref2str {
5323: my ($arrayref) = @_;
1.265 albertel 5324: my $result='__ARRAY_REF__';
1.204 albertel 5325: foreach my $elem (@$arrayref) {
1.265 albertel 5326: if(ref($elem) eq 'ARRAY') {
5327: $result.=&arrayref2str($elem).'&';
5328: } elsif(ref($elem) eq 'HASH') {
5329: $result.=&hashref2str($elem).'&';
5330: } elsif(ref($elem)) {
5331: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 5332: } else {
5333: $result.=&escape($elem).'&';
5334: }
5335: }
5336: $result=~s/\&$//;
1.265 albertel 5337: $result .= '__END_ARRAY_REF__';
1.204 albertel 5338: return $result;
5339: }
5340:
1.168 albertel 5341: sub hash2str {
1.204 albertel 5342: my (%hash) = @_;
5343: my $result=&hashref2str(\%hash);
1.265 albertel 5344: $result=~s/^__HASH_REF__//;
5345: $result=~s/__END_HASH_REF__$//;
1.204 albertel 5346: return $result;
5347: }
5348:
5349: sub hashref2str {
5350: my ($hashref)=@_;
1.265 albertel 5351: my $result='__HASH_REF__';
1.800 albertel 5352: foreach my $key (sort(keys(%$hashref))) {
5353: if (ref($key) eq 'ARRAY') {
5354: $result.=&arrayref2str($key).'=';
5355: } elsif (ref($key) eq 'HASH') {
5356: $result.=&hashref2str($key).'=';
5357: } elsif (ref($key)) {
1.265 albertel 5358: $result.='=';
1.800 albertel 5359: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 5360: } else {
1.1132 raeburn 5361: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 5362: }
5363:
1.800 albertel 5364: if(ref($hashref->{$key}) eq 'ARRAY') {
5365: $result.=&arrayref2str($hashref->{$key}).'&';
5366: } elsif(ref($hashref->{$key}) eq 'HASH') {
5367: $result.=&hashref2str($hashref->{$key}).'&';
5368: } elsif(ref($hashref->{$key})) {
1.265 albertel 5369: $result.='&';
1.800 albertel 5370: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 5371: } else {
1.800 albertel 5372: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 5373: }
5374: }
1.168 albertel 5375: $result=~s/\&$//;
1.265 albertel 5376: $result .= '__END_HASH_REF__';
1.168 albertel 5377: return $result;
5378: }
5379:
5380: sub str2hash {
1.265 albertel 5381: my ($string)=@_;
5382: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
5383: return %$hash;
5384: }
5385:
5386: sub str2hashref {
1.168 albertel 5387: my ($string) = @_;
1.265 albertel 5388:
5389: my %hash;
5390:
5391: if($string !~ /^__HASH_REF__/) {
5392: if (! ($string eq '' || !defined($string))) {
5393: $hash{'error'}='Not hash reference';
5394: }
5395: return (\%hash, $string);
5396: }
5397:
5398: $string =~ s/^__HASH_REF__//;
5399:
5400: while($string !~ /^__END_HASH_REF__/) {
5401: #key
5402: my $key='';
5403: if($string =~ /^__HASH_REF__/) {
5404: ($key, $string)=&str2hashref($string);
5405: if(defined($key->{'error'})) {
5406: $hash{'error'}='Bad data';
5407: return (\%hash, $string);
5408: }
5409: } elsif($string =~ /^__ARRAY_REF__/) {
5410: ($key, $string)=&str2arrayref($string);
5411: if($key->[0] eq 'Array reference error') {
5412: $hash{'error'}='Bad data';
5413: return (\%hash, $string);
5414: }
5415: } else {
5416: $string =~ s/^(.*?)=//;
1.267 albertel 5417: $key=&unescape($1);
1.265 albertel 5418: }
5419: $string =~ s/^=//;
5420:
5421: #value
5422: my $value='';
5423: if($string =~ /^__HASH_REF__/) {
5424: ($value, $string)=&str2hashref($string);
5425: if(defined($value->{'error'})) {
5426: $hash{'error'}='Bad data';
5427: return (\%hash, $string);
5428: }
5429: } elsif($string =~ /^__ARRAY_REF__/) {
5430: ($value, $string)=&str2arrayref($string);
5431: if($value->[0] eq 'Array reference error') {
5432: $hash{'error'}='Bad data';
5433: return (\%hash, $string);
5434: }
5435: } else {
5436: $value=&get_scalar(\$string,'__END_HASH_REF__');
5437: }
5438: $string =~ s/^&//;
5439:
5440: $hash{$key}=$value;
1.204 albertel 5441: }
1.265 albertel 5442:
5443: $string =~ s/^__END_HASH_REF__//;
5444:
5445: return (\%hash, $string);
1.204 albertel 5446: }
5447:
5448: sub str2array {
1.265 albertel 5449: my ($string)=@_;
5450: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
5451: return @$array;
5452: }
5453:
5454: sub str2arrayref {
1.204 albertel 5455: my ($string) = @_;
1.265 albertel 5456: my @array;
5457:
5458: if($string !~ /^__ARRAY_REF__/) {
5459: if (! ($string eq '' || !defined($string))) {
5460: $array[0]='Array reference error';
5461: }
5462: return (\@array, $string);
5463: }
5464:
5465: $string =~ s/^__ARRAY_REF__//;
5466:
5467: while($string !~ /^__END_ARRAY_REF__/) {
5468: my $value='';
5469: if($string =~ /^__HASH_REF__/) {
5470: ($value, $string)=&str2hashref($string);
5471: if(defined($value->{'error'})) {
5472: $array[0] ='Array reference error';
5473: return (\@array, $string);
5474: }
5475: } elsif($string =~ /^__ARRAY_REF__/) {
5476: ($value, $string)=&str2arrayref($string);
5477: if($value->[0] eq 'Array reference error') {
5478: $array[0] ='Array reference error';
5479: return (\@array, $string);
5480: }
5481: } else {
5482: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5483: }
5484: $string =~ s/^&//;
5485:
5486: push(@array, $value);
1.191 harris41 5487: }
1.265 albertel 5488:
5489: $string =~ s/^__END_ARRAY_REF__//;
5490:
5491: return (\@array, $string);
1.168 albertel 5492: }
5493:
1.167 albertel 5494: # -------------------------------------------------------------------Temp Store
5495:
1.168 albertel 5496: sub tmpreset {
5497: my ($symb,$namespace,$domain,$stuname) = @_;
5498: if (!$symb) {
5499: $symb=&symbread();
1.620 albertel 5500: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5501: }
5502: $symb=escape($symb);
5503:
1.620 albertel 5504: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 5505: $namespace=~s/\//\_/g;
5506: $namespace=~s/\W//g;
5507:
1.620 albertel 5508: if (!$domain) { $domain=$env{'user.domain'}; }
5509: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5510: if ($domain eq 'public' && $stuname eq 'public') {
5511: $stuname=$ENV{'REMOTE_ADDR'};
5512: }
1.1117 foxr 5513: my $path=LONCAPA::tempdir();
1.168 albertel 5514: my %hash;
5515: if (tie(%hash,'GDBM_File',
5516: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5517: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 5518: foreach my $key (keys(%hash)) {
1.180 albertel 5519: if ($key=~ /:$symb/) {
1.168 albertel 5520: delete($hash{$key});
5521: }
5522: }
5523: }
5524: }
5525:
1.167 albertel 5526: sub tmpstore {
1.168 albertel 5527: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5528:
5529: if (!$symb) {
5530: $symb=&symbread();
1.620 albertel 5531: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5532: }
5533: $symb=escape($symb);
5534:
5535: if (!$namespace) {
5536: # I don't think we would ever want to store this for a course.
5537: # it seems this will only be used if we don't have a course.
1.620 albertel 5538: #$namespace=$env{'request.course.id'};
1.168 albertel 5539: #if (!$namespace) {
1.620 albertel 5540: $namespace=$env{'request.state'};
1.168 albertel 5541: #}
5542: }
5543: $namespace=~s/\//\_/g;
5544: $namespace=~s/\W//g;
1.620 albertel 5545: if (!$domain) { $domain=$env{'user.domain'}; }
5546: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5547: if ($domain eq 'public' && $stuname eq 'public') {
5548: $stuname=$ENV{'REMOTE_ADDR'};
5549: }
1.168 albertel 5550: my $now=time;
5551: my %hash;
1.1117 foxr 5552: my $path=LONCAPA::tempdir();
1.168 albertel 5553: if (tie(%hash,'GDBM_File',
5554: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5555: &GDBM_WRCREAT(),0640)) {
1.168 albertel 5556: $hash{"version:$symb"}++;
5557: my $version=$hash{"version:$symb"};
5558: my $allkeys='';
5559: foreach my $key (keys(%$storehash)) {
5560: $allkeys.=$key.':';
1.591 albertel 5561: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 5562: }
5563: $hash{"$version:$symb:timestamp"}=$now;
5564: $allkeys.='timestamp';
5565: $hash{"$version:keys:$symb"}=$allkeys;
5566: if (untie(%hash)) {
5567: return 'ok';
5568: } else {
5569: return "error:$!";
5570: }
5571: } else {
5572: return "error:$!";
5573: }
5574: }
1.167 albertel 5575:
1.168 albertel 5576: # -----------------------------------------------------------------Temp Restore
1.167 albertel 5577:
1.168 albertel 5578: sub tmprestore {
5579: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 5580:
1.168 albertel 5581: if (!$symb) {
5582: $symb=&symbread();
1.620 albertel 5583: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5584: }
5585: $symb=escape($symb);
5586:
1.620 albertel 5587: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 5588:
1.620 albertel 5589: if (!$domain) { $domain=$env{'user.domain'}; }
5590: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5591: if ($domain eq 'public' && $stuname eq 'public') {
5592: $stuname=$ENV{'REMOTE_ADDR'};
5593: }
1.168 albertel 5594: my %returnhash;
5595: $namespace=~s/\//\_/g;
5596: $namespace=~s/\W//g;
5597: my %hash;
1.1117 foxr 5598: my $path=LONCAPA::tempdir();
1.168 albertel 5599: if (tie(%hash,'GDBM_File',
5600: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5601: &GDBM_READER(),0640)) {
1.168 albertel 5602: my $version=$hash{"version:$symb"};
5603: $returnhash{'version'}=$version;
5604: my $scope;
5605: for ($scope=1;$scope<=$version;$scope++) {
5606: my $vkeys=$hash{"$scope:keys:$symb"};
5607: my @keys=split(/:/,$vkeys);
5608: my $key;
5609: $returnhash{"$scope:keys"}=$vkeys;
5610: foreach $key (@keys) {
1.591 albertel 5611: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5612: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 5613: }
5614: }
1.168 albertel 5615: if (!(untie(%hash))) {
5616: return "error:$!";
5617: }
5618: } else {
5619: return "error:$!";
5620: }
5621: return %returnhash;
1.167 albertel 5622: }
5623:
1.9 www 5624: # ----------------------------------------------------------------------- Store
5625:
5626: sub store {
1.1269 raeburn 5627: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5628: my $home='';
5629:
1.168 albertel 5630: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5631:
1.213 www 5632: $symb=&symbclean($symb);
1.122 albertel 5633: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5634:
1.620 albertel 5635: if (!$domain) { $domain=$env{'user.domain'}; }
5636: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5637:
5638: &devalidate($symb,$stuname,$domain);
1.109 www 5639:
5640: $symb=escape($symb);
1.187 www 5641: if (!$namespace) {
1.620 albertel 5642: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5643: return '';
5644: }
5645: }
1.620 albertel 5646: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5647:
5648: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5649: $$storehash{'host'}=$perlvar{'lonHostID'};
5650:
1.12 www 5651: my $namevalue='';
1.800 albertel 5652: foreach my $key (keys(%$storehash)) {
5653: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5654: }
1.12 www 5655: $namevalue=~s/\&$//;
1.187 www 5656: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269 raeburn 5657: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 5658: }
5659:
1.47 www 5660: # -------------------------------------------------------------- Critical Store
5661:
5662: sub cstore {
1.1269 raeburn 5663: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5664: my $home='';
5665:
1.168 albertel 5666: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5667:
1.213 www 5668: $symb=&symbclean($symb);
1.122 albertel 5669: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5670:
1.620 albertel 5671: if (!$domain) { $domain=$env{'user.domain'}; }
5672: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5673:
5674: &devalidate($symb,$stuname,$domain);
1.109 www 5675:
5676: $symb=escape($symb);
1.187 www 5677: if (!$namespace) {
1.620 albertel 5678: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5679: return '';
5680: }
5681: }
1.620 albertel 5682: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5683:
5684: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5685: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 5686:
1.47 www 5687: my $namevalue='';
1.800 albertel 5688: foreach my $key (keys(%$storehash)) {
5689: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5690: }
1.47 www 5691: $namevalue=~s/\&$//;
1.187 www 5692: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 5693: return critical
1.1269 raeburn 5694: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 5695: }
5696:
1.9 www 5697: # --------------------------------------------------------------------- Restore
5698:
5699: sub restore {
1.124 www 5700: my ($symb,$namespace,$domain,$stuname) = @_;
5701: my $home='';
5702:
1.168 albertel 5703: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5704:
1.122 albertel 5705: if (!$symb) {
1.1224 raeburn 5706: return if ($namespace eq 'courserequests');
5707: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 5708: } else {
1.1224 raeburn 5709: unless ($namespace eq 'courserequests') {
5710: $symb=&escape(&symbclean($symb));
5711: }
1.122 albertel 5712: }
1.188 www 5713: if (!$namespace) {
1.620 albertel 5714: unless ($namespace=$env{'request.course.id'}) {
1.188 www 5715: return '';
5716: }
5717: }
1.620 albertel 5718: if (!$domain) { $domain=$env{'user.domain'}; }
5719: if (!$stuname) { $stuname=$env{'user.name'}; }
5720: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 5721: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5722:
1.12 www 5723: my %returnhash=();
1.800 albertel 5724: foreach my $line (split(/\&/,$answer)) {
5725: my ($name,$value)=split(/\=/,$line);
1.591 albertel 5726: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 5727: }
1.75 www 5728: my $version;
5729: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 5730: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5731: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 5732: }
1.75 www 5733: }
1.13 www 5734: return %returnhash;
1.34 www 5735: }
5736:
5737: # ---------------------------------------------------------- Course Description
1.1118 foxr 5738: #
5739: #
1.34 www 5740:
5741: sub coursedescription {
1.731 albertel 5742: my ($courseid,$args)=@_;
1.34 www 5743: $courseid=~s/^\///;
1.49 www 5744: $courseid=~s/\_/\//g;
1.34 www 5745: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 5746: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 5747: my $normalid=$cdomain.'_'.$cnum;
5748: # need to always cache even if we get errors otherwise we keep
5749: # trying and trying and trying to get the course description.
5750: my %envhash=();
5751: my %returnhash=();
1.731 albertel 5752:
5753: my $expiretime=600;
5754: if ($env{'request.course.id'} eq $normalid) {
5755: $expiretime=120;
5756: }
5757:
5758: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5759: if (!$args->{'freshen_cache'}
5760: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5761: foreach my $key (keys(%env)) {
5762: next if ($key !~ /^\Q$prefix\E(.*)/);
5763: my ($setting) = $1;
5764: $returnhash{$setting} = $env{$key};
5765: }
5766: return %returnhash;
5767: }
5768:
1.1118 foxr 5769: # get the data again
5770:
1.731 albertel 5771: if (!$args->{'one_time'}) {
5772: $envhash{'course.'.$normalid.'.last_cache'}=time;
5773: }
1.811 albertel 5774:
1.34 www 5775: if ($chome ne 'no_host') {
1.302 albertel 5776: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 5777: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 5778: my $username = $env{'user.name'}; # Defult username
5779: if(defined $args->{'user'}) {
5780: $username = $args->{'user'};
5781: }
1.129 albertel 5782: $returnhash{'home'}= $chome;
5783: $returnhash{'domain'} = $cdomain;
5784: $returnhash{'num'} = $cnum;
1.741 raeburn 5785: if (!defined($returnhash{'type'})) {
5786: $returnhash{'type'} = 'Course';
5787: }
1.130 albertel 5788: while (my ($name,$value) = each %returnhash) {
1.53 www 5789: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 5790: }
1.270 www 5791: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 5792: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 5793: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 5794: $envhash{'course.'.$normalid.'.home'}=$chome;
5795: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5796: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 5797: }
5798: }
1.731 albertel 5799: if (!$args->{'one_time'}) {
1.949 raeburn 5800: &appenv(\%envhash);
1.731 albertel 5801: }
1.302 albertel 5802: return %returnhash;
1.461 www 5803: }
5804:
1.1080 raeburn 5805: sub update_released_required {
5806: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5807: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5808: $cid = $env{'request.course.id'};
5809: $cdom = $env{'course.'.$cid.'.domain'};
5810: $cnum = $env{'course.'.$cid.'.num'};
5811: $chome = $env{'course.'.$cid.'.home'};
5812: }
5813: if ($needsrelease) {
5814: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5815: my $needsupdate;
5816: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5817: $needsupdate = 1;
5818: } else {
5819: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5820: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5821: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5822: $needsupdate = 1;
5823: }
5824: }
5825: if ($needsupdate) {
5826: my %needshash = (
5827: 'internal.releaserequired' => $needsrelease,
5828: );
5829: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5830: if ($putresult eq 'ok') {
5831: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5832: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5833: if (ref($crsinfo{$cid}) eq 'HASH') {
5834: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5835: &courseidput($cdom,\%crsinfo,$chome,'notime');
5836: }
5837: }
5838: }
5839: }
5840: return;
5841: }
5842:
1.461 www 5843: # -------------------------------------------------See if a user is privileged
5844:
5845: sub privileged {
1.1219 raeburn 5846: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 5847: my $now = time;
1.1219 raeburn 5848: my $roles;
5849: if (ref($possroles) eq 'ARRAY') {
5850: $roles = $possroles;
5851: } else {
5852: $roles = ['dc','su'];
5853: }
5854: if (ref($possdomains) eq 'ARRAY') {
5855: my %privileged = &privileged_by_domain($possdomains,$roles);
5856: foreach my $dom (@{$possdomains}) {
5857: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5858: (ref($privileged{$dom}) eq 'HASH')) {
5859: foreach my $role (@{$roles}) {
5860: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5861: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5862: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5863: return 1 unless (($end && $end < $now) ||
5864: ($start && $start > $now));
5865: }
5866: }
5867: }
5868: }
5869: }
5870: } else {
5871: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5872: my $now = time;
1.1170 droeschl 5873:
1.1275 musolffc 5874: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 5875: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 5876: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 5877: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 5878: or ($tstart && $tstart > $now);
1.1170 droeschl 5879: }
1.1219 raeburn 5880: }
5881: }
5882: return 0;
5883: }
1.1170 droeschl 5884:
1.1219 raeburn 5885: sub privileged_by_domain {
5886: my ($domains,$roles) = @_;
5887: my %privileged = ();
5888: my $cachetime = 60*60*24;
5889: my $now = time;
5890: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5891: return %privileged;
5892: }
5893: foreach my $dom (@{$domains}) {
5894: next if (ref($privileged{$dom}) eq 'HASH');
5895: my $needroles;
5896: foreach my $role (@{$roles}) {
5897: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5898: if (defined($cached)) {
5899: if (ref($result) eq 'HASH') {
5900: $privileged{$dom}{$role} = $result;
5901: }
5902: } else {
5903: $needroles = 1;
5904: }
5905: }
5906: if ($needroles) {
5907: my %dompersonnel = &get_domain_roles($dom,$roles);
5908: $privileged{$dom} = {};
5909: foreach my $server (keys(%dompersonnel)) {
5910: if (ref($dompersonnel{$server}) eq 'HASH') {
5911: foreach my $item (keys(%{$dompersonnel{$server}})) {
5912: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5913: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5914: next if ($end && $end < $now);
5915: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5916: $dompersonnel{$server}{$item};
5917: }
5918: }
5919: }
5920: if (ref($privileged{$dom}) eq 'HASH') {
5921: foreach my $role (@{$roles}) {
5922: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5923: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5924: } else {
5925: my %hash = ();
5926: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5927: }
5928: }
5929: }
5930: }
5931: }
5932: return %privileged;
1.9 www 5933: }
1.1 albertel 5934:
1.103 harris41 5935: # -------------------------------------------------------- Get user privileges
1.11 www 5936:
5937: sub rolesinit {
1.1169 droeschl 5938: my ($domain, $username) = @_;
5939: my %userroles = ('user.login.time' => time);
5940: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5941:
5942: # firstaccess and timerinterval are related to timed maps/resources.
5943: # also, blocking can be triggered by an activating timer
5944: # it's saved in the user's %env.
5945: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5946: my %timerinterval = &dump('timerinterval', $domain, $username);
5947: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5948: %timerintchk, %timerintenv);
5949:
1.1162 raeburn 5950: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 5951: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 5952: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5953: }
1.1169 droeschl 5954:
1.1162 raeburn 5955: foreach my $key (keys(%timerinterval)) {
5956: my ($cid,$rest) = split(/\0/,$key);
5957: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5958: }
1.1169 droeschl 5959:
1.11 www 5960: my %allroles=();
1.1162 raeburn 5961: my %allgroups=();
1.11 www 5962:
1.1274 raeburn 5963: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 5964: my $role = $rolesdump{$area};
5965: $area =~ s/\_\w\w$//;
5966:
5967: my ($trole, $tend, $tstart, $group_privs);
5968:
5969: if ($role =~ /^cr/) {
5970: # Custom role, defined by a user
5971: # e.g., user.role.cr/msu/smith/mynewrole
5972: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5973: $trole = $1;
5974: ($tend, $tstart) = split('_', $2);
5975: } else {
5976: $trole = $role;
5977: }
5978: } elsif ($role =~ m|^gr/|) {
5979: # Role of member in a group, defined within a course/community
5980: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5981: ($trole, $tend, $tstart) = split(/_/, $role);
5982: next if $tstart eq '-1';
5983: ($trole, $group_privs) = split(/\//, $trole);
5984: $group_privs = &unescape($group_privs);
5985: } else {
5986: # Just a normal role, defined in roles.tab
5987: ($trole, $tend, $tstart) = split(/_/,$role);
5988: }
5989:
5990: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5991: $username);
5992: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5993:
5994: # role expired or not available yet?
5995: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5996: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5997:
5998: next if $area eq '' or $trole eq '';
5999:
6000: my $spec = "$trole.$area";
6001: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
6002:
6003: if ($trole =~ /^cr\//) {
6004: # Custom role, defined by a user
6005: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6006: } elsif ($trole eq 'gr') {
6007: # Role of a member in a group, defined within a course/community
6008: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
6009: next;
6010: } else {
6011: # Normal role, defined in roles.tab
6012: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6013: }
6014:
6015: my $cid = $tdomain.'_'.$trest;
6016: unless ($firstaccchk{$cid}) {
6017: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6018: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6019: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6020: $coursetimerstarts{$cid}{$item};
6021: }
6022: }
6023: $firstaccchk{$cid} = 1;
6024: }
6025: unless ($timerintchk{$cid}) {
6026: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6027: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6028: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6029: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 6030: }
1.12 www 6031: }
1.1169 droeschl 6032: $timerintchk{$cid} = 1;
1.191 harris41 6033: }
1.11 www 6034: }
1.1169 droeschl 6035:
1.1341 raeburn 6036: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6037: \%allroles, \%allgroups);
1.1169 droeschl 6038: $env{'user.adv'} = $userroles{'user.adv'};
1.1341 raeburn 6039: $env{'user.rar'} = $userroles{'user.rar'};
1.1169 droeschl 6040:
1.1162 raeburn 6041: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 6042: }
6043:
1.567 raeburn 6044: sub set_arearole {
1.1215 raeburn 6045: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6046: unless ($nolog) {
1.567 raeburn 6047: # log the associated role with the area
1.1215 raeburn 6048: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6049: }
1.743 albertel 6050: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 6051: }
6052:
6053: sub custom_roleprivs {
6054: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6055: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250 raeburn 6056: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 6057: if (&hostname($homsvr) ne '') {
1.567 raeburn 6058: my ($rdummy,$roledef)=
6059: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6060: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6061: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6062: if (defined($syspriv)) {
1.1043 raeburn 6063: if ($trest =~ /^$match_community$/) {
6064: $syspriv =~ s/bre\&S//;
6065: }
1.567 raeburn 6066: $$allroles{'cm./'}.=':'.$syspriv;
6067: $$allroles{$spec.'./'}.=':'.$syspriv;
6068: }
6069: if ($tdomain ne '') {
6070: if (defined($dompriv)) {
6071: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6072: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6073: }
6074: if (($trest ne '') && (defined($coursepriv))) {
1.1332 raeburn 6075: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6076: my $rolename = $1;
6077: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6078: }
1.567 raeburn 6079: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6080: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6081: }
6082: }
6083: }
6084: }
6085: }
6086:
1.1332 raeburn 6087: sub course_adhocrole_privs {
6088: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6089: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6090: if ($overrides{"internal.adhocpriv.$rolename"}) {
6091: my (%currprivs,%storeprivs);
6092: foreach my $item (split(/:/,$coursepriv)) {
6093: my ($priv,$restrict) = split(/\&/,$item);
6094: $currprivs{$priv} = $restrict;
6095: }
6096: my (%possadd,%possremove,%full);
6097: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6098: my ($priv,$restrict)=split(/\&/,$item);
6099: $full{$priv} = $restrict;
6100: }
6101: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
6102: next if ($item eq '');
6103: my ($rule,$rest) = split(/=/,$item);
6104: next unless (($rule eq 'off') || ($rule eq 'on'));
6105: foreach my $priv (split(/:/,$rest)) {
6106: if ($priv ne '') {
6107: if ($rule eq 'off') {
6108: $possremove{$priv} = 1;
6109: } else {
6110: $possadd{$priv} = 1;
6111: }
6112: }
6113: }
6114: }
6115: foreach my $priv (sort(keys(%full))) {
6116: if (exists($currprivs{$priv})) {
6117: unless (exists($possremove{$priv})) {
6118: $storeprivs{$priv} = $currprivs{$priv};
6119: }
6120: } elsif (exists($possadd{$priv})) {
6121: $storeprivs{$priv} = $full{$priv};
6122: }
6123: }
6124: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6125: }
6126: return $coursepriv;
6127: }
6128:
1.678 raeburn 6129: sub group_roleprivs {
6130: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6131: my $access = 1;
6132: my $now = time;
6133: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6134: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6135: if ($access) {
1.811 albertel 6136: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 6137: $$allgroups{$course}{$group} .=':'.$group_privs;
6138: }
6139: }
1.567 raeburn 6140:
6141: sub standard_roleprivs {
6142: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6143: if (defined($pr{$trole.':s'})) {
6144: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6145: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6146: }
6147: if ($tdomain ne '') {
6148: if (defined($pr{$trole.':d'})) {
6149: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6150: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6151: }
6152: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6153: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6154: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
6155: }
6156: }
6157: }
6158:
6159: sub set_userprivs {
1.1064 raeburn 6160: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 6161: my $author=0;
6162: my $adv=0;
1.1341 raeburn 6163: my $rar=0;
1.678 raeburn 6164: my %grouproles = ();
6165: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 6166: my @groupkeys;
1.1000 raeburn 6167: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 6168: push(@groupkeys,$role);
6169: }
6170: if (ref($groups_roles) eq 'HASH') {
6171: foreach my $key (keys(%{$groups_roles})) {
6172: unless (grep(/^\Q$key\E$/,@groupkeys)) {
6173: push(@groupkeys,$key);
6174: }
6175: }
6176: }
6177: if (@groupkeys > 0) {
6178: foreach my $role (@groupkeys) {
6179: my ($trole,$area,$sec,$extendedarea);
6180: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
6181: $trole = $1;
6182: $area = $2;
6183: $sec = $3;
6184: $extendedarea = $area.$sec;
6185: if (exists($$allgroups{$area})) {
6186: foreach my $group (keys(%{$$allgroups{$area}})) {
6187: my $spec = $trole.'.'.$extendedarea;
6188: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 6189: $$allgroups{$area}{$group};
1.1064 raeburn 6190: }
1.678 raeburn 6191: }
6192: }
6193: }
6194: }
6195: }
1.800 albertel 6196: foreach my $group (keys(%grouproles)) {
6197: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 6198: }
1.800 albertel 6199: foreach my $role (keys(%{$allroles})) {
6200: my %thesepriv;
1.941 raeburn 6201: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 6202: foreach my $item (split(/:/,$$allroles{$role})) {
6203: if ($item ne '') {
6204: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 6205: if ($restrictions eq '') {
6206: $thesepriv{$privilege}='F';
6207: } elsif ($thesepriv{$privilege} ne 'F') {
6208: $thesepriv{$privilege}.=$restrictions;
6209: }
6210: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1341 raeburn 6211: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567 raeburn 6212: }
6213: }
6214: my $thesestr='';
1.1104 raeburn 6215: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 6216: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
6217: }
6218: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 6219: }
1.1341 raeburn 6220: return ($author,$adv,$rar);
1.567 raeburn 6221: }
6222:
1.994 raeburn 6223: sub role_status {
1.1104 raeburn 6224: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 6225: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250 raeburn 6226: my ($one,$two) = split(m{\./},$rolekey,2);
6227: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 6228: unless (!defined($$role) || $$role eq '') {
1.1251 raeburn 6229: $$where = '/'.$two;
1.994 raeburn 6230: $$trolecode=$$role.'.'.$$where;
6231: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
6232: $$tstatus='is';
1.1104 raeburn 6233: if ($$tstart && $$tstart>$update) {
1.994 raeburn 6234: $$tstatus='future';
1.1034 raeburn 6235: if ($$tstart<$now) {
6236: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 6237: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 6238: my (%allroles,%allgroups,$group_privs,
6239: %groups_roles,@rolecodes);
1.1002 raeburn 6240: my %userroles = (
6241: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
6242: );
1.1064 raeburn 6243: @rolecodes = ('cm');
1.1002 raeburn 6244: my $spec=$$role.'.'.$$where;
6245: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
6246: if ($$role =~ /^cr\//) {
6247: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 6248: push(@rolecodes,'cr');
1.1002 raeburn 6249: } elsif ($$role eq 'gr') {
1.1064 raeburn 6250: push(@rolecodes,$$role);
1.1002 raeburn 6251: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
6252: $env{'user.name'});
1.1064 raeburn 6253: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 6254: (undef,my $group_privs) = split(/\//,$trole);
6255: $group_privs = &unescape($group_privs);
6256: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 6257: 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 6258: &get_groups_roles($tdomain,$trest,
6259: \%course_roles,\@rolecodes,
6260: \%groups_roles);
1.1002 raeburn 6261: } else {
1.1064 raeburn 6262: push(@rolecodes,$$role);
1.1002 raeburn 6263: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
6264: }
1.1341 raeburn 6265: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
6266: \%groups_roles);
1.1064 raeburn 6267: &appenv(\%userroles,\@rolecodes);
1.1342 raeburn 6268: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002 raeburn 6269: }
6270: }
1.1034 raeburn 6271: $$tstatus = 'is';
1.1002 raeburn 6272: }
1.994 raeburn 6273: }
6274: if ($$tend) {
1.1104 raeburn 6275: if ($$tend<$update) {
1.994 raeburn 6276: $$tstatus='expired';
6277: } elsif ($$tend<$now) {
6278: $$tstatus='will_not';
6279: }
6280: }
6281: }
6282: }
6283: }
6284:
1.1104 raeburn 6285: sub get_groups_roles {
6286: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
6287: return unless((ref($cdom_courseroles) eq 'HASH') &&
6288: (ref($rolecodes) eq 'ARRAY') &&
6289: (ref($groups_roles) eq 'HASH'));
6290: if (keys(%{$cdom_courseroles}) > 0) {
6291: my ($cnum) = ($rest =~ /^($match_courseid)/);
6292: if ($cdom ne '' && $cnum ne '') {
6293: foreach my $key (keys(%{$cdom_courseroles})) {
6294: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
6295: my $crsrole = $1;
6296: my $crssec = $2;
6297: if ($crsrole =~ /^cr/) {
6298: unless (grep(/^cr$/,@{$rolecodes})) {
6299: push(@{$rolecodes},'cr');
6300: }
6301: } else {
6302: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
6303: push(@{$rolecodes},$crsrole);
6304: }
6305: }
6306: my $rolekey = "$crsrole./$cdom/$cnum";
6307: if ($crssec ne '') {
6308: $rolekey .= "/$crssec";
6309: }
6310: $rolekey .= './';
6311: $groups_roles->{$rolekey} = $rolecodes;
6312: }
6313: }
6314: }
6315: }
6316: return;
6317: }
6318:
6319: sub delete_env_groupprivs {
6320: my ($where,$courseroles,$possroles) = @_;
6321: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
6322: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
6323: unless (ref($courseroles->{$udom}) eq 'HASH') {
6324: %{$courseroles->{$udom}} =
6325: &get_my_roles('','','userroles',['active'],
6326: $possroles,[$udom],1);
6327: }
6328: if (ref($courseroles->{$udom}) eq 'HASH') {
6329: foreach my $item (keys(%{$courseroles->{$udom}})) {
6330: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
6331: my $area = '/'.$cdom.'/'.$cnum;
6332: my $privkey = "user.priv.$crsrole.$area";
6333: if ($crssec ne '') {
6334: $privkey .= '/'.$crssec;
6335: }
6336: $privkey .= ".$area/$group";
6337: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
6338: }
6339: }
6340: return;
6341: }
6342:
1.994 raeburn 6343: sub check_adhoc_privs {
1.1329 raeburn 6344: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 6345: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1329 raeburn 6346: if ($sec) {
6347: $cckey .= '/'.$sec;
6348: }
1.1185 raeburn 6349: my $setprivs;
1.994 raeburn 6350: if ($env{$cckey}) {
6351: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 6352: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 6353: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1329 raeburn 6354: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 6355: $setprivs = 1;
1.994 raeburn 6356: }
6357: } else {
1.1330 raeburn 6358: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 6359: $setprivs = 1;
1.994 raeburn 6360: }
1.1185 raeburn 6361: return $setprivs;
1.994 raeburn 6362: }
6363:
6364: sub set_adhoc_privileges {
1.1326 raeburn 6365: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1329 raeburn 6366: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 6367: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1329 raeburn 6368: if ($sec ne '') {
6369: $area .= '/'.$sec;
6370: }
1.994 raeburn 6371: my $spec = $role.'.'.$area;
6372: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 6373: $env{'user.name'},1);
1.1326 raeburn 6374: my %rolehash = ();
1.1332 raeburn 6375: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
6376: my $rolename = $1;
1.1326 raeburn 6377: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1332 raeburn 6378: my %domdef = &get_domain_defaults($dcdom);
6379: if (ref($domdef{'adhocroles'}) eq 'HASH') {
6380: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
6381: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
6382: }
6383: }
1.1326 raeburn 6384: } else {
6385: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
6386: }
1.1341 raeburn 6387: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 6388: &appenv(\%userroles,[$role,'cm']);
1.1342 raeburn 6389: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1088 raeburn 6390: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
6391: &appenv( {'request.role' => $spec,
6392: 'request.role.domain' => $dcdom,
1.1332 raeburn 6393: 'request.course.sec' => $sec,
1.1088 raeburn 6394: }
6395: );
6396: my $tadv=0;
6397: if (&allowed('adv') eq 'F') { $tadv=1; }
6398: &appenv({'request.role.adv' => $tadv});
6399: }
1.994 raeburn 6400: }
6401:
1.12 www 6402: # --------------------------------------------------------------- get interface
6403:
6404: sub get {
1.131 albertel 6405: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6406: my $items='';
1.800 albertel 6407: foreach my $item (@$storearr) {
6408: $items.=&escape($item).'&';
1.191 harris41 6409: }
1.12 www 6410: $items=~s/\&$//;
1.620 albertel 6411: if (!$udomain) { $udomain=$env{'user.domain'}; }
6412: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 6413: my $uhome=&homeserver($uname,$udomain);
6414:
1.133 albertel 6415: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6416: my @pairs=split(/\&/,$rep);
1.273 albertel 6417: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
6418: return @pairs;
6419: }
1.15 www 6420: my %returnhash=();
1.42 www 6421: my $i=0;
1.800 albertel 6422: foreach my $item (@$storearr) {
6423: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6424: $i++;
1.191 harris41 6425: }
1.15 www 6426: return %returnhash;
1.27 www 6427: }
6428:
6429: # --------------------------------------------------------------- del interface
6430:
6431: sub del {
1.133 albertel 6432: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 6433: my $items='';
1.800 albertel 6434: foreach my $item (@$storearr) {
6435: $items.=&escape($item).'&';
1.191 harris41 6436: }
1.984 neumanie 6437:
1.27 www 6438: $items=~s/\&$//;
1.620 albertel 6439: if (!$udomain) { $udomain=$env{'user.domain'}; }
6440: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6441: my $uhome=&homeserver($uname,$udomain);
6442: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6443: }
6444:
6445: # -------------------------------------------------------------- dump interface
6446:
1.1180 droeschl 6447: sub unserialize {
6448: my ($rep, $escapedkeys) = @_;
6449:
6450: return {} if $rep =~ /^error/;
6451:
6452: my %returnhash=();
1.1252 raeburn 6453: foreach my $item (split(/\&/,$rep)) {
1.1180 droeschl 6454: my ($key, $value) = split(/=/, $item, 2);
6455: $key = unescape($key) unless $escapedkeys;
6456: next if $key =~ /^error: 2 /;
1.1252 raeburn 6457: $returnhash{$key} = &thaw_unescape($value);
1.1180 droeschl 6458: }
6459: #return %returnhash;
6460: return \%returnhash;
6461: }
6462:
6463: # see Lond::dump_with_regexp
6464: # if $escapedkeys hash keys won't get unescaped.
1.15 www 6465: sub dump {
1.1180 droeschl 6466: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755 albertel 6467: if (!$udomain) { $udomain=$env{'user.domain'}; }
6468: if (!$uname) { $uname=$env{'user.name'}; }
6469: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 6470:
1.1266 raeburn 6471: if ($regexp) {
6472: $regexp=&escape($regexp);
6473: } else {
6474: $regexp='.';
6475: }
1.1180 droeschl 6476: if (grep { $_ eq $uhome } current_machine_ids()) {
6477: # user is hosted on this machine
1.1266 raeburn 6478: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 6479: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 6480: return %{unserialize($reply, $escapedkeys)};
6481: }
1.1166 raeburn 6482: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 6483: my @pairs=split(/\&/,$rep);
6484: my %returnhash=();
1.1098 foxr 6485: if (!($rep =~ /^error/ )) {
6486: foreach my $item (@pairs) {
6487: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 6488: $key = unescape($key) unless $escapedkeys;
6489: #$key = &unescape($key);
1.1098 foxr 6490: next if ($key =~ /^error: 2 /);
6491: $returnhash{$key}=&thaw_unescape($value);
6492: }
1.755 albertel 6493: }
6494: return %returnhash;
1.407 www 6495: }
6496:
1.1098 foxr 6497:
1.717 albertel 6498: # --------------------------------------------------------- dumpstore interface
6499:
6500: sub dumpstore {
6501: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 6502: # same as dump but keys must be escaped. They may contain colon separated
6503: # lists of values that may themself contain colons (e.g. symbs).
6504: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 6505: }
6506:
1.407 www 6507: # -------------------------------------------------------------- keys interface
6508:
6509: sub getkeys {
6510: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 6511: if (!$udomain) { $udomain=$env{'user.domain'}; }
6512: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 6513: my $uhome=&homeserver($uname,$udomain);
6514: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
6515: my @keyarray=();
1.800 albertel 6516: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 6517: next if ($key =~ /^error: 2 /);
1.800 albertel 6518: push(@keyarray,&unescape($key));
1.407 www 6519: }
6520: return @keyarray;
1.318 matthew 6521: }
6522:
1.319 matthew 6523: # --------------------------------------------------------------- currentdump
6524: sub currentdump {
1.328 matthew 6525: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 6526: $courseid = $env{'request.course.id'} if (! defined($courseid));
6527: $sdom = $env{'user.domain'} if (! defined($sdom));
6528: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 6529: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 6530: my $rep;
6531:
6532: if (grep { $_ eq $uhome } current_machine_ids()) {
6533: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
6534: $courseid)));
6535: } else {
6536: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
6537: }
6538:
1.318 matthew 6539: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 6540: #
1.318 matthew 6541: my %returnhash=();
1.319 matthew 6542: #
1.1343 raeburn 6543: if ($rep eq 'unknown_cmd') {
1.319 matthew 6544: # an old lond will not know currentdump
6545: # Do a dump and make it look like a currentdump
1.822 albertel 6546: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 6547: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6548: my %hash = @tmp;
6549: @tmp=();
1.424 matthew 6550: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 6551: } else {
6552: my @pairs=split(/\&/,$rep);
1.800 albertel 6553: foreach my $pair (@pairs) {
6554: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 6555: my ($symb,$param) = split(/:/,$key);
6556: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 6557: &thaw_unescape($value);
1.319 matthew 6558: }
1.191 harris41 6559: }
1.12 www 6560: return %returnhash;
1.424 matthew 6561: }
6562:
6563: sub convert_dump_to_currentdump{
6564: my %hash = %{shift()};
6565: my %returnhash;
6566: # Code ripped from lond, essentially. The only difference
6567: # here is the unescaping done by lonnet::dump(). Conceivably
6568: # we might run in to problems with parameter names =~ /^v\./
6569: while (my ($key,$value) = each(%hash)) {
6570: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 6571: $symb = &unescape($symb);
6572: $param = &unescape($param);
1.424 matthew 6573: next if ($v eq 'version' || $symb eq 'keys');
6574: next if (exists($returnhash{$symb}) &&
6575: exists($returnhash{$symb}->{$param}) &&
6576: $returnhash{$symb}->{'v.'.$param} > $v);
6577: $returnhash{$symb}->{$param}=$value;
6578: $returnhash{$symb}->{'v.'.$param}=$v;
6579: }
6580: #
6581: # Remove all of the keys in the hashes which keep track of
6582: # the version of the parameter.
6583: while (my ($symb,$param_hash) = each(%returnhash)) {
6584: # use a foreach because we are going to delete from the hash.
6585: foreach my $key (keys(%$param_hash)) {
6586: delete($param_hash->{$key}) if ($key =~ /^v\./);
6587: }
6588: }
6589: return \%returnhash;
1.12 www 6590: }
6591:
1.627 albertel 6592: # ------------------------------------------------------ critical inc interface
6593:
6594: sub cinc {
6595: return &inc(@_,'critical');
6596: }
6597:
1.449 matthew 6598: # --------------------------------------------------------------- inc interface
6599:
6600: sub inc {
1.627 albertel 6601: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 6602: if (!$udomain) { $udomain=$env{'user.domain'}; }
6603: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 6604: my $uhome=&homeserver($uname,$udomain);
6605: my $items='';
6606: if (! ref($store)) {
6607: # got a single value, so use that instead
6608: $items = &escape($store).'=&';
6609: } elsif (ref($store) eq 'SCALAR') {
6610: $items = &escape($$store).'=&';
6611: } elsif (ref($store) eq 'ARRAY') {
6612: $items = join('=&',map {&escape($_);} @{$store});
6613: } elsif (ref($store) eq 'HASH') {
6614: while (my($key,$value) = each(%{$store})) {
6615: $items.= &escape($key).'='.&escape($value).'&';
6616: }
6617: }
6618: $items=~s/\&$//;
1.627 albertel 6619: if ($critical) {
6620: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6621: } else {
6622: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6623: }
1.449 matthew 6624: }
6625:
1.12 www 6626: # --------------------------------------------------------------- put interface
6627:
6628: sub put {
1.134 albertel 6629: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6630: if (!$udomain) { $udomain=$env{'user.domain'}; }
6631: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6632: my $uhome=&homeserver($uname,$udomain);
1.12 www 6633: my $items='';
1.800 albertel 6634: foreach my $item (keys(%$storehash)) {
6635: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6636: }
1.12 www 6637: $items=~s/\&$//;
1.134 albertel 6638: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 6639: }
6640:
1.631 albertel 6641: # ------------------------------------------------------------ newput interface
6642:
6643: sub newput {
6644: my ($namespace,$storehash,$udomain,$uname)=@_;
6645: if (!$udomain) { $udomain=$env{'user.domain'}; }
6646: if (!$uname) { $uname=$env{'user.name'}; }
6647: my $uhome=&homeserver($uname,$udomain);
6648: my $items='';
6649: foreach my $key (keys(%$storehash)) {
6650: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6651: }
6652: $items=~s/\&$//;
6653: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6654: }
6655:
6656: # --------------------------------------------------------- putstore interface
6657:
1.524 raeburn 6658: sub putstore {
1.1269 raeburn 6659: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 6660: if (!$udomain) { $udomain=$env{'user.domain'}; }
6661: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 6662: my $uhome=&homeserver($uname,$udomain);
6663: my $items='';
1.715 albertel 6664: foreach my $key (keys(%$storehash)) {
6665: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 6666: }
1.715 albertel 6667: $items=~s/\&$//;
1.716 albertel 6668: my $esc_symb=&escape($symb);
6669: my $esc_v=&escape($version);
1.715 albertel 6670: my $reply =
1.716 albertel 6671: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 6672: $uhome);
1.1269 raeburn 6673: if (($tolog) && ($reply eq 'ok')) {
6674: my $namevalue='';
6675: foreach my $key (keys(%{$storehash})) {
6676: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6677: }
6678: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6679: '&host='.&escape($perlvar{'lonHostID'}).
6680: '&version='.$esc_v.
6681: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6682: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6683: }
1.715 albertel 6684: if ($reply eq 'unknown_cmd') {
1.716 albertel 6685: # gfall back to way things use to be done
1.715 albertel 6686: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6687: $uname);
1.524 raeburn 6688: }
1.715 albertel 6689: return $reply;
6690: }
6691:
6692: sub old_putstore {
1.716 albertel 6693: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6694: if (!$udomain) { $udomain=$env{'user.domain'}; }
6695: if (!$uname) { $uname=$env{'user.name'}; }
6696: my $uhome=&homeserver($uname,$udomain);
6697: my %newstorehash;
1.800 albertel 6698: foreach my $item (keys(%$storehash)) {
6699: my $key = $version.':'.&escape($symb).':'.$item;
6700: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 6701: }
6702: my $items='';
6703: my %allitems = ();
1.800 albertel 6704: foreach my $item (keys(%newstorehash)) {
6705: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 6706: my $key = $1.':keys:'.$2;
6707: $allitems{$key} .= $3.':';
6708: }
1.800 albertel 6709: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 6710: }
1.800 albertel 6711: foreach my $item (keys(%allitems)) {
6712: $allitems{$item} =~ s/\:$//;
6713: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 6714: }
6715: $items=~s/\&$//;
6716: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 6717: }
6718:
1.47 www 6719: # ------------------------------------------------------ critical put interface
6720:
6721: sub cput {
1.134 albertel 6722: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6723: if (!$udomain) { $udomain=$env{'user.domain'}; }
6724: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6725: my $uhome=&homeserver($uname,$udomain);
1.47 www 6726: my $items='';
1.800 albertel 6727: foreach my $item (keys(%$storehash)) {
6728: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6729: }
1.47 www 6730: $items=~s/\&$//;
1.134 albertel 6731: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6732: }
6733:
6734: # -------------------------------------------------------------- eget interface
6735:
6736: sub eget {
1.133 albertel 6737: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6738: my $items='';
1.800 albertel 6739: foreach my $item (@$storearr) {
6740: $items.=&escape($item).'&';
1.191 harris41 6741: }
1.12 www 6742: $items=~s/\&$//;
1.620 albertel 6743: if (!$udomain) { $udomain=$env{'user.domain'}; }
6744: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6745: my $uhome=&homeserver($uname,$udomain);
6746: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6747: my @pairs=split(/\&/,$rep);
6748: my %returnhash=();
1.42 www 6749: my $i=0;
1.800 albertel 6750: foreach my $item (@$storearr) {
6751: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6752: $i++;
1.191 harris41 6753: }
1.12 www 6754: return %returnhash;
6755: }
6756:
1.667 albertel 6757: # ------------------------------------------------------------ tmpput interface
6758: sub tmpput {
1.802 raeburn 6759: my ($storehash,$server,$context)=@_;
1.667 albertel 6760: my $items='';
1.800 albertel 6761: foreach my $item (keys(%$storehash)) {
6762: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 6763: }
6764: $items=~s/\&$//;
1.802 raeburn 6765: if (defined($context)) {
6766: $items .= ':'.&escape($context);
6767: }
1.667 albertel 6768: return &reply("tmpput:$items",$server);
6769: }
6770:
6771: # ------------------------------------------------------------ tmpget interface
6772: sub tmpget {
1.688 albertel 6773: my ($token,$server)=@_;
6774: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6775: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 6776: my %returnhash;
1.1328 raeburn 6777: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
6778: return %returnhash;
6779: }
1.667 albertel 6780: foreach my $item (split(/\&/,$rep)) {
6781: my ($key,$value)=split(/=/,$item);
6782: $returnhash{&unescape($key)}=&thaw_unescape($value);
6783: }
6784: return %returnhash;
6785: }
6786:
1.1113 raeburn 6787: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 6788: sub tmpdel {
6789: my ($token,$server)=@_;
6790: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6791: return &reply("tmpdel:$token",$server);
6792: }
6793:
1.1198 raeburn 6794: # ------------------------------------------------------------ get_timebased_id
6795:
6796: sub get_timebased_id {
6797: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6798: $maxtries) = @_;
6799: my ($newid,$error,$dellock);
6800: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6801: return ('','ok','invalid call to get suffix');
6802: }
6803:
6804: # set defaults for any optional args for which values were not supplied
6805: if ($who eq '') {
6806: $who = $env{'user.name'}.':'.$env{'user.domain'};
6807: }
6808: if (!$locktries) {
6809: $locktries = 3;
6810: }
6811: if (!$maxtries) {
6812: $maxtries = 10;
6813: }
6814:
6815: if (($cdom eq '') || ($cnum eq '')) {
6816: if ($env{'request.course.id'}) {
6817: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6818: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6819: }
6820: if (($cdom eq '') || ($cnum eq '')) {
6821: return ('','ok','call to get suffix not in course context');
6822: }
6823: }
6824:
6825: # construct locking item
6826: my $lockhash = {
6827: $prefix."\0".'locked_'.$keyid => $who,
6828: };
6829: my $tries = 0;
6830:
6831: # attempt to get lock on nohist_$namespace file
6832: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6833: while (($gotlock ne 'ok') && $tries <$locktries) {
6834: $tries ++;
6835: sleep 1;
6836: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6837: }
6838:
6839: # attempt to get unique identifier, based on current timestamp
6840: if ($gotlock eq 'ok') {
6841: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6842: my $id = time;
6843: $newid = $id;
1.1268 raeburn 6844: if ($idtype eq 'addcode') {
6845: $newid .= &sixnum_code();
6846: }
1.1198 raeburn 6847: my $idtries = 0;
6848: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6849: if ($idtype eq 'concat') {
6850: $newid = $id.$idtries;
1.1268 raeburn 6851: } elsif ($idtype eq 'addcode') {
6852: $newid = $newid.&sixnum_code();
1.1198 raeburn 6853: } else {
6854: $newid ++;
6855: }
6856: $idtries ++;
6857: }
6858: if (!exists($inuse{$prefix."\0".$newid})) {
6859: my %new_item = (
6860: $prefix."\0".$newid => $who,
6861: );
6862: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6863: $cdom,$cnum);
6864: if ($putresult ne 'ok') {
6865: undef($newid);
6866: $error = 'error saving new item: '.$putresult;
6867: }
6868: } else {
1.1268 raeburn 6869: undef($newid);
1.1198 raeburn 6870: $error = ('error: no unique suffix available for the new item ');
6871: }
6872: # remove lock
6873: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6874: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6875: } else {
6876: $error = "error: could not obtain lockfile\n";
6877: $dellock = 'ok';
1.1276 raeburn 6878: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6879: $dellock = 'nolock';
6880: }
1.1198 raeburn 6881: }
6882: return ($newid,$dellock,$error);
6883: }
6884:
1.1268 raeburn 6885: sub sixnum_code {
6886: my $code;
6887: for (0..6) {
6888: $code .= int( rand(9) );
6889: }
6890: return $code;
6891: }
6892:
1.765 albertel 6893: # -------------------------------------------------- portfolio access checking
6894:
6895: sub portfolio_access {
1.1270 raeburn 6896: my ($requrl,$clientip) = @_;
1.765 albertel 6897: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270 raeburn 6898: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 6899: if ($result) {
6900: my %setters;
6901: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6902: my ($startblock,$endblock) =
6903: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6904: if ($startblock && $endblock) {
6905: return 'B';
6906: }
6907: } else {
6908: my ($startblock,$endblock) =
6909: &Apache::loncommon::blockcheck(\%setters,'port');
6910: if ($startblock && $endblock) {
6911: return 'B';
6912: }
6913: }
6914: }
1.765 albertel 6915: if ($result eq 'ok') {
1.766 albertel 6916: return 'F';
1.765 albertel 6917: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 6918: return 'A';
1.765 albertel 6919: }
1.766 albertel 6920: return '';
1.765 albertel 6921: }
6922:
6923: sub get_portfolio_access {
1.1270 raeburn 6924: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 6925:
6926: if (!ref($access_hash)) {
6927: my $current_perms = &get_portfile_permissions($udom,$unum);
6928: my %access_controls = &get_access_controls($current_perms,$group,
6929: $file_name);
6930: $access_hash = $access_controls{$file_name};
6931: }
6932:
1.1270 raeburn 6933: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 6934: my $now = time;
6935: if (ref($access_hash) eq 'HASH') {
6936: foreach my $key (keys(%{$access_hash})) {
6937: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6938: if ($start > $now) {
6939: next;
6940: }
6941: if ($end && $end<$now) {
6942: next;
6943: }
6944: if ($scope eq 'public') {
6945: $public = $key;
6946: last;
6947: } elsif ($scope eq 'guest') {
6948: $guest = $key;
6949: } elsif ($scope eq 'domains') {
6950: push(@domains,$key);
6951: } elsif ($scope eq 'users') {
6952: push(@users,$key);
6953: } elsif ($scope eq 'course') {
6954: push(@courses,$key);
6955: } elsif ($scope eq 'group') {
6956: push(@groups,$key);
1.1270 raeburn 6957: } elsif ($scope eq 'ip') {
6958: push(@ips,$key);
1.765 albertel 6959: }
6960: }
6961: if ($public) {
6962: return 'ok';
1.1270 raeburn 6963: } elsif (@ips > 0) {
6964: my $allowed;
6965: foreach my $ipkey (@ips) {
6966: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6967: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6968: $allowed = 1;
6969: last;
6970: }
6971: }
6972: }
6973: if ($allowed) {
6974: return 'ok';
6975: }
1.765 albertel 6976: }
6977: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6978: if ($guest) {
6979: return $guest;
6980: }
6981: } else {
6982: if (@domains > 0) {
6983: foreach my $domkey (@domains) {
6984: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6985: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6986: return 'ok';
6987: }
6988: }
6989: }
6990: }
6991: if (@users > 0) {
6992: foreach my $userkey (@users) {
1.865 raeburn 6993: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6994: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6995: if (ref($item) eq 'HASH') {
6996: if (($item->{'uname'} eq $env{'user.name'}) &&
6997: ($item->{'udom'} eq $env{'user.domain'})) {
6998: return 'ok';
6999: }
7000: }
7001: }
7002: }
1.765 albertel 7003: }
7004: }
7005: my %roleshash;
7006: my @courses_and_groups = @courses;
7007: push(@courses_and_groups,@groups);
7008: if (@courses_and_groups > 0) {
7009: my (%allgroups,%allroles);
7010: my ($start,$end,$role,$sec,$group);
7011: foreach my $envkey (%env) {
1.1060 raeburn 7012: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7013: my $cid = $2.'_'.$3;
7014: if ($1 eq 'gr') {
7015: $group = $4;
7016: $allgroups{$cid}{$group} = $env{$envkey};
7017: } else {
7018: if ($4 eq '') {
7019: $sec = 'none';
7020: } else {
7021: $sec = $4;
7022: }
7023: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7024: }
1.811 albertel 7025: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7026: my $cid = $2.'_'.$3;
7027: if ($4 eq '') {
7028: $sec = 'none';
7029: } else {
7030: $sec = $4;
7031: }
7032: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7033: }
7034: }
7035: if (keys(%allroles) == 0) {
7036: return;
7037: }
7038: foreach my $key (@courses_and_groups) {
7039: my %content = %{$$access_hash{$key}};
7040: my $cnum = $content{'number'};
7041: my $cdom = $content{'domain'};
7042: my $cid = $cdom.'_'.$cnum;
7043: if (!exists($allroles{$cid})) {
7044: next;
7045: }
7046: foreach my $role_id (keys(%{$content{'roles'}})) {
7047: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7048: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7049: my @status = @{$content{'roles'}{$role_id}{'access'}};
7050: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7051: foreach my $role (keys(%{$allroles{$cid}})) {
7052: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7053: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7054: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7055: if (grep/^all$/,@sections) {
7056: return 'ok';
7057: } else {
7058: if (grep/^$sec$/,@sections) {
7059: return 'ok';
7060: }
7061: }
7062: }
7063: }
7064: if (keys(%{$allgroups{$cid}}) == 0) {
7065: if (grep/^none$/,@groups) {
7066: return 'ok';
7067: }
7068: } else {
7069: if (grep/^all$/,@groups) {
7070: return 'ok';
7071: }
7072: foreach my $group (keys(%{$allgroups{$cid}})) {
7073: if (grep/^$group$/,@groups) {
7074: return 'ok';
7075: }
7076: }
7077: }
7078: }
7079: }
7080: }
7081: }
7082: }
7083: if ($guest) {
7084: return $guest;
7085: }
7086: }
7087: }
7088: return;
7089: }
7090:
7091: sub course_group_datechecker {
7092: my ($dates,$now,$status) = @_;
7093: my ($start,$end) = split(/\./,$dates);
7094: if (!$start && !$end) {
7095: return 'ok';
7096: }
7097: if (grep/^active$/,@{$status}) {
7098: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7099: return 'ok';
7100: }
7101: }
7102: if (grep/^previous$/,@{$status}) {
7103: if ($end > $now ) {
7104: return 'ok';
7105: }
7106: }
7107: if (grep/^future$/,@{$status}) {
7108: if ($start > $now) {
7109: return 'ok';
7110: }
7111: }
7112: return;
7113: }
7114:
7115: sub parse_portfolio_url {
7116: my ($url) = @_;
7117:
7118: my ($type,$udom,$unum,$group,$file_name);
7119:
1.823 albertel 7120: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 7121: $type = 1;
7122: $udom = $1;
7123: $unum = $2;
7124: $file_name = $3;
1.823 albertel 7125: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 7126: $type = 2;
7127: $udom = $1;
7128: $unum = $2;
7129: $group = $3;
7130: $file_name = $3.'/'.$4;
7131: }
7132: if (wantarray) {
7133: return ($type,$udom,$unum,$file_name,$group);
7134: }
7135: return $type;
7136: }
7137:
7138: sub is_portfolio_url {
7139: my ($url) = @_;
7140: return scalar(&parse_portfolio_url($url));
7141: }
7142:
1.798 raeburn 7143: sub is_portfolio_file {
7144: my ($file) = @_;
1.820 raeburn 7145: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 7146: return 1;
7147: }
7148: return;
7149: }
7150:
1.976 raeburn 7151: sub usertools_access {
1.1084 raeburn 7152: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 7153: my ($access,%tools);
7154: if ($context eq '') {
7155: $context = 'tools';
7156: }
7157: if ($context eq 'requestcourses') {
7158: %tools = (
7159: official => 1,
7160: unofficial => 1,
1.1006 raeburn 7161: community => 1,
1.1246 raeburn 7162: textbook => 1,
1.1305 raeburn 7163: placement => 1,
1.1368 raeburn 7164: lti => 1,
1.985 raeburn 7165: );
1.1183 raeburn 7166: } elsif ($context eq 'requestauthor') {
7167: %tools = (
7168: requestauthor => 1,
7169: );
1.985 raeburn 7170: } else {
7171: %tools = (
7172: aboutme => 1,
7173: blog => 1,
1.1177 raeburn 7174: webdav => 1,
1.985 raeburn 7175: portfolio => 1,
7176: );
7177: }
1.976 raeburn 7178: return if (!defined($tools{$tool}));
7179:
1.1242 raeburn 7180: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 7181: $udom = $env{'user.domain'};
7182: $uname = $env{'user.name'};
7183: }
7184:
1.978 raeburn 7185: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7186: if ($action ne 'reload') {
1.985 raeburn 7187: if ($context eq 'requestcourses') {
7188: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 7189: } elsif ($context eq 'requestauthor') {
7190: return $env{'environment.canrequest.author'};
1.985 raeburn 7191: } else {
7192: return $env{'environment.availabletools.'.$tool};
7193: }
7194: }
1.976 raeburn 7195: }
7196:
1.1183 raeburn 7197: my ($toolstatus,$inststatus,$envkey);
7198: if ($context eq 'requestauthor') {
7199: $envkey = $context;
7200: } else {
7201: $envkey = $context.'.'.$tool;
7202: }
1.976 raeburn 7203:
1.985 raeburn 7204: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
7205: ($action ne 'reload')) {
1.1183 raeburn 7206: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 7207: $inststatus = $env{'environment.inststatus'};
7208: } else {
1.1084 raeburn 7209: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 7210: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 7211: $inststatus = $userenvref->{'inststatus'};
7212: } else {
1.1183 raeburn 7213: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
7214: $toolstatus = $userenv{$envkey};
1.1084 raeburn 7215: $inststatus = $userenv{'inststatus'};
7216: }
1.976 raeburn 7217: }
7218:
7219: if ($toolstatus ne '') {
7220: if ($toolstatus) {
7221: $access = 1;
7222: } else {
7223: $access = 0;
7224: }
7225: return $access;
7226: }
7227:
1.1084 raeburn 7228: my ($is_adv,%domdef);
7229: if (ref($is_advref) eq 'HASH') {
7230: $is_adv = $is_advref->{'is_adv'};
7231: } else {
7232: $is_adv = &is_advanced_user($udom,$uname);
7233: }
7234: if (ref($domdefref) eq 'HASH') {
7235: %domdef = %{$domdefref};
7236: } else {
7237: %domdef = &get_domain_defaults($udom);
7238: }
1.976 raeburn 7239: if (ref($domdef{$tool}) eq 'HASH') {
7240: if ($is_adv) {
7241: if ($domdef{$tool}{'_LC_adv'} ne '') {
7242: if ($domdef{$tool}{'_LC_adv'}) {
7243: $access = 1;
7244: } else {
7245: $access = 0;
7246: }
7247: return $access;
7248: }
7249: }
7250: if ($inststatus ne '') {
7251: my ($hasaccess,$hasnoaccess);
7252: foreach my $affiliation (split(/:/,$inststatus)) {
7253: if ($domdef{$tool}{$affiliation} ne '') {
7254: if ($domdef{$tool}{$affiliation}) {
7255: $hasaccess = 1;
7256: } else {
7257: $hasnoaccess = 1;
7258: }
7259: }
7260: }
7261: if ($hasaccess || $hasnoaccess) {
7262: if ($hasaccess) {
7263: $access = 1;
7264: } elsif ($hasnoaccess) {
7265: $access = 0;
7266: }
7267: return $access;
7268: }
7269: } else {
7270: if ($domdef{$tool}{'default'} ne '') {
7271: if ($domdef{$tool}{'default'}) {
7272: $access = 1;
7273: } elsif ($domdef{$tool}{'default'} == 0) {
7274: $access = 0;
7275: }
7276: return $access;
7277: }
7278: }
7279: } else {
1.1177 raeburn 7280: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 7281: $access = 1;
7282: } else {
7283: $access = 0;
7284: }
1.976 raeburn 7285: return $access;
7286: }
7287: }
7288:
1.1050 raeburn 7289: sub is_course_owner {
7290: my ($cdom,$cnum,$udom,$uname) = @_;
7291: if (($udom eq '') || ($uname eq '')) {
7292: $udom = $env{'user.domain'};
7293: $uname = $env{'user.name'};
7294: }
7295: unless (($udom eq '') || ($uname eq '')) {
7296: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
7297: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
7298: return 1;
7299: } else {
7300: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
7301: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
7302: return 1;
7303: }
7304: }
7305: }
7306: }
7307: return;
7308: }
7309:
1.976 raeburn 7310: sub is_advanced_user {
7311: my ($udom,$uname) = @_;
1.1085 raeburn 7312: if ($udom ne '' && $uname ne '') {
7313: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 7314: if (wantarray) {
7315: return ($env{'user.adv'},$env{'user.author'});
7316: } else {
7317: return $env{'user.adv'};
7318: }
1.1085 raeburn 7319: }
7320: }
1.976 raeburn 7321: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
7322: my %allroles;
1.1128 raeburn 7323: my ($is_adv,$is_author);
1.976 raeburn 7324: foreach my $role (keys(%roleshash)) {
7325: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
7326: my $area = '/'.$tdomain.'/'.$trest;
7327: if ($sec ne '') {
7328: $area .= '/'.$sec;
7329: }
7330: if (($area ne '') && ($trole ne '')) {
7331: my $spec=$trole.'.'.$area;
7332: if ($trole =~ /^cr\//) {
7333: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
7334: } elsif ($trole ne 'gr') {
7335: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
7336: }
1.1128 raeburn 7337: if ($trole eq 'au') {
7338: $is_author = 1;
7339: }
1.976 raeburn 7340: }
7341: }
7342: foreach my $role (keys(%allroles)) {
7343: last if ($is_adv);
7344: foreach my $item (split(/:/,$allroles{$role})) {
7345: if ($item ne '') {
7346: my ($privilege,$restrictions)=split(/&/,$item);
7347: if ($privilege eq 'adv') {
7348: $is_adv = 1;
7349: last;
7350: }
7351: }
7352: }
7353: }
1.1128 raeburn 7354: if (wantarray) {
7355: return ($is_adv,$is_author);
7356: }
1.976 raeburn 7357: return $is_adv;
7358: }
1.798 raeburn 7359:
1.1035 raeburn 7360: sub check_can_request {
1.1368 raeburn 7361: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
1.1035 raeburn 7362: my $canreq = 0;
1.1368 raeburn 7363: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
7364: $uname = $env{'user.name'};
7365: $udom = $env{'user.domain'};
7366: }
1.1035 raeburn 7367: my ($types,$typename) = &Apache::loncommon::course_types();
7368: my @options = ('approval','validate','autolimit');
7369: my $optregex = join('|',@options);
7370: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
7371: foreach my $type (@{$types}) {
1.1368 raeburn 7372: if (&usertools_access($uname,$udom,$type,undef,
7373: 'requestcourses')) {
1.1035 raeburn 7374: $canreq ++;
1.1036 raeburn 7375: if (ref($request_domains) eq 'HASH') {
1.1368 raeburn 7376: push(@{$request_domains->{$type}},$udom);
1.1036 raeburn 7377: }
1.1368 raeburn 7378: if ($dom eq $udom) {
1.1035 raeburn 7379: $can_request->{$type} = 1;
7380: }
7381: }
1.1368 raeburn 7382: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
7383: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
1.1035 raeburn 7384: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
7385: if (@curr > 0) {
1.1036 raeburn 7386: foreach my $item (@curr) {
7387: if (ref($request_domains) eq 'HASH') {
7388: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
7389: if ($otherdom ne '') {
7390: if (ref($request_domains->{$type}) eq 'ARRAY') {
7391: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
7392: push(@{$request_domains->{$type}},$otherdom);
7393: }
7394: } else {
7395: push(@{$request_domains->{$type}},$otherdom);
7396: }
7397: }
7398: }
7399: }
1.1368 raeburn 7400: unless ($dom eq $env{'user.domain'}) {
1.1036 raeburn 7401: $canreq ++;
1.1035 raeburn 7402: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
7403: $can_request->{$type} = 1;
7404: }
7405: }
7406: }
7407: }
7408: }
7409: }
7410: return $canreq;
7411: }
7412:
1.341 www 7413: # ---------------------------------------------- Custom access rule evaluation
7414:
7415: sub customaccess {
7416: my ($priv,$uri)=@_;
1.807 albertel 7417: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 7418: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 7419: $udom = &LONCAPA::clean_domain($udom);
7420: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 7421: my $access=0;
1.800 albertel 7422: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 7423: my ($effect,$realm,$role,$type)=split(/\:/,$right);
7424: if ($type eq 'user') {
7425: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 7426: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 7427: if ($tdom) {
7428: if ($tdom ne $env{'user.domain'}) { next; }
7429: }
1.896 albertel 7430: if ($tuname) {
7431: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 7432: }
7433: $access=($effect eq 'allow');
7434: last;
7435: }
7436: } else {
7437: if ($role) {
7438: if ($role ne $urole) { next; }
7439: }
7440: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7441: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
7442: if ($tdom) {
7443: if ($tdom ne $udom) { next; }
7444: }
7445: if ($tcrs) {
7446: if ($tcrs ne $ucrs) { next; }
7447: }
7448: if ($tsec) {
7449: if ($tsec ne $usec) { next; }
7450: }
7451: $access=($effect eq 'allow');
7452: last;
7453: }
7454: if ($realm eq '' && $role eq '') {
7455: $access=($effect eq 'allow');
7456: }
1.402 bowersj2 7457: }
1.341 www 7458: }
7459: return $access;
7460: }
7461:
1.103 harris41 7462: # ------------------------------------------------- Check for a user privilege
1.12 www 7463:
7464: sub allowed {
1.1281 raeburn 7465: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
1.705 albertel 7466: my $ver_orguri=$uri;
1.439 www 7467: $uri=&deversion($uri);
1.152 www 7468: my $orguri=$uri;
1.52 www 7469: $uri=&declutter($uri);
1.809 raeburn 7470:
1.810 raeburn 7471: if ($priv eq 'evb') {
7472: # Evade communication block restrictions for specified role in a course
7473: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
7474: return $1;
7475: } else {
7476: return;
7477: }
7478: }
7479:
1.620 albertel 7480: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 7481: # Free bre access to adm and meta resources
1.1343 raeburn 7482: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|ext\.tool)$}))
1.769 albertel 7483: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
7484: && ($priv eq 'bre')) {
1.14 www 7485: return 'F';
1.159 www 7486: }
7487:
1.545 banghart 7488: # Free bre access to user's own portfolio contents
1.714 raeburn 7489: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 7490: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 7491: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 7492: my %setters;
7493: my ($startblock,$endblock) =
7494: &Apache::loncommon::blockcheck(\%setters,'port');
7495: if ($startblock && $endblock) {
7496: return 'B';
7497: } else {
7498: return 'F';
7499: }
1.545 banghart 7500: }
7501:
1.762 raeburn 7502: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 7503: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
7504: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
7505: if (exists($env{'request.course.id'})) {
7506: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7507: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7508: if (($domain eq $cdom) && ($name eq $cnum)) {
7509: my $courseprivid=$env{'request.course.id'};
7510: $courseprivid=~s/\_/\//;
7511: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
7512: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
7513: return $1;
1.762 raeburn 7514: } else {
7515: if ($env{'request.course.sec'}) {
7516: $courseprivid.='/'.$env{'request.course.sec'};
7517: }
7518: if ($env{'user.priv.'.$env{'request.role'}.'./'.
7519: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
7520: return $2;
7521: }
1.714 raeburn 7522: }
7523: }
7524: }
7525: }
7526:
1.159 www 7527: # Free bre to public access
7528:
7529: if ($priv eq 'bre') {
1.1362 raeburn 7530: my $copyright;
7531: unless ($uri =~ /ext\.tool/) {
7532: $copyright=&metadata($uri,'copyright');
7533: }
1.620 albertel 7534: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 7535: return 'F';
7536: }
1.238 www 7537: if ($copyright eq 'priv') {
7538: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7539: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 7540: return '';
7541: }
7542: }
7543: if ($copyright eq 'domain') {
7544: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7545: unless (($env{'user.domain'} eq $1) ||
7546: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 7547: return '';
7548: }
1.262 matthew 7549: }
1.620 albertel 7550: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 7551: # Library role, so allow browsing of resources in this domain.
7552: return 'F';
1.238 www 7553: }
1.341 www 7554: if ($copyright eq 'custom') {
7555: unless (&customaccess($priv,$uri)) { return ''; }
7556: }
1.14 www 7557: }
1.264 matthew 7558: # Domain coordinator is trying to create a course
1.620 albertel 7559: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 7560: # uri is the requested domain in this case.
7561: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 7562: # a role of dc for the domain in question.
1.620 albertel 7563: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 7564: }
1.29 www 7565:
1.52 www 7566: my $thisallowed='';
7567: my $statecond=0;
7568: my $courseprivid='';
7569:
1.1039 raeburn 7570: my $ownaccess;
1.1043 raeburn 7571: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 7572: if (($priv eq 'bro') && ($env{'user.author'})) {
7573: if ($uri eq '') {
7574: $ownaccess = 1;
7575: } else {
7576: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7577: my $udom = $env{'user.domain'};
7578: my $uname = $env{'user.name'};
7579: if ($uri =~ m{^\Q$udom\E/?$}) {
7580: $ownaccess = 1;
1.1040 raeburn 7581: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 7582: unless ($uri =~ m{\.\./}) {
7583: $ownaccess = 1;
7584: }
7585: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7586: my $now = time;
7587: if ($uri =~ m{^([^/]+)/?$}) {
7588: my $adom = $1;
7589: foreach my $key (keys(%env)) {
1.1042 raeburn 7590: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 7591: my ($start,$end) = split('.',$env{$key});
7592: if (($now >= $start) && (!$end || $end < $now)) {
7593: $ownaccess = 1;
7594: last;
7595: }
7596: }
7597: }
7598: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7599: my $adom = $1;
7600: my $aname = $2;
1.1042 raeburn 7601: foreach my $role ('ca','aa') {
7602: if ($env{"user.role.$role./$adom/$aname"}) {
7603: my ($start,$end) =
7604: split('.',$env{"user.role.$role./$adom/$aname"});
7605: if (($now >= $start) && (!$end || $end < $now)) {
7606: $ownaccess = 1;
7607: last;
7608: }
1.1039 raeburn 7609: }
7610: }
7611: }
7612: }
7613: }
7614: }
7615: }
7616:
1.52 www 7617: # Course
7618:
1.620 albertel 7619: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7620: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7621: $thisallowed.=$1;
7622: }
1.52 www 7623: }
1.29 www 7624:
1.52 www 7625: # Domain
7626:
1.620 albertel 7627: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 7628: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7629: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7630: $thisallowed.=$1;
7631: }
1.12 www 7632: }
1.52 www 7633:
1.1141 raeburn 7634: # User who is not author or co-author might still be able to edit
7635: # resource of an author in the domain (e.g., if Domain Coordinator).
7636: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7637: (&allowed('mdc',$env{'request.course.id'}))) {
7638: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7639: $thisallowed.=$1;
7640: }
7641: }
7642:
1.52 www 7643: # Course: uri itself is a course
1.66 www 7644: my $courseuri=$uri;
7645: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 7646: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 7647:
1.620 albertel 7648: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 7649: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7650: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7651: $thisallowed.=$1;
7652: }
1.12 www 7653: }
1.29 www 7654:
1.665 albertel 7655: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 7656: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 7657: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 7658: $thisallowed='';
1.671 raeburn 7659: my ($match)=&is_on_map($uri);
7660: if ($match) {
7661: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7662: =~/\Q$priv\E\&([^\:]*)/) {
1.1281 raeburn 7663: my $value = $1;
7664: if ($noblockcheck) {
7665: $thisallowed.=$value;
1.1162 raeburn 7666: } else {
1.1281 raeburn 7667: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7668: if (@blockers > 0) {
7669: $thisallowed = 'B';
7670: } else {
7671: $thisallowed.=$value;
7672: }
1.1162 raeburn 7673: }
1.671 raeburn 7674: }
7675: } else {
1.705 albertel 7676: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 7677: if ($refuri) {
7678: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 7679: $thisallowed='F';
1.671 raeburn 7680: } else {
7681: $refuri=&declutter($refuri);
7682: my ($match) = &is_on_map($refuri);
7683: if ($match) {
1.1281 raeburn 7684: if ($noblockcheck) {
7685: $thisallowed='F';
1.1162 raeburn 7686: } else {
1.1281 raeburn 7687: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7688: if (@blockers > 0) {
7689: $thisallowed = 'B';
7690: } else {
7691: $thisallowed='F';
7692: }
1.1162 raeburn 7693: }
1.671 raeburn 7694: }
1.669 raeburn 7695: }
1.671 raeburn 7696: }
7697: }
1.314 www 7698: }
1.492 albertel 7699:
1.766 albertel 7700: if ($priv eq 'bre'
7701: && $thisallowed ne 'F'
7702: && $thisallowed ne '2'
7703: && &is_portfolio_url($uri)) {
1.1270 raeburn 7704: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 7705: }
1.1250 raeburn 7706:
1.52 www 7707: # Full access at system, domain or course-wide level? Exit.
1.29 www 7708: if ($thisallowed=~/F/) {
7709: return 'F';
7710: }
7711:
1.52 www 7712: # If this is generating or modifying users, exit with special codes
1.29 www 7713:
1.643 www 7714: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7715: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 7716: my ($audom,$auname)=split('/',$uri);
1.643 www 7717: # no author name given, so this just checks on the general right to make a co-author in this domain
7718: unless ($auname) { return $thisallowed; }
7719: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 7720: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7721: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7722: ($audom ne $env{'request.role.domain'}))) { return ''; }
7723: }
1.52 www 7724: return $thisallowed;
7725: }
7726: #
1.103 harris41 7727: # Gathered so far: system, domain and course wide privileges
1.52 www 7728: #
7729: # Course: See if uri or referer is an individual resource that is part of
7730: # the course
7731:
1.620 albertel 7732: if ($env{'request.course.id'}) {
1.232 www 7733:
1.620 albertel 7734: $courseprivid=$env{'request.course.id'};
7735: if ($env{'request.course.sec'}) {
7736: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 7737: }
7738: $courseprivid=~s/\_/\//;
7739: my $checkreferer=1;
1.232 www 7740: my ($match,$cond)=&is_on_map($uri);
7741: if ($match) {
7742: $statecond=$cond;
1.620 albertel 7743: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7744: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7745: my $value = $1;
7746: if ($priv eq 'bre') {
1.1281 raeburn 7747: if ($noblockcheck) {
7748: $thisallowed.=$value;
1.1162 raeburn 7749: } else {
1.1281 raeburn 7750: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7751: if (@blockers > 0) {
7752: $thisallowed = 'B';
7753: } else {
7754: $thisallowed.=$value;
7755: }
1.1162 raeburn 7756: }
7757: } else {
7758: $thisallowed.=$value;
7759: }
1.52 www 7760: $checkreferer=0;
7761: }
1.29 www 7762: }
1.83 www 7763:
1.148 www 7764: if ($checkreferer) {
1.620 albertel 7765: my $refuri=$env{'httpref.'.$orguri};
1.148 www 7766: unless ($refuri) {
1.800 albertel 7767: foreach my $key (keys(%env)) {
7768: if ($key=~/^httpref\..*\*/) {
7769: my $pattern=$key;
1.156 www 7770: $pattern=~s/^httpref\.\/res\///;
1.148 www 7771: $pattern=~s/\*/\[\^\/\]\+/g;
7772: $pattern=~s/\//\\\//g;
1.152 www 7773: if ($orguri=~/$pattern/) {
1.800 albertel 7774: $refuri=$env{$key};
1.148 www 7775: }
7776: }
1.191 harris41 7777: }
1.148 www 7778: }
1.232 www 7779:
1.148 www 7780: if ($refuri) {
1.152 www 7781: $refuri=&declutter($refuri);
1.232 www 7782: my ($match,$cond)=&is_on_map($refuri);
7783: if ($match) {
7784: my $refstatecond=$cond;
1.620 albertel 7785: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7786: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7787: my $value = $1;
7788: if ($priv eq 'bre') {
1.1281 raeburn 7789: if ($noblockcheck) {
7790: $thisallowed.=$value;
1.1162 raeburn 7791: } else {
1.1281 raeburn 7792: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7793: if (@blockers > 0) {
7794: $thisallowed = 'B';
7795: } else {
7796: $thisallowed.=$value;
7797: }
1.1162 raeburn 7798: }
7799: } else {
7800: $thisallowed.=$value;
7801: }
1.53 www 7802: $uri=$refuri;
7803: $statecond=$refstatecond;
1.52 www 7804: }
7805: }
1.148 www 7806: }
1.29 www 7807: }
1.52 www 7808: }
1.29 www 7809:
1.52 www 7810: #
1.103 harris41 7811: # Gathered now: all privileges that could apply, and condition number
1.52 www 7812: #
7813: #
7814: # Full or no access?
7815: #
1.29 www 7816:
1.52 www 7817: if ($thisallowed=~/F/) {
7818: return 'F';
7819: }
1.29 www 7820:
1.52 www 7821: unless ($thisallowed) {
7822: return '';
7823: }
1.29 www 7824:
1.52 www 7825: # Restrictions exist, deal with them
7826: #
7827: # C:according to course preferences
7828: # R:according to resource settings
7829: # L:unless locked
7830: # X:according to user session state
7831: #
7832:
7833: # Possibly locked functionality, check all courses
1.54 www 7834: # Locks might take effect only after 10 minutes cache expiration for other
7835: # courses, and 2 minutes for current course
1.52 www 7836:
7837: my $envkey;
7838: if ($thisallowed=~/L/) {
1.1000 raeburn 7839: foreach $envkey (keys(%env)) {
1.54 www 7840: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7841: my $courseid=$2;
7842: my $roleid=$1.'.'.$2;
1.92 www 7843: $courseid=~s/^\///;
1.54 www 7844: my $expiretime=600;
1.620 albertel 7845: if ($env{'request.role'} eq $roleid) {
1.54 www 7846: $expiretime=120;
7847: }
7848: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7849: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 7850: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 7851: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 7852: }
1.620 albertel 7853: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7854: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7855: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7856: &log($env{'user.domain'},$env{'user.name'},
7857: $env{'user.home'},
1.57 www 7858: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 7859: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7860: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7861: return '';
7862: }
7863: }
1.620 albertel 7864: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7865: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7866: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7867: &log($env{'user.domain'},$env{'user.name'},
7868: $env{'user.home'},
1.57 www 7869: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 7870: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7871: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7872: return '';
7873: }
7874: }
7875: }
1.29 www 7876: }
1.52 www 7877: }
7878:
7879: #
7880: # Rest of the restrictions depend on selected course
7881: #
7882:
1.620 albertel 7883: unless ($env{'request.course.id'}) {
1.766 albertel 7884: if ($thisallowed eq 'A') {
7885: return 'A';
1.814 raeburn 7886: } elsif ($thisallowed eq 'B') {
7887: return 'B';
1.766 albertel 7888: } else {
7889: return '1';
7890: }
1.52 www 7891: }
1.29 www 7892:
1.52 www 7893: #
7894: # Now user is definitely in a course
7895: #
1.53 www 7896:
7897:
7898: # Course preferences
7899:
7900: if ($thisallowed=~/C/) {
1.620 albertel 7901: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7902: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7903: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 7904: =~/\Q$rolecode\E/) {
1.1304 raeburn 7905: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 7906: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7907: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7908: $env{'request.course.id'});
7909: }
1.237 www 7910: return '';
7911: }
7912:
1.620 albertel 7913: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 7914: =~/\Q$unamedom\E/) {
1.1304 raeburn 7915: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 7916: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7917: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7918: $env{'request.course.id'});
7919: }
1.54 www 7920: return '';
7921: }
1.53 www 7922: }
7923:
7924: # Resource preferences
7925:
7926: if ($thisallowed=~/R/) {
1.620 albertel 7927: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 7928: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 7929: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7930: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7931: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7932: }
7933: return '';
1.54 www 7934: }
1.53 www 7935: }
1.30 www 7936:
1.246 www 7937: # Restricted by state or randomout?
1.30 www 7938:
1.52 www 7939: if ($thisallowed=~/X/) {
1.620 albertel 7940: if ($env{'acc.randomout'}) {
1.579 albertel 7941: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 7942: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 7943: return '';
7944: }
1.247 www 7945: }
7946: if (&condval($statecond)) {
1.52 www 7947: return '2';
7948: } else {
7949: return '';
7950: }
7951: }
1.30 www 7952:
1.766 albertel 7953: if ($thisallowed eq 'A') {
7954: return 'A';
1.814 raeburn 7955: } elsif ($thisallowed eq 'B') {
7956: return 'B';
1.766 albertel 7957: }
1.52 www 7958: return 'F';
1.232 www 7959: }
1.1162 raeburn 7960:
1.1192 raeburn 7961: # ------------------------------------------- Check construction space access
7962:
7963: sub constructaccess {
7964: my ($url,$setpriv)=@_;
7965:
7966: # We do not allow editing of previous versions of files
7967: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7968:
7969: # Get username and domain from URL
7970: my ($ownername,$ownerdomain,$ownerhome);
7971:
7972: ($ownerdomain,$ownername) =
1.1325 raeburn 7973: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
1.1192 raeburn 7974:
7975: # The URL does not really point to any authorspace, forget it
7976: unless (($ownername) && ($ownerdomain)) { return ''; }
7977:
7978: # Now we need to see if the user has access to the authorspace of
7979: # $ownername at $ownerdomain
7980:
7981: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7982: # Real author for this?
7983: $ownerhome = $env{'user.home'};
7984: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7985: return ($ownername,$ownerdomain,$ownerhome);
7986: }
7987: } else {
7988: # Co-author for this?
7989: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7990: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7991: $ownerhome = &homeserver($ownername,$ownerdomain);
7992: return ($ownername,$ownerdomain,$ownerhome);
7993: }
1.1312 raeburn 7994: if ($env{'request.course.id'}) {
7995: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
7996: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
7997: if (&allowed('mdc',$env{'request.course.id'})) {
7998: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
7999: return ($ownername,$ownerdomain,$ownerhome);
8000: }
8001: }
8002: }
1.1192 raeburn 8003: }
8004:
8005: # We don't have any access right now. If we are not possibly going to do anything about this,
8006: # we might as well leave
8007: unless ($setpriv) { return ''; }
8008:
8009: # Backdoor access?
8010: my $allowed=&allowed('eco',$ownerdomain);
8011: # Nope
8012: unless ($allowed) { return ''; }
8013: # Looks like we may have access, but could be locked by the owner of the construction space
8014: if ($allowed eq 'U') {
8015: my %blocked=&get('environment',['domcoord.author'],
8016: $ownerdomain,$ownername);
8017: # Is blocked by owner
8018: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
8019: }
8020: if (($allowed eq 'F') || ($allowed eq 'U')) {
8021: # Grant temporary access
8022: my $then=$env{'user.login.time'};
1.1209 raeburn 8023: my $update=$env{'user.update.time'};
1.1192 raeburn 8024: if (!$update) { $update = $then; }
8025: my $refresh=$env{'user.refresh.time'};
8026: if (!$refresh) { $refresh = $update; }
8027: my $now = time;
8028: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
8029: $now,'ca','constructaccess');
8030: $ownerhome = &homeserver($ownername,$ownerdomain);
8031: return($ownername,$ownerdomain,$ownerhome);
8032: }
8033: # No business here
8034: return '';
8035: }
8036:
1.1282 raeburn 8037: # ----------------------------------------------------------- Content Blocking
8038:
8039: {
8040: # Caches for faster Course Contents display where content blocking
8041: # is in operation (i.e., interval param set) for timed quiz.
8042: #
8043: # User for whom data are being temporarily cached.
8044: my $cacheduser='';
8045: # Cached blockers for this user (a hash of blocking items).
8046: my %cachedblockers=();
8047: # When the data were last cached.
8048: my $cachedlast='';
8049:
8050: sub load_all_blockers {
8051: my ($uname,$udom,$blocks)=@_;
8052: if (($uname ne '') && ($udom ne '')) {
8053: if (($cacheduser eq $uname.':'.$udom) &&
8054: (abs($cachedlast-time)<5)) {
8055: return;
8056: }
8057: }
8058: $cachedlast=time;
8059: $cacheduser=$uname.':'.$udom;
8060: %cachedblockers = &get_commblock_resources($blocks);
8061: }
8062:
1.1162 raeburn 8063: sub get_comm_blocks {
8064: my ($cdom,$cnum) = @_;
8065: if ($cdom eq '' || $cnum eq '') {
8066: return unless ($env{'request.course.id'});
8067: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8068: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8069: }
8070: my %commblocks;
8071: my $hashid=$cdom.'_'.$cnum;
8072: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
8073: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
8074: %commblocks = %{$blocksref};
8075: } else {
8076: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
8077: my $cachetime = 600;
8078: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
8079: }
8080: return %commblocks;
8081: }
8082:
1.1282 raeburn 8083: sub get_commblock_resources {
8084: my ($blocks) = @_;
8085: my %blockers = ();
8086: return %blockers unless ($env{'request.course.id'});
8087: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
1.1162 raeburn 8088: my %commblocks;
8089: if (ref($blocks) eq 'HASH') {
8090: %commblocks = %{$blocks};
8091: } else {
8092: %commblocks = &get_comm_blocks();
8093: }
1.1282 raeburn 8094: return %blockers unless (keys(%commblocks) > 0);
8095: my $navmap = Apache::lonnavmaps::navmap->new();
8096: return %blockers unless (ref($navmap));
1.1162 raeburn 8097: my $now = time;
8098: foreach my $block (keys(%commblocks)) {
8099: if ($block =~ /^(\d+)____(\d+)$/) {
8100: my ($start,$end) = ($1,$2);
8101: if ($start <= $now && $end >= $now) {
8102: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8103: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8104: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282 raeburn 8105: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8106: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 8107: }
8108: }
8109: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282 raeburn 8110: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8111: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 8112: }
8113: }
8114: }
8115: }
8116: }
8117: } elsif ($block =~ /^firstaccess____(.+)$/) {
8118: my $item = $1;
1.1163 raeburn 8119: my @to_test;
1.1162 raeburn 8120: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8121: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1282 raeburn 8122: my @interval;
8123: my $type = 'map';
8124: if ($item eq 'course') {
8125: $type = 'course';
8126: @interval=&EXT("resource.0.interval");
8127: } else {
8128: if ($item =~ /___\d+___/) {
8129: $type = 'resource';
8130: @interval=&EXT("resource.0.interval",$item);
8131: if (ref($navmap)) {
8132: my $res = $navmap->getBySymb($item);
8133: push(@to_test,$res);
8134: }
1.1162 raeburn 8135: } else {
1.1282 raeburn 8136: my $mapsymb = &symbread($item,1);
8137: if ($mapsymb) {
8138: if (ref($navmap)) {
8139: my $mapres = $navmap->getBySymb($mapsymb);
8140: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
8141: foreach my $res (@to_test) {
8142: my $symb = $res->symb();
8143: next if ($symb eq $mapsymb);
8144: if ($symb ne '') {
8145: @interval=&EXT("resource.0.interval",$symb);
8146: if ($interval[1] eq 'map') {
8147: last;
1.1162 raeburn 8148: }
8149: }
8150: }
8151: }
8152: }
8153: }
1.1282 raeburn 8154: }
1.1310 raeburn 8155: if ($interval[0] =~ /^(\d+)/) {
1.1308 raeburn 8156: my $timelimit = $1;
1.1282 raeburn 8157: my $first_access;
8158: if ($type eq 'resource') {
8159: $first_access=&get_first_access($interval[1],$item);
8160: } elsif ($type eq 'map') {
8161: $first_access=&get_first_access($interval[1],undef,$item);
8162: } else {
8163: $first_access=&get_first_access($interval[1]);
8164: }
8165: if ($first_access) {
1.1292 raeburn 8166: my $timesup = $first_access+$timelimit;
1.1282 raeburn 8167: if ($timesup > $now) {
8168: my $activeblock;
8169: foreach my $res (@to_test) {
1.1283 raeburn 8170: if ($res->answerable()) {
1.1282 raeburn 8171: $activeblock = 1;
8172: last;
8173: }
8174: }
8175: if ($activeblock) {
8176: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8177: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8178: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8179: }
8180: }
8181: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8182: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8183: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 8184: }
1.1162 raeburn 8185: }
8186: }
8187: }
8188: }
8189: }
8190: }
8191: }
8192: }
8193: }
1.1282 raeburn 8194: return %blockers;
1.1162 raeburn 8195: }
8196:
1.1282 raeburn 8197: sub has_comm_blocking {
8198: my ($priv,$symb,$uri,$blocks) = @_;
8199: my @blockers;
8200: return unless ($env{'request.course.id'});
8201: return unless ($priv eq 'bre');
8202: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
8203: return if ($env{'request.state'} eq 'construct');
8204: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
8205: return unless (keys(%cachedblockers) > 0);
8206: my (%possibles,@symbs);
8207: if (!$symb) {
8208: $symb = &symbread($uri,1,1,1,\%possibles);
1.1162 raeburn 8209: }
1.1282 raeburn 8210: if ($symb) {
8211: @symbs = ($symb);
8212: } elsif (keys(%possibles)) {
8213: @symbs = keys(%possibles);
8214: }
8215: my $noblock;
8216: foreach my $symb (@symbs) {
8217: last if ($noblock);
8218: my ($map,$resid,$resurl)=&decode_symb($symb);
8219: foreach my $block (keys(%cachedblockers)) {
8220: if ($block =~ /^firstaccess____(.+)$/) {
8221: my $item = $1;
8222: if (($item eq $map) || ($item eq $symb)) {
8223: $noblock = 1;
8224: last;
8225: }
8226: }
8227: if (ref($cachedblockers{$block}) eq 'HASH') {
8228: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
8229: if ($cachedblockers{$block}{'resources'}{$symb}) {
8230: unless (grep(/^\Q$block\E$/,@blockers)) {
8231: push(@blockers,$block);
8232: }
8233: }
8234: }
1.1162 raeburn 8235: }
1.1282 raeburn 8236: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
8237: if ($cachedblockers{$block}{'maps'}{$map}) {
8238: unless (grep(/^\Q$block\E$/,@blockers)) {
8239: push(@blockers,$block);
8240: }
8241: }
1.1162 raeburn 8242: }
8243: }
8244: }
1.1282 raeburn 8245: return if ($noblock);
8246: return @blockers;
8247: }
1.1162 raeburn 8248: }
8249:
1.1282 raeburn 8250: # -------------------------------- Deversion and split uri into path an filename
8251:
1.1133 foxr 8252: #
1.1282 raeburn 8253: # Removes the version from a URI and
1.1133 foxr 8254: # splits it in to its filename and path to the filename.
8255: # Seems like File::Basename could have done this more clearly.
8256: # Parameters:
8257: # $uri - input URI
8258: # Returns:
8259: # Two element list consisting of
8260: # $pathname - the URI up to and excluding the trailing /
8261: # $filename - The part of the URI following the last /
8262: # NOTE:
8263: # Another realization of this is simply:
8264: # use File::Basename;
8265: # ...
8266: # $uri = shift;
8267: # $filename = basename($uri);
8268: # $path = dirname($uri);
8269: # return ($filename, $path);
8270: #
8271: # The implementation below is probably faster however.
8272: #
1.710 albertel 8273: sub split_uri_for_cond {
8274: my $uri=&deversion(&declutter(shift));
8275: my @uriparts=split(/\//,$uri);
8276: my $filename=pop(@uriparts);
8277: my $pathname=join('/',@uriparts);
8278: return ($pathname,$filename);
8279: }
1.232 www 8280: # --------------------------------------------------- Is a resource on the map?
8281:
8282: sub is_on_map {
1.710 albertel 8283: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 8284: #Trying to find the conditional for the file
1.620 albertel 8285: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 8286: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 8287: if ($match) {
1.289 bowersj2 8288: return (1,$1);
8289: } else {
1.434 www 8290: return (0,0);
1.289 bowersj2 8291: }
1.12 www 8292: }
8293:
1.427 www 8294: # --------------------------------------------------------- Get symb from alias
8295:
8296: sub get_symb_from_alias {
8297: my $symb=shift;
8298: my ($map,$resid,$url)=&decode_symb($symb);
8299: # Already is a symb
8300: if ($url) { return $symb; }
8301: # Must be an alias
8302: my $aliassymb='';
8303: my %bighash;
1.620 albertel 8304: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 8305: &GDBM_READER(),0640)) {
8306: my $rid=$bighash{'mapalias_'.$symb};
8307: if ($rid) {
8308: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 8309: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
8310: $resid,$bighash{'src_'.$rid});
1.427 www 8311: }
8312: untie %bighash;
8313: }
8314: return $aliassymb;
8315: }
8316:
1.12 www 8317: # ----------------------------------------------------------------- Define Role
8318:
8319: sub definerole {
8320: if (allowed('mcr','/')) {
1.1326 raeburn 8321: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 8322: foreach my $role (split(':',$sysrole)) {
8323: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 8324: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
8325: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
8326: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 8327: return "refused:s:$crole&$cqual";
8328: }
8329: }
1.191 harris41 8330: }
1.800 albertel 8331: foreach my $role (split(':',$domrole)) {
8332: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 8333: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
8334: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
8335: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 8336: return "refused:d:$crole&$cqual";
8337: }
8338: }
1.191 harris41 8339: }
1.800 albertel 8340: foreach my $role (split(':',$courole)) {
8341: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 8342: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
8343: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
8344: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 8345: return "refused:c:$crole&$cqual";
8346: }
8347: }
1.191 harris41 8348: }
1.1326 raeburn 8349: my $uhome;
8350: if (($uname ne '') && ($udom ne '')) {
8351: $uhome = &homeserver($uname,$udom);
8352: return $uhome if ($uhome eq 'no_host');
8353: } else {
8354: $uname = $env{'user.name'};
8355: $udom = $env{'user.domain'};
8356: $uhome = $env{'user.home'};
8357: }
1.620 albertel 8358: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1326 raeburn 8359: "$udom:$uname:rolesdef_$rolename=".
1.21 www 8360: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1326 raeburn 8361: return reply($command,$uhome);
1.12 www 8362: } else {
8363: return 'refused';
8364: }
1.105 harris41 8365: }
8366:
8367: # ---------------- Make a metadata query against the network of library servers
8368:
8369: sub metadata_query {
1.1237 raeburn 8370: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 8371: my %rhash;
1.845 albertel 8372: my %libserv = &all_library();
1.244 matthew 8373: my @server_list = (defined($server_array) ? @$server_array
8374: : keys(%libserv) );
8375: for my $server (@server_list) {
1.1237 raeburn 8376: my $domains = '';
8377: if (ref($domains_hash) eq 'HASH') {
8378: $domains = $domains_hash->{$server};
8379: }
1.118 harris41 8380: unless ($custom or $customshow) {
1.1237 raeburn 8381: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 8382: $rhash{$server}=$reply;
8383: }
8384: else {
8385: my $reply=&reply("querysend:".&escape($query).':'.
1.1237 raeburn 8386: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 8387: $server);
8388: $rhash{$server}=$reply;
8389: }
1.112 harris41 8390: }
1.118 harris41 8391: return \%rhash;
1.240 www 8392: }
8393:
8394: # ----------------------------------------- Send log queries and wait for reply
8395:
8396: sub log_query {
8397: my ($uname,$udom,$query,%filters)=@_;
8398: my $uhome=&homeserver($uname,$udom);
8399: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 8400: my $uhost=&hostname($uhome);
1.800 albertel 8401: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 8402: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
8403: $uhome);
1.479 albertel 8404: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 8405: return get_query_reply($queryid);
8406: }
8407:
1.818 raeburn 8408: # -------------------------- Update MySQL table for portfolio file
8409:
8410: sub update_portfolio_table {
1.821 raeburn 8411: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 8412: if ($group ne '') {
8413: $file_name =~s /^\Q$group\E//;
8414: }
1.818 raeburn 8415: my $homeserver = &homeserver($uname,$udom);
8416: my $queryid=
1.821 raeburn 8417: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
8418: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 8419: my $reply = &get_query_reply($queryid);
8420: return $reply;
8421: }
8422:
1.899 raeburn 8423: # -------------------------- Update MySQL allusers table
8424:
8425: sub update_allusers_table {
8426: my ($uname,$udom,$names) = @_;
8427: my $homeserver = &homeserver($uname,$udom);
8428: my $queryid=
8429: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
8430: 'lastname='.&escape($names->{'lastname'}).'%%'.
8431: 'firstname='.&escape($names->{'firstname'}).'%%'.
8432: 'middlename='.&escape($names->{'middlename'}).'%%'.
8433: 'generation='.&escape($names->{'generation'}).'%%'.
8434: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
8435: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 8436: return;
1.899 raeburn 8437: }
8438:
1.508 raeburn 8439: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 8440:
8441: sub fetch_enrollment_query {
1.511 raeburn 8442: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1317 raeburn 8443: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 8444: my $maxtries = 1;
1.508 raeburn 8445: if ($context eq 'automated') {
8446: $homeserver = $perlvar{'lonHostID'};
1.1317 raeburn 8447: $sleep = 2;
8448: $loopmax = 100;
1.547 raeburn 8449: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 8450: } else {
8451: $homeserver = &homeserver($cnum,$dom);
8452: }
1.838 albertel 8453: my $host=&hostname($homeserver);
1.506 raeburn 8454: my $cmd = '';
1.1000 raeburn 8455: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 8456: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 8457: }
8458: $cmd =~ s/%%$//;
8459: $cmd = &escape($cmd);
8460: my $query = 'fetchenrollment';
1.620 albertel 8461: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 8462: unless ($queryid=~/^\Q$host\E\_/) {
8463: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
8464: return 'error: '.$queryid;
8465: }
1.1317 raeburn 8466: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 8467: my $tries = 1;
8468: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1317 raeburn 8469: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 8470: $tries ++;
8471: }
1.526 raeburn 8472: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 8473: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 8474: } else {
1.901 albertel 8475: my @responses = split(/:/,$reply);
1.1322 raeburn 8476: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 8477: foreach my $line (@responses) {
8478: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 8479: $$replyref{$key} = $value;
8480: }
8481: } else {
1.1117 foxr 8482: my $pathname = LONCAPA::tempdir();
1.800 albertel 8483: foreach my $line (@responses) {
8484: my ($key,$value) = split(/=/,$line);
1.506 raeburn 8485: $$replyref{$key} = $value;
8486: if ($value > 0) {
1.800 albertel 8487: foreach my $item (@{$$affiliatesref{$key}}) {
8488: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 8489: my $destname = $pathname.'/'.$filename;
8490: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 8491: if ($xml_classlist =~ /^error/) {
8492: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
8493: } else {
1.1359 raeburn 8494: if ( open(FILE,">",$destname) ) {
1.506 raeburn 8495: print FILE &unescape($xml_classlist);
8496: close(FILE);
1.526 raeburn 8497: } else {
8498: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 8499: }
8500: }
8501: }
8502: }
8503: }
8504: }
8505: return 'ok';
8506: }
8507: return 'error';
8508: }
8509:
1.242 www 8510: sub get_query_reply {
1.1317 raeburn 8511: my ($queryid,$sleep,$loopmax) = @_;;
8512: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
8513: $sleep = 0.2;
8514: }
8515: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
8516: $loopmax = 100;
8517: }
1.1117 foxr 8518: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 8519: my $reply='';
1.1317 raeburn 8520: for (1..$loopmax) {
8521: sleep($sleep);
1.240 www 8522: if (-e $replyfile.'.end') {
1.1359 raeburn 8523: if (open(my $fh,"<",$replyfile)) {
1.904 albertel 8524: $reply = join('',<$fh>);
8525: close($fh);
1.240 www 8526: } else { return 'error: reply_file_error'; }
1.242 www 8527: return &unescape($reply);
8528: }
1.240 www 8529: }
1.242 www 8530: return 'timeout:'.$queryid;
1.240 www 8531: }
8532:
8533: sub courselog_query {
1.241 www 8534: #
8535: # possible filters:
8536: # url: url or symb
8537: # username
8538: # domain
8539: # action: view, submit, grade
8540: # start: timestamp
8541: # end: timestamp
8542: #
1.240 www 8543: my (%filters)=@_;
1.620 albertel 8544: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 8545: if ($filters{'url'}) {
8546: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
8547: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
8548: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
8549: }
1.620 albertel 8550: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
8551: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 8552: return &log_query($cname,$cdom,'courselog',%filters);
8553: }
8554:
8555: sub userlog_query {
1.858 raeburn 8556: #
8557: # possible filters:
8558: # action: log check role
8559: # start: timestamp
8560: # end: timestamp
8561: #
1.240 www 8562: my ($uname,$udom,%filters)=@_;
8563: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 8564: }
8565:
1.506 raeburn 8566: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
8567:
8568: sub auto_run {
1.508 raeburn 8569: my ($cnum,$cdom) = @_;
1.876 raeburn 8570: my $response = 0;
8571: my $settings;
8572: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
8573: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
8574: $settings = $domconfig{'autoenroll'};
8575: if ($settings->{'run'} eq '1') {
8576: $response = 1;
8577: }
8578: } else {
1.934 raeburn 8579: my $homeserver;
8580: if (&is_course($cdom,$cnum)) {
8581: $homeserver = &homeserver($cnum,$cdom);
8582: } else {
8583: $homeserver = &domain($cdom,'primary');
8584: }
8585: if ($homeserver ne 'no_host') {
8586: $response = &reply('autorun:'.$cdom,$homeserver);
8587: }
1.876 raeburn 8588: }
1.506 raeburn 8589: return $response;
8590: }
1.776 albertel 8591:
1.506 raeburn 8592: sub auto_get_sections {
1.508 raeburn 8593: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 8594: my $homeserver;
8595: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8596: $homeserver = &homeserver($cnum,$cdom);
8597: }
8598: if (!defined($homeserver)) {
8599: if ($cdom =~ /^$match_domain$/) {
8600: $homeserver = &domain($cdom,'primary');
8601: }
8602: }
8603: my @secs;
8604: if (defined($homeserver)) {
8605: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
8606: unless ($response eq 'refused') {
8607: @secs = split(/:/,$response);
8608: }
1.506 raeburn 8609: }
8610: return @secs;
8611: }
1.776 albertel 8612:
1.506 raeburn 8613: sub auto_new_course {
1.1099 raeburn 8614: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 8615: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 8616: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 8617: return $response;
8618: }
1.776 albertel 8619:
1.506 raeburn 8620: sub auto_validate_courseID {
1.508 raeburn 8621: my ($cnum,$cdom,$inst_course_id) = @_;
8622: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 8623: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 8624: return $response;
8625: }
1.776 albertel 8626:
1.1007 raeburn 8627: sub auto_validate_instcode {
1.1020 raeburn 8628: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 8629: my ($homeserver,$response);
8630: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8631: $homeserver = &homeserver($cnum,$cdom);
8632: }
8633: if (!defined($homeserver)) {
8634: if ($cdom =~ /^$match_domain$/) {
8635: $homeserver = &domain($cdom,'primary');
8636: }
8637: }
1.1065 raeburn 8638: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8639: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 8640: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8641: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 8642: }
8643:
1.506 raeburn 8644: sub auto_create_password {
1.873 raeburn 8645: my ($cnum,$cdom,$authparam,$udom) = @_;
8646: my ($homeserver,$response);
1.506 raeburn 8647: my $create_passwd = 0;
8648: my $authchk = '';
1.873 raeburn 8649: if ($udom =~ /^$match_domain$/) {
8650: $homeserver = &domain($udom,'primary');
8651: }
8652: if ($homeserver eq '') {
8653: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8654: $homeserver = &homeserver($cnum,$cdom);
8655: }
8656: }
8657: if ($homeserver eq '') {
8658: $authchk = 'nodomain';
1.506 raeburn 8659: } else {
1.873 raeburn 8660: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8661: if ($response eq 'refused') {
8662: $authchk = 'refused';
8663: } else {
1.901 albertel 8664: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 8665: }
1.506 raeburn 8666: }
8667: return ($authparam,$create_passwd,$authchk);
8668: }
8669:
1.706 raeburn 8670: sub auto_photo_permission {
8671: my ($cnum,$cdom,$students) = @_;
8672: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 8673: my ($outcome,$perm_reqd,$conditions) =
8674: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 8675: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8676: return (undef,undef);
8677: }
1.706 raeburn 8678: return ($outcome,$perm_reqd,$conditions);
8679: }
8680:
8681: sub auto_checkphotos {
8682: my ($uname,$udom,$pid) = @_;
8683: my $homeserver = &homeserver($uname,$udom);
8684: my ($result,$resulttype);
8685: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 8686: &escape($uname).':'.&escape($pid),
8687: $homeserver));
1.709 albertel 8688: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8689: return (undef,undef);
8690: }
1.706 raeburn 8691: if ($outcome) {
8692: ($result,$resulttype) = split(/:/,$outcome);
8693: }
8694: return ($result,$resulttype);
8695: }
8696:
8697: sub auto_photochoice {
8698: my ($cnum,$cdom) = @_;
8699: my $homeserver = &homeserver($cnum,$cdom);
8700: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 8701: &escape($cdom),
8702: $homeserver)));
1.709 albertel 8703: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8704: return (undef,undef);
8705: }
1.706 raeburn 8706: return ($update,$comment);
8707: }
8708:
8709: sub auto_photoupdate {
8710: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8711: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 8712: my $host=&hostname($homeserver);
1.706 raeburn 8713: my $cmd = '';
8714: my $maxtries = 1;
1.800 albertel 8715: foreach my $affiliate (keys(%{$affiliatesref})) {
8716: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 8717: }
8718: $cmd =~ s/%%$//;
8719: $cmd = &escape($cmd);
8720: my $query = 'institutionalphotos';
8721: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8722: unless ($queryid=~/^\Q$host\E\_/) {
8723: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8724: return 'error: '.$queryid;
8725: }
8726: my $reply = &get_query_reply($queryid);
8727: my $tries = 1;
8728: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8729: $reply = &get_query_reply($queryid);
8730: $tries ++;
8731: }
8732: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8733: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8734: } else {
8735: my @responses = split(/:/,$reply);
8736: my $outcome = shift(@responses);
8737: foreach my $item (@responses) {
8738: my ($key,$value) = split(/=/,$item);
8739: $$photo{$key} = $value;
8740: }
8741: return $outcome;
8742: }
8743: return 'error';
8744: }
8745:
1.521 raeburn 8746: sub auto_instcode_format {
1.793 albertel 8747: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8748: $cat_order) = @_;
1.521 raeburn 8749: my $courses = '';
1.772 raeburn 8750: my @homeservers;
1.521 raeburn 8751: if ($caller eq 'global') {
1.841 albertel 8752: my %servers = &get_servers($codedom,'library');
8753: foreach my $tryserver (keys(%servers)) {
8754: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8755: push(@homeservers,$tryserver);
8756: }
1.584 raeburn 8757: }
1.1022 raeburn 8758: } elsif ($caller eq 'requests') {
8759: if ($codedom =~ /^$match_domain$/) {
8760: my $chome = &domain($codedom,'primary');
8761: unless ($chome eq 'no_host') {
8762: push(@homeservers,$chome);
8763: }
8764: }
1.521 raeburn 8765: } else {
1.772 raeburn 8766: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 8767: }
1.793 albertel 8768: foreach my $code (keys(%{$instcodes})) {
8769: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 8770: }
8771: chop($courses);
1.772 raeburn 8772: my $ok_response = 0;
8773: my $response;
8774: while (@homeservers > 0 && $ok_response == 0) {
8775: my $server = shift(@homeservers);
8776: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8777: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8778: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 8779: split(/:/,$response);
1.772 raeburn 8780: %{$codes} = (%{$codes},&str2hash($codes_str));
8781: push(@{$codetitles},&str2array($codetitles_str));
8782: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8783: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8784: $ok_response = 1;
8785: }
8786: }
8787: if ($ok_response) {
1.521 raeburn 8788: return 'ok';
1.772 raeburn 8789: } else {
8790: return $response;
1.521 raeburn 8791: }
8792: }
8793:
1.792 raeburn 8794: sub auto_instcode_defaults {
8795: my ($domain,$returnhash,$code_order) = @_;
8796: my @homeservers;
1.841 albertel 8797:
8798: my %servers = &get_servers($domain,'library');
8799: foreach my $tryserver (keys(%servers)) {
8800: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8801: push(@homeservers,$tryserver);
8802: }
1.792 raeburn 8803: }
1.841 albertel 8804:
1.792 raeburn 8805: my $response;
1.841 albertel 8806: foreach my $server (@homeservers) {
1.792 raeburn 8807: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 8808: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8809:
8810: foreach my $pair (split(/\&/,$response)) {
8811: my ($name,$value)=split(/\=/,$pair);
8812: if ($name eq 'code_order') {
8813: @{$code_order} = split(/\&/,&unescape($value));
8814: } else {
8815: $returnhash->{&unescape($name)}=&unescape($value);
8816: }
8817: }
8818: return 'ok';
1.792 raeburn 8819: }
1.841 albertel 8820:
8821: return $response;
1.1003 raeburn 8822: }
8823:
8824: sub auto_possible_instcodes {
1.1007 raeburn 8825: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8826: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8827: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8828: return;
8829: }
1.1003 raeburn 8830: my (@homeservers,$uhome);
8831: if (defined(&domain($domain,'primary'))) {
8832: $uhome=&domain($domain,'primary');
8833: push(@homeservers,&domain($domain,'primary'));
8834: } else {
8835: my %servers = &get_servers($domain,'library');
8836: foreach my $tryserver (keys(%servers)) {
8837: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8838: push(@homeservers,$tryserver);
8839: }
8840: }
8841: }
8842: my $response;
8843: foreach my $server (@homeservers) {
8844: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8845: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 8846: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8847: split(':',$response);
8848: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8849: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 8850: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 8851: my ($name,$value)=split('=',$item);
8852: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8853: }
8854: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 8855: my ($name,$value)=split('=',$item);
8856: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8857: }
8858: return 'ok';
8859: }
8860: return $response;
8861: }
1.792 raeburn 8862:
1.1010 raeburn 8863: sub auto_courserequest_checks {
8864: my ($dom) = @_;
1.1020 raeburn 8865: my ($homeserver,%validations);
8866: if ($dom =~ /^$match_domain$/) {
8867: $homeserver = &domain($dom,'primary');
8868: }
8869: unless ($homeserver eq 'no_host') {
8870: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8871: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8872: my @items = split(/&/,$response);
8873: foreach my $item (@items) {
8874: my ($key,$value) = split('=',$item);
8875: $validations{&unescape($key)} = &thaw_unescape($value);
8876: }
8877: }
8878: }
1.1010 raeburn 8879: return %validations;
8880: }
8881:
1.1020 raeburn 8882: sub auto_courserequest_validation {
1.1255 raeburn 8883: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 8884: my ($homeserver,$response);
8885: if ($dom =~ /^$match_domain$/) {
8886: $homeserver = &domain($dom,'primary');
8887: }
1.1255 raeburn 8888: unless ($homeserver eq 'no_host') {
8889: my $customdata;
8890: if (ref($custominfo) eq 'HASH') {
8891: $customdata = &freeze_escape($custominfo);
8892: }
1.1020 raeburn 8893: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 8894: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255 raeburn 8895: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8896: $customdata,$homeserver));
1.1020 raeburn 8897: }
8898: return $response;
8899: }
8900:
1.777 albertel 8901: sub auto_validate_class_sec {
1.918 raeburn 8902: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 8903: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 8904: my $ownerlist;
8905: if (ref($owners) eq 'ARRAY') {
8906: $ownerlist = join(',',@{$owners});
8907: } else {
8908: $ownerlist = $owners;
8909: }
1.773 raeburn 8910: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 8911: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 8912: return $response;
8913: }
8914:
1.1367 raeburn 8915: sub auto_validate_instclasses {
8916: my ($cdom,$cnum,$owners,$classesref) = @_;
8917: my ($homeserver,%validations);
8918: $homeserver = &homeserver($cnum,$cdom);
8919: unless ($homeserver eq 'no_host') {
8920: my $ownerlist;
8921: if (ref($owners) eq 'ARRAY') {
8922: $ownerlist = join(',',@{$owners});
8923: } else {
8924: $ownerlist = $owners;
8925: }
8926: if (ref($classesref) eq 'HASH') {
8927: my $classes = &freeze_escape($classesref);
8928: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
8929: ':'.$cdom.':'.$classes,$homeserver);
8930: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8931: my @items = split(/&/,$response);
8932: foreach my $item (@items) {
8933: my ($key,$value) = split('=',$item);
8934: $validations{&unescape($key)} = &thaw_unescape($value);
8935: }
8936: }
8937: }
8938: }
8939: return %validations;
8940: }
8941:
1.1248 raeburn 8942: sub auto_crsreq_update {
8943: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257 raeburn 8944: $code,$accessstart,$accessend,$inbound) = @_;
1.1248 raeburn 8945: my ($homeserver,%crsreqresponse);
8946: if ($cdom =~ /^$match_domain$/) {
8947: $homeserver = &domain($cdom,'primary');
8948: }
8949: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8950: my $info;
8951: if (ref($inbound) eq 'HASH') {
8952: $info = &freeze_escape($inbound);
8953: }
8954: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8955: ':'.&escape($action).':'.&escape($ownername).':'.
8956: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257 raeburn 8957: &escape($title).':'.&escape($code).':'.
8958: &escape($accessstart).':'.&escape($accessend).':'.$info,
8959: $homeserver);
1.1248 raeburn 8960: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8961: my @items = split(/&/,$response);
8962: foreach my $item (@items) {
8963: my ($key,$value) = split('=',$item);
8964: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8965: }
8966: }
8967: }
8968: return \%crsreqresponse;
8969: }
8970:
1.1305 raeburn 8971: sub auto_export_grades {
1.1309 raeburn 8972: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8973: my ($homeserver,%exportresponse);
8974: if ($cdom =~ /^$match_domain$/) {
8975: $homeserver = &domain($cdom,'primary');
8976: }
8977: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8978: my $info;
8979: if (ref($inforef) eq 'HASH') {
8980: $info = &freeze_escape($inforef);
8981: }
8982: if (ref($gradesref) eq 'HASH') {
8983: my $grades = &freeze_escape($gradesref);
8984: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8985: $info.':'.$grades,$homeserver);
8986: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8987: my @items = split(/&/,$response);
8988: foreach my $item (@items) {
8989: my ($key,$value) = split('=',$item);
8990: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8991: }
8992: }
8993: }
8994: }
8995: return \%exportresponse;
1.1305 raeburn 8996: }
8997:
1.1287 raeburn 8998: sub check_instcode_cloning {
8999: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
9000: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
9001: return;
9002: }
9003: my $canclone;
9004: if (@{$code_order} > 0) {
9005: my $instcoderegexp ='^';
9006: my @clonecodes = split(/\&/,$cloner);
9007: foreach my $item (@{$code_order}) {
9008: if (grep(/^\Q$item\E=/,@clonecodes)) {
9009: foreach my $pair (@clonecodes) {
9010: my ($key,$val) = split(/\=/,$pair,2);
9011: $val = &unescape($val);
9012: if ($key eq $item) {
9013: $instcoderegexp .= '('.$val.')';
9014: last;
9015: }
9016: }
9017: } else {
9018: $instcoderegexp .= $codedefaults->{$item};
9019: }
9020: }
9021: $instcoderegexp .= '$';
9022: my (@from,@to);
9023: eval {
9024: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9025: (@to) = ($clonetocode =~ /$instcoderegexp/);
9026: };
9027: if ((@from > 0) && (@to > 0)) {
9028: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9029: if (!@diffs) {
9030: $canclone = 1;
9031: }
9032: }
9033: }
9034: return $canclone;
9035: }
9036:
9037: sub default_instcode_cloning {
9038: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
9039: my (%codedefaults,@code_order,$canclone);
9040: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
9041: %codedefaults = %{$codedefaultsref};
9042: @code_order = @{$codeorderref};
9043: } elsif ($clonedom) {
9044: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
9045: }
9046: if (($domdefclone) && (@code_order)) {
9047: my @clonecodes = split(/\+/,$domdefclone);
9048: my $instcoderegexp ='^';
9049: foreach my $item (@code_order) {
9050: if (grep(/^\Q$item\E$/,@clonecodes)) {
9051: $instcoderegexp .= '('.$codedefaults{$item}.')';
9052: } else {
9053: $instcoderegexp .= $codedefaults{$item};
9054: }
9055: }
9056: $instcoderegexp .= '$';
9057: my (@from,@to);
9058: eval {
9059: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9060: (@to) = ($clonetocode =~ /$instcoderegexp/);
9061: };
9062: if ((@from > 0) && (@to > 0)) {
9063: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9064: if (!@diffs) {
9065: $canclone = 1;
9066: }
9067: }
9068: }
9069: return $canclone;
9070: }
9071:
1.679 raeburn 9072: # ------------------------------------------------------- Course Group routines
9073:
9074: sub get_coursegroups {
1.809 raeburn 9075: my ($cdom,$cnum,$group,$namespace) = @_;
9076: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 9077: }
9078:
1.679 raeburn 9079: sub modify_coursegroup {
9080: my ($cdom,$cnum,$groupsettings) = @_;
9081: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
9082: }
9083:
1.809 raeburn 9084: sub toggle_coursegroup_status {
9085: my ($cdom,$cnum,$group,$action) = @_;
9086: my ($from_namespace,$to_namespace);
9087: if ($action eq 'delete') {
9088: $from_namespace = 'coursegroups';
9089: $to_namespace = 'deleted_groups';
9090: } else {
9091: $from_namespace = 'deleted_groups';
9092: $to_namespace = 'coursegroups';
9093: }
9094: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 9095: if (my $tmp = &error(%curr_group)) {
9096: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
9097: return ('read error',$tmp);
9098: } else {
9099: my %savedsettings = %curr_group;
1.809 raeburn 9100: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 9101: my $deloutcome;
9102: if ($result eq 'ok') {
1.809 raeburn 9103: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 9104: } else {
9105: return ('write error',$result);
9106: }
9107: if ($deloutcome eq 'ok') {
9108: return 'ok';
9109: } else {
9110: return ('delete error',$deloutcome);
9111: }
9112: }
9113: }
9114:
1.679 raeburn 9115: sub modify_group_roles {
1.957 raeburn 9116: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 9117: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
9118: my $role = 'gr/'.&escape($userprivs);
9119: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 9120: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 9121: if ($result eq 'ok') {
9122: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
9123: }
1.679 raeburn 9124: return $result;
9125: }
9126:
9127: sub modify_coursegroup_membership {
9128: my ($cdom,$cnum,$membership) = @_;
9129: my $result = &put('groupmembership',$membership,$cdom,$cnum);
9130: return $result;
9131: }
9132:
1.682 raeburn 9133: sub get_active_groups {
9134: my ($udom,$uname,$cdom,$cnum) = @_;
9135: my $now = time;
9136: my %groups = ();
9137: foreach my $key (keys(%env)) {
1.811 albertel 9138: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 9139: my ($start,$end) = split(/\./,$env{$key});
9140: if (($end!=0) && ($end<$now)) { next; }
9141: if (($start!=0) && ($start>$now)) { next; }
9142: if ($1 eq $cdom && $2 eq $cnum) {
9143: $groups{$3} = $env{$key} ;
9144: }
9145: }
9146: }
9147: return %groups;
9148: }
9149:
1.683 raeburn 9150: sub get_group_membership {
9151: my ($cdom,$cnum,$group) = @_;
9152: return(&dump('groupmembership',$cdom,$cnum,$group));
9153: }
9154:
9155: sub get_users_groups {
9156: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 9157: my @usersgroups;
1.683 raeburn 9158: my $cachetime=1800;
9159:
9160: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 9161: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
9162: if (defined($cached)) {
1.734 albertel 9163: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 9164: } else {
9165: $grouplist = '';
1.816 raeburn 9166: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 9167: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 9168: my $access_end = $env{'course.'.$courseid.
9169: '.default_enrollment_end_date'};
9170: my $now = time;
9171: foreach my $key (keys(%roleshash)) {
9172: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
9173: my $group = $1;
9174: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
9175: my $start = $2;
9176: my $end = $1;
9177: if ($start == -1) { next; } # deleted from group
9178: if (($start!=0) && ($start>$now)) { next; }
9179: if (($end!=0) && ($end<$now)) {
9180: if ($access_end && $access_end < $now) {
9181: if ($access_end - $end < 86400) {
9182: push(@usersgroups,$group);
1.733 raeburn 9183: }
9184: }
1.817 raeburn 9185: next;
1.733 raeburn 9186: }
1.817 raeburn 9187: push(@usersgroups,$group);
1.683 raeburn 9188: }
9189: }
9190: }
1.817 raeburn 9191: @usersgroups = &sort_course_groups($courseid,@usersgroups);
9192: $grouplist = join(':',@usersgroups);
9193: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 9194: }
1.733 raeburn 9195: return @usersgroups;
1.683 raeburn 9196: }
9197:
9198: sub devalidate_getgroups_cache {
9199: my ($udom,$uname,$cdom,$cnum)=@_;
9200: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 9201:
1.683 raeburn 9202: my $hashid="$udom:$uname:$courseid";
9203: &devalidate_cache_new('getgroups',$hashid);
9204: }
9205:
1.12 www 9206: # ------------------------------------------------------------------ Plain Text
9207:
9208: sub plaintext {
1.988 raeburn 9209: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 9210: if ($short =~ m{^cr/}) {
1.758 albertel 9211: return (split('/',$short))[-1];
9212: }
1.742 raeburn 9213: if (!defined($cid)) {
9214: $cid = $env{'request.course.id'};
9215: }
9216: my %rolenames = (
1.1008 raeburn 9217: Course => 'std',
9218: Community => 'alt1',
1.1305 raeburn 9219: Placement => 'std',
1.742 raeburn 9220: );
1.1037 raeburn 9221: if ($cid ne '') {
9222: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
9223: unless ($forcedefault) {
9224: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
9225: &Apache::lonlocal::mt_escape(\$roletext);
9226: return &Apache::lonlocal::mt($roletext);
9227: }
9228: }
9229: }
9230: if ((defined($type)) && (defined($rolenames{$type})) &&
9231: (defined($rolenames{$type})) &&
9232: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 9233: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 9234: } elsif ($cid ne '') {
9235: my $crstype = $env{'course.'.$cid.'.type'};
9236: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
9237: (defined($prp{$short}{$rolenames{$crstype}}))) {
9238: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
9239: }
1.742 raeburn 9240: }
1.1037 raeburn 9241: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 9242: }
9243:
9244: # ----------------------------------------------------------------- Assign Role
9245:
9246: sub assignrole {
1.957 raeburn 9247: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
9248: $context)=@_;
1.21 www 9249: my $mrole;
9250: if ($role =~ /^cr\//) {
1.393 www 9251: my $cwosec=$url;
1.811 albertel 9252: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 9253: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 9254: my $refused = 1;
9255: if ($context eq 'requestcourses') {
9256: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
9257: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
9258: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
9259: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
9260: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9261: if ($crsenv{'internal.courseowner'} eq
9262: $env{'user.name'}.':'.$env{'user.domain'}) {
9263: $refused = '';
9264: }
9265: }
9266: }
9267: }
9268: }
9269: if ($refused) {
9270: &logthis('Refused custom assignrole: '.
9271: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
9272: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
9273: return 'refused';
9274: }
1.104 www 9275: }
1.21 www 9276: $mrole='cr';
1.678 raeburn 9277: } elsif ($role =~ /^gr\//) {
9278: my $cwogrp=$url;
1.811 albertel 9279: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 9280: unless (&allowed('mdg',$cwogrp)) {
9281: &logthis('Refused group assignrole: '.
9282: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
9283: $env{'user.name'}.' at '.$env{'user.domain'});
9284: return 'refused';
9285: }
9286: $mrole='gr';
1.21 www 9287: } else {
1.82 www 9288: my $cwosec=$url;
1.811 albertel 9289: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 9290: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
9291: my $refused;
9292: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
9293: if (!(&allowed('c'.$role,$url))) {
9294: $refused = 1;
9295: }
9296: } else {
9297: $refused = 1;
9298: }
1.947 raeburn 9299: if ($refused) {
1.1045 raeburn 9300: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
1.1377 raeburn 9301: if (!$selfenroll && (($context eq 'course') || ($context eq 'ltienroll' && $env{'request.lti.login'}))) {
1.1045 raeburn 9302: my %crsenv;
9303: if ($role eq 'cc' || $role eq 'co') {
9304: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9305: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
9306: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
9307: if ($crsenv{'internal.courseowner'} eq
9308: $env{'user.name'}.':'.$env{'user.domain'}) {
9309: $refused = '';
9310: }
9311: }
9312: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
9313: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
9314: if ($crsenv{'internal.courseowner'} eq
9315: $env{'user.name'}.':'.$env{'user.domain'}) {
9316: $refused = '';
9317: }
9318: }
9319: }
9320: }
1.1368 raeburn 9321: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
9322: if ($role eq 'st') {
9323: $refused = '';
1.1377 raeburn 9324: } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
1.1368 raeburn 9325: $refused = '';
9326: }
1.1017 raeburn 9327: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 9328: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 9329: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 9330: my $wrongcc;
9331: if ($cnum =~ /^$match_community$/) {
9332: $wrongcc = 1 if ($role eq 'cc');
9333: } else {
9334: $wrongcc = 1 if ($role eq 'co');
9335: }
9336: unless ($wrongcc) {
9337: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9338: if ($crsenv{'internal.courseowner'} eq
9339: $env{'user.name'}.':'.$env{'user.domain'}) {
9340: $refused = '';
9341: }
1.1017 raeburn 9342: }
9343: }
1.1183 raeburn 9344: } elsif ($context eq 'requestauthor') {
9345: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
9346: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
9347: if ($env{'environment.requestauthor'} eq 'automatic') {
9348: $refused = '';
9349: } else {
9350: my %domdefaults = &get_domain_defaults($udom);
9351: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
9352: my $checkbystatus;
9353: if ($env{'user.adv'}) {
9354: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
9355: if ($disposition eq 'automatic') {
9356: $refused = '';
9357: } elsif ($disposition eq '') {
9358: $checkbystatus = 1;
9359: }
9360: } else {
9361: $checkbystatus = 1;
9362: }
9363: if ($checkbystatus) {
9364: if ($env{'environment.inststatus'}) {
9365: my @inststatuses = split(/,/,$env{'environment.inststatus'});
9366: foreach my $type (@inststatuses) {
9367: if (($type ne '') &&
9368: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
9369: $refused = '';
9370: }
9371: }
9372: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
9373: $refused = '';
9374: }
9375: }
9376: }
9377: }
9378: }
1.1017 raeburn 9379: }
9380: if ($refused) {
1.947 raeburn 9381: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
9382: ' '.$role.' '.$end.' '.$start.' by '.
9383: $env{'user.name'}.' at '.$env{'user.domain'});
9384: return 'refused';
9385: }
1.932 raeburn 9386: }
1.1131 raeburn 9387: } elsif ($role eq 'au') {
9388: if ($url ne '/'.$udom.'/') {
9389: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
9390: ' to assign author role for '.$uname.':'.$udom.
9391: ' in domain: '.$url.' refused (wrong domain).');
9392: return 'refused';
9393: }
1.104 www 9394: }
1.21 www 9395: $mrole=$role;
9396: }
1.620 albertel 9397: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 9398: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 9399: if ($end) { $command.='_'.$end; }
1.21 www 9400: if ($start) {
9401: if ($end) {
1.81 www 9402: $command.='_'.$start;
1.21 www 9403: } else {
1.81 www 9404: $command.='_0_'.$start;
1.21 www 9405: }
9406: }
1.739 raeburn 9407: my $origstart = $start;
9408: my $origend = $end;
1.957 raeburn 9409: my $delflag;
1.357 www 9410: # actually delete
9411: if ($deleteflag) {
1.373 www 9412: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 9413: # modify command to delete the role
1.620 albertel 9414: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 9415: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 9416: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 9417: # set start and finish to negative values for userrolelog
9418: $start=-1;
9419: $end=-1;
1.957 raeburn 9420: $delflag = 1;
1.357 www 9421: }
9422: }
9423: # send command
1.349 www 9424: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 9425: # log new user role if status is ok
1.349 www 9426: if ($answer eq 'ok') {
1.663 raeburn 9427: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 9428: if (($role eq 'cc') || ($role eq 'in') ||
9429: ($role eq 'ep') || ($role eq 'ad') ||
9430: ($role eq 'ta') || ($role eq 'st') ||
9431: ($role=~/^cr/) || ($role eq 'gr') ||
9432: ($role eq 'co')) {
1.1200 raeburn 9433: # for course roles, perform group memberships changes triggered by role change.
9434: unless ($role =~ /^gr/) {
9435: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
9436: $origstart,$selfenroll,$context);
9437: }
1.1184 raeburn 9438: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9439: $selfenroll,$context);
9440: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1334 raeburn 9441: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
9442: ($role eq 'da')) {
1.1184 raeburn 9443: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9444: $context);
9445: } elsif (($role eq 'ca') || ($role eq 'aa')) {
9446: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9447: $context);
9448: }
1.1053 raeburn 9449: if ($role eq 'cc') {
9450: &autoupdate_coowners($url,$end,$start,$uname,$udom);
9451: }
1.349 www 9452: }
9453: return $answer;
1.169 harris41 9454: }
9455:
1.1053 raeburn 9456: sub autoupdate_coowners {
9457: my ($url,$end,$start,$uname,$udom) = @_;
9458: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
9459: if (($cdom ne '') && ($cnum ne '')) {
9460: my $now = time;
9461: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
9462: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
9463: my %coursehash = &coursedescription($cdom.'_'.$cnum);
9464: my $instcode = $coursehash{'internal.coursecode'};
9465: if ($instcode ne '') {
1.1056 raeburn 9466: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
9467: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 9468: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 9469: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
9470: if ($result eq 'valid') {
9471: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 9472: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9473: push(@newcoowners,$coowner);
9474: }
9475: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
9476: push(@newcoowners,$uname.':'.$udom);
9477: }
9478: @newcoowners = sort(@newcoowners);
9479: } else {
9480: push(@newcoowners,$uname.':'.$udom);
9481: }
9482: } else {
9483: if ($coursehash{'internal.co-owners'}) {
9484: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9485: unless ($coowner eq $uname.':'.$udom) {
9486: push(@newcoowners,$coowner);
9487: }
9488: }
9489: unless (@newcoowners > 0) {
9490: $delcoowners = 1;
9491: $coowners = '';
9492: }
9493: }
9494: }
9495: if (@newcoowners || $delcoowners) {
9496: &store_coowners($cdom,$cnum,$coursehash{'home'},
9497: $delcoowners,@newcoowners);
9498: }
9499: }
9500: }
9501: }
9502: }
9503: }
9504: }
9505:
9506: sub store_coowners {
9507: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
9508: my $cid = $cdom.'_'.$cnum;
9509: my ($coowners,$delresult,$putresult);
9510: if (@newcoowners) {
9511: $coowners = join(',',@newcoowners);
9512: my %coownershash = (
9513: 'internal.co-owners' => $coowners,
9514: );
9515: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
9516: if ($putresult eq 'ok') {
9517: if ($env{'course.'.$cid.'.num'} eq $cnum) {
9518: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
9519: }
9520: }
9521: }
9522: if ($delcoowners) {
9523: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
9524: if ($delresult eq 'ok') {
9525: if ($env{'course.'.$cid.'.internal.co-owners'}) {
9526: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
9527: }
9528: }
9529: }
9530: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
9531: my %crsinfo =
9532: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
9533: if (ref($crsinfo{$cid}) eq 'HASH') {
9534: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
9535: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
9536: }
9537: }
9538: }
9539:
1.169 harris41 9540: # -------------------------------------------------- Modify user authentication
1.197 www 9541: # Overrides without validation
9542:
1.169 harris41 9543: sub modifyuserauth {
9544: my ($udom,$uname,$umode,$upass)=@_;
9545: my $uhome=&homeserver($uname,$udom);
1.197 www 9546: unless (&allowed('mau',$udom)) { return 'refused'; }
9547: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 9548: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9549: ' in domain '.$env{'request.role.domain'});
1.169 harris41 9550: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
9551: &escape($upass),$uhome);
1.620 albertel 9552: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 9553: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
9554: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9555: &log($udom,,$uname,$uhome,
1.620 albertel 9556: 'Authentication changed by '.$env{'user.domain'}.', '.
9557: $env{'user.name'}.', '.$umode.
1.197 www 9558: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 9559: unless ($reply eq 'ok') {
1.197 www 9560: &logthis('Authentication mode error: '.$reply);
1.169 harris41 9561: return 'error: '.$reply;
9562: }
1.170 harris41 9563: return 'ok';
1.80 www 9564: }
9565:
1.81 www 9566: # --------------------------------------------------------------- Modify a user
1.80 www 9567:
1.81 www 9568: sub modifyuser {
1.206 matthew 9569: my ($udom, $uname, $uid,
9570: $umode, $upass, $first,
9571: $middle, $last, $gene,
1.1058 raeburn 9572: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 9573: $udom= &LONCAPA::clean_domain($udom);
9574: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 9575: my $showcandelete = 'none';
9576: if (ref($candelete) eq 'ARRAY') {
9577: if (@{$candelete} > 0) {
9578: $showcandelete = join(', ',@{$candelete});
9579: }
9580: }
1.81 www 9581: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 9582: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 9583: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 9584: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
9585: ' desiredhome not specified').
1.620 albertel 9586: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9587: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 9588: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 9589: my $newuser;
9590: if ($uhome eq 'no_host') {
9591: $newuser = 1;
1.1368 raeburn 9592: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
9593: ($umode eq 'lti')) {
9594: return 'error: more information needed to create new user';
9595: }
1.1075 raeburn 9596: }
1.80 www 9597: # ----------------------------------------------------------------- Create User
1.406 albertel 9598: if (($uhome eq 'no_host') &&
1.1368 raeburn 9599: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
1.80 www 9600: my $unhome='';
1.844 albertel 9601: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 9602: $unhome = $desiredhome;
1.620 albertel 9603: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
9604: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 9605: } else { # load balancing routine for determining $unhome
1.81 www 9606: my $loadm=10000000;
1.841 albertel 9607: my %servers = &get_servers($udom,'library');
9608: foreach my $tryserver (keys(%servers)) {
9609: my $answer=reply('load',$tryserver);
9610: if (($answer=~/\d+/) && ($answer<$loadm)) {
9611: $loadm=$answer;
9612: $unhome=$tryserver;
9613: }
1.80 www 9614: }
9615: }
9616: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 9617: return 'error: unable to find a home server for '.$uname.
9618: ' in domain '.$udom;
1.80 www 9619: }
9620: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
9621: &escape($upass),$unhome);
9622: unless ($reply eq 'ok') {
9623: return 'error: '.$reply;
9624: }
1.230 stredwic 9625: $uhome=&homeserver($uname,$udom,'true');
1.80 www 9626: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 9627: return 'error: unable verify users home machine.';
1.80 www 9628: }
1.209 matthew 9629: } # End of creation of new user
1.80 www 9630: # ---------------------------------------------------------------------- Add ID
9631: if ($uid) {
9632: $uid=~tr/A-Z/a-z/;
9633: my %uidhash=&idrget($udom,$uname);
1.196 www 9634: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
9635: && (!$forceid)) {
1.80 www 9636: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 9637: return 'error: user id "'.$uid.'" does not match '.
9638: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 9639: }
9640: } else {
1.1300 raeburn 9641: &idput($udom,{$uname => $uid},$uhome,'ids');
1.80 www 9642: }
9643: }
9644: # -------------------------------------------------------------- Add names, etc
1.313 matthew 9645: my @tmp=&get('environment',
1.899 raeburn 9646: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 9647: 'permanentemail','inststatus'],
1.134 albertel 9648: $udom,$uname);
1.1075 raeburn 9649: my (%names,%oldnames);
1.313 matthew 9650: if ($tmp[0] =~ m/^error:.*/) {
9651: %names=();
9652: } else {
9653: %names = @tmp;
1.1075 raeburn 9654: %oldnames = %names;
1.313 matthew 9655: }
1.388 www 9656: #
1.1058 raeburn 9657: # If name, email and/or uid are blank (e.g., because an uploaded file
9658: # of users did not contain them), do not overwrite existing values
9659: # unless field is in $candelete array ref.
9660: #
9661:
9662: my @fields = ('firstname','middlename','lastname','generation',
9663: 'permanentemail','id');
9664: my %newvalues;
9665: if (ref($candelete) eq 'ARRAY') {
9666: foreach my $field (@fields) {
9667: if (grep(/^\Q$field\E$/,@{$candelete})) {
9668: if ($field eq 'firstname') {
9669: $names{$field} = $first;
9670: } elsif ($field eq 'middlename') {
9671: $names{$field} = $middle;
9672: } elsif ($field eq 'lastname') {
9673: $names{$field} = $last;
9674: } elsif ($field eq 'generation') {
9675: $names{$field} = $gene;
9676: } elsif ($field eq 'permanentemail') {
9677: $names{$field} = $email;
9678: } elsif ($field eq 'id') {
9679: $names{$field} = $uid;
9680: }
9681: }
9682: }
9683: }
1.388 www 9684: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 9685: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 9686: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 9687: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 9688: if ($email) {
9689: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 9690: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 9691: }
1.899 raeburn 9692: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 9693: if (defined($inststatus)) {
9694: $names{'inststatus'} = '';
9695: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9696: if (ref($usertypes) eq 'HASH') {
9697: my @okstatuses;
9698: foreach my $item (split(/:/,$inststatus)) {
9699: if (defined($usertypes->{$item})) {
9700: push(@okstatuses,$item);
9701: }
9702: }
9703: if (@okstatuses) {
9704: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9705: }
9706: }
9707: }
1.1075 raeburn 9708: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 9709: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 9710: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 9711: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9712: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9713: } else {
9714: $logmsg .= ' during self creation';
9715: }
1.1075 raeburn 9716: my $changed;
9717: if ($newuser) {
9718: $changed = 1;
9719: } else {
9720: foreach my $field (@fields) {
9721: if ($names{$field} ne $oldnames{$field}) {
9722: $changed = 1;
9723: last;
9724: }
9725: }
9726: }
9727: unless ($changed) {
9728: $logmsg = 'No changes in user information needed for: '.$logmsg;
9729: &logthis($logmsg);
9730: return 'ok';
9731: }
9732: my $reply = &put('environment', \%names, $udom,$uname);
9733: if ($reply ne 'ok') {
9734: return 'error: '.$reply;
9735: }
1.1087 raeburn 9736: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9737: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9738: }
1.1075 raeburn 9739: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9740: &devalidate_cache_new('namescache',$uname.':'.$udom);
9741: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 9742: &logthis($logmsg);
1.134 albertel 9743: return 'ok';
1.80 www 9744: }
9745:
1.81 www 9746: # -------------------------------------------------------------- Modify student
1.80 www 9747:
1.81 www 9748: sub modifystudent {
9749: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 9750: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1314 raeburn 9751: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 9752: if (!$cid) {
1.620 albertel 9753: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9754: return 'not_in_class';
9755: }
1.80 www 9756: }
9757: # --------------------------------------------------------------- Make the user
1.81 www 9758: my $reply=&modifyuser
1.209 matthew 9759: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 9760: $desiredhome,$email,$inststatus);
1.80 www 9761: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 9762: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 9763: # student's environment
1.297 matthew 9764: $uid = undef if (!$forceid);
1.455 albertel 9765: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 9766: $gene,$usec,$end,$start,$type,$locktype,
1.1314 raeburn 9767: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 9768: return $reply;
9769: }
9770:
9771: sub modify_student_enrollment {
1.1216 raeburn 9772: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1314 raeburn 9773: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455 albertel 9774: my ($cdom,$cnum,$chome);
9775: if (!$cid) {
1.620 albertel 9776: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9777: return 'not_in_class';
9778: }
1.620 albertel 9779: $cdom=$env{'course.'.$cid.'.domain'};
9780: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 9781: } else {
9782: ($cdom,$cnum)=split(/_/,$cid);
9783: }
1.620 albertel 9784: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 9785: if (!$chome) {
1.457 raeburn 9786: $chome=&homeserver($cnum,$cdom);
1.297 matthew 9787: }
1.455 albertel 9788: if (!$chome) { return 'unknown_course'; }
1.297 matthew 9789: # Make sure the user exists
1.81 www 9790: my $uhome=&homeserver($uname,$udom);
9791: if (($uhome eq '') || ($uhome eq 'no_host')) {
9792: return 'error: no such user';
9793: }
1.297 matthew 9794: # Get student data if we were not given enough information
9795: if (!defined($first) || $first eq '' ||
9796: !defined($last) || $last eq '' ||
9797: !defined($uid) || $uid eq '' ||
9798: !defined($middle) || $middle eq '' ||
9799: !defined($gene) || $gene eq '') {
1.294 matthew 9800: # They did not supply us with enough data to enroll the student, so
9801: # we need to pick up more information.
1.297 matthew 9802: my %tmp = &get('environment',
1.294 matthew 9803: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 9804: ,$udom,$uname);
9805:
1.800 albertel 9806: #foreach my $key (keys(%tmp)) {
9807: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 9808: #}
1.294 matthew 9809: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9810: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9811: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 9812: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 9813: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9814: }
1.556 albertel 9815: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 9816: my $user = "$uname:$udom";
9817: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 9818: my $reply=cput('classlist',
1.1148 raeburn 9819: {$user =>
1.1314 raeburn 9820: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 9821: $cdom,$cnum);
1.1148 raeburn 9822: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9823: &devalidate_getsection_cache($udom,$uname,$cid);
9824: } else {
1.81 www 9825: return 'error: '.$reply;
9826: }
1.297 matthew 9827: # Add student role to user
1.83 www 9828: my $uurl='/'.$cid;
1.81 www 9829: $uurl=~s/\_/\//g;
9830: if ($usec) {
9831: $uurl.='/'.$usec;
9832: }
1.1148 raeburn 9833: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9834: $selfenroll,$context);
9835: if ($result ne 'ok') {
9836: if ($old_entry{$user} ne '') {
9837: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9838: } else {
9839: $reply = &del('classlist',[$user],$cdom,$cnum);
9840: }
9841: }
9842: return $result;
1.21 www 9843: }
9844:
1.556 albertel 9845: sub format_name {
9846: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9847: my $name;
9848: if ($first ne 'lastname') {
9849: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9850: } else {
9851: if ($lastname=~/\S/) {
9852: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9853: $name=~s/\s+,/,/;
9854: } else {
9855: $name.= $firstname.' '.$middlename.' '.$generation;
9856: }
9857: }
9858: $name=~s/^\s+//;
9859: $name=~s/\s+$//;
9860: $name=~s/\s+/ /g;
9861: return $name;
9862: }
9863:
1.84 www 9864: # ------------------------------------------------- Write to course preferences
9865:
9866: sub writecoursepref {
9867: my ($courseid,%prefs)=@_;
9868: $courseid=~s/^\///;
9869: $courseid=~s/\_/\//g;
9870: my ($cdomain,$cnum)=split(/\//,$courseid);
9871: my $chome=homeserver($cnum,$cdomain);
9872: if (($chome eq '') || ($chome eq 'no_host')) {
9873: return 'error: no such course';
9874: }
9875: my $cstring='';
1.800 albertel 9876: foreach my $pref (keys(%prefs)) {
9877: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 9878: }
1.84 www 9879: $cstring=~s/\&$//;
9880: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9881: }
9882:
9883: # ---------------------------------------------------------- Make/modify course
9884:
9885: sub createcourse {
1.741 raeburn 9886: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 9887: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 9888: $url=&declutter($url);
9889: my $cid='';
1.1028 raeburn 9890: if ($context eq 'requestcourses') {
9891: my $can_create = 0;
9892: my ($ownername,$ownerdom) = split(':',$course_owner);
9893: if ($udom eq $ownerdom) {
9894: if (&usertools_access($ownername,$ownerdom,$category,undef,
9895: $context)) {
9896: $can_create = 1;
9897: }
9898: } else {
9899: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9900: $category);
9901: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9902: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9903: if (@curr > 0) {
9904: my @options = qw(approval validate autolimit);
9905: my $optregex = join('|',@options);
9906: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9907: $can_create = 1;
9908: }
9909: }
9910: }
9911: }
9912: if ($can_create) {
9913: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9914: unless (&allowed('ccc',$udom)) {
9915: return 'refused';
9916: }
1.1017 raeburn 9917: }
9918: } else {
9919: return 'refused';
9920: }
1.1028 raeburn 9921: } elsif (!&allowed('ccc',$udom)) {
9922: return 'refused';
1.84 www 9923: }
1.1011 raeburn 9924: # --------------------------------------------------------------- Get Unique ID
9925: my $uname;
9926: if ($cnum =~ /^$match_courseid$/) {
9927: my $chome=&homeserver($cnum,$udom,'true');
9928: if (($chome eq '') || ($chome eq 'no_host')) {
9929: $uname = $cnum;
9930: } else {
1.1038 raeburn 9931: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9932: }
9933: } else {
1.1038 raeburn 9934: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9935: }
9936: return $uname if ($uname =~ /^error/);
9937: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 9938: if (!defined($course_server)) {
9939: if (defined(&domain($udom,'primary'))) {
9940: $course_server = &domain($udom,'primary');
9941: } else {
9942: $course_server = $env{'user.home'};
9943: }
9944: }
9945: my %host_servers =
9946: &Apache::lonnet::get_servers($udom,'library');
9947: unless ($host_servers{$course_server}) {
9948: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 9949: }
1.84 www 9950: # ------------------------------------------------------------- Make the course
9951: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 9952: $course_server);
1.84 www 9953: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 9954: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 9955: if (($uhome eq '') || ($uhome eq 'no_host')) {
9956: return 'error: no such course';
9957: }
1.271 www 9958: # ----------------------------------------------------------------- Course made
1.516 raeburn 9959: # log existence
1.1029 raeburn 9960: my $now = time;
1.918 raeburn 9961: my $newcourse = {
9962: $udom.'_'.$uname => {
1.921 raeburn 9963: description => $description,
9964: inst_code => $inst_code,
9965: owner => $course_owner,
9966: type => $crstype,
1.1029 raeburn 9967: creator => $env{'user.name'}.':'.
9968: $env{'user.domain'},
9969: created => $now,
9970: context => $context,
1.918 raeburn 9971: },
9972: };
1.921 raeburn 9973: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 9974: # set toplevel url
1.271 www 9975: my $topurl=$url;
9976: unless ($nonstandard) {
9977: # ------------------------------------------ For standard courses, make top url
9978: my $mapurl=&clutter($url);
1.278 www 9979: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 9980: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 9981: <map>
9982: <resource id="1" type="start"></resource>
9983: <resource id="2" src="$mapurl"></resource>
9984: <resource id="3" type="finish"></resource>
9985: <link index="1" from="1" to="2"></link>
9986: <link index="2" from="2" to="3"></link>
9987: </map>
9988: ENDINITMAP
9989: $topurl=&declutter(
1.638 albertel 9990: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 9991: );
9992: }
9993: # ----------------------------------------------------------- Write preferences
1.84 www 9994: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 9995: ('description' => $description,
9996: 'url' => $topurl,
9997: 'internal.creator' => $env{'user.name'}.':'.
9998: $env{'user.domain'},
9999: 'internal.created' => $now,
10000: 'internal.creationcontext' => $context)
10001: );
1.84 www 10002: return '/'.$udom.'/'.$uname;
10003: }
10004:
1.1011 raeburn 10005: # ------------------------------------------------------------------- Create ID
10006: sub generate_coursenum {
1.1038 raeburn 10007: my ($udom,$crstype) = @_;
1.1011 raeburn 10008: my $domdesc = &domain($udom);
10009: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 10010: my $first;
10011: if ($crstype eq 'Community') {
10012: $first = '0';
10013: } else {
10014: $first = int(1+rand(9));
10015: }
10016: my $uname=$first.
1.1011 raeburn 10017: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10018: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10019: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10020: # ----------------------------------------------- Make sure that does not exist
10021: my $uhome=&homeserver($uname,$udom,'true');
10022: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 10023: if ($crstype eq 'Community') {
10024: $first = '0';
10025: } else {
10026: $first = int(1+rand(9));
10027: }
10028: $uname=$first.
1.1011 raeburn 10029: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
10030: substr($$.time,0,5).unpack("H8",pack("I32",time)).
10031: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
10032: $uhome=&homeserver($uname,$udom,'true');
10033: unless (($uhome eq '') || ($uhome eq 'no_host')) {
10034: return 'error: unable to generate unique course-ID';
10035: }
10036: }
10037: return $uname;
10038: }
10039:
1.813 albertel 10040: sub is_course {
1.1167 droeschl 10041: my ($cdom, $cnum) = scalar(@_) == 1 ?
10042: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
10043:
10044: return unless $cdom and $cnum;
10045:
10046: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
10047: '.');
10048:
1.1219 raeburn 10049: return unless(exists($courses{$cdom.'_'.$cnum}));
1.1167 droeschl 10050: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 10051: }
10052:
1.1015 raeburn 10053: sub store_userdata {
10054: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 10055: my $result;
1.1016 raeburn 10056: if ($datakey ne '') {
1.1013 raeburn 10057: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 10058: if ($udom eq '' || $uname eq '') {
10059: $udom = $env{'user.domain'};
10060: $uname = $env{'user.name'};
10061: }
10062: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 10063: if (($uhome eq '') || ($uhome eq 'no_host')) {
10064: $result = 'error: no_host';
10065: } else {
10066: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
10067: $storehash->{'host'} = $perlvar{'lonHostID'};
10068:
10069: my $namevalue='';
10070: foreach my $key (keys(%{$storehash})) {
10071: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
10072: }
10073: $namevalue=~s/\&$//;
1.1224 raeburn 10074: unless ($namespace eq 'courserequests') {
10075: $datakey = &escape($datakey);
10076: }
1.1105 raeburn 10077: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
10078: $namevalue,$uhome);
1.1013 raeburn 10079: }
10080: } else {
10081: $result = 'error: data to store was not a hash reference';
10082: }
10083: } else {
10084: $result= 'error: invalid requestkey';
10085: }
10086: return $result;
10087: }
10088:
1.21 www 10089: # ---------------------------------------------------------- Assign Custom Role
10090:
10091: sub assigncustomrole {
1.957 raeburn 10092: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 10093: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 10094: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 10095: }
10096:
10097: # ----------------------------------------------------------------- Revoke Role
10098:
10099: sub revokerole {
1.957 raeburn 10100: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 10101: my $now=time;
1.965 raeburn 10102: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 10103: }
10104:
10105: # ---------------------------------------------------------- Revoke Custom Role
10106:
10107: sub revokecustomrole {
1.957 raeburn 10108: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 10109: my $now=time;
1.357 www 10110: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 10111: $deleteflag,$selfenroll,$context);
1.17 www 10112: }
10113:
1.533 banghart 10114: # ------------------------------------------------------------ Disk usage
1.535 albertel 10115: sub diskusage {
1.955 raeburn 10116: my ($udom,$uname,$directorypath,$getpropath)=@_;
10117: $directorypath =~ s/\/$//;
10118: my $listing=&reply('du2:'.&escape($directorypath).':'
10119: .&escape($getpropath).':'.&escape($uname).':'
10120: .&escape($udom),homeserver($uname,$udom));
10121: if ($listing eq 'unknown_cmd') {
10122: if ($getpropath) {
10123: $directorypath = &propath($udom,$uname).'/'.$directorypath;
10124: }
10125: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
10126: }
1.514 albertel 10127: return $listing;
1.512 banghart 10128: }
10129:
1.566 banghart 10130: sub is_locked {
1.1096 raeburn 10131: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 10132: my @check;
10133: my $is_locked;
1.1093 raeburn 10134: push (@check,$file_name);
1.613 albertel 10135: my %locked = &get('file_permissions',\@check,
1.620 albertel 10136: $env{'user.domain'},$env{'user.name'});
1.615 albertel 10137: my ($tmp)=keys(%locked);
10138: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 10139:
1.566 banghart 10140: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 10141: $is_locked = 'false';
10142: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 10143: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 10144: $is_locked = 'true';
1.1096 raeburn 10145: if (ref($which) eq 'ARRAY') {
10146: push(@{$which},$entry);
10147: } else {
10148: last;
10149: }
1.745 raeburn 10150: }
10151: }
1.566 banghart 10152: } else {
10153: $is_locked = 'false';
10154: }
1.1093 raeburn 10155: return $is_locked;
1.566 banghart 10156: }
10157:
1.759 albertel 10158: sub declutter_portfile {
10159: my ($file) = @_;
1.833 albertel 10160: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 10161: return $file;
10162: }
10163:
1.559 banghart 10164: # ------------------------------------------------------------- Mark as Read Only
10165:
10166: sub mark_as_readonly {
10167: my ($domain,$user,$files,$what) = @_;
1.613 albertel 10168: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 10169: my ($tmp)=keys(%current_permissions);
10170: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 10171: foreach my $file (@{$files}) {
1.759 albertel 10172: $file = &declutter_portfile($file);
1.561 banghart 10173: push(@{$current_permissions{$file}},$what);
1.559 banghart 10174: }
1.613 albertel 10175: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 10176: return;
10177: }
10178:
1.572 banghart 10179: # ------------------------------------------------------------Save Selected Files
10180:
10181: sub save_selected_files {
10182: my ($user, $path, @files) = @_;
10183: my $filename = $user."savedfiles";
1.573 banghart 10184: my @other_files = &files_not_in_path($user, $path);
1.1359 raeburn 10185: open (OUT,'>',LONCAPA::tempdir().$filename);
1.573 banghart 10186: foreach my $file (@files) {
1.620 albertel 10187: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 10188: }
10189: foreach my $file (@other_files) {
1.574 banghart 10190: print (OUT $file."\n");
1.572 banghart 10191: }
1.574 banghart 10192: close (OUT);
1.572 banghart 10193: return 'ok';
10194: }
10195:
1.574 banghart 10196: sub clear_selected_files {
10197: my ($user) = @_;
10198: my $filename = $user."savedfiles";
1.1359 raeburn 10199: open (OUT,'>',LONCAPA::tempdir().$filename);
1.574 banghart 10200: print (OUT undef);
10201: close (OUT);
10202: return ("ok");
10203: }
10204:
1.572 banghart 10205: sub files_in_path {
10206: my ($user, $path) = @_;
10207: my $filename = $user."savedfiles";
10208: my %return_files;
1.1359 raeburn 10209: open (IN,'<',LONCAPA::tempdir().$filename);
1.573 banghart 10210: while (my $line_in = <IN>) {
1.574 banghart 10211: chomp ($line_in);
10212: my @paths_and_file = split (m!/!, $line_in);
10213: my $file_part = pop (@paths_and_file);
10214: my $path_part = join ('/', @paths_and_file);
1.573 banghart 10215: $path_part.='/';
10216: my $path_and_file = $path_part.$file_part;
10217: if ($path_part eq $path) {
10218: $return_files{$file_part}= 'selected';
10219: }
10220: }
1.574 banghart 10221: close (IN);
10222: return (\%return_files);
1.572 banghart 10223: }
10224:
10225: # called in portfolio select mode, to show files selected NOT in current directory
10226: sub files_not_in_path {
10227: my ($user, $path) = @_;
10228: my $filename = $user."savedfiles";
10229: my @return_files;
10230: my $path_part;
1.1359 raeburn 10231: open(IN, '<',LONCAPA::tempdir().$filename);
1.800 albertel 10232: while (my $line = <IN>) {
1.572 banghart 10233: #ok, I know it's clunky, but I want it to work
1.800 albertel 10234: my @paths_and_file = split(m|/|, $line);
10235: my $file_part = pop(@paths_and_file);
10236: chomp($file_part);
10237: my $path_part = join('/', @paths_and_file);
1.572 banghart 10238: $path_part .= '/';
10239: my $path_and_file = $path_part.$file_part;
10240: if ($path_part ne $path) {
1.800 albertel 10241: push(@return_files, ($path_and_file));
1.572 banghart 10242: }
10243: }
1.800 albertel 10244: close(OUT);
1.574 banghart 10245: return (@return_files);
1.572 banghart 10246: }
10247:
1.1273 raeburn 10248: #------------------------------Submitted/Handedback Portfolio Files Versioning
10249:
10250: sub portfiles_versioning {
10251: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
10252: my $portfolio_root = '/userfiles/portfolio';
10253: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
10254: foreach my $file (@{$portfiles}) {
10255: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
10256: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
10257: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
10258: my $getpropath = 1;
10259: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
10260: $stu_name,$getpropath);
10261: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
10262: my $new_answer =
10263: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
10264: if ($new_answer ne 'problem getting file') {
10265: push(@{$versioned_portfiles}, $directory.$new_answer);
10266: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
10267: [$symb,$env{'request.course.id'},'graded']);
10268: }
10269: }
10270: }
10271:
10272: sub get_next_version {
10273: my ($answer_name, $answer_ext, $dir_list) = @_;
10274: my $version;
10275: if (ref($dir_list) eq 'ARRAY') {
10276: foreach my $row (@{$dir_list}) {
10277: my ($file) = split(/\&/,$row,2);
10278: my ($file_name,$file_version,$file_ext) =
10279: &file_name_version_ext($file);
10280: if (($file_name eq $answer_name) &&
10281: ($file_ext eq $answer_ext)) {
10282: # gets here if filename and extension match,
10283: # regardless of version
10284: if ($file_version ne '') {
10285: # a versioned file is found so save it for later
10286: if ($file_version > $version) {
10287: $version = $file_version;
10288: }
10289: }
10290: }
10291: }
10292: }
10293: $version ++;
10294: return($version);
10295: }
10296:
10297: sub version_selected_portfile {
10298: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
10299: my ($answer_name,$answer_ver,$answer_ext) =
10300: &file_name_version_ext($file_name);
10301: my $new_answer;
10302: $env{'form.copy'} =
10303: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
10304: if($env{'form.copy'} eq '-1') {
10305: $new_answer = 'problem getting file';
10306: } else {
10307: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
10308: my $copy_result =
10309: &finishuserfileupload($stu_name,$domain,'copy',
10310: '/portfolio'.$directory.$new_answer);
10311: }
10312: undef($env{'form.copy'});
10313: return ($new_answer);
10314: }
10315:
10316: sub file_name_version_ext {
10317: my ($file)=@_;
10318: my @file_parts = split(/\./, $file);
10319: my ($name,$version,$ext);
10320: if (@file_parts > 1) {
10321: $ext=pop(@file_parts);
10322: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
10323: $version=pop(@file_parts);
10324: }
10325: $name=join('.',@file_parts);
10326: } else {
10327: $name=join('.',@file_parts);
10328: }
10329: return($name,$version,$ext);
10330: }
10331:
1.745 raeburn 10332: #----------------------------------------------Get portfolio file permissions
1.629 banghart 10333:
1.745 raeburn 10334: sub get_portfile_permissions {
10335: my ($domain,$user) = @_;
1.613 albertel 10336: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 10337: my ($tmp)=keys(%current_permissions);
10338: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 10339: return \%current_permissions;
10340: }
10341:
10342: #---------------------------------------------Get portfolio file access controls
10343:
1.749 raeburn 10344: sub get_access_controls {
1.745 raeburn 10345: my ($current_permissions,$group,$file) = @_;
1.769 albertel 10346: my %access;
10347: my $real_file = $file;
10348: $file =~ s/\.meta$//;
1.745 raeburn 10349: if (defined($file)) {
1.749 raeburn 10350: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
10351: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 10352: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 10353: }
10354: }
1.745 raeburn 10355: } else {
1.749 raeburn 10356: foreach my $key (keys(%{$current_permissions})) {
10357: if ($key =~ /\0accesscontrol$/) {
10358: if (defined($group)) {
10359: if ($key !~ m-^\Q$group\E/-) {
10360: next;
10361: }
10362: }
10363: my ($fullpath) = split(/\0/,$key);
10364: if (ref($$current_permissions{$key}) eq 'HASH') {
10365: foreach my $control (keys(%{$$current_permissions{$key}})) {
10366: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
10367: }
10368: }
10369: }
10370: }
10371: }
10372: return %access;
10373: }
10374:
10375: sub modify_access_controls {
10376: my ($file_name,$changes,$domain,$user)=@_;
10377: my ($outcome,$deloutcome);
10378: my %store_permissions;
10379: my %new_values;
10380: my %new_control;
10381: my %translation;
10382: my @deletions = ();
10383: my $now = time;
10384: if (exists($$changes{'activate'})) {
10385: if (ref($$changes{'activate'}) eq 'HASH') {
10386: my @newitems = sort(keys(%{$$changes{'activate'}}));
10387: my $numnew = scalar(@newitems);
10388: for (my $i=0; $i<$numnew; $i++) {
10389: my $newkey = $newitems[$i];
10390: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 10391: if ($newkey =~ /^\d+:/) {
10392: $newkey =~ s/^(\d+)/$newid/;
10393: $translation{$1} = $newid;
10394: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
10395: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
10396: $translation{$1} = $newid;
10397: }
1.749 raeburn 10398: $new_values{$file_name."\0".$newkey} =
10399: $$changes{'activate'}{$newitems[$i]};
10400: $new_control{$newkey} = $now;
10401: }
10402: }
10403: }
10404: my %todelete;
10405: my %changed_items;
10406: foreach my $action ('delete','update') {
10407: if (exists($$changes{$action})) {
10408: if (ref($$changes{$action}) eq 'HASH') {
10409: foreach my $key (keys(%{$$changes{$action}})) {
10410: my ($itemnum) = ($key =~ /^([^:]+):/);
10411: if ($action eq 'delete') {
10412: $todelete{$itemnum} = 1;
10413: } else {
10414: $changed_items{$itemnum} = $key;
10415: }
10416: }
1.745 raeburn 10417: }
10418: }
1.749 raeburn 10419: }
10420: # get lock on access controls for file.
10421: my $lockhash = {
10422: $file_name."\0".'locked_access_records' => $env{'user.name'}.
10423: ':'.$env{'user.domain'},
10424: };
10425: my $tries = 0;
10426: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10427:
1.1288 damieng 10428: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 10429: $tries ++;
1.1289 damieng 10430: sleep(0.1);
1.749 raeburn 10431: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10432: }
10433: if ($gotlock eq 'ok') {
10434: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
10435: my ($tmp)=keys(%curr_permissions);
10436: if ($tmp=~/^error:/) { undef(%curr_permissions); }
10437: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
10438: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
10439: if (ref($curr_controls) eq 'HASH') {
10440: foreach my $control_item (keys(%{$curr_controls})) {
10441: my ($itemnum) = ($control_item =~ /^([^:]+):/);
10442: if (defined($todelete{$itemnum})) {
10443: push(@deletions,$file_name."\0".$control_item);
10444: } else {
10445: if (defined($changed_items{$itemnum})) {
10446: $new_control{$changed_items{$itemnum}} = $now;
10447: push(@deletions,$file_name."\0".$control_item);
10448: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
10449: } else {
10450: $new_control{$control_item} = $$curr_controls{$control_item};
10451: }
10452: }
1.745 raeburn 10453: }
10454: }
10455: }
1.970 raeburn 10456: my ($group);
10457: if (&is_course($domain,$user)) {
10458: ($group,my $file) = split(/\//,$file_name,2);
10459: }
1.749 raeburn 10460: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
10461: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
10462: $outcome = &put('file_permissions',\%new_values,$domain,$user);
10463: # remove lock
10464: my @del_lock = ($file_name."\0".'locked_access_records');
10465: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 10466: my $sqlresult =
1.970 raeburn 10467: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 10468: $group);
1.749 raeburn 10469: } else {
10470: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 10471: }
1.749 raeburn 10472: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 10473: }
10474:
1.827 raeburn 10475: sub make_public_indefinitely {
1.1271 raeburn 10476: my (@requrl) = @_;
10477: return &automated_portfile_access('public',\@requrl);
10478: }
10479:
10480: sub automated_portfile_access {
10481: my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273 raeburn 10482: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
10483: return 'invalid';
10484: }
1.1271 raeburn 10485: my %urls;
10486: if (ref($addsref) eq 'ARRAY') {
10487: foreach my $requrl (@{$addsref}) {
10488: if (&is_portfolio_url($requrl)) {
10489: unless (exists($urls{$requrl})) {
10490: $urls{$requrl} = 'add';
10491: }
10492: }
10493: }
10494: }
10495: if (ref($delsref) eq 'ARRAY') {
10496: foreach my $requrl (@{$delsref}) {
10497: if (&is_portfolio_url($requrl)) {
10498: unless (exists($urls{$requrl})) {
10499: $urls{$requrl} = 'delete';
10500: }
10501: }
10502: }
10503: }
10504: unless (keys(%urls)) {
10505: return 'invalid';
10506: }
10507: my $ip;
10508: if ($accesstype eq 'ip') {
10509: if (ref($info) eq 'HASH') {
10510: if ($info->{'ip'} ne '') {
10511: $ip = $info->{'ip'};
10512: }
10513: }
10514: if ($ip eq '') {
10515: return 'invalid';
10516: }
10517: }
10518: my $errors;
1.827 raeburn 10519: my $now = time;
1.1271 raeburn 10520: my %current_perms;
10521: foreach my $requrl (sort(keys(%urls))) {
10522: my $action;
10523: if ($urls{$requrl} eq 'add') {
10524: $action = 'activate';
10525: } else {
10526: $action = 'none';
10527: }
10528: my $aclnum = 0;
1.827 raeburn 10529: my (undef,$udom,$unum,$file_name,$group) =
10530: &parse_portfolio_url($requrl);
1.1271 raeburn 10531: unless (exists($current_perms{$unum.':'.$udom})) {
10532: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
10533: }
10534: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827 raeburn 10535: $group,$file_name);
10536: foreach my $key (keys(%{$access_controls{$file_name}})) {
10537: my ($num,$scope,$end,$start) =
10538: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271 raeburn 10539: if ($scope eq $accesstype) {
10540: if (($start <= $now) && ($end == 0)) {
10541: if ($accesstype eq 'ip') {
10542: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
10543: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
10544: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
10545: if ($urls{$requrl} eq 'add') {
10546: $action = 'none';
10547: last;
10548: } else {
10549: $action = 'delete';
10550: $aclnum = $num;
10551: last;
10552: }
10553: }
10554: }
10555: }
10556: } elsif ($accesstype eq 'public') {
10557: if ($urls{$requrl} eq 'add') {
10558: $action = 'none';
10559: last;
10560: } else {
10561: $action = 'delete';
10562: $aclnum = $num;
10563: last;
10564: }
10565: }
10566: } elsif ($accesstype eq 'public') {
1.827 raeburn 10567: $action = 'update';
10568: $aclnum = $num;
1.1271 raeburn 10569: last;
1.827 raeburn 10570: }
10571: }
10572: }
10573: if ($action eq 'none') {
1.1271 raeburn 10574: next;
1.827 raeburn 10575: } else {
10576: my %changes;
10577: my $newend = 0;
10578: my $newstart = $now;
1.1271 raeburn 10579: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827 raeburn 10580: $changes{$action}{$newkey} = {
1.1271 raeburn 10581: type => $accesstype,
1.827 raeburn 10582: time => {
10583: start => $newstart,
10584: end => $newend,
10585: },
10586: };
1.1271 raeburn 10587: if ($accesstype eq 'ip') {
10588: $changes{$action}{$newkey}{'ip'} = [$ip];
10589: }
1.827 raeburn 10590: my ($outcome,$deloutcome,$new_values,$translation) =
10591: &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271 raeburn 10592: unless ($outcome eq 'ok') {
10593: $errors .= $outcome.' ';
10594: }
1.827 raeburn 10595: }
1.1271 raeburn 10596: }
10597: if ($errors) {
10598: $errors =~ s/\s$//;
10599: return $errors;
1.827 raeburn 10600: } else {
1.1271 raeburn 10601: return 'ok';
1.827 raeburn 10602: }
10603: }
10604:
1.745 raeburn 10605: #------------------------------------------------------Get Marked as Read Only
10606:
10607: sub get_marked_as_readonly {
10608: my ($domain,$user,$what,$group) = @_;
10609: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 10610: my @readonly_files;
1.629 banghart 10611: my $cmp1=$what;
10612: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 10613: while (my ($file_name,$value) = each(%{$current_permissions})) {
10614: if (defined($group)) {
10615: if ($file_name !~ m-^\Q$group\E/-) {
10616: next;
10617: }
10618: }
1.561 banghart 10619: if (ref($value) eq "ARRAY"){
10620: foreach my $stored_what (@{$value}) {
1.629 banghart 10621: my $cmp2=$stored_what;
1.759 albertel 10622: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 10623: $cmp2=join('',@{$stored_what});
1.745 raeburn 10624: }
1.629 banghart 10625: if ($cmp1 eq $cmp2) {
1.561 banghart 10626: push(@readonly_files, $file_name);
1.745 raeburn 10627: last;
1.563 banghart 10628: } elsif (!defined($what)) {
10629: push(@readonly_files, $file_name);
1.745 raeburn 10630: last;
1.561 banghart 10631: }
10632: }
1.745 raeburn 10633: }
1.561 banghart 10634: }
10635: return @readonly_files;
10636: }
1.577 banghart 10637: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 10638:
1.577 banghart 10639: sub get_marked_as_readonly_hash {
1.745 raeburn 10640: my ($current_permissions,$group,$what) = @_;
1.577 banghart 10641: my %readonly_files;
1.745 raeburn 10642: while (my ($file_name,$value) = each(%{$current_permissions})) {
10643: if (defined($group)) {
10644: if ($file_name !~ m-^\Q$group\E/-) {
10645: next;
10646: }
10647: }
1.577 banghart 10648: if (ref($value) eq "ARRAY"){
10649: foreach my $stored_what (@{$value}) {
1.745 raeburn 10650: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 10651: foreach my $lock_descriptor(@{$stored_what}) {
10652: if ($lock_descriptor eq 'graded') {
10653: $readonly_files{$file_name} = 'graded';
10654: } elsif ($lock_descriptor eq 'handback') {
10655: $readonly_files{$file_name} = 'handback';
10656: } else {
10657: if (!exists($readonly_files{$file_name})) {
10658: $readonly_files{$file_name} = 'locked';
10659: }
10660: }
1.745 raeburn 10661: }
1.750 banghart 10662: }
1.577 banghart 10663: }
10664: }
10665: }
10666: return %readonly_files;
10667: }
1.559 banghart 10668: # ------------------------------------------------------------ Unmark as Read Only
10669:
10670: sub unmark_as_readonly {
1.629 banghart 10671: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10672: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 10673: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 10674: $file_name = &declutter_portfile($file_name);
1.634 albertel 10675: my $symb_crs = $what;
10676: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 10677: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 10678: my ($tmp)=keys(%current_permissions);
10679: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 10680: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 10681: foreach my $file (@readonly_files) {
1.759 albertel 10682: my $clean_file = &declutter_portfile($file);
10683: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 10684: my $current_locks = $current_permissions{$file};
1.563 banghart 10685: my @new_locks;
10686: my @del_keys;
10687: if (ref($current_locks) eq "ARRAY"){
10688: foreach my $locker (@{$current_locks}) {
1.632 albertel 10689: my $compare=$locker;
1.749 raeburn 10690: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 10691: $compare=join('',@{$locker});
1.746 raeburn 10692: if ($compare ne $symb_crs) {
10693: push(@new_locks, $locker);
10694: }
1.563 banghart 10695: }
10696: }
1.650 albertel 10697: if (scalar(@new_locks) > 0) {
1.563 banghart 10698: $current_permissions{$file} = \@new_locks;
10699: } else {
10700: push(@del_keys, $file);
1.613 albertel 10701: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 10702: delete($current_permissions{$file});
1.563 banghart 10703: }
10704: }
1.561 banghart 10705: }
1.613 albertel 10706: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 10707: return;
10708: }
1.512 banghart 10709:
1.17 www 10710: # ------------------------------------------------------------ Directory lister
10711:
10712: sub dirlist {
1.955 raeburn 10713: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 10714: $uri=~s/^\///;
10715: $uri=~s/\/$//;
1.253 stredwic 10716: my ($udom, $uname);
1.955 raeburn 10717: if ($getuserdir) {
1.253 stredwic 10718: $udom = $userdomain;
10719: $uname = $username;
1.955 raeburn 10720: } else {
10721: (undef,$udom,$uname)=split(/\//,$uri);
10722: if(defined($userdomain)) {
10723: $udom = $userdomain;
10724: }
10725: if(defined($username)) {
10726: $uname = $username;
10727: }
1.253 stredwic 10728: }
1.955 raeburn 10729: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 10730:
1.955 raeburn 10731: $dirRoot = $perlvar{'lonDocRoot'};
10732: if (defined($getpropath)) {
10733: $dirRoot = &propath($udom,$uname);
1.253 stredwic 10734: $dirRoot =~ s/\/$//;
1.955 raeburn 10735: } elsif (defined($getuserdir)) {
10736: my $subdir=$uname.'__';
10737: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10738: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10739: ."/$udom/$subdir/$uname";
10740: } elsif (defined($alternateRoot)) {
10741: $dirRoot = $alternateRoot;
1.751 banghart 10742: }
1.253 stredwic 10743:
10744: if($udom) {
10745: if($uname) {
1.1135 raeburn 10746: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 10747: if ($uhome eq 'no_host') {
10748: return ([],'no_host');
10749: }
1.955 raeburn 10750: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 10751: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 10752: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 10753: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10754: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 10755: } else {
10756: @listing_results = map { &unescape($_); } split(/:/,$listing);
10757: }
1.605 matthew 10758: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10759: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 10760: @listing_results = split(/:/,$listing);
10761: } else {
10762: @listing_results = map { &unescape($_); } split(/:/,$listing);
10763: }
1.1135 raeburn 10764: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 10765: ($listing eq 'rejected') || ($listing eq 'refused') ||
10766: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10767: return ([],$listing);
10768: } else {
10769: return (\@listing_results);
1.1135 raeburn 10770: }
1.955 raeburn 10771: } elsif(!$alternateRoot) {
1.1136 raeburn 10772: my (%allusers,%listerror);
1.841 albertel 10773: my %servers = &get_servers($udom,'library');
1.955 raeburn 10774: foreach my $tryserver (keys(%servers)) {
10775: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10776: &escape($udom),$tryserver);
10777: if ($listing eq 'unknown_cmd') {
10778: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10779: $udom, $tryserver);
10780: } else {
10781: @listing_results = map { &unescape($_); } split(/:/,$listing);
10782: }
1.841 albertel 10783: if ($listing eq 'unknown_cmd') {
10784: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10785: $udom, $tryserver);
10786: @listing_results = split(/:/,$listing);
10787: } else {
10788: @listing_results =
10789: map { &unescape($_); } split(/:/,$listing);
10790: }
1.1136 raeburn 10791: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10792: ($listing eq 'rejected') || ($listing eq 'refused') ||
10793: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10794: $listerror{$tryserver} = $listing;
10795: } else {
1.841 albertel 10796: foreach my $line (@listing_results) {
10797: my ($entry) = split(/&/,$line,2);
10798: $allusers{$entry} = 1;
10799: }
10800: }
1.253 stredwic 10801: }
1.1136 raeburn 10802: my @alluserslist=();
1.800 albertel 10803: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 10804: push(@alluserslist,$user.'&user');
1.253 stredwic 10805: }
1.1318 droeschl 10806:
10807: if (!%listerror) {
10808: # no errors
10809: return (\@alluserslist);
10810: } elsif (scalar(keys(%servers)) == 1) {
10811: # one library server, one error
10812: my ($key) = keys(%listerror);
10813: return (\@alluserslist, $listerror{$key});
10814: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
10815: # con_lost indicates that we might miss data from at least one
10816: # library server
10817: return (\@alluserslist, 'con_lost');
10818: } else {
10819: # multiple library servers and no con_lost -> data should be
10820: # complete.
10821: return (\@alluserslist);
10822: }
10823:
1.253 stredwic 10824: } else {
1.1136 raeburn 10825: return ([],'missing username');
1.253 stredwic 10826: }
1.955 raeburn 10827: } elsif(!defined($getpropath)) {
1.1136 raeburn 10828: my $path = $perlvar{'lonDocRoot'}.'/res/';
10829: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10830: return (\@all_domains);
1.955 raeburn 10831: } else {
1.1136 raeburn 10832: return ([],'missing domain');
1.275 stredwic 10833: }
10834: }
10835:
10836: # --------------------------------------------- GetFileTimestamp
10837: # This function utilizes dirlist and returns the date stamp for
10838: # when it was last modified. It will also return an error of -1
10839: # if an error occurs
10840:
10841: sub GetFileTimestamp {
1.955 raeburn 10842: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 10843: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10844: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 10845: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10846: undef,$getuserdir);
10847: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10848: return -1;
10849: }
10850: if (ref($fileref) eq 'ARRAY') {
10851: my @stats = split('&',$fileref->[0]);
1.375 matthew 10852: # @stats contains first the filename, then the stat output
10853: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 10854: } else {
10855: return -1;
1.253 stredwic 10856: }
1.26 www 10857: }
10858:
1.712 albertel 10859: sub stat_file {
10860: my ($uri) = @_;
1.787 albertel 10861: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 10862:
1.955 raeburn 10863: my ($udom,$uname,$file);
1.712 albertel 10864: if ($uri =~ m-^/(uploaded|editupload)/-) {
10865: ($udom,$uname,$file) =
1.811 albertel 10866: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 10867: $file = 'userfiles/'.$file;
10868: }
10869: if ($uri =~ m-^/res/-) {
10870: ($udom,$uname) =
1.807 albertel 10871: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 10872: $file = $uri;
10873: }
10874:
10875: if (!$udom || !$uname || !$file) {
10876: # unable to handle the uri
10877: return ();
10878: }
1.956 raeburn 10879: my $getpropath;
10880: if ($file =~ /^userfiles\//) {
10881: $getpropath = 1;
10882: }
1.1136 raeburn 10883: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10884: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10885: return ();
10886: } else {
10887: if (ref($listref) eq 'ARRAY') {
10888: my @stats = split('&',$listref->[0]);
10889: shift(@stats); #filename is first
10890: return @stats;
10891: }
1.712 albertel 10892: }
10893: return ();
10894: }
10895:
1.1313 raeburn 10896: # --------------------------------------------------------- recursedirs
10897: # Recursive function to traverse either a specific user's Authoring Space
10898: # or corresponding Published Resource Space, and populate the hash ref:
10899: # $dirhashref with URLs of all directories, and if $filehashref hash
10900: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
10901: # or .rights files in resource space, and .meta, .save, .log, and .bak
10902: # files in Authoring Space.
10903: #
10904: # Inputs:
10905: #
10906: # $is_home - true if current server is home server for user's space
10907: # $context - either: priv, or res respectively for Authoring or Resource Space.
10908: # $docroot - Document root (i.e., /home/httpd/html
10909: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
10910: # $relpath - Current path (relative to top level).
10911: # $dirhashref - reference to hash to populate with URLs of directories (Required)
10912: # $filehashref - reference to hash to populate with URLs of files (Optional)
10913: #
10914: # Returns: nothing
10915: #
10916: # Side Effects: populates $dirhashref, and $filehashref (if provided).
10917: #
10918: # Currently used by interface/londocs.pm to create linked select boxes for
10919: # directory and filename to import a Course "Author" resource into a course, and
10920: # also to create linked select boxes for Authoring Space and Directory to choose
10921: # save location for creation of a new "standard" problem from the Course Editor.
10922: #
10923:
10924: sub recursedirs {
10925: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
10926: return unless (ref($dirhashref) eq 'HASH');
10927: my $currpath = $docroot.$toppath;
10928: if ($relpath) {
10929: $currpath .= "/$relpath";
10930: }
10931: my $savefile;
10932: if (ref($filehashref)) {
10933: $savefile = 1;
10934: }
10935: if ($is_home) {
10936: if (opendir(my $dirh,$currpath)) {
10937: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
10938: next if ($item eq '');
10939: if (-d "$currpath/$item") {
10940: my $newpath;
10941: if ($relpath) {
10942: $newpath = "$relpath/$item";
10943: } else {
10944: $newpath = $item;
10945: }
10946: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10947: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10948: } elsif ($savefile) {
10949: if ($context eq 'priv') {
10950: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10951: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10952: }
10953: } else {
10954: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
10955: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10956: }
10957: }
10958: }
10959: }
10960: closedir($dirh);
10961: }
10962: } else {
10963: my ($dirlistref,$listerror) =
10964: &dirlist($toppath.$relpath);
10965: my @dir_lines;
10966: my $dirptr=16384;
10967: if (ref($dirlistref) eq 'ARRAY') {
10968: foreach my $dir_line (sort
10969: {
10970: my ($afile)=split('&',$a,2);
10971: my ($bfile)=split('&',$b,2);
10972: return (lc($afile) cmp lc($bfile));
10973: } (@{$dirlistref})) {
10974: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
10975: split(/\&/,$dir_line,16);
10976: $item =~ s/\s+$//;
10977: next if (($item =~ /^\.\.?$/) || ($obs));
10978: if ($dirptr&$testdir) {
10979: my $newpath;
10980: if ($relpath) {
10981: $newpath = "$relpath/$item";
10982: } else {
10983: $relpath = '/';
10984: $newpath = $item;
10985: }
10986: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10987: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10988: } elsif ($savefile) {
10989: if ($context eq 'priv') {
10990: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10991: $filehashref->{$relpath}{$item} = 1;
10992: }
10993: } else {
10994: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
10995: $filehashref->{$relpath}{$item} = 1;
10996: }
10997: }
10998: }
10999: }
11000: }
11001: }
11002: return;
11003: }
11004:
1.26 www 11005: # -------------------------------------------------------- Value of a Condition
11006:
1.713 albertel 11007: # gets the value of a specific preevaluated condition
11008: # stored in the string $env{user.state.<cid>}
11009: # or looks up a condition reference in the bighash and if if hasn't
11010: # already been evaluated recurses into docondval to get the value of
11011: # the condition, then memoizing it to
11012: # $env{user.state.<cid>.<condition>}
1.40 www 11013: sub directcondval {
11014: my $number=shift;
1.620 albertel 11015: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 11016: &Apache::lonuserstate::evalstate();
11017: }
1.713 albertel 11018: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
11019: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
11020: } elsif ($number =~ /^_/) {
11021: my $sub_condition;
11022: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11023: &GDBM_READER(),0640)) {
11024: $sub_condition=$bighash{'conditions'.$number};
11025: untie(%bighash);
11026: }
11027: my $value = &docondval($sub_condition);
1.949 raeburn 11028: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 11029: return $value;
11030: }
1.620 albertel 11031: if ($env{'user.state.'.$env{'request.course.id'}}) {
11032: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 11033: } else {
11034: return 2;
11035: }
11036: }
11037:
1.713 albertel 11038: # get the collection of conditions for this resource
1.26 www 11039: sub condval {
11040: my $condidx=shift;
1.54 www 11041: my $allpathcond='';
1.713 albertel 11042: foreach my $cond (split(/\|/,$condidx)) {
11043: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
11044: $allpathcond.=
11045: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
11046: }
1.191 harris41 11047: }
1.54 www 11048: $allpathcond=~s/\|$//;
1.713 albertel 11049: return &docondval($allpathcond);
11050: }
11051:
11052: #evaluates an expression of conditions
11053: sub docondval {
11054: my ($allpathcond) = @_;
11055: my $result=0;
11056: if ($env{'request.course.id'}
11057: && defined($allpathcond)) {
11058: my $operand='|';
11059: my @stack;
11060: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
11061: if ($chunk eq '(') {
11062: push @stack,($operand,$result);
11063: } elsif ($chunk eq ')') {
11064: my $before=pop @stack;
11065: if (pop @stack eq '&') {
11066: $result=$result>$before?$before:$result;
11067: } else {
11068: $result=$result>$before?$result:$before;
11069: }
11070: } elsif (($chunk eq '&') || ($chunk eq '|')) {
11071: $operand=$chunk;
11072: } else {
11073: my $new=directcondval($chunk);
11074: if ($operand eq '&') {
11075: $result=$result>$new?$new:$result;
11076: } else {
11077: $result=$result>$new?$result:$new;
11078: }
11079: }
11080: }
1.26 www 11081: }
11082: return $result;
1.421 albertel 11083: }
11084:
11085: # ---------------------------------------------------- Devalidate courseresdata
11086:
11087: sub devalidatecourseresdata {
11088: my ($coursenum,$coursedomain)=@_;
11089: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 11090: &devalidate_cache_new('courseres',$hashid);
1.28 www 11091: }
11092:
1.763 www 11093:
1.200 www 11094: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 11095: #
11096: # Parameters:
11097: # $coursenum - Number of the course.
11098: # $coursedomain - Domain at which the course was created.
11099: # Returns:
11100: # A hash of the course parameters along (I think) with timestamps
11101: # and version info.
1.877 foxr 11102:
1.624 albertel 11103: sub get_courseresdata {
11104: my ($coursenum,$coursedomain)=@_;
1.200 www 11105: my $coursehom=&homeserver($coursenum,$coursedomain);
11106: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 11107: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 11108: my %dumpreply;
1.417 albertel 11109: unless (defined($cached)) {
1.624 albertel 11110: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 11111: $result=\%dumpreply;
1.251 albertel 11112: my ($tmp) = keys(%dumpreply);
11113: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 11114: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 11115: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
11116: return $tmp;
1.416 albertel 11117: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 11118: $result=undef;
1.599 albertel 11119: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 11120: }
11121: }
1.624 albertel 11122: return $result;
11123: }
11124:
1.633 albertel 11125: sub devalidateuserresdata {
11126: my ($uname,$udom)=@_;
11127: my $hashid="$udom:$uname";
11128: &devalidate_cache_new('userres',$hashid);
11129: }
11130:
1.624 albertel 11131: sub get_userresdata {
11132: my ($uname,$udom)=@_;
11133: #most student don\'t have any data set, check if there is some data
11134: if (&EXT_cache_status($udom,$uname)) { return undef; }
11135:
11136: my $hashid="$udom:$uname";
11137: my ($result,$cached)=&is_cached_new('userres',$hashid);
11138: if (!defined($cached)) {
11139: my %resourcedata=&dump('resourcedata',$udom,$uname);
11140: $result=\%resourcedata;
11141: &do_cache_new('userres',$hashid,$result,600);
11142: }
11143: my ($tmp)=keys(%$result);
11144: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
11145: return $result;
11146: }
11147: #error 2 occurs when the .db doesn't exist
11148: if ($tmp!~/error: 2 /) {
1.1294 raeburn 11149: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
11150: &logthis("<font color=\"blue\">WARNING:".
11151: " Trying to get resource data for ".
11152: $uname." at ".$udom.": ".
11153: $tmp."</font>");
11154: }
1.624 albertel 11155: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 11156: #&EXT_cache_set($udom,$uname);
11157: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 11158: undef($tmp); # not really an error so don't send it back
1.624 albertel 11159: }
11160: return $tmp;
11161: }
1.879 foxr 11162: #----------------------------------------------- resdata - return resource data
11163: # Purpose:
11164: # Return resource data for either users or for a course.
11165: # Parameters:
11166: # $name - Course/user name.
11167: # $domain - Name of the domain the user/course is registered on.
1.1311 raeburn 11168: # $type - Type of thing $name is (must be 'course' or 'user')
1.1301 raeburn 11169: # $mapp - decluttered URL of enclosing map
11170: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
11171: # $recurseup - Ref to array of map URLs, starting with map containing
11172: # $mapp up through hierarchy of nested maps to top level map.
11173: # $courseid - CourseID (first part of param identifier).
11174: # $modifier - Middle part of param identifier.
11175: # $what - Last part of param identifier.
1.879 foxr 11176: # @which - Array of names of resources desired.
11177: # Returns:
11178: # The value of the first reasource in @which that is found in the
11179: # resource hash.
11180: # Exceptional Conditions:
11181: # If the $type passed in is not valid (not the string 'course' or
11182: # 'user', an undefined reference is returned.
11183: # If none of the resources are found, an undef is returned
1.624 albertel 11184: sub resdata {
1.1301 raeburn 11185: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
11186: $modifier,$what,@which)=@_;
1.624 albertel 11187: my $result;
11188: if ($type eq 'course') {
11189: $result=&get_courseresdata($name,$domain);
11190: } elsif ($type eq 'user') {
11191: $result=&get_userresdata($name,$domain);
11192: }
11193: if (!ref($result)) { return $result; }
1.251 albertel 11194: foreach my $item (@which) {
1.1301 raeburn 11195: if ($item->[1] eq 'course') {
11196: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
11197: unless ($$recursed) {
1.1302 raeburn 11198: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
1.1301 raeburn 11199: $$recursed = 1;
11200: }
11201: foreach my $item (@${recurseup}) {
11202: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
11203: last if (defined($result->{$norecursechk}));
11204: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
11205: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
11206: }
11207: }
11208: }
11209: if (defined($result->{$item->[0]})) {
1.927 albertel 11210: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 11211: }
1.250 albertel 11212: }
1.291 albertel 11213: return undef;
1.200 www 11214: }
11215:
1.1360 raeburn 11216: sub get_domain_lti {
11217: my ($cdom,$context) = @_;
11218: my ($name,%lti);
11219: if ($context eq 'consumer') {
11220: $name = 'ltitools';
11221: } elsif ($context eq 'provider') {
11222: $name = 'lti';
11223: } else {
11224: return %lti;
11225: }
11226: my ($result,$cached)=&is_cached_new($name,$cdom);
1.1298 raeburn 11227: if (defined($cached)) {
11228: if (ref($result) eq 'HASH') {
1.1360 raeburn 11229: %lti = %{$result};
1.1298 raeburn 11230: }
11231: } else {
1.1360 raeburn 11232: my %domconfig = &get_dom('configuration',[$name],$cdom);
11233: if (ref($domconfig{$name}) eq 'HASH') {
11234: %lti = %{$domconfig{$name}};
11235: my %encdomconfig = &get_dom('encconfig',[$name],$cdom);
11236: if (ref($encdomconfig{$name}) eq 'HASH') {
11237: foreach my $id (keys(%lti)) {
11238: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
1.1344 raeburn 11239: foreach my $item ('key','secret') {
1.1360 raeburn 11240: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
1.1344 raeburn 11241: }
11242: }
11243: }
11244: }
1.1298 raeburn 11245: }
11246: my $cachetime = 24*60*60;
1.1360 raeburn 11247: &do_cache_new($name,$cdom,\%lti,$cachetime);
1.1298 raeburn 11248: }
1.1360 raeburn 11249: return %lti;
1.1298 raeburn 11250: }
11251:
1.1236 raeburn 11252: sub get_numsuppfiles {
11253: my ($cnum,$cdom,$ignorecache)=@_;
11254: my $hashid=$cnum.':'.$cdom;
11255: my ($suppcount,$cached);
11256: unless ($ignorecache) {
11257: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
11258: }
11259: unless (defined($cached)) {
11260: my $chome=&homeserver($cnum,$cdom);
11261: unless ($chome eq 'no_host') {
1.1366 raeburn 11262: ($suppcount,my $supptools,my $errors) = (0,0,0);
1.1236 raeburn 11263: my $suppmap = 'supplemental.sequence';
1.1366 raeburn 11264: ($suppcount,$supptools,$errors) =
11265: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,
11266: $supptools,$errors);
1.1236 raeburn 11267: }
11268: &do_cache_new('suppcount',$hashid,$suppcount,600);
11269: }
11270: return $suppcount;
11271: }
11272:
1.379 matthew 11273: #
11274: # EXT resource caching routines
11275: #
11276:
1.1302 raeburn 11277: {
11278: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
11279: #
11280: # The course for which we cache
11281: my $cachedmapkey='';
11282: # The cached recursive maps for this course
11283: my %cachedmaps=();
11284: # When this was last done
11285: my $cachedmaptime='';
11286:
1.379 matthew 11287: sub clear_EXT_cache_status {
1.383 albertel 11288: &delenv('cache.EXT.');
1.379 matthew 11289: }
11290:
11291: sub EXT_cache_status {
11292: my ($target_domain,$target_user) = @_;
1.383 albertel 11293: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 11294: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 11295: # We know already the user has no data
11296: return 1;
11297: } else {
11298: return 0;
11299: }
11300: }
11301:
11302: sub EXT_cache_set {
11303: my ($target_domain,$target_user) = @_;
1.383 albertel 11304: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 11305: #&appenv({$cachename => time});
1.379 matthew 11306: }
11307:
1.28 www 11308: # --------------------------------------------------------- Value of a Variable
1.58 www 11309: sub EXT {
1.715 albertel 11310:
1.1228 raeburn 11311: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68 www 11312: unless ($varname) { return ''; }
1.218 albertel 11313: #get real user name/domain, courseid and symb
11314: my $courseid;
1.359 albertel 11315: my $publicuser;
1.427 www 11316: if ($symbparm) {
11317: $symbparm=&get_symb_from_alias($symbparm);
11318: }
1.218 albertel 11319: if (!($uname && $udom)) {
1.790 albertel 11320: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 11321: if (!$symbparm) { $symbparm=$cursymb; }
11322: } else {
1.620 albertel 11323: $courseid=$env{'request.course.id'};
1.218 albertel 11324: }
1.48 www 11325: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
11326: my $rest;
1.320 albertel 11327: if (defined($therest[0])) {
1.48 www 11328: $rest=join('.',@therest);
11329: } else {
11330: $rest='';
11331: }
1.320 albertel 11332:
1.57 www 11333: my $qualifierrest=$qualifier;
11334: if ($rest) { $qualifierrest.='.'.$rest; }
11335: my $spacequalifierrest=$space;
11336: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 11337: if ($realm eq 'user') {
1.48 www 11338: # --------------------------------------------------------------- user.resource
11339: if ($space eq 'resource') {
1.651 albertel 11340: if ( (defined($Apache::lonhomework::parsing_a_problem)
11341: || defined($Apache::lonhomework::parsing_a_task))
11342: &&
1.744 albertel 11343: ($symbparm eq &symbread()) ) {
11344: # if we are in the middle of processing the resource the
11345: # get the value we are planning on committing
11346: if (defined($Apache::lonhomework::results{$qualifierrest})) {
11347: return $Apache::lonhomework::results{$qualifierrest};
11348: } else {
11349: return $Apache::lonhomework::history{$qualifierrest};
11350: }
1.335 albertel 11351: } else {
1.359 albertel 11352: my %restored;
1.620 albertel 11353: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 11354: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
11355: } else {
11356: %restored=&restore($symbparm,$courseid,$udom,$uname);
11357: }
1.335 albertel 11358: return $restored{$qualifierrest};
11359: }
1.48 www 11360: # ----------------------------------------------------------------- user.access
11361: } elsif ($space eq 'access') {
1.218 albertel 11362: # FIXME - not supporting calls for a specific user
1.48 www 11363: return &allowed($qualifier,$rest);
11364: # ------------------------------------------ user.preferences, user.environment
11365: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 11366: if (($uname eq $env{'user.name'}) &&
11367: ($udom eq $env{'user.domain'})) {
11368: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 11369: } else {
1.359 albertel 11370: my %returnhash;
11371: if (!$publicuser) {
11372: %returnhash=&userenvironment($udom,$uname,
11373: $qualifierrest);
11374: }
1.218 albertel 11375: return $returnhash{$qualifierrest};
11376: }
1.48 www 11377: # ----------------------------------------------------------------- user.course
11378: } elsif ($space eq 'course') {
1.218 albertel 11379: # FIXME - not supporting calls for a specific user
1.620 albertel 11380: return $env{join('.',('request.course',$qualifier))};
1.48 www 11381: # ------------------------------------------------------------------- user.role
11382: } elsif ($space eq 'role') {
1.218 albertel 11383: # FIXME - not supporting calls for a specific user
1.620 albertel 11384: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 11385: if ($qualifier eq 'value') {
11386: return $role;
11387: } elsif ($qualifier eq 'extent') {
11388: return $where;
11389: }
11390: # ----------------------------------------------------------------- user.domain
11391: } elsif ($space eq 'domain') {
1.218 albertel 11392: return $udom;
1.48 www 11393: # ------------------------------------------------------------------- user.name
11394: } elsif ($space eq 'name') {
1.218 albertel 11395: return $uname;
1.48 www 11396: # ---------------------------------------------------- Any other user namespace
1.29 www 11397: } else {
1.359 albertel 11398: my %reply;
11399: if (!$publicuser) {
11400: %reply=&get($space,[$qualifierrest],$udom,$uname);
11401: }
11402: return $reply{$qualifierrest};
1.48 www 11403: }
1.236 www 11404: } elsif ($realm eq 'query') {
11405: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 11406: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
11407: [$spacequalifierrest]);
1.620 albertel 11408: return $env{'form.'.$spacequalifierrest};
1.236 www 11409: } elsif ($realm eq 'request') {
1.48 www 11410: # ------------------------------------------------------------- request.browser
11411: if ($space eq 'browser') {
1.1145 bisitz 11412: return $env{'browser.'.$qualifier};
1.57 www 11413: # ------------------------------------------------------------ request.filename
11414: } else {
1.620 albertel 11415: return $env{'request.'.$spacequalifierrest};
1.29 www 11416: }
1.28 www 11417: } elsif ($realm eq 'course') {
1.48 www 11418: # ---------------------------------------------------------- course.description
1.620 albertel 11419: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 11420: } elsif ($realm eq 'resource') {
1.165 www 11421:
1.620 albertel 11422: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 11423: if (!$symbparm) { $symbparm=&symbread(); }
11424: }
1.693 albertel 11425:
1.1232 raeburn 11426: if ($qualifier eq '') {
11427: if ($space eq 'title') {
11428: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
11429: return &gettitle($symbparm);
11430: }
1.693 albertel 11431:
1.1232 raeburn 11432: if ($space eq 'map') {
11433: my ($map) = &decode_symb($symbparm);
11434: return &symbread($map);
11435: }
11436: if ($space eq 'maptitle') {
11437: my ($map) = &decode_symb($symbparm);
11438: return &gettitle($map);
11439: }
11440: if ($space eq 'filename') {
11441: if ($symbparm) {
11442: return &clutter((&decode_symb($symbparm))[2]);
11443: }
11444: return &hreflocation('',$env{'request.filename'});
1.905 albertel 11445: }
1.1232 raeburn 11446:
1.1233 raeburn 11447: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
11448: if ($space eq 'visibleparts') {
11449: my $navmap = Apache::lonnavmaps::navmap->new();
11450: my $item;
11451: if (ref($navmap)) {
11452: my $res = $navmap->getBySymb($symbparm);
11453: my $parts = $res->parts();
11454: if (ref($parts) eq 'ARRAY') {
11455: $item = join(',',@{$parts});
11456: }
11457: undef($navmap);
1.1232 raeburn 11458: }
1.1233 raeburn 11459: return $item;
1.1232 raeburn 11460: }
11461: }
11462: }
1.693 albertel 11463:
1.1301 raeburn 11464: my ($section, $group, @groups, @recurseup, $recursed);
11465: my ($courselevelm,$courseleveli,$courselevel,$mapp);
1.1228 raeburn 11466: if (($courseid eq '') && ($cid)) {
11467: $courseid = $cid;
11468: }
11469: if (($symbparm && $courseid) &&
11470: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 11471:
1.218 albertel 11472: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 11473:
1.60 www 11474: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 11475: my $symbp=$symbparm;
1.1301 raeburn 11476: $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 11477: my $symbparm=$symbp.'.'.$spacequalifierrest;
1.1301 raeburn 11478: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
1.218 albertel 11479: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.620 albertel 11480: if (($env{'user.name'} eq $uname) &&
11481: ($env{'user.domain'} eq $udom)) {
11482: $section=$env{'request.course.sec'};
1.733 raeburn 11483: @groups = split(/:/,$env{'request.course.groups'});
11484: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 11485: } else {
1.539 albertel 11486: if (! defined($usection)) {
1.551 albertel 11487: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 11488: } else {
11489: $section = $usection;
11490: }
1.733 raeburn 11491: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 11492: }
11493:
11494: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
11495: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
1.1301 raeburn 11496: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
1.218 albertel 11497: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
11498:
1.593 albertel 11499: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 11500: my $courselevelr=$courseid.'.'.$symbparm;
1.1301 raeburn 11501: $courseleveli=$courseid.'.'.$recurseparm;
1.593 albertel 11502: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 11503:
1.60 www 11504: # ----------------------------------------------------------- first, check user
1.624 albertel 11505:
1.1301 raeburn 11506: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
11507: \@recurseup,$courseid,'.',$spacequalifierrest,
1.927 albertel 11508: ([$courselevelr,'resource'],
11509: [$courselevelm,'map' ],
1.1301 raeburn 11510: [$courseleveli,'map' ],
1.927 albertel 11511: [$courselevel, 'course' ]));
1.931 albertel 11512: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 11513:
1.594 albertel 11514: # ------------------------------------------------ second, check some of course
1.684 raeburn 11515: my $coursereply;
1.691 raeburn 11516: if (@groups > 0) {
11517: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
1.1301 raeburn 11518: $recurseparm,$mapparm,$spacequalifierrest,
11519: $mapp,\$recursed,\@recurseup);
11520: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 11521: }
1.96 www 11522:
1.684 raeburn 11523: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 11524: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 11525: 'course',$mapp,\$recursed,\@recurseup,
11526: $courseid,'.['.$section.'].',$spacequalifierrest,
1.927 albertel 11527: ([$seclevelr, 'resource'],
11528: [$seclevelm, 'map' ],
1.1301 raeburn 11529: [$secleveli, 'map' ],
1.927 albertel 11530: [$seclevel, 'course' ],
11531: [$courselevelr,'resource']));
11532: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 11533:
1.60 www 11534: # ------------------------------------------------------ third, check map parms
1.218 albertel 11535: my %parmhash=();
11536: my $thisparm='';
11537: if (tie(%parmhash,'GDBM_File',
1.620 albertel 11538: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 11539: &GDBM_READER(),0640)) {
1.218 albertel 11540: $thisparm=$parmhash{$symbparm};
11541: untie(%parmhash);
11542: }
1.927 albertel 11543: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 11544: }
1.594 albertel 11545: # ------------------------------------------ fourth, look in resource metadata
1.1301 raeburn 11546:
11547: my $what = $spacequalifierrest;
11548: $what=~s/\./\_/;
1.282 albertel 11549: my $filename;
11550: if (!$symbparm) { $symbparm=&symbread(); }
11551: if ($symbparm) {
1.409 www 11552: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 11553: } else {
1.620 albertel 11554: $filename=$env{'request.filename'};
1.282 albertel 11555: }
1.1362 raeburn 11556: my $toolsymb;
11557: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
11558: $toolsymb = $symbparm;
11559: }
11560: my $metadata=&metadata($filename,$what,$toolsymb);
1.927 albertel 11561: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.1362 raeburn 11562: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
1.927 albertel 11563: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 11564:
1.1301 raeburn 11565: # ----------------------------------------------- fifth, look in rest of course
1.593 albertel 11566: if ($symbparm && defined($courseid) &&
1.620 albertel 11567: $courseid eq $env{'request.course.id'}) {
1.624 albertel 11568: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
11569: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 11570: 'course',$mapp,\$recursed,\@recurseup,
11571: $courseid,'.',$spacequalifierrest,
1.927 albertel 11572: ([$courselevelm,'map' ],
1.1301 raeburn 11573: [$courseleveli,'map' ],
1.927 albertel 11574: [$courselevel, 'course']));
11575: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 11576: }
1.145 www 11577: # ------------------------------------------------------------------ Cascade up
1.218 albertel 11578: unless ($space eq '0') {
1.336 albertel 11579: my @parts=split(/_/,$space);
11580: my $id=pop(@parts);
11581: my $part=join('_',@parts);
11582: if ($part eq '') { $part='0'; }
1.927 albertel 11583: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 11584: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 11585: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 11586: }
1.395 albertel 11587: if ($recurse) { return undef; }
1.1362 raeburn 11588: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
1.927 albertel 11589: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 11590: # ---------------------------------------------------- Any other user namespace
11591: } elsif ($realm eq 'environment') {
11592: # ----------------------------------------------------------------- environment
1.620 albertel 11593: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
11594: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 11595: } else {
1.770 albertel 11596: if ($uname eq 'anonymous' && $udom eq '') {
11597: return '';
11598: }
1.219 albertel 11599: my %returnhash=&userenvironment($udom,$uname,
11600: $spacequalifierrest);
11601: return $returnhash{$spacequalifierrest};
11602: }
1.28 www 11603: } elsif ($realm eq 'system') {
1.48 www 11604: # ----------------------------------------------------------------- system.time
11605: if ($space eq 'time') {
11606: return time;
11607: }
1.696 albertel 11608: } elsif ($realm eq 'server') {
11609: # ----------------------------------------------------------------- system.time
11610: if ($space eq 'name') {
11611: return $ENV{'SERVER_NAME'};
11612: }
1.28 www 11613: }
1.48 www 11614: return '';
1.61 www 11615: }
11616:
1.927 albertel 11617: sub get_reply {
11618: my ($reply_value) = @_;
1.940 raeburn 11619: if (ref($reply_value) eq 'ARRAY') {
11620: if (wantarray) {
11621: return @$reply_value;
11622: }
11623: return $reply_value->[0];
11624: } else {
11625: return $reply_value;
1.927 albertel 11626: }
11627: }
11628:
1.691 raeburn 11629: sub check_group_parms {
1.1301 raeburn 11630: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
11631: $recursed,$recurseupref) = @_;
11632: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
11633: [$what,'course']);
11634: my $coursereply;
1.691 raeburn 11635: foreach my $group (@{$groups}) {
1.1301 raeburn 11636: my @groupitems = ();
1.691 raeburn 11637: foreach my $level (@levels) {
1.927 albertel 11638: my $item = $courseid.'.['.$group.'].'.$level->[0];
11639: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 11640: }
1.1301 raeburn 11641: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
11642: $env{'course.'.$courseid.'.domain'},
11643: 'course',$mapp,$recursed,$recurseupref,
11644: $courseid,'.['.$group.'].',$what,
11645: @groupitems);
11646: last if (defined($coursereply));
1.691 raeburn 11647: }
11648: return $coursereply;
11649: }
11650:
1.1301 raeburn 11651: sub get_map_hierarchy {
1.1302 raeburn 11652: my ($mapname,$courseid) = @_;
11653: my @recurseup = ();
1.1301 raeburn 11654: if ($mapname) {
1.1302 raeburn 11655: if (($cachedmapkey eq $courseid) &&
11656: (abs($cachedmaptime-time)<5)) {
11657: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
11658: return @{$cachedmaps{$mapname}};
11659: }
11660: }
1.1301 raeburn 11661: my $navmap = Apache::lonnavmaps::navmap->new();
11662: if (ref($navmap)) {
11663: @recurseup = $navmap->recurseup_maps($mapname);
11664: undef($navmap);
1.1302 raeburn 11665: $cachedmaps{$mapname} = \@recurseup;
11666: $cachedmaptime=time;
11667: $cachedmapkey=$courseid;
1.1301 raeburn 11668: }
11669: }
11670: return @recurseup;
11671: }
11672:
1.1302 raeburn 11673: }
11674:
1.691 raeburn 11675: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 11676: my ($courseid,@groups) = @_;
11677: @groups = sort(@groups);
1.691 raeburn 11678: return @groups;
11679: }
11680:
1.395 albertel 11681: sub packages_tab_default {
1.1362 raeburn 11682: my ($uri,$varname,$toolsymb)=@_;
1.395 albertel 11683: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 11684:
11685: my (@extension,@specifics,$do_default);
1.1362 raeburn 11686: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
1.395 albertel 11687: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 11688: if ($pack_type eq 'default') {
11689: $do_default=1;
11690: } elsif ($pack_type eq 'extension') {
11691: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 11692: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 11693: # only look at packages defaults for packages that this id is
1.738 albertel 11694: push(@specifics,[$package,$pack_type,$pack_part]);
11695: }
11696: }
11697: # first look for a package that matches the requested part id
11698: foreach my $package (@specifics) {
11699: my (undef,$pack_type,$pack_part)=@{$package};
11700: next if ($pack_part ne $part);
11701: if (defined($packagetab{"$pack_type&$name&default"})) {
11702: return $packagetab{"$pack_type&$name&default"};
11703: }
11704: }
11705: # look for any possible matching non extension_ package
11706: foreach my $package (@specifics) {
11707: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 11708: if (defined($packagetab{"$pack_type&$name&default"})) {
11709: return $packagetab{"$pack_type&$name&default"};
11710: }
1.585 albertel 11711: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 11712: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
11713: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 11714: }
11715: }
1.738 albertel 11716: # look for any posible extension_ match
11717: foreach my $package (@extension) {
11718: my ($package,$pack_type)=@{$package};
11719: if (defined($packagetab{"$pack_type&$name&default"})) {
11720: return $packagetab{"$pack_type&$name&default"};
11721: }
11722: if (defined($packagetab{$package."&$name&default"})) {
11723: return $packagetab{$package."&$name&default"};
11724: }
11725: }
11726: # look for a global default setting
11727: if ($do_default && defined($packagetab{"default&$name&default"})) {
11728: return $packagetab{"default&$name&default"};
11729: }
1.395 albertel 11730: return undef;
11731: }
11732:
1.334 albertel 11733: sub add_prefix_and_part {
11734: my ($prefix,$part)=@_;
11735: my $keyroot;
11736: if (defined($prefix) && $prefix !~ /^__/) {
11737: # prefix that has a part already
11738: $keyroot=$prefix;
11739: } elsif (defined($prefix)) {
11740: # prefix that is missing a part
11741: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
11742: } else {
11743: # no prefix at all
11744: if (defined($part)) { $keyroot='_'.$part; }
11745: }
11746: return $keyroot;
11747: }
11748:
1.71 www 11749: # ---------------------------------------------------------------- Get metadata
11750:
1.599 albertel 11751: my %metaentry;
1.1070 www 11752: my %importedpartids;
1.1369 raeburn 11753: my %importedrespids;
1.71 www 11754: sub metadata {
1.1362 raeburn 11755: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
1.71 www 11756: $uri=&declutter($uri);
1.288 albertel 11757: # if it is a non metadata possible uri return quickly
1.529 albertel 11758: if (($uri eq '') ||
11759: (($uri =~ m|^/*adm/|) &&
1.1343 raeburn 11760: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
1.1108 raeburn 11761: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 11762: return undef;
11763: }
1.1261 raeburn 11764: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 11765: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 11766: return undef;
1.288 albertel 11767: }
1.73 www 11768: my $filename=$uri;
11769: $uri=~s/\.meta$//;
1.172 www 11770: #
11771: # Is the metadata already cached?
1.177 www 11772: # Look at timestamp of caching
1.172 www 11773: # Everything is cached by the main uri, libraries are never directly cached
11774: #
1.428 albertel 11775: if (!defined($liburi)) {
1.599 albertel 11776: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 11777: if (defined($cached)) { return $result->{':'.$what}; }
11778: }
1.1362 raeburn 11779:
11780: #
11781: # If the uri is for an external tool the file from
11782: # which metadata should be retrieved depends on whether
11783: # the tool had been configured to be gradable (set in the Course
11784: # Editor or Resource Editor).
11785: #
11786: # If a valid symb has been included as the third arg in the call
11787: # to &metadata() that can be used to retrieve the value of
11788: # parameter_0_gradable set for the resource, and included in the
11789: # uploaded map containing the tool. The value is retrieved via
11790: # &EXT(), if a valid symb is available. Otherwise the value of
11791: # gradable in the exttool_$marker.db file for the tool instance
1.1364 raeburn 11792: # is retrieved via &get().
11793: #
11794: # When lonuserstate::traceroute() calls lonnet::EXT() for
11795: # hiddenresource and encrypturl (during course initialization)
11796: # the map-level parameter for resource.0.gradable included in the
11797: # uploaded map containing the tool will not yet have been stored
11798: # in the user_course_parms.db file for the user's session, so in
11799: # this case fall back to retrieving gradable status from the
11800: # exttool_$marker.db file.
1.1362 raeburn 11801: #
11802: # In order to avoid an infinite loop, &metadata() will return
11803: # before a call to &EXT(), if the uri is for an external tool
11804: # and the $what for which metadata is being requested is
11805: # parameter_0_gradable or 0_gradable.
11806: #
11807:
11808: if ($uri =~ /ext\.tool$/) {
11809: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
11810: return;
11811: } else {
11812: my ($checked,$use_passback);
11813: if ($toolsymb ne '') {
11814: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
1.1364 raeburn 11815: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
1.1362 raeburn 11816: $checked = 1;
11817: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
11818: $use_passback = 1;
11819: }
11820: }
11821: }
11822: unless ($checked) {
11823: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
11824: $marker=~s/\D//g;
1.1363 raeburn 11825: if ($marker) {
1.1362 raeburn 11826: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
11827: $use_passback = $toolsettings{'gradable'};
11828: }
11829: }
11830: if ($use_passback) {
11831: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
11832: } else {
11833: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
11834: }
11835: }
11836: }
11837:
1.428 albertel 11838: {
1.1069 www 11839: # Imported parts would go here
1.1369 raeburn 11840: my @origfiletagids=();
1.1069 www 11841: my $importedparts=0;
1.1369 raeburn 11842:
11843: # Imported responseids would go here
11844: my $importedresponses=0;
1.172 www 11845: #
11846: # Is this a recursive call for a library?
11847: #
1.599 albertel 11848: # if (! exists($metacache{$uri})) {
11849: # $metacache{$uri}={};
11850: # }
1.924 albertel 11851: my $cachetime = 60*60;
1.171 www 11852: if ($liburi) {
11853: $liburi=&declutter($liburi);
11854: $filename=$liburi;
1.401 bowersj2 11855: } else {
1.599 albertel 11856: &devalidate_cache_new('meta',$uri);
11857: undef(%metaentry);
1.401 bowersj2 11858: }
1.140 www 11859: my %metathesekeys=();
1.73 www 11860: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 11861: my $metastring;
1.1140 www 11862: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 11863: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 11864: $metastring =
1.929 albertel 11865: &Apache::lonnet::ssi_body($which,
1.924 albertel 11866: ('grade_target' => 'meta'));
11867: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 11868: } elsif (($uri !~ m -^(editupload)/-) &&
11869: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 11870: my $file=&filelocation('',&clutter($filename));
1.599 albertel 11871: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 11872: $metastring=&getfile($file);
1.489 albertel 11873: }
1.208 albertel 11874: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 11875: my $token;
1.140 www 11876: undef %metathesekeys;
1.71 www 11877: while ($token=$parser->get_token) {
1.339 albertel 11878: if ($token->[0] eq 'S') {
11879: if (defined($token->[2]->{'package'})) {
1.172 www 11880: #
11881: # This is a package - get package info
11882: #
1.339 albertel 11883: my $package=$token->[2]->{'package'};
11884: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11885: if (defined($token->[2]->{'id'})) {
11886: $keyroot.='_'.$token->[2]->{'id'};
11887: }
1.599 albertel 11888: if ($metaentry{':packages'}) {
11889: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 11890: } else {
1.599 albertel 11891: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 11892: }
1.736 albertel 11893: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 11894: my $part=$keyroot;
11895: $part=~s/^\_//;
1.736 albertel 11896: if ($pack_entry=~/^\Q$package\E\&/ ||
11897: $pack_entry=~/^\Q$package\E_0\&/) {
11898: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 11899: # ignore package.tab specified default values
11900: # here &package_tab_default() will fetch those
11901: if ($subp eq 'default') { next; }
1.736 albertel 11902: my $value=$packagetab{$pack_entry};
1.432 albertel 11903: my $unikey;
11904: if ($pack =~ /_0$/) {
11905: $unikey='parameter_0_'.$name;
11906: $part=0;
11907: } else {
11908: $unikey='parameter'.$keyroot.'_'.$name;
11909: }
1.339 albertel 11910: if ($subp eq 'display') {
11911: $value.=' [Part: '.$part.']';
11912: }
1.599 albertel 11913: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 11914: $metathesekeys{$unikey}=1;
1.599 albertel 11915: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11916: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 11917: }
1.599 albertel 11918: if (defined($metaentry{':'.$unikey.'.default'})) {
11919: $metaentry{':'.$unikey}=
11920: $metaentry{':'.$unikey.'.default'};
1.356 albertel 11921: }
1.339 albertel 11922: }
11923: }
11924: } else {
1.172 www 11925: #
11926: # This is not a package - some other kind of start tag
1.339 albertel 11927: #
11928: my $entry=$token->[1];
1.1068 www 11929: my $unikey='';
1.175 www 11930:
1.339 albertel 11931: if ($entry eq 'import') {
1.175 www 11932: #
11933: # Importing a library here
1.339 albertel 11934: #
1.1067 www 11935: my $location=$parser->get_text('/import');
11936: my $dir=$filename;
11937: $dir=~s|[^/]*$||;
11938: $location=&filelocation($dir,$location);
1.1369 raeburn 11939:
11940: my $importid=$token->[2]->{'id'};
1.1068 www 11941: my $importmode=$token->[2]->{'importmode'};
1.1369 raeburn 11942: #
11943: # Check metadata for imported file to
11944: # see if it contained response items
11945: #
1.1372 raeburn 11946: my ($origfile,@libfilekeys);
1.1370 raeburn 11947: my %currmetaentry = %metaentry;
1.1372 raeburn 11948: @libfilekeys = split(/,/,&metadata($location,'keys',undef,undef,undef,
11949: $depthcount+1));
11950: if (grep(/^responseorder$/,@libfilekeys)) {
11951: my $libresponseorder = &metadata($location,'responseorder',undef,undef,
11952: undef,$depthcount+1);
11953: if ($libresponseorder ne '') {
11954: if ($#origfiletagids<0) {
11955: undef(%importedrespids);
11956: undef(%importedpartids);
11957: }
1.1373 raeburn 11958: my @respids = split(/\s*,\s*/,$libresponseorder);
11959: if (@respids) {
11960: $importedrespids{$importid} = join(',',map { $importid.'_'.$_ } @respids);
11961: }
11962: if ($importedrespids{$importid} ne '') {
1.1372 raeburn 11963: $importedresponses = 1;
1.1369 raeburn 11964: # We need to get the original file and the imported file to get the response order correct
11965: # Load and inspect original file
1.1372 raeburn 11966: if ($#origfiletagids<0) {
11967: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11968: $origfile=&getfile($origfilelocation);
11969: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11970: }
1.1369 raeburn 11971: }
11972: }
11973: }
1.1370 raeburn 11974: # Do not overwrite contents of %metaentry hash for resource itself with
11975: # hash populated for imported library file
11976: %metaentry = %currmetaentry;
11977: undef(%currmetaentry);
1.1374 raeburn 11978: if ($importmode eq 'part') {
1.1068 www 11979: # Import as part(s)
1.1069 www 11980: $importedparts=1;
11981: # We need to get the original file and the imported file to get the part order correct
11982: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
1.1369 raeburn 11983: # Load and inspect original file if we didn't do that already
11984: if ($#origfiletagids<0) {
11985: undef(%importedrespids);
11986: undef(%importedpartids);
11987: if ($origfile eq '') {
11988: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11989: $origfile=&getfile($origfilelocation);
11990: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11991: }
1.1070 www 11992: }
1.1372 raeburn 11993: my @impfilepartids;
11994: # If <partorder> tag is included in metadata for the imported file
11995: # get the parts in the imported file from that.
11996: if (grep(/^partorder$/,@libfilekeys)) {
11997: %currmetaentry = %metaentry;
11998: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
11999: $depthcount+1);
12000: %metaentry = %currmetaentry;
12001: undef(%currmetaentry);
12002: if ($libpartorder ne '') {
12003: @impfilepartids=split(/\s*,\s*/,$libpartorder);
12004: }
12005: } else {
12006: # If no <partorder> tag available, load and inspect imported file
12007: my $impfile=&getfile($location);
12008: @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
12009: }
1.1069 www 12010: if ($#impfilepartids>=0) {
12011: # This problem had parts
1.1070 www 12012: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 12013: } else {
12014: # Importing by turning a single problem into a problem part
12015: # It gets the import-tags ID as part-ID
12016: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 12017: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 12018: }
1.1068 www 12019: } else {
1.1374 raeburn 12020: # Import as problem or as normal import
12021: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
12022: unless ($importmode eq 'problem') {
1.1068 www 12023: # Normal import
1.1374 raeburn 12024: if (defined($token->[2]->{'id'})) {
12025: $unikey.='_'.$token->[2]->{'id'};
12026: }
12027: }
12028: # Check metadata for imported file to
12029: # see if it contained parts
12030: if (grep(/^partorder$/,@libfilekeys)) {
12031: %currmetaentry = %metaentry;
12032: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
12033: $depthcount+1);
12034: %metaentry = %currmetaentry;
12035: undef(%currmetaentry);
12036: if ($libpartorder ne '') {
12037: $importedparts = 1;
12038: $importedpartids{$token->[2]->{'id'}}=$libpartorder;
12039: }
12040: }
1.1067 www 12041: }
1.339 albertel 12042: if ($depthcount<20) {
1.736 albertel 12043: my $metadata =
1.1362 raeburn 12044: &metadata($uri,'keys',$toolsymb,$location,$unikey,
1.736 albertel 12045: $depthcount+1);
12046: foreach my $meta (split(',',$metadata)) {
12047: $metaentry{':'.$meta}=$metaentry{':'.$meta};
12048: $metathesekeys{$meta}=1;
1.339 albertel 12049: }
1.1068 www 12050: }
1.1067 www 12051: } else {
12052: #
12053: # Not importing, some other kind of non-package, non-library start tag
12054: #
12055: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
12056: if (defined($token->[2]->{'id'})) {
12057: $unikey.='_'.$token->[2]->{'id'};
12058: }
1.339 albertel 12059: if (defined($token->[2]->{'name'})) {
12060: $unikey.='_'.$token->[2]->{'name'};
12061: }
12062: $metathesekeys{$unikey}=1;
1.736 albertel 12063: foreach my $param (@{$token->[3]}) {
12064: $metaentry{':'.$unikey.'.'.$param} =
12065: $token->[2]->{$param};
1.339 albertel 12066: }
12067: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 12068: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 12069: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
12070: # only ws inside the tag, and not in default, so use default
12071: # as value
1.599 albertel 12072: $metaentry{':'.$unikey}=$default;
1.908 albertel 12073: } elsif ( $internaltext =~ /\S/ ) {
12074: # something interesting inside the tag
12075: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 12076: } else {
1.908 albertel 12077: # no interesting values, don't set a default
1.339 albertel 12078: }
1.172 www 12079: # end of not-a-package not-a-library import
1.339 albertel 12080: }
1.172 www 12081: # end of not-a-package start tag
1.339 albertel 12082: }
1.172 www 12083: # the next is the end of "start tag"
1.339 albertel 12084: }
12085: }
1.483 albertel 12086: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 12087: $extension = lc($extension);
12088: if ($extension eq 'htm') { $extension='html'; }
12089:
1.737 albertel 12090: foreach my $key (keys(%packagetab)) {
1.483 albertel 12091: #no specific packages #how's our extension
12092: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 12093: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 12094: \%metathesekeys);
12095: }
1.883 albertel 12096:
12097: if (!exists($metaentry{':packages'})
12098: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 12099: foreach my $key (keys(%packagetab)) {
1.483 albertel 12100: #no specific packages well let's get default then
12101: if ($key!~/^default&/) { next; }
1.488 albertel 12102: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 12103: \%metathesekeys);
12104: }
12105: }
1.338 www 12106: # are there custom rights to evaluate
1.599 albertel 12107: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 12108:
1.338 www 12109: #
12110: # Importing a rights file here
1.339 albertel 12111: #
12112: unless ($depthcount) {
1.599 albertel 12113: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 12114: my $dir=$filename;
12115: $dir=~s|[^/]*$||;
12116: $location=&filelocation($dir,$location);
1.736 albertel 12117: my $rights_metadata =
1.1362 raeburn 12118: &metadata($uri,'keys',$toolsymb,$location,'_rights',
1.736 albertel 12119: $depthcount+1);
12120: foreach my $rights (split(',',$rights_metadata)) {
12121: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
12122: $metathesekeys{$rights}=1;
1.339 albertel 12123: }
12124: }
12125: }
1.737 albertel 12126: # uniqifiy package listing
12127: my %seen;
12128: my @uniq_packages =
12129: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
12130: $metaentry{':packages'} = join(',',@uniq_packages);
12131:
1.1369 raeburn 12132: if (($importedresponses) || ($importedparts)) {
12133: if ($importedparts) {
1.1070 www 12134: # We had imported parts and need to rebuild partorder
1.1369 raeburn 12135: $metaentry{':partorder'}='';
12136: $metathesekeys{'partorder'}=1;
12137: }
12138: if ($importedresponses) {
12139: # We had imported responses and need to rebuil responseorder
12140: $metaentry{':responseorder'}='';
12141: $metathesekeys{'responseorder'}=1;
12142: }
12143: for (my $index=0;$index<$#origfiletagids;$index+=2) {
12144: my $origid = $origfiletagids[$index+1];
12145: if ($origfiletagids[$index] eq 'part') {
12146: # Original part, part of the problem
12147: if ($importedparts) {
12148: $metaentry{':partorder'}.=','.$origid;
12149: }
12150: } elsif ($origfiletagids[$index] eq 'import') {
12151: if ($importedparts) {
12152: # We have imported parts at this position
1.1373 raeburn 12153: if ($importedpartids{$origid} ne '') {
12154: $metaentry{':partorder'}.=','.$importedpartids{$origid};
12155: }
1.1369 raeburn 12156: }
12157: if ($importedresponses) {
12158: # We have imported responses at this position
1.1373 raeburn 12159: if ($importedrespids{$origid} ne '') {
12160: $metaentry{':responseorder'}.=','.$importedrespids{$origid};
1.1369 raeburn 12161: }
12162: }
12163: } else {
12164: # Original response item, part of the problem
12165: if ($importedresponses) {
12166: $metaentry{':responseorder'}.=','.$origid;
12167: }
12168: }
12169: }
12170: if ($importedparts) {
12171: $metaentry{':partorder'}=~s/^\,//;
12172: }
12173: if ($importedresponses) {
12174: $metaentry{':responseorder'}=~s/^\,//;
12175: }
1.1070 www 12176: }
1.737 albertel 12177: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 12178: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274 raeburn 12179: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.1371 raeburn 12180: unless ($liburi) {
12181: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
12182: }
1.177 www 12183: # this is the end of "was not already recently cached
1.71 www 12184: }
1.599 albertel 12185: return $metaentry{':'.$what};
1.261 albertel 12186: }
12187:
1.488 albertel 12188: sub metadata_create_package_def {
1.483 albertel 12189: my ($uri,$key,$package,$metathesekeys)=@_;
12190: my ($pack,$name,$subp)=split(/\&/,$key);
12191: if ($subp eq 'default') { next; }
12192:
1.599 albertel 12193: if (defined($metaentry{':packages'})) {
12194: $metaentry{':packages'}.=','.$package;
1.483 albertel 12195: } else {
1.599 albertel 12196: $metaentry{':packages'}=$package;
1.483 albertel 12197: }
12198: my $value=$packagetab{$key};
12199: my $unikey;
12200: $unikey='parameter_0_'.$name;
1.599 albertel 12201: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 12202: $$metathesekeys{$unikey}=1;
1.599 albertel 12203: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
12204: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 12205: }
1.599 albertel 12206: if (defined($metaentry{':'.$unikey.'.default'})) {
12207: $metaentry{':'.$unikey}=
12208: $metaentry{':'.$unikey.'.default'};
1.483 albertel 12209: }
12210: }
12211:
1.261 albertel 12212: sub metadata_generate_part0 {
12213: my ($metadata,$metacache,$uri) = @_;
12214: my %allnames;
1.737 albertel 12215: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 12216: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 12217: my $part=$$metacache{':'.$metakey.'.part'};
12218: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 12219: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 12220: $allnames{$name}=$part;
12221: }
12222: }
12223: }
12224: foreach my $name (keys(%allnames)) {
12225: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 12226: my $key=":parameter_0_$name";
1.261 albertel 12227: $$metacache{"$key.part"}='0';
12228: $$metacache{"$key.name"}=$name;
1.428 albertel 12229: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 12230: $allnames{$name}.'_'.$name.
12231: '.type'};
1.428 albertel 12232: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 12233: '.display'};
1.644 www 12234: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 12235: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 12236: $$metacache{"$key.display"}=$olddis;
12237: }
1.71 www 12238: }
12239:
1.764 albertel 12240: # ------------------------------------------------------ Devalidate title cache
12241:
12242: sub devalidate_title_cache {
12243: my ($url)=@_;
12244: if (!$env{'request.course.id'}) { return; }
12245: my $symb=&symbread($url);
12246: if (!$symb) { return; }
12247: my $key=$env{'request.course.id'}."\0".$symb;
12248: &devalidate_cache_new('title',$key);
12249: }
12250:
1.1014 droeschl 12251: # ------------------------------------------------- Get the title of a course
12252:
12253: sub current_course_title {
12254: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
12255: }
1.301 www 12256: # ------------------------------------------------- Get the title of a resource
12257:
12258: sub gettitle {
12259: my $urlsymb=shift;
12260: my $symb=&symbread($urlsymb);
1.534 albertel 12261: if ($symb) {
1.620 albertel 12262: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 12263: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 12264: if (defined($cached)) {
12265: return $result;
12266: }
1.534 albertel 12267: my ($map,$resid,$url)=&decode_symb($symb);
12268: my $title='';
1.907 albertel 12269: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
12270: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
12271: } else {
12272: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12273: &GDBM_READER(),0640)) {
12274: my $mapid=$bighash{'map_pc_'.&clutter($map)};
12275: $title=$bighash{'title_'.$mapid.'.'.$resid};
12276: untie(%bighash);
12277: }
1.534 albertel 12278: }
12279: $title=~s/\&colon\;/\:/gs;
12280: if ($title) {
1.1159 www 12281: # Remember both $symb and $title for dynamic metadata
12282: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 12283: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 12284: # Cache this title and then return it
1.599 albertel 12285: return &do_cache_new('title',$key,$title,600);
1.534 albertel 12286: }
12287: $urlsymb=$url;
12288: }
12289: my $title=&metadata($urlsymb,'title');
12290: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
12291: return $title;
1.301 www 12292: }
1.613 albertel 12293:
1.614 albertel 12294: sub get_slot {
12295: my ($which,$cnum,$cdom)=@_;
12296: if (!$cnum || !$cdom) {
1.790 albertel 12297: (undef,my $courseid)=&whichuser();
1.620 albertel 12298: $cdom=$env{'course.'.$courseid.'.domain'};
12299: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 12300: }
1.703 albertel 12301: my $key=join("\0",'slots',$cdom,$cnum,$which);
12302: my %slotinfo;
12303: if (exists($remembered{$key})) {
12304: $slotinfo{$which} = $remembered{$key};
12305: } else {
12306: %slotinfo=&get('slots',[$which],$cdom,$cnum);
12307: &Apache::lonhomework::showhash(%slotinfo);
12308: my ($tmp)=keys(%slotinfo);
12309: if ($tmp=~/^error:/) { return (); }
12310: $remembered{$key} = $slotinfo{$which};
12311: }
1.616 albertel 12312: if (ref($slotinfo{$which}) eq 'HASH') {
12313: return %{$slotinfo{$which}};
12314: }
12315: return $slotinfo{$which};
1.614 albertel 12316: }
1.1150 raeburn 12317:
12318: sub get_reservable_slots {
12319: my ($cnum,$cdom,$uname,$udom) = @_;
12320: my $now = time;
12321: my $reservable_info;
12322: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
12323: if (exists($remembered{$key})) {
12324: $reservable_info = $remembered{$key};
12325: } else {
12326: my %resv;
12327: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
12328: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
12329: $reservable_info = \%resv;
12330: $remembered{$key} = $reservable_info;
12331: }
12332: return $reservable_info;
12333: }
12334:
12335: sub get_course_slots {
12336: my ($cnum,$cdom) = @_;
12337: my $hashid=$cnum.':'.$cdom;
12338: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
12339: if (defined($cached)) {
12340: if (ref($result) eq 'HASH') {
12341: return %{$result};
12342: }
12343: } else {
12344: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
12345: my ($tmp) = keys(%slots);
12346: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 12347: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 12348: return %slots;
12349: }
12350: }
12351: return;
12352: }
12353:
12354: sub devalidate_slots_cache {
12355: my ($cnum,$cdom)=@_;
12356: my $hashid=$cnum.':'.$cdom;
12357: &devalidate_cache_new('allslots',$hashid);
12358: }
12359:
1.1181 raeburn 12360: sub get_coursechange {
12361: my ($cdom,$cnum) = @_;
12362: if ($cdom eq '' || $cnum eq '') {
12363: return unless ($env{'request.course.id'});
12364: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
12365: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12366: }
12367: my $hashid=$cdom.'_'.$cnum;
12368: my ($change,$cached)=&is_cached_new('crschange',$hashid);
12369: if ((defined($cached)) && ($change ne '')) {
12370: return $change;
12371: } else {
12372: my %crshash;
12373: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
12374: if ($crshash{'internal.contentchange'} eq '') {
12375: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
12376: if ($change eq '') {
12377: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
12378: $change = $crshash{'internal.created'};
12379: }
12380: } else {
12381: $change = $crshash{'internal.contentchange'};
12382: }
12383: my $cachetime = 600;
12384: &do_cache_new('crschange',$hashid,$change,$cachetime);
12385: }
12386: return $change;
12387: }
12388:
12389: sub devalidate_coursechange_cache {
12390: my ($cnum,$cdom)=@_;
12391: my $hashid=$cnum.':'.$cdom;
12392: &devalidate_cache_new('crschange',$hashid);
12393: }
12394:
1.31 www 12395: # ------------------------------------------------- Update symbolic store links
12396:
12397: sub symblist {
12398: my ($mapname,%newhash)=@_;
1.438 www 12399: $mapname=&deversion(&declutter($mapname));
1.31 www 12400: my %hash;
1.620 albertel 12401: if (($env{'request.course.fn'}) && (%newhash)) {
12402: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 12403: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 12404: foreach my $url (keys(%newhash)) {
1.711 albertel 12405: next if ($url eq 'last_known'
12406: && $env{'form.no_update_last_known'});
12407: $hash{declutter($url)}=&encode_symb($mapname,
12408: $newhash{$url}->[1],
12409: $newhash{$url}->[0]);
1.191 harris41 12410: }
1.31 www 12411: if (untie(%hash)) {
12412: return 'ok';
12413: }
12414: }
12415: }
12416: return 'error';
1.212 www 12417: }
12418:
12419: # --------------------------------------------------------------- Verify a symb
12420:
12421: sub symbverify {
1.1190 raeburn 12422: my ($symb,$thisurl,$encstate)=@_;
1.510 www 12423: my $thisfn=$thisurl;
1.439 www 12424: $thisfn=&declutter($thisfn);
1.215 www 12425: # direct jump to resource in page or to a sequence - will construct own symbs
12426: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
12427: # check URL part
1.409 www 12428: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 12429:
1.431 www 12430: unless ($url eq $thisfn) { return 0; }
1.213 www 12431:
1.216 www 12432: $symb=&symbclean($symb);
1.510 www 12433: $thisurl=&deversion($thisurl);
1.439 www 12434: $thisfn=&deversion($thisfn);
1.213 www 12435:
12436: my %bighash;
12437: my $okay=0;
1.431 www 12438:
1.620 albertel 12439: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 12440: &GDBM_READER(),0640)) {
1.1204 raeburn 12441: my $noclutter;
1.1032 raeburn 12442: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
12443: $thisurl =~ s/\?.+$//;
1.1204 raeburn 12444: if ($map =~ m{^uploaded/.+\.page$}) {
12445: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
12446: $thisurl =~ s{^\Qhttp://https://\E}{https://};
12447: $noclutter = 1;
12448: }
12449: }
12450: my $ids;
12451: if ($noclutter) {
12452: $ids=$bighash{'ids_'.$thisurl};
12453: } else {
12454: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 12455: }
1.1102 raeburn 12456: unless ($ids) {
12457: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
12458: $ids=$bighash{$idkey};
1.216 www 12459: }
12460: if ($ids) {
12461: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 12462: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 12463: $symb =~ s/\?.+$//;
1.1202 raeburn 12464: }
1.800 albertel 12465: foreach my $id (split(/\,/,$ids)) {
12466: my ($mapid,$resid)=split(/\./,$id);
1.216 www 12467: if (
12468: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 12469: eq $symb) {
12470: if (ref($encstate)) {
12471: $$encstate = $bighash{'encrypted_'.$id};
12472: }
1.620 albertel 12473: if (($env{'request.role.adv'}) ||
1.1101 raeburn 12474: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
12475: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 12476: $okay=1;
1.1202 raeburn 12477: last;
1.582 albertel 12478: }
12479: }
1.216 www 12480: }
12481: }
1.213 www 12482: untie(%bighash);
12483: }
12484: return $okay;
1.31 www 12485: }
12486:
1.210 www 12487: # --------------------------------------------------------------- Clean-up symb
12488:
12489: sub symbclean {
12490: my $symb=shift;
1.568 albertel 12491: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 12492: # remove version from map
12493: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 12494:
1.210 www 12495: # remove version from URL
12496: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 12497:
1.507 www 12498: # remove wrapper
12499:
1.510 www 12500: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 12501: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 12502: return $symb;
1.409 www 12503: }
12504:
12505: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 12506:
12507: sub encode_symb {
12508: my ($map,$resid,$url)=@_;
12509: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
12510: }
1.409 www 12511:
12512: sub decode_symb {
1.568 albertel 12513: my $symb=shift;
12514: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
12515: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 12516: return (&fixversion($map),$resid,&fixversion($url));
12517: }
12518:
12519: sub fixversion {
12520: my $fn=shift;
1.609 banghart 12521: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 12522: my %bighash;
12523: my $uri=&clutter($fn);
1.620 albertel 12524: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 12525: # is this cached?
1.599 albertel 12526: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 12527: if (defined($cached)) { return $result; }
12528: # unfortunately not cached, or expired
1.620 albertel 12529: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 12530: &GDBM_READER(),0640)) {
12531: if ($bighash{'version_'.$uri}) {
12532: my $version=$bighash{'version_'.$uri};
1.444 www 12533: unless (($version eq 'mostrecent') ||
12534: ($version==&getversion($uri))) {
1.440 www 12535: $uri=~s/\.(\w+)$/\.$version\.$1/;
12536: }
12537: }
12538: untie %bighash;
1.413 www 12539: }
1.599 albertel 12540: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 12541: }
12542:
12543: sub deversion {
12544: my $url=shift;
12545: $url=~s/\.\d+\.(\w+)$/\.$1/;
12546: return $url;
1.210 www 12547: }
12548:
1.31 www 12549: # ------------------------------------------------------ Return symb list entry
12550:
12551: sub symbread {
1.1282 raeburn 12552: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
1.1265 raeburn 12553: my $cache_str='request.symbread.cached.'.$thisfn;
1.1282 raeburn 12554: if (defined($env{$cache_str})) {
12555: if ($ignorecachednull) {
12556: return $env{$cache_str} unless ($env{$cache_str} eq '');
12557: } else {
12558: return $env{$cache_str};
12559: }
12560: }
1.242 www 12561: # no filename provided? try from environment
1.1265 raeburn 12562: unless ($thisfn) {
1.620 albertel 12563: if ($env{'request.symb'}) {
12564: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 12565: }
1.620 albertel 12566: $thisfn=$env{'request.filename'};
1.44 www 12567: }
1.569 albertel 12568: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 12569: # is that filename actually a symb? Verify, clean, and return
12570: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 12571: if (&symbverify($thisfn,$1)) {
1.620 albertel 12572: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 12573: }
1.242 www 12574: }
1.44 www 12575: $thisfn=declutter($thisfn);
1.31 www 12576: my %hash;
1.37 www 12577: my %bighash;
12578: my $syval='';
1.620 albertel 12579: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 12580: my $targetfn = $thisfn;
1.609 banghart 12581: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 12582: $targetfn = 'adm/wrapper/'.$thisfn;
12583: }
1.687 albertel 12584: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
12585: $targetfn=$1;
12586: }
1.620 albertel 12587: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 12588: &GDBM_READER(),0640)) {
1.481 raeburn 12589: $syval=$hash{$targetfn};
1.37 www 12590: untie(%hash);
12591: }
12592: # ---------------------------------------------------------- There was an entry
12593: if ($syval) {
1.601 albertel 12594: #unless ($syval=~/\_\d+$/) {
1.620 albertel 12595: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 12596: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 12597: #return $env{$cache_str}='';
1.601 albertel 12598: #}
12599: #$syval.=$1;
12600: #}
1.37 www 12601: } else {
12602: # ------------------------------------------------------- Was not in symb table
1.620 albertel 12603: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 12604: &GDBM_READER(),0640)) {
1.37 www 12605: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 12606: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 12607: unless ($ids) {
12608: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 12609: }
12610: unless ($ids) {
12611: # alias?
12612: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 12613: }
1.37 www 12614: if ($ids) {
12615: # ------------------------------------------------------------------- Has ID(s)
12616: my @possibilities=split(/\,/,$ids);
1.39 www 12617: if ($#possibilities==0) {
12618: # ----------------------------------------------- There is only one possibility
1.37 www 12619: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 12620: $syval=&encode_symb($bighash{'map_id_'.$mapid},
12621: $resid,$thisfn);
1.1282 raeburn 12622: if (ref($possibles) eq 'HASH') {
12623: $possibles->{$syval} = 1;
12624: }
12625: if ($checkforblock) {
12626: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
12627: if (@blockers) {
12628: $syval = '';
12629: return;
12630: }
12631: }
12632: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 12633: # ------------------------------------------ There is more than one possibility
12634: my $realpossible=0;
1.800 albertel 12635: foreach my $id (@possibilities) {
12636: my $file=$bighash{'src_'.$id};
1.1282 raeburn 12637: my $canaccess;
12638: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
12639: $canaccess = 1;
12640: } else {
12641: $canaccess = &allowed('bre',$file);
12642: }
12643: if ($canaccess) {
12644: my ($mapid,$resid)=split(/\./,$id);
12645: if ($bighash{'map_type_'.$mapid} ne 'page') {
12646: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
12647: $resid,$thisfn);
12648: if (ref($possibles) eq 'HASH') {
12649: $possibles->{$syval} = 1;
12650: }
12651: if ($checkforblock) {
12652: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
12653: unless (@blockers > 0) {
12654: $syval = $poss_syval;
12655: $realpossible++;
12656: }
12657: } else {
12658: $syval = $poss_syval;
12659: $realpossible++;
12660: }
12661: }
1.39 www 12662: }
1.191 harris41 12663: }
1.39 www 12664: if ($realpossible!=1) { $syval=''; }
1.249 www 12665: } else {
12666: $syval='';
1.37 www 12667: }
12668: }
1.1282 raeburn 12669: untie(%bighash);
1.481 raeburn 12670: }
1.31 www 12671: }
1.62 www 12672: if ($syval) {
1.620 albertel 12673: return $env{$cache_str}=$syval;
1.62 www 12674: }
1.31 www 12675: }
1.949 raeburn 12676: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 12677: return $env{$cache_str}='';
1.31 www 12678: }
12679:
12680: # ---------------------------------------------------------- Return random seed
12681:
1.32 www 12682: sub numval {
12683: my $txt=shift;
12684: $txt=~tr/A-J/0-9/;
12685: $txt=~tr/a-j/0-9/;
12686: $txt=~tr/K-T/0-9/;
12687: $txt=~tr/k-t/0-9/;
12688: $txt=~tr/U-Z/0-5/;
12689: $txt=~tr/u-z/0-5/;
12690: $txt=~s/\D//g;
1.564 albertel 12691: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 12692: return int($txt);
1.368 albertel 12693: }
12694:
1.484 albertel 12695: sub numval2 {
12696: my $txt=shift;
12697: $txt=~tr/A-J/0-9/;
12698: $txt=~tr/a-j/0-9/;
12699: $txt=~tr/K-T/0-9/;
12700: $txt=~tr/k-t/0-9/;
12701: $txt=~tr/U-Z/0-5/;
12702: $txt=~tr/u-z/0-5/;
12703: $txt=~s/\D//g;
12704: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
12705: my $total;
12706: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 12707: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 12708: return int($total);
12709: }
12710:
1.575 albertel 12711: sub numval3 {
12712: use integer;
12713: my $txt=shift;
12714: $txt=~tr/A-J/0-9/;
12715: $txt=~tr/a-j/0-9/;
12716: $txt=~tr/K-T/0-9/;
12717: $txt=~tr/k-t/0-9/;
12718: $txt=~tr/U-Z/0-5/;
12719: $txt=~tr/u-z/0-5/;
12720: $txt=~s/\D//g;
12721: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
12722: my $total;
12723: foreach my $val (@txts) { $total+=$val; }
12724: if ($_64bit) { $total=(($total<<32)>>32); }
12725: return $total;
12726: }
12727:
1.675 albertel 12728: sub digest {
12729: my ($data)=@_;
12730: my $digest=&Digest::MD5::md5($data);
12731: my ($a,$b,$c,$d)=unpack("iiii",$digest);
12732: my ($e,$f);
12733: {
12734: use integer;
12735: $e=($a+$b);
12736: $f=($c+$d);
12737: if ($_64bit) {
12738: $e=(($e<<32)>>32);
12739: $f=(($f<<32)>>32);
12740: }
12741: }
12742: if (wantarray) {
12743: return ($e,$f);
12744: } else {
12745: my $g;
12746: {
12747: use integer;
12748: $g=($e+$f);
12749: if ($_64bit) {
12750: $g=(($g<<32)>>32);
12751: }
12752: }
12753: return $g;
12754: }
12755: }
12756:
1.368 albertel 12757: sub latest_rnd_algorithm_id {
1.675 albertel 12758: return '64bit5';
1.366 albertel 12759: }
1.32 www 12760:
1.503 albertel 12761: sub get_rand_alg {
12762: my ($courseid)=@_;
1.790 albertel 12763: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 12764: if ($courseid) {
1.620 albertel 12765: return $env{"course.$courseid.rndseed"};
1.503 albertel 12766: }
12767: return &latest_rnd_algorithm_id();
12768: }
12769:
1.562 albertel 12770: sub validCODE {
12771: my ($CODE)=@_;
12772: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
12773: return 0;
12774: }
12775:
1.491 albertel 12776: sub getCODE {
1.620 albertel 12777: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 12778: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
12779: defined($Apache::lonhomework::parsing_a_task) ) &&
12780: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 12781: return $Apache::lonhomework::history{'resource.CODE'};
12782: }
12783: return undef;
12784: }
1.1133 foxr 12785: #
12786: # Determines the random seed for a specific context:
12787: #
12788: # parameters:
12789: # symb - in course context the symb for the seed.
12790: # course_id - The course id of the form domain_coursenum.
12791: # domain - Domain for the user.
12792: # course - Course for the user.
12793: # cenv - environment of the course.
12794: #
12795: # NOTE:
12796: # All parameters are picked out of the environment if missing
12797: # or not defined.
12798: # If a symb cannot be determined the current time is used instead.
12799: #
12800: # For a given well defined symb, courside, domain, username,
12801: # and course environment, the seed is reproducible.
12802: #
1.31 www 12803: sub rndseed {
1.1133 foxr 12804: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 12805: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 12806: if (!defined($symb)) {
1.366 albertel 12807: unless ($symb=$wsymb) { return time; }
12808: }
1.1146 foxr 12809: if (!defined $courseid) {
12810: $courseid=$wcourseid;
12811: }
12812: if (!defined $domain) { $domain=$wdomain; }
12813: if (!defined $username) { $username=$wusername }
1.1133 foxr 12814:
12815: my $which;
12816: if (defined($cenv->{'rndseed'})) {
12817: $which = $cenv->{'rndseed'};
12818: } else {
12819: $which =&get_rand_alg($courseid);
12820: }
1.491 albertel 12821: if (defined(&getCODE())) {
1.1133 foxr 12822:
1.675 albertel 12823: if ($which eq '64bit5') {
12824: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
12825: } elsif ($which eq '64bit4') {
1.575 albertel 12826: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
12827: } else {
12828: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
12829: }
1.675 albertel 12830: } elsif ($which eq '64bit5') {
12831: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 12832: } elsif ($which eq '64bit4') {
12833: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 12834: } elsif ($which eq '64bit3') {
12835: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 12836: } elsif ($which eq '64bit2') {
12837: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 12838: } elsif ($which eq '64bit') {
12839: return &rndseed_64bit($symb,$courseid,$domain,$username);
12840: }
12841: return &rndseed_32bit($symb,$courseid,$domain,$username);
12842: }
12843:
12844: sub rndseed_32bit {
12845: my ($symb,$courseid,$domain,$username)=@_;
12846: {
12847: use integer;
12848: my $symbchck=unpack("%32C*",$symb) << 27;
12849: my $symbseed=numval($symb) << 22;
12850: my $namechck=unpack("%32C*",$username) << 17;
12851: my $nameseed=numval($username) << 12;
12852: my $domainseed=unpack("%32C*",$domain) << 7;
12853: my $courseseed=unpack("%32C*",$courseid);
12854: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 12855: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12856: #&logthis("rndseed :$num:$symb");
1.564 albertel 12857: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 12858: return $num;
12859: }
12860: }
12861:
12862: sub rndseed_64bit {
12863: my ($symb,$courseid,$domain,$username)=@_;
12864: {
12865: use integer;
12866: my $symbchck=unpack("%32S*",$symb) << 21;
12867: my $symbseed=numval($symb) << 10;
12868: my $namechck=unpack("%32S*",$username);
12869:
12870: my $nameseed=numval($username) << 21;
12871: my $domainseed=unpack("%32S*",$domain) << 10;
12872: my $courseseed=unpack("%32S*",$courseid);
12873:
12874: my $num1=$symbchck+$symbseed+$namechck;
12875: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12876: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12877: #&logthis("rndseed :$num:$symb");
1.564 albertel 12878: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 12879: return "$num1,$num2";
1.155 albertel 12880: }
1.366 albertel 12881: }
12882:
1.443 albertel 12883: sub rndseed_64bit2 {
12884: my ($symb,$courseid,$domain,$username)=@_;
12885: {
12886: use integer;
12887: # strings need to be an even # of cahracters long, it it is odd the
12888: # last characters gets thrown away
12889: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12890: my $symbseed=numval($symb) << 10;
12891: my $namechck=unpack("%32S*",$username.' ');
12892:
12893: my $nameseed=numval($username) << 21;
1.501 albertel 12894: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12895: my $courseseed=unpack("%32S*",$courseid.' ');
12896:
12897: my $num1=$symbchck+$symbseed+$namechck;
12898: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12899: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12900: #&logthis("rndseed :$num:$symb");
1.803 albertel 12901: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 12902: return "$num1,$num2";
12903: }
12904: }
12905:
12906: sub rndseed_64bit3 {
12907: my ($symb,$courseid,$domain,$username)=@_;
12908: {
12909: use integer;
12910: # strings need to be an even # of cahracters long, it it is odd the
12911: # last characters gets thrown away
12912: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12913: my $symbseed=numval2($symb) << 10;
12914: my $namechck=unpack("%32S*",$username.' ');
12915:
12916: my $nameseed=numval2($username) << 21;
1.443 albertel 12917: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12918: my $courseseed=unpack("%32S*",$courseid.' ');
12919:
12920: my $num1=$symbchck+$symbseed+$namechck;
12921: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12922: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12923: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 12924: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 12925:
1.503 albertel 12926: return "$num1:$num2";
1.443 albertel 12927: }
12928: }
12929:
1.575 albertel 12930: sub rndseed_64bit4 {
12931: my ($symb,$courseid,$domain,$username)=@_;
12932: {
12933: use integer;
12934: # strings need to be an even # of cahracters long, it it is odd the
12935: # last characters gets thrown away
12936: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12937: my $symbseed=numval3($symb) << 10;
12938: my $namechck=unpack("%32S*",$username.' ');
12939:
12940: my $nameseed=numval3($username) << 21;
12941: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12942: my $courseseed=unpack("%32S*",$courseid.' ');
12943:
12944: my $num1=$symbchck+$symbseed+$namechck;
12945: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12946: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12947: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 12948: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 12949:
1.575 albertel 12950: return "$num1:$num2";
12951: }
12952: }
12953:
1.675 albertel 12954: sub rndseed_64bit5 {
12955: my ($symb,$courseid,$domain,$username)=@_;
12956: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
12957: return "$num1:$num2";
12958: }
12959:
1.366 albertel 12960: sub rndseed_CODE_64bit {
12961: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 12962: {
1.366 albertel 12963: use integer;
1.443 albertel 12964: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 12965: my $symbseed=numval2($symb);
1.491 albertel 12966: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12967: my $CODEseed=numval(&getCODE());
1.443 albertel 12968: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 12969: my $num1=$symbseed+$CODEchck;
12970: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12971: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12972: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 12973: if ($_64bit) { $num1=(($num1<<32)>>32); }
12974: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 12975: return "$num1:$num2";
1.366 albertel 12976: }
12977: }
12978:
1.575 albertel 12979: sub rndseed_CODE_64bit4 {
12980: my ($symb,$courseid,$domain,$username)=@_;
12981: {
12982: use integer;
12983: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12984: my $symbseed=numval3($symb);
12985: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12986: my $CODEseed=numval3(&getCODE());
12987: my $courseseed=unpack("%32S*",$courseid.' ');
12988: my $num1=$symbseed+$CODEchck;
12989: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12990: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12991: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 12992: if ($_64bit) { $num1=(($num1<<32)>>32); }
12993: if ($_64bit) { $num2=(($num2<<32)>>32); }
12994: return "$num1:$num2";
12995: }
12996: }
12997:
1.675 albertel 12998: sub rndseed_CODE_64bit5 {
12999: my ($symb,$courseid,$domain,$username)=@_;
13000: my $code = &getCODE();
13001: my ($num1,$num2)=&digest("$symb,$courseid,$code");
13002: return "$num1:$num2";
13003: }
13004:
1.366 albertel 13005: sub setup_random_from_rndseed {
13006: my ($rndseed)=@_;
1.503 albertel 13007: if ($rndseed =~/([,:])/) {
1.1262 raeburn 13008: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
13009: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
13010: &Math::Random::random_set_seed_from_phrase($rndseed);
13011: } else {
13012: &Math::Random::random_set_seed($num1,$num2);
13013: }
1.366 albertel 13014: } else {
13015: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 13016: }
1.36 albertel 13017: }
13018:
1.474 albertel 13019: sub latest_receipt_algorithm_id {
1.835 albertel 13020: return 'receipt3';
1.474 albertel 13021: }
13022:
1.480 www 13023: sub recunique {
13024: my $fucourseid=shift;
13025: my $unique;
1.835 albertel 13026: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
13027: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 13028: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 13029: } else {
13030: $unique=$perlvar{'lonReceipt'};
13031: }
13032: return unpack("%32C*",$unique);
13033: }
13034:
13035: sub recprefix {
13036: my $fucourseid=shift;
13037: my $prefix;
1.835 albertel 13038: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
13039: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 13040: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 13041: } else {
13042: $prefix=$perlvar{'lonHostID'};
13043: }
13044: return unpack("%32C*",$prefix);
13045: }
13046:
1.76 www 13047: sub ireceipt {
1.474 albertel 13048: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 13049:
13050: my $return =&recprefix($fucourseid).'-';
13051:
13052: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
13053: $env{'request.state'} eq 'construct') {
13054: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
13055: return $return;
13056: }
13057:
1.76 www 13058: my $cuname=unpack("%32C*",$funame);
13059: my $cudom=unpack("%32C*",$fudom);
13060: my $cucourseid=unpack("%32C*",$fucourseid);
13061: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 13062: my $cunique=&recunique($fucourseid);
1.474 albertel 13063: my $cpart=unpack("%32S*",$part);
1.835 albertel 13064: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
13065:
1.790 albertel 13066: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 13067:
13068: $return.= ($cunique%$cuname+
13069: $cunique%$cudom+
13070: $cusymb%$cuname+
13071: $cusymb%$cudom+
13072: $cucourseid%$cuname+
13073: $cucourseid%$cudom+
13074: $cpart%$cuname+
13075: $cpart%$cudom);
13076: } else {
13077: $return.= ($cunique%$cuname+
13078: $cunique%$cudom+
13079: $cusymb%$cuname+
13080: $cusymb%$cudom+
13081: $cucourseid%$cuname+
13082: $cucourseid%$cudom);
13083: }
13084: return $return;
1.76 www 13085: }
13086:
13087: sub receipt {
1.474 albertel 13088: my ($part)=@_;
1.790 albertel 13089: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 13090: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 13091: }
1.260 ng 13092:
1.790 albertel 13093: sub whichuser {
13094: my ($passedsymb)=@_;
13095: my ($symb,$courseid,$domain,$name,$publicuser);
13096: if (defined($env{'form.grade_symb'})) {
13097: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
13098: my $allowed=&allowed('vgr',$tmp_courseid);
13099: if (!$allowed &&
13100: exists($env{'request.course.sec'}) &&
13101: $env{'request.course.sec'} !~ /^\s*$/) {
13102: $allowed=&allowed('vgr',$tmp_courseid.
13103: '/'.$env{'request.course.sec'});
13104: }
13105: if ($allowed) {
13106: ($symb)=&get_env_multiple('form.grade_symb');
13107: $courseid=$tmp_courseid;
13108: ($domain)=&get_env_multiple('form.grade_domain');
13109: ($name)=&get_env_multiple('form.grade_username');
13110: return ($symb,$courseid,$domain,$name,$publicuser);
13111: }
13112: }
13113: if (!$passedsymb) {
13114: $symb=&symbread();
13115: } else {
13116: $symb=$passedsymb;
13117: }
13118: $courseid=$env{'request.course.id'};
13119: $domain=$env{'user.domain'};
13120: $name=$env{'user.name'};
13121: if ($name eq 'public' && $domain eq 'public') {
13122: if (!defined($env{'form.username'})) {
13123: $env{'form.username'}.=time.rand(10000000);
13124: }
13125: $name.=$env{'form.username'};
13126: }
13127: return ($symb,$courseid,$domain,$name,$publicuser);
13128:
13129: }
13130:
1.36 albertel 13131: # ------------------------------------------------------------ Serves up a file
1.472 albertel 13132: # returns either the contents of the file or
13133: # -1 if the file doesn't exist
1.481 raeburn 13134: #
13135: # if the target is a file that was uploaded via DOCS,
13136: # a check will be made to see if a current copy exists on the local server,
13137: # if it does this will be served, otherwise a copy will be retrieved from
13138: # the home server for the course and stored in /home/httpd/html/userfiles on
13139: # the local server.
1.472 albertel 13140:
1.36 albertel 13141: sub getfile {
1.538 albertel 13142: my ($file) = @_;
1.609 banghart 13143: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 13144: &repcopy($file);
13145: return &readfile($file);
13146: }
13147:
13148: sub repcopy_userfile {
13149: my ($file)=@_;
1.1142 raeburn 13150: my $londocroot = $perlvar{'lonDocRoot'};
13151: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 13152: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 13153: my ($cdom,$cnum,$filename) =
1.811 albertel 13154: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 13155: my $uri="/uploaded/$cdom/$cnum/$filename";
13156: if (-e "$file") {
1.828 www 13157: # we already have a local copy, check it out
1.538 albertel 13158: my @fileinfo = stat($file);
1.828 www 13159: my $rtncode;
13160: my $info;
1.538 albertel 13161: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 13162: if ($lwpresp ne 'ok') {
1.828 www 13163: # there is no such file anymore, even though we had a local copy
1.482 albertel 13164: if ($rtncode eq '404') {
1.538 albertel 13165: unlink($file);
1.482 albertel 13166: }
13167: return -1;
13168: }
13169: if ($info < $fileinfo[9]) {
1.828 www 13170: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 13171: return 'ok';
1.828 www 13172: } else {
13173: # the file is outdated, get rid of it
13174: unlink($file);
1.482 albertel 13175: }
1.828 www 13176: }
13177: # one way or the other, at this point, we don't have the file
13178: # construct the correct path for the file
13179: my @parts = ($cdom,$cnum);
13180: if ($filename =~ m|^(.+)/[^/]+$|) {
13181: push @parts, split(/\//,$1);
13182: }
13183: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
13184: foreach my $part (@parts) {
13185: $path .= '/'.$part;
13186: if (!-e $path) {
13187: mkdir($path,0770);
1.482 albertel 13188: }
13189: }
1.828 www 13190: # now the path exists for sure
13191: # get a user agent
13192: my $transferfile=$file.'.in.transfer';
13193: # FIXME: this should flock
13194: if (-e $transferfile) { return 'ok'; }
13195: my $request;
13196: $uri=~s/^\///;
1.980 raeburn 13197: my $homeserver = &homeserver($cnum,$cdom);
13198: my $protocol = $protocol{$homeserver};
13199: $protocol = 'http' if ($protocol ne 'https');
13200: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.1345 raeburn 13201: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
1.828 www 13202: # did it work?
13203: if ($response->is_error()) {
13204: unlink($transferfile);
13205: &logthis("Userfile repcopy failed for $uri");
13206: return -1;
13207: }
13208: # worked, rename the transfer file
13209: rename($transferfile,$file);
1.607 raeburn 13210: return 'ok';
1.481 raeburn 13211: }
13212:
1.517 albertel 13213: sub tokenwrapper {
13214: my $uri=shift;
1.980 raeburn 13215: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 13216: $uri=~s|^/||;
1.620 albertel 13217: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 13218: my $token=$1;
1.552 albertel 13219: my (undef,$udom,$uname,$file)=split('/',$uri,4);
13220: if ($udom && $uname && $file) {
13221: $file=~s|(\?\.*)*$||;
1.949 raeburn 13222: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 13223: my $homeserver = &homeserver($uname,$udom);
13224: my $protocol = $protocol{$homeserver};
13225: $protocol = 'http' if ($protocol ne 'https');
13226: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 13227: (($uri=~/\?/)?'&':'?').'token='.$token.
13228: '&tokenissued='.$perlvar{'lonHostID'};
13229: } else {
13230: return '/adm/notfound.html';
13231: }
13232: }
13233:
1.828 www 13234: # call with reqtype HEAD: get last modification time
13235: # call with reqtype GET: get the file contents
13236: # Do not call this with reqtype GET for large files! It loads everything into memory
13237: #
1.481 raeburn 13238: sub getuploaded {
13239: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
13240: $uri=~s/^\///;
1.980 raeburn 13241: my $homeserver = &homeserver($cnum,$cdom);
13242: my $protocol = $protocol{$homeserver};
13243: $protocol = 'http' if ($protocol ne 'https');
13244: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 13245: my $request=new HTTP::Request($reqtype,$uri);
1.1345 raeburn 13246: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
1.481 raeburn 13247: $$rtncode = $response->code;
1.482 albertel 13248: if (! $response->is_success()) {
13249: return 'failed';
13250: }
13251: if ($reqtype eq 'HEAD') {
1.486 www 13252: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 13253: } elsif ($reqtype eq 'GET') {
13254: $$info = $response->content;
1.472 albertel 13255: }
1.482 albertel 13256: return 'ok';
1.36 albertel 13257: }
13258:
1.481 raeburn 13259: sub readfile {
13260: my $file = shift;
13261: if ( (! -e $file ) || ($file eq '') ) { return -1; };
13262: my $fh;
1.1359 raeburn 13263: open($fh,"<",$file);
1.481 raeburn 13264: my $a='';
1.800 albertel 13265: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 13266: return $a;
13267: }
13268:
1.36 albertel 13269: sub filelocation {
1.590 banghart 13270: my ($dir,$file) = @_;
13271: my $location;
13272: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 13273:
13274: if ($file =~ m-^/adm/-) {
13275: $file=~s-^/adm/wrapper/-/-;
13276: $file=~s-^/adm/coursedocs/showdoc/-/-;
13277: }
1.882 albertel 13278:
1.1139 www 13279: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 13280: $location = $file;
1.609 banghart 13281: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 13282: my ($udom,$uname,$filename)=
1.811 albertel 13283: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 13284: my $home=&homeserver($uname,$udom);
13285: my $is_me=0;
13286: my @ids=¤t_machine_ids();
13287: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
13288: if ($is_me) {
1.1117 foxr 13289: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 13290: } else {
13291: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
13292: $udom.'/'.$uname.'/'.$filename;
13293: }
1.882 albertel 13294: } elsif ($file =~ m-^/adm/-) {
13295: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 13296: } else {
13297: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 13298: $file=~s:^/(res|priv)/:/:;
13299: my $space=$1;
1.590 banghart 13300: if ( !( $file =~ m:^/:) ) {
13301: $location = $dir. '/'.$file;
13302: } else {
1.1142 raeburn 13303: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 13304: }
1.59 albertel 13305: }
1.590 banghart 13306: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 13307: while ($location=~m{/\.\./}) {
13308: if ($location =~ m{/[^/]+/\.\./}) {
13309: $location=~ s{/[^/]+/\.\./}{/}g;
13310: } else {
13311: $location=~ s{/\.\./}{/}g;
13312: }
13313: } #remove dir/..
1.590 banghart 13314: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
13315: return $location;
1.46 www 13316: }
1.36 albertel 13317:
1.46 www 13318: sub hreflocation {
13319: my ($dir,$file)=@_;
1.980 raeburn 13320: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 13321: $file=filelocation($dir,$file);
1.700 albertel 13322: } elsif ($file=~m-^/adm/-) {
13323: $file=~s-^/adm/wrapper/-/-;
13324: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 13325: }
13326: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
13327: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
13328: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 13329: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
13330: {/uploaded/$1/$2/}x;
1.46 www 13331: }
1.913 albertel 13332: if ($file=~ m{^/userfiles/}) {
13333: $file =~ s{^/userfiles/}{/uploaded/};
13334: }
1.462 albertel 13335: return $file;
1.465 albertel 13336: }
13337:
1.1139 www 13338:
13339:
13340:
13341:
1.465 albertel 13342: sub current_machine_domains {
1.853 albertel 13343: return &machine_domains(&hostname($perlvar{'lonHostID'}));
13344: }
13345:
13346: sub machine_domains {
13347: my ($hostname) = @_;
1.465 albertel 13348: my @domains;
1.838 albertel 13349: my %hostname = &all_hostnames();
1.465 albertel 13350: while( my($id, $name) = each(%hostname)) {
1.467 matthew 13351: # &logthis("-$id-$name-$hostname-");
1.465 albertel 13352: if ($hostname eq $name) {
1.844 albertel 13353: push(@domains,&host_domain($id));
1.465 albertel 13354: }
13355: }
13356: return @domains;
13357: }
13358:
13359: sub current_machine_ids {
1.853 albertel 13360: return &machine_ids(&hostname($perlvar{'lonHostID'}));
13361: }
13362:
13363: sub machine_ids {
13364: my ($hostname) = @_;
13365: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 13366: my @ids;
1.888 albertel 13367: my %name_to_host = &all_names();
1.889 albertel 13368: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
13369: return @{ $name_to_host{$hostname} };
13370: }
13371: return;
1.31 www 13372: }
13373:
1.824 raeburn 13374: sub additional_machine_domains {
13375: my @domains;
1.1359 raeburn 13376: open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab");
1.824 raeburn 13377: while( my $line = <$fh>) {
13378: $line =~ s/\s//g;
13379: push(@domains,$line);
13380: }
13381: return @domains;
13382: }
13383:
13384: sub default_login_domain {
13385: my $domain = $perlvar{'lonDefDomain'};
13386: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
13387: foreach my $posdom (¤t_machine_domains(),
13388: &additional_machine_domains()) {
13389: if (lc($posdom) eq lc($testdomain)) {
13390: $domain=$posdom;
13391: last;
13392: }
13393: }
13394: return $domain;
13395: }
13396:
1.31 www 13397: # ------------------------------------------------------------- Declutters URLs
13398:
13399: sub declutter {
13400: my $thisfn=shift;
1.569 albertel 13401: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261 raeburn 13402: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
13403: $thisfn=~s{^/home/httpd/html}{};
13404: }
1.31 www 13405: $thisfn=~s/^\///;
1.697 albertel 13406: $thisfn=~s|^adm/wrapper/||;
13407: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 13408: $thisfn=~s/^res\///;
1.1172 bisitz 13409: $thisfn=~s/^priv\///;
1.1032 raeburn 13410: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
13411: $thisfn=~s/\?.+$//;
13412: }
1.268 www 13413: return $thisfn;
13414: }
13415:
13416: # ------------------------------------------------------------- Clutter up URLs
13417:
13418: sub clutter {
13419: my $thisfn='/'.&declutter(shift);
1.887 albertel 13420: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 13421: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 13422: $thisfn='/res'.$thisfn;
13423: }
1.1031 raeburn 13424: if ($thisfn !~m|^/adm|) {
13425: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 13426: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 13427: } else {
13428: my ($ext) = ($thisfn =~ /\.(\w+)$/);
13429: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 13430: if ($embstyle eq 'ssi'
13431: || ($embstyle eq 'hdn')
13432: || ($embstyle eq 'rat')
13433: || ($embstyle eq 'prv')
13434: || ($embstyle eq 'ign')) {
13435: #do nothing with these
13436: } elsif (($embstyle eq 'img')
1.695 albertel 13437: || ($embstyle eq 'emb')
13438: || ($embstyle eq 'wrp')) {
13439: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 13440: } elsif ($embstyle eq 'unk'
13441: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 13442: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 13443: } else {
1.718 www 13444: # &logthis("Got a blank emb style");
1.695 albertel 13445: }
1.694 albertel 13446: }
1.1343 raeburn 13447: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
1.1298 raeburn 13448: $thisfn='/adm/wrapper'.$thisfn;
1.694 albertel 13449: }
1.31 www 13450: return $thisfn;
1.12 www 13451: }
13452:
1.787 albertel 13453: sub clutter_with_no_wrapper {
13454: my $uri = &clutter(shift);
13455: if ($uri =~ m-^/adm/-) {
13456: $uri =~ s-^/adm/wrapper/-/-;
13457: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
13458: }
13459: return $uri;
13460: }
13461:
1.557 albertel 13462: sub freeze_escape {
13463: my ($value)=@_;
13464: if (ref($value)) {
13465: $value=&nfreeze($value);
13466: return '__FROZEN__'.&escape($value);
13467: }
13468: return &escape($value);
13469: }
13470:
1.11 www 13471:
1.557 albertel 13472: sub thaw_unescape {
13473: my ($value)=@_;
13474: if ($value =~ /^__FROZEN__/) {
13475: substr($value,0,10,undef);
13476: $value=&unescape($value);
13477: return &thaw($value);
13478: }
13479: return &unescape($value);
13480: }
13481:
1.436 albertel 13482: sub correct_line_ends {
13483: my ($result)=@_;
13484: $$result =~s/\r\n/\n/mg;
13485: $$result =~s/\r/\n/mg;
1.415 albertel 13486: }
1.1 albertel 13487: # ================================================================ Main Program
13488:
1.184 www 13489: sub goodbye {
1.204 albertel 13490: &logthis("Starting Shut down");
1.443 albertel 13491: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 13492: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 13493: #converted
1.599 albertel 13494: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 13495: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
13496: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
13497: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 13498: #1.1 only
1.870 albertel 13499: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
13500: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
13501: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
13502: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
13503: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 13504: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
13505: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 13506: &flushcourselogs();
13507: &logthis("Shutting down");
13508: }
13509:
1.852 albertel 13510: sub get_dns {
1.1210 raeburn 13511: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 13512: if (!$ignore_cache) {
13513: my ($content,$cached)=
13514: &Apache::lonnet::is_cached_new('dns',$url);
13515: if ($cached) {
1.1210 raeburn 13516: &$func($content,$hashref);
1.869 albertel 13517: return;
13518: }
13519: }
13520:
13521: my %alldns;
1.1379 raeburn 13522: if (open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab")) {
13523: foreach my $dns (<$config>) {
13524: next if ($dns !~ /^\^(\S*)/x);
13525: my $line = $1;
13526: my ($host,$protocol) = split(/:/,$line);
13527: if ($protocol ne 'https') {
13528: $protocol = 'http';
13529: }
13530: $alldns{$host} = $protocol;
1.979 raeburn 13531: }
1.1379 raeburn 13532: close($config);
1.869 albertel 13533: }
13534: while (%alldns) {
1.1263 raeburn 13535: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.979 raeburn 13536: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.1345 raeburn 13537: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
1.979 raeburn 13538: delete($alldns{$dns});
1.852 albertel 13539: next if ($response->is_error());
1.1379 raeburn 13540: if ($url eq '/adm/dns/loncapaCRL') {
13541: return &$func($response);
13542: } else {
13543: my @content = split("\n",$response->content);
13544: unless ($nocache) {
13545: &do_cache_new('dns',$url,\@content,30*24*60*60);
13546: }
13547: &$func(\@content,$hashref);
13548: return;
13549: }
13550: }
13551: my $which = (split('/',$url,4))[3];
13552: if ($which eq 'loncapaCRL') {
13553: my $diskfile = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
13554: if (-e $diskfile) {
13555: &logthis("unable to contact DNS, on disk file $diskfile not updated");
13556: } else {
13557: &logthis("unable to contact DNS, no on disk file $diskfile available");
13558: }
13559: } else {
13560: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
13561: if (open(my $config,"<","$perlvar{'lonTabDir'}/dns_$which.tab")) {
13562: my @content = <$config>;
13563: close($config);
13564: &$func(\@content,$hashref);
13565: }
1.852 albertel 13566: }
1.1210 raeburn 13567: return;
13568: }
13569:
13570: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 13571: sub parse_dns_checksums_tab {
1.1210 raeburn 13572: my ($lines,$hashref) = @_;
1.1264 raeburn 13573: my $lonhost = $perlvar{'lonHostID'};
13574: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1210 raeburn 13575: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264 raeburn 13576: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
13577: my $webconfdir = '/etc/httpd/conf';
13578: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
13579: $webconfdir = '/etc/apache2';
13580: } elsif ($distro =~ /^sles(\d+)$/) {
13581: if ($1 >= 10) {
13582: $webconfdir = '/etc/apache2';
13583: }
13584: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
13585: if ($1 >= 10.0) {
13586: $webconfdir = '/etc/apache2';
13587: }
13588: }
1.1210 raeburn 13589: my ($release,$timestamp) = split(/\-/,$loncaparev);
13590: my (%chksum,%revnum);
13591: if (ref($lines) eq 'ARRAY') {
13592: chomp(@{$lines});
1.1238 raeburn 13593: my $version = shift(@{$lines});
13594: if ($version eq $release) {
1.1210 raeburn 13595: foreach my $line (@{$lines}) {
1.1238 raeburn 13596: my ($file,$version,$shasum) = split(/,/,$line);
1.1264 raeburn 13597: if ($file =~ m{^/etc/httpd/conf}) {
13598: if ($webconfdir eq '/etc/apache2') {
13599: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
13600: }
13601: }
1.1238 raeburn 13602: $chksum{$file} = $shasum;
13603: $revnum{$file} = $version;
1.1210 raeburn 13604: }
13605: if (ref($hashref) eq 'HASH') {
13606: %{$hashref} = (
13607: sums => \%chksum,
13608: versions => \%revnum,
13609: );
13610: }
13611: }
13612: }
1.869 albertel 13613: return;
1.852 albertel 13614: }
1.1210 raeburn 13615:
13616: sub fetch_dns_checksums {
1.1238 raeburn 13617: my %checksums;
13618: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1260 raeburn 13619: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238 raeburn 13620: my ($release,$timestamp) = split(/\-/,$loncaparev);
13621: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211 raeburn 13622: \%checksums);
1.1210 raeburn 13623: return \%checksums;
13624: }
13625:
1.1379 raeburn 13626: sub fetch_crl_pemfile {
13627: return &get_dns("/adm/dns/loncapaCRL",\&save_crl_pem,1,1);
13628: }
13629:
13630: sub save_crl_pem {
13631: my ($response) = @_;
1.1380 ! raeburn 13632: my ($msg,$hadchanges);
1.1379 raeburn 13633: if (ref($response)) {
13634: my $now = time;
13635: my $lonca = $perlvar{'lonCertificateDirectory'}.'/'.$perlvar{'lonnetCertificateAuthority'};
13636: my $tmpcrl = $tmpdir.'/'.$perlvar{'lonnetCertRevocationList'}.'_'.$now.'.'.$$.'.tmp';
13637: if (open(my $fh,'>',"$tmpcrl")) {
13638: print $fh $response->content;
13639: close($fh);
13640: if (-e $lonca) {
13641: if (open(PIPE,"openssl crl -in $tmpcrl -inform pem -CAfile $lonca -noout 2>&1 |")) {
13642: my $check = <PIPE>;
13643: close(PIPE);
13644: chomp($check);
13645: if ($check eq 'verify OK') {
13646: my $dest = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
1.1380 ! raeburn 13647: my $backup;
1.1379 raeburn 13648: if (-e $dest) {
1.1380 ! raeburn 13649: if (&File::Copy::move($dest,"$dest.bak")) {
! 13650: $backup = 'ok';
! 13651: }
1.1379 raeburn 13652: }
13653: if (&File::Copy::move($tmpcrl,$dest)) {
13654: $msg = 'ok';
1.1380 ! raeburn 13655: if ($backup) {
! 13656: my (%oldnums,%newnums);
! 13657: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest.bak |grep 'Serial Number' |")) {
! 13658: while (<PIPE>) {
! 13659: $oldnums{(split(/:/))[1]} = 1;
! 13660: }
! 13661: close(PIPE);
! 13662: }
! 13663: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest |grep 'Serial Number' |")) {
! 13664: while(<PIPE>) {
! 13665: $newnums{(split(/:/))[1]} = 1;
! 13666: }
! 13667: close(PIPE);
! 13668: }
! 13669: foreach my $key (sort {$b <=> $a } (keys(%newnums))) {
! 13670: unless (exists($oldnums{$key})) {
! 13671: $hadchanges = 1;
! 13672: last;
! 13673: }
! 13674: }
! 13675: unless ($hadchanges) {
! 13676: foreach my $key (sort {$b <=> $a } (keys(%oldnums))) {
! 13677: unless (exists($newnums{$key})) {
! 13678: $hadchanges = 1;
! 13679: last;
! 13680: }
! 13681: }
! 13682: }
! 13683: }
1.1379 raeburn 13684: }
13685: } else {
13686: unlink($tmpcrl);
13687: }
13688: } else {
13689: unlink($tmpcrl);
13690: }
13691: } else {
13692: unlink($tmpcrl);
13693: }
13694: }
13695: }
1.1380 ! raeburn 13696: return ($msg,$hadchanges);
1.1379 raeburn 13697: }
13698:
1.327 albertel 13699: # ------------------------------------------------------------ Read domain file
13700: {
1.852 albertel 13701: my $loaded;
1.846 albertel 13702: my %domain;
13703:
1.852 albertel 13704: sub parse_domain_tab {
13705: my ($lines) = @_;
13706: foreach my $line (@$lines) {
13707: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 13708:
1.846 albertel 13709: chomp($line);
1.852 albertel 13710: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 13711: my %this_domain;
13712: foreach my $field ('description', 'auth_def', 'auth_arg_def',
13713: 'lang_def', 'city', 'longi', 'lati',
13714: 'primary') {
13715: $this_domain{$field} = shift(@elements);
13716: }
13717: $domain{$name} = \%this_domain;
1.852 albertel 13718: }
13719: }
1.864 albertel 13720:
13721: sub reset_domain_info {
13722: undef($loaded);
13723: undef(%domain);
13724: }
13725:
1.852 albertel 13726: sub load_domain_tab {
1.1293 raeburn 13727: my ($ignore_cache,$nocache) = @_;
13728: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 13729: my $fh;
1.1359 raeburn 13730: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
1.852 albertel 13731: my @lines = <$fh>;
13732: &parse_domain_tab(\@lines);
1.448 albertel 13733: }
1.852 albertel 13734: close($fh);
13735: $loaded = 1;
1.327 albertel 13736: }
1.846 albertel 13737:
13738: sub domain {
1.852 albertel 13739: &load_domain_tab() if (!$loaded);
13740:
1.846 albertel 13741: my ($name,$what) = @_;
13742: return if ( !exists($domain{$name}) );
13743:
13744: if (!$what) {
13745: return $domain{$name}{'description'};
13746: }
13747: return $domain{$name}{$what};
13748: }
1.974 raeburn 13749:
13750: sub domain_info {
13751: &load_domain_tab() if (!$loaded);
13752: return %domain;
13753: }
13754:
1.327 albertel 13755: }
13756:
13757:
1.1 albertel 13758: # ------------------------------------------------------------- Read hosts file
13759: {
1.838 albertel 13760: my %hostname;
1.844 albertel 13761: my %hostdom;
1.845 albertel 13762: my %libserv;
1.852 albertel 13763: my $loaded;
1.888 albertel 13764: my %name_to_host;
1.1074 raeburn 13765: my %internetdom;
1.1107 raeburn 13766: my %LC_dns_serv;
1.852 albertel 13767:
13768: sub parse_hosts_tab {
13769: my ($file) = @_;
13770: foreach my $configline (@$file) {
13771: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 13772: chomp($configline);
13773: if ($configline =~ /^\^/) {
13774: if ($configline =~ /^\^([\w.\-]+)/) {
13775: $LC_dns_serv{$1} = 1;
13776: }
13777: next;
13778: }
1.1074 raeburn 13779: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 13780: $name=~s/\s//g;
13781: if ($id && $domain && $role && $name) {
1.1351 raeburn 13782: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
13783: my $curr = $hostname{$id};
13784: my $skip;
13785: if (ref($name_to_host{$curr}) eq 'ARRAY') {
13786: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
13787: $skip = 1;
13788: } else {
13789: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
13790: }
13791: }
13792: unless ($skip) {
13793: push(@{$name_to_host{$name}},$id);
13794: }
13795: } else {
13796: push(@{$name_to_host{$name}},$id);
13797: }
1.852 albertel 13798: $hostname{$id}=$name;
13799: $hostdom{$id}=$domain;
13800: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 13801: if (defined($protocol)) {
13802: if ($protocol eq 'https') {
13803: $protocol{$id} = $protocol;
13804: } else {
13805: $protocol{$id} = 'http';
13806: }
1.968 raeburn 13807: } else {
1.969 raeburn 13808: $protocol{$id} = 'http';
1.968 raeburn 13809: }
1.1074 raeburn 13810: if (defined($intdom)) {
13811: $internetdom{$id} = $intdom;
13812: }
1.852 albertel 13813: }
13814: }
13815: }
1.864 albertel 13816:
13817: sub reset_hosts_info {
1.897 albertel 13818: &purge_remembered();
1.864 albertel 13819: &reset_domain_info();
13820: &reset_hosts_ip_info();
1.1339 raeburn 13821: undef(%internetdom);
1.892 albertel 13822: undef(%name_to_host);
1.864 albertel 13823: undef(%hostname);
13824: undef(%hostdom);
13825: undef(%libserv);
13826: undef($loaded);
13827: }
1.1 albertel 13828:
1.852 albertel 13829: sub load_hosts_tab {
1.1293 raeburn 13830: my ($ignore_cache,$nocache) = @_;
13831: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.1359 raeburn 13832: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852 albertel 13833: my @config = <$config>;
13834: &parse_hosts_tab(\@config);
13835: close($config);
13836: $loaded=1;
1.1 albertel 13837: }
1.852 albertel 13838:
1.838 albertel 13839: sub hostname {
1.852 albertel 13840: &load_hosts_tab() if (!$loaded);
13841:
1.838 albertel 13842: my ($lonid) = @_;
13843: return $hostname{$lonid};
13844: }
1.845 albertel 13845:
1.838 albertel 13846: sub all_hostnames {
1.852 albertel 13847: &load_hosts_tab() if (!$loaded);
13848:
1.838 albertel 13849: return %hostname;
13850: }
1.845 albertel 13851:
1.888 albertel 13852: sub all_names {
1.1293 raeburn 13853: my ($ignore_cache,$nocache) = @_;
13854: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 13855:
13856: return %name_to_host;
13857: }
13858:
1.974 raeburn 13859: sub all_host_domain {
13860: &load_hosts_tab() if (!$loaded);
13861: return %hostdom;
13862: }
13863:
1.1339 raeburn 13864: sub all_host_intdom {
13865: &load_hosts_tab() if (!$loaded);
13866: return %internetdom;
13867: }
13868:
1.845 albertel 13869: sub is_library {
1.852 albertel 13870: &load_hosts_tab() if (!$loaded);
13871:
1.845 albertel 13872: return exists($libserv{$_[0]});
13873: }
13874:
13875: sub all_library {
1.852 albertel 13876: &load_hosts_tab() if (!$loaded);
13877:
1.845 albertel 13878: return %libserv;
13879: }
13880:
1.1062 droeschl 13881: sub unique_library {
13882: #2x reverse removes all hostnames that appear more than once
13883: my %unique = reverse &all_library();
13884: return reverse %unique;
13885: }
13886:
1.841 albertel 13887: sub get_servers {
1.852 albertel 13888: &load_hosts_tab() if (!$loaded);
13889:
1.841 albertel 13890: my ($domain,$type) = @_;
13891: my %possible_hosts = ($type eq 'library') ? %libserv
13892: : %hostname;
13893: my %result;
1.842 albertel 13894: if (ref($domain) eq 'ARRAY') {
13895: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 13896: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 13897: $result{$host} = $hostname;
13898: }
13899: }
13900: } else {
13901: while ( my ($host,$hostname) = each(%possible_hosts)) {
13902: if ($hostdom{$host} eq $domain) {
13903: $result{$host} = $hostname;
13904: }
1.841 albertel 13905: }
13906: }
13907: return %result;
13908: }
1.845 albertel 13909:
1.1062 droeschl 13910: sub get_unique_servers {
13911: my %unique = reverse &get_servers(@_);
13912: return reverse %unique;
13913: }
13914:
1.844 albertel 13915: sub host_domain {
1.852 albertel 13916: &load_hosts_tab() if (!$loaded);
13917:
1.844 albertel 13918: my ($lonid) = @_;
13919: return $hostdom{$lonid};
13920: }
13921:
1.841 albertel 13922: sub all_domains {
1.852 albertel 13923: &load_hosts_tab() if (!$loaded);
13924:
1.841 albertel 13925: my %seen;
13926: my @uniq = grep(!$seen{$_}++, values(%hostdom));
13927: return @uniq;
13928: }
1.1074 raeburn 13929:
13930: sub internet_dom {
13931: &load_hosts_tab() if (!$loaded);
13932:
13933: my ($lonid) = @_;
13934: return $internetdom{$lonid};
13935: }
1.1107 raeburn 13936:
13937: sub is_LC_dns {
13938: &load_hosts_tab() if (!$loaded);
13939:
13940: my ($hostname) = @_;
13941: return exists($LC_dns_serv{$hostname});
13942: }
13943:
1.1 albertel 13944: }
13945:
1.847 albertel 13946: {
13947: my %iphost;
1.856 albertel 13948: my %name_to_ip;
13949: my %lonid_to_ip;
1.869 albertel 13950:
1.847 albertel 13951: sub get_hosts_from_ip {
13952: my ($ip) = @_;
13953: my %iphosts = &get_iphost();
13954: if (ref($iphosts{$ip})) {
13955: return @{$iphosts{$ip}};
13956: }
13957: return;
1.839 albertel 13958: }
1.864 albertel 13959:
13960: sub reset_hosts_ip_info {
13961: undef(%iphost);
13962: undef(%name_to_ip);
13963: undef(%lonid_to_ip);
13964: }
1.856 albertel 13965:
13966: sub get_host_ip {
13967: my ($lonid) = @_;
13968: if (exists($lonid_to_ip{$lonid})) {
13969: return $lonid_to_ip{$lonid};
13970: }
13971: my $name=&hostname($lonid);
13972: my $ip = gethostbyname($name);
13973: return if (!$ip || length($ip) ne 4);
13974: $ip=inet_ntoa($ip);
13975: $name_to_ip{$name} = $ip;
13976: $lonid_to_ip{$lonid} = $ip;
13977: return $ip;
13978: }
1.847 albertel 13979:
13980: sub get_iphost {
1.1293 raeburn 13981: my ($ignore_cache,$nocache) = @_;
1.894 albertel 13982:
1.869 albertel 13983: if (!$ignore_cache) {
13984: if (%iphost) {
13985: return %iphost;
13986: }
13987: my ($ip_info,$cached)=
13988: &Apache::lonnet::is_cached_new('iphost','iphost');
13989: if ($cached) {
13990: %iphost = %{$ip_info->[0]};
13991: %name_to_ip = %{$ip_info->[1]};
13992: %lonid_to_ip = %{$ip_info->[2]};
13993: return %iphost;
13994: }
13995: }
1.894 albertel 13996:
13997: # get yesterday's info for fallback
13998: my %old_name_to_ip;
13999: my ($ip_info,$cached)=
14000: &Apache::lonnet::is_cached_new('iphost','iphost');
14001: if ($cached) {
14002: %old_name_to_ip = %{$ip_info->[1]};
14003: }
14004:
1.1293 raeburn 14005: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 14006: foreach my $name (keys(%name_to_host)) {
1.847 albertel 14007: my $ip;
14008: if (!exists($name_to_ip{$name})) {
14009: $ip = gethostbyname($name);
14010: if (!$ip || length($ip) ne 4) {
1.894 albertel 14011: if (defined($old_name_to_ip{$name})) {
14012: $ip = $old_name_to_ip{$name};
14013: &logthis("Can't find $name defaulting to old $ip");
14014: } else {
14015: &logthis("Name $name no IP found");
14016: next;
14017: }
14018: } else {
14019: $ip=inet_ntoa($ip);
1.847 albertel 14020: }
14021: $name_to_ip{$name} = $ip;
14022: } else {
14023: $ip = $name_to_ip{$name};
1.653 albertel 14024: }
1.888 albertel 14025: foreach my $id (@{ $name_to_host{$name} }) {
14026: $lonid_to_ip{$id} = $ip;
14027: }
14028: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 14029: }
1.1293 raeburn 14030: unless ($nocache) {
14031: &do_cache_new('iphost','iphost',
14032: [\%iphost,\%name_to_ip,\%lonid_to_ip],
14033: 48*60*60);
14034: }
1.869 albertel 14035:
1.847 albertel 14036: return %iphost;
1.598 albertel 14037: }
14038:
1.992 raeburn 14039: #
14040: # Given a DNS returns the loncapa host name for that DNS
14041: #
14042: sub host_from_dns {
14043: my ($dns) = @_;
14044: my @hosts;
14045: my $ip;
14046:
1.993 raeburn 14047: if (exists($name_to_ip{$dns})) {
1.992 raeburn 14048: $ip = $name_to_ip{$dns};
14049: }
14050: if (!$ip) {
14051: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
14052: if (length($ip) == 4) {
14053: $ip = &IO::Socket::inet_ntoa($ip);
14054: }
14055: }
14056: if ($ip) {
14057: @hosts = get_hosts_from_ip($ip);
14058: return $hosts[0];
14059: }
14060: return undef;
1.986 foxr 14061: }
1.992 raeburn 14062:
1.1074 raeburn 14063: sub get_internet_names {
14064: my ($lonid) = @_;
14065: return if ($lonid eq '');
14066: my ($idnref,$cached)=
14067: &Apache::lonnet::is_cached_new('internetnames',$lonid);
14068: if ($cached) {
14069: return $idnref;
14070: }
14071: my $ip = &get_host_ip($lonid);
14072: my @hosts = &get_hosts_from_ip($ip);
14073: my %iphost = &get_iphost();
14074: my (@idns,%seen);
14075: foreach my $id (@hosts) {
14076: my $dom = &host_domain($id);
14077: my $prim_id = &domain($dom,'primary');
14078: my $prim_ip = &get_host_ip($prim_id);
14079: next if ($seen{$prim_ip});
14080: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
14081: foreach my $id (@{$iphost{$prim_ip}}) {
14082: my $intdom = &internet_dom($id);
14083: unless (grep(/^\Q$intdom\E$/,@idns)) {
14084: push(@idns,$intdom);
14085: }
14086: }
14087: }
14088: $seen{$prim_ip} = 1;
14089: }
1.1219 raeburn 14090: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 14091: }
14092:
1.986 foxr 14093: }
14094:
1.1079 raeburn 14095: sub all_loncaparevs {
1.1249 raeburn 14096: 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 14097: }
14098:
1.1227 raeburn 14099: # ---------------------------------------------------------- Read loncaparev table
14100: {
14101: sub load_loncaparevs {
14102: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
1.1359 raeburn 14103: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
1.1227 raeburn 14104: while (my $configline=<$config>) {
14105: chomp($configline);
14106: my ($hostid,$loncaparev)=split(/:/,$configline);
14107: $loncaparevs{$hostid}=$loncaparev;
14108: }
14109: close($config);
14110: }
14111: }
14112: }
14113: }
14114:
14115: # ---------------------------------------------------------- Read serverhostID table
14116: {
14117: sub load_serverhomeIDs {
14118: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
1.1359 raeburn 14119: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
1.1227 raeburn 14120: while (my $configline=<$config>) {
14121: chomp($configline);
14122: my ($name,$id)=split(/:/,$configline);
14123: $serverhomeIDs{$name}=$id;
14124: }
14125: close($config);
14126: }
14127: }
14128: }
14129: }
14130:
14131:
1.862 albertel 14132: BEGIN {
14133:
14134: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
14135: unless ($readit) {
14136: {
14137: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
14138: %perlvar = (%perlvar,%{$configvars});
14139: }
14140:
14141:
1.1 albertel 14142: # ------------------------------------------------------ Read spare server file
14143: {
1.1359 raeburn 14144: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 14145:
14146: while (my $configline=<$config>) {
14147: chomp($configline);
1.284 matthew 14148: if ($configline) {
1.784 albertel 14149: my ($host,$type) = split(':',$configline,2);
1.785 albertel 14150: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 14151: push(@{ $spareid{$type} }, $host);
1.1 albertel 14152: }
14153: }
1.448 albertel 14154: close($config);
1.1 albertel 14155: }
1.11 www 14156: # ------------------------------------------------------------ Read permissions
14157: {
1.1359 raeburn 14158: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
1.11 www 14159:
14160: while (my $configline=<$config>) {
1.448 albertel 14161: chomp($configline);
14162: if ($configline) {
14163: my ($role,$perm)=split(/ /,$configline);
14164: if ($perm ne '') { $pr{$role}=$perm; }
14165: }
1.11 www 14166: }
1.448 albertel 14167: close($config);
1.11 www 14168: }
14169:
14170: # -------------------------------------------- Read plain texts for permissions
14171: {
1.1359 raeburn 14172: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 14173:
14174: while (my $configline=<$config>) {
1.448 albertel 14175: chomp($configline);
14176: if ($configline) {
1.742 raeburn 14177: my ($short,@plain)=split(/:/,$configline);
14178: %{$prp{$short}} = ();
14179: if (@plain > 0) {
14180: $prp{$short}{'std'} = $plain[0];
14181: for (my $i=1; $i<@plain; $i++) {
14182: $prp{$short}{'alt'.$i} = $plain[$i];
14183: }
14184: }
1.448 albertel 14185: }
1.135 www 14186: }
1.448 albertel 14187: close($config);
1.135 www 14188: }
14189:
14190: # ---------------------------------------------------------- Read package table
14191: {
1.1359 raeburn 14192: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
1.135 www 14193:
14194: while (my $configline=<$config>) {
1.483 albertel 14195: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 14196: chomp($configline);
14197: my ($short,$plain)=split(/:/,$configline);
14198: my ($pack,$name)=split(/\&/,$short);
14199: if ($plain ne '') {
14200: $packagetab{$pack.'&'.$name.'&name'}=$name;
14201: $packagetab{$short}=$plain;
14202: }
1.11 www 14203: }
1.448 albertel 14204: close($config);
1.329 matthew 14205: }
14206:
1.1073 raeburn 14207: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 14208:
14209: &load_loncaparevs();
1.1073 raeburn 14210:
1.1074 raeburn 14211: # ---------------------------------------------------------- Read serverhostID table
14212:
1.1227 raeburn 14213: &load_serverhomeIDs();
14214:
14215: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 14216: {
14217: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
14218: if (-e $file) {
14219: my $parser = HTML::LCParser->new($file);
14220: while (my $token = $parser->get_token()) {
14221: if ($token->[0] eq 'S') {
14222: my $item = $token->[1];
14223: my $name = $token->[2]{'name'};
14224: my $value = $token->[2]{'value'};
1.1285 raeburn 14225: my $valuematch = $token->[2]{'valuematch'};
1.1303 raeburn 14226: my $namematch = $token->[2]{'namematch'};
14227: if ($item eq 'parameter') {
14228: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
14229: my $release = $parser->get_text();
14230: $release =~ s/(^\s*|\s*$ )//gx;
14231: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
14232: }
14233: } elsif ($item ne '' && $name ne '') {
1.1079 raeburn 14234: my $release = $parser->get_text();
14235: $release =~ s/(^\s*|\s*$ )//gx;
1.1303 raeburn 14236: $needsrelease{$item.':'.$name.':'.$value} = $release;
1.1079 raeburn 14237: }
14238: }
14239: }
14240: }
1.1073 raeburn 14241: }
14242:
1.1138 raeburn 14243: # ---------------------------------------------------------- Read managers table
14244: {
14245: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
1.1359 raeburn 14246: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
1.1138 raeburn 14247: while (my $configline=<$config>) {
14248: chomp($configline);
14249: next if ($configline =~ /^\#/);
14250: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
14251: $managerstab{$configline} = 1;
14252: }
14253: }
14254: close($config);
14255: }
14256: }
14257: }
14258:
1.329 matthew 14259: # ------------- set up temporary directory
14260: {
1.1117 foxr 14261: $tmpdir = LONCAPA::tempdir();
1.329 matthew 14262:
1.11 www 14263: }
14264:
1.794 albertel 14265: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
14266: 'compress_threshold'=> 20_000,
14267: });
1.185 www 14268:
1.281 www 14269: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 14270: $dumpcount=0;
1.958 www 14271: $locknum=0;
1.22 www 14272:
1.163 harris41 14273: &logtouch();
1.672 albertel 14274: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 14275: $readit=1;
1.564 albertel 14276: {
14277: use integer;
14278: my $test=(2**32)+1;
1.568 albertel 14279: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 14280: &logthis(" Detected 64bit platform ($_64bit)");
14281: }
1.195 www 14282: }
1.1 albertel 14283: }
1.179 www 14284:
1.1 albertel 14285: 1;
1.191 harris41 14286: __END__
14287:
1.243 albertel 14288: =pod
14289:
1.191 harris41 14290: =head1 NAME
14291:
1.243 albertel 14292: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 14293:
14294: =head1 SYNOPSIS
14295:
1.243 albertel 14296: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 14297:
14298: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
14299:
1.243 albertel 14300: Common parameters:
14301:
14302: =over 4
14303:
14304: =item *
14305:
14306: $uname : an internal username (if $cname expecting a course Id specifically)
14307:
14308: =item *
14309:
14310: $udom : a domain (if $cdom expecting a course's domain specifically)
14311:
14312: =item *
14313:
14314: $symb : a resource instance identifier
14315:
14316: =item *
14317:
14318: $namespace : the name of a .db file that contains the data needed or
14319: being set.
14320:
14321: =back
14322:
1.394 bowersj2 14323: =head1 OVERVIEW
1.191 harris41 14324:
1.394 bowersj2 14325: lonnet provides subroutines which interact with the
14326: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
14327: about classes, users, and resources.
1.243 albertel 14328:
14329: For many of these objects you can also use this to store data about
14330: them or modify them in various ways.
1.191 harris41 14331:
1.394 bowersj2 14332: =head2 Symbs
1.191 harris41 14333:
1.394 bowersj2 14334: To identify a specific instance of a resource, LON-CAPA uses symbols
14335: or "symbs"X<symb>. These identifiers are built from the URL of the
14336: map, the resource number of the resource in the map, and the URL of
14337: the resource itself. The latter is somewhat redundant, but might help
14338: if maps change.
14339:
14340: An example is
14341:
14342: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
14343:
14344: The respective map entry is
14345:
14346: <resource id="19" src="/res/msu/korte/tests/part12.problem"
14347: title="Problem 2">
14348: </resource>
14349:
14350: Symbs are used by the random number generator, as well as to store and
14351: restore data specific to a certain instance of for example a problem.
14352:
14353: =head2 Storing And Retrieving Data
14354:
14355: X<store()>X<cstore()>X<restore()>Three of the most important functions
14356: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
14357: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
14358: is is the non-critical message twin of cstore. These functions are for
14359: handlers to store a perl hash to a user's permanent data space in an
14360: easy manner, and to retrieve it again on another call. It is expected
14361: that a handler would use this once at the beginning to retrieve data,
14362: and then again once at the end to send only the new data back.
14363:
14364: The data is stored in the user's data directory on the user's
14365: homeserver under the ID of the course.
14366:
14367: The hash that is returned by restore will have all of the previous
14368: value for all of the elements of the hash.
14369:
14370: Example:
14371:
14372: #creating a hash
14373: my %hash;
14374: $hash{'foo'}='bar';
14375:
14376: #storing it
14377: &Apache::lonnet::cstore(\%hash);
14378:
14379: #changing a value
14380: $hash{'foo'}='notbar';
14381:
14382: #adding a new value
14383: $hash{'bar'}='foo';
14384: &Apache::lonnet::cstore(\%hash);
14385:
14386: #retrieving the hash
14387: my %history=&Apache::lonnet::restore();
14388:
14389: #print the hash
14390: foreach my $key (sort(keys(%history))) {
14391: print("\%history{$key} = $history{$key}");
14392: }
14393:
14394: Will print out:
1.191 harris41 14395:
1.394 bowersj2 14396: %history{1:foo} = bar
14397: %history{1:keys} = foo:timestamp
14398: %history{1:timestamp} = 990455579
14399: %history{2:bar} = foo
14400: %history{2:foo} = notbar
14401: %history{2:keys} = foo:bar:timestamp
14402: %history{2:timestamp} = 990455580
14403: %history{bar} = foo
14404: %history{foo} = notbar
14405: %history{timestamp} = 990455580
14406: %history{version} = 2
14407:
14408: Note that the special hash entries C<keys>, C<version> and
14409: C<timestamp> were added to the hash. C<version> will be equal to the
14410: total number of versions of the data that have been stored. The
14411: C<timestamp> attribute will be the UNIX time the hash was
14412: stored. C<keys> is available in every historical section to list which
14413: keys were added or changed at a specific historical revision of a
14414: hash.
14415:
14416: B<Warning>: do not store the hash that restore returns directly. This
14417: will cause a mess since it will restore the historical keys as if the
14418: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 14419:
1.394 bowersj2 14420: Calling convention:
1.191 harris41 14421:
1.1225 raeburn 14422: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269 raeburn 14423: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 14424:
1.394 bowersj2 14425: For more detailed information, see lonnet specific documentation.
1.191 harris41 14426:
1.394 bowersj2 14427: =head1 RETURN MESSAGES
1.191 harris41 14428:
1.394 bowersj2 14429: =over 4
1.191 harris41 14430:
1.394 bowersj2 14431: =item * B<con_lost>: unable to contact remote host
1.191 harris41 14432:
1.394 bowersj2 14433: =item * B<con_delayed>: unable to contact remote host, message will be delivered
14434: when the connection is brought back up
1.191 harris41 14435:
1.394 bowersj2 14436: =item * B<con_failed>: unable to contact remote host and unable to save message
14437: for later delivery
1.191 harris41 14438:
1.967 bisitz 14439: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 14440:
1.394 bowersj2 14441: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 14442: that was requested
1.191 harris41 14443:
1.243 albertel 14444: =back
1.191 harris41 14445:
1.243 albertel 14446: =head1 PUBLIC SUBROUTINES
1.191 harris41 14447:
1.243 albertel 14448: =head2 Session Environment Functions
1.191 harris41 14449:
1.243 albertel 14450: =over 4
1.191 harris41 14451:
1.394 bowersj2 14452: =item *
14453: X<appenv()>
1.949 raeburn 14454: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 14455: the user envirnoment file, and will be restored for each access this
1.620 albertel 14456: user makes during this session, also modifies the %env for the current
1.949 raeburn 14457: process. Optional rolesarrayref - if defined contains a reference to an array
14458: of roles which are exempt from the restriction on modifying user.role entries
14459: in the user's environment.db and in %env.
1.191 harris41 14460:
14461: =item *
1.394 bowersj2 14462: X<delenv()>
1.987 raeburn 14463: B<delenv($delthis,$regexp)>: removes all items from the session
14464: environment file that begin with $delthis. If the
14465: optional second arg - $regexp - is true, $delthis is treated as a
14466: regular expression, otherwise \Q$delthis\E is used.
14467: The values are also deleted from the current processes %env.
1.191 harris41 14468:
1.795 albertel 14469: =item * get_env_multiple($name)
14470:
14471: gets $name from the %env hash, it seemlessly handles the cases where multiple
14472: values may be defined and end up as an array ref.
14473:
14474: returns an array of values
14475:
1.243 albertel 14476: =back
14477:
14478: =head2 User Information
1.191 harris41 14479:
1.243 albertel 14480: =over 4
1.191 harris41 14481:
14482: =item *
1.394 bowersj2 14483: X<queryauthenticate()>
14484: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 14485: authentication scheme
14486:
14487: =item *
1.394 bowersj2 14488: X<authenticate()>
1.1073 raeburn 14489: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 14490: authenticate user from domain's lib servers (first use the current
14491: one). C<$upass> should be the users password.
1.1073 raeburn 14492: $checkdefauth is optional (value is 1 if a check should be made to
14493: authenticate user using default authentication method, and allow
14494: account creation if username does not have account in the domain).
14495: $clientcancheckhost is optional (value is 1 if checking whether the
14496: server can host will occur on the client side in lonauth.pm).
1.191 harris41 14497:
14498: =item *
1.394 bowersj2 14499: X<homeserver()>
14500: B<homeserver($uname,$udom)>: find the server which has
14501: the user's directory and files (there must be only one), this caches
14502: the answer, and also caches if there is a borken connection.
1.191 harris41 14503:
14504: =item *
1.394 bowersj2 14505: X<idget()>
1.1300 raeburn 14506: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
14507: a list of student/employee IDs or clicker IDs
14508: (student/employee IDs are a unique resource in a domain, there must be
14509: only 1 ID per username, and only 1 username per ID in a specific domain).
14510: clickerIDs are not necessarily unique, as students might share clickers.
14511: (returns hash: id=>name,id=>name)
1.191 harris41 14512:
14513: =item *
1.394 bowersj2 14514: X<idrget()>
14515: B<idrget($udom,@unames)>: find the IDs behind a list of
14516: usernames (returns hash: name=>id,name=>id)
1.191 harris41 14517:
14518: =item *
1.394 bowersj2 14519: X<idput()>
1.1300 raeburn 14520: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
14521: names and associated student/employee IDs or clicker IDs.
14522:
14523: =item *
14524: X<iddel()>
14525: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
14526: student/employee ID or clicker ID username look-ups from domain.
14527: The homeserver ($uhome) and namespace ($namespace) are optional.
14528: If no $uhome is provided, it will be determined usig &homeserver()
14529: for each user. If no $namespace is provided, the default is ids.
14530:
14531: =item *
14532: X<updateclickers()>
14533: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
14534: clicker ID-to-username look-ups in clickers.db on library server.
14535: Permitted actions are add or del (i.e., add or delete). The
14536: clickers.db contains clickerID as keys (escaped), and each corresponding
14537: value is an escaped comma-separated list of usernames (for whom the
14538: library server is the homeserver), who registered that particular ID.
14539: If $critical is true, the update will be sent via &critical, otherwise
14540: &reply() will be used.
1.191 harris41 14541:
14542: =item *
1.394 bowersj2 14543: X<rolesinit()>
1.1169 droeschl 14544: B<rolesinit($udom,$username)>: get user privileges.
14545: returns user role, first access and timer interval hashes
1.243 albertel 14546:
14547: =item *
1.1171 droeschl 14548: X<privileged()>
14549: B<privileged($username,$domain)>: returns a true if user has a
14550: privileged and active role (i.e. su or dc), false otherwise.
14551:
14552: =item *
1.551 albertel 14553: X<getsection()>
14554: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 14555: course $cname, return section name/number or '' for "not in course"
14556: and '-1' for "no section"
14557:
14558: =item *
1.394 bowersj2 14559: X<userenvironment()>
14560: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 14561: passed in @what from the requested user's environment, returns a hash
14562:
1.858 raeburn 14563: =item *
14564: X<userlog_query()>
1.859 albertel 14565: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
14566: activity.log file. %filters defines filters applied when parsing the
14567: log file. These can be start or end timestamps, or the type of action
14568: - log to look for Login or Logout events, check for Checkin or
14569: Checkout, role for role selection. The response is in the form
14570: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
14571: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 14572:
1.243 albertel 14573: =back
14574:
14575: =head2 User Roles
14576:
14577: =over 4
14578:
14579: =item *
14580:
1.1284 raeburn 14581: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
14582: returns codes for allowed actions.
14583:
14584: The first argument is required, all others are optional.
14585:
14586: $priv is the privilege being checked.
14587: $uri contains additional information about what is being checked for access (e.g.,
14588: URL, course ID etc.).
14589: $symb is the unique resource instance identifier in a course; if needed,
14590: but not provided, it will be retrieved via a call to &symbread().
14591: $role is the role for which a priv is being checked (only used if priv is evb).
14592: $clientip is the user's IP address (only used when checking for access to portfolio
14593: files).
14594: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
14595: prevents recursive calls to &allowed.
14596:
1.243 albertel 14597: F: full access
14598: U,I,K: authentication modes (cxx only)
14599: '': forbidden
14600: 1: user needs to choose course
14601: 2: browse allowed
1.766 albertel 14602: A: passphrase authentication needed
1.1284 raeburn 14603: B: access temporarily blocked because of a blocking event in a course.
1.243 albertel 14604:
14605: =item *
14606:
1.1192 raeburn 14607: constructaccess($url,$setpriv) : check for access to construction space URL
14608:
14609: See if the owner domain and name in the URL match those in the
14610: expected environment. If so, return three element list
14611: ($ownername,$ownerdomain,$ownerhome).
14612:
14613: Otherwise return the null string.
14614:
14615: If second argument 'setpriv' is true, it assigns the privileges,
14616: and returns the same three element list, unless the owner has
14617: blocked "ad hoc" Domain Coordinator access to the Author Space,
14618: in which case the null string is returned.
14619:
14620: =item *
14621:
1.1326 raeburn 14622: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
14623: define a custom role rolename set privileges in format of lonTabs/roles.tab
14624: for system, domain, and course level. $uname and $udom are optional (current
14625: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 14626:
14627: =item *
14628:
1.988 raeburn 14629: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
14630: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 14631: $type is Course (default) or Community.
1.988 raeburn 14632: If $forcedefault evaluates to true, text returned will be default
14633: text for $type. Otherwise, if this is a course, the text returned
14634: will be a custom name for the role (if defined in the course's
14635: environment). If no custom name is defined the default is returned.
14636:
1.832 raeburn 14637: =item *
14638:
1.1219 raeburn 14639: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 14640: All arguments are optional. Returns a hash of a roles, either for
14641: co-author/assistant author roles for a user's Construction Space
1.906 albertel 14642: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 14643: In the hash, keys are set to colon-separated $uname,$udom,$role, and
14644: (optionally) if $withsec is true, a fourth colon-separated item - $section.
14645: For each key, value is set to colon-separated start and end times for
14646: the role. If no username and domain are specified, will default to
1.934 raeburn 14647: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 14648: of role statuses (active, future or previous), roles
14649: (e.g., cc,in, st etc.) and domains of the roles which can be used
14650: to restrict the list of roles reported. If no array ref is
14651: provided for types, will default to return only active roles.
1.834 albertel 14652:
1.1195 raeburn 14653: =item *
14654:
14655: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 14656: user: $uname:$udom has a role in the course: $cdom_$cnum.
14657:
14658: Additional optional arguments are: $type (if role checking is to be restricted
14659: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 14660: available roles) or future (roles available in the future), and
14661: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 14662: have active Domain Coordinator role in course's domain or in additional
14663: domains (specified in 'Domains to check for privileged users' in course
14664: environment -- set via: Course Settings -> Classlists and staff listing).
14665:
14666: =item *
14667:
14668: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
14669: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
14670: $possdomains and $possroles are optional array refs -- to domains to check and
14671: roles to check. If $possdomains is not specified, a dump will be done of the
14672: users' roles.db to check for a dc or su role in any domain. This can be
14673: time consuming if &privileged is called repeatedly (e.g., when displaying a
14674: classlist), so in such cases, supplying a $possdomains array is preferred, as
14675: this then allows &privileged_by_domain() to be used, which caches the identity
14676: of privileged users, eliminating the need for repeated calls to &dump().
14677:
14678: =item *
14679:
14680: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
14681: where the outer hash keys are domains specified in the $possdomains array ref,
14682: next inner hash keys are privileged roles specified in the $roles array ref,
14683: and the innermost hash contains key = value pairs for username:domain = end:start
14684: for active or future "privileged" users with that role in that domain. To avoid
14685: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
14686: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 14687:
1.243 albertel 14688: =back
14689:
14690: =head2 User Modification
14691:
14692: =over 4
14693:
14694: =item *
14695:
1.957 raeburn 14696: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 14697: user for the level given by URL. Optional start and end dates (leave empty
14698: string or zero for "no date")
1.191 harris41 14699:
14700: =item *
14701:
1.243 albertel 14702: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
14703: change a users, password, possible return values are: ok,
14704: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
14705: refused
1.191 harris41 14706:
14707: =item *
14708:
1.243 albertel 14709: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 14710:
14711: =item *
14712:
1.1058 raeburn 14713: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
14714: $forceid,$desiredhome,$email,$inststatus,$candelete) :
14715:
14716: will update user information (firstname,middlename,lastname,generation,
14717: permanentemail), and if forceid is true, student/employee ID also.
14718: A user's institutional affiliation(s) can also be updated.
14719: User information fields will not be overwritten with empty entries
14720: unless the field is included in the $candelete array reference.
14721: This array is included when a single user is modified via "Manage Users",
14722: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 14723:
14724: =item *
14725:
1.286 matthew 14726: modifystudent
14727:
1.957 raeburn 14728: modify a student's enrollment and identification information.
1.1235 raeburn 14729: The course id is resolved based on the current user's environment.
14730: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 14731: associated with a course.
14732:
1.297 matthew 14733: This call is essentially a wrapper for lonnet::modifyuser and
14734: lonnet::modify_student_enrollment
1.286 matthew 14735:
14736: Inputs:
14737:
14738: =over 4
14739:
1.957 raeburn 14740: =item B<$udom> Student's loncapa domain
1.286 matthew 14741:
1.957 raeburn 14742: =item B<$uname> Student's loncapa login name
1.286 matthew 14743:
1.964 bisitz 14744: =item B<$uid> Student/Employee ID
1.286 matthew 14745:
1.957 raeburn 14746: =item B<$umode> Student's authentication mode
1.286 matthew 14747:
1.957 raeburn 14748: =item B<$upass> Student's password
1.286 matthew 14749:
1.957 raeburn 14750: =item B<$first> Student's first name
1.286 matthew 14751:
1.957 raeburn 14752: =item B<$middle> Student's middle name
1.286 matthew 14753:
1.957 raeburn 14754: =item B<$last> Student's last name
1.286 matthew 14755:
1.957 raeburn 14756: =item B<$gene> Student's generation
1.286 matthew 14757:
1.957 raeburn 14758: =item B<$usec> Student's section in course
1.286 matthew 14759:
14760: =item B<$end> Unix time of the roles expiration
14761:
14762: =item B<$start> Unix time of the roles start date
14763:
14764: =item B<$forceid> If defined, allow $uid to be changed
14765:
14766: =item B<$desiredhome> server to use as home server for student
14767:
1.957 raeburn 14768: =item B<$email> Student's permanent e-mail address
14769:
14770: =item B<$type> Type of enrollment (auto or manual)
14771:
1.963 raeburn 14772: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
14773:
14774: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 14775:
1.963 raeburn 14776: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 14777:
1.963 raeburn 14778: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 14779:
1.1216 raeburn 14780: =item B<$inststatus> institutional status of user - : separated string of escaped status types
14781:
14782: =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 14783:
1.286 matthew 14784: =back
1.297 matthew 14785:
14786: =item *
14787:
14788: modify_student_enrollment
14789:
1.1235 raeburn 14790: Change a student's enrollment status in a class. The environment variable
1.297 matthew 14791: 'role.request.course' must be defined for this function to proceed.
14792:
14793: Inputs:
14794:
14795: =over 4
14796:
1.1235 raeburn 14797: =item $udom, student's domain
1.297 matthew 14798:
1.1235 raeburn 14799: =item $uname, student's name
1.297 matthew 14800:
1.1235 raeburn 14801: =item $uid, student's user id
1.297 matthew 14802:
1.1235 raeburn 14803: =item $first, student's first name
1.297 matthew 14804:
14805: =item $middle
14806:
14807: =item $last
14808:
14809: =item $gene
14810:
14811: =item $usec
14812:
14813: =item $end
14814:
14815: =item $start
14816:
1.957 raeburn 14817: =item $type
14818:
14819: =item $locktype
14820:
14821: =item $cid
14822:
14823: =item $selfenroll
14824:
14825: =item $context
14826:
1.1216 raeburn 14827: =item $credits, number of credits student will earn from this class
14828:
1.1314 raeburn 14829: =item $instsec, institutional course section code for student
14830:
1.297 matthew 14831: =back
14832:
1.191 harris41 14833:
14834: =item *
14835:
1.243 albertel 14836: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
14837: custom role; give a custom role to a user for the level given by URL. Specify
14838: name and domain of role author, and role name
1.191 harris41 14839:
14840: =item *
14841:
1.243 albertel 14842: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 14843:
14844: =item *
14845:
1.243 albertel 14846: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
14847:
14848: =back
14849:
14850: =head2 Course Infomation
14851:
14852: =over 4
1.191 harris41 14853:
14854: =item *
14855:
1.1118 foxr 14856: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 14857: specified course id, including all environment settings for the
14858: course, the description of the course will be in the hash under the
14859: key 'description'
1.191 harris41 14860:
1.1118 foxr 14861: $options is an optional parameter that if supplied is a hash reference that controls
14862: what how this function works. It has the following key/values:
14863:
14864: =over 4
14865:
14866: =item freshen_cache
14867:
14868: If defined, and the environment cache for the course is valid, it is
14869: returned in the returned hash.
14870:
14871: =item one_time
14872:
14873: If defined, the last cache time is set to _now_
14874:
14875: =item user
14876:
14877: If defined, the supplied username is used instead of the current user.
14878:
14879:
14880: =back
14881:
1.191 harris41 14882: =item *
14883:
1.624 albertel 14884: resdata($name,$domain,$type,@which) : request for current parameter
14885: setting for a specific $type, where $type is either 'course' or 'user',
14886: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 14887: answers for 10 minutes.
1.243 albertel 14888:
1.877 foxr 14889: =item *
14890:
14891: get_courseresdata($courseid, $domain) : dump the entire course resource
14892: data base, returning a hash that is keyed by the resource name and has
14893: values that are the resource value. I believe that the timestamps and
14894: versions are also returned.
14895:
1.1236 raeburn 14896: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
14897: supplemental content area. This routine caches the number of files for
14898: 10 minutes.
14899:
1.243 albertel 14900: =back
14901:
14902: =head2 Course Modification
14903:
14904: =over 4
1.191 harris41 14905:
14906: =item *
14907:
1.243 albertel 14908: writecoursepref($courseid,%prefs) : write preferences (environment
14909: database) for a course
1.191 harris41 14910:
14911: =item *
14912:
1.1011 raeburn 14913: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
14914:
14915: =item *
14916:
1.1038 raeburn 14917: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 14918:
1.1167 droeschl 14919: =item *
14920:
14921: is_course($courseid), is_course($cdom, $cnum)
14922:
14923: Accepts either a combined $courseid (in the form of domain_courseid) or the
14924: two component version $cdom, $cnum. It checks if the specified course exists.
14925:
14926: Returns:
14927: undef if the course doesn't exist, otherwise
14928: in scalar context the combined courseid.
14929: in list context the two components of the course identifier, domain and
14930: courseid.
14931:
1.243 albertel 14932: =back
14933:
14934: =head2 Resource Subroutines
14935:
14936: =over 4
1.191 harris41 14937:
14938: =item *
14939:
1.243 albertel 14940: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 14941:
14942: =item *
14943:
1.243 albertel 14944: repcopy($filename) : subscribes to the requested file, and attempts to
14945: replicate from the owning library server, Might return
1.607 raeburn 14946: 'unavailable', 'not_found', 'forbidden', 'ok', or
14947: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 14948: resource. Expects the local filesystem pathname
14949: (/home/httpd/html/res/....)
14950:
14951: =back
14952:
14953: =head2 Resource Information
14954:
14955: =over 4
1.191 harris41 14956:
14957: =item *
14958:
1.1228 raeburn 14959: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
14960: and returns the value of a variety of different possible values,
14961: $varname should be a request string, and the other parameters can be
14962: used to specify who and what one is asking about. Ordinarily, $cid
14963: does not need to be specified, as it is retrived from
14964: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
14965: within lonuserstate::loadmap() when initializing a course, before
14966: $env{'request.course.id'} has been set, so it needs to be provided
14967: in that one case.
1.243 albertel 14968:
14969: Possible values for $varname are environment.lastname (or other item
14970: from the envirnment hash), user.name (or someother aspect about the
14971: user), resource.0.maxtries (or some other part and parameter of a
14972: resource)
1.204 albertel 14973:
14974: =item *
14975:
1.243 albertel 14976: directcondval($number) : get current value of a condition; reads from a state
14977: string
1.204 albertel 14978:
14979: =item *
14980:
1.243 albertel 14981: condval($condidx) : value of condition index based on state
1.204 albertel 14982:
14983: =item *
14984:
1.1362 raeburn 14985: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
1.243 albertel 14986: resource's metadata, $what should be either a specific key, or either
14987: 'keys' (to get a list of possible keys) or 'packages' to get a list of
1.1362 raeburn 14988: packages that this resource currently uses, the last 3 arguments are
14989: only used internally for recursive metadata.
14990:
14991: the toolsymb is only used where the uri is for an external tool (for which
14992: the uri as well as the symb are guaranteed to be unique).
1.243 albertel 14993:
1.1371 raeburn 14994: this function automatically caches all requests except any made recursively
14995: to retrieve a list of metadata keys for an imported library file ($liburi is
14996: defined).
1.191 harris41 14997:
14998: =item *
14999:
1.243 albertel 15000: metadata_query($query,$custom,$customshow) : make a metadata query against the
15001: network of library servers; returns file handle of where SQL and regex results
15002: will be stored for query
1.191 harris41 15003:
15004: =item *
15005:
1.1282 raeburn 15006: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
15007: return symbolic list entry (all arguments optional).
15008:
15009: Args: filename is the filename (including path) for the file for which a symb
15010: is required; donotrecurse, if true will prevent calls to allowed() being made
15011: to check access status if more than one resource was found in the bighash
15012: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
15013: a randompick); ignorecachednull, if true will prevent a symb of '' being
15014: returned if $env{$cache_str} is defined as ''; checkforblock if true will
15015: cause possible symbs to be checked to determine if they are subject to content
15016: blocking, if so they will not be included as possible symbs; possibles is a
15017: ref to a hash, which, as a side effect, will be populated with all possible
15018: symbs (content blocking not tested).
15019:
1.243 albertel 15020: returns the data handle
1.191 harris41 15021:
15022: =item *
15023:
1.1190 raeburn 15024: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
15025: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 15026: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 15027: on failure, user must be in a course, as it assumes the existence of
15028: the course initial hash, and uses $env('request.course.id'}. The third
15029: arg is an optional reference to a scalar. If this arg is passed in the
15030: call to symbverify, it will be set to 1 if the symb has been set to be
15031: encrypted; otherwise it will be null.
1.191 harris41 15032:
15033: =item *
15034:
1.243 albertel 15035: symbclean($symb) : removes versions numbers from a symb, returns the
15036: cleaned symb
1.191 harris41 15037:
15038: =item *
15039:
1.243 albertel 15040: is_on_map($uri) : checks if the $uri is somewhere on the current
15041: course map, user must be in a course for it to work.
1.191 harris41 15042:
15043: =item *
15044:
1.243 albertel 15045: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 15046:
15047: =item *
15048:
1.243 albertel 15049: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
15050: a random seed, all arguments are optional, if they aren't sent it uses the
15051: environment to derive them. Note: if symb isn't sent and it can't get one
15052: from &symbread it will use the current time as its return value
1.191 harris41 15053:
15054: =item *
15055:
1.243 albertel 15056: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
15057: unfakeable, receipt
1.191 harris41 15058:
15059: =item *
15060:
1.620 albertel 15061: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 15062:
15063: =item *
15064:
1.243 albertel 15065: countacc($url) : count the number of accesses to a given URL
1.191 harris41 15066:
15067: =item *
15068:
1.243 albertel 15069: 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 15070:
15071: =item *
15072:
1.243 albertel 15073: 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 15074:
15075: =item *
15076:
1.243 albertel 15077: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 15078:
15079: =item *
15080:
1.243 albertel 15081: devalidate($symb) : devalidate temporary spreadsheet calculations,
15082: forcing spreadsheet to reevaluate the resource scores next time.
15083:
1.1195 raeburn 15084: =item *
15085:
1.1196 raeburn 15086: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
15087: when viewing in course context.
1.1195 raeburn 15088:
1.1196 raeburn 15089: input: six args -- filename (decluttered), course number, course domain,
15090: url, symb (if registered) and group (if this is a
15091: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 15092:
1.1196 raeburn 15093: output: array of five scalars --
1.1195 raeburn 15094: $cfile -- url for file editing if editable on current server
15095: $home -- homeserver of resource (i.e., for author if published,
15096: or course if uploaded.).
15097: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 15098: $forceedit -- 1 if icon/link should be to go to edit mode
15099: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 15100:
15101: =item *
15102:
15103: is_course_upload($file,$cnum,$cdom)
15104:
15105: Used in course context to determine if current file was uploaded to
15106: the course (i.e., would be found in /userfiles/docs on the course's
15107: homeserver.
15108:
15109: input: 3 args -- filename (decluttered), course number and course domain.
15110: output: boolean -- 1 if file was uploaded.
15111:
1.243 albertel 15112: =back
15113:
15114: =head2 Storing/Retreiving Data
15115:
15116: =over 4
1.191 harris41 15117:
15118: =item *
15119:
1.1269 raeburn 15120: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
15121: permanently for this url; hashref needs to be given and should be a \%hashname;
15122: the remaining args aren't required and if they aren't passed or are '' they will
15123: be derived from the env (with the exception of $laststore, which is an
15124: optional arg used when a user's submission is stored in grading).
15125: $laststore is $version=$timestamp, where $version is the most recent version
15126: number retrieved for the corresponding $symb in the $namespace db file, and
15127: $timestamp is the timestamp for that transaction (UNIX time).
15128: $laststore is currently only passed when cstore() is called by
15129: structuretags::finalize_storage().
1.191 harris41 15130:
15131: =item *
15132:
1.1269 raeburn 15133: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
15134: but uses critical subroutine
1.191 harris41 15135:
15136: =item *
15137:
1.243 albertel 15138: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
15139: all args are optional
1.191 harris41 15140:
15141: =item *
15142:
1.717 albertel 15143: dumpstore($namespace,$udom,$uname,$regexp,$range) :
15144: dumps the complete (or key matching regexp) namespace into a hash
15145: ($udom, $uname, $regexp, $range are optional) for a namespace that is
15146: normally &store()ed into
15147:
15148: $range should be either an integer '100' (give me the first 100
15149: matching records)
15150: or be two integers sperated by a - with no spaces
15151: '30-50' (give me the 30th through the 50th matching
15152: records)
15153:
15154:
15155: =item *
15156:
1.1269 raeburn 15157: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 15158: replaces a &store() version of data with a replacement set of data
15159: for a particular resource in a namespace passed in the $storehash hash
1.1269 raeburn 15160: reference. If $tolog is true, the transaction is logged in the courselog
15161: with an action=PUTSTORE.
1.717 albertel 15162:
15163: =item *
15164:
1.243 albertel 15165: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
15166: works very similar to store/cstore, but all data is stored in a
15167: temporary location and can be reset using tmpreset, $storehash should
15168: be a hash reference, returns nothing on success
1.191 harris41 15169:
15170: =item *
15171:
1.243 albertel 15172: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
15173: similar to restore, but all data is stored in a temporary location and
15174: can be reset using tmpreset. Returns a hash of values on success,
15175: error string otherwise.
1.191 harris41 15176:
15177: =item *
15178:
1.243 albertel 15179: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
15180: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 15181:
15182: =item *
15183:
1.243 albertel 15184: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
15185: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 15186:
15187: =item *
15188:
1.243 albertel 15189: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
15190: namesp ($udom and $uname are optional)
1.191 harris41 15191:
15192: =item *
15193:
1.702 albertel 15194: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 15195: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 15196: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 15197:
1.702 albertel 15198: $range should be either an integer '100' (give me the first 100
15199: matching records)
15200: or be two integers sperated by a - with no spaces
15201: '30-50' (give me the 30th through the 50th matching
15202: records)
1.449 matthew 15203: =item *
15204:
15205: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
15206: $store can be a scalar, an array reference, or if the amount to be
15207: incremented is > 1, a hash reference.
15208:
15209: ($udom and $uname are optional)
1.191 harris41 15210:
15211: =item *
15212:
1.243 albertel 15213: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
15214: ($udom and $uname are optional)
1.191 harris41 15215:
15216: =item *
15217:
1.243 albertel 15218: cput($namespace,$storehash,$udom,$uname) : critical put
15219: ($udom and $uname are optional)
1.191 harris41 15220:
15221: =item *
15222:
1.748 albertel 15223: newput($namespace,$storehash,$udom,$uname) :
15224:
15225: Attempts to store the items in the $storehash, but only if they don't
15226: currently exist, if this succeeds you can be certain that you have
15227: successfully created a new key value pair in the $namespace db.
15228:
15229:
15230: Args:
15231: $namespace: name of database to store values to
15232: $storehash: hashref to store to the db
15233: $udom: (optional) domain of user containing the db
15234: $uname: (optional) name of user caontaining the db
15235:
15236: Returns:
15237: 'ok' -> succeeded in storing all keys of $storehash
15238: 'key_exists: <key>' -> failed to anything out of $storehash, as at
15239: least <key> already existed in the db (other
15240: requested keys may also already exist)
1.967 bisitz 15241: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 15242: 'con_lost' -> unable to contact request server
15243: 'refused' -> action was not allowed by remote machine
15244:
15245:
15246: =item *
15247:
1.243 albertel 15248: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
15249: reference filled in from namesp (encrypts the return communication)
15250: ($udom and $uname are optional)
1.191 harris41 15251:
15252: =item *
15253:
1.243 albertel 15254: log($udom,$name,$home,$message) : write to permanent log for user; use
15255: critical subroutine
15256:
1.806 raeburn 15257: =item *
15258:
1.860 raeburn 15259: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
15260: array reference filled in from namespace found in domain level on either
15261: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 15262:
15263: =item *
15264:
1.860 raeburn 15265: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
15266: domain level either on specified domain server ($uhome) or primary domain
15267: server ($udom and $uhome are optional)
1.806 raeburn 15268:
1.943 raeburn 15269: =item *
15270:
1.1240 raeburn 15271: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
15272: for: authentication, language, quotas, timezone, date locale, and portal URL in
15273: the target domain.
15274:
15275: May also include additional key => value pairs for the following groups:
15276:
15277: =over
15278:
15279: =item
15280: disk quotas (MB allocated by default to portfolios and authoring spaces).
15281:
15282: =over
15283:
15284: =item defaultquota, authorquota
15285:
15286: =back
15287:
15288: =item
15289: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
15290: portfolio for users).
15291:
15292: =over
15293:
15294: =item
15295: aboutme, blog, webdav, portfolio
15296:
15297: =back
15298:
15299: =item
15300: requestcourses: ability to request courses, and how requests are processed.
15301:
15302: =over
15303:
15304: =item
1.1305 raeburn 15305: official, unofficial, community, textbook, placement
1.1240 raeburn 15306:
15307: =back
15308:
15309: =item
15310: inststatus: types of institutional affiliation, and order in which they are displayed.
15311:
15312: =over
15313:
15314: =item
1.1256 raeburn 15315: inststatustypes, inststatusorder, inststatusguest
1.1240 raeburn 15316:
15317: =back
15318:
15319: =item
15320: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
15321: for course's uploaded content.
15322:
15323: =over
15324:
15325: =item
1.1246 raeburn 15326: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
1.1305 raeburn 15327: communityquota, textbookquota, placementquota
1.1240 raeburn 15328:
15329: =back
15330:
15331: =item
15332: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
15333: on your servers.
15334:
15335: =over
15336:
15337: =item
15338: remotesessions, hostedsessions
15339:
15340: =back
15341:
15342: =back
15343:
15344: In cases where a domain coordinator has never used the "Set Domain Configuration"
15345: utility to create a configuration.db file on a domain's primary library server
15346: only the following domain defaults: auth_def, auth_arg_def, lang_def
15347: -- corresponding values are authentication type (internal, krb4, krb5,
15348: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
15349: will be available. Values are retrieved from cache (if current), unless the
15350: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
15351: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
15352:
15353: Typical usage:
1.943 raeburn 15354:
1.1240 raeburn 15355: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 15356:
1.243 albertel 15357: =back
15358:
15359: =head2 Network Status Functions
15360:
15361: =over 4
1.191 harris41 15362:
15363: =item *
15364:
1.1137 raeburn 15365: dirlist() : return directory list based on URI (first arg).
15366:
15367: Inputs: 1 required, 5 optional.
15368:
15369: =over
15370:
15371: =item
15372: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
15373:
15374: =item
15375: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
15376:
15377: =item
15378: $username - username of user/course to be listed. Extracted from $uri if absent.
15379:
15380: =item
15381: $getpropath - boolean: 1 if prepend path using &propath().
15382:
15383: =item
15384: $getuserdir - boolean: 1 if prepend path for "userfiles".
15385:
15386: =item
15387: $alternateRoot - path to prepend in place of path from $uri.
15388:
15389: =back
15390:
15391: Returns: Array of up to two items.
15392:
15393: =over
15394:
15395: a reference to an array of files/subdirectories
15396:
15397: =over
15398:
15399: Each element in the array of files/subdirectories is a & separated list of
15400: item name and the result of running stat on the item. If dirlist was requested
15401: for a file instead of a directory, the item name will be ''. For a directory
15402: listing, if the item is a metadata file, the element will end &N&M
15403: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
15404: default copyright set (1).
15405:
15406: =back
15407:
15408: a scalar containing error condition (if encountered).
15409:
15410: =over
15411:
15412: =item
15413: no_host (no homeserver identified for $username:$domain).
15414:
15415: =item
15416: no_such_host (server contacted for listing not identified as valid host).
15417:
15418: =item
15419: con_lost (connection to remote server failed).
15420:
15421: =item
15422: refused (invalid $username:$domain received on lond side).
15423:
15424: =item
15425: no_such_dir (directory at specified path on lond side does not exist).
15426:
15427: =item
15428: empty (directory at specified path on lond side is empty).
15429:
15430: =over
15431:
15432: This is currently not encountered because the &ls3, &ls2,
15433: &ls (_handler) routines on the lond side do not filter out
15434: . and .. from a directory listing.
15435:
15436: =back
15437:
15438: =back
15439:
15440: =back
1.191 harris41 15441:
15442: =item *
15443:
1.243 albertel 15444: spareserver() : find server with least workload from spare.tab
15445:
1.986 foxr 15446:
15447: =item *
15448:
15449: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
15450: if there is no corresponding loncapa host.
15451:
1.243 albertel 15452: =back
15453:
1.986 foxr 15454:
1.243 albertel 15455: =head2 Apache Request
15456:
15457: =over 4
1.191 harris41 15458:
15459: =item *
15460:
1.243 albertel 15461: ssi($url,%hash) : server side include, does a complete request cycle on url to
15462: localhost, posts hash
15463:
15464: =back
15465:
15466: =head2 Data to String to Data
15467:
15468: =over 4
1.191 harris41 15469:
15470: =item *
15471:
1.243 albertel 15472: hash2str(%hash) : convert a hash into a string complete with escaping and '='
15473: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 15474:
15475: =item *
15476:
1.243 albertel 15477: hashref2str($hashref) : convert a hashref into a string complete with
15478: escaping and '=' and '&' separators, supports elements that are
15479: arrayrefs and hashrefs
1.191 harris41 15480:
15481: =item *
15482:
1.243 albertel 15483: arrayref2str($arrayref) : convert an arrayref into a string complete
15484: with escaping and '&' separators, supports elements that are arrayrefs
15485: and hashrefs
1.191 harris41 15486:
15487: =item *
15488:
1.243 albertel 15489: str2hash($string) : convert string to hash using unescaping and
15490: splitting on '=' and '&', supports elements that are arrayrefs and
15491: hashrefs
1.191 harris41 15492:
15493: =item *
15494:
1.243 albertel 15495: str2array($string) : convert string to hash using unescaping and
15496: splitting on '&', supports elements that are arrayrefs and hashrefs
15497:
15498: =back
15499:
15500: =head2 Logging Routines
15501:
15502:
15503: These routines allow one to make log messages in the lonnet.log and
15504: lonnet.perm logfiles.
1.191 harris41 15505:
1.1119 foxr 15506: =over 4
15507:
1.191 harris41 15508: =item *
15509:
1.243 albertel 15510: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 15511:
15512: =item *
15513:
1.243 albertel 15514: logthis() : append message to the normal lonnet.log file, it gets
15515: preiodically rolled over and deleted.
1.191 harris41 15516:
15517: =item *
15518:
1.243 albertel 15519: logperm() : append a permanent message to lonnet.perm.log, this log
15520: file never gets deleted by any automated portion of the system, only
15521: messages of critical importance should go in here.
15522:
1.1119 foxr 15523:
1.243 albertel 15524: =back
15525:
15526: =head2 General File Helper Routines
15527:
15528: =over 4
1.191 harris41 15529:
15530: =item *
15531:
1.481 raeburn 15532: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
15533: (a) files in /uploaded
15534: (i) If a local copy of the file exists -
15535: compares modification date of local copy with last-modified date for
15536: definitive version stored on home server for course. If local copy is
15537: stale, requests a new version from the home server and stores it.
15538: If the original has been removed from the home server, then local copy
15539: is unlinked.
15540: (ii) If local copy does not exist -
15541: requests the file from the home server and stores it.
15542:
15543: If $caller is 'uploadrep':
15544: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
15545: for request for files originally uploaded via DOCS.
15546: - returns 'ok' if fresh local copy now available, -1 otherwise.
15547:
15548: Otherwise:
15549: This indicates a call from the content generation phase of the request.
15550: - returns the entire contents of the file or -1.
15551:
15552: (b) files in /res
15553: - returns the entire contents of a file or -1;
15554: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 15555:
1.712 albertel 15556:
15557: =item *
15558:
15559: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
15560: reference
15561:
15562: returns either a stat() list of data about the file or an empty list
15563: if the file doesn't exist or couldn't find out about it (connection
15564: problems or user unknown)
15565:
1.191 harris41 15566: =item *
15567:
1.243 albertel 15568: filelocation($dir,$file) : returns file system location of a file
15569: based on URI; meant to be "fairly clean" absolute reference, $dir is a
15570: directory that relative $file lookups are to looked in ($dir of /a/dir
15571: and a file of ../bob will become /a/bob)
1.191 harris41 15572:
15573: =item *
15574:
15575: hreflocation($dir,$file) : returns file system location or a URL; same as
15576: filelocation except for hrefs
15577:
15578: =item *
15579:
1.1261 raeburn 15580: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
15581: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 15582:
1.243 albertel 15583: =back
15584:
1.608 albertel 15585: =head2 Usererfile file routines (/uploaded*)
15586:
15587: =over 4
15588:
15589: =item *
15590:
15591: userfileupload(): main rotine for putting a file in a user or course's
15592: filespace, arguments are,
15593:
1.620 albertel 15594: formname - required - this is the name of the element in $env where the
1.608 albertel 15595: filename, and the contents of the file to create/modifed exist
1.620 albertel 15596: the filename is in $env{'form.'.$formname.'.filename'} and the
15597: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 15598: context - if coursedoc, store the file in the course of the active role
15599: of the current user;
15600: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
15601: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 15602: subdir - required - subdirectory to put the file in under ../userfiles/
15603: if undefined, it will be placed in "unknown"
15604:
15605: (This routine calls clean_filename() to remove any dangerous
15606: characters from the filename, and then calls finuserfileupload() to
15607: complete the transaction)
15608:
15609: returns either the url of the uploaded file (/uploaded/....) if successful
15610: and /adm/notfound.html if unsuccessful
15611:
15612: =item *
15613:
15614: clean_filename(): routine for cleaing a filename up for storage in
15615: userfile space, argument is:
15616:
15617: filename - proposed filename
15618:
15619: returns: the new clean filename
15620:
15621: =item *
15622:
1.1090 raeburn 15623: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 15624: userspace, probably shouldn't be called directly
15625:
15626: docuname: username or courseid of destination for the file
15627: docudom: domain of user/course of destination for the file
15628: formname: same as for userfileupload()
1.1090 raeburn 15629: fname: filename (including subdirectories) for the file
15630: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
15631: allfiles: reference to hash used to store objects found by parser
15632: codebase: reference to hash used for codebases of java objects found by parser
15633: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
15634: thumbheight: height (pixels) of thumbnail to be created for uploaded image
15635: resizewidth: width to be used to resize image using resizeImage from ImageMagick
15636: resizeheight: height to be used to resize image using resizeImage from ImageMagick
15637: context: if 'overwrite', will move the uploaded file from its temporary location to
15638: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 15639: mimetype: reference to scalar to accommodate mime type determined
15640: from File::MMagic if $parser = parse.
1.608 albertel 15641:
15642: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 15643: and /adm/notfound.html if unsuccessful (or an error message if context
15644: was 'overwrite').
15645:
1.608 albertel 15646:
15647: =item *
15648:
15649: renameuserfile(): renames an existing userfile to a new name
15650:
15651: Args:
15652: docuname: username or courseid of destination for the file
15653: docudom: domain of user/course of destination for the file
15654: old: current file name (including any subdirs under userfiles)
15655: new: desired file name (including any subdirs under userfiles)
15656:
15657: =item *
15658:
15659: mkdiruserfile(): creates a directory is a userfiles dir
15660:
15661: Args:
15662: docuname: username or courseid of destination for the file
15663: docudom: domain of user/course of destination for the file
15664: dir: dir to create (including any subdirs under userfiles)
15665:
15666: =item *
15667:
15668: removeuserfile(): removes a file that exists in userfiles
15669:
15670: Args:
15671: docuname: username or courseid of destination for the file
15672: docudom: domain of user/course of destination for the file
15673: fname: filname to delete (including any subdirs under userfiles)
15674:
15675: =item *
15676:
15677: removeuploadedurl(): convience function for removeuserfile()
15678:
15679: Args:
15680: url: a full /uploaded/... url to delete
15681:
1.747 albertel 15682: =item *
15683:
15684: get_portfile_permissions():
15685: Args:
15686: domain: domain of user or course contain the portfolio files
15687: user: name of user or num of course contain the portfolio files
15688: Returns:
15689: hashref of a dump of the proper file_permissions.db
15690:
15691:
15692: =item *
15693:
15694: get_access_controls():
15695:
15696: Args:
15697: current_permissions: the hash ref returned from get_portfile_permissions()
15698: group: (optional) the group you want the files associated with
15699: file: (optional) the file you want access info on
15700:
15701: Returns:
1.749 raeburn 15702: a hash (keys are file names) of hashes containing
15703: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
15704: values are XML containing access control settings (see below)
1.747 albertel 15705:
15706: Internal notes:
15707:
1.749 raeburn 15708: access controls are stored in file_permissions.db as key=value pairs.
15709: key -> path to file/file_name\0uniqueID:scope_end_start
15710: where scope -> public,guest,course,group,domains or users.
15711: end -> UNIX time for end of access (0 -> no end date)
15712: start -> UNIX time for start of access
15713:
15714: value -> XML description of access control
15715: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
15716: <start></start>
15717: <end></end>
15718:
15719: <password></password> for scope type = guest
15720:
15721: <domain></domain> for scope type = course or group
15722: <number></number>
15723: <roles id="">
15724: <role></role>
15725: <access></access>
15726: <section></section>
15727: <group></group>
15728: </roles>
15729:
15730: <dom></dom> for scope type = domains
15731:
15732: <users> for scope type = users
15733: <user>
15734: <uname></uname>
15735: <udom></udom>
15736: </user>
15737: </users>
15738: </scope>
15739:
15740: Access data is also aggregated for each file in an additional key=value pair:
15741: key -> path to file/file_name\0accesscontrol
15742: value -> reference to hash
15743: hash contains key = value pairs
15744: where key = uniqueID:scope_end_start
15745: value = UNIX time record was last updated
15746:
15747: Used to improve speed of look-ups of access controls for each file.
15748:
15749: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
15750:
1.1198 raeburn 15751: =item *
15752:
1.749 raeburn 15753: modify_access_controls():
15754:
15755: Modifies access controls for a portfolio file
15756: Args
15757: 1. file name
15758: 2. reference to hash of required changes,
15759: 3. domain
15760: 4. username
15761: where domain,username are the domain of the portfolio owner
15762: (either a user or a course)
15763:
15764: Returns:
15765: 1. result of additions or updates ('ok' or 'error', with error message).
15766: 2. result of deletions ('ok' or 'error', with error message).
15767: 3. reference to hash of any new or updated access controls.
15768: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
15769: key = integer (inbound ID)
1.1198 raeburn 15770: value = uniqueID
15771:
15772: =item *
15773:
15774: get_timebased_id():
15775:
15776: Attempts to get a unique timestamp-based suffix for use with items added to a
15777: course via the Course Editor (e.g., folders, composite pages,
15778: group bulletin boards).
15779:
15780: Args: (first three required; six others optional)
15781:
15782: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
15783: docssequence, or name of group
15784:
15785: 2. keyid (alphanumeric): name of temporary locking key in hash,
15786: e.g., num, boardids
15787:
15788: 3. namespace: name of gdbm file used to store suffixes already assigned;
15789: file will be named nohist_namespace.db
15790:
15791: 4. cdom: domain of course; default is current course domain from %env
15792:
15793: 5. cnum: course number; default is current course number from %env
15794:
15795: 6. idtype: set to concat if an additional digit is to be appended to the
15796: unix timestamp to form the suffix, if the plain timestamp is already
15797: in use. Default is to not do this, but simply increment the unix
15798: timestamp by 1 until a unique key is obtained.
15799:
15800: 7. who: holder of locking key; defaults to user:domain for user.
15801:
15802: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
15803: retrying); default is 3.
15804:
15805: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
15806:
15807: Returns:
15808:
15809: 1. suffix obtained (numeric)
15810:
15811: 2. result of deleting locking key (ok if deleted, or lock never obtained)
15812:
15813: 3. error: contains (localized) error message if an error occurred.
15814:
1.747 albertel 15815:
1.608 albertel 15816: =back
15817:
1.243 albertel 15818: =head2 HTTP Helper Routines
15819:
15820: =over 4
15821:
1.191 harris41 15822: =item *
15823:
15824: escape() : unpack non-word characters into CGI-compatible hex codes
15825:
15826: =item *
15827:
15828: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
15829:
1.243 albertel 15830: =back
15831:
15832: =head1 PRIVATE SUBROUTINES
15833:
15834: =head2 Underlying communication routines (Shouldn't call)
15835:
15836: =over 4
15837:
15838: =item *
15839:
15840: subreply() : tries to pass a message to lonc, returns con_lost if incapable
15841:
15842: =item *
15843:
15844: reply() : uses subreply to send a message to remote machine, logs all failures
15845:
15846: =item *
15847:
15848: critical() : passes a critical message to another server; if cannot
15849: get through then place message in connection buffer directory and
15850: returns con_delayed, if incapable of saving message, returns
15851: con_failed
15852:
15853: =item *
15854:
15855: reconlonc() : tries to reconnect lonc client processes.
15856:
15857: =back
15858:
15859: =head2 Resource Access Logging
15860:
15861: =over 4
15862:
15863: =item *
15864:
15865: flushcourselogs() : flush (save) buffer logs and access logs
15866:
15867: =item *
15868:
15869: courselog($what) : save message for course in hash
15870:
15871: =item *
15872:
15873: courseacclog($what) : save message for course using &courselog(). Perform
15874: special processing for specific resource types (problems, exams, quizzes, etc).
15875:
1.191 harris41 15876: =item *
15877:
15878: goodbye() : flush course logs and log shutting down; it is called in srm.conf
15879: as a PerlChildExitHandler
1.243 albertel 15880:
15881: =back
15882:
15883: =head2 Other
15884:
15885: =over 4
15886:
15887: =item *
15888:
15889: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 15890:
15891: =back
15892:
15893: =cut
1.877 foxr 15894:
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