Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1362
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1362 ! raeburn 4: # $Id: lonnet.pm,v 1.1361 2017/11/30 15:15:06 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.1337 raeburn 655: my ($linkname,$pubname);
1.1155 raeburn 656: if ($name eq '') {
657: $name = 'lonID';
1.1337 raeburn 658: $linkname = 'lonLinkID';
659: $pubname = 'lonPubID';
1.1155 raeburn 660: }
661: my $lonid=$cookies{$name};
1.1337 raeburn 662: if (!$lonid) {
663: if (($name eq 'lonID') && ($ENV{'SERVER_PORT'} != 443) && ($linkname)) {
664: $lonid=$cookies{$linkname};
665: }
666: if (!$lonid) {
667: if (($name eq 'lonID') && ($pubname)) {
668: $lonid=$cookies{$pubname};
669: }
670: }
671: }
1.916 albertel 672: return undef if (!$lonid);
673:
674: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1155 raeburn 675: my $lonidsdir;
676: if ($name eq 'lonDAV') {
677: $lonidsdir=$r->dir_config('lonDAVsessDir');
678: } else {
679: $lonidsdir=$r->dir_config('lonIDsDir');
680: }
1.1355 raeburn 681: if (!-e "$lonidsdir/$handle.id") {
682: if ((ref($domref)) && ($name eq 'lonID') &&
683: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
684: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
685: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
686: $$domref = $possudom;
687: }
688: }
689: return undef;
690: }
1.916 albertel 691:
1.917 albertel 692: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
693: return undef if (!$opened);
1.916 albertel 694:
695: flock($idf,LOCK_SH);
696: my %disk_env;
697: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
698: &GDBM_READER(),0640)) {
699: return undef;
700: }
701:
702: if (!defined($disk_env{'user.name'})
703: || !defined($disk_env{'user.domain'})) {
704: return undef;
705: }
1.1245 raeburn 706:
707: if (ref($userhashref) eq 'HASH') {
708: $userhashref->{'name'} = $disk_env{'user.name'};
709: $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1361 raeburn 710: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
1.1212 raeburn 711: }
1.1245 raeburn 712:
1.916 albertel 713: return $handle;
714: }
715:
1.830 albertel 716: sub timed_flock {
717: my ($file,$lock_type) = @_;
718: my $failed=0;
719: eval {
720: local $SIG{__DIE__}='DEFAULT';
721: local $SIG{ALRM}=sub {
722: $failed=1;
723: die("failed lock");
724: };
725: alarm(13);
726: flock($file,$lock_type);
727: alarm(0);
728: };
729: if ($failed) {
730: return undef;
731: } else {
732: return 1;
733: }
734: }
735:
1.5 www 736: # ---------------------------------------------------------- Append Environment
737:
738: sub appenv {
1.949 raeburn 739: my ($newenv,$roles) = @_;
740: if (ref($newenv) eq 'HASH') {
741: foreach my $key (keys(%{$newenv})) {
742: my $refused = 0;
743: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
744: $refused = 1;
745: if (ref($roles) eq 'ARRAY') {
1.1250 raeburn 746: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949 raeburn 747: if (grep(/^\Q$role\E$/,@{$roles})) {
748: $refused = 0;
749: }
750: }
751: }
752: if ($refused) {
753: &logthis("<font color=\"blue\">WARNING: ".
754: "Attempt to modify environment ".$key." to ".$newenv->{$key}
755: .'</font>');
756: delete($newenv->{$key});
757: } else {
758: $env{$key}=$newenv->{$key};
759: }
760: }
761: my $opened = open(my $env_file,'+<',$env{'user.environment'});
762: if ($opened
763: && &timed_flock($env_file,LOCK_EX)
764: &&
765: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
766: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
767: while (my ($key,$value) = each(%{$newenv})) {
768: $disk_env{$key} = $value;
769: }
770: untie(%disk_env);
1.35 www 771: }
1.191 harris41 772: }
1.56 www 773: return 'ok';
774: }
775: # ----------------------------------------------------- Delete from Environment
776:
777: sub delenv {
1.1104 raeburn 778: my ($delthis,$regexp,$roles) = @_;
779: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
780: my $refused = 1;
781: if (ref($roles) eq 'ARRAY') {
782: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
783: if (grep(/^\Q$role\E$/,@{$roles})) {
784: $refused = 0;
785: }
786: }
787: if ($refused) {
788: &logthis("<font color=\"blue\">WARNING: ".
789: "Attempt to delete from environment ".$delthis);
790: return 'error';
791: }
1.56 www 792: }
1.917 albertel 793: my $opened = open(my $env_file,'+<',$env{'user.environment'});
794: if ($opened
1.915 albertel 795: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 796: &&
797: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
798: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 799: foreach my $key (keys(%disk_env)) {
1.987 raeburn 800: if ($regexp) {
801: if ($key=~/^$delthis/) {
802: delete($env{$key});
803: delete($disk_env{$key});
804: }
805: } else {
806: if ($key=~/^\Q$delthis\E/) {
807: delete($env{$key});
808: delete($disk_env{$key});
809: }
810: }
1.448 albertel 811: }
1.783 albertel 812: untie(%disk_env);
1.5 www 813: }
814: return 'ok';
1.369 albertel 815: }
816:
1.790 albertel 817: sub get_env_multiple {
818: my ($name) = @_;
819: my @values;
820: if (defined($env{$name})) {
821: # exists is it an array
822: if (ref($env{$name})) {
823: @values=@{ $env{$name} };
824: } else {
825: $values[0]=$env{$name};
826: }
827: }
828: return(@values);
829: }
830:
1.958 www 831: # ------------------------------------------------------------------- Locking
832:
833: sub set_lock {
834: my ($text)=@_;
835: $locknum++;
836: my $id=$$.'-'.$locknum;
837: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
838: 'session.lock.'.$id => $text});
839: return $id;
840: }
841:
842: sub get_locks {
843: my $num=0;
844: my %texts=();
845: foreach my $lock (split(/\,/,$env{'session.locks'})) {
846: if ($lock=~/\w/) {
847: $num++;
848: $texts{$lock}=$env{'session.lock.'.$lock};
849: }
850: }
851: return ($num,%texts);
852: }
853:
854: sub remove_lock {
855: my ($id)=@_;
856: my $newlocks='';
857: foreach my $lock (split(/\,/,$env{'session.locks'})) {
858: if (($lock=~/\w/) && ($lock ne $id)) {
859: $newlocks.=','.$lock;
860: }
861: }
862: &appenv({'session.locks' => $newlocks});
863: &delenv('session.lock.'.$id);
864: }
865:
866: sub remove_all_locks {
867: my $activelocks=$env{'session.locks'};
868: foreach my $lock (split(/\,/,$env{'session.locks'})) {
869: if ($lock=~/\w/) {
870: &remove_lock($lock);
871: }
872: }
873: }
874:
875:
1.369 albertel 876: # ------------------------------------------ Find out current server userload
877: sub userload {
878: my $numusers=0;
879: {
880: opendir(LONIDS,$perlvar{'lonIDsDir'});
881: my $filename;
882: my $curtime=time;
883: while ($filename=readdir(LONIDS)) {
1.925 albertel 884: next if ($filename eq '.' || $filename eq '..');
885: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 886: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 887: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 888: }
889: closedir(LONIDS);
890: }
891: my $userloadpercent=0;
892: my $maxuserload=$perlvar{'lonUserLoadLim'};
893: if ($maxuserload) {
1.371 albertel 894: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 895: }
1.372 albertel 896: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 897: return $userloadpercent;
1.283 www 898: }
899:
1.1 albertel 900: # ------------------------------ Find server with least workload from spare.tab
1.11 www 901:
1.1 albertel 902: sub spareserver {
1.1083 raeburn 903: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 904: my $spare_server;
1.370 albertel 905: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 906: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
907: : $userloadpercent;
1.1083 raeburn 908: my ($uint_dom,$remotesessions);
909: if (($udom ne '') && (&domain($udom) ne '')) {
910: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
911: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
912: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
913: $remotesessions = $udomdefaults{'remotesessions'};
914: }
1.1123 raeburn 915: my $spareshash = &this_host_spares($udom);
916: if (ref($spareshash) eq 'HASH') {
917: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
918: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1.1279 raeburn 919: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
920: $try_server));
1.1123 raeburn 921: ($spare_server, $lowest_load) =
922: &compare_server_load($try_server, $spare_server, $lowest_load);
923: }
1.1083 raeburn 924: }
1.784 albertel 925:
1.1123 raeburn 926: my $found_server = ($spare_server ne '' && $lowest_load < 100);
927:
928: if (!$found_server) {
929: if (ref($spareshash->{'default'}) eq 'ARRAY') {
930: foreach my $try_server (@{ $spareshash->{'default'} }) {
1.1279 raeburn 931: next unless (&spare_can_host($udom,$uint_dom,
932: $remotesessions,$try_server));
1.1123 raeburn 933: ($spare_server, $lowest_load) =
934: &compare_server_load($try_server, $spare_server, $lowest_load);
935: }
936: }
937: }
1.784 albertel 938: }
939:
940: if (!$want_server_name) {
1.968 raeburn 941: my $protocol = 'http';
942: if ($protocol{$spare_server} eq 'https') {
943: $protocol = $protocol{$spare_server};
944: }
1.1001 raeburn 945: if (defined($spare_server)) {
946: my $hostname = &hostname($spare_server);
1.1083 raeburn 947: if (defined($hostname)) {
1.1001 raeburn 948: $spare_server = $protocol.'://'.$hostname;
949: }
950: }
1.784 albertel 951: }
952: return $spare_server;
953: }
954:
955: sub compare_server_load {
1.1253 raeburn 956: my ($try_server, $spare_server, $lowest_load, $required) = @_;
957:
958: if ($required) {
959: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
960: my $remoterev = &get_server_loncaparev(undef,$try_server);
961: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
962: if (($major eq '' && $minor eq '') ||
963: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
964: return ($spare_server,$lowest_load);
965: }
966: }
1.784 albertel 967:
968: my $loadans = &reply('load', $try_server);
969: my $userloadans = &reply('userload',$try_server);
970:
971: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 972: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 973: }
974:
975: my $load;
976: if ($loadans =~ /\d/) {
977: if ($userloadans =~ /\d/) {
978: #both are numbers, pick the bigger one
979: $load = ($loadans > $userloadans) ? $loadans
980: : $userloadans;
1.411 albertel 981: } else {
1.784 albertel 982: $load = $loadans;
1.411 albertel 983: }
1.784 albertel 984: } else {
985: $load = $userloadans;
986: }
987:
988: if (($load =~ /\d/) && ($load < $lowest_load)) {
989: $spare_server = $try_server;
990: $lowest_load = $load;
1.370 albertel 991: }
1.784 albertel 992: return ($spare_server,$lowest_load);
1.202 matthew 993: }
1.914 albertel 994:
995: # --------------------------- ask offload servers if user already has a session
996: sub find_existing_session {
997: my ($udom,$uname) = @_;
1.1123 raeburn 998: my $spareshash = &this_host_spares($udom);
999: if (ref($spareshash) eq 'HASH') {
1000: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1001: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1002: return $try_server if (&has_user_session($try_server, $udom, $uname));
1003: }
1004: }
1005: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1006: foreach my $try_server (@{ $spareshash->{'default'} }) {
1007: return $try_server if (&has_user_session($try_server, $udom, $uname));
1008: }
1009: }
1.914 albertel 1010: }
1011: return;
1012: }
1013:
1014: # -------------------------------- ask if server already has a session for user
1015: sub has_user_session {
1016: my ($lonid,$udom,$uname) = @_;
1017: my $result = &reply(join(':','userhassession',
1018: map {&escape($_)} ($udom,$uname)),$lonid);
1019: return 1 if ($result eq 'ok');
1020:
1021: return 0;
1022: }
1023:
1.1076 raeburn 1024: # --------- determine least loaded server in a user's domain which allows login
1025:
1026: sub choose_server {
1.1259 raeburn 1027: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076 raeburn 1028: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 1029: my %servers = &get_servers($udom);
1.1076 raeburn 1030: my $lowest_load = 30000;
1.1259 raeburn 1031: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1032: if ($skiploadbal) {
1033: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1034: unless (defined($cached)) {
1035: my $cachetime = 60*60*24;
1036: my %domconfig =
1037: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1038: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1039: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1040: $cachetime);
1041: }
1042: }
1043: }
1.1076 raeburn 1044: foreach my $lonhost (keys(%servers)) {
1.1259 raeburn 1045: if ($skiploadbal) {
1046: if (ref($balancers) eq 'HASH') {
1047: next if (exists($balancers->{$lonhost}));
1048: }
1049: }
1.1115 raeburn 1050: my $loginvia;
1051: if ($checkloginvia) {
1052: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 1053: if ($loginvia) {
1054: my ($server,$path) = split(/:/,$loginvia);
1055: ($login_host, $lowest_load) =
1.1253 raeburn 1056: &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116 raeburn 1057: if ($login_host eq $server) {
1058: $portal_path = $path;
1.1151 raeburn 1059: $isredirect = 1;
1.1116 raeburn 1060: }
1061: } else {
1062: ($login_host, $lowest_load) =
1.1253 raeburn 1063: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116 raeburn 1064: if ($login_host eq $lonhost) {
1065: $portal_path = '';
1.1151 raeburn 1066: $isredirect = '';
1.1116 raeburn 1067: }
1068: }
1069: } else {
1.1076 raeburn 1070: ($login_host, $lowest_load) =
1.1253 raeburn 1071: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076 raeburn 1072: }
1073: }
1074: if ($login_host ne '') {
1.1116 raeburn 1075: $hostname = &hostname($login_host);
1.1076 raeburn 1076: }
1.1331 raeburn 1077: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1.1076 raeburn 1078: }
1079:
1.202 matthew 1080: # --------------------------------------------- Try to change a user's password
1081:
1082: sub changepass {
1.799 raeburn 1083: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 1084: $currentpass = &escape($currentpass);
1085: $newpass = &escape($newpass);
1.1030 raeburn 1086: my $lonhost = $perlvar{'lonHostID'};
1087: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 1088: $server);
1089: if (! $answer) {
1090: &logthis("No reply on password change request to $server ".
1091: "by $uname in domain $udom.");
1092: } elsif ($answer =~ "^ok") {
1093: &logthis("$uname in $udom successfully changed their password ".
1094: "on $server.");
1095: } elsif ($answer =~ "^pwchange_failure") {
1096: &logthis("$uname in $udom was unable to change their password ".
1097: "on $server. The action was blocked by either lcpasswd ".
1098: "or pwchange");
1099: } elsif ($answer =~ "^non_authorized") {
1100: &logthis("$uname in $udom did not get their password correct when ".
1101: "attempting to change it on $server.");
1102: } elsif ($answer =~ "^auth_mode_error") {
1103: &logthis("$uname in $udom attempted to change their password despite ".
1104: "not being locally or internally authenticated on $server.");
1105: } elsif ($answer =~ "^unknown_user") {
1106: &logthis("$uname in $udom attempted to change their password ".
1107: "on $server but were unable to because $server is not ".
1108: "their home server.");
1109: } elsif ($answer =~ "^refused") {
1110: &logthis("$server refused to change $uname in $udom password because ".
1111: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1112: } elsif ($answer =~ "invalid_client") {
1113: &logthis("$server refused to change $uname in $udom password because ".
1114: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 1115: }
1116: return $answer;
1.1 albertel 1117: }
1118:
1.169 harris41 1119: # ----------------------- Try to determine user's current authentication scheme
1120:
1121: sub queryauthenticate {
1122: my ($uname,$udom)=@_;
1.456 albertel 1123: my $uhome=&homeserver($uname,$udom);
1124: if (!$uhome) {
1125: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1126: return 'no_host';
1127: }
1128: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1129: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1130: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1131: }
1.456 albertel 1132: return $answer;
1.169 harris41 1133: }
1134:
1.1 albertel 1135: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1136:
1.1 albertel 1137: sub authenticate {
1.1073 raeburn 1138: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1139: $upass=&escape($upass);
1140: $uname= &LONCAPA::clean_username($uname);
1.836 www 1141: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1142: my $newhome;
1.836 www 1143: if ((!$uhome) || ($uhome eq 'no_host')) {
1144: # Maybe the machine was offline and only re-appeared again recently?
1145: &reconlonc();
1146: # One more
1.952 raeburn 1147: $uhome=&homeserver($uname,$udom,1);
1148: if (($uhome eq 'no_host') && $checkdefauth) {
1149: if (defined(&domain($udom,'primary'))) {
1150: $newhome=&domain($udom,'primary');
1151: }
1152: if ($newhome ne '') {
1153: $uhome = $newhome;
1154: }
1155: }
1.836 www 1156: if ((!$uhome) || ($uhome eq 'no_host')) {
1157: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1158: return 'no_host';
1159: }
1.1 albertel 1160: }
1.1073 raeburn 1161: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1162: if ($answer eq 'authorized') {
1.952 raeburn 1163: if ($newhome) {
1164: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1165: return 'no_account_on_host';
1166: } else {
1167: &logthis("User $uname at $udom authorized by $uhome");
1168: return $uhome;
1169: }
1.471 albertel 1170: }
1171: if ($answer eq 'non_authorized') {
1172: &logthis("User $uname at $udom rejected by $uhome");
1173: return 'no_host';
1.9 www 1174: }
1.471 albertel 1175: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1176: return 'no_host';
1177: }
1178:
1.1073 raeburn 1179: sub can_host_session {
1.1074 raeburn 1180: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1181: my $canhost = 1;
1.1074 raeburn 1182: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1183: if (ref($remotesessions) eq 'HASH') {
1184: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1185: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1186: $canhost = 0;
1187: } else {
1188: $canhost = 1;
1189: }
1190: }
1191: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1192: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1193: $canhost = 1;
1194: } else {
1195: $canhost = 0;
1196: }
1197: }
1198: if ($canhost) {
1199: if ($remotesessions->{'version'} ne '') {
1200: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1201: if ($reqmajor ne '' && $reqminor ne '') {
1202: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1203: my $major = $1;
1204: my $minor = $2;
1205: if (($major < $reqmajor ) ||
1206: (($major == $reqmajor) && ($minor < $reqminor))) {
1207: $canhost = 0;
1208: }
1209: } else {
1210: $canhost = 0;
1211: }
1212: }
1213: }
1214: }
1215: }
1216: if ($canhost) {
1217: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1218: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1219: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1220: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1221: if (($uint_dom ne '') &&
1222: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1223: $canhost = 0;
1224: } else {
1225: $canhost = 1;
1226: }
1227: }
1228: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1229: if (($uint_dom ne '') &&
1230: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1231: $canhost = 1;
1232: } else {
1233: $canhost = 0;
1234: }
1235: }
1236: }
1237: }
1238: return $canhost;
1239: }
1240:
1.1083 raeburn 1241: sub spare_can_host {
1242: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1243: my $canhost=1;
1.1279 raeburn 1244: my $try_server_hostname = &hostname($try_server);
1245: my $serverhomeID = &get_server_homeID($try_server_hostname);
1246: my $serverhomedom = &host_domain($serverhomeID);
1247: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1248: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1249: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1250: $canhost = 0;
1251: }
1252: }
1253: if (($canhost) && ($uint_dom)) {
1254: my @intdoms;
1255: my $internet_names = &get_internet_names($try_server);
1256: if (ref($internet_names) eq 'ARRAY') {
1257: @intdoms = @{$internet_names};
1258: }
1259: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1260: my $remoterev = &get_server_loncaparev(undef,$try_server);
1261: $canhost = &can_host_session($udom,$try_server,$remoterev,
1262: $remotesessions,
1263: $defdomdefaults{'hostedsessions'});
1264: }
1.1083 raeburn 1265: }
1266: return $canhost;
1267: }
1268:
1.1123 raeburn 1269: sub this_host_spares {
1270: my ($dom) = @_;
1.1126 raeburn 1271: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1272: my @hosts = ¤t_machine_ids();
1273: foreach my $lonhost (@hosts) {
1274: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1275: $dom_in_use = $dom;
1276: $lonhost_in_use = $lonhost;
1.1123 raeburn 1277: last;
1278: }
1279: }
1.1126 raeburn 1280: if ($dom_in_use ne '') {
1281: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1282: }
1283: if (ref($result) ne 'HASH') {
1284: $lonhost_in_use = $perlvar{'lonHostID'};
1285: $dom_in_use = &host_domain($lonhost_in_use);
1286: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1287: if (ref($result) ne 'HASH') {
1288: $result = \%spareid;
1289: }
1290: }
1291: return $result;
1292: }
1293:
1294: sub spares_for_offload {
1295: my ($dom_in_use,$lonhost_in_use) = @_;
1296: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1297: if (defined($cached)) {
1298: return $result;
1299: } else {
1.1126 raeburn 1300: my $cachetime = 60*60*24;
1301: my %domconfig =
1302: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1303: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1304: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1305: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1306: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1307: }
1308: }
1309: }
1310: }
1.1126 raeburn 1311: return;
1.1123 raeburn 1312: }
1313:
1.1129 raeburn 1314: sub get_lonbalancer_config {
1315: my ($servers) = @_;
1316: my ($currbalancer,$currtargets);
1317: if (ref($servers) eq 'HASH') {
1318: foreach my $server (keys(%{$servers})) {
1319: my %what = (
1320: spareid => 1,
1321: perlvar => 1,
1322: );
1323: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1324: if ($result eq 'ok') {
1325: if (ref($returnhash) eq 'HASH') {
1326: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1327: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1328: $currbalancer = $server;
1329: $currtargets = {};
1330: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1331: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1332: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1333: }
1334: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1335: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1336: }
1337: }
1338: last;
1339: }
1340: }
1341: }
1342: }
1343: }
1344: }
1345: return ($currbalancer,$currtargets);
1346: }
1347:
1348: sub check_loadbalancing {
1.1331 raeburn 1349: my ($uname,$udom,$caller) = @_;
1.1191 raeburn 1350: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1351: $rule_in_effect,$offloadto,$otherserver);
1.1129 raeburn 1352: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1353: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1354: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1355: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1356: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1357: my $serverhomedom = &host_domain($lonhost);
1.1307 raeburn 1358: my $domneedscache;
1.1129 raeburn 1359: my $cachetime = 60*60*24;
1360:
1361: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1362: $dom_in_use = $udom;
1363: $homeintdom = 1;
1364: } else {
1365: $dom_in_use = $serverhomedom;
1366: }
1367: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1368: unless (defined($cached)) {
1369: my %domconfig =
1370: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1371: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1372: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1307 raeburn 1373: } else {
1374: $domneedscache = $dom_in_use;
1.1129 raeburn 1375: }
1376: }
1377: if (ref($result) eq 'HASH') {
1.1191 raeburn 1378: ($is_balancer,$currtargets,$currrules) =
1379: &check_balancer_result($result,@hosts);
1.1129 raeburn 1380: if ($is_balancer) {
1381: if (ref($currrules) eq 'HASH') {
1382: if ($homeintdom) {
1383: if ($uname ne '') {
1384: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1385: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1386: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1387: $rule_in_effect = $currrules->{'_LC_author'};
1388: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1389: $rule_in_effect = $currrules->{'_LC_adv'}
1390: }
1391: }
1392: if ($rule_in_effect eq '') {
1393: my %userenv = &userenvironment($udom,$uname,'inststatus');
1394: if ($userenv{'inststatus'} ne '') {
1395: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1396: my ($othertitle,$usertypes,$types) =
1397: &Apache::loncommon::sorted_inst_types($udom);
1398: if (ref($types) eq 'ARRAY') {
1399: foreach my $type (@{$types}) {
1400: if (grep(/^\Q$type\E$/,@statuses)) {
1401: if (exists($currrules->{$type})) {
1402: $rule_in_effect = $currrules->{$type};
1403: }
1404: }
1405: }
1406: }
1407: } else {
1408: if (exists($currrules->{'default'})) {
1409: $rule_in_effect = $currrules->{'default'};
1410: }
1411: }
1412: }
1413: } else {
1414: if (exists($currrules->{'default'})) {
1415: $rule_in_effect = $currrules->{'default'};
1416: }
1417: }
1418: } else {
1419: if ($currrules->{'_LC_external'} ne '') {
1420: $rule_in_effect = $currrules->{'_LC_external'};
1421: }
1422: }
1423: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1424: $uname,$udom);
1425: }
1426: }
1427: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1239 raeburn 1428: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1429: unless (defined($cached)) {
1430: my %domconfig =
1431: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1432: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1307 raeburn 1433: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1434: } else {
1435: $domneedscache = $serverhomedom;
1.1129 raeburn 1436: }
1437: }
1438: if (ref($result) eq 'HASH') {
1.1191 raeburn 1439: ($is_balancer,$currtargets,$currrules) =
1440: &check_balancer_result($result,@hosts);
1441: if ($is_balancer) {
1.1129 raeburn 1442: if (ref($currrules) eq 'HASH') {
1443: if ($currrules->{'_LC_internetdom'} ne '') {
1444: $rule_in_effect = $currrules->{'_LC_internetdom'};
1445: }
1446: }
1447: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1448: $uname,$udom);
1449: }
1450: } else {
1451: if ($perlvar{'lonBalancer'} eq 'yes') {
1452: $is_balancer = 1;
1453: $offloadto = &this_host_spares($dom_in_use);
1454: }
1.1307 raeburn 1455: unless (defined($cached)) {
1456: $domneedscache = $serverhomedom;
1457: }
1.1129 raeburn 1458: }
1459: } else {
1460: if ($perlvar{'lonBalancer'} eq 'yes') {
1461: $is_balancer = 1;
1462: $offloadto = &this_host_spares($dom_in_use);
1463: }
1.1307 raeburn 1464: unless (defined($cached)) {
1465: $domneedscache = $serverhomedom;
1466: }
1467: }
1468: if ($domneedscache) {
1469: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129 raeburn 1470: }
1.1176 raeburn 1471: if ($is_balancer) {
1472: my $lowest_load = 30000;
1473: if (ref($offloadto) eq 'HASH') {
1474: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1475: foreach my $try_server (@{$offloadto->{'primary'}}) {
1476: ($otherserver,$lowest_load) =
1477: &compare_server_load($try_server,$otherserver,$lowest_load);
1478: }
1.1129 raeburn 1479: }
1.1176 raeburn 1480: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1481:
1.1176 raeburn 1482: if (!$found_server) {
1483: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1484: foreach my $try_server (@{$offloadto->{'default'}}) {
1485: ($otherserver,$lowest_load) =
1486: &compare_server_load($try_server,$otherserver,$lowest_load);
1487: }
1488: }
1489: }
1490: } elsif (ref($offloadto) eq 'ARRAY') {
1491: if (@{$offloadto} == 1) {
1492: $otherserver = $offloadto->[0];
1493: } elsif (@{$offloadto} > 1) {
1494: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1495: ($otherserver,$lowest_load) =
1496: &compare_server_load($try_server,$otherserver,$lowest_load);
1497: }
1498: }
1499: }
1.1331 raeburn 1500: unless ($caller eq 'login') {
1501: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1502: $is_balancer = 0;
1503: if ($uname ne '' && $udom ne '') {
1504: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1.1176 raeburn 1505:
1.1331 raeburn 1506: &appenv({'user.loadbalexempt' => $lonhost,
1507: 'user.loadbalcheck.time' => time});
1508: }
1.1176 raeburn 1509: }
1.1129 raeburn 1510: }
1511: }
1512: }
1513: return ($is_balancer,$otherserver);
1514: }
1515:
1.1191 raeburn 1516: sub check_balancer_result {
1517: my ($result,@hosts) = @_;
1518: my ($is_balancer,$currtargets,$currrules);
1519: if (ref($result) eq 'HASH') {
1520: if ($result->{'lonhost'} ne '') {
1521: my $currbalancer = $result->{'lonhost'};
1522: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1523: $is_balancer = 1;
1524: $currtargets = $result->{'targets'};
1525: $currrules = $result->{'rules'};
1526: }
1527: } else {
1528: foreach my $key (keys(%{$result})) {
1529: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1530: (ref($result->{$key}) eq 'HASH')) {
1531: $is_balancer = 1;
1532: $currrules = $result->{$key}{'rules'};
1533: $currtargets = $result->{$key}{'targets'};
1534: last;
1535: }
1536: }
1537: }
1538: }
1539: return ($is_balancer,$currtargets,$currrules);
1540: }
1541:
1.1129 raeburn 1542: sub get_loadbalancer_targets {
1543: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1544: my $offloadto;
1.1175 raeburn 1545: if ($rule_in_effect eq 'none') {
1546: return [$perlvar{'lonHostID'}];
1547: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1548: $offloadto = $currtargets;
1549: } else {
1550: if ($rule_in_effect eq 'homeserver') {
1551: my $homeserver = &homeserver($uname,$udom);
1552: if ($homeserver ne 'no_host') {
1553: $offloadto = [$homeserver];
1554: }
1555: } elsif ($rule_in_effect eq 'externalbalancer') {
1556: my %domconfig =
1557: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1558: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1559: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1560: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1561: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1562: }
1563: }
1564: } else {
1.1178 raeburn 1565: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1566: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1567: if (&hostname($remotebalancer) ne '') {
1568: $offloadto = [$remotebalancer];
1569: }
1570: }
1571: } elsif (&hostname($rule_in_effect) ne '') {
1572: $offloadto = [$rule_in_effect];
1573: }
1574: }
1575: return $offloadto;
1576: }
1577:
1.1127 raeburn 1578: sub internet_dom_servers {
1579: my ($dom) = @_;
1580: my (%uniqservers,%servers);
1581: my $primaryserver = &hostname(&domain($dom,'primary'));
1582: my @machinedoms = &machine_domains($primaryserver);
1583: foreach my $mdom (@machinedoms) {
1584: my %currservers = %servers;
1585: my %server = &get_servers($mdom);
1586: %servers = (%currservers,%server);
1587: }
1588: my %by_hostname;
1589: foreach my $id (keys(%servers)) {
1590: push(@{$by_hostname{$servers{$id}}},$id);
1591: }
1592: foreach my $hostname (sort(keys(%by_hostname))) {
1593: if (@{$by_hostname{$hostname}} > 1) {
1594: my $match = 0;
1595: foreach my $id (@{$by_hostname{$hostname}}) {
1596: if (&host_domain($id) eq $dom) {
1597: $uniqservers{$id} = $hostname;
1598: $match = 1;
1599: }
1600: }
1601: unless ($match) {
1602: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1603: }
1604: } else {
1605: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1606: }
1607: }
1608: return %uniqservers;
1609: }
1610:
1.1347 raeburn 1611: sub trusted_domains {
1612: my ($cmdtype,$calldom) = @_;
1.1349 raeburn 1613: my ($trusted,$untrusted);
1.1347 raeburn 1614: if (&domain($calldom) eq '') {
1.1349 raeburn 1615: return ($trusted,$untrusted);
1.1347 raeburn 1616: }
1617: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|domroles|catalog|reqcrs|msg)$/) {
1.1349 raeburn 1618: return ($trusted,$untrusted);
1.1347 raeburn 1619: }
1620: my $callprimary = &domain($calldom,'primary');
1621: my $intcalldom = &Apache::lonnet::internet_dom($callprimary);
1622: if ($intcalldom eq '') {
1.1349 raeburn 1623: return ($trusted,$untrusted);
1.1347 raeburn 1624: }
1625:
1626: my ($trustconfig,$cached)=&Apache::lonnet::is_cached_new('trust',$calldom);
1627: unless (defined($cached)) {
1628: my %domconfig = &Apache::lonnet::get_dom('configuration',['trust'],$calldom);
1629: &Apache::lonnet::do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1630: $trustconfig = $domconfig{'trust'};
1631: }
1632: if (ref($trustconfig)) {
1633: my (%possexc,%possinc,@allexc,@allinc);
1634: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1635: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1636: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1637: }
1638: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1639: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1640: }
1641: }
1642: if (keys(%possexc)) {
1643: if (keys(%possinc)) {
1644: foreach my $key (sort(keys(%possexc))) {
1645: next if ($key eq $intcalldom);
1646: unless ($possinc{$key}) {
1647: push(@allexc,$key);
1648: }
1649: }
1650: } else {
1651: @allexc = sort(keys(%possexc));
1652: }
1653: }
1654: if (keys(%possinc)) {
1655: $possinc{$intcalldom} = 1;
1656: @allinc = sort(keys(%possinc));
1657: }
1658: if ((@allexc > 0) || (@allinc > 0)) {
1659: my %doms_by_intdom;
1660: my %allintdoms = &all_host_intdom();
1661: my %alldoms = &all_host_domain();
1662: foreach my $key (%allintdoms) {
1663: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1664: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1665: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1666: }
1667: } else {
1668: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1669: }
1670: }
1671: foreach my $exc (@allexc) {
1672: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1.1349 raeburn 1673: $untrusted = $doms_by_intdom{$exc};
1.1347 raeburn 1674: }
1675: }
1676: foreach my $inc (@allinc) {
1677: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1.1349 raeburn 1678: $trusted = $doms_by_intdom{$inc};
1.1347 raeburn 1679: }
1680: }
1681: }
1682: }
1.1349 raeburn 1683: return ($trusted,$untrusted);
1.1347 raeburn 1684: }
1685:
1686: sub will_trust {
1687: my ($cmdtype,$domain,$possdom) = @_;
1688: return 1 if ($domain eq $possdom);
1689: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1690: my $willtrust;
1691: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1692: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1693: $willtrust = 1;
1694: }
1695: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1696: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1697: $willtrust = 1;
1698: }
1699: } else {
1700: $willtrust = 1;
1701: }
1702: return $willtrust;
1703: }
1704:
1.1 albertel 1705: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1706:
1.599 albertel 1707: my %homecache;
1.1 albertel 1708: sub homeserver {
1.230 stredwic 1709: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1710: my $index="$uname:$udom";
1.426 albertel 1711:
1.599 albertel 1712: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1713:
1714: my %servers = &get_servers($udom,'library');
1715: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1716: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1717: exists($badServerCache{$tryserver}));
1.841 albertel 1718:
1719: my $answer=reply("home:$udom:$uname",$tryserver);
1720: if ($answer eq 'found') {
1721: delete($badServerCache{$tryserver});
1722: return $homecache{$index}=$tryserver;
1723: } elsif ($answer eq 'no_host') {
1724: $badServerCache{$tryserver}=1;
1725: }
1.1 albertel 1726: }
1727: return 'no_host';
1.70 www 1728: }
1729:
1.1300 raeburn 1730: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1.70 www 1731:
1732: sub idget {
1.1300 raeburn 1733: my ($udom,$idsref,$namespace)=@_;
1.70 www 1734: my %returnhash=();
1.1300 raeburn 1735: my @ids=();
1736: if (ref($idsref) eq 'ARRAY') {
1737: @ids = @{$idsref};
1738: } else {
1739: return %returnhash;
1740: }
1741: if ($namespace eq '') {
1742: $namespace = 'ids';
1743: }
1.70 www 1744:
1.841 albertel 1745: my %servers = &get_servers($udom,'library');
1746: foreach my $tryserver (keys(%servers)) {
1.1299 raeburn 1747: my $idlist=join('&', map { &escape($_); } @ids);
1.1300 raeburn 1748: if ($namespace eq 'ids') {
1749: $idlist=~tr/A-Z/a-z/;
1750: }
1751: my $reply;
1752: if ($namespace eq 'ids') {
1753: $reply=&reply("idget:$udom:".$idlist,$tryserver);
1754: } else {
1755: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
1756: }
1.841 albertel 1757: my @answer=();
1758: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1759: @answer=split(/\&/,$reply);
1760: } ;
1761: my $i;
1762: for ($i=0;$i<=$#ids;$i++) {
1763: if ($answer[$i]) {
1.1299 raeburn 1764: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1.1300 raeburn 1765: }
1.841 albertel 1766: }
1.1300 raeburn 1767: }
1.70 www 1768: return %returnhash;
1769: }
1770:
1771: # ------------------------------------- Find the IDs behind a list of usernames
1772:
1773: sub idrget {
1774: my ($udom,@unames)=@_;
1775: my %returnhash=();
1.800 albertel 1776: foreach my $uname (@unames) {
1777: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1778: }
1.70 www 1779: return %returnhash;
1780: }
1781:
1.1300 raeburn 1782: # Store away a list of names and associated student/employee IDs or clicker IDs
1.70 www 1783:
1784: sub idput {
1.1300 raeburn 1785: my ($udom,$idsref,$uhom,$namespace)=@_;
1.70 www 1786: my %servers=();
1.1300 raeburn 1787: my %ids=();
1788: my %byid = ();
1789: if (ref($idsref) eq 'HASH') {
1790: %ids=%{$idsref};
1791: }
1792: if ($namespace eq '') {
1793: $namespace = 'ids';
1794: }
1.800 albertel 1795: foreach my $uname (keys(%ids)) {
1796: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1.1300 raeburn 1797: if ($uhom eq '') {
1798: $uhom=&homeserver($uname,$udom);
1799: }
1.70 www 1800: if ($uhom ne 'no_host') {
1.800 albertel 1801: my $esc_unam=&escape($uname);
1.1300 raeburn 1802: if ($namespace eq 'ids') {
1803: my $id=&escape($ids{$uname});
1804: $id=~tr/A-Z/a-z/;
1805: my $esc_unam=&escape($uname);
1806: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1.70 www 1807: } else {
1.1300 raeburn 1808: my @currids = split(/,/,$ids{$uname});
1809: foreach my $id (@currids) {
1810: $byid{$uhom}{$id} .= $uname.',';
1811: }
1812: }
1813: }
1814: }
1815: if ($namespace eq 'clickers') {
1816: foreach my $server (keys(%byid)) {
1817: if (ref($byid{$server}) eq 'HASH') {
1818: foreach my $id (keys(%{$byid{$server}})) {
1819: $byid{$server} =~ s/,$//;
1820: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
1821: }
1.70 www 1822: }
1823: }
1.191 harris41 1824: }
1.800 albertel 1825: foreach my $server (keys(%servers)) {
1.1300 raeburn 1826: $servers{$server} =~ s/\&$//;
1827: if ($namespace eq 'ids') {
1828: &critical('idput:'.$udom.':'.$servers{$server},$server);
1829: } else {
1830: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
1831: }
1.191 harris41 1832: }
1.344 www 1833: }
1834:
1.1300 raeburn 1835: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1.1231 raeburn 1836:
1837: sub iddel {
1.1300 raeburn 1838: my ($udom,$idshashref,$uhome,$namespace)=@_;
1.1231 raeburn 1839: my %result=();
1.1300 raeburn 1840: my %ids=();
1841: my %byid = ();
1842: if (ref($idshashref) eq 'HASH') {
1843: %ids=%{$idshashref};
1844: } else {
1.1231 raeburn 1845: return %result;
1846: }
1.1300 raeburn 1847: if ($namespace eq '') {
1848: $namespace = 'ids';
1849: }
1.1231 raeburn 1850: my %servers=();
1.1300 raeburn 1851: while (my ($id,$unamestr) = each(%ids)) {
1852: if ($namespace eq 'ids') {
1853: my $uhom = $uhome;
1854: if ($uhom eq '') {
1855: $uhom=&homeserver($unamestr,$udom);
1856: }
1857: if ($uhom ne 'no_host') {
1858: $servers{$uhom}.='&'.&escape($id);
1859: }
1860: } else {
1861: my @curritems = split(/,/,$ids{$id});
1862: foreach my $uname (@curritems) {
1863: my $uhom = $uhome;
1864: if ($uhom eq '') {
1865: $uhom=&homeserver($uname,$udom);
1866: }
1867: if ($uhom ne 'no_host') {
1868: $byid{$uhom}{$id} .= $uname.',';
1869: }
1870: }
1.1231 raeburn 1871: }
1.1300 raeburn 1872: }
1873: if ($namespace eq 'clickers') {
1874: foreach my $server (keys(%byid)) {
1875: if (ref($byid{$server}) eq 'HASH') {
1876: foreach my $id (keys(%{$byid{$server}})) {
1877: $byid{$server}{$id} =~ s/,$//;
1878: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
1879: }
1.1231 raeburn 1880: }
1881: }
1882: }
1883: foreach my $server (keys(%servers)) {
1.1300 raeburn 1884: $servers{$server} =~ s/\&$//;
1885: if ($namespace eq 'ids') {
1886: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1887: } elsif ($namespace eq 'clickers') {
1888: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
1889: }
1.1231 raeburn 1890: }
1891: return %result;
1892: }
1893:
1.1300 raeburn 1894: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
1895:
1896: sub updateclickers {
1897: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
1898: my %clickers;
1899: if (ref($idshashref) eq 'HASH') {
1900: %clickers=%{$idshashref};
1901: } else {
1902: return;
1903: }
1904: my $items='';
1905: foreach my $item (keys(%clickers)) {
1906: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
1907: }
1908: $items=~s/\&$//;
1909: my $request = "updateclickers:$udom:$action:$items";
1910: if ($critical) {
1911: return &critical($request,$uhome);
1912: } else {
1913: return &reply($request,$uhome);
1914: }
1915: }
1916:
1.1023 raeburn 1917: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 1918: sub dump_dom {
1.1165 droeschl 1919: my ($namespace, $udom, $regexp) = @_;
1920:
1921: $udom ||= $env{'user.domain'};
1922:
1923: return () unless $udom;
1924:
1925: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 1926: }
1927:
1.1023 raeburn 1928: # ------------------------------------------ get items from domain db files
1.806 raeburn 1929:
1930: sub get_dom {
1.860 raeburn 1931: my ($namespace,$storearr,$udom,$uhome)=@_;
1.1267 raeburn 1932: return if ($udom eq 'public');
1.806 raeburn 1933: my $items='';
1934: foreach my $item (@$storearr) {
1935: $items.=&escape($item).'&';
1936: }
1937: $items=~s/\&$//;
1.860 raeburn 1938: if (!$udom) {
1939: $udom=$env{'user.domain'};
1.1267 raeburn 1940: return if ($udom eq 'public');
1.860 raeburn 1941: if (defined(&domain($udom,'primary'))) {
1942: $uhome=&domain($udom,'primary');
1943: } else {
1.874 albertel 1944: undef($uhome);
1.860 raeburn 1945: }
1946: } else {
1947: if (!$uhome) {
1948: if (defined(&domain($udom,'primary'))) {
1949: $uhome=&domain($udom,'primary');
1950: }
1951: }
1952: }
1953: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.1344 raeburn 1954: my $rep;
1955: if ($namespace =~ /^enc/) {
1956: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
1957: } else {
1958: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1959: }
1.866 raeburn 1960: my %returnhash;
1.875 albertel 1961: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1962: return %returnhash;
1963: }
1.806 raeburn 1964: my @pairs=split(/\&/,$rep);
1965: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1966: return @pairs;
1967: }
1968: my $i=0;
1969: foreach my $item (@$storearr) {
1970: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1971: $i++;
1972: }
1973: return %returnhash;
1974: } else {
1.880 banghart 1975: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1976: }
1977: }
1978:
1979: # -------------------------------------------- put items in domain db files
1980:
1981: sub put_dom {
1.860 raeburn 1982: my ($namespace,$storehash,$udom,$uhome)=@_;
1983: if (!$udom) {
1984: $udom=$env{'user.domain'};
1985: if (defined(&domain($udom,'primary'))) {
1986: $uhome=&domain($udom,'primary');
1987: } else {
1.874 albertel 1988: undef($uhome);
1.860 raeburn 1989: }
1990: } else {
1991: if (!$uhome) {
1992: if (defined(&domain($udom,'primary'))) {
1993: $uhome=&domain($udom,'primary');
1994: }
1995: }
1996: }
1997: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1998: my $items='';
1999: foreach my $item (keys(%$storehash)) {
2000: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2001: }
2002: $items=~s/\&$//;
1.1344 raeburn 2003: if ($namespace =~ /^enc/) {
2004: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2005: } else {
2006: return &reply("putdom:$udom:$namespace:$items",$uhome);
2007: }
1.806 raeburn 2008: } else {
1.860 raeburn 2009: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 2010: }
2011: }
2012:
1.1023 raeburn 2013: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 2014: sub newput_dom {
1.1023 raeburn 2015: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 2016: my $result;
2017: if (!$udom) {
2018: $udom=$env{'user.domain'};
2019: }
1.1023 raeburn 2020: if ($udom) {
2021: my $uname = &get_domainconfiguser($udom);
2022: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 2023: }
2024: return $result;
2025: }
2026:
1.1023 raeburn 2027: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 2028: sub del_dom {
1.1023 raeburn 2029: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 2030: if (ref($storearr) eq 'ARRAY') {
2031: if (!$udom) {
2032: $udom=$env{'user.domain'};
2033: }
1.1023 raeburn 2034: if ($udom) {
2035: my $uname = &get_domainconfiguser($udom);
2036: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 2037: }
2038: }
2039: }
2040:
1.1023 raeburn 2041: # ----------------------------------construct domainconfig user for a domain
2042: sub get_domainconfiguser {
2043: my ($udom) = @_;
2044: return $udom.'-domainconfig';
2045: }
2046:
1.837 raeburn 2047: sub retrieve_inst_usertypes {
2048: my ($udom) = @_;
2049: my (%returnhash,@order);
1.989 raeburn 2050: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
2051: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2052: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256 raeburn 2053: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 2054: } else {
2055: if (defined(&domain($udom,'primary'))) {
2056: my $uhome=&domain($udom,'primary');
2057: my $rep=&reply("inst_usertypes:$udom",$uhome);
2058: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1256 raeburn 2059: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 2060: return (\%returnhash,\@order);
2061: }
2062: my ($hashitems,$orderitems) = split(/:/,$rep);
2063: my @pairs=split(/\&/,$hashitems);
2064: foreach my $item (@pairs) {
2065: my ($key,$value)=split(/=/,$item,2);
2066: $key = &unescape($key);
2067: next if ($key =~ /^error: 2 /);
2068: $returnhash{$key}=&thaw_unescape($value);
2069: }
2070: my @esc_order = split(/\&/,$orderitems);
2071: foreach my $item (@esc_order) {
2072: push(@order,&unescape($item));
2073: }
2074: } else {
1.1256 raeburn 2075: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 2076: }
1.1256 raeburn 2077: return (\%returnhash,\@order);
1.837 raeburn 2078: }
2079: }
2080:
1.868 raeburn 2081: sub is_domainimage {
2082: my ($url) = @_;
1.1306 raeburn 2083: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1.868 raeburn 2084: if (&domain($1) ne '') {
2085: return '1';
2086: }
2087: }
2088: return;
2089: }
2090:
1.899 raeburn 2091: sub inst_directory_query {
2092: my ($srch) = @_;
2093: my $udom = $srch->{'srchdomain'};
2094: my %results;
2095: my $homeserver = &domain($udom,'primary');
1.909 raeburn 2096: my $outcome;
1.899 raeburn 2097: if ($homeserver ne '') {
1.1357 raeburn 2098: unless ($homeserver eq $perlvar{'lonHostID'}) {
2099: if ($srch->{'srchby'} eq 'email') {
2100: my $lcrev = &get_server_loncaparev(undef,$homeserver);
2101: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2102: if (($major eq '' && $minor eq '') || ($major < 2) ||
2103: (($major == 2) && ($minor < 12))) {
2104: return;
2105: }
2106: }
2107: }
1.904 albertel 2108: my $queryid=&reply("querysend:instdirsearch:".
2109: &escape($srch->{'srchby'}).':'.
2110: &escape($srch->{'srchterm'}).':'.
2111: &escape($srch->{'srchtype'}),$homeserver);
2112: my $host=&hostname($homeserver);
2113: if ($queryid !~/^\Q$host\E\_/) {
1.1343 raeburn 2114: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
1.904 albertel 2115: return;
2116: }
2117: my $response = &get_query_reply($queryid);
2118: my $maxtries = 5;
2119: my $tries = 1;
2120: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2121: $response = &get_query_reply($queryid);
2122: $tries ++;
2123: }
2124:
2125: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 2126: if ($response eq 'unavailable') {
2127: $outcome = $response;
2128: } else {
2129: $outcome = 'ok';
2130: my @matches = split(/\n/,$response);
2131: foreach my $match (@matches) {
2132: my ($key,$value) = split(/=/,$match);
2133: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2134: }
1.899 raeburn 2135: }
2136: }
2137: }
1.909 raeburn 2138: return ($outcome,%results);
1.899 raeburn 2139: }
2140:
2141: sub usersearch {
2142: my ($srch) = @_;
2143: my $dom = $srch->{'srchdomain'};
2144: my %results;
2145: my %libserv = &all_library();
2146: my $query = 'usersearch';
2147: foreach my $tryserver (keys(%libserv)) {
2148: if (&host_domain($tryserver) eq $dom) {
1.1357 raeburn 2149: unless ($tryserver eq $perlvar{'lonHostID'}) {
2150: if ($srch->{'srchby'} eq 'email') {
2151: my $lcrev = &get_server_loncaparev(undef,$tryserver);
2152: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2153: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2154: (($major == 2) && ($minor < 12)));
2155: }
2156: }
1.899 raeburn 2157: my $host=&hostname($tryserver);
2158: my $queryid=
1.911 raeburn 2159: &reply("querysend:".&escape($query).':'.
2160: &escape($srch->{'srchby'}).':'.
1.899 raeburn 2161: &escape($srch->{'srchtype'}).':'.
2162: &escape($srch->{'srchterm'}),$tryserver);
2163: if ($queryid !~/^\Q$host\E\_/) {
2164: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 2165: next;
1.899 raeburn 2166: }
2167: my $reply = &get_query_reply($queryid);
2168: my $maxtries = 1;
2169: my $tries = 1;
2170: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2171: $reply = &get_query_reply($queryid);
2172: $tries ++;
2173: }
2174: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2175: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2176: } else {
1.911 raeburn 2177: my @matches;
2178: if ($reply =~ /\n/) {
2179: @matches = split(/\n/,$reply);
2180: } else {
2181: @matches = split(/\&/,$reply);
2182: }
1.899 raeburn 2183: foreach my $match (@matches) {
2184: my ($uname,$udom,%userhash);
1.911 raeburn 2185: foreach my $entry (split(/:/,$match)) {
2186: my ($key,$value) =
2187: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 2188: $userhash{$key} = $value;
2189: if ($key eq 'username') {
2190: $uname = $value;
2191: } elsif ($key eq 'domain') {
2192: $udom = $value;
1.911 raeburn 2193: }
1.899 raeburn 2194: }
2195: $results{$uname.':'.$udom} = \%userhash;
2196: }
2197: }
2198: }
2199: }
2200: return %results;
2201: }
2202:
1.912 raeburn 2203: sub get_instuser {
2204: my ($udom,$uname,$id) = @_;
2205: my $homeserver = &domain($udom,'primary');
2206: my ($outcome,%results);
2207: if ($homeserver ne '') {
2208: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2209: &escape($id).':'.&escape($udom),$homeserver);
2210: my $host=&hostname($homeserver);
2211: if ($queryid !~/^\Q$host\E\_/) {
2212: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2213: return;
2214: }
2215: my $response = &get_query_reply($queryid);
2216: my $maxtries = 5;
2217: my $tries = 1;
2218: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2219: $response = &get_query_reply($queryid);
2220: $tries ++;
2221: }
2222: if (!&error($response) && $response ne 'refused') {
2223: if ($response eq 'unavailable') {
2224: $outcome = $response;
2225: } else {
2226: $outcome = 'ok';
2227: my @matches = split(/\n/,$response);
2228: foreach my $match (@matches) {
2229: my ($key,$value) = split(/=/,$match);
2230: $results{&unescape($key)} = &thaw_unescape($value);
2231: }
2232: }
2233: }
2234: }
2235: my %userinfo;
2236: if (ref($results{$uname}) eq 'HASH') {
2237: %userinfo = %{$results{$uname}};
2238: }
2239: return ($outcome,%userinfo);
2240: }
2241:
1.1290 raeburn 2242: sub get_multiple_instusers {
2243: my ($udom,$users,$caller) = @_;
2244: my ($outcome,$results);
2245: if (ref($users) eq 'HASH') {
2246: my $count = keys(%{$users});
2247: my $requested = &freeze_escape($users);
2248: my $homeserver = &domain($udom,'primary');
2249: if ($homeserver ne '') {
2250: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2251: my $host=&hostname($homeserver);
2252: if ($queryid !~/^\Q$host\E\_/) {
2253: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2254: ' for host: '.$homeserver.'in domain '.$udom);
2255: return ($outcome,$results);
2256: }
2257: my $response = &get_query_reply($queryid);
2258: my $maxtries = 5;
2259: if ($count > 100) {
2260: $maxtries = 1+int($count/20);
2261: }
2262: my $tries = 1;
2263: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2264: $response = &get_query_reply($queryid);
2265: $tries ++;
2266: }
2267: if ($response eq '') {
2268: $results = {};
2269: foreach my $key (keys(%{$users})) {
2270: my ($uname,$id);
2271: if ($caller eq 'id') {
2272: $id = $key;
2273: } else {
2274: $uname = $key;
2275: }
2276: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1.1291 raeburn 2277: $outcome = $resp;
1.1290 raeburn 2278: if ($resp eq 'ok') {
2279: %{$results} = (%{$results}, %info);
2280: } else {
2281: last;
2282: }
2283: }
2284: } elsif(!&error($response) && ($response ne 'refused')) {
2285: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2286: $outcome = $response;
2287: } else {
1.1291 raeburn 2288: ($outcome,my $userdata) = split(/=/,$response,2);
1.1290 raeburn 2289: if ($outcome eq 'ok') {
2290: $results = &thaw_unescape($userdata);
2291: }
2292: }
2293: }
2294: }
2295: }
2296: return ($outcome,$results);
2297: }
2298:
1.912 raeburn 2299: sub inst_rulecheck {
1.923 raeburn 2300: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 2301: my %returnhash;
2302: if ($udom ne '') {
2303: if (ref($rules) eq 'ARRAY') {
2304: @{$rules} = map {&escape($_);} (@{$rules});
2305: my $rulestr = join(':',@{$rules});
2306: my $homeserver=&domain($udom,'primary');
2307: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2308: my $response;
2309: if ($item eq 'username') {
2310: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2311: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2312: $homeserver));
1.923 raeburn 2313: } elsif ($item eq 'id') {
2314: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2315: ':'.&escape($id).':'.$rulestr,
2316: $homeserver));
1.945 raeburn 2317: } elsif ($item eq 'selfcreate') {
2318: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2319: &escape($udom).':'.&escape($uname).
2320: ':'.$rulestr,$homeserver));
1.923 raeburn 2321: }
1.912 raeburn 2322: if ($response ne 'refused') {
2323: my @pairs=split(/\&/,$response);
2324: foreach my $item (@pairs) {
2325: my ($key,$value)=split(/=/,$item,2);
2326: $key = &unescape($key);
2327: next if ($key =~ /^error: 2 /);
2328: $returnhash{$key}=&thaw_unescape($value);
2329: }
2330: }
2331: }
2332: }
2333: }
2334: return %returnhash;
2335: }
2336:
2337: sub inst_userrules {
1.923 raeburn 2338: my ($udom,$check) = @_;
1.912 raeburn 2339: my (%ruleshash,@ruleorder);
2340: if ($udom ne '') {
2341: my $homeserver=&domain($udom,'primary');
2342: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2343: my $response;
2344: if ($check eq 'id') {
2345: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2346: $homeserver);
1.943 raeburn 2347: } elsif ($check eq 'email') {
2348: $response=&reply('instemailrules:'.&escape($udom),
2349: $homeserver);
1.923 raeburn 2350: } else {
2351: $response=&reply('instuserrules:'.&escape($udom),
2352: $homeserver);
2353: }
1.912 raeburn 2354: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2355: ($response ne 'unknown_cmd') &&
1.912 raeburn 2356: ($response ne 'no_such_host')) {
2357: my ($hashitems,$orderitems) = split(/:/,$response);
2358: my @pairs=split(/\&/,$hashitems);
2359: foreach my $item (@pairs) {
2360: my ($key,$value)=split(/=/,$item,2);
2361: $key = &unescape($key);
2362: next if ($key =~ /^error: 2 /);
2363: $ruleshash{$key}=&thaw_unescape($value);
2364: }
2365: my @esc_order = split(/\&/,$orderitems);
2366: foreach my $item (@esc_order) {
2367: push(@ruleorder,&unescape($item));
2368: }
2369: }
2370: }
2371: }
2372: return (\%ruleshash,\@ruleorder);
2373: }
2374:
1.976 raeburn 2375: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2376:
2377: sub get_domain_defaults {
1.1240 raeburn 2378: my ($domain,$ignore_cache) = @_;
1.1242 raeburn 2379: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2380: my $cachetime = 60*60*24;
1.1240 raeburn 2381: unless ($ignore_cache) {
2382: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2383: if (defined($cached)) {
2384: if (ref($result) eq 'HASH') {
2385: return %{$result};
2386: }
1.943 raeburn 2387: }
2388: }
2389: my %domdefaults;
2390: my %domconfig =
1.989 raeburn 2391: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2392: 'requestcourses','inststatus',
1.1183 raeburn 2393: 'coursedefaults','usersessions',
1.1258 raeburn 2394: 'requestauthor','selfenrollment',
1.1320 raeburn 2395: 'coursecategories','ssl','autoenroll',
1.1332 raeburn 2396: 'trust','helpsettings'],$domain);
1.1305 raeburn 2397: my @coursetypes = ('official','unofficial','community','textbook','placement');
1.943 raeburn 2398: if (ref($domconfig{'defaults'}) eq 'HASH') {
2399: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2400: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2401: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2402: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2403: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2404: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.1340 raeburn 2405: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2406: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2407: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.943 raeburn 2408: } else {
2409: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2410: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2411: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2412: }
1.976 raeburn 2413: if (ref($domconfig{'quotas'}) eq 'HASH') {
2414: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2415: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2416: } else {
2417: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2418: }
1.1177 raeburn 2419: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2420: foreach my $item (@usertools) {
2421: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2422: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2423: }
2424: }
1.1229 raeburn 2425: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2426: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2427: }
1.976 raeburn 2428: }
1.985 raeburn 2429: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1305 raeburn 2430: foreach my $item ('official','unofficial','community','textbook','placement') {
1.985 raeburn 2431: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2432: }
2433: }
1.1183 raeburn 2434: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2435: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2436: }
1.989 raeburn 2437: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256 raeburn 2438: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2439: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2440: }
2441: }
1.1047 raeburn 2442: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2443: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277 raeburn 2444: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2445: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2446: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2447: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2448: }
1.1254 raeburn 2449: foreach my $type (@coursetypes) {
2450: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2451: unless ($type eq 'community') {
2452: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2453: }
2454: }
2455: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2456: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2457: }
1.1277 raeburn 2458: if ($domdefaults{'postsubmit'} eq 'on') {
2459: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2460: $domdefaults{$type.'postsubtimeout'} =
2461: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2462: }
2463: }
1.1230 raeburn 2464: }
1.1286 raeburn 2465: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2466: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2467: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2468: if (@clonecodes) {
2469: $domdefaults{'canclone'} = join('+',@clonecodes);
2470: }
2471: }
2472: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2473: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2474: }
1.1356 raeburn 2475: if ($domconfig{'coursedefaults'}{'texengine'}) {
2476: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
2477: }
1.1047 raeburn 2478: }
1.1073 raeburn 2479: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2480: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2481: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2482: }
2483: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2484: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2485: }
1.1279 raeburn 2486: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2487: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2488: }
1.1073 raeburn 2489: }
1.1254 raeburn 2490: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2491: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2492: my @settings = ('types','registered','enroll_dates','access_dates','section',
2493: 'approval','limit');
2494: foreach my $type (@coursetypes) {
2495: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2496: my @mgrdc = ();
2497: foreach my $item (@settings) {
2498: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2499: push(@mgrdc,$item);
2500: }
2501: }
2502: if (@mgrdc) {
2503: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2504: }
2505: }
2506: }
2507: }
2508: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2509: foreach my $type (@coursetypes) {
2510: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2511: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2512: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2513: }
2514: }
2515: }
2516: }
2517: }
1.1258 raeburn 2518: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2519: $domdefaults{'catauth'} = 'std';
2520: $domdefaults{'catunauth'} = 'std';
2521: if ($domconfig{'coursecategories'}{'auth'}) {
2522: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2523: }
2524: if ($domconfig{'coursecategories'}{'unauth'}) {
2525: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2526: }
2527: }
1.1315 raeburn 2528: if (ref($domconfig{'ssl'}) eq 'HASH') {
2529: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2530: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2531: }
1.1338 raeburn 2532: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2533: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2534: }
2535: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2536: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
1.1315 raeburn 2537: }
2538: }
1.1320 raeburn 2539: if (ref($domconfig{'trust'}) eq 'HASH') {
2540: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2541: foreach my $prefix (@prefixes) {
2542: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2543: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2544: }
2545: }
2546: }
1.1314 raeburn 2547: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2548: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2549: }
1.1332 raeburn 2550: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2551: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2552: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2553: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2554: }
2555: }
1.1219 raeburn 2556: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2557: return %domdefaults;
2558: }
2559:
1.1311 raeburn 2560: sub course_portal_url {
2561: my ($cnum,$cdom) = @_;
2562: my $chome = &homeserver($cnum,$cdom);
2563: my $hostname = &hostname($chome);
2564: my $protocol = $protocol{$chome};
2565: $protocol = 'http' if ($protocol ne 'https');
2566: my %domdefaults = &get_domain_defaults($cdom);
2567: my $firsturl;
2568: if ($domdefaults{'portal_def'}) {
2569: $firsturl = $domdefaults{'portal_def'};
2570: } else {
2571: $firsturl = $protocol.'://'.$hostname;
2572: }
2573: return $firsturl;
2574: }
2575:
1.344 www 2576: # --------------------------------------------------- Assign a key to a student
2577:
2578: sub assign_access_key {
1.364 www 2579: #
2580: # a valid key looks like uname:udom#comments
2581: # comments are being appended
2582: #
1.498 www 2583: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2584: $kdom=
1.620 albertel 2585: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2586: $knum=
1.620 albertel 2587: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2588: $cdom=
1.620 albertel 2589: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2590: $cnum=
1.620 albertel 2591: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2592: $udom=$env{'user.name'} unless (defined($udom));
2593: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2594: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2595: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2596: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2597: # assigned to this person
2598: # - this should not happen,
1.345 www 2599: # unless something went wrong
2600: # the first time around
2601: # ready to assign
1.364 www 2602: $logentry=$1.'; '.$logentry;
1.496 www 2603: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2604: $kdom,$knum) eq 'ok') {
1.345 www 2605: # key now belongs to user
1.346 www 2606: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2607: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2608: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2609: return 'ok';
2610: } else {
2611: return
2612: 'error: Count not permanently assign key, will need to be re-entered later.';
2613: }
2614: } else {
2615: return 'error: Could not assign key, try again later.';
2616: }
1.364 www 2617: } elsif (!$existing{$ckey}) {
1.345 www 2618: # the key does not exist
2619: return 'error: The key does not exist';
2620: } else {
2621: # the key is somebody else's
2622: return 'error: The key is already in use';
2623: }
1.344 www 2624: }
2625:
1.364 www 2626: # ------------------------------------------ put an additional comment on a key
2627:
2628: sub comment_access_key {
2629: #
2630: # a valid key looks like uname:udom#comments
2631: # comments are being appended
2632: #
2633: my ($ckey,$cdom,$cnum,$logentry)=@_;
2634: $cdom=
1.620 albertel 2635: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2636: $cnum=
1.620 albertel 2637: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2638: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2639: if ($existing{$ckey}) {
2640: $existing{$ckey}.='; '.$logentry;
2641: # ready to assign
1.367 www 2642: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2643: $cdom,$cnum) eq 'ok') {
2644: return 'ok';
2645: } else {
2646: return 'error: Count not store comment.';
2647: }
2648: } else {
2649: # the key does not exist
2650: return 'error: The key does not exist';
2651: }
2652: }
2653:
1.344 www 2654: # ------------------------------------------------------ Generate a set of keys
2655:
2656: sub generate_access_keys {
1.364 www 2657: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2658: $cdom=
1.620 albertel 2659: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2660: $cnum=
1.620 albertel 2661: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2662: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2663: unless (($cdom) && ($cnum)) { return 0; }
2664: if ($number>10000) { return 0; }
2665: sleep(2); # make sure don't get same seed twice
2666: srand(time()^($$+($$<<15))); # from "Programming Perl"
2667: my $total=0;
2668: for (my $i=1;$i<=$number;$i++) {
2669: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2670: sprintf("%lx",int(100000*rand)).'-'.
2671: sprintf("%lx",int(100000*rand));
2672: $newkey=~s/1/g/g; # folks mix up 1 and l
2673: $newkey=~s/0/h/g; # and also 0 and O
2674: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2675: if ($existing{$newkey}) {
2676: $i--;
2677: } else {
1.364 www 2678: if (&put('accesskeys',
2679: { $newkey => '# generated '.localtime().
1.620 albertel 2680: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 2681: '; '.$logentry },
2682: $cdom,$cnum) eq 'ok') {
1.344 www 2683: $total++;
2684: }
2685: }
2686: }
1.620 albertel 2687: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 2688: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2689: return $total;
2690: }
2691:
2692: # ------------------------------------------------------- Validate an accesskey
2693:
2694: sub validate_access_key {
2695: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2696: $cdom=
1.620 albertel 2697: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2698: $cnum=
1.620 albertel 2699: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2700: $udom=$env{'user.domain'} unless (defined($udom));
2701: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 2702: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 2703: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 2704: }
2705:
2706: # ------------------------------------- Find the section of student in a course
1.652 albertel 2707: sub devalidate_getsection_cache {
2708: my ($udom,$unam,$courseid)=@_;
2709: my $hashid="$udom:$unam:$courseid";
2710: &devalidate_cache_new('getsection',$hashid);
2711: }
1.298 matthew 2712:
1.815 albertel 2713: sub courseid_to_courseurl {
2714: my ($courseid) = @_;
2715: #already url style courseid
2716: return $courseid if ($courseid =~ m{^/});
2717:
2718: if (exists($env{'course.'.$courseid.'.num'})) {
2719: my $cnum = $env{'course.'.$courseid.'.num'};
2720: my $cdom = $env{'course.'.$courseid.'.domain'};
2721: return "/$cdom/$cnum";
2722: }
2723:
2724: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2725: if (exists($courseinfo{'num'})) {
2726: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2727: }
2728:
2729: return undef;
2730: }
2731:
1.298 matthew 2732: sub getsection {
2733: my ($udom,$unam,$courseid)=@_;
1.599 albertel 2734: my $cachetime=1800;
1.551 albertel 2735:
2736: my $hashid="$udom:$unam:$courseid";
1.599 albertel 2737: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 2738: if (defined($cached)) { return $result; }
2739:
1.298 matthew 2740: my %Pending;
2741: my %Expired;
2742: #
2743: # Each role can either have not started yet (pending), be active,
2744: # or have expired.
2745: #
2746: # If there is an active role, we are done.
2747: #
2748: # If there is more than one role which has not started yet,
2749: # choose the one which will start sooner
2750: # If there is one role which has not started yet, return it.
2751: #
2752: # If there is more than one expired role, choose the one which ended last.
2753: # If there is a role which has expired, return it.
2754: #
1.815 albertel 2755: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 2756: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 2757: foreach my $key (keys(%roleshash)) {
1.479 albertel 2758: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 2759: my $section=$1;
2760: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 2761: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 2762: my $now=time;
1.548 albertel 2763: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 2764: $Expired{$end}=$section;
2765: next;
2766: }
1.548 albertel 2767: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 2768: $Pending{$start}=$section;
2769: next;
2770: }
1.599 albertel 2771: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 2772: }
2773: #
2774: # Presumedly there will be few matching roles from the above
2775: # loop and the sorting time will be negligible.
2776: if (scalar(keys(%Pending))) {
2777: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 2778: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 2779: }
2780: if (scalar(keys(%Expired))) {
2781: my @sorted = sort {$a <=> $b} keys(%Expired);
2782: my $time = pop(@sorted);
1.599 albertel 2783: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 2784: }
1.599 albertel 2785: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 2786: }
1.70 www 2787:
1.599 albertel 2788: sub save_cache {
2789: &purge_remembered();
1.722 albertel 2790: #&Apache::loncommon::validate_page();
1.620 albertel 2791: undef(%env);
1.780 albertel 2792: undef($env_loaded);
1.599 albertel 2793: }
1.452 albertel 2794:
1.599 albertel 2795: my $to_remember=-1;
2796: my %remembered;
2797: my %accessed;
2798: my $kicks=0;
2799: my $hits=0;
1.849 albertel 2800: sub make_key {
2801: my ($name,$id) = @_;
1.872 albertel 2802: if (length($id) > 65
2803: && length(&escape($id)) > 200) {
2804: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2805: }
1.849 albertel 2806: return &escape($name.':'.$id);
2807: }
2808:
1.599 albertel 2809: sub devalidate_cache_new {
2810: my ($name,$id,$debug) = @_;
2811: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1319 damieng 2812: my $remembered_id=$name.':'.$id;
1.849 albertel 2813: $id=&make_key($name,$id);
1.599 albertel 2814: $memcache->delete($id);
1.1319 damieng 2815: delete($remembered{$remembered_id});
2816: delete($accessed{$remembered_id});
1.599 albertel 2817: }
2818:
2819: sub is_cached_new {
2820: my ($name,$id,$debug) = @_;
1.1319 damieng 2821: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
2822: if (exists($remembered{$remembered_id})) {
2823: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
2824: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2825: $hits++;
1.1319 damieng 2826: return ($remembered{$remembered_id},1);
1.599 albertel 2827: }
1.1319 damieng 2828: $id=&make_key($name,$id);
1.599 albertel 2829: my $value = $memcache->get($id);
2830: if (!(defined($value))) {
2831: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 2832: return (undef,undef);
1.416 albertel 2833: }
1.599 albertel 2834: if ($value eq '__undef__') {
2835: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2836: $value=undef;
2837: }
1.1319 damieng 2838: &make_room($remembered_id,$value,$debug);
1.599 albertel 2839: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2840: return ($value,1);
2841: }
2842:
2843: sub do_cache_new {
2844: my ($name,$id,$value,$time,$debug) = @_;
1.1319 damieng 2845: my $remembered_id=$name.':'.$id;
1.849 albertel 2846: $id=&make_key($name,$id);
1.599 albertel 2847: my $setvalue=$value;
2848: if (!defined($setvalue)) {
2849: $setvalue='__undef__';
2850: }
1.623 albertel 2851: if (!defined($time) ) {
2852: $time=600;
2853: }
1.599 albertel 2854: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 2855: my $result = $memcache->set($id,$setvalue,$time);
2856: if (! $result) {
1.872 albertel 2857: &logthis("caching of id -> $id failed");
1.910 albertel 2858: $memcache->disconnect_all();
1.872 albertel 2859: }
1.600 albertel 2860: # need to make a copy of $value
1.1319 damieng 2861: &make_room($remembered_id,$value,$debug);
1.599 albertel 2862: return $value;
2863: }
2864:
2865: sub make_room {
1.1319 damieng 2866: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 2867:
1.1319 damieng 2868: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 2869: : $value;
1.599 albertel 2870: if ($to_remember<0) { return; }
1.1319 damieng 2871: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2872: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2873: my $to_kick;
2874: my $max_time=0;
2875: foreach my $other (keys(%accessed)) {
2876: if (&tv_interval($accessed{$other}) > $max_time) {
2877: $to_kick=$other;
2878: $max_time=&tv_interval($accessed{$other});
2879: }
2880: }
2881: delete($remembered{$to_kick});
2882: delete($accessed{$to_kick});
2883: $kicks++;
2884: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 2885: return;
2886: }
2887:
1.599 albertel 2888: sub purge_remembered {
1.604 albertel 2889: #&logthis("Tossing ".scalar(keys(%remembered)));
2890: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 2891: undef(%remembered);
2892: undef(%accessed);
1.428 albertel 2893: }
1.70 www 2894: # ------------------------------------- Read an entry from a user's environment
2895:
2896: sub userenvironment {
2897: my ($udom,$unam,@what)=@_;
1.976 raeburn 2898: my $items;
2899: foreach my $item (@what) {
2900: $items.=&escape($item).'&';
2901: }
2902: $items=~s/\&$//;
1.70 www 2903: my %returnhash=();
1.1009 raeburn 2904: my $uhome = &homeserver($unam,$udom);
2905: unless ($uhome eq 'no_host') {
2906: my @answer=split(/\&/,
2907: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 2908: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2909: return %returnhash;
2910: }
1.1009 raeburn 2911: my $i;
2912: for ($i=0;$i<=$#what;$i++) {
2913: $returnhash{$what[$i]}=&unescape($answer[$i]);
2914: }
1.70 www 2915: }
2916: return %returnhash;
1.1 albertel 2917: }
2918:
1.617 albertel 2919: # ---------------------------------------------------------- Get a studentphoto
2920: sub studentphoto {
2921: my ($udom,$unam,$ext) = @_;
2922: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 2923: if (defined($env{'request.course.id'})) {
1.708 raeburn 2924: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 2925: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2926: return(&retrievestudentphoto($udom,$unam,$ext));
2927: } else {
2928: my ($result,$perm_reqd)=
1.707 albertel 2929: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2930: if ($result eq 'ok') {
2931: if (!($perm_reqd eq 'yes')) {
2932: return(&retrievestudentphoto($udom,$unam,$ext));
2933: }
2934: }
2935: }
2936: }
2937: } else {
2938: my ($result,$perm_reqd) =
1.707 albertel 2939: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2940: if ($result eq 'ok') {
2941: if (!($perm_reqd eq 'yes')) {
2942: return(&retrievestudentphoto($udom,$unam,$ext));
2943: }
2944: }
2945: }
2946: return '/adm/lonKaputt/lonlogo_broken.gif';
2947: }
2948:
2949: sub retrievestudentphoto {
2950: my ($udom,$unam,$ext,$type) = @_;
2951: my $home=&Apache::lonnet::homeserver($unam,$udom);
2952: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2953: if ($ret eq 'ok') {
2954: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2955: if ($type eq 'thumbnail') {
2956: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2957: }
2958: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2959: return $tokenurl;
2960: } else {
2961: if ($type eq 'thumbnail') {
2962: return '/adm/lonKaputt/genericstudent_tn.gif';
2963: } else {
2964: return '/adm/lonKaputt/lonlogo_broken.gif';
2965: }
1.617 albertel 2966: }
2967: }
2968:
1.263 www 2969: # -------------------------------------------------------------------- New chat
2970:
2971: sub chatsend {
1.724 raeburn 2972: my ($newentry,$anon,$group)=@_;
1.620 albertel 2973: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2974: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2975: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 2976: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 2977: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 2978: &escape($newentry)).':'.$group,$chome);
1.292 www 2979: }
2980:
2981: # ------------------------------------------ Find current version of a resource
2982:
2983: sub getversion {
2984: my $fname=&clutter(shift);
1.1189 raeburn 2985: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 2986: return ¤tversion(&filelocation('',$fname));
2987: }
2988:
2989: sub currentversion {
2990: my $fname=shift;
2991: my $author=$fname;
2992: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2993: my ($udom,$uname)=split(/\//,$author);
1.1112 www 2994: my $home=&homeserver($uname,$udom);
1.292 www 2995: if ($home eq 'no_host') {
2996: return -1;
2997: }
1.1112 www 2998: my $answer=&reply("currentversion:$fname",$home);
1.292 www 2999: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3000: return -1;
3001: }
1.1112 www 3002: return $answer;
1.263 www 3003: }
3004:
1.1111 www 3005: #
3006: # Return special version number of resource if set by override, empty otherwise
3007: #
3008: sub usedversion {
3009: my $fname=shift;
3010: unless ($fname) { $fname=$env{'request.uri'}; }
3011: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3012: if ($urlversion) { return $urlversion; }
3013: return '';
3014: }
3015:
1.1 albertel 3016: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 3017:
1.1 albertel 3018: sub subscribe {
3019: my $fname=shift;
1.761 raeburn 3020: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 3021: $fname=~s/[\n\r]//g;
1.1 albertel 3022: my $author=$fname;
3023: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3024: my ($udom,$uname)=split(/\//,$author);
3025: my $home=homeserver($uname,$udom);
1.335 albertel 3026: if ($home eq 'no_host') {
3027: return 'not_found';
1.1 albertel 3028: }
3029: my $answer=reply("sub:$fname",$home);
1.64 www 3030: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3031: $answer.=' by '.$home;
3032: }
1.1 albertel 3033: return $answer;
3034: }
3035:
1.8 www 3036: # -------------------------------------------------------------- Replicate file
3037:
3038: sub repcopy {
3039: my $filename=shift;
1.23 www 3040: $filename=~s/\/+/\//g;
1.1142 raeburn 3041: my $londocroot = $perlvar{'lonDocRoot'};
3042: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 3043: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 3044: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3045: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 3046: return &repcopy_userfile($filename);
3047: }
1.532 albertel 3048: $filename=~s/[\n\r]//g;
1.8 www 3049: my $transname="$filename.in.transfer";
1.828 www 3050: # FIXME: this should flock
1.607 raeburn 3051: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 3052: my $remoteurl=subscribe($filename);
1.64 www 3053: if ($remoteurl =~ /^con_lost by/) {
3054: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3055: return 'unavailable';
1.8 www 3056: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 3057: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 3058: return 'not_found';
1.64 www 3059: } elsif ($remoteurl =~ /^rejected by/) {
3060: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3061: return 'forbidden';
1.20 www 3062: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 3063: return 'ok';
1.8 www 3064: } else {
1.290 www 3065: my $author=$filename;
3066: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3067: my ($udom,$uname)=split(/\//,$author);
3068: my $home=homeserver($uname,$udom);
3069: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 3070: my @parts=split(/\//,$filename);
3071: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 3072: if ($path ne "$londocroot/res") {
1.8 www 3073: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 3074: return 'bad_request';
1.8 www 3075: }
3076: my $count;
3077: for ($count=5;$count<$#parts;$count++) {
3078: $path.="/$parts[$count]";
3079: if ((-e $path)!=1) {
3080: mkdir($path,0777);
3081: }
3082: }
3083: my $request=new HTTP::Request('GET',"$remoteurl");
1.1345 raeburn 3084: my $response;
3085: if ($remoteurl =~ m{/raw/}) {
3086: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3087: } else {
3088: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3089: }
1.8 www 3090: if ($response->is_error()) {
3091: unlink($transname);
3092: my $message=$response->status_line;
1.672 albertel 3093: &logthis("<font color=\"blue\">WARNING:"
1.12 www 3094: ." LWP get: $message: $filename</font>");
1.607 raeburn 3095: return 'unavailable';
1.8 www 3096: } else {
1.16 www 3097: if ($remoteurl!~/\.meta$/) {
3098: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1.1345 raeburn 3099: my $mresponse;
3100: if ($remoteurl =~ m{/raw/}) {
3101: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3102: } else {
3103: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3104: }
1.16 www 3105: if ($mresponse->is_error()) {
3106: unlink($filename.'.meta');
3107: &logthis(
1.672 albertel 3108: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 3109: }
3110: }
1.8 www 3111: rename($transname,$filename);
1.607 raeburn 3112: return 'ok';
1.8 www 3113: }
1.290 www 3114: }
1.8 www 3115: }
1.330 www 3116: }
3117:
3118: # ------------------------------------------------ Get server side include body
3119: sub ssi_body {
1.381 albertel 3120: my ($filelink,%form)=@_;
1.606 matthew 3121: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3122: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3123: }
1.953 www 3124: my $output='';
3125: my $response;
1.980 raeburn 3126: if ($filelink=~/^https?\:/) {
1.954 raeburn 3127: ($output,$response)=&externalssi($filelink);
1.953 www 3128: } else {
1.1004 droeschl 3129: $filelink .= $filelink=~/\?/ ? '&' : '?';
3130: $filelink .= 'inhibitmenu=yes';
1.953 www 3131: ($output,$response)=&ssi($filelink,%form);
3132: }
1.778 albertel 3133: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 3134: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 3135: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 3136: if (wantarray) {
3137: return ($output, $response);
3138: } else {
3139: return $output;
3140: }
1.8 www 3141: }
3142:
1.15 www 3143: # --------------------------------------------------------- Server Side Include
3144:
1.782 albertel 3145: sub absolute_url {
3146: my ($host_name) = @_;
3147: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3148: if ($host_name eq '') {
3149: $host_name = $ENV{'SERVER_NAME'};
3150: }
3151: return $protocol.$host_name;
3152: }
3153:
1.942 foxr 3154: #
3155: # Server side include.
3156: # Parameters:
3157: # fn Possibly encrypted resource name/id.
3158: # form Hash that describes how the rendering should be done
3159: # and other things.
1.944 foxr 3160: # Returns:
1.950 raeburn 3161: # Scalar context: The content of the response.
3162: # Array context: 2 element list of the content and the full response object.
1.942 foxr 3163: #
1.15 www 3164: sub ssi {
3165:
1.944 foxr 3166: my ($fn,%form)=@_;
1.23 www 3167: my $request;
1.711 albertel 3168:
3169: $form{'no_update_last_known'}=1;
1.895 albertel 3170: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 3171: if (%form) {
1.782 albertel 3172: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1272 droeschl 3173: $request->content(join('&',map {
3174: my $name = escape($_);
3175: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3176: ? join("&$name=", map {escape($_) } @{$form{$_}})
3177: : &escape($form{$_}) );
3178: } keys(%form)));
1.23 www 3179: } else {
1.782 albertel 3180: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 3181: }
3182:
1.15 www 3183: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1345 raeburn 3184: my $lonhost = $perlvar{'lonHostID'};
3185: my $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar);
1.1182 foxr 3186:
1.944 foxr 3187: if (wantarray) {
1.1345 raeburn 3188: return ($response->content, $response);
1.944 foxr 3189: } else {
1.1345 raeburn 3190: return $response->content;
1.942 foxr 3191: }
1.324 www 3192: }
3193:
3194: sub externalssi {
3195: my ($url)=@_;
3196: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 3197: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
1.954 raeburn 3198: if (wantarray) {
3199: return ($response->content, $response);
3200: } else {
3201: return $response->content;
3202: }
1.15 www 3203: }
1.254 www 3204:
1.1354 raeburn 3205:
3206: # If the local copy of a replicated resource is outdated, trigger a
3207: # connection from the homeserver to flush the delayed queue. If no update
3208: # happens, remove local copies of outdated resource (and corresponding
3209: # metadata file).
3210:
1.1352 raeburn 3211: sub remove_stale_resfile {
3212: my ($url) = @_;
1.1354 raeburn 3213: my $removed;
1.1352 raeburn 3214: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3215: my $audom = $1;
3216: my $auname = $2;
1.1353 raeburn 3217: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
1.1352 raeburn 3218: my $homeserver = &homeserver($auname,$audom);
3219: unless (($homeserver eq 'no_host') ||
3220: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3221: my $fname = &filelocation('',$url);
3222: if (-e $fname) {
3223: my $protocol = $protocol{$homeserver};
3224: $protocol = 'http' if ($protocol ne 'https');
3225: my $hostname = &hostname($homeserver);
3226: if ($hostname) {
3227: my $uri = &declutter($url);
3228: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3229: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3230: if ($response->is_success()) {
3231: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3232: my $locmodtime = (stat($fname))[9];
3233: if ($locmodtime < $remmodtime) {
1.1354 raeburn 3234: my $stale;
3235: my $answer = &reply('pong',$homeserver);
3236: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3237: sleep(0.2);
3238: $locmodtime = (stat($fname))[9];
3239: if ($locmodtime < $remmodtime) {
3240: my $posstransfer = $fname.'.in.transfer';
3241: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3242: $removed = 1;
3243: } else {
3244: $stale = 1;
3245: }
3246: } else {
3247: $removed = 1;
3248: }
3249: } else {
3250: $stale = 1;
3251: }
3252: if ($stale) {
3253: unlink($fname);
3254: if ($uri!~/\.meta$/) {
3255: unlink($fname.'.meta');
3256: }
3257: &reply("unsub:$fname",$homeserver);
3258: $removed = 1;
1.1352 raeburn 3259: }
3260: }
3261: }
3262: }
3263: }
3264: }
3265: }
3266: }
1.1354 raeburn 3267: return $removed;
1.1352 raeburn 3268: }
3269:
1.492 albertel 3270: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3271:
3272: sub allowuploaded {
3273: my ($srcurl,$url)=@_;
3274: $url=&clutter(&declutter($url));
3275: my $dir=$url;
3276: $dir=~s/\/[^\/]+$//;
3277: my %httpref=();
3278: my $httpurl=&hreflocation('',$url);
3279: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 3280: &Apache::lonnet::appenv(\%httpref);
1.254 www 3281: }
1.477 raeburn 3282:
1.1193 raeburn 3283: #
3284: # Determine if the current user should be able to edit a particular resource,
3285: # when viewing in course context.
3286: # (a) When viewing resource used to determine if "Edit" item is included in
3287: # Functions.
3288: # (b) When displaying folder contents in course editor, used to determine if
3289: # "Edit" link will be displayed alongside resource.
3290: #
1.1196 raeburn 3291: # input: six args -- filename (decluttered), course number, course domain,
3292: # url, symb (if registered) and group (if this is a group
3293: # item -- e.g., bulletin board, group page etc.).
3294: # output: array of five scalars --
1.1193 raeburn 3295: # $cfile -- url for file editing if editable on current server
3296: # $home -- homeserver of resource (i.e., for author if published,
3297: # or course if uploaded.).
3298: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 3299: # $forceedit -- 1 if icon/link should be to go to edit mode
3300: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 3301: #
3302:
3303: sub can_edit_resource {
1.1194 raeburn 3304: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3305: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3306: #
3307: # For aboutme pages user can only edit his/her own.
3308: #
1.1199 raeburn 3309: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 3310: my ($sdom,$sname) = ($1,$2);
3311: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3312: $home = $env{'user.home'};
3313: $cfile = $resurl;
3314: if ($env{'form.forceedit'}) {
3315: $forceview = 1;
3316: } else {
3317: $forceedit = 1;
3318: }
3319: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3320: } else {
3321: return;
3322: }
3323: }
3324:
3325: if ($env{'request.course.id'}) {
3326: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
3327: if ($group ne '') {
3328: # if this is a group homepage or group bulletin board, check group privs
3329: my $allowed = 0;
1.1197 raeburn 3330: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3331: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 3332: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 3333: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3334: $allowed = 1;
3335: }
1.1197 raeburn 3336: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3337: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3338: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 3339: $allowed = 1;
3340: }
3341: }
3342: if ($allowed) {
3343: $home=&homeserver($cnum,$cdom);
3344: if ($env{'form.forceedit'}) {
3345: $forceview = 1;
3346: } else {
3347: $forceedit = 1;
3348: }
3349: $cfile = $resurl;
3350: } else {
3351: return;
3352: }
3353: } else {
1.1208 raeburn 3354: if ($resurl =~ m{^/?adm/viewclasslist$}) {
3355: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
3356: return;
3357: }
3358: } elsif (!$crsedit) {
1.1194 raeburn 3359: #
3360: # No edit allowed where CC has switched to student role.
3361: #
3362: return;
3363: }
3364: }
3365: }
3366:
1.1193 raeburn 3367: if ($file ne '') {
3368: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 3369: if (&is_course_upload($file,$cnum,$cdom)) {
3370: $uploaded = 1;
3371: $incourse = 1;
1.1193 raeburn 3372: if ($file =~/\.(htm|html|css|js|txt)$/) {
3373: $cfile = &hreflocation('',$file);
1.1201 raeburn 3374: if ($env{'form.forceedit'}) {
3375: $forceview = 1;
3376: } else {
3377: $forceedit = 1;
3378: }
1.1194 raeburn 3379: }
3380: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
3381: $incourse = 1;
3382: if ($env{'form.forceedit'}) {
3383: $forceview = 1;
3384: } else {
3385: $forceedit = 1;
3386: }
3387: $cfile = $resurl;
3388: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
3389: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
3390: $incourse = 1;
3391: if ($env{'form.forceedit'}) {
3392: $forceview = 1;
3393: } else {
3394: $forceedit = 1;
3395: }
3396: $cfile = $resurl;
1.1199 raeburn 3397: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 3398: $incourse = 1;
3399: $cfile = $resurl.'/smpedit';
1.1199 raeburn 3400: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 3401: $incourse = 1;
1.1199 raeburn 3402: if ($env{'form.forceedit'}) {
3403: $forceview = 1;
3404: } else {
3405: $forceedit = 1;
3406: }
3407: $cfile = $resurl;
1.1343 raeburn 3408: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3409: $incourse = 1;
3410: if ($env{'form.forceedit'}) {
3411: $forceview = 1;
3412: } else {
3413: $forceedit = 1;
3414: }
3415: $cfile = $resurl;
1.1208 raeburn 3416: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3417: $incourse = 1;
3418: if ($env{'form.forceedit'}) {
3419: $forceview = 1;
3420: } else {
3421: $forceedit = 1;
3422: }
3423: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 3424: }
3425: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3426: my $template = '/res/lib/templates/simpleproblem.problem';
3427: if (&is_on_map($template)) {
3428: $incourse = 1;
3429: $forceview = 1;
3430: $cfile = $template;
1.1193 raeburn 3431: }
1.1199 raeburn 3432: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3433: $incourse = 1;
3434: if ($env{'form.forceedit'}) {
3435: $forceview = 1;
3436: } else {
3437: $forceedit = 1;
3438: }
3439: $cfile = $resurl;
1.1343 raeburn 3440: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1298 raeburn 3441: $incourse = 1;
3442: if ($env{'form.forceedit'}) {
3443: $forceview = 1;
3444: } else {
3445: $forceedit = 1;
3446: }
3447: $cfile = $resurl;
1.1199 raeburn 3448: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3449: $incourse = 1;
3450: $forceview = 1;
3451: if ($symb) {
3452: my ($map,$id,$res)=&decode_symb($symb);
3453: $env{'request.symb'} = $symb;
3454: $cfile = &clutter($res);
3455: } else {
3456: $cfile = $env{'form.suppurl'};
1.1298 raeburn 3457: my $escfile = &unescape($cfile);
1.1343 raeburn 3458: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 3459: $cfile = '/adm/wrapper'.$escfile;
3460: } else {
3461: $escfile =~ s{^http://}{};
3462: $cfile = &escape("/adm/wrapper/ext/$escfile");
3463: }
1.1199 raeburn 3464: }
1.1234 raeburn 3465: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3466: if ($env{'form.forceedit'}) {
3467: $forceview = 1;
3468: } else {
3469: $forceedit = 1;
3470: }
3471: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 3472: }
3473: }
1.1194 raeburn 3474: if ($uploaded || $incourse) {
3475: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 3476: } elsif ($file !~ m{/$}) {
1.1193 raeburn 3477: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3478: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3479: # Check that the user has permission to edit this resource
3480: my $setpriv = 1;
3481: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3482: if (defined($cfudom)) {
3483: $home=&homeserver($cfuname,$cfudom);
3484: $cfile=$file;
3485: }
3486: }
1.1194 raeburn 3487: if (($cfile ne '') && (!$incourse || $uploaded) &&
3488: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 3489: my @ids=¤t_machine_ids();
3490: unless (grep(/^\Q$home\E$/,@ids)) {
3491: $switchserver=1;
3492: }
3493: }
3494: }
1.1194 raeburn 3495: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 3496: }
3497:
3498: sub is_course_upload {
3499: my ($file,$cnum,$cdom) = @_;
3500: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3501: $uploadpath =~ s{^\/}{};
1.1201 raeburn 3502: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3503: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 3504: return 1;
3505: }
3506: return;
3507: }
3508:
1.1194 raeburn 3509: sub in_course {
1.1195 raeburn 3510: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3511: if ($hideprivileged) {
3512: my $skipuser;
1.1219 raeburn 3513: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3514: my @possdoms = ($cdom);
3515: if ($coursehash{'checkforpriv'}) {
3516: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3517: }
3518: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 3519: $skipuser = 1;
3520: if ($coursehash{'nothideprivileged'}) {
3521: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3522: my $user;
3523: if ($item =~ /:/) {
3524: $user = $item;
3525: } else {
3526: $user = join(':',split(/[\@]/,$item));
3527: }
3528: if ($user eq $uname.':'.$udom) {
3529: undef($skipuser);
3530: last;
3531: }
3532: }
3533: }
3534: if ($skipuser) {
3535: return 0;
3536: }
3537: }
3538: }
1.1194 raeburn 3539: $type ||= 'any';
3540: if (!defined($cdom) || !defined($cnum)) {
3541: my $cid = $env{'request.course.id'};
3542: $cdom = $env{'course.'.$cid.'.domain'};
3543: $cnum = $env{'course.'.$cid.'.num'};
3544: }
3545: my $typesref;
1.1195 raeburn 3546: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 3547: $typesref = ['active','previous','future'];
3548: } elsif ($type eq 'previous' || $type eq 'future') {
3549: $typesref = [$type];
3550: }
3551: my %roles = &get_my_roles($uname,$udom,'userroles',
3552: $typesref,undef,[$cdom]);
3553: my ($tmp) = keys(%roles);
3554: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3555: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3556: if (@course_roles > 0) {
3557: return 1;
3558: }
3559: return 0;
3560: }
3561:
1.478 albertel 3562: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 3563: # input: action, courseID, current domain, intended
1.637 raeburn 3564: # path to file, source of file, instruction to parse file for objects,
3565: # ref to hash for embedded objects,
3566: # ref to hash for codebase of java objects.
1.1095 raeburn 3567: # reference to scalar to accommodate mime type determined
3568: # from File::MMagic if $parser = parse.
1.637 raeburn 3569: #
1.485 raeburn 3570: # output: url to file (if action was uploaddoc),
3571: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 3572: #
1.478 albertel 3573: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3574: # course.
1.477 raeburn 3575: #
1.478 albertel 3576: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3577: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3578: # course's home server.
1.477 raeburn 3579: #
1.478 albertel 3580: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3581: # be copied from $source (current location) to
3582: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3583: # and will then be copied to
3584: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3585: # course's home server.
1.485 raeburn 3586: #
1.481 raeburn 3587: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 3588: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 3589: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3590: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3591: # in course's home server.
1.637 raeburn 3592: #
1.477 raeburn 3593:
3594: sub process_coursefile {
1.1095 raeburn 3595: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3596: $mimetype)=@_;
1.477 raeburn 3597: my $fetchresult;
1.638 albertel 3598: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 3599: if ($action eq 'propagate') {
1.638 albertel 3600: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3601: $home);
1.481 raeburn 3602: } else {
1.477 raeburn 3603: my $fpath = '';
3604: my $fname = $file;
1.478 albertel 3605: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 3606: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 3607: my $filepath = &build_filepath($fpath);
1.481 raeburn 3608: if ($action eq 'copy') {
3609: if ($source eq '') {
3610: $fetchresult = 'no source file';
3611: return $fetchresult;
3612: } else {
3613: my $destination = $filepath.'/'.$fname;
3614: rename($source,$destination);
3615: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3616: $home);
1.481 raeburn 3617: }
3618: } elsif ($action eq 'uploaddoc') {
1.1359 raeburn 3619: open(my $fh,'>',$filepath.'/'.$fname);
1.620 albertel 3620: print $fh $env{'form.'.$source};
1.481 raeburn 3621: close($fh);
1.637 raeburn 3622: if ($parser eq 'parse') {
1.1024 raeburn 3623: my $mm = new File::MMagic;
1.1095 raeburn 3624: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3625: if ($type eq 'text/html') {
1.1024 raeburn 3626: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3627: unless ($parse_result eq 'ok') {
3628: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3629: }
1.637 raeburn 3630: }
1.1095 raeburn 3631: if (ref($mimetype)) {
3632: $$mimetype = $type;
3633: }
1.637 raeburn 3634: }
1.477 raeburn 3635: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3636: $home);
1.481 raeburn 3637: if ($fetchresult eq 'ok') {
3638: return '/uploaded/'.$fpath.'/'.$fname;
3639: } else {
3640: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3641: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 3642: return '/adm/notfound.html';
3643: }
1.477 raeburn 3644: }
3645: }
1.485 raeburn 3646: unless ( $fetchresult eq 'ok') {
1.477 raeburn 3647: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3648: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 3649: }
3650: return $fetchresult;
3651: }
3652:
1.637 raeburn 3653: sub build_filepath {
3654: my ($fpath) = @_;
3655: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3656: unless ($fpath eq '') {
3657: my @parts=split('/',$fpath);
3658: foreach my $part (@parts) {
3659: $filepath.= '/'.$part;
3660: if ((-e $filepath)!=1) {
3661: mkdir($filepath,0777);
3662: }
3663: }
3664: }
3665: return $filepath;
3666: }
3667:
3668: sub store_edited_file {
1.638 albertel 3669: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 3670: my $file = $primary_url;
3671: $file =~ s#^/uploaded/$docudom/$docuname/##;
3672: my $fpath = '';
3673: my $fname = $file;
3674: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3675: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3676: my $filepath = &build_filepath($fpath);
1.1359 raeburn 3677: open(my $fh,'>',$filepath.'/'.$fname);
1.637 raeburn 3678: print $fh $content;
3679: close($fh);
1.638 albertel 3680: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 3681: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3682: $home);
1.637 raeburn 3683: if ($$fetchresult eq 'ok') {
3684: return '/uploaded/'.$fpath.'/'.$fname;
3685: } else {
1.638 albertel 3686: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3687: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 3688: return '/adm/notfound.html';
3689: }
3690: }
3691:
1.531 albertel 3692: sub clean_filename {
1.831 albertel 3693: my ($fname,$args)=@_;
1.315 www 3694: # Replace Windows backslashes by forward slashes
1.257 www 3695: $fname=~s/\\/\//g;
1.831 albertel 3696: if (!$args->{'keep_path'}) {
3697: # Get rid of everything but the actual filename
3698: $fname=~s/^.*\/([^\/]+)$/$1/;
3699: }
1.315 www 3700: # Replace spaces by underscores
3701: $fname=~s/\s+/\_/g;
3702: # Replace all other weird characters by nothing
1.831 albertel 3703: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 3704: # Replace all .\d. sequences with _\d. so they no longer look like version
3705: # numbers
3706: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 3707: return $fname;
3708: }
1.1051 raeburn 3709: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3710: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3711: # image with the same aspect ratio as the original, but with dimensions which do
3712: # not exceed $resizewidth and $resizeheight.
3713:
1.984 neumanie 3714: sub resizeImage {
1.1051 raeburn 3715: my ($img_path,$resizewidth,$resizeheight) = @_;
3716: my $ima = Image::Magick->new;
3717: my $resized;
3718: if (-e $img_path) {
3719: $ima->Read($img_path);
3720: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3721: my $width = $ima->Get('width');
3722: my $height = $ima->Get('height');
3723: if ($width > $resizewidth) {
3724: my $factor = $width/$resizewidth;
3725: my $newheight = $height/$factor;
3726: $ima->Scale(width=>$resizewidth,height=>$newheight);
3727: $resized = 1;
3728: }
3729: }
3730: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3731: my $width = $ima->Get('width');
3732: my $height = $ima->Get('height');
3733: if ($height > $resizeheight) {
3734: my $factor = $height/$resizeheight;
3735: my $newwidth = $width/$factor;
3736: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3737: $resized = 1;
3738: }
3739: }
3740: if ($resized) {
3741: $ima->Write($img_path);
3742: }
3743: }
3744: return;
1.977 amueller 3745: }
3746:
1.608 albertel 3747: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 3748: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 3749: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 3750: # $context - possible values: coursedoc, existingfile, overwrite,
3751: # canceloverwrite, or ''.
3752: # if 'coursedoc': upload to the current course
3753: # if 'existingfile': write file to tmp/overwrites directory
3754: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3755: # $context is passed as argument to &finishuserfileupload
1.686 albertel 3756: # $subdir - directory in userfile to store the file into
1.858 raeburn 3757: # $parser - instruction to parse file for objects ($parser = parse)
3758: # $allfiles - reference to hash for embedded objects
3759: # $codebase - reference to hash for codebase of java objects
3760: # $desuname - username for permanent storage of uploaded file
3761: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 3762: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3763: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 3764: # $resizewidth - width (pixels) to which to resize uploaded image
3765: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 3766: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 3767: # from File::MMagic.
1.858 raeburn 3768: #
1.686 albertel 3769: # output: url of file in userspace, or error: <message>
3770: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 3771:
1.531 albertel 3772: sub userfileupload {
1.1090 raeburn 3773: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 3774: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 3775: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 3776: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 3777: $fname=&clean_filename($fname);
1.1090 raeburn 3778: # See if there is anything left
1.257 www 3779: unless ($fname) { return 'error: no uploaded file'; }
1.1090 raeburn 3780: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3781: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3782: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3783: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 3784: my $now = time;
1.1090 raeburn 3785: my $filepath;
1.1095 raeburn 3786: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 3787: $filepath = 'tmp/helprequests/'.$now;
3788: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3789: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3790: '_'.$env{'user.domain'}.'/pending';
3791: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3792: my ($docuname,$docudom);
1.1350 raeburn 3793: if ($destudom =~ /^$match_domain$/) {
1.1090 raeburn 3794: $docudom = $destudom;
3795: } else {
3796: $docudom = $env{'user.domain'};
3797: }
1.1350 raeburn 3798: if ($destuname =~ /^$match_username$/) {
1.1090 raeburn 3799: $docuname = $destuname;
3800: } else {
3801: $docuname = $env{'user.name'};
3802: }
3803: if (exists($env{'form.group'})) {
3804: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3805: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3806: }
3807: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3808: if ($context eq 'canceloverwrite') {
3809: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3810: if (-e $tempfile) {
3811: my @info = stat($tempfile);
3812: if ($info[9] eq $env{'form.timestamp'}) {
3813: unlink($tempfile);
3814: }
3815: }
3816: return;
1.523 raeburn 3817: }
3818: }
1.1090 raeburn 3819: # Create the directory if not present
1.741 raeburn 3820: my @parts=split(/\//,$filepath);
3821: my $fullpath = $perlvar{'lonDaemons'};
3822: for (my $i=0;$i<@parts;$i++) {
3823: $fullpath .= '/'.$parts[$i];
3824: if ((-e $fullpath)!=1) {
3825: mkdir($fullpath,0777);
3826: }
3827: }
1.1359 raeburn 3828: open(my $fh,'>',$fullpath.'/'.$fname);
1.741 raeburn 3829: print $fh $env{'form.'.$formname};
3830: close($fh);
1.1090 raeburn 3831: if ($context eq 'existingfile') {
3832: my @info = stat($fullpath.'/'.$fname);
3833: return ($fullpath.'/'.$fname,$info[9]);
3834: } else {
3835: return $fullpath.'/'.$fname;
3836: }
1.523 raeburn 3837: }
1.995 raeburn 3838: if ($subdir eq 'scantron') {
3839: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 3840: } else {
1.995 raeburn 3841: $fname="$subdir/$fname";
3842: }
1.1090 raeburn 3843: if ($context eq 'coursedoc') {
1.638 albertel 3844: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3845: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 3846: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 3847: return &finishuserfileupload($docuname,$docudom,
3848: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 3849: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 3850: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 3851: } else {
1.1218 raeburn 3852: if ($env{'form.folder'}) {
3853: $fname=$env{'form.folder'}.'/'.$fname;
3854: }
1.638 albertel 3855: return &process_coursefile('uploaddoc',$docuname,$docudom,
3856: $fname,$formname,$parser,
1.1095 raeburn 3857: $allfiles,$codebase,$mimetype);
1.481 raeburn 3858: }
1.719 banghart 3859: } elsif (defined($destuname)) {
3860: my $docuname=$destuname;
3861: my $docudom=$destudom;
1.860 raeburn 3862: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3863: $parser,$allfiles,$codebase,
1.1051 raeburn 3864: $thumbwidth,$thumbheight,
1.1095 raeburn 3865: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3866: } else {
1.638 albertel 3867: my $docuname=$env{'user.name'};
3868: my $docudom=$env{'user.domain'};
1.1220 raeburn 3869: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 3870: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3871: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3872: }
1.860 raeburn 3873: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3874: $parser,$allfiles,$codebase,
1.1051 raeburn 3875: $thumbwidth,$thumbheight,
1.1095 raeburn 3876: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3877: }
1.271 www 3878: }
3879:
3880: sub finishuserfileupload {
1.860 raeburn 3881: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 3882: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 3883: my $path=$docudom.'/'.$docuname.'/';
1.258 www 3884: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 3885:
1.860 raeburn 3886: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 3887: $file=$fname;
3888: if ($fname=~m|/|) {
3889: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3890: $path.=$fnamepath.'/';
3891: }
1.259 www 3892: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 3893: my $count;
3894: for ($count=4;$count<=$#parts;$count++) {
3895: $filepath.="/$parts[$count]";
3896: if ((-e $filepath)!=1) {
3897: mkdir($filepath,0777);
3898: }
3899: }
1.984 neumanie 3900:
1.258 www 3901: # Save the file
3902: {
1.1359 raeburn 3903: if (!open(FH,'>',$filepath.'/'.$file)) {
1.701 albertel 3904: &logthis('Failed to create '.$filepath.'/'.$file);
3905: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3906: return '/adm/notfound.html';
3907: }
1.1090 raeburn 3908: if ($context eq 'overwrite') {
1.1117 foxr 3909: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 3910: my $target = $filepath.'/'.$file;
3911: if (-e $source) {
3912: my @info = stat($source);
3913: if ($info[9] eq $env{'form.timestamp'}) {
3914: unless (&File::Copy::move($source,$target)) {
3915: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3916: return "Moving from $source failed";
3917: }
3918: } else {
3919: return "Temporary file: $source had unexpected date/time for last modification";
3920: }
3921: } else {
3922: return "Temporary file: $source missing";
3923: }
3924: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 3925: &logthis('Failed to write to '.$filepath.'/'.$file);
3926: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3927: return '/adm/notfound.html';
3928: }
1.570 albertel 3929: close(FH);
1.1051 raeburn 3930: if ($resizewidth && $resizeheight) {
3931: my $mm = new File::MMagic;
3932: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3933: if ($mime_type =~ m{^image/}) {
3934: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3935: }
1.977 amueller 3936: }
1.258 www 3937: }
1.1152 raeburn 3938: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3939: if (ref($mimetype)) {
3940: if ($$mimetype eq '') {
3941: my $mm = new File::MMagic;
3942: my $type = $mm->checktype_filename($filepath.'/'.$file);
3943: $$mimetype = $type;
3944: }
3945: }
3946: }
1.637 raeburn 3947: if ($parser eq 'parse') {
1.1152 raeburn 3948: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 3949: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3950: $allfiles,$codebase);
3951: unless ($parse_result eq 'ok') {
3952: &logthis('Failed to parse '.$filepath.$file.
3953: ' for embedded media: '.$parse_result);
3954: }
1.637 raeburn 3955: }
3956: }
1.860 raeburn 3957: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3958: my $input = $filepath.'/'.$file;
3959: my $output = $filepath.'/'.'tn-'.$file;
3960: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1.1359 raeburn 3961: my @args = ('convert','-sample',$thumbsize,$input,$output);
3962: system({$args[0]} @args);
1.860 raeburn 3963: if (-e $filepath.'/'.'tn-'.$file) {
3964: $fetchthumb = 1;
3965: }
3966: }
1.858 raeburn 3967:
1.259 www 3968: # Notify homeserver to grep it
3969: #
1.984 neumanie 3970: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 3971: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 3972: if ($fetchresult eq 'ok') {
1.860 raeburn 3973: if ($fetchthumb) {
3974: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3975: if ($thumbresult ne 'ok') {
3976: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3977: $docuhome.': '.$thumbresult);
3978: }
3979: }
1.259 www 3980: #
1.258 www 3981: # Return the URL to it
1.494 albertel 3982: return '/uploaded/'.$path.$file;
1.263 www 3983: } else {
1.494 albertel 3984: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3985: ': '.$fetchresult);
1.263 www 3986: return '/adm/notfound.html';
1.858 raeburn 3987: }
1.493 albertel 3988: }
3989:
1.637 raeburn 3990: sub extract_embedded_items {
1.961 raeburn 3991: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 3992: my @state = ();
1.1164 raeburn 3993: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 3994: my %javafiles = (
3995: codebase => '',
3996: code => '',
3997: archive => ''
3998: );
3999: my %mediafiles = (
4000: src => '',
4001: movie => '',
4002: );
1.648 raeburn 4003: my $p;
4004: if ($content) {
4005: $p = HTML::LCParser->new($content);
4006: } else {
1.961 raeburn 4007: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 4008: }
1.641 albertel 4009: while (my $t=$p->get_token()) {
1.640 albertel 4010: if ($t->[0] eq 'S') {
4011: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 4012: push(@state, $tagname);
1.648 raeburn 4013: if (lc($tagname) eq 'allow') {
4014: &add_filetype($allfiles,$attr->{'src'},'src');
4015: }
1.640 albertel 4016: if (lc($tagname) eq 'img') {
4017: &add_filetype($allfiles,$attr->{'src'},'src');
4018: }
1.886 albertel 4019: if (lc($tagname) eq 'a') {
1.1222 raeburn 4020: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 4021: &add_filetype($allfiles,$attr->{'href'},'href');
4022: }
1.886 albertel 4023: }
1.645 raeburn 4024: if (lc($tagname) eq 'script') {
1.1164 raeburn 4025: my $src;
1.645 raeburn 4026: if ($attr->{'archive'} =~ /\.jar$/i) {
4027: &add_filetype($allfiles,$attr->{'archive'},'archive');
4028: } else {
1.1164 raeburn 4029: if ($attr->{'src'} ne '') {
4030: $src = $attr->{'src'};
4031: &add_filetype($allfiles,$src,'src');
4032: }
4033: }
4034: my $text = $p->get_trimmed_text();
4035: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4036: my @swfargs = split(/,/,$1);
4037: foreach my $item (@swfargs) {
4038: $item =~ s/["']//g;
4039: $item =~ s/^\s+//;
4040: $item =~ s/\s+$//;
4041: }
4042: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4043: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4044: push(@{$related{$swfargs[0]}},$swfargs[2]);
4045: } else {
4046: $related{$swfargs[0]} = [$swfargs[2]];
4047: }
4048: }
1.645 raeburn 4049: }
4050: }
4051: if (lc($tagname) eq 'link') {
4052: if (lc($attr->{'rel'}) eq 'stylesheet') {
4053: &add_filetype($allfiles,$attr->{'href'},'href');
4054: }
4055: }
1.640 albertel 4056: if (lc($tagname) eq 'object' ||
4057: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4058: foreach my $item (keys(%javafiles)) {
4059: $javafiles{$item} = '';
4060: }
1.1164 raeburn 4061: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4062: $lastids{lc($tagname)} = $attr->{'id'};
4063: }
1.640 albertel 4064: }
4065: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4066: my $name = lc($attr->{'name'});
4067: foreach my $item (keys(%javafiles)) {
4068: if ($name eq $item) {
4069: $javafiles{$item} = $attr->{'value'};
4070: last;
4071: }
4072: }
1.1164 raeburn 4073: my $pathfrom;
1.640 albertel 4074: foreach my $item (keys(%mediafiles)) {
4075: if ($name eq $item) {
1.1164 raeburn 4076: $pathfrom = $attr->{'value'};
4077: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4078: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 4079: last;
4080: }
4081: }
1.1164 raeburn 4082: if ($name eq 'flashvars') {
4083: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4084: }
4085: if ($pathfrom ne '') {
4086: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4087: $pathfrom);
4088: }
1.640 albertel 4089: }
4090: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4091: foreach my $item (keys(%javafiles)) {
4092: if ($attr->{$item}) {
4093: $javafiles{$item} = $attr->{$item};
4094: last;
4095: }
4096: }
4097: foreach my $item (keys(%mediafiles)) {
4098: if ($attr->{$item}) {
4099: &add_filetype($allfiles,$attr->{$item},$item);
4100: last;
4101: }
4102: }
1.1164 raeburn 4103: if (lc($tagname) eq 'embed') {
4104: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4105: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4106: $attr->{'src'});
4107: }
4108: }
1.640 albertel 4109: }
1.1243 raeburn 4110: if (lc($tagname) eq 'iframe') {
4111: my $src = $attr->{'src'} ;
4112: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4113: &add_filetype($allfiles,$src,'src');
4114: } elsif ($src =~ m{^/}) {
4115: if ($env{'request.course.id'}) {
4116: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4117: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4118: my $url = &hreflocation('',$fullpath);
4119: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4120: my $relpath = $1;
4121: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4122: &add_filetype($allfiles,$1,'src');
4123: }
4124: }
4125: }
4126: }
4127: }
1.1164 raeburn 4128: if ($t->[4] =~ m{/>$}) {
1.1243 raeburn 4129: pop(@state);
1.1164 raeburn 4130: }
1.640 albertel 4131: } elsif ($t->[0] eq 'E') {
4132: my ($tagname) = ($t->[1]);
4133: if ($javafiles{'codebase'} ne '') {
4134: $javafiles{'codebase'} .= '/';
4135: }
4136: if (lc($tagname) eq 'applet' ||
4137: lc($tagname) eq 'object' ||
4138: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4139: ) {
4140: foreach my $item (keys(%javafiles)) {
4141: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4142: my $file=$javafiles{'codebase'}.$javafiles{$item};
4143: &add_filetype($allfiles,$file,$item);
4144: }
4145: }
4146: }
4147: pop @state;
4148: }
4149: }
1.1164 raeburn 4150: foreach my $id (sort(keys(%flashvars))) {
4151: if ($shockwave{$id} ne '') {
4152: my @pairs = split(/\&/,$flashvars{$id});
4153: foreach my $pair (@pairs) {
4154: my ($key,$value) = split(/\=/,$pair);
4155: if ($key eq 'thumb') {
4156: &add_filetype($allfiles,$value,$key);
4157: } elsif ($key eq 'content') {
4158: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4159: my ($ext) = ($value =~ /\.([^.]+)$/);
4160: if ($ext ne '') {
4161: &add_filetype($allfiles,$path.$value,$ext);
4162: }
4163: }
4164: }
4165: }
4166: }
1.637 raeburn 4167: return 'ok';
4168: }
4169:
1.639 albertel 4170: sub add_filetype {
4171: my ($allfiles,$file,$type)=@_;
4172: if (exists($allfiles->{$file})) {
4173: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4174: push(@{$allfiles->{$file}}, &escape($type));
4175: }
4176: } else {
4177: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 4178: }
4179: }
4180:
1.1164 raeburn 4181: sub embedded_dependency {
4182: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4183: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4184: if (($identifier ne '') &&
4185: (ref($related->{$identifier}) eq 'ARRAY') &&
4186: ($pathfrom ne '')) {
4187: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4188: foreach my $dep (@{$related->{$identifier}}) {
4189: &add_filetype($allfiles,$path.$dep,'object');
4190: }
4191: }
4192: }
4193: return;
4194: }
4195:
1.493 albertel 4196: sub removeuploadedurl {
1.984 neumanie 4197: my ($url)=@_;
4198: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 4199: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 4200: }
4201:
4202: sub removeuserfile {
4203: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 4204: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4205: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 4206: if ($result eq 'ok') {
1.798 raeburn 4207: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
4208: my $metafile = $fname.'.meta';
4209: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 4210: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 4211: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4212: my $sqlresult =
1.823 albertel 4213: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4214: 'portfolio_metadata',$group,
4215: 'delete');
1.798 raeburn 4216: }
4217: }
4218: return $result;
1.257 www 4219: }
1.15 www 4220:
1.530 albertel 4221: sub mkdiruserfile {
4222: my ($docuname,$docudom,$dir)=@_;
4223: my $home=&homeserver($docuname,$docudom);
4224: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
4225: }
4226:
1.531 albertel 4227: sub renameuserfile {
4228: my ($docuname,$docudom,$old,$new)=@_;
4229: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 4230: my $result = &reply("renameuserfile:$docudom:$docuname:".
4231: &escape("$old").':'.&escape("$new"),$home);
4232: if ($result eq 'ok') {
4233: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
4234: my $oldmeta = $old.'.meta';
4235: my $newmeta = $new.'.meta';
4236: my $metaresult =
4237: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 4238: my $url = "/uploaded/$docudom/$docuname/$old";
4239: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 4240: my $sqlresult =
1.823 albertel 4241: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 4242: 'portfolio_metadata',$group,
4243: 'delete');
1.798 raeburn 4244: }
4245: }
4246: return $result;
1.531 albertel 4247: }
4248:
1.14 www 4249: # ------------------------------------------------------------------------- Log
4250:
4251: sub log {
4252: my ($dom,$nam,$hom,$what)=@_;
1.47 www 4253: return critical("log:$dom:$nam:$what",$hom);
1.157 www 4254: }
4255:
4256: # ------------------------------------------------------------------ Course Log
1.352 www 4257: #
4258: # This routine flushes several buffers of non-mission-critical nature
4259: #
1.157 www 4260:
4261: sub flushcourselogs {
1.352 www 4262: &logthis('Flushing log buffers');
4263: #
4264: # course logs
4265: # This is a log of all transactions in a course, which can be used
4266: # for data mining purposes
4267: #
4268: # It also collects the courseid database, which lists last transaction
4269: # times and course titles for all courseids
4270: #
4271: my %courseidbuffer=();
1.921 raeburn 4272: foreach my $crsid (keys(%courselogs)) {
1.352 www 4273: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 4274: &escape($courselogs{$crsid}),
4275: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 4276: delete $courselogs{$crsid};
4277: } else {
4278: &logthis('Failed to flush log buffer for '.$crsid);
4279: if (length($courselogs{$crsid})>40000) {
1.672 albertel 4280: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 4281: " exceeded maximum size, deleting.</font>");
4282: delete $courselogs{$crsid};
4283: }
1.352 www 4284: }
1.920 raeburn 4285: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 4286: 'description' => $coursedescrbuf{$crsid},
4287: 'inst_code' => $courseinstcodebuf{$crsid},
4288: 'type' => $coursetypebuf{$crsid},
4289: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 4290: };
1.191 harris41 4291: }
1.352 www 4292: #
4293: # Write course id database (reverse lookup) to homeserver of courses
4294: # Is used in pickcourse
4295: #
1.840 albertel 4296: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 4297: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 4298: $courseidbuffer{$crs_home},
4299: $crs_home,'timeonly');
1.352 www 4300: }
4301: #
4302: # File accesses
4303: # Writes to the dynamic metadata of resources to get hit counts, etc.
4304: #
1.449 matthew 4305: foreach my $entry (keys(%accesshash)) {
1.458 matthew 4306: if ($entry =~ /___count$/) {
4307: my ($dom,$name);
1.807 albertel 4308: ($dom,$name,undef)=
1.811 albertel 4309: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 4310: if (! defined($dom) || $dom eq '' ||
4311: ! defined($name) || $name eq '') {
1.620 albertel 4312: my $cid = $env{'request.course.id'};
4313: $dom = $env{'request.'.$cid.'.domain'};
4314: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 4315: }
1.450 matthew 4316: my $value = $accesshash{$entry};
4317: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
4318: my %temphash=($url => $value);
1.449 matthew 4319: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
4320: if ($result eq 'ok') {
4321: delete $accesshash{$entry};
4322: }
4323: } else {
1.811 albertel 4324: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 4325: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 4326: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 4327: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
4328: delete $accesshash{$entry};
4329: }
1.185 www 4330: }
1.191 harris41 4331: }
1.352 www 4332: #
4333: # Roles
4334: # Reverse lookup of user roles for course faculty/staff and co-authorship
4335: #
1.800 albertel 4336: foreach my $entry (keys(%userrolehash)) {
1.351 www 4337: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 4338: split(/\:/,$entry);
4339: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 4340: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 4341: $rudom,$runame) eq 'ok') {
4342: delete $userrolehash{$entry};
4343: }
4344: }
1.662 raeburn 4345: #
1.1334 raeburn 4346: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 4347: #
4348: my %domrolebuffer = ();
1.1000 raeburn 4349: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 4350: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 4351: if ($domrolebuffer{$rudom}) {
4352: $domrolebuffer{$rudom}.='&'.&escape($entry).
4353: '='.&escape($domainrolehash{$entry});
4354: } else {
4355: $domrolebuffer{$rudom}.=&escape($entry).
4356: '='.&escape($domainrolehash{$entry});
4357: }
4358: delete $domainrolehash{$entry};
4359: }
4360: foreach my $dom (keys(%domrolebuffer)) {
1.1324 raeburn 4361: my %servers;
4362: if (defined(&domain($dom,'primary'))) {
4363: my $primary=&domain($dom,'primary');
4364: my $hostname=&hostname($primary);
4365: $servers{$primary} = $hostname;
4366: } else {
4367: %servers = &get_servers($dom,'library');
4368: }
1.841 albertel 4369: foreach my $tryserver (keys(%servers)) {
1.1324 raeburn 4370: if (&reply('domroleput:'.$dom.':'.
4371: $domrolebuffer{$dom},$tryserver) eq 'ok') {
4372: last;
4373: } else {
1.841 albertel 4374: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
4375: }
1.662 raeburn 4376: }
4377: }
1.186 www 4378: $dumpcount++;
1.157 www 4379: }
4380:
4381: sub courselog {
4382: my $what=shift;
1.158 www 4383: $what=time.':'.$what;
1.620 albertel 4384: unless ($env{'request.course.id'}) { return ''; }
4385: $coursedombuf{$env{'request.course.id'}}=
4386: $env{'course.'.$env{'request.course.id'}.'.domain'};
4387: $coursenumbuf{$env{'request.course.id'}}=
4388: $env{'course.'.$env{'request.course.id'}.'.num'};
4389: $coursehombuf{$env{'request.course.id'}}=
4390: $env{'course.'.$env{'request.course.id'}.'.home'};
4391: $coursedescrbuf{$env{'request.course.id'}}=
4392: $env{'course.'.$env{'request.course.id'}.'.description'};
4393: $courseinstcodebuf{$env{'request.course.id'}}=
4394: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
4395: $courseownerbuf{$env{'request.course.id'}}=
4396: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 4397: $coursetypebuf{$env{'request.course.id'}}=
4398: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 4399: if (defined $courselogs{$env{'request.course.id'}}) {
4400: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 4401: } else {
1.620 albertel 4402: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 4403: }
1.620 albertel 4404: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 4405: &flushcourselogs();
4406: }
1.158 www 4407: }
4408:
4409: sub courseacclog {
4410: my $fnsymb=shift;
1.620 albertel 4411: unless ($env{'request.course.id'}) { return ''; }
4412: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 4413: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 4414: $what.=':POST';
1.583 matthew 4415: # FIXME: Probably ought to escape things....
1.800 albertel 4416: foreach my $key (keys(%env)) {
4417: if ($key=~/^form\.(.*)/) {
1.975 raeburn 4418: my $formitem = $1;
4419: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
4420: $what.=':'.$formitem.'='.$env{$key};
4421: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
4422: $what.=':'.$formitem.'='.$env{$key};
4423: }
1.158 www 4424: }
1.191 harris41 4425: }
1.583 matthew 4426: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4427: # FIXME: We should not be depending on a form parameter that someone
4428: # editing lonsearchcat.pm might change in the future.
1.620 albertel 4429: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 4430: $what.= ':POST';
4431: # FIXME: Probably ought to escape things....
4432: foreach my $element ('courseexp','crsfulltext','crsrelated',
4433: 'crsdiscuss') {
1.620 albertel 4434: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 4435: }
4436: }
1.158 www 4437: }
4438: &courselog($what);
1.149 www 4439: }
4440:
1.185 www 4441: sub countacc {
4442: my $url=&declutter(shift);
1.458 matthew 4443: return if (! defined($url) || $url eq '');
1.620 albertel 4444: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 4445: #
4446: # Mark that this url was used in this course
4447: #
1.620 albertel 4448: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 4449: #
4450: # Increase the access count for this resource in this child process
4451: #
1.281 www 4452: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 4453: $accesshash{$key}++;
1.185 www 4454: }
1.349 www 4455:
1.361 www 4456: sub linklog {
4457: my ($from,$to)=@_;
4458: $from=&declutter($from);
4459: $to=&declutter($to);
4460: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4461: $accesshash{$to.'___'.$from.'___goto'}=1;
4462: }
1.1160 www 4463:
4464: sub statslog {
4465: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4466: if ($users<2) { return; }
4467: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4468: 'course' => $env{'request.course.id'},
4469: 'sections' => '"all"',
4470: 'num_students' => $users,
4471: 'part' => $part,
4472: 'symb' => $symb,
4473: 'mean_tries' => $av_attempts,
4474: 'deg_of_diff' => $degdiff});
4475: foreach my $key (keys(%dynstore)) {
4476: $accesshash{$key}=$dynstore{$key};
4477: }
4478: }
1.361 www 4479:
1.349 www 4480: sub userrolelog {
4481: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 4482: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 4483: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4484: $userrolehash
4485: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 4486: =$tend.':'.$tstart;
1.662 raeburn 4487: }
1.1169 droeschl 4488: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 4489: $userrolehash
4490: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4491: =$tend.':'.$tstart;
4492: }
1.1334 raeburn 4493: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 4494: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4495: $domainrolehash
4496: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4497: = $tend.':'.$tstart;
4498: }
1.351 www 4499: }
4500:
1.957 raeburn 4501: sub courserolelog {
4502: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184 raeburn 4503: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4504: my $cdom = $1;
4505: my $cnum = $2;
4506: my $sec = $3;
4507: my $namespace = 'rolelog';
4508: my %storehash = (
4509: role => $trole,
4510: start => $tstart,
4511: end => $tend,
4512: selfenroll => $selfenroll,
4513: context => $context,
4514: );
4515: if ($trole eq 'gr') {
4516: $namespace = 'groupslog';
4517: $storehash{'group'} = $sec;
4518: } else {
4519: $storehash{'section'} = $sec;
4520: }
1.1188 raeburn 4521: &write_log('course',$namespace,\%storehash,$delflag,$username,
4522: $domain,$cnum,$cdom);
1.1184 raeburn 4523: if (($trole ne 'st') || ($sec ne '')) {
4524: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 4525: }
4526: }
4527: return;
4528: }
4529:
1.1184 raeburn 4530: sub domainrolelog {
4531: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4532: if ($area =~ m{^/($match_domain)/$}) {
4533: my $cdom = $1;
4534: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4535: my $namespace = 'rolelog';
4536: my %storehash = (
4537: role => $trole,
4538: start => $tstart,
4539: end => $tend,
4540: context => $context,
4541: );
1.1188 raeburn 4542: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4543: $domain,$domconfiguser,$cdom);
1.1184 raeburn 4544: }
4545: return;
4546:
4547: }
4548:
4549: sub coauthorrolelog {
4550: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4551: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4552: my $audom = $1;
4553: my $auname = $2;
4554: my $namespace = 'rolelog';
4555: my %storehash = (
4556: role => $trole,
4557: start => $tstart,
4558: end => $tend,
4559: context => $context,
4560: );
1.1188 raeburn 4561: &write_log('author',$namespace,\%storehash,$delflag,$username,
4562: $domain,$auname,$audom);
1.1184 raeburn 4563: }
4564: return;
4565: }
4566:
1.351 www 4567: sub get_course_adv_roles {
1.948 raeburn 4568: my ($cid,$codes) = @_;
1.620 albertel 4569: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 4570: my %coursehash=&coursedescription($cid);
1.988 raeburn 4571: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 4572: my %nothide=();
1.800 albertel 4573: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 4574: if ($user !~ /:/) {
4575: $nothide{join(':',split(/[\@]/,$user))}=1;
4576: } else {
4577: $nothide{$user}=1;
4578: }
1.470 www 4579: }
1.1219 raeburn 4580: my @possdoms = ($coursehash{'domain'});
4581: if ($coursehash{'checkforpriv'}) {
4582: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4583: }
1.351 www 4584: my %returnhash=();
4585: my %dumphash=
4586: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4587: my $now=time;
1.997 raeburn 4588: my %privileged;
1.1000 raeburn 4589: foreach my $entry (keys(%dumphash)) {
1.800 albertel 4590: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 4591: if (($tstart) && ($tstart<0)) { next; }
4592: if (($tend) && ($tend<$now)) { next; }
4593: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 4594: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 4595: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 4596: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 4597: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 4598: if ($role eq 'cr') { next; }
1.948 raeburn 4599: if ($codes) {
4600: if ($section) { $role .= ':'.$section; }
4601: if ($returnhash{$role}) {
4602: $returnhash{$role}.=','.$username.':'.$domain;
4603: } else {
4604: $returnhash{$role}=$username.':'.$domain;
4605: }
1.351 www 4606: } else {
1.988 raeburn 4607: my $key=&plaintext($role,$crstype);
1.973 bisitz 4608: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 4609: if ($returnhash{$key}) {
4610: $returnhash{$key}.=','.$username.':'.$domain;
4611: } else {
4612: $returnhash{$key}=$username.':'.$domain;
4613: }
1.351 www 4614: }
1.948 raeburn 4615: }
1.400 www 4616: return %returnhash;
4617: }
4618:
4619: sub get_my_roles {
1.937 raeburn 4620: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 4621: unless (defined($uname)) { $uname=$env{'user.name'}; }
4622: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 4623: my (%dumphash,%nothide);
1.1086 raeburn 4624: if ($context eq 'userroles') {
1.1166 raeburn 4625: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 4626: } else {
1.1219 raeburn 4627: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 4628: if ($hidepriv) {
4629: my %coursehash=&coursedescription($udom.'_'.$uname);
4630: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4631: if ($user !~ /:/) {
4632: $nothide{join(':',split(/[\@]/,$user))} = 1;
4633: } else {
4634: $nothide{$user} = 1;
4635: }
4636: }
4637: }
1.858 raeburn 4638: }
1.400 www 4639: my %returnhash=();
4640: my $now=time;
1.999 raeburn 4641: my %privileged;
1.800 albertel 4642: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 4643: my ($role,$tend,$tstart);
4644: if ($context eq 'userroles') {
1.1149 raeburn 4645: next if ($entry =~ /^rolesdef/);
1.867 raeburn 4646: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4647: } else {
4648: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4649: }
1.400 www 4650: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 4651: my $status = 'active';
1.939 raeburn 4652: if (($tend) && ($tend<=$now)) {
1.832 raeburn 4653: $status = 'previous';
4654: }
4655: if (($tstart) && ($now<$tstart)) {
4656: $status = 'future';
4657: }
4658: if (ref($types) eq 'ARRAY') {
4659: if (!grep(/^\Q$status\E$/,@{$types})) {
4660: next;
4661: }
4662: } else {
4663: if ($status ne 'active') {
4664: next;
4665: }
4666: }
1.867 raeburn 4667: my ($rolecode,$username,$domain,$section,$area);
4668: if ($context eq 'userroles') {
1.1186 raeburn 4669: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 4670: (undef,$domain,$username,$section) = split(/\//,$area);
4671: } else {
4672: ($role,$username,$domain,$section) = split(/\:/,$entry);
4673: }
1.832 raeburn 4674: if (ref($roledoms) eq 'ARRAY') {
4675: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4676: next;
4677: }
4678: }
4679: if (ref($roles) eq 'ARRAY') {
4680: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 4681: if ($role =~ /^cr\//) {
4682: if (!grep(/^cr$/,@{$roles})) {
4683: next;
4684: }
1.1104 raeburn 4685: } elsif ($role =~ /^gr\//) {
4686: if (!grep(/^gr$/,@{$roles})) {
4687: next;
4688: }
1.922 raeburn 4689: } else {
4690: next;
4691: }
1.832 raeburn 4692: }
1.867 raeburn 4693: }
1.937 raeburn 4694: if ($hidepriv) {
1.1219 raeburn 4695: my @privroles = ('dc','su');
1.999 raeburn 4696: if ($context eq 'userroles') {
1.1219 raeburn 4697: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 4698: } else {
1.1219 raeburn 4699: my $possdoms = [$domain];
4700: if (ref($roledoms) eq 'ARRAY') {
4701: push(@{$possdoms},@{$roledoms});
1.999 raeburn 4702: }
1.1219 raeburn 4703: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 4704: if (!$nothide{$username.':'.$domain}) {
4705: next;
4706: }
4707: }
1.937 raeburn 4708: }
4709: }
1.933 raeburn 4710: if ($withsec) {
4711: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4712: $tstart.':'.$tend;
4713: } else {
4714: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4715: }
1.832 raeburn 4716: }
1.373 www 4717: return %returnhash;
1.399 www 4718: }
4719:
1.1333 raeburn 4720: sub get_all_adhocroles {
4721: my ($dom) = @_;
4722: my @roles_by_num = ();
4723: my %domdefaults = &get_domain_defaults($dom);
4724: my (%description,%access_in_dom,%access_info);
4725: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
4726: my $count = 0;
4727: my %domcurrent = %{$domdefaults{'adhocroles'}};
4728: my %ordered;
4729: foreach my $role (sort(keys(%domcurrent))) {
4730: my ($order,$desc,$access_in_dom);
4731: if (ref($domcurrent{$role}) eq 'HASH') {
4732: $order = $domcurrent{$role}{'order'};
4733: $desc = $domcurrent{$role}{'desc'};
4734: $access_in_dom{$role} = $domcurrent{$role}{'access'};
4735: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
4736: }
4737: if ($order eq '') {
4738: $order = $count;
4739: }
4740: $ordered{$order} = $role;
4741: if ($desc ne '') {
4742: $description{$role} = $desc;
4743: } else {
4744: $description{$role}= $role;
4745: }
4746: $count++;
4747: }
4748: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
4749: push(@roles_by_num,$ordered{$item});
4750: }
4751: }
4752: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
4753: }
4754:
1.1332 raeburn 4755: sub get_my_adhocroles {
1.1333 raeburn 4756: my ($cid,$checkreg) = @_;
4757: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
4758: if ($env{'request.course.id'} eq $cid) {
4759: $cdom = $env{'course.'.$cid.'.domain'};
4760: $cnum = $env{'course.'.$cid.'.num'};
4761: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
4762: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
4763: $cdom = $1;
4764: $cnum = $2;
4765: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
4766: $cdom,$cnum);
4767: }
4768: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
4769: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4770: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
4771: if ($rosterhash{$user} ne '') {
4772: my $type = (split(/:/,$rosterhash{$user}))[5];
4773: return ([],{}) if ($type eq 'auto');
4774: }
4775: }
4776: if (($cdom ne '') && ($cnum ne '')) {
1.1334 raeburn 4777: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1332 raeburn 4778: my $then=$env{'user.login.time'};
4779: my $update=$env{'user.update.time'};
1.1335 raeburn 4780: if (!$update) {
4781: $update = $then;
4782: }
4783: my @liveroles;
1.1334 raeburn 4784: foreach my $role ('dh','da') {
4785: if ($env{"user.role.$role./$cdom/"}) {
1.1335 raeburn 4786: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
1.1334 raeburn 4787: my $limit = $update;
4788: if ($env{'request.role'} eq "$role./$cdom/") {
4789: $limit = $then;
4790: }
1.1335 raeburn 4791: my $activerole = 1;
4792: if ($tstart && $tstart>$limit) { $activerole = 0; }
4793: if ($tend && $tend <$limit) { $activerole = 0; }
4794: if ($activerole) {
4795: push(@liveroles,$role);
4796: }
1.1334 raeburn 4797: }
1.1332 raeburn 4798: }
1.1335 raeburn 4799: if (@liveroles) {
1.1332 raeburn 4800: if (&homeserver($cnum,$cdom) ne 'no_host') {
1.1333 raeburn 4801: my ($accessref,$accessinfo,%access_in_dom);
4802: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
4803: if (ref($roles_by_num) eq 'ARRAY') {
4804: if (@{$roles_by_num}) {
1.1332 raeburn 4805: my %settings;
4806: if ($env{'request.course.id'} eq $cid) {
4807: foreach my $envkey (keys(%env)) {
4808: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
4809: $settings{$1} = $env{$envkey};
4810: }
4811: }
4812: } else {
4813: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
4814: }
4815: my %setincrs;
4816: if ($settings{'internal.adhocaccess'}) {
4817: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
4818: }
4819: my @statuses;
4820: if ($env{'environment.inststatus'}) {
4821: @statuses = split(/,/,$env{'environment.inststatus'});
4822: }
4823: my $user = $env{'user.name'}.':'.$env{'user.domain'};
1.1333 raeburn 4824: if (ref($accessref) eq 'HASH') {
4825: %access_in_dom = %{$accessref};
4826: }
4827: foreach my $role (@{$roles_by_num}) {
1.1332 raeburn 4828: my ($curraccess,@okstatus,@personnel);
4829: if ($setincrs{$role}) {
4830: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
4831: if ($curraccess eq 'status') {
4832: @okstatus = split(/\&/,$rest);
4833: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4834: @personnel = split(/\&/,$rest);
4835: }
4836: } else {
4837: $curraccess = $access_in_dom{$role};
1.1333 raeburn 4838: if (ref($accessinfo) eq 'HASH') {
4839: if ($curraccess eq 'status') {
4840: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4841: @okstatus = @{$accessinfo->{$role}};
4842: }
4843: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4844: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4845: @personnel = @{$accessinfo->{$role}};
4846: }
1.1332 raeburn 4847: }
4848: }
4849: }
4850: if ($curraccess eq 'none') {
4851: next;
4852: } elsif ($curraccess eq 'all') {
4853: push(@possroles,$role);
1.1336 raeburn 4854: } elsif ($curraccess eq 'dh') {
1.1335 raeburn 4855: if (grep(/^dh$/,@liveroles)) {
4856: push(@possroles,$role);
4857: } else {
4858: next;
4859: }
1.1336 raeburn 4860: } elsif ($curraccess eq 'da') {
1.1335 raeburn 4861: if (grep(/^da$/,@liveroles)) {
4862: push(@possroles,$role);
4863: } else {
4864: next;
4865: }
1.1332 raeburn 4866: } elsif ($curraccess eq 'status') {
4867: if (@okstatus) {
4868: if (!@statuses) {
4869: if (grep(/^default$/,@okstatus)) {
4870: push(@possroles,$role);
4871: }
4872: } else {
4873: foreach my $status (@okstatus) {
4874: if (grep(/^\Q$status\E$/,@statuses)) {
4875: push(@possroles,$role);
4876: last;
4877: }
4878: }
4879: }
4880: }
4881: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4882: if (grep(/^\Q$user\E$/,@personnel)) {
4883: if ($curraccess eq 'exc') {
4884: push(@possroles,$role);
4885: }
4886: } elsif ($curraccess eq 'inc') {
4887: push(@possroles,$role);
4888: }
4889: }
4890: }
4891: }
4892: }
4893: }
4894: }
4895: }
4896: }
1.1333 raeburn 4897: unless (ref($description) eq 'HASH') {
4898: if (ref($roles_by_num) eq 'ARRAY') {
4899: my %desc;
4900: map { $desc{$_} = $_; } (@{$roles_by_num});
4901: $description = \%desc;
4902: } else {
4903: $description = {};
4904: }
4905: }
4906: return (\@possroles,$description);
1.1332 raeburn 4907: }
4908:
1.399 www 4909: # ----------------------------------------------------- Frontpage Announcements
4910: #
4911: #
4912:
4913: sub postannounce {
4914: my ($server,$text)=@_;
1.844 albertel 4915: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 4916: unless ($text=~/\w/) { $text=''; }
4917: return &reply('setannounce:'.&escape($text),$server);
4918: }
4919:
4920: sub getannounce {
1.448 albertel 4921:
1.1359 raeburn 4922: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 4923: my $announcement='';
1.800 albertel 4924: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 4925: close($fh);
1.399 www 4926: if ($announcement=~/\w/) {
4927: return
4928: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 4929: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 4930: } else {
4931: return '';
4932: }
4933: } else {
4934: return '';
4935: }
1.351 www 4936: }
1.353 www 4937:
4938: # ---------------------------------------------------------- Course ID routines
4939: # Deal with domain's nohist_courseid.db files
4940: #
4941:
4942: sub courseidput {
1.921 raeburn 4943: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 4944: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 4945: my $outcome;
4946: if ($caller eq 'timeonly') {
4947: my $cids = '';
4948: foreach my $item (keys(%$storehash)) {
4949: $cids.=&escape($item).'&';
4950: }
4951: $cids=~s/\&$//;
4952: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4953: $coursehome);
4954: } else {
4955: my $items = '';
4956: foreach my $item (keys(%$storehash)) {
4957: $items.= &escape($item).'='.
4958: &freeze_escape($$storehash{$item}).'&';
4959: }
4960: $items=~s/\&$//;
4961: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4962: $coursehome);
1.918 raeburn 4963: }
4964: if ($outcome eq 'unknown_cmd') {
4965: my $what;
4966: foreach my $cid (keys(%$storehash)) {
4967: $what .= &escape($cid).'=';
1.921 raeburn 4968: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 4969: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 4970: }
4971: $what =~ s/\:$/&/;
4972: }
4973: $what =~ s/\&$//;
4974: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4975: } else {
4976: return $outcome;
4977: }
1.353 www 4978: }
4979:
4980: sub courseiddump {
1.921 raeburn 4981: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 4982: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 4983: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247 raeburn 4984: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287 raeburn 4985: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 4986: my $as_hash = 1;
4987: my %returnhash;
4988: if (!$domfilter) { $domfilter=''; }
1.845 albertel 4989: my %libserv = &all_library();
4990: foreach my $tryserver (keys(%libserv)) {
4991: if ( ( $hostidflag == 1
4992: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4993: || (!defined($hostidflag)) ) {
4994:
1.918 raeburn 4995: if (($domfilter eq '') ||
4996: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 4997: my $rep;
4998: if (grep { $_ eq $tryserver } current_machine_ids()) {
4999: $rep = LONCAPA::Lond::dump_course_id_handler(
5000: join(":", (&host_domain($tryserver), $sincefilter,
5001: &escape($descfilter), &escape($instcodefilter),
5002: &escape($ownerfilter), &escape($coursefilter),
5003: &escape($typefilter), &escape($regexp_ok),
5004: $as_hash, &escape($selfenrollonly),
5005: &escape($catfilter), $showhidden, $caller,
5006: &escape($cloner), &escape($cc_clone), $cloneonly,
5007: &escape($createdbefore), &escape($createdafter),
1.1287 raeburn 5008: &escape($creationcontext),$domcloner,$hasuniquecode,
5009: $reqcrsdom,&escape($reqinstcode))));
1.1180 droeschl 5010: } else {
5011: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
5012: $sincefilter.':'.&escape($descfilter).':'.
5013: &escape($instcodefilter).':'.&escape($ownerfilter).
5014: ':'.&escape($coursefilter).':'.&escape($typefilter).
5015: ':'.&escape($regexp_ok).':'.$as_hash.':'.
5016: &escape($selfenrollonly).':'.&escape($catfilter).':'.
5017: $showhidden.':'.$caller.':'.&escape($cloner).':'.
5018: &escape($cc_clone).':'.$cloneonly.':'.
5019: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287 raeburn 5020: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
5021: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180 droeschl 5022: }
5023:
1.918 raeburn 5024: my @pairs=split(/\&/,$rep);
5025: foreach my $item (@pairs) {
5026: my ($key,$value)=split(/\=/,$item,2);
5027: $key = &unescape($key);
5028: next if ($key =~ /^error: 2 /);
5029: my $result = &thaw_unescape($value);
5030: if (ref($result) eq 'HASH') {
5031: $returnhash{$key}=$result;
5032: } else {
1.921 raeburn 5033: my @responses = split(/:/,$value);
5034: my @items = ('description','inst_code','owner','type');
1.918 raeburn 5035: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 5036: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 5037: }
1.1008 raeburn 5038: }
1.353 www 5039: }
5040: }
5041: }
5042: }
5043: return %returnhash;
5044: }
5045:
1.1055 raeburn 5046: sub courselastaccess {
5047: my ($cdom,$cnum,$hostidref) = @_;
5048: my %returnhash;
5049: if ($cdom && $cnum) {
5050: my $chome = &homeserver($cnum,$cdom);
5051: if ($chome ne 'no_host') {
5052: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
5053: &extract_lastaccess(\%returnhash,$rep);
5054: }
5055: } else {
5056: if (!$cdom) { $cdom=''; }
5057: my %libserv = &all_library();
5058: foreach my $tryserver (keys(%libserv)) {
5059: if (ref($hostidref) eq 'ARRAY') {
5060: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
5061: }
5062: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
5063: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
5064: &extract_lastaccess(\%returnhash,$rep);
5065: }
5066: }
5067: }
5068: return %returnhash;
5069: }
5070:
5071: sub extract_lastaccess {
5072: my ($returnhash,$rep) = @_;
5073: if (ref($returnhash) eq 'HASH') {
5074: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
5075: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
5076: $rep eq '') {
5077: my @pairs=split(/\&/,$rep);
5078: foreach my $item (@pairs) {
5079: my ($key,$value)=split(/\=/,$item,2);
5080: $key = &unescape($key);
5081: next if ($key =~ /^error: 2 /);
5082: $returnhash->{$key} = &thaw_unescape($value);
5083: }
5084: }
5085: }
5086: return;
5087: }
5088:
1.658 raeburn 5089: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 5090:
5091: sub dcmailput {
1.685 raeburn 5092: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 5093: my $status = &Apache::lonnet::critical(
1.740 www 5094: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
5095: &escape($message),$server);
1.662 raeburn 5096: return $status;
5097: }
5098:
1.658 raeburn 5099: sub dcmaildump {
5100: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 5101: my %returnhash=();
1.846 albertel 5102:
5103: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 5104: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
5105: &escape($enddate).':';
5106: my @esc_senders=map { &escape($_)} @$senders;
5107: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 5108: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 5109: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 5110: if (($key) && ($value)) {
5111: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 5112: }
5113: }
5114: }
5115: return %returnhash;
5116: }
1.662 raeburn 5117: # ---------------------------------------------------------- Domain roles
5118:
5119: sub get_domain_roles {
5120: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 5121: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 5122: $startdate = '.';
5123: }
1.1018 raeburn 5124: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 5125: $enddate = '.';
5126: }
1.922 raeburn 5127: my $rolelist;
5128: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 5129: $rolelist = join('&',@{$roles});
1.922 raeburn 5130: }
1.662 raeburn 5131: my %personnel = ();
1.841 albertel 5132:
5133: my %servers = &get_servers($dom,'library');
5134: foreach my $tryserver (keys(%servers)) {
5135: %{$personnel{$tryserver}}=();
5136: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
5137: &escape($startdate).':'.
5138: &escape($enddate).':'.
5139: &escape($rolelist), $tryserver))) {
5140: my ($key,$value) = split(/\=/,$line,2);
5141: if (($key) && ($value)) {
5142: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
5143: }
5144: }
1.662 raeburn 5145: }
5146: return %personnel;
5147: }
1.658 raeburn 5148:
1.1332 raeburn 5149: sub get_active_domroles {
5150: my ($dom,$roles) = @_;
5151: return () unless (ref($roles) eq 'ARRAY');
5152: my $now = time;
5153: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
5154: my %domroles;
5155: foreach my $server (keys(%dompersonnel)) {
5156: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
5157: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
5158: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
5159: }
5160: }
5161: return %domroles;
5162: }
5163:
1.1057 www 5164: # ----------------------------------------------------------- Interval timing
1.149 www 5165:
1.1153 www 5166: {
5167: # Caches needed for speedup of navmaps
5168: # We don't want to cache this for very long at all (5 seconds at most)
5169: #
5170: # The user for whom we cache
5171: my $cachedkey='';
5172: # The cached times for this user
5173: my %cachedtimes=();
5174: # When this was last done
1.1282 raeburn 5175: my $cachedtime='';
1.1153 www 5176:
5177: sub load_all_first_access {
1.1308 raeburn 5178: my ($uname,$udom,$ignorecache)=@_;
1.1156 www 5179: if (($cachedkey eq $uname.':'.$udom) &&
1.1308 raeburn 5180: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
5181: (!$ignorecache)) {
1.1154 raeburn 5182: return;
5183: }
5184: $cachedtime=time;
5185: $cachedkey=$uname.':'.$udom;
5186: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 5187: }
5188:
1.504 albertel 5189: sub get_first_access {
1.1308 raeburn 5190: my ($type,$argsymb,$argmap,$ignorecache)=@_;
1.790 albertel 5191: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5192: if ($argsymb) { $symb=$argsymb; }
5193: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 5194: if ($argmap) { $map = $argmap; }
1.926 albertel 5195: if ($type eq 'course') {
5196: $res='course';
5197: } elsif ($type eq 'map') {
1.588 albertel 5198: $res=&symbread($map);
5199: } else {
5200: $res=$symb;
5201: }
1.1308 raeburn 5202: &load_all_first_access($uname,$udom,$ignorecache);
1.1153 www 5203: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 5204: }
5205:
5206: sub set_first_access {
1.1162 raeburn 5207: my ($type,$interval)=@_;
1.790 albertel 5208: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 5209: my ($map,$id,$res)=&decode_symb($symb);
1.928 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.1153 www 5217: $cachedkey='';
1.1162 raeburn 5218: my $firstaccess=&get_first_access($type,$symb,$map);
1.505 albertel 5219: if (!$firstaccess) {
1.1162 raeburn 5220: my $start = time;
5221: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
5222: $udom,$uname);
5223: if ($putres eq 'ok') {
5224: &put('timerinterval',{"$courseid\0$res"=>$interval},
5225: $udom,$uname);
5226: &appenv(
5227: {
5228: 'course.'.$courseid.'.firstaccess.'.$res => $start,
5229: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
5230: }
5231: );
5232: }
5233: return $putres;
1.505 albertel 5234: }
5235: return 'already_set';
1.504 albertel 5236: }
1.1153 www 5237: }
1.1282 raeburn 5238:
1.110 www 5239: # --------------------------------------------- Set Expire Date for Spreadsheet
5240:
5241: sub expirespread {
5242: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 5243: my $cid=$env{'request.course.id'};
1.110 www 5244: if ($cid) {
5245: my $now=time;
5246: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 5247: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
5248: $env{'course.'.$cid.'.num'}.
1.110 www 5249: ':nohist_expirationdates:'.
5250: &escape($key).'='.$now,
1.620 albertel 5251: $env{'course.'.$cid.'.home'})
1.110 www 5252: }
5253: return 'ok';
1.14 www 5254: }
5255:
1.109 www 5256: # ----------------------------------------------------- Devalidate Spreadsheets
5257:
5258: sub devalidate {
1.325 www 5259: my ($symb,$uname,$udom)=@_;
1.620 albertel 5260: my $cid=$env{'request.course.id'};
1.109 www 5261: if ($cid) {
1.391 matthew 5262: # delete the stored spreadsheets for
5263: # - the student level sheet of this user in course's homespace
5264: # - the assessment level sheet for this resource
5265: # for this user in user's homespace
1.553 albertel 5266: # - current conditional state info
1.325 www 5267: my $key=$uname.':'.$udom.':';
1.109 www 5268: my $status=
1.299 matthew 5269: &del('nohist_calculatedsheets',
1.391 matthew 5270: [$key.'studentcalc:'],
1.620 albertel 5271: $env{'course.'.$cid.'.domain'},
5272: $env{'course.'.$cid.'.num'})
1.133 albertel 5273: .' '.
5274: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 5275: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 5276: unless ($status eq 'ok ok') {
5277: &logthis('Could not devalidate spreadsheet '.
1.325 www 5278: $uname.' at '.$udom.' for '.
1.109 www 5279: $symb.': '.$status);
1.133 albertel 5280: }
1.553 albertel 5281: &delenv('user.state.'.$cid);
1.109 www 5282: }
5283: }
5284:
1.265 albertel 5285: sub get_scalar {
5286: my ($string,$end) = @_;
5287: my $value;
5288: if ($$string =~ s/^([^&]*?)($end)/$2/) {
5289: $value = $1;
5290: } elsif ($$string =~ s/^([^&]*?)&//) {
5291: $value = $1;
5292: }
5293: return &unescape($value);
5294: }
5295:
5296: sub array2str {
5297: my (@array) = @_;
5298: my $result=&arrayref2str(\@array);
5299: $result=~s/^__ARRAY_REF__//;
5300: $result=~s/__END_ARRAY_REF__$//;
5301: return $result;
5302: }
5303:
1.204 albertel 5304: sub arrayref2str {
5305: my ($arrayref) = @_;
1.265 albertel 5306: my $result='__ARRAY_REF__';
1.204 albertel 5307: foreach my $elem (@$arrayref) {
1.265 albertel 5308: if(ref($elem) eq 'ARRAY') {
5309: $result.=&arrayref2str($elem).'&';
5310: } elsif(ref($elem) eq 'HASH') {
5311: $result.=&hashref2str($elem).'&';
5312: } elsif(ref($elem)) {
5313: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 5314: } else {
5315: $result.=&escape($elem).'&';
5316: }
5317: }
5318: $result=~s/\&$//;
1.265 albertel 5319: $result .= '__END_ARRAY_REF__';
1.204 albertel 5320: return $result;
5321: }
5322:
1.168 albertel 5323: sub hash2str {
1.204 albertel 5324: my (%hash) = @_;
5325: my $result=&hashref2str(\%hash);
1.265 albertel 5326: $result=~s/^__HASH_REF__//;
5327: $result=~s/__END_HASH_REF__$//;
1.204 albertel 5328: return $result;
5329: }
5330:
5331: sub hashref2str {
5332: my ($hashref)=@_;
1.265 albertel 5333: my $result='__HASH_REF__';
1.800 albertel 5334: foreach my $key (sort(keys(%$hashref))) {
5335: if (ref($key) eq 'ARRAY') {
5336: $result.=&arrayref2str($key).'=';
5337: } elsif (ref($key) eq 'HASH') {
5338: $result.=&hashref2str($key).'=';
5339: } elsif (ref($key)) {
1.265 albertel 5340: $result.='=';
1.800 albertel 5341: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 5342: } else {
1.1132 raeburn 5343: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 5344: }
5345:
1.800 albertel 5346: if(ref($hashref->{$key}) eq 'ARRAY') {
5347: $result.=&arrayref2str($hashref->{$key}).'&';
5348: } elsif(ref($hashref->{$key}) eq 'HASH') {
5349: $result.=&hashref2str($hashref->{$key}).'&';
5350: } elsif(ref($hashref->{$key})) {
1.265 albertel 5351: $result.='&';
1.800 albertel 5352: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 5353: } else {
1.800 albertel 5354: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 5355: }
5356: }
1.168 albertel 5357: $result=~s/\&$//;
1.265 albertel 5358: $result .= '__END_HASH_REF__';
1.168 albertel 5359: return $result;
5360: }
5361:
5362: sub str2hash {
1.265 albertel 5363: my ($string)=@_;
5364: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
5365: return %$hash;
5366: }
5367:
5368: sub str2hashref {
1.168 albertel 5369: my ($string) = @_;
1.265 albertel 5370:
5371: my %hash;
5372:
5373: if($string !~ /^__HASH_REF__/) {
5374: if (! ($string eq '' || !defined($string))) {
5375: $hash{'error'}='Not hash reference';
5376: }
5377: return (\%hash, $string);
5378: }
5379:
5380: $string =~ s/^__HASH_REF__//;
5381:
5382: while($string !~ /^__END_HASH_REF__/) {
5383: #key
5384: my $key='';
5385: if($string =~ /^__HASH_REF__/) {
5386: ($key, $string)=&str2hashref($string);
5387: if(defined($key->{'error'})) {
5388: $hash{'error'}='Bad data';
5389: return (\%hash, $string);
5390: }
5391: } elsif($string =~ /^__ARRAY_REF__/) {
5392: ($key, $string)=&str2arrayref($string);
5393: if($key->[0] eq 'Array reference error') {
5394: $hash{'error'}='Bad data';
5395: return (\%hash, $string);
5396: }
5397: } else {
5398: $string =~ s/^(.*?)=//;
1.267 albertel 5399: $key=&unescape($1);
1.265 albertel 5400: }
5401: $string =~ s/^=//;
5402:
5403: #value
5404: my $value='';
5405: if($string =~ /^__HASH_REF__/) {
5406: ($value, $string)=&str2hashref($string);
5407: if(defined($value->{'error'})) {
5408: $hash{'error'}='Bad data';
5409: return (\%hash, $string);
5410: }
5411: } elsif($string =~ /^__ARRAY_REF__/) {
5412: ($value, $string)=&str2arrayref($string);
5413: if($value->[0] eq 'Array reference error') {
5414: $hash{'error'}='Bad data';
5415: return (\%hash, $string);
5416: }
5417: } else {
5418: $value=&get_scalar(\$string,'__END_HASH_REF__');
5419: }
5420: $string =~ s/^&//;
5421:
5422: $hash{$key}=$value;
1.204 albertel 5423: }
1.265 albertel 5424:
5425: $string =~ s/^__END_HASH_REF__//;
5426:
5427: return (\%hash, $string);
1.204 albertel 5428: }
5429:
5430: sub str2array {
1.265 albertel 5431: my ($string)=@_;
5432: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
5433: return @$array;
5434: }
5435:
5436: sub str2arrayref {
1.204 albertel 5437: my ($string) = @_;
1.265 albertel 5438: my @array;
5439:
5440: if($string !~ /^__ARRAY_REF__/) {
5441: if (! ($string eq '' || !defined($string))) {
5442: $array[0]='Array reference error';
5443: }
5444: return (\@array, $string);
5445: }
5446:
5447: $string =~ s/^__ARRAY_REF__//;
5448:
5449: while($string !~ /^__END_ARRAY_REF__/) {
5450: my $value='';
5451: if($string =~ /^__HASH_REF__/) {
5452: ($value, $string)=&str2hashref($string);
5453: if(defined($value->{'error'})) {
5454: $array[0] ='Array reference error';
5455: return (\@array, $string);
5456: }
5457: } elsif($string =~ /^__ARRAY_REF__/) {
5458: ($value, $string)=&str2arrayref($string);
5459: if($value->[0] eq 'Array reference error') {
5460: $array[0] ='Array reference error';
5461: return (\@array, $string);
5462: }
5463: } else {
5464: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5465: }
5466: $string =~ s/^&//;
5467:
5468: push(@array, $value);
1.191 harris41 5469: }
1.265 albertel 5470:
5471: $string =~ s/^__END_ARRAY_REF__//;
5472:
5473: return (\@array, $string);
1.168 albertel 5474: }
5475:
1.167 albertel 5476: # -------------------------------------------------------------------Temp Store
5477:
1.168 albertel 5478: sub tmpreset {
5479: my ($symb,$namespace,$domain,$stuname) = @_;
5480: if (!$symb) {
5481: $symb=&symbread();
1.620 albertel 5482: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5483: }
5484: $symb=escape($symb);
5485:
1.620 albertel 5486: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 5487: $namespace=~s/\//\_/g;
5488: $namespace=~s/\W//g;
5489:
1.620 albertel 5490: if (!$domain) { $domain=$env{'user.domain'}; }
5491: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5492: if ($domain eq 'public' && $stuname eq 'public') {
5493: $stuname=$ENV{'REMOTE_ADDR'};
5494: }
1.1117 foxr 5495: my $path=LONCAPA::tempdir();
1.168 albertel 5496: my %hash;
5497: if (tie(%hash,'GDBM_File',
5498: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5499: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 5500: foreach my $key (keys(%hash)) {
1.180 albertel 5501: if ($key=~ /:$symb/) {
1.168 albertel 5502: delete($hash{$key});
5503: }
5504: }
5505: }
5506: }
5507:
1.167 albertel 5508: sub tmpstore {
1.168 albertel 5509: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5510:
5511: if (!$symb) {
5512: $symb=&symbread();
1.620 albertel 5513: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5514: }
5515: $symb=escape($symb);
5516:
5517: if (!$namespace) {
5518: # I don't think we would ever want to store this for a course.
5519: # it seems this will only be used if we don't have a course.
1.620 albertel 5520: #$namespace=$env{'request.course.id'};
1.168 albertel 5521: #if (!$namespace) {
1.620 albertel 5522: $namespace=$env{'request.state'};
1.168 albertel 5523: #}
5524: }
5525: $namespace=~s/\//\_/g;
5526: $namespace=~s/\W//g;
1.620 albertel 5527: if (!$domain) { $domain=$env{'user.domain'}; }
5528: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5529: if ($domain eq 'public' && $stuname eq 'public') {
5530: $stuname=$ENV{'REMOTE_ADDR'};
5531: }
1.168 albertel 5532: my $now=time;
5533: my %hash;
1.1117 foxr 5534: my $path=LONCAPA::tempdir();
1.168 albertel 5535: if (tie(%hash,'GDBM_File',
5536: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5537: &GDBM_WRCREAT(),0640)) {
1.168 albertel 5538: $hash{"version:$symb"}++;
5539: my $version=$hash{"version:$symb"};
5540: my $allkeys='';
5541: foreach my $key (keys(%$storehash)) {
5542: $allkeys.=$key.':';
1.591 albertel 5543: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 5544: }
5545: $hash{"$version:$symb:timestamp"}=$now;
5546: $allkeys.='timestamp';
5547: $hash{"$version:keys:$symb"}=$allkeys;
5548: if (untie(%hash)) {
5549: return 'ok';
5550: } else {
5551: return "error:$!";
5552: }
5553: } else {
5554: return "error:$!";
5555: }
5556: }
1.167 albertel 5557:
1.168 albertel 5558: # -----------------------------------------------------------------Temp Restore
1.167 albertel 5559:
1.168 albertel 5560: sub tmprestore {
5561: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 5562:
1.168 albertel 5563: if (!$symb) {
5564: $symb=&symbread();
1.620 albertel 5565: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5566: }
5567: $symb=escape($symb);
5568:
1.620 albertel 5569: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 5570:
1.620 albertel 5571: if (!$domain) { $domain=$env{'user.domain'}; }
5572: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5573: if ($domain eq 'public' && $stuname eq 'public') {
5574: $stuname=$ENV{'REMOTE_ADDR'};
5575: }
1.168 albertel 5576: my %returnhash;
5577: $namespace=~s/\//\_/g;
5578: $namespace=~s/\W//g;
5579: my %hash;
1.1117 foxr 5580: my $path=LONCAPA::tempdir();
1.168 albertel 5581: if (tie(%hash,'GDBM_File',
5582: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5583: &GDBM_READER(),0640)) {
1.168 albertel 5584: my $version=$hash{"version:$symb"};
5585: $returnhash{'version'}=$version;
5586: my $scope;
5587: for ($scope=1;$scope<=$version;$scope++) {
5588: my $vkeys=$hash{"$scope:keys:$symb"};
5589: my @keys=split(/:/,$vkeys);
5590: my $key;
5591: $returnhash{"$scope:keys"}=$vkeys;
5592: foreach $key (@keys) {
1.591 albertel 5593: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5594: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 5595: }
5596: }
1.168 albertel 5597: if (!(untie(%hash))) {
5598: return "error:$!";
5599: }
5600: } else {
5601: return "error:$!";
5602: }
5603: return %returnhash;
1.167 albertel 5604: }
5605:
1.9 www 5606: # ----------------------------------------------------------------------- Store
5607:
5608: sub store {
1.1269 raeburn 5609: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5610: my $home='';
5611:
1.168 albertel 5612: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5613:
1.213 www 5614: $symb=&symbclean($symb);
1.122 albertel 5615: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5616:
1.620 albertel 5617: if (!$domain) { $domain=$env{'user.domain'}; }
5618: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5619:
5620: &devalidate($symb,$stuname,$domain);
1.109 www 5621:
5622: $symb=escape($symb);
1.187 www 5623: if (!$namespace) {
1.620 albertel 5624: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5625: return '';
5626: }
5627: }
1.620 albertel 5628: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5629:
5630: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5631: $$storehash{'host'}=$perlvar{'lonHostID'};
5632:
1.12 www 5633: my $namevalue='';
1.800 albertel 5634: foreach my $key (keys(%$storehash)) {
5635: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5636: }
1.12 www 5637: $namevalue=~s/\&$//;
1.187 www 5638: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269 raeburn 5639: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 5640: }
5641:
1.47 www 5642: # -------------------------------------------------------------- Critical Store
5643:
5644: sub cstore {
1.1269 raeburn 5645: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5646: my $home='';
5647:
1.168 albertel 5648: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5649:
1.213 www 5650: $symb=&symbclean($symb);
1.122 albertel 5651: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5652:
1.620 albertel 5653: if (!$domain) { $domain=$env{'user.domain'}; }
5654: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5655:
5656: &devalidate($symb,$stuname,$domain);
1.109 www 5657:
5658: $symb=escape($symb);
1.187 www 5659: if (!$namespace) {
1.620 albertel 5660: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5661: return '';
5662: }
5663: }
1.620 albertel 5664: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5665:
5666: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5667: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 5668:
1.47 www 5669: my $namevalue='';
1.800 albertel 5670: foreach my $key (keys(%$storehash)) {
5671: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5672: }
1.47 www 5673: $namevalue=~s/\&$//;
1.187 www 5674: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 5675: return critical
1.1269 raeburn 5676: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 5677: }
5678:
1.9 www 5679: # --------------------------------------------------------------------- Restore
5680:
5681: sub restore {
1.124 www 5682: my ($symb,$namespace,$domain,$stuname) = @_;
5683: my $home='';
5684:
1.168 albertel 5685: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5686:
1.122 albertel 5687: if (!$symb) {
1.1224 raeburn 5688: return if ($namespace eq 'courserequests');
5689: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 5690: } else {
1.1224 raeburn 5691: unless ($namespace eq 'courserequests') {
5692: $symb=&escape(&symbclean($symb));
5693: }
1.122 albertel 5694: }
1.188 www 5695: if (!$namespace) {
1.620 albertel 5696: unless ($namespace=$env{'request.course.id'}) {
1.188 www 5697: return '';
5698: }
5699: }
1.620 albertel 5700: if (!$domain) { $domain=$env{'user.domain'}; }
5701: if (!$stuname) { $stuname=$env{'user.name'}; }
5702: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 5703: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5704:
1.12 www 5705: my %returnhash=();
1.800 albertel 5706: foreach my $line (split(/\&/,$answer)) {
5707: my ($name,$value)=split(/\=/,$line);
1.591 albertel 5708: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 5709: }
1.75 www 5710: my $version;
5711: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 5712: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5713: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 5714: }
1.75 www 5715: }
1.13 www 5716: return %returnhash;
1.34 www 5717: }
5718:
5719: # ---------------------------------------------------------- Course Description
1.1118 foxr 5720: #
5721: #
1.34 www 5722:
5723: sub coursedescription {
1.731 albertel 5724: my ($courseid,$args)=@_;
1.34 www 5725: $courseid=~s/^\///;
1.49 www 5726: $courseid=~s/\_/\//g;
1.34 www 5727: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 5728: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 5729: my $normalid=$cdomain.'_'.$cnum;
5730: # need to always cache even if we get errors otherwise we keep
5731: # trying and trying and trying to get the course description.
5732: my %envhash=();
5733: my %returnhash=();
1.731 albertel 5734:
5735: my $expiretime=600;
5736: if ($env{'request.course.id'} eq $normalid) {
5737: $expiretime=120;
5738: }
5739:
5740: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5741: if (!$args->{'freshen_cache'}
5742: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5743: foreach my $key (keys(%env)) {
5744: next if ($key !~ /^\Q$prefix\E(.*)/);
5745: my ($setting) = $1;
5746: $returnhash{$setting} = $env{$key};
5747: }
5748: return %returnhash;
5749: }
5750:
1.1118 foxr 5751: # get the data again
5752:
1.731 albertel 5753: if (!$args->{'one_time'}) {
5754: $envhash{'course.'.$normalid.'.last_cache'}=time;
5755: }
1.811 albertel 5756:
1.34 www 5757: if ($chome ne 'no_host') {
1.302 albertel 5758: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 5759: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 5760: my $username = $env{'user.name'}; # Defult username
5761: if(defined $args->{'user'}) {
5762: $username = $args->{'user'};
5763: }
1.129 albertel 5764: $returnhash{'home'}= $chome;
5765: $returnhash{'domain'} = $cdomain;
5766: $returnhash{'num'} = $cnum;
1.741 raeburn 5767: if (!defined($returnhash{'type'})) {
5768: $returnhash{'type'} = 'Course';
5769: }
1.130 albertel 5770: while (my ($name,$value) = each %returnhash) {
1.53 www 5771: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 5772: }
1.270 www 5773: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 5774: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 5775: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 5776: $envhash{'course.'.$normalid.'.home'}=$chome;
5777: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5778: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 5779: }
5780: }
1.731 albertel 5781: if (!$args->{'one_time'}) {
1.949 raeburn 5782: &appenv(\%envhash);
1.731 albertel 5783: }
1.302 albertel 5784: return %returnhash;
1.461 www 5785: }
5786:
1.1080 raeburn 5787: sub update_released_required {
5788: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5789: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5790: $cid = $env{'request.course.id'};
5791: $cdom = $env{'course.'.$cid.'.domain'};
5792: $cnum = $env{'course.'.$cid.'.num'};
5793: $chome = $env{'course.'.$cid.'.home'};
5794: }
5795: if ($needsrelease) {
5796: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5797: my $needsupdate;
5798: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5799: $needsupdate = 1;
5800: } else {
5801: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5802: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5803: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5804: $needsupdate = 1;
5805: }
5806: }
5807: if ($needsupdate) {
5808: my %needshash = (
5809: 'internal.releaserequired' => $needsrelease,
5810: );
5811: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5812: if ($putresult eq 'ok') {
5813: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5814: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5815: if (ref($crsinfo{$cid}) eq 'HASH') {
5816: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5817: &courseidput($cdom,\%crsinfo,$chome,'notime');
5818: }
5819: }
5820: }
5821: }
5822: return;
5823: }
5824:
1.461 www 5825: # -------------------------------------------------See if a user is privileged
5826:
5827: sub privileged {
1.1219 raeburn 5828: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 5829: my $now = time;
1.1219 raeburn 5830: my $roles;
5831: if (ref($possroles) eq 'ARRAY') {
5832: $roles = $possroles;
5833: } else {
5834: $roles = ['dc','su'];
5835: }
5836: if (ref($possdomains) eq 'ARRAY') {
5837: my %privileged = &privileged_by_domain($possdomains,$roles);
5838: foreach my $dom (@{$possdomains}) {
5839: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5840: (ref($privileged{$dom}) eq 'HASH')) {
5841: foreach my $role (@{$roles}) {
5842: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5843: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5844: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5845: return 1 unless (($end && $end < $now) ||
5846: ($start && $start > $now));
5847: }
5848: }
5849: }
5850: }
5851: }
5852: } else {
5853: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5854: my $now = time;
1.1170 droeschl 5855:
1.1275 musolffc 5856: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 5857: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 5858: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 5859: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 5860: or ($tstart && $tstart > $now);
1.1170 droeschl 5861: }
1.1219 raeburn 5862: }
5863: }
5864: return 0;
5865: }
1.1170 droeschl 5866:
1.1219 raeburn 5867: sub privileged_by_domain {
5868: my ($domains,$roles) = @_;
5869: my %privileged = ();
5870: my $cachetime = 60*60*24;
5871: my $now = time;
5872: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5873: return %privileged;
5874: }
5875: foreach my $dom (@{$domains}) {
5876: next if (ref($privileged{$dom}) eq 'HASH');
5877: my $needroles;
5878: foreach my $role (@{$roles}) {
5879: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5880: if (defined($cached)) {
5881: if (ref($result) eq 'HASH') {
5882: $privileged{$dom}{$role} = $result;
5883: }
5884: } else {
5885: $needroles = 1;
5886: }
5887: }
5888: if ($needroles) {
5889: my %dompersonnel = &get_domain_roles($dom,$roles);
5890: $privileged{$dom} = {};
5891: foreach my $server (keys(%dompersonnel)) {
5892: if (ref($dompersonnel{$server}) eq 'HASH') {
5893: foreach my $item (keys(%{$dompersonnel{$server}})) {
5894: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5895: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5896: next if ($end && $end < $now);
5897: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5898: $dompersonnel{$server}{$item};
5899: }
5900: }
5901: }
5902: if (ref($privileged{$dom}) eq 'HASH') {
5903: foreach my $role (@{$roles}) {
5904: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5905: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5906: } else {
5907: my %hash = ();
5908: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5909: }
5910: }
5911: }
5912: }
5913: }
5914: return %privileged;
1.9 www 5915: }
1.1 albertel 5916:
1.103 harris41 5917: # -------------------------------------------------------- Get user privileges
1.11 www 5918:
5919: sub rolesinit {
1.1169 droeschl 5920: my ($domain, $username) = @_;
5921: my %userroles = ('user.login.time' => time);
5922: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5923:
5924: # firstaccess and timerinterval are related to timed maps/resources.
5925: # also, blocking can be triggered by an activating timer
5926: # it's saved in the user's %env.
5927: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5928: my %timerinterval = &dump('timerinterval', $domain, $username);
5929: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5930: %timerintchk, %timerintenv);
5931:
1.1162 raeburn 5932: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 5933: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 5934: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5935: }
1.1169 droeschl 5936:
1.1162 raeburn 5937: foreach my $key (keys(%timerinterval)) {
5938: my ($cid,$rest) = split(/\0/,$key);
5939: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5940: }
1.1169 droeschl 5941:
1.11 www 5942: my %allroles=();
1.1162 raeburn 5943: my %allgroups=();
1.11 www 5944:
1.1274 raeburn 5945: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 5946: my $role = $rolesdump{$area};
5947: $area =~ s/\_\w\w$//;
5948:
5949: my ($trole, $tend, $tstart, $group_privs);
5950:
5951: if ($role =~ /^cr/) {
5952: # Custom role, defined by a user
5953: # e.g., user.role.cr/msu/smith/mynewrole
5954: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5955: $trole = $1;
5956: ($tend, $tstart) = split('_', $2);
5957: } else {
5958: $trole = $role;
5959: }
5960: } elsif ($role =~ m|^gr/|) {
5961: # Role of member in a group, defined within a course/community
5962: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5963: ($trole, $tend, $tstart) = split(/_/, $role);
5964: next if $tstart eq '-1';
5965: ($trole, $group_privs) = split(/\//, $trole);
5966: $group_privs = &unescape($group_privs);
5967: } else {
5968: # Just a normal role, defined in roles.tab
5969: ($trole, $tend, $tstart) = split(/_/,$role);
5970: }
5971:
5972: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5973: $username);
5974: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5975:
5976: # role expired or not available yet?
5977: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5978: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5979:
5980: next if $area eq '' or $trole eq '';
5981:
5982: my $spec = "$trole.$area";
5983: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5984:
5985: if ($trole =~ /^cr\//) {
5986: # Custom role, defined by a user
5987: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5988: } elsif ($trole eq 'gr') {
5989: # Role of a member in a group, defined within a course/community
5990: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5991: next;
5992: } else {
5993: # Normal role, defined in roles.tab
5994: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5995: }
5996:
5997: my $cid = $tdomain.'_'.$trest;
5998: unless ($firstaccchk{$cid}) {
5999: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
6000: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
6001: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
6002: $coursetimerstarts{$cid}{$item};
6003: }
6004: }
6005: $firstaccchk{$cid} = 1;
6006: }
6007: unless ($timerintchk{$cid}) {
6008: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
6009: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
6010: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
6011: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 6012: }
1.12 www 6013: }
1.1169 droeschl 6014: $timerintchk{$cid} = 1;
1.191 harris41 6015: }
1.11 www 6016: }
1.1169 droeschl 6017:
1.1341 raeburn 6018: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
6019: \%allroles, \%allgroups);
1.1169 droeschl 6020: $env{'user.adv'} = $userroles{'user.adv'};
1.1341 raeburn 6021: $env{'user.rar'} = $userroles{'user.rar'};
1.1169 droeschl 6022:
1.1162 raeburn 6023: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 6024: }
6025:
1.567 raeburn 6026: sub set_arearole {
1.1215 raeburn 6027: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
6028: unless ($nolog) {
1.567 raeburn 6029: # log the associated role with the area
1.1215 raeburn 6030: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
6031: }
1.743 albertel 6032: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 6033: }
6034:
6035: sub custom_roleprivs {
6036: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
6037: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250 raeburn 6038: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 6039: if (&hostname($homsvr) ne '') {
1.567 raeburn 6040: my ($rdummy,$roledef)=
6041: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
6042: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
6043: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
6044: if (defined($syspriv)) {
1.1043 raeburn 6045: if ($trest =~ /^$match_community$/) {
6046: $syspriv =~ s/bre\&S//;
6047: }
1.567 raeburn 6048: $$allroles{'cm./'}.=':'.$syspriv;
6049: $$allroles{$spec.'./'}.=':'.$syspriv;
6050: }
6051: if ($tdomain ne '') {
6052: if (defined($dompriv)) {
6053: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
6054: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
6055: }
6056: if (($trest ne '') && (defined($coursepriv))) {
1.1332 raeburn 6057: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
6058: my $rolename = $1;
6059: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
6060: }
1.567 raeburn 6061: $$allroles{'cm.'.$area}.=':'.$coursepriv;
6062: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
6063: }
6064: }
6065: }
6066: }
6067: }
6068:
1.1332 raeburn 6069: sub course_adhocrole_privs {
6070: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
6071: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
6072: if ($overrides{"internal.adhocpriv.$rolename"}) {
6073: my (%currprivs,%storeprivs);
6074: foreach my $item (split(/:/,$coursepriv)) {
6075: my ($priv,$restrict) = split(/\&/,$item);
6076: $currprivs{$priv} = $restrict;
6077: }
6078: my (%possadd,%possremove,%full);
6079: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
6080: my ($priv,$restrict)=split(/\&/,$item);
6081: $full{$priv} = $restrict;
6082: }
6083: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
6084: next if ($item eq '');
6085: my ($rule,$rest) = split(/=/,$item);
6086: next unless (($rule eq 'off') || ($rule eq 'on'));
6087: foreach my $priv (split(/:/,$rest)) {
6088: if ($priv ne '') {
6089: if ($rule eq 'off') {
6090: $possremove{$priv} = 1;
6091: } else {
6092: $possadd{$priv} = 1;
6093: }
6094: }
6095: }
6096: }
6097: foreach my $priv (sort(keys(%full))) {
6098: if (exists($currprivs{$priv})) {
6099: unless (exists($possremove{$priv})) {
6100: $storeprivs{$priv} = $currprivs{$priv};
6101: }
6102: } elsif (exists($possadd{$priv})) {
6103: $storeprivs{$priv} = $full{$priv};
6104: }
6105: }
6106: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
6107: }
6108: return $coursepriv;
6109: }
6110:
1.678 raeburn 6111: sub group_roleprivs {
6112: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
6113: my $access = 1;
6114: my $now = time;
6115: if (($tend!=0) && ($tend<$now)) { $access = 0; }
6116: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
6117: if ($access) {
1.811 albertel 6118: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 6119: $$allgroups{$course}{$group} .=':'.$group_privs;
6120: }
6121: }
1.567 raeburn 6122:
6123: sub standard_roleprivs {
6124: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
6125: if (defined($pr{$trole.':s'})) {
6126: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
6127: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
6128: }
6129: if ($tdomain ne '') {
6130: if (defined($pr{$trole.':d'})) {
6131: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6132: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
6133: }
6134: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
6135: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
6136: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
6137: }
6138: }
6139: }
6140:
6141: sub set_userprivs {
1.1064 raeburn 6142: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 6143: my $author=0;
6144: my $adv=0;
1.1341 raeburn 6145: my $rar=0;
1.678 raeburn 6146: my %grouproles = ();
6147: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 6148: my @groupkeys;
1.1000 raeburn 6149: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 6150: push(@groupkeys,$role);
6151: }
6152: if (ref($groups_roles) eq 'HASH') {
6153: foreach my $key (keys(%{$groups_roles})) {
6154: unless (grep(/^\Q$key\E$/,@groupkeys)) {
6155: push(@groupkeys,$key);
6156: }
6157: }
6158: }
6159: if (@groupkeys > 0) {
6160: foreach my $role (@groupkeys) {
6161: my ($trole,$area,$sec,$extendedarea);
6162: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
6163: $trole = $1;
6164: $area = $2;
6165: $sec = $3;
6166: $extendedarea = $area.$sec;
6167: if (exists($$allgroups{$area})) {
6168: foreach my $group (keys(%{$$allgroups{$area}})) {
6169: my $spec = $trole.'.'.$extendedarea;
6170: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 6171: $$allgroups{$area}{$group};
1.1064 raeburn 6172: }
1.678 raeburn 6173: }
6174: }
6175: }
6176: }
6177: }
1.800 albertel 6178: foreach my $group (keys(%grouproles)) {
6179: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 6180: }
1.800 albertel 6181: foreach my $role (keys(%{$allroles})) {
6182: my %thesepriv;
1.941 raeburn 6183: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 6184: foreach my $item (split(/:/,$$allroles{$role})) {
6185: if ($item ne '') {
6186: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 6187: if ($restrictions eq '') {
6188: $thesepriv{$privilege}='F';
6189: } elsif ($thesepriv{$privilege} ne 'F') {
6190: $thesepriv{$privilege}.=$restrictions;
6191: }
6192: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1341 raeburn 6193: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567 raeburn 6194: }
6195: }
6196: my $thesestr='';
1.1104 raeburn 6197: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 6198: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
6199: }
6200: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 6201: }
1.1341 raeburn 6202: return ($author,$adv,$rar);
1.567 raeburn 6203: }
6204:
1.994 raeburn 6205: sub role_status {
1.1104 raeburn 6206: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 6207: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250 raeburn 6208: my ($one,$two) = split(m{\./},$rolekey,2);
6209: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 6210: unless (!defined($$role) || $$role eq '') {
1.1251 raeburn 6211: $$where = '/'.$two;
1.994 raeburn 6212: $$trolecode=$$role.'.'.$$where;
6213: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
6214: $$tstatus='is';
1.1104 raeburn 6215: if ($$tstart && $$tstart>$update) {
1.994 raeburn 6216: $$tstatus='future';
1.1034 raeburn 6217: if ($$tstart<$now) {
6218: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 6219: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 6220: my (%allroles,%allgroups,$group_privs,
6221: %groups_roles,@rolecodes);
1.1002 raeburn 6222: my %userroles = (
6223: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
6224: );
1.1064 raeburn 6225: @rolecodes = ('cm');
1.1002 raeburn 6226: my $spec=$$role.'.'.$$where;
6227: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
6228: if ($$role =~ /^cr\//) {
6229: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 6230: push(@rolecodes,'cr');
1.1002 raeburn 6231: } elsif ($$role eq 'gr') {
1.1064 raeburn 6232: push(@rolecodes,$$role);
1.1002 raeburn 6233: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
6234: $env{'user.name'});
1.1064 raeburn 6235: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 6236: (undef,my $group_privs) = split(/\//,$trole);
6237: $group_privs = &unescape($group_privs);
6238: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 6239: 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 6240: &get_groups_roles($tdomain,$trest,
6241: \%course_roles,\@rolecodes,
6242: \%groups_roles);
1.1002 raeburn 6243: } else {
1.1064 raeburn 6244: push(@rolecodes,$$role);
1.1002 raeburn 6245: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
6246: }
1.1341 raeburn 6247: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
6248: \%groups_roles);
1.1064 raeburn 6249: &appenv(\%userroles,\@rolecodes);
1.1342 raeburn 6250: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002 raeburn 6251: }
6252: }
1.1034 raeburn 6253: $$tstatus = 'is';
1.1002 raeburn 6254: }
1.994 raeburn 6255: }
6256: if ($$tend) {
1.1104 raeburn 6257: if ($$tend<$update) {
1.994 raeburn 6258: $$tstatus='expired';
6259: } elsif ($$tend<$now) {
6260: $$tstatus='will_not';
6261: }
6262: }
6263: }
6264: }
6265: }
6266:
1.1104 raeburn 6267: sub get_groups_roles {
6268: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
6269: return unless((ref($cdom_courseroles) eq 'HASH') &&
6270: (ref($rolecodes) eq 'ARRAY') &&
6271: (ref($groups_roles) eq 'HASH'));
6272: if (keys(%{$cdom_courseroles}) > 0) {
6273: my ($cnum) = ($rest =~ /^($match_courseid)/);
6274: if ($cdom ne '' && $cnum ne '') {
6275: foreach my $key (keys(%{$cdom_courseroles})) {
6276: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
6277: my $crsrole = $1;
6278: my $crssec = $2;
6279: if ($crsrole =~ /^cr/) {
6280: unless (grep(/^cr$/,@{$rolecodes})) {
6281: push(@{$rolecodes},'cr');
6282: }
6283: } else {
6284: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
6285: push(@{$rolecodes},$crsrole);
6286: }
6287: }
6288: my $rolekey = "$crsrole./$cdom/$cnum";
6289: if ($crssec ne '') {
6290: $rolekey .= "/$crssec";
6291: }
6292: $rolekey .= './';
6293: $groups_roles->{$rolekey} = $rolecodes;
6294: }
6295: }
6296: }
6297: }
6298: return;
6299: }
6300:
6301: sub delete_env_groupprivs {
6302: my ($where,$courseroles,$possroles) = @_;
6303: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
6304: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
6305: unless (ref($courseroles->{$udom}) eq 'HASH') {
6306: %{$courseroles->{$udom}} =
6307: &get_my_roles('','','userroles',['active'],
6308: $possroles,[$udom],1);
6309: }
6310: if (ref($courseroles->{$udom}) eq 'HASH') {
6311: foreach my $item (keys(%{$courseroles->{$udom}})) {
6312: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
6313: my $area = '/'.$cdom.'/'.$cnum;
6314: my $privkey = "user.priv.$crsrole.$area";
6315: if ($crssec ne '') {
6316: $privkey .= '/'.$crssec;
6317: }
6318: $privkey .= ".$area/$group";
6319: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
6320: }
6321: }
6322: return;
6323: }
6324:
1.994 raeburn 6325: sub check_adhoc_privs {
1.1329 raeburn 6326: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 6327: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1329 raeburn 6328: if ($sec) {
6329: $cckey .= '/'.$sec;
6330: }
1.1185 raeburn 6331: my $setprivs;
1.994 raeburn 6332: if ($env{$cckey}) {
6333: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 6334: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 6335: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1329 raeburn 6336: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 6337: $setprivs = 1;
1.994 raeburn 6338: }
6339: } else {
1.1330 raeburn 6340: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 6341: $setprivs = 1;
1.994 raeburn 6342: }
1.1185 raeburn 6343: return $setprivs;
1.994 raeburn 6344: }
6345:
6346: sub set_adhoc_privileges {
1.1326 raeburn 6347: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1329 raeburn 6348: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 6349: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1329 raeburn 6350: if ($sec ne '') {
6351: $area .= '/'.$sec;
6352: }
1.994 raeburn 6353: my $spec = $role.'.'.$area;
6354: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 6355: $env{'user.name'},1);
1.1326 raeburn 6356: my %rolehash = ();
1.1332 raeburn 6357: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
6358: my $rolename = $1;
1.1326 raeburn 6359: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1332 raeburn 6360: my %domdef = &get_domain_defaults($dcdom);
6361: if (ref($domdef{'adhocroles'}) eq 'HASH') {
6362: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
6363: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
6364: }
6365: }
1.1326 raeburn 6366: } else {
6367: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
6368: }
1.1341 raeburn 6369: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 6370: &appenv(\%userroles,[$role,'cm']);
1.1342 raeburn 6371: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1088 raeburn 6372: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
6373: &appenv( {'request.role' => $spec,
6374: 'request.role.domain' => $dcdom,
1.1332 raeburn 6375: 'request.course.sec' => $sec,
1.1088 raeburn 6376: }
6377: );
6378: my $tadv=0;
6379: if (&allowed('adv') eq 'F') { $tadv=1; }
6380: &appenv({'request.role.adv' => $tadv});
6381: }
1.994 raeburn 6382: }
6383:
1.12 www 6384: # --------------------------------------------------------------- get interface
6385:
6386: sub get {
1.131 albertel 6387: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6388: my $items='';
1.800 albertel 6389: foreach my $item (@$storearr) {
6390: $items.=&escape($item).'&';
1.191 harris41 6391: }
1.12 www 6392: $items=~s/\&$//;
1.620 albertel 6393: if (!$udomain) { $udomain=$env{'user.domain'}; }
6394: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 6395: my $uhome=&homeserver($uname,$udomain);
6396:
1.133 albertel 6397: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6398: my @pairs=split(/\&/,$rep);
1.273 albertel 6399: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
6400: return @pairs;
6401: }
1.15 www 6402: my %returnhash=();
1.42 www 6403: my $i=0;
1.800 albertel 6404: foreach my $item (@$storearr) {
6405: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6406: $i++;
1.191 harris41 6407: }
1.15 www 6408: return %returnhash;
1.27 www 6409: }
6410:
6411: # --------------------------------------------------------------- del interface
6412:
6413: sub del {
1.133 albertel 6414: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 6415: my $items='';
1.800 albertel 6416: foreach my $item (@$storearr) {
6417: $items.=&escape($item).'&';
1.191 harris41 6418: }
1.984 neumanie 6419:
1.27 www 6420: $items=~s/\&$//;
1.620 albertel 6421: if (!$udomain) { $udomain=$env{'user.domain'}; }
6422: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6423: my $uhome=&homeserver($uname,$udomain);
6424: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6425: }
6426:
6427: # -------------------------------------------------------------- dump interface
6428:
1.1180 droeschl 6429: sub unserialize {
6430: my ($rep, $escapedkeys) = @_;
6431:
6432: return {} if $rep =~ /^error/;
6433:
6434: my %returnhash=();
1.1252 raeburn 6435: foreach my $item (split(/\&/,$rep)) {
1.1180 droeschl 6436: my ($key, $value) = split(/=/, $item, 2);
6437: $key = unescape($key) unless $escapedkeys;
6438: next if $key =~ /^error: 2 /;
1.1252 raeburn 6439: $returnhash{$key} = &thaw_unescape($value);
1.1180 droeschl 6440: }
6441: #return %returnhash;
6442: return \%returnhash;
6443: }
6444:
6445: # see Lond::dump_with_regexp
6446: # if $escapedkeys hash keys won't get unescaped.
1.15 www 6447: sub dump {
1.1180 droeschl 6448: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755 albertel 6449: if (!$udomain) { $udomain=$env{'user.domain'}; }
6450: if (!$uname) { $uname=$env{'user.name'}; }
6451: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 6452:
1.1266 raeburn 6453: if ($regexp) {
6454: $regexp=&escape($regexp);
6455: } else {
6456: $regexp='.';
6457: }
1.1180 droeschl 6458: if (grep { $_ eq $uhome } current_machine_ids()) {
6459: # user is hosted on this machine
1.1266 raeburn 6460: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 6461: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 6462: return %{unserialize($reply, $escapedkeys)};
6463: }
1.1166 raeburn 6464: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 6465: my @pairs=split(/\&/,$rep);
6466: my %returnhash=();
1.1098 foxr 6467: if (!($rep =~ /^error/ )) {
6468: foreach my $item (@pairs) {
6469: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 6470: $key = unescape($key) unless $escapedkeys;
6471: #$key = &unescape($key);
1.1098 foxr 6472: next if ($key =~ /^error: 2 /);
6473: $returnhash{$key}=&thaw_unescape($value);
6474: }
1.755 albertel 6475: }
6476: return %returnhash;
1.407 www 6477: }
6478:
1.1098 foxr 6479:
1.717 albertel 6480: # --------------------------------------------------------- dumpstore interface
6481:
6482: sub dumpstore {
6483: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 6484: # same as dump but keys must be escaped. They may contain colon separated
6485: # lists of values that may themself contain colons (e.g. symbs).
6486: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 6487: }
6488:
1.407 www 6489: # -------------------------------------------------------------- keys interface
6490:
6491: sub getkeys {
6492: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 6493: if (!$udomain) { $udomain=$env{'user.domain'}; }
6494: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 6495: my $uhome=&homeserver($uname,$udomain);
6496: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
6497: my @keyarray=();
1.800 albertel 6498: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 6499: next if ($key =~ /^error: 2 /);
1.800 albertel 6500: push(@keyarray,&unescape($key));
1.407 www 6501: }
6502: return @keyarray;
1.318 matthew 6503: }
6504:
1.319 matthew 6505: # --------------------------------------------------------------- currentdump
6506: sub currentdump {
1.328 matthew 6507: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 6508: $courseid = $env{'request.course.id'} if (! defined($courseid));
6509: $sdom = $env{'user.domain'} if (! defined($sdom));
6510: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 6511: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 6512: my $rep;
6513:
6514: if (grep { $_ eq $uhome } current_machine_ids()) {
6515: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
6516: $courseid)));
6517: } else {
6518: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
6519: }
6520:
1.318 matthew 6521: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 6522: #
1.318 matthew 6523: my %returnhash=();
1.319 matthew 6524: #
1.1343 raeburn 6525: if ($rep eq 'unknown_cmd') {
1.319 matthew 6526: # an old lond will not know currentdump
6527: # Do a dump and make it look like a currentdump
1.822 albertel 6528: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 6529: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6530: my %hash = @tmp;
6531: @tmp=();
1.424 matthew 6532: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 6533: } else {
6534: my @pairs=split(/\&/,$rep);
1.800 albertel 6535: foreach my $pair (@pairs) {
6536: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 6537: my ($symb,$param) = split(/:/,$key);
6538: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 6539: &thaw_unescape($value);
1.319 matthew 6540: }
1.191 harris41 6541: }
1.12 www 6542: return %returnhash;
1.424 matthew 6543: }
6544:
6545: sub convert_dump_to_currentdump{
6546: my %hash = %{shift()};
6547: my %returnhash;
6548: # Code ripped from lond, essentially. The only difference
6549: # here is the unescaping done by lonnet::dump(). Conceivably
6550: # we might run in to problems with parameter names =~ /^v\./
6551: while (my ($key,$value) = each(%hash)) {
6552: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 6553: $symb = &unescape($symb);
6554: $param = &unescape($param);
1.424 matthew 6555: next if ($v eq 'version' || $symb eq 'keys');
6556: next if (exists($returnhash{$symb}) &&
6557: exists($returnhash{$symb}->{$param}) &&
6558: $returnhash{$symb}->{'v.'.$param} > $v);
6559: $returnhash{$symb}->{$param}=$value;
6560: $returnhash{$symb}->{'v.'.$param}=$v;
6561: }
6562: #
6563: # Remove all of the keys in the hashes which keep track of
6564: # the version of the parameter.
6565: while (my ($symb,$param_hash) = each(%returnhash)) {
6566: # use a foreach because we are going to delete from the hash.
6567: foreach my $key (keys(%$param_hash)) {
6568: delete($param_hash->{$key}) if ($key =~ /^v\./);
6569: }
6570: }
6571: return \%returnhash;
1.12 www 6572: }
6573:
1.627 albertel 6574: # ------------------------------------------------------ critical inc interface
6575:
6576: sub cinc {
6577: return &inc(@_,'critical');
6578: }
6579:
1.449 matthew 6580: # --------------------------------------------------------------- inc interface
6581:
6582: sub inc {
1.627 albertel 6583: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 6584: if (!$udomain) { $udomain=$env{'user.domain'}; }
6585: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 6586: my $uhome=&homeserver($uname,$udomain);
6587: my $items='';
6588: if (! ref($store)) {
6589: # got a single value, so use that instead
6590: $items = &escape($store).'=&';
6591: } elsif (ref($store) eq 'SCALAR') {
6592: $items = &escape($$store).'=&';
6593: } elsif (ref($store) eq 'ARRAY') {
6594: $items = join('=&',map {&escape($_);} @{$store});
6595: } elsif (ref($store) eq 'HASH') {
6596: while (my($key,$value) = each(%{$store})) {
6597: $items.= &escape($key).'='.&escape($value).'&';
6598: }
6599: }
6600: $items=~s/\&$//;
1.627 albertel 6601: if ($critical) {
6602: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6603: } else {
6604: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6605: }
1.449 matthew 6606: }
6607:
1.12 www 6608: # --------------------------------------------------------------- put interface
6609:
6610: sub put {
1.134 albertel 6611: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6612: if (!$udomain) { $udomain=$env{'user.domain'}; }
6613: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6614: my $uhome=&homeserver($uname,$udomain);
1.12 www 6615: my $items='';
1.800 albertel 6616: foreach my $item (keys(%$storehash)) {
6617: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6618: }
1.12 www 6619: $items=~s/\&$//;
1.134 albertel 6620: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 6621: }
6622:
1.631 albertel 6623: # ------------------------------------------------------------ newput interface
6624:
6625: sub newput {
6626: my ($namespace,$storehash,$udomain,$uname)=@_;
6627: if (!$udomain) { $udomain=$env{'user.domain'}; }
6628: if (!$uname) { $uname=$env{'user.name'}; }
6629: my $uhome=&homeserver($uname,$udomain);
6630: my $items='';
6631: foreach my $key (keys(%$storehash)) {
6632: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6633: }
6634: $items=~s/\&$//;
6635: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6636: }
6637:
6638: # --------------------------------------------------------- putstore interface
6639:
1.524 raeburn 6640: sub putstore {
1.1269 raeburn 6641: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 6642: if (!$udomain) { $udomain=$env{'user.domain'}; }
6643: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 6644: my $uhome=&homeserver($uname,$udomain);
6645: my $items='';
1.715 albertel 6646: foreach my $key (keys(%$storehash)) {
6647: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 6648: }
1.715 albertel 6649: $items=~s/\&$//;
1.716 albertel 6650: my $esc_symb=&escape($symb);
6651: my $esc_v=&escape($version);
1.715 albertel 6652: my $reply =
1.716 albertel 6653: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 6654: $uhome);
1.1269 raeburn 6655: if (($tolog) && ($reply eq 'ok')) {
6656: my $namevalue='';
6657: foreach my $key (keys(%{$storehash})) {
6658: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6659: }
6660: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6661: '&host='.&escape($perlvar{'lonHostID'}).
6662: '&version='.$esc_v.
6663: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6664: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6665: }
1.715 albertel 6666: if ($reply eq 'unknown_cmd') {
1.716 albertel 6667: # gfall back to way things use to be done
1.715 albertel 6668: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6669: $uname);
1.524 raeburn 6670: }
1.715 albertel 6671: return $reply;
6672: }
6673:
6674: sub old_putstore {
1.716 albertel 6675: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6676: if (!$udomain) { $udomain=$env{'user.domain'}; }
6677: if (!$uname) { $uname=$env{'user.name'}; }
6678: my $uhome=&homeserver($uname,$udomain);
6679: my %newstorehash;
1.800 albertel 6680: foreach my $item (keys(%$storehash)) {
6681: my $key = $version.':'.&escape($symb).':'.$item;
6682: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 6683: }
6684: my $items='';
6685: my %allitems = ();
1.800 albertel 6686: foreach my $item (keys(%newstorehash)) {
6687: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 6688: my $key = $1.':keys:'.$2;
6689: $allitems{$key} .= $3.':';
6690: }
1.800 albertel 6691: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 6692: }
1.800 albertel 6693: foreach my $item (keys(%allitems)) {
6694: $allitems{$item} =~ s/\:$//;
6695: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 6696: }
6697: $items=~s/\&$//;
6698: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 6699: }
6700:
1.47 www 6701: # ------------------------------------------------------ critical put interface
6702:
6703: sub cput {
1.134 albertel 6704: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6705: if (!$udomain) { $udomain=$env{'user.domain'}; }
6706: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6707: my $uhome=&homeserver($uname,$udomain);
1.47 www 6708: my $items='';
1.800 albertel 6709: foreach my $item (keys(%$storehash)) {
6710: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6711: }
1.47 www 6712: $items=~s/\&$//;
1.134 albertel 6713: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6714: }
6715:
6716: # -------------------------------------------------------------- eget interface
6717:
6718: sub eget {
1.133 albertel 6719: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6720: my $items='';
1.800 albertel 6721: foreach my $item (@$storearr) {
6722: $items.=&escape($item).'&';
1.191 harris41 6723: }
1.12 www 6724: $items=~s/\&$//;
1.620 albertel 6725: if (!$udomain) { $udomain=$env{'user.domain'}; }
6726: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6727: my $uhome=&homeserver($uname,$udomain);
6728: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6729: my @pairs=split(/\&/,$rep);
6730: my %returnhash=();
1.42 www 6731: my $i=0;
1.800 albertel 6732: foreach my $item (@$storearr) {
6733: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6734: $i++;
1.191 harris41 6735: }
1.12 www 6736: return %returnhash;
6737: }
6738:
1.667 albertel 6739: # ------------------------------------------------------------ tmpput interface
6740: sub tmpput {
1.802 raeburn 6741: my ($storehash,$server,$context)=@_;
1.667 albertel 6742: my $items='';
1.800 albertel 6743: foreach my $item (keys(%$storehash)) {
6744: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 6745: }
6746: $items=~s/\&$//;
1.802 raeburn 6747: if (defined($context)) {
6748: $items .= ':'.&escape($context);
6749: }
1.667 albertel 6750: return &reply("tmpput:$items",$server);
6751: }
6752:
6753: # ------------------------------------------------------------ tmpget interface
6754: sub tmpget {
1.688 albertel 6755: my ($token,$server)=@_;
6756: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6757: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 6758: my %returnhash;
1.1328 raeburn 6759: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
6760: return %returnhash;
6761: }
1.667 albertel 6762: foreach my $item (split(/\&/,$rep)) {
6763: my ($key,$value)=split(/=/,$item);
6764: $returnhash{&unescape($key)}=&thaw_unescape($value);
6765: }
6766: return %returnhash;
6767: }
6768:
1.1113 raeburn 6769: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 6770: sub tmpdel {
6771: my ($token,$server)=@_;
6772: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6773: return &reply("tmpdel:$token",$server);
6774: }
6775:
1.1198 raeburn 6776: # ------------------------------------------------------------ get_timebased_id
6777:
6778: sub get_timebased_id {
6779: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6780: $maxtries) = @_;
6781: my ($newid,$error,$dellock);
6782: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6783: return ('','ok','invalid call to get suffix');
6784: }
6785:
6786: # set defaults for any optional args for which values were not supplied
6787: if ($who eq '') {
6788: $who = $env{'user.name'}.':'.$env{'user.domain'};
6789: }
6790: if (!$locktries) {
6791: $locktries = 3;
6792: }
6793: if (!$maxtries) {
6794: $maxtries = 10;
6795: }
6796:
6797: if (($cdom eq '') || ($cnum eq '')) {
6798: if ($env{'request.course.id'}) {
6799: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6800: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6801: }
6802: if (($cdom eq '') || ($cnum eq '')) {
6803: return ('','ok','call to get suffix not in course context');
6804: }
6805: }
6806:
6807: # construct locking item
6808: my $lockhash = {
6809: $prefix."\0".'locked_'.$keyid => $who,
6810: };
6811: my $tries = 0;
6812:
6813: # attempt to get lock on nohist_$namespace file
6814: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6815: while (($gotlock ne 'ok') && $tries <$locktries) {
6816: $tries ++;
6817: sleep 1;
6818: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6819: }
6820:
6821: # attempt to get unique identifier, based on current timestamp
6822: if ($gotlock eq 'ok') {
6823: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6824: my $id = time;
6825: $newid = $id;
1.1268 raeburn 6826: if ($idtype eq 'addcode') {
6827: $newid .= &sixnum_code();
6828: }
1.1198 raeburn 6829: my $idtries = 0;
6830: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6831: if ($idtype eq 'concat') {
6832: $newid = $id.$idtries;
1.1268 raeburn 6833: } elsif ($idtype eq 'addcode') {
6834: $newid = $newid.&sixnum_code();
1.1198 raeburn 6835: } else {
6836: $newid ++;
6837: }
6838: $idtries ++;
6839: }
6840: if (!exists($inuse{$prefix."\0".$newid})) {
6841: my %new_item = (
6842: $prefix."\0".$newid => $who,
6843: );
6844: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6845: $cdom,$cnum);
6846: if ($putresult ne 'ok') {
6847: undef($newid);
6848: $error = 'error saving new item: '.$putresult;
6849: }
6850: } else {
1.1268 raeburn 6851: undef($newid);
1.1198 raeburn 6852: $error = ('error: no unique suffix available for the new item ');
6853: }
6854: # remove lock
6855: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6856: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6857: } else {
6858: $error = "error: could not obtain lockfile\n";
6859: $dellock = 'ok';
1.1276 raeburn 6860: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6861: $dellock = 'nolock';
6862: }
1.1198 raeburn 6863: }
6864: return ($newid,$dellock,$error);
6865: }
6866:
1.1268 raeburn 6867: sub sixnum_code {
6868: my $code;
6869: for (0..6) {
6870: $code .= int( rand(9) );
6871: }
6872: return $code;
6873: }
6874:
1.765 albertel 6875: # -------------------------------------------------- portfolio access checking
6876:
6877: sub portfolio_access {
1.1270 raeburn 6878: my ($requrl,$clientip) = @_;
1.765 albertel 6879: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270 raeburn 6880: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 6881: if ($result) {
6882: my %setters;
6883: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6884: my ($startblock,$endblock) =
6885: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6886: if ($startblock && $endblock) {
6887: return 'B';
6888: }
6889: } else {
6890: my ($startblock,$endblock) =
6891: &Apache::loncommon::blockcheck(\%setters,'port');
6892: if ($startblock && $endblock) {
6893: return 'B';
6894: }
6895: }
6896: }
1.765 albertel 6897: if ($result eq 'ok') {
1.766 albertel 6898: return 'F';
1.765 albertel 6899: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 6900: return 'A';
1.765 albertel 6901: }
1.766 albertel 6902: return '';
1.765 albertel 6903: }
6904:
6905: sub get_portfolio_access {
1.1270 raeburn 6906: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 6907:
6908: if (!ref($access_hash)) {
6909: my $current_perms = &get_portfile_permissions($udom,$unum);
6910: my %access_controls = &get_access_controls($current_perms,$group,
6911: $file_name);
6912: $access_hash = $access_controls{$file_name};
6913: }
6914:
1.1270 raeburn 6915: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 6916: my $now = time;
6917: if (ref($access_hash) eq 'HASH') {
6918: foreach my $key (keys(%{$access_hash})) {
6919: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6920: if ($start > $now) {
6921: next;
6922: }
6923: if ($end && $end<$now) {
6924: next;
6925: }
6926: if ($scope eq 'public') {
6927: $public = $key;
6928: last;
6929: } elsif ($scope eq 'guest') {
6930: $guest = $key;
6931: } elsif ($scope eq 'domains') {
6932: push(@domains,$key);
6933: } elsif ($scope eq 'users') {
6934: push(@users,$key);
6935: } elsif ($scope eq 'course') {
6936: push(@courses,$key);
6937: } elsif ($scope eq 'group') {
6938: push(@groups,$key);
1.1270 raeburn 6939: } elsif ($scope eq 'ip') {
6940: push(@ips,$key);
1.765 albertel 6941: }
6942: }
6943: if ($public) {
6944: return 'ok';
1.1270 raeburn 6945: } elsif (@ips > 0) {
6946: my $allowed;
6947: foreach my $ipkey (@ips) {
6948: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6949: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6950: $allowed = 1;
6951: last;
6952: }
6953: }
6954: }
6955: if ($allowed) {
6956: return 'ok';
6957: }
1.765 albertel 6958: }
6959: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6960: if ($guest) {
6961: return $guest;
6962: }
6963: } else {
6964: if (@domains > 0) {
6965: foreach my $domkey (@domains) {
6966: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6967: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6968: return 'ok';
6969: }
6970: }
6971: }
6972: }
6973: if (@users > 0) {
6974: foreach my $userkey (@users) {
1.865 raeburn 6975: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6976: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6977: if (ref($item) eq 'HASH') {
6978: if (($item->{'uname'} eq $env{'user.name'}) &&
6979: ($item->{'udom'} eq $env{'user.domain'})) {
6980: return 'ok';
6981: }
6982: }
6983: }
6984: }
1.765 albertel 6985: }
6986: }
6987: my %roleshash;
6988: my @courses_and_groups = @courses;
6989: push(@courses_and_groups,@groups);
6990: if (@courses_and_groups > 0) {
6991: my (%allgroups,%allroles);
6992: my ($start,$end,$role,$sec,$group);
6993: foreach my $envkey (%env) {
1.1060 raeburn 6994: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6995: my $cid = $2.'_'.$3;
6996: if ($1 eq 'gr') {
6997: $group = $4;
6998: $allgroups{$cid}{$group} = $env{$envkey};
6999: } else {
7000: if ($4 eq '') {
7001: $sec = 'none';
7002: } else {
7003: $sec = $4;
7004: }
7005: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7006: }
1.811 albertel 7007: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 7008: my $cid = $2.'_'.$3;
7009: if ($4 eq '') {
7010: $sec = 'none';
7011: } else {
7012: $sec = $4;
7013: }
7014: $allroles{$cid}{$1}{$sec} = $env{$envkey};
7015: }
7016: }
7017: if (keys(%allroles) == 0) {
7018: return;
7019: }
7020: foreach my $key (@courses_and_groups) {
7021: my %content = %{$$access_hash{$key}};
7022: my $cnum = $content{'number'};
7023: my $cdom = $content{'domain'};
7024: my $cid = $cdom.'_'.$cnum;
7025: if (!exists($allroles{$cid})) {
7026: next;
7027: }
7028: foreach my $role_id (keys(%{$content{'roles'}})) {
7029: my @sections = @{$content{'roles'}{$role_id}{'section'}};
7030: my @groups = @{$content{'roles'}{$role_id}{'group'}};
7031: my @status = @{$content{'roles'}{$role_id}{'access'}};
7032: my @roles = @{$content{'roles'}{$role_id}{'role'}};
7033: foreach my $role (keys(%{$allroles{$cid}})) {
7034: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
7035: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
7036: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
7037: if (grep/^all$/,@sections) {
7038: return 'ok';
7039: } else {
7040: if (grep/^$sec$/,@sections) {
7041: return 'ok';
7042: }
7043: }
7044: }
7045: }
7046: if (keys(%{$allgroups{$cid}}) == 0) {
7047: if (grep/^none$/,@groups) {
7048: return 'ok';
7049: }
7050: } else {
7051: if (grep/^all$/,@groups) {
7052: return 'ok';
7053: }
7054: foreach my $group (keys(%{$allgroups{$cid}})) {
7055: if (grep/^$group$/,@groups) {
7056: return 'ok';
7057: }
7058: }
7059: }
7060: }
7061: }
7062: }
7063: }
7064: }
7065: if ($guest) {
7066: return $guest;
7067: }
7068: }
7069: }
7070: return;
7071: }
7072:
7073: sub course_group_datechecker {
7074: my ($dates,$now,$status) = @_;
7075: my ($start,$end) = split(/\./,$dates);
7076: if (!$start && !$end) {
7077: return 'ok';
7078: }
7079: if (grep/^active$/,@{$status}) {
7080: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
7081: return 'ok';
7082: }
7083: }
7084: if (grep/^previous$/,@{$status}) {
7085: if ($end > $now ) {
7086: return 'ok';
7087: }
7088: }
7089: if (grep/^future$/,@{$status}) {
7090: if ($start > $now) {
7091: return 'ok';
7092: }
7093: }
7094: return;
7095: }
7096:
7097: sub parse_portfolio_url {
7098: my ($url) = @_;
7099:
7100: my ($type,$udom,$unum,$group,$file_name);
7101:
1.823 albertel 7102: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 7103: $type = 1;
7104: $udom = $1;
7105: $unum = $2;
7106: $file_name = $3;
1.823 albertel 7107: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 7108: $type = 2;
7109: $udom = $1;
7110: $unum = $2;
7111: $group = $3;
7112: $file_name = $3.'/'.$4;
7113: }
7114: if (wantarray) {
7115: return ($type,$udom,$unum,$file_name,$group);
7116: }
7117: return $type;
7118: }
7119:
7120: sub is_portfolio_url {
7121: my ($url) = @_;
7122: return scalar(&parse_portfolio_url($url));
7123: }
7124:
1.798 raeburn 7125: sub is_portfolio_file {
7126: my ($file) = @_;
1.820 raeburn 7127: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 7128: return 1;
7129: }
7130: return;
7131: }
7132:
1.976 raeburn 7133: sub usertools_access {
1.1084 raeburn 7134: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 7135: my ($access,%tools);
7136: if ($context eq '') {
7137: $context = 'tools';
7138: }
7139: if ($context eq 'requestcourses') {
7140: %tools = (
7141: official => 1,
7142: unofficial => 1,
1.1006 raeburn 7143: community => 1,
1.1246 raeburn 7144: textbook => 1,
1.1305 raeburn 7145: placement => 1,
1.985 raeburn 7146: );
1.1183 raeburn 7147: } elsif ($context eq 'requestauthor') {
7148: %tools = (
7149: requestauthor => 1,
7150: );
1.985 raeburn 7151: } else {
7152: %tools = (
7153: aboutme => 1,
7154: blog => 1,
1.1177 raeburn 7155: webdav => 1,
1.985 raeburn 7156: portfolio => 1,
7157: );
7158: }
1.976 raeburn 7159: return if (!defined($tools{$tool}));
7160:
1.1242 raeburn 7161: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 7162: $udom = $env{'user.domain'};
7163: $uname = $env{'user.name'};
7164: }
7165:
1.978 raeburn 7166: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
7167: if ($action ne 'reload') {
1.985 raeburn 7168: if ($context eq 'requestcourses') {
7169: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 7170: } elsif ($context eq 'requestauthor') {
7171: return $env{'environment.canrequest.author'};
1.985 raeburn 7172: } else {
7173: return $env{'environment.availabletools.'.$tool};
7174: }
7175: }
1.976 raeburn 7176: }
7177:
1.1183 raeburn 7178: my ($toolstatus,$inststatus,$envkey);
7179: if ($context eq 'requestauthor') {
7180: $envkey = $context;
7181: } else {
7182: $envkey = $context.'.'.$tool;
7183: }
1.976 raeburn 7184:
1.985 raeburn 7185: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
7186: ($action ne 'reload')) {
1.1183 raeburn 7187: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 7188: $inststatus = $env{'environment.inststatus'};
7189: } else {
1.1084 raeburn 7190: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 7191: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 7192: $inststatus = $userenvref->{'inststatus'};
7193: } else {
1.1183 raeburn 7194: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
7195: $toolstatus = $userenv{$envkey};
1.1084 raeburn 7196: $inststatus = $userenv{'inststatus'};
7197: }
1.976 raeburn 7198: }
7199:
7200: if ($toolstatus ne '') {
7201: if ($toolstatus) {
7202: $access = 1;
7203: } else {
7204: $access = 0;
7205: }
7206: return $access;
7207: }
7208:
1.1084 raeburn 7209: my ($is_adv,%domdef);
7210: if (ref($is_advref) eq 'HASH') {
7211: $is_adv = $is_advref->{'is_adv'};
7212: } else {
7213: $is_adv = &is_advanced_user($udom,$uname);
7214: }
7215: if (ref($domdefref) eq 'HASH') {
7216: %domdef = %{$domdefref};
7217: } else {
7218: %domdef = &get_domain_defaults($udom);
7219: }
1.976 raeburn 7220: if (ref($domdef{$tool}) eq 'HASH') {
7221: if ($is_adv) {
7222: if ($domdef{$tool}{'_LC_adv'} ne '') {
7223: if ($domdef{$tool}{'_LC_adv'}) {
7224: $access = 1;
7225: } else {
7226: $access = 0;
7227: }
7228: return $access;
7229: }
7230: }
7231: if ($inststatus ne '') {
7232: my ($hasaccess,$hasnoaccess);
7233: foreach my $affiliation (split(/:/,$inststatus)) {
7234: if ($domdef{$tool}{$affiliation} ne '') {
7235: if ($domdef{$tool}{$affiliation}) {
7236: $hasaccess = 1;
7237: } else {
7238: $hasnoaccess = 1;
7239: }
7240: }
7241: }
7242: if ($hasaccess || $hasnoaccess) {
7243: if ($hasaccess) {
7244: $access = 1;
7245: } elsif ($hasnoaccess) {
7246: $access = 0;
7247: }
7248: return $access;
7249: }
7250: } else {
7251: if ($domdef{$tool}{'default'} ne '') {
7252: if ($domdef{$tool}{'default'}) {
7253: $access = 1;
7254: } elsif ($domdef{$tool}{'default'} == 0) {
7255: $access = 0;
7256: }
7257: return $access;
7258: }
7259: }
7260: } else {
1.1177 raeburn 7261: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 7262: $access = 1;
7263: } else {
7264: $access = 0;
7265: }
1.976 raeburn 7266: return $access;
7267: }
7268: }
7269:
1.1050 raeburn 7270: sub is_course_owner {
7271: my ($cdom,$cnum,$udom,$uname) = @_;
7272: if (($udom eq '') || ($uname eq '')) {
7273: $udom = $env{'user.domain'};
7274: $uname = $env{'user.name'};
7275: }
7276: unless (($udom eq '') || ($uname eq '')) {
7277: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
7278: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
7279: return 1;
7280: } else {
7281: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
7282: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
7283: return 1;
7284: }
7285: }
7286: }
7287: }
7288: return;
7289: }
7290:
1.976 raeburn 7291: sub is_advanced_user {
7292: my ($udom,$uname) = @_;
1.1085 raeburn 7293: if ($udom ne '' && $uname ne '') {
7294: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 7295: if (wantarray) {
7296: return ($env{'user.adv'},$env{'user.author'});
7297: } else {
7298: return $env{'user.adv'};
7299: }
1.1085 raeburn 7300: }
7301: }
1.976 raeburn 7302: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
7303: my %allroles;
1.1128 raeburn 7304: my ($is_adv,$is_author);
1.976 raeburn 7305: foreach my $role (keys(%roleshash)) {
7306: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
7307: my $area = '/'.$tdomain.'/'.$trest;
7308: if ($sec ne '') {
7309: $area .= '/'.$sec;
7310: }
7311: if (($area ne '') && ($trole ne '')) {
7312: my $spec=$trole.'.'.$area;
7313: if ($trole =~ /^cr\//) {
7314: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
7315: } elsif ($trole ne 'gr') {
7316: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
7317: }
1.1128 raeburn 7318: if ($trole eq 'au') {
7319: $is_author = 1;
7320: }
1.976 raeburn 7321: }
7322: }
7323: foreach my $role (keys(%allroles)) {
7324: last if ($is_adv);
7325: foreach my $item (split(/:/,$allroles{$role})) {
7326: if ($item ne '') {
7327: my ($privilege,$restrictions)=split(/&/,$item);
7328: if ($privilege eq 'adv') {
7329: $is_adv = 1;
7330: last;
7331: }
7332: }
7333: }
7334: }
1.1128 raeburn 7335: if (wantarray) {
7336: return ($is_adv,$is_author);
7337: }
1.976 raeburn 7338: return $is_adv;
7339: }
1.798 raeburn 7340:
1.1035 raeburn 7341: sub check_can_request {
1.1036 raeburn 7342: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 7343: my $canreq = 0;
7344: my ($types,$typename) = &Apache::loncommon::course_types();
7345: my @options = ('approval','validate','autolimit');
7346: my $optregex = join('|',@options);
7347: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
7348: foreach my $type (@{$types}) {
7349: if (&usertools_access($env{'user.name'},
7350: $env{'user.domain'},
7351: $type,undef,'requestcourses')) {
7352: $canreq ++;
1.1036 raeburn 7353: if (ref($request_domains) eq 'HASH') {
7354: push(@{$request_domains->{$type}},$env{'user.domain'});
7355: }
1.1035 raeburn 7356: if ($dom eq $env{'user.domain'}) {
7357: $can_request->{$type} = 1;
7358: }
7359: }
7360: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
7361: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
7362: if (@curr > 0) {
1.1036 raeburn 7363: foreach my $item (@curr) {
7364: if (ref($request_domains) eq 'HASH') {
7365: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
7366: if ($otherdom ne '') {
7367: if (ref($request_domains->{$type}) eq 'ARRAY') {
7368: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
7369: push(@{$request_domains->{$type}},$otherdom);
7370: }
7371: } else {
7372: push(@{$request_domains->{$type}},$otherdom);
7373: }
7374: }
7375: }
7376: }
7377: unless($dom eq $env{'user.domain'}) {
7378: $canreq ++;
1.1035 raeburn 7379: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
7380: $can_request->{$type} = 1;
7381: }
7382: }
7383: }
7384: }
7385: }
7386: }
7387: return $canreq;
7388: }
7389:
1.341 www 7390: # ---------------------------------------------- Custom access rule evaluation
7391:
7392: sub customaccess {
7393: my ($priv,$uri)=@_;
1.807 albertel 7394: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 7395: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 7396: $udom = &LONCAPA::clean_domain($udom);
7397: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 7398: my $access=0;
1.800 albertel 7399: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 7400: my ($effect,$realm,$role,$type)=split(/\:/,$right);
7401: if ($type eq 'user') {
7402: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 7403: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 7404: if ($tdom) {
7405: if ($tdom ne $env{'user.domain'}) { next; }
7406: }
1.896 albertel 7407: if ($tuname) {
7408: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 7409: }
7410: $access=($effect eq 'allow');
7411: last;
7412: }
7413: } else {
7414: if ($role) {
7415: if ($role ne $urole) { next; }
7416: }
7417: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7418: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
7419: if ($tdom) {
7420: if ($tdom ne $udom) { next; }
7421: }
7422: if ($tcrs) {
7423: if ($tcrs ne $ucrs) { next; }
7424: }
7425: if ($tsec) {
7426: if ($tsec ne $usec) { next; }
7427: }
7428: $access=($effect eq 'allow');
7429: last;
7430: }
7431: if ($realm eq '' && $role eq '') {
7432: $access=($effect eq 'allow');
7433: }
1.402 bowersj2 7434: }
1.341 www 7435: }
7436: return $access;
7437: }
7438:
1.103 harris41 7439: # ------------------------------------------------- Check for a user privilege
1.12 www 7440:
7441: sub allowed {
1.1281 raeburn 7442: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
1.705 albertel 7443: my $ver_orguri=$uri;
1.439 www 7444: $uri=&deversion($uri);
1.152 www 7445: my $orguri=$uri;
1.52 www 7446: $uri=&declutter($uri);
1.809 raeburn 7447:
1.810 raeburn 7448: if ($priv eq 'evb') {
7449: # Evade communication block restrictions for specified role in a course
7450: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
7451: return $1;
7452: } else {
7453: return;
7454: }
7455: }
7456:
1.620 albertel 7457: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 7458: # Free bre access to adm and meta resources
1.1343 raeburn 7459: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|ext\.tool)$}))
1.769 albertel 7460: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
7461: && ($priv eq 'bre')) {
1.14 www 7462: return 'F';
1.159 www 7463: }
7464:
1.545 banghart 7465: # Free bre access to user's own portfolio contents
1.714 raeburn 7466: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 7467: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 7468: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 7469: my %setters;
7470: my ($startblock,$endblock) =
7471: &Apache::loncommon::blockcheck(\%setters,'port');
7472: if ($startblock && $endblock) {
7473: return 'B';
7474: } else {
7475: return 'F';
7476: }
1.545 banghart 7477: }
7478:
1.762 raeburn 7479: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 7480: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
7481: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
7482: if (exists($env{'request.course.id'})) {
7483: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7484: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7485: if (($domain eq $cdom) && ($name eq $cnum)) {
7486: my $courseprivid=$env{'request.course.id'};
7487: $courseprivid=~s/\_/\//;
7488: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
7489: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
7490: return $1;
1.762 raeburn 7491: } else {
7492: if ($env{'request.course.sec'}) {
7493: $courseprivid.='/'.$env{'request.course.sec'};
7494: }
7495: if ($env{'user.priv.'.$env{'request.role'}.'./'.
7496: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
7497: return $2;
7498: }
1.714 raeburn 7499: }
7500: }
7501: }
7502: }
7503:
1.159 www 7504: # Free bre to public access
7505:
7506: if ($priv eq 'bre') {
1.1362 ! raeburn 7507: my $copyright;
! 7508: unless ($uri =~ /ext\.tool/) {
! 7509: $copyright=&metadata($uri,'copyright');
! 7510: }
1.620 albertel 7511: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 7512: return 'F';
7513: }
1.238 www 7514: if ($copyright eq 'priv') {
7515: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7516: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 7517: return '';
7518: }
7519: }
7520: if ($copyright eq 'domain') {
7521: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7522: unless (($env{'user.domain'} eq $1) ||
7523: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 7524: return '';
7525: }
1.262 matthew 7526: }
1.620 albertel 7527: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 7528: # Library role, so allow browsing of resources in this domain.
7529: return 'F';
1.238 www 7530: }
1.341 www 7531: if ($copyright eq 'custom') {
7532: unless (&customaccess($priv,$uri)) { return ''; }
7533: }
1.14 www 7534: }
1.264 matthew 7535: # Domain coordinator is trying to create a course
1.620 albertel 7536: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 7537: # uri is the requested domain in this case.
7538: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 7539: # a role of dc for the domain in question.
1.620 albertel 7540: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 7541: }
1.29 www 7542:
1.52 www 7543: my $thisallowed='';
7544: my $statecond=0;
7545: my $courseprivid='';
7546:
1.1039 raeburn 7547: my $ownaccess;
1.1043 raeburn 7548: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 7549: if (($priv eq 'bro') && ($env{'user.author'})) {
7550: if ($uri eq '') {
7551: $ownaccess = 1;
7552: } else {
7553: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7554: my $udom = $env{'user.domain'};
7555: my $uname = $env{'user.name'};
7556: if ($uri =~ m{^\Q$udom\E/?$}) {
7557: $ownaccess = 1;
1.1040 raeburn 7558: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 7559: unless ($uri =~ m{\.\./}) {
7560: $ownaccess = 1;
7561: }
7562: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7563: my $now = time;
7564: if ($uri =~ m{^([^/]+)/?$}) {
7565: my $adom = $1;
7566: foreach my $key (keys(%env)) {
1.1042 raeburn 7567: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 7568: my ($start,$end) = split('.',$env{$key});
7569: if (($now >= $start) && (!$end || $end < $now)) {
7570: $ownaccess = 1;
7571: last;
7572: }
7573: }
7574: }
7575: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7576: my $adom = $1;
7577: my $aname = $2;
1.1042 raeburn 7578: foreach my $role ('ca','aa') {
7579: if ($env{"user.role.$role./$adom/$aname"}) {
7580: my ($start,$end) =
7581: split('.',$env{"user.role.$role./$adom/$aname"});
7582: if (($now >= $start) && (!$end || $end < $now)) {
7583: $ownaccess = 1;
7584: last;
7585: }
1.1039 raeburn 7586: }
7587: }
7588: }
7589: }
7590: }
7591: }
7592: }
7593:
1.52 www 7594: # Course
7595:
1.620 albertel 7596: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7597: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7598: $thisallowed.=$1;
7599: }
1.52 www 7600: }
1.29 www 7601:
1.52 www 7602: # Domain
7603:
1.620 albertel 7604: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 7605: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7606: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7607: $thisallowed.=$1;
7608: }
1.12 www 7609: }
1.52 www 7610:
1.1141 raeburn 7611: # User who is not author or co-author might still be able to edit
7612: # resource of an author in the domain (e.g., if Domain Coordinator).
7613: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7614: (&allowed('mdc',$env{'request.course.id'}))) {
7615: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7616: $thisallowed.=$1;
7617: }
7618: }
7619:
1.52 www 7620: # Course: uri itself is a course
1.66 www 7621: my $courseuri=$uri;
7622: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 7623: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 7624:
1.620 albertel 7625: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 7626: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7627: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7628: $thisallowed.=$1;
7629: }
1.12 www 7630: }
1.29 www 7631:
1.665 albertel 7632: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 7633: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 7634: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 7635: $thisallowed='';
1.671 raeburn 7636: my ($match)=&is_on_map($uri);
7637: if ($match) {
7638: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7639: =~/\Q$priv\E\&([^\:]*)/) {
1.1281 raeburn 7640: my $value = $1;
7641: if ($noblockcheck) {
7642: $thisallowed.=$value;
1.1162 raeburn 7643: } else {
1.1281 raeburn 7644: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7645: if (@blockers > 0) {
7646: $thisallowed = 'B';
7647: } else {
7648: $thisallowed.=$value;
7649: }
1.1162 raeburn 7650: }
1.671 raeburn 7651: }
7652: } else {
1.705 albertel 7653: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 7654: if ($refuri) {
7655: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 7656: $thisallowed='F';
1.671 raeburn 7657: } else {
7658: $refuri=&declutter($refuri);
7659: my ($match) = &is_on_map($refuri);
7660: if ($match) {
1.1281 raeburn 7661: if ($noblockcheck) {
7662: $thisallowed='F';
1.1162 raeburn 7663: } else {
1.1281 raeburn 7664: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7665: if (@blockers > 0) {
7666: $thisallowed = 'B';
7667: } else {
7668: $thisallowed='F';
7669: }
1.1162 raeburn 7670: }
1.671 raeburn 7671: }
1.669 raeburn 7672: }
1.671 raeburn 7673: }
7674: }
1.314 www 7675: }
1.492 albertel 7676:
1.766 albertel 7677: if ($priv eq 'bre'
7678: && $thisallowed ne 'F'
7679: && $thisallowed ne '2'
7680: && &is_portfolio_url($uri)) {
1.1270 raeburn 7681: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 7682: }
1.1250 raeburn 7683:
1.52 www 7684: # Full access at system, domain or course-wide level? Exit.
1.29 www 7685: if ($thisallowed=~/F/) {
7686: return 'F';
7687: }
7688:
1.52 www 7689: # If this is generating or modifying users, exit with special codes
1.29 www 7690:
1.643 www 7691: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7692: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 7693: my ($audom,$auname)=split('/',$uri);
1.643 www 7694: # no author name given, so this just checks on the general right to make a co-author in this domain
7695: unless ($auname) { return $thisallowed; }
7696: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 7697: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7698: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7699: ($audom ne $env{'request.role.domain'}))) { return ''; }
7700: }
1.52 www 7701: return $thisallowed;
7702: }
7703: #
1.103 harris41 7704: # Gathered so far: system, domain and course wide privileges
1.52 www 7705: #
7706: # Course: See if uri or referer is an individual resource that is part of
7707: # the course
7708:
1.620 albertel 7709: if ($env{'request.course.id'}) {
1.232 www 7710:
1.620 albertel 7711: $courseprivid=$env{'request.course.id'};
7712: if ($env{'request.course.sec'}) {
7713: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 7714: }
7715: $courseprivid=~s/\_/\//;
7716: my $checkreferer=1;
1.232 www 7717: my ($match,$cond)=&is_on_map($uri);
7718: if ($match) {
7719: $statecond=$cond;
1.620 albertel 7720: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7721: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7722: my $value = $1;
7723: if ($priv eq 'bre') {
1.1281 raeburn 7724: if ($noblockcheck) {
7725: $thisallowed.=$value;
1.1162 raeburn 7726: } else {
1.1281 raeburn 7727: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7728: if (@blockers > 0) {
7729: $thisallowed = 'B';
7730: } else {
7731: $thisallowed.=$value;
7732: }
1.1162 raeburn 7733: }
7734: } else {
7735: $thisallowed.=$value;
7736: }
1.52 www 7737: $checkreferer=0;
7738: }
1.29 www 7739: }
1.83 www 7740:
1.148 www 7741: if ($checkreferer) {
1.620 albertel 7742: my $refuri=$env{'httpref.'.$orguri};
1.148 www 7743: unless ($refuri) {
1.800 albertel 7744: foreach my $key (keys(%env)) {
7745: if ($key=~/^httpref\..*\*/) {
7746: my $pattern=$key;
1.156 www 7747: $pattern=~s/^httpref\.\/res\///;
1.148 www 7748: $pattern=~s/\*/\[\^\/\]\+/g;
7749: $pattern=~s/\//\\\//g;
1.152 www 7750: if ($orguri=~/$pattern/) {
1.800 albertel 7751: $refuri=$env{$key};
1.148 www 7752: }
7753: }
1.191 harris41 7754: }
1.148 www 7755: }
1.232 www 7756:
1.148 www 7757: if ($refuri) {
1.152 www 7758: $refuri=&declutter($refuri);
1.232 www 7759: my ($match,$cond)=&is_on_map($refuri);
7760: if ($match) {
7761: my $refstatecond=$cond;
1.620 albertel 7762: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7763: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7764: my $value = $1;
7765: if ($priv eq 'bre') {
1.1281 raeburn 7766: if ($noblockcheck) {
7767: $thisallowed.=$value;
1.1162 raeburn 7768: } else {
1.1281 raeburn 7769: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7770: if (@blockers > 0) {
7771: $thisallowed = 'B';
7772: } else {
7773: $thisallowed.=$value;
7774: }
1.1162 raeburn 7775: }
7776: } else {
7777: $thisallowed.=$value;
7778: }
1.53 www 7779: $uri=$refuri;
7780: $statecond=$refstatecond;
1.52 www 7781: }
7782: }
1.148 www 7783: }
1.29 www 7784: }
1.52 www 7785: }
1.29 www 7786:
1.52 www 7787: #
1.103 harris41 7788: # Gathered now: all privileges that could apply, and condition number
1.52 www 7789: #
7790: #
7791: # Full or no access?
7792: #
1.29 www 7793:
1.52 www 7794: if ($thisallowed=~/F/) {
7795: return 'F';
7796: }
1.29 www 7797:
1.52 www 7798: unless ($thisallowed) {
7799: return '';
7800: }
1.29 www 7801:
1.52 www 7802: # Restrictions exist, deal with them
7803: #
7804: # C:according to course preferences
7805: # R:according to resource settings
7806: # L:unless locked
7807: # X:according to user session state
7808: #
7809:
7810: # Possibly locked functionality, check all courses
1.54 www 7811: # Locks might take effect only after 10 minutes cache expiration for other
7812: # courses, and 2 minutes for current course
1.52 www 7813:
7814: my $envkey;
7815: if ($thisallowed=~/L/) {
1.1000 raeburn 7816: foreach $envkey (keys(%env)) {
1.54 www 7817: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7818: my $courseid=$2;
7819: my $roleid=$1.'.'.$2;
1.92 www 7820: $courseid=~s/^\///;
1.54 www 7821: my $expiretime=600;
1.620 albertel 7822: if ($env{'request.role'} eq $roleid) {
1.54 www 7823: $expiretime=120;
7824: }
7825: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7826: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 7827: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 7828: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 7829: }
1.620 albertel 7830: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7831: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7832: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7833: &log($env{'user.domain'},$env{'user.name'},
7834: $env{'user.home'},
1.57 www 7835: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 7836: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7837: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7838: return '';
7839: }
7840: }
1.620 albertel 7841: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7842: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7843: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7844: &log($env{'user.domain'},$env{'user.name'},
7845: $env{'user.home'},
1.57 www 7846: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 7847: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7848: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7849: return '';
7850: }
7851: }
7852: }
1.29 www 7853: }
1.52 www 7854: }
7855:
7856: #
7857: # Rest of the restrictions depend on selected course
7858: #
7859:
1.620 albertel 7860: unless ($env{'request.course.id'}) {
1.766 albertel 7861: if ($thisallowed eq 'A') {
7862: return 'A';
1.814 raeburn 7863: } elsif ($thisallowed eq 'B') {
7864: return 'B';
1.766 albertel 7865: } else {
7866: return '1';
7867: }
1.52 www 7868: }
1.29 www 7869:
1.52 www 7870: #
7871: # Now user is definitely in a course
7872: #
1.53 www 7873:
7874:
7875: # Course preferences
7876:
7877: if ($thisallowed=~/C/) {
1.620 albertel 7878: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7879: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7880: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 7881: =~/\Q$rolecode\E/) {
1.1304 raeburn 7882: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 7883: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7884: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7885: $env{'request.course.id'});
7886: }
1.237 www 7887: return '';
7888: }
7889:
1.620 albertel 7890: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 7891: =~/\Q$unamedom\E/) {
1.1304 raeburn 7892: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 7893: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7894: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7895: $env{'request.course.id'});
7896: }
1.54 www 7897: return '';
7898: }
1.53 www 7899: }
7900:
7901: # Resource preferences
7902:
7903: if ($thisallowed=~/R/) {
1.620 albertel 7904: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 7905: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 7906: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7907: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7908: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7909: }
7910: return '';
1.54 www 7911: }
1.53 www 7912: }
1.30 www 7913:
1.246 www 7914: # Restricted by state or randomout?
1.30 www 7915:
1.52 www 7916: if ($thisallowed=~/X/) {
1.620 albertel 7917: if ($env{'acc.randomout'}) {
1.579 albertel 7918: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 7919: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 7920: return '';
7921: }
1.247 www 7922: }
7923: if (&condval($statecond)) {
1.52 www 7924: return '2';
7925: } else {
7926: return '';
7927: }
7928: }
1.30 www 7929:
1.766 albertel 7930: if ($thisallowed eq 'A') {
7931: return 'A';
1.814 raeburn 7932: } elsif ($thisallowed eq 'B') {
7933: return 'B';
1.766 albertel 7934: }
1.52 www 7935: return 'F';
1.232 www 7936: }
1.1162 raeburn 7937:
1.1192 raeburn 7938: # ------------------------------------------- Check construction space access
7939:
7940: sub constructaccess {
7941: my ($url,$setpriv)=@_;
7942:
7943: # We do not allow editing of previous versions of files
7944: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7945:
7946: # Get username and domain from URL
7947: my ($ownername,$ownerdomain,$ownerhome);
7948:
7949: ($ownerdomain,$ownername) =
1.1325 raeburn 7950: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
1.1192 raeburn 7951:
7952: # The URL does not really point to any authorspace, forget it
7953: unless (($ownername) && ($ownerdomain)) { return ''; }
7954:
7955: # Now we need to see if the user has access to the authorspace of
7956: # $ownername at $ownerdomain
7957:
7958: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7959: # Real author for this?
7960: $ownerhome = $env{'user.home'};
7961: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7962: return ($ownername,$ownerdomain,$ownerhome);
7963: }
7964: } else {
7965: # Co-author for this?
7966: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7967: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7968: $ownerhome = &homeserver($ownername,$ownerdomain);
7969: return ($ownername,$ownerdomain,$ownerhome);
7970: }
1.1312 raeburn 7971: if ($env{'request.course.id'}) {
7972: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
7973: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
7974: if (&allowed('mdc',$env{'request.course.id'})) {
7975: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
7976: return ($ownername,$ownerdomain,$ownerhome);
7977: }
7978: }
7979: }
1.1192 raeburn 7980: }
7981:
7982: # We don't have any access right now. If we are not possibly going to do anything about this,
7983: # we might as well leave
7984: unless ($setpriv) { return ''; }
7985:
7986: # Backdoor access?
7987: my $allowed=&allowed('eco',$ownerdomain);
7988: # Nope
7989: unless ($allowed) { return ''; }
7990: # Looks like we may have access, but could be locked by the owner of the construction space
7991: if ($allowed eq 'U') {
7992: my %blocked=&get('environment',['domcoord.author'],
7993: $ownerdomain,$ownername);
7994: # Is blocked by owner
7995: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7996: }
7997: if (($allowed eq 'F') || ($allowed eq 'U')) {
7998: # Grant temporary access
7999: my $then=$env{'user.login.time'};
1.1209 raeburn 8000: my $update=$env{'user.update.time'};
1.1192 raeburn 8001: if (!$update) { $update = $then; }
8002: my $refresh=$env{'user.refresh.time'};
8003: if (!$refresh) { $refresh = $update; }
8004: my $now = time;
8005: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
8006: $now,'ca','constructaccess');
8007: $ownerhome = &homeserver($ownername,$ownerdomain);
8008: return($ownername,$ownerdomain,$ownerhome);
8009: }
8010: # No business here
8011: return '';
8012: }
8013:
1.1282 raeburn 8014: # ----------------------------------------------------------- Content Blocking
8015:
8016: {
8017: # Caches for faster Course Contents display where content blocking
8018: # is in operation (i.e., interval param set) for timed quiz.
8019: #
8020: # User for whom data are being temporarily cached.
8021: my $cacheduser='';
8022: # Cached blockers for this user (a hash of blocking items).
8023: my %cachedblockers=();
8024: # When the data were last cached.
8025: my $cachedlast='';
8026:
8027: sub load_all_blockers {
8028: my ($uname,$udom,$blocks)=@_;
8029: if (($uname ne '') && ($udom ne '')) {
8030: if (($cacheduser eq $uname.':'.$udom) &&
8031: (abs($cachedlast-time)<5)) {
8032: return;
8033: }
8034: }
8035: $cachedlast=time;
8036: $cacheduser=$uname.':'.$udom;
8037: %cachedblockers = &get_commblock_resources($blocks);
8038: }
8039:
1.1162 raeburn 8040: sub get_comm_blocks {
8041: my ($cdom,$cnum) = @_;
8042: if ($cdom eq '' || $cnum eq '') {
8043: return unless ($env{'request.course.id'});
8044: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8045: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8046: }
8047: my %commblocks;
8048: my $hashid=$cdom.'_'.$cnum;
8049: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
8050: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
8051: %commblocks = %{$blocksref};
8052: } else {
8053: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
8054: my $cachetime = 600;
8055: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
8056: }
8057: return %commblocks;
8058: }
8059:
1.1282 raeburn 8060: sub get_commblock_resources {
8061: my ($blocks) = @_;
8062: my %blockers = ();
8063: return %blockers unless ($env{'request.course.id'});
8064: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
1.1162 raeburn 8065: my %commblocks;
8066: if (ref($blocks) eq 'HASH') {
8067: %commblocks = %{$blocks};
8068: } else {
8069: %commblocks = &get_comm_blocks();
8070: }
1.1282 raeburn 8071: return %blockers unless (keys(%commblocks) > 0);
8072: my $navmap = Apache::lonnavmaps::navmap->new();
8073: return %blockers unless (ref($navmap));
1.1162 raeburn 8074: my $now = time;
8075: foreach my $block (keys(%commblocks)) {
8076: if ($block =~ /^(\d+)____(\d+)$/) {
8077: my ($start,$end) = ($1,$2);
8078: if ($start <= $now && $end >= $now) {
8079: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8080: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
8081: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282 raeburn 8082: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8083: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 8084: }
8085: }
8086: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282 raeburn 8087: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8088: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 8089: }
8090: }
8091: }
8092: }
8093: }
8094: } elsif ($block =~ /^firstaccess____(.+)$/) {
8095: my $item = $1;
1.1163 raeburn 8096: my @to_test;
1.1162 raeburn 8097: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
8098: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1282 raeburn 8099: my @interval;
8100: my $type = 'map';
8101: if ($item eq 'course') {
8102: $type = 'course';
8103: @interval=&EXT("resource.0.interval");
8104: } else {
8105: if ($item =~ /___\d+___/) {
8106: $type = 'resource';
8107: @interval=&EXT("resource.0.interval",$item);
8108: if (ref($navmap)) {
8109: my $res = $navmap->getBySymb($item);
8110: push(@to_test,$res);
8111: }
1.1162 raeburn 8112: } else {
1.1282 raeburn 8113: my $mapsymb = &symbread($item,1);
8114: if ($mapsymb) {
8115: if (ref($navmap)) {
8116: my $mapres = $navmap->getBySymb($mapsymb);
8117: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
8118: foreach my $res (@to_test) {
8119: my $symb = $res->symb();
8120: next if ($symb eq $mapsymb);
8121: if ($symb ne '') {
8122: @interval=&EXT("resource.0.interval",$symb);
8123: if ($interval[1] eq 'map') {
8124: last;
1.1162 raeburn 8125: }
8126: }
8127: }
8128: }
8129: }
8130: }
1.1282 raeburn 8131: }
1.1310 raeburn 8132: if ($interval[0] =~ /^(\d+)/) {
1.1308 raeburn 8133: my $timelimit = $1;
1.1282 raeburn 8134: my $first_access;
8135: if ($type eq 'resource') {
8136: $first_access=&get_first_access($interval[1],$item);
8137: } elsif ($type eq 'map') {
8138: $first_access=&get_first_access($interval[1],undef,$item);
8139: } else {
8140: $first_access=&get_first_access($interval[1]);
8141: }
8142: if ($first_access) {
1.1292 raeburn 8143: my $timesup = $first_access+$timelimit;
1.1282 raeburn 8144: if ($timesup > $now) {
8145: my $activeblock;
8146: foreach my $res (@to_test) {
1.1283 raeburn 8147: if ($res->answerable()) {
1.1282 raeburn 8148: $activeblock = 1;
8149: last;
8150: }
8151: }
8152: if ($activeblock) {
8153: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
8154: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
8155: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
8156: }
8157: }
8158: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
8159: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
8160: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 8161: }
1.1162 raeburn 8162: }
8163: }
8164: }
8165: }
8166: }
8167: }
8168: }
8169: }
8170: }
1.1282 raeburn 8171: return %blockers;
1.1162 raeburn 8172: }
8173:
1.1282 raeburn 8174: sub has_comm_blocking {
8175: my ($priv,$symb,$uri,$blocks) = @_;
8176: my @blockers;
8177: return unless ($env{'request.course.id'});
8178: return unless ($priv eq 'bre');
8179: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
8180: return if ($env{'request.state'} eq 'construct');
8181: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
8182: return unless (keys(%cachedblockers) > 0);
8183: my (%possibles,@symbs);
8184: if (!$symb) {
8185: $symb = &symbread($uri,1,1,1,\%possibles);
1.1162 raeburn 8186: }
1.1282 raeburn 8187: if ($symb) {
8188: @symbs = ($symb);
8189: } elsif (keys(%possibles)) {
8190: @symbs = keys(%possibles);
8191: }
8192: my $noblock;
8193: foreach my $symb (@symbs) {
8194: last if ($noblock);
8195: my ($map,$resid,$resurl)=&decode_symb($symb);
8196: foreach my $block (keys(%cachedblockers)) {
8197: if ($block =~ /^firstaccess____(.+)$/) {
8198: my $item = $1;
8199: if (($item eq $map) || ($item eq $symb)) {
8200: $noblock = 1;
8201: last;
8202: }
8203: }
8204: if (ref($cachedblockers{$block}) eq 'HASH') {
8205: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
8206: if ($cachedblockers{$block}{'resources'}{$symb}) {
8207: unless (grep(/^\Q$block\E$/,@blockers)) {
8208: push(@blockers,$block);
8209: }
8210: }
8211: }
1.1162 raeburn 8212: }
1.1282 raeburn 8213: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
8214: if ($cachedblockers{$block}{'maps'}{$map}) {
8215: unless (grep(/^\Q$block\E$/,@blockers)) {
8216: push(@blockers,$block);
8217: }
8218: }
1.1162 raeburn 8219: }
8220: }
8221: }
1.1282 raeburn 8222: return if ($noblock);
8223: return @blockers;
8224: }
1.1162 raeburn 8225: }
8226:
1.1282 raeburn 8227: # -------------------------------- Deversion and split uri into path an filename
8228:
1.1133 foxr 8229: #
1.1282 raeburn 8230: # Removes the version from a URI and
1.1133 foxr 8231: # splits it in to its filename and path to the filename.
8232: # Seems like File::Basename could have done this more clearly.
8233: # Parameters:
8234: # $uri - input URI
8235: # Returns:
8236: # Two element list consisting of
8237: # $pathname - the URI up to and excluding the trailing /
8238: # $filename - The part of the URI following the last /
8239: # NOTE:
8240: # Another realization of this is simply:
8241: # use File::Basename;
8242: # ...
8243: # $uri = shift;
8244: # $filename = basename($uri);
8245: # $path = dirname($uri);
8246: # return ($filename, $path);
8247: #
8248: # The implementation below is probably faster however.
8249: #
1.710 albertel 8250: sub split_uri_for_cond {
8251: my $uri=&deversion(&declutter(shift));
8252: my @uriparts=split(/\//,$uri);
8253: my $filename=pop(@uriparts);
8254: my $pathname=join('/',@uriparts);
8255: return ($pathname,$filename);
8256: }
1.232 www 8257: # --------------------------------------------------- Is a resource on the map?
8258:
8259: sub is_on_map {
1.710 albertel 8260: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 8261: #Trying to find the conditional for the file
1.620 albertel 8262: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 8263: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 8264: if ($match) {
1.289 bowersj2 8265: return (1,$1);
8266: } else {
1.434 www 8267: return (0,0);
1.289 bowersj2 8268: }
1.12 www 8269: }
8270:
1.427 www 8271: # --------------------------------------------------------- Get symb from alias
8272:
8273: sub get_symb_from_alias {
8274: my $symb=shift;
8275: my ($map,$resid,$url)=&decode_symb($symb);
8276: # Already is a symb
8277: if ($url) { return $symb; }
8278: # Must be an alias
8279: my $aliassymb='';
8280: my %bighash;
1.620 albertel 8281: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 8282: &GDBM_READER(),0640)) {
8283: my $rid=$bighash{'mapalias_'.$symb};
8284: if ($rid) {
8285: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 8286: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
8287: $resid,$bighash{'src_'.$rid});
1.427 www 8288: }
8289: untie %bighash;
8290: }
8291: return $aliassymb;
8292: }
8293:
1.12 www 8294: # ----------------------------------------------------------------- Define Role
8295:
8296: sub definerole {
8297: if (allowed('mcr','/')) {
1.1326 raeburn 8298: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 8299: foreach my $role (split(':',$sysrole)) {
8300: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 8301: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
8302: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
8303: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 8304: return "refused:s:$crole&$cqual";
8305: }
8306: }
1.191 harris41 8307: }
1.800 albertel 8308: foreach my $role (split(':',$domrole)) {
8309: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 8310: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
8311: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
8312: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 8313: return "refused:d:$crole&$cqual";
8314: }
8315: }
1.191 harris41 8316: }
1.800 albertel 8317: foreach my $role (split(':',$courole)) {
8318: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 8319: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
8320: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
8321: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 8322: return "refused:c:$crole&$cqual";
8323: }
8324: }
1.191 harris41 8325: }
1.1326 raeburn 8326: my $uhome;
8327: if (($uname ne '') && ($udom ne '')) {
8328: $uhome = &homeserver($uname,$udom);
8329: return $uhome if ($uhome eq 'no_host');
8330: } else {
8331: $uname = $env{'user.name'};
8332: $udom = $env{'user.domain'};
8333: $uhome = $env{'user.home'};
8334: }
1.620 albertel 8335: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1326 raeburn 8336: "$udom:$uname:rolesdef_$rolename=".
1.21 www 8337: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1326 raeburn 8338: return reply($command,$uhome);
1.12 www 8339: } else {
8340: return 'refused';
8341: }
1.105 harris41 8342: }
8343:
8344: # ---------------- Make a metadata query against the network of library servers
8345:
8346: sub metadata_query {
1.1237 raeburn 8347: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 8348: my %rhash;
1.845 albertel 8349: my %libserv = &all_library();
1.244 matthew 8350: my @server_list = (defined($server_array) ? @$server_array
8351: : keys(%libserv) );
8352: for my $server (@server_list) {
1.1237 raeburn 8353: my $domains = '';
8354: if (ref($domains_hash) eq 'HASH') {
8355: $domains = $domains_hash->{$server};
8356: }
1.118 harris41 8357: unless ($custom or $customshow) {
1.1237 raeburn 8358: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 8359: $rhash{$server}=$reply;
8360: }
8361: else {
8362: my $reply=&reply("querysend:".&escape($query).':'.
1.1237 raeburn 8363: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 8364: $server);
8365: $rhash{$server}=$reply;
8366: }
1.112 harris41 8367: }
1.118 harris41 8368: return \%rhash;
1.240 www 8369: }
8370:
8371: # ----------------------------------------- Send log queries and wait for reply
8372:
8373: sub log_query {
8374: my ($uname,$udom,$query,%filters)=@_;
8375: my $uhome=&homeserver($uname,$udom);
8376: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 8377: my $uhost=&hostname($uhome);
1.800 albertel 8378: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 8379: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
8380: $uhome);
1.479 albertel 8381: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 8382: return get_query_reply($queryid);
8383: }
8384:
1.818 raeburn 8385: # -------------------------- Update MySQL table for portfolio file
8386:
8387: sub update_portfolio_table {
1.821 raeburn 8388: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 8389: if ($group ne '') {
8390: $file_name =~s /^\Q$group\E//;
8391: }
1.818 raeburn 8392: my $homeserver = &homeserver($uname,$udom);
8393: my $queryid=
1.821 raeburn 8394: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
8395: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 8396: my $reply = &get_query_reply($queryid);
8397: return $reply;
8398: }
8399:
1.899 raeburn 8400: # -------------------------- Update MySQL allusers table
8401:
8402: sub update_allusers_table {
8403: my ($uname,$udom,$names) = @_;
8404: my $homeserver = &homeserver($uname,$udom);
8405: my $queryid=
8406: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
8407: 'lastname='.&escape($names->{'lastname'}).'%%'.
8408: 'firstname='.&escape($names->{'firstname'}).'%%'.
8409: 'middlename='.&escape($names->{'middlename'}).'%%'.
8410: 'generation='.&escape($names->{'generation'}).'%%'.
8411: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
8412: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 8413: return;
1.899 raeburn 8414: }
8415:
1.508 raeburn 8416: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 8417:
8418: sub fetch_enrollment_query {
1.511 raeburn 8419: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1317 raeburn 8420: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 8421: my $maxtries = 1;
1.508 raeburn 8422: if ($context eq 'automated') {
8423: $homeserver = $perlvar{'lonHostID'};
1.1317 raeburn 8424: $sleep = 2;
8425: $loopmax = 100;
1.547 raeburn 8426: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 8427: } else {
8428: $homeserver = &homeserver($cnum,$dom);
8429: }
1.838 albertel 8430: my $host=&hostname($homeserver);
1.506 raeburn 8431: my $cmd = '';
1.1000 raeburn 8432: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 8433: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 8434: }
8435: $cmd =~ s/%%$//;
8436: $cmd = &escape($cmd);
8437: my $query = 'fetchenrollment';
1.620 albertel 8438: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 8439: unless ($queryid=~/^\Q$host\E\_/) {
8440: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
8441: return 'error: '.$queryid;
8442: }
1.1317 raeburn 8443: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 8444: my $tries = 1;
8445: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1317 raeburn 8446: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 8447: $tries ++;
8448: }
1.526 raeburn 8449: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 8450: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 8451: } else {
1.901 albertel 8452: my @responses = split(/:/,$reply);
1.1322 raeburn 8453: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 8454: foreach my $line (@responses) {
8455: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 8456: $$replyref{$key} = $value;
8457: }
8458: } else {
1.1117 foxr 8459: my $pathname = LONCAPA::tempdir();
1.800 albertel 8460: foreach my $line (@responses) {
8461: my ($key,$value) = split(/=/,$line);
1.506 raeburn 8462: $$replyref{$key} = $value;
8463: if ($value > 0) {
1.800 albertel 8464: foreach my $item (@{$$affiliatesref{$key}}) {
8465: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 8466: my $destname = $pathname.'/'.$filename;
8467: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 8468: if ($xml_classlist =~ /^error/) {
8469: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
8470: } else {
1.1359 raeburn 8471: if ( open(FILE,">",$destname) ) {
1.506 raeburn 8472: print FILE &unescape($xml_classlist);
8473: close(FILE);
1.526 raeburn 8474: } else {
8475: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 8476: }
8477: }
8478: }
8479: }
8480: }
8481: }
8482: return 'ok';
8483: }
8484: return 'error';
8485: }
8486:
1.242 www 8487: sub get_query_reply {
1.1317 raeburn 8488: my ($queryid,$sleep,$loopmax) = @_;;
8489: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
8490: $sleep = 0.2;
8491: }
8492: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
8493: $loopmax = 100;
8494: }
1.1117 foxr 8495: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 8496: my $reply='';
1.1317 raeburn 8497: for (1..$loopmax) {
8498: sleep($sleep);
1.240 www 8499: if (-e $replyfile.'.end') {
1.1359 raeburn 8500: if (open(my $fh,"<",$replyfile)) {
1.904 albertel 8501: $reply = join('',<$fh>);
8502: close($fh);
1.240 www 8503: } else { return 'error: reply_file_error'; }
1.242 www 8504: return &unescape($reply);
8505: }
1.240 www 8506: }
1.242 www 8507: return 'timeout:'.$queryid;
1.240 www 8508: }
8509:
8510: sub courselog_query {
1.241 www 8511: #
8512: # possible filters:
8513: # url: url or symb
8514: # username
8515: # domain
8516: # action: view, submit, grade
8517: # start: timestamp
8518: # end: timestamp
8519: #
1.240 www 8520: my (%filters)=@_;
1.620 albertel 8521: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 8522: if ($filters{'url'}) {
8523: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
8524: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
8525: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
8526: }
1.620 albertel 8527: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
8528: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 8529: return &log_query($cname,$cdom,'courselog',%filters);
8530: }
8531:
8532: sub userlog_query {
1.858 raeburn 8533: #
8534: # possible filters:
8535: # action: log check role
8536: # start: timestamp
8537: # end: timestamp
8538: #
1.240 www 8539: my ($uname,$udom,%filters)=@_;
8540: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 8541: }
8542:
1.506 raeburn 8543: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
8544:
8545: sub auto_run {
1.508 raeburn 8546: my ($cnum,$cdom) = @_;
1.876 raeburn 8547: my $response = 0;
8548: my $settings;
8549: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
8550: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
8551: $settings = $domconfig{'autoenroll'};
8552: if ($settings->{'run'} eq '1') {
8553: $response = 1;
8554: }
8555: } else {
1.934 raeburn 8556: my $homeserver;
8557: if (&is_course($cdom,$cnum)) {
8558: $homeserver = &homeserver($cnum,$cdom);
8559: } else {
8560: $homeserver = &domain($cdom,'primary');
8561: }
8562: if ($homeserver ne 'no_host') {
8563: $response = &reply('autorun:'.$cdom,$homeserver);
8564: }
1.876 raeburn 8565: }
1.506 raeburn 8566: return $response;
8567: }
1.776 albertel 8568:
1.506 raeburn 8569: sub auto_get_sections {
1.508 raeburn 8570: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 8571: my $homeserver;
8572: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8573: $homeserver = &homeserver($cnum,$cdom);
8574: }
8575: if (!defined($homeserver)) {
8576: if ($cdom =~ /^$match_domain$/) {
8577: $homeserver = &domain($cdom,'primary');
8578: }
8579: }
8580: my @secs;
8581: if (defined($homeserver)) {
8582: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
8583: unless ($response eq 'refused') {
8584: @secs = split(/:/,$response);
8585: }
1.506 raeburn 8586: }
8587: return @secs;
8588: }
1.776 albertel 8589:
1.506 raeburn 8590: sub auto_new_course {
1.1099 raeburn 8591: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 8592: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 8593: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 8594: return $response;
8595: }
1.776 albertel 8596:
1.506 raeburn 8597: sub auto_validate_courseID {
1.508 raeburn 8598: my ($cnum,$cdom,$inst_course_id) = @_;
8599: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 8600: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 8601: return $response;
8602: }
1.776 albertel 8603:
1.1007 raeburn 8604: sub auto_validate_instcode {
1.1020 raeburn 8605: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 8606: my ($homeserver,$response);
8607: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8608: $homeserver = &homeserver($cnum,$cdom);
8609: }
8610: if (!defined($homeserver)) {
8611: if ($cdom =~ /^$match_domain$/) {
8612: $homeserver = &domain($cdom,'primary');
8613: }
8614: }
1.1065 raeburn 8615: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8616: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 8617: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8618: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 8619: }
8620:
1.506 raeburn 8621: sub auto_create_password {
1.873 raeburn 8622: my ($cnum,$cdom,$authparam,$udom) = @_;
8623: my ($homeserver,$response);
1.506 raeburn 8624: my $create_passwd = 0;
8625: my $authchk = '';
1.873 raeburn 8626: if ($udom =~ /^$match_domain$/) {
8627: $homeserver = &domain($udom,'primary');
8628: }
8629: if ($homeserver eq '') {
8630: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8631: $homeserver = &homeserver($cnum,$cdom);
8632: }
8633: }
8634: if ($homeserver eq '') {
8635: $authchk = 'nodomain';
1.506 raeburn 8636: } else {
1.873 raeburn 8637: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8638: if ($response eq 'refused') {
8639: $authchk = 'refused';
8640: } else {
1.901 albertel 8641: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 8642: }
1.506 raeburn 8643: }
8644: return ($authparam,$create_passwd,$authchk);
8645: }
8646:
1.706 raeburn 8647: sub auto_photo_permission {
8648: my ($cnum,$cdom,$students) = @_;
8649: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 8650: my ($outcome,$perm_reqd,$conditions) =
8651: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 8652: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8653: return (undef,undef);
8654: }
1.706 raeburn 8655: return ($outcome,$perm_reqd,$conditions);
8656: }
8657:
8658: sub auto_checkphotos {
8659: my ($uname,$udom,$pid) = @_;
8660: my $homeserver = &homeserver($uname,$udom);
8661: my ($result,$resulttype);
8662: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 8663: &escape($uname).':'.&escape($pid),
8664: $homeserver));
1.709 albertel 8665: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8666: return (undef,undef);
8667: }
1.706 raeburn 8668: if ($outcome) {
8669: ($result,$resulttype) = split(/:/,$outcome);
8670: }
8671: return ($result,$resulttype);
8672: }
8673:
8674: sub auto_photochoice {
8675: my ($cnum,$cdom) = @_;
8676: my $homeserver = &homeserver($cnum,$cdom);
8677: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 8678: &escape($cdom),
8679: $homeserver)));
1.709 albertel 8680: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8681: return (undef,undef);
8682: }
1.706 raeburn 8683: return ($update,$comment);
8684: }
8685:
8686: sub auto_photoupdate {
8687: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8688: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 8689: my $host=&hostname($homeserver);
1.706 raeburn 8690: my $cmd = '';
8691: my $maxtries = 1;
1.800 albertel 8692: foreach my $affiliate (keys(%{$affiliatesref})) {
8693: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 8694: }
8695: $cmd =~ s/%%$//;
8696: $cmd = &escape($cmd);
8697: my $query = 'institutionalphotos';
8698: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8699: unless ($queryid=~/^\Q$host\E\_/) {
8700: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8701: return 'error: '.$queryid;
8702: }
8703: my $reply = &get_query_reply($queryid);
8704: my $tries = 1;
8705: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8706: $reply = &get_query_reply($queryid);
8707: $tries ++;
8708: }
8709: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8710: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8711: } else {
8712: my @responses = split(/:/,$reply);
8713: my $outcome = shift(@responses);
8714: foreach my $item (@responses) {
8715: my ($key,$value) = split(/=/,$item);
8716: $$photo{$key} = $value;
8717: }
8718: return $outcome;
8719: }
8720: return 'error';
8721: }
8722:
1.521 raeburn 8723: sub auto_instcode_format {
1.793 albertel 8724: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8725: $cat_order) = @_;
1.521 raeburn 8726: my $courses = '';
1.772 raeburn 8727: my @homeservers;
1.521 raeburn 8728: if ($caller eq 'global') {
1.841 albertel 8729: my %servers = &get_servers($codedom,'library');
8730: foreach my $tryserver (keys(%servers)) {
8731: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8732: push(@homeservers,$tryserver);
8733: }
1.584 raeburn 8734: }
1.1022 raeburn 8735: } elsif ($caller eq 'requests') {
8736: if ($codedom =~ /^$match_domain$/) {
8737: my $chome = &domain($codedom,'primary');
8738: unless ($chome eq 'no_host') {
8739: push(@homeservers,$chome);
8740: }
8741: }
1.521 raeburn 8742: } else {
1.772 raeburn 8743: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 8744: }
1.793 albertel 8745: foreach my $code (keys(%{$instcodes})) {
8746: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 8747: }
8748: chop($courses);
1.772 raeburn 8749: my $ok_response = 0;
8750: my $response;
8751: while (@homeservers > 0 && $ok_response == 0) {
8752: my $server = shift(@homeservers);
8753: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8754: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8755: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 8756: split(/:/,$response);
1.772 raeburn 8757: %{$codes} = (%{$codes},&str2hash($codes_str));
8758: push(@{$codetitles},&str2array($codetitles_str));
8759: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8760: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8761: $ok_response = 1;
8762: }
8763: }
8764: if ($ok_response) {
1.521 raeburn 8765: return 'ok';
1.772 raeburn 8766: } else {
8767: return $response;
1.521 raeburn 8768: }
8769: }
8770:
1.792 raeburn 8771: sub auto_instcode_defaults {
8772: my ($domain,$returnhash,$code_order) = @_;
8773: my @homeservers;
1.841 albertel 8774:
8775: my %servers = &get_servers($domain,'library');
8776: foreach my $tryserver (keys(%servers)) {
8777: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8778: push(@homeservers,$tryserver);
8779: }
1.792 raeburn 8780: }
1.841 albertel 8781:
1.792 raeburn 8782: my $response;
1.841 albertel 8783: foreach my $server (@homeservers) {
1.792 raeburn 8784: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 8785: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8786:
8787: foreach my $pair (split(/\&/,$response)) {
8788: my ($name,$value)=split(/\=/,$pair);
8789: if ($name eq 'code_order') {
8790: @{$code_order} = split(/\&/,&unescape($value));
8791: } else {
8792: $returnhash->{&unescape($name)}=&unescape($value);
8793: }
8794: }
8795: return 'ok';
1.792 raeburn 8796: }
1.841 albertel 8797:
8798: return $response;
1.1003 raeburn 8799: }
8800:
8801: sub auto_possible_instcodes {
1.1007 raeburn 8802: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8803: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8804: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8805: return;
8806: }
1.1003 raeburn 8807: my (@homeservers,$uhome);
8808: if (defined(&domain($domain,'primary'))) {
8809: $uhome=&domain($domain,'primary');
8810: push(@homeservers,&domain($domain,'primary'));
8811: } else {
8812: my %servers = &get_servers($domain,'library');
8813: foreach my $tryserver (keys(%servers)) {
8814: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8815: push(@homeservers,$tryserver);
8816: }
8817: }
8818: }
8819: my $response;
8820: foreach my $server (@homeservers) {
8821: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8822: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 8823: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8824: split(':',$response);
8825: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8826: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 8827: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 8828: my ($name,$value)=split('=',$item);
8829: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8830: }
8831: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 8832: my ($name,$value)=split('=',$item);
8833: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8834: }
8835: return 'ok';
8836: }
8837: return $response;
8838: }
1.792 raeburn 8839:
1.1010 raeburn 8840: sub auto_courserequest_checks {
8841: my ($dom) = @_;
1.1020 raeburn 8842: my ($homeserver,%validations);
8843: if ($dom =~ /^$match_domain$/) {
8844: $homeserver = &domain($dom,'primary');
8845: }
8846: unless ($homeserver eq 'no_host') {
8847: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8848: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8849: my @items = split(/&/,$response);
8850: foreach my $item (@items) {
8851: my ($key,$value) = split('=',$item);
8852: $validations{&unescape($key)} = &thaw_unescape($value);
8853: }
8854: }
8855: }
1.1010 raeburn 8856: return %validations;
8857: }
8858:
1.1020 raeburn 8859: sub auto_courserequest_validation {
1.1255 raeburn 8860: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 8861: my ($homeserver,$response);
8862: if ($dom =~ /^$match_domain$/) {
8863: $homeserver = &domain($dom,'primary');
8864: }
1.1255 raeburn 8865: unless ($homeserver eq 'no_host') {
8866: my $customdata;
8867: if (ref($custominfo) eq 'HASH') {
8868: $customdata = &freeze_escape($custominfo);
8869: }
1.1020 raeburn 8870: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 8871: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255 raeburn 8872: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8873: $customdata,$homeserver));
1.1020 raeburn 8874: }
8875: return $response;
8876: }
8877:
1.777 albertel 8878: sub auto_validate_class_sec {
1.918 raeburn 8879: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 8880: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 8881: my $ownerlist;
8882: if (ref($owners) eq 'ARRAY') {
8883: $ownerlist = join(',',@{$owners});
8884: } else {
8885: $ownerlist = $owners;
8886: }
1.773 raeburn 8887: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 8888: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 8889: return $response;
8890: }
8891:
1.1248 raeburn 8892: sub auto_crsreq_update {
8893: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257 raeburn 8894: $code,$accessstart,$accessend,$inbound) = @_;
1.1248 raeburn 8895: my ($homeserver,%crsreqresponse);
8896: if ($cdom =~ /^$match_domain$/) {
8897: $homeserver = &domain($cdom,'primary');
8898: }
8899: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8900: my $info;
8901: if (ref($inbound) eq 'HASH') {
8902: $info = &freeze_escape($inbound);
8903: }
8904: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8905: ':'.&escape($action).':'.&escape($ownername).':'.
8906: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257 raeburn 8907: &escape($title).':'.&escape($code).':'.
8908: &escape($accessstart).':'.&escape($accessend).':'.$info,
8909: $homeserver);
1.1248 raeburn 8910: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8911: my @items = split(/&/,$response);
8912: foreach my $item (@items) {
8913: my ($key,$value) = split('=',$item);
8914: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8915: }
8916: }
8917: }
8918: return \%crsreqresponse;
8919: }
8920:
1.1305 raeburn 8921: sub auto_export_grades {
1.1309 raeburn 8922: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8923: my ($homeserver,%exportresponse);
8924: if ($cdom =~ /^$match_domain$/) {
8925: $homeserver = &domain($cdom,'primary');
8926: }
8927: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8928: my $info;
8929: if (ref($inforef) eq 'HASH') {
8930: $info = &freeze_escape($inforef);
8931: }
8932: if (ref($gradesref) eq 'HASH') {
8933: my $grades = &freeze_escape($gradesref);
8934: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8935: $info.':'.$grades,$homeserver);
8936: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8937: my @items = split(/&/,$response);
8938: foreach my $item (@items) {
8939: my ($key,$value) = split('=',$item);
8940: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8941: }
8942: }
8943: }
8944: }
8945: return \%exportresponse;
1.1305 raeburn 8946: }
8947:
1.1287 raeburn 8948: sub check_instcode_cloning {
8949: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8950: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8951: return;
8952: }
8953: my $canclone;
8954: if (@{$code_order} > 0) {
8955: my $instcoderegexp ='^';
8956: my @clonecodes = split(/\&/,$cloner);
8957: foreach my $item (@{$code_order}) {
8958: if (grep(/^\Q$item\E=/,@clonecodes)) {
8959: foreach my $pair (@clonecodes) {
8960: my ($key,$val) = split(/\=/,$pair,2);
8961: $val = &unescape($val);
8962: if ($key eq $item) {
8963: $instcoderegexp .= '('.$val.')';
8964: last;
8965: }
8966: }
8967: } else {
8968: $instcoderegexp .= $codedefaults->{$item};
8969: }
8970: }
8971: $instcoderegexp .= '$';
8972: my (@from,@to);
8973: eval {
8974: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8975: (@to) = ($clonetocode =~ /$instcoderegexp/);
8976: };
8977: if ((@from > 0) && (@to > 0)) {
8978: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8979: if (!@diffs) {
8980: $canclone = 1;
8981: }
8982: }
8983: }
8984: return $canclone;
8985: }
8986:
8987: sub default_instcode_cloning {
8988: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
8989: my (%codedefaults,@code_order,$canclone);
8990: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
8991: %codedefaults = %{$codedefaultsref};
8992: @code_order = @{$codeorderref};
8993: } elsif ($clonedom) {
8994: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
8995: }
8996: if (($domdefclone) && (@code_order)) {
8997: my @clonecodes = split(/\+/,$domdefclone);
8998: my $instcoderegexp ='^';
8999: foreach my $item (@code_order) {
9000: if (grep(/^\Q$item\E$/,@clonecodes)) {
9001: $instcoderegexp .= '('.$codedefaults{$item}.')';
9002: } else {
9003: $instcoderegexp .= $codedefaults{$item};
9004: }
9005: }
9006: $instcoderegexp .= '$';
9007: my (@from,@to);
9008: eval {
9009: (@from) = ($clonefromcode =~ /$instcoderegexp/);
9010: (@to) = ($clonetocode =~ /$instcoderegexp/);
9011: };
9012: if ((@from > 0) && (@to > 0)) {
9013: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
9014: if (!@diffs) {
9015: $canclone = 1;
9016: }
9017: }
9018: }
9019: return $canclone;
9020: }
9021:
1.679 raeburn 9022: # ------------------------------------------------------- Course Group routines
9023:
9024: sub get_coursegroups {
1.809 raeburn 9025: my ($cdom,$cnum,$group,$namespace) = @_;
9026: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 9027: }
9028:
1.679 raeburn 9029: sub modify_coursegroup {
9030: my ($cdom,$cnum,$groupsettings) = @_;
9031: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
9032: }
9033:
1.809 raeburn 9034: sub toggle_coursegroup_status {
9035: my ($cdom,$cnum,$group,$action) = @_;
9036: my ($from_namespace,$to_namespace);
9037: if ($action eq 'delete') {
9038: $from_namespace = 'coursegroups';
9039: $to_namespace = 'deleted_groups';
9040: } else {
9041: $from_namespace = 'deleted_groups';
9042: $to_namespace = 'coursegroups';
9043: }
9044: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 9045: if (my $tmp = &error(%curr_group)) {
9046: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
9047: return ('read error',$tmp);
9048: } else {
9049: my %savedsettings = %curr_group;
1.809 raeburn 9050: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 9051: my $deloutcome;
9052: if ($result eq 'ok') {
1.809 raeburn 9053: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 9054: } else {
9055: return ('write error',$result);
9056: }
9057: if ($deloutcome eq 'ok') {
9058: return 'ok';
9059: } else {
9060: return ('delete error',$deloutcome);
9061: }
9062: }
9063: }
9064:
1.679 raeburn 9065: sub modify_group_roles {
1.957 raeburn 9066: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 9067: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
9068: my $role = 'gr/'.&escape($userprivs);
9069: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 9070: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 9071: if ($result eq 'ok') {
9072: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
9073: }
1.679 raeburn 9074: return $result;
9075: }
9076:
9077: sub modify_coursegroup_membership {
9078: my ($cdom,$cnum,$membership) = @_;
9079: my $result = &put('groupmembership',$membership,$cdom,$cnum);
9080: return $result;
9081: }
9082:
1.682 raeburn 9083: sub get_active_groups {
9084: my ($udom,$uname,$cdom,$cnum) = @_;
9085: my $now = time;
9086: my %groups = ();
9087: foreach my $key (keys(%env)) {
1.811 albertel 9088: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 9089: my ($start,$end) = split(/\./,$env{$key});
9090: if (($end!=0) && ($end<$now)) { next; }
9091: if (($start!=0) && ($start>$now)) { next; }
9092: if ($1 eq $cdom && $2 eq $cnum) {
9093: $groups{$3} = $env{$key} ;
9094: }
9095: }
9096: }
9097: return %groups;
9098: }
9099:
1.683 raeburn 9100: sub get_group_membership {
9101: my ($cdom,$cnum,$group) = @_;
9102: return(&dump('groupmembership',$cdom,$cnum,$group));
9103: }
9104:
9105: sub get_users_groups {
9106: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 9107: my @usersgroups;
1.683 raeburn 9108: my $cachetime=1800;
9109:
9110: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 9111: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
9112: if (defined($cached)) {
1.734 albertel 9113: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 9114: } else {
9115: $grouplist = '';
1.816 raeburn 9116: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 9117: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 9118: my $access_end = $env{'course.'.$courseid.
9119: '.default_enrollment_end_date'};
9120: my $now = time;
9121: foreach my $key (keys(%roleshash)) {
9122: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
9123: my $group = $1;
9124: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
9125: my $start = $2;
9126: my $end = $1;
9127: if ($start == -1) { next; } # deleted from group
9128: if (($start!=0) && ($start>$now)) { next; }
9129: if (($end!=0) && ($end<$now)) {
9130: if ($access_end && $access_end < $now) {
9131: if ($access_end - $end < 86400) {
9132: push(@usersgroups,$group);
1.733 raeburn 9133: }
9134: }
1.817 raeburn 9135: next;
1.733 raeburn 9136: }
1.817 raeburn 9137: push(@usersgroups,$group);
1.683 raeburn 9138: }
9139: }
9140: }
1.817 raeburn 9141: @usersgroups = &sort_course_groups($courseid,@usersgroups);
9142: $grouplist = join(':',@usersgroups);
9143: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 9144: }
1.733 raeburn 9145: return @usersgroups;
1.683 raeburn 9146: }
9147:
9148: sub devalidate_getgroups_cache {
9149: my ($udom,$uname,$cdom,$cnum)=@_;
9150: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 9151:
1.683 raeburn 9152: my $hashid="$udom:$uname:$courseid";
9153: &devalidate_cache_new('getgroups',$hashid);
9154: }
9155:
1.12 www 9156: # ------------------------------------------------------------------ Plain Text
9157:
9158: sub plaintext {
1.988 raeburn 9159: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 9160: if ($short =~ m{^cr/}) {
1.758 albertel 9161: return (split('/',$short))[-1];
9162: }
1.742 raeburn 9163: if (!defined($cid)) {
9164: $cid = $env{'request.course.id'};
9165: }
9166: my %rolenames = (
1.1008 raeburn 9167: Course => 'std',
9168: Community => 'alt1',
1.1305 raeburn 9169: Placement => 'std',
1.742 raeburn 9170: );
1.1037 raeburn 9171: if ($cid ne '') {
9172: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
9173: unless ($forcedefault) {
9174: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
9175: &Apache::lonlocal::mt_escape(\$roletext);
9176: return &Apache::lonlocal::mt($roletext);
9177: }
9178: }
9179: }
9180: if ((defined($type)) && (defined($rolenames{$type})) &&
9181: (defined($rolenames{$type})) &&
9182: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 9183: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 9184: } elsif ($cid ne '') {
9185: my $crstype = $env{'course.'.$cid.'.type'};
9186: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
9187: (defined($prp{$short}{$rolenames{$crstype}}))) {
9188: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
9189: }
1.742 raeburn 9190: }
1.1037 raeburn 9191: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 9192: }
9193:
9194: # ----------------------------------------------------------------- Assign Role
9195:
9196: sub assignrole {
1.957 raeburn 9197: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
9198: $context)=@_;
1.21 www 9199: my $mrole;
9200: if ($role =~ /^cr\//) {
1.393 www 9201: my $cwosec=$url;
1.811 albertel 9202: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 9203: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 9204: my $refused = 1;
9205: if ($context eq 'requestcourses') {
9206: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
9207: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
9208: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
9209: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
9210: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9211: if ($crsenv{'internal.courseowner'} eq
9212: $env{'user.name'}.':'.$env{'user.domain'}) {
9213: $refused = '';
9214: }
9215: }
9216: }
9217: }
9218: }
9219: if ($refused) {
9220: &logthis('Refused custom assignrole: '.
9221: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
9222: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
9223: return 'refused';
9224: }
1.104 www 9225: }
1.21 www 9226: $mrole='cr';
1.678 raeburn 9227: } elsif ($role =~ /^gr\//) {
9228: my $cwogrp=$url;
1.811 albertel 9229: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 9230: unless (&allowed('mdg',$cwogrp)) {
9231: &logthis('Refused group assignrole: '.
9232: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
9233: $env{'user.name'}.' at '.$env{'user.domain'});
9234: return 'refused';
9235: }
9236: $mrole='gr';
1.21 www 9237: } else {
1.82 www 9238: my $cwosec=$url;
1.811 albertel 9239: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 9240: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
9241: my $refused;
9242: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
9243: if (!(&allowed('c'.$role,$url))) {
9244: $refused = 1;
9245: }
9246: } else {
9247: $refused = 1;
9248: }
1.947 raeburn 9249: if ($refused) {
1.1045 raeburn 9250: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
9251: if (!$selfenroll && $context eq 'course') {
9252: my %crsenv;
9253: if ($role eq 'cc' || $role eq 'co') {
9254: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9255: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
9256: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
9257: if ($crsenv{'internal.courseowner'} eq
9258: $env{'user.name'}.':'.$env{'user.domain'}) {
9259: $refused = '';
9260: }
9261: }
9262: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
9263: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
9264: if ($crsenv{'internal.courseowner'} eq
9265: $env{'user.name'}.':'.$env{'user.domain'}) {
9266: $refused = '';
9267: }
9268: }
9269: }
9270: }
9271: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 9272: $refused = '';
1.1017 raeburn 9273: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 9274: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 9275: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 9276: my $wrongcc;
9277: if ($cnum =~ /^$match_community$/) {
9278: $wrongcc = 1 if ($role eq 'cc');
9279: } else {
9280: $wrongcc = 1 if ($role eq 'co');
9281: }
9282: unless ($wrongcc) {
9283: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
9284: if ($crsenv{'internal.courseowner'} eq
9285: $env{'user.name'}.':'.$env{'user.domain'}) {
9286: $refused = '';
9287: }
1.1017 raeburn 9288: }
9289: }
1.1183 raeburn 9290: } elsif ($context eq 'requestauthor') {
9291: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
9292: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
9293: if ($env{'environment.requestauthor'} eq 'automatic') {
9294: $refused = '';
9295: } else {
9296: my %domdefaults = &get_domain_defaults($udom);
9297: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
9298: my $checkbystatus;
9299: if ($env{'user.adv'}) {
9300: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
9301: if ($disposition eq 'automatic') {
9302: $refused = '';
9303: } elsif ($disposition eq '') {
9304: $checkbystatus = 1;
9305: }
9306: } else {
9307: $checkbystatus = 1;
9308: }
9309: if ($checkbystatus) {
9310: if ($env{'environment.inststatus'}) {
9311: my @inststatuses = split(/,/,$env{'environment.inststatus'});
9312: foreach my $type (@inststatuses) {
9313: if (($type ne '') &&
9314: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
9315: $refused = '';
9316: }
9317: }
9318: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
9319: $refused = '';
9320: }
9321: }
9322: }
9323: }
9324: }
1.1017 raeburn 9325: }
9326: if ($refused) {
1.947 raeburn 9327: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
9328: ' '.$role.' '.$end.' '.$start.' by '.
9329: $env{'user.name'}.' at '.$env{'user.domain'});
9330: return 'refused';
9331: }
1.932 raeburn 9332: }
1.1131 raeburn 9333: } elsif ($role eq 'au') {
9334: if ($url ne '/'.$udom.'/') {
9335: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
9336: ' to assign author role for '.$uname.':'.$udom.
9337: ' in domain: '.$url.' refused (wrong domain).');
9338: return 'refused';
9339: }
1.104 www 9340: }
1.21 www 9341: $mrole=$role;
9342: }
1.620 albertel 9343: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 9344: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 9345: if ($end) { $command.='_'.$end; }
1.21 www 9346: if ($start) {
9347: if ($end) {
1.81 www 9348: $command.='_'.$start;
1.21 www 9349: } else {
1.81 www 9350: $command.='_0_'.$start;
1.21 www 9351: }
9352: }
1.739 raeburn 9353: my $origstart = $start;
9354: my $origend = $end;
1.957 raeburn 9355: my $delflag;
1.357 www 9356: # actually delete
9357: if ($deleteflag) {
1.373 www 9358: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 9359: # modify command to delete the role
1.620 albertel 9360: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 9361: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 9362: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 9363: # set start and finish to negative values for userrolelog
9364: $start=-1;
9365: $end=-1;
1.957 raeburn 9366: $delflag = 1;
1.357 www 9367: }
9368: }
9369: # send command
1.349 www 9370: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 9371: # log new user role if status is ok
1.349 www 9372: if ($answer eq 'ok') {
1.663 raeburn 9373: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 9374: if (($role eq 'cc') || ($role eq 'in') ||
9375: ($role eq 'ep') || ($role eq 'ad') ||
9376: ($role eq 'ta') || ($role eq 'st') ||
9377: ($role=~/^cr/) || ($role eq 'gr') ||
9378: ($role eq 'co')) {
1.1200 raeburn 9379: # for course roles, perform group memberships changes triggered by role change.
9380: unless ($role =~ /^gr/) {
9381: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
9382: $origstart,$selfenroll,$context);
9383: }
1.1184 raeburn 9384: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9385: $selfenroll,$context);
9386: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1334 raeburn 9387: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
9388: ($role eq 'da')) {
1.1184 raeburn 9389: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9390: $context);
9391: } elsif (($role eq 'ca') || ($role eq 'aa')) {
9392: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9393: $context);
9394: }
1.1053 raeburn 9395: if ($role eq 'cc') {
9396: &autoupdate_coowners($url,$end,$start,$uname,$udom);
9397: }
1.349 www 9398: }
9399: return $answer;
1.169 harris41 9400: }
9401:
1.1053 raeburn 9402: sub autoupdate_coowners {
9403: my ($url,$end,$start,$uname,$udom) = @_;
9404: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
9405: if (($cdom ne '') && ($cnum ne '')) {
9406: my $now = time;
9407: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
9408: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
9409: my %coursehash = &coursedescription($cdom.'_'.$cnum);
9410: my $instcode = $coursehash{'internal.coursecode'};
9411: if ($instcode ne '') {
1.1056 raeburn 9412: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
9413: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 9414: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 9415: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
9416: if ($result eq 'valid') {
9417: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 9418: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9419: push(@newcoowners,$coowner);
9420: }
9421: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
9422: push(@newcoowners,$uname.':'.$udom);
9423: }
9424: @newcoowners = sort(@newcoowners);
9425: } else {
9426: push(@newcoowners,$uname.':'.$udom);
9427: }
9428: } else {
9429: if ($coursehash{'internal.co-owners'}) {
9430: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9431: unless ($coowner eq $uname.':'.$udom) {
9432: push(@newcoowners,$coowner);
9433: }
9434: }
9435: unless (@newcoowners > 0) {
9436: $delcoowners = 1;
9437: $coowners = '';
9438: }
9439: }
9440: }
9441: if (@newcoowners || $delcoowners) {
9442: &store_coowners($cdom,$cnum,$coursehash{'home'},
9443: $delcoowners,@newcoowners);
9444: }
9445: }
9446: }
9447: }
9448: }
9449: }
9450: }
9451:
9452: sub store_coowners {
9453: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
9454: my $cid = $cdom.'_'.$cnum;
9455: my ($coowners,$delresult,$putresult);
9456: if (@newcoowners) {
9457: $coowners = join(',',@newcoowners);
9458: my %coownershash = (
9459: 'internal.co-owners' => $coowners,
9460: );
9461: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
9462: if ($putresult eq 'ok') {
9463: if ($env{'course.'.$cid.'.num'} eq $cnum) {
9464: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
9465: }
9466: }
9467: }
9468: if ($delcoowners) {
9469: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
9470: if ($delresult eq 'ok') {
9471: if ($env{'course.'.$cid.'.internal.co-owners'}) {
9472: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
9473: }
9474: }
9475: }
9476: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
9477: my %crsinfo =
9478: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
9479: if (ref($crsinfo{$cid}) eq 'HASH') {
9480: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
9481: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
9482: }
9483: }
9484: }
9485:
1.169 harris41 9486: # -------------------------------------------------- Modify user authentication
1.197 www 9487: # Overrides without validation
9488:
1.169 harris41 9489: sub modifyuserauth {
9490: my ($udom,$uname,$umode,$upass)=@_;
9491: my $uhome=&homeserver($uname,$udom);
1.197 www 9492: unless (&allowed('mau',$udom)) { return 'refused'; }
9493: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 9494: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9495: ' in domain '.$env{'request.role.domain'});
1.169 harris41 9496: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
9497: &escape($upass),$uhome);
1.620 albertel 9498: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 9499: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
9500: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9501: &log($udom,,$uname,$uhome,
1.620 albertel 9502: 'Authentication changed by '.$env{'user.domain'}.', '.
9503: $env{'user.name'}.', '.$umode.
1.197 www 9504: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 9505: unless ($reply eq 'ok') {
1.197 www 9506: &logthis('Authentication mode error: '.$reply);
1.169 harris41 9507: return 'error: '.$reply;
9508: }
1.170 harris41 9509: return 'ok';
1.80 www 9510: }
9511:
1.81 www 9512: # --------------------------------------------------------------- Modify a user
1.80 www 9513:
1.81 www 9514: sub modifyuser {
1.206 matthew 9515: my ($udom, $uname, $uid,
9516: $umode, $upass, $first,
9517: $middle, $last, $gene,
1.1058 raeburn 9518: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 9519: $udom= &LONCAPA::clean_domain($udom);
9520: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 9521: my $showcandelete = 'none';
9522: if (ref($candelete) eq 'ARRAY') {
9523: if (@{$candelete} > 0) {
9524: $showcandelete = join(', ',@{$candelete});
9525: }
9526: }
1.81 www 9527: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 9528: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 9529: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 9530: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
9531: ' desiredhome not specified').
1.620 albertel 9532: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9533: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 9534: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 9535: my $newuser;
9536: if ($uhome eq 'no_host') {
9537: $newuser = 1;
9538: }
1.80 www 9539: # ----------------------------------------------------------------- Create User
1.406 albertel 9540: if (($uhome eq 'no_host') &&
9541: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 9542: my $unhome='';
1.844 albertel 9543: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 9544: $unhome = $desiredhome;
1.620 albertel 9545: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
9546: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 9547: } else { # load balancing routine for determining $unhome
1.81 www 9548: my $loadm=10000000;
1.841 albertel 9549: my %servers = &get_servers($udom,'library');
9550: foreach my $tryserver (keys(%servers)) {
9551: my $answer=reply('load',$tryserver);
9552: if (($answer=~/\d+/) && ($answer<$loadm)) {
9553: $loadm=$answer;
9554: $unhome=$tryserver;
9555: }
1.80 www 9556: }
9557: }
9558: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 9559: return 'error: unable to find a home server for '.$uname.
9560: ' in domain '.$udom;
1.80 www 9561: }
9562: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
9563: &escape($upass),$unhome);
9564: unless ($reply eq 'ok') {
9565: return 'error: '.$reply;
9566: }
1.230 stredwic 9567: $uhome=&homeserver($uname,$udom,'true');
1.80 www 9568: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 9569: return 'error: unable verify users home machine.';
1.80 www 9570: }
1.209 matthew 9571: } # End of creation of new user
1.80 www 9572: # ---------------------------------------------------------------------- Add ID
9573: if ($uid) {
9574: $uid=~tr/A-Z/a-z/;
9575: my %uidhash=&idrget($udom,$uname);
1.196 www 9576: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
9577: && (!$forceid)) {
1.80 www 9578: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 9579: return 'error: user id "'.$uid.'" does not match '.
9580: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 9581: }
9582: } else {
1.1300 raeburn 9583: &idput($udom,{$uname => $uid},$uhome,'ids');
1.80 www 9584: }
9585: }
9586: # -------------------------------------------------------------- Add names, etc
1.313 matthew 9587: my @tmp=&get('environment',
1.899 raeburn 9588: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 9589: 'permanentemail','inststatus'],
1.134 albertel 9590: $udom,$uname);
1.1075 raeburn 9591: my (%names,%oldnames);
1.313 matthew 9592: if ($tmp[0] =~ m/^error:.*/) {
9593: %names=();
9594: } else {
9595: %names = @tmp;
1.1075 raeburn 9596: %oldnames = %names;
1.313 matthew 9597: }
1.388 www 9598: #
1.1058 raeburn 9599: # If name, email and/or uid are blank (e.g., because an uploaded file
9600: # of users did not contain them), do not overwrite existing values
9601: # unless field is in $candelete array ref.
9602: #
9603:
9604: my @fields = ('firstname','middlename','lastname','generation',
9605: 'permanentemail','id');
9606: my %newvalues;
9607: if (ref($candelete) eq 'ARRAY') {
9608: foreach my $field (@fields) {
9609: if (grep(/^\Q$field\E$/,@{$candelete})) {
9610: if ($field eq 'firstname') {
9611: $names{$field} = $first;
9612: } elsif ($field eq 'middlename') {
9613: $names{$field} = $middle;
9614: } elsif ($field eq 'lastname') {
9615: $names{$field} = $last;
9616: } elsif ($field eq 'generation') {
9617: $names{$field} = $gene;
9618: } elsif ($field eq 'permanentemail') {
9619: $names{$field} = $email;
9620: } elsif ($field eq 'id') {
9621: $names{$field} = $uid;
9622: }
9623: }
9624: }
9625: }
1.388 www 9626: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 9627: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 9628: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 9629: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 9630: if ($email) {
9631: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 9632: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 9633: }
1.899 raeburn 9634: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 9635: if (defined($inststatus)) {
9636: $names{'inststatus'} = '';
9637: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9638: if (ref($usertypes) eq 'HASH') {
9639: my @okstatuses;
9640: foreach my $item (split(/:/,$inststatus)) {
9641: if (defined($usertypes->{$item})) {
9642: push(@okstatuses,$item);
9643: }
9644: }
9645: if (@okstatuses) {
9646: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9647: }
9648: }
9649: }
1.1075 raeburn 9650: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 9651: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 9652: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 9653: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9654: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9655: } else {
9656: $logmsg .= ' during self creation';
9657: }
1.1075 raeburn 9658: my $changed;
9659: if ($newuser) {
9660: $changed = 1;
9661: } else {
9662: foreach my $field (@fields) {
9663: if ($names{$field} ne $oldnames{$field}) {
9664: $changed = 1;
9665: last;
9666: }
9667: }
9668: }
9669: unless ($changed) {
9670: $logmsg = 'No changes in user information needed for: '.$logmsg;
9671: &logthis($logmsg);
9672: return 'ok';
9673: }
9674: my $reply = &put('environment', \%names, $udom,$uname);
9675: if ($reply ne 'ok') {
9676: return 'error: '.$reply;
9677: }
1.1087 raeburn 9678: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9679: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9680: }
1.1075 raeburn 9681: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9682: &devalidate_cache_new('namescache',$uname.':'.$udom);
9683: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 9684: &logthis($logmsg);
1.134 albertel 9685: return 'ok';
1.80 www 9686: }
9687:
1.81 www 9688: # -------------------------------------------------------------- Modify student
1.80 www 9689:
1.81 www 9690: sub modifystudent {
9691: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 9692: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1314 raeburn 9693: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 9694: if (!$cid) {
1.620 albertel 9695: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9696: return 'not_in_class';
9697: }
1.80 www 9698: }
9699: # --------------------------------------------------------------- Make the user
1.81 www 9700: my $reply=&modifyuser
1.209 matthew 9701: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 9702: $desiredhome,$email,$inststatus);
1.80 www 9703: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 9704: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 9705: # student's environment
1.297 matthew 9706: $uid = undef if (!$forceid);
1.455 albertel 9707: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 9708: $gene,$usec,$end,$start,$type,$locktype,
1.1314 raeburn 9709: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 9710: return $reply;
9711: }
9712:
9713: sub modify_student_enrollment {
1.1216 raeburn 9714: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1314 raeburn 9715: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455 albertel 9716: my ($cdom,$cnum,$chome);
9717: if (!$cid) {
1.620 albertel 9718: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9719: return 'not_in_class';
9720: }
1.620 albertel 9721: $cdom=$env{'course.'.$cid.'.domain'};
9722: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 9723: } else {
9724: ($cdom,$cnum)=split(/_/,$cid);
9725: }
1.620 albertel 9726: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 9727: if (!$chome) {
1.457 raeburn 9728: $chome=&homeserver($cnum,$cdom);
1.297 matthew 9729: }
1.455 albertel 9730: if (!$chome) { return 'unknown_course'; }
1.297 matthew 9731: # Make sure the user exists
1.81 www 9732: my $uhome=&homeserver($uname,$udom);
9733: if (($uhome eq '') || ($uhome eq 'no_host')) {
9734: return 'error: no such user';
9735: }
1.297 matthew 9736: # Get student data if we were not given enough information
9737: if (!defined($first) || $first eq '' ||
9738: !defined($last) || $last eq '' ||
9739: !defined($uid) || $uid eq '' ||
9740: !defined($middle) || $middle eq '' ||
9741: !defined($gene) || $gene eq '') {
1.294 matthew 9742: # They did not supply us with enough data to enroll the student, so
9743: # we need to pick up more information.
1.297 matthew 9744: my %tmp = &get('environment',
1.294 matthew 9745: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 9746: ,$udom,$uname);
9747:
1.800 albertel 9748: #foreach my $key (keys(%tmp)) {
9749: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 9750: #}
1.294 matthew 9751: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9752: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9753: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 9754: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 9755: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9756: }
1.556 albertel 9757: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 9758: my $user = "$uname:$udom";
9759: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 9760: my $reply=cput('classlist',
1.1148 raeburn 9761: {$user =>
1.1314 raeburn 9762: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 9763: $cdom,$cnum);
1.1148 raeburn 9764: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9765: &devalidate_getsection_cache($udom,$uname,$cid);
9766: } else {
1.81 www 9767: return 'error: '.$reply;
9768: }
1.297 matthew 9769: # Add student role to user
1.83 www 9770: my $uurl='/'.$cid;
1.81 www 9771: $uurl=~s/\_/\//g;
9772: if ($usec) {
9773: $uurl.='/'.$usec;
9774: }
1.1148 raeburn 9775: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9776: $selfenroll,$context);
9777: if ($result ne 'ok') {
9778: if ($old_entry{$user} ne '') {
9779: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9780: } else {
9781: $reply = &del('classlist',[$user],$cdom,$cnum);
9782: }
9783: }
9784: return $result;
1.21 www 9785: }
9786:
1.556 albertel 9787: sub format_name {
9788: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9789: my $name;
9790: if ($first ne 'lastname') {
9791: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9792: } else {
9793: if ($lastname=~/\S/) {
9794: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9795: $name=~s/\s+,/,/;
9796: } else {
9797: $name.= $firstname.' '.$middlename.' '.$generation;
9798: }
9799: }
9800: $name=~s/^\s+//;
9801: $name=~s/\s+$//;
9802: $name=~s/\s+/ /g;
9803: return $name;
9804: }
9805:
1.84 www 9806: # ------------------------------------------------- Write to course preferences
9807:
9808: sub writecoursepref {
9809: my ($courseid,%prefs)=@_;
9810: $courseid=~s/^\///;
9811: $courseid=~s/\_/\//g;
9812: my ($cdomain,$cnum)=split(/\//,$courseid);
9813: my $chome=homeserver($cnum,$cdomain);
9814: if (($chome eq '') || ($chome eq 'no_host')) {
9815: return 'error: no such course';
9816: }
9817: my $cstring='';
1.800 albertel 9818: foreach my $pref (keys(%prefs)) {
9819: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 9820: }
1.84 www 9821: $cstring=~s/\&$//;
9822: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9823: }
9824:
9825: # ---------------------------------------------------------- Make/modify course
9826:
9827: sub createcourse {
1.741 raeburn 9828: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 9829: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 9830: $url=&declutter($url);
9831: my $cid='';
1.1028 raeburn 9832: if ($context eq 'requestcourses') {
9833: my $can_create = 0;
9834: my ($ownername,$ownerdom) = split(':',$course_owner);
9835: if ($udom eq $ownerdom) {
9836: if (&usertools_access($ownername,$ownerdom,$category,undef,
9837: $context)) {
9838: $can_create = 1;
9839: }
9840: } else {
9841: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9842: $category);
9843: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9844: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9845: if (@curr > 0) {
9846: my @options = qw(approval validate autolimit);
9847: my $optregex = join('|',@options);
9848: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9849: $can_create = 1;
9850: }
9851: }
9852: }
9853: }
9854: if ($can_create) {
9855: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9856: unless (&allowed('ccc',$udom)) {
9857: return 'refused';
9858: }
1.1017 raeburn 9859: }
9860: } else {
9861: return 'refused';
9862: }
1.1028 raeburn 9863: } elsif (!&allowed('ccc',$udom)) {
9864: return 'refused';
1.84 www 9865: }
1.1011 raeburn 9866: # --------------------------------------------------------------- Get Unique ID
9867: my $uname;
9868: if ($cnum =~ /^$match_courseid$/) {
9869: my $chome=&homeserver($cnum,$udom,'true');
9870: if (($chome eq '') || ($chome eq 'no_host')) {
9871: $uname = $cnum;
9872: } else {
1.1038 raeburn 9873: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9874: }
9875: } else {
1.1038 raeburn 9876: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9877: }
9878: return $uname if ($uname =~ /^error/);
9879: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 9880: if (!defined($course_server)) {
9881: if (defined(&domain($udom,'primary'))) {
9882: $course_server = &domain($udom,'primary');
9883: } else {
9884: $course_server = $env{'user.home'};
9885: }
9886: }
9887: my %host_servers =
9888: &Apache::lonnet::get_servers($udom,'library');
9889: unless ($host_servers{$course_server}) {
9890: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 9891: }
1.84 www 9892: # ------------------------------------------------------------- Make the course
9893: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 9894: $course_server);
1.84 www 9895: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 9896: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 9897: if (($uhome eq '') || ($uhome eq 'no_host')) {
9898: return 'error: no such course';
9899: }
1.271 www 9900: # ----------------------------------------------------------------- Course made
1.516 raeburn 9901: # log existence
1.1029 raeburn 9902: my $now = time;
1.918 raeburn 9903: my $newcourse = {
9904: $udom.'_'.$uname => {
1.921 raeburn 9905: description => $description,
9906: inst_code => $inst_code,
9907: owner => $course_owner,
9908: type => $crstype,
1.1029 raeburn 9909: creator => $env{'user.name'}.':'.
9910: $env{'user.domain'},
9911: created => $now,
9912: context => $context,
1.918 raeburn 9913: },
9914: };
1.921 raeburn 9915: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 9916: # set toplevel url
1.271 www 9917: my $topurl=$url;
9918: unless ($nonstandard) {
9919: # ------------------------------------------ For standard courses, make top url
9920: my $mapurl=&clutter($url);
1.278 www 9921: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 9922: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 9923: <map>
9924: <resource id="1" type="start"></resource>
9925: <resource id="2" src="$mapurl"></resource>
9926: <resource id="3" type="finish"></resource>
9927: <link index="1" from="1" to="2"></link>
9928: <link index="2" from="2" to="3"></link>
9929: </map>
9930: ENDINITMAP
9931: $topurl=&declutter(
1.638 albertel 9932: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 9933: );
9934: }
9935: # ----------------------------------------------------------- Write preferences
1.84 www 9936: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 9937: ('description' => $description,
9938: 'url' => $topurl,
9939: 'internal.creator' => $env{'user.name'}.':'.
9940: $env{'user.domain'},
9941: 'internal.created' => $now,
9942: 'internal.creationcontext' => $context)
9943: );
1.84 www 9944: return '/'.$udom.'/'.$uname;
9945: }
9946:
1.1011 raeburn 9947: # ------------------------------------------------------------------- Create ID
9948: sub generate_coursenum {
1.1038 raeburn 9949: my ($udom,$crstype) = @_;
1.1011 raeburn 9950: my $domdesc = &domain($udom);
9951: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 9952: my $first;
9953: if ($crstype eq 'Community') {
9954: $first = '0';
9955: } else {
9956: $first = int(1+rand(9));
9957: }
9958: my $uname=$first.
1.1011 raeburn 9959: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9960: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9961: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9962: # ----------------------------------------------- Make sure that does not exist
9963: my $uhome=&homeserver($uname,$udom,'true');
9964: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 9965: if ($crstype eq 'Community') {
9966: $first = '0';
9967: } else {
9968: $first = int(1+rand(9));
9969: }
9970: $uname=$first.
1.1011 raeburn 9971: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9972: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9973: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9974: $uhome=&homeserver($uname,$udom,'true');
9975: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9976: return 'error: unable to generate unique course-ID';
9977: }
9978: }
9979: return $uname;
9980: }
9981:
1.813 albertel 9982: sub is_course {
1.1167 droeschl 9983: my ($cdom, $cnum) = scalar(@_) == 1 ?
9984: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
9985:
9986: return unless $cdom and $cnum;
9987:
9988: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
9989: '.');
9990:
1.1219 raeburn 9991: return unless(exists($courses{$cdom.'_'.$cnum}));
1.1167 droeschl 9992: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 9993: }
9994:
1.1015 raeburn 9995: sub store_userdata {
9996: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 9997: my $result;
1.1016 raeburn 9998: if ($datakey ne '') {
1.1013 raeburn 9999: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 10000: if ($udom eq '' || $uname eq '') {
10001: $udom = $env{'user.domain'};
10002: $uname = $env{'user.name'};
10003: }
10004: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 10005: if (($uhome eq '') || ($uhome eq 'no_host')) {
10006: $result = 'error: no_host';
10007: } else {
10008: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
10009: $storehash->{'host'} = $perlvar{'lonHostID'};
10010:
10011: my $namevalue='';
10012: foreach my $key (keys(%{$storehash})) {
10013: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
10014: }
10015: $namevalue=~s/\&$//;
1.1224 raeburn 10016: unless ($namespace eq 'courserequests') {
10017: $datakey = &escape($datakey);
10018: }
1.1105 raeburn 10019: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
10020: $namevalue,$uhome);
1.1013 raeburn 10021: }
10022: } else {
10023: $result = 'error: data to store was not a hash reference';
10024: }
10025: } else {
10026: $result= 'error: invalid requestkey';
10027: }
10028: return $result;
10029: }
10030:
1.21 www 10031: # ---------------------------------------------------------- Assign Custom Role
10032:
10033: sub assigncustomrole {
1.957 raeburn 10034: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 10035: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 10036: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 10037: }
10038:
10039: # ----------------------------------------------------------------- Revoke Role
10040:
10041: sub revokerole {
1.957 raeburn 10042: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 10043: my $now=time;
1.965 raeburn 10044: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 10045: }
10046:
10047: # ---------------------------------------------------------- Revoke Custom Role
10048:
10049: sub revokecustomrole {
1.957 raeburn 10050: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 10051: my $now=time;
1.357 www 10052: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 10053: $deleteflag,$selfenroll,$context);
1.17 www 10054: }
10055:
1.533 banghart 10056: # ------------------------------------------------------------ Disk usage
1.535 albertel 10057: sub diskusage {
1.955 raeburn 10058: my ($udom,$uname,$directorypath,$getpropath)=@_;
10059: $directorypath =~ s/\/$//;
10060: my $listing=&reply('du2:'.&escape($directorypath).':'
10061: .&escape($getpropath).':'.&escape($uname).':'
10062: .&escape($udom),homeserver($uname,$udom));
10063: if ($listing eq 'unknown_cmd') {
10064: if ($getpropath) {
10065: $directorypath = &propath($udom,$uname).'/'.$directorypath;
10066: }
10067: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
10068: }
1.514 albertel 10069: return $listing;
1.512 banghart 10070: }
10071:
1.566 banghart 10072: sub is_locked {
1.1096 raeburn 10073: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 10074: my @check;
10075: my $is_locked;
1.1093 raeburn 10076: push (@check,$file_name);
1.613 albertel 10077: my %locked = &get('file_permissions',\@check,
1.620 albertel 10078: $env{'user.domain'},$env{'user.name'});
1.615 albertel 10079: my ($tmp)=keys(%locked);
10080: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 10081:
1.566 banghart 10082: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 10083: $is_locked = 'false';
10084: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 10085: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 10086: $is_locked = 'true';
1.1096 raeburn 10087: if (ref($which) eq 'ARRAY') {
10088: push(@{$which},$entry);
10089: } else {
10090: last;
10091: }
1.745 raeburn 10092: }
10093: }
1.566 banghart 10094: } else {
10095: $is_locked = 'false';
10096: }
1.1093 raeburn 10097: return $is_locked;
1.566 banghart 10098: }
10099:
1.759 albertel 10100: sub declutter_portfile {
10101: my ($file) = @_;
1.833 albertel 10102: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 10103: return $file;
10104: }
10105:
1.559 banghart 10106: # ------------------------------------------------------------- Mark as Read Only
10107:
10108: sub mark_as_readonly {
10109: my ($domain,$user,$files,$what) = @_;
1.613 albertel 10110: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 10111: my ($tmp)=keys(%current_permissions);
10112: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 10113: foreach my $file (@{$files}) {
1.759 albertel 10114: $file = &declutter_portfile($file);
1.561 banghart 10115: push(@{$current_permissions{$file}},$what);
1.559 banghart 10116: }
1.613 albertel 10117: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 10118: return;
10119: }
10120:
1.572 banghart 10121: # ------------------------------------------------------------Save Selected Files
10122:
10123: sub save_selected_files {
10124: my ($user, $path, @files) = @_;
10125: my $filename = $user."savedfiles";
1.573 banghart 10126: my @other_files = &files_not_in_path($user, $path);
1.1359 raeburn 10127: open (OUT,'>',LONCAPA::tempdir().$filename);
1.573 banghart 10128: foreach my $file (@files) {
1.620 albertel 10129: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 10130: }
10131: foreach my $file (@other_files) {
1.574 banghart 10132: print (OUT $file."\n");
1.572 banghart 10133: }
1.574 banghart 10134: close (OUT);
1.572 banghart 10135: return 'ok';
10136: }
10137:
1.574 banghart 10138: sub clear_selected_files {
10139: my ($user) = @_;
10140: my $filename = $user."savedfiles";
1.1359 raeburn 10141: open (OUT,'>',LONCAPA::tempdir().$filename);
1.574 banghart 10142: print (OUT undef);
10143: close (OUT);
10144: return ("ok");
10145: }
10146:
1.572 banghart 10147: sub files_in_path {
10148: my ($user, $path) = @_;
10149: my $filename = $user."savedfiles";
10150: my %return_files;
1.1359 raeburn 10151: open (IN,'<',LONCAPA::tempdir().$filename);
1.573 banghart 10152: while (my $line_in = <IN>) {
1.574 banghart 10153: chomp ($line_in);
10154: my @paths_and_file = split (m!/!, $line_in);
10155: my $file_part = pop (@paths_and_file);
10156: my $path_part = join ('/', @paths_and_file);
1.573 banghart 10157: $path_part.='/';
10158: my $path_and_file = $path_part.$file_part;
10159: if ($path_part eq $path) {
10160: $return_files{$file_part}= 'selected';
10161: }
10162: }
1.574 banghart 10163: close (IN);
10164: return (\%return_files);
1.572 banghart 10165: }
10166:
10167: # called in portfolio select mode, to show files selected NOT in current directory
10168: sub files_not_in_path {
10169: my ($user, $path) = @_;
10170: my $filename = $user."savedfiles";
10171: my @return_files;
10172: my $path_part;
1.1359 raeburn 10173: open(IN, '<',LONCAPA::tempdir().$filename);
1.800 albertel 10174: while (my $line = <IN>) {
1.572 banghart 10175: #ok, I know it's clunky, but I want it to work
1.800 albertel 10176: my @paths_and_file = split(m|/|, $line);
10177: my $file_part = pop(@paths_and_file);
10178: chomp($file_part);
10179: my $path_part = join('/', @paths_and_file);
1.572 banghart 10180: $path_part .= '/';
10181: my $path_and_file = $path_part.$file_part;
10182: if ($path_part ne $path) {
1.800 albertel 10183: push(@return_files, ($path_and_file));
1.572 banghart 10184: }
10185: }
1.800 albertel 10186: close(OUT);
1.574 banghart 10187: return (@return_files);
1.572 banghart 10188: }
10189:
1.1273 raeburn 10190: #------------------------------Submitted/Handedback Portfolio Files Versioning
10191:
10192: sub portfiles_versioning {
10193: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
10194: my $portfolio_root = '/userfiles/portfolio';
10195: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
10196: foreach my $file (@{$portfiles}) {
10197: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
10198: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
10199: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
10200: my $getpropath = 1;
10201: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
10202: $stu_name,$getpropath);
10203: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
10204: my $new_answer =
10205: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
10206: if ($new_answer ne 'problem getting file') {
10207: push(@{$versioned_portfiles}, $directory.$new_answer);
10208: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
10209: [$symb,$env{'request.course.id'},'graded']);
10210: }
10211: }
10212: }
10213:
10214: sub get_next_version {
10215: my ($answer_name, $answer_ext, $dir_list) = @_;
10216: my $version;
10217: if (ref($dir_list) eq 'ARRAY') {
10218: foreach my $row (@{$dir_list}) {
10219: my ($file) = split(/\&/,$row,2);
10220: my ($file_name,$file_version,$file_ext) =
10221: &file_name_version_ext($file);
10222: if (($file_name eq $answer_name) &&
10223: ($file_ext eq $answer_ext)) {
10224: # gets here if filename and extension match,
10225: # regardless of version
10226: if ($file_version ne '') {
10227: # a versioned file is found so save it for later
10228: if ($file_version > $version) {
10229: $version = $file_version;
10230: }
10231: }
10232: }
10233: }
10234: }
10235: $version ++;
10236: return($version);
10237: }
10238:
10239: sub version_selected_portfile {
10240: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
10241: my ($answer_name,$answer_ver,$answer_ext) =
10242: &file_name_version_ext($file_name);
10243: my $new_answer;
10244: $env{'form.copy'} =
10245: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
10246: if($env{'form.copy'} eq '-1') {
10247: $new_answer = 'problem getting file';
10248: } else {
10249: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
10250: my $copy_result =
10251: &finishuserfileupload($stu_name,$domain,'copy',
10252: '/portfolio'.$directory.$new_answer);
10253: }
10254: undef($env{'form.copy'});
10255: return ($new_answer);
10256: }
10257:
10258: sub file_name_version_ext {
10259: my ($file)=@_;
10260: my @file_parts = split(/\./, $file);
10261: my ($name,$version,$ext);
10262: if (@file_parts > 1) {
10263: $ext=pop(@file_parts);
10264: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
10265: $version=pop(@file_parts);
10266: }
10267: $name=join('.',@file_parts);
10268: } else {
10269: $name=join('.',@file_parts);
10270: }
10271: return($name,$version,$ext);
10272: }
10273:
1.745 raeburn 10274: #----------------------------------------------Get portfolio file permissions
1.629 banghart 10275:
1.745 raeburn 10276: sub get_portfile_permissions {
10277: my ($domain,$user) = @_;
1.613 albertel 10278: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 10279: my ($tmp)=keys(%current_permissions);
10280: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 10281: return \%current_permissions;
10282: }
10283:
10284: #---------------------------------------------Get portfolio file access controls
10285:
1.749 raeburn 10286: sub get_access_controls {
1.745 raeburn 10287: my ($current_permissions,$group,$file) = @_;
1.769 albertel 10288: my %access;
10289: my $real_file = $file;
10290: $file =~ s/\.meta$//;
1.745 raeburn 10291: if (defined($file)) {
1.749 raeburn 10292: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
10293: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 10294: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 10295: }
10296: }
1.745 raeburn 10297: } else {
1.749 raeburn 10298: foreach my $key (keys(%{$current_permissions})) {
10299: if ($key =~ /\0accesscontrol$/) {
10300: if (defined($group)) {
10301: if ($key !~ m-^\Q$group\E/-) {
10302: next;
10303: }
10304: }
10305: my ($fullpath) = split(/\0/,$key);
10306: if (ref($$current_permissions{$key}) eq 'HASH') {
10307: foreach my $control (keys(%{$$current_permissions{$key}})) {
10308: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
10309: }
10310: }
10311: }
10312: }
10313: }
10314: return %access;
10315: }
10316:
10317: sub modify_access_controls {
10318: my ($file_name,$changes,$domain,$user)=@_;
10319: my ($outcome,$deloutcome);
10320: my %store_permissions;
10321: my %new_values;
10322: my %new_control;
10323: my %translation;
10324: my @deletions = ();
10325: my $now = time;
10326: if (exists($$changes{'activate'})) {
10327: if (ref($$changes{'activate'}) eq 'HASH') {
10328: my @newitems = sort(keys(%{$$changes{'activate'}}));
10329: my $numnew = scalar(@newitems);
10330: for (my $i=0; $i<$numnew; $i++) {
10331: my $newkey = $newitems[$i];
10332: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 10333: if ($newkey =~ /^\d+:/) {
10334: $newkey =~ s/^(\d+)/$newid/;
10335: $translation{$1} = $newid;
10336: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
10337: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
10338: $translation{$1} = $newid;
10339: }
1.749 raeburn 10340: $new_values{$file_name."\0".$newkey} =
10341: $$changes{'activate'}{$newitems[$i]};
10342: $new_control{$newkey} = $now;
10343: }
10344: }
10345: }
10346: my %todelete;
10347: my %changed_items;
10348: foreach my $action ('delete','update') {
10349: if (exists($$changes{$action})) {
10350: if (ref($$changes{$action}) eq 'HASH') {
10351: foreach my $key (keys(%{$$changes{$action}})) {
10352: my ($itemnum) = ($key =~ /^([^:]+):/);
10353: if ($action eq 'delete') {
10354: $todelete{$itemnum} = 1;
10355: } else {
10356: $changed_items{$itemnum} = $key;
10357: }
10358: }
1.745 raeburn 10359: }
10360: }
1.749 raeburn 10361: }
10362: # get lock on access controls for file.
10363: my $lockhash = {
10364: $file_name."\0".'locked_access_records' => $env{'user.name'}.
10365: ':'.$env{'user.domain'},
10366: };
10367: my $tries = 0;
10368: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10369:
1.1288 damieng 10370: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 10371: $tries ++;
1.1289 damieng 10372: sleep(0.1);
1.749 raeburn 10373: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
10374: }
10375: if ($gotlock eq 'ok') {
10376: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
10377: my ($tmp)=keys(%curr_permissions);
10378: if ($tmp=~/^error:/) { undef(%curr_permissions); }
10379: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
10380: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
10381: if (ref($curr_controls) eq 'HASH') {
10382: foreach my $control_item (keys(%{$curr_controls})) {
10383: my ($itemnum) = ($control_item =~ /^([^:]+):/);
10384: if (defined($todelete{$itemnum})) {
10385: push(@deletions,$file_name."\0".$control_item);
10386: } else {
10387: if (defined($changed_items{$itemnum})) {
10388: $new_control{$changed_items{$itemnum}} = $now;
10389: push(@deletions,$file_name."\0".$control_item);
10390: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
10391: } else {
10392: $new_control{$control_item} = $$curr_controls{$control_item};
10393: }
10394: }
1.745 raeburn 10395: }
10396: }
10397: }
1.970 raeburn 10398: my ($group);
10399: if (&is_course($domain,$user)) {
10400: ($group,my $file) = split(/\//,$file_name,2);
10401: }
1.749 raeburn 10402: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
10403: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
10404: $outcome = &put('file_permissions',\%new_values,$domain,$user);
10405: # remove lock
10406: my @del_lock = ($file_name."\0".'locked_access_records');
10407: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 10408: my $sqlresult =
1.970 raeburn 10409: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 10410: $group);
1.749 raeburn 10411: } else {
10412: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 10413: }
1.749 raeburn 10414: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 10415: }
10416:
1.827 raeburn 10417: sub make_public_indefinitely {
1.1271 raeburn 10418: my (@requrl) = @_;
10419: return &automated_portfile_access('public',\@requrl);
10420: }
10421:
10422: sub automated_portfile_access {
10423: my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273 raeburn 10424: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
10425: return 'invalid';
10426: }
1.1271 raeburn 10427: my %urls;
10428: if (ref($addsref) eq 'ARRAY') {
10429: foreach my $requrl (@{$addsref}) {
10430: if (&is_portfolio_url($requrl)) {
10431: unless (exists($urls{$requrl})) {
10432: $urls{$requrl} = 'add';
10433: }
10434: }
10435: }
10436: }
10437: if (ref($delsref) eq 'ARRAY') {
10438: foreach my $requrl (@{$delsref}) {
10439: if (&is_portfolio_url($requrl)) {
10440: unless (exists($urls{$requrl})) {
10441: $urls{$requrl} = 'delete';
10442: }
10443: }
10444: }
10445: }
10446: unless (keys(%urls)) {
10447: return 'invalid';
10448: }
10449: my $ip;
10450: if ($accesstype eq 'ip') {
10451: if (ref($info) eq 'HASH') {
10452: if ($info->{'ip'} ne '') {
10453: $ip = $info->{'ip'};
10454: }
10455: }
10456: if ($ip eq '') {
10457: return 'invalid';
10458: }
10459: }
10460: my $errors;
1.827 raeburn 10461: my $now = time;
1.1271 raeburn 10462: my %current_perms;
10463: foreach my $requrl (sort(keys(%urls))) {
10464: my $action;
10465: if ($urls{$requrl} eq 'add') {
10466: $action = 'activate';
10467: } else {
10468: $action = 'none';
10469: }
10470: my $aclnum = 0;
1.827 raeburn 10471: my (undef,$udom,$unum,$file_name,$group) =
10472: &parse_portfolio_url($requrl);
1.1271 raeburn 10473: unless (exists($current_perms{$unum.':'.$udom})) {
10474: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
10475: }
10476: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827 raeburn 10477: $group,$file_name);
10478: foreach my $key (keys(%{$access_controls{$file_name}})) {
10479: my ($num,$scope,$end,$start) =
10480: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271 raeburn 10481: if ($scope eq $accesstype) {
10482: if (($start <= $now) && ($end == 0)) {
10483: if ($accesstype eq 'ip') {
10484: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
10485: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
10486: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
10487: if ($urls{$requrl} eq 'add') {
10488: $action = 'none';
10489: last;
10490: } else {
10491: $action = 'delete';
10492: $aclnum = $num;
10493: last;
10494: }
10495: }
10496: }
10497: }
10498: } elsif ($accesstype eq 'public') {
10499: if ($urls{$requrl} eq 'add') {
10500: $action = 'none';
10501: last;
10502: } else {
10503: $action = 'delete';
10504: $aclnum = $num;
10505: last;
10506: }
10507: }
10508: } elsif ($accesstype eq 'public') {
1.827 raeburn 10509: $action = 'update';
10510: $aclnum = $num;
1.1271 raeburn 10511: last;
1.827 raeburn 10512: }
10513: }
10514: }
10515: if ($action eq 'none') {
1.1271 raeburn 10516: next;
1.827 raeburn 10517: } else {
10518: my %changes;
10519: my $newend = 0;
10520: my $newstart = $now;
1.1271 raeburn 10521: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827 raeburn 10522: $changes{$action}{$newkey} = {
1.1271 raeburn 10523: type => $accesstype,
1.827 raeburn 10524: time => {
10525: start => $newstart,
10526: end => $newend,
10527: },
10528: };
1.1271 raeburn 10529: if ($accesstype eq 'ip') {
10530: $changes{$action}{$newkey}{'ip'} = [$ip];
10531: }
1.827 raeburn 10532: my ($outcome,$deloutcome,$new_values,$translation) =
10533: &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271 raeburn 10534: unless ($outcome eq 'ok') {
10535: $errors .= $outcome.' ';
10536: }
1.827 raeburn 10537: }
1.1271 raeburn 10538: }
10539: if ($errors) {
10540: $errors =~ s/\s$//;
10541: return $errors;
1.827 raeburn 10542: } else {
1.1271 raeburn 10543: return 'ok';
1.827 raeburn 10544: }
10545: }
10546:
1.745 raeburn 10547: #------------------------------------------------------Get Marked as Read Only
10548:
10549: sub get_marked_as_readonly {
10550: my ($domain,$user,$what,$group) = @_;
10551: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 10552: my @readonly_files;
1.629 banghart 10553: my $cmp1=$what;
10554: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 10555: while (my ($file_name,$value) = each(%{$current_permissions})) {
10556: if (defined($group)) {
10557: if ($file_name !~ m-^\Q$group\E/-) {
10558: next;
10559: }
10560: }
1.561 banghart 10561: if (ref($value) eq "ARRAY"){
10562: foreach my $stored_what (@{$value}) {
1.629 banghart 10563: my $cmp2=$stored_what;
1.759 albertel 10564: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 10565: $cmp2=join('',@{$stored_what});
1.745 raeburn 10566: }
1.629 banghart 10567: if ($cmp1 eq $cmp2) {
1.561 banghart 10568: push(@readonly_files, $file_name);
1.745 raeburn 10569: last;
1.563 banghart 10570: } elsif (!defined($what)) {
10571: push(@readonly_files, $file_name);
1.745 raeburn 10572: last;
1.561 banghart 10573: }
10574: }
1.745 raeburn 10575: }
1.561 banghart 10576: }
10577: return @readonly_files;
10578: }
1.577 banghart 10579: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 10580:
1.577 banghart 10581: sub get_marked_as_readonly_hash {
1.745 raeburn 10582: my ($current_permissions,$group,$what) = @_;
1.577 banghart 10583: my %readonly_files;
1.745 raeburn 10584: while (my ($file_name,$value) = each(%{$current_permissions})) {
10585: if (defined($group)) {
10586: if ($file_name !~ m-^\Q$group\E/-) {
10587: next;
10588: }
10589: }
1.577 banghart 10590: if (ref($value) eq "ARRAY"){
10591: foreach my $stored_what (@{$value}) {
1.745 raeburn 10592: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 10593: foreach my $lock_descriptor(@{$stored_what}) {
10594: if ($lock_descriptor eq 'graded') {
10595: $readonly_files{$file_name} = 'graded';
10596: } elsif ($lock_descriptor eq 'handback') {
10597: $readonly_files{$file_name} = 'handback';
10598: } else {
10599: if (!exists($readonly_files{$file_name})) {
10600: $readonly_files{$file_name} = 'locked';
10601: }
10602: }
1.745 raeburn 10603: }
1.750 banghart 10604: }
1.577 banghart 10605: }
10606: }
10607: }
10608: return %readonly_files;
10609: }
1.559 banghart 10610: # ------------------------------------------------------------ Unmark as Read Only
10611:
10612: sub unmark_as_readonly {
1.629 banghart 10613: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10614: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 10615: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 10616: $file_name = &declutter_portfile($file_name);
1.634 albertel 10617: my $symb_crs = $what;
10618: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 10619: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 10620: my ($tmp)=keys(%current_permissions);
10621: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 10622: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 10623: foreach my $file (@readonly_files) {
1.759 albertel 10624: my $clean_file = &declutter_portfile($file);
10625: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 10626: my $current_locks = $current_permissions{$file};
1.563 banghart 10627: my @new_locks;
10628: my @del_keys;
10629: if (ref($current_locks) eq "ARRAY"){
10630: foreach my $locker (@{$current_locks}) {
1.632 albertel 10631: my $compare=$locker;
1.749 raeburn 10632: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 10633: $compare=join('',@{$locker});
1.746 raeburn 10634: if ($compare ne $symb_crs) {
10635: push(@new_locks, $locker);
10636: }
1.563 banghart 10637: }
10638: }
1.650 albertel 10639: if (scalar(@new_locks) > 0) {
1.563 banghart 10640: $current_permissions{$file} = \@new_locks;
10641: } else {
10642: push(@del_keys, $file);
1.613 albertel 10643: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 10644: delete($current_permissions{$file});
1.563 banghart 10645: }
10646: }
1.561 banghart 10647: }
1.613 albertel 10648: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 10649: return;
10650: }
1.512 banghart 10651:
1.17 www 10652: # ------------------------------------------------------------ Directory lister
10653:
10654: sub dirlist {
1.955 raeburn 10655: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 10656: $uri=~s/^\///;
10657: $uri=~s/\/$//;
1.253 stredwic 10658: my ($udom, $uname);
1.955 raeburn 10659: if ($getuserdir) {
1.253 stredwic 10660: $udom = $userdomain;
10661: $uname = $username;
1.955 raeburn 10662: } else {
10663: (undef,$udom,$uname)=split(/\//,$uri);
10664: if(defined($userdomain)) {
10665: $udom = $userdomain;
10666: }
10667: if(defined($username)) {
10668: $uname = $username;
10669: }
1.253 stredwic 10670: }
1.955 raeburn 10671: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 10672:
1.955 raeburn 10673: $dirRoot = $perlvar{'lonDocRoot'};
10674: if (defined($getpropath)) {
10675: $dirRoot = &propath($udom,$uname);
1.253 stredwic 10676: $dirRoot =~ s/\/$//;
1.955 raeburn 10677: } elsif (defined($getuserdir)) {
10678: my $subdir=$uname.'__';
10679: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10680: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10681: ."/$udom/$subdir/$uname";
10682: } elsif (defined($alternateRoot)) {
10683: $dirRoot = $alternateRoot;
1.751 banghart 10684: }
1.253 stredwic 10685:
10686: if($udom) {
10687: if($uname) {
1.1135 raeburn 10688: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 10689: if ($uhome eq 'no_host') {
10690: return ([],'no_host');
10691: }
1.955 raeburn 10692: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 10693: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 10694: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 10695: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10696: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 10697: } else {
10698: @listing_results = map { &unescape($_); } split(/:/,$listing);
10699: }
1.605 matthew 10700: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10701: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 10702: @listing_results = split(/:/,$listing);
10703: } else {
10704: @listing_results = map { &unescape($_); } split(/:/,$listing);
10705: }
1.1135 raeburn 10706: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 10707: ($listing eq 'rejected') || ($listing eq 'refused') ||
10708: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10709: return ([],$listing);
10710: } else {
10711: return (\@listing_results);
1.1135 raeburn 10712: }
1.955 raeburn 10713: } elsif(!$alternateRoot) {
1.1136 raeburn 10714: my (%allusers,%listerror);
1.841 albertel 10715: my %servers = &get_servers($udom,'library');
1.955 raeburn 10716: foreach my $tryserver (keys(%servers)) {
10717: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10718: &escape($udom),$tryserver);
10719: if ($listing eq 'unknown_cmd') {
10720: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10721: $udom, $tryserver);
10722: } else {
10723: @listing_results = map { &unescape($_); } split(/:/,$listing);
10724: }
1.841 albertel 10725: if ($listing eq 'unknown_cmd') {
10726: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10727: $udom, $tryserver);
10728: @listing_results = split(/:/,$listing);
10729: } else {
10730: @listing_results =
10731: map { &unescape($_); } split(/:/,$listing);
10732: }
1.1136 raeburn 10733: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10734: ($listing eq 'rejected') || ($listing eq 'refused') ||
10735: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10736: $listerror{$tryserver} = $listing;
10737: } else {
1.841 albertel 10738: foreach my $line (@listing_results) {
10739: my ($entry) = split(/&/,$line,2);
10740: $allusers{$entry} = 1;
10741: }
10742: }
1.253 stredwic 10743: }
1.1136 raeburn 10744: my @alluserslist=();
1.800 albertel 10745: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 10746: push(@alluserslist,$user.'&user');
1.253 stredwic 10747: }
1.1318 droeschl 10748:
10749: if (!%listerror) {
10750: # no errors
10751: return (\@alluserslist);
10752: } elsif (scalar(keys(%servers)) == 1) {
10753: # one library server, one error
10754: my ($key) = keys(%listerror);
10755: return (\@alluserslist, $listerror{$key});
10756: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
10757: # con_lost indicates that we might miss data from at least one
10758: # library server
10759: return (\@alluserslist, 'con_lost');
10760: } else {
10761: # multiple library servers and no con_lost -> data should be
10762: # complete.
10763: return (\@alluserslist);
10764: }
10765:
1.253 stredwic 10766: } else {
1.1136 raeburn 10767: return ([],'missing username');
1.253 stredwic 10768: }
1.955 raeburn 10769: } elsif(!defined($getpropath)) {
1.1136 raeburn 10770: my $path = $perlvar{'lonDocRoot'}.'/res/';
10771: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10772: return (\@all_domains);
1.955 raeburn 10773: } else {
1.1136 raeburn 10774: return ([],'missing domain');
1.275 stredwic 10775: }
10776: }
10777:
10778: # --------------------------------------------- GetFileTimestamp
10779: # This function utilizes dirlist and returns the date stamp for
10780: # when it was last modified. It will also return an error of -1
10781: # if an error occurs
10782:
10783: sub GetFileTimestamp {
1.955 raeburn 10784: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 10785: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10786: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 10787: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10788: undef,$getuserdir);
10789: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10790: return -1;
10791: }
10792: if (ref($fileref) eq 'ARRAY') {
10793: my @stats = split('&',$fileref->[0]);
1.375 matthew 10794: # @stats contains first the filename, then the stat output
10795: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 10796: } else {
10797: return -1;
1.253 stredwic 10798: }
1.26 www 10799: }
10800:
1.712 albertel 10801: sub stat_file {
10802: my ($uri) = @_;
1.787 albertel 10803: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 10804:
1.955 raeburn 10805: my ($udom,$uname,$file);
1.712 albertel 10806: if ($uri =~ m-^/(uploaded|editupload)/-) {
10807: ($udom,$uname,$file) =
1.811 albertel 10808: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 10809: $file = 'userfiles/'.$file;
10810: }
10811: if ($uri =~ m-^/res/-) {
10812: ($udom,$uname) =
1.807 albertel 10813: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 10814: $file = $uri;
10815: }
10816:
10817: if (!$udom || !$uname || !$file) {
10818: # unable to handle the uri
10819: return ();
10820: }
1.956 raeburn 10821: my $getpropath;
10822: if ($file =~ /^userfiles\//) {
10823: $getpropath = 1;
10824: }
1.1136 raeburn 10825: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10826: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10827: return ();
10828: } else {
10829: if (ref($listref) eq 'ARRAY') {
10830: my @stats = split('&',$listref->[0]);
10831: shift(@stats); #filename is first
10832: return @stats;
10833: }
1.712 albertel 10834: }
10835: return ();
10836: }
10837:
1.1313 raeburn 10838: # --------------------------------------------------------- recursedirs
10839: # Recursive function to traverse either a specific user's Authoring Space
10840: # or corresponding Published Resource Space, and populate the hash ref:
10841: # $dirhashref with URLs of all directories, and if $filehashref hash
10842: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
10843: # or .rights files in resource space, and .meta, .save, .log, and .bak
10844: # files in Authoring Space.
10845: #
10846: # Inputs:
10847: #
10848: # $is_home - true if current server is home server for user's space
10849: # $context - either: priv, or res respectively for Authoring or Resource Space.
10850: # $docroot - Document root (i.e., /home/httpd/html
10851: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
10852: # $relpath - Current path (relative to top level).
10853: # $dirhashref - reference to hash to populate with URLs of directories (Required)
10854: # $filehashref - reference to hash to populate with URLs of files (Optional)
10855: #
10856: # Returns: nothing
10857: #
10858: # Side Effects: populates $dirhashref, and $filehashref (if provided).
10859: #
10860: # Currently used by interface/londocs.pm to create linked select boxes for
10861: # directory and filename to import a Course "Author" resource into a course, and
10862: # also to create linked select boxes for Authoring Space and Directory to choose
10863: # save location for creation of a new "standard" problem from the Course Editor.
10864: #
10865:
10866: sub recursedirs {
10867: my ($is_home,$context,$docroot,$toppath,$relpath,$dirhashref,$filehashref) = @_;
10868: return unless (ref($dirhashref) eq 'HASH');
10869: my $currpath = $docroot.$toppath;
10870: if ($relpath) {
10871: $currpath .= "/$relpath";
10872: }
10873: my $savefile;
10874: if (ref($filehashref)) {
10875: $savefile = 1;
10876: }
10877: if ($is_home) {
10878: if (opendir(my $dirh,$currpath)) {
10879: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
10880: next if ($item eq '');
10881: if (-d "$currpath/$item") {
10882: my $newpath;
10883: if ($relpath) {
10884: $newpath = "$relpath/$item";
10885: } else {
10886: $newpath = $item;
10887: }
10888: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10889: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10890: } elsif ($savefile) {
10891: if ($context eq 'priv') {
10892: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10893: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10894: }
10895: } else {
10896: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/) || ($item =~ /\.rights$/)) {
10897: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
10898: }
10899: }
10900: }
10901: }
10902: closedir($dirh);
10903: }
10904: } else {
10905: my ($dirlistref,$listerror) =
10906: &dirlist($toppath.$relpath);
10907: my @dir_lines;
10908: my $dirptr=16384;
10909: if (ref($dirlistref) eq 'ARRAY') {
10910: foreach my $dir_line (sort
10911: {
10912: my ($afile)=split('&',$a,2);
10913: my ($bfile)=split('&',$b,2);
10914: return (lc($afile) cmp lc($bfile));
10915: } (@{$dirlistref})) {
10916: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
10917: split(/\&/,$dir_line,16);
10918: $item =~ s/\s+$//;
10919: next if (($item =~ /^\.\.?$/) || ($obs));
10920: if ($dirptr&$testdir) {
10921: my $newpath;
10922: if ($relpath) {
10923: $newpath = "$relpath/$item";
10924: } else {
10925: $relpath = '/';
10926: $newpath = $item;
10927: }
10928: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
10929: &recursedirs($is_home,$context,$docroot,$toppath,$newpath,$dirhashref,$filehashref);
10930: } elsif ($savefile) {
10931: if ($context eq 'priv') {
10932: unless ($item =~ /\.(meta|save|log|bak|DS_Store)$/) {
10933: $filehashref->{$relpath}{$item} = 1;
10934: }
10935: } else {
10936: unless (($item =~ /\.meta$/) || ($item =~ /\.\d+\.\w+$/)) {
10937: $filehashref->{$relpath}{$item} = 1;
10938: }
10939: }
10940: }
10941: }
10942: }
10943: }
10944: return;
10945: }
10946:
1.26 www 10947: # -------------------------------------------------------- Value of a Condition
10948:
1.713 albertel 10949: # gets the value of a specific preevaluated condition
10950: # stored in the string $env{user.state.<cid>}
10951: # or looks up a condition reference in the bighash and if if hasn't
10952: # already been evaluated recurses into docondval to get the value of
10953: # the condition, then memoizing it to
10954: # $env{user.state.<cid>.<condition>}
1.40 www 10955: sub directcondval {
10956: my $number=shift;
1.620 albertel 10957: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 10958: &Apache::lonuserstate::evalstate();
10959: }
1.713 albertel 10960: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
10961: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
10962: } elsif ($number =~ /^_/) {
10963: my $sub_condition;
10964: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10965: &GDBM_READER(),0640)) {
10966: $sub_condition=$bighash{'conditions'.$number};
10967: untie(%bighash);
10968: }
10969: my $value = &docondval($sub_condition);
1.949 raeburn 10970: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 10971: return $value;
10972: }
1.620 albertel 10973: if ($env{'user.state.'.$env{'request.course.id'}}) {
10974: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 10975: } else {
10976: return 2;
10977: }
10978: }
10979:
1.713 albertel 10980: # get the collection of conditions for this resource
1.26 www 10981: sub condval {
10982: my $condidx=shift;
1.54 www 10983: my $allpathcond='';
1.713 albertel 10984: foreach my $cond (split(/\|/,$condidx)) {
10985: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
10986: $allpathcond.=
10987: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
10988: }
1.191 harris41 10989: }
1.54 www 10990: $allpathcond=~s/\|$//;
1.713 albertel 10991: return &docondval($allpathcond);
10992: }
10993:
10994: #evaluates an expression of conditions
10995: sub docondval {
10996: my ($allpathcond) = @_;
10997: my $result=0;
10998: if ($env{'request.course.id'}
10999: && defined($allpathcond)) {
11000: my $operand='|';
11001: my @stack;
11002: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
11003: if ($chunk eq '(') {
11004: push @stack,($operand,$result);
11005: } elsif ($chunk eq ')') {
11006: my $before=pop @stack;
11007: if (pop @stack eq '&') {
11008: $result=$result>$before?$before:$result;
11009: } else {
11010: $result=$result>$before?$result:$before;
11011: }
11012: } elsif (($chunk eq '&') || ($chunk eq '|')) {
11013: $operand=$chunk;
11014: } else {
11015: my $new=directcondval($chunk);
11016: if ($operand eq '&') {
11017: $result=$result>$new?$new:$result;
11018: } else {
11019: $result=$result>$new?$result:$new;
11020: }
11021: }
11022: }
1.26 www 11023: }
11024: return $result;
1.421 albertel 11025: }
11026:
11027: # ---------------------------------------------------- Devalidate courseresdata
11028:
11029: sub devalidatecourseresdata {
11030: my ($coursenum,$coursedomain)=@_;
11031: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 11032: &devalidate_cache_new('courseres',$hashid);
1.28 www 11033: }
11034:
1.763 www 11035:
1.200 www 11036: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 11037: #
11038: # Parameters:
11039: # $coursenum - Number of the course.
11040: # $coursedomain - Domain at which the course was created.
11041: # Returns:
11042: # A hash of the course parameters along (I think) with timestamps
11043: # and version info.
1.877 foxr 11044:
1.624 albertel 11045: sub get_courseresdata {
11046: my ($coursenum,$coursedomain)=@_;
1.200 www 11047: my $coursehom=&homeserver($coursenum,$coursedomain);
11048: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 11049: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 11050: my %dumpreply;
1.417 albertel 11051: unless (defined($cached)) {
1.624 albertel 11052: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 11053: $result=\%dumpreply;
1.251 albertel 11054: my ($tmp) = keys(%dumpreply);
11055: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 11056: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 11057: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
11058: return $tmp;
1.416 albertel 11059: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 11060: $result=undef;
1.599 albertel 11061: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 11062: }
11063: }
1.624 albertel 11064: return $result;
11065: }
11066:
1.633 albertel 11067: sub devalidateuserresdata {
11068: my ($uname,$udom)=@_;
11069: my $hashid="$udom:$uname";
11070: &devalidate_cache_new('userres',$hashid);
11071: }
11072:
1.624 albertel 11073: sub get_userresdata {
11074: my ($uname,$udom)=@_;
11075: #most student don\'t have any data set, check if there is some data
11076: if (&EXT_cache_status($udom,$uname)) { return undef; }
11077:
11078: my $hashid="$udom:$uname";
11079: my ($result,$cached)=&is_cached_new('userres',$hashid);
11080: if (!defined($cached)) {
11081: my %resourcedata=&dump('resourcedata',$udom,$uname);
11082: $result=\%resourcedata;
11083: &do_cache_new('userres',$hashid,$result,600);
11084: }
11085: my ($tmp)=keys(%$result);
11086: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
11087: return $result;
11088: }
11089: #error 2 occurs when the .db doesn't exist
11090: if ($tmp!~/error: 2 /) {
1.1294 raeburn 11091: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
11092: &logthis("<font color=\"blue\">WARNING:".
11093: " Trying to get resource data for ".
11094: $uname." at ".$udom.": ".
11095: $tmp."</font>");
11096: }
1.624 albertel 11097: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 11098: #&EXT_cache_set($udom,$uname);
11099: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 11100: undef($tmp); # not really an error so don't send it back
1.624 albertel 11101: }
11102: return $tmp;
11103: }
1.879 foxr 11104: #----------------------------------------------- resdata - return resource data
11105: # Purpose:
11106: # Return resource data for either users or for a course.
11107: # Parameters:
11108: # $name - Course/user name.
11109: # $domain - Name of the domain the user/course is registered on.
1.1311 raeburn 11110: # $type - Type of thing $name is (must be 'course' or 'user')
1.1301 raeburn 11111: # $mapp - decluttered URL of enclosing map
11112: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
11113: # $recurseup - Ref to array of map URLs, starting with map containing
11114: # $mapp up through hierarchy of nested maps to top level map.
11115: # $courseid - CourseID (first part of param identifier).
11116: # $modifier - Middle part of param identifier.
11117: # $what - Last part of param identifier.
1.879 foxr 11118: # @which - Array of names of resources desired.
11119: # Returns:
11120: # The value of the first reasource in @which that is found in the
11121: # resource hash.
11122: # Exceptional Conditions:
11123: # If the $type passed in is not valid (not the string 'course' or
11124: # 'user', an undefined reference is returned.
11125: # If none of the resources are found, an undef is returned
1.624 albertel 11126: sub resdata {
1.1301 raeburn 11127: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
11128: $modifier,$what,@which)=@_;
1.624 albertel 11129: my $result;
11130: if ($type eq 'course') {
11131: $result=&get_courseresdata($name,$domain);
11132: } elsif ($type eq 'user') {
11133: $result=&get_userresdata($name,$domain);
11134: }
11135: if (!ref($result)) { return $result; }
1.251 albertel 11136: foreach my $item (@which) {
1.1301 raeburn 11137: if ($item->[1] eq 'course') {
11138: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
11139: unless ($$recursed) {
1.1302 raeburn 11140: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
1.1301 raeburn 11141: $$recursed = 1;
11142: }
11143: foreach my $item (@${recurseup}) {
11144: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
11145: last if (defined($result->{$norecursechk}));
11146: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
11147: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
11148: }
11149: }
11150: }
11151: if (defined($result->{$item->[0]})) {
1.927 albertel 11152: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 11153: }
1.250 albertel 11154: }
1.291 albertel 11155: return undef;
1.200 www 11156: }
11157:
1.1360 raeburn 11158: sub get_domain_lti {
11159: my ($cdom,$context) = @_;
11160: my ($name,%lti);
11161: if ($context eq 'consumer') {
11162: $name = 'ltitools';
11163: } elsif ($context eq 'provider') {
11164: $name = 'lti';
11165: } else {
11166: return %lti;
11167: }
11168: my ($result,$cached)=&is_cached_new($name,$cdom);
1.1298 raeburn 11169: if (defined($cached)) {
11170: if (ref($result) eq 'HASH') {
1.1360 raeburn 11171: %lti = %{$result};
1.1298 raeburn 11172: }
11173: } else {
1.1360 raeburn 11174: my %domconfig = &get_dom('configuration',[$name],$cdom);
11175: if (ref($domconfig{$name}) eq 'HASH') {
11176: %lti = %{$domconfig{$name}};
11177: my %encdomconfig = &get_dom('encconfig',[$name],$cdom);
11178: if (ref($encdomconfig{$name}) eq 'HASH') {
11179: foreach my $id (keys(%lti)) {
11180: if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
1.1344 raeburn 11181: foreach my $item ('key','secret') {
1.1360 raeburn 11182: $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
1.1344 raeburn 11183: }
11184: }
11185: }
11186: }
1.1298 raeburn 11187: }
11188: my $cachetime = 24*60*60;
1.1360 raeburn 11189: &do_cache_new($name,$cdom,\%lti,$cachetime);
1.1298 raeburn 11190: }
1.1360 raeburn 11191: return %lti;
1.1298 raeburn 11192: }
11193:
1.1236 raeburn 11194: sub get_numsuppfiles {
11195: my ($cnum,$cdom,$ignorecache)=@_;
11196: my $hashid=$cnum.':'.$cdom;
11197: my ($suppcount,$cached);
11198: unless ($ignorecache) {
11199: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
11200: }
11201: unless (defined($cached)) {
11202: my $chome=&homeserver($cnum,$cdom);
11203: unless ($chome eq 'no_host') {
11204: ($suppcount,my $errors) = (0,0);
11205: my $suppmap = 'supplemental.sequence';
11206: ($suppcount,$errors) =
11207: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
11208: }
11209: &do_cache_new('suppcount',$hashid,$suppcount,600);
11210: }
11211: return $suppcount;
11212: }
11213:
1.379 matthew 11214: #
11215: # EXT resource caching routines
11216: #
11217:
1.1302 raeburn 11218: {
11219: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
11220: #
11221: # The course for which we cache
11222: my $cachedmapkey='';
11223: # The cached recursive maps for this course
11224: my %cachedmaps=();
11225: # When this was last done
11226: my $cachedmaptime='';
11227:
1.379 matthew 11228: sub clear_EXT_cache_status {
1.383 albertel 11229: &delenv('cache.EXT.');
1.379 matthew 11230: }
11231:
11232: sub EXT_cache_status {
11233: my ($target_domain,$target_user) = @_;
1.383 albertel 11234: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 11235: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 11236: # We know already the user has no data
11237: return 1;
11238: } else {
11239: return 0;
11240: }
11241: }
11242:
11243: sub EXT_cache_set {
11244: my ($target_domain,$target_user) = @_;
1.383 albertel 11245: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 11246: #&appenv({$cachename => time});
1.379 matthew 11247: }
11248:
1.28 www 11249: # --------------------------------------------------------- Value of a Variable
1.58 www 11250: sub EXT {
1.715 albertel 11251:
1.1228 raeburn 11252: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68 www 11253: unless ($varname) { return ''; }
1.218 albertel 11254: #get real user name/domain, courseid and symb
11255: my $courseid;
1.359 albertel 11256: my $publicuser;
1.427 www 11257: if ($symbparm) {
11258: $symbparm=&get_symb_from_alias($symbparm);
11259: }
1.218 albertel 11260: if (!($uname && $udom)) {
1.790 albertel 11261: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 11262: if (!$symbparm) { $symbparm=$cursymb; }
11263: } else {
1.620 albertel 11264: $courseid=$env{'request.course.id'};
1.218 albertel 11265: }
1.48 www 11266: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
11267: my $rest;
1.320 albertel 11268: if (defined($therest[0])) {
1.48 www 11269: $rest=join('.',@therest);
11270: } else {
11271: $rest='';
11272: }
1.320 albertel 11273:
1.57 www 11274: my $qualifierrest=$qualifier;
11275: if ($rest) { $qualifierrest.='.'.$rest; }
11276: my $spacequalifierrest=$space;
11277: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 11278: if ($realm eq 'user') {
1.48 www 11279: # --------------------------------------------------------------- user.resource
11280: if ($space eq 'resource') {
1.651 albertel 11281: if ( (defined($Apache::lonhomework::parsing_a_problem)
11282: || defined($Apache::lonhomework::parsing_a_task))
11283: &&
1.744 albertel 11284: ($symbparm eq &symbread()) ) {
11285: # if we are in the middle of processing the resource the
11286: # get the value we are planning on committing
11287: if (defined($Apache::lonhomework::results{$qualifierrest})) {
11288: return $Apache::lonhomework::results{$qualifierrest};
11289: } else {
11290: return $Apache::lonhomework::history{$qualifierrest};
11291: }
1.335 albertel 11292: } else {
1.359 albertel 11293: my %restored;
1.620 albertel 11294: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 11295: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
11296: } else {
11297: %restored=&restore($symbparm,$courseid,$udom,$uname);
11298: }
1.335 albertel 11299: return $restored{$qualifierrest};
11300: }
1.48 www 11301: # ----------------------------------------------------------------- user.access
11302: } elsif ($space eq 'access') {
1.218 albertel 11303: # FIXME - not supporting calls for a specific user
1.48 www 11304: return &allowed($qualifier,$rest);
11305: # ------------------------------------------ user.preferences, user.environment
11306: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 11307: if (($uname eq $env{'user.name'}) &&
11308: ($udom eq $env{'user.domain'})) {
11309: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 11310: } else {
1.359 albertel 11311: my %returnhash;
11312: if (!$publicuser) {
11313: %returnhash=&userenvironment($udom,$uname,
11314: $qualifierrest);
11315: }
1.218 albertel 11316: return $returnhash{$qualifierrest};
11317: }
1.48 www 11318: # ----------------------------------------------------------------- user.course
11319: } elsif ($space eq 'course') {
1.218 albertel 11320: # FIXME - not supporting calls for a specific user
1.620 albertel 11321: return $env{join('.',('request.course',$qualifier))};
1.48 www 11322: # ------------------------------------------------------------------- user.role
11323: } elsif ($space eq 'role') {
1.218 albertel 11324: # FIXME - not supporting calls for a specific user
1.620 albertel 11325: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 11326: if ($qualifier eq 'value') {
11327: return $role;
11328: } elsif ($qualifier eq 'extent') {
11329: return $where;
11330: }
11331: # ----------------------------------------------------------------- user.domain
11332: } elsif ($space eq 'domain') {
1.218 albertel 11333: return $udom;
1.48 www 11334: # ------------------------------------------------------------------- user.name
11335: } elsif ($space eq 'name') {
1.218 albertel 11336: return $uname;
1.48 www 11337: # ---------------------------------------------------- Any other user namespace
1.29 www 11338: } else {
1.359 albertel 11339: my %reply;
11340: if (!$publicuser) {
11341: %reply=&get($space,[$qualifierrest],$udom,$uname);
11342: }
11343: return $reply{$qualifierrest};
1.48 www 11344: }
1.236 www 11345: } elsif ($realm eq 'query') {
11346: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 11347: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
11348: [$spacequalifierrest]);
1.620 albertel 11349: return $env{'form.'.$spacequalifierrest};
1.236 www 11350: } elsif ($realm eq 'request') {
1.48 www 11351: # ------------------------------------------------------------- request.browser
11352: if ($space eq 'browser') {
1.1145 bisitz 11353: return $env{'browser.'.$qualifier};
1.57 www 11354: # ------------------------------------------------------------ request.filename
11355: } else {
1.620 albertel 11356: return $env{'request.'.$spacequalifierrest};
1.29 www 11357: }
1.28 www 11358: } elsif ($realm eq 'course') {
1.48 www 11359: # ---------------------------------------------------------- course.description
1.620 albertel 11360: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 11361: } elsif ($realm eq 'resource') {
1.165 www 11362:
1.620 albertel 11363: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 11364: if (!$symbparm) { $symbparm=&symbread(); }
11365: }
1.693 albertel 11366:
1.1232 raeburn 11367: if ($qualifier eq '') {
11368: if ($space eq 'title') {
11369: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
11370: return &gettitle($symbparm);
11371: }
1.693 albertel 11372:
1.1232 raeburn 11373: if ($space eq 'map') {
11374: my ($map) = &decode_symb($symbparm);
11375: return &symbread($map);
11376: }
11377: if ($space eq 'maptitle') {
11378: my ($map) = &decode_symb($symbparm);
11379: return &gettitle($map);
11380: }
11381: if ($space eq 'filename') {
11382: if ($symbparm) {
11383: return &clutter((&decode_symb($symbparm))[2]);
11384: }
11385: return &hreflocation('',$env{'request.filename'});
1.905 albertel 11386: }
1.1232 raeburn 11387:
1.1233 raeburn 11388: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
11389: if ($space eq 'visibleparts') {
11390: my $navmap = Apache::lonnavmaps::navmap->new();
11391: my $item;
11392: if (ref($navmap)) {
11393: my $res = $navmap->getBySymb($symbparm);
11394: my $parts = $res->parts();
11395: if (ref($parts) eq 'ARRAY') {
11396: $item = join(',',@{$parts});
11397: }
11398: undef($navmap);
1.1232 raeburn 11399: }
1.1233 raeburn 11400: return $item;
1.1232 raeburn 11401: }
11402: }
11403: }
1.693 albertel 11404:
1.1301 raeburn 11405: my ($section, $group, @groups, @recurseup, $recursed);
11406: my ($courselevelm,$courseleveli,$courselevel,$mapp);
1.1228 raeburn 11407: if (($courseid eq '') && ($cid)) {
11408: $courseid = $cid;
11409: }
11410: if (($symbparm && $courseid) &&
11411: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 11412:
1.218 albertel 11413: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 11414:
1.60 www 11415: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 11416: my $symbp=$symbparm;
1.1301 raeburn 11417: $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 11418: my $symbparm=$symbp.'.'.$spacequalifierrest;
1.1301 raeburn 11419: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
1.218 albertel 11420: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.620 albertel 11421: if (($env{'user.name'} eq $uname) &&
11422: ($env{'user.domain'} eq $udom)) {
11423: $section=$env{'request.course.sec'};
1.733 raeburn 11424: @groups = split(/:/,$env{'request.course.groups'});
11425: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 11426: } else {
1.539 albertel 11427: if (! defined($usection)) {
1.551 albertel 11428: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 11429: } else {
11430: $section = $usection;
11431: }
1.733 raeburn 11432: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 11433: }
11434:
11435: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
11436: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
1.1301 raeburn 11437: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
1.218 albertel 11438: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
11439:
1.593 albertel 11440: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 11441: my $courselevelr=$courseid.'.'.$symbparm;
1.1301 raeburn 11442: $courseleveli=$courseid.'.'.$recurseparm;
1.593 albertel 11443: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 11444:
1.60 www 11445: # ----------------------------------------------------------- first, check user
1.624 albertel 11446:
1.1301 raeburn 11447: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
11448: \@recurseup,$courseid,'.',$spacequalifierrest,
1.927 albertel 11449: ([$courselevelr,'resource'],
11450: [$courselevelm,'map' ],
1.1301 raeburn 11451: [$courseleveli,'map' ],
1.927 albertel 11452: [$courselevel, 'course' ]));
1.931 albertel 11453: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 11454:
1.594 albertel 11455: # ------------------------------------------------ second, check some of course
1.684 raeburn 11456: my $coursereply;
1.691 raeburn 11457: if (@groups > 0) {
11458: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
1.1301 raeburn 11459: $recurseparm,$mapparm,$spacequalifierrest,
11460: $mapp,\$recursed,\@recurseup);
11461: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 11462: }
1.96 www 11463:
1.684 raeburn 11464: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 11465: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 11466: 'course',$mapp,\$recursed,\@recurseup,
11467: $courseid,'.['.$section.'].',$spacequalifierrest,
1.927 albertel 11468: ([$seclevelr, 'resource'],
11469: [$seclevelm, 'map' ],
1.1301 raeburn 11470: [$secleveli, 'map' ],
1.927 albertel 11471: [$seclevel, 'course' ],
11472: [$courselevelr,'resource']));
11473: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 11474:
1.60 www 11475: # ------------------------------------------------------ third, check map parms
1.218 albertel 11476: my %parmhash=();
11477: my $thisparm='';
11478: if (tie(%parmhash,'GDBM_File',
1.620 albertel 11479: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 11480: &GDBM_READER(),0640)) {
1.218 albertel 11481: $thisparm=$parmhash{$symbparm};
11482: untie(%parmhash);
11483: }
1.927 albertel 11484: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 11485: }
1.594 albertel 11486: # ------------------------------------------ fourth, look in resource metadata
1.1301 raeburn 11487:
11488: my $what = $spacequalifierrest;
11489: $what=~s/\./\_/;
1.282 albertel 11490: my $filename;
11491: if (!$symbparm) { $symbparm=&symbread(); }
11492: if ($symbparm) {
1.409 www 11493: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 11494: } else {
1.620 albertel 11495: $filename=$env{'request.filename'};
1.282 albertel 11496: }
1.1362 ! raeburn 11497: my $toolsymb;
! 11498: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
! 11499: $toolsymb = $symbparm;
! 11500: }
! 11501: my $metadata=&metadata($filename,$what,$toolsymb);
1.927 albertel 11502: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.1362 ! raeburn 11503: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
1.927 albertel 11504: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 11505:
1.1301 raeburn 11506: # ----------------------------------------------- fifth, look in rest of course
1.593 albertel 11507: if ($symbparm && defined($courseid) &&
1.620 albertel 11508: $courseid eq $env{'request.course.id'}) {
1.624 albertel 11509: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
11510: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 11511: 'course',$mapp,\$recursed,\@recurseup,
11512: $courseid,'.',$spacequalifierrest,
1.927 albertel 11513: ([$courselevelm,'map' ],
1.1301 raeburn 11514: [$courseleveli,'map' ],
1.927 albertel 11515: [$courselevel, 'course']));
11516: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 11517: }
1.145 www 11518: # ------------------------------------------------------------------ Cascade up
1.218 albertel 11519: unless ($space eq '0') {
1.336 albertel 11520: my @parts=split(/_/,$space);
11521: my $id=pop(@parts);
11522: my $part=join('_',@parts);
11523: if ($part eq '') { $part='0'; }
1.927 albertel 11524: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 11525: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 11526: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 11527: }
1.395 albertel 11528: if ($recurse) { return undef; }
1.1362 ! raeburn 11529: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
1.927 albertel 11530: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 11531: # ---------------------------------------------------- Any other user namespace
11532: } elsif ($realm eq 'environment') {
11533: # ----------------------------------------------------------------- environment
1.620 albertel 11534: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
11535: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 11536: } else {
1.770 albertel 11537: if ($uname eq 'anonymous' && $udom eq '') {
11538: return '';
11539: }
1.219 albertel 11540: my %returnhash=&userenvironment($udom,$uname,
11541: $spacequalifierrest);
11542: return $returnhash{$spacequalifierrest};
11543: }
1.28 www 11544: } elsif ($realm eq 'system') {
1.48 www 11545: # ----------------------------------------------------------------- system.time
11546: if ($space eq 'time') {
11547: return time;
11548: }
1.696 albertel 11549: } elsif ($realm eq 'server') {
11550: # ----------------------------------------------------------------- system.time
11551: if ($space eq 'name') {
11552: return $ENV{'SERVER_NAME'};
11553: }
1.28 www 11554: }
1.48 www 11555: return '';
1.61 www 11556: }
11557:
1.927 albertel 11558: sub get_reply {
11559: my ($reply_value) = @_;
1.940 raeburn 11560: if (ref($reply_value) eq 'ARRAY') {
11561: if (wantarray) {
11562: return @$reply_value;
11563: }
11564: return $reply_value->[0];
11565: } else {
11566: return $reply_value;
1.927 albertel 11567: }
11568: }
11569:
1.691 raeburn 11570: sub check_group_parms {
1.1301 raeburn 11571: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
11572: $recursed,$recurseupref) = @_;
11573: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
11574: [$what,'course']);
11575: my $coursereply;
1.691 raeburn 11576: foreach my $group (@{$groups}) {
1.1301 raeburn 11577: my @groupitems = ();
1.691 raeburn 11578: foreach my $level (@levels) {
1.927 albertel 11579: my $item = $courseid.'.['.$group.'].'.$level->[0];
11580: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 11581: }
1.1301 raeburn 11582: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
11583: $env{'course.'.$courseid.'.domain'},
11584: 'course',$mapp,$recursed,$recurseupref,
11585: $courseid,'.['.$group.'].',$what,
11586: @groupitems);
11587: last if (defined($coursereply));
1.691 raeburn 11588: }
11589: return $coursereply;
11590: }
11591:
1.1301 raeburn 11592: sub get_map_hierarchy {
1.1302 raeburn 11593: my ($mapname,$courseid) = @_;
11594: my @recurseup = ();
1.1301 raeburn 11595: if ($mapname) {
1.1302 raeburn 11596: if (($cachedmapkey eq $courseid) &&
11597: (abs($cachedmaptime-time)<5)) {
11598: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
11599: return @{$cachedmaps{$mapname}};
11600: }
11601: }
1.1301 raeburn 11602: my $navmap = Apache::lonnavmaps::navmap->new();
11603: if (ref($navmap)) {
11604: @recurseup = $navmap->recurseup_maps($mapname);
11605: undef($navmap);
1.1302 raeburn 11606: $cachedmaps{$mapname} = \@recurseup;
11607: $cachedmaptime=time;
11608: $cachedmapkey=$courseid;
1.1301 raeburn 11609: }
11610: }
11611: return @recurseup;
11612: }
11613:
1.1302 raeburn 11614: }
11615:
1.691 raeburn 11616: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 11617: my ($courseid,@groups) = @_;
11618: @groups = sort(@groups);
1.691 raeburn 11619: return @groups;
11620: }
11621:
1.395 albertel 11622: sub packages_tab_default {
1.1362 ! raeburn 11623: my ($uri,$varname,$toolsymb)=@_;
1.395 albertel 11624: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 11625:
11626: my (@extension,@specifics,$do_default);
1.1362 ! raeburn 11627: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
1.395 albertel 11628: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 11629: if ($pack_type eq 'default') {
11630: $do_default=1;
11631: } elsif ($pack_type eq 'extension') {
11632: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 11633: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 11634: # only look at packages defaults for packages that this id is
1.738 albertel 11635: push(@specifics,[$package,$pack_type,$pack_part]);
11636: }
11637: }
11638: # first look for a package that matches the requested part id
11639: foreach my $package (@specifics) {
11640: my (undef,$pack_type,$pack_part)=@{$package};
11641: next if ($pack_part ne $part);
11642: if (defined($packagetab{"$pack_type&$name&default"})) {
11643: return $packagetab{"$pack_type&$name&default"};
11644: }
11645: }
11646: # look for any possible matching non extension_ package
11647: foreach my $package (@specifics) {
11648: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 11649: if (defined($packagetab{"$pack_type&$name&default"})) {
11650: return $packagetab{"$pack_type&$name&default"};
11651: }
1.585 albertel 11652: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 11653: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
11654: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 11655: }
11656: }
1.738 albertel 11657: # look for any posible extension_ match
11658: foreach my $package (@extension) {
11659: my ($package,$pack_type)=@{$package};
11660: if (defined($packagetab{"$pack_type&$name&default"})) {
11661: return $packagetab{"$pack_type&$name&default"};
11662: }
11663: if (defined($packagetab{$package."&$name&default"})) {
11664: return $packagetab{$package."&$name&default"};
11665: }
11666: }
11667: # look for a global default setting
11668: if ($do_default && defined($packagetab{"default&$name&default"})) {
11669: return $packagetab{"default&$name&default"};
11670: }
1.395 albertel 11671: return undef;
11672: }
11673:
1.334 albertel 11674: sub add_prefix_and_part {
11675: my ($prefix,$part)=@_;
11676: my $keyroot;
11677: if (defined($prefix) && $prefix !~ /^__/) {
11678: # prefix that has a part already
11679: $keyroot=$prefix;
11680: } elsif (defined($prefix)) {
11681: # prefix that is missing a part
11682: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
11683: } else {
11684: # no prefix at all
11685: if (defined($part)) { $keyroot='_'.$part; }
11686: }
11687: return $keyroot;
11688: }
11689:
1.71 www 11690: # ---------------------------------------------------------------- Get metadata
11691:
1.599 albertel 11692: my %metaentry;
1.1070 www 11693: my %importedpartids;
1.71 www 11694: sub metadata {
1.1362 ! raeburn 11695: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
1.71 www 11696: $uri=&declutter($uri);
1.288 albertel 11697: # if it is a non metadata possible uri return quickly
1.529 albertel 11698: if (($uri eq '') ||
11699: (($uri =~ m|^/*adm/|) &&
1.1343 raeburn 11700: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
1.1108 raeburn 11701: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 11702: return undef;
11703: }
1.1261 raeburn 11704: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 11705: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 11706: return undef;
1.288 albertel 11707: }
1.73 www 11708: my $filename=$uri;
11709: $uri=~s/\.meta$//;
1.172 www 11710: #
11711: # Is the metadata already cached?
1.177 www 11712: # Look at timestamp of caching
1.172 www 11713: # Everything is cached by the main uri, libraries are never directly cached
11714: #
1.428 albertel 11715: if (!defined($liburi)) {
1.599 albertel 11716: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 11717: if (defined($cached)) { return $result->{':'.$what}; }
11718: }
1.1362 ! raeburn 11719:
! 11720: #
! 11721: # If the uri is for an external tool the file from
! 11722: # which metadata should be retrieved depends on whether
! 11723: # the tool had been configured to be gradable (set in the Course
! 11724: # Editor or Resource Editor).
! 11725: #
! 11726: # If a valid symb has been included as the third arg in the call
! 11727: # to &metadata() that can be used to retrieve the value of
! 11728: # parameter_0_gradable set for the resource, and included in the
! 11729: # uploaded map containing the tool. The value is retrieved via
! 11730: # &EXT(), if a valid symb is available. Otherwise the value of
! 11731: # gradable in the exttool_$marker.db file for the tool instance
! 11732: # is retrived via &get().
! 11733: #
! 11734: # In order to avoid an infinite loop, &metadata() will return
! 11735: # before a call to &EXT(), if the uri is for an external tool
! 11736: # and the $what for which metadata is being requested is
! 11737: # parameter_0_gradable or 0_gradable.
! 11738: #
! 11739:
! 11740: if ($uri =~ /ext\.tool$/) {
! 11741: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
! 11742: return;
! 11743: } else {
! 11744: my ($checked,$use_passback);
! 11745: if ($toolsymb ne '') {
! 11746: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
! 11747: if ($tooluri eq $uri) {
! 11748: $checked = 1;
! 11749: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
! 11750: $use_passback = 1;
! 11751: }
! 11752: }
! 11753: }
! 11754: unless ($checked) {
! 11755: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
! 11756: $marker=~s/\D//g;
! 11757: if (!$marker) {
! 11758: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
! 11759: $use_passback = $toolsettings{'gradable'};
! 11760: }
! 11761: }
! 11762: if ($use_passback) {
! 11763: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
! 11764: } else {
! 11765: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
! 11766: }
! 11767: }
! 11768: }
! 11769:
1.428 albertel 11770: {
1.1069 www 11771: # Imported parts would go here
1.1070 www 11772: my %importedids=();
11773: my @origfileimportpartids=();
1.1069 www 11774: my $importedparts=0;
1.172 www 11775: #
11776: # Is this a recursive call for a library?
11777: #
1.599 albertel 11778: # if (! exists($metacache{$uri})) {
11779: # $metacache{$uri}={};
11780: # }
1.924 albertel 11781: my $cachetime = 60*60;
1.171 www 11782: if ($liburi) {
11783: $liburi=&declutter($liburi);
11784: $filename=$liburi;
1.401 bowersj2 11785: } else {
1.599 albertel 11786: &devalidate_cache_new('meta',$uri);
11787: undef(%metaentry);
1.401 bowersj2 11788: }
1.140 www 11789: my %metathesekeys=();
1.73 www 11790: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 11791: my $metastring;
1.1140 www 11792: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 11793: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 11794: $metastring =
1.929 albertel 11795: &Apache::lonnet::ssi_body($which,
1.924 albertel 11796: ('grade_target' => 'meta'));
11797: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 11798: } elsif (($uri !~ m -^(editupload)/-) &&
11799: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 11800: my $file=&filelocation('',&clutter($filename));
1.599 albertel 11801: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 11802: $metastring=&getfile($file);
1.489 albertel 11803: }
1.208 albertel 11804: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 11805: my $token;
1.140 www 11806: undef %metathesekeys;
1.71 www 11807: while ($token=$parser->get_token) {
1.339 albertel 11808: if ($token->[0] eq 'S') {
11809: if (defined($token->[2]->{'package'})) {
1.172 www 11810: #
11811: # This is a package - get package info
11812: #
1.339 albertel 11813: my $package=$token->[2]->{'package'};
11814: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11815: if (defined($token->[2]->{'id'})) {
11816: $keyroot.='_'.$token->[2]->{'id'};
11817: }
1.599 albertel 11818: if ($metaentry{':packages'}) {
11819: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 11820: } else {
1.599 albertel 11821: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 11822: }
1.736 albertel 11823: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 11824: my $part=$keyroot;
11825: $part=~s/^\_//;
1.736 albertel 11826: if ($pack_entry=~/^\Q$package\E\&/ ||
11827: $pack_entry=~/^\Q$package\E_0\&/) {
11828: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 11829: # ignore package.tab specified default values
11830: # here &package_tab_default() will fetch those
11831: if ($subp eq 'default') { next; }
1.736 albertel 11832: my $value=$packagetab{$pack_entry};
1.432 albertel 11833: my $unikey;
11834: if ($pack =~ /_0$/) {
11835: $unikey='parameter_0_'.$name;
11836: $part=0;
11837: } else {
11838: $unikey='parameter'.$keyroot.'_'.$name;
11839: }
1.339 albertel 11840: if ($subp eq 'display') {
11841: $value.=' [Part: '.$part.']';
11842: }
1.599 albertel 11843: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 11844: $metathesekeys{$unikey}=1;
1.599 albertel 11845: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11846: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 11847: }
1.599 albertel 11848: if (defined($metaentry{':'.$unikey.'.default'})) {
11849: $metaentry{':'.$unikey}=
11850: $metaentry{':'.$unikey.'.default'};
1.356 albertel 11851: }
1.339 albertel 11852: }
11853: }
11854: } else {
1.172 www 11855: #
11856: # This is not a package - some other kind of start tag
1.339 albertel 11857: #
11858: my $entry=$token->[1];
1.1068 www 11859: my $unikey='';
1.175 www 11860:
1.339 albertel 11861: if ($entry eq 'import') {
1.175 www 11862: #
11863: # Importing a library here
1.339 albertel 11864: #
1.1067 www 11865: my $location=$parser->get_text('/import');
11866: my $dir=$filename;
11867: $dir=~s|[^/]*$||;
11868: $location=&filelocation($dir,$location);
1.1069 www 11869:
1.1068 www 11870: my $importmode=$token->[2]->{'importmode'};
11871: if ($importmode eq 'problem') {
1.1069 www 11872: # Import as problem/response
1.1068 www 11873: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11874: } elsif ($importmode eq 'part') {
11875: # Import as part(s)
1.1069 www 11876: $importedparts=1;
11877: # We need to get the original file and the imported file to get the part order correct
11878: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
11879: # Load and inspect original file
1.1070 www 11880: if ($#origfileimportpartids<0) {
11881: undef(%importedpartids);
11882: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11883: my $origfile=&getfile($origfilelocation);
11884: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11885: }
11886:
1.1069 www 11887: # Load and inspect imported file
11888: my $impfile=&getfile($location);
11889: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11890: if ($#impfilepartids>=0) {
11891: # This problem had parts
1.1070 www 11892: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 11893: } else {
11894: # Importing by turning a single problem into a problem part
11895: # It gets the import-tags ID as part-ID
11896: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 11897: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 11898: }
1.1068 www 11899: } else {
11900: # Normal import
11901: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11902: if (defined($token->[2]->{'id'})) {
11903: $unikey.='_'.$token->[2]->{'id'};
11904: }
1.1067 www 11905: }
11906:
1.339 albertel 11907: if ($depthcount<20) {
1.736 albertel 11908: my $metadata =
1.1362 ! raeburn 11909: &metadata($uri,'keys',$toolsymb,$location,$unikey,
1.736 albertel 11910: $depthcount+1);
11911: foreach my $meta (split(',',$metadata)) {
11912: $metaentry{':'.$meta}=$metaentry{':'.$meta};
11913: $metathesekeys{$meta}=1;
1.339 albertel 11914: }
1.1068 www 11915:
11916: }
1.1067 www 11917: } else {
11918: #
11919: # Not importing, some other kind of non-package, non-library start tag
11920: #
11921: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
11922: if (defined($token->[2]->{'id'})) {
11923: $unikey.='_'.$token->[2]->{'id'};
11924: }
1.339 albertel 11925: if (defined($token->[2]->{'name'})) {
11926: $unikey.='_'.$token->[2]->{'name'};
11927: }
11928: $metathesekeys{$unikey}=1;
1.736 albertel 11929: foreach my $param (@{$token->[3]}) {
11930: $metaentry{':'.$unikey.'.'.$param} =
11931: $token->[2]->{$param};
1.339 albertel 11932: }
11933: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 11934: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 11935: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
11936: # only ws inside the tag, and not in default, so use default
11937: # as value
1.599 albertel 11938: $metaentry{':'.$unikey}=$default;
1.908 albertel 11939: } elsif ( $internaltext =~ /\S/ ) {
11940: # something interesting inside the tag
11941: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 11942: } else {
1.908 albertel 11943: # no interesting values, don't set a default
1.339 albertel 11944: }
1.172 www 11945: # end of not-a-package not-a-library import
1.339 albertel 11946: }
1.172 www 11947: # end of not-a-package start tag
1.339 albertel 11948: }
1.172 www 11949: # the next is the end of "start tag"
1.339 albertel 11950: }
11951: }
1.483 albertel 11952: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 11953: $extension = lc($extension);
11954: if ($extension eq 'htm') { $extension='html'; }
11955:
1.737 albertel 11956: foreach my $key (keys(%packagetab)) {
1.483 albertel 11957: #no specific packages #how's our extension
11958: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 11959: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 11960: \%metathesekeys);
11961: }
1.883 albertel 11962:
11963: if (!exists($metaentry{':packages'})
11964: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 11965: foreach my $key (keys(%packagetab)) {
1.483 albertel 11966: #no specific packages well let's get default then
11967: if ($key!~/^default&/) { next; }
1.488 albertel 11968: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 11969: \%metathesekeys);
11970: }
11971: }
1.338 www 11972: # are there custom rights to evaluate
1.599 albertel 11973: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 11974:
1.338 www 11975: #
11976: # Importing a rights file here
1.339 albertel 11977: #
11978: unless ($depthcount) {
1.599 albertel 11979: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 11980: my $dir=$filename;
11981: $dir=~s|[^/]*$||;
11982: $location=&filelocation($dir,$location);
1.736 albertel 11983: my $rights_metadata =
1.1362 ! raeburn 11984: &metadata($uri,'keys',$toolsymb,$location,'_rights',
1.736 albertel 11985: $depthcount+1);
11986: foreach my $rights (split(',',$rights_metadata)) {
11987: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
11988: $metathesekeys{$rights}=1;
1.339 albertel 11989: }
11990: }
11991: }
1.737 albertel 11992: # uniqifiy package listing
11993: my %seen;
11994: my @uniq_packages =
11995: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
11996: $metaentry{':packages'} = join(',',@uniq_packages);
11997:
1.1070 www 11998: if ($importedparts) {
11999: # We had imported parts and need to rebuild partorder
12000: $metaentry{':partorder'}='';
12001: $metathesekeys{'partorder'}=1;
12002: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
12003: if ($origfileimportpartids[$index] eq 'part') {
12004: # original part, part of the problem
12005: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
12006: } else {
12007: # we have imported parts at this position
12008: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
12009: }
12010: }
12011: $metaentry{':partorder'}=~s/^\,//;
12012: }
12013:
1.737 albertel 12014: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 12015: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274 raeburn 12016: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.924 albertel 12017: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 12018: # this is the end of "was not already recently cached
1.71 www 12019: }
1.599 albertel 12020: return $metaentry{':'.$what};
1.261 albertel 12021: }
12022:
1.488 albertel 12023: sub metadata_create_package_def {
1.483 albertel 12024: my ($uri,$key,$package,$metathesekeys)=@_;
12025: my ($pack,$name,$subp)=split(/\&/,$key);
12026: if ($subp eq 'default') { next; }
12027:
1.599 albertel 12028: if (defined($metaentry{':packages'})) {
12029: $metaentry{':packages'}.=','.$package;
1.483 albertel 12030: } else {
1.599 albertel 12031: $metaentry{':packages'}=$package;
1.483 albertel 12032: }
12033: my $value=$packagetab{$key};
12034: my $unikey;
12035: $unikey='parameter_0_'.$name;
1.599 albertel 12036: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 12037: $$metathesekeys{$unikey}=1;
1.599 albertel 12038: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
12039: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 12040: }
1.599 albertel 12041: if (defined($metaentry{':'.$unikey.'.default'})) {
12042: $metaentry{':'.$unikey}=
12043: $metaentry{':'.$unikey.'.default'};
1.483 albertel 12044: }
12045: }
12046:
1.261 albertel 12047: sub metadata_generate_part0 {
12048: my ($metadata,$metacache,$uri) = @_;
12049: my %allnames;
1.737 albertel 12050: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 12051: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 12052: my $part=$$metacache{':'.$metakey.'.part'};
12053: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 12054: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 12055: $allnames{$name}=$part;
12056: }
12057: }
12058: }
12059: foreach my $name (keys(%allnames)) {
12060: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 12061: my $key=":parameter_0_$name";
1.261 albertel 12062: $$metacache{"$key.part"}='0';
12063: $$metacache{"$key.name"}=$name;
1.428 albertel 12064: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 12065: $allnames{$name}.'_'.$name.
12066: '.type'};
1.428 albertel 12067: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 12068: '.display'};
1.644 www 12069: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 12070: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 12071: $$metacache{"$key.display"}=$olddis;
12072: }
1.71 www 12073: }
12074:
1.764 albertel 12075: # ------------------------------------------------------ Devalidate title cache
12076:
12077: sub devalidate_title_cache {
12078: my ($url)=@_;
12079: if (!$env{'request.course.id'}) { return; }
12080: my $symb=&symbread($url);
12081: if (!$symb) { return; }
12082: my $key=$env{'request.course.id'}."\0".$symb;
12083: &devalidate_cache_new('title',$key);
12084: }
12085:
1.1014 droeschl 12086: # ------------------------------------------------- Get the title of a course
12087:
12088: sub current_course_title {
12089: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
12090: }
1.301 www 12091: # ------------------------------------------------- Get the title of a resource
12092:
12093: sub gettitle {
12094: my $urlsymb=shift;
12095: my $symb=&symbread($urlsymb);
1.534 albertel 12096: if ($symb) {
1.620 albertel 12097: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 12098: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 12099: if (defined($cached)) {
12100: return $result;
12101: }
1.534 albertel 12102: my ($map,$resid,$url)=&decode_symb($symb);
12103: my $title='';
1.907 albertel 12104: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
12105: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
12106: } else {
12107: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12108: &GDBM_READER(),0640)) {
12109: my $mapid=$bighash{'map_pc_'.&clutter($map)};
12110: $title=$bighash{'title_'.$mapid.'.'.$resid};
12111: untie(%bighash);
12112: }
1.534 albertel 12113: }
12114: $title=~s/\&colon\;/\:/gs;
12115: if ($title) {
1.1159 www 12116: # Remember both $symb and $title for dynamic metadata
12117: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 12118: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 12119: # Cache this title and then return it
1.599 albertel 12120: return &do_cache_new('title',$key,$title,600);
1.534 albertel 12121: }
12122: $urlsymb=$url;
12123: }
12124: my $title=&metadata($urlsymb,'title');
12125: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
12126: return $title;
1.301 www 12127: }
1.613 albertel 12128:
1.614 albertel 12129: sub get_slot {
12130: my ($which,$cnum,$cdom)=@_;
12131: if (!$cnum || !$cdom) {
1.790 albertel 12132: (undef,my $courseid)=&whichuser();
1.620 albertel 12133: $cdom=$env{'course.'.$courseid.'.domain'};
12134: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 12135: }
1.703 albertel 12136: my $key=join("\0",'slots',$cdom,$cnum,$which);
12137: my %slotinfo;
12138: if (exists($remembered{$key})) {
12139: $slotinfo{$which} = $remembered{$key};
12140: } else {
12141: %slotinfo=&get('slots',[$which],$cdom,$cnum);
12142: &Apache::lonhomework::showhash(%slotinfo);
12143: my ($tmp)=keys(%slotinfo);
12144: if ($tmp=~/^error:/) { return (); }
12145: $remembered{$key} = $slotinfo{$which};
12146: }
1.616 albertel 12147: if (ref($slotinfo{$which}) eq 'HASH') {
12148: return %{$slotinfo{$which}};
12149: }
12150: return $slotinfo{$which};
1.614 albertel 12151: }
1.1150 raeburn 12152:
12153: sub get_reservable_slots {
12154: my ($cnum,$cdom,$uname,$udom) = @_;
12155: my $now = time;
12156: my $reservable_info;
12157: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
12158: if (exists($remembered{$key})) {
12159: $reservable_info = $remembered{$key};
12160: } else {
12161: my %resv;
12162: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
12163: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
12164: $reservable_info = \%resv;
12165: $remembered{$key} = $reservable_info;
12166: }
12167: return $reservable_info;
12168: }
12169:
12170: sub get_course_slots {
12171: my ($cnum,$cdom) = @_;
12172: my $hashid=$cnum.':'.$cdom;
12173: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
12174: if (defined($cached)) {
12175: if (ref($result) eq 'HASH') {
12176: return %{$result};
12177: }
12178: } else {
12179: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
12180: my ($tmp) = keys(%slots);
12181: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 12182: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 12183: return %slots;
12184: }
12185: }
12186: return;
12187: }
12188:
12189: sub devalidate_slots_cache {
12190: my ($cnum,$cdom)=@_;
12191: my $hashid=$cnum.':'.$cdom;
12192: &devalidate_cache_new('allslots',$hashid);
12193: }
12194:
1.1181 raeburn 12195: sub get_coursechange {
12196: my ($cdom,$cnum) = @_;
12197: if ($cdom eq '' || $cnum eq '') {
12198: return unless ($env{'request.course.id'});
12199: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
12200: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
12201: }
12202: my $hashid=$cdom.'_'.$cnum;
12203: my ($change,$cached)=&is_cached_new('crschange',$hashid);
12204: if ((defined($cached)) && ($change ne '')) {
12205: return $change;
12206: } else {
12207: my %crshash;
12208: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
12209: if ($crshash{'internal.contentchange'} eq '') {
12210: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
12211: if ($change eq '') {
12212: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
12213: $change = $crshash{'internal.created'};
12214: }
12215: } else {
12216: $change = $crshash{'internal.contentchange'};
12217: }
12218: my $cachetime = 600;
12219: &do_cache_new('crschange',$hashid,$change,$cachetime);
12220: }
12221: return $change;
12222: }
12223:
12224: sub devalidate_coursechange_cache {
12225: my ($cnum,$cdom)=@_;
12226: my $hashid=$cnum.':'.$cdom;
12227: &devalidate_cache_new('crschange',$hashid);
12228: }
12229:
1.31 www 12230: # ------------------------------------------------- Update symbolic store links
12231:
12232: sub symblist {
12233: my ($mapname,%newhash)=@_;
1.438 www 12234: $mapname=&deversion(&declutter($mapname));
1.31 www 12235: my %hash;
1.620 albertel 12236: if (($env{'request.course.fn'}) && (%newhash)) {
12237: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 12238: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 12239: foreach my $url (keys(%newhash)) {
1.711 albertel 12240: next if ($url eq 'last_known'
12241: && $env{'form.no_update_last_known'});
12242: $hash{declutter($url)}=&encode_symb($mapname,
12243: $newhash{$url}->[1],
12244: $newhash{$url}->[0]);
1.191 harris41 12245: }
1.31 www 12246: if (untie(%hash)) {
12247: return 'ok';
12248: }
12249: }
12250: }
12251: return 'error';
1.212 www 12252: }
12253:
12254: # --------------------------------------------------------------- Verify a symb
12255:
12256: sub symbverify {
1.1190 raeburn 12257: my ($symb,$thisurl,$encstate)=@_;
1.510 www 12258: my $thisfn=$thisurl;
1.439 www 12259: $thisfn=&declutter($thisfn);
1.215 www 12260: # direct jump to resource in page or to a sequence - will construct own symbs
12261: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
12262: # check URL part
1.409 www 12263: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 12264:
1.431 www 12265: unless ($url eq $thisfn) { return 0; }
1.213 www 12266:
1.216 www 12267: $symb=&symbclean($symb);
1.510 www 12268: $thisurl=&deversion($thisurl);
1.439 www 12269: $thisfn=&deversion($thisfn);
1.213 www 12270:
12271: my %bighash;
12272: my $okay=0;
1.431 www 12273:
1.620 albertel 12274: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 12275: &GDBM_READER(),0640)) {
1.1204 raeburn 12276: my $noclutter;
1.1032 raeburn 12277: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
12278: $thisurl =~ s/\?.+$//;
1.1204 raeburn 12279: if ($map =~ m{^uploaded/.+\.page$}) {
12280: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
12281: $thisurl =~ s{^\Qhttp://https://\E}{https://};
12282: $noclutter = 1;
12283: }
12284: }
12285: my $ids;
12286: if ($noclutter) {
12287: $ids=$bighash{'ids_'.$thisurl};
12288: } else {
12289: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 12290: }
1.1102 raeburn 12291: unless ($ids) {
12292: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
12293: $ids=$bighash{$idkey};
1.216 www 12294: }
12295: if ($ids) {
12296: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 12297: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 12298: $symb =~ s/\?.+$//;
1.1202 raeburn 12299: }
1.800 albertel 12300: foreach my $id (split(/\,/,$ids)) {
12301: my ($mapid,$resid)=split(/\./,$id);
1.216 www 12302: if (
12303: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 12304: eq $symb) {
12305: if (ref($encstate)) {
12306: $$encstate = $bighash{'encrypted_'.$id};
12307: }
1.620 albertel 12308: if (($env{'request.role.adv'}) ||
1.1101 raeburn 12309: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
12310: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 12311: $okay=1;
1.1202 raeburn 12312: last;
1.582 albertel 12313: }
12314: }
1.216 www 12315: }
12316: }
1.213 www 12317: untie(%bighash);
12318: }
12319: return $okay;
1.31 www 12320: }
12321:
1.210 www 12322: # --------------------------------------------------------------- Clean-up symb
12323:
12324: sub symbclean {
12325: my $symb=shift;
1.568 albertel 12326: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 12327: # remove version from map
12328: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 12329:
1.210 www 12330: # remove version from URL
12331: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 12332:
1.507 www 12333: # remove wrapper
12334:
1.510 www 12335: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 12336: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 12337: return $symb;
1.409 www 12338: }
12339:
12340: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 12341:
12342: sub encode_symb {
12343: my ($map,$resid,$url)=@_;
12344: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
12345: }
1.409 www 12346:
12347: sub decode_symb {
1.568 albertel 12348: my $symb=shift;
12349: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
12350: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 12351: return (&fixversion($map),$resid,&fixversion($url));
12352: }
12353:
12354: sub fixversion {
12355: my $fn=shift;
1.609 banghart 12356: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 12357: my %bighash;
12358: my $uri=&clutter($fn);
1.620 albertel 12359: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 12360: # is this cached?
1.599 albertel 12361: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 12362: if (defined($cached)) { return $result; }
12363: # unfortunately not cached, or expired
1.620 albertel 12364: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 12365: &GDBM_READER(),0640)) {
12366: if ($bighash{'version_'.$uri}) {
12367: my $version=$bighash{'version_'.$uri};
1.444 www 12368: unless (($version eq 'mostrecent') ||
12369: ($version==&getversion($uri))) {
1.440 www 12370: $uri=~s/\.(\w+)$/\.$version\.$1/;
12371: }
12372: }
12373: untie %bighash;
1.413 www 12374: }
1.599 albertel 12375: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 12376: }
12377:
12378: sub deversion {
12379: my $url=shift;
12380: $url=~s/\.\d+\.(\w+)$/\.$1/;
12381: return $url;
1.210 www 12382: }
12383:
1.31 www 12384: # ------------------------------------------------------ Return symb list entry
12385:
12386: sub symbread {
1.1282 raeburn 12387: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
1.1265 raeburn 12388: my $cache_str='request.symbread.cached.'.$thisfn;
1.1282 raeburn 12389: if (defined($env{$cache_str})) {
12390: if ($ignorecachednull) {
12391: return $env{$cache_str} unless ($env{$cache_str} eq '');
12392: } else {
12393: return $env{$cache_str};
12394: }
12395: }
1.242 www 12396: # no filename provided? try from environment
1.1265 raeburn 12397: unless ($thisfn) {
1.620 albertel 12398: if ($env{'request.symb'}) {
12399: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 12400: }
1.620 albertel 12401: $thisfn=$env{'request.filename'};
1.44 www 12402: }
1.569 albertel 12403: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 12404: # is that filename actually a symb? Verify, clean, and return
12405: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 12406: if (&symbverify($thisfn,$1)) {
1.620 albertel 12407: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 12408: }
1.242 www 12409: }
1.44 www 12410: $thisfn=declutter($thisfn);
1.31 www 12411: my %hash;
1.37 www 12412: my %bighash;
12413: my $syval='';
1.620 albertel 12414: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 12415: my $targetfn = $thisfn;
1.609 banghart 12416: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 12417: $targetfn = 'adm/wrapper/'.$thisfn;
12418: }
1.687 albertel 12419: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
12420: $targetfn=$1;
12421: }
1.620 albertel 12422: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 12423: &GDBM_READER(),0640)) {
1.481 raeburn 12424: $syval=$hash{$targetfn};
1.37 www 12425: untie(%hash);
12426: }
12427: # ---------------------------------------------------------- There was an entry
12428: if ($syval) {
1.601 albertel 12429: #unless ($syval=~/\_\d+$/) {
1.620 albertel 12430: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 12431: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 12432: #return $env{$cache_str}='';
1.601 albertel 12433: #}
12434: #$syval.=$1;
12435: #}
1.37 www 12436: } else {
12437: # ------------------------------------------------------- Was not in symb table
1.620 albertel 12438: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 12439: &GDBM_READER(),0640)) {
1.37 www 12440: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 12441: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 12442: unless ($ids) {
12443: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 12444: }
12445: unless ($ids) {
12446: # alias?
12447: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 12448: }
1.37 www 12449: if ($ids) {
12450: # ------------------------------------------------------------------- Has ID(s)
12451: my @possibilities=split(/\,/,$ids);
1.39 www 12452: if ($#possibilities==0) {
12453: # ----------------------------------------------- There is only one possibility
1.37 www 12454: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 12455: $syval=&encode_symb($bighash{'map_id_'.$mapid},
12456: $resid,$thisfn);
1.1282 raeburn 12457: if (ref($possibles) eq 'HASH') {
12458: $possibles->{$syval} = 1;
12459: }
12460: if ($checkforblock) {
12461: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
12462: if (@blockers) {
12463: $syval = '';
12464: return;
12465: }
12466: }
12467: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 12468: # ------------------------------------------ There is more than one possibility
12469: my $realpossible=0;
1.800 albertel 12470: foreach my $id (@possibilities) {
12471: my $file=$bighash{'src_'.$id};
1.1282 raeburn 12472: my $canaccess;
12473: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
12474: $canaccess = 1;
12475: } else {
12476: $canaccess = &allowed('bre',$file);
12477: }
12478: if ($canaccess) {
12479: my ($mapid,$resid)=split(/\./,$id);
12480: if ($bighash{'map_type_'.$mapid} ne 'page') {
12481: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
12482: $resid,$thisfn);
12483: if (ref($possibles) eq 'HASH') {
12484: $possibles->{$syval} = 1;
12485: }
12486: if ($checkforblock) {
12487: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
12488: unless (@blockers > 0) {
12489: $syval = $poss_syval;
12490: $realpossible++;
12491: }
12492: } else {
12493: $syval = $poss_syval;
12494: $realpossible++;
12495: }
12496: }
1.39 www 12497: }
1.191 harris41 12498: }
1.39 www 12499: if ($realpossible!=1) { $syval=''; }
1.249 www 12500: } else {
12501: $syval='';
1.37 www 12502: }
12503: }
1.1282 raeburn 12504: untie(%bighash);
1.481 raeburn 12505: }
1.31 www 12506: }
1.62 www 12507: if ($syval) {
1.620 albertel 12508: return $env{$cache_str}=$syval;
1.62 www 12509: }
1.31 www 12510: }
1.949 raeburn 12511: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 12512: return $env{$cache_str}='';
1.31 www 12513: }
12514:
12515: # ---------------------------------------------------------- Return random seed
12516:
1.32 www 12517: sub numval {
12518: my $txt=shift;
12519: $txt=~tr/A-J/0-9/;
12520: $txt=~tr/a-j/0-9/;
12521: $txt=~tr/K-T/0-9/;
12522: $txt=~tr/k-t/0-9/;
12523: $txt=~tr/U-Z/0-5/;
12524: $txt=~tr/u-z/0-5/;
12525: $txt=~s/\D//g;
1.564 albertel 12526: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 12527: return int($txt);
1.368 albertel 12528: }
12529:
1.484 albertel 12530: sub numval2 {
12531: my $txt=shift;
12532: $txt=~tr/A-J/0-9/;
12533: $txt=~tr/a-j/0-9/;
12534: $txt=~tr/K-T/0-9/;
12535: $txt=~tr/k-t/0-9/;
12536: $txt=~tr/U-Z/0-5/;
12537: $txt=~tr/u-z/0-5/;
12538: $txt=~s/\D//g;
12539: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
12540: my $total;
12541: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 12542: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 12543: return int($total);
12544: }
12545:
1.575 albertel 12546: sub numval3 {
12547: use integer;
12548: my $txt=shift;
12549: $txt=~tr/A-J/0-9/;
12550: $txt=~tr/a-j/0-9/;
12551: $txt=~tr/K-T/0-9/;
12552: $txt=~tr/k-t/0-9/;
12553: $txt=~tr/U-Z/0-5/;
12554: $txt=~tr/u-z/0-5/;
12555: $txt=~s/\D//g;
12556: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
12557: my $total;
12558: foreach my $val (@txts) { $total+=$val; }
12559: if ($_64bit) { $total=(($total<<32)>>32); }
12560: return $total;
12561: }
12562:
1.675 albertel 12563: sub digest {
12564: my ($data)=@_;
12565: my $digest=&Digest::MD5::md5($data);
12566: my ($a,$b,$c,$d)=unpack("iiii",$digest);
12567: my ($e,$f);
12568: {
12569: use integer;
12570: $e=($a+$b);
12571: $f=($c+$d);
12572: if ($_64bit) {
12573: $e=(($e<<32)>>32);
12574: $f=(($f<<32)>>32);
12575: }
12576: }
12577: if (wantarray) {
12578: return ($e,$f);
12579: } else {
12580: my $g;
12581: {
12582: use integer;
12583: $g=($e+$f);
12584: if ($_64bit) {
12585: $g=(($g<<32)>>32);
12586: }
12587: }
12588: return $g;
12589: }
12590: }
12591:
1.368 albertel 12592: sub latest_rnd_algorithm_id {
1.675 albertel 12593: return '64bit5';
1.366 albertel 12594: }
1.32 www 12595:
1.503 albertel 12596: sub get_rand_alg {
12597: my ($courseid)=@_;
1.790 albertel 12598: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 12599: if ($courseid) {
1.620 albertel 12600: return $env{"course.$courseid.rndseed"};
1.503 albertel 12601: }
12602: return &latest_rnd_algorithm_id();
12603: }
12604:
1.562 albertel 12605: sub validCODE {
12606: my ($CODE)=@_;
12607: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
12608: return 0;
12609: }
12610:
1.491 albertel 12611: sub getCODE {
1.620 albertel 12612: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 12613: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
12614: defined($Apache::lonhomework::parsing_a_task) ) &&
12615: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 12616: return $Apache::lonhomework::history{'resource.CODE'};
12617: }
12618: return undef;
12619: }
1.1133 foxr 12620: #
12621: # Determines the random seed for a specific context:
12622: #
12623: # parameters:
12624: # symb - in course context the symb for the seed.
12625: # course_id - The course id of the form domain_coursenum.
12626: # domain - Domain for the user.
12627: # course - Course for the user.
12628: # cenv - environment of the course.
12629: #
12630: # NOTE:
12631: # All parameters are picked out of the environment if missing
12632: # or not defined.
12633: # If a symb cannot be determined the current time is used instead.
12634: #
12635: # For a given well defined symb, courside, domain, username,
12636: # and course environment, the seed is reproducible.
12637: #
1.31 www 12638: sub rndseed {
1.1133 foxr 12639: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 12640: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 12641: if (!defined($symb)) {
1.366 albertel 12642: unless ($symb=$wsymb) { return time; }
12643: }
1.1146 foxr 12644: if (!defined $courseid) {
12645: $courseid=$wcourseid;
12646: }
12647: if (!defined $domain) { $domain=$wdomain; }
12648: if (!defined $username) { $username=$wusername }
1.1133 foxr 12649:
12650: my $which;
12651: if (defined($cenv->{'rndseed'})) {
12652: $which = $cenv->{'rndseed'};
12653: } else {
12654: $which =&get_rand_alg($courseid);
12655: }
1.491 albertel 12656: if (defined(&getCODE())) {
1.1133 foxr 12657:
1.675 albertel 12658: if ($which eq '64bit5') {
12659: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
12660: } elsif ($which eq '64bit4') {
1.575 albertel 12661: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
12662: } else {
12663: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
12664: }
1.675 albertel 12665: } elsif ($which eq '64bit5') {
12666: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 12667: } elsif ($which eq '64bit4') {
12668: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 12669: } elsif ($which eq '64bit3') {
12670: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 12671: } elsif ($which eq '64bit2') {
12672: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 12673: } elsif ($which eq '64bit') {
12674: return &rndseed_64bit($symb,$courseid,$domain,$username);
12675: }
12676: return &rndseed_32bit($symb,$courseid,$domain,$username);
12677: }
12678:
12679: sub rndseed_32bit {
12680: my ($symb,$courseid,$domain,$username)=@_;
12681: {
12682: use integer;
12683: my $symbchck=unpack("%32C*",$symb) << 27;
12684: my $symbseed=numval($symb) << 22;
12685: my $namechck=unpack("%32C*",$username) << 17;
12686: my $nameseed=numval($username) << 12;
12687: my $domainseed=unpack("%32C*",$domain) << 7;
12688: my $courseseed=unpack("%32C*",$courseid);
12689: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 12690: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12691: #&logthis("rndseed :$num:$symb");
1.564 albertel 12692: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 12693: return $num;
12694: }
12695: }
12696:
12697: sub rndseed_64bit {
12698: my ($symb,$courseid,$domain,$username)=@_;
12699: {
12700: use integer;
12701: my $symbchck=unpack("%32S*",$symb) << 21;
12702: my $symbseed=numval($symb) << 10;
12703: my $namechck=unpack("%32S*",$username);
12704:
12705: my $nameseed=numval($username) << 21;
12706: my $domainseed=unpack("%32S*",$domain) << 10;
12707: my $courseseed=unpack("%32S*",$courseid);
12708:
12709: my $num1=$symbchck+$symbseed+$namechck;
12710: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12711: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12712: #&logthis("rndseed :$num:$symb");
1.564 albertel 12713: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 12714: return "$num1,$num2";
1.155 albertel 12715: }
1.366 albertel 12716: }
12717:
1.443 albertel 12718: sub rndseed_64bit2 {
12719: my ($symb,$courseid,$domain,$username)=@_;
12720: {
12721: use integer;
12722: # strings need to be an even # of cahracters long, it it is odd the
12723: # last characters gets thrown away
12724: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12725: my $symbseed=numval($symb) << 10;
12726: my $namechck=unpack("%32S*",$username.' ');
12727:
12728: my $nameseed=numval($username) << 21;
1.501 albertel 12729: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12730: my $courseseed=unpack("%32S*",$courseid.' ');
12731:
12732: my $num1=$symbchck+$symbseed+$namechck;
12733: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12734: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12735: #&logthis("rndseed :$num:$symb");
1.803 albertel 12736: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 12737: return "$num1,$num2";
12738: }
12739: }
12740:
12741: sub rndseed_64bit3 {
12742: my ($symb,$courseid,$domain,$username)=@_;
12743: {
12744: use integer;
12745: # strings need to be an even # of cahracters long, it it is odd the
12746: # last characters gets thrown away
12747: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12748: my $symbseed=numval2($symb) << 10;
12749: my $namechck=unpack("%32S*",$username.' ');
12750:
12751: my $nameseed=numval2($username) << 21;
1.443 albertel 12752: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12753: my $courseseed=unpack("%32S*",$courseid.' ');
12754:
12755: my $num1=$symbchck+$symbseed+$namechck;
12756: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12757: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12758: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 12759: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 12760:
1.503 albertel 12761: return "$num1:$num2";
1.443 albertel 12762: }
12763: }
12764:
1.575 albertel 12765: sub rndseed_64bit4 {
12766: my ($symb,$courseid,$domain,$username)=@_;
12767: {
12768: use integer;
12769: # strings need to be an even # of cahracters long, it it is odd the
12770: # last characters gets thrown away
12771: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12772: my $symbseed=numval3($symb) << 10;
12773: my $namechck=unpack("%32S*",$username.' ');
12774:
12775: my $nameseed=numval3($username) << 21;
12776: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12777: my $courseseed=unpack("%32S*",$courseid.' ');
12778:
12779: my $num1=$symbchck+$symbseed+$namechck;
12780: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12781: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12782: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 12783: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 12784:
1.575 albertel 12785: return "$num1:$num2";
12786: }
12787: }
12788:
1.675 albertel 12789: sub rndseed_64bit5 {
12790: my ($symb,$courseid,$domain,$username)=@_;
12791: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
12792: return "$num1:$num2";
12793: }
12794:
1.366 albertel 12795: sub rndseed_CODE_64bit {
12796: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 12797: {
1.366 albertel 12798: use integer;
1.443 albertel 12799: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 12800: my $symbseed=numval2($symb);
1.491 albertel 12801: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12802: my $CODEseed=numval(&getCODE());
1.443 albertel 12803: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 12804: my $num1=$symbseed+$CODEchck;
12805: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12806: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12807: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 12808: if ($_64bit) { $num1=(($num1<<32)>>32); }
12809: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 12810: return "$num1:$num2";
1.366 albertel 12811: }
12812: }
12813:
1.575 albertel 12814: sub rndseed_CODE_64bit4 {
12815: my ($symb,$courseid,$domain,$username)=@_;
12816: {
12817: use integer;
12818: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12819: my $symbseed=numval3($symb);
12820: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12821: my $CODEseed=numval3(&getCODE());
12822: my $courseseed=unpack("%32S*",$courseid.' ');
12823: my $num1=$symbseed+$CODEchck;
12824: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12825: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12826: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 12827: if ($_64bit) { $num1=(($num1<<32)>>32); }
12828: if ($_64bit) { $num2=(($num2<<32)>>32); }
12829: return "$num1:$num2";
12830: }
12831: }
12832:
1.675 albertel 12833: sub rndseed_CODE_64bit5 {
12834: my ($symb,$courseid,$domain,$username)=@_;
12835: my $code = &getCODE();
12836: my ($num1,$num2)=&digest("$symb,$courseid,$code");
12837: return "$num1:$num2";
12838: }
12839:
1.366 albertel 12840: sub setup_random_from_rndseed {
12841: my ($rndseed)=@_;
1.503 albertel 12842: if ($rndseed =~/([,:])/) {
1.1262 raeburn 12843: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
12844: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
12845: &Math::Random::random_set_seed_from_phrase($rndseed);
12846: } else {
12847: &Math::Random::random_set_seed($num1,$num2);
12848: }
1.366 albertel 12849: } else {
12850: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 12851: }
1.36 albertel 12852: }
12853:
1.474 albertel 12854: sub latest_receipt_algorithm_id {
1.835 albertel 12855: return 'receipt3';
1.474 albertel 12856: }
12857:
1.480 www 12858: sub recunique {
12859: my $fucourseid=shift;
12860: my $unique;
1.835 albertel 12861: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
12862: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 12863: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 12864: } else {
12865: $unique=$perlvar{'lonReceipt'};
12866: }
12867: return unpack("%32C*",$unique);
12868: }
12869:
12870: sub recprefix {
12871: my $fucourseid=shift;
12872: my $prefix;
1.835 albertel 12873: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
12874: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 12875: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 12876: } else {
12877: $prefix=$perlvar{'lonHostID'};
12878: }
12879: return unpack("%32C*",$prefix);
12880: }
12881:
1.76 www 12882: sub ireceipt {
1.474 albertel 12883: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 12884:
12885: my $return =&recprefix($fucourseid).'-';
12886:
12887: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
12888: $env{'request.state'} eq 'construct') {
12889: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
12890: return $return;
12891: }
12892:
1.76 www 12893: my $cuname=unpack("%32C*",$funame);
12894: my $cudom=unpack("%32C*",$fudom);
12895: my $cucourseid=unpack("%32C*",$fucourseid);
12896: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 12897: my $cunique=&recunique($fucourseid);
1.474 albertel 12898: my $cpart=unpack("%32S*",$part);
1.835 albertel 12899: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
12900:
1.790 albertel 12901: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 12902:
12903: $return.= ($cunique%$cuname+
12904: $cunique%$cudom+
12905: $cusymb%$cuname+
12906: $cusymb%$cudom+
12907: $cucourseid%$cuname+
12908: $cucourseid%$cudom+
12909: $cpart%$cuname+
12910: $cpart%$cudom);
12911: } else {
12912: $return.= ($cunique%$cuname+
12913: $cunique%$cudom+
12914: $cusymb%$cuname+
12915: $cusymb%$cudom+
12916: $cucourseid%$cuname+
12917: $cucourseid%$cudom);
12918: }
12919: return $return;
1.76 www 12920: }
12921:
12922: sub receipt {
1.474 albertel 12923: my ($part)=@_;
1.790 albertel 12924: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 12925: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 12926: }
1.260 ng 12927:
1.790 albertel 12928: sub whichuser {
12929: my ($passedsymb)=@_;
12930: my ($symb,$courseid,$domain,$name,$publicuser);
12931: if (defined($env{'form.grade_symb'})) {
12932: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
12933: my $allowed=&allowed('vgr',$tmp_courseid);
12934: if (!$allowed &&
12935: exists($env{'request.course.sec'}) &&
12936: $env{'request.course.sec'} !~ /^\s*$/) {
12937: $allowed=&allowed('vgr',$tmp_courseid.
12938: '/'.$env{'request.course.sec'});
12939: }
12940: if ($allowed) {
12941: ($symb)=&get_env_multiple('form.grade_symb');
12942: $courseid=$tmp_courseid;
12943: ($domain)=&get_env_multiple('form.grade_domain');
12944: ($name)=&get_env_multiple('form.grade_username');
12945: return ($symb,$courseid,$domain,$name,$publicuser);
12946: }
12947: }
12948: if (!$passedsymb) {
12949: $symb=&symbread();
12950: } else {
12951: $symb=$passedsymb;
12952: }
12953: $courseid=$env{'request.course.id'};
12954: $domain=$env{'user.domain'};
12955: $name=$env{'user.name'};
12956: if ($name eq 'public' && $domain eq 'public') {
12957: if (!defined($env{'form.username'})) {
12958: $env{'form.username'}.=time.rand(10000000);
12959: }
12960: $name.=$env{'form.username'};
12961: }
12962: return ($symb,$courseid,$domain,$name,$publicuser);
12963:
12964: }
12965:
1.36 albertel 12966: # ------------------------------------------------------------ Serves up a file
1.472 albertel 12967: # returns either the contents of the file or
12968: # -1 if the file doesn't exist
1.481 raeburn 12969: #
12970: # if the target is a file that was uploaded via DOCS,
12971: # a check will be made to see if a current copy exists on the local server,
12972: # if it does this will be served, otherwise a copy will be retrieved from
12973: # the home server for the course and stored in /home/httpd/html/userfiles on
12974: # the local server.
1.472 albertel 12975:
1.36 albertel 12976: sub getfile {
1.538 albertel 12977: my ($file) = @_;
1.609 banghart 12978: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 12979: &repcopy($file);
12980: return &readfile($file);
12981: }
12982:
12983: sub repcopy_userfile {
12984: my ($file)=@_;
1.1142 raeburn 12985: my $londocroot = $perlvar{'lonDocRoot'};
12986: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 12987: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 12988: my ($cdom,$cnum,$filename) =
1.811 albertel 12989: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 12990: my $uri="/uploaded/$cdom/$cnum/$filename";
12991: if (-e "$file") {
1.828 www 12992: # we already have a local copy, check it out
1.538 albertel 12993: my @fileinfo = stat($file);
1.828 www 12994: my $rtncode;
12995: my $info;
1.538 albertel 12996: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 12997: if ($lwpresp ne 'ok') {
1.828 www 12998: # there is no such file anymore, even though we had a local copy
1.482 albertel 12999: if ($rtncode eq '404') {
1.538 albertel 13000: unlink($file);
1.482 albertel 13001: }
13002: return -1;
13003: }
13004: if ($info < $fileinfo[9]) {
1.828 www 13005: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 13006: return 'ok';
1.828 www 13007: } else {
13008: # the file is outdated, get rid of it
13009: unlink($file);
1.482 albertel 13010: }
1.828 www 13011: }
13012: # one way or the other, at this point, we don't have the file
13013: # construct the correct path for the file
13014: my @parts = ($cdom,$cnum);
13015: if ($filename =~ m|^(.+)/[^/]+$|) {
13016: push @parts, split(/\//,$1);
13017: }
13018: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
13019: foreach my $part (@parts) {
13020: $path .= '/'.$part;
13021: if (!-e $path) {
13022: mkdir($path,0770);
1.482 albertel 13023: }
13024: }
1.828 www 13025: # now the path exists for sure
13026: # get a user agent
13027: my $transferfile=$file.'.in.transfer';
13028: # FIXME: this should flock
13029: if (-e $transferfile) { return 'ok'; }
13030: my $request;
13031: $uri=~s/^\///;
1.980 raeburn 13032: my $homeserver = &homeserver($cnum,$cdom);
13033: my $protocol = $protocol{$homeserver};
13034: $protocol = 'http' if ($protocol ne 'https');
13035: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.1345 raeburn 13036: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
1.828 www 13037: # did it work?
13038: if ($response->is_error()) {
13039: unlink($transferfile);
13040: &logthis("Userfile repcopy failed for $uri");
13041: return -1;
13042: }
13043: # worked, rename the transfer file
13044: rename($transferfile,$file);
1.607 raeburn 13045: return 'ok';
1.481 raeburn 13046: }
13047:
1.517 albertel 13048: sub tokenwrapper {
13049: my $uri=shift;
1.980 raeburn 13050: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 13051: $uri=~s|^/||;
1.620 albertel 13052: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 13053: my $token=$1;
1.552 albertel 13054: my (undef,$udom,$uname,$file)=split('/',$uri,4);
13055: if ($udom && $uname && $file) {
13056: $file=~s|(\?\.*)*$||;
1.949 raeburn 13057: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 13058: my $homeserver = &homeserver($uname,$udom);
13059: my $protocol = $protocol{$homeserver};
13060: $protocol = 'http' if ($protocol ne 'https');
13061: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 13062: (($uri=~/\?/)?'&':'?').'token='.$token.
13063: '&tokenissued='.$perlvar{'lonHostID'};
13064: } else {
13065: return '/adm/notfound.html';
13066: }
13067: }
13068:
1.828 www 13069: # call with reqtype HEAD: get last modification time
13070: # call with reqtype GET: get the file contents
13071: # Do not call this with reqtype GET for large files! It loads everything into memory
13072: #
1.481 raeburn 13073: sub getuploaded {
13074: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
13075: $uri=~s/^\///;
1.980 raeburn 13076: my $homeserver = &homeserver($cnum,$cdom);
13077: my $protocol = $protocol{$homeserver};
13078: $protocol = 'http' if ($protocol ne 'https');
13079: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 13080: my $request=new HTTP::Request($reqtype,$uri);
1.1345 raeburn 13081: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
1.481 raeburn 13082: $$rtncode = $response->code;
1.482 albertel 13083: if (! $response->is_success()) {
13084: return 'failed';
13085: }
13086: if ($reqtype eq 'HEAD') {
1.486 www 13087: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 13088: } elsif ($reqtype eq 'GET') {
13089: $$info = $response->content;
1.472 albertel 13090: }
1.482 albertel 13091: return 'ok';
1.36 albertel 13092: }
13093:
1.481 raeburn 13094: sub readfile {
13095: my $file = shift;
13096: if ( (! -e $file ) || ($file eq '') ) { return -1; };
13097: my $fh;
1.1359 raeburn 13098: open($fh,"<",$file);
1.481 raeburn 13099: my $a='';
1.800 albertel 13100: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 13101: return $a;
13102: }
13103:
1.36 albertel 13104: sub filelocation {
1.590 banghart 13105: my ($dir,$file) = @_;
13106: my $location;
13107: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 13108:
13109: if ($file =~ m-^/adm/-) {
13110: $file=~s-^/adm/wrapper/-/-;
13111: $file=~s-^/adm/coursedocs/showdoc/-/-;
13112: }
1.882 albertel 13113:
1.1139 www 13114: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 13115: $location = $file;
1.609 banghart 13116: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 13117: my ($udom,$uname,$filename)=
1.811 albertel 13118: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 13119: my $home=&homeserver($uname,$udom);
13120: my $is_me=0;
13121: my @ids=¤t_machine_ids();
13122: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
13123: if ($is_me) {
1.1117 foxr 13124: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 13125: } else {
13126: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
13127: $udom.'/'.$uname.'/'.$filename;
13128: }
1.882 albertel 13129: } elsif ($file =~ m-^/adm/-) {
13130: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 13131: } else {
13132: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 13133: $file=~s:^/(res|priv)/:/:;
13134: my $space=$1;
1.590 banghart 13135: if ( !( $file =~ m:^/:) ) {
13136: $location = $dir. '/'.$file;
13137: } else {
1.1142 raeburn 13138: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 13139: }
1.59 albertel 13140: }
1.590 banghart 13141: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 13142: while ($location=~m{/\.\./}) {
13143: if ($location =~ m{/[^/]+/\.\./}) {
13144: $location=~ s{/[^/]+/\.\./}{/}g;
13145: } else {
13146: $location=~ s{/\.\./}{/}g;
13147: }
13148: } #remove dir/..
1.590 banghart 13149: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
13150: return $location;
1.46 www 13151: }
1.36 albertel 13152:
1.46 www 13153: sub hreflocation {
13154: my ($dir,$file)=@_;
1.980 raeburn 13155: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 13156: $file=filelocation($dir,$file);
1.700 albertel 13157: } elsif ($file=~m-^/adm/-) {
13158: $file=~s-^/adm/wrapper/-/-;
13159: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 13160: }
13161: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
13162: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
13163: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 13164: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
13165: {/uploaded/$1/$2/}x;
1.46 www 13166: }
1.913 albertel 13167: if ($file=~ m{^/userfiles/}) {
13168: $file =~ s{^/userfiles/}{/uploaded/};
13169: }
1.462 albertel 13170: return $file;
1.465 albertel 13171: }
13172:
1.1139 www 13173:
13174:
13175:
13176:
1.465 albertel 13177: sub current_machine_domains {
1.853 albertel 13178: return &machine_domains(&hostname($perlvar{'lonHostID'}));
13179: }
13180:
13181: sub machine_domains {
13182: my ($hostname) = @_;
1.465 albertel 13183: my @domains;
1.838 albertel 13184: my %hostname = &all_hostnames();
1.465 albertel 13185: while( my($id, $name) = each(%hostname)) {
1.467 matthew 13186: # &logthis("-$id-$name-$hostname-");
1.465 albertel 13187: if ($hostname eq $name) {
1.844 albertel 13188: push(@domains,&host_domain($id));
1.465 albertel 13189: }
13190: }
13191: return @domains;
13192: }
13193:
13194: sub current_machine_ids {
1.853 albertel 13195: return &machine_ids(&hostname($perlvar{'lonHostID'}));
13196: }
13197:
13198: sub machine_ids {
13199: my ($hostname) = @_;
13200: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 13201: my @ids;
1.888 albertel 13202: my %name_to_host = &all_names();
1.889 albertel 13203: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
13204: return @{ $name_to_host{$hostname} };
13205: }
13206: return;
1.31 www 13207: }
13208:
1.824 raeburn 13209: sub additional_machine_domains {
13210: my @domains;
1.1359 raeburn 13211: open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab");
1.824 raeburn 13212: while( my $line = <$fh>) {
13213: $line =~ s/\s//g;
13214: push(@domains,$line);
13215: }
13216: return @domains;
13217: }
13218:
13219: sub default_login_domain {
13220: my $domain = $perlvar{'lonDefDomain'};
13221: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
13222: foreach my $posdom (¤t_machine_domains(),
13223: &additional_machine_domains()) {
13224: if (lc($posdom) eq lc($testdomain)) {
13225: $domain=$posdom;
13226: last;
13227: }
13228: }
13229: return $domain;
13230: }
13231:
1.31 www 13232: # ------------------------------------------------------------- Declutters URLs
13233:
13234: sub declutter {
13235: my $thisfn=shift;
1.569 albertel 13236: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261 raeburn 13237: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
13238: $thisfn=~s{^/home/httpd/html}{};
13239: }
1.31 www 13240: $thisfn=~s/^\///;
1.697 albertel 13241: $thisfn=~s|^adm/wrapper/||;
13242: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 13243: $thisfn=~s/^res\///;
1.1172 bisitz 13244: $thisfn=~s/^priv\///;
1.1032 raeburn 13245: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
13246: $thisfn=~s/\?.+$//;
13247: }
1.268 www 13248: return $thisfn;
13249: }
13250:
13251: # ------------------------------------------------------------- Clutter up URLs
13252:
13253: sub clutter {
13254: my $thisfn='/'.&declutter(shift);
1.887 albertel 13255: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 13256: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 13257: $thisfn='/res'.$thisfn;
13258: }
1.1031 raeburn 13259: if ($thisfn !~m|^/adm|) {
13260: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 13261: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 13262: } else {
13263: my ($ext) = ($thisfn =~ /\.(\w+)$/);
13264: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 13265: if ($embstyle eq 'ssi'
13266: || ($embstyle eq 'hdn')
13267: || ($embstyle eq 'rat')
13268: || ($embstyle eq 'prv')
13269: || ($embstyle eq 'ign')) {
13270: #do nothing with these
13271: } elsif (($embstyle eq 'img')
1.695 albertel 13272: || ($embstyle eq 'emb')
13273: || ($embstyle eq 'wrp')) {
13274: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 13275: } elsif ($embstyle eq 'unk'
13276: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 13277: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 13278: } else {
1.718 www 13279: # &logthis("Got a blank emb style");
1.695 albertel 13280: }
1.694 albertel 13281: }
1.1343 raeburn 13282: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
1.1298 raeburn 13283: $thisfn='/adm/wrapper'.$thisfn;
1.694 albertel 13284: }
1.31 www 13285: return $thisfn;
1.12 www 13286: }
13287:
1.787 albertel 13288: sub clutter_with_no_wrapper {
13289: my $uri = &clutter(shift);
13290: if ($uri =~ m-^/adm/-) {
13291: $uri =~ s-^/adm/wrapper/-/-;
13292: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
13293: }
13294: return $uri;
13295: }
13296:
1.557 albertel 13297: sub freeze_escape {
13298: my ($value)=@_;
13299: if (ref($value)) {
13300: $value=&nfreeze($value);
13301: return '__FROZEN__'.&escape($value);
13302: }
13303: return &escape($value);
13304: }
13305:
1.11 www 13306:
1.557 albertel 13307: sub thaw_unescape {
13308: my ($value)=@_;
13309: if ($value =~ /^__FROZEN__/) {
13310: substr($value,0,10,undef);
13311: $value=&unescape($value);
13312: return &thaw($value);
13313: }
13314: return &unescape($value);
13315: }
13316:
1.436 albertel 13317: sub correct_line_ends {
13318: my ($result)=@_;
13319: $$result =~s/\r\n/\n/mg;
13320: $$result =~s/\r/\n/mg;
1.415 albertel 13321: }
1.1 albertel 13322: # ================================================================ Main Program
13323:
1.184 www 13324: sub goodbye {
1.204 albertel 13325: &logthis("Starting Shut down");
1.443 albertel 13326: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 13327: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 13328: #converted
1.599 albertel 13329: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 13330: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
13331: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
13332: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 13333: #1.1 only
1.870 albertel 13334: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
13335: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
13336: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
13337: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
13338: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 13339: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
13340: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 13341: &flushcourselogs();
13342: &logthis("Shutting down");
13343: }
13344:
1.852 albertel 13345: sub get_dns {
1.1210 raeburn 13346: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 13347: if (!$ignore_cache) {
13348: my ($content,$cached)=
13349: &Apache::lonnet::is_cached_new('dns',$url);
13350: if ($cached) {
1.1210 raeburn 13351: &$func($content,$hashref);
1.869 albertel 13352: return;
13353: }
13354: }
13355:
13356: my %alldns;
1.1359 raeburn 13357: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852 albertel 13358: foreach my $dns (<$config>) {
13359: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 13360: my $line = $1;
13361: my ($host,$protocol) = split(/:/,$line);
13362: if ($protocol ne 'https') {
13363: $protocol = 'http';
13364: }
13365: $alldns{$host} = $protocol;
1.869 albertel 13366: }
13367: while (%alldns) {
1.1263 raeburn 13368: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.979 raeburn 13369: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.1345 raeburn 13370: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
1.979 raeburn 13371: delete($alldns{$dns});
1.852 albertel 13372: next if ($response->is_error());
13373: my @content = split("\n",$response->content);
1.1210 raeburn 13374: unless ($nocache) {
1.1219 raeburn 13375: &do_cache_new('dns',$url,\@content,30*24*60*60);
1.1210 raeburn 13376: }
13377: &$func(\@content,$hashref);
1.869 albertel 13378: return;
1.852 albertel 13379: }
13380: close($config);
1.871 albertel 13381: my $which = (split('/',$url))[3];
13382: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
1.1359 raeburn 13383: open($config,"<","$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 13384: my @content = <$config>;
1.1210 raeburn 13385: &$func(\@content,$hashref);
13386: return;
13387: }
13388:
13389: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 13390: sub parse_dns_checksums_tab {
1.1210 raeburn 13391: my ($lines,$hashref) = @_;
1.1264 raeburn 13392: my $lonhost = $perlvar{'lonHostID'};
13393: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1210 raeburn 13394: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264 raeburn 13395: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
13396: my $webconfdir = '/etc/httpd/conf';
13397: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
13398: $webconfdir = '/etc/apache2';
13399: } elsif ($distro =~ /^sles(\d+)$/) {
13400: if ($1 >= 10) {
13401: $webconfdir = '/etc/apache2';
13402: }
13403: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
13404: if ($1 >= 10.0) {
13405: $webconfdir = '/etc/apache2';
13406: }
13407: }
1.1210 raeburn 13408: my ($release,$timestamp) = split(/\-/,$loncaparev);
13409: my (%chksum,%revnum);
13410: if (ref($lines) eq 'ARRAY') {
13411: chomp(@{$lines});
1.1238 raeburn 13412: my $version = shift(@{$lines});
13413: if ($version eq $release) {
1.1210 raeburn 13414: foreach my $line (@{$lines}) {
1.1238 raeburn 13415: my ($file,$version,$shasum) = split(/,/,$line);
1.1264 raeburn 13416: if ($file =~ m{^/etc/httpd/conf}) {
13417: if ($webconfdir eq '/etc/apache2') {
13418: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
13419: }
13420: }
1.1238 raeburn 13421: $chksum{$file} = $shasum;
13422: $revnum{$file} = $version;
1.1210 raeburn 13423: }
13424: if (ref($hashref) eq 'HASH') {
13425: %{$hashref} = (
13426: sums => \%chksum,
13427: versions => \%revnum,
13428: );
13429: }
13430: }
13431: }
1.869 albertel 13432: return;
1.852 albertel 13433: }
1.1210 raeburn 13434:
13435: sub fetch_dns_checksums {
1.1238 raeburn 13436: my %checksums;
13437: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1260 raeburn 13438: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238 raeburn 13439: my ($release,$timestamp) = split(/\-/,$loncaparev);
13440: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211 raeburn 13441: \%checksums);
1.1210 raeburn 13442: return \%checksums;
13443: }
13444:
1.327 albertel 13445: # ------------------------------------------------------------ Read domain file
13446: {
1.852 albertel 13447: my $loaded;
1.846 albertel 13448: my %domain;
13449:
1.852 albertel 13450: sub parse_domain_tab {
13451: my ($lines) = @_;
13452: foreach my $line (@$lines) {
13453: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 13454:
1.846 albertel 13455: chomp($line);
1.852 albertel 13456: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 13457: my %this_domain;
13458: foreach my $field ('description', 'auth_def', 'auth_arg_def',
13459: 'lang_def', 'city', 'longi', 'lati',
13460: 'primary') {
13461: $this_domain{$field} = shift(@elements);
13462: }
13463: $domain{$name} = \%this_domain;
1.852 albertel 13464: }
13465: }
1.864 albertel 13466:
13467: sub reset_domain_info {
13468: undef($loaded);
13469: undef(%domain);
13470: }
13471:
1.852 albertel 13472: sub load_domain_tab {
1.1293 raeburn 13473: my ($ignore_cache,$nocache) = @_;
13474: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 13475: my $fh;
1.1359 raeburn 13476: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
1.852 albertel 13477: my @lines = <$fh>;
13478: &parse_domain_tab(\@lines);
1.448 albertel 13479: }
1.852 albertel 13480: close($fh);
13481: $loaded = 1;
1.327 albertel 13482: }
1.846 albertel 13483:
13484: sub domain {
1.852 albertel 13485: &load_domain_tab() if (!$loaded);
13486:
1.846 albertel 13487: my ($name,$what) = @_;
13488: return if ( !exists($domain{$name}) );
13489:
13490: if (!$what) {
13491: return $domain{$name}{'description'};
13492: }
13493: return $domain{$name}{$what};
13494: }
1.974 raeburn 13495:
13496: sub domain_info {
13497: &load_domain_tab() if (!$loaded);
13498: return %domain;
13499: }
13500:
1.327 albertel 13501: }
13502:
13503:
1.1 albertel 13504: # ------------------------------------------------------------- Read hosts file
13505: {
1.838 albertel 13506: my %hostname;
1.844 albertel 13507: my %hostdom;
1.845 albertel 13508: my %libserv;
1.852 albertel 13509: my $loaded;
1.888 albertel 13510: my %name_to_host;
1.1074 raeburn 13511: my %internetdom;
1.1107 raeburn 13512: my %LC_dns_serv;
1.852 albertel 13513:
13514: sub parse_hosts_tab {
13515: my ($file) = @_;
13516: foreach my $configline (@$file) {
13517: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 13518: chomp($configline);
13519: if ($configline =~ /^\^/) {
13520: if ($configline =~ /^\^([\w.\-]+)/) {
13521: $LC_dns_serv{$1} = 1;
13522: }
13523: next;
13524: }
1.1074 raeburn 13525: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 13526: $name=~s/\s//g;
13527: if ($id && $domain && $role && $name) {
1.1351 raeburn 13528: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
13529: my $curr = $hostname{$id};
13530: my $skip;
13531: if (ref($name_to_host{$curr}) eq 'ARRAY') {
13532: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
13533: $skip = 1;
13534: } else {
13535: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
13536: }
13537: }
13538: unless ($skip) {
13539: push(@{$name_to_host{$name}},$id);
13540: }
13541: } else {
13542: push(@{$name_to_host{$name}},$id);
13543: }
1.852 albertel 13544: $hostname{$id}=$name;
13545: $hostdom{$id}=$domain;
13546: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 13547: if (defined($protocol)) {
13548: if ($protocol eq 'https') {
13549: $protocol{$id} = $protocol;
13550: } else {
13551: $protocol{$id} = 'http';
13552: }
1.968 raeburn 13553: } else {
1.969 raeburn 13554: $protocol{$id} = 'http';
1.968 raeburn 13555: }
1.1074 raeburn 13556: if (defined($intdom)) {
13557: $internetdom{$id} = $intdom;
13558: }
1.852 albertel 13559: }
13560: }
13561: }
1.864 albertel 13562:
13563: sub reset_hosts_info {
1.897 albertel 13564: &purge_remembered();
1.864 albertel 13565: &reset_domain_info();
13566: &reset_hosts_ip_info();
1.1339 raeburn 13567: undef(%internetdom);
1.892 albertel 13568: undef(%name_to_host);
1.864 albertel 13569: undef(%hostname);
13570: undef(%hostdom);
13571: undef(%libserv);
13572: undef($loaded);
13573: }
1.1 albertel 13574:
1.852 albertel 13575: sub load_hosts_tab {
1.1293 raeburn 13576: my ($ignore_cache,$nocache) = @_;
13577: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.1359 raeburn 13578: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852 albertel 13579: my @config = <$config>;
13580: &parse_hosts_tab(\@config);
13581: close($config);
13582: $loaded=1;
1.1 albertel 13583: }
1.852 albertel 13584:
1.838 albertel 13585: sub hostname {
1.852 albertel 13586: &load_hosts_tab() if (!$loaded);
13587:
1.838 albertel 13588: my ($lonid) = @_;
13589: return $hostname{$lonid};
13590: }
1.845 albertel 13591:
1.838 albertel 13592: sub all_hostnames {
1.852 albertel 13593: &load_hosts_tab() if (!$loaded);
13594:
1.838 albertel 13595: return %hostname;
13596: }
1.845 albertel 13597:
1.888 albertel 13598: sub all_names {
1.1293 raeburn 13599: my ($ignore_cache,$nocache) = @_;
13600: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 13601:
13602: return %name_to_host;
13603: }
13604:
1.974 raeburn 13605: sub all_host_domain {
13606: &load_hosts_tab() if (!$loaded);
13607: return %hostdom;
13608: }
13609:
1.1339 raeburn 13610: sub all_host_intdom {
13611: &load_hosts_tab() if (!$loaded);
13612: return %internetdom;
13613: }
13614:
1.845 albertel 13615: sub is_library {
1.852 albertel 13616: &load_hosts_tab() if (!$loaded);
13617:
1.845 albertel 13618: return exists($libserv{$_[0]});
13619: }
13620:
13621: sub all_library {
1.852 albertel 13622: &load_hosts_tab() if (!$loaded);
13623:
1.845 albertel 13624: return %libserv;
13625: }
13626:
1.1062 droeschl 13627: sub unique_library {
13628: #2x reverse removes all hostnames that appear more than once
13629: my %unique = reverse &all_library();
13630: return reverse %unique;
13631: }
13632:
1.841 albertel 13633: sub get_servers {
1.852 albertel 13634: &load_hosts_tab() if (!$loaded);
13635:
1.841 albertel 13636: my ($domain,$type) = @_;
13637: my %possible_hosts = ($type eq 'library') ? %libserv
13638: : %hostname;
13639: my %result;
1.842 albertel 13640: if (ref($domain) eq 'ARRAY') {
13641: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 13642: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 13643: $result{$host} = $hostname;
13644: }
13645: }
13646: } else {
13647: while ( my ($host,$hostname) = each(%possible_hosts)) {
13648: if ($hostdom{$host} eq $domain) {
13649: $result{$host} = $hostname;
13650: }
1.841 albertel 13651: }
13652: }
13653: return %result;
13654: }
1.845 albertel 13655:
1.1062 droeschl 13656: sub get_unique_servers {
13657: my %unique = reverse &get_servers(@_);
13658: return reverse %unique;
13659: }
13660:
1.844 albertel 13661: sub host_domain {
1.852 albertel 13662: &load_hosts_tab() if (!$loaded);
13663:
1.844 albertel 13664: my ($lonid) = @_;
13665: return $hostdom{$lonid};
13666: }
13667:
1.841 albertel 13668: sub all_domains {
1.852 albertel 13669: &load_hosts_tab() if (!$loaded);
13670:
1.841 albertel 13671: my %seen;
13672: my @uniq = grep(!$seen{$_}++, values(%hostdom));
13673: return @uniq;
13674: }
1.1074 raeburn 13675:
13676: sub internet_dom {
13677: &load_hosts_tab() if (!$loaded);
13678:
13679: my ($lonid) = @_;
13680: return $internetdom{$lonid};
13681: }
1.1107 raeburn 13682:
13683: sub is_LC_dns {
13684: &load_hosts_tab() if (!$loaded);
13685:
13686: my ($hostname) = @_;
13687: return exists($LC_dns_serv{$hostname});
13688: }
13689:
1.1 albertel 13690: }
13691:
1.847 albertel 13692: {
13693: my %iphost;
1.856 albertel 13694: my %name_to_ip;
13695: my %lonid_to_ip;
1.869 albertel 13696:
1.847 albertel 13697: sub get_hosts_from_ip {
13698: my ($ip) = @_;
13699: my %iphosts = &get_iphost();
13700: if (ref($iphosts{$ip})) {
13701: return @{$iphosts{$ip}};
13702: }
13703: return;
1.839 albertel 13704: }
1.864 albertel 13705:
13706: sub reset_hosts_ip_info {
13707: undef(%iphost);
13708: undef(%name_to_ip);
13709: undef(%lonid_to_ip);
13710: }
1.856 albertel 13711:
13712: sub get_host_ip {
13713: my ($lonid) = @_;
13714: if (exists($lonid_to_ip{$lonid})) {
13715: return $lonid_to_ip{$lonid};
13716: }
13717: my $name=&hostname($lonid);
13718: my $ip = gethostbyname($name);
13719: return if (!$ip || length($ip) ne 4);
13720: $ip=inet_ntoa($ip);
13721: $name_to_ip{$name} = $ip;
13722: $lonid_to_ip{$lonid} = $ip;
13723: return $ip;
13724: }
1.847 albertel 13725:
13726: sub get_iphost {
1.1293 raeburn 13727: my ($ignore_cache,$nocache) = @_;
1.894 albertel 13728:
1.869 albertel 13729: if (!$ignore_cache) {
13730: if (%iphost) {
13731: return %iphost;
13732: }
13733: my ($ip_info,$cached)=
13734: &Apache::lonnet::is_cached_new('iphost','iphost');
13735: if ($cached) {
13736: %iphost = %{$ip_info->[0]};
13737: %name_to_ip = %{$ip_info->[1]};
13738: %lonid_to_ip = %{$ip_info->[2]};
13739: return %iphost;
13740: }
13741: }
1.894 albertel 13742:
13743: # get yesterday's info for fallback
13744: my %old_name_to_ip;
13745: my ($ip_info,$cached)=
13746: &Apache::lonnet::is_cached_new('iphost','iphost');
13747: if ($cached) {
13748: %old_name_to_ip = %{$ip_info->[1]};
13749: }
13750:
1.1293 raeburn 13751: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 13752: foreach my $name (keys(%name_to_host)) {
1.847 albertel 13753: my $ip;
13754: if (!exists($name_to_ip{$name})) {
13755: $ip = gethostbyname($name);
13756: if (!$ip || length($ip) ne 4) {
1.894 albertel 13757: if (defined($old_name_to_ip{$name})) {
13758: $ip = $old_name_to_ip{$name};
13759: &logthis("Can't find $name defaulting to old $ip");
13760: } else {
13761: &logthis("Name $name no IP found");
13762: next;
13763: }
13764: } else {
13765: $ip=inet_ntoa($ip);
1.847 albertel 13766: }
13767: $name_to_ip{$name} = $ip;
13768: } else {
13769: $ip = $name_to_ip{$name};
1.653 albertel 13770: }
1.888 albertel 13771: foreach my $id (@{ $name_to_host{$name} }) {
13772: $lonid_to_ip{$id} = $ip;
13773: }
13774: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 13775: }
1.1293 raeburn 13776: unless ($nocache) {
13777: &do_cache_new('iphost','iphost',
13778: [\%iphost,\%name_to_ip,\%lonid_to_ip],
13779: 48*60*60);
13780: }
1.869 albertel 13781:
1.847 albertel 13782: return %iphost;
1.598 albertel 13783: }
13784:
1.992 raeburn 13785: #
13786: # Given a DNS returns the loncapa host name for that DNS
13787: #
13788: sub host_from_dns {
13789: my ($dns) = @_;
13790: my @hosts;
13791: my $ip;
13792:
1.993 raeburn 13793: if (exists($name_to_ip{$dns})) {
1.992 raeburn 13794: $ip = $name_to_ip{$dns};
13795: }
13796: if (!$ip) {
13797: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
13798: if (length($ip) == 4) {
13799: $ip = &IO::Socket::inet_ntoa($ip);
13800: }
13801: }
13802: if ($ip) {
13803: @hosts = get_hosts_from_ip($ip);
13804: return $hosts[0];
13805: }
13806: return undef;
1.986 foxr 13807: }
1.992 raeburn 13808:
1.1074 raeburn 13809: sub get_internet_names {
13810: my ($lonid) = @_;
13811: return if ($lonid eq '');
13812: my ($idnref,$cached)=
13813: &Apache::lonnet::is_cached_new('internetnames',$lonid);
13814: if ($cached) {
13815: return $idnref;
13816: }
13817: my $ip = &get_host_ip($lonid);
13818: my @hosts = &get_hosts_from_ip($ip);
13819: my %iphost = &get_iphost();
13820: my (@idns,%seen);
13821: foreach my $id (@hosts) {
13822: my $dom = &host_domain($id);
13823: my $prim_id = &domain($dom,'primary');
13824: my $prim_ip = &get_host_ip($prim_id);
13825: next if ($seen{$prim_ip});
13826: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
13827: foreach my $id (@{$iphost{$prim_ip}}) {
13828: my $intdom = &internet_dom($id);
13829: unless (grep(/^\Q$intdom\E$/,@idns)) {
13830: push(@idns,$intdom);
13831: }
13832: }
13833: }
13834: $seen{$prim_ip} = 1;
13835: }
1.1219 raeburn 13836: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 13837: }
13838:
1.986 foxr 13839: }
13840:
1.1079 raeburn 13841: sub all_loncaparevs {
1.1249 raeburn 13842: 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 13843: }
13844:
1.1227 raeburn 13845: # ---------------------------------------------------------- Read loncaparev table
13846: {
13847: sub load_loncaparevs {
13848: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
1.1359 raeburn 13849: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
1.1227 raeburn 13850: while (my $configline=<$config>) {
13851: chomp($configline);
13852: my ($hostid,$loncaparev)=split(/:/,$configline);
13853: $loncaparevs{$hostid}=$loncaparev;
13854: }
13855: close($config);
13856: }
13857: }
13858: }
13859: }
13860:
13861: # ---------------------------------------------------------- Read serverhostID table
13862: {
13863: sub load_serverhomeIDs {
13864: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
1.1359 raeburn 13865: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
1.1227 raeburn 13866: while (my $configline=<$config>) {
13867: chomp($configline);
13868: my ($name,$id)=split(/:/,$configline);
13869: $serverhomeIDs{$name}=$id;
13870: }
13871: close($config);
13872: }
13873: }
13874: }
13875: }
13876:
13877:
1.862 albertel 13878: BEGIN {
13879:
13880: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
13881: unless ($readit) {
13882: {
13883: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
13884: %perlvar = (%perlvar,%{$configvars});
13885: }
13886:
13887:
1.1 albertel 13888: # ------------------------------------------------------ Read spare server file
13889: {
1.1359 raeburn 13890: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 13891:
13892: while (my $configline=<$config>) {
13893: chomp($configline);
1.284 matthew 13894: if ($configline) {
1.784 albertel 13895: my ($host,$type) = split(':',$configline,2);
1.785 albertel 13896: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 13897: push(@{ $spareid{$type} }, $host);
1.1 albertel 13898: }
13899: }
1.448 albertel 13900: close($config);
1.1 albertel 13901: }
1.11 www 13902: # ------------------------------------------------------------ Read permissions
13903: {
1.1359 raeburn 13904: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
1.11 www 13905:
13906: while (my $configline=<$config>) {
1.448 albertel 13907: chomp($configline);
13908: if ($configline) {
13909: my ($role,$perm)=split(/ /,$configline);
13910: if ($perm ne '') { $pr{$role}=$perm; }
13911: }
1.11 www 13912: }
1.448 albertel 13913: close($config);
1.11 www 13914: }
13915:
13916: # -------------------------------------------- Read plain texts for permissions
13917: {
1.1359 raeburn 13918: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 13919:
13920: while (my $configline=<$config>) {
1.448 albertel 13921: chomp($configline);
13922: if ($configline) {
1.742 raeburn 13923: my ($short,@plain)=split(/:/,$configline);
13924: %{$prp{$short}} = ();
13925: if (@plain > 0) {
13926: $prp{$short}{'std'} = $plain[0];
13927: for (my $i=1; $i<@plain; $i++) {
13928: $prp{$short}{'alt'.$i} = $plain[$i];
13929: }
13930: }
1.448 albertel 13931: }
1.135 www 13932: }
1.448 albertel 13933: close($config);
1.135 www 13934: }
13935:
13936: # ---------------------------------------------------------- Read package table
13937: {
1.1359 raeburn 13938: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
1.135 www 13939:
13940: while (my $configline=<$config>) {
1.483 albertel 13941: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 13942: chomp($configline);
13943: my ($short,$plain)=split(/:/,$configline);
13944: my ($pack,$name)=split(/\&/,$short);
13945: if ($plain ne '') {
13946: $packagetab{$pack.'&'.$name.'&name'}=$name;
13947: $packagetab{$short}=$plain;
13948: }
1.11 www 13949: }
1.448 albertel 13950: close($config);
1.329 matthew 13951: }
13952:
1.1073 raeburn 13953: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 13954:
13955: &load_loncaparevs();
1.1073 raeburn 13956:
1.1074 raeburn 13957: # ---------------------------------------------------------- Read serverhostID table
13958:
1.1227 raeburn 13959: &load_serverhomeIDs();
13960:
13961: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 13962: {
13963: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
13964: if (-e $file) {
13965: my $parser = HTML::LCParser->new($file);
13966: while (my $token = $parser->get_token()) {
13967: if ($token->[0] eq 'S') {
13968: my $item = $token->[1];
13969: my $name = $token->[2]{'name'};
13970: my $value = $token->[2]{'value'};
1.1285 raeburn 13971: my $valuematch = $token->[2]{'valuematch'};
1.1303 raeburn 13972: my $namematch = $token->[2]{'namematch'};
13973: if ($item eq 'parameter') {
13974: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
13975: my $release = $parser->get_text();
13976: $release =~ s/(^\s*|\s*$ )//gx;
13977: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
13978: }
13979: } elsif ($item ne '' && $name ne '') {
1.1079 raeburn 13980: my $release = $parser->get_text();
13981: $release =~ s/(^\s*|\s*$ )//gx;
1.1303 raeburn 13982: $needsrelease{$item.':'.$name.':'.$value} = $release;
1.1079 raeburn 13983: }
13984: }
13985: }
13986: }
1.1073 raeburn 13987: }
13988:
1.1138 raeburn 13989: # ---------------------------------------------------------- Read managers table
13990: {
13991: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
1.1359 raeburn 13992: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
1.1138 raeburn 13993: while (my $configline=<$config>) {
13994: chomp($configline);
13995: next if ($configline =~ /^\#/);
13996: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
13997: $managerstab{$configline} = 1;
13998: }
13999: }
14000: close($config);
14001: }
14002: }
14003: }
14004:
1.329 matthew 14005: # ------------- set up temporary directory
14006: {
1.1117 foxr 14007: $tmpdir = LONCAPA::tempdir();
1.329 matthew 14008:
1.11 www 14009: }
14010:
1.794 albertel 14011: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
14012: 'compress_threshold'=> 20_000,
14013: });
1.185 www 14014:
1.281 www 14015: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 14016: $dumpcount=0;
1.958 www 14017: $locknum=0;
1.22 www 14018:
1.163 harris41 14019: &logtouch();
1.672 albertel 14020: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 14021: $readit=1;
1.564 albertel 14022: {
14023: use integer;
14024: my $test=(2**32)+1;
1.568 albertel 14025: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 14026: &logthis(" Detected 64bit platform ($_64bit)");
14027: }
1.195 www 14028: }
1.1 albertel 14029: }
1.179 www 14030:
1.1 albertel 14031: 1;
1.191 harris41 14032: __END__
14033:
1.243 albertel 14034: =pod
14035:
1.191 harris41 14036: =head1 NAME
14037:
1.243 albertel 14038: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 14039:
14040: =head1 SYNOPSIS
14041:
1.243 albertel 14042: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 14043:
14044: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
14045:
1.243 albertel 14046: Common parameters:
14047:
14048: =over 4
14049:
14050: =item *
14051:
14052: $uname : an internal username (if $cname expecting a course Id specifically)
14053:
14054: =item *
14055:
14056: $udom : a domain (if $cdom expecting a course's domain specifically)
14057:
14058: =item *
14059:
14060: $symb : a resource instance identifier
14061:
14062: =item *
14063:
14064: $namespace : the name of a .db file that contains the data needed or
14065: being set.
14066:
14067: =back
14068:
1.394 bowersj2 14069: =head1 OVERVIEW
1.191 harris41 14070:
1.394 bowersj2 14071: lonnet provides subroutines which interact with the
14072: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
14073: about classes, users, and resources.
1.243 albertel 14074:
14075: For many of these objects you can also use this to store data about
14076: them or modify them in various ways.
1.191 harris41 14077:
1.394 bowersj2 14078: =head2 Symbs
1.191 harris41 14079:
1.394 bowersj2 14080: To identify a specific instance of a resource, LON-CAPA uses symbols
14081: or "symbs"X<symb>. These identifiers are built from the URL of the
14082: map, the resource number of the resource in the map, and the URL of
14083: the resource itself. The latter is somewhat redundant, but might help
14084: if maps change.
14085:
14086: An example is
14087:
14088: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
14089:
14090: The respective map entry is
14091:
14092: <resource id="19" src="/res/msu/korte/tests/part12.problem"
14093: title="Problem 2">
14094: </resource>
14095:
14096: Symbs are used by the random number generator, as well as to store and
14097: restore data specific to a certain instance of for example a problem.
14098:
14099: =head2 Storing And Retrieving Data
14100:
14101: X<store()>X<cstore()>X<restore()>Three of the most important functions
14102: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
14103: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
14104: is is the non-critical message twin of cstore. These functions are for
14105: handlers to store a perl hash to a user's permanent data space in an
14106: easy manner, and to retrieve it again on another call. It is expected
14107: that a handler would use this once at the beginning to retrieve data,
14108: and then again once at the end to send only the new data back.
14109:
14110: The data is stored in the user's data directory on the user's
14111: homeserver under the ID of the course.
14112:
14113: The hash that is returned by restore will have all of the previous
14114: value for all of the elements of the hash.
14115:
14116: Example:
14117:
14118: #creating a hash
14119: my %hash;
14120: $hash{'foo'}='bar';
14121:
14122: #storing it
14123: &Apache::lonnet::cstore(\%hash);
14124:
14125: #changing a value
14126: $hash{'foo'}='notbar';
14127:
14128: #adding a new value
14129: $hash{'bar'}='foo';
14130: &Apache::lonnet::cstore(\%hash);
14131:
14132: #retrieving the hash
14133: my %history=&Apache::lonnet::restore();
14134:
14135: #print the hash
14136: foreach my $key (sort(keys(%history))) {
14137: print("\%history{$key} = $history{$key}");
14138: }
14139:
14140: Will print out:
1.191 harris41 14141:
1.394 bowersj2 14142: %history{1:foo} = bar
14143: %history{1:keys} = foo:timestamp
14144: %history{1:timestamp} = 990455579
14145: %history{2:bar} = foo
14146: %history{2:foo} = notbar
14147: %history{2:keys} = foo:bar:timestamp
14148: %history{2:timestamp} = 990455580
14149: %history{bar} = foo
14150: %history{foo} = notbar
14151: %history{timestamp} = 990455580
14152: %history{version} = 2
14153:
14154: Note that the special hash entries C<keys>, C<version> and
14155: C<timestamp> were added to the hash. C<version> will be equal to the
14156: total number of versions of the data that have been stored. The
14157: C<timestamp> attribute will be the UNIX time the hash was
14158: stored. C<keys> is available in every historical section to list which
14159: keys were added or changed at a specific historical revision of a
14160: hash.
14161:
14162: B<Warning>: do not store the hash that restore returns directly. This
14163: will cause a mess since it will restore the historical keys as if the
14164: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 14165:
1.394 bowersj2 14166: Calling convention:
1.191 harris41 14167:
1.1225 raeburn 14168: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269 raeburn 14169: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 14170:
1.394 bowersj2 14171: For more detailed information, see lonnet specific documentation.
1.191 harris41 14172:
1.394 bowersj2 14173: =head1 RETURN MESSAGES
1.191 harris41 14174:
1.394 bowersj2 14175: =over 4
1.191 harris41 14176:
1.394 bowersj2 14177: =item * B<con_lost>: unable to contact remote host
1.191 harris41 14178:
1.394 bowersj2 14179: =item * B<con_delayed>: unable to contact remote host, message will be delivered
14180: when the connection is brought back up
1.191 harris41 14181:
1.394 bowersj2 14182: =item * B<con_failed>: unable to contact remote host and unable to save message
14183: for later delivery
1.191 harris41 14184:
1.967 bisitz 14185: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 14186:
1.394 bowersj2 14187: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 14188: that was requested
1.191 harris41 14189:
1.243 albertel 14190: =back
1.191 harris41 14191:
1.243 albertel 14192: =head1 PUBLIC SUBROUTINES
1.191 harris41 14193:
1.243 albertel 14194: =head2 Session Environment Functions
1.191 harris41 14195:
1.243 albertel 14196: =over 4
1.191 harris41 14197:
1.394 bowersj2 14198: =item *
14199: X<appenv()>
1.949 raeburn 14200: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 14201: the user envirnoment file, and will be restored for each access this
1.620 albertel 14202: user makes during this session, also modifies the %env for the current
1.949 raeburn 14203: process. Optional rolesarrayref - if defined contains a reference to an array
14204: of roles which are exempt from the restriction on modifying user.role entries
14205: in the user's environment.db and in %env.
1.191 harris41 14206:
14207: =item *
1.394 bowersj2 14208: X<delenv()>
1.987 raeburn 14209: B<delenv($delthis,$regexp)>: removes all items from the session
14210: environment file that begin with $delthis. If the
14211: optional second arg - $regexp - is true, $delthis is treated as a
14212: regular expression, otherwise \Q$delthis\E is used.
14213: The values are also deleted from the current processes %env.
1.191 harris41 14214:
1.795 albertel 14215: =item * get_env_multiple($name)
14216:
14217: gets $name from the %env hash, it seemlessly handles the cases where multiple
14218: values may be defined and end up as an array ref.
14219:
14220: returns an array of values
14221:
1.243 albertel 14222: =back
14223:
14224: =head2 User Information
1.191 harris41 14225:
1.243 albertel 14226: =over 4
1.191 harris41 14227:
14228: =item *
1.394 bowersj2 14229: X<queryauthenticate()>
14230: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 14231: authentication scheme
14232:
14233: =item *
1.394 bowersj2 14234: X<authenticate()>
1.1073 raeburn 14235: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 14236: authenticate user from domain's lib servers (first use the current
14237: one). C<$upass> should be the users password.
1.1073 raeburn 14238: $checkdefauth is optional (value is 1 if a check should be made to
14239: authenticate user using default authentication method, and allow
14240: account creation if username does not have account in the domain).
14241: $clientcancheckhost is optional (value is 1 if checking whether the
14242: server can host will occur on the client side in lonauth.pm).
1.191 harris41 14243:
14244: =item *
1.394 bowersj2 14245: X<homeserver()>
14246: B<homeserver($uname,$udom)>: find the server which has
14247: the user's directory and files (there must be only one), this caches
14248: the answer, and also caches if there is a borken connection.
1.191 harris41 14249:
14250: =item *
1.394 bowersj2 14251: X<idget()>
1.1300 raeburn 14252: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
14253: a list of student/employee IDs or clicker IDs
14254: (student/employee IDs are a unique resource in a domain, there must be
14255: only 1 ID per username, and only 1 username per ID in a specific domain).
14256: clickerIDs are not necessarily unique, as students might share clickers.
14257: (returns hash: id=>name,id=>name)
1.191 harris41 14258:
14259: =item *
1.394 bowersj2 14260: X<idrget()>
14261: B<idrget($udom,@unames)>: find the IDs behind a list of
14262: usernames (returns hash: name=>id,name=>id)
1.191 harris41 14263:
14264: =item *
1.394 bowersj2 14265: X<idput()>
1.1300 raeburn 14266: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
14267: names and associated student/employee IDs or clicker IDs.
14268:
14269: =item *
14270: X<iddel()>
14271: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
14272: student/employee ID or clicker ID username look-ups from domain.
14273: The homeserver ($uhome) and namespace ($namespace) are optional.
14274: If no $uhome is provided, it will be determined usig &homeserver()
14275: for each user. If no $namespace is provided, the default is ids.
14276:
14277: =item *
14278: X<updateclickers()>
14279: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
14280: clicker ID-to-username look-ups in clickers.db on library server.
14281: Permitted actions are add or del (i.e., add or delete). The
14282: clickers.db contains clickerID as keys (escaped), and each corresponding
14283: value is an escaped comma-separated list of usernames (for whom the
14284: library server is the homeserver), who registered that particular ID.
14285: If $critical is true, the update will be sent via &critical, otherwise
14286: &reply() will be used.
1.191 harris41 14287:
14288: =item *
1.394 bowersj2 14289: X<rolesinit()>
1.1169 droeschl 14290: B<rolesinit($udom,$username)>: get user privileges.
14291: returns user role, first access and timer interval hashes
1.243 albertel 14292:
14293: =item *
1.1171 droeschl 14294: X<privileged()>
14295: B<privileged($username,$domain)>: returns a true if user has a
14296: privileged and active role (i.e. su or dc), false otherwise.
14297:
14298: =item *
1.551 albertel 14299: X<getsection()>
14300: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 14301: course $cname, return section name/number or '' for "not in course"
14302: and '-1' for "no section"
14303:
14304: =item *
1.394 bowersj2 14305: X<userenvironment()>
14306: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 14307: passed in @what from the requested user's environment, returns a hash
14308:
1.858 raeburn 14309: =item *
14310: X<userlog_query()>
1.859 albertel 14311: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
14312: activity.log file. %filters defines filters applied when parsing the
14313: log file. These can be start or end timestamps, or the type of action
14314: - log to look for Login or Logout events, check for Checkin or
14315: Checkout, role for role selection. The response is in the form
14316: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
14317: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 14318:
1.243 albertel 14319: =back
14320:
14321: =head2 User Roles
14322:
14323: =over 4
14324:
14325: =item *
14326:
1.1284 raeburn 14327: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
14328: returns codes for allowed actions.
14329:
14330: The first argument is required, all others are optional.
14331:
14332: $priv is the privilege being checked.
14333: $uri contains additional information about what is being checked for access (e.g.,
14334: URL, course ID etc.).
14335: $symb is the unique resource instance identifier in a course; if needed,
14336: but not provided, it will be retrieved via a call to &symbread().
14337: $role is the role for which a priv is being checked (only used if priv is evb).
14338: $clientip is the user's IP address (only used when checking for access to portfolio
14339: files).
14340: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
14341: prevents recursive calls to &allowed.
14342:
1.243 albertel 14343: F: full access
14344: U,I,K: authentication modes (cxx only)
14345: '': forbidden
14346: 1: user needs to choose course
14347: 2: browse allowed
1.766 albertel 14348: A: passphrase authentication needed
1.1284 raeburn 14349: B: access temporarily blocked because of a blocking event in a course.
1.243 albertel 14350:
14351: =item *
14352:
1.1192 raeburn 14353: constructaccess($url,$setpriv) : check for access to construction space URL
14354:
14355: See if the owner domain and name in the URL match those in the
14356: expected environment. If so, return three element list
14357: ($ownername,$ownerdomain,$ownerhome).
14358:
14359: Otherwise return the null string.
14360:
14361: If second argument 'setpriv' is true, it assigns the privileges,
14362: and returns the same three element list, unless the owner has
14363: blocked "ad hoc" Domain Coordinator access to the Author Space,
14364: in which case the null string is returned.
14365:
14366: =item *
14367:
1.1326 raeburn 14368: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
14369: define a custom role rolename set privileges in format of lonTabs/roles.tab
14370: for system, domain, and course level. $uname and $udom are optional (current
14371: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 14372:
14373: =item *
14374:
1.988 raeburn 14375: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
14376: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 14377: $type is Course (default) or Community.
1.988 raeburn 14378: If $forcedefault evaluates to true, text returned will be default
14379: text for $type. Otherwise, if this is a course, the text returned
14380: will be a custom name for the role (if defined in the course's
14381: environment). If no custom name is defined the default is returned.
14382:
1.832 raeburn 14383: =item *
14384:
1.1219 raeburn 14385: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 14386: All arguments are optional. Returns a hash of a roles, either for
14387: co-author/assistant author roles for a user's Construction Space
1.906 albertel 14388: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 14389: In the hash, keys are set to colon-separated $uname,$udom,$role, and
14390: (optionally) if $withsec is true, a fourth colon-separated item - $section.
14391: For each key, value is set to colon-separated start and end times for
14392: the role. If no username and domain are specified, will default to
1.934 raeburn 14393: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 14394: of role statuses (active, future or previous), roles
14395: (e.g., cc,in, st etc.) and domains of the roles which can be used
14396: to restrict the list of roles reported. If no array ref is
14397: provided for types, will default to return only active roles.
1.834 albertel 14398:
1.1195 raeburn 14399: =item *
14400:
14401: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 14402: user: $uname:$udom has a role in the course: $cdom_$cnum.
14403:
14404: Additional optional arguments are: $type (if role checking is to be restricted
14405: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 14406: available roles) or future (roles available in the future), and
14407: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 14408: have active Domain Coordinator role in course's domain or in additional
14409: domains (specified in 'Domains to check for privileged users' in course
14410: environment -- set via: Course Settings -> Classlists and staff listing).
14411:
14412: =item *
14413:
14414: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
14415: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
14416: $possdomains and $possroles are optional array refs -- to domains to check and
14417: roles to check. If $possdomains is not specified, a dump will be done of the
14418: users' roles.db to check for a dc or su role in any domain. This can be
14419: time consuming if &privileged is called repeatedly (e.g., when displaying a
14420: classlist), so in such cases, supplying a $possdomains array is preferred, as
14421: this then allows &privileged_by_domain() to be used, which caches the identity
14422: of privileged users, eliminating the need for repeated calls to &dump().
14423:
14424: =item *
14425:
14426: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
14427: where the outer hash keys are domains specified in the $possdomains array ref,
14428: next inner hash keys are privileged roles specified in the $roles array ref,
14429: and the innermost hash contains key = value pairs for username:domain = end:start
14430: for active or future "privileged" users with that role in that domain. To avoid
14431: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
14432: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 14433:
1.243 albertel 14434: =back
14435:
14436: =head2 User Modification
14437:
14438: =over 4
14439:
14440: =item *
14441:
1.957 raeburn 14442: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 14443: user for the level given by URL. Optional start and end dates (leave empty
14444: string or zero for "no date")
1.191 harris41 14445:
14446: =item *
14447:
1.243 albertel 14448: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
14449: change a users, password, possible return values are: ok,
14450: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
14451: refused
1.191 harris41 14452:
14453: =item *
14454:
1.243 albertel 14455: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 14456:
14457: =item *
14458:
1.1058 raeburn 14459: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
14460: $forceid,$desiredhome,$email,$inststatus,$candelete) :
14461:
14462: will update user information (firstname,middlename,lastname,generation,
14463: permanentemail), and if forceid is true, student/employee ID also.
14464: A user's institutional affiliation(s) can also be updated.
14465: User information fields will not be overwritten with empty entries
14466: unless the field is included in the $candelete array reference.
14467: This array is included when a single user is modified via "Manage Users",
14468: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 14469:
14470: =item *
14471:
1.286 matthew 14472: modifystudent
14473:
1.957 raeburn 14474: modify a student's enrollment and identification information.
1.1235 raeburn 14475: The course id is resolved based on the current user's environment.
14476: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 14477: associated with a course.
14478:
1.297 matthew 14479: This call is essentially a wrapper for lonnet::modifyuser and
14480: lonnet::modify_student_enrollment
1.286 matthew 14481:
14482: Inputs:
14483:
14484: =over 4
14485:
1.957 raeburn 14486: =item B<$udom> Student's loncapa domain
1.286 matthew 14487:
1.957 raeburn 14488: =item B<$uname> Student's loncapa login name
1.286 matthew 14489:
1.964 bisitz 14490: =item B<$uid> Student/Employee ID
1.286 matthew 14491:
1.957 raeburn 14492: =item B<$umode> Student's authentication mode
1.286 matthew 14493:
1.957 raeburn 14494: =item B<$upass> Student's password
1.286 matthew 14495:
1.957 raeburn 14496: =item B<$first> Student's first name
1.286 matthew 14497:
1.957 raeburn 14498: =item B<$middle> Student's middle name
1.286 matthew 14499:
1.957 raeburn 14500: =item B<$last> Student's last name
1.286 matthew 14501:
1.957 raeburn 14502: =item B<$gene> Student's generation
1.286 matthew 14503:
1.957 raeburn 14504: =item B<$usec> Student's section in course
1.286 matthew 14505:
14506: =item B<$end> Unix time of the roles expiration
14507:
14508: =item B<$start> Unix time of the roles start date
14509:
14510: =item B<$forceid> If defined, allow $uid to be changed
14511:
14512: =item B<$desiredhome> server to use as home server for student
14513:
1.957 raeburn 14514: =item B<$email> Student's permanent e-mail address
14515:
14516: =item B<$type> Type of enrollment (auto or manual)
14517:
1.963 raeburn 14518: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
14519:
14520: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 14521:
1.963 raeburn 14522: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 14523:
1.963 raeburn 14524: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 14525:
1.1216 raeburn 14526: =item B<$inststatus> institutional status of user - : separated string of escaped status types
14527:
14528: =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 14529:
1.286 matthew 14530: =back
1.297 matthew 14531:
14532: =item *
14533:
14534: modify_student_enrollment
14535:
1.1235 raeburn 14536: Change a student's enrollment status in a class. The environment variable
1.297 matthew 14537: 'role.request.course' must be defined for this function to proceed.
14538:
14539: Inputs:
14540:
14541: =over 4
14542:
1.1235 raeburn 14543: =item $udom, student's domain
1.297 matthew 14544:
1.1235 raeburn 14545: =item $uname, student's name
1.297 matthew 14546:
1.1235 raeburn 14547: =item $uid, student's user id
1.297 matthew 14548:
1.1235 raeburn 14549: =item $first, student's first name
1.297 matthew 14550:
14551: =item $middle
14552:
14553: =item $last
14554:
14555: =item $gene
14556:
14557: =item $usec
14558:
14559: =item $end
14560:
14561: =item $start
14562:
1.957 raeburn 14563: =item $type
14564:
14565: =item $locktype
14566:
14567: =item $cid
14568:
14569: =item $selfenroll
14570:
14571: =item $context
14572:
1.1216 raeburn 14573: =item $credits, number of credits student will earn from this class
14574:
1.1314 raeburn 14575: =item $instsec, institutional course section code for student
14576:
1.297 matthew 14577: =back
14578:
1.191 harris41 14579:
14580: =item *
14581:
1.243 albertel 14582: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
14583: custom role; give a custom role to a user for the level given by URL. Specify
14584: name and domain of role author, and role name
1.191 harris41 14585:
14586: =item *
14587:
1.243 albertel 14588: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 14589:
14590: =item *
14591:
1.243 albertel 14592: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
14593:
14594: =back
14595:
14596: =head2 Course Infomation
14597:
14598: =over 4
1.191 harris41 14599:
14600: =item *
14601:
1.1118 foxr 14602: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 14603: specified course id, including all environment settings for the
14604: course, the description of the course will be in the hash under the
14605: key 'description'
1.191 harris41 14606:
1.1118 foxr 14607: $options is an optional parameter that if supplied is a hash reference that controls
14608: what how this function works. It has the following key/values:
14609:
14610: =over 4
14611:
14612: =item freshen_cache
14613:
14614: If defined, and the environment cache for the course is valid, it is
14615: returned in the returned hash.
14616:
14617: =item one_time
14618:
14619: If defined, the last cache time is set to _now_
14620:
14621: =item user
14622:
14623: If defined, the supplied username is used instead of the current user.
14624:
14625:
14626: =back
14627:
1.191 harris41 14628: =item *
14629:
1.624 albertel 14630: resdata($name,$domain,$type,@which) : request for current parameter
14631: setting for a specific $type, where $type is either 'course' or 'user',
14632: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 14633: answers for 10 minutes.
1.243 albertel 14634:
1.877 foxr 14635: =item *
14636:
14637: get_courseresdata($courseid, $domain) : dump the entire course resource
14638: data base, returning a hash that is keyed by the resource name and has
14639: values that are the resource value. I believe that the timestamps and
14640: versions are also returned.
14641:
1.1236 raeburn 14642: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
14643: supplemental content area. This routine caches the number of files for
14644: 10 minutes.
14645:
1.243 albertel 14646: =back
14647:
14648: =head2 Course Modification
14649:
14650: =over 4
1.191 harris41 14651:
14652: =item *
14653:
1.243 albertel 14654: writecoursepref($courseid,%prefs) : write preferences (environment
14655: database) for a course
1.191 harris41 14656:
14657: =item *
14658:
1.1011 raeburn 14659: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
14660:
14661: =item *
14662:
1.1038 raeburn 14663: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 14664:
1.1167 droeschl 14665: =item *
14666:
14667: is_course($courseid), is_course($cdom, $cnum)
14668:
14669: Accepts either a combined $courseid (in the form of domain_courseid) or the
14670: two component version $cdom, $cnum. It checks if the specified course exists.
14671:
14672: Returns:
14673: undef if the course doesn't exist, otherwise
14674: in scalar context the combined courseid.
14675: in list context the two components of the course identifier, domain and
14676: courseid.
14677:
1.243 albertel 14678: =back
14679:
14680: =head2 Resource Subroutines
14681:
14682: =over 4
1.191 harris41 14683:
14684: =item *
14685:
1.243 albertel 14686: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 14687:
14688: =item *
14689:
1.243 albertel 14690: repcopy($filename) : subscribes to the requested file, and attempts to
14691: replicate from the owning library server, Might return
1.607 raeburn 14692: 'unavailable', 'not_found', 'forbidden', 'ok', or
14693: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 14694: resource. Expects the local filesystem pathname
14695: (/home/httpd/html/res/....)
14696:
14697: =back
14698:
14699: =head2 Resource Information
14700:
14701: =over 4
1.191 harris41 14702:
14703: =item *
14704:
1.1228 raeburn 14705: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
14706: and returns the value of a variety of different possible values,
14707: $varname should be a request string, and the other parameters can be
14708: used to specify who and what one is asking about. Ordinarily, $cid
14709: does not need to be specified, as it is retrived from
14710: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
14711: within lonuserstate::loadmap() when initializing a course, before
14712: $env{'request.course.id'} has been set, so it needs to be provided
14713: in that one case.
1.243 albertel 14714:
14715: Possible values for $varname are environment.lastname (or other item
14716: from the envirnment hash), user.name (or someother aspect about the
14717: user), resource.0.maxtries (or some other part and parameter of a
14718: resource)
1.204 albertel 14719:
14720: =item *
14721:
1.243 albertel 14722: directcondval($number) : get current value of a condition; reads from a state
14723: string
1.204 albertel 14724:
14725: =item *
14726:
1.243 albertel 14727: condval($condidx) : value of condition index based on state
1.204 albertel 14728:
14729: =item *
14730:
1.1362 ! raeburn 14731: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
1.243 albertel 14732: resource's metadata, $what should be either a specific key, or either
14733: 'keys' (to get a list of possible keys) or 'packages' to get a list of
1.1362 ! raeburn 14734: packages that this resource currently uses, the last 3 arguments are
! 14735: only used internally for recursive metadata.
! 14736:
! 14737: the toolsymb is only used where the uri is for an external tool (for which
! 14738: the uri as well as the symb are guaranteed to be unique).
1.243 albertel 14739:
14740: this function automatically caches all requests
1.191 harris41 14741:
14742: =item *
14743:
1.243 albertel 14744: metadata_query($query,$custom,$customshow) : make a metadata query against the
14745: network of library servers; returns file handle of where SQL and regex results
14746: will be stored for query
1.191 harris41 14747:
14748: =item *
14749:
1.1282 raeburn 14750: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
14751: return symbolic list entry (all arguments optional).
14752:
14753: Args: filename is the filename (including path) for the file for which a symb
14754: is required; donotrecurse, if true will prevent calls to allowed() being made
14755: to check access status if more than one resource was found in the bighash
14756: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
14757: a randompick); ignorecachednull, if true will prevent a symb of '' being
14758: returned if $env{$cache_str} is defined as ''; checkforblock if true will
14759: cause possible symbs to be checked to determine if they are subject to content
14760: blocking, if so they will not be included as possible symbs; possibles is a
14761: ref to a hash, which, as a side effect, will be populated with all possible
14762: symbs (content blocking not tested).
14763:
1.243 albertel 14764: returns the data handle
1.191 harris41 14765:
14766: =item *
14767:
1.1190 raeburn 14768: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
14769: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 14770: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 14771: on failure, user must be in a course, as it assumes the existence of
14772: the course initial hash, and uses $env('request.course.id'}. The third
14773: arg is an optional reference to a scalar. If this arg is passed in the
14774: call to symbverify, it will be set to 1 if the symb has been set to be
14775: encrypted; otherwise it will be null.
1.191 harris41 14776:
14777: =item *
14778:
1.243 albertel 14779: symbclean($symb) : removes versions numbers from a symb, returns the
14780: cleaned symb
1.191 harris41 14781:
14782: =item *
14783:
1.243 albertel 14784: is_on_map($uri) : checks if the $uri is somewhere on the current
14785: course map, user must be in a course for it to work.
1.191 harris41 14786:
14787: =item *
14788:
1.243 albertel 14789: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 14790:
14791: =item *
14792:
1.243 albertel 14793: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
14794: a random seed, all arguments are optional, if they aren't sent it uses the
14795: environment to derive them. Note: if symb isn't sent and it can't get one
14796: from &symbread it will use the current time as its return value
1.191 harris41 14797:
14798: =item *
14799:
1.243 albertel 14800: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
14801: unfakeable, receipt
1.191 harris41 14802:
14803: =item *
14804:
1.620 albertel 14805: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 14806:
14807: =item *
14808:
1.243 albertel 14809: countacc($url) : count the number of accesses to a given URL
1.191 harris41 14810:
14811: =item *
14812:
1.243 albertel 14813: 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 14814:
14815: =item *
14816:
1.243 albertel 14817: 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 14818:
14819: =item *
14820:
1.243 albertel 14821: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 14822:
14823: =item *
14824:
1.243 albertel 14825: devalidate($symb) : devalidate temporary spreadsheet calculations,
14826: forcing spreadsheet to reevaluate the resource scores next time.
14827:
1.1195 raeburn 14828: =item *
14829:
1.1196 raeburn 14830: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
14831: when viewing in course context.
1.1195 raeburn 14832:
1.1196 raeburn 14833: input: six args -- filename (decluttered), course number, course domain,
14834: url, symb (if registered) and group (if this is a
14835: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 14836:
1.1196 raeburn 14837: output: array of five scalars --
1.1195 raeburn 14838: $cfile -- url for file editing if editable on current server
14839: $home -- homeserver of resource (i.e., for author if published,
14840: or course if uploaded.).
14841: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 14842: $forceedit -- 1 if icon/link should be to go to edit mode
14843: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 14844:
14845: =item *
14846:
14847: is_course_upload($file,$cnum,$cdom)
14848:
14849: Used in course context to determine if current file was uploaded to
14850: the course (i.e., would be found in /userfiles/docs on the course's
14851: homeserver.
14852:
14853: input: 3 args -- filename (decluttered), course number and course domain.
14854: output: boolean -- 1 if file was uploaded.
14855:
1.243 albertel 14856: =back
14857:
14858: =head2 Storing/Retreiving Data
14859:
14860: =over 4
1.191 harris41 14861:
14862: =item *
14863:
1.1269 raeburn 14864: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
14865: permanently for this url; hashref needs to be given and should be a \%hashname;
14866: the remaining args aren't required and if they aren't passed or are '' they will
14867: be derived from the env (with the exception of $laststore, which is an
14868: optional arg used when a user's submission is stored in grading).
14869: $laststore is $version=$timestamp, where $version is the most recent version
14870: number retrieved for the corresponding $symb in the $namespace db file, and
14871: $timestamp is the timestamp for that transaction (UNIX time).
14872: $laststore is currently only passed when cstore() is called by
14873: structuretags::finalize_storage().
1.191 harris41 14874:
14875: =item *
14876:
1.1269 raeburn 14877: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
14878: but uses critical subroutine
1.191 harris41 14879:
14880: =item *
14881:
1.243 albertel 14882: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
14883: all args are optional
1.191 harris41 14884:
14885: =item *
14886:
1.717 albertel 14887: dumpstore($namespace,$udom,$uname,$regexp,$range) :
14888: dumps the complete (or key matching regexp) namespace into a hash
14889: ($udom, $uname, $regexp, $range are optional) for a namespace that is
14890: normally &store()ed into
14891:
14892: $range should be either an integer '100' (give me the first 100
14893: matching records)
14894: or be two integers sperated by a - with no spaces
14895: '30-50' (give me the 30th through the 50th matching
14896: records)
14897:
14898:
14899: =item *
14900:
1.1269 raeburn 14901: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 14902: replaces a &store() version of data with a replacement set of data
14903: for a particular resource in a namespace passed in the $storehash hash
1.1269 raeburn 14904: reference. If $tolog is true, the transaction is logged in the courselog
14905: with an action=PUTSTORE.
1.717 albertel 14906:
14907: =item *
14908:
1.243 albertel 14909: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
14910: works very similar to store/cstore, but all data is stored in a
14911: temporary location and can be reset using tmpreset, $storehash should
14912: be a hash reference, returns nothing on success
1.191 harris41 14913:
14914: =item *
14915:
1.243 albertel 14916: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
14917: similar to restore, but all data is stored in a temporary location and
14918: can be reset using tmpreset. Returns a hash of values on success,
14919: error string otherwise.
1.191 harris41 14920:
14921: =item *
14922:
1.243 albertel 14923: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
14924: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 14925:
14926: =item *
14927:
1.243 albertel 14928: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14929: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 14930:
14931: =item *
14932:
1.243 albertel 14933: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
14934: namesp ($udom and $uname are optional)
1.191 harris41 14935:
14936: =item *
14937:
1.702 albertel 14938: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 14939: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 14940: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 14941:
1.702 albertel 14942: $range should be either an integer '100' (give me the first 100
14943: matching records)
14944: or be two integers sperated by a - with no spaces
14945: '30-50' (give me the 30th through the 50th matching
14946: records)
1.449 matthew 14947: =item *
14948:
14949: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
14950: $store can be a scalar, an array reference, or if the amount to be
14951: incremented is > 1, a hash reference.
14952:
14953: ($udom and $uname are optional)
1.191 harris41 14954:
14955: =item *
14956:
1.243 albertel 14957: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
14958: ($udom and $uname are optional)
1.191 harris41 14959:
14960: =item *
14961:
1.243 albertel 14962: cput($namespace,$storehash,$udom,$uname) : critical put
14963: ($udom and $uname are optional)
1.191 harris41 14964:
14965: =item *
14966:
1.748 albertel 14967: newput($namespace,$storehash,$udom,$uname) :
14968:
14969: Attempts to store the items in the $storehash, but only if they don't
14970: currently exist, if this succeeds you can be certain that you have
14971: successfully created a new key value pair in the $namespace db.
14972:
14973:
14974: Args:
14975: $namespace: name of database to store values to
14976: $storehash: hashref to store to the db
14977: $udom: (optional) domain of user containing the db
14978: $uname: (optional) name of user caontaining the db
14979:
14980: Returns:
14981: 'ok' -> succeeded in storing all keys of $storehash
14982: 'key_exists: <key>' -> failed to anything out of $storehash, as at
14983: least <key> already existed in the db (other
14984: requested keys may also already exist)
1.967 bisitz 14985: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 14986: 'con_lost' -> unable to contact request server
14987: 'refused' -> action was not allowed by remote machine
14988:
14989:
14990: =item *
14991:
1.243 albertel 14992: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14993: reference filled in from namesp (encrypts the return communication)
14994: ($udom and $uname are optional)
1.191 harris41 14995:
14996: =item *
14997:
1.243 albertel 14998: log($udom,$name,$home,$message) : write to permanent log for user; use
14999: critical subroutine
15000:
1.806 raeburn 15001: =item *
15002:
1.860 raeburn 15003: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
15004: array reference filled in from namespace found in domain level on either
15005: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 15006:
15007: =item *
15008:
1.860 raeburn 15009: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
15010: domain level either on specified domain server ($uhome) or primary domain
15011: server ($udom and $uhome are optional)
1.806 raeburn 15012:
1.943 raeburn 15013: =item *
15014:
1.1240 raeburn 15015: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
15016: for: authentication, language, quotas, timezone, date locale, and portal URL in
15017: the target domain.
15018:
15019: May also include additional key => value pairs for the following groups:
15020:
15021: =over
15022:
15023: =item
15024: disk quotas (MB allocated by default to portfolios and authoring spaces).
15025:
15026: =over
15027:
15028: =item defaultquota, authorquota
15029:
15030: =back
15031:
15032: =item
15033: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
15034: portfolio for users).
15035:
15036: =over
15037:
15038: =item
15039: aboutme, blog, webdav, portfolio
15040:
15041: =back
15042:
15043: =item
15044: requestcourses: ability to request courses, and how requests are processed.
15045:
15046: =over
15047:
15048: =item
1.1305 raeburn 15049: official, unofficial, community, textbook, placement
1.1240 raeburn 15050:
15051: =back
15052:
15053: =item
15054: inststatus: types of institutional affiliation, and order in which they are displayed.
15055:
15056: =over
15057:
15058: =item
1.1256 raeburn 15059: inststatustypes, inststatusorder, inststatusguest
1.1240 raeburn 15060:
15061: =back
15062:
15063: =item
15064: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
15065: for course's uploaded content.
15066:
15067: =over
15068:
15069: =item
1.1246 raeburn 15070: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
1.1305 raeburn 15071: communityquota, textbookquota, placementquota
1.1240 raeburn 15072:
15073: =back
15074:
15075: =item
15076: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
15077: on your servers.
15078:
15079: =over
15080:
15081: =item
15082: remotesessions, hostedsessions
15083:
15084: =back
15085:
15086: =back
15087:
15088: In cases where a domain coordinator has never used the "Set Domain Configuration"
15089: utility to create a configuration.db file on a domain's primary library server
15090: only the following domain defaults: auth_def, auth_arg_def, lang_def
15091: -- corresponding values are authentication type (internal, krb4, krb5,
15092: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
15093: will be available. Values are retrieved from cache (if current), unless the
15094: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
15095: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
15096:
15097: Typical usage:
1.943 raeburn 15098:
1.1240 raeburn 15099: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 15100:
1.243 albertel 15101: =back
15102:
15103: =head2 Network Status Functions
15104:
15105: =over 4
1.191 harris41 15106:
15107: =item *
15108:
1.1137 raeburn 15109: dirlist() : return directory list based on URI (first arg).
15110:
15111: Inputs: 1 required, 5 optional.
15112:
15113: =over
15114:
15115: =item
15116: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
15117:
15118: =item
15119: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
15120:
15121: =item
15122: $username - username of user/course to be listed. Extracted from $uri if absent.
15123:
15124: =item
15125: $getpropath - boolean: 1 if prepend path using &propath().
15126:
15127: =item
15128: $getuserdir - boolean: 1 if prepend path for "userfiles".
15129:
15130: =item
15131: $alternateRoot - path to prepend in place of path from $uri.
15132:
15133: =back
15134:
15135: Returns: Array of up to two items.
15136:
15137: =over
15138:
15139: a reference to an array of files/subdirectories
15140:
15141: =over
15142:
15143: Each element in the array of files/subdirectories is a & separated list of
15144: item name and the result of running stat on the item. If dirlist was requested
15145: for a file instead of a directory, the item name will be ''. For a directory
15146: listing, if the item is a metadata file, the element will end &N&M
15147: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
15148: default copyright set (1).
15149:
15150: =back
15151:
15152: a scalar containing error condition (if encountered).
15153:
15154: =over
15155:
15156: =item
15157: no_host (no homeserver identified for $username:$domain).
15158:
15159: =item
15160: no_such_host (server contacted for listing not identified as valid host).
15161:
15162: =item
15163: con_lost (connection to remote server failed).
15164:
15165: =item
15166: refused (invalid $username:$domain received on lond side).
15167:
15168: =item
15169: no_such_dir (directory at specified path on lond side does not exist).
15170:
15171: =item
15172: empty (directory at specified path on lond side is empty).
15173:
15174: =over
15175:
15176: This is currently not encountered because the &ls3, &ls2,
15177: &ls (_handler) routines on the lond side do not filter out
15178: . and .. from a directory listing.
15179:
15180: =back
15181:
15182: =back
15183:
15184: =back
1.191 harris41 15185:
15186: =item *
15187:
1.243 albertel 15188: spareserver() : find server with least workload from spare.tab
15189:
1.986 foxr 15190:
15191: =item *
15192:
15193: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
15194: if there is no corresponding loncapa host.
15195:
1.243 albertel 15196: =back
15197:
1.986 foxr 15198:
1.243 albertel 15199: =head2 Apache Request
15200:
15201: =over 4
1.191 harris41 15202:
15203: =item *
15204:
1.243 albertel 15205: ssi($url,%hash) : server side include, does a complete request cycle on url to
15206: localhost, posts hash
15207:
15208: =back
15209:
15210: =head2 Data to String to Data
15211:
15212: =over 4
1.191 harris41 15213:
15214: =item *
15215:
1.243 albertel 15216: hash2str(%hash) : convert a hash into a string complete with escaping and '='
15217: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 15218:
15219: =item *
15220:
1.243 albertel 15221: hashref2str($hashref) : convert a hashref into a string complete with
15222: escaping and '=' and '&' separators, supports elements that are
15223: arrayrefs and hashrefs
1.191 harris41 15224:
15225: =item *
15226:
1.243 albertel 15227: arrayref2str($arrayref) : convert an arrayref into a string complete
15228: with escaping and '&' separators, supports elements that are arrayrefs
15229: and hashrefs
1.191 harris41 15230:
15231: =item *
15232:
1.243 albertel 15233: str2hash($string) : convert string to hash using unescaping and
15234: splitting on '=' and '&', supports elements that are arrayrefs and
15235: hashrefs
1.191 harris41 15236:
15237: =item *
15238:
1.243 albertel 15239: str2array($string) : convert string to hash using unescaping and
15240: splitting on '&', supports elements that are arrayrefs and hashrefs
15241:
15242: =back
15243:
15244: =head2 Logging Routines
15245:
15246:
15247: These routines allow one to make log messages in the lonnet.log and
15248: lonnet.perm logfiles.
1.191 harris41 15249:
1.1119 foxr 15250: =over 4
15251:
1.191 harris41 15252: =item *
15253:
1.243 albertel 15254: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 15255:
15256: =item *
15257:
1.243 albertel 15258: logthis() : append message to the normal lonnet.log file, it gets
15259: preiodically rolled over and deleted.
1.191 harris41 15260:
15261: =item *
15262:
1.243 albertel 15263: logperm() : append a permanent message to lonnet.perm.log, this log
15264: file never gets deleted by any automated portion of the system, only
15265: messages of critical importance should go in here.
15266:
1.1119 foxr 15267:
1.243 albertel 15268: =back
15269:
15270: =head2 General File Helper Routines
15271:
15272: =over 4
1.191 harris41 15273:
15274: =item *
15275:
1.481 raeburn 15276: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
15277: (a) files in /uploaded
15278: (i) If a local copy of the file exists -
15279: compares modification date of local copy with last-modified date for
15280: definitive version stored on home server for course. If local copy is
15281: stale, requests a new version from the home server and stores it.
15282: If the original has been removed from the home server, then local copy
15283: is unlinked.
15284: (ii) If local copy does not exist -
15285: requests the file from the home server and stores it.
15286:
15287: If $caller is 'uploadrep':
15288: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
15289: for request for files originally uploaded via DOCS.
15290: - returns 'ok' if fresh local copy now available, -1 otherwise.
15291:
15292: Otherwise:
15293: This indicates a call from the content generation phase of the request.
15294: - returns the entire contents of the file or -1.
15295:
15296: (b) files in /res
15297: - returns the entire contents of a file or -1;
15298: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 15299:
1.712 albertel 15300:
15301: =item *
15302:
15303: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
15304: reference
15305:
15306: returns either a stat() list of data about the file or an empty list
15307: if the file doesn't exist or couldn't find out about it (connection
15308: problems or user unknown)
15309:
1.191 harris41 15310: =item *
15311:
1.243 albertel 15312: filelocation($dir,$file) : returns file system location of a file
15313: based on URI; meant to be "fairly clean" absolute reference, $dir is a
15314: directory that relative $file lookups are to looked in ($dir of /a/dir
15315: and a file of ../bob will become /a/bob)
1.191 harris41 15316:
15317: =item *
15318:
15319: hreflocation($dir,$file) : returns file system location or a URL; same as
15320: filelocation except for hrefs
15321:
15322: =item *
15323:
1.1261 raeburn 15324: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
15325: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 15326:
1.243 albertel 15327: =back
15328:
1.608 albertel 15329: =head2 Usererfile file routines (/uploaded*)
15330:
15331: =over 4
15332:
15333: =item *
15334:
15335: userfileupload(): main rotine for putting a file in a user or course's
15336: filespace, arguments are,
15337:
1.620 albertel 15338: formname - required - this is the name of the element in $env where the
1.608 albertel 15339: filename, and the contents of the file to create/modifed exist
1.620 albertel 15340: the filename is in $env{'form.'.$formname.'.filename'} and the
15341: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 15342: context - if coursedoc, store the file in the course of the active role
15343: of the current user;
15344: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
15345: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 15346: subdir - required - subdirectory to put the file in under ../userfiles/
15347: if undefined, it will be placed in "unknown"
15348:
15349: (This routine calls clean_filename() to remove any dangerous
15350: characters from the filename, and then calls finuserfileupload() to
15351: complete the transaction)
15352:
15353: returns either the url of the uploaded file (/uploaded/....) if successful
15354: and /adm/notfound.html if unsuccessful
15355:
15356: =item *
15357:
15358: clean_filename(): routine for cleaing a filename up for storage in
15359: userfile space, argument is:
15360:
15361: filename - proposed filename
15362:
15363: returns: the new clean filename
15364:
15365: =item *
15366:
1.1090 raeburn 15367: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 15368: userspace, probably shouldn't be called directly
15369:
15370: docuname: username or courseid of destination for the file
15371: docudom: domain of user/course of destination for the file
15372: formname: same as for userfileupload()
1.1090 raeburn 15373: fname: filename (including subdirectories) for the file
15374: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
15375: allfiles: reference to hash used to store objects found by parser
15376: codebase: reference to hash used for codebases of java objects found by parser
15377: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
15378: thumbheight: height (pixels) of thumbnail to be created for uploaded image
15379: resizewidth: width to be used to resize image using resizeImage from ImageMagick
15380: resizeheight: height to be used to resize image using resizeImage from ImageMagick
15381: context: if 'overwrite', will move the uploaded file from its temporary location to
15382: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 15383: mimetype: reference to scalar to accommodate mime type determined
15384: from File::MMagic if $parser = parse.
1.608 albertel 15385:
15386: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 15387: and /adm/notfound.html if unsuccessful (or an error message if context
15388: was 'overwrite').
15389:
1.608 albertel 15390:
15391: =item *
15392:
15393: renameuserfile(): renames an existing userfile to a new name
15394:
15395: Args:
15396: docuname: username or courseid of destination for the file
15397: docudom: domain of user/course of destination for the file
15398: old: current file name (including any subdirs under userfiles)
15399: new: desired file name (including any subdirs under userfiles)
15400:
15401: =item *
15402:
15403: mkdiruserfile(): creates a directory is a userfiles dir
15404:
15405: Args:
15406: docuname: username or courseid of destination for the file
15407: docudom: domain of user/course of destination for the file
15408: dir: dir to create (including any subdirs under userfiles)
15409:
15410: =item *
15411:
15412: removeuserfile(): removes a file that exists in userfiles
15413:
15414: Args:
15415: docuname: username or courseid of destination for the file
15416: docudom: domain of user/course of destination for the file
15417: fname: filname to delete (including any subdirs under userfiles)
15418:
15419: =item *
15420:
15421: removeuploadedurl(): convience function for removeuserfile()
15422:
15423: Args:
15424: url: a full /uploaded/... url to delete
15425:
1.747 albertel 15426: =item *
15427:
15428: get_portfile_permissions():
15429: Args:
15430: domain: domain of user or course contain the portfolio files
15431: user: name of user or num of course contain the portfolio files
15432: Returns:
15433: hashref of a dump of the proper file_permissions.db
15434:
15435:
15436: =item *
15437:
15438: get_access_controls():
15439:
15440: Args:
15441: current_permissions: the hash ref returned from get_portfile_permissions()
15442: group: (optional) the group you want the files associated with
15443: file: (optional) the file you want access info on
15444:
15445: Returns:
1.749 raeburn 15446: a hash (keys are file names) of hashes containing
15447: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
15448: values are XML containing access control settings (see below)
1.747 albertel 15449:
15450: Internal notes:
15451:
1.749 raeburn 15452: access controls are stored in file_permissions.db as key=value pairs.
15453: key -> path to file/file_name\0uniqueID:scope_end_start
15454: where scope -> public,guest,course,group,domains or users.
15455: end -> UNIX time for end of access (0 -> no end date)
15456: start -> UNIX time for start of access
15457:
15458: value -> XML description of access control
15459: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
15460: <start></start>
15461: <end></end>
15462:
15463: <password></password> for scope type = guest
15464:
15465: <domain></domain> for scope type = course or group
15466: <number></number>
15467: <roles id="">
15468: <role></role>
15469: <access></access>
15470: <section></section>
15471: <group></group>
15472: </roles>
15473:
15474: <dom></dom> for scope type = domains
15475:
15476: <users> for scope type = users
15477: <user>
15478: <uname></uname>
15479: <udom></udom>
15480: </user>
15481: </users>
15482: </scope>
15483:
15484: Access data is also aggregated for each file in an additional key=value pair:
15485: key -> path to file/file_name\0accesscontrol
15486: value -> reference to hash
15487: hash contains key = value pairs
15488: where key = uniqueID:scope_end_start
15489: value = UNIX time record was last updated
15490:
15491: Used to improve speed of look-ups of access controls for each file.
15492:
15493: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
15494:
1.1198 raeburn 15495: =item *
15496:
1.749 raeburn 15497: modify_access_controls():
15498:
15499: Modifies access controls for a portfolio file
15500: Args
15501: 1. file name
15502: 2. reference to hash of required changes,
15503: 3. domain
15504: 4. username
15505: where domain,username are the domain of the portfolio owner
15506: (either a user or a course)
15507:
15508: Returns:
15509: 1. result of additions or updates ('ok' or 'error', with error message).
15510: 2. result of deletions ('ok' or 'error', with error message).
15511: 3. reference to hash of any new or updated access controls.
15512: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
15513: key = integer (inbound ID)
1.1198 raeburn 15514: value = uniqueID
15515:
15516: =item *
15517:
15518: get_timebased_id():
15519:
15520: Attempts to get a unique timestamp-based suffix for use with items added to a
15521: course via the Course Editor (e.g., folders, composite pages,
15522: group bulletin boards).
15523:
15524: Args: (first three required; six others optional)
15525:
15526: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
15527: docssequence, or name of group
15528:
15529: 2. keyid (alphanumeric): name of temporary locking key in hash,
15530: e.g., num, boardids
15531:
15532: 3. namespace: name of gdbm file used to store suffixes already assigned;
15533: file will be named nohist_namespace.db
15534:
15535: 4. cdom: domain of course; default is current course domain from %env
15536:
15537: 5. cnum: course number; default is current course number from %env
15538:
15539: 6. idtype: set to concat if an additional digit is to be appended to the
15540: unix timestamp to form the suffix, if the plain timestamp is already
15541: in use. Default is to not do this, but simply increment the unix
15542: timestamp by 1 until a unique key is obtained.
15543:
15544: 7. who: holder of locking key; defaults to user:domain for user.
15545:
15546: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
15547: retrying); default is 3.
15548:
15549: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
15550:
15551: Returns:
15552:
15553: 1. suffix obtained (numeric)
15554:
15555: 2. result of deleting locking key (ok if deleted, or lock never obtained)
15556:
15557: 3. error: contains (localized) error message if an error occurred.
15558:
1.747 albertel 15559:
1.608 albertel 15560: =back
15561:
1.243 albertel 15562: =head2 HTTP Helper Routines
15563:
15564: =over 4
15565:
1.191 harris41 15566: =item *
15567:
15568: escape() : unpack non-word characters into CGI-compatible hex codes
15569:
15570: =item *
15571:
15572: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
15573:
1.243 albertel 15574: =back
15575:
15576: =head1 PRIVATE SUBROUTINES
15577:
15578: =head2 Underlying communication routines (Shouldn't call)
15579:
15580: =over 4
15581:
15582: =item *
15583:
15584: subreply() : tries to pass a message to lonc, returns con_lost if incapable
15585:
15586: =item *
15587:
15588: reply() : uses subreply to send a message to remote machine, logs all failures
15589:
15590: =item *
15591:
15592: critical() : passes a critical message to another server; if cannot
15593: get through then place message in connection buffer directory and
15594: returns con_delayed, if incapable of saving message, returns
15595: con_failed
15596:
15597: =item *
15598:
15599: reconlonc() : tries to reconnect lonc client processes.
15600:
15601: =back
15602:
15603: =head2 Resource Access Logging
15604:
15605: =over 4
15606:
15607: =item *
15608:
15609: flushcourselogs() : flush (save) buffer logs and access logs
15610:
15611: =item *
15612:
15613: courselog($what) : save message for course in hash
15614:
15615: =item *
15616:
15617: courseacclog($what) : save message for course using &courselog(). Perform
15618: special processing for specific resource types (problems, exams, quizzes, etc).
15619:
1.191 harris41 15620: =item *
15621:
15622: goodbye() : flush course logs and log shutting down; it is called in srm.conf
15623: as a PerlChildExitHandler
1.243 albertel 15624:
15625: =back
15626:
15627: =head2 Other
15628:
15629: =over 4
15630:
15631: =item *
15632:
15633: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 15634:
15635: =back
15636:
15637: =cut
1.877 foxr 15638:
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