Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1526
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1526 ! raeburn 4: # $Id: lonnet.pm,v 1.1525 2024/04/14 17:12:29 raeburn Exp $
1.178 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.169 harris41 28: ###
29:
1.971 jms 30: =pod
31:
1.972 jms 32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
1.971 jms 51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
1.1 albertel 71: package Apache::lonnet;
72:
73: use strict;
1.486 www 74: use HTTP::Date;
1.977 amueller 75: use Image::Magick;
1.1389 raeburn 76: use CGI::Cookie;
1.1182 foxr 77:
1.1173 foxr 78: use Encode;
79:
1.1405 raeburn 80: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir $deftex
1.1138 raeburn 81: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
1.1416 raeburn 82: %managerstab $passwdmin);
1.871 albertel 83:
84: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
85: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
86: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 87: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 88:
1.1 albertel 89: use IO::Socket;
1.31 www 90: use GDBM_File;
1.208 albertel 91: use HTML::LCParser;
1.88 www 92: use Fcntl qw(:flock);
1.870 albertel 93: use Storable qw(thaw nfreeze);
1.1289 damieng 94: use Time::HiRes qw( sleep gettimeofday tv_interval );
1.599 albertel 95: use Cache::Memcached;
1.676 albertel 96: use Digest::MD5;
1.790 albertel 97: use Math::Random;
1.1024 raeburn 98: use File::MMagic;
1.1434 raeburn 99: use Net::CIDR;
1.1456 raeburn 100: use Sys::Hostname::FQDN();
1.807 albertel 101: use LONCAPA qw(:DEFAULT :match);
1.740 www 102: use LONCAPA::Configuration;
1.1160 www 103: use LONCAPA::lonmetadata;
1.1167 droeschl 104: use LONCAPA::Lond;
1.1345 raeburn 105: use LONCAPA::LWPReq;
1.1406 raeburn 106: use LONCAPA::transliterate;
1.1117 foxr 107:
1.1090 raeburn 108: use File::Copy;
1.676 albertel 109:
1.195 www 110: my $readit;
1.1288 damieng 111: my $max_connection_retries = 20; # Or some such value.
1.1 albertel 112:
1.619 albertel 113: require Exporter;
114:
115: our @ISA = qw (Exporter);
116: our @EXPORT = qw(%env);
117:
1.449 matthew 118:
1.1187 raeburn 119: # ------------------------------------ Logging (parameters, docs, slots, roles)
1.729 www 120: {
121: my $logid;
1.1187 raeburn 122: sub write_log {
1.1188 raeburn 123: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
1.1184 raeburn 124: if ($context eq 'course') {
125: if (($cnum eq '') || ($cdom eq '')) {
126: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
127: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
128: }
1.957 raeburn 129: }
1.1184 raeburn 130: $logid ++;
1.957 raeburn 131: my $now = time();
132: my $id=$now.'00000'.$$.'00000'.$logid;
1.1434 raeburn 133: my $ip = &get_requestor_ip();
1.1184 raeburn 134: my $logentry = {
135: $id => {
136: 'exe_uname' => $env{'user.name'},
137: 'exe_udom' => $env{'user.domain'},
138: 'exe_time' => $now,
1.1434 raeburn 139: 'exe_ip' => $ip,
1.1184 raeburn 140: 'delflag' => $delflag,
141: 'logentry' => $storehash,
142: 'uname' => $uname,
143: 'udom' => $udom,
144: }
145: };
146: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
1.729 www 147: }
148: }
1.1 albertel 149:
1.163 harris41 150: sub logtouch {
151: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 152: unless (-e "$execdir/logs/lonnet.log") {
1.1359 raeburn 153: open(my $fh,">>","$execdir/logs/lonnet.log");
1.163 harris41 154: close $fh;
155: }
156: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
157: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
158: }
159:
1.1 albertel 160: sub logthis {
161: my $message=shift;
162: my $execdir=$perlvar{'lonDaemons'};
163: my $now=time;
164: my $local=localtime($now);
1.1359 raeburn 165: if (open(my $fh,">>","$execdir/logs/lonnet.log")) {
1.986 foxr 166: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
167: print $fh $logstring;
1.448 albertel 168: close($fh);
169: }
1.1 albertel 170: return 1;
171: }
172:
173: sub logperm {
174: my $message=shift;
175: my $execdir=$perlvar{'lonDaemons'};
176: my $now=time;
177: my $local=localtime($now);
1.1359 raeburn 178: if (open(my $fh,">>","$execdir/logs/lonnet.perm.log")) {
1.448 albertel 179: print $fh "$now:$message:$local\n";
180: close($fh);
181: }
1.1 albertel 182: return 1;
183: }
184:
1.850 albertel 185: sub create_connection {
1.853 albertel 186: my ($hostname,$lonid) = @_;
1.851 albertel 187: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 188: Type => SOCK_STREAM,
189: Timeout => 10);
190: return 0 if (!$client);
1.1399 raeburn 191: print $client (join(':',$hostname,$lonid,&machine_ids($hostname),$loncaparevs{$lonid})."\n");
1.850 albertel 192: my $result = <$client>;
193: chomp($result);
194: return 1 if ($result eq 'done');
195: return 0;
196: }
197:
1.983 raeburn 198: sub get_server_timezone {
199: my ($cnum,$cdom) = @_;
200: my $home=&homeserver($cnum,$cdom);
201: if ($home ne 'no_host') {
202: my $cachetime = 24*3600;
203: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
204: if (defined($cached)) {
205: return $timezone;
206: } else {
207: my $timezone = &reply('servertimezone',$home);
208: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
209: }
210: }
211: }
1.850 albertel 212:
1.1106 raeburn 213: sub get_server_distarch {
214: my ($lonhost,$ignore_cache) = @_;
215: if (defined($lonhost)) {
216: if (!defined(&hostname($lonhost))) {
217: return;
218: }
219: my $cachetime = 12*3600;
220: if (!$ignore_cache) {
221: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
222: if (defined($cached)) {
223: return $distarch;
224: }
225: }
226: my $rep = &reply('serverdistarch',$lonhost);
227: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
228: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
229: $rep eq '') {
230: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
231: }
232: }
233: return;
234: }
235:
1.1315 raeburn 236: sub get_servercerts_info {
1.1383 raeburn 237: my ($lonhost,$hostname,$context) = @_;
238: return if ($lonhost eq '');
239: if ($hostname eq '') {
240: $hostname = &hostname($lonhost);
241: }
242: return if ($hostname eq '');
1.1315 raeburn 243: my ($rep,$uselocal);
1.1388 raeburn 244: if ($context eq 'install') {
1.1387 raeburn 245: $uselocal = 1;
246: } elsif (grep { $_ eq $lonhost } ¤t_machine_ids()) {
1.1315 raeburn 247: $uselocal = 1;
248: }
1.1387 raeburn 249: if (($context ne 'cgi') && ($context ne 'install') && ($uselocal)) {
1.1315 raeburn 250: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
1.1323 raeburn 251: if ($distro eq '') {
252: $uselocal = 0;
253: } elsif ($distro =~ /^(?:centos|redhat|scientific)(\d+)$/) {
1.1315 raeburn 254: if ($1 < 6) {
255: $uselocal = 0;
256: }
1.1346 raeburn 257: } elsif ($distro =~ /^(?:sles)(\d+)$/) {
258: if ($1 < 12) {
259: $uselocal = 0;
260: }
1.1315 raeburn 261: }
262: }
263: if ($uselocal) {
1.1383 raeburn 264: $rep = LONCAPA::Lond::server_certs(\%perlvar,$lonhost,$hostname);
1.1315 raeburn 265: } else {
266: $rep=&reply('servercerts',$lonhost);
267: }
268: my ($result,%returnhash);
269: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
270: ($rep eq 'unknown_cmd')) {
271: $result = $rep;
272: } else {
273: $result = 'ok';
274: my @pairs=split(/\&/,$rep);
275: foreach my $item (@pairs) {
276: my ($key,$value)=split(/=/,$item,2);
277: my $what = &unescape($key);
278: $returnhash{$what}=&thaw_unescape($value);
279: }
280: }
281: return ($result,\%returnhash);
282: }
283:
1.993 raeburn 284: sub get_server_loncaparev {
1.1073 raeburn 285: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
1.993 raeburn 286: if (defined($lonhost)) {
287: if (!defined(&hostname($lonhost))) {
288: undef($lonhost);
289: }
290: }
291: if (!defined($lonhost)) {
292: if (defined(&domain($dom,'primary'))) {
293: $lonhost=&domain($dom,'primary');
294: if ($lonhost eq 'no_host') {
295: undef($lonhost);
296: }
297: }
298: }
299: if (defined($lonhost)) {
1.1073 raeburn 300: my $cachetime = 12*3600;
301: if (!$ignore_cache) {
302: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
303: if (defined($cached)) {
304: return $loncaparev;
305: }
306: }
307: my ($answer,$loncaparev);
308: my @ids=¤t_machine_ids();
309: if (grep(/^\Q$lonhost\E$/,@ids)) {
310: $answer = $perlvar{'lonVersion'};
1.1081 raeburn 311: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 312: $loncaparev = $1;
313: }
314: } else {
315: $answer = &reply('serverloncaparev',$lonhost);
316: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
317: if ($caller eq 'loncron') {
1.1397 raeburn 318: my $hostname = &hostname($lonhost);
1.1073 raeburn 319: my $protocol = $protocol{$lonhost};
320: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 321: my $url = $protocol.'://'.$hostname.'/adm/about.html';
1.1073 raeburn 322: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 323: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,4,1);
1.1073 raeburn 324: unless ($response->is_error()) {
325: my $content = $response->content;
1.1081 raeburn 326: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
1.1073 raeburn 327: $loncaparev = $1;
328: }
329: }
330: } else {
331: $loncaparev = $loncaparevs{$lonhost};
332: }
1.1081 raeburn 333: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 334: $loncaparev = $1;
335: }
1.993 raeburn 336: }
1.1073 raeburn 337: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
1.993 raeburn 338: }
339: }
340:
1.1074 raeburn 341: sub get_server_homeID {
342: my ($hostname,$ignore_cache,$caller) = @_;
343: unless ($ignore_cache) {
344: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
345: if (defined($cached)) {
346: return $serverhomeID;
347: }
348: }
349: my $cachetime = 12*3600;
350: my $serverhomeID;
351: if ($caller eq 'loncron') {
352: my @machine_ids = &machine_ids($hostname);
353: foreach my $id (@machine_ids) {
354: my $response = &reply('serverhomeID',$id);
355: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
356: $serverhomeID = $response;
357: last;
358: }
359: }
360: if ($serverhomeID eq '') {
361: $serverhomeID = $machine_ids[-1];
362: }
363: } else {
364: $serverhomeID = $serverhomeIDs{$hostname};
365: }
366: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
367: }
368:
1.1121 raeburn 369: sub get_remote_globals {
370: my ($lonhost,$whathash,$ignore_cache) = @_;
1.1125 raeburn 371: my ($result,%returnhash,%whatneeded);
372: if (ref($whathash) eq 'HASH') {
1.1121 raeburn 373: foreach my $what (sort(keys(%{$whathash}))) {
374: my $hashid = $lonhost.'-'.$what;
1.1125 raeburn 375: my ($response,$cached);
1.1121 raeburn 376: unless ($ignore_cache) {
1.1125 raeburn 377: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
1.1121 raeburn 378: }
379: if (defined($cached)) {
1.1125 raeburn 380: $returnhash{$what} = $response;
1.1121 raeburn 381: } else {
1.1125 raeburn 382: $whatneeded{$what} = 1;
1.1121 raeburn 383: }
384: }
1.1125 raeburn 385: if (keys(%whatneeded) == 0) {
386: $result = 'ok';
387: } else {
1.1121 raeburn 388: my $requested = &freeze_escape(\%whatneeded);
389: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
1.1125 raeburn 390: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
391: ($rep eq 'unknown_cmd')) {
392: $result = $rep;
393: } else {
394: $result = 'ok';
1.1121 raeburn 395: my @pairs=split(/\&/,$rep);
1.1125 raeburn 396: foreach my $item (@pairs) {
397: my ($key,$value)=split(/=/,$item,2);
398: my $what = &unescape($key);
399: my $hashid = $lonhost.'-'.$what;
400: $returnhash{$what}=&thaw_unescape($value);
401: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
1.1121 raeburn 402: }
403: }
404: }
405: }
1.1125 raeburn 406: return ($result,\%returnhash);
1.1121 raeburn 407: }
408:
1.1124 raeburn 409: sub remote_devalidate_cache {
1.1241 raeburn 410: my ($lonhost,$cachekeys) = @_;
411: my $items;
412: return unless (ref($cachekeys) eq 'ARRAY');
413: my $cachestr = join('&',@{$cachekeys});
414: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
1.1124 raeburn 415: return $response;
416: }
417:
1.1510 raeburn 418: sub sign_lti {
1.1511 raeburn 419: my ($cdom,$cnum,$crsdef,$type,$context,$url,$ltinum,$keynum,$paramsref,$inforef) = @_;
1.1510 raeburn 420: my $chome;
421: if (&domain($cdom) ne '') {
1.1511 raeburn 422: if ($crsdef) {
1.1510 raeburn 423: $chome = &homeserver($cnum,$cdom);
424: } else {
425: $chome = &domain($cdom,'primary');
426: }
427: }
428: if ($cdom && $chome && ($chome ne 'no_host')) {
429: if ((ref($paramsref) eq 'HASH') &&
430: (ref($inforef) eq 'HASH')) {
431: my $rep;
432: if (grep { $_ eq $chome } ¤t_machine_ids()) {
433: # domain information is hosted on this machine
434: $rep =
1.1511 raeburn 435: &LONCAPA::Lond::sign_lti_payload($cdom,$cnum,$crsdef,$type,
436: $context,$url,$ltinum,$keynum,
437: $perlvar{'lonVersion'},
438: $paramsref,$inforef);
439: if (ref($rep) eq 'HASH') {
1.1510 raeburn 440: return ('ok',$rep);
441: }
442: } else {
443: my ($escurl,$params,$info);
444: $escurl = &escape($url);
445: if (ref($paramsref) eq 'HASH') {
446: $params = &freeze_escape($paramsref);
447: }
448: if (ref($inforef) eq 'HASH') {
449: $info = &freeze_escape($inforef);
450: }
1.1511 raeburn 451: $rep=&reply("encrypt:signlti:$cdom:$cnum:$crsdef:$type:$context:$escurl:$ltinum:$keynum:$params:$info",$chome);
1.1510 raeburn 452: }
453: if (($rep eq '') || ($rep =~ /^con_lost|error|no_such_host|unknown_cmd/i)) {
454: return ();
1.1511 raeburn 455: } elsif (($inforef->{'respfmt'} eq 'to_post_body') ||
456: ($inforef->{'respfmt'} eq 'to_authorization_header')) {
457: return ('ok',$rep);
1.1510 raeburn 458: } else {
459: my %returnhash;
460: foreach my $item (split(/\&/,$rep)) {
461: my ($name,$value)=split(/\=/,$item);
462: $returnhash{&unescape($name)}=&thaw_unescape($value);
463: }
464: return('ok',\%returnhash);
465: }
466: } else {
467: return ();
468: }
469: } else {
470: return ();
471: &logthis("sign_lti failed - no homeserver and/or domain ($cdom) ($chome)");
472: }
473: }
474:
1.1 albertel 475: # -------------------------------------------------- Non-critical communication
476: sub subreply {
477: my ($cmd,$server)=@_;
1.838 albertel 478: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 479: #
480: # With loncnew process trimming, there's a timing hole between lonc server
481: # process exit and the master server picking up the listen on the AF_UNIX
482: # socket. In that time interval, a lock file will exist:
483:
484: my $lockfile=$peerfile.".lock";
485: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
1.1289 damieng 486: sleep(0.1);
1.549 foxr 487: }
488: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 489: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 490: #
1.550 foxr 491: # We'll give the connection a few tries before abandoning it. If
492: # connection is not possible, we'll con_lost back to the client.
493: #
494: my $client;
495: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
496: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
497: Type => SOCK_STREAM,
498: Timeout => 10);
1.869 albertel 499: if ($client) {
1.550 foxr 500: last; # Connected!
1.850 albertel 501: } else {
1.853 albertel 502: &create_connection(&hostname($server),$server);
1.550 foxr 503: }
1.1289 damieng 504: sleep(0.1); # Try again later if failed connection.
1.550 foxr 505: }
506: my $answer;
507: if ($client) {
1.704 albertel 508: print $client "sethost:$server:$cmd\n";
1.550 foxr 509: $answer=<$client>;
510: if (!$answer) { $answer="con_lost"; }
511: chomp($answer);
512: } else {
513: $answer = 'con_lost'; # Failed connection.
514: }
1.1 albertel 515: return $answer;
516: }
517:
518: sub reply {
519: my ($cmd,$server)=@_;
1.838 albertel 520: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 521: my $answer=subreply($cmd,$server);
1.65 www 522: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.1396 raeburn 523: my $logged = $cmd;
524: if ($cmd =~ /^encrypt:([^:]+):/) {
525: my $subcmd = $1;
526: if (($subcmd eq 'auth') || ($subcmd eq 'passwd') ||
527: ($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
1.1462 raeburn 528: ($subcmd eq 'putdom') || ($subcmd eq 'autoexportgrades') ||
529: ($subcmd eq 'put')) {
1.1396 raeburn 530: (undef,undef,my @rest) = split(/:/,$cmd);
531: if (($subcmd eq 'auth') || ($subcmd eq 'putdom')) {
532: splice(@rest,2,1,'Hidden');
533: } elsif ($subcmd eq 'passwd') {
534: splice(@rest,2,2,('Hidden','Hidden'));
535: } elsif (($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
1.1462 raeburn 536: ($subcmd eq 'autoexportgrades') || ($subcmd eq 'put')) {
1.1396 raeburn 537: splice(@rest,3,1,'Hidden');
538: }
539: $logged = join(':',('encrypt:'.$subcmd,@rest));
540: }
541: }
542: &logthis("<font color=\"blue\">WARNING:".
543: " $logged to $server returned $answer</font>");
1.12 www 544: }
1.1 albertel 545: return $answer;
546: }
547:
548: # ----------------------------------------------------------- Send USR1 to lonc
549:
550: sub reconlonc {
1.891 albertel 551: my ($lonid) = @_;
552: if ($lonid) {
1.1295 raeburn 553: my $hostname = &hostname($lonid);
1.891 albertel 554: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
555: if ($hostname && -e $peerfile) {
556: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
557: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
558: Type => SOCK_STREAM,
559: Timeout => 10);
560: if ($client) {
561: print $client ("reset_retries\n");
562: my $answer=<$client>;
563: #reset just this one.
564: }
565: }
566: return;
567: }
568:
1.836 www 569: &logthis("Trying to reconnect lonc");
1.1 albertel 570: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.1359 raeburn 571: if (open(my $fh,"<",$loncfile)) {
1.1 albertel 572: my $loncpid=<$fh>;
573: chomp($loncpid);
574: if (kill 0 => $loncpid) {
575: &logthis("lonc at pid $loncpid responding, sending USR1");
576: kill USR1 => $loncpid;
577: sleep 1;
1.1295 raeburn 578: } else {
1.12 www 579: &logthis(
1.672 albertel 580: "<font color=\"blue\">WARNING:".
1.12 www 581: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 582: }
583: } else {
1.836 www 584: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 585: }
586: }
587:
588: # ------------------------------------------------------ Critical communication
1.12 www 589:
1.1 albertel 590: sub critical {
591: my ($cmd,$server)=@_;
1.838 albertel 592: unless (&hostname($server)) {
1.672 albertel 593: &logthis("<font color=\"blue\">WARNING:".
1.89 www 594: " Critical message to unknown server ($server)</font>");
595: return 'no_such_host';
596: }
1.1 albertel 597: my $answer=reply($cmd,$server);
598: if ($answer eq 'con_lost') {
1.1295 raeburn 599: &reconlonc($server);
1.589 albertel 600: my $answer=reply($cmd,$server);
1.1 albertel 601: if ($answer eq 'con_lost') {
602: my $now=time;
603: my $middlename=$cmd;
1.5 www 604: $middlename=substr($middlename,0,16);
1.1 albertel 605: $middlename=~s/\W//g;
606: my $dfilename=
1.305 www 607: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
608: $dumpcount++;
1.1 albertel 609: {
1.448 albertel 610: my $dfh;
1.1359 raeburn 611: if (open($dfh,">",$dfilename)) {
1.448 albertel 612: print $dfh "$cmd\n";
613: close($dfh);
614: }
1.1 albertel 615: }
1.1288 damieng 616: sleep 1;
1.1 albertel 617: my $wcmd='';
618: {
1.448 albertel 619: my $dfh;
1.1359 raeburn 620: if (open($dfh,"<",$dfilename)) {
1.448 albertel 621: $wcmd=<$dfh>;
622: close($dfh);
623: }
1.1 albertel 624: }
625: chomp($wcmd);
1.7 www 626: if ($wcmd eq $cmd) {
1.672 albertel 627: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 628: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 629: &logperm("D:$server:$cmd");
630: return 'con_delayed';
631: } else {
1.672 albertel 632: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 633: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 634: &logperm("F:$server:$cmd");
635: return 'con_failed';
636: }
637: }
638: }
639: return $answer;
1.405 albertel 640: }
641:
1.755 albertel 642: # ------------------------------------------- check if return value is an error
643:
644: sub error {
645: my ($result) = @_;
1.756 albertel 646: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 647: if ($2 == 2) { return undef; }
648: return $1;
649: }
650: return undef;
651: }
652:
1.783 albertel 653: sub convert_and_load_session_env {
654: my ($lonidsdir,$handle)=@_;
655: my @profile;
656: {
1.917 albertel 657: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
658: if (!$opened) {
1.915 albertel 659: return 0;
660: }
1.783 albertel 661: flock($idf,LOCK_SH);
662: @profile=<$idf>;
663: close($idf);
664: }
665: my %temp_env;
666: foreach my $line (@profile) {
1.786 albertel 667: if ($line !~ m/=/) {
668: return 0;
669: }
1.783 albertel 670: chomp($line);
671: my ($envname,$envvalue)=split(/=/,$line,2);
672: $temp_env{&unescape($envname)} = &unescape($envvalue);
673: }
674: unlink("$lonidsdir/$handle.id");
675: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
676: 0640)) {
677: %disk_env = %temp_env;
678: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
679: untie(%disk_env);
680: }
1.786 albertel 681: return 1;
1.783 albertel 682: }
683:
1.374 www 684: # ------------------------------------------- Transfer profile into environment
1.780 albertel 685: my $env_loaded;
686: sub transfer_profile_to_env {
1.788 albertel 687: my ($lonidsdir,$handle,$force_transfer) = @_;
688: if (!$force_transfer && $env_loaded) { return; }
1.374 www 689:
1.720 albertel 690: if (!defined($lonidsdir)) {
691: $lonidsdir = $perlvar{'lonIDsDir'};
692: }
693: if (!defined($handle)) {
694: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
695: }
696:
1.786 albertel 697: my $convert;
698: {
1.917 albertel 699: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
700: if (!$opened) {
1.915 albertel 701: return;
702: }
1.786 albertel 703: flock($idf,LOCK_SH);
704: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
705: &GDBM_READER(),0640)) {
706: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
707: untie(%disk_env);
708: } else {
709: $convert = 1;
710: }
711: }
712: if ($convert) {
713: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
714: &logthis("Failed to load session, or convert session.");
715: }
1.374 www 716: }
1.783 albertel 717:
1.786 albertel 718: my %remove;
1.783 albertel 719: while ( my $envname = each(%env) ) {
1.433 matthew 720: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
721: if ($time < time-300) {
1.783 albertel 722: $remove{$key}++;
1.433 matthew 723: }
724: }
725: }
1.783 albertel 726:
1.619 albertel 727: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 728: $env_loaded=1;
1.783 albertel 729: foreach my $expired_key (keys(%remove)) {
1.433 matthew 730: &delenv($expired_key);
1.374 www 731: }
1.1 albertel 732: }
733:
1.916 albertel 734: # ---------------------------------------------------- Check for valid session
735: sub check_for_valid_session {
1.1355 raeburn 736: my ($r,$name,$userhashref,$domref) = @_;
1.916 albertel 737: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1378 raeburn 738: my ($lonidsdir,$linkname,$pubname,$secure,$lonid);
739: if ($name eq 'lonDAV') {
740: $lonidsdir=$r->dir_config('lonDAVsessDir');
741: } else {
742: $lonidsdir=$r->dir_config('lonIDsDir');
743: if ($name eq '') {
744: $name = 'lonID';
745: }
746: }
747: if ($name eq 'lonID') {
748: $secure = 'lonSID';
1.1337 raeburn 749: $linkname = 'lonLinkID';
750: $pubname = 'lonPubID';
1.1378 raeburn 751: if (exists($cookies{$secure})) {
752: $lonid=$cookies{$secure};
753: } elsif (exists($cookies{$name})) {
754: $lonid=$cookies{$name};
1.1400 raeburn 755: } elsif ((exists($cookies{$linkname})) && ($ENV{'SERVER_PORT'} != 443)) {
1.1337 raeburn 756: $lonid=$cookies{$linkname};
1.1378 raeburn 757: } elsif (exists($cookies{$pubname})) {
758: $lonid=$cookies{$pubname};
1.1337 raeburn 759: }
1.1378 raeburn 760: } else {
761: $lonid=$cookies{$name};
1.1337 raeburn 762: }
1.916 albertel 763: return undef if (!$lonid);
764:
765: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1378 raeburn 766: if (-l "$lonidsdir/$handle.id") {
767: my $link = readlink("$lonidsdir/$handle.id");
768: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
769: $handle = $1;
770: }
1.1155 raeburn 771: }
1.1355 raeburn 772: if (!-e "$lonidsdir/$handle.id") {
773: if ((ref($domref)) && ($name eq 'lonID') &&
774: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
775: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
776: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
777: $$domref = $possudom;
778: }
779: }
780: return undef;
781: }
1.916 albertel 782:
1.917 albertel 783: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
784: return undef if (!$opened);
1.916 albertel 785:
786: flock($idf,LOCK_SH);
787: my %disk_env;
788: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
789: &GDBM_READER(),0640)) {
790: return undef;
791: }
792:
793: if (!defined($disk_env{'user.name'})
794: || !defined($disk_env{'user.domain'})) {
1.1394 raeburn 795: untie(%disk_env);
1.916 albertel 796: return undef;
797: }
1.1245 raeburn 798:
799: if (ref($userhashref) eq 'HASH') {
800: $userhashref->{'name'} = $disk_env{'user.name'};
801: $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1448 raeburn 802: if ($disk_env{'request.role'}) {
803: $userhashref->{'role'} = $disk_env{'request.role'};
804: }
1.1361 raeburn 805: $userhashref->{'lti'} = $disk_env{'request.lti.login'};
1.1375 raeburn 806: if ($userhashref->{'lti'}) {
807: $userhashref->{'ltitarget'} = $disk_env{'request.lti.target'};
808: $userhashref->{'ltiuri'} = $disk_env{'request.lti.uri'};
809: }
1.1212 raeburn 810: }
1.1394 raeburn 811: untie(%disk_env);
1.1245 raeburn 812:
1.916 albertel 813: return $handle;
814: }
815:
1.830 albertel 816: sub timed_flock {
817: my ($file,$lock_type) = @_;
818: my $failed=0;
819: eval {
820: local $SIG{__DIE__}='DEFAULT';
821: local $SIG{ALRM}=sub {
822: $failed=1;
823: die("failed lock");
824: };
825: alarm(13);
826: flock($file,$lock_type);
827: alarm(0);
828: };
829: if ($failed) {
830: return undef;
831: } else {
832: return 1;
833: }
834: }
835:
1.1392 raeburn 836: sub get_sessionfile_vars {
837: my ($handle,$lonidsdir,$storearr) = @_;
838: my %returnhash;
839: unless (ref($storearr) eq 'ARRAY') {
840: return %returnhash;
841: }
842: if (-l "$lonidsdir/$handle.id") {
843: my $link = readlink("$lonidsdir/$handle.id");
844: if ((-e $link) && ($link =~ m{^\Q$lonidsdir\E/(.+)\.id$})) {
845: $handle = $1;
846: }
847: }
848: if ((-e "$lonidsdir/$handle.id") &&
849: ($handle =~ /^($match_username)\_\d+\_($match_domain)\_(.+)$/)) {
850: my ($possuname,$possudom,$possuhome) = ($1,$2,$3);
851: if ((&domain($possudom) ne '') && (&homeserver($possuname,$possudom) eq $possuhome)) {
852: if (open(my $idf,'+<',"$lonidsdir/$handle.id")) {
853: flock($idf,LOCK_SH);
854: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
855: &GDBM_READER(),0640)) {
856: foreach my $item (@{$storearr}) {
857: $returnhash{$item} = $disk_env{$item};
858: }
859: untie(%disk_env);
860: }
861: }
862: }
863: }
864: return %returnhash;
865: }
866:
1.5 www 867: # ---------------------------------------------------------- Append Environment
868:
869: sub appenv {
1.949 raeburn 870: my ($newenv,$roles) = @_;
871: if (ref($newenv) eq 'HASH') {
872: foreach my $key (keys(%{$newenv})) {
873: my $refused = 0;
874: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
875: $refused = 1;
876: if (ref($roles) eq 'ARRAY') {
1.1250 raeburn 877: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949 raeburn 878: if (grep(/^\Q$role\E$/,@{$roles})) {
879: $refused = 0;
880: }
881: }
882: }
883: if ($refused) {
884: &logthis("<font color=\"blue\">WARNING: ".
885: "Attempt to modify environment ".$key." to ".$newenv->{$key}
886: .'</font>');
887: delete($newenv->{$key});
888: } else {
889: $env{$key}=$newenv->{$key};
890: }
891: }
1.1376 raeburn 892: my $lonids = $perlvar{'lonIDsDir'};
893: if ($env{'user.environment'} =~ m{^\Q$lonids/\E$match_username\_\d+\_$match_domain\_[\w\-.]+\.id$}) {
894: my $opened = open(my $env_file,'+<',$env{'user.environment'});
895: if ($opened
896: && &timed_flock($env_file,LOCK_EX)
897: &&
898: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
899: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
900: while (my ($key,$value) = each(%{$newenv})) {
901: $disk_env{$key} = $value;
902: }
903: untie(%disk_env);
904: }
1.35 www 905: }
1.191 harris41 906: }
1.56 www 907: return 'ok';
908: }
909: # ----------------------------------------------------- Delete from Environment
910:
911: sub delenv {
1.1104 raeburn 912: my ($delthis,$regexp,$roles) = @_;
913: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
914: my $refused = 1;
915: if (ref($roles) eq 'ARRAY') {
916: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
917: if (grep(/^\Q$role\E$/,@{$roles})) {
918: $refused = 0;
919: }
920: }
921: if ($refused) {
922: &logthis("<font color=\"blue\">WARNING: ".
923: "Attempt to delete from environment ".$delthis);
924: return 'error';
925: }
1.56 www 926: }
1.917 albertel 927: my $opened = open(my $env_file,'+<',$env{'user.environment'});
928: if ($opened
1.915 albertel 929: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 930: &&
931: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
932: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 933: foreach my $key (keys(%disk_env)) {
1.987 raeburn 934: if ($regexp) {
935: if ($key=~/^$delthis/) {
936: delete($env{$key});
937: delete($disk_env{$key});
938: }
939: } else {
940: if ($key=~/^\Q$delthis\E/) {
941: delete($env{$key});
942: delete($disk_env{$key});
943: }
944: }
1.448 albertel 945: }
1.783 albertel 946: untie(%disk_env);
1.5 www 947: }
948: return 'ok';
1.369 albertel 949: }
950:
1.790 albertel 951: sub get_env_multiple {
952: my ($name) = @_;
953: my @values;
954: if (defined($env{$name})) {
955: # exists is it an array
956: if (ref($env{$name})) {
957: @values=@{ $env{$name} };
958: } else {
959: $values[0]=$env{$name};
960: }
961: }
962: return(@values);
963: }
964:
1.958 www 965: # ------------------------------------------------------------------- Locking
966:
967: sub set_lock {
968: my ($text)=@_;
969: $locknum++;
970: my $id=$$.'-'.$locknum;
971: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
972: 'session.lock.'.$id => $text});
973: return $id;
974: }
975:
976: sub get_locks {
977: my $num=0;
978: my %texts=();
979: foreach my $lock (split(/\,/,$env{'session.locks'})) {
980: if ($lock=~/\w/) {
981: $num++;
982: $texts{$lock}=$env{'session.lock.'.$lock};
983: }
984: }
985: return ($num,%texts);
986: }
987:
988: sub remove_lock {
989: my ($id)=@_;
990: my $newlocks='';
991: foreach my $lock (split(/\,/,$env{'session.locks'})) {
992: if (($lock=~/\w/) && ($lock ne $id)) {
993: $newlocks.=','.$lock;
994: }
995: }
996: &appenv({'session.locks' => $newlocks});
997: &delenv('session.lock.'.$id);
998: }
999:
1000: sub remove_all_locks {
1001: my $activelocks=$env{'session.locks'};
1002: foreach my $lock (split(/\,/,$env{'session.locks'})) {
1003: if ($lock=~/\w/) {
1004: &remove_lock($lock);
1005: }
1006: }
1007: }
1008:
1009:
1.369 albertel 1010: # ------------------------------------------ Find out current server userload
1011: sub userload {
1012: my $numusers=0;
1013: {
1014: opendir(LONIDS,$perlvar{'lonIDsDir'});
1015: my $filename;
1016: my $curtime=time;
1017: while ($filename=readdir(LONIDS)) {
1.925 albertel 1018: next if ($filename eq '.' || $filename eq '..');
1019: next if ($filename =~ /publicuser_\d+\.id/);
1.1390 raeburn 1020: next if ($filename =~ /^[a-f0-9]+_linked\.id$/);
1.404 albertel 1021: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 1022: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 1023: }
1024: closedir(LONIDS);
1025: }
1026: my $userloadpercent=0;
1027: my $maxuserload=$perlvar{'lonUserLoadLim'};
1028: if ($maxuserload) {
1.371 albertel 1029: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 1030: }
1.372 albertel 1031: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 1032: return $userloadpercent;
1.283 www 1033: }
1034:
1.1 albertel 1035: # ------------------------------ Find server with least workload from spare.tab
1.11 www 1036:
1.1 albertel 1037: sub spareserver {
1.1451 raeburn 1038: my ($r,$loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 1039: my $spare_server;
1.370 albertel 1040: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 1041: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
1042: : $userloadpercent;
1.1083 raeburn 1043: my ($uint_dom,$remotesessions);
1044: if (($udom ne '') && (&domain($udom) ne '')) {
1.1494 raeburn 1045: my $uprimary_id = &domain($udom,'primary');
1046: $uint_dom = &internet_dom($uprimary_id);
1047: my %udomdefaults = &get_domain_defaults($udom);
1.1083 raeburn 1048: $remotesessions = $udomdefaults{'remotesessions'};
1049: }
1.1123 raeburn 1050: my $spareshash = &this_host_spares($udom);
1051: if (ref($spareshash) eq 'HASH') {
1052: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1053: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1.1279 raeburn 1054: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
1055: $try_server));
1.1123 raeburn 1056: ($spare_server, $lowest_load) =
1057: &compare_server_load($try_server, $spare_server, $lowest_load);
1058: }
1.1083 raeburn 1059: }
1.784 albertel 1060:
1.1123 raeburn 1061: my $found_server = ($spare_server ne '' && $lowest_load < 100);
1062:
1063: if (!$found_server) {
1064: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1065: foreach my $try_server (@{ $spareshash->{'default'} }) {
1.1279 raeburn 1066: next unless (&spare_can_host($udom,$uint_dom,
1067: $remotesessions,$try_server));
1.1123 raeburn 1068: ($spare_server, $lowest_load) =
1069: &compare_server_load($try_server, $spare_server, $lowest_load);
1070: }
1071: }
1072: }
1.784 albertel 1073: }
1074:
1075: if (!$want_server_name) {
1.1001 raeburn 1076: if (defined($spare_server)) {
1077: my $hostname = &hostname($spare_server);
1.1083 raeburn 1078: if (defined($hostname)) {
1.1397 raeburn 1079: my $protocol = 'http';
1080: if ($protocol{$spare_server} eq 'https') {
1081: $protocol = $protocol{$spare_server};
1082: }
1.1494 raeburn 1083: my $alias = &use_proxy_alias($r,$spare_server);
1.1451 raeburn 1084: $hostname = $alias if ($alias ne '');
1.1001 raeburn 1085: $spare_server = $protocol.'://'.$hostname;
1086: }
1087: }
1.784 albertel 1088: }
1089: return $spare_server;
1090: }
1091:
1092: sub compare_server_load {
1.1253 raeburn 1093: my ($try_server, $spare_server, $lowest_load, $required) = @_;
1094:
1095: if ($required) {
1096: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
1097: my $remoterev = &get_server_loncaparev(undef,$try_server);
1098: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
1099: if (($major eq '' && $minor eq '') ||
1100: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
1101: return ($spare_server,$lowest_load);
1102: }
1103: }
1.784 albertel 1104:
1105: my $loadans = &reply('load', $try_server);
1106: my $userloadans = &reply('userload',$try_server);
1107:
1108: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 1109: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 1110: }
1111:
1112: my $load;
1113: if ($loadans =~ /\d/) {
1114: if ($userloadans =~ /\d/) {
1115: #both are numbers, pick the bigger one
1116: $load = ($loadans > $userloadans) ? $loadans
1117: : $userloadans;
1.411 albertel 1118: } else {
1.784 albertel 1119: $load = $loadans;
1.411 albertel 1120: }
1.784 albertel 1121: } else {
1122: $load = $userloadans;
1123: }
1124:
1125: if (($load =~ /\d/) && ($load < $lowest_load)) {
1126: $spare_server = $try_server;
1127: $lowest_load = $load;
1.370 albertel 1128: }
1.784 albertel 1129: return ($spare_server,$lowest_load);
1.202 matthew 1130: }
1.914 albertel 1131:
1132: # --------------------------- ask offload servers if user already has a session
1133: sub find_existing_session {
1134: my ($udom,$uname) = @_;
1.1123 raeburn 1135: my $spareshash = &this_host_spares($udom);
1136: if (ref($spareshash) eq 'HASH') {
1137: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
1138: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1139: return $try_server if (&has_user_session($try_server, $udom, $uname));
1140: }
1141: }
1142: if (ref($spareshash->{'default'}) eq 'ARRAY') {
1143: foreach my $try_server (@{ $spareshash->{'default'} }) {
1144: return $try_server if (&has_user_session($try_server, $udom, $uname));
1145: }
1146: }
1.914 albertel 1147: }
1148: return;
1149: }
1150:
1.1411 raeburn 1151: sub delusersession {
1152: my ($lonid,$udom,$uname) = @_;
1153: my $uprimary_id = &domain($udom,'primary');
1154: my $uintdom = &internet_dom($uprimary_id);
1155: my $intdom = &internet_dom($lonid);
1156: my $serverhomedom = &host_domain($lonid);
1157: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1158: return &reply(join(':','delusersession',
1159: map {&escape($_)} ($udom,$uname)),$lonid);
1160: }
1161: return;
1162: }
1163:
1.1389 raeburn 1164: # check if user's browser sent load balancer cookie and server still has session
1165: # and is not overloaded.
1166: sub check_for_balancer_cookie {
1167: my ($r,$update_mtime) = @_;
1168: my ($otherserver,$cookie);
1169: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1170: if (exists($cookies{'balanceID'})) {
1171: my $balid = $cookies{'balanceID'};
1172: $cookie=&LONCAPA::clean_handle($balid->value);
1173: my $balancedir=$r->dir_config('lonBalanceDir');
1174: if ((-d $balancedir) && (-e "$balancedir/$cookie.id")) {
1175: if ($cookie =~ /^($match_domain)_($match_username)_[a-f0-9]+$/) {
1176: my ($possudom,$possuname) = ($1,$2);
1177: my $has_session = 0;
1178: if ((&domain($possudom) ne '') &&
1179: (&homeserver($possuname,$possudom) ne 'no_host')) {
1180: my $try_server;
1181: my $opened = open(my $idf,'+<',"$balancedir/$cookie.id");
1182: if ($opened) {
1183: flock($idf,LOCK_SH);
1184: while (my $line = <$idf>) {
1185: chomp($line);
1186: if (&hostname($line) ne '') {
1187: $try_server = $line;
1188: last;
1189: }
1190: }
1191: close($idf);
1192: if (($try_server) &&
1193: (&has_user_session($try_server,$possudom,$possuname))) {
1194: my $lowest_load = 30000;
1195: ($otherserver,$lowest_load) =
1196: &compare_server_load($try_server,undef,$lowest_load);
1197: if ($otherserver ne '' && $lowest_load < 100) {
1198: $has_session = 1;
1199: } else {
1200: undef($otherserver);
1201: }
1202: }
1203: }
1204: }
1205: if ($has_session) {
1206: if ($update_mtime) {
1207: my $atime = my $mtime = time;
1208: utime($atime,$mtime,"$balancedir/$cookie.id");
1209: }
1210: } else {
1211: unlink("$balancedir/$cookie.id");
1212: }
1213: }
1214: }
1215: }
1216: return ($otherserver,$cookie);
1217: }
1218:
1.1431 raeburn 1219: sub updatebalcookie {
1220: my ($cookie,$balancer,$lastentry)=@_;
1221: if ($cookie =~ /^($match_domain)\_($match_username)\_[a-f0-9]{32}$/) {
1222: my ($udom,$uname) = ($1,$2);
1223: my $uprimary_id = &domain($udom,'primary');
1224: my $uintdom = &internet_dom($uprimary_id);
1225: my $intdom = &internet_dom($balancer);
1226: my $serverhomedom = &host_domain($balancer);
1227: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1228: return &reply('updatebalcookie:'.&escape($cookie).':'.&escape($lastentry),$balancer);
1229: }
1230: }
1231: return;
1232: }
1233:
1.1389 raeburn 1234: sub delbalcookie {
1235: my ($cookie,$balancer) =@_;
1236: if ($cookie =~ /^($match_domain)\_($match_username)\_[a-f0-9]{32}$/) {
1237: my ($udom,$uname) = ($1,$2);
1238: my $uprimary_id = &domain($udom,'primary');
1239: my $uintdom = &internet_dom($uprimary_id);
1240: my $intdom = &internet_dom($balancer);
1241: my $serverhomedom = &host_domain($balancer);
1242: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1.1431 raeburn 1243: return &reply('delbalcookie:'.&escape($cookie),$balancer);
1.1389 raeburn 1244: }
1245: }
1246: }
1247:
1.914 albertel 1248: # -------------------------------- ask if server already has a session for user
1249: sub has_user_session {
1250: my ($lonid,$udom,$uname) = @_;
1251: my $result = &reply(join(':','userhassession',
1252: map {&escape($_)} ($udom,$uname)),$lonid);
1253: return 1 if ($result eq 'ok');
1254:
1255: return 0;
1256: }
1257:
1.1076 raeburn 1258: # --------- determine least loaded server in a user's domain which allows login
1259:
1260: sub choose_server {
1.1259 raeburn 1261: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076 raeburn 1262: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 1263: my %servers = &get_servers($udom);
1.1076 raeburn 1264: my $lowest_load = 30000;
1.1259 raeburn 1265: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
1266: if ($skiploadbal) {
1267: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
1268: unless (defined($cached)) {
1269: my $cachetime = 60*60*24;
1270: my %domconfig =
1.1494 raeburn 1271: &get_dom('configuration',['loadbalancing'],$udom);
1.1259 raeburn 1272: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1273: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
1274: $cachetime);
1275: }
1276: }
1277: }
1.1076 raeburn 1278: foreach my $lonhost (keys(%servers)) {
1.1259 raeburn 1279: if ($skiploadbal) {
1280: if (ref($balancers) eq 'HASH') {
1281: next if (exists($balancers->{$lonhost}));
1282: }
1.1389 raeburn 1283: }
1.1115 raeburn 1284: my $loginvia;
1285: if ($checkloginvia) {
1286: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 1287: if ($loginvia) {
1288: my ($server,$path) = split(/:/,$loginvia);
1289: ($login_host, $lowest_load) =
1.1253 raeburn 1290: &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116 raeburn 1291: if ($login_host eq $server) {
1292: $portal_path = $path;
1.1151 raeburn 1293: $isredirect = 1;
1.1116 raeburn 1294: }
1295: } else {
1296: ($login_host, $lowest_load) =
1.1253 raeburn 1297: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116 raeburn 1298: if ($login_host eq $lonhost) {
1299: $portal_path = '';
1.1151 raeburn 1300: $isredirect = '';
1.1116 raeburn 1301: }
1302: }
1303: } else {
1.1076 raeburn 1304: ($login_host, $lowest_load) =
1.1253 raeburn 1305: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076 raeburn 1306: }
1307: }
1308: if ($login_host ne '') {
1.1116 raeburn 1309: $hostname = &hostname($login_host);
1.1076 raeburn 1310: }
1.1331 raeburn 1311: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1.1076 raeburn 1312: }
1313:
1.1420 raeburn 1314: sub get_course_sessions {
1315: my ($cnum,$cdom,$lastactivity) = @_;
1316: my %servers = &internet_dom_servers($cdom);
1317: my %returnhash;
1318: foreach my $server (sort(keys(%servers))) {
1319: my $rep = &reply("coursesessions:$cdom:$cnum:$lastactivity",$server);
1320: my @pairs=split(/\&/,$rep);
1321: unless (($rep eq 'unknown_cmd') || ($rep =~ /^error/)) {
1322: foreach my $item (@pairs) {
1323: my ($key,$value)=split(/=/,$item,2);
1324: $key = &unescape($key);
1325: next if ($key =~ /^error: 2 /);
1326: if (exists($returnhash{$key})) {
1327: next if ($value < $returnhash{$key});
1328: }
1329: $returnhash{$key}=$value;
1330: }
1331: }
1332: }
1333: return %returnhash;
1334: }
1335:
1.202 matthew 1336: # --------------------------------------------- Try to change a user's password
1337:
1338: sub changepass {
1.799 raeburn 1339: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 1340: $currentpass = &escape($currentpass);
1341: $newpass = &escape($newpass);
1.1030 raeburn 1342: my $lonhost = $perlvar{'lonHostID'};
1343: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 1344: $server);
1345: if (! $answer) {
1346: &logthis("No reply on password change request to $server ".
1347: "by $uname in domain $udom.");
1348: } elsif ($answer =~ "^ok") {
1349: &logthis("$uname in $udom successfully changed their password ".
1350: "on $server.");
1351: } elsif ($answer =~ "^pwchange_failure") {
1352: &logthis("$uname in $udom was unable to change their password ".
1353: "on $server. The action was blocked by either lcpasswd ".
1354: "or pwchange");
1355: } elsif ($answer =~ "^non_authorized") {
1356: &logthis("$uname in $udom did not get their password correct when ".
1357: "attempting to change it on $server.");
1358: } elsif ($answer =~ "^auth_mode_error") {
1359: &logthis("$uname in $udom attempted to change their password despite ".
1360: "not being locally or internally authenticated on $server.");
1361: } elsif ($answer =~ "^unknown_user") {
1362: &logthis("$uname in $udom attempted to change their password ".
1363: "on $server but were unable to because $server is not ".
1364: "their home server.");
1365: } elsif ($answer =~ "^refused") {
1366: &logthis("$server refused to change $uname in $udom password because ".
1367: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1368: } elsif ($answer =~ "invalid_client") {
1369: &logthis("$server refused to change $uname in $udom password because ".
1370: "it was a reset by e-mail originating from an invalid server.");
1.1408 raeburn 1371: } elsif ($answer =~ "^prioruse") {
1372: &logthis("$server refused to change $uname in $udom password because ".
1373: "the password had been used before");
1.202 matthew 1374: }
1375: return $answer;
1.1 albertel 1376: }
1377:
1.169 harris41 1378: # ----------------------- Try to determine user's current authentication scheme
1379:
1380: sub queryauthenticate {
1381: my ($uname,$udom)=@_;
1.456 albertel 1382: my $uhome=&homeserver($uname,$udom);
1.1484 raeburn 1383: if ((!$uhome) || ($uhome eq 'no_host')) {
1.456 albertel 1384: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1385: return 'no_host';
1386: }
1387: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1388: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1389: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1390: }
1.456 albertel 1391: return $answer;
1.169 harris41 1392: }
1393:
1.1 albertel 1394: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1395:
1.1 albertel 1396: sub authenticate {
1.1073 raeburn 1397: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1398: $upass=&escape($upass);
1399: $uname= &LONCAPA::clean_username($uname);
1.836 www 1400: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1401: my $newhome;
1.836 www 1402: if ((!$uhome) || ($uhome eq 'no_host')) {
1403: # Maybe the machine was offline and only re-appeared again recently?
1404: &reconlonc();
1405: # One more
1.952 raeburn 1406: $uhome=&homeserver($uname,$udom,1);
1407: if (($uhome eq 'no_host') && $checkdefauth) {
1408: if (defined(&domain($udom,'primary'))) {
1409: $newhome=&domain($udom,'primary');
1410: }
1411: if ($newhome ne '') {
1412: $uhome = $newhome;
1413: }
1414: }
1.836 www 1415: if ((!$uhome) || ($uhome eq 'no_host')) {
1416: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1417: return 'no_host';
1418: }
1.1 albertel 1419: }
1.1073 raeburn 1420: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1421: if ($answer eq 'authorized') {
1.952 raeburn 1422: if ($newhome) {
1423: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1424: return 'no_account_on_host';
1425: } else {
1426: &logthis("User $uname at $udom authorized by $uhome");
1427: return $uhome;
1428: }
1.471 albertel 1429: }
1430: if ($answer eq 'non_authorized') {
1431: &logthis("User $uname at $udom rejected by $uhome");
1.1484 raeburn 1432: return 'no_host';
1.9 www 1433: }
1.471 albertel 1434: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1435: return 'no_host';
1436: }
1437:
1.1491 raeburn 1438: sub can_switchserver {
1439: my ($udom,$home) = @_;
1440: my ($canswitch,@intdoms);
1441: my $internet_names = &get_internet_names($home);
1442: if (ref($internet_names) eq 'ARRAY') {
1443: @intdoms = @{$internet_names};
1444: }
1445: my $uint_dom = &internet_dom(&domain($udom,'primary'));
1446: if ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
1447: $canswitch = 1;
1448: } else {
1449: my $serverhomeID = &get_server_homeID(&hostname($home));
1450: my $serverhomedom = &host_domain($serverhomeID);
1451: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1452: my %udomdefaults = &get_domain_defaults($udom);
1453: my $remoterev = &get_server_loncaparev('',$home);
1454: $canswitch = &can_host_session($udom,$home,$remoterev,
1455: $udomdefaults{'remotesessions'},
1456: $defdomdefaults{'hostedsessions'});
1457: }
1458: return $canswitch;
1459: }
1460:
1.1073 raeburn 1461: sub can_host_session {
1.1074 raeburn 1462: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1463: my $canhost = 1;
1.1494 raeburn 1464: my $host_idn = &internet_dom($lonhost);
1.1073 raeburn 1465: if (ref($remotesessions) eq 'HASH') {
1466: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1467: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1468: $canhost = 0;
1469: } else {
1470: $canhost = 1;
1471: }
1472: }
1473: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1474: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1475: $canhost = 1;
1476: } else {
1477: $canhost = 0;
1478: }
1479: }
1480: if ($canhost) {
1481: if ($remotesessions->{'version'} ne '') {
1482: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1483: if ($reqmajor ne '' && $reqminor ne '') {
1484: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1485: my $major = $1;
1486: my $minor = $2;
1487: if (($major < $reqmajor ) ||
1488: (($major == $reqmajor) && ($minor < $reqminor))) {
1489: $canhost = 0;
1490: }
1491: } else {
1492: $canhost = 0;
1493: }
1494: }
1495: }
1496: }
1497: }
1498: if ($canhost) {
1499: if (ref($hostedsessions) eq 'HASH') {
1.1494 raeburn 1500: my $uprimary_id = &domain($udom,'primary');
1501: my $uint_dom = &internet_dom($uprimary_id);
1.1073 raeburn 1502: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1503: if (($uint_dom ne '') &&
1504: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1505: $canhost = 0;
1506: } else {
1507: $canhost = 1;
1508: }
1509: }
1510: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1511: if (($uint_dom ne '') &&
1512: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1513: $canhost = 1;
1514: } else {
1515: $canhost = 0;
1516: }
1517: }
1518: }
1519: }
1520: return $canhost;
1521: }
1522:
1.1083 raeburn 1523: sub spare_can_host {
1524: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1525: my $canhost=1;
1.1279 raeburn 1526: my $try_server_hostname = &hostname($try_server);
1527: my $serverhomeID = &get_server_homeID($try_server_hostname);
1528: my $serverhomedom = &host_domain($serverhomeID);
1529: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1530: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1531: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1532: $canhost = 0;
1533: }
1534: }
1.1439 raeburn 1535: if ($canhost) {
1536: if (ref($defdomdefaults{'offloadoth'}) eq 'HASH') {
1537: if ($defdomdefaults{'offloadoth'}{$try_server}) {
1538: unless (&shared_institution($udom,$try_server)) {
1539: $canhost = 0;
1540: }
1541: }
1542: }
1543: }
1.1279 raeburn 1544: if (($canhost) && ($uint_dom)) {
1545: my @intdoms;
1546: my $internet_names = &get_internet_names($try_server);
1547: if (ref($internet_names) eq 'ARRAY') {
1548: @intdoms = @{$internet_names};
1549: }
1550: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1551: my $remoterev = &get_server_loncaparev(undef,$try_server);
1552: $canhost = &can_host_session($udom,$try_server,$remoterev,
1553: $remotesessions,
1554: $defdomdefaults{'hostedsessions'});
1555: }
1.1083 raeburn 1556: }
1557: return $canhost;
1558: }
1559:
1.1123 raeburn 1560: sub this_host_spares {
1561: my ($dom) = @_;
1.1126 raeburn 1562: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1563: my @hosts = ¤t_machine_ids();
1564: foreach my $lonhost (@hosts) {
1565: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1566: $dom_in_use = $dom;
1567: $lonhost_in_use = $lonhost;
1.1123 raeburn 1568: last;
1569: }
1570: }
1.1126 raeburn 1571: if ($dom_in_use ne '') {
1572: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1573: }
1574: if (ref($result) ne 'HASH') {
1575: $lonhost_in_use = $perlvar{'lonHostID'};
1576: $dom_in_use = &host_domain($lonhost_in_use);
1577: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1578: if (ref($result) ne 'HASH') {
1579: $result = \%spareid;
1580: }
1581: }
1582: return $result;
1583: }
1584:
1585: sub spares_for_offload {
1586: my ($dom_in_use,$lonhost_in_use) = @_;
1587: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1588: if (defined($cached)) {
1589: return $result;
1590: } else {
1.1126 raeburn 1591: my $cachetime = 60*60*24;
1592: my %domconfig =
1.1494 raeburn 1593: &get_dom('configuration',['usersessions'],$dom_in_use);
1.1126 raeburn 1594: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1595: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1596: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1597: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1598: }
1599: }
1600: }
1601: }
1.1126 raeburn 1602: return;
1.1123 raeburn 1603: }
1604:
1.1129 raeburn 1605: sub get_lonbalancer_config {
1606: my ($servers) = @_;
1607: my ($currbalancer,$currtargets);
1608: if (ref($servers) eq 'HASH') {
1609: foreach my $server (keys(%{$servers})) {
1610: my %what = (
1611: spareid => 1,
1612: perlvar => 1,
1613: );
1614: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1615: if ($result eq 'ok') {
1616: if (ref($returnhash) eq 'HASH') {
1617: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1618: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1619: $currbalancer = $server;
1620: $currtargets = {};
1621: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1622: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1623: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1624: }
1625: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1626: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1627: }
1628: }
1629: last;
1630: }
1631: }
1632: }
1633: }
1634: }
1635: }
1636: return ($currbalancer,$currtargets);
1637: }
1638:
1639: sub check_loadbalancing {
1.1331 raeburn 1640: my ($uname,$udom,$caller) = @_;
1.1191 raeburn 1641: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1.1391 raeburn 1642: $rule_in_effect,$offloadto,$otherserver,$setcookie,$dom_balancers);
1.1129 raeburn 1643: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1644: my @hosts = ¤t_machine_ids();
1.1494 raeburn 1645: my $uprimary_id = &domain($udom,'primary');
1646: my $uintdom = &internet_dom($uprimary_id);
1647: my $intdom = &internet_dom($lonhost);
1.1129 raeburn 1648: my $serverhomedom = &host_domain($lonhost);
1.1307 raeburn 1649: my $domneedscache;
1.1129 raeburn 1650: my $cachetime = 60*60*24;
1651:
1652: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1653: $dom_in_use = $udom;
1654: $homeintdom = 1;
1655: } else {
1656: $dom_in_use = $serverhomedom;
1657: }
1658: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1659: unless (defined($cached)) {
1660: my %domconfig =
1.1494 raeburn 1661: &get_dom('configuration',['loadbalancing'],$dom_in_use);
1.1129 raeburn 1662: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1663: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1307 raeburn 1664: } else {
1665: $domneedscache = $dom_in_use;
1.1129 raeburn 1666: }
1667: }
1668: if (ref($result) eq 'HASH') {
1.1391 raeburn 1669: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1670: &check_balancer_result($result,@hosts);
1.1129 raeburn 1671: if ($is_balancer) {
1672: if (ref($currrules) eq 'HASH') {
1673: if ($homeintdom) {
1674: if ($uname ne '') {
1675: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1676: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1677: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1678: $rule_in_effect = $currrules->{'_LC_author'};
1679: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1680: $rule_in_effect = $currrules->{'_LC_adv'}
1681: }
1682: }
1683: if ($rule_in_effect eq '') {
1684: my %userenv = &userenvironment($udom,$uname,'inststatus');
1685: if ($userenv{'inststatus'} ne '') {
1686: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1687: my ($othertitle,$usertypes,$types) =
1688: &Apache::loncommon::sorted_inst_types($udom);
1689: if (ref($types) eq 'ARRAY') {
1690: foreach my $type (@{$types}) {
1691: if (grep(/^\Q$type\E$/,@statuses)) {
1692: if (exists($currrules->{$type})) {
1693: $rule_in_effect = $currrules->{$type};
1694: }
1695: }
1696: }
1697: }
1698: } else {
1699: if (exists($currrules->{'default'})) {
1700: $rule_in_effect = $currrules->{'default'};
1701: }
1702: }
1703: }
1704: } else {
1705: if (exists($currrules->{'default'})) {
1706: $rule_in_effect = $currrules->{'default'};
1707: }
1708: }
1709: } else {
1710: if ($currrules->{'_LC_external'} ne '') {
1711: $rule_in_effect = $currrules->{'_LC_external'};
1712: }
1713: }
1714: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1715: $uname,$udom);
1716: }
1717: }
1718: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1239 raeburn 1719: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1720: unless (defined($cached)) {
1721: my %domconfig =
1.1494 raeburn 1722: &get_dom('configuration',['loadbalancing'],$serverhomedom);
1.1129 raeburn 1723: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1307 raeburn 1724: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1725: } else {
1726: $domneedscache = $serverhomedom;
1.1129 raeburn 1727: }
1728: }
1729: if (ref($result) eq 'HASH') {
1.1391 raeburn 1730: ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers) =
1.1191 raeburn 1731: &check_balancer_result($result,@hosts);
1732: if ($is_balancer) {
1.1129 raeburn 1733: if (ref($currrules) eq 'HASH') {
1734: if ($currrules->{'_LC_internetdom'} ne '') {
1735: $rule_in_effect = $currrules->{'_LC_internetdom'};
1736: }
1737: }
1738: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1739: $uname,$udom);
1740: }
1741: } else {
1742: if ($perlvar{'lonBalancer'} eq 'yes') {
1743: $is_balancer = 1;
1744: $offloadto = &this_host_spares($dom_in_use);
1745: }
1.1307 raeburn 1746: unless (defined($cached)) {
1747: $domneedscache = $serverhomedom;
1748: }
1.1129 raeburn 1749: }
1750: } else {
1751: if ($perlvar{'lonBalancer'} eq 'yes') {
1752: $is_balancer = 1;
1753: $offloadto = &this_host_spares($dom_in_use);
1754: }
1.1307 raeburn 1755: unless (defined($cached)) {
1756: $domneedscache = $serverhomedom;
1757: }
1758: }
1759: if ($domneedscache) {
1760: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129 raeburn 1761: }
1.1430 raeburn 1762: if (($is_balancer) && ($caller ne 'switchserver')) {
1.1176 raeburn 1763: my $lowest_load = 30000;
1764: if (ref($offloadto) eq 'HASH') {
1765: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1766: foreach my $try_server (@{$offloadto->{'primary'}}) {
1767: ($otherserver,$lowest_load) =
1768: &compare_server_load($try_server,$otherserver,$lowest_load);
1769: }
1.1129 raeburn 1770: }
1.1176 raeburn 1771: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1772:
1.1176 raeburn 1773: if (!$found_server) {
1774: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1775: foreach my $try_server (@{$offloadto->{'default'}}) {
1776: ($otherserver,$lowest_load) =
1777: &compare_server_load($try_server,$otherserver,$lowest_load);
1778: }
1779: }
1780: }
1781: } elsif (ref($offloadto) eq 'ARRAY') {
1782: if (@{$offloadto} == 1) {
1783: $otherserver = $offloadto->[0];
1784: } elsif (@{$offloadto} > 1) {
1785: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1786: ($otherserver,$lowest_load) =
1787: &compare_server_load($try_server,$otherserver,$lowest_load);
1788: }
1789: }
1790: }
1.1331 raeburn 1791: unless ($caller eq 'login') {
1792: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1793: $is_balancer = 0;
1794: if ($uname ne '' && $udom ne '') {
1795: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1.1389 raeburn 1796: &appenv({'user.loadbalexempt' => $lonhost,
1.1331 raeburn 1797: 'user.loadbalcheck.time' => time});
1798: }
1.1176 raeburn 1799: }
1.1129 raeburn 1800: }
1801: }
1.1430 raeburn 1802: }
1803: if (($is_balancer) && (!$homeintdom)) {
1804: undef($setcookie);
1.1129 raeburn 1805: }
1.1391 raeburn 1806: return ($is_balancer,$otherserver,$setcookie,$offloadto,$dom_balancers);
1.1129 raeburn 1807: }
1808:
1.1191 raeburn 1809: sub check_balancer_result {
1810: my ($result,@hosts) = @_;
1.1391 raeburn 1811: my ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 1812: if (ref($result) eq 'HASH') {
1813: if ($result->{'lonhost'} ne '') {
1814: my $currbalancer = $result->{'lonhost'};
1815: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1816: $is_balancer = 1;
1817: $currtargets = $result->{'targets'};
1818: $currrules = $result->{'rules'};
1819: }
1.1391 raeburn 1820: $dom_balancers = $currbalancer;
1.1191 raeburn 1821: } else {
1.1391 raeburn 1822: if (keys(%{$result})) {
1823: foreach my $key (keys(%{$result})) {
1824: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1825: (ref($result->{$key}) eq 'HASH')) {
1826: $is_balancer = 1;
1827: $currrules = $result->{$key}{'rules'};
1828: $currtargets = $result->{$key}{'targets'};
1829: $setcookie = $result->{$key}{'cookie'};
1830: last;
1831: }
1.1191 raeburn 1832: }
1.1391 raeburn 1833: $dom_balancers = join(',',sort(keys(%{$result})));
1.1191 raeburn 1834: }
1835: }
1836: }
1.1391 raeburn 1837: return ($is_balancer,$currtargets,$currrules,$setcookie,$dom_balancers);
1.1191 raeburn 1838: }
1839:
1.1129 raeburn 1840: sub get_loadbalancer_targets {
1841: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1842: my $offloadto;
1.1175 raeburn 1843: if ($rule_in_effect eq 'none') {
1844: return [$perlvar{'lonHostID'}];
1845: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1846: $offloadto = $currtargets;
1847: } else {
1848: if ($rule_in_effect eq 'homeserver') {
1849: my $homeserver = &homeserver($uname,$udom);
1850: if ($homeserver ne 'no_host') {
1851: $offloadto = [$homeserver];
1852: }
1853: } elsif ($rule_in_effect eq 'externalbalancer') {
1854: my %domconfig =
1.1494 raeburn 1855: &get_dom('configuration',['loadbalancing'],$udom);
1.1129 raeburn 1856: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1857: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1858: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1859: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1860: }
1861: }
1862: } else {
1.1178 raeburn 1863: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1864: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1865: if (&hostname($remotebalancer) ne '') {
1866: $offloadto = [$remotebalancer];
1867: }
1868: }
1869: } elsif (&hostname($rule_in_effect) ne '') {
1870: $offloadto = [$rule_in_effect];
1871: }
1872: }
1873: return $offloadto;
1874: }
1875:
1.1127 raeburn 1876: sub internet_dom_servers {
1877: my ($dom) = @_;
1878: my (%uniqservers,%servers);
1879: my $primaryserver = &hostname(&domain($dom,'primary'));
1880: my @machinedoms = &machine_domains($primaryserver);
1881: foreach my $mdom (@machinedoms) {
1882: my %currservers = %servers;
1883: my %server = &get_servers($mdom);
1884: %servers = (%currservers,%server);
1885: }
1886: my %by_hostname;
1887: foreach my $id (keys(%servers)) {
1888: push(@{$by_hostname{$servers{$id}}},$id);
1889: }
1890: foreach my $hostname (sort(keys(%by_hostname))) {
1891: if (@{$by_hostname{$hostname}} > 1) {
1892: my $match = 0;
1893: foreach my $id (@{$by_hostname{$hostname}}) {
1894: if (&host_domain($id) eq $dom) {
1895: $uniqservers{$id} = $hostname;
1896: $match = 1;
1897: }
1898: }
1899: unless ($match) {
1900: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1901: }
1902: } else {
1903: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1904: }
1905: }
1906: return %uniqservers;
1907: }
1908:
1.1347 raeburn 1909: sub trusted_domains {
1910: my ($cmdtype,$calldom) = @_;
1.1349 raeburn 1911: my ($trusted,$untrusted);
1.1347 raeburn 1912: if (&domain($calldom) eq '') {
1.1349 raeburn 1913: return ($trusted,$untrusted);
1.1347 raeburn 1914: }
1.1395 raeburn 1915: unless ($cmdtype =~ /^(content|shared|enroll|coaurem|othcoau|domroles|catalog|reqcrs|msg)$/) {
1.1349 raeburn 1916: return ($trusted,$untrusted);
1.1347 raeburn 1917: }
1918: my $callprimary = &domain($calldom,'primary');
1.1494 raeburn 1919: my $intcalldom = &internet_dom($callprimary);
1.1347 raeburn 1920: if ($intcalldom eq '') {
1.1349 raeburn 1921: return ($trusted,$untrusted);
1.1347 raeburn 1922: }
1923:
1.1494 raeburn 1924: my ($trustconfig,$cached)=&is_cached_new('trust',$calldom);
1.1347 raeburn 1925: unless (defined($cached)) {
1.1494 raeburn 1926: my %domconfig = &get_dom('configuration',['trust'],$calldom);
1927: &do_cache_new('trust',$calldom,$domconfig{'trust'},3600);
1.1347 raeburn 1928: $trustconfig = $domconfig{'trust'};
1929: }
1930: if (ref($trustconfig)) {
1931: my (%possexc,%possinc,@allexc,@allinc);
1932: if (ref($trustconfig->{$cmdtype}) eq 'HASH') {
1933: if (ref($trustconfig->{$cmdtype}->{'exc'}) eq 'ARRAY') {
1934: map { $possexc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'exc'}};
1935: }
1936: if (ref($trustconfig->{$cmdtype}->{'inc'}) eq 'ARRAY') {
1.1395 raeburn 1937: $possinc{$intcalldom} = 1;
1.1347 raeburn 1938: map { $possinc{$_} = 1; } @{$trustconfig->{$cmdtype}->{'inc'}};
1939: }
1940: }
1941: if (keys(%possexc)) {
1942: if (keys(%possinc)) {
1943: foreach my $key (sort(keys(%possexc))) {
1944: next if ($key eq $intcalldom);
1945: unless ($possinc{$key}) {
1946: push(@allexc,$key);
1947: }
1948: }
1949: } else {
1950: @allexc = sort(keys(%possexc));
1951: }
1952: }
1953: if (keys(%possinc)) {
1954: $possinc{$intcalldom} = 1;
1955: @allinc = sort(keys(%possinc));
1956: }
1957: if ((@allexc > 0) || (@allinc > 0)) {
1958: my %doms_by_intdom;
1959: my %allintdoms = &all_host_intdom();
1960: my %alldoms = &all_host_domain();
1961: foreach my $key (%allintdoms) {
1962: if (ref($doms_by_intdom{$allintdoms{$key}}) eq 'ARRAY') {
1963: unless (grep(/^\Q$alldoms{$key}\E$/,@{$doms_by_intdom{$allintdoms{$key}}})) {
1964: push(@{$doms_by_intdom{$allintdoms{$key}}},$alldoms{$key});
1965: }
1966: } else {
1967: $doms_by_intdom{$allintdoms{$key}} = [$alldoms{$key}];
1968: }
1969: }
1970: foreach my $exc (@allexc) {
1971: if (ref($doms_by_intdom{$exc}) eq 'ARRAY') {
1.1395 raeburn 1972: push(@{$untrusted},@{$doms_by_intdom{$exc}});
1.1347 raeburn 1973: }
1974: }
1975: foreach my $inc (@allinc) {
1976: if (ref($doms_by_intdom{$inc}) eq 'ARRAY') {
1.1395 raeburn 1977: push(@{$trusted},@{$doms_by_intdom{$inc}});
1.1347 raeburn 1978: }
1979: }
1980: }
1981: }
1.1349 raeburn 1982: return ($trusted,$untrusted);
1.1347 raeburn 1983: }
1984:
1985: sub will_trust {
1986: my ($cmdtype,$domain,$possdom) = @_;
1987: return 1 if ($domain eq $possdom);
1988: my ($trustedref,$untrustedref) = &trusted_domains($cmdtype,$possdom);
1989: my $willtrust;
1990: if ((ref($trustedref) eq 'ARRAY') && (@{$trustedref} > 0)) {
1991: if (grep(/^\Q$domain\E$/,@{$trustedref})) {
1992: $willtrust = 1;
1993: }
1994: } elsif ((ref($untrustedref) eq 'ARRAY') && (@{$untrustedref} > 0)) {
1995: unless (grep(/^\Q$domain\E$/,@{$untrustedref})) {
1996: $willtrust = 1;
1997: }
1998: } else {
1999: $willtrust = 1;
2000: }
2001: return $willtrust;
2002: }
2003:
1.1 albertel 2004: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 2005:
1.599 albertel 2006: my %homecache;
1.1 albertel 2007: sub homeserver {
1.230 stredwic 2008: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 2009: my $index="$uname:$udom";
1.426 albertel 2010:
1.599 albertel 2011: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 2012:
2013: my %servers = &get_servers($udom,'library');
2014: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 2015: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 2016: exists($badServerCache{$tryserver}));
1.841 albertel 2017:
2018: my $answer=reply("home:$udom:$uname",$tryserver);
2019: if ($answer eq 'found') {
2020: delete($badServerCache{$tryserver});
2021: return $homecache{$index}=$tryserver;
2022: } elsif ($answer eq 'no_host') {
2023: $badServerCache{$tryserver}=1;
2024: }
1.1 albertel 2025: }
2026: return 'no_host';
1.70 www 2027: }
2028:
1.1300 raeburn 2029: # ----- Find the usernames behind a list of student/employee IDs or clicker IDs
1.70 www 2030:
2031: sub idget {
1.1300 raeburn 2032: my ($udom,$idsref,$namespace)=@_;
1.70 www 2033: my %returnhash=();
1.1300 raeburn 2034: my @ids=();
2035: if (ref($idsref) eq 'ARRAY') {
2036: @ids = @{$idsref};
2037: } else {
2038: return %returnhash;
2039: }
2040: if ($namespace eq '') {
2041: $namespace = 'ids';
2042: }
1.70 www 2043:
1.841 albertel 2044: my %servers = &get_servers($udom,'library');
2045: foreach my $tryserver (keys(%servers)) {
1.1299 raeburn 2046: my $idlist=join('&', map { &escape($_); } @ids);
1.1300 raeburn 2047: if ($namespace eq 'ids') {
2048: $idlist=~tr/A-Z/a-z/;
2049: }
2050: my $reply;
2051: if ($namespace eq 'ids') {
2052: $reply=&reply("idget:$udom:".$idlist,$tryserver);
2053: } else {
2054: $reply=&reply("getdom:$udom:$namespace:$idlist",$tryserver);
2055: }
1.841 albertel 2056: my @answer=();
2057: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
2058: @answer=split(/\&/,$reply);
2059: } ;
2060: my $i;
2061: for ($i=0;$i<=$#ids;$i++) {
2062: if ($answer[$i]) {
1.1299 raeburn 2063: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1.1300 raeburn 2064: }
1.841 albertel 2065: }
1.1300 raeburn 2066: }
1.70 www 2067: return %returnhash;
2068: }
2069:
2070: # ------------------------------------- Find the IDs behind a list of usernames
2071:
2072: sub idrget {
2073: my ($udom,@unames)=@_;
2074: my %returnhash=();
1.800 albertel 2075: foreach my $uname (@unames) {
2076: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 2077: }
1.70 www 2078: return %returnhash;
2079: }
2080:
1.1300 raeburn 2081: # Store away a list of names and associated student/employee IDs or clicker IDs
1.70 www 2082:
2083: sub idput {
1.1300 raeburn 2084: my ($udom,$idsref,$uhom,$namespace)=@_;
1.70 www 2085: my %servers=();
1.1300 raeburn 2086: my %ids=();
2087: my %byid = ();
2088: if (ref($idsref) eq 'HASH') {
2089: %ids=%{$idsref};
2090: }
2091: if ($namespace eq '') {
2092: $namespace = 'ids';
2093: }
1.800 albertel 2094: foreach my $uname (keys(%ids)) {
2095: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1.1300 raeburn 2096: if ($uhom eq '') {
2097: $uhom=&homeserver($uname,$udom);
2098: }
1.70 www 2099: if ($uhom ne 'no_host') {
1.800 albertel 2100: my $esc_unam=&escape($uname);
1.1300 raeburn 2101: if ($namespace eq 'ids') {
2102: my $id=&escape($ids{$uname});
2103: $id=~tr/A-Z/a-z/;
2104: my $esc_unam=&escape($uname);
2105: $servers{$uhom}.=$id.'='.$esc_unam.'&';
1.70 www 2106: } else {
1.1300 raeburn 2107: my @currids = split(/,/,$ids{$uname});
2108: foreach my $id (@currids) {
2109: $byid{$uhom}{$id} .= $uname.',';
2110: }
2111: }
2112: }
2113: }
2114: if ($namespace eq 'clickers') {
2115: foreach my $server (keys(%byid)) {
2116: if (ref($byid{$server}) eq 'HASH') {
2117: foreach my $id (keys(%{$byid{$server}})) {
2118: $byid{$server} =~ s/,$//;
2119: $servers{$uhom}.=&escape($id).'='.&escape($byid{$server}).'&';
2120: }
1.70 www 2121: }
2122: }
1.191 harris41 2123: }
1.800 albertel 2124: foreach my $server (keys(%servers)) {
1.1300 raeburn 2125: $servers{$server} =~ s/\&$//;
2126: if ($namespace eq 'ids') {
2127: &critical('idput:'.$udom.':'.$servers{$server},$server);
2128: } else {
2129: &critical('updateclickers:'.$udom.':add:'.$servers{$server},$server);
2130: }
1.191 harris41 2131: }
1.344 www 2132: }
2133:
1.1300 raeburn 2134: # ------------- Delete unwanted student/employee IDs or clicker IDs from domain
1.1231 raeburn 2135:
2136: sub iddel {
1.1300 raeburn 2137: my ($udom,$idshashref,$uhome,$namespace)=@_;
1.1231 raeburn 2138: my %result=();
1.1300 raeburn 2139: my %ids=();
2140: my %byid = ();
2141: if (ref($idshashref) eq 'HASH') {
2142: %ids=%{$idshashref};
2143: } else {
1.1231 raeburn 2144: return %result;
2145: }
1.1300 raeburn 2146: if ($namespace eq '') {
2147: $namespace = 'ids';
2148: }
1.1231 raeburn 2149: my %servers=();
1.1300 raeburn 2150: while (my ($id,$unamestr) = each(%ids)) {
2151: if ($namespace eq 'ids') {
2152: my $uhom = $uhome;
2153: if ($uhom eq '') {
2154: $uhom=&homeserver($unamestr,$udom);
2155: }
2156: if ($uhom ne 'no_host') {
2157: $servers{$uhom}.='&'.&escape($id);
2158: }
2159: } else {
2160: my @curritems = split(/,/,$ids{$id});
2161: foreach my $uname (@curritems) {
2162: my $uhom = $uhome;
2163: if ($uhom eq '') {
2164: $uhom=&homeserver($uname,$udom);
2165: }
2166: if ($uhom ne 'no_host') {
2167: $byid{$uhom}{$id} .= $uname.',';
2168: }
2169: }
1.1231 raeburn 2170: }
1.1300 raeburn 2171: }
2172: if ($namespace eq 'clickers') {
2173: foreach my $server (keys(%byid)) {
2174: if (ref($byid{$server}) eq 'HASH') {
2175: foreach my $id (keys(%{$byid{$server}})) {
2176: $byid{$server}{$id} =~ s/,$//;
2177: $servers{$server}.=&escape($id).'='.&escape($byid{$server}{$id}).'&';
2178: }
1.1231 raeburn 2179: }
2180: }
2181: }
2182: foreach my $server (keys(%servers)) {
1.1300 raeburn 2183: $servers{$server} =~ s/\&$//;
2184: if ($namespace eq 'ids') {
2185: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
2186: } elsif ($namespace eq 'clickers') {
2187: $result{$server} = &critical('updateclickers:'.$udom.':del:'.$servers{$server},$server);
2188: }
1.1231 raeburn 2189: }
2190: return %result;
2191: }
2192:
1.1300 raeburn 2193: # ----- Update clicker ID-to-username look-ups in clickers.db on library server
2194:
2195: sub updateclickers {
2196: my ($udom,$action,$idshashref,$uhome,$critical) = @_;
2197: my %clickers;
2198: if (ref($idshashref) eq 'HASH') {
2199: %clickers=%{$idshashref};
2200: } else {
2201: return;
2202: }
2203: my $items='';
2204: foreach my $item (keys(%clickers)) {
2205: $items.=&escape($item).'='.&escape($clickers{$item}).'&';
2206: }
2207: $items=~s/\&$//;
2208: my $request = "updateclickers:$udom:$action:$items";
2209: if ($critical) {
2210: return &critical($request,$uhome);
2211: } else {
2212: return &reply($request,$uhome);
2213: }
2214: }
2215:
1.1023 raeburn 2216: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 2217: sub dump_dom {
1.1165 droeschl 2218: my ($namespace, $udom, $regexp) = @_;
2219:
2220: $udom ||= $env{'user.domain'};
2221:
2222: return () unless $udom;
2223:
2224: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 2225: }
2226:
1.1023 raeburn 2227: # ------------------------------------------ get items from domain db files
1.806 raeburn 2228:
2229: sub get_dom {
1.1462 raeburn 2230: my ($namespace,$storearr,$udom,$uhome,$encrypt)=@_;
1.1267 raeburn 2231: return if ($udom eq 'public');
1.806 raeburn 2232: my $items='';
2233: foreach my $item (@$storearr) {
2234: $items.=&escape($item).'&';
2235: }
2236: $items=~s/\&$//;
1.860 raeburn 2237: if (!$udom) {
2238: $udom=$env{'user.domain'};
1.1267 raeburn 2239: return if ($udom eq 'public');
1.860 raeburn 2240: if (defined(&domain($udom,'primary'))) {
2241: $uhome=&domain($udom,'primary');
2242: } else {
1.874 albertel 2243: undef($uhome);
1.860 raeburn 2244: }
2245: } else {
2246: if (!$uhome) {
2247: if (defined(&domain($udom,'primary'))) {
2248: $uhome=&domain($udom,'primary');
2249: }
2250: }
2251: }
2252: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.1344 raeburn 2253: my $rep;
1.1442 raeburn 2254: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
2255: # domain information is hosted on this machine
1.1462 raeburn 2256: $rep = &LONCAPA::Lond::get_dom("getdom:$udom:$namespace:$items");
1.1344 raeburn 2257: } else {
1.1462 raeburn 2258: if ($encrypt) {
1.1442 raeburn 2259: $rep=&reply("encrypt:egetdom:$udom:$namespace:$items",$uhome);
2260: } else {
2261: $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
2262: }
1.1344 raeburn 2263: }
1.866 raeburn 2264: my %returnhash;
1.875 albertel 2265: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 2266: return %returnhash;
2267: }
1.806 raeburn 2268: my @pairs=split(/\&/,$rep);
2269: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
2270: return @pairs;
2271: }
2272: my $i=0;
2273: foreach my $item (@$storearr) {
2274: $returnhash{$item}=&thaw_unescape($pairs[$i]);
2275: $i++;
2276: }
2277: return %returnhash;
2278: } else {
1.880 banghart 2279: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 2280: }
2281: }
2282:
2283: # -------------------------------------------- put items in domain db files
2284:
2285: sub put_dom {
1.1462 raeburn 2286: my ($namespace,$storehash,$udom,$uhome,$encrypt)=@_;
1.860 raeburn 2287: if (!$udom) {
2288: $udom=$env{'user.domain'};
2289: if (defined(&domain($udom,'primary'))) {
2290: $uhome=&domain($udom,'primary');
2291: } else {
1.874 albertel 2292: undef($uhome);
1.860 raeburn 2293: }
2294: } else {
2295: if (!$uhome) {
2296: if (defined(&domain($udom,'primary'))) {
2297: $uhome=&domain($udom,'primary');
2298: }
2299: }
2300: }
2301: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 2302: my $items='';
2303: foreach my $item (keys(%$storehash)) {
2304: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
2305: }
2306: $items=~s/\&$//;
1.1462 raeburn 2307: if ($encrypt) {
1.1344 raeburn 2308: return &reply("encrypt:putdom:$udom:$namespace:$items",$uhome);
2309: } else {
2310: return &reply("putdom:$udom:$namespace:$items",$uhome);
2311: }
1.806 raeburn 2312: } else {
1.860 raeburn 2313: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 2314: }
2315: }
2316:
1.1023 raeburn 2317: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 2318: sub newput_dom {
1.1023 raeburn 2319: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 2320: my $result;
2321: if (!$udom) {
2322: $udom=$env{'user.domain'};
2323: }
1.1023 raeburn 2324: if ($udom) {
2325: my $uname = &get_domainconfiguser($udom);
2326: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 2327: }
2328: return $result;
2329: }
2330:
1.1023 raeburn 2331: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 2332: sub del_dom {
1.1023 raeburn 2333: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 2334: if (ref($storearr) eq 'ARRAY') {
2335: if (!$udom) {
2336: $udom=$env{'user.domain'};
2337: }
1.1023 raeburn 2338: if ($udom) {
2339: my $uname = &get_domainconfiguser($udom);
2340: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 2341: }
2342: }
2343: }
2344:
1.1481 raeburn 2345: sub store_dom {
1.1482 raeburn 2346: my ($storehash,$id,$namespace,$dom,$home,$encrypt) = @_;
1.1481 raeburn 2347: $$storehash{'ip'}=&get_requestor_ip();
2348: $$storehash{'host'}=$perlvar{'lonHostID'};
2349: my $namevalue='';
2350: foreach my $key (keys(%{$storehash})) {
2351: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
2352: }
2353: $namevalue=~s/\&$//;
2354: if (grep { $_ eq $home } current_machine_ids()) {
2355: return LONCAPA::Lond::store_dom("storedom:$dom:$namespace:$id:$namevalue");
2356: } else {
2357: if ($namespace eq 'private') {
2358: return 'refused';
1.1482 raeburn 2359: } elsif ($encrypt) {
2360: return reply("encrypt:storedom:$dom:$namespace:$id:$namevalue",$home);
1.1481 raeburn 2361: } else {
1.1482 raeburn 2362: return reply("storedom:$dom:$namespace:$id:$namevalue",$home);
1.1481 raeburn 2363: }
2364: }
2365: }
2366:
1.1482 raeburn 2367: sub restore_dom {
2368: my ($id,$namespace,$dom,$home,$encrypt) = @_;
2369: my $answer;
2370: if (grep { $_ eq $home } current_machine_ids()) {
2371: $answer = LONCAPA::Lond::restore_dom("restoredom:$dom:$namespace:$id");
2372: } elsif ($namespace ne 'private') {
2373: if ($encrypt) {
2374: $answer=&reply("encrypt:restoredom:$dom:$namespace:$id",$home);
2375: } else {
2376: $answer=&reply("restoredom:$dom:$namespace:$id",$home);
2377: }
2378: }
2379: my %returnhash=();
2380: unless (($answer eq '') || ($answer eq 'con_lost') || ($answer eq 'refused') ||
2381: ($answer eq 'unknown_cmd') || ($answer eq 'rejected')) {
2382: foreach my $line (split(/\&/,$answer)) {
2383: my ($name,$value)=split(/\=/,$line);
2384: $returnhash{&unescape($name)}=&thaw_unescape($value);
2385: }
2386: my $version;
2387: for ($version=1;$version<=$returnhash{'version'};$version++) {
2388: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
2389: $returnhash{$item}=$returnhash{$version.':'.$item};
2390: }
2391: }
2392: }
2393: return %returnhash;
2394: }
2395:
1.1023 raeburn 2396: # ----------------------------------construct domainconfig user for a domain
2397: sub get_domainconfiguser {
2398: my ($udom) = @_;
2399: return $udom.'-domainconfig';
2400: }
2401:
1.837 raeburn 2402: sub retrieve_inst_usertypes {
2403: my ($udom) = @_;
2404: my (%returnhash,@order);
1.1494 raeburn 2405: my %domdefs = &get_domain_defaults($udom);
1.989 raeburn 2406: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
2407: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256 raeburn 2408: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 2409: } else {
2410: if (defined(&domain($udom,'primary'))) {
2411: my $uhome=&domain($udom,'primary');
2412: my $rep=&reply("inst_usertypes:$udom",$uhome);
2413: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1256 raeburn 2414: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 2415: return (\%returnhash,\@order);
2416: }
2417: my ($hashitems,$orderitems) = split(/:/,$rep);
2418: my @pairs=split(/\&/,$hashitems);
2419: foreach my $item (@pairs) {
2420: my ($key,$value)=split(/=/,$item,2);
2421: $key = &unescape($key);
2422: next if ($key =~ /^error: 2 /);
2423: $returnhash{$key}=&thaw_unescape($value);
2424: }
2425: my @esc_order = split(/\&/,$orderitems);
2426: foreach my $item (@esc_order) {
2427: push(@order,&unescape($item));
2428: }
2429: } else {
1.1256 raeburn 2430: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 2431: }
1.1256 raeburn 2432: return (\%returnhash,\@order);
1.837 raeburn 2433: }
2434: }
2435:
1.868 raeburn 2436: sub is_domainimage {
2437: my ($url) = @_;
1.1468 raeburn 2438: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo|login)/+[^/]-) {
1.868 raeburn 2439: if (&domain($1) ne '') {
2440: return '1';
2441: }
2442: }
2443: return;
2444: }
2445:
1.899 raeburn 2446: sub inst_directory_query {
2447: my ($srch) = @_;
2448: my $udom = $srch->{'srchdomain'};
2449: my %results;
2450: my $homeserver = &domain($udom,'primary');
1.909 raeburn 2451: my $outcome;
1.899 raeburn 2452: if ($homeserver ne '') {
1.1357 raeburn 2453: unless ($homeserver eq $perlvar{'lonHostID'}) {
2454: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2455: my $lcrev = &get_server_loncaparev($udom,$homeserver);
1.1357 raeburn 2456: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2457: if (($major eq '' && $minor eq '') || ($major < 2) ||
2458: (($major == 2) && ($minor < 12))) {
2459: return;
2460: }
2461: }
2462: }
1.904 albertel 2463: my $queryid=&reply("querysend:instdirsearch:".
2464: &escape($srch->{'srchby'}).':'.
2465: &escape($srch->{'srchterm'}).':'.
2466: &escape($srch->{'srchtype'}),$homeserver);
2467: my $host=&hostname($homeserver);
2468: if ($queryid !~/^\Q$host\E\_/) {
1.1343 raeburn 2469: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.' in domain '.$udom);
1.904 albertel 2470: return;
2471: }
2472: my $response = &get_query_reply($queryid);
2473: my $maxtries = 5;
2474: my $tries = 1;
2475: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2476: $response = &get_query_reply($queryid);
2477: $tries ++;
2478: }
2479:
2480: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 2481: if ($response eq 'unavailable') {
2482: $outcome = $response;
2483: } else {
2484: $outcome = 'ok';
2485: my @matches = split(/\n/,$response);
2486: foreach my $match (@matches) {
2487: my ($key,$value) = split(/=/,$match);
2488: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
2489: }
1.899 raeburn 2490: }
2491: }
2492: }
1.909 raeburn 2493: return ($outcome,%results);
1.899 raeburn 2494: }
2495:
2496: sub usersearch {
2497: my ($srch) = @_;
2498: my $dom = $srch->{'srchdomain'};
2499: my %results;
2500: my %libserv = &all_library();
2501: my $query = 'usersearch';
2502: foreach my $tryserver (keys(%libserv)) {
2503: if (&host_domain($tryserver) eq $dom) {
1.1357 raeburn 2504: unless ($tryserver eq $perlvar{'lonHostID'}) {
2505: if ($srch->{'srchby'} eq 'email') {
1.1417 raeburn 2506: my $lcrev = &get_server_loncaparev($dom,$tryserver);
1.1357 raeburn 2507: my ($major,$minor) = ($lcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
2508: next if (($major eq '' && $minor eq '') || ($major < 2) ||
2509: (($major == 2) && ($minor < 12)));
2510: }
2511: }
1.899 raeburn 2512: my $host=&hostname($tryserver);
2513: my $queryid=
1.911 raeburn 2514: &reply("querysend:".&escape($query).':'.
2515: &escape($srch->{'srchby'}).':'.
1.899 raeburn 2516: &escape($srch->{'srchtype'}).':'.
2517: &escape($srch->{'srchterm'}),$tryserver);
2518: if ($queryid !~/^\Q$host\E\_/) {
2519: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 2520: next;
1.899 raeburn 2521: }
2522: my $reply = &get_query_reply($queryid);
2523: my $maxtries = 1;
2524: my $tries = 1;
2525: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
2526: $reply = &get_query_reply($queryid);
2527: $tries ++;
2528: }
2529: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
2530: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
2531: } else {
1.911 raeburn 2532: my @matches;
2533: if ($reply =~ /\n/) {
2534: @matches = split(/\n/,$reply);
2535: } else {
2536: @matches = split(/\&/,$reply);
2537: }
1.899 raeburn 2538: foreach my $match (@matches) {
2539: my ($uname,$udom,%userhash);
1.911 raeburn 2540: foreach my $entry (split(/:/,$match)) {
2541: my ($key,$value) =
2542: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 2543: $userhash{$key} = $value;
2544: if ($key eq 'username') {
2545: $uname = $value;
2546: } elsif ($key eq 'domain') {
2547: $udom = $value;
1.911 raeburn 2548: }
1.899 raeburn 2549: }
2550: $results{$uname.':'.$udom} = \%userhash;
2551: }
2552: }
2553: }
2554: }
2555: return %results;
2556: }
2557:
1.912 raeburn 2558: sub get_instuser {
2559: my ($udom,$uname,$id) = @_;
2560: my $homeserver = &domain($udom,'primary');
2561: my ($outcome,%results);
2562: if ($homeserver ne '') {
2563: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
2564: &escape($id).':'.&escape($udom),$homeserver);
2565: my $host=&hostname($homeserver);
2566: if ($queryid !~/^\Q$host\E\_/) {
2567: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
2568: return;
2569: }
2570: my $response = &get_query_reply($queryid);
2571: my $maxtries = 5;
2572: my $tries = 1;
2573: while (($response=~/^timeout/) && ($tries < $maxtries)) {
2574: $response = &get_query_reply($queryid);
2575: $tries ++;
2576: }
2577: if (!&error($response) && $response ne 'refused') {
2578: if ($response eq 'unavailable') {
2579: $outcome = $response;
2580: } else {
2581: $outcome = 'ok';
2582: my @matches = split(/\n/,$response);
2583: foreach my $match (@matches) {
2584: my ($key,$value) = split(/=/,$match);
2585: $results{&unescape($key)} = &thaw_unescape($value);
2586: }
2587: }
2588: }
2589: }
2590: my %userinfo;
2591: if (ref($results{$uname}) eq 'HASH') {
2592: %userinfo = %{$results{$uname}};
2593: }
2594: return ($outcome,%userinfo);
2595: }
2596:
1.1290 raeburn 2597: sub get_multiple_instusers {
2598: my ($udom,$users,$caller) = @_;
2599: my ($outcome,$results);
2600: if (ref($users) eq 'HASH') {
2601: my $count = keys(%{$users});
2602: my $requested = &freeze_escape($users);
2603: my $homeserver = &domain($udom,'primary');
2604: if ($homeserver ne '') {
2605: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
2606: my $host=&hostname($homeserver);
2607: if ($queryid !~/^\Q$host\E\_/) {
2608: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
2609: ' for host: '.$homeserver.'in domain '.$udom);
2610: return ($outcome,$results);
2611: }
2612: my $response = &get_query_reply($queryid);
2613: my $maxtries = 5;
2614: if ($count > 100) {
2615: $maxtries = 1+int($count/20);
2616: }
2617: my $tries = 1;
2618: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
2619: $response = &get_query_reply($queryid);
2620: $tries ++;
2621: }
2622: if ($response eq '') {
2623: $results = {};
2624: foreach my $key (keys(%{$users})) {
2625: my ($uname,$id);
2626: if ($caller eq 'id') {
2627: $id = $key;
2628: } else {
2629: $uname = $key;
2630: }
2631: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1.1291 raeburn 2632: $outcome = $resp;
1.1290 raeburn 2633: if ($resp eq 'ok') {
2634: %{$results} = (%{$results}, %info);
2635: } else {
2636: last;
2637: }
2638: }
2639: } elsif(!&error($response) && ($response ne 'refused')) {
2640: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
2641: $outcome = $response;
2642: } else {
1.1291 raeburn 2643: ($outcome,my $userdata) = split(/=/,$response,2);
1.1290 raeburn 2644: if ($outcome eq 'ok') {
2645: $results = &thaw_unescape($userdata);
2646: }
2647: }
2648: }
2649: }
2650: }
2651: return ($outcome,$results);
2652: }
2653:
1.912 raeburn 2654: sub inst_rulecheck {
1.923 raeburn 2655: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 2656: my %returnhash;
2657: if ($udom ne '') {
2658: if (ref($rules) eq 'ARRAY') {
2659: @{$rules} = map {&escape($_);} (@{$rules});
2660: my $rulestr = join(':',@{$rules});
2661: my $homeserver=&domain($udom,'primary');
2662: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2663: my $response;
2664: if ($item eq 'username') {
2665: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2666: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2667: $homeserver));
1.923 raeburn 2668: } elsif ($item eq 'id') {
2669: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2670: ':'.&escape($id).':'.$rulestr,
2671: $homeserver));
1.945 raeburn 2672: } elsif ($item eq 'selfcreate') {
2673: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2674: &escape($udom).':'.&escape($uname).
2675: ':'.$rulestr,$homeserver));
1.1484 raeburn 2676: } elsif ($item eq 'unamemap') {
2677: $response=&unescape(&reply('instunamemapcheck:'.
2678: &escape($udom).':'.&escape($uname).
2679: ':'.$rulestr,$homeserver));
1.923 raeburn 2680: }
1.912 raeburn 2681: if ($response ne 'refused') {
2682: my @pairs=split(/\&/,$response);
2683: foreach my $item (@pairs) {
2684: my ($key,$value)=split(/=/,$item,2);
2685: $key = &unescape($key);
2686: next if ($key =~ /^error: 2 /);
2687: $returnhash{$key}=&thaw_unescape($value);
2688: }
2689: }
2690: }
2691: }
2692: }
2693: return %returnhash;
2694: }
2695:
2696: sub inst_userrules {
1.923 raeburn 2697: my ($udom,$check) = @_;
1.912 raeburn 2698: my (%ruleshash,@ruleorder);
2699: if ($udom ne '') {
2700: my $homeserver=&domain($udom,'primary');
2701: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2702: my $response;
2703: if ($check eq 'id') {
2704: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2705: $homeserver);
1.943 raeburn 2706: } elsif ($check eq 'email') {
2707: $response=&reply('instemailrules:'.&escape($udom),
2708: $homeserver);
1.1484 raeburn 2709: } elsif ($check eq 'unamemap') {
2710: $response=&reply('unamemaprules:'.&escape($udom),
2711: $homeserver);
1.923 raeburn 2712: } else {
2713: $response=&reply('instuserrules:'.&escape($udom),
2714: $homeserver);
2715: }
1.912 raeburn 2716: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2717: ($response ne 'unknown_cmd') &&
1.912 raeburn 2718: ($response ne 'no_such_host')) {
2719: my ($hashitems,$orderitems) = split(/:/,$response);
2720: my @pairs=split(/\&/,$hashitems);
2721: foreach my $item (@pairs) {
2722: my ($key,$value)=split(/=/,$item,2);
2723: $key = &unescape($key);
2724: next if ($key =~ /^error: 2 /);
2725: $ruleshash{$key}=&thaw_unescape($value);
2726: }
2727: my @esc_order = split(/\&/,$orderitems);
2728: foreach my $item (@esc_order) {
2729: push(@ruleorder,&unescape($item));
2730: }
2731: }
2732: }
2733: }
2734: return (\%ruleshash,\@ruleorder);
2735: }
2736:
1.976 raeburn 2737: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2738:
2739: sub get_domain_defaults {
1.1240 raeburn 2740: my ($domain,$ignore_cache) = @_;
1.1242 raeburn 2741: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2742: my $cachetime = 60*60*24;
1.1240 raeburn 2743: unless ($ignore_cache) {
2744: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2745: if (defined($cached)) {
2746: if (ref($result) eq 'HASH') {
2747: return %{$result};
2748: }
1.943 raeburn 2749: }
2750: }
2751: my %domdefaults;
2752: my %domconfig =
1.1494 raeburn 2753: &get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2754: 'requestcourses','inststatus',
1.1183 raeburn 2755: 'coursedefaults','usersessions',
1.1517 raeburn 2756: 'requestauthor','authordefaults',
2757: 'selfenrollment','coursecategories',
2758: 'ssl','autoenroll','trust',
2759: 'helpsettings','wafproxy',
1.1520 raeburn 2760: 'ltisec','toolsec','privacy'],$domain);
1.1305 raeburn 2761: my @coursetypes = ('official','unofficial','community','textbook','placement');
1.943 raeburn 2762: if (ref($domconfig{'defaults'}) eq 'HASH') {
2763: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2764: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2765: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2766: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2767: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2768: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.1492 raeburn 2769: $domdefaults{'portal_def_email'} = $domconfig{'defaults'}{'portal_def_email'};
2770: $domdefaults{'portal_def_web'} = $domconfig{'defaults'}{'portal_def_web'};
1.1340 raeburn 2771: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2772: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2773: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.1484 raeburn 2774: $domdefaults{'unamemap_rule'} = $domconfig{'defaults'}{'unamemap_rule'};
1.943 raeburn 2775: } else {
2776: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2777: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2778: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2779: }
1.976 raeburn 2780: if (ref($domconfig{'quotas'}) eq 'HASH') {
2781: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2782: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2783: } else {
2784: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2785: }
1.1521 raeburn 2786: my @usertools = ('aboutme','blog','webdav','portfolio','portaccess');
1.976 raeburn 2787: foreach my $item (@usertools) {
2788: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2789: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2790: }
2791: }
1.1229 raeburn 2792: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2793: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2794: }
1.976 raeburn 2795: }
1.985 raeburn 2796: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1305 raeburn 2797: foreach my $item ('official','unofficial','community','textbook','placement') {
1.985 raeburn 2798: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2799: }
2800: }
1.1183 raeburn 2801: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2802: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2803: }
1.1517 raeburn 2804: if (ref($domconfig{'authordefaults'}) eq 'HASH') {
2805: foreach my $item ('nocodemirror','copyright','sourceavail','domcoordacc','editors') {
2806: if ($item eq 'editors') {
2807: if (ref($domconfig{'authordefaults'}{'editors'}) eq 'ARRAY') {
2808: $domdefaults{$item} = join(',',@{$domconfig{'authordefaults'}{'editors'}});
2809: }
2810: } else {
2811: $domdefaults{$item} = $domconfig{'authordefaults'}{$item};
2812: }
2813: }
2814: }
1.989 raeburn 2815: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256 raeburn 2816: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2817: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2818: }
2819: }
1.1047 raeburn 2820: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2821: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277 raeburn 2822: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
1.1476 raeburn 2823: $domdefaults{'inline_chem'} = $domconfig{'coursedefaults'}{'inline_chem'};
1.1277 raeburn 2824: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2825: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2826: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2827: }
1.1254 raeburn 2828: foreach my $type (@coursetypes) {
2829: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2830: unless ($type eq 'community') {
2831: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2832: }
2833: }
2834: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2835: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2836: }
1.1514 raeburn 2837: if (ref($domconfig{'coursedefaults'}{'coursequota'}) eq 'HASH') {
2838: $domdefaults{$type.'coursequota'} = $domconfig{'coursedefaults'}{'coursequota'}{$type};
2839: }
1.1277 raeburn 2840: if ($domdefaults{'postsubmit'} eq 'on') {
2841: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2842: $domdefaults{$type.'postsubtimeout'} =
2843: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2844: }
2845: }
1.1508 raeburn 2846: if (ref($domconfig{'coursedefaults'}{'domexttool'}) eq 'HASH') {
2847: $domdefaults{$type.'domexttool'} = $domconfig{'coursedefaults'}{'domexttool'}{$type};
2848: } else {
2849: $domdefaults{$type.'domexttool'} = 1;
2850: }
2851: if (ref($domconfig{'coursedefaults'}{'exttool'}) eq 'HASH') {
2852: $domdefaults{$type.'exttool'} = $domconfig{'coursedefaults'}{'exttool'}{$type};
2853: } else {
2854: $domdefaults{$type.'exttool'} = 0;
2855: }
1.1520 raeburn 2856: if (ref($domconfig{'coursedefaults'}{'crsauthor'}) eq 'HASH') {
2857: $domdefaults{$type.'crsauthor'} = $domconfig{'coursedefaults'}{'crsauthor'}{$type};
2858: } else {
2859: $domdefaults{$type.'crsauthor'} = 1;
2860: }
1.1525 raeburn 2861: if (ref($domconfig{'coursedefaults'}{'crseditors'}) eq 'ARRAY') {
2862: $domdefaults{'crseditors'}=join(',',@{$domconfig{'coursedefaults'}{'crseditors'}});
2863: }
1.1230 raeburn 2864: }
1.1286 raeburn 2865: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2866: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2867: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2868: if (@clonecodes) {
2869: $domdefaults{'canclone'} = join('+',@clonecodes);
2870: }
2871: }
2872: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2873: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2874: }
1.1356 raeburn 2875: if ($domconfig{'coursedefaults'}{'texengine'}) {
2876: $domdefaults{'texengine'} = $domconfig{'coursedefaults'}{'texengine'};
1.1480 raeburn 2877: }
2878: if (exists($domconfig{'coursedefaults'}{'ltiauth'})) {
2879: $domdefaults{'crsltiauth'} = $domconfig{'coursedefaults'}{'ltiauth'};
2880: }
1.1047 raeburn 2881: }
1.1073 raeburn 2882: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2883: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2884: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2885: }
2886: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2887: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2888: }
1.1279 raeburn 2889: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2890: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2891: }
1.1440 raeburn 2892: if (ref($domconfig{'usersessions'}{'offloadoth'}) eq 'HASH') {
1.1439 raeburn 2893: $domdefaults{'offloadoth'} = $domconfig{'usersessions'}{'offloadoth'};
2894: }
1.1073 raeburn 2895: }
1.1254 raeburn 2896: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2897: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2898: my @settings = ('types','registered','enroll_dates','access_dates','section',
2899: 'approval','limit');
2900: foreach my $type (@coursetypes) {
2901: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2902: my @mgrdc = ();
2903: foreach my $item (@settings) {
2904: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2905: push(@mgrdc,$item);
2906: }
2907: }
2908: if (@mgrdc) {
2909: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2910: }
2911: }
2912: }
2913: }
2914: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2915: foreach my $type (@coursetypes) {
2916: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2917: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2918: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2919: }
2920: }
2921: }
2922: }
2923: }
1.1258 raeburn 2924: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2925: $domdefaults{'catauth'} = 'std';
2926: $domdefaults{'catunauth'} = 'std';
1.1413 raeburn 2927: if ($domconfig{'coursecategories'}{'auth'}) {
1.1258 raeburn 2928: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2929: }
2930: if ($domconfig{'coursecategories'}{'unauth'}) {
2931: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2932: }
2933: }
1.1315 raeburn 2934: if (ref($domconfig{'ssl'}) eq 'HASH') {
2935: if (ref($domconfig{'ssl'}{'replication'}) eq 'HASH') {
2936: $domdefaults{'replication'} = $domconfig{'ssl'}{'replication'};
2937: }
1.1338 raeburn 2938: if (ref($domconfig{'ssl'}{'connto'}) eq 'HASH') {
2939: $domdefaults{'connect'} = $domconfig{'ssl'}{'connto'};
2940: }
2941: if (ref($domconfig{'ssl'}{'connfrom'}) eq 'HASH') {
2942: $domdefaults{'connect'} = $domconfig{'ssl'}{'connfrom'};
1.1315 raeburn 2943: }
2944: }
1.1320 raeburn 2945: if (ref($domconfig{'trust'}) eq 'HASH') {
2946: my @prefixes = qw(content shared enroll othcoau coaurem domroles catalog reqcrs msg);
2947: foreach my $prefix (@prefixes) {
2948: if (ref($domconfig{'trust'}{$prefix}) eq 'HASH') {
2949: $domdefaults{'trust'.$prefix} = $domconfig{'trust'}{$prefix};
2950: }
2951: }
2952: }
1.1314 raeburn 2953: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2954: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
1.1477 raeburn 2955: $domdefaults{'failsafe'} = $domconfig{'autoenroll'}{'failsafe'};
1.1314 raeburn 2956: }
1.1332 raeburn 2957: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2958: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2959: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2960: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2961: }
2962: }
1.1434 raeburn 2963: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
1.1449 raeburn 2964: foreach my $item ('ipheader','trusted','vpnint','vpnext','sslopt') {
1.1434 raeburn 2965: if ($domconfig{'wafproxy'}{$item}) {
2966: $domdefaults{'waf_'.$item} = $domconfig{'wafproxy'}{$item};
2967: }
2968: }
1.1482 raeburn 2969: }
2970: if (ref($domconfig{'ltisec'}) eq 'HASH') {
2971: if (ref($domconfig{'ltisec'}{'encrypt'}) eq 'HASH') {
2972: $domdefaults{'linkprotenc_crs'} = $domconfig{'ltisec'}{'encrypt'}{'crs'};
2973: $domdefaults{'linkprotenc_dom'} = $domconfig{'ltisec'}{'encrypt'}{'dom'};
2974: $domdefaults{'ltienc_consumers'} = $domconfig{'ltisec'}{'encrypt'}{'consumers'};
2975: }
2976: if (ref($domconfig{'ltisec'}{'private'}) eq 'HASH') {
2977: if (ref($domconfig{'ltisec'}{'private'}{'keys'}) eq 'ARRAY') {
1.1504 raeburn 2978: $domdefaults{'ltiprivhosts'} = $domconfig{'ltisec'}{'private'}{'keys'};
2979: }
2980: }
1.1523 raeburn 2981: if (ref($domconfig{'ltisec'}{'suggested'}) eq 'HASH') {
2982: my %suggestions = %{$domconfig{'ltisec'}{'suggested'}};
2983: foreach my $item (keys(%{$domconfig{'ltisec'}{'suggested'}})) {
2984: unless (ref($domconfig{'ltisec'}{'suggested'}{$item}) eq 'HASH') {
2985: delete($suggestions{$item});
2986: }
2987: }
2988: if (keys(%suggestions)) {
2989: $domdefaults{'linkprotsuggested'} = \%suggestions;
2990: }
2991: }
1.1504 raeburn 2992: }
2993: if (ref($domconfig{'toolsec'}) eq 'HASH') {
2994: if (ref($domconfig{'toolsec'}{'encrypt'}) eq 'HASH') {
2995: $domdefaults{'toolenc_crs'} = $domconfig{'toolsec'}{'encrypt'}{'crs'};
2996: $domdefaults{'toolenc_dom'} = $domconfig{'toolsec'}{'encrypt'}{'dom'};
2997: }
2998: if (ref($domconfig{'toolsec'}{'private'}) eq 'HASH') {
2999: if (ref($domconfig{'toolsec'}{'private'}{'keys'}) eq 'ARRAY') {
3000: $domdefaults{'toolprivhosts'} = $domconfig{'toolsec'}{'private'}{'keys'};
1.1482 raeburn 3001: }
3002: }
3003: }
1.1512 raeburn 3004: if (ref($domconfig{'privacy'}) eq 'HASH') {
3005: if (ref($domconfig{'privacy'}{'approval'}) eq 'HASH') {
3006: foreach my $domtype ('instdom','extdom') {
3007: if (ref($domconfig{'privacy'}{'approval'}{$domtype}) eq 'HASH') {
3008: foreach my $roletype ('domain','author','course','community') {
3009: if ($domconfig{'privacy'}{'approval'}{$domtype}{$roletype} eq 'user') {
3010: $domdefaults{'userapprovals'} = 1;
3011: last;
3012: }
3013: }
3014: }
3015: last if ($domdefaults{'userapprovals'});
3016: }
3017: }
3018: }
1.1219 raeburn 3019: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 3020: return %domdefaults;
3021: }
3022:
1.1412 raeburn 3023: sub get_dom_cats {
3024: my ($dom) = @_;
3025: return unless (&domain($dom));
3026: my ($cats,$cached)=&is_cached_new('cats',$dom);
3027: unless (defined($cached)) {
3028: my %domconfig = &get_dom('configuration',['coursecategories'],$dom);
3029: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
3030: if (ref($domconfig{'coursecategories'}{'cats'}) eq 'HASH') {
3031: %{$cats} = %{$domconfig{'coursecategories'}{'cats'}};
3032: } else {
3033: $cats = {};
3034: }
3035: } else {
3036: $cats = {};
3037: }
1.1494 raeburn 3038: &do_cache_new('cats',$dom,$cats,3600);
1.1412 raeburn 3039: }
1.1413 raeburn 3040: return $cats;
3041: }
3042:
3043: sub get_dom_instcats {
3044: my ($dom) = @_;
3045: return unless (&domain($dom));
3046: my ($instcats,$cached)=&is_cached_new('instcats',$dom);
3047: unless (defined($cached)) {
3048: my (%coursecodes,%codes,@codetitles,%cat_titles,%cat_order);
3049: my $totcodes = &retrieve_instcodes(\%coursecodes,$dom);
3050: if ($totcodes > 0) {
3051: my $caller = 'global';
3052: if (&auto_instcode_format($caller,$dom,\%coursecodes,\%codes,
3053: \@codetitles,\%cat_titles,\%cat_order) eq 'ok') {
3054: $instcats = {
1.1503 raeburn 3055: totcodes => $totcodes,
1.1413 raeburn 3056: codes => \%codes,
3057: codetitles => \@codetitles,
3058: cat_titles => \%cat_titles,
3059: cat_order => \%cat_order,
3060: };
3061: &do_cache_new('instcats',$dom,$instcats,3600);
3062: }
3063: }
3064: }
3065: return $instcats;
3066: }
3067:
3068: sub retrieve_instcodes {
3069: my ($coursecodes,$dom) = @_;
3070: my $totcodes;
3071: my %courses = &courseiddump($dom,'.',1,'.','.','.',undef,undef,'Course');
3072: foreach my $course (keys(%courses)) {
3073: if (ref($courses{$course}) eq 'HASH') {
3074: if ($courses{$course}{'inst_code'} ne '') {
3075: $$coursecodes{$course} = $courses{$course}{'inst_code'};
3076: $totcodes ++;
3077: }
3078: }
3079: }
3080: return $totcodes;
1.1412 raeburn 3081: }
3082:
1.1311 raeburn 3083: sub course_portal_url {
1.1451 raeburn 3084: my ($cnum,$cdom,$r) = @_;
1.1311 raeburn 3085: my $chome = &homeserver($cnum,$cdom);
3086: my $hostname = &hostname($chome);
3087: my $protocol = $protocol{$chome};
3088: $protocol = 'http' if ($protocol ne 'https');
3089: my %domdefaults = &get_domain_defaults($cdom);
3090: my $firsturl;
3091: if ($domdefaults{'portal_def'}) {
3092: $firsturl = $domdefaults{'portal_def'};
3093: } else {
1.1494 raeburn 3094: my $alias = &use_proxy_alias($r,$chome);
1.1451 raeburn 3095: $hostname = $alias if ($alias ne '');
1.1311 raeburn 3096: $firsturl = $protocol.'://'.$hostname;
3097: }
3098: return $firsturl;
3099: }
3100:
1.1492 raeburn 3101: sub url_prefix {
3102: my ($r,$dom,$home,$context) = @_;
3103: my $prefix;
3104: my %domdefs = &get_domain_defaults($dom);
3105: if ($domdefs{'portal_def'} && $domdefs{'portal_def_'.$context}) {
3106: if ($domdefs{'portal_def'} =~ m{^(https?://[^/]+)}) {
3107: $prefix = $1;
3108: }
3109: }
3110: if ($prefix eq '') {
3111: my $hostname = &hostname($home);
3112: my $protocol = $protocol{$home};
3113: $protocol = 'http' if ($protocol{$home} ne 'https');
3114: my $alias = &use_proxy_alias($r,$home);
3115: $hostname = $alias if ($alias ne '');
3116: $prefix = $protocol.'://'.$hostname;
3117: }
3118: return $prefix;
3119: }
3120:
1.1407 raeburn 3121: # --------------------------------------------- Get domain config for passwords
3122:
3123: sub get_passwdconf {
3124: my ($dom) = @_;
3125: my (%passwdconf,$gotconf,$lookup);
3126: my ($result,$cached)=&is_cached_new('passwdconf',$dom);
3127: if (defined($cached)) {
3128: if (ref($result) eq 'HASH') {
3129: %passwdconf = %{$result};
3130: $gotconf = 1;
3131: }
3132: }
3133: unless ($gotconf) {
3134: my %domconfig = &get_dom('configuration',['passwords'],$dom);
3135: if (ref($domconfig{'passwords'}) eq 'HASH') {
3136: %passwdconf = %{$domconfig{'passwords'}};
3137: }
3138: my $cachetime = 24*60*60;
3139: &do_cache_new('passwdconf',$dom,\%passwdconf,$cachetime);
3140: }
3141: return %passwdconf;
3142: }
3143:
1.344 www 3144: # --------------------------------------------------- Assign a key to a student
3145:
3146: sub assign_access_key {
1.364 www 3147: #
3148: # a valid key looks like uname:udom#comments
3149: # comments are being appended
3150: #
1.498 www 3151: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
3152: $kdom=
1.620 albertel 3153: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 3154: $knum=
1.620 albertel 3155: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 3156: $cdom=
1.620 albertel 3157: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3158: $cnum=
1.620 albertel 3159: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3160: $udom=$env{'user.name'} unless (defined($udom));
3161: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 3162: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 3163: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 3164: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 3165: # assigned to this person
3166: # - this should not happen,
1.345 www 3167: # unless something went wrong
3168: # the first time around
3169: # ready to assign
1.364 www 3170: $logentry=$1.'; '.$logentry;
1.496 www 3171: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 3172: $kdom,$knum) eq 'ok') {
1.345 www 3173: # key now belongs to user
1.346 www 3174: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 3175: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 3176: &appenv({'environment.'.$envkey => $ckey});
1.345 www 3177: return 'ok';
3178: } else {
3179: return
3180: 'error: Count not permanently assign key, will need to be re-entered later.';
3181: }
3182: } else {
3183: return 'error: Could not assign key, try again later.';
3184: }
1.364 www 3185: } elsif (!$existing{$ckey}) {
1.345 www 3186: # the key does not exist
3187: return 'error: The key does not exist';
3188: } else {
3189: # the key is somebody else's
3190: return 'error: The key is already in use';
3191: }
1.344 www 3192: }
3193:
1.364 www 3194: # ------------------------------------------ put an additional comment on a key
3195:
3196: sub comment_access_key {
3197: #
3198: # a valid key looks like uname:udom#comments
3199: # comments are being appended
3200: #
3201: my ($ckey,$cdom,$cnum,$logentry)=@_;
3202: $cdom=
1.620 albertel 3203: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 3204: $cnum=
1.620 albertel 3205: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 3206: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
3207: if ($existing{$ckey}) {
3208: $existing{$ckey}.='; '.$logentry;
3209: # ready to assign
1.367 www 3210: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 3211: $cdom,$cnum) eq 'ok') {
3212: return 'ok';
3213: } else {
3214: return 'error: Count not store comment.';
3215: }
3216: } else {
3217: # the key does not exist
3218: return 'error: The key does not exist';
3219: }
3220: }
3221:
1.344 www 3222: # ------------------------------------------------------ Generate a set of keys
3223:
3224: sub generate_access_keys {
1.364 www 3225: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 3226: $cdom=
1.620 albertel 3227: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3228: $cnum=
1.620 albertel 3229: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 3230: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 3231: unless (($cdom) && ($cnum)) { return 0; }
3232: if ($number>10000) { return 0; }
3233: sleep(2); # make sure don't get same seed twice
3234: srand(time()^($$+($$<<15))); # from "Programming Perl"
3235: my $total=0;
3236: for (my $i=1;$i<=$number;$i++) {
3237: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
3238: sprintf("%lx",int(100000*rand)).'-'.
3239: sprintf("%lx",int(100000*rand));
3240: $newkey=~s/1/g/g; # folks mix up 1 and l
3241: $newkey=~s/0/h/g; # and also 0 and O
3242: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
3243: if ($existing{$newkey}) {
3244: $i--;
3245: } else {
1.364 www 3246: if (&put('accesskeys',
3247: { $newkey => '# generated '.localtime().
1.620 albertel 3248: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 3249: '; '.$logentry },
3250: $cdom,$cnum) eq 'ok') {
1.344 www 3251: $total++;
3252: }
3253: }
3254: }
1.620 albertel 3255: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 3256: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
3257: return $total;
3258: }
3259:
3260: # ------------------------------------------------------- Validate an accesskey
3261:
3262: sub validate_access_key {
3263: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
3264: $cdom=
1.620 albertel 3265: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 3266: $cnum=
1.620 albertel 3267: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
3268: $udom=$env{'user.domain'} unless (defined($udom));
3269: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 3270: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 3271: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 3272: }
3273:
3274: # ------------------------------------- Find the section of student in a course
1.652 albertel 3275: sub devalidate_getsection_cache {
3276: my ($udom,$unam,$courseid)=@_;
3277: my $hashid="$udom:$unam:$courseid";
3278: &devalidate_cache_new('getsection',$hashid);
3279: }
1.298 matthew 3280:
1.815 albertel 3281: sub courseid_to_courseurl {
3282: my ($courseid) = @_;
3283: #already url style courseid
3284: return $courseid if ($courseid =~ m{^/});
3285:
3286: if (exists($env{'course.'.$courseid.'.num'})) {
3287: my $cnum = $env{'course.'.$courseid.'.num'};
3288: my $cdom = $env{'course.'.$courseid.'.domain'};
3289: return "/$cdom/$cnum";
3290: }
3291:
1.1494 raeburn 3292: my %courseinfo=&coursedescription($courseid);
1.815 albertel 3293: if (exists($courseinfo{'num'})) {
3294: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
3295: }
3296:
3297: return undef;
3298: }
3299:
1.298 matthew 3300: sub getsection {
3301: my ($udom,$unam,$courseid)=@_;
1.599 albertel 3302: my $cachetime=1800;
1.551 albertel 3303:
3304: my $hashid="$udom:$unam:$courseid";
1.599 albertel 3305: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 3306: if (defined($cached)) { return $result; }
3307:
1.298 matthew 3308: my %Pending;
3309: my %Expired;
3310: #
3311: # Each role can either have not started yet (pending), be active,
3312: # or have expired.
3313: #
3314: # If there is an active role, we are done.
3315: #
3316: # If there is more than one role which has not started yet,
3317: # choose the one which will start sooner
3318: # If there is one role which has not started yet, return it.
3319: #
3320: # If there is more than one expired role, choose the one which ended last.
3321: # If there is a role which has expired, return it.
3322: #
1.815 albertel 3323: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 3324: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 3325: foreach my $key (keys(%roleshash)) {
1.479 albertel 3326: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 3327: my $section=$1;
3328: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 3329: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 3330: my $now=time;
1.548 albertel 3331: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 3332: $Expired{$end}=$section;
3333: next;
3334: }
1.548 albertel 3335: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 3336: $Pending{$start}=$section;
3337: next;
3338: }
1.599 albertel 3339: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 3340: }
3341: #
3342: # Presumedly there will be few matching roles from the above
3343: # loop and the sorting time will be negligible.
3344: if (scalar(keys(%Pending))) {
3345: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 3346: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 3347: }
3348: if (scalar(keys(%Expired))) {
3349: my @sorted = sort {$a <=> $b} keys(%Expired);
3350: my $time = pop(@sorted);
1.599 albertel 3351: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 3352: }
1.599 albertel 3353: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 3354: }
1.70 www 3355:
1.599 albertel 3356: sub save_cache {
3357: &purge_remembered();
1.722 albertel 3358: #&Apache::loncommon::validate_page();
1.620 albertel 3359: undef(%env);
1.780 albertel 3360: undef($env_loaded);
1.599 albertel 3361: }
1.452 albertel 3362:
1.599 albertel 3363: my $to_remember=-1;
3364: my %remembered;
3365: my %accessed;
3366: my $kicks=0;
3367: my $hits=0;
1.849 albertel 3368: sub make_key {
3369: my ($name,$id) = @_;
1.872 albertel 3370: if (length($id) > 65
3371: && length(&escape($id)) > 200) {
3372: $id=length($id).':'.&Digest::MD5::md5_hex($id);
3373: }
1.849 albertel 3374: return &escape($name.':'.$id);
3375: }
3376:
1.599 albertel 3377: sub devalidate_cache_new {
3378: my ($name,$id,$debug) = @_;
3379: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1319 damieng 3380: my $remembered_id=$name.':'.$id;
1.849 albertel 3381: $id=&make_key($name,$id);
1.599 albertel 3382: $memcache->delete($id);
1.1319 damieng 3383: delete($remembered{$remembered_id});
3384: delete($accessed{$remembered_id});
1.599 albertel 3385: }
3386:
3387: sub is_cached_new {
3388: my ($name,$id,$debug) = @_;
1.1319 damieng 3389: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) whenever possible
3390: if (exists($remembered{$remembered_id})) {
3391: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
3392: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3393: $hits++;
1.1319 damieng 3394: return ($remembered{$remembered_id},1);
1.599 albertel 3395: }
1.1319 damieng 3396: $id=&make_key($name,$id);
1.599 albertel 3397: my $value = $memcache->get($id);
3398: if (!(defined($value))) {
3399: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 3400: return (undef,undef);
1.416 albertel 3401: }
1.599 albertel 3402: if ($value eq '__undef__') {
3403: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
3404: $value=undef;
3405: }
1.1319 damieng 3406: &make_room($remembered_id,$value,$debug);
1.599 albertel 3407: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
3408: return ($value,1);
3409: }
3410:
3411: sub do_cache_new {
3412: my ($name,$id,$value,$time,$debug) = @_;
1.1319 damieng 3413: my $remembered_id=$name.':'.$id;
1.849 albertel 3414: $id=&make_key($name,$id);
1.599 albertel 3415: my $setvalue=$value;
3416: if (!defined($setvalue)) {
3417: $setvalue='__undef__';
3418: }
1.623 albertel 3419: if (!defined($time) ) {
3420: $time=600;
3421: }
1.599 albertel 3422: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 3423: my $result = $memcache->set($id,$setvalue,$time);
3424: if (! $result) {
1.872 albertel 3425: &logthis("caching of id -> $id failed");
1.910 albertel 3426: $memcache->disconnect_all();
1.872 albertel 3427: }
1.600 albertel 3428: # need to make a copy of $value
1.1319 damieng 3429: &make_room($remembered_id,$value,$debug);
1.599 albertel 3430: return $value;
3431: }
3432:
3433: sub make_room {
1.1319 damieng 3434: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 3435:
1.1319 damieng 3436: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 3437: : $value;
1.599 albertel 3438: if ($to_remember<0) { return; }
1.1319 damieng 3439: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 3440: if (scalar(keys(%remembered)) <= $to_remember) { return; }
3441: my $to_kick;
3442: my $max_time=0;
3443: foreach my $other (keys(%accessed)) {
3444: if (&tv_interval($accessed{$other}) > $max_time) {
3445: $to_kick=$other;
3446: $max_time=&tv_interval($accessed{$other});
3447: }
3448: }
3449: delete($remembered{$to_kick});
3450: delete($accessed{$to_kick});
3451: $kicks++;
3452: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 3453: return;
3454: }
3455:
1.599 albertel 3456: sub purge_remembered {
1.604 albertel 3457: #&logthis("Tossing ".scalar(keys(%remembered)));
3458: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 3459: undef(%remembered);
3460: undef(%accessed);
1.428 albertel 3461: }
1.70 www 3462: # ------------------------------------- Read an entry from a user's environment
3463:
3464: sub userenvironment {
3465: my ($udom,$unam,@what)=@_;
1.976 raeburn 3466: my $items;
3467: foreach my $item (@what) {
3468: $items.=&escape($item).'&';
3469: }
3470: $items=~s/\&$//;
1.70 www 3471: my %returnhash=();
1.1009 raeburn 3472: my $uhome = &homeserver($unam,$udom);
3473: unless ($uhome eq 'no_host') {
3474: my @answer=split(/\&/,
3475: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 3476: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
3477: return %returnhash;
3478: }
1.1009 raeburn 3479: my $i;
3480: for ($i=0;$i<=$#what;$i++) {
3481: $returnhash{$what[$i]}=&unescape($answer[$i]);
3482: }
1.70 www 3483: }
3484: return %returnhash;
1.1 albertel 3485: }
3486:
1.617 albertel 3487: # ---------------------------------------------------------- Get a studentphoto
3488: sub studentphoto {
3489: my ($udom,$unam,$ext) = @_;
1.1494 raeburn 3490: my $home=&homeserver($unam,$udom);
1.706 raeburn 3491: if (defined($env{'request.course.id'})) {
1.708 raeburn 3492: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 3493: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
3494: return(&retrievestudentphoto($udom,$unam,$ext));
3495: } else {
3496: my ($result,$perm_reqd)=
1.1494 raeburn 3497: &auto_photo_permission($unam,$udom);
1.706 raeburn 3498: if ($result eq 'ok') {
3499: if (!($perm_reqd eq 'yes')) {
3500: return(&retrievestudentphoto($udom,$unam,$ext));
3501: }
3502: }
3503: }
3504: }
3505: } else {
3506: my ($result,$perm_reqd) =
1.1494 raeburn 3507: &auto_photo_permission($unam,$udom);
1.706 raeburn 3508: if ($result eq 'ok') {
3509: if (!($perm_reqd eq 'yes')) {
3510: return(&retrievestudentphoto($udom,$unam,$ext));
3511: }
3512: }
3513: }
3514: return '/adm/lonKaputt/lonlogo_broken.gif';
3515: }
3516:
3517: sub retrievestudentphoto {
3518: my ($udom,$unam,$ext,$type) = @_;
1.1494 raeburn 3519: my $home=&homeserver($unam,$udom);
3520: my $ret=&reply("studentphoto:$udom:$unam:$ext:$type",$home);
1.706 raeburn 3521: if ($ret eq 'ok') {
3522: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
3523: if ($type eq 'thumbnail') {
3524: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
3525: }
1.1494 raeburn 3526: my $tokenurl=&tokenwrapper($url);
1.706 raeburn 3527: return $tokenurl;
3528: } else {
3529: if ($type eq 'thumbnail') {
3530: return '/adm/lonKaputt/genericstudent_tn.gif';
3531: } else {
3532: return '/adm/lonKaputt/lonlogo_broken.gif';
3533: }
1.617 albertel 3534: }
3535: }
3536:
1.263 www 3537: # -------------------------------------------------------------------- New chat
3538:
3539: sub chatsend {
1.724 raeburn 3540: my ($newentry,$anon,$group)=@_;
1.620 albertel 3541: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
3542: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3543: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 3544: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 3545: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 3546: &escape($newentry)).':'.$group,$chome);
1.292 www 3547: }
3548:
3549: # ------------------------------------------ Find current version of a resource
3550:
3551: sub getversion {
3552: my $fname=&clutter(shift);
1.1189 raeburn 3553: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 3554: return ¤tversion(&filelocation('',$fname));
3555: }
3556:
3557: sub currentversion {
3558: my $fname=shift;
3559: my $author=$fname;
3560: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3561: my ($udom,$uname)=split(/\//,$author);
1.1112 www 3562: my $home=&homeserver($uname,$udom);
1.292 www 3563: if ($home eq 'no_host') {
3564: return -1;
3565: }
1.1112 www 3566: my $answer=&reply("currentversion:$fname",$home);
1.292 www 3567: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3568: return -1;
3569: }
1.1112 www 3570: return $answer;
1.263 www 3571: }
3572:
1.1111 www 3573: #
3574: # Return special version number of resource if set by override, empty otherwise
3575: #
3576: sub usedversion {
3577: my $fname=shift;
3578: unless ($fname) { $fname=$env{'request.uri'}; }
3579: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
3580: if ($urlversion) { return $urlversion; }
3581: return '';
3582: }
3583:
1.1 albertel 3584: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 3585:
1.1 albertel 3586: sub subscribe {
3587: my $fname=shift;
1.761 raeburn 3588: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 3589: $fname=~s/[\n\r]//g;
1.1 albertel 3590: my $author=$fname;
3591: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3592: my ($udom,$uname)=split(/\//,$author);
3593: my $home=homeserver($uname,$udom);
1.335 albertel 3594: if ($home eq 'no_host') {
3595: return 'not_found';
1.1 albertel 3596: }
3597: my $answer=reply("sub:$fname",$home);
1.64 www 3598: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
3599: $answer.=' by '.$home;
3600: }
1.1 albertel 3601: return $answer;
3602: }
3603:
1.8 www 3604: # -------------------------------------------------------------- Replicate file
3605:
3606: sub repcopy {
3607: my $filename=shift;
1.23 www 3608: $filename=~s/\/+/\//g;
1.1142 raeburn 3609: my $londocroot = $perlvar{'lonDocRoot'};
3610: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 3611: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 3612: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
3613: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 3614: return &repcopy_userfile($filename);
3615: }
1.532 albertel 3616: $filename=~s/[\n\r]//g;
1.8 www 3617: my $transname="$filename.in.transfer";
1.828 www 3618: # FIXME: this should flock
1.607 raeburn 3619: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 3620: my $remoteurl=subscribe($filename);
1.64 www 3621: if ($remoteurl =~ /^con_lost by/) {
3622: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3623: return 'unavailable';
1.8 www 3624: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 3625: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 3626: return 'not_found';
1.64 www 3627: } elsif ($remoteurl =~ /^rejected by/) {
3628: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 3629: return 'forbidden';
1.20 www 3630: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 3631: return 'ok';
1.8 www 3632: } else {
1.290 www 3633: my $author=$filename;
3634: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3635: my ($udom,$uname)=split(/\//,$author);
3636: my $home=homeserver($uname,$udom);
3637: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 3638: my @parts=split(/\//,$filename);
3639: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 3640: if ($path ne "$londocroot/res") {
1.8 www 3641: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 3642: return 'bad_request';
1.8 www 3643: }
3644: my $count;
3645: for ($count=5;$count<$#parts;$count++) {
3646: $path.="/$parts[$count]";
3647: if ((-e $path)!=1) {
3648: mkdir($path,0777);
3649: }
3650: }
3651: my $request=new HTTP::Request('GET',"$remoteurl");
1.1345 raeburn 3652: my $response;
3653: if ($remoteurl =~ m{/raw/}) {
3654: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',0,1);
3655: } else {
3656: $response=&LONCAPA::LWPReq::makerequest($home,$request,$transname,\%perlvar,'',1);
3657: }
1.8 www 3658: if ($response->is_error()) {
3659: unlink($transname);
3660: my $message=$response->status_line;
1.672 albertel 3661: &logthis("<font color=\"blue\">WARNING:"
1.12 www 3662: ." LWP get: $message: $filename</font>");
1.607 raeburn 3663: return 'unavailable';
1.8 www 3664: } else {
1.16 www 3665: if ($remoteurl!~/\.meta$/) {
3666: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1.1345 raeburn 3667: my $mresponse;
3668: if ($remoteurl =~ m{/raw/}) {
3669: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',0,1);
3670: } else {
3671: $mresponse = &LONCAPA::LWPReq::makerequest($home,$mrequest,$filename.'.meta',\%perlvar,'',1);
3672: }
1.16 www 3673: if ($mresponse->is_error()) {
3674: unlink($filename.'.meta');
3675: &logthis(
1.672 albertel 3676: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 3677: }
3678: }
1.8 www 3679: rename($transname,$filename);
1.607 raeburn 3680: return 'ok';
1.8 www 3681: }
1.290 www 3682: }
1.8 www 3683: }
1.330 www 3684: }
3685:
1.1422 raeburn 3686: # ------------------------------------------------- Unsubscribe from a resource
3687:
3688: sub unsubscribe {
3689: my ($fname) = @_;
3690: my $answer;
3691: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return $answer; }
3692: $fname=~s/[\n\r]//g;
3693: my $author=$fname;
3694: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
3695: my ($udom,$uname)=split(/\//,$author);
3696: my $home=homeserver($uname,$udom);
3697: if ($home eq 'no_host') {
3698: $answer = 'no_host';
3699: } elsif (grep { $_ eq $home } ¤t_machine_ids()) {
3700: $answer = 'home';
3701: } else {
3702: my $defdom = $perlvar{'lonDefDomain'};
3703: if (&will_trust('content',$defdom,$udom)) {
3704: $answer = reply("unsub:$fname",$home);
3705: } else {
3706: $answer = 'untrusted';
3707: }
3708: }
3709: return $answer;
3710: }
3711:
1.330 www 3712: # ------------------------------------------------ Get server side include body
3713: sub ssi_body {
1.381 albertel 3714: my ($filelink,%form)=@_;
1.606 matthew 3715: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
3716: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
3717: }
1.953 www 3718: my $output='';
3719: my $response;
1.980 raeburn 3720: if ($filelink=~/^https?\:/) {
1.954 raeburn 3721: ($output,$response)=&externalssi($filelink);
1.953 www 3722: } else {
1.1004 droeschl 3723: $filelink .= $filelink=~/\?/ ? '&' : '?';
3724: $filelink .= 'inhibitmenu=yes';
1.953 www 3725: ($output,$response)=&ssi($filelink,%form);
3726: }
1.778 albertel 3727: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 3728: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 3729: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 3730: if (wantarray) {
3731: return ($output, $response);
3732: } else {
3733: return $output;
3734: }
1.8 www 3735: }
3736:
1.15 www 3737: # --------------------------------------------------------- Server Side Include
3738:
1.782 albertel 3739: sub absolute_url {
1.1447 raeburn 3740: my ($host_name,$unalias,$keep_proto) = @_;
1.782 albertel 3741: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
3742: if ($host_name eq '') {
3743: $host_name = $ENV{'SERVER_NAME'};
3744: }
1.1447 raeburn 3745: if ($unalias) {
3746: my $alias = &get_proxy_alias();
3747: if ($alias eq $host_name) {
3748: my $lonhost = $perlvar{'lonHostID'};
3749: my $hostname = &hostname($lonhost);
3750: my $lcproto;
3751: if (($keep_proto) || ($hostname eq '')) {
3752: $lcproto = $protocol;
3753: } else {
3754: $lcproto = $protocol{$lonhost};
3755: $lcproto = 'http' if ($lcproto ne 'https');
3756: $lcproto .= '://';
3757: }
3758: unless ($hostname eq '') {
3759: return $lcproto.$hostname;
3760: }
3761: }
3762: }
1.782 albertel 3763: return $protocol.$host_name;
3764: }
3765:
1.942 foxr 3766: #
3767: # Server side include.
3768: # Parameters:
3769: # fn Possibly encrypted resource name/id.
3770: # form Hash that describes how the rendering should be done
3771: # and other things.
1.944 foxr 3772: # Returns:
1.950 raeburn 3773: # Scalar context: The content of the response.
3774: # Array context: 2 element list of the content and the full response object.
1.942 foxr 3775: #
1.15 www 3776: sub ssi {
3777:
1.944 foxr 3778: my ($fn,%form)=@_;
1.1447 raeburn 3779: my ($host,$request,$response);
3780: $host = &absolute_url('',1);
1.711 albertel 3781:
3782: $form{'no_update_last_known'}=1;
1.895 albertel 3783: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 3784: if (%form) {
1.1447 raeburn 3785: $request=new HTTP::Request('POST',$host.$fn);
1.1272 droeschl 3786: $request->content(join('&',map {
3787: my $name = escape($_);
3788: "$name=" . ( ref($form{$_}) eq 'ARRAY'
3789: ? join("&$name=", map {escape($_) } @{$form{$_}})
3790: : &escape($form{$_}) );
3791: } keys(%form)));
1.23 www 3792: } else {
1.1447 raeburn 3793: $request=new HTTP::Request('GET',$host.$fn);
1.23 www 3794: }
3795:
1.15 www 3796: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1345 raeburn 3797: my $lonhost = $perlvar{'lonHostID'};
1.1385 raeburn 3798: my $islocal;
3799: if (($env{'request.course.id'}) &&
3800: ($form{'grade_courseid'} eq $env{'request.course.id'}) &&
3801: ($form{'grade_username'} ne '') && ($form{'grade_domain'} ne '') &&
3802: ($form{'grade_symb'} ne '') &&
1.1494 raeburn 3803: (&allowed('mgr',$env{'request.course.id'}.
3804: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:'')))) {
1.1385 raeburn 3805: $islocal = 1;
3806: }
1.1447 raeburn 3807: $response= &LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,
3808: '','','',$islocal);
1.1182 foxr 3809:
1.944 foxr 3810: if (wantarray) {
1.1345 raeburn 3811: return ($response->content, $response);
1.944 foxr 3812: } else {
1.1345 raeburn 3813: return $response->content;
1.942 foxr 3814: }
1.324 www 3815: }
3816:
3817: sub externalssi {
3818: my ($url)=@_;
3819: my $request=new HTTP::Request('GET',$url);
1.1345 raeburn 3820: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar);
1.954 raeburn 3821: if (wantarray) {
3822: return ($response->content, $response);
3823: } else {
3824: return $response->content;
3825: }
1.15 www 3826: }
1.254 www 3827:
1.1354 raeburn 3828:
3829: # If the local copy of a replicated resource is outdated, trigger a
3830: # connection from the homeserver to flush the delayed queue. If no update
3831: # happens, remove local copies of outdated resource (and corresponding
3832: # metadata file).
3833:
1.1352 raeburn 3834: sub remove_stale_resfile {
3835: my ($url) = @_;
1.1354 raeburn 3836: my $removed;
1.1352 raeburn 3837: if ($url=~m{^/res/($match_domain)/($match_username)/}) {
3838: my $audom = $1;
3839: my $auname = $2;
1.1353 raeburn 3840: unless (($url =~ /\.\d+\.\w+$/) || ($url =~ m{^/res/lib/templates/})) {
1.1352 raeburn 3841: my $homeserver = &homeserver($auname,$audom);
3842: unless (($homeserver eq 'no_host') ||
3843: (grep { $_ eq $homeserver } ¤t_machine_ids())) {
3844: my $fname = &filelocation('',$url);
3845: if (-e $fname) {
3846: my $hostname = &hostname($homeserver);
3847: if ($hostname) {
1.1397 raeburn 3848: my $protocol = $protocol{$homeserver};
3849: $protocol = 'http' if ($protocol ne 'https');
1.1352 raeburn 3850: my $uri = &declutter($url);
3851: my $request=new HTTP::Request('HEAD',$protocol.'://'.$hostname.'/raw/'.$uri);
3852: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,5,0,1);
3853: if ($response->is_success()) {
3854: my $remmodtime = &HTTP::Date::str2time( $response->header('Last-modified') );
3855: my $locmodtime = (stat($fname))[9];
3856: if ($locmodtime < $remmodtime) {
1.1354 raeburn 3857: my $stale;
3858: my $answer = &reply('pong',$homeserver);
3859: if ($answer eq $homeserver.':'.$perlvar{'lonHostID'}) {
3860: sleep(0.2);
3861: $locmodtime = (stat($fname))[9];
3862: if ($locmodtime < $remmodtime) {
3863: my $posstransfer = $fname.'.in.transfer';
3864: if ((-e $posstransfer) && ($remmodtime < (stat($posstransfer))[9])) {
3865: $removed = 1;
3866: } else {
3867: $stale = 1;
3868: }
3869: } else {
3870: $removed = 1;
3871: }
3872: } else {
3873: $stale = 1;
3874: }
3875: if ($stale) {
1.1421 raeburn 3876: if (unlink($fname)) {
3877: if ($uri!~/\.meta$/) {
3878: if (-e $fname.'.meta') {
3879: unlink($fname.'.meta');
3880: }
3881: }
1.1422 raeburn 3882: my $unsubresult = &unsubscribe($fname);
3883: unless ($unsubresult eq 'ok') {
3884: &logthis("no unsub of $fname from $homeserver, reason: $unsubresult");
3885: }
1.1421 raeburn 3886: $removed = 1;
1.1354 raeburn 3887: }
1.1352 raeburn 3888: }
3889: }
3890: }
3891: }
3892: }
3893: }
3894: }
3895: }
1.1354 raeburn 3896: return $removed;
1.1352 raeburn 3897: }
3898:
1.492 albertel 3899: # -------------------------------- Allow a /uploaded/ URI to be vouched for
3900:
3901: sub allowuploaded {
3902: my ($srcurl,$url)=@_;
3903: $url=&clutter(&declutter($url));
3904: my $dir=$url;
3905: $dir=~s/\/[^\/]+$//;
3906: my %httpref=();
3907: my $httpurl=&hreflocation('',$url);
3908: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 3909: &Apache::lonnet::appenv(\%httpref);
1.254 www 3910: }
1.477 raeburn 3911:
1.1193 raeburn 3912: #
3913: # Determine if the current user should be able to edit a particular resource,
3914: # when viewing in course context.
3915: # (a) When viewing resource used to determine if "Edit" item is included in
3916: # Functions.
3917: # (b) When displaying folder contents in course editor, used to determine if
3918: # "Edit" link will be displayed alongside resource.
3919: #
1.1196 raeburn 3920: # input: six args -- filename (decluttered), course number, course domain,
3921: # url, symb (if registered) and group (if this is a group
3922: # item -- e.g., bulletin board, group page etc.).
3923: # output: array of five scalars --
1.1193 raeburn 3924: # $cfile -- url for file editing if editable on current server
3925: # $home -- homeserver of resource (i.e., for author if published,
3926: # or course if uploaded.).
3927: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 3928: # $forceedit -- 1 if icon/link should be to go to edit mode
3929: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 3930: #
3931:
3932: sub can_edit_resource {
1.1194 raeburn 3933: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
3934: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
3935: #
3936: # For aboutme pages user can only edit his/her own.
3937: #
1.1199 raeburn 3938: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 3939: my ($sdom,$sname) = ($1,$2);
3940: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
3941: $home = $env{'user.home'};
3942: $cfile = $resurl;
3943: if ($env{'form.forceedit'}) {
3944: $forceview = 1;
3945: } else {
3946: $forceedit = 1;
3947: }
3948: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3949: } else {
3950: return;
3951: }
3952: }
3953:
1.1517 raeburn 3954: #
3955: # For /adm/viewcoauthors can only edit if author or co-author who is manager.
3956: #
3957:
3958: if (($resurl eq '/adm/viewcoauthors') && ($cnum ne '') && ($cdom ne '')) {
3959: if (((&allowed('cca',"$cdom/$cnum")) ||
3960: (&allowed('caa',"$cdom/$cnum"))) ||
3961: ((&allowed('vca',"$cdom/$cnum") ||
3962: &allowed('vaa',"$cdom/$cnum")) &&
3963: ($env{"environment.internal.manager./$cdom/$cnum"}))) {
3964: $home = $env{'user.home'};
3965: $cfile = $resurl;
3966: if ($env{'form.forceedit'}) {
3967: $forceview = 1;
3968: } else {
3969: $forceedit = 1;
3970: }
3971: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3972: } else {
3973: return;
3974: }
3975: }
3976:
1.1194 raeburn 3977: if ($env{'request.course.id'}) {
1.1494 raeburn 3978: my $crsedit = &allowed('mdc',$env{'request.course.id'});
1.1194 raeburn 3979: if ($group ne '') {
3980: # if this is a group homepage or group bulletin board, check group privs
3981: my $allowed = 0;
1.1197 raeburn 3982: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
3983: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 3984: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 3985: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
3986: $allowed = 1;
3987: }
1.1197 raeburn 3988: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
3989: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
3990: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 3991: $allowed = 1;
3992: }
3993: }
3994: if ($allowed) {
3995: $home=&homeserver($cnum,$cdom);
3996: if ($env{'form.forceedit'}) {
3997: $forceview = 1;
3998: } else {
3999: $forceedit = 1;
4000: }
4001: $cfile = $resurl;
4002: } else {
4003: return;
4004: }
4005: } else {
1.1208 raeburn 4006: if ($resurl =~ m{^/?adm/viewclasslist$}) {
1.1494 raeburn 4007: unless (&allowed('opa',$env{'request.course.id'})) {
1.1208 raeburn 4008: return;
4009: }
4010: } elsif (!$crsedit) {
1.1507 raeburn 4011: if ($env{'request.role'} =~ m{^st\./$cdom/$cnum}) {
1.1194 raeburn 4012: #
4013: # No edit allowed where CC has switched to student role.
4014: #
1.1507 raeburn 4015: return;
4016: } elsif (($resurl !~ m{^/res/$match_domain/$match_username/}) ||
4017: ($resurl =~ m{^/res/lib/templates/})) {
4018: return;
4019: }
1.1194 raeburn 4020: }
4021: }
4022: }
4023:
1.1193 raeburn 4024: if ($file ne '') {
4025: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 4026: if (&is_course_upload($file,$cnum,$cdom)) {
4027: $uploaded = 1;
4028: $incourse = 1;
1.1193 raeburn 4029: if ($file =~/\.(htm|html|css|js|txt)$/) {
4030: $cfile = &hreflocation('',$file);
1.1201 raeburn 4031: if ($env{'form.forceedit'}) {
4032: $forceview = 1;
4033: } else {
4034: $forceedit = 1;
4035: }
1.1194 raeburn 4036: }
4037: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
4038: $incourse = 1;
4039: if ($env{'form.forceedit'}) {
4040: $forceview = 1;
4041: } else {
4042: $forceedit = 1;
4043: }
4044: $cfile = $resurl;
1.1507 raeburn 4045: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
1.1194 raeburn 4046: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
4047: $incourse = 1;
4048: if ($env{'form.forceedit'}) {
4049: $forceview = 1;
4050: } else {
4051: $forceedit = 1;
4052: }
4053: $cfile = $resurl;
1.1199 raeburn 4054: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 4055: $incourse = 1;
4056: $cfile = $resurl.'/smpedit';
1.1199 raeburn 4057: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 4058: $incourse = 1;
1.1199 raeburn 4059: if ($env{'form.forceedit'}) {
4060: $forceview = 1;
4061: } else {
4062: $forceedit = 1;
4063: }
4064: $cfile = $resurl;
1.1419 raeburn 4065: } elsif (($resurl =~ m{^/ext/}) && ($symb ne '')) {
4066: my ($map,$id,$res) = &decode_symb($symb);
4067: if ($map =~ /\.page$/) {
4068: $incourse = 1;
4069: if ($env{'form.forceedit'}) {
4070: $forceview = 1;
4071: $cfile = $map;
4072: } else {
4073: $forceedit = 1;
4074: $cfile = '/adm/wrapper'.$resurl;
4075: }
4076: }
1.1343 raeburn 4077: } elsif ($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 4078: $incourse = 1;
4079: if ($env{'form.forceedit'}) {
4080: $forceview = 1;
4081: } else {
4082: $forceedit = 1;
4083: }
4084: $cfile = $resurl;
1.1208 raeburn 4085: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
4086: $incourse = 1;
4087: if ($env{'form.forceedit'}) {
4088: $forceview = 1;
4089: } else {
4090: $forceedit = 1;
4091: }
4092: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 4093: }
4094: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
4095: my $template = '/res/lib/templates/simpleproblem.problem';
4096: if (&is_on_map($template)) {
4097: $incourse = 1;
4098: $forceview = 1;
4099: $cfile = $template;
1.1193 raeburn 4100: }
1.1199 raeburn 4101: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1418 raeburn 4102: $incourse = 1;
4103: if ($env{'form.forceedit'}) {
4104: $forceview = 1;
4105: } else {
4106: $forceedit = 1;
4107: }
4108: $cfile = $resurl;
1.1343 raeburn 4109: } elsif (($resurl =~ m{^/adm/wrapper/adm/$cdom/$cnum/\d+/ext\.tool$}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
1.1298 raeburn 4110: $incourse = 1;
4111: if ($env{'form.forceedit'}) {
4112: $forceview = 1;
4113: } else {
4114: $forceedit = 1;
4115: }
4116: $cfile = $resurl;
1.1199 raeburn 4117: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
4118: $incourse = 1;
4119: $forceview = 1;
4120: if ($symb) {
4121: my ($map,$id,$res)=&decode_symb($symb);
4122: $env{'request.symb'} = $symb;
4123: $cfile = &clutter($res);
4124: } else {
4125: $cfile = $env{'form.suppurl'};
1.1298 raeburn 4126: my $escfile = &unescape($cfile);
1.1343 raeburn 4127: if ($escfile =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
1.1298 raeburn 4128: $cfile = '/adm/wrapper'.$escfile;
4129: } else {
4130: $escfile =~ s{^http://}{};
4131: $cfile = &escape("/adm/wrapper/ext/$escfile");
4132: }
1.1199 raeburn 4133: }
1.1234 raeburn 4134: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
4135: if ($env{'form.forceedit'}) {
4136: $forceview = 1;
4137: } else {
4138: $forceedit = 1;
4139: }
4140: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 4141: }
4142: }
1.1194 raeburn 4143: if ($uploaded || $incourse) {
4144: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 4145: } elsif ($file !~ m{/$}) {
1.1193 raeburn 4146: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
4147: $file=~s{^($match_domain/$match_username)}{/priv/$1};
4148: # Check that the user has permission to edit this resource
4149: my $setpriv = 1;
4150: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
4151: if (defined($cfudom)) {
4152: $home=&homeserver($cfuname,$cfudom);
4153: $cfile=$file;
4154: }
4155: }
1.1194 raeburn 4156: if (($cfile ne '') && (!$incourse || $uploaded) &&
4157: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 4158: my @ids=¤t_machine_ids();
4159: unless (grep(/^\Q$home\E$/,@ids)) {
4160: $switchserver=1;
4161: }
4162: }
4163: }
1.1194 raeburn 4164: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 4165: }
4166:
4167: sub is_course_upload {
4168: my ($file,$cnum,$cdom) = @_;
4169: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
4170: $uploadpath =~ s{^\/}{};
1.1201 raeburn 4171: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
4172: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 4173: return 1;
4174: }
4175: return;
4176: }
4177:
1.1194 raeburn 4178: sub in_course {
1.1195 raeburn 4179: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
4180: if ($hideprivileged) {
4181: my $skipuser;
1.1219 raeburn 4182: my %coursehash = &coursedescription($cdom.'_'.$cnum);
4183: my @possdoms = ($cdom);
4184: if ($coursehash{'checkforpriv'}) {
4185: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4186: }
4187: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 4188: $skipuser = 1;
4189: if ($coursehash{'nothideprivileged'}) {
4190: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4191: my $user;
4192: if ($item =~ /:/) {
4193: $user = $item;
4194: } else {
4195: $user = join(':',split(/[\@]/,$item));
4196: }
4197: if ($user eq $uname.':'.$udom) {
4198: undef($skipuser);
4199: last;
4200: }
4201: }
4202: }
4203: if ($skipuser) {
4204: return 0;
4205: }
4206: }
4207: }
1.1194 raeburn 4208: $type ||= 'any';
4209: if (!defined($cdom) || !defined($cnum)) {
4210: my $cid = $env{'request.course.id'};
4211: $cdom = $env{'course.'.$cid.'.domain'};
4212: $cnum = $env{'course.'.$cid.'.num'};
4213: }
4214: my $typesref;
1.1195 raeburn 4215: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 4216: $typesref = ['active','previous','future'];
4217: } elsif ($type eq 'previous' || $type eq 'future') {
4218: $typesref = [$type];
4219: }
4220: my %roles = &get_my_roles($uname,$udom,'userroles',
4221: $typesref,undef,[$cdom]);
4222: my ($tmp) = keys(%roles);
4223: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
4224: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
4225: if (@course_roles > 0) {
4226: return 1;
4227: }
4228: return 0;
4229: }
4230:
1.478 albertel 4231: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 4232: # input: action, courseID, current domain, intended
1.637 raeburn 4233: # path to file, source of file, instruction to parse file for objects,
4234: # ref to hash for embedded objects,
4235: # ref to hash for codebase of java objects.
1.1095 raeburn 4236: # reference to scalar to accommodate mime type determined
4237: # from File::MMagic if $parser = parse.
1.637 raeburn 4238: #
1.485 raeburn 4239: # output: url to file (if action was uploaddoc),
4240: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 4241: #
1.478 albertel 4242: # Allows directory structure to be used within lonUsers/../userfiles/ for a
4243: # course.
1.477 raeburn 4244: #
1.478 albertel 4245: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4246: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
4247: # course's home server.
1.477 raeburn 4248: #
1.478 albertel 4249: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
4250: # be copied from $source (current location) to
4251: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4252: # and will then be copied to
4253: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
4254: # course's home server.
1.485 raeburn 4255: #
1.481 raeburn 4256: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 4257: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 4258: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
4259: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
4260: # in course's home server.
1.637 raeburn 4261: #
1.477 raeburn 4262:
4263: sub process_coursefile {
1.1095 raeburn 4264: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
4265: $mimetype)=@_;
1.477 raeburn 4266: my $fetchresult;
1.638 albertel 4267: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 4268: if ($action eq 'propagate') {
1.638 albertel 4269: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
4270: $home);
1.481 raeburn 4271: } else {
1.477 raeburn 4272: my $fpath = '';
4273: my $fname = $file;
1.478 albertel 4274: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 4275: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 4276: my $filepath = &build_filepath($fpath);
1.481 raeburn 4277: if ($action eq 'copy') {
4278: if ($source eq '') {
4279: $fetchresult = 'no source file';
4280: return $fetchresult;
4281: } else {
4282: my $destination = $filepath.'/'.$fname;
4283: rename($source,$destination);
4284: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4285: $home);
1.481 raeburn 4286: }
4287: } elsif ($action eq 'uploaddoc') {
1.1359 raeburn 4288: open(my $fh,'>',$filepath.'/'.$fname);
1.620 albertel 4289: print $fh $env{'form.'.$source};
1.481 raeburn 4290: close($fh);
1.637 raeburn 4291: if ($parser eq 'parse') {
1.1024 raeburn 4292: my $mm = new File::MMagic;
1.1095 raeburn 4293: my $type = $mm->checktype_filename($filepath.'/'.$fname);
4294: if ($type eq 'text/html') {
1.1024 raeburn 4295: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
4296: unless ($parse_result eq 'ok') {
4297: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
4298: }
1.637 raeburn 4299: }
1.1095 raeburn 4300: if (ref($mimetype)) {
4301: $$mimetype = $type;
4302: }
1.637 raeburn 4303: }
1.477 raeburn 4304: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4305: $home);
1.481 raeburn 4306: if ($fetchresult eq 'ok') {
4307: return '/uploaded/'.$fpath.'/'.$fname;
4308: } else {
4309: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4310: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 4311: return '/adm/notfound.html';
4312: }
1.477 raeburn 4313: }
4314: }
1.485 raeburn 4315: unless ( $fetchresult eq 'ok') {
1.477 raeburn 4316: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 4317: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 4318: }
4319: return $fetchresult;
4320: }
4321:
1.637 raeburn 4322: sub build_filepath {
4323: my ($fpath) = @_;
4324: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
4325: unless ($fpath eq '') {
4326: my @parts=split('/',$fpath);
4327: foreach my $part (@parts) {
4328: $filepath.= '/'.$part;
4329: if ((-e $filepath)!=1) {
4330: mkdir($filepath,0777);
4331: }
4332: }
4333: }
4334: return $filepath;
4335: }
4336:
4337: sub store_edited_file {
1.638 albertel 4338: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 4339: my $file = $primary_url;
4340: $file =~ s#^/uploaded/$docudom/$docuname/##;
4341: my $fpath = '';
4342: my $fname = $file;
4343: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
4344: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
4345: my $filepath = &build_filepath($fpath);
1.1359 raeburn 4346: open(my $fh,'>',$filepath.'/'.$fname);
1.637 raeburn 4347: print $fh $content;
4348: close($fh);
1.638 albertel 4349: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 4350: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 4351: $home);
1.637 raeburn 4352: if ($$fetchresult eq 'ok') {
4353: return '/uploaded/'.$fpath.'/'.$fname;
4354: } else {
1.638 albertel 4355: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
4356: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 4357: return '/adm/notfound.html';
4358: }
4359: }
4360:
1.531 albertel 4361: sub clean_filename {
1.831 albertel 4362: my ($fname,$args)=@_;
1.315 www 4363: # Replace Windows backslashes by forward slashes
1.257 www 4364: $fname=~s/\\/\//g;
1.831 albertel 4365: if (!$args->{'keep_path'}) {
4366: # Get rid of everything but the actual filename
4367: $fname=~s/^.*\/([^\/]+)$/$1/;
4368: }
1.315 www 4369: # Replace spaces by underscores
4370: $fname=~s/\s+/\_/g;
1.1406 raeburn 4371: # Transliterate non-ascii text to ascii
4372: my $lang = &Apache::lonlocal::current_language();
4373: $fname = &LONCAPA::transliterate::fname_to_ascii($fname,$lang);
1.315 www 4374: # Replace all other weird characters by nothing
1.831 albertel 4375: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 4376: # Replace all .\d. sequences with _\d. so they no longer look like version
4377: # numbers
4378: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.1443 raeburn 4379: # Replace three or more adjacent underscores with one for consistency
4380: # with loncfile::filename_check() so complete url can be extracted by
4381: # lonnet::decode_symb()
4382: $fname=~s/_{3,}/_/g;
1.531 albertel 4383: return $fname;
4384: }
1.1406 raeburn 4385:
1.1051 raeburn 4386: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
4387: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
4388: # image with the same aspect ratio as the original, but with dimensions which do
4389: # not exceed $resizewidth and $resizeheight.
4390:
1.984 neumanie 4391: sub resizeImage {
1.1051 raeburn 4392: my ($img_path,$resizewidth,$resizeheight) = @_;
4393: my $ima = Image::Magick->new;
4394: my $resized;
4395: if (-e $img_path) {
4396: $ima->Read($img_path);
4397: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
4398: my $width = $ima->Get('width');
4399: my $height = $ima->Get('height');
4400: if ($width > $resizewidth) {
4401: my $factor = $width/$resizewidth;
4402: my $newheight = $height/$factor;
4403: $ima->Scale(width=>$resizewidth,height=>$newheight);
4404: $resized = 1;
4405: }
4406: }
4407: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
4408: my $width = $ima->Get('width');
4409: my $height = $ima->Get('height');
4410: if ($height > $resizeheight) {
4411: my $factor = $height/$resizeheight;
4412: my $newwidth = $width/$factor;
4413: $ima->Scale(width=>$newwidth,height=>$resizeheight);
4414: $resized = 1;
4415: }
4416: }
4417: if ($resized) {
4418: $ima->Write($img_path);
4419: }
4420: }
4421: return;
1.977 amueller 4422: }
4423:
1.608 albertel 4424: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 4425: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 4426: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 4427: # $context - possible values: coursedoc, existingfile, overwrite,
1.1504 raeburn 4428: # canceloverwrite, scantron, toollogo or ''.
1.1090 raeburn 4429: # if 'coursedoc': upload to the current course
4430: # if 'existingfile': write file to tmp/overwrites directory
4431: # if 'canceloverwrite': delete file written to tmp/overwrites directory
4432: # $context is passed as argument to &finishuserfileupload
1.686 albertel 4433: # $subdir - directory in userfile to store the file into
1.1401 raeburn 4434: # $parser - instruction to parse file for objects ($parser = parse) or
4435: # if context is 'scantron', $parser is hashref of csv column mapping
4436: # (e.g.,{ PaperID => 0, LastName => 1, FirstName => 2, ID => 3,
4437: # Section => 4, CODE => 5, FirstQuestion => 9 }).
1.858 raeburn 4438: # $allfiles - reference to hash for embedded objects
4439: # $codebase - reference to hash for codebase of java objects
1.1504 raeburn 4440: # $destuname - username for permanent storage of uploaded file
4441: # $destudom - domain for permanaent storage of uploaded file
1.860 raeburn 4442: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
4443: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 4444: # $resizewidth - width (pixels) to which to resize uploaded image
4445: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 4446: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 4447: # from File::MMagic.
1.858 raeburn 4448: #
1.686 albertel 4449: # output: url of file in userspace, or error: <message>
4450: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 4451:
1.531 albertel 4452: sub userfileupload {
1.1090 raeburn 4453: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 4454: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 4455: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 4456: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 4457: $fname=&clean_filename($fname);
1.1090 raeburn 4458: # See if there is anything left
1.257 www 4459: unless ($fname) { return 'error: no uploaded file'; }
1.1406 raeburn 4460: # If filename now begins with a . prepend unix timestamp _ milliseconds
4461: if ($fname =~ /^\./) {
4462: my ($s,$usec) = &gettimeofday();
4463: while (length($usec) < 6) {
4464: $usec = '0'.$usec;
4465: }
4466: $fname = $s.'_'.substr($usec,0,3).$fname;
4467: }
1.1090 raeburn 4468: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
4469: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
4470: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
4471: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 4472: my $now = time;
1.1090 raeburn 4473: my $filepath;
1.1095 raeburn 4474: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 4475: $filepath = 'tmp/helprequests/'.$now;
4476: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
4477: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
4478: '_'.$env{'user.domain'}.'/pending';
4479: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
4480: my ($docuname,$docudom);
1.1350 raeburn 4481: if ($destudom =~ /^$match_domain$/) {
1.1090 raeburn 4482: $docudom = $destudom;
4483: } else {
4484: $docudom = $env{'user.domain'};
4485: }
1.1350 raeburn 4486: if ($destuname =~ /^$match_username$/) {
1.1090 raeburn 4487: $docuname = $destuname;
4488: } else {
4489: $docuname = $env{'user.name'};
4490: }
4491: if (exists($env{'form.group'})) {
4492: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4493: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4494: }
4495: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
4496: if ($context eq 'canceloverwrite') {
4497: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
4498: if (-e $tempfile) {
4499: my @info = stat($tempfile);
4500: if ($info[9] eq $env{'form.timestamp'}) {
4501: unlink($tempfile);
4502: }
4503: }
4504: return;
1.523 raeburn 4505: }
4506: }
1.1090 raeburn 4507: # Create the directory if not present
1.741 raeburn 4508: my @parts=split(/\//,$filepath);
4509: my $fullpath = $perlvar{'lonDaemons'};
4510: for (my $i=0;$i<@parts;$i++) {
4511: $fullpath .= '/'.$parts[$i];
4512: if ((-e $fullpath)!=1) {
4513: mkdir($fullpath,0777);
4514: }
4515: }
1.1359 raeburn 4516: open(my $fh,'>',$fullpath.'/'.$fname);
1.741 raeburn 4517: print $fh $env{'form.'.$formname};
4518: close($fh);
1.1090 raeburn 4519: if ($context eq 'existingfile') {
4520: my @info = stat($fullpath.'/'.$fname);
4521: return ($fullpath.'/'.$fname,$info[9]);
4522: } else {
4523: return $fullpath.'/'.$fname;
4524: }
1.523 raeburn 4525: }
1.995 raeburn 4526: if ($subdir eq 'scantron') {
4527: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 4528: } else {
1.995 raeburn 4529: $fname="$subdir/$fname";
4530: }
1.1090 raeburn 4531: if ($context eq 'coursedoc') {
1.638 albertel 4532: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4533: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 4534: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 4535: return &finishuserfileupload($docuname,$docudom,
4536: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 4537: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 4538: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 4539: } else {
1.1218 raeburn 4540: if ($env{'form.folder'}) {
4541: $fname=$env{'form.folder'}.'/'.$fname;
4542: }
1.638 albertel 4543: return &process_coursefile('uploaddoc',$docuname,$docudom,
4544: $fname,$formname,$parser,
1.1095 raeburn 4545: $allfiles,$codebase,$mimetype);
1.481 raeburn 4546: }
1.719 banghart 4547: } elsif (defined($destuname)) {
4548: my $docuname=$destuname;
4549: my $docudom=$destudom;
1.860 raeburn 4550: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4551: $parser,$allfiles,$codebase,
1.1051 raeburn 4552: $thumbwidth,$thumbheight,
1.1095 raeburn 4553: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4554: } else {
1.638 albertel 4555: my $docuname=$env{'user.name'};
4556: my $docudom=$env{'user.domain'};
1.1220 raeburn 4557: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 4558: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
4559: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
4560: }
1.860 raeburn 4561: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
4562: $parser,$allfiles,$codebase,
1.1051 raeburn 4563: $thumbwidth,$thumbheight,
1.1095 raeburn 4564: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 4565: }
1.271 www 4566: }
4567:
4568: sub finishuserfileupload {
1.860 raeburn 4569: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 4570: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 4571: my $path=$docudom.'/'.$docuname.'/';
1.258 www 4572: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 4573:
1.860 raeburn 4574: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 4575: $file=$fname;
4576: if ($fname=~m|/|) {
4577: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
4578: $path.=$fnamepath.'/';
4579: }
1.259 www 4580: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 4581: my $count;
4582: for ($count=4;$count<=$#parts;$count++) {
4583: $filepath.="/$parts[$count]";
4584: if ((-e $filepath)!=1) {
4585: mkdir($filepath,0777);
4586: }
4587: }
1.984 neumanie 4588:
1.258 www 4589: # Save the file
4590: {
1.1359 raeburn 4591: if (!open(FH,'>',$filepath.'/'.$file)) {
1.701 albertel 4592: &logthis('Failed to create '.$filepath.'/'.$file);
4593: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
4594: return '/adm/notfound.html';
4595: }
1.1090 raeburn 4596: if ($context eq 'overwrite') {
1.1117 foxr 4597: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 4598: my $target = $filepath.'/'.$file;
4599: if (-e $source) {
4600: my @info = stat($source);
4601: if ($info[9] eq $env{'form.timestamp'}) {
4602: unless (&File::Copy::move($source,$target)) {
4603: &logthis('Failed to overwrite '.$filepath.'/'.$file);
4604: return "Moving from $source failed";
4605: }
4606: } else {
4607: return "Temporary file: $source had unexpected date/time for last modification";
4608: }
4609: } else {
4610: return "Temporary file: $source missing";
4611: }
4612: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 4613: &logthis('Failed to write to '.$filepath.'/'.$file);
4614: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
4615: return '/adm/notfound.html';
4616: }
1.570 albertel 4617: close(FH);
1.1051 raeburn 4618: if ($resizewidth && $resizeheight) {
4619: my $mm = new File::MMagic;
4620: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
4621: if ($mime_type =~ m{^image/}) {
4622: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
4623: }
1.977 amueller 4624: }
1.258 www 4625: }
1.1152 raeburn 4626: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
4627: if (ref($mimetype)) {
4628: if ($$mimetype eq '') {
4629: my $mm = new File::MMagic;
4630: my $type = $mm->checktype_filename($filepath.'/'.$file);
4631: $$mimetype = $type;
4632: }
4633: }
4634: }
1.1401 raeburn 4635: if (($context ne 'scantron') && ($parser eq 'parse')) {
1.1152 raeburn 4636: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 4637: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
4638: $allfiles,$codebase);
4639: unless ($parse_result eq 'ok') {
4640: &logthis('Failed to parse '.$filepath.$file.
4641: ' for embedded media: '.$parse_result);
4642: }
1.637 raeburn 4643: }
1.1401 raeburn 4644: } elsif (($context eq 'scantron') && (ref($parser) eq 'HASH')) {
4645: my $format = $env{'form.scantron_format'};
4646: &bubblesheet_converter($docudom,$filepath.'/'.$file,$parser,$format);
1.637 raeburn 4647: }
1.860 raeburn 4648: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
4649: my $input = $filepath.'/'.$file;
4650: my $output = $filepath.'/'.'tn-'.$file;
1.1504 raeburn 4651: my $makethumb;
1.860 raeburn 4652: my $thumbsize = $thumbwidth.'x'.$thumbheight;
1.1504 raeburn 4653: if ($context eq 'toollogo') {
4654: my ($fullwidth,$fullheight) = &check_dimensions($input);
4655: if ($fullwidth ne '' && $fullheight ne '') {
4656: if ($fullwidth > $thumbwidth && $fullheight > $thumbheight) {
4657: $makethumb = 1;
4658: }
4659: }
4660: } else {
4661: $makethumb = 1;
4662: }
4663: if ($makethumb) {
4664: my @args = ('convert','-sample',$thumbsize,$input,$output);
4665: system({$args[0]} @args);
4666: if (-e $filepath.'/'.'tn-'.$file) {
4667: $fetchthumb = 1;
4668: }
1.860 raeburn 4669: }
4670: }
1.858 raeburn 4671:
1.259 www 4672: # Notify homeserver to grep it
4673: #
1.984 neumanie 4674: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 4675: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 4676: if ($fetchresult eq 'ok') {
1.860 raeburn 4677: if ($fetchthumb) {
4678: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
4679: if ($thumbresult ne 'ok') {
4680: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
4681: $docuhome.': '.$thumbresult);
4682: }
4683: }
1.259 www 4684: #
1.258 www 4685: # Return the URL to it
1.494 albertel 4686: return '/uploaded/'.$path.$file;
1.263 www 4687: } else {
1.494 albertel 4688: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
4689: ': '.$fetchresult);
1.263 www 4690: return '/adm/notfound.html';
1.858 raeburn 4691: }
1.493 albertel 4692: }
4693:
1.637 raeburn 4694: sub extract_embedded_items {
1.961 raeburn 4695: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 4696: my @state = ();
1.1164 raeburn 4697: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 4698: my %javafiles = (
4699: codebase => '',
4700: code => '',
4701: archive => ''
4702: );
4703: my %mediafiles = (
4704: src => '',
4705: movie => '',
4706: );
1.648 raeburn 4707: my $p;
4708: if ($content) {
4709: $p = HTML::LCParser->new($content);
4710: } else {
1.961 raeburn 4711: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 4712: }
1.641 albertel 4713: while (my $t=$p->get_token()) {
1.640 albertel 4714: if ($t->[0] eq 'S') {
4715: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 4716: push(@state, $tagname);
1.648 raeburn 4717: if (lc($tagname) eq 'allow') {
4718: &add_filetype($allfiles,$attr->{'src'},'src');
4719: }
1.640 albertel 4720: if (lc($tagname) eq 'img') {
4721: &add_filetype($allfiles,$attr->{'src'},'src');
4722: }
1.886 albertel 4723: if (lc($tagname) eq 'a') {
1.1222 raeburn 4724: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 4725: &add_filetype($allfiles,$attr->{'href'},'href');
4726: }
1.886 albertel 4727: }
1.645 raeburn 4728: if (lc($tagname) eq 'script') {
1.1164 raeburn 4729: my $src;
1.645 raeburn 4730: if ($attr->{'archive'} =~ /\.jar$/i) {
4731: &add_filetype($allfiles,$attr->{'archive'},'archive');
4732: } else {
1.1164 raeburn 4733: if ($attr->{'src'} ne '') {
4734: $src = $attr->{'src'};
4735: &add_filetype($allfiles,$src,'src');
4736: }
4737: }
4738: my $text = $p->get_trimmed_text();
4739: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
4740: my @swfargs = split(/,/,$1);
4741: foreach my $item (@swfargs) {
4742: $item =~ s/["']//g;
4743: $item =~ s/^\s+//;
4744: $item =~ s/\s+$//;
4745: }
4746: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
4747: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
4748: push(@{$related{$swfargs[0]}},$swfargs[2]);
4749: } else {
4750: $related{$swfargs[0]} = [$swfargs[2]];
4751: }
4752: }
1.645 raeburn 4753: }
4754: }
4755: if (lc($tagname) eq 'link') {
4756: if (lc($attr->{'rel'}) eq 'stylesheet') {
4757: &add_filetype($allfiles,$attr->{'href'},'href');
4758: }
4759: }
1.640 albertel 4760: if (lc($tagname) eq 'object' ||
4761: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
4762: foreach my $item (keys(%javafiles)) {
4763: $javafiles{$item} = '';
4764: }
1.1164 raeburn 4765: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
4766: $lastids{lc($tagname)} = $attr->{'id'};
4767: }
1.640 albertel 4768: }
4769: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
4770: my $name = lc($attr->{'name'});
4771: foreach my $item (keys(%javafiles)) {
4772: if ($name eq $item) {
4773: $javafiles{$item} = $attr->{'value'};
4774: last;
4775: }
4776: }
1.1164 raeburn 4777: my $pathfrom;
1.640 albertel 4778: foreach my $item (keys(%mediafiles)) {
4779: if ($name eq $item) {
1.1164 raeburn 4780: $pathfrom = $attr->{'value'};
4781: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
4782: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 4783: last;
4784: }
4785: }
1.1164 raeburn 4786: if ($name eq 'flashvars') {
4787: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
4788: }
4789: if ($pathfrom ne '') {
4790: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
4791: $pathfrom);
4792: }
1.640 albertel 4793: }
4794: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
4795: foreach my $item (keys(%javafiles)) {
4796: if ($attr->{$item}) {
4797: $javafiles{$item} = $attr->{$item};
4798: last;
4799: }
4800: }
4801: foreach my $item (keys(%mediafiles)) {
4802: if ($attr->{$item}) {
4803: &add_filetype($allfiles,$attr->{$item},$item);
4804: last;
4805: }
4806: }
1.1164 raeburn 4807: if (lc($tagname) eq 'embed') {
4808: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
4809: &embedded_dependency($allfiles,\%related,$attr->{'name'},
4810: $attr->{'src'});
4811: }
4812: }
1.640 albertel 4813: }
1.1243 raeburn 4814: if (lc($tagname) eq 'iframe') {
4815: my $src = $attr->{'src'} ;
4816: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
4817: &add_filetype($allfiles,$src,'src');
4818: } elsif ($src =~ m{^/}) {
4819: if ($env{'request.course.id'}) {
4820: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4821: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4822: my $url = &hreflocation('',$fullpath);
4823: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
4824: my $relpath = $1;
4825: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
4826: &add_filetype($allfiles,$1,'src');
4827: }
4828: }
4829: }
4830: }
4831: }
1.1164 raeburn 4832: if ($t->[4] =~ m{/>$}) {
1.1243 raeburn 4833: pop(@state);
1.1164 raeburn 4834: }
1.640 albertel 4835: } elsif ($t->[0] eq 'E') {
4836: my ($tagname) = ($t->[1]);
4837: if ($javafiles{'codebase'} ne '') {
4838: $javafiles{'codebase'} .= '/';
4839: }
4840: if (lc($tagname) eq 'applet' ||
4841: lc($tagname) eq 'object' ||
4842: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
4843: ) {
4844: foreach my $item (keys(%javafiles)) {
4845: if ($item ne 'codebase' && $javafiles{$item} ne '') {
4846: my $file=$javafiles{'codebase'}.$javafiles{$item};
4847: &add_filetype($allfiles,$file,$item);
4848: }
4849: }
4850: }
4851: pop @state;
4852: }
4853: }
1.1164 raeburn 4854: foreach my $id (sort(keys(%flashvars))) {
4855: if ($shockwave{$id} ne '') {
4856: my @pairs = split(/\&/,$flashvars{$id});
4857: foreach my $pair (@pairs) {
4858: my ($key,$value) = split(/\=/,$pair);
4859: if ($key eq 'thumb') {
4860: &add_filetype($allfiles,$value,$key);
4861: } elsif ($key eq 'content') {
4862: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
4863: my ($ext) = ($value =~ /\.([^.]+)$/);
4864: if ($ext ne '') {
4865: &add_filetype($allfiles,$path.$value,$ext);
4866: }
4867: }
4868: }
4869: }
4870: }
1.637 raeburn 4871: return 'ok';
4872: }
4873:
1.639 albertel 4874: sub add_filetype {
4875: my ($allfiles,$file,$type)=@_;
4876: if (exists($allfiles->{$file})) {
4877: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
4878: push(@{$allfiles->{$file}}, &escape($type));
4879: }
4880: } else {
4881: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 4882: }
4883: }
4884:
1.1164 raeburn 4885: sub embedded_dependency {
4886: my ($allfiles,$related,$identifier,$pathfrom) = @_;
4887: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
4888: if (($identifier ne '') &&
4889: (ref($related->{$identifier}) eq 'ARRAY') &&
4890: ($pathfrom ne '')) {
4891: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
4892: foreach my $dep (@{$related->{$identifier}}) {
4893: &add_filetype($allfiles,$path.$dep,'object');
4894: }
4895: }
4896: }
4897: return;
4898: }
4899:
1.1504 raeburn 4900: sub check_dimensions {
4901: my ($inputfile) = @_;
4902: my ($fullwidth,$fullheight);
4903: if (($inputfile =~ m|^[/\w.\-]+$|) && (-e $inputfile)) {
4904: my $mm = new File::MMagic;
4905: my $mime_type = $mm->checktype_filename($inputfile);
4906: if ($mime_type =~ m{^image/}) {
4907: if (open(PIPE,"identify $inputfile 2>&1 |")) {
4908: my $imageinfo = <PIPE>;
4909: if (!close(PIPE)) {
4910: &Apache::lonnet::logthis("Failed to close PIPE opened to retrieve image information for $inputfile");
4911: }
4912: chomp($imageinfo);
4913: my ($fullsize) =
4914: ($imageinfo =~ /^\Q$inputfile\E\s+\w+\s+(\d+x\d+)/);
4915: if ($fullsize) {
4916: ($fullwidth,$fullheight) = split(/x/,$fullsize);
4917: }
4918: }
4919: }
4920: }
4921: return ($fullwidth,$fullheight);
4922: }
4923:
1.1401 raeburn 4924: sub bubblesheet_converter {
4925: my ($cdom,$fullpath,$config,$format) = @_;
4926: if ((&domain($cdom) ne '') &&
1.1403 raeburn 4927: ($fullpath =~ m{^\Q$perlvar{'lonDocRoot'}/userfiles/$cdom/\E$match_courseid/scantron_orig}) &&
1.1401 raeburn 4928: (-e $fullpath) && (ref($config) eq 'HASH') && ($format ne '')) {
1.1404 raeburn 4929: my (%csvcols,%csvoptions);
4930: if (ref($config->{'fields'}) eq 'HASH') {
4931: %csvcols = %{$config->{'fields'}};
4932: }
4933: if (ref($config->{'options'}) eq 'HASH') {
4934: %csvoptions = %{$config->{'options'}};
4935: }
1.1401 raeburn 4936: my %csvbynum = reverse(%csvcols);
4937: my %scantronconf = &get_scantron_config($format,$cdom);
4938: if (keys(%scantronconf)) {
4939: my %bynum = (
4940: $scantronconf{CODEstart} => 'CODEstart',
4941: $scantronconf{IDstart} => 'IDstart',
4942: $scantronconf{PaperID} => 'PaperID',
4943: $scantronconf{FirstName} => 'FirstName',
4944: $scantronconf{LastName} => 'LastName',
4945: $scantronconf{Qstart} => 'Qstart',
4946: );
4947: my @ordered;
4948: foreach my $item (sort { $a <=> $b } keys(%bynum)) {
1.1403 raeburn 4949: push(@ordered,$bynum{$item});
1.1401 raeburn 4950: }
4951: my %mapstart = (
4952: CODEstart => 'CODE',
4953: IDstart => 'ID',
4954: PaperID => 'PaperID',
4955: FirstName => 'FirstName',
4956: LastName => 'LastName',
4957: Qstart => 'FirstQuestion',
4958: );
4959: my %maplength = (
4960: CODEstart => 'CODElength',
4961: IDstart => 'IDlength',
4962: PaperID => 'PaperIDlength',
4963: FirstName => 'FirstNamelength',
4964: LastName => 'LastNamelength',
4965: );
4966: if (open(my $fh,'<',$fullpath)) {
4967: my $output;
1.1403 raeburn 4968: my %lettdig = &letter_to_digits();
4969: my %diglett = reverse(%lettdig);
4970: my $numletts = scalar(keys(%lettdig));
1.1404 raeburn 4971: my $num = 0;
1.1401 raeburn 4972: while (my $line=<$fh>) {
1.1404 raeburn 4973: $num ++;
4974: next if (($num == 1) && ($csvoptions{'hdr'} == 1));
1.1401 raeburn 4975: $line =~ s{[\r\n]+$}{};
4976: my %found;
1.1475 raeburn 4977: my @values = split(/,/,$line,-1);
1.1401 raeburn 4978: my ($qstart,$record);
4979: for (my $i=0; $i<@values; $i++) {
1.1403 raeburn 4980: if ((($qstart ne '') && ($i > $qstart)) ||
4981: ($csvbynum{$i} eq 'FirstQuestion')) {
4982: if ($values[$i] eq '') {
4983: $values[$i] = $scantronconf{'Qoff'};
4984: } elsif ($scantronconf{'Qon'} eq 'number') {
4985: if ($values[$i] =~ /^[A-Ja-j]$/) {
4986: $values[$i] = $lettdig{uc($values[$i])};
4987: }
4988: } elsif ($scantronconf{'Qon'} eq 'letter') {
4989: if ($values[$i] =~ /^[0-9]$/) {
4990: $values[$i] = $diglett{$values[$i]};
4991: }
4992: } else {
4993: if ($values[$i] =~ /^[0-9A-Ja-j]$/) {
4994: my $digit;
4995: if ($values[$i] =~ /^[A-Ja-j]$/) {
4996: $digit = $lettdig{uc($values[$i])}-1;
4997: if ($values[$i] eq 'J') {
4998: $digit += $numletts;
4999: }
5000: } elsif ($values[$i] =~ /^[0-9]$/) {
5001: $digit = $values[$i]-1;
5002: if ($values[$i] eq '0') {
5003: $digit += $numletts;
5004: }
5005: }
5006: my $qval='';
5007: for (my $j=0; $j<$scantronconf{'Qlength'}; $j++) {
5008: if ($j == $digit) {
5009: $qval .= $scantronconf{'Qon'};
5010: } else {
5011: $qval .= $scantronconf{'Qoff'};
5012: }
5013: }
5014: $values[$i] = $qval;
5015: }
5016: }
5017: if (length($values[$i]) > $scantronconf{'Qlength'}) {
5018: $values[$i] = substr($values[$i],0,$scantronconf{'Qlength'});
5019: }
5020: my $numblank = $scantronconf{'Qlength'} - length($values[$i]);
5021: if ($numblank > 0) {
5022: $values[$i] .= ($scantronconf{'Qoff'} x $numblank);
5023: }
1.1401 raeburn 5024: if ($csvbynum{$i} eq 'FirstQuestion') {
5025: $qstart = $i;
1.1403 raeburn 5026: $found{$csvbynum{$i}} = $values[$i];
1.1401 raeburn 5027: } else {
1.1403 raeburn 5028: $found{'FirstQuestion'} .= $values[$i];
5029: }
5030: } elsif (exists($csvbynum{$i})) {
1.1404 raeburn 5031: if ($csvoptions{'rem'}) {
5032: $values[$i] =~ s/^\s+//;
5033: }
5034: if (($csvbynum{$i} eq 'PaperID') && ($csvoptions{'pad'})) {
1.1403 raeburn 5035: while (length($values[$i]) < $scantronconf{$maplength{$csvbynum{$i}}}) {
5036: $values[$i] = '0'.$values[$i];
1.1401 raeburn 5037: }
5038: }
5039: $found{$csvbynum{$i}} = $values[$i];
5040: }
5041: }
5042: foreach my $item (@ordered) {
5043: my $currlength = 1+length($record);
5044: my $numspaces = $scantronconf{$item} - $currlength;
5045: if ($numspaces > 0) {
5046: $record .= (' ' x $numspaces);
5047: }
5048: if (($mapstart{$item} ne '') && (exists($found{$mapstart{$item}}))) {
5049: unless ($item eq 'Qstart') {
5050: if (length($found{$mapstart{$item}}) > $scantronconf{$maplength{$item}}) {
5051: $found{$mapstart{$item}} = substr($found{$mapstart{$item}},0,$scantronconf{$maplength{$item}});
5052: }
5053: }
5054: $record .= $found{$mapstart{$item}};
5055: }
5056: }
5057: $output .= "$record\n";
5058: }
5059: close($fh);
5060: if ($output) {
5061: if (open(my $fh,'>',$fullpath)) {
5062: print $fh $output;
5063: close($fh);
5064: }
5065: }
5066: }
5067: }
5068: return;
5069: }
5070: }
5071:
1.1403 raeburn 5072: sub letter_to_digits {
5073: my %lettdig = (
5074: A => 1,
5075: B => 2,
5076: C => 3,
5077: D => 4,
5078: E => 5,
5079: F => 6,
5080: G => 7,
5081: H => 8,
5082: I => 9,
5083: J => 0,
5084: );
5085: return %lettdig;
5086: }
5087:
1.1401 raeburn 5088: sub get_scantron_config {
5089: my ($which,$cdom) = @_;
5090: my @lines = &get_scantronformat_file($cdom);
5091: my %config;
5092: #FIXME probably should move to XML it has already gotten a bit much now
5093: foreach my $line (@lines) {
5094: my ($name,$descrip)=split(/:/,$line);
5095: if ($name ne $which ) { next; }
5096: chomp($line);
5097: my @config=split(/:/,$line);
5098: $config{'name'}=$config[0];
5099: $config{'description'}=$config[1];
5100: $config{'CODElocation'}=$config[2];
5101: $config{'CODEstart'}=$config[3];
5102: $config{'CODElength'}=$config[4];
5103: $config{'IDstart'}=$config[5];
5104: $config{'IDlength'}=$config[6];
5105: $config{'Qstart'}=$config[7];
5106: $config{'Qlength'}=$config[8];
5107: $config{'Qoff'}=$config[9];
5108: $config{'Qon'}=$config[10];
5109: $config{'PaperID'}=$config[11];
5110: $config{'PaperIDlength'}=$config[12];
5111: $config{'FirstName'}=$config[13];
5112: $config{'FirstNamelength'}=$config[14];
5113: $config{'LastName'}=$config[15];
5114: $config{'LastNamelength'}=$config[16];
5115: $config{'BubblesPerRow'}=$config[17];
5116: last;
5117: }
5118: return %config;
5119: }
5120:
5121: sub get_scantronformat_file {
5122: my ($cdom) = @_;
5123: if ($cdom eq '') {
5124: $cdom= $env{'course.'.$env{'request.course.id'}.'.domain'};
5125: }
5126: my %domconfig = &get_dom('configuration',['scantron'],$cdom);
5127: my $gottab = 0;
5128: my @lines;
5129: if (ref($domconfig{'scantron'}) eq 'HASH') {
5130: if ($domconfig{'scantron'}{'scantronformat'} ne '') {
5131: my $formatfile = &getfile($perlvar{'lonDocRoot'}.$domconfig{'scantron'}{'scantronformat'});
5132: if ($formatfile ne '-1') {
5133: @lines = split("\n",$formatfile,-1);
5134: $gottab = 1;
5135: }
5136: }
5137: }
5138: if (!$gottab) {
5139: my $confname = $cdom.'-domainconfig';
5140: my $default = $perlvar{'lonDocRoot'}.'/res/'.$cdom.'/'.$confname.'/default.tab';
5141: my $formatfile = &getfile($default);
5142: if ($formatfile ne '-1') {
5143: @lines = split("\n",$formatfile,-1);
5144: $gottab = 1;
5145: }
5146: }
5147: if (!$gottab) {
5148: my @domains = ¤t_machine_domains();
5149: if (grep(/^\Q$cdom\E$/,@domains)) {
5150: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/scantronformat.tab')) {
5151: @lines = <$fh>;
5152: close($fh);
1.1403 raeburn 5153: }
1.1401 raeburn 5154: } else {
5155: if (open(my $fh,'<',$perlvar{'lonTabDir'}.'/default_scantronformat.tab')) {
5156: @lines = <$fh>;
5157: close($fh);
5158: }
5159: }
1.1488 raeburn 5160: chomp(@lines);
1.1401 raeburn 5161: }
5162: return @lines;
5163: }
5164:
1.493 albertel 5165: sub removeuploadedurl {
1.984 neumanie 5166: my ($url)=@_;
5167: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 5168: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 5169: }
5170:
5171: sub removeuserfile {
5172: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 5173: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 5174: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 5175: if ($result eq 'ok') {
1.798 raeburn 5176: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
5177: my $metafile = $fname.'.meta';
5178: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 5179: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 5180: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 5181: my $sqlresult =
1.823 albertel 5182: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 5183: 'portfolio_metadata',$group,
5184: 'delete');
1.798 raeburn 5185: }
5186: }
5187: return $result;
1.257 www 5188: }
1.15 www 5189:
1.530 albertel 5190: sub mkdiruserfile {
5191: my ($docuname,$docudom,$dir)=@_;
5192: my $home=&homeserver($docuname,$docudom);
5193: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
5194: }
5195:
1.531 albertel 5196: sub renameuserfile {
5197: my ($docuname,$docudom,$old,$new)=@_;
5198: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 5199: my $result = &reply("renameuserfile:$docudom:$docuname:".
5200: &escape("$old").':'.&escape("$new"),$home);
5201: if ($result eq 'ok') {
5202: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
5203: my $oldmeta = $old.'.meta';
5204: my $newmeta = $new.'.meta';
5205: my $metaresult =
5206: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 5207: my $url = "/uploaded/$docudom/$docuname/$old";
5208: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 5209: my $sqlresult =
1.823 albertel 5210: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 5211: 'portfolio_metadata',$group,
5212: 'delete');
1.798 raeburn 5213: }
5214: }
5215: return $result;
1.531 albertel 5216: }
5217:
1.14 www 5218: # ------------------------------------------------------------------------- Log
5219:
5220: sub log {
5221: my ($dom,$nam,$hom,$what)=@_;
1.47 www 5222: return critical("log:$dom:$nam:$what",$hom);
1.157 www 5223: }
5224:
5225: # ------------------------------------------------------------------ Course Log
1.352 www 5226: #
5227: # This routine flushes several buffers of non-mission-critical nature
5228: #
1.157 www 5229:
5230: sub flushcourselogs {
1.352 www 5231: &logthis('Flushing log buffers');
5232: #
5233: # course logs
5234: # This is a log of all transactions in a course, which can be used
5235: # for data mining purposes
5236: #
5237: # It also collects the courseid database, which lists last transaction
5238: # times and course titles for all courseids
5239: #
5240: my %courseidbuffer=();
1.921 raeburn 5241: foreach my $crsid (keys(%courselogs)) {
1.352 www 5242: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 5243: &escape($courselogs{$crsid}),
5244: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 5245: delete $courselogs{$crsid};
5246: } else {
5247: &logthis('Failed to flush log buffer for '.$crsid);
5248: if (length($courselogs{$crsid})>40000) {
1.672 albertel 5249: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 5250: " exceeded maximum size, deleting.</font>");
5251: delete $courselogs{$crsid};
5252: }
1.352 www 5253: }
1.920 raeburn 5254: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 5255: 'description' => $coursedescrbuf{$crsid},
5256: 'inst_code' => $courseinstcodebuf{$crsid},
5257: 'type' => $coursetypebuf{$crsid},
5258: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 5259: };
1.191 harris41 5260: }
1.352 www 5261: #
5262: # Write course id database (reverse lookup) to homeserver of courses
5263: # Is used in pickcourse
5264: #
1.840 albertel 5265: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 5266: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 5267: $courseidbuffer{$crs_home},
5268: $crs_home,'timeonly');
1.352 www 5269: }
5270: #
5271: # File accesses
5272: # Writes to the dynamic metadata of resources to get hit counts, etc.
5273: #
1.449 matthew 5274: foreach my $entry (keys(%accesshash)) {
1.458 matthew 5275: if ($entry =~ /___count$/) {
5276: my ($dom,$name);
1.807 albertel 5277: ($dom,$name,undef)=
1.811 albertel 5278: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 5279: if (! defined($dom) || $dom eq '' ||
5280: ! defined($name) || $name eq '') {
1.620 albertel 5281: my $cid = $env{'request.course.id'};
1.1472 raeburn 5282: #
5283: # FIXME 11/29/2021
5284: # Typo in rev. 1.458 (2003/12/09)??
5285: # These should likely by $env{'course.'.$cid.'.domain'} and $env{'course.'.$cid.'.num'}
5286: #
1.1509 raeburn 5287: # While these remain as $env{'request.'.$cid.'.domain'} and $env{'request.'.$cid.'.num'}
1.1472 raeburn 5288: # $dom and $name will always be null, so the &inc() call will default to storing this data
5289: # in a nohist_accesscount.db file for the user rather than the course.
5290: #
5291: # That said there is a lot of noise in the data being stored.
5292: # So counts for prtspool/ and adm/ etc. are recorded.
5293: #
5294: # A review of which items ending '___count' are written to %accesshash should likely be
5295: # made before deciding whether to set these to 'course.' instead of 'request.'
5296: #
5297: # Under the current scheme each user receives a nohist_accesscount.db file listing
5298: # accesses for things which are not published resources, regardless of course, and
5299: # there is not a nohist_accesscount.db file in a course, which might log accesses from
5300: # anyone in the course for things which are not published resources.
5301: #
5302: # For an author, nohist_accesscount.db ends up having records for other items
5303: # mixed up with the legitimate access counts for the author's published resources.
5304: #
1.620 albertel 5305: $dom = $env{'request.'.$cid.'.domain'};
5306: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 5307: }
1.450 matthew 5308: my $value = $accesshash{$entry};
5309: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
5310: my %temphash=($url => $value);
1.449 matthew 5311: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
5312: if ($result eq 'ok') {
5313: delete $accesshash{$entry};
5314: }
5315: } else {
1.811 albertel 5316: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 5317: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 5318: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 5319: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
5320: delete $accesshash{$entry};
5321: }
1.185 www 5322: }
1.191 harris41 5323: }
1.352 www 5324: #
5325: # Roles
5326: # Reverse lookup of user roles for course faculty/staff and co-authorship
5327: #
1.800 albertel 5328: foreach my $entry (keys(%userrolehash)) {
1.351 www 5329: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 5330: split(/\:/,$entry);
1.1494 raeburn 5331: if (&put('nohist_userroles',
1.351 www 5332: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 5333: $rudom,$runame) eq 'ok') {
5334: delete $userrolehash{$entry};
5335: }
5336: }
1.662 raeburn 5337: #
1.1334 raeburn 5338: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 5339: #
5340: my %domrolebuffer = ();
1.1000 raeburn 5341: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 5342: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 5343: if ($domrolebuffer{$rudom}) {
5344: $domrolebuffer{$rudom}.='&'.&escape($entry).
5345: '='.&escape($domainrolehash{$entry});
5346: } else {
5347: $domrolebuffer{$rudom}.=&escape($entry).
5348: '='.&escape($domainrolehash{$entry});
5349: }
5350: delete $domainrolehash{$entry};
5351: }
5352: foreach my $dom (keys(%domrolebuffer)) {
1.1324 raeburn 5353: my %servers;
5354: if (defined(&domain($dom,'primary'))) {
5355: my $primary=&domain($dom,'primary');
5356: my $hostname=&hostname($primary);
5357: $servers{$primary} = $hostname;
5358: } else {
5359: %servers = &get_servers($dom,'library');
5360: }
1.841 albertel 5361: foreach my $tryserver (keys(%servers)) {
1.1324 raeburn 5362: if (&reply('domroleput:'.$dom.':'.
5363: $domrolebuffer{$dom},$tryserver) eq 'ok') {
5364: last;
5365: } else {
1.841 albertel 5366: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
5367: }
1.662 raeburn 5368: }
5369: }
1.186 www 5370: $dumpcount++;
1.157 www 5371: }
5372:
5373: sub courselog {
5374: my $what=shift;
1.158 www 5375: $what=time.':'.$what;
1.620 albertel 5376: unless ($env{'request.course.id'}) { return ''; }
5377: $coursedombuf{$env{'request.course.id'}}=
5378: $env{'course.'.$env{'request.course.id'}.'.domain'};
5379: $coursenumbuf{$env{'request.course.id'}}=
5380: $env{'course.'.$env{'request.course.id'}.'.num'};
5381: $coursehombuf{$env{'request.course.id'}}=
5382: $env{'course.'.$env{'request.course.id'}.'.home'};
5383: $coursedescrbuf{$env{'request.course.id'}}=
5384: $env{'course.'.$env{'request.course.id'}.'.description'};
5385: $courseinstcodebuf{$env{'request.course.id'}}=
5386: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
5387: $courseownerbuf{$env{'request.course.id'}}=
5388: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 5389: $coursetypebuf{$env{'request.course.id'}}=
5390: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 5391: if (defined $courselogs{$env{'request.course.id'}}) {
5392: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 5393: } else {
1.620 albertel 5394: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 5395: }
1.620 albertel 5396: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 5397: &flushcourselogs();
5398: }
1.158 www 5399: }
5400:
5401: sub courseacclog {
5402: my $fnsymb=shift;
1.620 albertel 5403: unless ($env{'request.course.id'}) { return ''; }
5404: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 5405: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 5406: $what.=':POST';
1.583 matthew 5407: # FIXME: Probably ought to escape things....
1.800 albertel 5408: foreach my $key (keys(%env)) {
5409: if ($key=~/^form\.(.*)/) {
1.975 raeburn 5410: my $formitem = $1;
5411: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
5412: $what.=':'.$formitem.'='.$env{$key};
5413: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
1.1432 raeburn 5414: if ($formitem eq 'proctorpassword') {
1.1433 raeburn 5415: $what.=':'.$formitem.'=' . '*' x length($env{$key});
1.1432 raeburn 5416: } else {
5417: $what.=':'.$formitem.'='.$env{$key};
5418: }
1.975 raeburn 5419: }
1.158 www 5420: }
1.191 harris41 5421: }
1.583 matthew 5422: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
5423: # FIXME: We should not be depending on a form parameter that someone
5424: # editing lonsearchcat.pm might change in the future.
1.620 albertel 5425: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 5426: $what.= ':POST';
5427: # FIXME: Probably ought to escape things....
5428: foreach my $element ('courseexp','crsfulltext','crsrelated',
5429: 'crsdiscuss') {
1.620 albertel 5430: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 5431: }
5432: }
1.158 www 5433: }
5434: &courselog($what);
1.149 www 5435: }
5436:
1.185 www 5437: sub countacc {
5438: my $url=&declutter(shift);
1.458 matthew 5439: return if (! defined($url) || $url eq '');
1.620 albertel 5440: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 5441: #
5442: # Mark that this url was used in this course
5443: #
1.620 albertel 5444: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 5445: #
5446: # Increase the access count for this resource in this child process
5447: #
1.281 www 5448: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 5449: $accesshash{$key}++;
1.185 www 5450: }
1.349 www 5451:
1.361 www 5452: sub linklog {
5453: my ($from,$to)=@_;
5454: $from=&declutter($from);
5455: $to=&declutter($to);
5456: $accesshash{$from.'___'.$to.'___comefrom'}=1;
5457: $accesshash{$to.'___'.$from.'___goto'}=1;
5458: }
1.1160 www 5459:
5460: sub statslog {
5461: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
5462: if ($users<2) { return; }
5463: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
5464: 'course' => $env{'request.course.id'},
5465: 'sections' => '"all"',
5466: 'num_students' => $users,
5467: 'part' => $part,
5468: 'symb' => $symb,
5469: 'mean_tries' => $av_attempts,
5470: 'deg_of_diff' => $degdiff});
5471: foreach my $key (keys(%dynstore)) {
5472: $accesshash{$key}=$dynstore{$key};
5473: }
5474: }
1.361 www 5475:
1.349 www 5476: sub userrolelog {
5477: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 5478: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 5479: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5480: $userrolehash
5481: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 5482: =$tend.':'.$tstart;
1.662 raeburn 5483: }
1.1169 droeschl 5484: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 5485: $userrolehash
5486: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
5487: =$tend.':'.$tstart;
5488: }
1.1334 raeburn 5489: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 5490: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
5491: $domainrolehash
5492: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
5493: = $tend.':'.$tstart;
5494: }
1.351 www 5495: }
5496:
1.957 raeburn 5497: sub courserolelog {
1.1512 raeburn 5498: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,
5499: $context,$othdomby,$requester)=@_;
1.1184 raeburn 5500: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
5501: my $cdom = $1;
5502: my $cnum = $2;
5503: my $sec = $3;
5504: my $namespace = 'rolelog';
5505: my %storehash = (
5506: role => $trole,
5507: start => $tstart,
5508: end => $tend,
5509: selfenroll => $selfenroll,
5510: context => $context,
5511: );
1.1512 raeburn 5512: if ($othdomby) {
5513: if ($othdomby eq 'othdombydc') {
5514: $storehash{'approval'} = 'domain';
5515: } elsif ($othdomby eq 'othdombyuser') {
5516: $storehash{'approval'} = 'user';
5517: }
5518: if ($requester ne '') {
5519: $storehash{'requester'} = $requester;
5520: }
5521: }
1.1184 raeburn 5522: if ($trole eq 'gr') {
5523: $namespace = 'groupslog';
5524: $storehash{'group'} = $sec;
5525: } else {
5526: $storehash{'section'} = $sec;
1.1516 raeburn 5527: my ($curruserdomstr,$newuserdomstr);
1.1515 raeburn 5528: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.userdomains'})) {
5529: $curruserdomstr = $env{'course.'.$env{'request.course.id'}.'.internal.userdomains'};
1.1516 raeburn 5530: } else {
1.1515 raeburn 5531: my %courseinfo = &coursedescription($cdom.'/'.$cnum);
5532: $curruserdomstr = $courseinfo{'internal.userdomains'};
5533: }
1.1516 raeburn 5534: if ($curruserdomstr ne '') {
5535: my @udoms = split(/,/,$curruserdomstr);
1.1515 raeburn 5536: unless (grep(/^\Q$domain\E/,@udoms)) {
5537: push(@udoms,$domain);
5538: $newuserdomstr = join(',',sort(@udoms));
5539: }
5540: } else {
5541: $newuserdomstr = $domain;
5542: }
5543: if ($newuserdomstr ne '') {
5544: my $putresult = &put('environment',{ 'internal.userdomains' => $newuserdomstr },
5545: $cdom,$cnum);
5546: if ($putresult eq 'ok') {
5547: unless (($selfenroll) || ($context eq 'selfenroll')) {
5548: if (($context eq 'createcourse') || ($context eq 'requestcourses') ||
5549: ($context eq 'automated') || ($context eq 'domain')) {
5550: $env{'course.'.$cdom.'_'.$cnum.'.internal.userdomains'} = $newuserdomstr;
5551: } elsif ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
5552: &appenv({'course.'.$cdom.'_'.$cnum.'.internal.userdomains' => $newuserdomstr});
5553: }
5554: }
5555: }
5556: }
1.1184 raeburn 5557: }
1.1188 raeburn 5558: &write_log('course',$namespace,\%storehash,$delflag,$username,
5559: $domain,$cnum,$cdom);
1.1184 raeburn 5560: if (($trole ne 'st') || ($sec ne '')) {
5561: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 5562: }
5563: }
5564: return;
5565: }
5566:
1.1184 raeburn 5567: sub domainrolelog {
1.1512 raeburn 5568: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,
5569: $context,$othdomby,$requester)=@_;
1.1184 raeburn 5570: if ($area =~ m{^/($match_domain)/$}) {
5571: my $cdom = $1;
1.1494 raeburn 5572: my $domconfiguser = &get_domainconfiguser($cdom);
1.1184 raeburn 5573: my $namespace = 'rolelog';
5574: my %storehash = (
5575: role => $trole,
5576: start => $tstart,
5577: end => $tend,
5578: context => $context,
5579: );
1.1512 raeburn 5580: if ($othdomby) {
5581: if ($othdomby eq 'othdombydc') {
5582: $storehash{'approval'} = 'domain';
5583: } elsif ($othdomby eq 'othdombyuser') {
5584: $storehash{'approval'} = 'user';
5585: }
5586: if ($requester ne '') {
5587: $storehash{'requester'} = $requester;
5588: }
5589: }
1.1188 raeburn 5590: &write_log('domain',$namespace,\%storehash,$delflag,$username,
5591: $domain,$domconfiguser,$cdom);
1.1184 raeburn 5592: }
5593: return;
5594:
5595: }
5596:
5597: sub coauthorrolelog {
1.1512 raeburn 5598: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,
5599: $context,$othdomby,$requester)=@_;
1.1184 raeburn 5600: if ($area =~ m{^/($match_domain)/($match_username)$}) {
5601: my $audom = $1;
5602: my $auname = $2;
5603: my $namespace = 'rolelog';
5604: my %storehash = (
5605: role => $trole,
5606: start => $tstart,
5607: end => $tend,
5608: context => $context,
5609: );
1.1512 raeburn 5610: if ($othdomby) {
5611: if ($othdomby eq 'othdombydc') {
5612: $storehash{'approval'} = 'domain';
5613: } elsif ($othdomby eq 'othdombyuser') {
5614: $storehash{'approval'} = 'user';
5615: }
5616: if ($requester ne '') {
5617: $storehash{'requester'} = $requester;
5618: }
5619: }
1.1188 raeburn 5620: &write_log('author',$namespace,\%storehash,$delflag,$username,
5621: $domain,$auname,$audom);
1.1184 raeburn 5622: }
5623: return;
5624: }
5625:
1.351 www 5626: sub get_course_adv_roles {
1.948 raeburn 5627: my ($cid,$codes) = @_;
1.620 albertel 5628: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 5629: my %coursehash=&coursedescription($cid);
1.988 raeburn 5630: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 5631: my %nothide=();
1.800 albertel 5632: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 5633: if ($user !~ /:/) {
5634: $nothide{join(':',split(/[\@]/,$user))}=1;
5635: } else {
5636: $nothide{$user}=1;
5637: }
1.470 www 5638: }
1.1219 raeburn 5639: my @possdoms = ($coursehash{'domain'});
5640: if ($coursehash{'checkforpriv'}) {
5641: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
5642: }
1.351 www 5643: my %returnhash=();
5644: my %dumphash=
5645: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
5646: my $now=time;
1.997 raeburn 5647: my %privileged;
1.1000 raeburn 5648: foreach my $entry (keys(%dumphash)) {
1.800 albertel 5649: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 5650: if (($tstart) && ($tstart<0)) { next; }
5651: if (($tend) && ($tend<$now)) { next; }
5652: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 5653: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 5654: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 5655: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 5656: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 5657: if ($role eq 'cr') { next; }
1.948 raeburn 5658: if ($codes) {
5659: if ($section) { $role .= ':'.$section; }
5660: if ($returnhash{$role}) {
5661: $returnhash{$role}.=','.$username.':'.$domain;
5662: } else {
5663: $returnhash{$role}=$username.':'.$domain;
5664: }
1.351 www 5665: } else {
1.988 raeburn 5666: my $key=&plaintext($role,$crstype);
1.973 bisitz 5667: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 5668: if ($returnhash{$key}) {
5669: $returnhash{$key}.=','.$username.':'.$domain;
5670: } else {
5671: $returnhash{$key}=$username.':'.$domain;
5672: }
1.351 www 5673: }
1.948 raeburn 5674: }
1.400 www 5675: return %returnhash;
5676: }
5677:
5678: sub get_my_roles {
1.937 raeburn 5679: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 5680: unless (defined($uname)) { $uname=$env{'user.name'}; }
5681: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 5682: my (%dumphash,%nothide);
1.1086 raeburn 5683: if ($context eq 'userroles') {
1.1166 raeburn 5684: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 5685: } else {
1.1219 raeburn 5686: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 5687: if ($hidepriv) {
5688: my %coursehash=&coursedescription($udom.'_'.$uname);
5689: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5690: if ($user !~ /:/) {
5691: $nothide{join(':',split(/[\@]/,$user))} = 1;
5692: } else {
5693: $nothide{$user} = 1;
5694: }
5695: }
5696: }
1.858 raeburn 5697: }
1.400 www 5698: my %returnhash=();
5699: my $now=time;
1.999 raeburn 5700: my %privileged;
1.800 albertel 5701: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 5702: my ($role,$tend,$tstart);
5703: if ($context eq 'userroles') {
1.1149 raeburn 5704: next if ($entry =~ /^rolesdef/);
1.867 raeburn 5705: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
5706: } else {
5707: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
5708: }
1.400 www 5709: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 5710: my $status = 'active';
1.939 raeburn 5711: if (($tend) && ($tend<=$now)) {
1.832 raeburn 5712: $status = 'previous';
5713: }
5714: if (($tstart) && ($now<$tstart)) {
5715: $status = 'future';
5716: }
5717: if (ref($types) eq 'ARRAY') {
5718: if (!grep(/^\Q$status\E$/,@{$types})) {
5719: next;
5720: }
5721: } else {
5722: if ($status ne 'active') {
5723: next;
5724: }
5725: }
1.867 raeburn 5726: my ($rolecode,$username,$domain,$section,$area);
5727: if ($context eq 'userroles') {
1.1186 raeburn 5728: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 5729: (undef,$domain,$username,$section) = split(/\//,$area);
5730: } else {
5731: ($role,$username,$domain,$section) = split(/\:/,$entry);
5732: }
1.832 raeburn 5733: if (ref($roledoms) eq 'ARRAY') {
5734: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
5735: next;
5736: }
5737: }
5738: if (ref($roles) eq 'ARRAY') {
5739: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 5740: if ($role =~ /^cr\//) {
5741: if (!grep(/^cr$/,@{$roles})) {
5742: next;
5743: }
1.1104 raeburn 5744: } elsif ($role =~ /^gr\//) {
5745: if (!grep(/^gr$/,@{$roles})) {
5746: next;
5747: }
1.922 raeburn 5748: } else {
5749: next;
5750: }
1.832 raeburn 5751: }
1.867 raeburn 5752: }
1.937 raeburn 5753: if ($hidepriv) {
1.1219 raeburn 5754: my @privroles = ('dc','su');
1.999 raeburn 5755: if ($context eq 'userroles') {
1.1219 raeburn 5756: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 5757: } else {
1.1219 raeburn 5758: my $possdoms = [$domain];
5759: if (ref($roledoms) eq 'ARRAY') {
5760: push(@{$possdoms},@{$roledoms});
1.999 raeburn 5761: }
1.1219 raeburn 5762: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 5763: if (!$nothide{$username.':'.$domain}) {
5764: next;
5765: }
5766: }
1.937 raeburn 5767: }
5768: }
1.933 raeburn 5769: if ($withsec) {
5770: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
5771: $tstart.':'.$tend;
5772: } else {
5773: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
5774: }
1.832 raeburn 5775: }
1.373 www 5776: return %returnhash;
1.399 www 5777: }
5778:
1.1333 raeburn 5779: sub get_all_adhocroles {
5780: my ($dom) = @_;
5781: my @roles_by_num = ();
5782: my %domdefaults = &get_domain_defaults($dom);
5783: my (%description,%access_in_dom,%access_info);
5784: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
5785: my $count = 0;
5786: my %domcurrent = %{$domdefaults{'adhocroles'}};
5787: my %ordered;
5788: foreach my $role (sort(keys(%domcurrent))) {
5789: my ($order,$desc,$access_in_dom);
5790: if (ref($domcurrent{$role}) eq 'HASH') {
5791: $order = $domcurrent{$role}{'order'};
5792: $desc = $domcurrent{$role}{'desc'};
5793: $access_in_dom{$role} = $domcurrent{$role}{'access'};
5794: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
5795: }
5796: if ($order eq '') {
5797: $order = $count;
5798: }
5799: $ordered{$order} = $role;
5800: if ($desc ne '') {
5801: $description{$role} = $desc;
5802: } else {
5803: $description{$role}= $role;
5804: }
5805: $count++;
5806: }
5807: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
5808: push(@roles_by_num,$ordered{$item});
5809: }
5810: }
5811: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
5812: }
5813:
1.1332 raeburn 5814: sub get_my_adhocroles {
1.1333 raeburn 5815: my ($cid,$checkreg) = @_;
5816: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
5817: if ($env{'request.course.id'} eq $cid) {
5818: $cdom = $env{'course.'.$cid.'.domain'};
5819: $cnum = $env{'course.'.$cid.'.num'};
5820: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
5821: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
5822: $cdom = $1;
5823: $cnum = $2;
1.1494 raeburn 5824: %info = &get('environment',['internal.coursecode'],
5825: $cdom,$cnum);
1.1333 raeburn 5826: }
5827: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
5828: my $user = $env{'user.name'}.':'.$env{'user.domain'};
5829: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
5830: if ($rosterhash{$user} ne '') {
5831: my $type = (split(/:/,$rosterhash{$user}))[5];
5832: return ([],{}) if ($type eq 'auto');
5833: }
5834: }
5835: if (($cdom ne '') && ($cnum ne '')) {
1.1334 raeburn 5836: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1332 raeburn 5837: my $then=$env{'user.login.time'};
5838: my $update=$env{'user.update.time'};
1.1335 raeburn 5839: if (!$update) {
5840: $update = $then;
5841: }
5842: my @liveroles;
1.1334 raeburn 5843: foreach my $role ('dh','da') {
5844: if ($env{"user.role.$role./$cdom/"}) {
1.1335 raeburn 5845: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
1.1334 raeburn 5846: my $limit = $update;
5847: if ($env{'request.role'} eq "$role./$cdom/") {
5848: $limit = $then;
5849: }
1.1335 raeburn 5850: my $activerole = 1;
5851: if ($tstart && $tstart>$limit) { $activerole = 0; }
5852: if ($tend && $tend <$limit) { $activerole = 0; }
5853: if ($activerole) {
5854: push(@liveroles,$role);
5855: }
1.1334 raeburn 5856: }
1.1332 raeburn 5857: }
1.1335 raeburn 5858: if (@liveroles) {
1.1332 raeburn 5859: if (&homeserver($cnum,$cdom) ne 'no_host') {
1.1333 raeburn 5860: my ($accessref,$accessinfo,%access_in_dom);
5861: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
5862: if (ref($roles_by_num) eq 'ARRAY') {
5863: if (@{$roles_by_num}) {
1.1332 raeburn 5864: my %settings;
5865: if ($env{'request.course.id'} eq $cid) {
5866: foreach my $envkey (keys(%env)) {
5867: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
5868: $settings{$1} = $env{$envkey};
5869: }
5870: }
5871: } else {
5872: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
5873: }
5874: my %setincrs;
5875: if ($settings{'internal.adhocaccess'}) {
5876: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
5877: }
5878: my @statuses;
5879: if ($env{'environment.inststatus'}) {
5880: @statuses = split(/,/,$env{'environment.inststatus'});
5881: }
5882: my $user = $env{'user.name'}.':'.$env{'user.domain'};
1.1333 raeburn 5883: if (ref($accessref) eq 'HASH') {
5884: %access_in_dom = %{$accessref};
5885: }
5886: foreach my $role (@{$roles_by_num}) {
1.1332 raeburn 5887: my ($curraccess,@okstatus,@personnel);
5888: if ($setincrs{$role}) {
5889: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
5890: if ($curraccess eq 'status') {
5891: @okstatus = split(/\&/,$rest);
5892: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5893: @personnel = split(/\&/,$rest);
5894: }
5895: } else {
5896: $curraccess = $access_in_dom{$role};
1.1333 raeburn 5897: if (ref($accessinfo) eq 'HASH') {
5898: if ($curraccess eq 'status') {
5899: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5900: @okstatus = @{$accessinfo->{$role}};
5901: }
5902: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5903: if (ref($accessinfo->{$role}) eq 'ARRAY') {
5904: @personnel = @{$accessinfo->{$role}};
5905: }
1.1332 raeburn 5906: }
5907: }
5908: }
5909: if ($curraccess eq 'none') {
5910: next;
5911: } elsif ($curraccess eq 'all') {
5912: push(@possroles,$role);
1.1336 raeburn 5913: } elsif ($curraccess eq 'dh') {
1.1335 raeburn 5914: if (grep(/^dh$/,@liveroles)) {
5915: push(@possroles,$role);
5916: } else {
5917: next;
5918: }
1.1336 raeburn 5919: } elsif ($curraccess eq 'da') {
1.1335 raeburn 5920: if (grep(/^da$/,@liveroles)) {
5921: push(@possroles,$role);
5922: } else {
5923: next;
5924: }
1.1332 raeburn 5925: } elsif ($curraccess eq 'status') {
5926: if (@okstatus) {
5927: if (!@statuses) {
5928: if (grep(/^default$/,@okstatus)) {
5929: push(@possroles,$role);
5930: }
5931: } else {
5932: foreach my $status (@okstatus) {
5933: if (grep(/^\Q$status\E$/,@statuses)) {
5934: push(@possroles,$role);
5935: last;
5936: }
5937: }
5938: }
5939: }
5940: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
5941: if (grep(/^\Q$user\E$/,@personnel)) {
5942: if ($curraccess eq 'exc') {
5943: push(@possroles,$role);
5944: }
5945: } elsif ($curraccess eq 'inc') {
5946: push(@possroles,$role);
5947: }
5948: }
5949: }
5950: }
5951: }
5952: }
5953: }
5954: }
5955: }
1.1333 raeburn 5956: unless (ref($description) eq 'HASH') {
5957: if (ref($roles_by_num) eq 'ARRAY') {
5958: my %desc;
5959: map { $desc{$_} = $_; } (@{$roles_by_num});
5960: $description = \%desc;
5961: } else {
5962: $description = {};
5963: }
5964: }
5965: return (\@possroles,$description);
1.1332 raeburn 5966: }
5967:
1.399 www 5968: # ----------------------------------------------------- Frontpage Announcements
5969: #
5970: #
5971:
5972: sub postannounce {
5973: my ($server,$text)=@_;
1.844 albertel 5974: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 5975: unless ($text=~/\w/) { $text=''; }
5976: return &reply('setannounce:'.&escape($text),$server);
5977: }
5978:
5979: sub getannounce {
1.448 albertel 5980:
1.1359 raeburn 5981: if (open(my $fh,"<",$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 5982: my $announcement='';
1.800 albertel 5983: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 5984: close($fh);
1.399 www 5985: if ($announcement=~/\w/) {
5986: return
5987: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 5988: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 5989: } else {
5990: return '';
5991: }
5992: } else {
5993: return '';
5994: }
1.351 www 5995: }
1.353 www 5996:
5997: # ---------------------------------------------------------- Course ID routines
5998: # Deal with domain's nohist_courseid.db files
5999: #
6000:
6001: sub courseidput {
1.921 raeburn 6002: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 6003: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 6004: my $outcome;
6005: if ($caller eq 'timeonly') {
6006: my $cids = '';
6007: foreach my $item (keys(%$storehash)) {
6008: $cids.=&escape($item).'&';
6009: }
6010: $cids=~s/\&$//;
6011: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
6012: $coursehome);
6013: } else {
6014: my $items = '';
6015: foreach my $item (keys(%$storehash)) {
6016: $items.= &escape($item).'='.
6017: &freeze_escape($$storehash{$item}).'&';
6018: }
6019: $items=~s/\&$//;
6020: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
6021: $coursehome);
1.918 raeburn 6022: }
6023: if ($outcome eq 'unknown_cmd') {
6024: my $what;
6025: foreach my $cid (keys(%$storehash)) {
6026: $what .= &escape($cid).'=';
1.921 raeburn 6027: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 6028: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 6029: }
6030: $what =~ s/\:$/&/;
6031: }
6032: $what =~ s/\&$//;
6033: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
6034: } else {
6035: return $outcome;
6036: }
1.353 www 6037: }
6038:
6039: sub courseiddump {
1.921 raeburn 6040: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 6041: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 6042: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247 raeburn 6043: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287 raeburn 6044: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 6045: my $as_hash = 1;
6046: my %returnhash;
6047: if (!$domfilter) { $domfilter=''; }
1.845 albertel 6048: my %libserv = &all_library();
6049: foreach my $tryserver (keys(%libserv)) {
6050: if ( ( $hostidflag == 1
6051: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
6052: || (!defined($hostidflag)) ) {
6053:
1.918 raeburn 6054: if (($domfilter eq '') ||
6055: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 6056: my $rep;
6057: if (grep { $_ eq $tryserver } current_machine_ids()) {
6058: $rep = LONCAPA::Lond::dump_course_id_handler(
6059: join(":", (&host_domain($tryserver), $sincefilter,
6060: &escape($descfilter), &escape($instcodefilter),
6061: &escape($ownerfilter), &escape($coursefilter),
6062: &escape($typefilter), &escape($regexp_ok),
6063: $as_hash, &escape($selfenrollonly),
6064: &escape($catfilter), $showhidden, $caller,
6065: &escape($cloner), &escape($cc_clone), $cloneonly,
6066: &escape($createdbefore), &escape($createdafter),
1.1287 raeburn 6067: &escape($creationcontext),$domcloner,$hasuniquecode,
6068: $reqcrsdom,&escape($reqinstcode))));
1.1180 droeschl 6069: } else {
6070: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
6071: $sincefilter.':'.&escape($descfilter).':'.
6072: &escape($instcodefilter).':'.&escape($ownerfilter).
6073: ':'.&escape($coursefilter).':'.&escape($typefilter).
6074: ':'.&escape($regexp_ok).':'.$as_hash.':'.
6075: &escape($selfenrollonly).':'.&escape($catfilter).':'.
6076: $showhidden.':'.$caller.':'.&escape($cloner).':'.
6077: &escape($cc_clone).':'.$cloneonly.':'.
6078: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287 raeburn 6079: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
6080: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180 droeschl 6081: }
6082:
1.918 raeburn 6083: my @pairs=split(/\&/,$rep);
6084: foreach my $item (@pairs) {
6085: my ($key,$value)=split(/\=/,$item,2);
6086: $key = &unescape($key);
6087: next if ($key =~ /^error: 2 /);
6088: my $result = &thaw_unescape($value);
6089: if (ref($result) eq 'HASH') {
6090: $returnhash{$key}=$result;
6091: } else {
1.921 raeburn 6092: my @responses = split(/:/,$value);
6093: my @items = ('description','inst_code','owner','type');
1.918 raeburn 6094: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 6095: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 6096: }
1.1008 raeburn 6097: }
1.353 www 6098: }
6099: }
6100: }
6101: }
6102: return %returnhash;
6103: }
6104:
1.1055 raeburn 6105: sub courselastaccess {
6106: my ($cdom,$cnum,$hostidref) = @_;
6107: my %returnhash;
6108: if ($cdom && $cnum) {
6109: my $chome = &homeserver($cnum,$cdom);
6110: if ($chome ne 'no_host') {
6111: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
6112: &extract_lastaccess(\%returnhash,$rep);
6113: }
6114: } else {
6115: if (!$cdom) { $cdom=''; }
6116: my %libserv = &all_library();
6117: foreach my $tryserver (keys(%libserv)) {
6118: if (ref($hostidref) eq 'ARRAY') {
6119: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
6120: }
6121: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
6122: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
6123: &extract_lastaccess(\%returnhash,$rep);
6124: }
6125: }
6126: }
6127: return %returnhash;
6128: }
6129:
6130: sub extract_lastaccess {
6131: my ($returnhash,$rep) = @_;
6132: if (ref($returnhash) eq 'HASH') {
6133: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
6134: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
6135: $rep eq '') {
6136: my @pairs=split(/\&/,$rep);
6137: foreach my $item (@pairs) {
6138: my ($key,$value)=split(/\=/,$item,2);
6139: $key = &unescape($key);
6140: next if ($key =~ /^error: 2 /);
6141: $returnhash->{$key} = &thaw_unescape($value);
6142: }
6143: }
6144: }
6145: return;
6146: }
6147:
1.658 raeburn 6148: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 6149:
6150: sub dcmailput {
1.685 raeburn 6151: my ($domain,$msgid,$message,$server)=@_;
1.1494 raeburn 6152: my $status = &critical(
1.740 www 6153: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
6154: &escape($message),$server);
1.662 raeburn 6155: return $status;
6156: }
6157:
1.658 raeburn 6158: sub dcmaildump {
6159: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 6160: my %returnhash=();
1.846 albertel 6161:
6162: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 6163: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
6164: &escape($enddate).':';
6165: my @esc_senders=map { &escape($_)} @$senders;
6166: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 6167: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 6168: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 6169: if (($key) && ($value)) {
6170: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 6171: }
6172: }
6173: }
6174: return %returnhash;
6175: }
1.662 raeburn 6176: # ---------------------------------------------------------- Domain roles
6177:
6178: sub get_domain_roles {
6179: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 6180: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 6181: $startdate = '.';
6182: }
1.1018 raeburn 6183: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 6184: $enddate = '.';
6185: }
1.922 raeburn 6186: my $rolelist;
6187: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 6188: $rolelist = join('&',@{$roles});
1.922 raeburn 6189: }
1.662 raeburn 6190: my %personnel = ();
1.841 albertel 6191:
6192: my %servers = &get_servers($dom,'library');
6193: foreach my $tryserver (keys(%servers)) {
6194: %{$personnel{$tryserver}}=();
6195: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
6196: &escape($startdate).':'.
6197: &escape($enddate).':'.
6198: &escape($rolelist), $tryserver))) {
6199: my ($key,$value) = split(/\=/,$line,2);
6200: if (($key) && ($value)) {
6201: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
6202: }
6203: }
1.662 raeburn 6204: }
6205: return %personnel;
6206: }
1.658 raeburn 6207:
1.1332 raeburn 6208: sub get_active_domroles {
6209: my ($dom,$roles) = @_;
6210: return () unless (ref($roles) eq 'ARRAY');
6211: my $now = time;
6212: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
6213: my %domroles;
6214: foreach my $server (keys(%dompersonnel)) {
6215: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
6216: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
6217: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
6218: }
6219: }
6220: return %domroles;
6221: }
6222:
1.1057 www 6223: # ----------------------------------------------------------- Interval timing
1.149 www 6224:
1.1153 www 6225: {
6226: # Caches needed for speedup of navmaps
6227: # We don't want to cache this for very long at all (5 seconds at most)
6228: #
6229: # The user for whom we cache
6230: my $cachedkey='';
6231: # The cached times for this user
6232: my %cachedtimes=();
6233: # When this was last done
1.1282 raeburn 6234: my $cachedtime='';
1.1153 www 6235:
6236: sub load_all_first_access {
1.1308 raeburn 6237: my ($uname,$udom,$ignorecache)=@_;
1.1156 www 6238: if (($cachedkey eq $uname.':'.$udom) &&
1.1308 raeburn 6239: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'}) &&
6240: (!$ignorecache)) {
1.1154 raeburn 6241: return;
6242: }
6243: $cachedtime=time;
6244: $cachedkey=$uname.':'.$udom;
6245: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 6246: }
6247:
1.504 albertel 6248: sub get_first_access {
1.1308 raeburn 6249: my ($type,$argsymb,$argmap,$ignorecache)=@_;
1.790 albertel 6250: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 6251: if ($argsymb) { $symb=$argsymb; }
6252: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 6253: if ($argmap) { $map = $argmap; }
1.926 albertel 6254: if ($type eq 'course') {
6255: $res='course';
6256: } elsif ($type eq 'map') {
1.588 albertel 6257: $res=&symbread($map);
6258: } else {
6259: $res=$symb;
6260: }
1.1308 raeburn 6261: &load_all_first_access($uname,$udom,$ignorecache);
1.1153 www 6262: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 6263: }
6264:
6265: sub set_first_access {
1.1162 raeburn 6266: my ($type,$interval)=@_;
1.790 albertel 6267: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 6268: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 6269: if ($type eq 'course') {
6270: $res='course';
6271: } elsif ($type eq 'map') {
1.588 albertel 6272: $res=&symbread($map);
6273: } else {
6274: $res=$symb;
6275: }
1.1153 www 6276: $cachedkey='';
1.1162 raeburn 6277: my $firstaccess=&get_first_access($type,$symb,$map);
1.1386 raeburn 6278: if ($firstaccess) {
6279: &logthis("First access time already set ($firstaccess) when attempting ".
1.1393 raeburn 6280: "to set new value (type: $type, extent: $res) for $uname:$udom ".
6281: "in $courseid");
1.1386 raeburn 6282: return 'already_set';
6283: } else {
1.1162 raeburn 6284: my $start = time;
6285: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
6286: $udom,$uname);
6287: if ($putres eq 'ok') {
6288: &put('timerinterval',{"$courseid\0$res"=>$interval},
6289: $udom,$uname);
6290: &appenv(
6291: {
6292: 'course.'.$courseid.'.firstaccess.'.$res => $start,
6293: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
6294: }
6295: );
1.1365 raeburn 6296: if (($cachedtime) && (abs($start-$cachedtime) < 5)) {
6297: $cachedtimes{"$courseid\0$res"} = $start;
6298: }
1.1386 raeburn 6299: } elsif ($putres ne 'refused') {
6300: &logthis("Result: $putres when attempting to set first access time ".
6301: "(type: $type, extent: $res) for $uname:$udom in $courseid");
1.1162 raeburn 6302: }
6303: return $putres;
1.505 albertel 6304: }
6305: return 'already_set';
1.504 albertel 6306: }
1.1153 www 6307: }
1.1282 raeburn 6308:
1.110 www 6309: # --------------------------------------------- Set Expire Date for Spreadsheet
6310:
6311: sub expirespread {
6312: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 6313: my $cid=$env{'request.course.id'};
1.110 www 6314: if ($cid) {
6315: my $now=time;
6316: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 6317: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
6318: $env{'course.'.$cid.'.num'}.
1.110 www 6319: ':nohist_expirationdates:'.
6320: &escape($key).'='.$now,
1.620 albertel 6321: $env{'course.'.$cid.'.home'})
1.110 www 6322: }
6323: return 'ok';
1.14 www 6324: }
6325:
1.109 www 6326: # ----------------------------------------------------- Devalidate Spreadsheets
6327:
6328: sub devalidate {
1.325 www 6329: my ($symb,$uname,$udom)=@_;
1.620 albertel 6330: my $cid=$env{'request.course.id'};
1.109 www 6331: if ($cid) {
1.391 matthew 6332: # delete the stored spreadsheets for
6333: # - the student level sheet of this user in course's homespace
6334: # - the assessment level sheet for this resource
6335: # for this user in user's homespace
1.553 albertel 6336: # - current conditional state info
1.325 www 6337: my $key=$uname.':'.$udom.':';
1.109 www 6338: my $status=
1.299 matthew 6339: &del('nohist_calculatedsheets',
1.391 matthew 6340: [$key.'studentcalc:'],
1.620 albertel 6341: $env{'course.'.$cid.'.domain'},
6342: $env{'course.'.$cid.'.num'})
1.133 albertel 6343: .' '.
6344: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 6345: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 6346: unless ($status eq 'ok ok') {
6347: &logthis('Could not devalidate spreadsheet '.
1.325 www 6348: $uname.' at '.$udom.' for '.
1.109 www 6349: $symb.': '.$status);
1.133 albertel 6350: }
1.553 albertel 6351: &delenv('user.state.'.$cid);
1.109 www 6352: }
6353: }
6354:
1.265 albertel 6355: sub get_scalar {
6356: my ($string,$end) = @_;
6357: my $value;
6358: if ($$string =~ s/^([^&]*?)($end)/$2/) {
6359: $value = $1;
6360: } elsif ($$string =~ s/^([^&]*?)&//) {
6361: $value = $1;
6362: }
6363: return &unescape($value);
6364: }
6365:
6366: sub array2str {
6367: my (@array) = @_;
6368: my $result=&arrayref2str(\@array);
6369: $result=~s/^__ARRAY_REF__//;
6370: $result=~s/__END_ARRAY_REF__$//;
6371: return $result;
6372: }
6373:
1.204 albertel 6374: sub arrayref2str {
6375: my ($arrayref) = @_;
1.265 albertel 6376: my $result='__ARRAY_REF__';
1.204 albertel 6377: foreach my $elem (@$arrayref) {
1.265 albertel 6378: if(ref($elem) eq 'ARRAY') {
6379: $result.=&arrayref2str($elem).'&';
6380: } elsif(ref($elem) eq 'HASH') {
6381: $result.=&hashref2str($elem).'&';
6382: } elsif(ref($elem)) {
6383: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 6384: } else {
6385: $result.=&escape($elem).'&';
6386: }
6387: }
6388: $result=~s/\&$//;
1.265 albertel 6389: $result .= '__END_ARRAY_REF__';
1.204 albertel 6390: return $result;
6391: }
6392:
1.168 albertel 6393: sub hash2str {
1.204 albertel 6394: my (%hash) = @_;
6395: my $result=&hashref2str(\%hash);
1.265 albertel 6396: $result=~s/^__HASH_REF__//;
6397: $result=~s/__END_HASH_REF__$//;
1.204 albertel 6398: return $result;
6399: }
6400:
6401: sub hashref2str {
6402: my ($hashref)=@_;
1.265 albertel 6403: my $result='__HASH_REF__';
1.800 albertel 6404: foreach my $key (sort(keys(%$hashref))) {
6405: if (ref($key) eq 'ARRAY') {
6406: $result.=&arrayref2str($key).'=';
6407: } elsif (ref($key) eq 'HASH') {
6408: $result.=&hashref2str($key).'=';
6409: } elsif (ref($key)) {
1.265 albertel 6410: $result.='=';
1.800 albertel 6411: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 6412: } else {
1.1132 raeburn 6413: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 6414: }
6415:
1.800 albertel 6416: if(ref($hashref->{$key}) eq 'ARRAY') {
6417: $result.=&arrayref2str($hashref->{$key}).'&';
6418: } elsif(ref($hashref->{$key}) eq 'HASH') {
6419: $result.=&hashref2str($hashref->{$key}).'&';
6420: } elsif(ref($hashref->{$key})) {
1.265 albertel 6421: $result.='&';
1.800 albertel 6422: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 6423: } else {
1.800 albertel 6424: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 6425: }
6426: }
1.168 albertel 6427: $result=~s/\&$//;
1.265 albertel 6428: $result .= '__END_HASH_REF__';
1.168 albertel 6429: return $result;
6430: }
6431:
6432: sub str2hash {
1.265 albertel 6433: my ($string)=@_;
6434: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
6435: return %$hash;
6436: }
6437:
6438: sub str2hashref {
1.168 albertel 6439: my ($string) = @_;
1.265 albertel 6440:
6441: my %hash;
6442:
6443: if($string !~ /^__HASH_REF__/) {
6444: if (! ($string eq '' || !defined($string))) {
6445: $hash{'error'}='Not hash reference';
6446: }
6447: return (\%hash, $string);
6448: }
6449:
6450: $string =~ s/^__HASH_REF__//;
6451:
6452: while($string !~ /^__END_HASH_REF__/) {
6453: #key
6454: my $key='';
6455: if($string =~ /^__HASH_REF__/) {
6456: ($key, $string)=&str2hashref($string);
6457: if(defined($key->{'error'})) {
6458: $hash{'error'}='Bad data';
6459: return (\%hash, $string);
6460: }
6461: } elsif($string =~ /^__ARRAY_REF__/) {
6462: ($key, $string)=&str2arrayref($string);
6463: if($key->[0] eq 'Array reference error') {
6464: $hash{'error'}='Bad data';
6465: return (\%hash, $string);
6466: }
6467: } else {
6468: $string =~ s/^(.*?)=//;
1.267 albertel 6469: $key=&unescape($1);
1.265 albertel 6470: }
6471: $string =~ s/^=//;
6472:
6473: #value
6474: my $value='';
6475: if($string =~ /^__HASH_REF__/) {
6476: ($value, $string)=&str2hashref($string);
6477: if(defined($value->{'error'})) {
6478: $hash{'error'}='Bad data';
6479: return (\%hash, $string);
6480: }
6481: } elsif($string =~ /^__ARRAY_REF__/) {
6482: ($value, $string)=&str2arrayref($string);
6483: if($value->[0] eq 'Array reference error') {
6484: $hash{'error'}='Bad data';
6485: return (\%hash, $string);
6486: }
6487: } else {
6488: $value=&get_scalar(\$string,'__END_HASH_REF__');
6489: }
6490: $string =~ s/^&//;
6491:
6492: $hash{$key}=$value;
1.204 albertel 6493: }
1.265 albertel 6494:
6495: $string =~ s/^__END_HASH_REF__//;
6496:
6497: return (\%hash, $string);
1.204 albertel 6498: }
6499:
6500: sub str2array {
1.265 albertel 6501: my ($string)=@_;
6502: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
6503: return @$array;
6504: }
6505:
6506: sub str2arrayref {
1.204 albertel 6507: my ($string) = @_;
1.265 albertel 6508: my @array;
6509:
6510: if($string !~ /^__ARRAY_REF__/) {
6511: if (! ($string eq '' || !defined($string))) {
6512: $array[0]='Array reference error';
6513: }
6514: return (\@array, $string);
6515: }
6516:
6517: $string =~ s/^__ARRAY_REF__//;
6518:
6519: while($string !~ /^__END_ARRAY_REF__/) {
6520: my $value='';
6521: if($string =~ /^__HASH_REF__/) {
6522: ($value, $string)=&str2hashref($string);
6523: if(defined($value->{'error'})) {
6524: $array[0] ='Array reference error';
6525: return (\@array, $string);
6526: }
6527: } elsif($string =~ /^__ARRAY_REF__/) {
6528: ($value, $string)=&str2arrayref($string);
6529: if($value->[0] eq 'Array reference error') {
6530: $array[0] ='Array reference error';
6531: return (\@array, $string);
6532: }
6533: } else {
6534: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
6535: }
6536: $string =~ s/^&//;
6537:
6538: push(@array, $value);
1.191 harris41 6539: }
1.265 albertel 6540:
6541: $string =~ s/^__END_ARRAY_REF__//;
6542:
6543: return (\@array, $string);
1.168 albertel 6544: }
6545:
1.167 albertel 6546: # -------------------------------------------------------------------Temp Store
6547:
1.168 albertel 6548: sub tmpreset {
6549: my ($symb,$namespace,$domain,$stuname) = @_;
6550: if (!$symb) {
6551: $symb=&symbread();
1.620 albertel 6552: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6553: }
6554: $symb=escape($symb);
6555:
1.620 albertel 6556: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 6557: $namespace=~s/\//\_/g;
6558: $namespace=~s/\W//g;
6559:
1.620 albertel 6560: if (!$domain) { $domain=$env{'user.domain'}; }
6561: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6562: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6563: $stuname=&get_requestor_ip();
1.591 albertel 6564: }
1.1117 foxr 6565: my $path=LONCAPA::tempdir();
1.168 albertel 6566: my %hash;
6567: if (tie(%hash,'GDBM_File',
6568: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6569: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 6570: foreach my $key (keys(%hash)) {
1.180 albertel 6571: if ($key=~ /:$symb/) {
1.168 albertel 6572: delete($hash{$key});
6573: }
6574: }
6575: }
6576: }
6577:
1.167 albertel 6578: sub tmpstore {
1.168 albertel 6579: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
6580:
6581: if (!$symb) {
6582: $symb=&symbread();
1.620 albertel 6583: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6584: }
6585: $symb=escape($symb);
6586:
6587: if (!$namespace) {
6588: # I don't think we would ever want to store this for a course.
6589: # it seems this will only be used if we don't have a course.
1.620 albertel 6590: #$namespace=$env{'request.course.id'};
1.168 albertel 6591: #if (!$namespace) {
1.620 albertel 6592: $namespace=$env{'request.state'};
1.168 albertel 6593: #}
6594: }
6595: $namespace=~s/\//\_/g;
6596: $namespace=~s/\W//g;
1.620 albertel 6597: if (!$domain) { $domain=$env{'user.domain'}; }
6598: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6599: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6600: $stuname=&get_requestor_ip();
1.591 albertel 6601: }
1.168 albertel 6602: my $now=time;
6603: my %hash;
1.1117 foxr 6604: my $path=LONCAPA::tempdir();
1.168 albertel 6605: if (tie(%hash,'GDBM_File',
6606: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6607: &GDBM_WRCREAT(),0640)) {
1.168 albertel 6608: $hash{"version:$symb"}++;
6609: my $version=$hash{"version:$symb"};
6610: my $allkeys='';
6611: foreach my $key (keys(%$storehash)) {
6612: $allkeys.=$key.':';
1.591 albertel 6613: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 6614: }
6615: $hash{"$version:$symb:timestamp"}=$now;
6616: $allkeys.='timestamp';
6617: $hash{"$version:keys:$symb"}=$allkeys;
6618: if (untie(%hash)) {
6619: return 'ok';
6620: } else {
6621: return "error:$!";
6622: }
6623: } else {
6624: return "error:$!";
6625: }
6626: }
1.167 albertel 6627:
1.168 albertel 6628: # -----------------------------------------------------------------Temp Restore
1.167 albertel 6629:
1.168 albertel 6630: sub tmprestore {
6631: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 6632:
1.168 albertel 6633: if (!$symb) {
6634: $symb=&symbread();
1.620 albertel 6635: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 6636: }
6637: $symb=escape($symb);
6638:
1.620 albertel 6639: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 6640:
1.620 albertel 6641: if (!$domain) { $domain=$env{'user.domain'}; }
6642: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 6643: if ($domain eq 'public' && $stuname eq 'public') {
1.1434 raeburn 6644: $stuname=&get_requestor_ip();
1.591 albertel 6645: }
1.168 albertel 6646: my %returnhash;
6647: $namespace=~s/\//\_/g;
6648: $namespace=~s/\W//g;
6649: my %hash;
1.1117 foxr 6650: my $path=LONCAPA::tempdir();
1.168 albertel 6651: if (tie(%hash,'GDBM_File',
6652: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 6653: &GDBM_READER(),0640)) {
1.168 albertel 6654: my $version=$hash{"version:$symb"};
6655: $returnhash{'version'}=$version;
6656: my $scope;
6657: for ($scope=1;$scope<=$version;$scope++) {
6658: my $vkeys=$hash{"$scope:keys:$symb"};
6659: my @keys=split(/:/,$vkeys);
6660: my $key;
6661: $returnhash{"$scope:keys"}=$vkeys;
6662: foreach $key (@keys) {
1.591 albertel 6663: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
6664: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 6665: }
6666: }
1.168 albertel 6667: if (!(untie(%hash))) {
6668: return "error:$!";
6669: }
6670: } else {
6671: return "error:$!";
6672: }
6673: return %returnhash;
1.167 albertel 6674: }
6675:
1.9 www 6676: # ----------------------------------------------------------------------- Store
6677:
6678: sub store {
1.1269 raeburn 6679: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6680: my $home='';
6681:
1.168 albertel 6682: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6683:
1.213 www 6684: $symb=&symbclean($symb);
1.122 albertel 6685: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6686:
1.620 albertel 6687: if (!$domain) { $domain=$env{'user.domain'}; }
6688: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6689:
6690: &devalidate($symb,$stuname,$domain);
1.109 www 6691:
6692: $symb=escape($symb);
1.187 www 6693: if (!$namespace) {
1.620 albertel 6694: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6695: return '';
6696: }
6697: }
1.620 albertel 6698: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6699:
1.1434 raeburn 6700: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6701: $$storehash{'host'}=$perlvar{'lonHostID'};
6702:
1.12 www 6703: my $namevalue='';
1.800 albertel 6704: foreach my $key (keys(%$storehash)) {
6705: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6706: }
1.12 www 6707: $namevalue=~s/\&$//;
1.187 www 6708: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269 raeburn 6709: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 6710: }
6711:
1.47 www 6712: # -------------------------------------------------------------- Critical Store
6713:
6714: sub cstore {
1.1269 raeburn 6715: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 6716: my $home='';
6717:
1.168 albertel 6718: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6719:
1.213 www 6720: $symb=&symbclean($symb);
1.122 albertel 6721: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 6722:
1.620 albertel 6723: if (!$domain) { $domain=$env{'user.domain'}; }
6724: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 6725:
6726: &devalidate($symb,$stuname,$domain);
1.109 www 6727:
6728: $symb=escape($symb);
1.187 www 6729: if (!$namespace) {
1.620 albertel 6730: unless ($namespace=$env{'request.course.id'}) {
1.187 www 6731: return '';
6732: }
6733: }
1.620 albertel 6734: if (!$home) { $home=$env{'user.home'}; }
1.447 www 6735:
1.1434 raeburn 6736: $$storehash{'ip'}=&get_requestor_ip();
1.447 www 6737: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 6738:
1.47 www 6739: my $namevalue='';
1.800 albertel 6740: foreach my $key (keys(%$storehash)) {
6741: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 6742: }
1.47 www 6743: $namevalue=~s/\&$//;
1.187 www 6744: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 6745: return critical
1.1269 raeburn 6746: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 6747: }
6748:
1.9 www 6749: # --------------------------------------------------------------------- Restore
6750:
6751: sub restore {
1.124 www 6752: my ($symb,$namespace,$domain,$stuname) = @_;
6753: my $home='';
6754:
1.168 albertel 6755: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 6756:
1.122 albertel 6757: if (!$symb) {
1.1224 raeburn 6758: return if ($namespace eq 'courserequests');
6759: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 6760: } else {
1.1224 raeburn 6761: unless ($namespace eq 'courserequests') {
6762: $symb=&escape(&symbclean($symb));
6763: }
1.122 albertel 6764: }
1.188 www 6765: if (!$namespace) {
1.620 albertel 6766: unless ($namespace=$env{'request.course.id'}) {
1.188 www 6767: return '';
6768: }
6769: }
1.620 albertel 6770: if (!$domain) { $domain=$env{'user.domain'}; }
6771: if (!$stuname) { $stuname=$env{'user.name'}; }
6772: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 6773: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
6774:
1.12 www 6775: my %returnhash=();
1.800 albertel 6776: foreach my $line (split(/\&/,$answer)) {
6777: my ($name,$value)=split(/\=/,$line);
1.591 albertel 6778: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 6779: }
1.75 www 6780: my $version;
6781: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 6782: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
6783: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 6784: }
1.75 www 6785: }
1.13 www 6786: return %returnhash;
1.34 www 6787: }
6788:
6789: # ---------------------------------------------------------- Course Description
1.1118 foxr 6790: #
6791: #
1.34 www 6792:
6793: sub coursedescription {
1.731 albertel 6794: my ($courseid,$args)=@_;
1.34 www 6795: $courseid=~s/^\///;
1.49 www 6796: $courseid=~s/\_/\//g;
1.34 www 6797: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 6798: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 6799: my $normalid=$cdomain.'_'.$cnum;
6800: # need to always cache even if we get errors otherwise we keep
6801: # trying and trying and trying to get the course description.
6802: my %envhash=();
6803: my %returnhash=();
1.731 albertel 6804:
6805: my $expiretime=600;
6806: if ($env{'request.course.id'} eq $normalid) {
6807: $expiretime=120;
6808: }
6809:
6810: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
6811: if (!$args->{'freshen_cache'}
6812: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
6813: foreach my $key (keys(%env)) {
6814: next if ($key !~ /^\Q$prefix\E(.*)/);
6815: my ($setting) = $1;
6816: $returnhash{$setting} = $env{$key};
6817: }
6818: return %returnhash;
6819: }
6820:
1.1118 foxr 6821: # get the data again
6822:
1.731 albertel 6823: if (!$args->{'one_time'}) {
6824: $envhash{'course.'.$normalid.'.last_cache'}=time;
6825: }
1.811 albertel 6826:
1.34 www 6827: if ($chome ne 'no_host') {
1.302 albertel 6828: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 6829: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 6830: my $username = $env{'user.name'}; # Defult username
6831: if(defined $args->{'user'}) {
6832: $username = $args->{'user'};
6833: }
1.129 albertel 6834: $returnhash{'home'}= $chome;
6835: $returnhash{'domain'} = $cdomain;
6836: $returnhash{'num'} = $cnum;
1.741 raeburn 6837: if (!defined($returnhash{'type'})) {
6838: $returnhash{'type'} = 'Course';
6839: }
1.130 albertel 6840: while (my ($name,$value) = each %returnhash) {
1.53 www 6841: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 6842: }
1.270 www 6843: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 6844: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 6845: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 6846: $envhash{'course.'.$normalid.'.home'}=$chome;
6847: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
6848: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 6849: }
6850: }
1.731 albertel 6851: if (!$args->{'one_time'}) {
1.949 raeburn 6852: &appenv(\%envhash);
1.731 albertel 6853: }
1.302 albertel 6854: return %returnhash;
1.461 www 6855: }
6856:
1.1080 raeburn 6857: sub update_released_required {
6858: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
6859: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
6860: $cid = $env{'request.course.id'};
6861: $cdom = $env{'course.'.$cid.'.domain'};
6862: $cnum = $env{'course.'.$cid.'.num'};
6863: $chome = $env{'course.'.$cid.'.home'};
6864: }
6865: if ($needsrelease) {
6866: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
6867: my $needsupdate;
6868: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
6869: $needsupdate = 1;
6870: } else {
6871: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
6872: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
6873: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
6874: $needsupdate = 1;
6875: }
6876: }
6877: if ($needsupdate) {
6878: my %needshash = (
6879: 'internal.releaserequired' => $needsrelease,
6880: );
6881: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
6882: if ($putresult eq 'ok') {
6883: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
6884: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6885: if (ref($crsinfo{$cid}) eq 'HASH') {
6886: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
6887: &courseidput($cdom,\%crsinfo,$chome,'notime');
6888: }
6889: }
6890: }
6891: }
6892: return;
6893: }
6894:
1.461 www 6895: # -------------------------------------------------See if a user is privileged
6896:
6897: sub privileged {
1.1219 raeburn 6898: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 6899: my $now = time;
1.1219 raeburn 6900: my $roles;
6901: if (ref($possroles) eq 'ARRAY') {
6902: $roles = $possroles;
6903: } else {
6904: $roles = ['dc','su'];
6905: }
6906: if (ref($possdomains) eq 'ARRAY') {
6907: my %privileged = &privileged_by_domain($possdomains,$roles);
6908: foreach my $dom (@{$possdomains}) {
6909: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
6910: (ref($privileged{$dom}) eq 'HASH')) {
6911: foreach my $role (@{$roles}) {
6912: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6913: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
6914: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
6915: return 1 unless (($end && $end < $now) ||
6916: ($start && $start > $now));
6917: }
6918: }
6919: }
6920: }
6921: }
6922: } else {
6923: my %rolesdump = &dump("roles", $domain, $username) or return 0;
6924: my $now = time;
1.1170 droeschl 6925:
1.1275 musolffc 6926: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 6927: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 6928: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 6929: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 6930: or ($tstart && $tstart > $now);
1.1170 droeschl 6931: }
1.1219 raeburn 6932: }
6933: }
6934: return 0;
6935: }
1.1170 droeschl 6936:
1.1219 raeburn 6937: sub privileged_by_domain {
6938: my ($domains,$roles) = @_;
6939: my %privileged = ();
6940: my $cachetime = 60*60*24;
6941: my $now = time;
6942: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
6943: return %privileged;
6944: }
6945: foreach my $dom (@{$domains}) {
6946: next if (ref($privileged{$dom}) eq 'HASH');
6947: my $needroles;
6948: foreach my $role (@{$roles}) {
6949: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
6950: if (defined($cached)) {
6951: if (ref($result) eq 'HASH') {
6952: $privileged{$dom}{$role} = $result;
6953: }
6954: } else {
6955: $needroles = 1;
6956: }
6957: }
6958: if ($needroles) {
6959: my %dompersonnel = &get_domain_roles($dom,$roles);
6960: $privileged{$dom} = {};
6961: foreach my $server (keys(%dompersonnel)) {
6962: if (ref($dompersonnel{$server}) eq 'HASH') {
6963: foreach my $item (keys(%{$dompersonnel{$server}})) {
6964: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
6965: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
6966: next if ($end && $end < $now);
6967: $privileged{$dom}{$trole}{$uname.':'.$udom} =
6968: $dompersonnel{$server}{$item};
6969: }
6970: }
6971: }
6972: if (ref($privileged{$dom}) eq 'HASH') {
6973: foreach my $role (@{$roles}) {
6974: if (ref($privileged{$dom}{$role}) eq 'HASH') {
6975: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
6976: } else {
6977: my %hash = ();
6978: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
6979: }
6980: }
6981: }
6982: }
6983: }
6984: return %privileged;
1.9 www 6985: }
1.1 albertel 6986:
1.103 harris41 6987: # -------------------------------------------------------- Get user privileges
1.11 www 6988:
6989: sub rolesinit {
1.1169 droeschl 6990: my ($domain, $username) = @_;
6991: my %userroles = ('user.login.time' => time);
6992: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
6993:
6994: # firstaccess and timerinterval are related to timed maps/resources.
6995: # also, blocking can be triggered by an activating timer
6996: # it's saved in the user's %env.
6997: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
6998: my %timerinterval = &dump('timerinterval', $domain, $username);
6999: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
1.1517 raeburn 7000: %timerintchk, %timerintenv, %coauthorenv);
1.1169 droeschl 7001:
1.1162 raeburn 7002: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 7003: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 7004: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
7005: }
1.1169 droeschl 7006:
1.1162 raeburn 7007: foreach my $key (keys(%timerinterval)) {
7008: my ($cid,$rest) = split(/\0/,$key);
7009: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
7010: }
1.1169 droeschl 7011:
1.11 www 7012: my %allroles=();
1.1162 raeburn 7013: my %allgroups=();
1.1517 raeburn 7014: my %gotcoauconfig=();
1.1524 raeburn 7015: my %domdefaults=();
1.11 www 7016:
1.1274 raeburn 7017: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 7018: my $role = $rolesdump{$area};
7019: $area =~ s/\_\w\w$//;
7020:
7021: my ($trole, $tend, $tstart, $group_privs);
7022:
7023: if ($role =~ /^cr/) {
7024: # Custom role, defined by a user
7025: # e.g., user.role.cr/msu/smith/mynewrole
7026: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
7027: $trole = $1;
7028: ($tend, $tstart) = split('_', $2);
7029: } else {
7030: $trole = $role;
7031: }
7032: } elsif ($role =~ m|^gr/|) {
7033: # Role of member in a group, defined within a course/community
7034: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
7035: ($trole, $tend, $tstart) = split(/_/, $role);
7036: next if $tstart eq '-1';
7037: ($trole, $group_privs) = split(/\//, $trole);
7038: $group_privs = &unescape($group_privs);
7039: } else {
7040: # Just a normal role, defined in roles.tab
7041: ($trole, $tend, $tstart) = split(/_/,$role);
7042: }
7043:
7044: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
7045: $username);
7046: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
7047:
7048: # role expired or not available yet?
7049: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
7050: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
7051:
7052: next if $area eq '' or $trole eq '';
7053:
7054: my $spec = "$trole.$area";
7055: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
7056:
7057: if ($trole =~ /^cr\//) {
7058: # Custom role, defined by a user
7059: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
7060: } elsif ($trole eq 'gr') {
7061: # Role of a member in a group, defined within a course/community
7062: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
7063: next;
7064: } else {
7065: # Normal role, defined in roles.tab
7066: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.1517 raeburn 7067: if (($trole eq 'ca') || ($trole eq 'aa')) {
7068: (undef,my ($audom,$auname)) = split(/\//,$area);
7069: unless ($gotcoauconfig{$area}) {
7070: my @ca_settings = ('authoreditors','coauthorlist','coauthoroptin');
7071: my %info = &userenvironment($audom,$auname,@ca_settings);
7072: $gotcoauconfig{$area} = 1;
7073: foreach my $item (@ca_settings) {
7074: if (exists($info{$item})) {
1.1519 raeburn 7075: my $name = $item;
7076: if ($item eq 'authoreditors') {
7077: $name = 'editors';
1.1524 raeburn 7078: unless ($info{'authoreditors'}) {
7079: my %domdefs;
7080: if (ref($domdefaults{$audom}) eq 'HASH') {
7081: %domdefs = %{$domdefaults{$audom}};
7082: } else {
7083: %domdefs = &get_domain_defaults($audom);
7084: $domdefaults{$audom} = \%domdefs;
7085: }
7086: if ($domdefs{$name} ne '') {
7087: $info{'authoreditors'} = $domdefs{$name};
7088: } else {
7089: $info{'authoreditors'} = 'edit,xml';
7090: }
7091: }
1.1519 raeburn 7092: }
7093: $coauthorenv{"environment.internal.$name.$area"} = $info{$item};
1.1517 raeburn 7094: }
7095: }
7096: }
7097: }
1.1169 droeschl 7098: }
7099:
7100: my $cid = $tdomain.'_'.$trest;
7101: unless ($firstaccchk{$cid}) {
7102: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
7103: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
7104: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
7105: $coursetimerstarts{$cid}{$item};
7106: }
7107: }
7108: $firstaccchk{$cid} = 1;
7109: }
7110: unless ($timerintchk{$cid}) {
7111: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
7112: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
7113: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
7114: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 7115: }
1.12 www 7116: }
1.1169 droeschl 7117: $timerintchk{$cid} = 1;
1.191 harris41 7118: }
1.11 www 7119: }
1.1169 droeschl 7120:
1.1341 raeburn 7121: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
7122: \%allroles, \%allgroups);
1.1169 droeschl 7123: $env{'user.adv'} = $userroles{'user.adv'};
1.1341 raeburn 7124: $env{'user.rar'} = $userroles{'user.rar'};
1.1169 droeschl 7125:
1.1517 raeburn 7126: return (\%userroles,\%firstaccenv,\%timerintenv,\%coauthorenv);
1.11 www 7127: }
7128:
1.567 raeburn 7129: sub set_arearole {
1.1215 raeburn 7130: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
7131: unless ($nolog) {
1.567 raeburn 7132: # log the associated role with the area
1.1215 raeburn 7133: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
7134: }
1.743 albertel 7135: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 7136: }
7137:
7138: sub custom_roleprivs {
7139: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
7140: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250 raeburn 7141: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 7142: if (&hostname($homsvr) ne '') {
1.567 raeburn 7143: my ($rdummy,$roledef)=
7144: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
7145: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
7146: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
7147: if (defined($syspriv)) {
1.1043 raeburn 7148: if ($trest =~ /^$match_community$/) {
7149: $syspriv =~ s/bre\&S//;
7150: }
1.567 raeburn 7151: $$allroles{'cm./'}.=':'.$syspriv;
7152: $$allroles{$spec.'./'}.=':'.$syspriv;
7153: }
7154: if ($tdomain ne '') {
7155: if (defined($dompriv)) {
7156: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
7157: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
7158: }
7159: if (($trest ne '') && (defined($coursepriv))) {
1.1332 raeburn 7160: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
7161: my $rolename = $1;
7162: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
7163: }
1.567 raeburn 7164: $$allroles{'cm.'.$area}.=':'.$coursepriv;
7165: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
7166: }
7167: }
7168: }
7169: }
7170: }
7171:
1.1332 raeburn 7172: sub course_adhocrole_privs {
7173: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
7174: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
7175: if ($overrides{"internal.adhocpriv.$rolename"}) {
7176: my (%currprivs,%storeprivs);
7177: foreach my $item (split(/:/,$coursepriv)) {
7178: my ($priv,$restrict) = split(/\&/,$item);
7179: $currprivs{$priv} = $restrict;
7180: }
7181: my (%possadd,%possremove,%full);
7182: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
7183: my ($priv,$restrict)=split(/\&/,$item);
7184: $full{$priv} = $restrict;
7185: }
7186: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
1.1490 raeburn 7187: next if ($item eq '');
7188: my ($rule,$rest) = split(/=/,$item);
7189: next unless (($rule eq 'off') || ($rule eq 'on'));
7190: foreach my $priv (split(/:/,$rest)) {
7191: if ($priv ne '') {
7192: if ($rule eq 'off') {
7193: $possremove{$priv} = 1;
7194: } else {
7195: $possadd{$priv} = 1;
7196: }
7197: }
7198: }
7199: }
7200: foreach my $priv (sort(keys(%full))) {
7201: if (exists($currprivs{$priv})) {
7202: unless (exists($possremove{$priv})) {
7203: $storeprivs{$priv} = $currprivs{$priv};
7204: }
7205: } elsif (exists($possadd{$priv})) {
7206: $storeprivs{$priv} = $full{$priv};
7207: }
7208: }
7209: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
7210: }
7211: return $coursepriv;
1.1332 raeburn 7212: }
7213:
1.678 raeburn 7214: sub group_roleprivs {
7215: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
7216: my $access = 1;
7217: my $now = time;
7218: if (($tend!=0) && ($tend<$now)) { $access = 0; }
7219: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
7220: if ($access) {
1.811 albertel 7221: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 7222: $$allgroups{$course}{$group} .=':'.$group_privs;
7223: }
7224: }
1.567 raeburn 7225:
7226: sub standard_roleprivs {
7227: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
7228: if (defined($pr{$trole.':s'})) {
7229: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
7230: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
7231: }
7232: if ($tdomain ne '') {
7233: if (defined($pr{$trole.':d'})) {
7234: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
7235: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
7236: }
7237: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
7238: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
7239: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
7240: }
7241: }
7242: }
7243:
7244: sub set_userprivs {
1.1064 raeburn 7245: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 7246: my $author=0;
7247: my $adv=0;
1.1341 raeburn 7248: my $rar=0;
1.678 raeburn 7249: my %grouproles = ();
7250: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 7251: my @groupkeys;
1.1000 raeburn 7252: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 7253: push(@groupkeys,$role);
7254: }
7255: if (ref($groups_roles) eq 'HASH') {
7256: foreach my $key (keys(%{$groups_roles})) {
7257: unless (grep(/^\Q$key\E$/,@groupkeys)) {
7258: push(@groupkeys,$key);
7259: }
7260: }
7261: }
7262: if (@groupkeys > 0) {
7263: foreach my $role (@groupkeys) {
7264: my ($trole,$area,$sec,$extendedarea);
7265: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
7266: $trole = $1;
7267: $area = $2;
7268: $sec = $3;
7269: $extendedarea = $area.$sec;
7270: if (exists($$allgroups{$area})) {
7271: foreach my $group (keys(%{$$allgroups{$area}})) {
7272: my $spec = $trole.'.'.$extendedarea;
7273: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 7274: $$allgroups{$area}{$group};
1.1064 raeburn 7275: }
1.678 raeburn 7276: }
7277: }
7278: }
7279: }
7280: }
1.800 albertel 7281: foreach my $group (keys(%grouproles)) {
7282: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 7283: }
1.800 albertel 7284: foreach my $role (keys(%{$allroles})) {
7285: my %thesepriv;
1.941 raeburn 7286: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 7287: foreach my $item (split(/:/,$$allroles{$role})) {
7288: if ($item ne '') {
7289: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 7290: if ($restrictions eq '') {
7291: $thesepriv{$privilege}='F';
7292: } elsif ($thesepriv{$privilege} ne 'F') {
7293: $thesepriv{$privilege}.=$restrictions;
7294: }
7295: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1341 raeburn 7296: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567 raeburn 7297: }
7298: }
7299: my $thesestr='';
1.1104 raeburn 7300: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 7301: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
7302: }
7303: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 7304: }
1.1341 raeburn 7305: return ($author,$adv,$rar);
1.567 raeburn 7306: }
7307:
1.994 raeburn 7308: sub role_status {
1.1104 raeburn 7309: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 7310: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250 raeburn 7311: my ($one,$two) = split(m{\./},$rolekey,2);
7312: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 7313: unless (!defined($$role) || $$role eq '') {
1.1251 raeburn 7314: $$where = '/'.$two;
1.994 raeburn 7315: $$trolecode=$$role.'.'.$$where;
7316: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
7317: $$tstatus='is';
1.1104 raeburn 7318: if ($$tstart && $$tstart>$update) {
1.994 raeburn 7319: $$tstatus='future';
1.1034 raeburn 7320: if ($$tstart<$now) {
7321: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 7322: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 7323: my (%allroles,%allgroups,$group_privs,
7324: %groups_roles,@rolecodes);
1.1002 raeburn 7325: my %userroles = (
7326: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
7327: );
1.1064 raeburn 7328: @rolecodes = ('cm');
1.1002 raeburn 7329: my $spec=$$role.'.'.$$where;
7330: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
7331: if ($$role =~ /^cr\//) {
7332: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 7333: push(@rolecodes,'cr');
1.1002 raeburn 7334: } elsif ($$role eq 'gr') {
1.1064 raeburn 7335: push(@rolecodes,$$role);
1.1002 raeburn 7336: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
7337: $env{'user.name'});
1.1064 raeburn 7338: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 7339: (undef,my $group_privs) = split(/\//,$trole);
7340: $group_privs = &unescape($group_privs);
7341: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 7342: 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 7343: &get_groups_roles($tdomain,$trest,
7344: \%course_roles,\@rolecodes,
7345: \%groups_roles);
1.1002 raeburn 7346: } else {
1.1064 raeburn 7347: push(@rolecodes,$$role);
1.1002 raeburn 7348: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
7349: }
1.1341 raeburn 7350: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
7351: \%groups_roles);
1.1064 raeburn 7352: &appenv(\%userroles,\@rolecodes);
1.1342 raeburn 7353: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002 raeburn 7354: }
7355: }
1.1034 raeburn 7356: $$tstatus = 'is';
1.1002 raeburn 7357: }
1.994 raeburn 7358: }
7359: if ($$tend) {
1.1104 raeburn 7360: if ($$tend<$update) {
1.994 raeburn 7361: $$tstatus='expired';
7362: } elsif ($$tend<$now) {
7363: $$tstatus='will_not';
7364: }
7365: }
7366: }
7367: }
7368: }
7369:
1.1104 raeburn 7370: sub get_groups_roles {
7371: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
7372: return unless((ref($cdom_courseroles) eq 'HASH') &&
7373: (ref($rolecodes) eq 'ARRAY') &&
7374: (ref($groups_roles) eq 'HASH'));
7375: if (keys(%{$cdom_courseroles}) > 0) {
7376: my ($cnum) = ($rest =~ /^($match_courseid)/);
7377: if ($cdom ne '' && $cnum ne '') {
7378: foreach my $key (keys(%{$cdom_courseroles})) {
7379: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
7380: my $crsrole = $1;
7381: my $crssec = $2;
7382: if ($crsrole =~ /^cr/) {
7383: unless (grep(/^cr$/,@{$rolecodes})) {
7384: push(@{$rolecodes},'cr');
7385: }
7386: } else {
7387: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
7388: push(@{$rolecodes},$crsrole);
7389: }
7390: }
7391: my $rolekey = "$crsrole./$cdom/$cnum";
7392: if ($crssec ne '') {
7393: $rolekey .= "/$crssec";
7394: }
7395: $rolekey .= './';
7396: $groups_roles->{$rolekey} = $rolecodes;
7397: }
7398: }
7399: }
7400: }
7401: return;
7402: }
7403:
7404: sub delete_env_groupprivs {
7405: my ($where,$courseroles,$possroles) = @_;
7406: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
7407: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
7408: unless (ref($courseroles->{$udom}) eq 'HASH') {
7409: %{$courseroles->{$udom}} =
7410: &get_my_roles('','','userroles',['active'],
7411: $possroles,[$udom],1);
7412: }
7413: if (ref($courseroles->{$udom}) eq 'HASH') {
7414: foreach my $item (keys(%{$courseroles->{$udom}})) {
7415: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
7416: my $area = '/'.$cdom.'/'.$cnum;
7417: my $privkey = "user.priv.$crsrole.$area";
7418: if ($crssec ne '') {
7419: $privkey .= '/'.$crssec;
7420: }
7421: $privkey .= ".$area/$group";
7422: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
7423: }
7424: }
7425: return;
7426: }
7427:
1.994 raeburn 7428: sub check_adhoc_privs {
1.1329 raeburn 7429: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 7430: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1329 raeburn 7431: if ($sec) {
7432: $cckey .= '/'.$sec;
7433: }
1.1185 raeburn 7434: my $setprivs;
1.994 raeburn 7435: if ($env{$cckey}) {
7436: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 7437: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 7438: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1329 raeburn 7439: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7440: $setprivs = 1;
1.994 raeburn 7441: }
7442: } else {
1.1330 raeburn 7443: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1185 raeburn 7444: $setprivs = 1;
1.994 raeburn 7445: }
1.1185 raeburn 7446: return $setprivs;
1.994 raeburn 7447: }
7448:
7449: sub set_adhoc_privileges {
1.1326 raeburn 7450: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1329 raeburn 7451: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 7452: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1329 raeburn 7453: if ($sec ne '') {
7454: $area .= '/'.$sec;
7455: }
1.994 raeburn 7456: my $spec = $role.'.'.$area;
7457: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 7458: $env{'user.name'},1);
1.1326 raeburn 7459: my %rolehash = ();
1.1332 raeburn 7460: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
7461: my $rolename = $1;
1.1326 raeburn 7462: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1332 raeburn 7463: my %domdef = &get_domain_defaults($dcdom);
7464: if (ref($domdef{'adhocroles'}) eq 'HASH') {
7465: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
7466: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
7467: }
7468: }
1.1326 raeburn 7469: } else {
7470: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
7471: }
1.1341 raeburn 7472: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 7473: &appenv(\%userroles,[$role,'cm']);
1.1342 raeburn 7474: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1402 raeburn 7475: unless (($caller eq 'constructaccess' && $env{'request.course.id'}) ||
7476: ($caller eq 'tiny')) {
1.1088 raeburn 7477: &appenv( {'request.role' => $spec,
7478: 'request.role.domain' => $dcdom,
1.1332 raeburn 7479: 'request.course.sec' => $sec,
1.1088 raeburn 7480: }
7481: );
7482: my $tadv=0;
7483: if (&allowed('adv') eq 'F') { $tadv=1; }
7484: &appenv({'request.role.adv' => $tadv});
7485: }
1.994 raeburn 7486: }
7487:
1.12 www 7488: # --------------------------------------------------------------- get interface
7489:
7490: sub get {
1.131 albertel 7491: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7492: my $items='';
1.800 albertel 7493: foreach my $item (@$storearr) {
7494: $items.=&escape($item).'&';
1.191 harris41 7495: }
1.12 www 7496: $items=~s/\&$//;
1.620 albertel 7497: if (!$udomain) { $udomain=$env{'user.domain'}; }
7498: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 7499: my $uhome=&homeserver($uname,$udomain);
7500:
1.133 albertel 7501: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7502: my @pairs=split(/\&/,$rep);
1.273 albertel 7503: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
7504: return @pairs;
7505: }
1.15 www 7506: my %returnhash=();
1.42 www 7507: my $i=0;
1.800 albertel 7508: foreach my $item (@$storearr) {
7509: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7510: $i++;
1.191 harris41 7511: }
1.15 www 7512: return %returnhash;
1.27 www 7513: }
7514:
7515: # --------------------------------------------------------------- del interface
7516:
7517: sub del {
1.133 albertel 7518: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 7519: my $items='';
1.800 albertel 7520: foreach my $item (@$storearr) {
7521: $items.=&escape($item).'&';
1.191 harris41 7522: }
1.984 neumanie 7523:
1.27 www 7524: $items=~s/\&$//;
1.620 albertel 7525: if (!$udomain) { $udomain=$env{'user.domain'}; }
7526: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7527: my $uhome=&homeserver($uname,$udomain);
7528: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 7529: }
7530:
7531: # -------------------------------------------------------------- dump interface
7532:
1.1180 droeschl 7533: sub unserialize {
7534: my ($rep, $escapedkeys) = @_;
7535:
7536: return {} if $rep =~ /^error/;
7537:
7538: my %returnhash=();
1.1252 raeburn 7539: foreach my $item (split(/\&/,$rep)) {
1.1180 droeschl 7540: my ($key, $value) = split(/=/, $item, 2);
7541: $key = unescape($key) unless $escapedkeys;
7542: next if $key =~ /^error: 2 /;
1.1252 raeburn 7543: $returnhash{$key} = &thaw_unescape($value);
1.1180 droeschl 7544: }
7545: #return %returnhash;
7546: return \%returnhash;
7547: }
7548:
7549: # see Lond::dump_with_regexp
7550: # if $escapedkeys hash keys won't get unescaped.
1.15 www 7551: sub dump {
1.1462 raeburn 7552: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys,$encrypt)=@_;
1.755 albertel 7553: if (!$udomain) { $udomain=$env{'user.domain'}; }
7554: if (!$uname) { $uname=$env{'user.name'}; }
7555: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 7556:
1.1266 raeburn 7557: if ($regexp) {
7558: $regexp=&escape($regexp);
7559: } else {
7560: $regexp='.';
7561: }
1.1180 droeschl 7562: if (grep { $_ eq $uhome } current_machine_ids()) {
7563: # user is hosted on this machine
1.1266 raeburn 7564: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 7565: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 7566: return %{unserialize($reply, $escapedkeys)};
7567: }
1.1462 raeburn 7568: my $rep;
7569: if ($encrypt) {
7570: $rep=&reply("encrypt:edump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.1463 raeburn 7571: } else {
1.1462 raeburn 7572: $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
7573: }
1.755 albertel 7574: my @pairs=split(/\&/,$rep);
7575: my %returnhash=();
1.1098 foxr 7576: if (!($rep =~ /^error/ )) {
7577: foreach my $item (@pairs) {
7578: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 7579: $key = unescape($key) unless $escapedkeys;
7580: #$key = &unescape($key);
1.1098 foxr 7581: next if ($key =~ /^error: 2 /);
7582: $returnhash{$key}=&thaw_unescape($value);
7583: }
1.755 albertel 7584: }
7585: return %returnhash;
1.407 www 7586: }
7587:
1.1098 foxr 7588:
1.717 albertel 7589: # --------------------------------------------------------- dumpstore interface
7590:
7591: sub dumpstore {
7592: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 7593: # same as dump but keys must be escaped. They may contain colon separated
7594: # lists of values that may themself contain colons (e.g. symbs).
7595: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 7596: }
7597:
1.407 www 7598: # -------------------------------------------------------------- keys interface
7599:
7600: sub getkeys {
7601: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 7602: if (!$udomain) { $udomain=$env{'user.domain'}; }
7603: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 7604: my $uhome=&homeserver($uname,$udomain);
7605: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
7606: my @keyarray=();
1.800 albertel 7607: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 7608: next if ($key =~ /^error: 2 /);
1.800 albertel 7609: push(@keyarray,&unescape($key));
1.407 www 7610: }
7611: return @keyarray;
1.318 matthew 7612: }
7613:
1.319 matthew 7614: # --------------------------------------------------------------- currentdump
7615: sub currentdump {
1.328 matthew 7616: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 7617: $courseid = $env{'request.course.id'} if (! defined($courseid));
7618: $sdom = $env{'user.domain'} if (! defined($sdom));
7619: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 7620: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 7621: my $rep;
7622:
7623: if (grep { $_ eq $uhome } current_machine_ids()) {
7624: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
7625: $courseid)));
7626: } else {
7627: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
7628: }
7629:
1.318 matthew 7630: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 7631: #
1.318 matthew 7632: my %returnhash=();
1.319 matthew 7633: #
1.1343 raeburn 7634: if ($rep eq 'unknown_cmd') {
1.319 matthew 7635: # an old lond will not know currentdump
7636: # Do a dump and make it look like a currentdump
1.822 albertel 7637: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 7638: return if ($tmp[0] =~ /^(error:|no_such_host)/);
7639: my %hash = @tmp;
7640: @tmp=();
1.424 matthew 7641: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 7642: } else {
7643: my @pairs=split(/\&/,$rep);
1.800 albertel 7644: foreach my $pair (@pairs) {
7645: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 7646: my ($symb,$param) = split(/:/,$key);
7647: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 7648: &thaw_unescape($value);
1.319 matthew 7649: }
1.191 harris41 7650: }
1.12 www 7651: return %returnhash;
1.424 matthew 7652: }
7653:
7654: sub convert_dump_to_currentdump{
7655: my %hash = %{shift()};
7656: my %returnhash;
7657: # Code ripped from lond, essentially. The only difference
7658: # here is the unescaping done by lonnet::dump(). Conceivably
7659: # we might run in to problems with parameter names =~ /^v\./
7660: while (my ($key,$value) = each(%hash)) {
7661: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 7662: $symb = &unescape($symb);
7663: $param = &unescape($param);
1.424 matthew 7664: next if ($v eq 'version' || $symb eq 'keys');
7665: next if (exists($returnhash{$symb}) &&
7666: exists($returnhash{$symb}->{$param}) &&
7667: $returnhash{$symb}->{'v.'.$param} > $v);
7668: $returnhash{$symb}->{$param}=$value;
7669: $returnhash{$symb}->{'v.'.$param}=$v;
7670: }
7671: #
7672: # Remove all of the keys in the hashes which keep track of
7673: # the version of the parameter.
7674: while (my ($symb,$param_hash) = each(%returnhash)) {
7675: # use a foreach because we are going to delete from the hash.
7676: foreach my $key (keys(%$param_hash)) {
7677: delete($param_hash->{$key}) if ($key =~ /^v\./);
7678: }
7679: }
7680: return \%returnhash;
1.12 www 7681: }
7682:
1.627 albertel 7683: # ------------------------------------------------------ critical inc interface
7684:
7685: sub cinc {
7686: return &inc(@_,'critical');
7687: }
7688:
1.449 matthew 7689: # --------------------------------------------------------------- inc interface
7690:
7691: sub inc {
1.627 albertel 7692: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 7693: if (!$udomain) { $udomain=$env{'user.domain'}; }
7694: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 7695: my $uhome=&homeserver($uname,$udomain);
7696: my $items='';
7697: if (! ref($store)) {
7698: # got a single value, so use that instead
7699: $items = &escape($store).'=&';
7700: } elsif (ref($store) eq 'SCALAR') {
7701: $items = &escape($$store).'=&';
7702: } elsif (ref($store) eq 'ARRAY') {
7703: $items = join('=&',map {&escape($_);} @{$store});
7704: } elsif (ref($store) eq 'HASH') {
7705: while (my($key,$value) = each(%{$store})) {
7706: $items.= &escape($key).'='.&escape($value).'&';
7707: }
7708: }
7709: $items=~s/\&$//;
1.627 albertel 7710: if ($critical) {
7711: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
7712: } else {
7713: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
7714: }
1.449 matthew 7715: }
7716:
1.12 www 7717: # --------------------------------------------------------------- put interface
7718:
7719: sub put {
1.1462 raeburn 7720: my ($namespace,$storehash,$udomain,$uname,$encrypt)=@_;
1.620 albertel 7721: if (!$udomain) { $udomain=$env{'user.domain'}; }
7722: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7723: my $uhome=&homeserver($uname,$udomain);
1.12 www 7724: my $items='';
1.800 albertel 7725: foreach my $item (keys(%$storehash)) {
7726: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7727: }
1.12 www 7728: $items=~s/\&$//;
1.1462 raeburn 7729: if ($encrypt) {
7730: return &reply("encrypt:put:$udomain:$uname:$namespace:$items",$uhome);
7731: } else {
7732: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
7733: }
1.47 www 7734: }
7735:
1.631 albertel 7736: # ------------------------------------------------------------ newput interface
7737:
7738: sub newput {
7739: my ($namespace,$storehash,$udomain,$uname)=@_;
7740: if (!$udomain) { $udomain=$env{'user.domain'}; }
7741: if (!$uname) { $uname=$env{'user.name'}; }
7742: my $uhome=&homeserver($uname,$udomain);
7743: my $items='';
7744: foreach my $key (keys(%$storehash)) {
7745: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7746: }
7747: $items=~s/\&$//;
7748: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
7749: }
7750:
7751: # --------------------------------------------------------- putstore interface
7752:
1.524 raeburn 7753: sub putstore {
1.1269 raeburn 7754: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 7755: if (!$udomain) { $udomain=$env{'user.domain'}; }
7756: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 7757: my $uhome=&homeserver($uname,$udomain);
7758: my $items='';
1.715 albertel 7759: foreach my $key (keys(%$storehash)) {
7760: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 7761: }
1.715 albertel 7762: $items=~s/\&$//;
1.716 albertel 7763: my $esc_symb=&escape($symb);
7764: my $esc_v=&escape($version);
1.715 albertel 7765: my $reply =
1.716 albertel 7766: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 7767: $uhome);
1.1269 raeburn 7768: if (($tolog) && ($reply eq 'ok')) {
7769: my $namevalue='';
7770: foreach my $key (keys(%{$storehash})) {
7771: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
7772: }
1.1434 raeburn 7773: my $ip = &get_requestor_ip();
7774: $namevalue .= 'ip='.&escape($ip).
1.1269 raeburn 7775: '&host='.&escape($perlvar{'lonHostID'}).
7776: '&version='.$esc_v.
7777: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
1.1494 raeburn 7778: &courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
1.1269 raeburn 7779: }
1.715 albertel 7780: if ($reply eq 'unknown_cmd') {
1.716 albertel 7781: # gfall back to way things use to be done
1.715 albertel 7782: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
7783: $uname);
1.524 raeburn 7784: }
1.715 albertel 7785: return $reply;
7786: }
7787:
7788: sub old_putstore {
1.716 albertel 7789: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
7790: if (!$udomain) { $udomain=$env{'user.domain'}; }
7791: if (!$uname) { $uname=$env{'user.name'}; }
7792: my $uhome=&homeserver($uname,$udomain);
7793: my %newstorehash;
1.800 albertel 7794: foreach my $item (keys(%$storehash)) {
7795: my $key = $version.':'.&escape($symb).':'.$item;
7796: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 7797: }
7798: my $items='';
7799: my %allitems = ();
1.800 albertel 7800: foreach my $item (keys(%newstorehash)) {
7801: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 7802: my $key = $1.':keys:'.$2;
7803: $allitems{$key} .= $3.':';
7804: }
1.800 albertel 7805: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 7806: }
1.800 albertel 7807: foreach my $item (keys(%allitems)) {
7808: $allitems{$item} =~ s/\:$//;
7809: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 7810: }
7811: $items=~s/\&$//;
7812: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 7813: }
7814:
1.47 www 7815: # ------------------------------------------------------ critical put interface
7816:
7817: sub cput {
1.134 albertel 7818: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 7819: if (!$udomain) { $udomain=$env{'user.domain'}; }
7820: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 7821: my $uhome=&homeserver($uname,$udomain);
1.47 www 7822: my $items='';
1.800 albertel 7823: foreach my $item (keys(%$storehash)) {
7824: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 7825: }
1.47 www 7826: $items=~s/\&$//;
1.134 albertel 7827: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7828: }
7829:
7830: # -------------------------------------------------------------- eget interface
7831:
7832: sub eget {
1.133 albertel 7833: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 7834: my $items='';
1.800 albertel 7835: foreach my $item (@$storearr) {
7836: $items.=&escape($item).'&';
1.191 harris41 7837: }
1.12 www 7838: $items=~s/\&$//;
1.620 albertel 7839: if (!$udomain) { $udomain=$env{'user.domain'}; }
7840: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 7841: my $uhome=&homeserver($uname,$udomain);
7842: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 7843: my @pairs=split(/\&/,$rep);
7844: my %returnhash=();
1.42 www 7845: my $i=0;
1.800 albertel 7846: foreach my $item (@$storearr) {
7847: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 7848: $i++;
1.191 harris41 7849: }
1.12 www 7850: return %returnhash;
7851: }
7852:
1.667 albertel 7853: # ------------------------------------------------------------ tmpput interface
7854: sub tmpput {
1.802 raeburn 7855: my ($storehash,$server,$context)=@_;
1.667 albertel 7856: my $items='';
1.800 albertel 7857: foreach my $item (keys(%$storehash)) {
7858: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 7859: }
7860: $items=~s/\&$//;
1.802 raeburn 7861: if (defined($context)) {
7862: $items .= ':'.&escape($context);
7863: }
1.667 albertel 7864: return &reply("tmpput:$items",$server);
7865: }
7866:
7867: # ------------------------------------------------------------ tmpget interface
7868: sub tmpget {
1.688 albertel 7869: my ($token,$server)=@_;
7870: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7871: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 7872: my %returnhash;
1.1328 raeburn 7873: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
7874: return %returnhash;
7875: }
1.667 albertel 7876: foreach my $item (split(/\&/,$rep)) {
7877: my ($key,$value)=split(/=/,$item);
7878: $returnhash{&unescape($key)}=&thaw_unescape($value);
7879: }
7880: return %returnhash;
7881: }
7882:
1.1113 raeburn 7883: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 7884: sub tmpdel {
7885: my ($token,$server)=@_;
7886: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
7887: return &reply("tmpdel:$token",$server);
7888: }
7889:
1.1198 raeburn 7890: # ------------------------------------------------------------ get_timebased_id
7891:
7892: sub get_timebased_id {
7893: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
7894: $maxtries) = @_;
7895: my ($newid,$error,$dellock);
7896: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
7897: return ('','ok','invalid call to get suffix');
7898: }
7899:
7900: # set defaults for any optional args for which values were not supplied
7901: if ($who eq '') {
7902: $who = $env{'user.name'}.':'.$env{'user.domain'};
7903: }
7904: if (!$locktries) {
7905: $locktries = 3;
7906: }
7907: if (!$maxtries) {
7908: $maxtries = 10;
7909: }
7910:
7911: if (($cdom eq '') || ($cnum eq '')) {
7912: if ($env{'request.course.id'}) {
7913: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7914: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7915: }
7916: if (($cdom eq '') || ($cnum eq '')) {
7917: return ('','ok','call to get suffix not in course context');
7918: }
7919: }
7920:
7921: # construct locking item
7922: my $lockhash = {
7923: $prefix."\0".'locked_'.$keyid => $who,
7924: };
7925: my $tries = 0;
7926:
7927: # attempt to get lock on nohist_$namespace file
1.1494 raeburn 7928: my $gotlock = &newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
1.1198 raeburn 7929: while (($gotlock ne 'ok') && $tries <$locktries) {
7930: $tries ++;
7931: sleep 1;
1.1494 raeburn 7932: $gotlock = &newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
1.1198 raeburn 7933: }
7934:
7935: # attempt to get unique identifier, based on current timestamp
7936: if ($gotlock eq 'ok') {
1.1494 raeburn 7937: my %inuse = &dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
1.1198 raeburn 7938: my $id = time;
7939: $newid = $id;
1.1268 raeburn 7940: if ($idtype eq 'addcode') {
7941: $newid .= &sixnum_code();
7942: }
1.1198 raeburn 7943: my $idtries = 0;
7944: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
7945: if ($idtype eq 'concat') {
7946: $newid = $id.$idtries;
1.1268 raeburn 7947: } elsif ($idtype eq 'addcode') {
7948: $newid = $newid.&sixnum_code();
1.1198 raeburn 7949: } else {
7950: $newid ++;
7951: }
7952: $idtries ++;
7953: }
7954: if (!exists($inuse{$prefix."\0".$newid})) {
7955: my %new_item = (
7956: $prefix."\0".$newid => $who,
7957: );
1.1494 raeburn 7958: my $putresult = &put('nohist_'.$namespace,\%new_item,
1.1198 raeburn 7959: $cdom,$cnum);
7960: if ($putresult ne 'ok') {
7961: undef($newid);
7962: $error = 'error saving new item: '.$putresult;
7963: }
7964: } else {
1.1268 raeburn 7965: undef($newid);
1.1198 raeburn 7966: $error = ('error: no unique suffix available for the new item ');
7967: }
7968: # remove lock
7969: my @del_lock = ($prefix."\0".'locked_'.$keyid);
7970: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
7971: } else {
7972: $error = "error: could not obtain lockfile\n";
7973: $dellock = 'ok';
1.1276 raeburn 7974: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
7975: $dellock = 'nolock';
7976: }
1.1198 raeburn 7977: }
7978: return ($newid,$dellock,$error);
7979: }
7980:
1.1268 raeburn 7981: sub sixnum_code {
7982: my $code;
7983: for (0..6) {
7984: $code .= int( rand(9) );
7985: }
7986: return $code;
7987: }
7988:
1.765 albertel 7989: # -------------------------------------------------- portfolio access checking
7990:
7991: sub portfolio_access {
1.1270 raeburn 7992: my ($requrl,$clientip) = @_;
1.765 albertel 7993: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270 raeburn 7994: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 7995: if ($result) {
7996: my %setters;
7997: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
1.1473 raeburn 7998: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
7999: &Apache::loncommon::blockcheck(\%setters,'port',$clientip,$unum,$udom);
8000: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 8001: return 'B';
8002: }
8003: } else {
1.1473 raeburn 8004: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
8005: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
8006: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 8007: return 'B';
8008: }
8009: }
8010: }
1.765 albertel 8011: if ($result eq 'ok') {
1.766 albertel 8012: return 'F';
1.765 albertel 8013: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 8014: return 'A';
1.765 albertel 8015: }
1.766 albertel 8016: return '';
1.765 albertel 8017: }
8018:
8019: sub get_portfolio_access {
1.1521 raeburn 8020: my ($udom,$unum,$file_name,$group,$clientip,$access_hash,$portaccessref) = @_;
1.767 albertel 8021:
8022: if (!ref($access_hash)) {
8023: my $current_perms = &get_portfile_permissions($udom,$unum);
8024: my %access_controls = &get_access_controls($current_perms,$group,
8025: $file_name);
8026: $access_hash = $access_controls{$file_name};
8027: }
8028:
1.1521 raeburn 8029: my $portaccess;
8030: if (ref($portaccess) eq 'SCALAR') {
8031: $portaccess = $$portaccessref;
8032: } else {
8033: $portaccess = &usertools_access($unum,$udom,'portaccess',undef,'tools');
8034: }
8035:
1.1522 raeburn 8036: my ($public,$guest,@domains,@users,@courses,@groups,@ips,@userips);
1.765 albertel 8037: my $now = time;
8038: if (ref($access_hash) eq 'HASH') {
8039: foreach my $key (keys(%{$access_hash})) {
8040: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1521 raeburn 8041: next if (($scope ne 'ip') && ($portaccess == 0));
1.765 albertel 8042: if ($start > $now) {
8043: next;
8044: }
8045: if ($end && $end<$now) {
8046: next;
8047: }
8048: if ($scope eq 'public') {
8049: $public = $key;
8050: last;
8051: } elsif ($scope eq 'guest') {
8052: $guest = $key;
8053: } elsif ($scope eq 'domains') {
8054: push(@domains,$key);
8055: } elsif ($scope eq 'users') {
8056: push(@users,$key);
8057: } elsif ($scope eq 'course') {
8058: push(@courses,$key);
8059: } elsif ($scope eq 'group') {
8060: push(@groups,$key);
1.1270 raeburn 8061: } elsif ($scope eq 'ip') {
8062: push(@ips,$key);
1.1522 raeburn 8063: } elsif ($scope eq 'userip') {
8064: push(@userips,$key);
1.765 albertel 8065: }
8066: }
8067: if ($public) {
8068: return 'ok';
1.1270 raeburn 8069: } elsif (@ips > 0) {
8070: my $allowed;
8071: foreach my $ipkey (@ips) {
8072: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
8073: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
8074: $allowed = 1;
8075: last;
8076: }
8077: }
8078: }
8079: if ($allowed) {
8080: return 'ok';
8081: }
1.1522 raeburn 8082: } elsif (@userips > 0) {
8083: my $allowed;
8084: foreach my $useripkey (@userips) {
8085: if (ref($access_hash->{$useripkey}{'ip'}) eq 'ARRAY') {
8086: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$useripkey}{'ip'}}),$clientip)) {
8087: $allowed = 1;
8088: last;
8089: }
8090: }
8091: }
8092: if ($allowed) {
8093: return 'ok';
8094: }
1.765 albertel 8095: }
8096: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
8097: if ($guest) {
8098: return $guest;
8099: }
8100: } else {
8101: if (@domains > 0) {
8102: foreach my $domkey (@domains) {
8103: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
8104: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
8105: return 'ok';
8106: }
8107: }
8108: }
8109: }
8110: if (@users > 0) {
8111: foreach my $userkey (@users) {
1.865 raeburn 8112: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
8113: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
8114: if (ref($item) eq 'HASH') {
8115: if (($item->{'uname'} eq $env{'user.name'}) &&
8116: ($item->{'udom'} eq $env{'user.domain'})) {
8117: return 'ok';
8118: }
8119: }
8120: }
8121: }
1.765 albertel 8122: }
8123: }
8124: my %roleshash;
8125: my @courses_and_groups = @courses;
8126: push(@courses_and_groups,@groups);
8127: if (@courses_and_groups > 0) {
8128: my (%allgroups,%allroles);
8129: my ($start,$end,$role,$sec,$group);
8130: foreach my $envkey (%env) {
1.1060 raeburn 8131: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 8132: my $cid = $2.'_'.$3;
8133: if ($1 eq 'gr') {
8134: $group = $4;
8135: $allgroups{$cid}{$group} = $env{$envkey};
8136: } else {
8137: if ($4 eq '') {
8138: $sec = 'none';
8139: } else {
8140: $sec = $4;
8141: }
8142: $allroles{$cid}{$1}{$sec} = $env{$envkey};
8143: }
1.811 albertel 8144: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 8145: my $cid = $2.'_'.$3;
8146: if ($4 eq '') {
8147: $sec = 'none';
8148: } else {
8149: $sec = $4;
8150: }
8151: $allroles{$cid}{$1}{$sec} = $env{$envkey};
8152: }
8153: }
8154: if (keys(%allroles) == 0) {
8155: return;
8156: }
8157: foreach my $key (@courses_and_groups) {
8158: my %content = %{$$access_hash{$key}};
8159: my $cnum = $content{'number'};
8160: my $cdom = $content{'domain'};
8161: my $cid = $cdom.'_'.$cnum;
8162: if (!exists($allroles{$cid})) {
8163: next;
8164: }
8165: foreach my $role_id (keys(%{$content{'roles'}})) {
8166: my @sections = @{$content{'roles'}{$role_id}{'section'}};
8167: my @groups = @{$content{'roles'}{$role_id}{'group'}};
8168: my @status = @{$content{'roles'}{$role_id}{'access'}};
8169: my @roles = @{$content{'roles'}{$role_id}{'role'}};
8170: foreach my $role (keys(%{$allroles{$cid}})) {
8171: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
8172: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
8173: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
8174: if (grep/^all$/,@sections) {
8175: return 'ok';
8176: } else {
8177: if (grep/^$sec$/,@sections) {
8178: return 'ok';
8179: }
8180: }
8181: }
8182: }
8183: if (keys(%{$allgroups{$cid}}) == 0) {
8184: if (grep/^none$/,@groups) {
8185: return 'ok';
8186: }
8187: } else {
8188: if (grep/^all$/,@groups) {
8189: return 'ok';
8190: }
8191: foreach my $group (keys(%{$allgroups{$cid}})) {
8192: if (grep/^$group$/,@groups) {
8193: return 'ok';
8194: }
8195: }
8196: }
8197: }
8198: }
8199: }
8200: }
8201: }
8202: if ($guest) {
8203: return $guest;
8204: }
8205: }
8206: }
8207: return;
8208: }
8209:
8210: sub course_group_datechecker {
8211: my ($dates,$now,$status) = @_;
8212: my ($start,$end) = split(/\./,$dates);
8213: if (!$start && !$end) {
8214: return 'ok';
8215: }
8216: if (grep/^active$/,@{$status}) {
8217: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
8218: return 'ok';
8219: }
8220: }
8221: if (grep/^previous$/,@{$status}) {
8222: if ($end > $now ) {
8223: return 'ok';
8224: }
8225: }
8226: if (grep/^future$/,@{$status}) {
8227: if ($start > $now) {
8228: return 'ok';
8229: }
8230: }
8231: return;
8232: }
8233:
8234: sub parse_portfolio_url {
8235: my ($url) = @_;
8236:
8237: my ($type,$udom,$unum,$group,$file_name);
8238:
1.823 albertel 8239: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 8240: $type = 1;
8241: $udom = $1;
8242: $unum = $2;
8243: $file_name = $3;
1.823 albertel 8244: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 8245: $type = 2;
8246: $udom = $1;
8247: $unum = $2;
8248: $group = $3;
8249: $file_name = $3.'/'.$4;
8250: }
8251: if (wantarray) {
8252: return ($type,$udom,$unum,$file_name,$group);
8253: }
8254: return $type;
8255: }
8256:
8257: sub is_portfolio_url {
8258: my ($url) = @_;
8259: return scalar(&parse_portfolio_url($url));
8260: }
8261:
1.798 raeburn 8262: sub is_portfolio_file {
8263: my ($file) = @_;
1.820 raeburn 8264: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 8265: return 1;
8266: }
8267: return;
8268: }
8269:
1.1504 raeburn 8270: sub is_coursetool_logo {
8271: my ($uri) = @_;
8272: if ($env{'request.course.id'}) {
8273: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
8274: if ($uri =~ m{^/*uploaded\Q$courseurl\E/toollogo/\d+/[^/]+$}) {
8275: return 1;
8276: }
8277: }
8278: return;
8279: }
8280:
1.976 raeburn 8281: sub usertools_access {
1.1084 raeburn 8282: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 8283: my ($access,%tools);
8284: if ($context eq '') {
8285: $context = 'tools';
8286: }
8287: if ($context eq 'requestcourses') {
8288: %tools = (
8289: official => 1,
8290: unofficial => 1,
1.1006 raeburn 8291: community => 1,
1.1246 raeburn 8292: textbook => 1,
1.1305 raeburn 8293: placement => 1,
1.1368 raeburn 8294: lti => 1,
1.985 raeburn 8295: );
1.1183 raeburn 8296: } elsif ($context eq 'requestauthor') {
8297: %tools = (
8298: requestauthor => 1,
8299: );
1.1517 raeburn 8300: } elsif ($context eq 'authordefaults') {
8301: %tools = (
8302: webdav => 1,
8303: );
1.985 raeburn 8304: } else {
8305: %tools = (
8306: aboutme => 1,
8307: blog => 1,
1.1526 ! raeburn 8308: webdav => 1,
1.985 raeburn 8309: portfolio => 1,
1.1517 raeburn 8310: portaccess => 1,
1.1489 raeburn 8311: timezone => 1,
1.985 raeburn 8312: );
8313: }
1.976 raeburn 8314: return if (!defined($tools{$tool}));
8315:
1.1242 raeburn 8316: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 8317: $udom = $env{'user.domain'};
8318: $uname = $env{'user.name'};
8319: }
8320:
1.978 raeburn 8321: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
8322: if ($action ne 'reload') {
1.985 raeburn 8323: if ($context eq 'requestcourses') {
8324: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 8325: } elsif ($context eq 'requestauthor') {
8326: return $env{'environment.canrequest.author'};
1.1517 raeburn 8327: } elsif ($context eq 'authordefaults') {
8328: if ($tool eq 'webdav') {
8329: return $env{'environment.availabletools.'.$tool};
8330: }
1.985 raeburn 8331: } else {
8332: return $env{'environment.availabletools.'.$tool};
8333: }
8334: }
1.976 raeburn 8335: }
8336:
1.1183 raeburn 8337: my ($toolstatus,$inststatus,$envkey);
8338: if ($context eq 'requestauthor') {
1.1517 raeburn 8339: $envkey = $context;
8340: } elsif ($context eq 'authordefaults') {
8341: if ($tool eq 'webdav') {
8342: $envkey = 'tools.'.$tool;
8343: }
1.1183 raeburn 8344: } else {
8345: $envkey = $context.'.'.$tool;
8346: }
1.976 raeburn 8347:
1.985 raeburn 8348: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8349: ($action ne 'reload')) {
1.1183 raeburn 8350: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 8351: $inststatus = $env{'environment.inststatus'};
8352: } else {
1.1084 raeburn 8353: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 8354: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 8355: $inststatus = $userenvref->{'inststatus'};
8356: } else {
1.1183 raeburn 8357: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
8358: $toolstatus = $userenv{$envkey};
1.1084 raeburn 8359: $inststatus = $userenv{'inststatus'};
8360: }
1.976 raeburn 8361: }
8362:
8363: if ($toolstatus ne '') {
8364: if ($toolstatus) {
8365: $access = 1;
8366: } else {
8367: $access = 0;
8368: }
8369: return $access;
8370: }
8371:
1.1084 raeburn 8372: my ($is_adv,%domdef);
8373: if (ref($is_advref) eq 'HASH') {
8374: $is_adv = $is_advref->{'is_adv'};
8375: } else {
8376: $is_adv = &is_advanced_user($udom,$uname);
8377: }
8378: if (ref($domdefref) eq 'HASH') {
8379: %domdef = %{$domdefref};
8380: } else {
8381: %domdef = &get_domain_defaults($udom);
8382: }
1.976 raeburn 8383: if (ref($domdef{$tool}) eq 'HASH') {
8384: if ($is_adv) {
8385: if ($domdef{$tool}{'_LC_adv'} ne '') {
8386: if ($domdef{$tool}{'_LC_adv'}) {
8387: $access = 1;
8388: } else {
8389: $access = 0;
8390: }
8391: return $access;
8392: }
8393: }
8394: if ($inststatus ne '') {
8395: my ($hasaccess,$hasnoaccess);
8396: foreach my $affiliation (split(/:/,$inststatus)) {
8397: if ($domdef{$tool}{$affiliation} ne '') {
8398: if ($domdef{$tool}{$affiliation}) {
8399: $hasaccess = 1;
8400: } else {
8401: $hasnoaccess = 1;
8402: }
8403: }
8404: }
8405: if ($hasaccess || $hasnoaccess) {
8406: if ($hasaccess) {
8407: $access = 1;
8408: } elsif ($hasnoaccess) {
8409: $access = 0;
8410: }
8411: return $access;
8412: }
8413: } else {
8414: if ($domdef{$tool}{'default'} ne '') {
8415: if ($domdef{$tool}{'default'}) {
8416: $access = 1;
8417: } elsif ($domdef{$tool}{'default'} == 0) {
8418: $access = 0;
8419: }
8420: return $access;
8421: }
8422: }
8423: } else {
1.1177 raeburn 8424: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 8425: $access = 1;
8426: } else {
8427: $access = 0;
8428: }
1.976 raeburn 8429: return $access;
8430: }
8431: }
8432:
1.1050 raeburn 8433: sub is_course_owner {
8434: my ($cdom,$cnum,$udom,$uname) = @_;
8435: if (($udom eq '') || ($uname eq '')) {
8436: $udom = $env{'user.domain'};
8437: $uname = $env{'user.name'};
8438: }
8439: unless (($udom eq '') || ($uname eq '')) {
8440: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
8441: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
8442: return 1;
8443: } else {
1.1494 raeburn 8444: my %courseinfo = &coursedescription($cdom.'/'.$cnum);
1.1050 raeburn 8445: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
8446: return 1;
8447: }
8448: }
8449: }
8450: }
8451: return;
8452: }
8453:
1.976 raeburn 8454: sub is_advanced_user {
1.1512 raeburn 8455: my ($udom,$uname,$nocache) = @_;
8456: my ($is_adv,$is_author,$use_cache,$hashid);
1.1085 raeburn 8457: if ($udom ne '' && $uname ne '') {
8458: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 8459: if (wantarray) {
8460: return ($env{'user.adv'},$env{'user.author'});
8461: } else {
8462: return $env{'user.adv'};
8463: }
1.1512 raeburn 8464: } elsif (!$nocache) {
8465: $use_cache = 1;
8466: $hashid = "$udom:$uname";
8467: my ($info,$cached)=&is_cached_new('isadvau',$hashid);
8468: if ($cached) {
8469: ($is_adv,$is_author) = split(/:/,$info);
8470: if (wantarray) {
8471: return ($is_adv,$is_author);
8472: }
8473: return $is_adv;
8474: }
1.1085 raeburn 8475: }
8476: }
1.976 raeburn 8477: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
8478: my %allroles;
8479: foreach my $role (keys(%roleshash)) {
8480: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
8481: my $area = '/'.$tdomain.'/'.$trest;
8482: if ($sec ne '') {
8483: $area .= '/'.$sec;
8484: }
8485: if (($area ne '') && ($trole ne '')) {
8486: my $spec=$trole.'.'.$area;
8487: if ($trole =~ /^cr\//) {
8488: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
8489: } elsif ($trole ne 'gr') {
8490: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
8491: }
1.1128 raeburn 8492: if ($trole eq 'au') {
8493: $is_author = 1;
8494: }
1.976 raeburn 8495: }
8496: }
8497: foreach my $role (keys(%allroles)) {
8498: last if ($is_adv);
8499: foreach my $item (split(/:/,$allroles{$role})) {
8500: if ($item ne '') {
8501: my ($privilege,$restrictions)=split(/&/,$item);
8502: if ($privilege eq 'adv') {
8503: $is_adv = 1;
8504: last;
8505: }
8506: }
8507: }
8508: }
1.1512 raeburn 8509: if ($use_cache) {
8510: my $cachetime = 600;
8511: &do_cache_new('isadvau',$hashid,$is_adv.':'.$is_author,$cachetime);
8512: }
1.1128 raeburn 8513: if (wantarray) {
8514: return ($is_adv,$is_author);
8515: }
1.976 raeburn 8516: return $is_adv;
8517: }
1.798 raeburn 8518:
1.1035 raeburn 8519: sub check_can_request {
1.1368 raeburn 8520: my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
1.1035 raeburn 8521: my $canreq = 0;
1.1368 raeburn 8522: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8523: $uname = $env{'user.name'};
8524: $udom = $env{'user.domain'};
8525: }
1.1035 raeburn 8526: my ($types,$typename) = &Apache::loncommon::course_types();
8527: my @options = ('approval','validate','autolimit');
8528: my $optregex = join('|',@options);
8529: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
1.1486 raeburn 8530: my %willtrust;
1.1035 raeburn 8531: foreach my $type (@{$types}) {
1.1368 raeburn 8532: if (&usertools_access($uname,$udom,$type,undef,
8533: 'requestcourses')) {
1.1035 raeburn 8534: $canreq ++;
1.1036 raeburn 8535: if (ref($request_domains) eq 'HASH') {
1.1368 raeburn 8536: push(@{$request_domains->{$type}},$udom);
1.1036 raeburn 8537: }
1.1368 raeburn 8538: if ($dom eq $udom) {
1.1035 raeburn 8539: $can_request->{$type} = 1;
8540: }
8541: }
1.1368 raeburn 8542: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
8543: ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
1.1035 raeburn 8544: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
8545: if (@curr > 0) {
1.1036 raeburn 8546: foreach my $item (@curr) {
8547: if (ref($request_domains) eq 'HASH') {
8548: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
8549: if ($otherdom ne '') {
1.1486 raeburn 8550: unless (exists($willtrust{$otherdom})) {
8551: $willtrust{$otherdom} = &will_trust('reqcrs',$env{'user.domain'},$otherdom);
8552: }
8553: if ($willtrust{$otherdom}) {
8554: if (ref($request_domains->{$type}) eq 'ARRAY') {
8555: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
8556: push(@{$request_domains->{$type}},$otherdom);
8557: }
8558: } else {
1.1036 raeburn 8559: push(@{$request_domains->{$type}},$otherdom);
8560: }
8561: }
8562: }
8563: }
8564: }
1.1368 raeburn 8565: unless ($dom eq $env{'user.domain'}) {
1.1036 raeburn 8566: $canreq ++;
1.1035 raeburn 8567: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
8568: $can_request->{$type} = 1;
8569: }
8570: }
8571: }
8572: }
8573: }
8574: }
8575: return $canreq;
8576: }
8577:
1.341 www 8578: # ---------------------------------------------- Custom access rule evaluation
8579:
8580: sub customaccess {
8581: my ($priv,$uri)=@_;
1.807 albertel 8582: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 8583: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 8584: $udom = &LONCAPA::clean_domain($udom);
8585: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 8586: my $access=0;
1.800 albertel 8587: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 8588: my ($effect,$realm,$role,$type)=split(/\:/,$right);
8589: if ($type eq 'user') {
8590: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 8591: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 8592: if ($tdom) {
8593: if ($tdom ne $env{'user.domain'}) { next; }
8594: }
1.896 albertel 8595: if ($tuname) {
8596: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 8597: }
8598: $access=($effect eq 'allow');
8599: last;
8600: }
8601: } else {
8602: if ($role) {
8603: if ($role ne $urole) { next; }
8604: }
8605: foreach my $scope (split(/\s*\,\s*/,$realm)) {
8606: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
8607: if ($tdom) {
8608: if ($tdom ne $udom) { next; }
8609: }
8610: if ($tcrs) {
8611: if ($tcrs ne $ucrs) { next; }
8612: }
8613: if ($tsec) {
8614: if ($tsec ne $usec) { next; }
8615: }
8616: $access=($effect eq 'allow');
8617: last;
8618: }
8619: if ($realm eq '' && $role eq '') {
8620: $access=($effect eq 'allow');
8621: }
1.402 bowersj2 8622: }
1.341 www 8623: }
8624: return $access;
8625: }
8626:
1.103 harris41 8627: # ------------------------------------------------- Check for a user privilege
1.12 www 8628:
8629: sub allowed {
1.1461 raeburn 8630: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck,$ignorecache,$nodeeplinkcheck,$nodeeplinkout)=@_;
1.705 albertel 8631: my $ver_orguri=$uri;
1.439 www 8632: $uri=&deversion($uri);
1.152 www 8633: my $orguri=$uri;
1.52 www 8634: $uri=&declutter($uri);
1.809 raeburn 8635:
1.810 raeburn 8636: if ($priv eq 'evb') {
1.1478 raeburn 8637: # Evade communication block restrictions for specified role in a course or domain
1.810 raeburn 8638: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
8639: return $1;
8640: } else {
8641: return;
8642: }
8643: }
8644:
1.620 albertel 8645: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 8646: # Free bre access to adm and meta resources
1.1436 raeburn 8647: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard|viewclasslist|aboutme|ext\.tool)$}))
1.769 albertel 8648: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
8649: && ($priv eq 'bre')) {
1.14 www 8650: return 'F';
1.159 www 8651: }
8652:
1.545 banghart 8653: # Free bre access to user's own portfolio contents
1.714 raeburn 8654: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 8655: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 8656: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 8657: my %setters;
1.1473 raeburn 8658: my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) =
8659: &Apache::loncommon::blockcheck(\%setters,'port',$clientip);
8660: if (($startblock && $endblock) || ($by_ip)) {
1.814 raeburn 8661: return 'B';
8662: } else {
8663: return 'F';
8664: }
1.545 banghart 8665: }
8666:
1.762 raeburn 8667: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 8668: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
8669: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
8670: if (exists($env{'request.course.id'})) {
8671: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8672: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
8673: if (($domain eq $cdom) && ($name eq $cnum)) {
8674: my $courseprivid=$env{'request.course.id'};
8675: $courseprivid=~s/\_/\//;
8676: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
8677: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
8678: return $1;
1.762 raeburn 8679: } else {
8680: if ($env{'request.course.sec'}) {
8681: $courseprivid.='/'.$env{'request.course.sec'};
8682: }
8683: if ($env{'user.priv.'.$env{'request.role'}.'./'.
8684: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
8685: return $2;
8686: }
1.714 raeburn 8687: }
8688: }
8689: }
8690: }
8691:
1.159 www 8692: # Free bre to public access
8693:
8694: if ($priv eq 'bre') {
1.1362 raeburn 8695: my $copyright;
8696: unless ($uri =~ /ext\.tool/) {
8697: $copyright=&metadata($uri,'copyright');
8698: }
1.620 albertel 8699: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 8700: return 'F';
8701: }
1.238 www 8702: if ($copyright eq 'priv') {
8703: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8704: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 8705: return '';
8706: }
8707: }
8708: if ($copyright eq 'domain') {
8709: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 8710: unless (($env{'user.domain'} eq $1) ||
8711: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 8712: return '';
8713: }
1.262 matthew 8714: }
1.620 albertel 8715: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 8716: # Library role, so allow browsing of resources in this domain.
8717: return 'F';
1.238 www 8718: }
1.341 www 8719: if ($copyright eq 'custom') {
8720: unless (&customaccess($priv,$uri)) { return ''; }
8721: }
1.14 www 8722: }
1.264 matthew 8723: # Domain coordinator is trying to create a course
1.620 albertel 8724: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 8725: # uri is the requested domain in this case.
8726: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 8727: # a role of dc for the domain in question.
1.620 albertel 8728: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 8729: }
1.29 www 8730:
1.52 www 8731: my $thisallowed='';
8732: my $statecond=0;
8733: my $courseprivid='';
8734:
1.1039 raeburn 8735: my $ownaccess;
1.1043 raeburn 8736: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 8737: if (($priv eq 'bro') && ($env{'user.author'})) {
8738: if ($uri eq '') {
8739: $ownaccess = 1;
8740: } else {
8741: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
8742: my $udom = $env{'user.domain'};
8743: my $uname = $env{'user.name'};
8744: if ($uri =~ m{^\Q$udom\E/?$}) {
8745: $ownaccess = 1;
1.1040 raeburn 8746: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 8747: unless ($uri =~ m{\.\./}) {
8748: $ownaccess = 1;
8749: }
8750: } elsif (($udom ne 'public') && ($uname ne 'public')) {
8751: my $now = time;
8752: if ($uri =~ m{^([^/]+)/?$}) {
8753: my $adom = $1;
8754: foreach my $key (keys(%env)) {
1.1042 raeburn 8755: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1452 raeburn 8756: my ($start,$end) = split(/\./,$env{$key});
8757: if (($now >= $start) && (!$end || $end > $now)) {
1.1039 raeburn 8758: $ownaccess = 1;
8759: last;
8760: }
8761: }
8762: }
8763: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
8764: my $adom = $1;
8765: my $aname = $2;
1.1042 raeburn 8766: foreach my $role ('ca','aa') {
8767: if ($env{"user.role.$role./$adom/$aname"}) {
8768: my ($start,$end) =
1.1452 raeburn 8769: split(/\./,$env{"user.role.$role./$adom/$aname"});
8770: if (($now >= $start) && (!$end || $end > $now)) {
1.1042 raeburn 8771: $ownaccess = 1;
8772: last;
8773: }
1.1039 raeburn 8774: }
8775: }
8776: }
8777: }
8778: }
8779: }
8780: }
8781:
1.52 www 8782: # Course
8783:
1.620 albertel 8784: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8785: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8786: $thisallowed.=$1;
8787: }
1.52 www 8788: }
1.29 www 8789:
1.52 www 8790: # Domain
8791:
1.620 albertel 8792: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 8793: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 8794: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 8795: $thisallowed.=$1;
8796: }
1.12 www 8797: }
1.52 www 8798:
1.1141 raeburn 8799: # User who is not author or co-author might still be able to edit
8800: # resource of an author in the domain (e.g., if Domain Coordinator).
8801: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
8802: (&allowed('mdc',$env{'request.course.id'}))) {
8803: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
8804: $thisallowed.=$1;
8805: }
8806: }
8807:
1.52 www 8808: # Course: uri itself is a course
1.66 www 8809: my $courseuri=$uri;
8810: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 8811: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 8812:
1.620 albertel 8813: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 8814: =~/\Q$priv\E\&([^\:]*)/) {
1.1409 raeburn 8815: if ($priv eq 'mip') {
8816: my $rem = $1;
8817: if (($uri ne '') && ($env{'request.course.id'} eq $uri) &&
8818: ($env{'course.'.$env{'request.course.id'}.'.internal.courseowner'} eq $env{'user.name'}.':'.$env{'user.domain'})) {
8819: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
8820: if ($cdom ne '') {
1.1410 raeburn 8821: my %passwdconf = &get_passwdconf($cdom);
8822: if (ref($passwdconf{'crsownerchg'}) eq 'HASH') {
8823: if (ref($passwdconf{'crsownerchg'}{'by'}) eq 'ARRAY') {
8824: if (@{$passwdconf{'crsownerchg'}{'by'}}) {
8825: my @inststatuses = split(':',$env{'environment.inststatus'});
8826: unless (@inststatuses) {
8827: @inststatuses = ('default');
8828: }
8829: foreach my $status (@inststatuses) {
8830: if (grep(/^\Q$status\E$/,@{$passwdconf{'crsownerchg'}{'by'}})) {
8831: $thisallowed.=$rem;
8832: }
8833: }
8834: }
8835: }
1.1409 raeburn 8836: }
8837: }
8838: }
8839: } else {
8840: unless (($priv eq 'bro') && (!$ownaccess)) {
8841: $thisallowed.=$1;
8842: }
1.1039 raeburn 8843: }
1.12 www 8844: }
1.29 www 8845:
1.665 albertel 8846: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 8847: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 8848: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 8849: $thisallowed='';
1.671 raeburn 8850: my ($match)=&is_on_map($uri);
8851: if ($match) {
8852: if ($env{'user.priv.'.$env{'request.role'}.'./'}
8853: =~/\Q$priv\E\&([^\:]*)/) {
1.1281 raeburn 8854: my $value = $1;
1.1461 raeburn 8855: my $deeplinkblock;
8856: unless ($nodeeplinkcheck) {
8857: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8858: }
1.1402 raeburn 8859: if ($deeplinkblock) {
8860: $thisallowed='D';
8861: } elsif ($noblockcheck) {
1.1281 raeburn 8862: $thisallowed.=$value;
1.1162 raeburn 8863: } else {
1.1424 raeburn 8864: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8865: if (@blockers > 0) {
8866: $thisallowed = 'B';
8867: } else {
8868: $thisallowed.=$value;
8869: }
1.1162 raeburn 8870: }
1.671 raeburn 8871: }
8872: } else {
1.705 albertel 8873: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 8874: if ($refuri) {
8875: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 8876: $thisallowed='F';
1.671 raeburn 8877: } else {
8878: $refuri=&declutter($refuri);
8879: my ($match) = &is_on_map($refuri);
8880: if ($match) {
1.1461 raeburn 8881: my $deeplinkblock;
8882: unless ($nodeeplinkcheck) {
8883: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
8884: }
1.1402 raeburn 8885: if ($deeplinkblock) {
8886: $thisallowed='D';
8887: } elsif ($noblockcheck) {
1.1281 raeburn 8888: $thisallowed='F';
1.1162 raeburn 8889: } else {
1.1426 raeburn 8890: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 8891: if (@blockers > 0) {
8892: $thisallowed = 'B';
8893: } else {
8894: $thisallowed='F';
8895: }
1.1162 raeburn 8896: }
1.671 raeburn 8897: }
1.669 raeburn 8898: }
1.671 raeburn 8899: }
8900: }
1.314 www 8901: }
1.492 albertel 8902:
1.766 albertel 8903: if ($priv eq 'bre'
8904: && $thisallowed ne 'F'
8905: && $thisallowed ne '2'
8906: && &is_portfolio_url($uri)) {
1.1270 raeburn 8907: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 8908: }
1.1250 raeburn 8909:
1.52 www 8910: # Full access at system, domain or course-wide level? Exit.
1.29 www 8911: if ($thisallowed=~/F/) {
8912: return 'F';
8913: }
8914:
1.52 www 8915: # If this is generating or modifying users, exit with special codes
1.29 www 8916:
1.1517 raeburn 8917: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:vca:vaa:'=~/\:\Q$priv\E\:/) {
1.643 www 8918: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 8919: my ($audom,$auname)=split('/',$uri);
1.643 www 8920: # no author name given, so this just checks on the general right to make a co-author in this domain
8921: unless ($auname) { return $thisallowed; }
8922: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 8923: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
8924: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
8925: ($audom ne $env{'request.role.domain'}))) { return ''; }
1.1517 raeburn 8926: } elsif (($priv eq 'vca') || ($priv eq 'vaa')) {
8927: my ($audom,$auname)=split('/',$uri);
8928: unless ($auname) { return $thisallowed; }
8929: unless (($env{'request.role'} eq "dc./$audom") ||
8930: ($env{'request.role'} eq "ca./$uri")) {
8931: return '';
8932: }
1.642 albertel 8933: }
1.52 www 8934: return $thisallowed;
8935: }
8936: #
1.103 harris41 8937: # Gathered so far: system, domain and course wide privileges
1.52 www 8938: #
8939: # Course: See if uri or referer is an individual resource that is part of
8940: # the course
8941:
1.620 albertel 8942: if ($env{'request.course.id'}) {
1.232 www 8943:
1.1504 raeburn 8944: if ($priv eq 'bre') {
8945: if (&is_coursetool_logo($uri)) {
8946: return 'F';
8947: }
8948: }
8949:
1.1409 raeburn 8950: # If this is modifying password (internal auth) domains must match for user and user's role.
8951:
8952: if ($priv eq 'mip') {
8953: if ($env{'user.domain'} eq $env{'request.role.domain'}) {
8954: return $thisallowed;
8955: } else {
8956: return '';
8957: }
8958: }
8959:
1.620 albertel 8960: $courseprivid=$env{'request.course.id'};
8961: if ($env{'request.course.sec'}) {
8962: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 8963: }
8964: $courseprivid=~s/\_/\//;
8965: my $checkreferer=1;
1.232 www 8966: my ($match,$cond)=&is_on_map($uri);
8967: if ($match) {
8968: $statecond=$cond;
1.620 albertel 8969: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 8970: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 8971: my $value = $1;
8972: if ($priv eq 'bre') {
1.1461 raeburn 8973: my $deeplinkblock;
8974: unless ($nodeeplinkcheck) {
8975: $deeplinkblock = &deeplink_check($priv,$symb,$uri);
8976: }
1.1458 raeburn 8977: if ($deeplinkblock) {
8978: $thisallowed = 'D';
8979: } elsif ($noblockcheck) {
1.1281 raeburn 8980: $thisallowed.=$value;
1.1162 raeburn 8981: } else {
1.1424 raeburn 8982: my @blockers = &has_comm_blocking($priv,$symb,$uri,$ignorecache);
1.1281 raeburn 8983: if (@blockers > 0) {
8984: $thisallowed = 'B';
8985: } else {
8986: $thisallowed.=$value;
8987: }
1.1162 raeburn 8988: }
8989: } else {
8990: $thisallowed.=$value;
8991: }
1.52 www 8992: $checkreferer=0;
8993: }
1.29 www 8994: }
1.1424 raeburn 8995:
1.148 www 8996: if ($checkreferer) {
1.620 albertel 8997: my $refuri=$env{'httpref.'.$orguri};
1.148 www 8998: unless ($refuri) {
1.800 albertel 8999: foreach my $key (keys(%env)) {
9000: if ($key=~/^httpref\..*\*/) {
9001: my $pattern=$key;
1.156 www 9002: $pattern=~s/^httpref\.\/res\///;
1.148 www 9003: $pattern=~s/\*/\[\^\/\]\+/g;
9004: $pattern=~s/\//\\\//g;
1.152 www 9005: if ($orguri=~/$pattern/) {
1.800 albertel 9006: $refuri=$env{$key};
1.148 www 9007: }
9008: }
1.191 harris41 9009: }
1.148 www 9010: }
1.232 www 9011:
1.148 www 9012: if ($refuri) {
1.152 www 9013: $refuri=&declutter($refuri);
1.232 www 9014: my ($match,$cond)=&is_on_map($refuri);
9015: if ($match) {
9016: my $refstatecond=$cond;
1.620 albertel 9017: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 9018: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 9019: my $value = $1;
9020: if ($priv eq 'bre') {
1.1461 raeburn 9021: my $deeplinkblock;
9022: unless ($nodeeplinkcheck) {
9023: $deeplinkblock = &deeplink_check($priv,$symb,$refuri);
9024: }
1.1402 raeburn 9025: if ($deeplinkblock) {
9026: $thisallowed = 'D';
9027: } elsif ($noblockcheck) {
1.1281 raeburn 9028: $thisallowed.=$value;
1.1162 raeburn 9029: } else {
1.1426 raeburn 9030: my @blockers = &has_comm_blocking($priv,'',$refuri,'',1);
1.1281 raeburn 9031: if (@blockers > 0) {
9032: $thisallowed = 'B';
9033: } else {
9034: $thisallowed.=$value;
9035: }
1.1162 raeburn 9036: }
9037: } else {
9038: $thisallowed.=$value;
9039: }
1.53 www 9040: $uri=$refuri;
9041: $statecond=$refstatecond;
1.52 www 9042: }
9043: }
1.148 www 9044: }
1.29 www 9045: }
1.52 www 9046: }
1.29 www 9047:
1.52 www 9048: #
1.103 harris41 9049: # Gathered now: all privileges that could apply, and condition number
1.52 www 9050: #
9051: #
9052: # Full or no access?
9053: #
1.29 www 9054:
1.52 www 9055: if ($thisallowed=~/F/) {
9056: return 'F';
9057: }
1.29 www 9058:
1.52 www 9059: unless ($thisallowed) {
9060: return '';
9061: }
1.29 www 9062:
1.52 www 9063: # Restrictions exist, deal with them
9064: #
9065: # C:according to course preferences
9066: # R:according to resource settings
9067: # L:unless locked
9068: # X:according to user session state
9069: #
9070:
9071: # Possibly locked functionality, check all courses
1.1454 raeburn 9072: # In roles.tab, L (unless locked) available for bre, pch, plc, pac and sma.
1.54 www 9073: # Locks might take effect only after 10 minutes cache expiration for other
1.1454 raeburn 9074: # courses, and 2 minutes for current course, in which user has st or ta role
9075: # which is neither expired nor a future role (unless current course).
1.52 www 9076:
1.1454 raeburn 9077: my ($needlockcheck,$now,$crsonly);
1.52 www 9078: if ($thisallowed=~/L/) {
1.1454 raeburn 9079: $now = time;
9080: if ($priv eq 'bre') {
9081: if ($uri ne '') {
9082: if ($orguri =~ m{^/+res/}) {
9083: if ($uri =~ m{^lib/templates/}) {
9084: if ($env{'request.course.id'}) {
9085: $crsonly = 1;
9086: $needlockcheck = 1;
9087: }
9088: } else {
9089: $needlockcheck = 1;
9090: }
9091: } elsif ($env{'request.course.id'}) {
9092: my ($crsdom,$crsnum) = split('_',$env{'request.course.id'});
9093: if (($uri =~ m{^(adm|uploaded|public)/$crsdom/$crsnum/}) ||
9094: ($uri =~ m{^adm/$match_domain/$match_username/\d+/(smppg|bulletinboard)$})) {
9095: $crsonly = 1;
9096: }
9097: $needlockcheck = 1;
9098: }
9099: }
9100: } elsif (($priv eq 'pch') || ($priv eq 'plc') || ($priv eq 'pac') || ($priv eq 'sma')) {
9101: $needlockcheck = 1;
9102: }
9103: }
9104: if ($needlockcheck) {
1.1453 raeburn 9105: foreach my $envkey (keys(%env)) {
1.54 www 9106: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
9107: my $courseid=$2;
9108: my $roleid=$1.'.'.$2;
1.92 www 9109: $courseid=~s/^\///;
1.1453 raeburn 9110: unless ($env{'request.role'} eq $roleid) {
9111: my ($start,$end) = split(/\./,$env{$envkey});
9112: next unless (($now >= $start) && (!$end || $end > $now));
9113: }
1.54 www 9114: my $expiretime=600;
1.620 albertel 9115: if ($env{'request.role'} eq $roleid) {
1.54 www 9116: $expiretime=120;
9117: }
9118: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
9119: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 9120: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 9121: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 9122: }
1.620 albertel 9123: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
9124: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
9125: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
9126: &log($env{'user.domain'},$env{'user.name'},
9127: $env{'user.home'},
1.57 www 9128: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 9129: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 9130: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 9131: return '';
9132: }
9133: }
1.620 albertel 9134: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
9135: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
1.1455 raeburn 9136: if ($env{$prefix.'priv.'.$priv.'.lock.expire'}>time) {
1.620 albertel 9137: &log($env{'user.domain'},$env{'user.name'},
9138: $env{'user.home'},
1.57 www 9139: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 9140: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 9141: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 9142: return '';
9143: }
9144: }
9145: }
1.29 www 9146: }
1.52 www 9147: }
1.1424 raeburn 9148:
1.52 www 9149: #
9150: # Rest of the restrictions depend on selected course
9151: #
9152:
1.620 albertel 9153: unless ($env{'request.course.id'}) {
1.766 albertel 9154: if ($thisallowed eq 'A') {
9155: return 'A';
1.814 raeburn 9156: } elsif ($thisallowed eq 'B') {
9157: return 'B';
1.766 albertel 9158: } else {
9159: return '1';
9160: }
1.52 www 9161: }
1.29 www 9162:
1.52 www 9163: #
9164: # Now user is definitely in a course
9165: #
1.53 www 9166:
9167:
9168: # Course preferences
9169:
9170: if ($thisallowed=~/C/) {
1.620 albertel 9171: my $rolecode=(split(/\./,$env{'request.role'}))[0];
9172: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
9173: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 9174: =~/\Q$rolecode\E/) {
1.1304 raeburn 9175: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 9176: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
9177: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
9178: $env{'request.course.id'});
9179: }
1.237 www 9180: return '';
9181: }
9182:
1.620 albertel 9183: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 9184: =~/\Q$unamedom\E/) {
1.1304 raeburn 9185: if (($priv ne 'pch') && ($priv ne 'plc') && ($priv ne 'pac')) {
1.689 albertel 9186: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
9187: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
9188: $env{'request.course.id'});
9189: }
1.54 www 9190: return '';
9191: }
1.53 www 9192: }
9193:
9194: # Resource preferences
9195:
9196: if ($thisallowed=~/R/) {
1.620 albertel 9197: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 9198: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 9199: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 9200: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
9201: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
9202: }
9203: return '';
1.54 www 9204: }
1.53 www 9205: }
1.30 www 9206:
1.1461 raeburn 9207: # Restricted for deeplinked session?
9208:
9209: if ($env{'request.deeplink.login'}) {
9210: if ($env{'acc.deeplinkout'} && !$nodeeplinkout) {
9211: if (!$symb) { $symb=&symbread($uri,1); }
9212: if (($symb) && ($env{'acc.deeplinkout'}=~/\&\Q$symb\E\&/)) {
9213: return '';
9214: }
9215: }
9216: }
9217:
1.246 www 9218: # Restricted by state or randomout?
1.30 www 9219:
1.52 www 9220: if ($thisallowed=~/X/) {
1.620 albertel 9221: if ($env{'acc.randomout'}) {
1.579 albertel 9222: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 9223: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 9224: return '';
9225: }
1.247 www 9226: }
9227: if (&condval($statecond)) {
1.52 www 9228: return '2';
9229: } else {
9230: return '';
9231: }
9232: }
1.30 www 9233:
1.766 albertel 9234: if ($thisallowed eq 'A') {
9235: return 'A';
1.814 raeburn 9236: } elsif ($thisallowed eq 'B') {
9237: return 'B';
1.1402 raeburn 9238: } elsif ($thisallowed eq 'D') {
9239: return 'D';
1.766 albertel 9240: }
1.52 www 9241: return 'F';
1.232 www 9242: }
1.1162 raeburn 9243:
1.1192 raeburn 9244: # ------------------------------------------- Check construction space access
9245:
9246: sub constructaccess {
9247: my ($url,$setpriv)=@_;
9248:
9249: # We do not allow editing of previous versions of files
9250: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
9251:
9252: # Get username and domain from URL
9253: my ($ownername,$ownerdomain,$ownerhome);
9254:
9255: ($ownerdomain,$ownername) =
1.1325 raeburn 9256: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)(?:/daxepage|/daxeopen)?/priv/($match_domain)/($match_username)(?:/|$)});
1.1192 raeburn 9257:
9258: # The URL does not really point to any authorspace, forget it
9259: unless (($ownername) && ($ownerdomain)) { return ''; }
9260:
9261: # Now we need to see if the user has access to the authorspace of
9262: # $ownername at $ownerdomain
9263:
9264: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
9265: # Real author for this?
9266: $ownerhome = $env{'user.home'};
9267: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
9268: return ($ownername,$ownerdomain,$ownerhome);
9269: }
1.1506 raeburn 9270: } elsif (&is_course($ownerdomain,$ownername)) {
9271: # Course Authoring Space?
1.1312 raeburn 9272: if ($env{'request.course.id'}) {
9273: if (($ownername eq $env{'course.'.$env{'request.course.id'}.'.num'}) &&
9274: ($ownerdomain eq $env{'course.'.$env{'request.course.id'}.'.domain'})) {
9275: if (&allowed('mdc',$env{'request.course.id'})) {
1.1520 raeburn 9276: return if ($env{'course.'.$env{'request.course.id'}.'.internal.crsauthor'} eq '0');
9277: unless ($env{'course.'.$env{'request.course.id'}.'.internal.crsauthor'}) {
9278: my %domdefs = &get_domain_defaults($ownerdomain);
9279: my $type = lc($env{'course.'.$env{'request.course.id'}.'.type'});
9280: unless (($type eq 'community') || ($type eq 'placement')) {
9281: $type = 'unofficial';
9282: if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'} ne '') {
9283: $type = 'official';
9284: } elsif ($env{'course.'.$env{'request.course.id'}.'internal.textbook'} ne '') {
9285: $type = 'textbook';
9286: } else {
9287: $type = 'unofficial';
9288: }
9289: }
9290: return if ($domdefs{$type.'crsauthor'} eq '0');
9291: }
1.1312 raeburn 9292: $ownerhome = $env{'course.'.$env{'request.course.id'}.'.home'};
9293: return ($ownername,$ownerdomain,$ownerhome);
9294: }
9295: }
9296: }
1.1506 raeburn 9297: return '';
9298: } else {
9299: # Co-author for this?
9300: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
9301: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
9302: $ownerhome = &homeserver($ownername,$ownerdomain);
9303: return ($ownername,$ownerdomain,$ownerhome);
9304: }
1.1192 raeburn 9305: }
9306:
9307: # We don't have any access right now. If we are not possibly going to do anything about this,
9308: # we might as well leave
9309: unless ($setpriv) { return ''; }
9310:
9311: # Backdoor access?
9312: my $allowed=&allowed('eco',$ownerdomain);
9313: # Nope
9314: unless ($allowed) { return ''; }
9315: # Looks like we may have access, but could be locked by the owner of the construction space
9316: if ($allowed eq 'U') {
9317: my %blocked=&get('environment',['domcoord.author'],
9318: $ownerdomain,$ownername);
9319: # Is blocked by owner
9320: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
9321: }
9322: if (($allowed eq 'F') || ($allowed eq 'U')) {
9323: # Grant temporary access
9324: my $then=$env{'user.login.time'};
1.1209 raeburn 9325: my $update=$env{'user.update.time'};
1.1192 raeburn 9326: if (!$update) { $update = $then; }
9327: my $refresh=$env{'user.refresh.time'};
9328: if (!$refresh) { $refresh = $update; }
9329: my $now = time;
9330: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
9331: $now,'ca','constructaccess');
9332: $ownerhome = &homeserver($ownername,$ownerdomain);
9333: return($ownername,$ownerdomain,$ownerhome);
9334: }
9335: # No business here
9336: return '';
9337: }
9338:
1.1282 raeburn 9339: # ----------------------------------------------------------- Content Blocking
9340:
9341: {
9342: # Caches for faster Course Contents display where content blocking
9343: # is in operation (i.e., interval param set) for timed quiz.
9344: #
9345: # User for whom data are being temporarily cached.
9346: my $cacheduser='';
1.1424 raeburn 9347: # Course for which data are being temporarily cached.
9348: my $cachedcid='';
1.1282 raeburn 9349: # Cached blockers for this user (a hash of blocking items).
9350: my %cachedblockers=();
9351: # When the data were last cached.
9352: my $cachedlast='';
9353:
9354: sub load_all_blockers {
1.1427 raeburn 9355: my ($uname,$udom)=@_;
1.1282 raeburn 9356: if (($uname ne '') && ($udom ne '')) {
9357: if (($cacheduser eq $uname.':'.$udom) &&
1.1424 raeburn 9358: ($cachedcid eq $env{'request.course.id'}) &&
1.1427 raeburn 9359: (abs($cachedlast-time)<5)) {
1.1282 raeburn 9360: return;
9361: }
9362: }
9363: $cachedlast=time;
9364: $cacheduser=$uname.':'.$udom;
1.1424 raeburn 9365: $cachedcid=$env{'request.course.id'};
1.1427 raeburn 9366: %cachedblockers = &get_commblock_resources();
1.1424 raeburn 9367: return;
1.1282 raeburn 9368: }
9369:
1.1162 raeburn 9370: sub get_comm_blocks {
9371: my ($cdom,$cnum) = @_;
9372: if ($cdom eq '' || $cnum eq '') {
9373: return unless ($env{'request.course.id'});
9374: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9375: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9376: }
9377: my %commblocks;
9378: my $hashid=$cdom.'_'.$cnum;
9379: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
9380: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
9381: %commblocks = %{$blocksref};
9382: } else {
1.1494 raeburn 9383: %commblocks = &dump('comm_block',$cdom,$cnum);
1.1162 raeburn 9384: my $cachetime = 600;
9385: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
9386: }
9387: return %commblocks;
9388: }
9389:
1.1282 raeburn 9390: sub get_commblock_resources {
9391: my ($blocks) = @_;
9392: my %blockers = ();
9393: return %blockers unless ($env{'request.course.id'});
1.1470 raeburn 9394: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
9395: if ($env{'request.course.sec'}) {
9396: $courseurl .= '/'.$env{'request.course.sec'};
9397: }
9398: return %blockers if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
1.1162 raeburn 9399: my %commblocks;
9400: if (ref($blocks) eq 'HASH') {
9401: %commblocks = %{$blocks};
9402: } else {
9403: %commblocks = &get_comm_blocks();
9404: }
1.1282 raeburn 9405: return %blockers unless (keys(%commblocks) > 0);
9406: my $navmap = Apache::lonnavmaps::navmap->new();
9407: return %blockers unless (ref($navmap));
1.1162 raeburn 9408: my $now = time;
9409: foreach my $block (keys(%commblocks)) {
9410: if ($block =~ /^(\d+)____(\d+)$/) {
9411: my ($start,$end) = ($1,$2);
9412: if ($start <= $now && $end >= $now) {
9413: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
9414: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
9415: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282 raeburn 9416: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
9417: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 9418: }
9419: }
9420: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282 raeburn 9421: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
9422: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 9423: }
9424: }
9425: }
9426: }
9427: }
9428: } elsif ($block =~ /^firstaccess____(.+)$/) {
9429: my $item = $1;
9430: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
9431: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1471 raeburn 9432: my (@interval,$mapname);
1.1282 raeburn 9433: my $type = 'map';
9434: if ($item eq 'course') {
9435: $type = 'course';
9436: @interval=&EXT("resource.0.interval");
9437: } else {
9438: if ($item =~ /___\d+___/) {
9439: $type = 'resource';
9440: @interval=&EXT("resource.0.interval",$item);
1.1162 raeburn 9441: } else {
1.1471 raeburn 9442: $mapname = &deversion($item);
9443: if (ref($navmap)) {
9444: my $timelimit = $navmap->get_mapparam(undef,$mapname,'0.interval');
9445: @interval = ($timelimit,'map');
1.1162 raeburn 9446: }
9447: }
1.1282 raeburn 9448: }
1.1310 raeburn 9449: if ($interval[0] =~ /^(\d+)/) {
1.1308 raeburn 9450: my $timelimit = $1;
1.1282 raeburn 9451: my $first_access;
9452: if ($type eq 'resource') {
9453: $first_access=&get_first_access($interval[1],$item);
9454: } elsif ($type eq 'map') {
9455: $first_access=&get_first_access($interval[1],undef,$item);
9456: } else {
9457: $first_access=&get_first_access($interval[1]);
9458: }
9459: if ($first_access) {
1.1292 raeburn 9460: my $timesup = $first_access+$timelimit;
1.1282 raeburn 9461: if ($timesup > $now) {
9462: my $activeblock;
1.1471 raeburn 9463: if ($type eq 'resource') {
9464: if (ref($navmap)) {
9465: my $res = $navmap->getBySymb($item);
9466: if ($res->answerable()) {
9467: $activeblock = 1;
9468: }
9469: }
9470: } elsif ($type eq 'map') {
9471: my $mapsymb = &symbread($mapname,1);
9472: if (($mapsymb) && (ref($navmap))) {
9473: my $mapres = $navmap->getBySymb($mapsymb);
9474: if (ref($mapres)) {
9475: my $first = $mapres->map_start();
9476: my $finish = $mapres->map_finish();
9477: my $it = $navmap->getIterator($first,$finish,undef,0,0);
9478: if (ref($it)) {
9479: my $res;
9480: while ($res = $it->next(undef,1)) {
9481: next unless (ref($res));
9482: my $symb = $res->symb();
9483: next if (($symb eq $mapsymb) || ($symb eq ''));
9484: @interval=&EXT("resource.0.interval",$symb);
9485: if ($interval[1] eq 'map') {
9486: if ($res->answerable()) {
9487: $activeblock = 1;
9488: last;
9489: }
9490: }
9491: }
9492: }
9493: }
1.1282 raeburn 9494: }
9495: }
9496: if ($activeblock) {
9497: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
9498: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
9499: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
9500: }
9501: }
9502: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
9503: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
9504: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 9505: }
1.1162 raeburn 9506: }
9507: }
9508: }
9509: }
9510: }
9511: }
9512: }
9513: }
9514: }
1.1282 raeburn 9515: return %blockers;
1.1162 raeburn 9516: }
9517:
1.1282 raeburn 9518: sub has_comm_blocking {
1.1427 raeburn 9519: my ($priv,$symb,$uri,$ignoresymbdb,$noenccheck,$blocked,$blocks) = @_;
1.1282 raeburn 9520: my @blockers;
9521: return unless ($env{'request.course.id'});
9522: return unless ($priv eq 'bre');
9523: return if ($env{'request.state'} eq 'construct');
1.1470 raeburn 9524: my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
9525: if ($env{'request.course.sec'}) {
9526: $courseurl .= '/'.$env{'request.course.sec'};
9527: }
9528: return if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseurl} =~/evb\&([^\:]*)/);
1.1427 raeburn 9529: my %blockinfo;
9530: if (ref($blocks) eq 'HASH') {
9531: %blockinfo = &get_commblock_resources($blocks);
9532: } else {
9533: &load_all_blockers($env{'user.name'},$env{'user.domain'});
9534: %blockinfo = %cachedblockers;
9535: }
9536: return unless (keys(%blockinfo) > 0);
1.1282 raeburn 9537: my (%possibles,@symbs);
9538: if (!$symb) {
1.1427 raeburn 9539: $symb = &symbread($uri,1,1,1,\%possibles,$ignoresymbdb,$noenccheck);
1.1162 raeburn 9540: }
1.1282 raeburn 9541: if ($symb) {
9542: @symbs = ($symb);
9543: } elsif (keys(%possibles)) {
9544: @symbs = keys(%possibles);
9545: }
9546: my $noblock;
9547: foreach my $symb (@symbs) {
9548: last if ($noblock);
9549: my ($map,$resid,$resurl)=&decode_symb($symb);
1.1427 raeburn 9550: foreach my $block (keys(%blockinfo)) {
1.1282 raeburn 9551: if ($block =~ /^firstaccess____(.+)$/) {
9552: my $item = $1;
1.1424 raeburn 9553: unless ($blocked) {
9554: if (($item eq $map) || ($item eq $symb)) {
9555: $noblock = 1;
9556: last;
9557: }
1.1282 raeburn 9558: }
9559: }
1.1427 raeburn 9560: if (ref($blockinfo{$block}) eq 'HASH') {
9561: if (ref($blockinfo{$block}{'resources'}) eq 'HASH') {
9562: if ($blockinfo{$block}{'resources'}{$symb}) {
1.1282 raeburn 9563: unless (grep(/^\Q$block\E$/,@blockers)) {
9564: push(@blockers,$block);
9565: }
9566: }
9567: }
1.1427 raeburn 9568: if (ref($blockinfo{$block}{'maps'}) eq 'HASH') {
9569: if ($blockinfo{$block}{'maps'}{$map}) {
1.1424 raeburn 9570: unless (grep(/^\Q$block\E$/,@blockers)) {
9571: push(@blockers,$block);
9572: }
1.1282 raeburn 9573: }
9574: }
1.1162 raeburn 9575: }
9576: }
9577: }
1.1424 raeburn 9578: unless ($noblock) {
9579: return @blockers;
9580: }
9581: return;
1.1282 raeburn 9582: }
1.1162 raeburn 9583: }
9584:
1.1402 raeburn 9585: sub deeplink_check {
9586: my ($priv,$symb,$uri) = @_;
9587: return unless ($env{'request.course.id'});
9588: return unless ($priv eq 'bre');
9589: return if ($env{'request.state'} eq 'construct');
9590: return if ($env{'request.role.adv'});
9591: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
9592: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
9593: my (%possibles,@symbs);
9594: if (!$symb) {
9595: $symb = &symbread($uri,1,1,1,\%possibles);
9596: }
9597: if ($symb) {
9598: @symbs = ($symb);
9599: } elsif (keys(%possibles)) {
9600: @symbs = keys(%possibles);
9601: }
9602:
1.1461 raeburn 9603: my ($deeplink_symb,$allow);
9604: if ($env{'request.deeplink.login'}) {
9605: $deeplink_symb = &Apache::loncommon::deeplink_login_symb($cnum,$cdom);
1.1402 raeburn 9606: }
9607: foreach my $symb (@symbs) {
9608: last if ($allow);
9609: my $deeplink = &EXT("resource.0.deeplink",$symb);
9610: if ($deeplink eq '') {
9611: $allow = 1;
9612: } else {
1.1463 raeburn 9613: my ($state,$others,$listed,$scope,$protect) = split(/,/,$deeplink);
9614: if ($state ne 'only') {
1.1402 raeburn 9615: $allow = 1;
1.1463 raeburn 9616: } else {
9617: my $check_deeplink_entry;
9618: if ($protect ne 'none') {
9619: my ($acctype,$item) = split(/:/,$protect);
9620: if (($acctype eq 'ltic') && ($env{'user.linkprotector'})) {
9621: if (grep(/^\Q$item\Ec$/,split(/,/,$env{'user.linkprotector'}))) {
9622: $check_deeplink_entry = 1
9623: }
9624: } elsif (($acctype eq 'ltid') && ($env{'user.linkprotector'})) {
9625: if (grep(/^\Q$item\Ed$/,split(/,/,$env{'user.linkprotector'}))) {
9626: $check_deeplink_entry = 1;
9627: }
9628: } elsif (($acctype eq 'key') && ($env{'user.deeplinkkey'})) {
9629: if (grep(/^\Q$item\E$/,split(/,/,$env{'user.deeplinkkey'}))) {
9630: $check_deeplink_entry = 1;
9631: }
9632: }
9633: }
9634: if (($protect eq 'none') || ($check_deeplink_entry)) {
1.1402 raeburn 9635: if ($scope eq 'res') {
1.1461 raeburn 9636: if ($symb eq $deeplink_symb) {
1.1402 raeburn 9637: $allow = 1;
9638: }
1.1459 raeburn 9639: } elsif (($scope eq 'map') || ($scope eq 'rec')) {
1.1463 raeburn 9640: my ($map_from_symb,$map_from_login);
1.1461 raeburn 9641: $map_from_symb = &deversion((&decode_symb($symb))[0]);
9642: if ($deeplink_symb =~ /\.(page|sequence)$/) {
9643: $map_from_login = &deversion((&decode_symb($deeplink_symb))[2]);
9644: } else {
9645: $map_from_login = &deversion((&decode_symb($deeplink_symb))[0]);
9646: }
1.1459 raeburn 9647: if (($map_from_symb) && ($map_from_login)) {
9648: if ($map_from_symb eq $map_from_login) {
9649: $allow = 1;
9650: } elsif ($scope eq 'rec') {
9651: my @recurseup = &get_map_hierarchy($map_from_symb,$env{'request.course.id'});
9652: if (grep(/^\Q$map_from_login\E$/,@recurseup)) {
9653: $allow = 1;
9654: }
9655: }
9656: }
1.1402 raeburn 9657: }
9658: }
9659: }
9660: }
9661: }
9662: return if ($allow);
9663: return 1;
9664: }
9665:
1.1282 raeburn 9666: # -------------------------------- Deversion and split uri into path an filename
9667:
1.1133 foxr 9668: #
1.1282 raeburn 9669: # Removes the version from a URI and
1.1133 foxr 9670: # splits it in to its filename and path to the filename.
9671: # Seems like File::Basename could have done this more clearly.
9672: # Parameters:
9673: # $uri - input URI
9674: # Returns:
9675: # Two element list consisting of
9676: # $pathname - the URI up to and excluding the trailing /
9677: # $filename - The part of the URI following the last /
9678: # NOTE:
9679: # Another realization of this is simply:
9680: # use File::Basename;
9681: # ...
9682: # $uri = shift;
9683: # $filename = basename($uri);
9684: # $path = dirname($uri);
9685: # return ($filename, $path);
9686: #
9687: # The implementation below is probably faster however.
9688: #
1.710 albertel 9689: sub split_uri_for_cond {
9690: my $uri=&deversion(&declutter(shift));
9691: my @uriparts=split(/\//,$uri);
9692: my $filename=pop(@uriparts);
9693: my $pathname=join('/',@uriparts);
9694: return ($pathname,$filename);
9695: }
1.232 www 9696: # --------------------------------------------------- Is a resource on the map?
9697:
9698: sub is_on_map {
1.710 albertel 9699: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 9700: #Trying to find the conditional for the file
1.620 albertel 9701: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 9702: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 9703: if ($match) {
1.289 bowersj2 9704: return (1,$1);
9705: } else {
1.434 www 9706: return (0,0);
1.289 bowersj2 9707: }
1.12 www 9708: }
9709:
1.427 www 9710: # --------------------------------------------------------- Get symb from alias
9711:
9712: sub get_symb_from_alias {
9713: my $symb=shift;
9714: my ($map,$resid,$url)=&decode_symb($symb);
9715: # Already is a symb
9716: if ($url) { return $symb; }
9717: # Must be an alias
9718: my $aliassymb='';
9719: my %bighash;
1.620 albertel 9720: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 9721: &GDBM_READER(),0640)) {
9722: my $rid=$bighash{'mapalias_'.$symb};
9723: if ($rid) {
9724: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 9725: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
9726: $resid,$bighash{'src_'.$rid});
1.427 www 9727: }
9728: untie %bighash;
9729: }
9730: return $aliassymb;
9731: }
9732:
1.12 www 9733: # ----------------------------------------------------------------- Define Role
9734:
9735: sub definerole {
9736: if (allowed('mcr','/')) {
1.1326 raeburn 9737: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 9738: foreach my $role (split(':',$sysrole)) {
9739: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9740: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
9741: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
9742: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9743: return "refused:s:$crole&$cqual";
9744: }
9745: }
1.191 harris41 9746: }
1.800 albertel 9747: foreach my $role (split(':',$domrole)) {
9748: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9749: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
9750: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
9751: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 9752: return "refused:d:$crole&$cqual";
9753: }
9754: }
1.191 harris41 9755: }
1.800 albertel 9756: foreach my $role (split(':',$courole)) {
9757: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 9758: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
9759: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
9760: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 9761: return "refused:c:$crole&$cqual";
9762: }
9763: }
1.191 harris41 9764: }
1.1326 raeburn 9765: my $uhome;
9766: if (($uname ne '') && ($udom ne '')) {
9767: $uhome = &homeserver($uname,$udom);
9768: return $uhome if ($uhome eq 'no_host');
9769: } else {
9770: $uname = $env{'user.name'};
9771: $udom = $env{'user.domain'};
9772: $uhome = $env{'user.home'};
9773: }
1.620 albertel 9774: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1326 raeburn 9775: "$udom:$uname:rolesdef_$rolename=".
1.21 www 9776: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1326 raeburn 9777: return reply($command,$uhome);
1.12 www 9778: } else {
9779: return 'refused';
9780: }
1.105 harris41 9781: }
9782:
9783: # ---------------- Make a metadata query against the network of library servers
9784:
9785: sub metadata_query {
1.1237 raeburn 9786: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 9787: my %rhash;
1.845 albertel 9788: my %libserv = &all_library();
1.244 matthew 9789: my @server_list = (defined($server_array) ? @$server_array
9790: : keys(%libserv) );
9791: for my $server (@server_list) {
1.1237 raeburn 9792: my $domains = '';
9793: if (ref($domains_hash) eq 'HASH') {
9794: $domains = $domains_hash->{$server};
9795: }
1.118 harris41 9796: unless ($custom or $customshow) {
1.1237 raeburn 9797: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 9798: $rhash{$server}=$reply;
9799: }
9800: else {
9801: my $reply=&reply("querysend:".&escape($query).':'.
1.1237 raeburn 9802: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 9803: $server);
9804: $rhash{$server}=$reply;
9805: }
1.112 harris41 9806: }
1.118 harris41 9807: return \%rhash;
1.240 www 9808: }
9809:
9810: # ----------------------------------------- Send log queries and wait for reply
9811:
9812: sub log_query {
9813: my ($uname,$udom,$query,%filters)=@_;
9814: my $uhome=&homeserver($uname,$udom);
9815: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 9816: my $uhost=&hostname($uhome);
1.800 albertel 9817: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 9818: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
9819: $uhome);
1.479 albertel 9820: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 9821: return get_query_reply($queryid);
9822: }
9823:
1.818 raeburn 9824: # -------------------------- Update MySQL table for portfolio file
9825:
9826: sub update_portfolio_table {
1.821 raeburn 9827: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 9828: if ($group ne '') {
9829: $file_name =~s /^\Q$group\E//;
9830: }
1.818 raeburn 9831: my $homeserver = &homeserver($uname,$udom);
9832: my $queryid=
1.821 raeburn 9833: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
9834: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 9835: my $reply = &get_query_reply($queryid);
9836: return $reply;
9837: }
9838:
1.899 raeburn 9839: # -------------------------- Update MySQL allusers table
9840:
9841: sub update_allusers_table {
9842: my ($uname,$udom,$names) = @_;
9843: my $homeserver = &homeserver($uname,$udom);
9844: my $queryid=
9845: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
9846: 'lastname='.&escape($names->{'lastname'}).'%%'.
9847: 'firstname='.&escape($names->{'firstname'}).'%%'.
9848: 'middlename='.&escape($names->{'middlename'}).'%%'.
9849: 'generation='.&escape($names->{'generation'}).'%%'.
9850: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
9851: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 9852: return;
1.899 raeburn 9853: }
9854:
1.508 raeburn 9855: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 9856:
9857: sub fetch_enrollment_query {
1.511 raeburn 9858: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1317 raeburn 9859: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 9860: my $maxtries = 1;
1.508 raeburn 9861: if ($context eq 'automated') {
9862: $homeserver = $perlvar{'lonHostID'};
1.1317 raeburn 9863: $sleep = 2;
9864: $loopmax = 100;
1.547 raeburn 9865: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 9866: } else {
9867: $homeserver = &homeserver($cnum,$dom);
9868: }
1.838 albertel 9869: my $host=&hostname($homeserver);
1.506 raeburn 9870: my $cmd = '';
1.1000 raeburn 9871: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 9872: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 9873: }
9874: $cmd =~ s/%%$//;
9875: $cmd = &escape($cmd);
9876: my $query = 'fetchenrollment';
1.620 albertel 9877: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 9878: unless ($queryid=~/^\Q$host\E\_/) {
9879: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
9880: return 'error: '.$queryid;
9881: }
1.1317 raeburn 9882: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9883: my $tries = 1;
9884: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1317 raeburn 9885: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 9886: $tries ++;
9887: }
1.526 raeburn 9888: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 9889: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 9890: } else {
1.901 albertel 9891: my @responses = split(/:/,$reply);
1.1322 raeburn 9892: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 9893: foreach my $line (@responses) {
9894: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 9895: $$replyref{$key} = $value;
9896: }
9897: } else {
1.1117 foxr 9898: my $pathname = LONCAPA::tempdir();
1.800 albertel 9899: foreach my $line (@responses) {
9900: my ($key,$value) = split(/=/,$line);
1.506 raeburn 9901: $$replyref{$key} = $value;
9902: if ($value > 0) {
1.800 albertel 9903: foreach my $item (@{$$affiliatesref{$key}}) {
9904: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 9905: my $destname = $pathname.'/'.$filename;
9906: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 9907: if ($xml_classlist =~ /^error/) {
9908: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
9909: } else {
1.1359 raeburn 9910: if ( open(FILE,">",$destname) ) {
1.506 raeburn 9911: print FILE &unescape($xml_classlist);
9912: close(FILE);
1.526 raeburn 9913: } else {
9914: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 9915: }
9916: }
9917: }
9918: }
9919: }
9920: }
9921: return 'ok';
9922: }
9923: return 'error';
9924: }
9925:
1.242 www 9926: sub get_query_reply {
1.1471 raeburn 9927: my ($queryid,$sleep,$loopmax) = @_;
1.1317 raeburn 9928: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
9929: $sleep = 0.2;
9930: }
9931: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
9932: $loopmax = 100;
9933: }
1.1117 foxr 9934: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 9935: my $reply='';
1.1317 raeburn 9936: for (1..$loopmax) {
9937: sleep($sleep);
1.240 www 9938: if (-e $replyfile.'.end') {
1.1359 raeburn 9939: if (open(my $fh,"<",$replyfile)) {
1.904 albertel 9940: $reply = join('',<$fh>);
9941: close($fh);
1.240 www 9942: } else { return 'error: reply_file_error'; }
1.242 www 9943: return &unescape($reply);
9944: }
1.240 www 9945: }
1.242 www 9946: return 'timeout:'.$queryid;
1.240 www 9947: }
9948:
9949: sub courselog_query {
1.241 www 9950: #
9951: # possible filters:
9952: # url: url or symb
9953: # username
9954: # domain
9955: # action: view, submit, grade
9956: # start: timestamp
9957: # end: timestamp
9958: #
1.240 www 9959: my (%filters)=@_;
1.620 albertel 9960: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 9961: if ($filters{'url'}) {
9962: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
9963: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
9964: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
9965: }
1.620 albertel 9966: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
9967: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 9968: return &log_query($cname,$cdom,'courselog',%filters);
9969: }
9970:
9971: sub userlog_query {
1.858 raeburn 9972: #
9973: # possible filters:
9974: # action: log check role
9975: # start: timestamp
9976: # end: timestamp
9977: #
1.240 www 9978: my ($uname,$udom,%filters)=@_;
9979: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 9980: }
9981:
1.506 raeburn 9982: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
9983:
9984: sub auto_run {
1.508 raeburn 9985: my ($cnum,$cdom) = @_;
1.876 raeburn 9986: my $response = 0;
9987: my $settings;
9988: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
9989: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
9990: $settings = $domconfig{'autoenroll'};
9991: if ($settings->{'run'} eq '1') {
9992: $response = 1;
9993: }
9994: } else {
1.934 raeburn 9995: my $homeserver;
9996: if (&is_course($cdom,$cnum)) {
9997: $homeserver = &homeserver($cnum,$cdom);
9998: } else {
9999: $homeserver = &domain($cdom,'primary');
10000: }
10001: if ($homeserver ne 'no_host') {
10002: $response = &reply('autorun:'.$cdom,$homeserver);
10003: }
1.876 raeburn 10004: }
1.506 raeburn 10005: return $response;
10006: }
1.776 albertel 10007:
1.506 raeburn 10008: sub auto_get_sections {
1.508 raeburn 10009: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 10010: my $homeserver;
10011: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
10012: $homeserver = &homeserver($cnum,$cdom);
10013: }
10014: if (!defined($homeserver)) {
10015: if ($cdom =~ /^$match_domain$/) {
10016: $homeserver = &domain($cdom,'primary');
10017: }
10018: }
10019: my @secs;
10020: if (defined($homeserver)) {
10021: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
10022: unless ($response eq 'refused') {
10023: @secs = split(/:/,$response);
10024: }
1.506 raeburn 10025: }
10026: return @secs;
10027: }
1.776 albertel 10028:
1.506 raeburn 10029: sub auto_new_course {
1.1099 raeburn 10030: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 10031: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 10032: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 10033: return $response;
10034: }
1.776 albertel 10035:
1.506 raeburn 10036: sub auto_validate_courseID {
1.508 raeburn 10037: my ($cnum,$cdom,$inst_course_id) = @_;
10038: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 10039: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 10040: return $response;
10041: }
1.776 albertel 10042:
1.1007 raeburn 10043: sub auto_validate_instcode {
1.1020 raeburn 10044: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 10045: my ($homeserver,$response);
10046: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
10047: $homeserver = &homeserver($cnum,$cdom);
10048: }
10049: if (!defined($homeserver)) {
10050: if ($cdom =~ /^$match_domain$/) {
10051: $homeserver = &domain($cdom,'primary');
10052: }
10053: }
1.1065 raeburn 10054: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
10055: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 10056: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
10057: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 10058: }
10059:
1.1444 raeburn 10060: sub auto_validate_inst_crosslist {
10061: my ($cnum,$cdom,$instcode,$inst_xlist,$coowner) = @_;
10062: my ($homeserver,$response);
10063: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
10064: $homeserver = &homeserver($cnum,$cdom);
10065: }
10066: if (!defined($homeserver)) {
10067: if ($cdom =~ /^$match_domain$/) {
10068: $homeserver = &domain($cdom,'primary');
10069: }
10070: }
10071: unless (($homeserver eq '') || ($homeserver eq 'no_host')) {
10072: $response=&reply('autovalidateinstcrosslist:'.$cdom.':'.
10073: &escape($instcode).':'.&escape($inst_xlist).':'.
1.1445 raeburn 10074: &escape($coowner),$homeserver);
1.1444 raeburn 10075: }
10076: return $response;
10077: }
10078:
1.506 raeburn 10079: sub auto_create_password {
1.873 raeburn 10080: my ($cnum,$cdom,$authparam,$udom) = @_;
10081: my ($homeserver,$response);
1.506 raeburn 10082: my $create_passwd = 0;
10083: my $authchk = '';
1.873 raeburn 10084: if ($udom =~ /^$match_domain$/) {
10085: $homeserver = &domain($udom,'primary');
10086: }
10087: if ($homeserver eq '') {
10088: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
10089: $homeserver = &homeserver($cnum,$cdom);
10090: }
10091: }
10092: if ($homeserver eq '') {
10093: $authchk = 'nodomain';
1.506 raeburn 10094: } else {
1.873 raeburn 10095: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
10096: if ($response eq 'refused') {
10097: $authchk = 'refused';
10098: } else {
1.901 albertel 10099: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 10100: }
1.506 raeburn 10101: }
10102: return ($authparam,$create_passwd,$authchk);
10103: }
10104:
1.706 raeburn 10105: sub auto_photo_permission {
10106: my ($cnum,$cdom,$students) = @_;
10107: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 10108: my ($outcome,$perm_reqd,$conditions) =
10109: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 10110: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
10111: return (undef,undef);
10112: }
1.706 raeburn 10113: return ($outcome,$perm_reqd,$conditions);
10114: }
10115:
10116: sub auto_checkphotos {
10117: my ($uname,$udom,$pid) = @_;
10118: my $homeserver = &homeserver($uname,$udom);
10119: my ($result,$resulttype);
10120: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 10121: &escape($uname).':'.&escape($pid),
10122: $homeserver));
1.709 albertel 10123: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
10124: return (undef,undef);
10125: }
1.706 raeburn 10126: if ($outcome) {
10127: ($result,$resulttype) = split(/:/,$outcome);
10128: }
10129: return ($result,$resulttype);
10130: }
10131:
10132: sub auto_photochoice {
10133: my ($cnum,$cdom) = @_;
10134: my $homeserver = &homeserver($cnum,$cdom);
10135: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 10136: &escape($cdom),
10137: $homeserver)));
1.709 albertel 10138: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
10139: return (undef,undef);
10140: }
1.706 raeburn 10141: return ($update,$comment);
10142: }
10143:
10144: sub auto_photoupdate {
10145: my ($affiliatesref,$dom,$cnum,$photo) = @_;
10146: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 10147: my $host=&hostname($homeserver);
1.706 raeburn 10148: my $cmd = '';
10149: my $maxtries = 1;
1.800 albertel 10150: foreach my $affiliate (keys(%{$affiliatesref})) {
10151: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 10152: }
10153: $cmd =~ s/%%$//;
10154: $cmd = &escape($cmd);
10155: my $query = 'institutionalphotos';
10156: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
10157: unless ($queryid=~/^\Q$host\E\_/) {
10158: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
10159: return 'error: '.$queryid;
10160: }
10161: my $reply = &get_query_reply($queryid);
10162: my $tries = 1;
10163: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
10164: $reply = &get_query_reply($queryid);
10165: $tries ++;
10166: }
10167: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
10168: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
10169: } else {
10170: my @responses = split(/:/,$reply);
10171: my $outcome = shift(@responses);
10172: foreach my $item (@responses) {
10173: my ($key,$value) = split(/=/,$item);
10174: $$photo{$key} = $value;
10175: }
10176: return $outcome;
10177: }
10178: return 'error';
10179: }
10180:
1.521 raeburn 10181: sub auto_instcode_format {
1.793 albertel 10182: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
10183: $cat_order) = @_;
1.521 raeburn 10184: my $courses = '';
1.772 raeburn 10185: my @homeservers;
1.521 raeburn 10186: if ($caller eq 'global') {
1.841 albertel 10187: my %servers = &get_servers($codedom,'library');
10188: foreach my $tryserver (keys(%servers)) {
10189: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
10190: push(@homeservers,$tryserver);
10191: }
1.584 raeburn 10192: }
1.1022 raeburn 10193: } elsif ($caller eq 'requests') {
10194: if ($codedom =~ /^$match_domain$/) {
10195: my $chome = &domain($codedom,'primary');
10196: unless ($chome eq 'no_host') {
10197: push(@homeservers,$chome);
10198: }
10199: }
1.521 raeburn 10200: } else {
1.772 raeburn 10201: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 10202: }
1.793 albertel 10203: foreach my $code (keys(%{$instcodes})) {
10204: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 10205: }
10206: chop($courses);
1.772 raeburn 10207: my $ok_response = 0;
10208: my $response;
10209: while (@homeservers > 0 && $ok_response == 0) {
10210: my $server = shift(@homeservers);
10211: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
10212: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
10213: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 10214: split(/:/,$response);
1.772 raeburn 10215: %{$codes} = (%{$codes},&str2hash($codes_str));
10216: push(@{$codetitles},&str2array($codetitles_str));
10217: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
10218: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
10219: $ok_response = 1;
10220: }
10221: }
10222: if ($ok_response) {
1.521 raeburn 10223: return 'ok';
1.772 raeburn 10224: } else {
10225: return $response;
1.521 raeburn 10226: }
10227: }
10228:
1.792 raeburn 10229: sub auto_instcode_defaults {
10230: my ($domain,$returnhash,$code_order) = @_;
10231: my @homeservers;
1.841 albertel 10232:
10233: my %servers = &get_servers($domain,'library');
10234: foreach my $tryserver (keys(%servers)) {
10235: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
10236: push(@homeservers,$tryserver);
10237: }
1.792 raeburn 10238: }
1.841 albertel 10239:
1.792 raeburn 10240: my $response;
1.841 albertel 10241: foreach my $server (@homeservers) {
1.792 raeburn 10242: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 10243: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
10244:
10245: foreach my $pair (split(/\&/,$response)) {
10246: my ($name,$value)=split(/\=/,$pair);
10247: if ($name eq 'code_order') {
10248: @{$code_order} = split(/\&/,&unescape($value));
10249: } else {
10250: $returnhash->{&unescape($name)}=&unescape($value);
10251: }
10252: }
10253: return 'ok';
1.792 raeburn 10254: }
1.841 albertel 10255:
10256: return $response;
1.1003 raeburn 10257: }
10258:
10259: sub auto_possible_instcodes {
1.1007 raeburn 10260: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
10261: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
10262: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
10263: return;
10264: }
1.1003 raeburn 10265: my (@homeservers,$uhome);
10266: if (defined(&domain($domain,'primary'))) {
10267: $uhome=&domain($domain,'primary');
10268: push(@homeservers,&domain($domain,'primary'));
10269: } else {
10270: my %servers = &get_servers($domain,'library');
10271: foreach my $tryserver (keys(%servers)) {
10272: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
10273: push(@homeservers,$tryserver);
10274: }
10275: }
10276: }
10277: my $response;
10278: foreach my $server (@homeservers) {
10279: $response=&reply('autopossibleinstcodes:'.$domain,$server);
10280: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 10281: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
10282: split(':',$response);
10283: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
10284: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 10285: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 10286: my ($name,$value)=split('=',$item);
10287: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 10288: }
10289: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 10290: my ($name,$value)=split('=',$item);
10291: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 10292: }
10293: return 'ok';
10294: }
10295: return $response;
10296: }
1.792 raeburn 10297:
1.1010 raeburn 10298: sub auto_courserequest_checks {
10299: my ($dom) = @_;
1.1020 raeburn 10300: my ($homeserver,%validations);
10301: if ($dom =~ /^$match_domain$/) {
10302: $homeserver = &domain($dom,'primary');
10303: }
10304: unless ($homeserver eq 'no_host') {
10305: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
10306: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
10307: my @items = split(/&/,$response);
10308: foreach my $item (@items) {
10309: my ($key,$value) = split('=',$item);
10310: $validations{&unescape($key)} = &thaw_unescape($value);
10311: }
10312: }
10313: }
1.1010 raeburn 10314: return %validations;
10315: }
10316:
1.1020 raeburn 10317: sub auto_courserequest_validation {
1.1255 raeburn 10318: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 10319: my ($homeserver,$response);
10320: if ($dom =~ /^$match_domain$/) {
10321: $homeserver = &domain($dom,'primary');
10322: }
1.1255 raeburn 10323: unless ($homeserver eq 'no_host') {
10324: my $customdata;
10325: if (ref($custominfo) eq 'HASH') {
10326: $customdata = &freeze_escape($custominfo);
10327: }
1.1020 raeburn 10328: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 10329: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255 raeburn 10330: ':'.&escape($instcode).':'.&escape($instseclist).':'.
10331: $customdata,$homeserver));
1.1020 raeburn 10332: }
10333: return $response;
10334: }
10335:
1.777 albertel 10336: sub auto_validate_class_sec {
1.918 raeburn 10337: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 10338: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 10339: my $ownerlist;
10340: if (ref($owners) eq 'ARRAY') {
10341: $ownerlist = join(',',@{$owners});
10342: } else {
10343: $ownerlist = $owners;
10344: }
1.773 raeburn 10345: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 10346: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 10347: return $response;
10348: }
10349:
1.1460 raeburn 10350: sub auto_instsec_reformat {
10351: my ($cdom,$action,$instsecref) = @_;
10352: return unless(($action eq 'clutter') || ($action eq 'declutter'));
10353: my @homeservers;
10354: if (defined(&domain($cdom,'primary'))) {
10355: push(@homeservers,&domain($cdom,'primary'));
10356: } else {
10357: my %servers = &get_servers($cdom,'library');
10358: foreach my $tryserver (keys(%servers)) {
10359: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
10360: push(@homeservers,$tryserver);
10361: }
10362: }
10363: }
10364: my $response;
10365: my %reformatted = %{$instsecref};
10366: foreach my $server (@homeservers) {
10367: if (ref($instsecref) eq 'HASH') {
10368: my $info = &freeze_escape($instsecref);
10369: my $response=&reply('autoinstsecreformat:'.$cdom.':'.
10370: $action.':'.$info,$server);
10371: next if ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/);
10372: my @items = split(/&/,$response);
10373: foreach my $item (@items) {
10374: my ($key,$value) = split(/=/,$item);
10375: $reformatted{&unescape($key)} = &thaw_unescape($value);
10376: }
10377: }
10378: }
10379: return %reformatted;
10380: }
10381:
1.1367 raeburn 10382: sub auto_validate_instclasses {
10383: my ($cdom,$cnum,$owners,$classesref) = @_;
10384: my ($homeserver,%validations);
10385: $homeserver = &homeserver($cnum,$cdom);
10386: unless ($homeserver eq 'no_host') {
10387: my $ownerlist;
10388: if (ref($owners) eq 'ARRAY') {
10389: $ownerlist = join(',',@{$owners});
10390: } else {
10391: $ownerlist = $owners;
10392: }
10393: if (ref($classesref) eq 'HASH') {
10394: my $classes = &freeze_escape($classesref);
10395: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
10396: ':'.$cdom.':'.$classes,$homeserver);
10397: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
10398: my @items = split(/&/,$response);
10399: foreach my $item (@items) {
10400: my ($key,$value) = split('=',$item);
10401: $validations{&unescape($key)} = &thaw_unescape($value);
10402: }
10403: }
10404: }
10405: }
10406: return %validations;
10407: }
10408:
1.1248 raeburn 10409: sub auto_crsreq_update {
10410: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257 raeburn 10411: $code,$accessstart,$accessend,$inbound) = @_;
1.1248 raeburn 10412: my ($homeserver,%crsreqresponse);
10413: if ($cdom =~ /^$match_domain$/) {
10414: $homeserver = &domain($cdom,'primary');
10415: }
10416: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
10417: my $info;
10418: if (ref($inbound) eq 'HASH') {
10419: $info = &freeze_escape($inbound);
10420: }
10421: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
10422: ':'.&escape($action).':'.&escape($ownername).':'.
10423: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257 raeburn 10424: &escape($title).':'.&escape($code).':'.
10425: &escape($accessstart).':'.&escape($accessend).':'.$info,
10426: $homeserver);
1.1248 raeburn 10427: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
10428: my @items = split(/&/,$response);
10429: foreach my $item (@items) {
10430: my ($key,$value) = split('=',$item);
10431: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
10432: }
10433: }
10434: }
10435: return \%crsreqresponse;
10436: }
10437:
1.1305 raeburn 10438: sub auto_export_grades {
1.1309 raeburn 10439: my ($cdom,$cnum,$inforef,$gradesref) = @_;
10440: my ($homeserver,%exportresponse);
10441: if ($cdom =~ /^$match_domain$/) {
10442: $homeserver = &domain($cdom,'primary');
10443: }
10444: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
10445: my $info;
10446: if (ref($inforef) eq 'HASH') {
10447: $info = &freeze_escape($inforef);
10448: }
10449: if (ref($gradesref) eq 'HASH') {
10450: my $grades = &freeze_escape($gradesref);
10451: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
10452: $info.':'.$grades,$homeserver);
10453: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
10454: my @items = split(/&/,$response);
10455: foreach my $item (@items) {
10456: my ($key,$value) = split('=',$item);
10457: $exportresponse{&unescape($key)} = &thaw_unescape($value);
10458: }
10459: }
10460: }
10461: }
10462: return \%exportresponse;
1.1305 raeburn 10463: }
10464:
1.1287 raeburn 10465: sub check_instcode_cloning {
10466: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
10467: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
10468: return;
10469: }
10470: my $canclone;
10471: if (@{$code_order} > 0) {
10472: my $instcoderegexp ='^';
10473: my @clonecodes = split(/\&/,$cloner);
10474: foreach my $item (@{$code_order}) {
10475: if (grep(/^\Q$item\E=/,@clonecodes)) {
10476: foreach my $pair (@clonecodes) {
10477: my ($key,$val) = split(/\=/,$pair,2);
10478: $val = &unescape($val);
10479: if ($key eq $item) {
10480: $instcoderegexp .= '('.$val.')';
10481: last;
10482: }
10483: }
10484: } else {
10485: $instcoderegexp .= $codedefaults->{$item};
10486: }
10487: }
10488: $instcoderegexp .= '$';
10489: my (@from,@to);
10490: eval {
10491: (@from) = ($clonefromcode =~ /$instcoderegexp/);
10492: (@to) = ($clonetocode =~ /$instcoderegexp/);
10493: };
10494: if ((@from > 0) && (@to > 0)) {
10495: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
10496: if (!@diffs) {
10497: $canclone = 1;
10498: }
10499: }
10500: }
10501: return $canclone;
10502: }
10503:
10504: sub default_instcode_cloning {
10505: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
10506: my (%codedefaults,@code_order,$canclone);
10507: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
10508: %codedefaults = %{$codedefaultsref};
10509: @code_order = @{$codeorderref};
10510: } elsif ($clonedom) {
10511: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
10512: }
10513: if (($domdefclone) && (@code_order)) {
10514: my @clonecodes = split(/\+/,$domdefclone);
10515: my $instcoderegexp ='^';
10516: foreach my $item (@code_order) {
10517: if (grep(/^\Q$item\E$/,@clonecodes)) {
10518: $instcoderegexp .= '('.$codedefaults{$item}.')';
10519: } else {
10520: $instcoderegexp .= $codedefaults{$item};
10521: }
10522: }
10523: $instcoderegexp .= '$';
10524: my (@from,@to);
10525: eval {
10526: (@from) = ($clonefromcode =~ /$instcoderegexp/);
10527: (@to) = ($clonetocode =~ /$instcoderegexp/);
10528: };
10529: if ((@from > 0) && (@to > 0)) {
10530: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
10531: if (!@diffs) {
10532: $canclone = 1;
10533: }
10534: }
10535: }
10536: return $canclone;
10537: }
10538:
1.679 raeburn 10539: # ------------------------------------------------------- Course Group routines
10540:
10541: sub get_coursegroups {
1.809 raeburn 10542: my ($cdom,$cnum,$group,$namespace) = @_;
10543: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 10544: }
10545:
1.679 raeburn 10546: sub modify_coursegroup {
10547: my ($cdom,$cnum,$groupsettings) = @_;
10548: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
10549: }
10550:
1.809 raeburn 10551: sub toggle_coursegroup_status {
10552: my ($cdom,$cnum,$group,$action) = @_;
10553: my ($from_namespace,$to_namespace);
10554: if ($action eq 'delete') {
10555: $from_namespace = 'coursegroups';
10556: $to_namespace = 'deleted_groups';
10557: } else {
10558: $from_namespace = 'deleted_groups';
10559: $to_namespace = 'coursegroups';
10560: }
10561: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 10562: if (my $tmp = &error(%curr_group)) {
10563: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
10564: return ('read error',$tmp);
10565: } else {
10566: my %savedsettings = %curr_group;
1.809 raeburn 10567: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 10568: my $deloutcome;
10569: if ($result eq 'ok') {
1.809 raeburn 10570: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 10571: } else {
10572: return ('write error',$result);
10573: }
10574: if ($deloutcome eq 'ok') {
10575: return 'ok';
10576: } else {
10577: return ('delete error',$deloutcome);
10578: }
10579: }
10580: }
10581:
1.679 raeburn 10582: sub modify_group_roles {
1.1512 raeburn 10583: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context,
10584: $othdomby,$requester) = @_;
1.679 raeburn 10585: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
10586: my $role = 'gr/'.&escape($userprivs);
10587: my ($uname,$udom) = split(/:/,$user);
1.1512 raeburn 10588: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context,
10589: $othdomby,$requester);
1.684 raeburn 10590: if ($result eq 'ok') {
10591: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
10592: }
1.679 raeburn 10593: return $result;
10594: }
10595:
10596: sub modify_coursegroup_membership {
10597: my ($cdom,$cnum,$membership) = @_;
10598: my $result = &put('groupmembership',$membership,$cdom,$cnum);
10599: return $result;
10600: }
10601:
1.682 raeburn 10602: sub get_active_groups {
10603: my ($udom,$uname,$cdom,$cnum) = @_;
10604: my $now = time;
10605: my %groups = ();
10606: foreach my $key (keys(%env)) {
1.811 albertel 10607: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 10608: my ($start,$end) = split(/\./,$env{$key});
10609: if (($end!=0) && ($end<$now)) { next; }
10610: if (($start!=0) && ($start>$now)) { next; }
10611: if ($1 eq $cdom && $2 eq $cnum) {
10612: $groups{$3} = $env{$key} ;
10613: }
10614: }
10615: }
10616: return %groups;
10617: }
10618:
1.683 raeburn 10619: sub get_group_membership {
10620: my ($cdom,$cnum,$group) = @_;
10621: return(&dump('groupmembership',$cdom,$cnum,$group));
10622: }
10623:
10624: sub get_users_groups {
10625: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 10626: my @usersgroups;
1.683 raeburn 10627: my $cachetime=1800;
10628:
10629: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 10630: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
10631: if (defined($cached)) {
1.734 albertel 10632: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 10633: } else {
10634: $grouplist = '';
1.816 raeburn 10635: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 10636: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 10637: my $access_end = $env{'course.'.$courseid.
10638: '.default_enrollment_end_date'};
10639: my $now = time;
10640: foreach my $key (keys(%roleshash)) {
10641: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
10642: my $group = $1;
10643: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
10644: my $start = $2;
10645: my $end = $1;
10646: if ($start == -1) { next; } # deleted from group
10647: if (($start!=0) && ($start>$now)) { next; }
10648: if (($end!=0) && ($end<$now)) {
10649: if ($access_end && $access_end < $now) {
10650: if ($access_end - $end < 86400) {
10651: push(@usersgroups,$group);
1.733 raeburn 10652: }
10653: }
1.817 raeburn 10654: next;
1.733 raeburn 10655: }
1.817 raeburn 10656: push(@usersgroups,$group);
1.683 raeburn 10657: }
10658: }
10659: }
1.817 raeburn 10660: @usersgroups = &sort_course_groups($courseid,@usersgroups);
10661: $grouplist = join(':',@usersgroups);
10662: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 10663: }
1.733 raeburn 10664: return @usersgroups;
1.683 raeburn 10665: }
10666:
10667: sub devalidate_getgroups_cache {
10668: my ($udom,$uname,$cdom,$cnum)=@_;
10669: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 10670:
1.683 raeburn 10671: my $hashid="$udom:$uname:$courseid";
10672: &devalidate_cache_new('getgroups',$hashid);
10673: }
10674:
1.12 www 10675: # ------------------------------------------------------------------ Plain Text
10676:
10677: sub plaintext {
1.988 raeburn 10678: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 10679: if ($short =~ m{^cr/}) {
1.758 albertel 10680: return (split('/',$short))[-1];
10681: }
1.742 raeburn 10682: if (!defined($cid)) {
10683: $cid = $env{'request.course.id'};
10684: }
10685: my %rolenames = (
1.1008 raeburn 10686: Course => 'std',
10687: Community => 'alt1',
1.1305 raeburn 10688: Placement => 'std',
1.742 raeburn 10689: );
1.1037 raeburn 10690: if ($cid ne '') {
10691: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
10692: unless ($forcedefault) {
10693: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
10694: &Apache::lonlocal::mt_escape(\$roletext);
10695: return &Apache::lonlocal::mt($roletext);
10696: }
10697: }
10698: }
10699: if ((defined($type)) && (defined($rolenames{$type})) &&
10700: (defined($rolenames{$type})) &&
10701: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 10702: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 10703: } elsif ($cid ne '') {
10704: my $crstype = $env{'course.'.$cid.'.type'};
10705: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
10706: (defined($prp{$short}{$rolenames{$crstype}}))) {
10707: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
10708: }
1.742 raeburn 10709: }
1.1037 raeburn 10710: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 10711: }
10712:
10713: # ----------------------------------------------------------------- Assign Role
10714:
10715: sub assignrole {
1.957 raeburn 10716: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
1.1512 raeburn 10717: $context,$othdomby,$requester,$reqsec,$reqrole)=@_;
1.1517 raeburn 10718: my ($mrole,$rolelogcontext);
1.21 www 10719: if ($role =~ /^cr\//) {
1.393 www 10720: my $cwosec=$url;
1.811 albertel 10721: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.1502 raeburn 10722: if ((!&allowed('ccr',$cwosec)) && (!&allowed('ccr',$udom))) {
1.1512 raeburn 10723: my $refused = 1;
10724: if ($context eq 'requestcourses') {
10725: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
10726: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
10727: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
10728: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
10729: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10730: if ($crsenv{'internal.courseowner'} eq
10731: $env{'user.name'}.':'.$env{'user.domain'}) {
10732: $refused = '';
10733: }
10734: }
10735: }
10736: }
10737: } elsif (($context eq 'course') && ($othdomby eq 'othdombyuser')) {
10738: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
10739: my ($sec) = ($url =~ m{^/\Q$cwosec\E/(.*)$});
10740: my $key = "$uname:$udom:$role:$sec";
10741: my %queuedrolereq = &Apache::lonnet::get('nohist_othdomqueued',[$key],$cdom,$cnum);
10742: if ((exists($queuedrolereq{$key})) && (ref($queuedrolereq{$key}) eq 'HASH')) {
10743: if (($queuedrolereq{$key}{'adj'} eq 'user') && ($queuedrolereq{$key}{'requester'} eq $requester)) {
10744: $refused = '';
10745: }
10746: }
10747: }
10748: if ($refused) {
10749: &logthis('Refused custom assignrole: '.
10750: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
10751: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
10752: return 'refused';
10753: }
1.104 www 10754: }
1.21 www 10755: $mrole='cr';
1.678 raeburn 10756: } elsif ($role =~ /^gr\//) {
10757: my $cwogrp=$url;
1.811 albertel 10758: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.1512 raeburn 10759: if (!&allowed('mdg',$cwogrp)) {
10760: my $refused = 1;
10761: if (($refused) && ($othdomby eq 'othdombyuser') && ($requester ne '') && ($reqrole ne '')) {
10762: my ($cdom,$cnum) = ($cwogrp =~ m{^/?($match_domain)/($match_courseid)$});
10763: my $key = "$uname:$udom:$reqrole:$reqsec";
10764: my %queuedrolereq = &Apache::lonnet::get('nohist_othdomqueued',[$key],$cdom,$cnum);
10765: if ((exists($queuedrolereq{$key})) && (ref($queuedrolereq{$key}) eq 'HASH')) {
10766: if (($queuedrolereq{$key}{'adj'} eq 'user') && ($queuedrolereq{$key}{'requester'} eq $requester)) {
10767: $refused = '';
10768: }
10769: }
10770: }
10771: if ($refused) {
10772: &logthis('Refused group assignrole: '.
10773: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
10774: $env{'user.name'}.' at '.$env{'user.domain'});
10775: return 'refused';
10776: }
1.678 raeburn 10777: }
10778: $mrole='gr';
1.21 www 10779: } else {
1.82 www 10780: my $cwosec=$url;
1.811 albertel 10781: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 10782: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
10783: my $refused;
10784: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
10785: if (!(&allowed('c'.$role,$url))) {
10786: $refused = 1;
10787: }
10788: } else {
10789: $refused = 1;
10790: }
1.947 raeburn 10791: if ($refused) {
1.1045 raeburn 10792: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
1.1512 raeburn 10793: if (!$selfenroll && ($othdomby ne 'othdombyuser') &&
10794: (($context eq 'course') || ($context eq 'ltienroll' && $env{'request.lti.login'}))) {
1.1045 raeburn 10795: my %crsenv;
10796: if ($role eq 'cc' || $role eq 'co') {
10797: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10798: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
10799: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
10800: if ($crsenv{'internal.courseowner'} eq
10801: $env{'user.name'}.':'.$env{'user.domain'}) {
10802: $refused = '';
10803: }
10804: }
10805: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
10806: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
10807: if ($crsenv{'internal.courseowner'} eq
10808: $env{'user.name'}.':'.$env{'user.domain'}) {
10809: $refused = '';
10810: }
10811: }
10812: }
10813: }
1.1368 raeburn 10814: } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
10815: if ($role eq 'st') {
10816: $refused = '';
1.1377 raeburn 10817: } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
1.1368 raeburn 10818: $refused = '';
10819: }
1.1512 raeburn 10820: } elsif ($othdomby eq 'othdombyuser') {
10821: my ($key,%queuedrolereq);
10822: if ($context eq 'course') {
10823: my ($sec) = ($url =~ m{^/\Q$cwosec\E/(.*)$});
10824: $key = "$uname:$udom:$role:$sec";
10825: %queuedrolereq = &Apache::lonnet::get('nohist_othdomqueued',[$key],$cdom,$cnum);
10826: if ((exists($queuedrolereq{$key})) && (ref($queuedrolereq{$key}) eq 'HASH')) {
10827: if (($queuedrolereq{$key}{'adj'} eq 'user') && ($queuedrolereq{$key}{'requester'} eq $requester)) {
10828: if ((($role eq 'cc') && ($cnum !~ /^$match_community$/)) ||
10829: (($role eq 'co') && ($cnum =~ /^$match_community$/))) {
10830: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10831: if ($crsenv{'internal.courseowner'} eq $requester) {
10832: $refused = '';
10833: }
10834: } elsif ($role =~ /^(?:in|ta|ep|st)$/) {
10835: $refused = '';
10836: }
10837: }
10838: }
10839: } elsif (($context eq 'author') && ($role =~ /^ca|aa$/)) {
10840: my $key = "$uname:$udom:$role";
10841: my ($audom,$auname) = ($url =~ m{^/($match_domain)/($match_username)$});
10842: if (($audom ne '') && ($auname ne '')) {
10843: my %queuedrolereq = &Apache::lonnet::get('nohist_othdomqueued',[$key],$audom,$auname);
10844: if ((exists($queuedrolereq{$key})) && (ref($queuedrolereq{$key}) eq 'HASH')) {
10845: if (($queuedrolereq{$key}{'adj'} eq 'user') && ($queuedrolereq{$key}{'requester'} eq $requester)) {
10846: $refused = '';
10847: }
10848: }
10849: }
10850: } elsif (($context eq 'domain') && ($role ne 'dc') && ($role ne 'su')) {
10851: my $key = "$uname:$udom:$role";
10852: my ($roledom) = ($url =~ m{^/($match_domain)/\Q$role\E$});
10853: if ($roledom ne '') {
10854: my $confname = $roledom.'-domainconfig';
10855: my %queuedrolereq = &Apache::lonnet::get('nohist_othdomqueued',[$key],$roledom,$confname);
10856: if ((exists($queuedrolereq{$key})) && (ref($queuedrolereq{$key}) eq 'HASH')) {
10857: if (($queuedrolereq{$key}{'adj'} eq 'user') && ($queuedrolereq{$key}{'requester'} eq $requester)) {
10858: $refused = '';
10859: }
10860: }
10861: }
10862: }
1.1017 raeburn 10863: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 10864: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 10865: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 10866: my $wrongcc;
10867: if ($cnum =~ /^$match_community$/) {
10868: $wrongcc = 1 if ($role eq 'cc');
10869: } else {
10870: $wrongcc = 1 if ($role eq 'co');
10871: }
10872: unless ($wrongcc) {
10873: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
10874: if ($crsenv{'internal.courseowner'} eq
10875: $env{'user.name'}.':'.$env{'user.domain'}) {
10876: $refused = '';
10877: }
1.1017 raeburn 10878: }
10879: }
1.1183 raeburn 10880: } elsif ($context eq 'requestauthor') {
10881: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
10882: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
10883: if ($env{'environment.requestauthor'} eq 'automatic') {
10884: $refused = '';
10885: } else {
10886: my %domdefaults = &get_domain_defaults($udom);
10887: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
10888: my $checkbystatus;
10889: if ($env{'user.adv'}) {
10890: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
10891: if ($disposition eq 'automatic') {
10892: $refused = '';
10893: } elsif ($disposition eq '') {
10894: $checkbystatus = 1;
10895: }
10896: } else {
10897: $checkbystatus = 1;
10898: }
10899: if ($checkbystatus) {
10900: if ($env{'environment.inststatus'}) {
10901: my @inststatuses = split(/,/,$env{'environment.inststatus'});
10902: foreach my $type (@inststatuses) {
10903: if (($type ne '') &&
10904: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
10905: $refused = '';
10906: }
10907: }
10908: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
10909: $refused = '';
10910: }
10911: }
10912: }
10913: }
10914: }
1.1517 raeburn 10915: } elsif (($context eq 'author') && (($role eq 'ca' || $role eq 'aa'))) {
10916: if ($url =~ m{^/($match_domain)/($match_username)$}) {
10917: my ($audom,$auname) = ($1,$2);
10918: if ((&Apache::lonnet::allowed('v'.$role,"$audom/$auname")) &&
10919: ($env{"environment.internal.manager.$url"})) {
10920: $refused = '';
10921: $rolelogcontext = 'coauthor';
10922: }
10923: }
1.1017 raeburn 10924: }
10925: if ($refused) {
1.947 raeburn 10926: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
10927: ' '.$role.' '.$end.' '.$start.' by '.
10928: $env{'user.name'}.' at '.$env{'user.domain'});
10929: return 'refused';
10930: }
1.932 raeburn 10931: }
1.1131 raeburn 10932: } elsif ($role eq 'au') {
10933: if ($url ne '/'.$udom.'/') {
10934: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
10935: ' to assign author role for '.$uname.':'.$udom.
10936: ' in domain: '.$url.' refused (wrong domain).');
10937: return 'refused';
10938: }
1.104 www 10939: }
1.21 www 10940: $mrole=$role;
10941: }
1.620 albertel 10942: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 10943: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 10944: if ($end) { $command.='_'.$end; }
1.21 www 10945: if ($start) {
10946: if ($end) {
1.81 www 10947: $command.='_'.$start;
1.21 www 10948: } else {
1.81 www 10949: $command.='_0_'.$start;
1.21 www 10950: }
10951: }
1.739 raeburn 10952: my $origstart = $start;
10953: my $origend = $end;
1.957 raeburn 10954: my $delflag;
1.357 www 10955: # actually delete
10956: if ($deleteflag) {
1.373 www 10957: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 10958: # modify command to delete the role
1.620 albertel 10959: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 10960: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 10961: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 10962: # set start and finish to negative values for userrolelog
10963: $start=-1;
10964: $end=-1;
1.957 raeburn 10965: $delflag = 1;
1.357 www 10966: }
10967: }
10968: # send command
1.349 www 10969: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 10970: # log new user role if status is ok
1.349 www 10971: if ($answer eq 'ok') {
1.663 raeburn 10972: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 10973: if (($role eq 'cc') || ($role eq 'in') ||
10974: ($role eq 'ep') || ($role eq 'ad') ||
10975: ($role eq 'ta') || ($role eq 'st') ||
10976: ($role=~/^cr/) || ($role eq 'gr') ||
10977: ($role eq 'co')) {
1.1200 raeburn 10978: # for course roles, perform group memberships changes triggered by role change.
10979: unless ($role =~ /^gr/) {
10980: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
10981: $origstart,$selfenroll,$context);
10982: }
1.1184 raeburn 10983: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
1.1512 raeburn 10984: $selfenroll,$context,$othdomby,$requester);
1.1184 raeburn 10985: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1334 raeburn 10986: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
10987: ($role eq 'da')) {
1.1184 raeburn 10988: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
1.1512 raeburn 10989: $context,$othdomby,$requester);
1.1184 raeburn 10990: } elsif (($role eq 'ca') || ($role eq 'aa')) {
1.1517 raeburn 10991: if ($rolelogcontext eq '') {
10992: $rolelogcontext = $context;
10993: }
1.1184 raeburn 10994: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
1.1517 raeburn 10995: $rolelogcontext,$othdomby,$requester);
1.1184 raeburn 10996: }
1.1053 raeburn 10997: if ($role eq 'cc') {
10998: &autoupdate_coowners($url,$end,$start,$uname,$udom);
10999: }
1.349 www 11000: }
11001: return $answer;
1.169 harris41 11002: }
11003:
1.1053 raeburn 11004: sub autoupdate_coowners {
11005: my ($url,$end,$start,$uname,$udom) = @_;
11006: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
11007: if (($cdom ne '') && ($cnum ne '')) {
11008: my $now = time;
11009: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
11010: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
11011: my %coursehash = &coursedescription($cdom.'_'.$cnum);
11012: my $instcode = $coursehash{'internal.coursecode'};
1.1444 raeburn 11013: my $xlists = $coursehash{'internal.crosslistings'};
1.1053 raeburn 11014: if ($instcode ne '') {
1.1056 raeburn 11015: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
11016: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 11017: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 11018: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
1.1444 raeburn 11019: unless ($result eq 'valid') {
11020: if ($xlists ne '') {
11021: foreach my $xlist (split(',',$xlists)) {
11022: my ($inst_crosslist,$lcsec) = split(':',$xlist);
11023: $result =
1.1446 raeburn 11024: &auto_validate_inst_crosslist($cnum,$cdom,$instcode,
11025: $inst_crosslist,$uname.':'.$udom);
11026: last if ($result eq 'valid');
1.1444 raeburn 11027: }
11028: }
11029: }
1.1056 raeburn 11030: if ($result eq 'valid') {
11031: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 11032: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
11033: push(@newcoowners,$coowner);
11034: }
11035: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
11036: push(@newcoowners,$uname.':'.$udom);
11037: }
11038: @newcoowners = sort(@newcoowners);
11039: } else {
11040: push(@newcoowners,$uname.':'.$udom);
11041: }
1.1444 raeburn 11042: } elsif ($coursehash{'internal.co-owners'}) {
11043: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
11044: unless ($coowner eq $uname.':'.$udom) {
11045: push(@newcoowners,$coowner);
1.1053 raeburn 11046: }
1.1444 raeburn 11047: }
11048: unless (@newcoowners > 0) {
11049: $delcoowners = 1;
11050: $coowners = '';
1.1053 raeburn 11051: }
11052: }
11053: if (@newcoowners || $delcoowners) {
11054: &store_coowners($cdom,$cnum,$coursehash{'home'},
11055: $delcoowners,@newcoowners);
11056: }
11057: }
11058: }
11059: }
11060: }
11061: }
11062: }
11063:
11064: sub store_coowners {
11065: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
11066: my $cid = $cdom.'_'.$cnum;
11067: my ($coowners,$delresult,$putresult);
11068: if (@newcoowners) {
11069: $coowners = join(',',@newcoowners);
11070: my %coownershash = (
11071: 'internal.co-owners' => $coowners,
11072: );
11073: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
11074: if ($putresult eq 'ok') {
11075: if ($env{'course.'.$cid.'.num'} eq $cnum) {
11076: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
11077: }
11078: }
11079: }
11080: if ($delcoowners) {
11081: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
11082: if ($delresult eq 'ok') {
11083: if ($env{'course.'.$cid.'.internal.co-owners'}) {
11084: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
11085: }
11086: }
11087: }
11088: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
11089: my %crsinfo =
1.1494 raeburn 11090: &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
1.1053 raeburn 11091: if (ref($crsinfo{$cid}) eq 'HASH') {
11092: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
1.1494 raeburn 11093: my $cidput = &courseidput($cdom,\%crsinfo,$chome,'notime');
1.1053 raeburn 11094: }
11095: }
11096: }
11097:
1.169 harris41 11098: # -------------------------------------------------- Modify user authentication
1.197 www 11099: # Overrides without validation
11100:
1.169 harris41 11101: sub modifyuserauth {
11102: my ($udom,$uname,$umode,$upass)=@_;
11103: my $uhome=&homeserver($uname,$udom);
1.1409 raeburn 11104: my $allowed;
11105: if (&allowed('mau',$udom)) {
11106: $allowed = 1;
11107: } elsif (($umode eq 'internal') && ($udom eq $env{'user.domain'}) &&
11108: ($env{'request.course.id'}) && (&allowed('mip',$env{'request.course.id'})) &&
11109: (!$env{'course.'.$env{'request.course.id'}.'.internal.nopasswdchg'})) {
11110: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11111: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
11112: if (($cdom ne '') && ($cnum ne '')) {
11113: my $is_owner = &is_course_owner($cdom,$cnum);
11114: if ($is_owner) {
11115: $allowed = 1;
11116: }
11117: }
11118: }
11119: unless ($allowed) { return 'refused'; }
1.197 www 11120: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 11121: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
11122: ' in domain '.$env{'request.role.domain'});
1.169 harris41 11123: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
11124: &escape($upass),$uhome);
1.1434 raeburn 11125: my $ip = &get_requestor_ip();
1.620 albertel 11126: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 11127: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
1.1434 raeburn 11128: '(Remote '.$ip.'): '.$reply);
1.197 www 11129: &log($udom,,$uname,$uhome,
1.620 albertel 11130: 'Authentication changed by '.$env{'user.domain'}.', '.
11131: $env{'user.name'}.', '.$umode.
1.1435 raeburn 11132: '(Remote '.$ip.'): '.$reply);
1.169 harris41 11133: unless ($reply eq 'ok') {
1.197 www 11134: &logthis('Authentication mode error: '.$reply);
1.169 harris41 11135: return 'error: '.$reply;
11136: }
1.170 harris41 11137: return 'ok';
1.80 www 11138: }
11139:
1.81 www 11140: # --------------------------------------------------------------- Modify a user
1.80 www 11141:
1.81 www 11142: sub modifyuser {
1.206 matthew 11143: my ($udom, $uname, $uid,
11144: $umode, $upass, $first,
11145: $middle, $last, $gene,
1.1058 raeburn 11146: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 11147: $udom= &LONCAPA::clean_domain($udom);
11148: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 11149: my $showcandelete = 'none';
11150: if (ref($candelete) eq 'ARRAY') {
11151: if (@{$candelete} > 0) {
11152: $showcandelete = join(', ',@{$candelete});
11153: }
11154: }
1.81 www 11155: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 11156: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 11157: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 11158: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
11159: ' desiredhome not specified').
1.620 albertel 11160: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
11161: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 11162: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 11163: my $newuser;
11164: if ($uhome eq 'no_host') {
11165: $newuser = 1;
1.1368 raeburn 11166: unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
11167: ($umode eq 'lti')) {
11168: return 'error: more information needed to create new user';
11169: }
1.1075 raeburn 11170: }
1.80 www 11171: # ----------------------------------------------------------------- Create User
1.406 albertel 11172: if (($uhome eq 'no_host') &&
1.1368 raeburn 11173: (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
1.80 www 11174: my $unhome='';
1.844 albertel 11175: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 11176: $unhome = $desiredhome;
1.620 albertel 11177: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
11178: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 11179: } else { # load balancing routine for determining $unhome
1.81 www 11180: my $loadm=10000000;
1.841 albertel 11181: my %servers = &get_servers($udom,'library');
11182: foreach my $tryserver (keys(%servers)) {
11183: my $answer=reply('load',$tryserver);
11184: if (($answer=~/\d+/) && ($answer<$loadm)) {
11185: $loadm=$answer;
11186: $unhome=$tryserver;
11187: }
1.80 www 11188: }
11189: }
11190: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 11191: return 'error: unable to find a home server for '.$uname.
11192: ' in domain '.$udom;
1.80 www 11193: }
11194: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
11195: &escape($upass),$unhome);
11196: unless ($reply eq 'ok') {
11197: return 'error: '.$reply;
11198: }
1.230 stredwic 11199: $uhome=&homeserver($uname,$udom,'true');
1.80 www 11200: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 11201: return 'error: unable verify users home machine.';
1.80 www 11202: }
1.209 matthew 11203: } # End of creation of new user
1.80 www 11204: # ---------------------------------------------------------------------- Add ID
11205: if ($uid) {
11206: $uid=~tr/A-Z/a-z/;
11207: my %uidhash=&idrget($udom,$uname);
1.196 www 11208: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
11209: && (!$forceid)) {
1.80 www 11210: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 11211: return 'error: user id "'.$uid.'" does not match '.
11212: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 11213: }
11214: } else {
1.1300 raeburn 11215: &idput($udom,{$uname => $uid},$uhome,'ids');
1.80 www 11216: }
11217: }
11218: # -------------------------------------------------------------- Add names, etc
1.313 matthew 11219: my @tmp=&get('environment',
1.899 raeburn 11220: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 11221: 'permanentemail','inststatus'],
1.134 albertel 11222: $udom,$uname);
1.1075 raeburn 11223: my (%names,%oldnames);
1.313 matthew 11224: if ($tmp[0] =~ m/^error:.*/) {
11225: %names=();
11226: } else {
11227: %names = @tmp;
1.1075 raeburn 11228: %oldnames = %names;
1.313 matthew 11229: }
1.388 www 11230: #
1.1058 raeburn 11231: # If name, email and/or uid are blank (e.g., because an uploaded file
11232: # of users did not contain them), do not overwrite existing values
11233: # unless field is in $candelete array ref.
11234: #
11235:
11236: my @fields = ('firstname','middlename','lastname','generation',
11237: 'permanentemail','id');
11238: my %newvalues;
11239: if (ref($candelete) eq 'ARRAY') {
11240: foreach my $field (@fields) {
11241: if (grep(/^\Q$field\E$/,@{$candelete})) {
11242: if ($field eq 'firstname') {
11243: $names{$field} = $first;
11244: } elsif ($field eq 'middlename') {
11245: $names{$field} = $middle;
11246: } elsif ($field eq 'lastname') {
11247: $names{$field} = $last;
11248: } elsif ($field eq 'generation') {
11249: $names{$field} = $gene;
11250: } elsif ($field eq 'permanentemail') {
11251: $names{$field} = $email;
11252: } elsif ($field eq 'id') {
11253: $names{$field} = $uid;
11254: }
11255: }
11256: }
11257: }
1.388 www 11258: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 11259: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 11260: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 11261: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 11262: if ($email) {
11263: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 11264: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 11265: }
1.899 raeburn 11266: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 11267: if (defined($inststatus)) {
11268: $names{'inststatus'} = '';
11269: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
11270: if (ref($usertypes) eq 'HASH') {
11271: my @okstatuses;
11272: foreach my $item (split(/:/,$inststatus)) {
11273: if (defined($usertypes->{$item})) {
11274: push(@okstatuses,$item);
11275: }
11276: }
11277: if (@okstatuses) {
11278: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
11279: }
11280: }
11281: }
1.1075 raeburn 11282: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 11283: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 11284: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 11285: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
11286: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
11287: } else {
11288: $logmsg .= ' during self creation';
11289: }
1.1075 raeburn 11290: my $changed;
11291: if ($newuser) {
11292: $changed = 1;
11293: } else {
11294: foreach my $field (@fields) {
11295: if ($names{$field} ne $oldnames{$field}) {
11296: $changed = 1;
11297: last;
11298: }
11299: }
11300: }
11301: unless ($changed) {
11302: $logmsg = 'No changes in user information needed for: '.$logmsg;
11303: &logthis($logmsg);
11304: return 'ok';
11305: }
11306: my $reply = &put('environment', \%names, $udom,$uname);
11307: if ($reply ne 'ok') {
11308: return 'error: '.$reply;
11309: }
1.1087 raeburn 11310: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
1.1494 raeburn 11311: &devalidate_cache_new('emailscache',$uname.':'.$udom);
1.1087 raeburn 11312: }
1.1075 raeburn 11313: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
11314: &devalidate_cache_new('namescache',$uname.':'.$udom);
11315: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 11316: &logthis($logmsg);
1.134 albertel 11317: return 'ok';
1.80 www 11318: }
11319:
1.81 www 11320: # -------------------------------------------------------------- Modify student
1.80 www 11321:
1.81 www 11322: sub modifystudent {
11323: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 11324: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1314 raeburn 11325: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 11326: if (!$cid) {
1.620 albertel 11327: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 11328: return 'not_in_class';
11329: }
1.80 www 11330: }
11331: # --------------------------------------------------------------- Make the user
1.81 www 11332: my $reply=&modifyuser
1.209 matthew 11333: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 11334: $desiredhome,$email,$inststatus);
1.80 www 11335: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 11336: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 11337: # student's environment
1.297 matthew 11338: $uid = undef if (!$forceid);
1.455 albertel 11339: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 11340: $gene,$usec,$end,$start,$type,$locktype,
1.1314 raeburn 11341: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 11342: return $reply;
11343: }
11344:
11345: sub modify_student_enrollment {
1.1216 raeburn 11346: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1512 raeburn 11347: $locktype,$cid,$selfenroll,$context,$credits,$instsec,$othdomby,$requester) = @_;
1.455 albertel 11348: my ($cdom,$cnum,$chome);
11349: if (!$cid) {
1.620 albertel 11350: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 11351: return 'not_in_class';
11352: }
1.620 albertel 11353: $cdom=$env{'course.'.$cid.'.domain'};
11354: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 11355: } else {
11356: ($cdom,$cnum)=split(/_/,$cid);
11357: }
1.620 albertel 11358: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 11359: if (!$chome) {
1.457 raeburn 11360: $chome=&homeserver($cnum,$cdom);
1.297 matthew 11361: }
1.455 albertel 11362: if (!$chome) { return 'unknown_course'; }
1.297 matthew 11363: # Make sure the user exists
1.81 www 11364: my $uhome=&homeserver($uname,$udom);
11365: if (($uhome eq '') || ($uhome eq 'no_host')) {
11366: return 'error: no such user';
11367: }
1.297 matthew 11368: # Get student data if we were not given enough information
11369: if (!defined($first) || $first eq '' ||
11370: !defined($last) || $last eq '' ||
11371: !defined($uid) || $uid eq '' ||
11372: !defined($middle) || $middle eq '' ||
11373: !defined($gene) || $gene eq '') {
1.294 matthew 11374: # They did not supply us with enough data to enroll the student, so
11375: # we need to pick up more information.
1.297 matthew 11376: my %tmp = &get('environment',
1.294 matthew 11377: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 11378: ,$udom,$uname);
11379:
1.800 albertel 11380: #foreach my $key (keys(%tmp)) {
11381: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 11382: #}
1.294 matthew 11383: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
11384: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
11385: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 11386: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 11387: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
11388: }
1.556 albertel 11389: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 11390: my $user = "$uname:$udom";
1.1494 raeburn 11391: my %old_entry = &get('classlist',[$user],$cdom,$cnum);
1.487 albertel 11392: my $reply=cput('classlist',
1.1148 raeburn 11393: {$user =>
1.1314 raeburn 11394: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 11395: $cdom,$cnum);
1.1148 raeburn 11396: if (($reply eq 'ok') || ($reply eq 'delayed')) {
11397: &devalidate_getsection_cache($udom,$uname,$cid);
11398: } else {
1.81 www 11399: return 'error: '.$reply;
11400: }
1.297 matthew 11401: # Add student role to user
1.83 www 11402: my $uurl='/'.$cid;
1.81 www 11403: $uurl=~s/\_/\//g;
11404: if ($usec) {
11405: $uurl.='/'.$usec;
11406: }
1.1148 raeburn 11407: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
1.1512 raeburn 11408: $selfenroll,$context,$othdomby,$requester);
1.1148 raeburn 11409: if ($result ne 'ok') {
11410: if ($old_entry{$user} ne '') {
11411: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
11412: } else {
11413: $reply = &del('classlist',[$user],$cdom,$cnum);
11414: }
11415: }
11416: return $result;
1.21 www 11417: }
11418:
1.556 albertel 11419: sub format_name {
11420: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
11421: my $name;
11422: if ($first ne 'lastname') {
11423: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
11424: } else {
11425: if ($lastname=~/\S/) {
11426: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
11427: $name=~s/\s+,/,/;
11428: } else {
11429: $name.= $firstname.' '.$middlename.' '.$generation;
11430: }
11431: }
11432: $name=~s/^\s+//;
11433: $name=~s/\s+$//;
11434: $name=~s/\s+/ /g;
11435: return $name;
11436: }
11437:
1.84 www 11438: # ------------------------------------------------- Write to course preferences
11439:
11440: sub writecoursepref {
11441: my ($courseid,%prefs)=@_;
11442: $courseid=~s/^\///;
11443: $courseid=~s/\_/\//g;
11444: my ($cdomain,$cnum)=split(/\//,$courseid);
11445: my $chome=homeserver($cnum,$cdomain);
11446: if (($chome eq '') || ($chome eq 'no_host')) {
11447: return 'error: no such course';
11448: }
11449: my $cstring='';
1.800 albertel 11450: foreach my $pref (keys(%prefs)) {
11451: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 11452: }
1.84 www 11453: $cstring=~s/\&$//;
11454: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
11455: }
11456:
11457: # ---------------------------------------------------------- Make/modify course
11458:
11459: sub createcourse {
1.741 raeburn 11460: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1423 raeburn 11461: $course_owner,$crstype,$cnum,$context,$category,$callercontext)=@_;
1.84 www 11462: $url=&declutter($url);
11463: my $cid='';
1.1028 raeburn 11464: if ($context eq 'requestcourses') {
11465: my $can_create = 0;
11466: my ($ownername,$ownerdom) = split(':',$course_owner);
11467: if ($udom eq $ownerdom) {
1.1423 raeburn 11468: my $reload;
11469: if (($callercontext eq 'auto') &&
11470: ($ownerdom eq $env{'user.domain'}) && ($ownername eq $env{'user.name'})) {
11471: $reload = 'reload';
11472: }
11473: if (&usertools_access($ownername,$ownerdom,$category,$reload,
1.1028 raeburn 11474: $context)) {
11475: $can_create = 1;
11476: }
11477: } else {
11478: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
11479: $category);
11480: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
11481: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
11482: if (@curr > 0) {
11483: my @options = qw(approval validate autolimit);
11484: my $optregex = join('|',@options);
11485: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
11486: $can_create = 1;
11487: }
11488: }
11489: }
11490: }
11491: if ($can_create) {
11492: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
11493: unless (&allowed('ccc',$udom)) {
11494: return 'refused';
11495: }
1.1017 raeburn 11496: }
11497: } else {
11498: return 'refused';
11499: }
1.1028 raeburn 11500: } elsif (!&allowed('ccc',$udom)) {
11501: return 'refused';
1.84 www 11502: }
1.1011 raeburn 11503: # --------------------------------------------------------------- Get Unique ID
11504: my $uname;
11505: if ($cnum =~ /^$match_courseid$/) {
11506: my $chome=&homeserver($cnum,$udom,'true');
11507: if (($chome eq '') || ($chome eq 'no_host')) {
11508: $uname = $cnum;
11509: } else {
1.1038 raeburn 11510: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 11511: }
11512: } else {
1.1038 raeburn 11513: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 11514: }
11515: return $uname if ($uname =~ /^error/);
11516: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 11517: if (!defined($course_server)) {
11518: if (defined(&domain($udom,'primary'))) {
11519: $course_server = &domain($udom,'primary');
11520: } else {
11521: $course_server = $env{'user.home'};
11522: }
11523: }
11524: my %host_servers =
1.1494 raeburn 11525: &get_servers($udom,'library');
1.1052 raeburn 11526: unless ($host_servers{$course_server}) {
11527: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 11528: }
1.84 www 11529: # ------------------------------------------------------------- Make the course
11530: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 11531: $course_server);
1.84 www 11532: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 11533: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 11534: if (($uhome eq '') || ($uhome eq 'no_host')) {
11535: return 'error: no such course';
11536: }
1.271 www 11537: # ----------------------------------------------------------------- Course made
1.516 raeburn 11538: # log existence
1.1029 raeburn 11539: my $now = time;
1.918 raeburn 11540: my $newcourse = {
11541: $udom.'_'.$uname => {
1.921 raeburn 11542: description => $description,
11543: inst_code => $inst_code,
11544: owner => $course_owner,
11545: type => $crstype,
1.1029 raeburn 11546: creator => $env{'user.name'}.':'.
11547: $env{'user.domain'},
11548: created => $now,
11549: context => $context,
1.918 raeburn 11550: },
11551: };
1.921 raeburn 11552: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 11553: # set toplevel url
1.271 www 11554: my $topurl=$url;
11555: unless ($nonstandard) {
11556: # ------------------------------------------ For standard courses, make top url
11557: my $mapurl=&clutter($url);
1.278 www 11558: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 11559: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 11560: <map>
11561: <resource id="1" type="start"></resource>
11562: <resource id="2" src="$mapurl"></resource>
11563: <resource id="3" type="finish"></resource>
11564: <link index="1" from="1" to="2"></link>
11565: <link index="2" from="2" to="3"></link>
11566: </map>
11567: ENDINITMAP
11568: $topurl=&declutter(
1.638 albertel 11569: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 11570: );
11571: }
11572: # ----------------------------------------------------------- Write preferences
1.84 www 11573: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 11574: ('description' => $description,
11575: 'url' => $topurl,
11576: 'internal.creator' => $env{'user.name'}.':'.
11577: $env{'user.domain'},
11578: 'internal.created' => $now,
11579: 'internal.creationcontext' => $context)
11580: );
1.84 www 11581: return '/'.$udom.'/'.$uname;
11582: }
11583:
1.1011 raeburn 11584: # ------------------------------------------------------------------- Create ID
11585: sub generate_coursenum {
1.1038 raeburn 11586: my ($udom,$crstype) = @_;
1.1011 raeburn 11587: my $domdesc = &domain($udom);
11588: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 11589: my $first;
11590: if ($crstype eq 'Community') {
11591: $first = '0';
11592: } else {
11593: $first = int(1+rand(9));
11594: }
11595: my $uname=$first.
1.1011 raeburn 11596: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11597: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11598: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11599: # ----------------------------------------------- Make sure that does not exist
11600: my $uhome=&homeserver($uname,$udom,'true');
11601: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 11602: if ($crstype eq 'Community') {
11603: $first = '0';
11604: } else {
11605: $first = int(1+rand(9));
11606: }
11607: $uname=$first.
1.1011 raeburn 11608: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
11609: substr($$.time,0,5).unpack("H8",pack("I32",time)).
11610: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
11611: $uhome=&homeserver($uname,$udom,'true');
11612: unless (($uhome eq '') || ($uhome eq 'no_host')) {
11613: return 'error: unable to generate unique course-ID';
11614: }
11615: }
11616: return $uname;
11617: }
11618:
1.813 albertel 11619: sub is_course {
1.1167 droeschl 11620: my ($cdom, $cnum) = scalar(@_) == 1 ?
11621: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
11622:
1.1381 raeburn 11623: return unless (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/));
11624: my $uhome=&homeserver($cnum,$cdom);
11625: my $iscourse;
11626: if (grep { $_ eq $uhome } current_machine_ids()) {
1.1382 raeburn 11627: $iscourse = &LONCAPA::Lond::is_course($cdom,$cnum);
1.1381 raeburn 11628: } else {
11629: my $hashid = $cdom.':'.$cnum;
11630: ($iscourse,my $cached) = &is_cached_new('iscourse',$hashid);
11631: unless (defined($cached)) {
11632: my %courses = &courseiddump($cdom, '.', 1, '.', '.',
11633: $cnum,undef,undef,'.');
11634: $iscourse = 0;
11635: if (exists($courses{$cdom.'_'.$cnum})) {
11636: $iscourse = 1;
11637: }
11638: &do_cache_new('iscourse',$hashid,$iscourse,3600);
11639: }
11640: }
11641: return unless ($iscourse);
1.1167 droeschl 11642: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 11643: }
11644:
1.1015 raeburn 11645: sub store_userdata {
11646: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 11647: my $result;
1.1016 raeburn 11648: if ($datakey ne '') {
1.1013 raeburn 11649: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 11650: if ($udom eq '' || $uname eq '') {
11651: $udom = $env{'user.domain'};
11652: $uname = $env{'user.name'};
11653: }
11654: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 11655: if (($uhome eq '') || ($uhome eq 'no_host')) {
11656: $result = 'error: no_host';
11657: } else {
1.1434 raeburn 11658: $storehash->{'ip'} = &get_requestor_ip();
1.1013 raeburn 11659: $storehash->{'host'} = $perlvar{'lonHostID'};
11660:
11661: my $namevalue='';
11662: foreach my $key (keys(%{$storehash})) {
11663: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
11664: }
11665: $namevalue=~s/\&$//;
1.1224 raeburn 11666: unless ($namespace eq 'courserequests') {
11667: $datakey = &escape($datakey);
11668: }
1.1105 raeburn 11669: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
11670: $namevalue,$uhome);
1.1013 raeburn 11671: }
11672: } else {
11673: $result = 'error: data to store was not a hash reference';
11674: }
11675: } else {
11676: $result= 'error: invalid requestkey';
11677: }
11678: return $result;
11679: }
11680:
1.21 www 11681: # ---------------------------------------------------------- Assign Custom Role
11682:
11683: sub assigncustomrole {
1.1512 raeburn 11684: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,
11685: $selfenroll,$context,$othdomby,$requester)=@_;
1.21 www 11686: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.1512 raeburn 11687: $end,$start,$deleteflag,$selfenroll,$context,$othdomby,
11688: $requester);
1.21 www 11689: }
11690:
11691: # ----------------------------------------------------------------- Revoke Role
11692:
11693: sub revokerole {
1.957 raeburn 11694: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11695: my $now=time;
1.965 raeburn 11696: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 11697: }
11698:
11699: # ---------------------------------------------------------- Revoke Custom Role
11700:
11701: sub revokecustomrole {
1.957 raeburn 11702: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 11703: my $now=time;
1.357 www 11704: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 11705: $deleteflag,$selfenroll,$context);
1.17 www 11706: }
11707:
1.533 banghart 11708: # ------------------------------------------------------------ Disk usage
1.535 albertel 11709: sub diskusage {
1.955 raeburn 11710: my ($udom,$uname,$directorypath,$getpropath)=@_;
11711: $directorypath =~ s/\/$//;
11712: my $listing=&reply('du2:'.&escape($directorypath).':'
11713: .&escape($getpropath).':'.&escape($uname).':'
11714: .&escape($udom),homeserver($uname,$udom));
11715: if ($listing eq 'unknown_cmd') {
11716: if ($getpropath) {
11717: $directorypath = &propath($udom,$uname).'/'.$directorypath;
11718: }
11719: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
11720: }
1.514 albertel 11721: return $listing;
1.512 banghart 11722: }
11723:
1.566 banghart 11724: sub is_locked {
1.1096 raeburn 11725: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 11726: my @check;
11727: my $is_locked;
1.1093 raeburn 11728: push (@check,$file_name);
1.613 albertel 11729: my %locked = &get('file_permissions',\@check,
1.620 albertel 11730: $env{'user.domain'},$env{'user.name'});
1.615 albertel 11731: my ($tmp)=keys(%locked);
11732: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 11733:
1.566 banghart 11734: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 11735: $is_locked = 'false';
11736: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 11737: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 11738: $is_locked = 'true';
1.1096 raeburn 11739: if (ref($which) eq 'ARRAY') {
11740: push(@{$which},$entry);
11741: } else {
11742: last;
11743: }
1.745 raeburn 11744: }
11745: }
1.566 banghart 11746: } else {
11747: $is_locked = 'false';
11748: }
1.1093 raeburn 11749: return $is_locked;
1.566 banghart 11750: }
11751:
1.759 albertel 11752: sub declutter_portfile {
11753: my ($file) = @_;
1.833 albertel 11754: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 11755: return $file;
11756: }
11757:
1.559 banghart 11758: # ------------------------------------------------------------- Mark as Read Only
11759:
11760: sub mark_as_readonly {
11761: my ($domain,$user,$files,$what) = @_;
1.613 albertel 11762: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11763: my ($tmp)=keys(%current_permissions);
11764: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 11765: foreach my $file (@{$files}) {
1.759 albertel 11766: $file = &declutter_portfile($file);
1.561 banghart 11767: push(@{$current_permissions{$file}},$what);
1.559 banghart 11768: }
1.613 albertel 11769: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 11770: return;
11771: }
11772:
1.572 banghart 11773: # ------------------------------------------------------------Save Selected Files
11774:
11775: sub save_selected_files {
11776: my ($user, $path, @files) = @_;
11777: my $filename = $user."savedfiles";
1.573 banghart 11778: my @other_files = &files_not_in_path($user, $path);
1.1359 raeburn 11779: open (OUT,'>',LONCAPA::tempdir().$filename);
1.573 banghart 11780: foreach my $file (@files) {
1.620 albertel 11781: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 11782: }
11783: foreach my $file (@other_files) {
1.574 banghart 11784: print (OUT $file."\n");
1.572 banghart 11785: }
1.574 banghart 11786: close (OUT);
1.572 banghart 11787: return 'ok';
11788: }
11789:
1.574 banghart 11790: sub clear_selected_files {
11791: my ($user) = @_;
11792: my $filename = $user."savedfiles";
1.1359 raeburn 11793: open (OUT,'>',LONCAPA::tempdir().$filename);
1.574 banghart 11794: print (OUT undef);
11795: close (OUT);
11796: return ("ok");
11797: }
11798:
1.572 banghart 11799: sub files_in_path {
11800: my ($user, $path) = @_;
11801: my $filename = $user."savedfiles";
11802: my %return_files;
1.1359 raeburn 11803: open (IN,'<',LONCAPA::tempdir().$filename);
1.573 banghart 11804: while (my $line_in = <IN>) {
1.574 banghart 11805: chomp ($line_in);
11806: my @paths_and_file = split (m!/!, $line_in);
11807: my $file_part = pop (@paths_and_file);
11808: my $path_part = join ('/', @paths_and_file);
1.573 banghart 11809: $path_part.='/';
11810: my $path_and_file = $path_part.$file_part;
11811: if ($path_part eq $path) {
11812: $return_files{$file_part}= 'selected';
11813: }
11814: }
1.574 banghart 11815: close (IN);
11816: return (\%return_files);
1.572 banghart 11817: }
11818:
11819: # called in portfolio select mode, to show files selected NOT in current directory
11820: sub files_not_in_path {
11821: my ($user, $path) = @_;
11822: my $filename = $user."savedfiles";
11823: my @return_files;
11824: my $path_part;
1.1359 raeburn 11825: open(IN, '<',LONCAPA::tempdir().$filename);
1.800 albertel 11826: while (my $line = <IN>) {
1.572 banghart 11827: #ok, I know it's clunky, but I want it to work
1.800 albertel 11828: my @paths_and_file = split(m|/|, $line);
11829: my $file_part = pop(@paths_and_file);
11830: chomp($file_part);
11831: my $path_part = join('/', @paths_and_file);
1.572 banghart 11832: $path_part .= '/';
11833: my $path_and_file = $path_part.$file_part;
11834: if ($path_part ne $path) {
1.800 albertel 11835: push(@return_files, ($path_and_file));
1.572 banghart 11836: }
11837: }
1.800 albertel 11838: close(OUT);
1.574 banghart 11839: return (@return_files);
1.572 banghart 11840: }
11841:
1.1273 raeburn 11842: #------------------------------Submitted/Handedback Portfolio Files Versioning
11843:
11844: sub portfiles_versioning {
11845: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
11846: my $portfolio_root = '/userfiles/portfolio';
11847: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
11848: foreach my $file (@{$portfiles}) {
11849: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
11850: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
11851: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
11852: my $getpropath = 1;
11853: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
11854: $stu_name,$getpropath);
11855: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
11856: my $new_answer =
11857: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
11858: if ($new_answer ne 'problem getting file') {
11859: push(@{$versioned_portfiles}, $directory.$new_answer);
11860: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
11861: [$symb,$env{'request.course.id'},'graded']);
11862: }
11863: }
11864: }
11865:
11866: sub get_next_version {
11867: my ($answer_name, $answer_ext, $dir_list) = @_;
11868: my $version;
11869: if (ref($dir_list) eq 'ARRAY') {
11870: foreach my $row (@{$dir_list}) {
11871: my ($file) = split(/\&/,$row,2);
11872: my ($file_name,$file_version,$file_ext) =
11873: &file_name_version_ext($file);
11874: if (($file_name eq $answer_name) &&
11875: ($file_ext eq $answer_ext)) {
11876: # gets here if filename and extension match,
11877: # regardless of version
11878: if ($file_version ne '') {
11879: # a versioned file is found so save it for later
11880: if ($file_version > $version) {
11881: $version = $file_version;
11882: }
11883: }
11884: }
11885: }
11886: }
11887: $version ++;
11888: return($version);
11889: }
11890:
11891: sub version_selected_portfile {
11892: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
11893: my ($answer_name,$answer_ver,$answer_ext) =
11894: &file_name_version_ext($file_name);
11895: my $new_answer;
11896: $env{'form.copy'} =
11897: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
11898: if($env{'form.copy'} eq '-1') {
11899: $new_answer = 'problem getting file';
11900: } else {
11901: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
11902: my $copy_result =
11903: &finishuserfileupload($stu_name,$domain,'copy',
11904: '/portfolio'.$directory.$new_answer);
11905: }
11906: undef($env{'form.copy'});
11907: return ($new_answer);
11908: }
11909:
11910: sub file_name_version_ext {
11911: my ($file)=@_;
11912: my @file_parts = split(/\./, $file);
11913: my ($name,$version,$ext);
11914: if (@file_parts > 1) {
11915: $ext=pop(@file_parts);
11916: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
11917: $version=pop(@file_parts);
11918: }
11919: $name=join('.',@file_parts);
11920: } else {
11921: $name=join('.',@file_parts);
11922: }
11923: return($name,$version,$ext);
11924: }
11925:
1.745 raeburn 11926: #----------------------------------------------Get portfolio file permissions
1.629 banghart 11927:
1.745 raeburn 11928: sub get_portfile_permissions {
11929: my ($domain,$user) = @_;
1.613 albertel 11930: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 11931: my ($tmp)=keys(%current_permissions);
11932: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 11933: return \%current_permissions;
11934: }
11935:
11936: #---------------------------------------------Get portfolio file access controls
11937:
1.749 raeburn 11938: sub get_access_controls {
1.745 raeburn 11939: my ($current_permissions,$group,$file) = @_;
1.769 albertel 11940: my %access;
11941: my $real_file = $file;
11942: $file =~ s/\.meta$//;
1.745 raeburn 11943: if (defined($file)) {
1.749 raeburn 11944: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
11945: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 11946: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 11947: }
11948: }
1.745 raeburn 11949: } else {
1.749 raeburn 11950: foreach my $key (keys(%{$current_permissions})) {
11951: if ($key =~ /\0accesscontrol$/) {
11952: if (defined($group)) {
11953: if ($key !~ m-^\Q$group\E/-) {
11954: next;
11955: }
11956: }
11957: my ($fullpath) = split(/\0/,$key);
11958: if (ref($$current_permissions{$key}) eq 'HASH') {
11959: foreach my $control (keys(%{$$current_permissions{$key}})) {
11960: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
11961: }
11962: }
11963: }
11964: }
11965: }
11966: return %access;
11967: }
11968:
11969: sub modify_access_controls {
11970: my ($file_name,$changes,$domain,$user)=@_;
11971: my ($outcome,$deloutcome);
11972: my %store_permissions;
11973: my %new_values;
11974: my %new_control;
11975: my %translation;
11976: my @deletions = ();
11977: my $now = time;
11978: if (exists($$changes{'activate'})) {
11979: if (ref($$changes{'activate'}) eq 'HASH') {
11980: my @newitems = sort(keys(%{$$changes{'activate'}}));
11981: my $numnew = scalar(@newitems);
11982: for (my $i=0; $i<$numnew; $i++) {
11983: my $newkey = $newitems[$i];
11984: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 11985: if ($newkey =~ /^\d+:/) {
11986: $newkey =~ s/^(\d+)/$newid/;
11987: $translation{$1} = $newid;
11988: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
11989: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
11990: $translation{$1} = $newid;
11991: }
1.749 raeburn 11992: $new_values{$file_name."\0".$newkey} =
11993: $$changes{'activate'}{$newitems[$i]};
11994: $new_control{$newkey} = $now;
11995: }
11996: }
11997: }
11998: my %todelete;
11999: my %changed_items;
12000: foreach my $action ('delete','update') {
12001: if (exists($$changes{$action})) {
12002: if (ref($$changes{$action}) eq 'HASH') {
12003: foreach my $key (keys(%{$$changes{$action}})) {
12004: my ($itemnum) = ($key =~ /^([^:]+):/);
12005: if ($action eq 'delete') {
12006: $todelete{$itemnum} = 1;
12007: } else {
12008: $changed_items{$itemnum} = $key;
12009: }
12010: }
1.745 raeburn 12011: }
12012: }
1.749 raeburn 12013: }
12014: # get lock on access controls for file.
12015: my $lockhash = {
12016: $file_name."\0".'locked_access_records' => $env{'user.name'}.
12017: ':'.$env{'user.domain'},
12018: };
12019: my $tries = 0;
12020: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
12021:
1.1288 damieng 12022: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 12023: $tries ++;
1.1289 damieng 12024: sleep(0.1);
1.749 raeburn 12025: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
12026: }
12027: if ($gotlock eq 'ok') {
12028: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
12029: my ($tmp)=keys(%curr_permissions);
12030: if ($tmp=~/^error:/) { undef(%curr_permissions); }
12031: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
12032: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
12033: if (ref($curr_controls) eq 'HASH') {
12034: foreach my $control_item (keys(%{$curr_controls})) {
12035: my ($itemnum) = ($control_item =~ /^([^:]+):/);
12036: if (defined($todelete{$itemnum})) {
12037: push(@deletions,$file_name."\0".$control_item);
12038: } else {
12039: if (defined($changed_items{$itemnum})) {
12040: $new_control{$changed_items{$itemnum}} = $now;
12041: push(@deletions,$file_name."\0".$control_item);
12042: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
12043: } else {
12044: $new_control{$control_item} = $$curr_controls{$control_item};
12045: }
12046: }
1.745 raeburn 12047: }
12048: }
12049: }
1.970 raeburn 12050: my ($group);
12051: if (&is_course($domain,$user)) {
12052: ($group,my $file) = split(/\//,$file_name,2);
12053: }
1.749 raeburn 12054: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
12055: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
12056: $outcome = &put('file_permissions',\%new_values,$domain,$user);
12057: # remove lock
12058: my @del_lock = ($file_name."\0".'locked_access_records');
12059: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 12060: my $sqlresult =
1.970 raeburn 12061: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 12062: $group);
1.749 raeburn 12063: } else {
12064: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 12065: }
1.749 raeburn 12066: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 12067: }
12068:
1.827 raeburn 12069: sub make_public_indefinitely {
1.1271 raeburn 12070: my (@requrl) = @_;
12071: return &automated_portfile_access('public',\@requrl);
12072: }
12073:
12074: sub automated_portfile_access {
12075: my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273 raeburn 12076: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
12077: return 'invalid';
12078: }
1.1271 raeburn 12079: my %urls;
12080: if (ref($addsref) eq 'ARRAY') {
12081: foreach my $requrl (@{$addsref}) {
12082: if (&is_portfolio_url($requrl)) {
12083: unless (exists($urls{$requrl})) {
12084: $urls{$requrl} = 'add';
12085: }
12086: }
12087: }
12088: }
12089: if (ref($delsref) eq 'ARRAY') {
12090: foreach my $requrl (@{$delsref}) {
12091: if (&is_portfolio_url($requrl)) {
12092: unless (exists($urls{$requrl})) {
12093: $urls{$requrl} = 'delete';
12094: }
12095: }
12096: }
12097: }
12098: unless (keys(%urls)) {
12099: return 'invalid';
12100: }
12101: my $ip;
12102: if ($accesstype eq 'ip') {
12103: if (ref($info) eq 'HASH') {
12104: if ($info->{'ip'} ne '') {
12105: $ip = $info->{'ip'};
12106: }
12107: }
12108: if ($ip eq '') {
12109: return 'invalid';
12110: }
12111: }
12112: my $errors;
1.827 raeburn 12113: my $now = time;
1.1271 raeburn 12114: my %current_perms;
12115: foreach my $requrl (sort(keys(%urls))) {
12116: my $action;
12117: if ($urls{$requrl} eq 'add') {
12118: $action = 'activate';
12119: } else {
12120: $action = 'none';
12121: }
12122: my $aclnum = 0;
1.827 raeburn 12123: my (undef,$udom,$unum,$file_name,$group) =
12124: &parse_portfolio_url($requrl);
1.1271 raeburn 12125: unless (exists($current_perms{$unum.':'.$udom})) {
12126: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
12127: }
12128: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827 raeburn 12129: $group,$file_name);
12130: foreach my $key (keys(%{$access_controls{$file_name}})) {
12131: my ($num,$scope,$end,$start) =
12132: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271 raeburn 12133: if ($scope eq $accesstype) {
12134: if (($start <= $now) && ($end == 0)) {
12135: if ($accesstype eq 'ip') {
12136: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
12137: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
12138: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
12139: if ($urls{$requrl} eq 'add') {
12140: $action = 'none';
12141: last;
12142: } else {
12143: $action = 'delete';
12144: $aclnum = $num;
12145: last;
12146: }
12147: }
12148: }
12149: }
12150: } elsif ($accesstype eq 'public') {
12151: if ($urls{$requrl} eq 'add') {
12152: $action = 'none';
12153: last;
12154: } else {
12155: $action = 'delete';
12156: $aclnum = $num;
12157: last;
12158: }
12159: }
12160: } elsif ($accesstype eq 'public') {
1.827 raeburn 12161: $action = 'update';
12162: $aclnum = $num;
1.1271 raeburn 12163: last;
1.827 raeburn 12164: }
12165: }
12166: }
12167: if ($action eq 'none') {
1.1271 raeburn 12168: next;
1.827 raeburn 12169: } else {
12170: my %changes;
12171: my $newend = 0;
12172: my $newstart = $now;
1.1271 raeburn 12173: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827 raeburn 12174: $changes{$action}{$newkey} = {
1.1271 raeburn 12175: type => $accesstype,
1.827 raeburn 12176: time => {
12177: start => $newstart,
12178: end => $newend,
12179: },
12180: };
1.1271 raeburn 12181: if ($accesstype eq 'ip') {
12182: $changes{$action}{$newkey}{'ip'} = [$ip];
12183: }
1.827 raeburn 12184: my ($outcome,$deloutcome,$new_values,$translation) =
12185: &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271 raeburn 12186: unless ($outcome eq 'ok') {
12187: $errors .= $outcome.' ';
12188: }
1.827 raeburn 12189: }
1.1271 raeburn 12190: }
12191: if ($errors) {
12192: $errors =~ s/\s$//;
12193: return $errors;
1.827 raeburn 12194: } else {
1.1271 raeburn 12195: return 'ok';
1.827 raeburn 12196: }
12197: }
12198:
1.745 raeburn 12199: #------------------------------------------------------Get Marked as Read Only
12200:
12201: sub get_marked_as_readonly {
12202: my ($domain,$user,$what,$group) = @_;
12203: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 12204: my @readonly_files;
1.629 banghart 12205: my $cmp1=$what;
12206: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 12207: while (my ($file_name,$value) = each(%{$current_permissions})) {
12208: if (defined($group)) {
12209: if ($file_name !~ m-^\Q$group\E/-) {
12210: next;
12211: }
12212: }
1.561 banghart 12213: if (ref($value) eq "ARRAY"){
12214: foreach my $stored_what (@{$value}) {
1.629 banghart 12215: my $cmp2=$stored_what;
1.759 albertel 12216: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 12217: $cmp2=join('',@{$stored_what});
1.745 raeburn 12218: }
1.629 banghart 12219: if ($cmp1 eq $cmp2) {
1.561 banghart 12220: push(@readonly_files, $file_name);
1.745 raeburn 12221: last;
1.563 banghart 12222: } elsif (!defined($what)) {
12223: push(@readonly_files, $file_name);
1.745 raeburn 12224: last;
1.561 banghart 12225: }
12226: }
1.745 raeburn 12227: }
1.561 banghart 12228: }
12229: return @readonly_files;
12230: }
1.577 banghart 12231: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 12232:
1.577 banghart 12233: sub get_marked_as_readonly_hash {
1.745 raeburn 12234: my ($current_permissions,$group,$what) = @_;
1.577 banghart 12235: my %readonly_files;
1.745 raeburn 12236: while (my ($file_name,$value) = each(%{$current_permissions})) {
12237: if (defined($group)) {
12238: if ($file_name !~ m-^\Q$group\E/-) {
12239: next;
12240: }
12241: }
1.577 banghart 12242: if (ref($value) eq "ARRAY"){
12243: foreach my $stored_what (@{$value}) {
1.745 raeburn 12244: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 12245: foreach my $lock_descriptor(@{$stored_what}) {
12246: if ($lock_descriptor eq 'graded') {
12247: $readonly_files{$file_name} = 'graded';
12248: } elsif ($lock_descriptor eq 'handback') {
12249: $readonly_files{$file_name} = 'handback';
12250: } else {
12251: if (!exists($readonly_files{$file_name})) {
12252: $readonly_files{$file_name} = 'locked';
12253: }
12254: }
1.745 raeburn 12255: }
1.750 banghart 12256: }
1.577 banghart 12257: }
12258: }
12259: }
12260: return %readonly_files;
12261: }
1.559 banghart 12262: # ------------------------------------------------------------ Unmark as Read Only
12263:
12264: sub unmark_as_readonly {
1.629 banghart 12265: # unmarks $file_name (if $file_name is defined), or all files locked by $what
12266: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 12267: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 12268: $file_name = &declutter_portfile($file_name);
1.634 albertel 12269: my $symb_crs = $what;
12270: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 12271: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 12272: my ($tmp)=keys(%current_permissions);
12273: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 12274: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 12275: foreach my $file (@readonly_files) {
1.759 albertel 12276: my $clean_file = &declutter_portfile($file);
12277: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 12278: my $current_locks = $current_permissions{$file};
1.563 banghart 12279: my @new_locks;
12280: my @del_keys;
12281: if (ref($current_locks) eq "ARRAY"){
12282: foreach my $locker (@{$current_locks}) {
1.632 albertel 12283: my $compare=$locker;
1.749 raeburn 12284: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 12285: $compare=join('',@{$locker});
1.746 raeburn 12286: if ($compare ne $symb_crs) {
12287: push(@new_locks, $locker);
12288: }
1.563 banghart 12289: }
12290: }
1.650 albertel 12291: if (scalar(@new_locks) > 0) {
1.563 banghart 12292: $current_permissions{$file} = \@new_locks;
12293: } else {
12294: push(@del_keys, $file);
1.613 albertel 12295: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 12296: delete($current_permissions{$file});
1.563 banghart 12297: }
12298: }
1.561 banghart 12299: }
1.613 albertel 12300: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 12301: return;
12302: }
1.512 banghart 12303:
1.17 www 12304: # ------------------------------------------------------------ Directory lister
12305:
12306: sub dirlist {
1.955 raeburn 12307: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 12308: $uri=~s/^\///;
12309: $uri=~s/\/$//;
1.253 stredwic 12310: my ($udom, $uname);
1.955 raeburn 12311: if ($getuserdir) {
1.253 stredwic 12312: $udom = $userdomain;
12313: $uname = $username;
1.955 raeburn 12314: } else {
12315: (undef,$udom,$uname)=split(/\//,$uri);
12316: if(defined($userdomain)) {
12317: $udom = $userdomain;
12318: }
12319: if(defined($username)) {
12320: $uname = $username;
12321: }
1.253 stredwic 12322: }
1.955 raeburn 12323: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 12324:
1.955 raeburn 12325: $dirRoot = $perlvar{'lonDocRoot'};
12326: if (defined($getpropath)) {
12327: $dirRoot = &propath($udom,$uname);
1.253 stredwic 12328: $dirRoot =~ s/\/$//;
1.955 raeburn 12329: } elsif (defined($getuserdir)) {
12330: my $subdir=$uname.'__';
12331: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
12332: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
12333: ."/$udom/$subdir/$uname";
12334: } elsif (defined($alternateRoot)) {
12335: $dirRoot = $alternateRoot;
1.751 banghart 12336: }
1.253 stredwic 12337:
12338: if($udom) {
12339: if($uname) {
1.1135 raeburn 12340: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 12341: if ($uhome eq 'no_host') {
12342: return ([],'no_host');
12343: }
1.955 raeburn 12344: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 12345: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 12346: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 12347: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 12348: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 12349: } else {
12350: @listing_results = map { &unescape($_); } split(/:/,$listing);
12351: }
1.605 matthew 12352: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 12353: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 12354: @listing_results = split(/:/,$listing);
12355: } else {
12356: @listing_results = map { &unescape($_); } split(/:/,$listing);
12357: }
1.1135 raeburn 12358: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 12359: ($listing eq 'rejected') || ($listing eq 'refused') ||
12360: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
12361: return ([],$listing);
12362: } else {
12363: return (\@listing_results);
1.1135 raeburn 12364: }
1.955 raeburn 12365: } elsif(!$alternateRoot) {
1.1136 raeburn 12366: my (%allusers,%listerror);
1.841 albertel 12367: my %servers = &get_servers($udom,'library');
1.955 raeburn 12368: foreach my $tryserver (keys(%servers)) {
12369: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
12370: &escape($udom),$tryserver);
12371: if ($listing eq 'unknown_cmd') {
12372: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
12373: $udom, $tryserver);
12374: } else {
12375: @listing_results = map { &unescape($_); } split(/:/,$listing);
12376: }
1.841 albertel 12377: if ($listing eq 'unknown_cmd') {
12378: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
12379: $udom, $tryserver);
12380: @listing_results = split(/:/,$listing);
12381: } else {
12382: @listing_results =
12383: map { &unescape($_); } split(/:/,$listing);
12384: }
1.1136 raeburn 12385: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
12386: ($listing eq 'rejected') || ($listing eq 'refused') ||
12387: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
12388: $listerror{$tryserver} = $listing;
12389: } else {
1.841 albertel 12390: foreach my $line (@listing_results) {
12391: my ($entry) = split(/&/,$line,2);
12392: $allusers{$entry} = 1;
12393: }
12394: }
1.253 stredwic 12395: }
1.1136 raeburn 12396: my @alluserslist=();
1.800 albertel 12397: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 12398: push(@alluserslist,$user.'&user');
1.253 stredwic 12399: }
1.1318 droeschl 12400:
12401: if (!%listerror) {
12402: # no errors
12403: return (\@alluserslist);
12404: } elsif (scalar(keys(%servers)) == 1) {
12405: # one library server, one error
12406: my ($key) = keys(%listerror);
12407: return (\@alluserslist, $listerror{$key});
12408: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
12409: # con_lost indicates that we might miss data from at least one
12410: # library server
12411: return (\@alluserslist, 'con_lost');
12412: } else {
12413: # multiple library servers and no con_lost -> data should be
12414: # complete.
12415: return (\@alluserslist);
12416: }
12417:
1.253 stredwic 12418: } else {
1.1136 raeburn 12419: return ([],'missing username');
1.253 stredwic 12420: }
1.955 raeburn 12421: } elsif(!defined($getpropath)) {
1.1136 raeburn 12422: my $path = $perlvar{'lonDocRoot'}.'/res/';
12423: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
12424: return (\@all_domains);
1.955 raeburn 12425: } else {
1.1136 raeburn 12426: return ([],'missing domain');
1.275 stredwic 12427: }
12428: }
12429:
12430: # --------------------------------------------- GetFileTimestamp
12431: # This function utilizes dirlist and returns the date stamp for
12432: # when it was last modified. It will also return an error of -1
12433: # if an error occurs
12434:
12435: sub GetFileTimestamp {
1.955 raeburn 12436: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 12437: $studentDomain = &LONCAPA::clean_domain($studentDomain);
12438: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 12439: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
12440: undef,$getuserdir);
12441: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
12442: return -1;
12443: }
12444: if (ref($fileref) eq 'ARRAY') {
12445: my @stats = split('&',$fileref->[0]);
1.375 matthew 12446: # @stats contains first the filename, then the stat output
12447: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 12448: } else {
12449: return -1;
1.253 stredwic 12450: }
1.26 www 12451: }
12452:
1.712 albertel 12453: sub stat_file {
12454: my ($uri) = @_;
1.787 albertel 12455: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 12456:
1.955 raeburn 12457: my ($udom,$uname,$file);
1.712 albertel 12458: if ($uri =~ m-^/(uploaded|editupload)/-) {
12459: ($udom,$uname,$file) =
1.811 albertel 12460: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 12461: $file = 'userfiles/'.$file;
12462: }
12463: if ($uri =~ m-^/res/-) {
12464: ($udom,$uname) =
1.807 albertel 12465: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 12466: $file = $uri;
12467: }
12468:
12469: if (!$udom || !$uname || !$file) {
12470: # unable to handle the uri
12471: return ();
12472: }
1.956 raeburn 12473: my $getpropath;
12474: if ($file =~ /^userfiles\//) {
12475: $getpropath = 1;
12476: }
1.1136 raeburn 12477: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
12478: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
12479: return ();
12480: } else {
12481: if (ref($listref) eq 'ARRAY') {
12482: my @stats = split('&',$listref->[0]);
12483: shift(@stats); #filename is first
12484: return @stats;
12485: }
1.712 albertel 12486: }
12487: return ();
12488: }
12489:
1.1313 raeburn 12490: # --------------------------------------------------------- recursedirs
12491: # Recursive function to traverse either a specific user's Authoring Space
12492: # or corresponding Published Resource Space, and populate the hash ref:
12493: # $dirhashref with URLs of all directories, and if $filehashref hash
12494: # ref arg is provided, the URLs of any files, excluding versioned, .meta,
1.1503 raeburn 12495: # or .rights files in resource space, and .meta, .save, .log, .bak and
12496: # .rights files in Authoring Space.
1.1313 raeburn 12497: #
12498: # Inputs:
12499: #
12500: # $is_home - true if current server is home server for user's space
1.1503 raeburn 12501: # $recurse - if true will also traverse subdirectories recursively
12502: # $include - reference to hash containing allowed file extensions. If provided,
12503: # files which do not have a matching extension will be ignored.
12504: # $exclude - reference to hash containing excluded file extensions. If provided,
12505: # files which have a matching extension will be ignored.
12506: # $nonemptydir - if true, will only populate $fileshashref hash entry for a particular
12507: # directory with first file found (with acceptable extension).
1.1505 raeburn 12508: # $addtopdir - if true, set $dirhashref->{'/'} = 1
1.1313 raeburn 12509: # $toppath - Top level directory (i.e., /res/$dom/$uname or /priv/$dom/$uname
12510: # $relpath - Current path (relative to top level).
12511: # $dirhashref - reference to hash to populate with URLs of directories (Required)
12512: # $filehashref - reference to hash to populate with URLs of files (Optional)
12513: #
12514: # Returns: nothing
12515: #
12516: # Side Effects: populates $dirhashref, and $filehashref (if provided).
12517: #
12518: # Currently used by interface/londocs.pm to create linked select boxes for
12519: # directory and filename to import a Course "Author" resource into a course, and
12520: # also to create linked select boxes for Authoring Space and Directory to choose
12521: # save location for creation of a new "standard" problem from the Course Editor.
12522: #
12523:
12524: sub recursedirs {
1.1505 raeburn 12525: my ($is_home,$recurse,$include,$exclude,$nonemptydir,$addtopdir,$toppath,$relpath,$dirhashref,$filehashref) = @_;
1.1313 raeburn 12526: return unless (ref($dirhashref) eq 'HASH');
1.1503 raeburn 12527: my $docroot = $perlvar{'lonDocRoot'};
1.1313 raeburn 12528: my $currpath = $docroot.$toppath;
1.1503 raeburn 12529: if ($relpath ne '') {
1.1313 raeburn 12530: $currpath .= "/$relpath";
12531: }
1.1503 raeburn 12532: my ($savefile,$checkinc,$checkexc);
1.1313 raeburn 12533: if (ref($filehashref)) {
12534: $savefile = 1;
12535: }
1.1503 raeburn 12536: if (ref($include) eq 'HASH') {
12537: $checkinc = 1;
12538: }
12539: if (ref($exclude) eq 'HASH') {
12540: $checkexc = 1;
12541: }
1.1313 raeburn 12542: if ($is_home) {
1.1505 raeburn 12543: if ((-e $currpath) && (opendir(my $dirh,$currpath))) {
1.1503 raeburn 12544: my $filecount = 0;
1.1313 raeburn 12545: foreach my $item (sort { lc($a) cmp lc($b) } grep(!/^\.+$/,readdir($dirh))) {
12546: next if ($item eq '');
12547: if (-d "$currpath/$item") {
12548: my $newpath;
1.1503 raeburn 12549: if ($relpath ne '') {
1.1313 raeburn 12550: $newpath = "$relpath/$item";
12551: } else {
12552: $newpath = $item;
12553: }
12554: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
1.1503 raeburn 12555: if ($recurse) {
1.1505 raeburn 12556: &recursedirs($is_home,$recurse,$include,$exclude,$nonemptydir,$addtopdir,$toppath,$newpath,$dirhashref,$filehashref);
1.1503 raeburn 12557: }
12558: } elsif (($savefile) || ($relpath eq '')) {
12559: next if ($nonemptydir && $filecount);
12560: if ($checkinc || $checkexc) {
12561: my ($extension) = ($item =~ /\.(\w+)$/);
12562: if ($checkinc) {
12563: next unless ($extension && $include->{$extension});
12564: }
12565: if ($checkexc) {
12566: next if ($extension && $exclude->{$extension});
12567: }
12568: }
1.1505 raeburn 12569: if (($relpath eq '') && (!exists($dirhashref->{'/'}))) {
1.1503 raeburn 12570: $dirhashref->{'/'} = 1;
12571: }
12572: if ($savefile) {
12573: if ($relpath eq '') {
12574: $filehashref->{'/'}{$item} = 1;
12575: } else {
1.1313 raeburn 12576: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
12577: }
12578: }
1.1503 raeburn 12579: $filecount ++;
1.1313 raeburn 12580: }
12581: }
12582: closedir($dirh);
12583: }
12584: } else {
12585: my ($dirlistref,$listerror) =
12586: &dirlist($toppath.$relpath);
12587: my @dir_lines;
12588: my $dirptr=16384;
12589: if (ref($dirlistref) eq 'ARRAY') {
1.1503 raeburn 12590: my $filecount = 0;
1.1313 raeburn 12591: foreach my $dir_line (sort
12592: {
12593: my ($afile)=split('&',$a,2);
12594: my ($bfile)=split('&',$b,2);
12595: return (lc($afile) cmp lc($bfile));
12596: } (@{$dirlistref})) {
12597: my ($item,$dom,undef,$testdir,undef,undef,undef,undef,$size,undef,$mtime,undef,undef,undef,$obs,undef) =
12598: split(/\&/,$dir_line,16);
12599: $item =~ s/\s+$//;
12600: next if (($item =~ /^\.\.?$/) || ($obs));
12601: if ($dirptr&$testdir) {
12602: my $newpath;
12603: if ($relpath) {
12604: $newpath = "$relpath/$item";
12605: } else {
12606: $newpath = $item;
12607: }
12608: $dirhashref->{&Apache::lonlocal::js_escape($newpath)} = 1;
1.1503 raeburn 12609: if ($recurse) {
1.1505 raeburn 12610: &recursedirs($is_home,$recurse,$include,$exclude,$nonemptydir,$addtopdir,$toppath,$newpath,$dirhashref,$filehashref);
1.1503 raeburn 12611: }
12612: } elsif (($savefile) || ($relpath eq '')) {
12613: next if ($nonemptydir && $filecount);
12614: if ($checkinc || $checkexc) {
12615: my $extension;
12616: if ($checkinc) {
12617: next unless ($extension && $include->{$extension});
12618: }
12619: if ($checkexc) {
12620: next if ($extension && $exclude->{$extension});
12621: }
12622: }
12623: if (($relpath eq '') && (!exists($dirhashref->{'/'}))) {
12624: $dirhashref->{'/'} = 1;
12625: }
12626: if ($savefile) {
12627: if ($relpath eq '') {
12628: $filehashref->{'/'}{$item} = 1;
12629: } else {
12630: $filehashref->{&Apache::lonlocal::js_escape($relpath)}{$item} = 1;
1.1313 raeburn 12631: }
12632: }
1.1503 raeburn 12633: $filecount ++;
1.1313 raeburn 12634: }
12635: }
12636: }
12637: }
1.1505 raeburn 12638: if ($addtopdir) {
12639: if (($relpath eq '') && (!exists($dirhashref->{'/'}))) {
12640: $dirhashref->{'/'} = 1;
12641: }
12642: }
1.1313 raeburn 12643: return;
12644: }
12645:
1.1503 raeburn 12646: sub priv_exclude {
12647: return {
12648: meta => 1,
12649: save => 1,
12650: log => 1,
12651: bak => 1,
12652: rights => 1,
12653: DS_Store => 1,
12654: };
12655: }
12656:
1.26 www 12657: # -------------------------------------------------------- Value of a Condition
12658:
1.713 albertel 12659: # gets the value of a specific preevaluated condition
12660: # stored in the string $env{user.state.<cid>}
12661: # or looks up a condition reference in the bighash and if if hasn't
12662: # already been evaluated recurses into docondval to get the value of
12663: # the condition, then memoizing it to
12664: # $env{user.state.<cid>.<condition>}
1.40 www 12665: sub directcondval {
12666: my $number=shift;
1.620 albertel 12667: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 12668: &Apache::lonuserstate::evalstate();
12669: }
1.713 albertel 12670: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
12671: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
12672: } elsif ($number =~ /^_/) {
12673: my $sub_condition;
12674: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
12675: &GDBM_READER(),0640)) {
12676: $sub_condition=$bighash{'conditions'.$number};
12677: untie(%bighash);
12678: }
12679: my $value = &docondval($sub_condition);
1.949 raeburn 12680: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 12681: return $value;
12682: }
1.620 albertel 12683: if ($env{'user.state.'.$env{'request.course.id'}}) {
12684: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 12685: } else {
12686: return 2;
12687: }
12688: }
12689:
1.713 albertel 12690: # get the collection of conditions for this resource
1.26 www 12691: sub condval {
12692: my $condidx=shift;
1.54 www 12693: my $allpathcond='';
1.713 albertel 12694: foreach my $cond (split(/\|/,$condidx)) {
12695: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
12696: $allpathcond.=
12697: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
12698: }
1.191 harris41 12699: }
1.54 www 12700: $allpathcond=~s/\|$//;
1.713 albertel 12701: return &docondval($allpathcond);
12702: }
12703:
12704: #evaluates an expression of conditions
12705: sub docondval {
12706: my ($allpathcond) = @_;
12707: my $result=0;
12708: if ($env{'request.course.id'}
12709: && defined($allpathcond)) {
12710: my $operand='|';
12711: my @stack;
12712: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
12713: if ($chunk eq '(') {
12714: push @stack,($operand,$result);
12715: } elsif ($chunk eq ')') {
12716: my $before=pop @stack;
12717: if (pop @stack eq '&') {
12718: $result=$result>$before?$before:$result;
12719: } else {
12720: $result=$result>$before?$result:$before;
12721: }
12722: } elsif (($chunk eq '&') || ($chunk eq '|')) {
12723: $operand=$chunk;
12724: } else {
12725: my $new=directcondval($chunk);
12726: if ($operand eq '&') {
12727: $result=$result>$new?$new:$result;
12728: } else {
12729: $result=$result>$new?$result:$new;
12730: }
12731: }
12732: }
1.26 www 12733: }
12734: return $result;
1.421 albertel 12735: }
12736:
12737: # ---------------------------------------------------- Devalidate courseresdata
12738:
12739: sub devalidatecourseresdata {
12740: my ($coursenum,$coursedomain)=@_;
12741: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12742: &devalidate_cache_new('courseres',$hashid);
1.28 www 12743: }
12744:
1.763 www 12745:
1.200 www 12746: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 12747: #
12748: # Parameters:
12749: # $coursenum - Number of the course.
12750: # $coursedomain - Domain at which the course was created.
12751: # Returns:
12752: # A hash of the course parameters along (I think) with timestamps
12753: # and version info.
1.877 foxr 12754:
1.624 albertel 12755: sub get_courseresdata {
12756: my ($coursenum,$coursedomain)=@_;
1.200 www 12757: my $coursehom=&homeserver($coursenum,$coursedomain);
12758: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 12759: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 12760: my %dumpreply;
1.417 albertel 12761: unless (defined($cached)) {
1.624 albertel 12762: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 12763: $result=\%dumpreply;
1.251 albertel 12764: my ($tmp) = keys(%dumpreply);
12765: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 12766: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 12767: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
12768: return $tmp;
1.416 albertel 12769: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 12770: $result=undef;
1.599 albertel 12771: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 12772: }
12773: }
1.624 albertel 12774: return $result;
12775: }
12776:
1.633 albertel 12777: sub devalidateuserresdata {
12778: my ($uname,$udom)=@_;
12779: my $hashid="$udom:$uname";
12780: &devalidate_cache_new('userres',$hashid);
12781: }
12782:
1.624 albertel 12783: sub get_userresdata {
12784: my ($uname,$udom)=@_;
12785: #most student don\'t have any data set, check if there is some data
12786: if (&EXT_cache_status($udom,$uname)) { return undef; }
12787:
12788: my $hashid="$udom:$uname";
12789: my ($result,$cached)=&is_cached_new('userres',$hashid);
12790: if (!defined($cached)) {
12791: my %resourcedata=&dump('resourcedata',$udom,$uname);
12792: $result=\%resourcedata;
12793: &do_cache_new('userres',$hashid,$result,600);
12794: }
12795: my ($tmp)=keys(%$result);
12796: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
12797: return $result;
12798: }
12799: #error 2 occurs when the .db doesn't exist
12800: if ($tmp!~/error: 2 /) {
1.1294 raeburn 12801: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
12802: &logthis("<font color=\"blue\">WARNING:".
12803: " Trying to get resource data for ".
12804: $uname." at ".$udom.": ".
12805: $tmp."</font>");
12806: }
1.624 albertel 12807: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 12808: #&EXT_cache_set($udom,$uname);
12809: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 12810: undef($tmp); # not really an error so don't send it back
1.624 albertel 12811: }
12812: return $tmp;
12813: }
1.879 foxr 12814: #----------------------------------------------- resdata - return resource data
12815: # Purpose:
12816: # Return resource data for either users or for a course.
12817: # Parameters:
12818: # $name - Course/user name.
12819: # $domain - Name of the domain the user/course is registered on.
1.1311 raeburn 12820: # $type - Type of thing $name is (must be 'course' or 'user')
1.1301 raeburn 12821: # $mapp - decluttered URL of enclosing map
12822: # $recursed - Ref to scalar -- set to 1, if nested maps have been recursed.
12823: # $recurseup - Ref to array of map URLs, starting with map containing
12824: # $mapp up through hierarchy of nested maps to top level map.
12825: # $courseid - CourseID (first part of param identifier).
12826: # $modifier - Middle part of param identifier.
12827: # $what - Last part of param identifier.
1.879 foxr 12828: # @which - Array of names of resources desired.
12829: # Returns:
12830: # The value of the first reasource in @which that is found in the
12831: # resource hash.
12832: # Exceptional Conditions:
12833: # If the $type passed in is not valid (not the string 'course' or
12834: # 'user', an undefined reference is returned.
12835: # If none of the resources are found, an undef is returned
1.624 albertel 12836: sub resdata {
1.1301 raeburn 12837: my ($name,$domain,$type,$mapp,$recursed,$recurseup,$courseid,
12838: $modifier,$what,@which)=@_;
1.624 albertel 12839: my $result;
12840: if ($type eq 'course') {
12841: $result=&get_courseresdata($name,$domain);
12842: } elsif ($type eq 'user') {
12843: $result=&get_userresdata($name,$domain);
12844: }
12845: if (!ref($result)) { return $result; }
1.251 albertel 12846: foreach my $item (@which) {
1.1301 raeburn 12847: if ($item->[1] eq 'course') {
12848: if ((ref($recurseup) eq 'ARRAY') && (ref($recursed) eq 'SCALAR')) {
12849: unless ($$recursed) {
1.1302 raeburn 12850: @{$recurseup} = &get_map_hierarchy($mapp,$courseid);
1.1301 raeburn 12851: $$recursed = 1;
12852: }
12853: foreach my $item (@${recurseup}) {
12854: my $norecursechk=$courseid.$modifier.$item.'___(all).'.$what;
12855: last if (defined($result->{$norecursechk}));
12856: my $recursechk=$courseid.$modifier.$item.'___(rec).'.$what;
12857: if (defined($result->{$recursechk})) { return [$result->{$recursechk},'map']; }
12858: }
12859: }
12860: }
12861: if (defined($result->{$item->[0]})) {
1.927 albertel 12862: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 12863: }
1.250 albertel 12864: }
1.291 albertel 12865: return undef;
1.200 www 12866: }
12867:
1.1360 raeburn 12868: sub get_domain_lti {
12869: my ($cdom,$context) = @_;
1.1483 raeburn 12870: my ($name,$cachename,%lti);
1.1360 raeburn 12871: if ($context eq 'consumer') {
12872: $name = 'ltitools';
12873: } elsif ($context eq 'provider') {
12874: $name = 'lti';
1.1483 raeburn 12875: } elsif ($context eq 'linkprot') {
12876: $name = 'ltisec';
1.1360 raeburn 12877: } else {
12878: return %lti;
12879: }
1.1483 raeburn 12880: if ($context eq 'linkprot') {
12881: $cachename = $context;
12882: } else {
12883: $cachename = $name;
12884: }
12885: my ($result,$cached)=&is_cached_new($cachename,$cdom);
1.1298 raeburn 12886: if (defined($cached)) {
12887: if (ref($result) eq 'HASH') {
1.1360 raeburn 12888: %lti = %{$result};
1.1298 raeburn 12889: }
12890: } else {
1.1360 raeburn 12891: my %domconfig = &get_dom('configuration',[$name],$cdom);
12892: if (ref($domconfig{$name}) eq 'HASH') {
1.1483 raeburn 12893: if ($context eq 'linkprot') {
12894: if (ref($domconfig{$name}{'linkprot'}) eq 'HASH') {
12895: %lti = %{$domconfig{$name}{'linkprot'}};
12896: }
12897: } else {
12898: %lti = %{$domconfig{$name}};
12899: }
1.1298 raeburn 12900: }
12901: my $cachetime = 24*60*60;
1.1483 raeburn 12902: &do_cache_new($cachename,$cdom,\%lti,$cachetime);
1.1298 raeburn 12903: }
1.1360 raeburn 12904: return %lti;
1.1298 raeburn 12905: }
12906:
1.1463 raeburn 12907: sub get_course_lti {
1.1510 raeburn 12908: my ($cnum,$cdom,$context) = @_;
12909: my ($name,$cachename,%lti);
12910: if ($context eq 'consumer') {
12911: $name = 'ltitools';
12912: $cachename = 'courseltitools';
12913: } elsif ($context eq 'provider') {
12914: $name = 'lti';
12915: $cachename = 'courselti';
12916: } else {
12917: return %lti;
12918: }
1.1463 raeburn 12919: my $hashid=$cdom.'_'.$cnum;
1.1510 raeburn 12920: my ($result,$cached)=&is_cached_new($cachename,$hashid);
1.1463 raeburn 12921: if (defined($cached)) {
12922: if (ref($result) eq 'HASH') {
1.1510 raeburn 12923: %lti = %{$result};
1.1463 raeburn 12924: }
12925: } else {
1.1510 raeburn 12926: %lti = &dump($name,$cdom,$cnum,undef,undef,undef,1);
1.1463 raeburn 12927: my $cachetime = 24*60*60;
1.1510 raeburn 12928: &do_cache_new($cachename,$hashid,\%lti,$cachetime);
1.1463 raeburn 12929: }
1.1510 raeburn 12930: return %lti;
1.1463 raeburn 12931: }
12932:
1.1479 raeburn 12933: sub courselti_itemid {
12934: my ($cnum,$cdom,$url,$method,$params,$context) = @_;
12935: my ($chome,$itemid);
12936: $chome = &homeserver($cnum,$cdom);
12937: return if ($chome eq 'no_host');
12938: if (ref($params) eq 'HASH') {
12939: my $rep;
12940: if (grep { $_ eq $chome } current_machine_ids()) {
12941: $rep = LONCAPA::Lond::crslti_itemid($cdom,$cnum,$url,$method,$params,$perlvar{'lonVersion'});
12942: } else {
12943: my $escurl = &escape($url);
12944: my $escmethod = &escape($method);
12945: my $items = &freeze_escape($params);
12946: $rep = &reply("encrypt:lti:$cdom:$cnum:$context:$escurl:$escmethod:$items",$chome);
12947: }
12948: unless (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
12949: ($rep eq 'unknown_cmd')) {
12950: $itemid = $rep;
12951: }
12952: }
12953: return $itemid;
12954: }
12955:
12956: sub domainlti_itemid {
12957: my ($cdom,$url,$method,$params,$context) = @_;
12958: my ($primary_id,$itemid);
12959: $primary_id = &domain($cdom,'primary');
12960: return if ($primary_id eq '');
12961: if (ref($params) eq 'HASH') {
12962: my $rep;
12963: if (grep { $_ eq $primary_id } current_machine_ids()) {
12964: $rep = LONCAPA::Lond::domlti_itemid($cdom,$context,$url,$method,$params,$perlvar{'lonVersion'});
12965: } else {
12966: my $cnum = '';
12967: my $escurl = &escape($url);
12968: my $escmethod = &escape($method);
12969: my $items = &freeze_escape($params);
12970: $rep = &reply("encrypt:lti:$cdom:$cnum:$context:$escurl:$escmethod:$items",$primary_id);
12971: }
12972: unless (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
12973: ($rep eq 'unknown_cmd')) {
12974: $itemid = $rep;
12975: }
12976: }
12977: return $itemid;
12978: }
12979:
1.1513 raeburn 12980: sub get_ltitools_id {
12981: my ($context,$cdom,$cnum,$title) = @_;
12982: my ($lockhash,$tries,$gotlock,$id,$error);
12983:
12984: # get lock on ltitools db
12985: $lockhash = {
12986: lock => $env{'user.name'}.
12987: ':'.$env{'user.domain'},
12988: };
12989: $tries = 0;
12990: if ($context eq 'domain') {
12991: $gotlock = &newput_dom('ltitools',$lockhash,$cdom);
12992: } else {
12993: $gotlock = &newput('ltitools',$lockhash,$cdom,$cnum);
12994: }
12995: while (($gotlock ne 'ok') && ($tries<10)) {
12996: $tries ++;
12997: sleep (0.1);
12998: if ($context eq 'domain') {
12999: $gotlock = &newput_dom('ltitools',$lockhash,$cdom);
13000: } else {
13001: $gotlock = &newput('ltitools',$lockhash,$cdom,$cnum);
13002: }
13003: }
13004: if ($gotlock eq 'ok') {
13005: my %currids;
13006: if ($context eq 'domain') {
13007: %currids = &dump_dom('ltitools',$cdom);
13008: } else {
13009: %currids = &dump('ltitools',$cdom,$cnum);
13010: }
13011: if ($currids{'lock'}) {
13012: delete($currids{'lock'});
13013: if (keys(%currids)) {
13014: my @curr = sort { $a <=> $b } keys(%currids);
13015: if ($curr[-1] =~ /^\d+$/) {
13016: $id = 1 + $curr[-1];
13017: }
13018: } else {
13019: $id = 1;
13020: }
13021: if ($id) {
13022: if ($context eq 'domain') {
13023: unless (&newput_dom('ltitools',{ $id => $title },$cdom) eq 'ok') {
13024: $error = 'nostore';
13025: }
13026: } else {
13027: unless (&newput('ltitools',{ $id => $title },$cdom,$cnum) eq 'ok') {
13028: $error = 'nostore';
13029: }
13030: }
13031: } else {
13032: $error = 'nonumber';
13033: }
13034: }
13035: my $dellockoutcome;
13036: if ($context eq 'domain') {
13037: $dellockoutcome = &del_dom('ltitools',['lock'],$cdom);
13038: } else {
13039: $dellockoutcome = &del('ltitools',['lock'],$cdom,$cnum);
13040: }
13041: } else {
13042: $error = 'nolock';
13043: }
13044: return ($id,$error);
13045: }
13046:
1.1496 raeburn 13047: sub count_supptools {
13048: my ($cnum,$cdom,$ignorecache,$reload)=@_;
13049: my $hashid=$cnum.':'.$cdom;
13050: my ($numexttools,$cached);
13051: unless ($ignorecache) {
13052: ($numexttools,$cached) = &is_cached_new('supptools',$hashid);
13053: }
13054: unless (defined($cached)) {
13055: my $chome=&homeserver($cnum,$cdom);
13056: $numexttools = 0;
13057: unless ($chome eq 'no_host') {
1.1500 raeburn 13058: my ($supplemental) = &Apache::loncommon::get_supplemental($cnum,$cdom,$reload);
1.1496 raeburn 13059: if (ref($supplemental) eq 'HASH') {
13060: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
13061: foreach my $key (keys(%{$supplemental->{'ids'}})) {
13062: if ($key =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
13063: $numexttools ++;
13064: }
13065: }
13066: }
13067: }
13068: }
13069: &do_cache_new('supptools',$hashid,$numexttools,600);
13070: }
13071: return $numexttools;
13072: }
13073:
13074: sub has_unhidden_suppfiles {
1.1498 raeburn 13075: my ($cnum,$cdom,$ignorecache,$possdel)=@_;
1.1236 raeburn 13076: my $hashid=$cnum.':'.$cdom;
1.1496 raeburn 13077: my ($showsupp,$cached);
1.1236 raeburn 13078: unless ($ignorecache) {
1.1496 raeburn 13079: ($showsupp,$cached) = &is_cached_new('showsupp',$hashid);
1.1236 raeburn 13080: }
13081: unless (defined($cached)) {
13082: my $chome=&homeserver($cnum,$cdom);
13083: unless ($chome eq 'no_host') {
1.1500 raeburn 13084: my ($supplemental) = &Apache::loncommon::get_supplemental($cnum,$cdom,$ignorecache,$possdel);
1.1496 raeburn 13085: if (ref($supplemental) eq 'HASH') {
13086: if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
13087: foreach my $key (keys(%{$supplemental->{'ids'}})) {
13088: next if ($key =~ /\.sequence$/);
13089: if (ref($supplemental->{'ids'}->{$key}) eq 'ARRAY') {
13090: foreach my $id (@{$supplemental->{'ids'}->{$key}}) {
13091: unless ($supplemental->{'hidden'}->{$id}) {
13092: $showsupp = 1;
13093: last;
13094: }
13095: }
13096: }
13097: last if ($showsupp);
13098: }
13099: }
13100: }
1.1236 raeburn 13101: }
1.1496 raeburn 13102: &do_cache_new('showsupp',$hashid,$showsupp,600);
1.1236 raeburn 13103: }
1.1496 raeburn 13104: return $showsupp;
13105: }
13106:
1.379 matthew 13107: #
13108: # EXT resource caching routines
13109: #
13110:
1.1302 raeburn 13111: {
13112: # Cache (5 seconds) of map hierarchy for speedup of navmaps display
13113: #
13114: # The course for which we cache
13115: my $cachedmapkey='';
13116: # The cached recursive maps for this course
13117: my %cachedmaps=();
13118: # When this was last done
13119: my $cachedmaptime='';
13120:
1.379 matthew 13121: sub clear_EXT_cache_status {
1.383 albertel 13122: &delenv('cache.EXT.');
1.379 matthew 13123: }
13124:
13125: sub EXT_cache_status {
13126: my ($target_domain,$target_user) = @_;
1.383 albertel 13127: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 13128: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 13129: # We know already the user has no data
13130: return 1;
13131: } else {
13132: return 0;
13133: }
13134: }
13135:
13136: sub EXT_cache_set {
13137: my ($target_domain,$target_user) = @_;
1.383 albertel 13138: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 13139: #&appenv({$cachename => time});
1.379 matthew 13140: }
13141:
1.28 www 13142: # --------------------------------------------------------- Value of a Variable
1.58 www 13143: sub EXT {
1.715 albertel 13144:
1.1461 raeburn 13145: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid,$recurseupref)=@_;
1.68 www 13146: unless ($varname) { return ''; }
1.218 albertel 13147: #get real user name/domain, courseid and symb
13148: my $courseid;
1.359 albertel 13149: my $publicuser;
1.427 www 13150: if ($symbparm) {
13151: $symbparm=&get_symb_from_alias($symbparm);
13152: }
1.218 albertel 13153: if (!($uname && $udom)) {
1.790 albertel 13154: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 13155: if (!$symbparm) { $symbparm=$cursymb; }
13156: } else {
1.620 albertel 13157: $courseid=$env{'request.course.id'};
1.218 albertel 13158: }
1.48 www 13159: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
13160: my $rest;
1.320 albertel 13161: if (defined($therest[0])) {
1.48 www 13162: $rest=join('.',@therest);
13163: } else {
13164: $rest='';
13165: }
1.320 albertel 13166:
1.57 www 13167: my $qualifierrest=$qualifier;
13168: if ($rest) { $qualifierrest.='.'.$rest; }
13169: my $spacequalifierrest=$space;
13170: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 13171: if ($realm eq 'user') {
1.48 www 13172: # --------------------------------------------------------------- user.resource
13173: if ($space eq 'resource') {
1.651 albertel 13174: if ( (defined($Apache::lonhomework::parsing_a_problem)
13175: || defined($Apache::lonhomework::parsing_a_task))
13176: &&
1.1469 raeburn 13177: ($symbparm eq &symbread()) ) {
1.744 albertel 13178: # if we are in the middle of processing the resource the
13179: # get the value we are planning on committing
13180: if (defined($Apache::lonhomework::results{$qualifierrest})) {
13181: return $Apache::lonhomework::results{$qualifierrest};
13182: } else {
13183: return $Apache::lonhomework::history{$qualifierrest};
13184: }
1.335 albertel 13185: } else {
1.359 albertel 13186: my %restored;
1.620 albertel 13187: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 13188: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
13189: } else {
13190: %restored=&restore($symbparm,$courseid,$udom,$uname);
13191: }
1.335 albertel 13192: return $restored{$qualifierrest};
13193: }
1.48 www 13194: # ----------------------------------------------------------------- user.access
13195: } elsif ($space eq 'access') {
1.218 albertel 13196: # FIXME - not supporting calls for a specific user
1.48 www 13197: return &allowed($qualifier,$rest);
13198: # ------------------------------------------ user.preferences, user.environment
13199: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 13200: if (($uname eq $env{'user.name'}) &&
13201: ($udom eq $env{'user.domain'})) {
13202: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 13203: } else {
1.359 albertel 13204: my %returnhash;
13205: if (!$publicuser) {
13206: %returnhash=&userenvironment($udom,$uname,
13207: $qualifierrest);
13208: }
1.218 albertel 13209: return $returnhash{$qualifierrest};
13210: }
1.48 www 13211: # ----------------------------------------------------------------- user.course
13212: } elsif ($space eq 'course') {
1.218 albertel 13213: # FIXME - not supporting calls for a specific user
1.620 albertel 13214: return $env{join('.',('request.course',$qualifier))};
1.48 www 13215: # ------------------------------------------------------------------- user.role
13216: } elsif ($space eq 'role') {
1.218 albertel 13217: # FIXME - not supporting calls for a specific user
1.620 albertel 13218: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 13219: if ($qualifier eq 'value') {
13220: return $role;
13221: } elsif ($qualifier eq 'extent') {
13222: return $where;
13223: }
13224: # ----------------------------------------------------------------- user.domain
13225: } elsif ($space eq 'domain') {
1.218 albertel 13226: return $udom;
1.48 www 13227: # ------------------------------------------------------------------- user.name
13228: } elsif ($space eq 'name') {
1.218 albertel 13229: return $uname;
1.48 www 13230: # ---------------------------------------------------- Any other user namespace
1.29 www 13231: } else {
1.359 albertel 13232: my %reply;
13233: if (!$publicuser) {
13234: %reply=&get($space,[$qualifierrest],$udom,$uname);
13235: }
13236: return $reply{$qualifierrest};
1.48 www 13237: }
1.236 www 13238: } elsif ($realm eq 'query') {
13239: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 13240: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
13241: [$spacequalifierrest]);
1.620 albertel 13242: return $env{'form.'.$spacequalifierrest};
1.236 www 13243: } elsif ($realm eq 'request') {
1.48 www 13244: # ------------------------------------------------------------- request.browser
13245: if ($space eq 'browser') {
1.1145 bisitz 13246: return $env{'browser.'.$qualifier};
1.57 www 13247: # ------------------------------------------------------------ request.filename
13248: } else {
1.620 albertel 13249: return $env{'request.'.$spacequalifierrest};
1.29 www 13250: }
1.28 www 13251: } elsif ($realm eq 'course') {
1.48 www 13252: # ---------------------------------------------------------- course.description
1.620 albertel 13253: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 13254: } elsif ($realm eq 'resource') {
1.165 www 13255:
1.620 albertel 13256: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 13257: if (!$symbparm) { $symbparm=&symbread(); }
13258: }
1.693 albertel 13259:
1.1232 raeburn 13260: if ($qualifier eq '') {
13261: if ($space eq 'title') {
13262: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
13263: return &gettitle($symbparm);
13264: }
1.693 albertel 13265:
1.1232 raeburn 13266: if ($space eq 'map') {
13267: my ($map) = &decode_symb($symbparm);
13268: return &symbread($map);
13269: }
13270: if ($space eq 'maptitle') {
13271: my ($map) = &decode_symb($symbparm);
13272: return &gettitle($map);
13273: }
13274: if ($space eq 'filename') {
13275: if ($symbparm) {
13276: return &clutter((&decode_symb($symbparm))[2]);
13277: }
13278: return &hreflocation('',$env{'request.filename'});
1.905 albertel 13279: }
1.1232 raeburn 13280:
1.1233 raeburn 13281: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
13282: if ($space eq 'visibleparts') {
13283: my $navmap = Apache::lonnavmaps::navmap->new();
13284: my $item;
13285: if (ref($navmap)) {
13286: my $res = $navmap->getBySymb($symbparm);
13287: my $parts = $res->parts();
13288: if (ref($parts) eq 'ARRAY') {
13289: $item = join(',',@{$parts});
13290: }
13291: undef($navmap);
1.1232 raeburn 13292: }
1.1233 raeburn 13293: return $item;
1.1232 raeburn 13294: }
13295: }
13296: }
1.693 albertel 13297:
1.1301 raeburn 13298: my ($section, $group, @groups, @recurseup, $recursed);
1.1461 raeburn 13299: if (ref($recurseupref) eq 'ARRAY') {
13300: @recurseup = @{$recurseupref};
13301: $recursed = 1;
13302: }
1.1301 raeburn 13303: my ($courselevelm,$courseleveli,$courselevel,$mapp);
1.1228 raeburn 13304: if (($courseid eq '') && ($cid)) {
13305: $courseid = $cid;
13306: }
13307: if (($symbparm && $courseid) &&
13308: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 13309:
1.218 albertel 13310: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 13311:
1.60 www 13312: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 13313: my $symbp=$symbparm;
1.1301 raeburn 13314: $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 13315: my $symbparm=$symbp.'.'.$spacequalifierrest;
1.1301 raeburn 13316: my $recurseparm=$mapp.'___(rec).'.$spacequalifierrest;
1.218 albertel 13317: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
1.620 albertel 13318: if (($env{'user.name'} eq $uname) &&
13319: ($env{'user.domain'} eq $udom)) {
13320: $section=$env{'request.course.sec'};
1.733 raeburn 13321: @groups = split(/:/,$env{'request.course.groups'});
13322: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 13323: } else {
1.539 albertel 13324: if (! defined($usection)) {
1.551 albertel 13325: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 13326: } else {
13327: $section = $usection;
13328: }
1.733 raeburn 13329: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 13330: }
13331:
13332: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
13333: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
1.1301 raeburn 13334: my $secleveli=$courseid.'.['.$section.'].'.$recurseparm;
1.218 albertel 13335: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
13336:
1.593 albertel 13337: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 13338: my $courselevelr=$courseid.'.'.$symbparm;
1.1301 raeburn 13339: $courseleveli=$courseid.'.'.$recurseparm;
1.593 albertel 13340: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 13341:
1.60 www 13342: # ----------------------------------------------------------- first, check user
1.624 albertel 13343:
1.1301 raeburn 13344: my $userreply=&resdata($uname,$udom,'user',$mapp,\$recursed,
13345: \@recurseup,$courseid,'.',$spacequalifierrest,
1.927 albertel 13346: ([$courselevelr,'resource'],
13347: [$courselevelm,'map' ],
1.1301 raeburn 13348: [$courseleveli,'map' ],
1.927 albertel 13349: [$courselevel, 'course' ]));
1.931 albertel 13350: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 13351:
1.594 albertel 13352: # ------------------------------------------------ second, check some of course
1.684 raeburn 13353: my $coursereply;
1.691 raeburn 13354: if (@groups > 0) {
13355: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
1.1301 raeburn 13356: $recurseparm,$mapparm,$spacequalifierrest,
13357: $mapp,\$recursed,\@recurseup);
13358: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 13359: }
1.96 www 13360:
1.684 raeburn 13361: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 13362: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 13363: 'course',$mapp,\$recursed,\@recurseup,
13364: $courseid,'.['.$section.'].',$spacequalifierrest,
1.927 albertel 13365: ([$seclevelr, 'resource'],
13366: [$seclevelm, 'map' ],
1.1301 raeburn 13367: [$secleveli, 'map' ],
1.927 albertel 13368: [$seclevel, 'course' ],
13369: [$courselevelr,'resource']));
13370: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 13371:
1.60 www 13372: # ------------------------------------------------------ third, check map parms
1.218 albertel 13373: my %parmhash=();
13374: my $thisparm='';
13375: if (tie(%parmhash,'GDBM_File',
1.620 albertel 13376: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 13377: &GDBM_READER(),0640)) {
1.218 albertel 13378: $thisparm=$parmhash{$symbparm};
13379: untie(%parmhash);
13380: }
1.927 albertel 13381: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 13382: }
1.594 albertel 13383: # ------------------------------------------ fourth, look in resource metadata
1.1301 raeburn 13384:
13385: my $what = $spacequalifierrest;
13386: $what=~s/\./\_/;
1.282 albertel 13387: my $filename;
13388: if (!$symbparm) { $symbparm=&symbread(); }
13389: if ($symbparm) {
1.409 www 13390: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 13391: } else {
1.620 albertel 13392: $filename=$env{'request.filename'};
1.282 albertel 13393: }
1.1362 raeburn 13394: my $toolsymb;
13395: if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
13396: $toolsymb = $symbparm;
13397: }
13398: my $metadata=&metadata($filename,$what,$toolsymb);
1.927 albertel 13399: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.1362 raeburn 13400: $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
1.927 albertel 13401: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 13402:
1.1301 raeburn 13403: # ----------------------------------------------- fifth, look in rest of course
1.593 albertel 13404: if ($symbparm && defined($courseid) &&
1.620 albertel 13405: $courseid eq $env{'request.course.id'}) {
1.624 albertel 13406: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
13407: $env{'course.'.$courseid.'.domain'},
1.1301 raeburn 13408: 'course',$mapp,\$recursed,\@recurseup,
13409: $courseid,'.',$spacequalifierrest,
1.927 albertel 13410: ([$courselevelm,'map' ],
1.1301 raeburn 13411: [$courseleveli,'map' ],
1.927 albertel 13412: [$courselevel, 'course']));
13413: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 13414: }
1.145 www 13415: # ------------------------------------------------------------------ Cascade up
1.218 albertel 13416: unless ($space eq '0') {
1.336 albertel 13417: my @parts=split(/_/,$space);
13418: my $id=pop(@parts);
13419: my $part=join('_',@parts);
13420: if ($part eq '') { $part='0'; }
1.927 albertel 13421: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 13422: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 13423: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 13424: }
1.395 albertel 13425: if ($recurse) { return undef; }
1.1362 raeburn 13426: my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
1.927 albertel 13427: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 13428: # ---------------------------------------------------- Any other user namespace
13429: } elsif ($realm eq 'environment') {
13430: # ----------------------------------------------------------------- environment
1.620 albertel 13431: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
13432: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 13433: } else {
1.770 albertel 13434: if ($uname eq 'anonymous' && $udom eq '') {
13435: return '';
13436: }
1.219 albertel 13437: my %returnhash=&userenvironment($udom,$uname,
13438: $spacequalifierrest);
13439: return $returnhash{$spacequalifierrest};
13440: }
1.28 www 13441: } elsif ($realm eq 'system') {
1.48 www 13442: # ----------------------------------------------------------------- system.time
13443: if ($space eq 'time') {
13444: return time;
13445: }
1.696 albertel 13446: } elsif ($realm eq 'server') {
13447: # ----------------------------------------------------------------- system.time
13448: if ($space eq 'name') {
13449: return $ENV{'SERVER_NAME'};
13450: }
1.1415 raeburn 13451: } elsif ($realm eq 'client') {
13452: if ($space eq 'remote_addr') {
1.1441 raeburn 13453: return &get_requestor_ip();
1.1415 raeburn 13454: }
1.28 www 13455: }
1.48 www 13456: return '';
1.61 www 13457: }
13458:
1.927 albertel 13459: sub get_reply {
13460: my ($reply_value) = @_;
1.940 raeburn 13461: if (ref($reply_value) eq 'ARRAY') {
13462: if (wantarray) {
13463: return @$reply_value;
13464: }
13465: return $reply_value->[0];
13466: } else {
13467: return $reply_value;
1.927 albertel 13468: }
13469: }
13470:
1.691 raeburn 13471: sub check_group_parms {
1.1301 raeburn 13472: my ($courseid,$groups,$symbparm,$recurseparm,$mapparm,$what,$mapp,
13473: $recursed,$recurseupref) = @_;
13474: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$recurseparm,'map'],
13475: [$what,'course']);
13476: my $coursereply;
1.691 raeburn 13477: foreach my $group (@{$groups}) {
1.1301 raeburn 13478: my @groupitems = ();
1.691 raeburn 13479: foreach my $level (@levels) {
1.927 albertel 13480: my $item = $courseid.'.['.$group.'].'.$level->[0];
13481: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 13482: }
1.1301 raeburn 13483: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
13484: $env{'course.'.$courseid.'.domain'},
13485: 'course',$mapp,$recursed,$recurseupref,
13486: $courseid,'.['.$group.'].',$what,
13487: @groupitems);
13488: last if (defined($coursereply));
1.691 raeburn 13489: }
13490: return $coursereply;
13491: }
13492:
1.1301 raeburn 13493: sub get_map_hierarchy {
1.1302 raeburn 13494: my ($mapname,$courseid) = @_;
13495: my @recurseup = ();
1.1301 raeburn 13496: if ($mapname) {
1.1302 raeburn 13497: if (($cachedmapkey eq $courseid) &&
13498: (abs($cachedmaptime-time)<5)) {
13499: if (ref($cachedmaps{$mapname}) eq 'ARRAY') {
13500: return @{$cachedmaps{$mapname}};
13501: }
13502: }
1.1301 raeburn 13503: my $navmap = Apache::lonnavmaps::navmap->new();
13504: if (ref($navmap)) {
13505: @recurseup = $navmap->recurseup_maps($mapname);
13506: undef($navmap);
1.1302 raeburn 13507: $cachedmaps{$mapname} = \@recurseup;
13508: $cachedmaptime=time;
13509: $cachedmapkey=$courseid;
1.1301 raeburn 13510: }
13511: }
13512: return @recurseup;
13513: }
13514:
1.1302 raeburn 13515: }
13516:
1.691 raeburn 13517: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 13518: my ($courseid,@groups) = @_;
13519: @groups = sort(@groups);
1.691 raeburn 13520: return @groups;
13521: }
13522:
1.395 albertel 13523: sub packages_tab_default {
1.1362 raeburn 13524: my ($uri,$varname,$toolsymb)=@_;
1.395 albertel 13525: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 13526:
13527: my (@extension,@specifics,$do_default);
1.1362 raeburn 13528: foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
1.395 albertel 13529: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 13530: if ($pack_type eq 'default') {
13531: $do_default=1;
13532: } elsif ($pack_type eq 'extension') {
13533: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 13534: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 13535: # only look at packages defaults for packages that this id is
1.738 albertel 13536: push(@specifics,[$package,$pack_type,$pack_part]);
13537: }
13538: }
13539: # first look for a package that matches the requested part id
13540: foreach my $package (@specifics) {
13541: my (undef,$pack_type,$pack_part)=@{$package};
13542: next if ($pack_part ne $part);
13543: if (defined($packagetab{"$pack_type&$name&default"})) {
13544: return $packagetab{"$pack_type&$name&default"};
13545: }
13546: }
13547: # look for any possible matching non extension_ package
13548: foreach my $package (@specifics) {
13549: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 13550: if (defined($packagetab{"$pack_type&$name&default"})) {
13551: return $packagetab{"$pack_type&$name&default"};
13552: }
1.585 albertel 13553: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 13554: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
13555: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 13556: }
13557: }
1.738 albertel 13558: # look for any posible extension_ match
13559: foreach my $package (@extension) {
13560: my ($package,$pack_type)=@{$package};
13561: if (defined($packagetab{"$pack_type&$name&default"})) {
13562: return $packagetab{"$pack_type&$name&default"};
13563: }
13564: if (defined($packagetab{$package."&$name&default"})) {
13565: return $packagetab{$package."&$name&default"};
13566: }
13567: }
13568: # look for a global default setting
13569: if ($do_default && defined($packagetab{"default&$name&default"})) {
13570: return $packagetab{"default&$name&default"};
13571: }
1.395 albertel 13572: return undef;
13573: }
13574:
1.334 albertel 13575: sub add_prefix_and_part {
13576: my ($prefix,$part)=@_;
13577: my $keyroot;
13578: if (defined($prefix) && $prefix !~ /^__/) {
13579: # prefix that has a part already
13580: $keyroot=$prefix;
13581: } elsif (defined($prefix)) {
13582: # prefix that is missing a part
13583: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
13584: } else {
13585: # no prefix at all
13586: if (defined($part)) { $keyroot='_'.$part; }
13587: }
13588: return $keyroot;
13589: }
13590:
1.71 www 13591: # ---------------------------------------------------------------- Get metadata
13592:
1.599 albertel 13593: my %metaentry;
1.1070 www 13594: my %importedpartids;
1.1369 raeburn 13595: my %importedrespids;
1.71 www 13596: sub metadata {
1.1362 raeburn 13597: my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
1.71 www 13598: $uri=&declutter($uri);
1.288 albertel 13599: # if it is a non metadata possible uri return quickly
1.529 albertel 13600: if (($uri eq '') ||
13601: (($uri =~ m|^/*adm/|) &&
1.1343 raeburn 13602: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard|ext\.tool)$})) ||
1.1108 raeburn 13603: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 13604: return undef;
13605: }
1.1261 raeburn 13606: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 13607: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 13608: return undef;
1.288 albertel 13609: }
1.73 www 13610: my $filename=$uri;
13611: $uri=~s/\.meta$//;
1.172 www 13612: #
13613: # Is the metadata already cached?
1.177 www 13614: # Look at timestamp of caching
1.172 www 13615: # Everything is cached by the main uri, libraries are never directly cached
13616: #
1.428 albertel 13617: if (!defined($liburi)) {
1.599 albertel 13618: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 13619: if (defined($cached)) { return $result->{':'.$what}; }
13620: }
1.1362 raeburn 13621:
13622: #
13623: # If the uri is for an external tool the file from
13624: # which metadata should be retrieved depends on whether
13625: # the tool had been configured to be gradable (set in the Course
13626: # Editor or Resource Editor).
13627: #
13628: # If a valid symb has been included as the third arg in the call
13629: # to &metadata() that can be used to retrieve the value of
13630: # parameter_0_gradable set for the resource, and included in the
13631: # uploaded map containing the tool. The value is retrieved via
13632: # &EXT(), if a valid symb is available. Otherwise the value of
13633: # gradable in the exttool_$marker.db file for the tool instance
1.1364 raeburn 13634: # is retrieved via &get().
13635: #
13636: # When lonuserstate::traceroute() calls lonnet::EXT() for
13637: # hiddenresource and encrypturl (during course initialization)
13638: # the map-level parameter for resource.0.gradable included in the
13639: # uploaded map containing the tool will not yet have been stored
13640: # in the user_course_parms.db file for the user's session, so in
13641: # this case fall back to retrieving gradable status from the
13642: # exttool_$marker.db file.
1.1362 raeburn 13643: #
13644: # In order to avoid an infinite loop, &metadata() will return
13645: # before a call to &EXT(), if the uri is for an external tool
13646: # and the $what for which metadata is being requested is
13647: # parameter_0_gradable or 0_gradable.
13648: #
13649:
13650: if ($uri =~ /ext\.tool$/) {
13651: if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
13652: return;
13653: } else {
13654: my ($checked,$use_passback);
13655: if ($toolsymb ne '') {
13656: (undef,undef,my $tooluri) = &decode_symb($toolsymb);
1.1364 raeburn 13657: if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
1.1362 raeburn 13658: $checked = 1;
13659: if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
13660: $use_passback = 1;
13661: }
13662: }
13663: }
13664: unless ($checked) {
13665: my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
13666: $marker=~s/\D//g;
1.1363 raeburn 13667: if ($marker) {
1.1362 raeburn 13668: my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
13669: $use_passback = $toolsettings{'gradable'};
13670: }
13671: }
13672: if ($use_passback) {
13673: $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
13674: } else {
13675: $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
13676: }
13677: }
13678: }
13679:
1.428 albertel 13680: {
1.1069 www 13681: # Imported parts would go here
1.1369 raeburn 13682: my @origfiletagids=();
1.1069 www 13683: my $importedparts=0;
1.1369 raeburn 13684:
13685: # Imported responseids would go here
13686: my $importedresponses=0;
1.172 www 13687: #
13688: # Is this a recursive call for a library?
13689: #
1.599 albertel 13690: # if (! exists($metacache{$uri})) {
13691: # $metacache{$uri}={};
13692: # }
1.924 albertel 13693: my $cachetime = 60*60;
1.171 www 13694: if ($liburi) {
13695: $liburi=&declutter($liburi);
13696: $filename=$liburi;
1.401 bowersj2 13697: } else {
1.599 albertel 13698: &devalidate_cache_new('meta',$uri);
13699: undef(%metaentry);
1.401 bowersj2 13700: }
1.140 www 13701: my %metathesekeys=();
1.73 www 13702: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 13703: my $metastring;
1.1140 www 13704: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 13705: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 13706: $metastring =
1.929 albertel 13707: &Apache::lonnet::ssi_body($which,
1.924 albertel 13708: ('grade_target' => 'meta'));
13709: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 13710: } elsif (($uri !~ m -^(editupload)/-) &&
13711: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 13712: my $file=&filelocation('',&clutter($filename));
1.599 albertel 13713: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 13714: $metastring=&getfile($file);
1.489 albertel 13715: }
1.208 albertel 13716: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 13717: my $token;
1.140 www 13718: undef %metathesekeys;
1.71 www 13719: while ($token=$parser->get_token) {
1.339 albertel 13720: if ($token->[0] eq 'S') {
13721: if (defined($token->[2]->{'package'})) {
1.172 www 13722: #
13723: # This is a package - get package info
13724: #
1.339 albertel 13725: my $package=$token->[2]->{'package'};
13726: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
13727: if (defined($token->[2]->{'id'})) {
13728: $keyroot.='_'.$token->[2]->{'id'};
13729: }
1.599 albertel 13730: if ($metaentry{':packages'}) {
13731: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 13732: } else {
1.599 albertel 13733: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 13734: }
1.736 albertel 13735: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 13736: my $part=$keyroot;
13737: $part=~s/^\_//;
1.736 albertel 13738: if ($pack_entry=~/^\Q$package\E\&/ ||
13739: $pack_entry=~/^\Q$package\E_0\&/) {
13740: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 13741: # ignore package.tab specified default values
13742: # here &package_tab_default() will fetch those
13743: if ($subp eq 'default') { next; }
1.736 albertel 13744: my $value=$packagetab{$pack_entry};
1.432 albertel 13745: my $unikey;
13746: if ($pack =~ /_0$/) {
13747: $unikey='parameter_0_'.$name;
13748: $part=0;
13749: } else {
13750: $unikey='parameter'.$keyroot.'_'.$name;
13751: }
1.339 albertel 13752: if ($subp eq 'display') {
13753: $value.=' [Part: '.$part.']';
13754: }
1.599 albertel 13755: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 13756: $metathesekeys{$unikey}=1;
1.599 albertel 13757: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
13758: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 13759: }
1.599 albertel 13760: if (defined($metaentry{':'.$unikey.'.default'})) {
13761: $metaentry{':'.$unikey}=
13762: $metaentry{':'.$unikey.'.default'};
1.356 albertel 13763: }
1.339 albertel 13764: }
13765: }
13766: } else {
1.172 www 13767: #
13768: # This is not a package - some other kind of start tag
1.339 albertel 13769: #
13770: my $entry=$token->[1];
1.1068 www 13771: my $unikey='';
1.175 www 13772:
1.339 albertel 13773: if ($entry eq 'import') {
1.175 www 13774: #
13775: # Importing a library here
1.339 albertel 13776: #
1.1067 www 13777: my $location=$parser->get_text('/import');
13778: my $dir=$filename;
13779: $dir=~s|[^/]*$||;
13780: $location=&filelocation($dir,$location);
1.1369 raeburn 13781:
13782: my $importid=$token->[2]->{'id'};
1.1068 www 13783: my $importmode=$token->[2]->{'importmode'};
1.1369 raeburn 13784: #
13785: # Check metadata for imported file to
13786: # see if it contained response items
13787: #
1.1372 raeburn 13788: my ($origfile,@libfilekeys);
1.1370 raeburn 13789: my %currmetaentry = %metaentry;
1.1372 raeburn 13790: @libfilekeys = split(/,/,&metadata($location,'keys',undef,undef,undef,
13791: $depthcount+1));
13792: if (grep(/^responseorder$/,@libfilekeys)) {
13793: my $libresponseorder = &metadata($location,'responseorder',undef,undef,
13794: undef,$depthcount+1);
13795: if ($libresponseorder ne '') {
13796: if ($#origfiletagids<0) {
13797: undef(%importedrespids);
13798: undef(%importedpartids);
13799: }
1.1373 raeburn 13800: my @respids = split(/\s*,\s*/,$libresponseorder);
13801: if (@respids) {
13802: $importedrespids{$importid} = join(',',map { $importid.'_'.$_ } @respids);
13803: }
13804: if ($importedrespids{$importid} ne '') {
1.1372 raeburn 13805: $importedresponses = 1;
1.1369 raeburn 13806: # We need to get the original file and the imported file to get the response order correct
13807: # Load and inspect original file
1.1372 raeburn 13808: if ($#origfiletagids<0) {
13809: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
13810: $origfile=&getfile($origfilelocation);
13811: @origfiletagids=($origfile=~/<((?:\w+)response|import|part)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13812: }
1.1369 raeburn 13813: }
13814: }
13815: }
1.1370 raeburn 13816: # Do not overwrite contents of %metaentry hash for resource itself with
13817: # hash populated for imported library file
13818: %metaentry = %currmetaentry;
13819: undef(%currmetaentry);
1.1374 raeburn 13820: if ($importmode eq 'part') {
1.1068 www 13821: # Import as part(s)
1.1069 www 13822: $importedparts=1;
13823: # We need to get the original file and the imported file to get the part order correct
13824: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
1.1369 raeburn 13825: # Load and inspect original file if we didn't do that already
13826: if ($#origfiletagids<0) {
13827: undef(%importedrespids);
13828: undef(%importedpartids);
13829: if ($origfile eq '') {
13830: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
13831: $origfile=&getfile($origfilelocation);
13832: @origfiletagids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13833: }
1.1070 www 13834: }
1.1372 raeburn 13835: my @impfilepartids;
13836: # If <partorder> tag is included in metadata for the imported file
13837: # get the parts in the imported file from that.
13838: if (grep(/^partorder$/,@libfilekeys)) {
13839: %currmetaentry = %metaentry;
13840: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13841: $depthcount+1);
13842: %metaentry = %currmetaentry;
13843: undef(%currmetaentry);
13844: if ($libpartorder ne '') {
13845: @impfilepartids=split(/\s*,\s*/,$libpartorder);
13846: }
13847: } else {
13848: # If no <partorder> tag available, load and inspect imported file
13849: my $impfile=&getfile($location);
13850: @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
13851: }
1.1069 www 13852: if ($#impfilepartids>=0) {
13853: # This problem had parts
1.1070 www 13854: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 13855: } else {
13856: # Importing by turning a single problem into a problem part
13857: # It gets the import-tags ID as part-ID
13858: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 13859: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 13860: }
1.1068 www 13861: } else {
1.1374 raeburn 13862: # Import as problem or as normal import
13863: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
13864: unless ($importmode eq 'problem') {
1.1068 www 13865: # Normal import
1.1374 raeburn 13866: if (defined($token->[2]->{'id'})) {
13867: $unikey.='_'.$token->[2]->{'id'};
13868: }
13869: }
13870: # Check metadata for imported file to
13871: # see if it contained parts
13872: if (grep(/^partorder$/,@libfilekeys)) {
13873: %currmetaentry = %metaentry;
13874: my $libpartorder = &metadata($location,'partorder',undef,undef,undef,
13875: $depthcount+1);
13876: %metaentry = %currmetaentry;
13877: undef(%currmetaentry);
13878: if ($libpartorder ne '') {
13879: $importedparts = 1;
13880: $importedpartids{$token->[2]->{'id'}}=$libpartorder;
13881: }
13882: }
1.1067 www 13883: }
1.339 albertel 13884: if ($depthcount<20) {
1.736 albertel 13885: my $metadata =
1.1362 raeburn 13886: &metadata($uri,'keys',$toolsymb,$location,$unikey,
1.736 albertel 13887: $depthcount+1);
13888: foreach my $meta (split(',',$metadata)) {
13889: $metaentry{':'.$meta}=$metaentry{':'.$meta};
13890: $metathesekeys{$meta}=1;
1.339 albertel 13891: }
1.1068 www 13892: }
1.1067 www 13893: } else {
13894: #
13895: # Not importing, some other kind of non-package, non-library start tag
13896: #
13897: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
13898: if (defined($token->[2]->{'id'})) {
13899: $unikey.='_'.$token->[2]->{'id'};
13900: }
1.339 albertel 13901: if (defined($token->[2]->{'name'})) {
13902: $unikey.='_'.$token->[2]->{'name'};
13903: }
13904: $metathesekeys{$unikey}=1;
1.736 albertel 13905: foreach my $param (@{$token->[3]}) {
13906: $metaentry{':'.$unikey.'.'.$param} =
13907: $token->[2]->{$param};
1.339 albertel 13908: }
13909: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 13910: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 13911: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
13912: # only ws inside the tag, and not in default, so use default
13913: # as value
1.599 albertel 13914: $metaentry{':'.$unikey}=$default;
1.908 albertel 13915: } elsif ( $internaltext =~ /\S/ ) {
13916: # something interesting inside the tag
13917: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 13918: } else {
1.908 albertel 13919: # no interesting values, don't set a default
1.339 albertel 13920: }
1.172 www 13921: # end of not-a-package not-a-library import
1.339 albertel 13922: }
1.172 www 13923: # end of not-a-package start tag
1.339 albertel 13924: }
1.172 www 13925: # the next is the end of "start tag"
1.339 albertel 13926: }
13927: }
1.483 albertel 13928: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 13929: $extension = lc($extension);
13930: if ($extension eq 'htm') { $extension='html'; }
13931:
1.737 albertel 13932: foreach my $key (keys(%packagetab)) {
1.483 albertel 13933: #no specific packages #how's our extension
13934: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 13935: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 13936: \%metathesekeys);
13937: }
1.883 albertel 13938:
13939: if (!exists($metaentry{':packages'})
13940: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 13941: foreach my $key (keys(%packagetab)) {
1.483 albertel 13942: #no specific packages well let's get default then
13943: if ($key!~/^default&/) { next; }
1.488 albertel 13944: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 13945: \%metathesekeys);
13946: }
13947: }
1.338 www 13948: # are there custom rights to evaluate
1.599 albertel 13949: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 13950:
1.338 www 13951: #
13952: # Importing a rights file here
1.339 albertel 13953: #
13954: unless ($depthcount) {
1.599 albertel 13955: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 13956: my $dir=$filename;
13957: $dir=~s|[^/]*$||;
13958: $location=&filelocation($dir,$location);
1.736 albertel 13959: my $rights_metadata =
1.1362 raeburn 13960: &metadata($uri,'keys',$toolsymb,$location,'_rights',
1.736 albertel 13961: $depthcount+1);
13962: foreach my $rights (split(',',$rights_metadata)) {
13963: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
13964: $metathesekeys{$rights}=1;
1.339 albertel 13965: }
13966: }
13967: }
1.737 albertel 13968: # uniqifiy package listing
13969: my %seen;
13970: my @uniq_packages =
13971: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
13972: $metaentry{':packages'} = join(',',@uniq_packages);
13973:
1.1369 raeburn 13974: if (($importedresponses) || ($importedparts)) {
13975: if ($importedparts) {
1.1070 www 13976: # We had imported parts and need to rebuild partorder
1.1369 raeburn 13977: $metaentry{':partorder'}='';
13978: $metathesekeys{'partorder'}=1;
13979: }
13980: if ($importedresponses) {
13981: # We had imported responses and need to rebuil responseorder
13982: $metaentry{':responseorder'}='';
13983: $metathesekeys{'responseorder'}=1;
13984: }
13985: for (my $index=0;$index<$#origfiletagids;$index+=2) {
13986: my $origid = $origfiletagids[$index+1];
13987: if ($origfiletagids[$index] eq 'part') {
13988: # Original part, part of the problem
13989: if ($importedparts) {
13990: $metaentry{':partorder'}.=','.$origid;
13991: }
13992: } elsif ($origfiletagids[$index] eq 'import') {
13993: if ($importedparts) {
13994: # We have imported parts at this position
1.1373 raeburn 13995: if ($importedpartids{$origid} ne '') {
13996: $metaentry{':partorder'}.=','.$importedpartids{$origid};
13997: }
1.1369 raeburn 13998: }
13999: if ($importedresponses) {
14000: # We have imported responses at this position
1.1373 raeburn 14001: if ($importedrespids{$origid} ne '') {
14002: $metaentry{':responseorder'}.=','.$importedrespids{$origid};
1.1369 raeburn 14003: }
14004: }
14005: } else {
14006: # Original response item, part of the problem
14007: if ($importedresponses) {
14008: $metaentry{':responseorder'}.=','.$origid;
14009: }
14010: }
14011: }
14012: if ($importedparts) {
14013: $metaentry{':partorder'}=~s/^\,//;
14014: }
14015: if ($importedresponses) {
14016: $metaentry{':responseorder'}=~s/^\,//;
14017: }
1.1070 www 14018: }
1.737 albertel 14019: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 14020: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274 raeburn 14021: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.1371 raeburn 14022: unless ($liburi) {
14023: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
14024: }
1.177 www 14025: # this is the end of "was not already recently cached
1.71 www 14026: }
1.599 albertel 14027: return $metaentry{':'.$what};
1.261 albertel 14028: }
14029:
1.488 albertel 14030: sub metadata_create_package_def {
1.483 albertel 14031: my ($uri,$key,$package,$metathesekeys)=@_;
14032: my ($pack,$name,$subp)=split(/\&/,$key);
14033: if ($subp eq 'default') { next; }
14034:
1.599 albertel 14035: if (defined($metaentry{':packages'})) {
14036: $metaentry{':packages'}.=','.$package;
1.483 albertel 14037: } else {
1.599 albertel 14038: $metaentry{':packages'}=$package;
1.483 albertel 14039: }
14040: my $value=$packagetab{$key};
14041: my $unikey;
14042: $unikey='parameter_0_'.$name;
1.599 albertel 14043: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 14044: $$metathesekeys{$unikey}=1;
1.599 albertel 14045: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
14046: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 14047: }
1.599 albertel 14048: if (defined($metaentry{':'.$unikey.'.default'})) {
14049: $metaentry{':'.$unikey}=
14050: $metaentry{':'.$unikey.'.default'};
1.483 albertel 14051: }
14052: }
14053:
1.261 albertel 14054: sub metadata_generate_part0 {
14055: my ($metadata,$metacache,$uri) = @_;
14056: my %allnames;
1.737 albertel 14057: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 14058: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 14059: my $part=$$metacache{':'.$metakey.'.part'};
14060: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 14061: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 14062: $allnames{$name}=$part;
14063: }
14064: }
14065: }
14066: foreach my $name (keys(%allnames)) {
14067: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 14068: my $key=":parameter_0_$name";
1.261 albertel 14069: $$metacache{"$key.part"}='0';
14070: $$metacache{"$key.name"}=$name;
1.428 albertel 14071: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 14072: $allnames{$name}.'_'.$name.
14073: '.type'};
1.428 albertel 14074: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 14075: '.display'};
1.644 www 14076: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 14077: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 14078: $$metacache{"$key.display"}=$olddis;
14079: }
1.71 www 14080: }
14081:
1.764 albertel 14082: # ------------------------------------------------------ Devalidate title cache
14083:
14084: sub devalidate_title_cache {
14085: my ($url)=@_;
14086: if (!$env{'request.course.id'}) { return; }
14087: my $symb=&symbread($url);
14088: if (!$symb) { return; }
14089: my $key=$env{'request.course.id'}."\0".$symb;
14090: &devalidate_cache_new('title',$key);
14091: }
14092:
1.1014 droeschl 14093: # ------------------------------------------------- Get the title of a course
14094:
14095: sub current_course_title {
14096: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
14097: }
1.301 www 14098: # ------------------------------------------------- Get the title of a resource
14099:
14100: sub gettitle {
14101: my $urlsymb=shift;
14102: my $symb=&symbread($urlsymb);
1.534 albertel 14103: if ($symb) {
1.620 albertel 14104: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 14105: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 14106: if (defined($cached)) {
14107: return $result;
14108: }
1.534 albertel 14109: my ($map,$resid,$url)=&decode_symb($symb);
14110: my $title='';
1.907 albertel 14111: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
14112: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
14113: } else {
14114: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
14115: &GDBM_READER(),0640)) {
14116: my $mapid=$bighash{'map_pc_'.&clutter($map)};
14117: $title=$bighash{'title_'.$mapid.'.'.$resid};
14118: untie(%bighash);
14119: }
1.534 albertel 14120: }
14121: $title=~s/\&colon\;/\:/gs;
14122: if ($title) {
1.1159 www 14123: # Remember both $symb and $title for dynamic metadata
14124: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 14125: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 14126: # Cache this title and then return it
1.599 albertel 14127: return &do_cache_new('title',$key,$title,600);
1.534 albertel 14128: }
14129: $urlsymb=$url;
14130: }
14131: my $title=&metadata($urlsymb,'title');
14132: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
14133: return $title;
1.301 www 14134: }
1.613 albertel 14135:
1.614 albertel 14136: sub get_slot {
14137: my ($which,$cnum,$cdom)=@_;
14138: if (!$cnum || !$cdom) {
1.790 albertel 14139: (undef,my $courseid)=&whichuser();
1.620 albertel 14140: $cdom=$env{'course.'.$courseid.'.domain'};
14141: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 14142: }
1.703 albertel 14143: my $key=join("\0",'slots',$cdom,$cnum,$which);
14144: my %slotinfo;
14145: if (exists($remembered{$key})) {
14146: $slotinfo{$which} = $remembered{$key};
14147: } else {
14148: %slotinfo=&get('slots',[$which],$cdom,$cnum);
14149: &Apache::lonhomework::showhash(%slotinfo);
14150: my ($tmp)=keys(%slotinfo);
14151: if ($tmp=~/^error:/) { return (); }
14152: $remembered{$key} = $slotinfo{$which};
14153: }
1.616 albertel 14154: if (ref($slotinfo{$which}) eq 'HASH') {
14155: return %{$slotinfo{$which}};
14156: }
14157: return $slotinfo{$which};
1.614 albertel 14158: }
1.1150 raeburn 14159:
14160: sub get_reservable_slots {
14161: my ($cnum,$cdom,$uname,$udom) = @_;
14162: my $now = time;
14163: my $reservable_info;
14164: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
14165: if (exists($remembered{$key})) {
14166: $reservable_info = $remembered{$key};
14167: } else {
14168: my %resv;
14169: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
14170: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
14171: $reservable_info = \%resv;
14172: $remembered{$key} = $reservable_info;
14173: }
14174: return $reservable_info;
14175: }
14176:
14177: sub get_course_slots {
14178: my ($cnum,$cdom) = @_;
14179: my $hashid=$cnum.':'.$cdom;
1.1494 raeburn 14180: my ($result,$cached) = &is_cached_new('allslots',$hashid);
1.1150 raeburn 14181: if (defined($cached)) {
14182: if (ref($result) eq 'HASH') {
14183: return %{$result};
14184: }
14185: } else {
1.1494 raeburn 14186: my %slots=&dump('slots',$cdom,$cnum);
1.1150 raeburn 14187: my ($tmp) = keys(%slots);
14188: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 14189: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 14190: return %slots;
14191: }
14192: }
14193: return;
14194: }
14195:
14196: sub devalidate_slots_cache {
14197: my ($cnum,$cdom)=@_;
14198: my $hashid=$cnum.':'.$cdom;
14199: &devalidate_cache_new('allslots',$hashid);
14200: }
14201:
1.1181 raeburn 14202: sub get_coursechange {
14203: my ($cdom,$cnum) = @_;
14204: if ($cdom eq '' || $cnum eq '') {
14205: return unless ($env{'request.course.id'});
14206: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
14207: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
14208: }
14209: my $hashid=$cdom.'_'.$cnum;
14210: my ($change,$cached)=&is_cached_new('crschange',$hashid);
14211: if ((defined($cached)) && ($change ne '')) {
14212: return $change;
14213: } else {
14214: my %crshash;
14215: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
14216: if ($crshash{'internal.contentchange'} eq '') {
14217: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
14218: if ($change eq '') {
14219: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
14220: $change = $crshash{'internal.created'};
14221: }
14222: } else {
14223: $change = $crshash{'internal.contentchange'};
14224: }
14225: my $cachetime = 600;
14226: &do_cache_new('crschange',$hashid,$change,$cachetime);
14227: }
14228: return $change;
14229: }
14230:
14231: sub devalidate_coursechange_cache {
1.1496 raeburn 14232: my ($cdom,$cnum)=@_;
14233: my $hashid=$cdom.'_'.$cnum;
1.1181 raeburn 14234: &devalidate_cache_new('crschange',$hashid);
14235: }
14236:
1.1496 raeburn 14237: sub get_suppchange {
14238: my ($cdom,$cnum) = @_;
14239: if ($cdom eq '' || $cnum eq '') {
14240: return unless ($env{'request.course.id'});
14241: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
14242: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
14243: }
14244: my $hashid=$cdom.'_'.$cnum;
14245: my ($change,$cached)=&is_cached_new('suppchange',$hashid);
14246: if ((defined($cached)) && ($change ne '')) {
14247: return $change;
14248: } else {
14249: my %crshash = &get('environment',['internal.supplementalchange'],$cdom,$cnum);
14250: if ($crshash{'internal.supplementalchange'} eq '') {
14251: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
14252: if ($change eq '') {
14253: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
14254: $change = $crshash{'internal.created'};
14255: }
14256: } else {
14257: $change = $crshash{'internal.supplementalchange'};
14258: }
14259: my $cachetime = 600;
14260: &do_cache_new('suppchange',$hashid,$change,$cachetime);
14261: }
14262: return $change;
14263: }
14264:
14265: sub devalidate_suppchange_cache {
14266: my ($cdom,$cnum)=@_;
14267: my $hashid=$cdom.'_'.$cnum;
14268: &devalidate_cache_new('suppchange',$hashid);
14269: }
14270:
1.1497 raeburn 14271: sub update_supp_caches {
14272: my ($cdom,$cnum) = @_;
14273: my %servers = &internet_dom_servers($cdom);
14274: my @ids=¤t_machine_ids();
14275: foreach my $server (keys(%servers)) {
14276: next if (grep(/^\Q$server\E$/,@ids));
14277: my $hashid=$cnum.':'.$cdom;
14278: my $cachekey = &escape('showsupp').':'.&escape($hashid);
14279: &remote_devalidate_cache($server,[$cachekey]);
14280: }
14281: &has_unhidden_suppfiles($cnum,$cdom,1,1);
14282: &count_supptools($cnum,$cdom,1);
14283: my $now = time;
14284: if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
14285: &Apache::lonnet::appenv({'request.course.suppupdated' => $now});
14286: }
14287: &put('environment',{'internal.supplementalchange' => $now},
14288: $cdom,$cnum);
14289: &Apache::lonnet::appenv(
14290: {'course.'.$cdom.'_'.$cnum.'.internal.supplementalchange' => $now});
14291: &do_cache_new('suppchange',$cdom.'_'.$cnum,$now,600);
14292: }
14293:
1.31 www 14294: # ------------------------------------------------- Update symbolic store links
14295:
14296: sub symblist {
14297: my ($mapname,%newhash)=@_;
1.438 www 14298: $mapname=&deversion(&declutter($mapname));
1.31 www 14299: my %hash;
1.620 albertel 14300: if (($env{'request.course.fn'}) && (%newhash)) {
14301: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 14302: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 14303: foreach my $url (keys(%newhash)) {
1.711 albertel 14304: next if ($url eq 'last_known'
14305: && $env{'form.no_update_last_known'});
14306: $hash{declutter($url)}=&encode_symb($mapname,
14307: $newhash{$url}->[1],
14308: $newhash{$url}->[0]);
1.191 harris41 14309: }
1.31 www 14310: if (untie(%hash)) {
14311: return 'ok';
14312: }
14313: }
14314: }
14315: return 'error';
1.212 www 14316: }
14317:
14318: # --------------------------------------------------------------- Verify a symb
14319:
14320: sub symbverify {
1.1190 raeburn 14321: my ($symb,$thisurl,$encstate)=@_;
1.510 www 14322: my $thisfn=$thisurl;
1.439 www 14323: $thisfn=&declutter($thisfn);
1.215 www 14324: # direct jump to resource in page or to a sequence - will construct own symbs
14325: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
14326: # check URL part
1.409 www 14327: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 14328:
1.431 www 14329: unless ($url eq $thisfn) { return 0; }
1.213 www 14330:
1.216 www 14331: $symb=&symbclean($symb);
1.510 www 14332: $thisurl=&deversion($thisurl);
1.439 www 14333: $thisfn=&deversion($thisfn);
1.213 www 14334:
14335: my %bighash;
14336: my $okay=0;
1.431 www 14337:
1.620 albertel 14338: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 14339: &GDBM_READER(),0640)) {
1.1032 raeburn 14340: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
14341: $thisurl =~ s/\?.+$//;
1.1204 raeburn 14342: if ($map =~ m{^uploaded/.+\.page$}) {
14343: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
14344: $thisurl =~ s{^\Qhttp://https://\E}{https://};
14345: }
14346: }
14347: my $ids;
1.1419 raeburn 14348: if ($map =~ m{^uploaded/.+\.page$}) {
14349: $ids=$bighash{'ids_'.&clutter_with_no_wrapper($thisurl)};
1.1204 raeburn 14350: } else {
14351: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 14352: }
1.1102 raeburn 14353: unless ($ids) {
14354: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
14355: $ids=$bighash{$idkey};
1.216 www 14356: }
14357: if ($ids) {
14358: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 14359: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 14360: $symb =~ s/\?.+$//;
1.1202 raeburn 14361: }
1.800 albertel 14362: foreach my $id (split(/\,/,$ids)) {
14363: my ($mapid,$resid)=split(/\./,$id);
1.216 www 14364: if (
14365: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 14366: eq $symb) {
14367: if (ref($encstate)) {
14368: $$encstate = $bighash{'encrypted_'.$id};
14369: }
1.620 albertel 14370: if (($env{'request.role.adv'}) ||
1.1101 raeburn 14371: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
14372: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 14373: $okay=1;
1.1202 raeburn 14374: last;
1.582 albertel 14375: }
14376: }
1.216 www 14377: }
14378: }
1.213 www 14379: untie(%bighash);
14380: }
14381: return $okay;
1.31 www 14382: }
14383:
1.210 www 14384: # --------------------------------------------------------------- Clean-up symb
14385:
14386: sub symbclean {
14387: my $symb=shift;
1.568 albertel 14388: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 14389: # remove version from map
14390: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 14391:
1.210 www 14392: # remove version from URL
14393: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 14394:
1.507 www 14395: # remove wrapper
14396:
1.510 www 14397: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 14398: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 14399: return $symb;
1.409 www 14400: }
14401:
14402: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 14403:
14404: sub encode_symb {
14405: my ($map,$resid,$url)=@_;
14406: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
14407: }
1.409 www 14408:
14409: sub decode_symb {
1.568 albertel 14410: my $symb=shift;
14411: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
14412: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 14413: return (&fixversion($map),$resid,&fixversion($url));
14414: }
14415:
14416: sub fixversion {
14417: my $fn=shift;
1.609 banghart 14418: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 14419: my %bighash;
14420: my $uri=&clutter($fn);
1.620 albertel 14421: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 14422: # is this cached?
1.599 albertel 14423: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 14424: if (defined($cached)) { return $result; }
14425: # unfortunately not cached, or expired
1.620 albertel 14426: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 14427: &GDBM_READER(),0640)) {
14428: if ($bighash{'version_'.$uri}) {
14429: my $version=$bighash{'version_'.$uri};
1.444 www 14430: unless (($version eq 'mostrecent') ||
14431: ($version==&getversion($uri))) {
1.440 www 14432: $uri=~s/\.(\w+)$/\.$version\.$1/;
14433: }
14434: }
14435: untie %bighash;
1.413 www 14436: }
1.599 albertel 14437: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 14438: }
14439:
14440: sub deversion {
14441: my $url=shift;
14442: $url=~s/\.\d+\.(\w+)$/\.$1/;
14443: return $url;
1.210 www 14444: }
14445:
1.31 www 14446: # ------------------------------------------------------ Return symb list entry
14447:
14448: sub symbread {
1.1424 raeburn 14449: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles,
1.1427 raeburn 14450: $ignoresymbdb,$noenccheck)=@_;
1.1265 raeburn 14451: my $cache_str='request.symbread.cached.'.$thisfn;
1.1427 raeburn 14452: if (defined($env{$cache_str})) {
1.1424 raeburn 14453: unless (ref($possibles) eq 'HASH') {
14454: if ($ignorecachednull) {
14455: return $env{$cache_str} unless ($env{$cache_str} eq '');
14456: } else {
14457: return $env{$cache_str};
14458: }
1.1282 raeburn 14459: }
14460: }
1.242 www 14461: # no filename provided? try from environment
1.1265 raeburn 14462: unless ($thisfn) {
1.620 albertel 14463: if ($env{'request.symb'}) {
1.1427 raeburn 14464: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 14465: }
1.620 albertel 14466: $thisfn=$env{'request.filename'};
1.44 www 14467: }
1.569 albertel 14468: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 14469: # is that filename actually a symb? Verify, clean, and return
14470: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 14471: if (&symbverify($thisfn,$1)) {
1.1427 raeburn 14472: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 14473: }
1.242 www 14474: }
1.44 www 14475: $thisfn=declutter($thisfn);
1.31 www 14476: my %hash;
1.37 www 14477: my %bighash;
14478: my $syval='';
1.620 albertel 14479: if (($env{'request.course.fn'}) && ($thisfn)) {
1.1427 raeburn 14480: unless ($ignoresymbdb) {
1.1424 raeburn 14481: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
14482: &GDBM_READER(),0640)) {
1.1487 raeburn 14483: $syval=$hash{$thisfn};
1.1424 raeburn 14484: untie(%hash);
14485: }
1.1427 raeburn 14486: if ($syval && $checkforblock) {
14487: my @blockers = &has_comm_blocking('bre',$syval,$thisfn,$ignoresymbdb,$noenccheck);
1.1424 raeburn 14488: if (@blockers) {
14489: $syval='';
14490: }
14491: }
1.37 www 14492: }
14493: # ---------------------------------------------------------- There was an entry
14494: if ($syval) {
1.601 albertel 14495: #unless ($syval=~/\_\d+$/) {
1.620 albertel 14496: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 14497: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 14498: #return $env{$cache_str}='';
1.601 albertel 14499: #}
14500: #$syval.=$1;
14501: #}
1.37 www 14502: } else {
14503: # ------------------------------------------------------- Was not in symb table
1.620 albertel 14504: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 14505: &GDBM_READER(),0640)) {
1.37 www 14506: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 14507: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 14508: unless ($ids) {
14509: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 14510: }
14511: unless ($ids) {
14512: # alias?
14513: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 14514: }
1.37 www 14515: if ($ids) {
14516: # ------------------------------------------------------------------- Has ID(s)
14517: my @possibilities=split(/\,/,$ids);
1.39 www 14518: if ($#possibilities==0) {
14519: # ----------------------------------------------- There is only one possibility
1.37 www 14520: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 14521: $syval=&encode_symb($bighash{'map_id_'.$mapid},
14522: $resid,$thisfn);
1.1282 raeburn 14523: if (ref($possibles) eq 'HASH') {
1.1424 raeburn 14524: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
14525: $possibles->{$syval} = 1;
14526: }
1.1282 raeburn 14527: }
14528: if ($checkforblock) {
1.1424 raeburn 14529: unless ($bighash{'randomout_'.$ids} || $env{'request.role.adv'}) {
1.1426 raeburn 14530: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids},'',$noenccheck);
1.1424 raeburn 14531: if (@blockers) {
14532: $syval = '';
1.1425 raeburn 14533: untie(%bighash);
14534: return $env{$cache_str}='';
1.1424 raeburn 14535: }
1.1282 raeburn 14536: }
14537: }
14538: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 14539: # ------------------------------------------ There is more than one possibility
14540: my $realpossible=0;
1.800 albertel 14541: foreach my $id (@possibilities) {
14542: my $file=$bighash{'src_'.$id};
1.1282 raeburn 14543: my $canaccess;
14544: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
14545: $canaccess = 1;
14546: } else {
14547: $canaccess = &allowed('bre',$file);
14548: }
14549: if ($canaccess) {
14550: my ($mapid,$resid)=split(/\./,$id);
14551: if ($bighash{'map_type_'.$mapid} ne 'page') {
14552: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
14553: $resid,$thisfn);
1.1424 raeburn 14554: next if ($bighash{'randomout_'.$id} && !$env{'request.role.adv'});
1.1426 raeburn 14555: next unless (($noenccheck) || ($bighash{'encrypted_'.$id} eq $env{'request.enc'}));
1.1282 raeburn 14556: if ($checkforblock) {
1.1426 raeburn 14557: my @blockers = &has_comm_blocking('bre',$poss_syval,$file,'',$noenccheck);
1.1424 raeburn 14558: if (@blockers > 0) {
14559: $syval = '';
14560: } else {
1.1282 raeburn 14561: $syval = $poss_syval;
14562: $realpossible++;
14563: }
14564: } else {
14565: $syval = $poss_syval;
14566: $realpossible++;
14567: }
1.1424 raeburn 14568: if ($syval) {
14569: if (ref($possibles) eq 'HASH') {
14570: $possibles->{$syval} = 1;
14571: }
14572: }
1.1282 raeburn 14573: }
1.39 www 14574: }
1.191 harris41 14575: }
1.39 www 14576: if ($realpossible!=1) { $syval=''; }
1.249 www 14577: } else {
14578: $syval='';
1.37 www 14579: }
14580: }
1.1282 raeburn 14581: untie(%bighash);
1.481 raeburn 14582: }
1.31 www 14583: }
1.62 www 14584: if ($syval) {
1.1427 raeburn 14585: return $env{$cache_str}=$syval;
1.62 www 14586: }
1.31 www 14587: }
1.949 raeburn 14588: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 14589: return $env{$cache_str}='';
1.31 www 14590: }
14591:
14592: # ---------------------------------------------------------- Return random seed
14593:
1.32 www 14594: sub numval {
14595: my $txt=shift;
14596: $txt=~tr/A-J/0-9/;
14597: $txt=~tr/a-j/0-9/;
14598: $txt=~tr/K-T/0-9/;
14599: $txt=~tr/k-t/0-9/;
14600: $txt=~tr/U-Z/0-5/;
14601: $txt=~tr/u-z/0-5/;
14602: $txt=~s/\D//g;
1.564 albertel 14603: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 14604: return int($txt);
1.368 albertel 14605: }
14606:
1.484 albertel 14607: sub numval2 {
14608: my $txt=shift;
14609: $txt=~tr/A-J/0-9/;
14610: $txt=~tr/a-j/0-9/;
14611: $txt=~tr/K-T/0-9/;
14612: $txt=~tr/k-t/0-9/;
14613: $txt=~tr/U-Z/0-5/;
14614: $txt=~tr/u-z/0-5/;
14615: $txt=~s/\D//g;
14616: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
14617: my $total;
14618: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 14619: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 14620: return int($total);
14621: }
14622:
1.575 albertel 14623: sub numval3 {
14624: use integer;
14625: my $txt=shift;
14626: $txt=~tr/A-J/0-9/;
14627: $txt=~tr/a-j/0-9/;
14628: $txt=~tr/K-T/0-9/;
14629: $txt=~tr/k-t/0-9/;
14630: $txt=~tr/U-Z/0-5/;
14631: $txt=~tr/u-z/0-5/;
14632: $txt=~s/\D//g;
14633: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
14634: my $total;
14635: foreach my $val (@txts) { $total+=$val; }
14636: if ($_64bit) { $total=(($total<<32)>>32); }
14637: return $total;
14638: }
14639:
1.675 albertel 14640: sub digest {
14641: my ($data)=@_;
14642: my $digest=&Digest::MD5::md5($data);
14643: my ($a,$b,$c,$d)=unpack("iiii",$digest);
14644: my ($e,$f);
14645: {
14646: use integer;
14647: $e=($a+$b);
14648: $f=($c+$d);
14649: if ($_64bit) {
14650: $e=(($e<<32)>>32);
14651: $f=(($f<<32)>>32);
14652: }
14653: }
14654: if (wantarray) {
14655: return ($e,$f);
14656: } else {
14657: my $g;
14658: {
14659: use integer;
14660: $g=($e+$f);
14661: if ($_64bit) {
14662: $g=(($g<<32)>>32);
14663: }
14664: }
14665: return $g;
14666: }
14667: }
14668:
1.368 albertel 14669: sub latest_rnd_algorithm_id {
1.675 albertel 14670: return '64bit5';
1.366 albertel 14671: }
1.32 www 14672:
1.503 albertel 14673: sub get_rand_alg {
14674: my ($courseid)=@_;
1.790 albertel 14675: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 14676: if ($courseid) {
1.620 albertel 14677: return $env{"course.$courseid.rndseed"};
1.503 albertel 14678: }
14679: return &latest_rnd_algorithm_id();
14680: }
14681:
1.562 albertel 14682: sub validCODE {
14683: my ($CODE)=@_;
14684: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
14685: return 0;
14686: }
14687:
1.491 albertel 14688: sub getCODE {
1.620 albertel 14689: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 14690: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
14691: defined($Apache::lonhomework::parsing_a_task) ) &&
14692: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 14693: return $Apache::lonhomework::history{'resource.CODE'};
14694: }
14695: return undef;
14696: }
1.1133 foxr 14697: #
14698: # Determines the random seed for a specific context:
14699: #
14700: # parameters:
14701: # symb - in course context the symb for the seed.
14702: # course_id - The course id of the form domain_coursenum.
14703: # domain - Domain for the user.
14704: # course - Course for the user.
14705: # cenv - environment of the course.
14706: #
14707: # NOTE:
14708: # All parameters are picked out of the environment if missing
14709: # or not defined.
14710: # If a symb cannot be determined the current time is used instead.
14711: #
14712: # For a given well defined symb, courside, domain, username,
14713: # and course environment, the seed is reproducible.
14714: #
1.31 www 14715: sub rndseed {
1.1133 foxr 14716: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 14717: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 14718: if (!defined($symb)) {
1.366 albertel 14719: unless ($symb=$wsymb) { return time; }
14720: }
1.1146 foxr 14721: if (!defined $courseid) {
14722: $courseid=$wcourseid;
14723: }
14724: if (!defined $domain) { $domain=$wdomain; }
14725: if (!defined $username) { $username=$wusername }
1.1133 foxr 14726:
14727: my $which;
14728: if (defined($cenv->{'rndseed'})) {
14729: $which = $cenv->{'rndseed'};
14730: } else {
14731: $which =&get_rand_alg($courseid);
14732: }
1.491 albertel 14733: if (defined(&getCODE())) {
1.1133 foxr 14734:
1.675 albertel 14735: if ($which eq '64bit5') {
14736: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
14737: } elsif ($which eq '64bit4') {
1.575 albertel 14738: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
14739: } else {
14740: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
14741: }
1.675 albertel 14742: } elsif ($which eq '64bit5') {
14743: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 14744: } elsif ($which eq '64bit4') {
14745: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 14746: } elsif ($which eq '64bit3') {
14747: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 14748: } elsif ($which eq '64bit2') {
14749: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 14750: } elsif ($which eq '64bit') {
14751: return &rndseed_64bit($symb,$courseid,$domain,$username);
14752: }
14753: return &rndseed_32bit($symb,$courseid,$domain,$username);
14754: }
14755:
14756: sub rndseed_32bit {
14757: my ($symb,$courseid,$domain,$username)=@_;
14758: {
14759: use integer;
14760: my $symbchck=unpack("%32C*",$symb) << 27;
14761: my $symbseed=numval($symb) << 22;
14762: my $namechck=unpack("%32C*",$username) << 17;
14763: my $nameseed=numval($username) << 12;
14764: my $domainseed=unpack("%32C*",$domain) << 7;
14765: my $courseseed=unpack("%32C*",$courseid);
14766: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 14767: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14768: #&logthis("rndseed :$num:$symb");
1.564 albertel 14769: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 14770: return $num;
14771: }
14772: }
14773:
14774: sub rndseed_64bit {
14775: my ($symb,$courseid,$domain,$username)=@_;
14776: {
14777: use integer;
14778: my $symbchck=unpack("%32S*",$symb) << 21;
14779: my $symbseed=numval($symb) << 10;
14780: my $namechck=unpack("%32S*",$username);
14781:
14782: my $nameseed=numval($username) << 21;
14783: my $domainseed=unpack("%32S*",$domain) << 10;
14784: my $courseseed=unpack("%32S*",$courseid);
14785:
14786: my $num1=$symbchck+$symbseed+$namechck;
14787: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14788: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14789: #&logthis("rndseed :$num:$symb");
1.564 albertel 14790: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 14791: return "$num1,$num2";
1.155 albertel 14792: }
1.366 albertel 14793: }
14794:
1.443 albertel 14795: sub rndseed_64bit2 {
14796: my ($symb,$courseid,$domain,$username)=@_;
14797: {
14798: use integer;
14799: # strings need to be an even # of cahracters long, it it is odd the
14800: # last characters gets thrown away
14801: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14802: my $symbseed=numval($symb) << 10;
14803: my $namechck=unpack("%32S*",$username.' ');
14804:
14805: my $nameseed=numval($username) << 21;
1.501 albertel 14806: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14807: my $courseseed=unpack("%32S*",$courseid.' ');
14808:
14809: my $num1=$symbchck+$symbseed+$namechck;
14810: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14811: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14812: #&logthis("rndseed :$num:$symb");
1.803 albertel 14813: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 14814: return "$num1,$num2";
14815: }
14816: }
14817:
14818: sub rndseed_64bit3 {
14819: my ($symb,$courseid,$domain,$username)=@_;
14820: {
14821: use integer;
14822: # strings need to be an even # of cahracters long, it it is odd the
14823: # last characters gets thrown away
14824: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14825: my $symbseed=numval2($symb) << 10;
14826: my $namechck=unpack("%32S*",$username.' ');
14827:
14828: my $nameseed=numval2($username) << 21;
1.443 albertel 14829: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14830: my $courseseed=unpack("%32S*",$courseid.' ');
14831:
14832: my $num1=$symbchck+$symbseed+$namechck;
14833: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14834: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14835: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 14836: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 14837:
1.503 albertel 14838: return "$num1:$num2";
1.443 albertel 14839: }
14840: }
14841:
1.575 albertel 14842: sub rndseed_64bit4 {
14843: my ($symb,$courseid,$domain,$username)=@_;
14844: {
14845: use integer;
14846: # strings need to be an even # of cahracters long, it it is odd the
14847: # last characters gets thrown away
14848: my $symbchck=unpack("%32S*",$symb.' ') << 21;
14849: my $symbseed=numval3($symb) << 10;
14850: my $namechck=unpack("%32S*",$username.' ');
14851:
14852: my $nameseed=numval3($username) << 21;
14853: my $domainseed=unpack("%32S*",$domain.' ') << 10;
14854: my $courseseed=unpack("%32S*",$courseid.' ');
14855:
14856: my $num1=$symbchck+$symbseed+$namechck;
14857: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 14858: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
14859: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 14860: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 14861:
1.575 albertel 14862: return "$num1:$num2";
14863: }
14864: }
14865:
1.675 albertel 14866: sub rndseed_64bit5 {
14867: my ($symb,$courseid,$domain,$username)=@_;
14868: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
14869: return "$num1:$num2";
14870: }
14871:
1.366 albertel 14872: sub rndseed_CODE_64bit {
14873: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 14874: {
1.366 albertel 14875: use integer;
1.443 albertel 14876: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 14877: my $symbseed=numval2($symb);
1.491 albertel 14878: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14879: my $CODEseed=numval(&getCODE());
1.443 albertel 14880: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 14881: my $num1=$symbseed+$CODEchck;
14882: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 14883: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14884: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 14885: if ($_64bit) { $num1=(($num1<<32)>>32); }
14886: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 14887: return "$num1:$num2";
1.366 albertel 14888: }
14889: }
14890:
1.575 albertel 14891: sub rndseed_CODE_64bit4 {
14892: my ($symb,$courseid,$domain,$username)=@_;
14893: {
14894: use integer;
14895: my $symbchck=unpack("%32S*",$symb.' ') << 16;
14896: my $symbseed=numval3($symb);
14897: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
14898: my $CODEseed=numval3(&getCODE());
14899: my $courseseed=unpack("%32S*",$courseid.' ');
14900: my $num1=$symbseed+$CODEchck;
14901: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 14902: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
14903: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 14904: if ($_64bit) { $num1=(($num1<<32)>>32); }
14905: if ($_64bit) { $num2=(($num2<<32)>>32); }
14906: return "$num1:$num2";
14907: }
14908: }
14909:
1.675 albertel 14910: sub rndseed_CODE_64bit5 {
14911: my ($symb,$courseid,$domain,$username)=@_;
14912: my $code = &getCODE();
14913: my ($num1,$num2)=&digest("$symb,$courseid,$code");
14914: return "$num1:$num2";
14915: }
14916:
1.366 albertel 14917: sub setup_random_from_rndseed {
14918: my ($rndseed)=@_;
1.503 albertel 14919: if ($rndseed =~/([,:])/) {
1.1262 raeburn 14920: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
14921: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
14922: &Math::Random::random_set_seed_from_phrase($rndseed);
14923: } else {
14924: &Math::Random::random_set_seed($num1,$num2);
14925: }
1.366 albertel 14926: } else {
14927: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 14928: }
1.36 albertel 14929: }
14930:
1.474 albertel 14931: sub latest_receipt_algorithm_id {
1.835 albertel 14932: return 'receipt3';
1.474 albertel 14933: }
14934:
1.480 www 14935: sub recunique {
14936: my $fucourseid=shift;
14937: my $unique;
1.835 albertel 14938: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
14939: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 14940: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 14941: } else {
14942: $unique=$perlvar{'lonReceipt'};
14943: }
14944: return unpack("%32C*",$unique);
14945: }
14946:
14947: sub recprefix {
14948: my $fucourseid=shift;
14949: my $prefix;
1.835 albertel 14950: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
14951: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 14952: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 14953: } else {
14954: $prefix=$perlvar{'lonHostID'};
14955: }
14956: return unpack("%32C*",$prefix);
14957: }
14958:
1.76 www 14959: sub ireceipt {
1.474 albertel 14960: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 14961:
14962: my $return =&recprefix($fucourseid).'-';
14963:
14964: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
14965: $env{'request.state'} eq 'construct') {
14966: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
14967: return $return;
14968: }
14969:
1.76 www 14970: my $cuname=unpack("%32C*",$funame);
14971: my $cudom=unpack("%32C*",$fudom);
14972: my $cucourseid=unpack("%32C*",$fucourseid);
14973: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 14974: my $cunique=&recunique($fucourseid);
1.474 albertel 14975: my $cpart=unpack("%32S*",$part);
1.835 albertel 14976: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
14977:
1.790 albertel 14978: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 14979:
14980: $return.= ($cunique%$cuname+
14981: $cunique%$cudom+
14982: $cusymb%$cuname+
14983: $cusymb%$cudom+
14984: $cucourseid%$cuname+
14985: $cucourseid%$cudom+
14986: $cpart%$cuname+
14987: $cpart%$cudom);
14988: } else {
14989: $return.= ($cunique%$cuname+
14990: $cunique%$cudom+
14991: $cusymb%$cuname+
14992: $cusymb%$cudom+
14993: $cucourseid%$cuname+
14994: $cucourseid%$cudom);
14995: }
14996: return $return;
1.76 www 14997: }
14998:
14999: sub receipt {
1.474 albertel 15000: my ($part)=@_;
1.790 albertel 15001: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 15002: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 15003: }
1.260 ng 15004:
1.790 albertel 15005: sub whichuser {
15006: my ($passedsymb)=@_;
15007: my ($symb,$courseid,$domain,$name,$publicuser);
15008: if (defined($env{'form.grade_symb'})) {
15009: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
15010: my $allowed=&allowed('vgr',$tmp_courseid);
15011: if (!$allowed &&
15012: exists($env{'request.course.sec'}) &&
15013: $env{'request.course.sec'} !~ /^\s*$/) {
15014: $allowed=&allowed('vgr',$tmp_courseid.
15015: '/'.$env{'request.course.sec'});
15016: }
15017: if ($allowed) {
15018: ($symb)=&get_env_multiple('form.grade_symb');
15019: $courseid=$tmp_courseid;
15020: ($domain)=&get_env_multiple('form.grade_domain');
15021: ($name)=&get_env_multiple('form.grade_username');
15022: return ($symb,$courseid,$domain,$name,$publicuser);
15023: }
15024: }
15025: if (!$passedsymb) {
15026: $symb=&symbread();
15027: } else {
15028: $symb=$passedsymb;
15029: }
15030: $courseid=$env{'request.course.id'};
15031: $domain=$env{'user.domain'};
15032: $name=$env{'user.name'};
15033: if ($name eq 'public' && $domain eq 'public') {
15034: if (!defined($env{'form.username'})) {
15035: $env{'form.username'}.=time.rand(10000000);
15036: }
15037: $name.=$env{'form.username'};
15038: }
15039: return ($symb,$courseid,$domain,$name,$publicuser);
15040:
15041: }
15042:
1.36 albertel 15043: # ------------------------------------------------------------ Serves up a file
1.472 albertel 15044: # returns either the contents of the file or
15045: # -1 if the file doesn't exist
1.481 raeburn 15046: #
15047: # if the target is a file that was uploaded via DOCS,
15048: # a check will be made to see if a current copy exists on the local server,
15049: # if it does this will be served, otherwise a copy will be retrieved from
15050: # the home server for the course and stored in /home/httpd/html/userfiles on
15051: # the local server.
1.472 albertel 15052:
1.36 albertel 15053: sub getfile {
1.538 albertel 15054: my ($file) = @_;
1.609 banghart 15055: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 15056: &repcopy($file);
15057: return &readfile($file);
15058: }
15059:
15060: sub repcopy_userfile {
15061: my ($file)=@_;
1.1142 raeburn 15062: my $londocroot = $perlvar{'lonDocRoot'};
15063: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 15064: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 15065: my ($cdom,$cnum,$filename) =
1.811 albertel 15066: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 15067: my $uri="/uploaded/$cdom/$cnum/$filename";
15068: if (-e "$file") {
1.828 www 15069: # we already have a local copy, check it out
1.538 albertel 15070: my @fileinfo = stat($file);
1.828 www 15071: my $rtncode;
15072: my $info;
1.538 albertel 15073: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 15074: if ($lwpresp ne 'ok') {
1.828 www 15075: # there is no such file anymore, even though we had a local copy
1.482 albertel 15076: if ($rtncode eq '404') {
1.538 albertel 15077: unlink($file);
1.482 albertel 15078: }
15079: return -1;
15080: }
15081: if ($info < $fileinfo[9]) {
1.828 www 15082: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 15083: return 'ok';
1.828 www 15084: } else {
15085: # the file is outdated, get rid of it
15086: unlink($file);
1.482 albertel 15087: }
1.828 www 15088: }
15089: # one way or the other, at this point, we don't have the file
15090: # construct the correct path for the file
15091: my @parts = ($cdom,$cnum);
15092: if ($filename =~ m|^(.+)/[^/]+$|) {
15093: push @parts, split(/\//,$1);
15094: }
15095: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
15096: foreach my $part (@parts) {
15097: $path .= '/'.$part;
15098: if (!-e $path) {
15099: mkdir($path,0770);
1.482 albertel 15100: }
15101: }
1.828 www 15102: # now the path exists for sure
15103: # get a user agent
15104: my $transferfile=$file.'.in.transfer';
15105: # FIXME: this should flock
15106: if (-e $transferfile) { return 'ok'; }
15107: my $request;
15108: $uri=~s/^\///;
1.980 raeburn 15109: my $homeserver = &homeserver($cnum,$cdom);
1.1398 raeburn 15110: my $hostname = &hostname($homeserver);
1.980 raeburn 15111: my $protocol = $protocol{$homeserver};
15112: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 15113: $request=new HTTP::Request('GET',$protocol.'://'.$hostname.'/raw/'.$uri);
1.1345 raeburn 15114: my $response = &LONCAPA::LWPReq::makerequest($homeserver,$request,$transferfile,\%perlvar,'',0,1);
1.828 www 15115: # did it work?
15116: if ($response->is_error()) {
15117: unlink($transferfile);
15118: &logthis("Userfile repcopy failed for $uri");
15119: return -1;
15120: }
15121: # worked, rename the transfer file
15122: rename($transferfile,$file);
1.607 raeburn 15123: return 'ok';
1.481 raeburn 15124: }
15125:
1.517 albertel 15126: sub tokenwrapper {
15127: my $uri=shift;
1.980 raeburn 15128: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 15129: $uri=~s|^/||;
1.620 albertel 15130: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 15131: my $token=$1;
1.552 albertel 15132: my (undef,$udom,$uname,$file)=split('/',$uri,4);
15133: if ($udom && $uname && $file) {
15134: $file=~s|(\?\.*)*$||;
1.949 raeburn 15135: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 15136: my $homeserver = &homeserver($uname,$udom);
1.1397 raeburn 15137: my $hostname = &hostname($homeserver);
1.980 raeburn 15138: my $protocol = $protocol{$homeserver};
15139: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 15140: return $protocol.'://'.$hostname.'/'.$uri.
1.517 albertel 15141: (($uri=~/\?/)?'&':'?').'token='.$token.
15142: '&tokenissued='.$perlvar{'lonHostID'};
15143: } else {
15144: return '/adm/notfound.html';
15145: }
15146: }
15147:
1.828 www 15148: # call with reqtype HEAD: get last modification time
15149: # call with reqtype GET: get the file contents
15150: # Do not call this with reqtype GET for large files! It loads everything into memory
15151: #
1.481 raeburn 15152: sub getuploaded {
15153: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
15154: $uri=~s/^\///;
1.980 raeburn 15155: my $homeserver = &homeserver($cnum,$cdom);
1.1397 raeburn 15156: my $hostname = &hostname($homeserver);
1.980 raeburn 15157: my $protocol = $protocol{$homeserver};
15158: $protocol = 'http' if ($protocol ne 'https');
1.1397 raeburn 15159: $uri = $protocol.'://'.$hostname.'/raw/'.$uri;
1.481 raeburn 15160: my $request=new HTTP::Request($reqtype,$uri);
1.1345 raeburn 15161: my $response=&LONCAPA::LWPReq::makerequest($homeserver,$request,'',\%perlvar,'',0,1);
1.481 raeburn 15162: $$rtncode = $response->code;
1.482 albertel 15163: if (! $response->is_success()) {
15164: return 'failed';
15165: }
15166: if ($reqtype eq 'HEAD') {
1.486 www 15167: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 15168: } elsif ($reqtype eq 'GET') {
15169: $$info = $response->content;
1.472 albertel 15170: }
1.482 albertel 15171: return 'ok';
1.36 albertel 15172: }
15173:
1.481 raeburn 15174: sub readfile {
15175: my $file = shift;
15176: if ( (! -e $file ) || ($file eq '') ) { return -1; };
15177: my $fh;
1.1359 raeburn 15178: open($fh,"<",$file);
1.481 raeburn 15179: my $a='';
1.800 albertel 15180: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 15181: return $a;
15182: }
15183:
1.36 albertel 15184: sub filelocation {
1.590 banghart 15185: my ($dir,$file) = @_;
15186: my $location;
15187: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 15188:
15189: if ($file =~ m-^/adm/-) {
15190: $file=~s-^/adm/wrapper/-/-;
15191: $file=~s-^/adm/coursedocs/showdoc/-/-;
15192: }
1.882 albertel 15193:
1.1139 www 15194: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 15195: $location = $file;
1.609 banghart 15196: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 15197: my ($udom,$uname,$filename)=
1.811 albertel 15198: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 15199: my $home=&homeserver($uname,$udom);
15200: my $is_me=0;
15201: my @ids=¤t_machine_ids();
15202: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
15203: if ($is_me) {
1.1117 foxr 15204: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 15205: } else {
15206: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
15207: $udom.'/'.$uname.'/'.$filename;
15208: }
1.882 albertel 15209: } elsif ($file =~ m-^/adm/-) {
15210: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 15211: } else {
15212: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 15213: $file=~s:^/(res|priv)/:/:;
15214: my $space=$1;
1.590 banghart 15215: if ( !( $file =~ m:^/:) ) {
15216: $location = $dir. '/'.$file;
15217: } else {
1.1142 raeburn 15218: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 15219: }
1.59 albertel 15220: }
1.590 banghart 15221: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 15222: while ($location=~m{/\.\./}) {
15223: if ($location =~ m{/[^/]+/\.\./}) {
15224: $location=~ s{/[^/]+/\.\./}{/}g;
15225: } else {
15226: $location=~ s{/\.\./}{/}g;
15227: }
15228: } #remove dir/..
1.590 banghart 15229: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
15230: return $location;
1.46 www 15231: }
1.36 albertel 15232:
1.46 www 15233: sub hreflocation {
15234: my ($dir,$file)=@_;
1.980 raeburn 15235: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 15236: $file=filelocation($dir,$file);
1.700 albertel 15237: } elsif ($file=~m-^/adm/-) {
15238: $file=~s-^/adm/wrapper/-/-;
15239: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 15240: }
15241: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
15242: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
15243: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 15244: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
15245: {/uploaded/$1/$2/}x;
1.46 www 15246: }
1.913 albertel 15247: if ($file=~ m{^/userfiles/}) {
15248: $file =~ s{^/userfiles/}{/uploaded/};
15249: }
1.462 albertel 15250: return $file;
1.465 albertel 15251: }
15252:
1.1139 www 15253:
15254:
15255:
15256:
1.465 albertel 15257: sub current_machine_domains {
1.853 albertel 15258: return &machine_domains(&hostname($perlvar{'lonHostID'}));
15259: }
15260:
15261: sub machine_domains {
15262: my ($hostname) = @_;
1.465 albertel 15263: my @domains;
1.838 albertel 15264: my %hostname = &all_hostnames();
1.465 albertel 15265: while( my($id, $name) = each(%hostname)) {
1.467 matthew 15266: # &logthis("-$id-$name-$hostname-");
1.465 albertel 15267: if ($hostname eq $name) {
1.844 albertel 15268: push(@domains,&host_domain($id));
1.465 albertel 15269: }
15270: }
15271: return @domains;
15272: }
15273:
15274: sub current_machine_ids {
1.853 albertel 15275: return &machine_ids(&hostname($perlvar{'lonHostID'}));
15276: }
15277:
15278: sub machine_ids {
15279: my ($hostname) = @_;
15280: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 15281: my @ids;
1.888 albertel 15282: my %name_to_host = &all_names();
1.889 albertel 15283: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
15284: return @{ $name_to_host{$hostname} };
15285: }
15286: return;
1.31 www 15287: }
15288:
1.824 raeburn 15289: sub additional_machine_domains {
15290: my @domains;
1.1466 raeburn 15291: if (-e "$perlvar{'lonTabDir'}/expected_domains.tab") {
15292: if (open(my $fh,"<","$perlvar{'lonTabDir'}/expected_domains.tab")) {
15293: while (my $line = <$fh>) {
15294: chomp($line);
15295: $line =~ s/\s//g;
15296: push(@domains,$line);
15297: }
15298: close($fh);
15299: }
1.824 raeburn 15300: }
15301: return @domains;
15302: }
15303:
15304: sub default_login_domain {
15305: my $domain = $perlvar{'lonDefDomain'};
15306: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
15307: foreach my $posdom (¤t_machine_domains(),
15308: &additional_machine_domains()) {
15309: if (lc($posdom) eq lc($testdomain)) {
15310: $domain=$posdom;
15311: last;
15312: }
15313: }
15314: return $domain;
15315: }
15316:
1.1414 raeburn 15317: sub shared_institution {
1.1439 raeburn 15318: my ($dom,$lonhost) = @_;
15319: if ($lonhost eq '') {
15320: $lonhost = $perlvar{'lonHostID'};
15321: }
1.1414 raeburn 15322: my $same_intdom;
1.1439 raeburn 15323: my $hostintdom = &internet_dom($lonhost);
1.1414 raeburn 15324: if ($hostintdom ne '') {
15325: my %iphost = &get_iphost();
15326: my $primary_id = &domain($dom,'primary');
15327: my $primary_ip = &get_host_ip($primary_id);
15328: if (ref($iphost{$primary_ip}) eq 'ARRAY') {
15329: foreach my $id (@{$iphost{$primary_ip}}) {
15330: my $intdom = &internet_dom($id);
15331: if ($intdom eq $hostintdom) {
15332: $same_intdom = 1;
15333: last;
15334: }
15335: }
15336: }
15337: }
15338: return $same_intdom;
15339: }
15340:
1.1398 raeburn 15341: sub uses_sts {
15342: my ($ignore_cache) = @_;
15343: my $lonhost = $perlvar{'lonHostID'};
15344: my $hostname = &hostname($lonhost);
15345: my $sts_on;
15346: if ($protocol{$lonhost} eq 'https') {
15347: my $cachetime = 12*3600;
15348: if (!$ignore_cache) {
15349: ($sts_on,my $cached)=&is_cached_new('stspolicy',$lonhost);
15350: if (defined($cached)) {
15351: return $sts_on;
15352: }
15353: }
15354: my $url = $protocol{$lonhost}.'://'.$hostname.'/index.html';
15355: my $request=new HTTP::Request('HEAD',$url);
15356: my $response=&LONCAPA::LWPReq::makerequest($lonhost,$request,'',\%perlvar,'','','',1);
15357: if ($response->is_success) {
15358: my $has_sts = $response->header('Strict-Transport-Security');
15359: if ($has_sts eq '') {
15360: $sts_on = 0;
15361: } else {
15362: if ($has_sts =~ /\Qmax-age=\E(\d+)/) {
15363: my $maxage = $1;
15364: if ($maxage) {
15365: $sts_on = 1;
15366: } else {
15367: $sts_on = 0;
15368: }
15369: } else {
15370: $sts_on = 0;
15371: }
15372: }
15373: return &do_cache_new('stspolicy',$lonhost,$sts_on,$cachetime);
15374: }
15375: }
15376: return;
15377: }
15378:
1.1449 raeburn 15379: sub waf_allssl {
15380: my ($host_name) = @_;
15381: my $alias = &get_proxy_alias();
15382: if ($host_name eq '') {
15383: $host_name = $ENV{'SERVER_NAME'};
15384: }
15385: if (($host_name ne '') && ($alias eq $host_name)) {
15386: my $serverhomedom = &host_domain($perlvar{'lonHostID'});
15387: my %defdomdefaults = &get_domain_defaults($serverhomedom);
15388: if ($defdomdefaults{'waf_sslopt'}) {
15389: return $defdomdefaults{'waf_sslopt'};
15390: }
15391: }
15392: return;
15393: }
15394:
1.1434 raeburn 15395: sub get_requestor_ip {
15396: my ($r,$nolookup,$noproxy) = @_;
15397: my $from_ip;
15398: if (ref($r)) {
1.1447 raeburn 15399: if ($r->can('useragent_ip')) {
15400: if ($noproxy && $r->can('client_ip')) {
15401: $from_ip = $r->client_ip();
15402: } else {
15403: $from_ip = $r->useragent_ip();
15404: }
15405: } elsif ($r->connection->can('remote_ip')) {
15406: $from_ip = $r->connection->remote_ip();
15407: } else {
15408: $from_ip = $r->get_remote_host($nolookup);
15409: }
1.1434 raeburn 15410: } else {
15411: $from_ip = $ENV{'REMOTE_ADDR'};
15412: }
15413: return $from_ip if ($noproxy);
15414: # Who controls proxy settings for server
15415: my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
15416: my $proxyinfo = &get_proxy_settings($dom_in_use);
15417: if ((ref($proxyinfo) eq 'HASH') && ($from_ip)) {
1.1437 raeburn 15418: if ($proxyinfo->{'vpnint'}) {
15419: if (&ip_match($from_ip,$proxyinfo->{'vpnint'})) {
1.1434 raeburn 15420: return $from_ip;
15421: }
15422: }
15423: if ($proxyinfo->{'trusted'}) {
15424: if (&ip_match($from_ip,$proxyinfo->{'trusted'})) {
15425: my $ipheader = $proxyinfo->{'ipheader'};
15426: my ($ip,$xfor);
15427: if (ref($r)) {
15428: if ($ipheader) {
15429: $ip = $r->headers_in->{$ipheader};
15430: }
15431: $xfor = $r->headers_in->{'X-Forwarded-For'};
15432: } else {
15433: if ($ipheader) {
15434: $ip = $ENV{'HTTP_'.uc($ipheader)};
15435: }
15436: $xfor = $ENV{'HTTP_X_FORWARDED_FOR'};
15437: }
15438: if (($ip eq '') && ($xfor ne '')) {
15439: foreach my $poss_ip (reverse(split(/\s*,\s*/,$xfor))) {
15440: unless (&ip_match($poss_ip,$proxyinfo->{'trusted'})) {
15441: $ip = $poss_ip;
1.1435 raeburn 15442: last;
1.1434 raeburn 15443: }
15444: }
15445: }
15446: if ($ip ne '') {
15447: return $ip;
15448: }
15449: }
15450: }
15451: }
15452: return $from_ip;
15453: }
15454:
15455: sub get_proxy_settings {
15456: my ($dom_in_use) = @_;
1.1494 raeburn 15457: my %domdefaults = &get_domain_defaults($dom_in_use);
1.1434 raeburn 15458: my $proxyinfo = {
15459: ipheader => $domdefaults{'waf_ipheader'},
15460: trusted => $domdefaults{'waf_trusted'},
1.1437 raeburn 15461: vpnint => $domdefaults{'waf_vpnint'},
1.1438 raeburn 15462: vpnext => $domdefaults{'waf_vpnext'},
1.1449 raeburn 15463: sslopt => $domdefaults{'waf_sslopt'},
1.1434 raeburn 15464: };
15465: return $proxyinfo;
15466: }
15467:
15468: sub ip_match {
15469: my ($ip,$pattern_str) = @_;
15470: $ip=Net::CIDR::cidrvalidate($ip);
15471: if ($ip) {
15472: return Net::CIDR::cidrlookup($ip,split(/\s*,\s*/,$pattern_str));
15473: }
15474: return;
15475: }
15476:
15477: sub get_proxy_alias {
1.1450 raeburn 15478: my ($lonid) = @_;
15479: if ($lonid eq '') {
15480: $lonid = $perlvar{'lonHostID'};
15481: }
15482: if (!defined(&hostname($lonid))) {
15483: return;
15484: }
15485: if ($lonid ne '') {
15486: my ($alias,$cached) = &is_cached_new('proxyalias',$lonid);
1.1434 raeburn 15487: if ($cached) {
15488: return $alias;
15489: }
1.1494 raeburn 15490: my $dom = &host_domain($lonid);
1.1434 raeburn 15491: if ($dom ne '') {
15492: my $cachetime = 60*60*24;
15493: my %domconfig =
1.1494 raeburn 15494: &get_dom('configuration',['wafproxy'],$dom);
1.1437 raeburn 15495: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
15496: if (ref($domconfig{'wafproxy'}{'alias'}) eq 'HASH') {
1.1450 raeburn 15497: $alias = $domconfig{'wafproxy'}{'alias'}{$lonid};
15498: }
15499: }
15500: return &do_cache_new('proxyalias',$lonid,$alias,$cachetime);
15501: }
15502: }
15503: return;
15504: }
15505:
15506: sub use_proxy_alias {
15507: my ($r,$lonid) = @_;
15508: my $alias = &get_proxy_alias($lonid);
15509: if ($alias) {
15510: my $dom = &host_domain($lonid);
15511: if ($dom ne '') {
1.1467 raeburn 15512: my $proxyinfo = &get_proxy_settings($dom);
1.1450 raeburn 15513: my ($vpnint,$remote_ip);
15514: if (ref($proxyinfo) eq 'HASH') {
15515: $vpnint = $proxyinfo->{'vpnint'};
15516: if ($vpnint) {
15517: $remote_ip = &get_requestor_ip($r,1,1);
1.1434 raeburn 15518: }
15519: }
1.1450 raeburn 15520: unless ($vpnint && &ip_match($remote_ip,$vpnint)) {
15521: return $alias;
15522: }
1.1434 raeburn 15523: }
15524: }
15525: return;
15526: }
15527:
1.1474 raeburn 15528: sub alias_sso {
1.1467 raeburn 15529: my ($lonid) = @_;
15530: if ($lonid eq '') {
15531: $lonid = $perlvar{'lonHostID'};
15532: }
15533: if (!defined(&hostname($lonid))) {
15534: return;
15535: }
15536: if ($lonid ne '') {
15537: my ($use_alias,$cached) = &is_cached_new('proxysaml',$lonid);
15538: if ($cached) {
15539: return $use_alias;
15540: }
1.1494 raeburn 15541: my $dom = &host_domain($lonid);
1.1467 raeburn 15542: if ($dom ne '') {
15543: my $cachetime = 60*60*24;
15544: my %domconfig =
1.1494 raeburn 15545: &get_dom('configuration',['wafproxy'],$dom);
1.1467 raeburn 15546: if (ref($domconfig{'wafproxy'}) eq 'HASH') {
15547: if (ref($domconfig{'wafproxy'}{'saml'}) eq 'HASH') {
15548: $use_alias = $domconfig{'wafproxy'}{'saml'}{$lonid};
15549: }
15550: }
15551: return &do_cache_new('proxysaml',$lonid,$use_alias,$cachetime);
15552: }
15553: }
15554: return;
15555: }
15556:
1.1465 raeburn 15557: sub get_saml_landing {
15558: my ($lonid) = @_;
15559: if ($lonid eq '') {
15560: my $defdom = &default_login_domain();
15561: my @hosts = ¤t_machine_ids();
15562: if (@hosts > 1) {
15563: foreach my $hostid (@hosts) {
15564: if (&host_domain($hostid) eq $defdom) {
15565: $lonid = $hostid;
15566: last;
15567: }
15568: }
15569: } else {
15570: $lonid = $perlvar{'lonHostID'};
15571: }
15572: if ($lonid) {
1.1494 raeburn 15573: unless (&host_domain($lonid) eq $defdom) {
1.1465 raeburn 15574: return;
15575: }
15576: } else {
15577: return;
15578: }
15579: } elsif (!defined(&hostname($lonid))) {
15580: return;
15581: }
15582: my ($landing,$cached) = &is_cached_new('samllanding',$lonid);
15583: if ($cached) {
15584: return $landing;
15585: }
1.1494 raeburn 15586: my $dom = &host_domain($lonid);
1.1465 raeburn 15587: if ($dom ne '') {
15588: my $cachetime = 60*60*24;
15589: my %domconfig =
1.1494 raeburn 15590: &get_dom('configuration',['login'],$dom);
1.1465 raeburn 15591: if (ref($domconfig{'login'}) eq 'HASH') {
15592: if (ref($domconfig{'login'}{'saml'}) eq 'HASH') {
15593: if (ref($domconfig{'login'}{'saml'}{$lonid}) eq 'HASH') {
15594: $landing = 1;
15595: }
15596: }
15597: }
15598: return &do_cache_new('samllanding',$lonid,$landing,$cachetime);
15599: }
15600: return;
15601: }
15602:
1.31 www 15603: # ------------------------------------------------------------- Declutters URLs
15604:
15605: sub declutter {
15606: my $thisfn=shift;
1.569 albertel 15607: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261 raeburn 15608: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
15609: $thisfn=~s{^/home/httpd/html}{};
15610: }
1.31 www 15611: $thisfn=~s/^\///;
1.697 albertel 15612: $thisfn=~s|^adm/wrapper/||;
15613: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 15614: $thisfn=~s/^res\///;
1.1172 bisitz 15615: $thisfn=~s/^priv\///;
1.1032 raeburn 15616: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
15617: $thisfn=~s/\?.+$//;
15618: }
1.268 www 15619: return $thisfn;
15620: }
15621:
15622: # ------------------------------------------------------------- Clutter up URLs
15623:
15624: sub clutter {
15625: my $thisfn='/'.&declutter(shift);
1.887 albertel 15626: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 15627: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 15628: $thisfn='/res'.$thisfn;
15629: }
1.1031 raeburn 15630: if ($thisfn !~m|^/adm|) {
15631: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 15632: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 15633: } else {
15634: my ($ext) = ($thisfn =~ /\.(\w+)$/);
15635: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 15636: if ($embstyle eq 'ssi'
15637: || ($embstyle eq 'hdn')
15638: || ($embstyle eq 'rat')
15639: || ($embstyle eq 'prv')
15640: || ($embstyle eq 'ign')) {
15641: #do nothing with these
15642: } elsif (($embstyle eq 'img')
1.695 albertel 15643: || ($embstyle eq 'emb')
15644: || ($embstyle eq 'wrp')) {
15645: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 15646: } elsif ($embstyle eq 'unk'
15647: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 15648: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 15649: } else {
1.718 www 15650: # &logthis("Got a blank emb style");
1.695 albertel 15651: }
1.694 albertel 15652: }
1.1343 raeburn 15653: } elsif ($thisfn =~ m{^/adm/$match_domain/$match_courseid/\d+/ext\.tool$}) {
1.1298 raeburn 15654: $thisfn='/adm/wrapper'.$thisfn;
1.694 albertel 15655: }
1.31 www 15656: return $thisfn;
1.12 www 15657: }
15658:
1.787 albertel 15659: sub clutter_with_no_wrapper {
15660: my $uri = &clutter(shift);
15661: if ($uri =~ m-^/adm/-) {
15662: $uri =~ s-^/adm/wrapper/-/-;
15663: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
15664: }
15665: return $uri;
15666: }
15667:
1.557 albertel 15668: sub freeze_escape {
15669: my ($value)=@_;
15670: if (ref($value)) {
15671: $value=&nfreeze($value);
15672: return '__FROZEN__'.&escape($value);
15673: }
15674: return &escape($value);
15675: }
15676:
1.11 www 15677:
1.557 albertel 15678: sub thaw_unescape {
15679: my ($value)=@_;
15680: if ($value =~ /^__FROZEN__/) {
15681: substr($value,0,10,undef);
15682: $value=&unescape($value);
15683: return &thaw($value);
15684: }
15685: return &unescape($value);
15686: }
15687:
1.436 albertel 15688: sub correct_line_ends {
15689: my ($result)=@_;
15690: $$result =~s/\r\n/\n/mg;
15691: $$result =~s/\r/\n/mg;
1.415 albertel 15692: }
1.1 albertel 15693: # ================================================================ Main Program
15694:
1.184 www 15695: sub goodbye {
1.204 albertel 15696: &logthis("Starting Shut down");
1.443 albertel 15697: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 15698: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 15699: #converted
1.599 albertel 15700: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 15701: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
15702: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
15703: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 15704: #1.1 only
1.870 albertel 15705: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
15706: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
15707: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
15708: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
15709: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 15710: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
15711: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 15712: &flushcourselogs();
15713: &logthis("Shutting down");
15714: }
15715:
1.852 albertel 15716: sub get_dns {
1.1210 raeburn 15717: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 15718: if (!$ignore_cache) {
15719: my ($content,$cached)=
1.1494 raeburn 15720: &is_cached_new('dns',$url);
1.869 albertel 15721: if ($cached) {
1.1210 raeburn 15722: &$func($content,$hashref);
1.869 albertel 15723: return;
15724: }
15725: }
15726:
15727: my %alldns;
1.1379 raeburn 15728: if (open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab")) {
15729: foreach my $dns (<$config>) {
15730: next if ($dns !~ /^\^(\S*)/x);
15731: my $line = $1;
15732: my ($host,$protocol) = split(/:/,$line);
15733: if ($protocol ne 'https') {
15734: $protocol = 'http';
15735: }
15736: $alldns{$host} = $protocol;
1.979 raeburn 15737: }
1.1379 raeburn 15738: close($config);
1.869 albertel 15739: }
15740: while (%alldns) {
1.1263 raeburn 15741: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.1456 raeburn 15742: my ($contents,@content);
15743: if ($dns eq Sys::Hostname::FQDN::fqdn()) {
15744: my $command = (split('/',$url))[3];
15745: my ($dir,$file) = &parse_getdns_url($command,$url);
15746: delete($alldns{$dns});
15747: next if (($dir eq '') || ($file eq ''));
15748: if (open(my $config,'<',"$dir/$file")) {
1.1457 raeburn 15749: @content = <$config>;
1.1456 raeburn 15750: close($config);
15751: }
15752: if ($url eq '/adm/dns/loncapaCRL') {
15753: $contents = join('',@content);
15754: }
15755: } else {
15756: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
15757: my $response = &LONCAPA::LWPReq::makerequest('',$request,'',\%perlvar,30,0);
15758: delete($alldns{$dns});
15759: next if ($response->is_error());
15760: if ($url eq '/adm/dns/loncapaCRL') {
15761: $contents = $response->content;
15762: } else {
15763: @content = split("\n",$response->content);
15764: }
15765: }
1.1379 raeburn 15766: if ($url eq '/adm/dns/loncapaCRL') {
1.1456 raeburn 15767: return &$func($contents);
1.1379 raeburn 15768: } else {
15769: unless ($nocache) {
15770: &do_cache_new('dns',$url,\@content,30*24*60*60);
15771: }
15772: &$func(\@content,$hashref);
15773: return;
15774: }
15775: }
15776: my $which = (split('/',$url,4))[3];
15777: if ($which eq 'loncapaCRL') {
15778: my $diskfile = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
15779: if (-e $diskfile) {
15780: &logthis("unable to contact DNS, on disk file $diskfile not updated");
15781: } else {
15782: &logthis("unable to contact DNS, no on disk file $diskfile available");
15783: }
15784: } else {
15785: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
15786: if (open(my $config,"<","$perlvar{'lonTabDir'}/dns_$which.tab")) {
15787: my @content = <$config>;
15788: close($config);
15789: &$func(\@content,$hashref);
15790: }
1.852 albertel 15791: }
1.1210 raeburn 15792: return;
15793: }
15794:
15795: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 15796: sub parse_dns_checksums_tab {
1.1210 raeburn 15797: my ($lines,$hashref) = @_;
1.1264 raeburn 15798: my $lonhost = $perlvar{'lonHostID'};
1.1494 raeburn 15799: my $machine_dom = &host_domain($lonhost);
1.1210 raeburn 15800: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264 raeburn 15801: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
15802: my $webconfdir = '/etc/httpd/conf';
15803: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
15804: $webconfdir = '/etc/apache2';
15805: } elsif ($distro =~ /^sles(\d+)$/) {
15806: if ($1 >= 10) {
15807: $webconfdir = '/etc/apache2';
15808: }
15809: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
15810: if ($1 >= 10.0) {
15811: $webconfdir = '/etc/apache2';
15812: }
15813: }
1.1210 raeburn 15814: my ($release,$timestamp) = split(/\-/,$loncaparev);
15815: my (%chksum,%revnum);
15816: if (ref($lines) eq 'ARRAY') {
15817: chomp(@{$lines});
1.1238 raeburn 15818: my $version = shift(@{$lines});
15819: if ($version eq $release) {
1.1210 raeburn 15820: foreach my $line (@{$lines}) {
1.1238 raeburn 15821: my ($file,$version,$shasum) = split(/,/,$line);
1.1264 raeburn 15822: if ($file =~ m{^/etc/httpd/conf}) {
15823: if ($webconfdir eq '/etc/apache2') {
15824: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
15825: }
15826: }
1.1238 raeburn 15827: $chksum{$file} = $shasum;
15828: $revnum{$file} = $version;
1.1210 raeburn 15829: }
15830: if (ref($hashref) eq 'HASH') {
15831: %{$hashref} = (
15832: sums => \%chksum,
15833: versions => \%revnum,
15834: );
15835: }
15836: }
15837: }
1.869 albertel 15838: return;
1.852 albertel 15839: }
1.1210 raeburn 15840:
15841: sub fetch_dns_checksums {
1.1238 raeburn 15842: my %checksums;
1.1494 raeburn 15843: my $machine_dom = &host_domain($perlvar{'lonHostID'});
1.1260 raeburn 15844: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238 raeburn 15845: my ($release,$timestamp) = split(/\-/,$loncaparev);
15846: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211 raeburn 15847: \%checksums);
1.1210 raeburn 15848: return \%checksums;
15849: }
15850:
1.1379 raeburn 15851: sub fetch_crl_pemfile {
15852: return &get_dns("/adm/dns/loncapaCRL",\&save_crl_pem,1,1);
15853: }
15854:
15855: sub save_crl_pem {
1.1456 raeburn 15856: my ($content) = @_;
1.1380 raeburn 15857: my ($msg,$hadchanges);
1.1456 raeburn 15858: if ($content ne '') {
1.1379 raeburn 15859: my $now = time;
15860: my $lonca = $perlvar{'lonCertificateDirectory'}.'/'.$perlvar{'lonnetCertificateAuthority'};
15861: my $tmpcrl = $tmpdir.'/'.$perlvar{'lonnetCertRevocationList'}.'_'.$now.'.'.$$.'.tmp';
15862: if (open(my $fh,'>',"$tmpcrl")) {
1.1456 raeburn 15863: print $fh $content;
1.1379 raeburn 15864: close($fh);
15865: if (-e $lonca) {
15866: if (open(PIPE,"openssl crl -in $tmpcrl -inform pem -CAfile $lonca -noout 2>&1 |")) {
15867: my $check = <PIPE>;
15868: close(PIPE);
15869: chomp($check);
15870: if ($check eq 'verify OK') {
15871: my $dest = "$perlvar{'lonCertificateDirectory'}/$perlvar{'lonnetCertRevocationList'}";
1.1380 raeburn 15872: my $backup;
1.1379 raeburn 15873: if (-e $dest) {
1.1380 raeburn 15874: if (&File::Copy::move($dest,"$dest.bak")) {
15875: $backup = 'ok';
15876: }
1.1379 raeburn 15877: }
15878: if (&File::Copy::move($tmpcrl,$dest)) {
15879: $msg = 'ok';
1.1380 raeburn 15880: if ($backup) {
15881: my (%oldnums,%newnums);
15882: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest.bak |grep 'Serial Number' |")) {
15883: while (<PIPE>) {
15884: $oldnums{(split(/:/))[1]} = 1;
15885: }
15886: close(PIPE);
15887: }
15888: if (open(PIPE, "openssl crl -inform PEM -text -noout -in $dest |grep 'Serial Number' |")) {
15889: while(<PIPE>) {
15890: $newnums{(split(/:/))[1]} = 1;
15891: }
15892: close(PIPE);
15893: }
15894: foreach my $key (sort {$b <=> $a } (keys(%newnums))) {
15895: unless (exists($oldnums{$key})) {
15896: $hadchanges = 1;
15897: last;
15898: }
15899: }
15900: unless ($hadchanges) {
15901: foreach my $key (sort {$b <=> $a } (keys(%oldnums))) {
15902: unless (exists($newnums{$key})) {
15903: $hadchanges = 1;
15904: last;
15905: }
15906: }
15907: }
15908: }
1.1379 raeburn 15909: }
15910: } else {
15911: unlink($tmpcrl);
15912: }
15913: } else {
15914: unlink($tmpcrl);
15915: }
15916: } else {
15917: unlink($tmpcrl);
15918: }
15919: }
15920: }
1.1380 raeburn 15921: return ($msg,$hadchanges);
1.1379 raeburn 15922: }
15923:
1.1456 raeburn 15924: sub parse_getdns_url {
15925: my ($command,$url) = @_;
15926: my $dir = $perlvar{'lonTabDir'};
15927: my $file;
15928: if ($command eq 'hosts') {
15929: $file = 'dns_hosts.tab';
15930: } elsif ($command eq 'domain') {
15931: $file = 'dns_domain.tab';
15932: } elsif ($command eq 'checksums') {
15933: my $version = (split('/',$url))[4];
15934: $file = "dns_checksums/$version.tab",
15935: } elsif ($command eq 'loncapaCRL') {
15936: $dir = $perlvar{'lonCertificateDirectory'};
15937: $file = $perlvar{'lonnetCertRevocationList'};
15938: }
15939: return ($dir,$file);
15940: }
15941:
1.327 albertel 15942: # ------------------------------------------------------------ Read domain file
15943: {
1.852 albertel 15944: my $loaded;
1.846 albertel 15945: my %domain;
15946:
1.852 albertel 15947: sub parse_domain_tab {
15948: my ($lines) = @_;
15949: foreach my $line (@$lines) {
15950: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 15951:
1.846 albertel 15952: chomp($line);
1.852 albertel 15953: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 15954: my %this_domain;
15955: foreach my $field ('description', 'auth_def', 'auth_arg_def',
15956: 'lang_def', 'city', 'longi', 'lati',
15957: 'primary') {
15958: $this_domain{$field} = shift(@elements);
15959: }
15960: $domain{$name} = \%this_domain;
1.852 albertel 15961: }
15962: }
1.864 albertel 15963:
15964: sub reset_domain_info {
15965: undef($loaded);
15966: undef(%domain);
15967: }
15968:
1.852 albertel 15969: sub load_domain_tab {
1.1293 raeburn 15970: my ($ignore_cache,$nocache) = @_;
15971: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 15972: my $fh;
1.1359 raeburn 15973: if (open($fh,"<",$perlvar{'lonTabDir'}.'/domain.tab')) {
1.852 albertel 15974: my @lines = <$fh>;
15975: &parse_domain_tab(\@lines);
1.448 albertel 15976: }
1.852 albertel 15977: close($fh);
15978: $loaded = 1;
1.327 albertel 15979: }
1.846 albertel 15980:
15981: sub domain {
1.852 albertel 15982: &load_domain_tab() if (!$loaded);
15983:
1.846 albertel 15984: my ($name,$what) = @_;
15985: return if ( !exists($domain{$name}) );
15986:
15987: if (!$what) {
15988: return $domain{$name}{'description'};
15989: }
15990: return $domain{$name}{$what};
15991: }
1.974 raeburn 15992:
15993: sub domain_info {
15994: &load_domain_tab() if (!$loaded);
15995: return %domain;
15996: }
15997:
1.327 albertel 15998: }
15999:
16000:
1.1 albertel 16001: # ------------------------------------------------------------- Read hosts file
16002: {
1.838 albertel 16003: my %hostname;
1.844 albertel 16004: my %hostdom;
1.845 albertel 16005: my %libserv;
1.852 albertel 16006: my $loaded;
1.888 albertel 16007: my %name_to_host;
1.1074 raeburn 16008: my %internetdom;
1.1107 raeburn 16009: my %LC_dns_serv;
1.852 albertel 16010:
16011: sub parse_hosts_tab {
16012: my ($file) = @_;
16013: foreach my $configline (@$file) {
16014: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 16015: chomp($configline);
16016: if ($configline =~ /^\^/) {
16017: if ($configline =~ /^\^([\w.\-]+)/) {
16018: $LC_dns_serv{$1} = 1;
16019: }
16020: next;
16021: }
1.1074 raeburn 16022: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 16023: $name=~s/\s//g;
16024: if ($id && $domain && $role && $name) {
1.1351 raeburn 16025: if ((exists($hostname{$id})) && ($hostname{$id} ne '')) {
16026: my $curr = $hostname{$id};
16027: my $skip;
16028: if (ref($name_to_host{$curr}) eq 'ARRAY') {
16029: if (($curr eq $name) && (@{$name_to_host{$curr}} == 1)) {
16030: $skip = 1;
16031: } else {
16032: @{$name_to_host{$curr}} = grep { $_ ne $id } @{$name_to_host{$curr}};
16033: }
16034: }
16035: unless ($skip) {
16036: push(@{$name_to_host{$name}},$id);
16037: }
16038: } else {
16039: push(@{$name_to_host{$name}},$id);
16040: }
1.852 albertel 16041: $hostname{$id}=$name;
16042: $hostdom{$id}=$domain;
16043: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 16044: if (defined($protocol)) {
16045: if ($protocol eq 'https') {
16046: $protocol{$id} = $protocol;
16047: } else {
16048: $protocol{$id} = 'http';
16049: }
1.968 raeburn 16050: } else {
1.969 raeburn 16051: $protocol{$id} = 'http';
1.968 raeburn 16052: }
1.1074 raeburn 16053: if (defined($intdom)) {
16054: $internetdom{$id} = $intdom;
16055: }
1.852 albertel 16056: }
16057: }
16058: }
1.864 albertel 16059:
16060: sub reset_hosts_info {
1.897 albertel 16061: &purge_remembered();
1.864 albertel 16062: &reset_domain_info();
16063: &reset_hosts_ip_info();
1.1339 raeburn 16064: undef(%internetdom);
1.892 albertel 16065: undef(%name_to_host);
1.864 albertel 16066: undef(%hostname);
16067: undef(%hostdom);
16068: undef(%libserv);
16069: undef($loaded);
16070: }
1.1 albertel 16071:
1.852 albertel 16072: sub load_hosts_tab {
1.1293 raeburn 16073: my ($ignore_cache,$nocache) = @_;
16074: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.1359 raeburn 16075: open(my $config,"<","$perlvar{'lonTabDir'}/hosts.tab");
1.852 albertel 16076: my @config = <$config>;
16077: &parse_hosts_tab(\@config);
16078: close($config);
16079: $loaded=1;
1.1 albertel 16080: }
1.852 albertel 16081:
1.838 albertel 16082: sub hostname {
1.852 albertel 16083: &load_hosts_tab() if (!$loaded);
16084:
1.838 albertel 16085: my ($lonid) = @_;
16086: return $hostname{$lonid};
16087: }
1.845 albertel 16088:
1.838 albertel 16089: sub all_hostnames {
1.852 albertel 16090: &load_hosts_tab() if (!$loaded);
16091:
1.838 albertel 16092: return %hostname;
16093: }
1.845 albertel 16094:
1.888 albertel 16095: sub all_names {
1.1293 raeburn 16096: my ($ignore_cache,$nocache) = @_;
16097: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 16098:
16099: return %name_to_host;
16100: }
16101:
1.974 raeburn 16102: sub all_host_domain {
16103: &load_hosts_tab() if (!$loaded);
16104: return %hostdom;
16105: }
16106:
1.1339 raeburn 16107: sub all_host_intdom {
16108: &load_hosts_tab() if (!$loaded);
16109: return %internetdom;
16110: }
16111:
1.845 albertel 16112: sub is_library {
1.852 albertel 16113: &load_hosts_tab() if (!$loaded);
16114:
1.845 albertel 16115: return exists($libserv{$_[0]});
16116: }
16117:
16118: sub all_library {
1.852 albertel 16119: &load_hosts_tab() if (!$loaded);
16120:
1.845 albertel 16121: return %libserv;
16122: }
16123:
1.1062 droeschl 16124: sub unique_library {
16125: #2x reverse removes all hostnames that appear more than once
16126: my %unique = reverse &all_library();
16127: return reverse %unique;
16128: }
16129:
1.841 albertel 16130: sub get_servers {
1.852 albertel 16131: &load_hosts_tab() if (!$loaded);
16132:
1.841 albertel 16133: my ($domain,$type) = @_;
16134: my %possible_hosts = ($type eq 'library') ? %libserv
16135: : %hostname;
16136: my %result;
1.842 albertel 16137: if (ref($domain) eq 'ARRAY') {
16138: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 16139: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 16140: $result{$host} = $hostname;
16141: }
16142: }
16143: } else {
16144: while ( my ($host,$hostname) = each(%possible_hosts)) {
16145: if ($hostdom{$host} eq $domain) {
16146: $result{$host} = $hostname;
16147: }
1.841 albertel 16148: }
16149: }
16150: return %result;
16151: }
1.845 albertel 16152:
1.1062 droeschl 16153: sub get_unique_servers {
16154: my %unique = reverse &get_servers(@_);
16155: return reverse %unique;
16156: }
16157:
1.844 albertel 16158: sub host_domain {
1.852 albertel 16159: &load_hosts_tab() if (!$loaded);
16160:
1.844 albertel 16161: my ($lonid) = @_;
16162: return $hostdom{$lonid};
16163: }
16164:
1.841 albertel 16165: sub all_domains {
1.852 albertel 16166: &load_hosts_tab() if (!$loaded);
16167:
1.841 albertel 16168: my %seen;
16169: my @uniq = grep(!$seen{$_}++, values(%hostdom));
16170: return @uniq;
16171: }
1.1074 raeburn 16172:
16173: sub internet_dom {
16174: &load_hosts_tab() if (!$loaded);
16175:
16176: my ($lonid) = @_;
16177: return $internetdom{$lonid};
16178: }
1.1107 raeburn 16179:
16180: sub is_LC_dns {
16181: &load_hosts_tab() if (!$loaded);
16182:
16183: my ($hostname) = @_;
16184: return exists($LC_dns_serv{$hostname});
16185: }
16186:
1.1 albertel 16187: }
16188:
1.847 albertel 16189: {
16190: my %iphost;
1.856 albertel 16191: my %name_to_ip;
16192: my %lonid_to_ip;
1.869 albertel 16193:
1.847 albertel 16194: sub get_hosts_from_ip {
16195: my ($ip) = @_;
16196: my %iphosts = &get_iphost();
16197: if (ref($iphosts{$ip})) {
16198: return @{$iphosts{$ip}};
16199: }
16200: return;
1.839 albertel 16201: }
1.864 albertel 16202:
16203: sub reset_hosts_ip_info {
16204: undef(%iphost);
16205: undef(%name_to_ip);
16206: undef(%lonid_to_ip);
16207: }
1.856 albertel 16208:
16209: sub get_host_ip {
16210: my ($lonid) = @_;
16211: if (exists($lonid_to_ip{$lonid})) {
16212: return $lonid_to_ip{$lonid};
16213: }
16214: my $name=&hostname($lonid);
16215: my $ip = gethostbyname($name);
16216: return if (!$ip || length($ip) ne 4);
16217: $ip=inet_ntoa($ip);
16218: $name_to_ip{$name} = $ip;
16219: $lonid_to_ip{$lonid} = $ip;
16220: return $ip;
16221: }
1.847 albertel 16222:
16223: sub get_iphost {
1.1293 raeburn 16224: my ($ignore_cache,$nocache) = @_;
1.894 albertel 16225:
1.869 albertel 16226: if (!$ignore_cache) {
16227: if (%iphost) {
16228: return %iphost;
16229: }
16230: my ($ip_info,$cached)=
1.1494 raeburn 16231: &is_cached_new('iphost','iphost');
1.869 albertel 16232: if ($cached) {
16233: %iphost = %{$ip_info->[0]};
16234: %name_to_ip = %{$ip_info->[1]};
16235: %lonid_to_ip = %{$ip_info->[2]};
16236: return %iphost;
16237: }
16238: }
1.894 albertel 16239:
16240: # get yesterday's info for fallback
16241: my %old_name_to_ip;
16242: my ($ip_info,$cached)=
1.1495 raeburn 16243: &is_cached_new('iphost','iphost');
1.894 albertel 16244: if ($cached) {
16245: %old_name_to_ip = %{$ip_info->[1]};
16246: }
16247:
1.1293 raeburn 16248: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 16249: foreach my $name (keys(%name_to_host)) {
1.847 albertel 16250: my $ip;
16251: if (!exists($name_to_ip{$name})) {
16252: $ip = gethostbyname($name);
16253: if (!$ip || length($ip) ne 4) {
1.894 albertel 16254: if (defined($old_name_to_ip{$name})) {
16255: $ip = $old_name_to_ip{$name};
16256: &logthis("Can't find $name defaulting to old $ip");
16257: } else {
16258: &logthis("Name $name no IP found");
16259: next;
16260: }
16261: } else {
16262: $ip=inet_ntoa($ip);
1.847 albertel 16263: }
16264: $name_to_ip{$name} = $ip;
16265: } else {
16266: $ip = $name_to_ip{$name};
1.653 albertel 16267: }
1.888 albertel 16268: foreach my $id (@{ $name_to_host{$name} }) {
16269: $lonid_to_ip{$id} = $ip;
16270: }
16271: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 16272: }
1.1293 raeburn 16273: unless ($nocache) {
16274: &do_cache_new('iphost','iphost',
16275: [\%iphost,\%name_to_ip,\%lonid_to_ip],
16276: 48*60*60);
16277: }
1.869 albertel 16278:
1.847 albertel 16279: return %iphost;
1.598 albertel 16280: }
16281:
1.992 raeburn 16282: #
16283: # Given a DNS returns the loncapa host name for that DNS
16284: #
16285: sub host_from_dns {
16286: my ($dns) = @_;
16287: my @hosts;
16288: my $ip;
16289:
1.993 raeburn 16290: if (exists($name_to_ip{$dns})) {
1.992 raeburn 16291: $ip = $name_to_ip{$dns};
16292: }
16293: if (!$ip) {
16294: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
16295: if (length($ip) == 4) {
16296: $ip = &IO::Socket::inet_ntoa($ip);
16297: }
16298: }
16299: if ($ip) {
16300: @hosts = get_hosts_from_ip($ip);
16301: return $hosts[0];
16302: }
16303: return undef;
1.986 foxr 16304: }
1.992 raeburn 16305:
1.1074 raeburn 16306: sub get_internet_names {
16307: my ($lonid) = @_;
16308: return if ($lonid eq '');
16309: my ($idnref,$cached)=
1.1494 raeburn 16310: &is_cached_new('internetnames',$lonid);
1.1074 raeburn 16311: if ($cached) {
16312: return $idnref;
16313: }
16314: my $ip = &get_host_ip($lonid);
16315: my @hosts = &get_hosts_from_ip($ip);
16316: my %iphost = &get_iphost();
16317: my (@idns,%seen);
16318: foreach my $id (@hosts) {
16319: my $dom = &host_domain($id);
16320: my $prim_id = &domain($dom,'primary');
16321: my $prim_ip = &get_host_ip($prim_id);
16322: next if ($seen{$prim_ip});
16323: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
16324: foreach my $id (@{$iphost{$prim_ip}}) {
16325: my $intdom = &internet_dom($id);
16326: unless (grep(/^\Q$intdom\E$/,@idns)) {
16327: push(@idns,$intdom);
16328: }
16329: }
16330: }
16331: $seen{$prim_ip} = 1;
16332: }
1.1219 raeburn 16333: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 16334: }
16335:
1.986 foxr 16336: }
16337:
1.1079 raeburn 16338: sub all_loncaparevs {
1.1249 raeburn 16339: 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 16340: }
16341:
1.1227 raeburn 16342: # ---------------------------------------------------------- Read loncaparev table
16343: {
16344: sub load_loncaparevs {
16345: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
1.1359 raeburn 16346: if (open(my $config,"<","$perlvar{'lonTabDir'}/loncaparevs.tab")) {
1.1227 raeburn 16347: while (my $configline=<$config>) {
16348: chomp($configline);
16349: my ($hostid,$loncaparev)=split(/:/,$configline);
16350: $loncaparevs{$hostid}=$loncaparev;
16351: }
16352: close($config);
16353: }
16354: }
16355: }
16356: }
16357:
16358: # ---------------------------------------------------------- Read serverhostID table
16359: {
16360: sub load_serverhomeIDs {
16361: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
1.1359 raeburn 16362: if (open(my $config,"<","$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
1.1227 raeburn 16363: while (my $configline=<$config>) {
16364: chomp($configline);
16365: my ($name,$id)=split(/:/,$configline);
16366: $serverhomeIDs{$name}=$id;
16367: }
16368: close($config);
16369: }
16370: }
16371: }
16372: }
16373:
16374:
1.862 albertel 16375: BEGIN {
16376:
16377: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
16378: unless ($readit) {
16379: {
16380: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
16381: %perlvar = (%perlvar,%{$configvars});
16382: }
16383:
16384:
1.1 albertel 16385: # ------------------------------------------------------ Read spare server file
16386: {
1.1359 raeburn 16387: open(my $config,"<","$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 16388:
16389: while (my $configline=<$config>) {
16390: chomp($configline);
1.284 matthew 16391: if ($configline) {
1.784 albertel 16392: my ($host,$type) = split(':',$configline,2);
1.785 albertel 16393: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 16394: push(@{ $spareid{$type} }, $host);
1.1 albertel 16395: }
16396: }
1.448 albertel 16397: close($config);
1.1 albertel 16398: }
1.11 www 16399: # ------------------------------------------------------------ Read permissions
16400: {
1.1359 raeburn 16401: open(my $config,"<","$perlvar{'lonTabDir'}/roles.tab");
1.11 www 16402:
16403: while (my $configline=<$config>) {
1.448 albertel 16404: chomp($configline);
16405: if ($configline) {
16406: my ($role,$perm)=split(/ /,$configline);
16407: if ($perm ne '') { $pr{$role}=$perm; }
16408: }
1.11 www 16409: }
1.448 albertel 16410: close($config);
1.11 www 16411: }
16412:
16413: # -------------------------------------------- Read plain texts for permissions
16414: {
1.1359 raeburn 16415: open(my $config,"<","$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 16416:
16417: while (my $configline=<$config>) {
1.448 albertel 16418: chomp($configline);
16419: if ($configline) {
1.742 raeburn 16420: my ($short,@plain)=split(/:/,$configline);
16421: %{$prp{$short}} = ();
16422: if (@plain > 0) {
16423: $prp{$short}{'std'} = $plain[0];
16424: for (my $i=1; $i<@plain; $i++) {
16425: $prp{$short}{'alt'.$i} = $plain[$i];
16426: }
16427: }
1.448 albertel 16428: }
1.135 www 16429: }
1.448 albertel 16430: close($config);
1.135 www 16431: }
16432:
16433: # ---------------------------------------------------------- Read package table
16434: {
1.1359 raeburn 16435: open(my $config,"<","$perlvar{'lonTabDir'}/packages.tab");
1.135 www 16436:
16437: while (my $configline=<$config>) {
1.483 albertel 16438: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 16439: chomp($configline);
16440: my ($short,$plain)=split(/:/,$configline);
16441: my ($pack,$name)=split(/\&/,$short);
16442: if ($plain ne '') {
16443: $packagetab{$pack.'&'.$name.'&name'}=$name;
16444: $packagetab{$short}=$plain;
16445: }
1.11 www 16446: }
1.448 albertel 16447: close($config);
1.329 matthew 16448: }
16449:
1.1073 raeburn 16450: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 16451:
16452: &load_loncaparevs();
1.1073 raeburn 16453:
1.1074 raeburn 16454: # ---------------------------------------------------------- Read serverhostID table
16455:
1.1227 raeburn 16456: &load_serverhomeIDs();
16457:
16458: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 16459: {
16460: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
16461: if (-e $file) {
16462: my $parser = HTML::LCParser->new($file);
16463: while (my $token = $parser->get_token()) {
16464: if ($token->[0] eq 'S') {
16465: my $item = $token->[1];
16466: my $name = $token->[2]{'name'};
16467: my $value = $token->[2]{'value'};
1.1285 raeburn 16468: my $valuematch = $token->[2]{'valuematch'};
1.1303 raeburn 16469: my $namematch = $token->[2]{'namematch'};
16470: if ($item eq 'parameter') {
16471: if (($namematch ne '') || (($name ne '') && ($value ne '' || $valuematch ne ''))) {
16472: my $release = $parser->get_text();
16473: $release =~ s/(^\s*|\s*$ )//gx;
16474: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch.':'.$namematch} = $release;
16475: }
16476: } elsif ($item ne '' && $name ne '') {
1.1079 raeburn 16477: my $release = $parser->get_text();
16478: $release =~ s/(^\s*|\s*$ )//gx;
1.1303 raeburn 16479: $needsrelease{$item.':'.$name.':'.$value} = $release;
1.1079 raeburn 16480: }
16481: }
16482: }
16483: }
1.1073 raeburn 16484: }
16485:
1.1138 raeburn 16486: # ---------------------------------------------------------- Read managers table
16487: {
16488: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
1.1359 raeburn 16489: if (open(my $config,"<","$perlvar{'lonTabDir'}/managers.tab")) {
1.1138 raeburn 16490: while (my $configline=<$config>) {
16491: chomp($configline);
16492: next if ($configline =~ /^\#/);
16493: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
16494: $managerstab{$configline} = 1;
16495: }
16496: }
16497: close($config);
16498: }
16499: }
16500: }
16501:
1.329 matthew 16502: # ------------- set up temporary directory
16503: {
1.1117 foxr 16504: $tmpdir = LONCAPA::tempdir();
1.329 matthew 16505:
1.11 www 16506: }
16507:
1.1405 raeburn 16508: # ------------- set default texengine (domain default overrides this)
16509: {
16510: $deftex = LONCAPA::texengine();
16511: }
16512:
1.1416 raeburn 16513: # ------------- set default minimum length for passwords for internal auth users
16514: {
16515: $passwdmin = LONCAPA::passwd_min();
16516: }
16517:
1.794 albertel 16518: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
16519: 'compress_threshold'=> 20_000,
16520: });
1.185 www 16521:
1.281 www 16522: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 16523: $dumpcount=0;
1.958 www 16524: $locknum=0;
1.22 www 16525:
1.163 harris41 16526: &logtouch();
1.672 albertel 16527: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 16528: $readit=1;
1.564 albertel 16529: {
16530: use integer;
16531: my $test=(2**32)+1;
1.568 albertel 16532: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 16533: &logthis(" Detected 64bit platform ($_64bit)");
16534: }
1.195 www 16535: }
1.1 albertel 16536: }
1.179 www 16537:
1.1 albertel 16538: 1;
1.191 harris41 16539: __END__
16540:
1.243 albertel 16541: =pod
16542:
1.191 harris41 16543: =head1 NAME
16544:
1.243 albertel 16545: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 16546:
16547: =head1 SYNOPSIS
16548:
1.243 albertel 16549: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 16550:
16551: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
16552:
1.243 albertel 16553: Common parameters:
16554:
16555: =over 4
16556:
16557: =item *
16558:
16559: $uname : an internal username (if $cname expecting a course Id specifically)
16560:
16561: =item *
16562:
16563: $udom : a domain (if $cdom expecting a course's domain specifically)
16564:
16565: =item *
16566:
16567: $symb : a resource instance identifier
16568:
16569: =item *
16570:
16571: $namespace : the name of a .db file that contains the data needed or
16572: being set.
16573:
16574: =back
16575:
1.394 bowersj2 16576: =head1 OVERVIEW
1.191 harris41 16577:
1.394 bowersj2 16578: lonnet provides subroutines which interact with the
16579: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
16580: about classes, users, and resources.
1.243 albertel 16581:
16582: For many of these objects you can also use this to store data about
16583: them or modify them in various ways.
1.191 harris41 16584:
1.394 bowersj2 16585: =head2 Symbs
1.191 harris41 16586:
1.394 bowersj2 16587: To identify a specific instance of a resource, LON-CAPA uses symbols
16588: or "symbs"X<symb>. These identifiers are built from the URL of the
16589: map, the resource number of the resource in the map, and the URL of
16590: the resource itself. The latter is somewhat redundant, but might help
16591: if maps change.
16592:
16593: An example is
16594:
16595: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
16596:
16597: The respective map entry is
16598:
16599: <resource id="19" src="/res/msu/korte/tests/part12.problem"
16600: title="Problem 2">
16601: </resource>
16602:
16603: Symbs are used by the random number generator, as well as to store and
16604: restore data specific to a certain instance of for example a problem.
16605:
16606: =head2 Storing And Retrieving Data
16607:
16608: X<store()>X<cstore()>X<restore()>Three of the most important functions
16609: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
16610: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
16611: is is the non-critical message twin of cstore. These functions are for
16612: handlers to store a perl hash to a user's permanent data space in an
16613: easy manner, and to retrieve it again on another call. It is expected
16614: that a handler would use this once at the beginning to retrieve data,
16615: and then again once at the end to send only the new data back.
16616:
16617: The data is stored in the user's data directory on the user's
16618: homeserver under the ID of the course.
16619:
16620: The hash that is returned by restore will have all of the previous
16621: value for all of the elements of the hash.
16622:
16623: Example:
16624:
16625: #creating a hash
16626: my %hash;
16627: $hash{'foo'}='bar';
16628:
16629: #storing it
16630: &Apache::lonnet::cstore(\%hash);
16631:
16632: #changing a value
16633: $hash{'foo'}='notbar';
16634:
16635: #adding a new value
16636: $hash{'bar'}='foo';
16637: &Apache::lonnet::cstore(\%hash);
16638:
16639: #retrieving the hash
16640: my %history=&Apache::lonnet::restore();
16641:
16642: #print the hash
16643: foreach my $key (sort(keys(%history))) {
16644: print("\%history{$key} = $history{$key}");
16645: }
16646:
16647: Will print out:
1.191 harris41 16648:
1.394 bowersj2 16649: %history{1:foo} = bar
16650: %history{1:keys} = foo:timestamp
16651: %history{1:timestamp} = 990455579
16652: %history{2:bar} = foo
16653: %history{2:foo} = notbar
16654: %history{2:keys} = foo:bar:timestamp
16655: %history{2:timestamp} = 990455580
16656: %history{bar} = foo
16657: %history{foo} = notbar
16658: %history{timestamp} = 990455580
16659: %history{version} = 2
16660:
16661: Note that the special hash entries C<keys>, C<version> and
16662: C<timestamp> were added to the hash. C<version> will be equal to the
16663: total number of versions of the data that have been stored. The
16664: C<timestamp> attribute will be the UNIX time the hash was
16665: stored. C<keys> is available in every historical section to list which
16666: keys were added or changed at a specific historical revision of a
16667: hash.
16668:
16669: B<Warning>: do not store the hash that restore returns directly. This
16670: will cause a mess since it will restore the historical keys as if the
16671: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 16672:
1.394 bowersj2 16673: Calling convention:
1.191 harris41 16674:
1.1225 raeburn 16675: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269 raeburn 16676: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 16677:
1.394 bowersj2 16678: For more detailed information, see lonnet specific documentation.
1.191 harris41 16679:
1.394 bowersj2 16680: =head1 RETURN MESSAGES
1.191 harris41 16681:
1.394 bowersj2 16682: =over 4
1.191 harris41 16683:
1.394 bowersj2 16684: =item * B<con_lost>: unable to contact remote host
1.191 harris41 16685:
1.394 bowersj2 16686: =item * B<con_delayed>: unable to contact remote host, message will be delivered
16687: when the connection is brought back up
1.191 harris41 16688:
1.394 bowersj2 16689: =item * B<con_failed>: unable to contact remote host and unable to save message
16690: for later delivery
1.191 harris41 16691:
1.967 bisitz 16692: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 16693:
1.394 bowersj2 16694: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 16695: that was requested
1.191 harris41 16696:
1.243 albertel 16697: =back
1.191 harris41 16698:
1.243 albertel 16699: =head1 PUBLIC SUBROUTINES
1.191 harris41 16700:
1.243 albertel 16701: =head2 Session Environment Functions
1.191 harris41 16702:
1.243 albertel 16703: =over 4
1.191 harris41 16704:
1.394 bowersj2 16705: =item *
16706: X<appenv()>
1.949 raeburn 16707: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 16708: the user envirnoment file, and will be restored for each access this
1.620 albertel 16709: user makes during this session, also modifies the %env for the current
1.949 raeburn 16710: process. Optional rolesarrayref - if defined contains a reference to an array
16711: of roles which are exempt from the restriction on modifying user.role entries
16712: in the user's environment.db and in %env.
1.191 harris41 16713:
16714: =item *
1.394 bowersj2 16715: X<delenv()>
1.987 raeburn 16716: B<delenv($delthis,$regexp)>: removes all items from the session
16717: environment file that begin with $delthis. If the
16718: optional second arg - $regexp - is true, $delthis is treated as a
16719: regular expression, otherwise \Q$delthis\E is used.
16720: The values are also deleted from the current processes %env.
1.191 harris41 16721:
1.795 albertel 16722: =item * get_env_multiple($name)
16723:
16724: gets $name from the %env hash, it seemlessly handles the cases where multiple
16725: values may be defined and end up as an array ref.
16726:
16727: returns an array of values
16728:
1.243 albertel 16729: =back
16730:
16731: =head2 User Information
1.191 harris41 16732:
1.243 albertel 16733: =over 4
1.191 harris41 16734:
16735: =item *
1.394 bowersj2 16736: X<queryauthenticate()>
16737: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 16738: authentication scheme
16739:
16740: =item *
1.394 bowersj2 16741: X<authenticate()>
1.1073 raeburn 16742: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 16743: authenticate user from domain's lib servers (first use the current
16744: one). C<$upass> should be the users password.
1.1073 raeburn 16745: $checkdefauth is optional (value is 1 if a check should be made to
16746: authenticate user using default authentication method, and allow
16747: account creation if username does not have account in the domain).
16748: $clientcancheckhost is optional (value is 1 if checking whether the
16749: server can host will occur on the client side in lonauth.pm).
1.191 harris41 16750:
16751: =item *
1.394 bowersj2 16752: X<homeserver()>
16753: B<homeserver($uname,$udom)>: find the server which has
16754: the user's directory and files (there must be only one), this caches
16755: the answer, and also caches if there is a borken connection.
1.191 harris41 16756:
16757: =item *
1.394 bowersj2 16758: X<idget()>
1.1300 raeburn 16759: B<idget($udom,$idsref,$namespace)>: find the usernames behind either
16760: a list of student/employee IDs or clicker IDs
16761: (student/employee IDs are a unique resource in a domain, there must be
16762: only 1 ID per username, and only 1 username per ID in a specific domain).
16763: clickerIDs are not necessarily unique, as students might share clickers.
16764: (returns hash: id=>name,id=>name)
1.191 harris41 16765:
16766: =item *
1.394 bowersj2 16767: X<idrget()>
16768: B<idrget($udom,@unames)>: find the IDs behind a list of
16769: usernames (returns hash: name=>id,name=>id)
1.191 harris41 16770:
16771: =item *
1.394 bowersj2 16772: X<idput()>
1.1300 raeburn 16773: B<idput($udom,$idsref,$uhome,$namespace)>: store away a list of
16774: names and associated student/employee IDs or clicker IDs.
16775:
16776: =item *
16777: X<iddel()>
16778: B<iddel($udom,$idshashref,$uhome,$namespace)>: delete unwanted
16779: student/employee ID or clicker ID username look-ups from domain.
16780: The homeserver ($uhome) and namespace ($namespace) are optional.
16781: If no $uhome is provided, it will be determined usig &homeserver()
16782: for each user. If no $namespace is provided, the default is ids.
16783:
16784: =item *
16785: X<updateclickers()>
16786: B<updateclickers($udom,$action,$idshashref,$uhome,$critical)>: update
16787: clicker ID-to-username look-ups in clickers.db on library server.
16788: Permitted actions are add or del (i.e., add or delete). The
16789: clickers.db contains clickerID as keys (escaped), and each corresponding
16790: value is an escaped comma-separated list of usernames (for whom the
16791: library server is the homeserver), who registered that particular ID.
16792: If $critical is true, the update will be sent via &critical, otherwise
16793: &reply() will be used.
1.191 harris41 16794:
16795: =item *
1.394 bowersj2 16796: X<rolesinit()>
1.1169 droeschl 16797: B<rolesinit($udom,$username)>: get user privileges.
16798: returns user role, first access and timer interval hashes
1.243 albertel 16799:
16800: =item *
1.1171 droeschl 16801: X<privileged()>
16802: B<privileged($username,$domain)>: returns a true if user has a
16803: privileged and active role (i.e. su or dc), false otherwise.
16804:
16805: =item *
1.551 albertel 16806: X<getsection()>
16807: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 16808: course $cname, return section name/number or '' for "not in course"
16809: and '-1' for "no section"
16810:
16811: =item *
1.394 bowersj2 16812: X<userenvironment()>
16813: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 16814: passed in @what from the requested user's environment, returns a hash
16815:
1.858 raeburn 16816: =item *
16817: X<userlog_query()>
1.859 albertel 16818: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
16819: activity.log file. %filters defines filters applied when parsing the
16820: log file. These can be start or end timestamps, or the type of action
16821: - log to look for Login or Logout events, check for Checkin or
16822: Checkout, role for role selection. The response is in the form
16823: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
16824: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 16825:
1.243 albertel 16826: =back
16827:
16828: =head2 User Roles
16829:
16830: =over 4
16831:
16832: =item *
16833:
1.1284 raeburn 16834: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
16835: returns codes for allowed actions.
16836:
16837: The first argument is required, all others are optional.
16838:
16839: $priv is the privilege being checked.
16840: $uri contains additional information about what is being checked for access (e.g.,
16841: URL, course ID etc.).
16842: $symb is the unique resource instance identifier in a course; if needed,
16843: but not provided, it will be retrieved via a call to &symbread().
16844: $role is the role for which a priv is being checked (only used if priv is evb).
16845: $clientip is the user's IP address (only used when checking for access to portfolio
16846: files).
16847: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
16848: prevents recursive calls to &allowed.
16849:
1.243 albertel 16850: F: full access
16851: U,I,K: authentication modes (cxx only)
16852: '': forbidden
16853: 1: user needs to choose course
16854: 2: browse allowed
1.766 albertel 16855: A: passphrase authentication needed
1.1284 raeburn 16856: B: access temporarily blocked because of a blocking event in a course.
1.1402 raeburn 16857: D: access blocked because access is required via session initiated via deep-link
1.243 albertel 16858:
16859: =item *
16860:
1.1192 raeburn 16861: constructaccess($url,$setpriv) : check for access to construction space URL
16862:
16863: See if the owner domain and name in the URL match those in the
16864: expected environment. If so, return three element list
16865: ($ownername,$ownerdomain,$ownerhome).
16866:
16867: Otherwise return the null string.
16868:
16869: If second argument 'setpriv' is true, it assigns the privileges,
16870: and returns the same three element list, unless the owner has
16871: blocked "ad hoc" Domain Coordinator access to the Author Space,
16872: in which case the null string is returned.
16873:
16874: =item *
16875:
1.1326 raeburn 16876: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
16877: define a custom role rolename set privileges in format of lonTabs/roles.tab
16878: for system, domain, and course level. $uname and $udom are optional (current
16879: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 16880:
16881: =item *
16882:
1.988 raeburn 16883: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
16884: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 16885: $type is Course (default) or Community.
1.988 raeburn 16886: If $forcedefault evaluates to true, text returned will be default
16887: text for $type. Otherwise, if this is a course, the text returned
16888: will be a custom name for the role (if defined in the course's
16889: environment). If no custom name is defined the default is returned.
16890:
1.832 raeburn 16891: =item *
16892:
1.1219 raeburn 16893: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 16894: All arguments are optional. Returns a hash of a roles, either for
16895: co-author/assistant author roles for a user's Construction Space
1.906 albertel 16896: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 16897: In the hash, keys are set to colon-separated $uname,$udom,$role, and
16898: (optionally) if $withsec is true, a fourth colon-separated item - $section.
16899: For each key, value is set to colon-separated start and end times for
16900: the role. If no username and domain are specified, will default to
1.934 raeburn 16901: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 16902: of role statuses (active, future or previous), roles
16903: (e.g., cc,in, st etc.) and domains of the roles which can be used
16904: to restrict the list of roles reported. If no array ref is
16905: provided for types, will default to return only active roles.
1.834 albertel 16906:
1.1195 raeburn 16907: =item *
16908:
16909: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 16910: user: $uname:$udom has a role in the course: $cdom_$cnum.
16911:
16912: Additional optional arguments are: $type (if role checking is to be restricted
16913: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 16914: available roles) or future (roles available in the future), and
16915: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 16916: have active Domain Coordinator role in course's domain or in additional
16917: domains (specified in 'Domains to check for privileged users' in course
16918: environment -- set via: Course Settings -> Classlists and staff listing).
16919:
16920: =item *
16921:
16922: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
16923: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
16924: $possdomains and $possroles are optional array refs -- to domains to check and
16925: roles to check. If $possdomains is not specified, a dump will be done of the
16926: users' roles.db to check for a dc or su role in any domain. This can be
16927: time consuming if &privileged is called repeatedly (e.g., when displaying a
16928: classlist), so in such cases, supplying a $possdomains array is preferred, as
16929: this then allows &privileged_by_domain() to be used, which caches the identity
16930: of privileged users, eliminating the need for repeated calls to &dump().
16931:
16932: =item *
16933:
16934: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
16935: where the outer hash keys are domains specified in the $possdomains array ref,
16936: next inner hash keys are privileged roles specified in the $roles array ref,
16937: and the innermost hash contains key = value pairs for username:domain = end:start
16938: for active or future "privileged" users with that role in that domain. To avoid
16939: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
16940: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 16941:
1.243 albertel 16942: =back
16943:
16944: =head2 User Modification
16945:
16946: =over 4
16947:
16948: =item *
16949:
1.957 raeburn 16950: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 16951: user for the level given by URL. Optional start and end dates (leave empty
16952: string or zero for "no date")
1.191 harris41 16953:
16954: =item *
16955:
1.243 albertel 16956: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
16957: change a users, password, possible return values are: ok,
16958: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
16959: refused
1.191 harris41 16960:
16961: =item *
16962:
1.243 albertel 16963: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 16964:
16965: =item *
16966:
1.1058 raeburn 16967: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
16968: $forceid,$desiredhome,$email,$inststatus,$candelete) :
16969:
16970: will update user information (firstname,middlename,lastname,generation,
16971: permanentemail), and if forceid is true, student/employee ID also.
16972: A user's institutional affiliation(s) can also be updated.
16973: User information fields will not be overwritten with empty entries
16974: unless the field is included in the $candelete array reference.
16975: This array is included when a single user is modified via "Manage Users",
16976: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 16977:
16978: =item *
16979:
1.286 matthew 16980: modifystudent
16981:
1.957 raeburn 16982: modify a student's enrollment and identification information.
1.1235 raeburn 16983: The course id is resolved based on the current user's environment.
16984: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 16985: associated with a course.
16986:
1.297 matthew 16987: This call is essentially a wrapper for lonnet::modifyuser and
16988: lonnet::modify_student_enrollment
1.286 matthew 16989:
16990: Inputs:
16991:
16992: =over 4
16993:
1.957 raeburn 16994: =item B<$udom> Student's loncapa domain
1.286 matthew 16995:
1.957 raeburn 16996: =item B<$uname> Student's loncapa login name
1.286 matthew 16997:
1.964 bisitz 16998: =item B<$uid> Student/Employee ID
1.286 matthew 16999:
1.957 raeburn 17000: =item B<$umode> Student's authentication mode
1.286 matthew 17001:
1.957 raeburn 17002: =item B<$upass> Student's password
1.286 matthew 17003:
1.957 raeburn 17004: =item B<$first> Student's first name
1.286 matthew 17005:
1.957 raeburn 17006: =item B<$middle> Student's middle name
1.286 matthew 17007:
1.957 raeburn 17008: =item B<$last> Student's last name
1.286 matthew 17009:
1.957 raeburn 17010: =item B<$gene> Student's generation
1.286 matthew 17011:
1.957 raeburn 17012: =item B<$usec> Student's section in course
1.286 matthew 17013:
17014: =item B<$end> Unix time of the roles expiration
17015:
17016: =item B<$start> Unix time of the roles start date
17017:
17018: =item B<$forceid> If defined, allow $uid to be changed
17019:
17020: =item B<$desiredhome> server to use as home server for student
17021:
1.957 raeburn 17022: =item B<$email> Student's permanent e-mail address
17023:
17024: =item B<$type> Type of enrollment (auto or manual)
17025:
1.963 raeburn 17026: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
17027:
17028: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 17029:
1.963 raeburn 17030: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 17031:
1.963 raeburn 17032: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 17033:
1.1216 raeburn 17034: =item B<$inststatus> institutional status of user - : separated string of escaped status types
17035:
17036: =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 17037:
1.286 matthew 17038: =back
1.297 matthew 17039:
17040: =item *
17041:
17042: modify_student_enrollment
17043:
1.1235 raeburn 17044: Change a student's enrollment status in a class. The environment variable
1.297 matthew 17045: 'role.request.course' must be defined for this function to proceed.
17046:
17047: Inputs:
17048:
17049: =over 4
17050:
1.1235 raeburn 17051: =item $udom, student's domain
1.297 matthew 17052:
1.1235 raeburn 17053: =item $uname, student's name
1.297 matthew 17054:
1.1235 raeburn 17055: =item $uid, student's user id
1.297 matthew 17056:
1.1235 raeburn 17057: =item $first, student's first name
1.297 matthew 17058:
17059: =item $middle
17060:
17061: =item $last
17062:
17063: =item $gene
17064:
17065: =item $usec
17066:
17067: =item $end
17068:
17069: =item $start
17070:
1.957 raeburn 17071: =item $type
17072:
17073: =item $locktype
17074:
17075: =item $cid
17076:
17077: =item $selfenroll
17078:
17079: =item $context
17080:
1.1216 raeburn 17081: =item $credits, number of credits student will earn from this class
17082:
1.1314 raeburn 17083: =item $instsec, institutional course section code for student
17084:
1.297 matthew 17085: =back
17086:
1.191 harris41 17087:
17088: =item *
17089:
1.243 albertel 17090: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
17091: custom role; give a custom role to a user for the level given by URL. Specify
17092: name and domain of role author, and role name
1.191 harris41 17093:
17094: =item *
17095:
1.243 albertel 17096: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 17097:
17098: =item *
17099:
1.243 albertel 17100: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
17101:
17102: =back
17103:
17104: =head2 Course Infomation
17105:
17106: =over 4
1.191 harris41 17107:
17108: =item *
17109:
1.1118 foxr 17110: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 17111: specified course id, including all environment settings for the
17112: course, the description of the course will be in the hash under the
17113: key 'description'
1.191 harris41 17114:
1.1118 foxr 17115: $options is an optional parameter that if supplied is a hash reference that controls
17116: what how this function works. It has the following key/values:
17117:
17118: =over 4
17119:
17120: =item freshen_cache
17121:
17122: If defined, and the environment cache for the course is valid, it is
17123: returned in the returned hash.
17124:
17125: =item one_time
17126:
17127: If defined, the last cache time is set to _now_
17128:
17129: =item user
17130:
17131: If defined, the supplied username is used instead of the current user.
17132:
17133:
17134: =back
17135:
1.191 harris41 17136: =item *
17137:
1.624 albertel 17138: resdata($name,$domain,$type,@which) : request for current parameter
17139: setting for a specific $type, where $type is either 'course' or 'user',
17140: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 17141: answers for 10 minutes.
1.243 albertel 17142:
1.877 foxr 17143: =item *
17144:
17145: get_courseresdata($courseid, $domain) : dump the entire course resource
17146: data base, returning a hash that is keyed by the resource name and has
17147: values that are the resource value. I believe that the timestamps and
17148: versions are also returned.
17149:
1.243 albertel 17150: =back
17151:
17152: =head2 Course Modification
17153:
17154: =over 4
1.191 harris41 17155:
17156: =item *
17157:
1.243 albertel 17158: writecoursepref($courseid,%prefs) : write preferences (environment
17159: database) for a course
1.191 harris41 17160:
17161: =item *
17162:
1.1011 raeburn 17163: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
17164:
17165: =item *
17166:
1.1038 raeburn 17167: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 17168:
1.1167 droeschl 17169: =item *
17170:
17171: is_course($courseid), is_course($cdom, $cnum)
17172:
17173: Accepts either a combined $courseid (in the form of domain_courseid) or the
17174: two component version $cdom, $cnum. It checks if the specified course exists.
17175:
17176: Returns:
17177: undef if the course doesn't exist, otherwise
17178: in scalar context the combined courseid.
17179: in list context the two components of the course identifier, domain and
17180: courseid.
17181:
1.243 albertel 17182: =back
17183:
1.1401 raeburn 17184: =head2 Bubblesheet Configuration
17185:
17186: =over 4
17187:
17188: =item *
17189:
17190: get_scantron_config($which)
17191:
17192: $which - the name of the configuration to parse from the file.
17193:
17194: Parses and returns the bubblesheet configuration line selected as a
17195: hash of configuration file fields.
17196:
17197:
17198: Returns:
17199: If the named configuration is not in the file, an empty
17200: hash is returned.
17201:
17202: a hash with the fields
17203: name - internal name for the this configuration setup
17204: description - text to display to operator that describes this config
17205: CODElocation - if 0 or the string 'none'
17206: - no CODE exists for this config
17207: if -1 || the string 'letter'
17208: - a CODE exists for this config and is
17209: a string of letters
17210: Unsupported value (but planned for future support)
17211: if a positive integer
17212: - The CODE exists as the first n items from
17213: the question section of the form
17214: if the string 'number'
17215: - The CODE exists for this config and is
17216: a string of numbers
17217: CODEstart - (only matter if a CODE exists) column in the line where
17218: the CODE starts
17219: CODElength - length of the CODE
17220: IDstart - column where the student/employee ID starts
17221: IDlength - length of the student/employee ID info
17222: Qstart - column where the information from the bubbled
17223: 'questions' start
17224: Qlength - number of columns comprising a single bubble line from
17225: the sheet. (usually either 1 or 10)
17226: Qon - either a single character representing the character used
17227: to signal a bubble was chosen in the positional setup, or
17228: the string 'letter' if the letter of the chosen bubble is
17229: in the final, or 'number' if a number representing the
17230: chosen bubble is in the file (1->A 0->J)
17231: Qoff - the character used to represent that a bubble was
17232: left blank
17233: PaperID - if the scanning process generates a unique number for each
17234: sheet scanned the column that this ID number starts in
17235: PaperIDlength - number of columns that comprise the unique ID number
17236: for the sheet of paper
17237: FirstName - column that the first name starts in
17238: FirstNameLength - number of columns that the first name spans
17239: LastName - column that the last name starts in
17240: LastNameLength - number of columns that the last name spans
17241: BubblesPerRow - number of bubbles available in each row used to
17242: bubble an answer. (If not specified, 10 assumed).
17243:
17244:
17245: =item *
17246:
17247: get_scantronformat_file($cdom)
17248:
17249: $cdom - the course's domain (optional); if not supplied, uses
17250: domain for current $env{'request.course.id'}.
17251:
17252: Returns an array containing lines from the scantron format file for
17253: the domain of the course.
17254:
17255: If a url for a custom.tab file is listed in domain's configuration.db,
17256: lines are from this file.
17257:
17258: Otherwise, if a default.tab has been published in RES space by the
17259: domainconfig user, lines are from this file.
17260:
17261: Otherwise, fall back to getting lines from the legacy file on the
17262: local server: /home/httpd/lonTabs/default_scantronformat.tab
17263:
17264: =back
17265:
1.243 albertel 17266: =head2 Resource Subroutines
17267:
17268: =over 4
1.191 harris41 17269:
17270: =item *
17271:
1.243 albertel 17272: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 17273:
17274: =item *
17275:
1.243 albertel 17276: repcopy($filename) : subscribes to the requested file, and attempts to
17277: replicate from the owning library server, Might return
1.607 raeburn 17278: 'unavailable', 'not_found', 'forbidden', 'ok', or
17279: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 17280: resource. Expects the local filesystem pathname
17281: (/home/httpd/html/res/....)
17282:
17283: =back
17284:
17285: =head2 Resource Information
17286:
17287: =over 4
1.191 harris41 17288:
17289: =item *
17290:
1.1228 raeburn 17291: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
17292: and returns the value of a variety of different possible values,
17293: $varname should be a request string, and the other parameters can be
17294: used to specify who and what one is asking about. Ordinarily, $cid
17295: does not need to be specified, as it is retrived from
17296: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
17297: within lonuserstate::loadmap() when initializing a course, before
17298: $env{'request.course.id'} has been set, so it needs to be provided
17299: in that one case.
1.243 albertel 17300:
17301: Possible values for $varname are environment.lastname (or other item
17302: from the envirnment hash), user.name (or someother aspect about the
17303: user), resource.0.maxtries (or some other part and parameter of a
17304: resource)
1.204 albertel 17305:
17306: =item *
17307:
1.243 albertel 17308: directcondval($number) : get current value of a condition; reads from a state
17309: string
1.204 albertel 17310:
17311: =item *
17312:
1.243 albertel 17313: condval($condidx) : value of condition index based on state
1.204 albertel 17314:
17315: =item *
17316:
1.1362 raeburn 17317: metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
1.243 albertel 17318: resource's metadata, $what should be either a specific key, or either
17319: 'keys' (to get a list of possible keys) or 'packages' to get a list of
1.1362 raeburn 17320: packages that this resource currently uses, the last 3 arguments are
17321: only used internally for recursive metadata.
17322:
17323: the toolsymb is only used where the uri is for an external tool (for which
17324: the uri as well as the symb are guaranteed to be unique).
1.243 albertel 17325:
1.1371 raeburn 17326: this function automatically caches all requests except any made recursively
17327: to retrieve a list of metadata keys for an imported library file ($liburi is
17328: defined).
1.191 harris41 17329:
17330: =item *
17331:
1.243 albertel 17332: metadata_query($query,$custom,$customshow) : make a metadata query against the
17333: network of library servers; returns file handle of where SQL and regex results
17334: will be stored for query
1.191 harris41 17335:
17336: =item *
17337:
1.1282 raeburn 17338: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
17339: return symbolic list entry (all arguments optional).
17340:
17341: Args: filename is the filename (including path) for the file for which a symb
17342: is required; donotrecurse, if true will prevent calls to allowed() being made
17343: to check access status if more than one resource was found in the bighash
17344: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
17345: a randompick); ignorecachednull, if true will prevent a symb of '' being
17346: returned if $env{$cache_str} is defined as ''; checkforblock if true will
17347: cause possible symbs to be checked to determine if they are subject to content
17348: blocking, if so they will not be included as possible symbs; possibles is a
17349: ref to a hash, which, as a side effect, will be populated with all possible
17350: symbs (content blocking not tested).
17351:
1.243 albertel 17352: returns the data handle
1.191 harris41 17353:
17354: =item *
17355:
1.1190 raeburn 17356: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
17357: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 17358: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 17359: on failure, user must be in a course, as it assumes the existence of
17360: the course initial hash, and uses $env('request.course.id'}. The third
17361: arg is an optional reference to a scalar. If this arg is passed in the
17362: call to symbverify, it will be set to 1 if the symb has been set to be
17363: encrypted; otherwise it will be null.
1.191 harris41 17364:
17365: =item *
17366:
1.243 albertel 17367: symbclean($symb) : removes versions numbers from a symb, returns the
17368: cleaned symb
1.191 harris41 17369:
17370: =item *
17371:
1.243 albertel 17372: is_on_map($uri) : checks if the $uri is somewhere on the current
17373: course map, user must be in a course for it to work.
1.191 harris41 17374:
17375: =item *
17376:
1.243 albertel 17377: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 17378:
17379: =item *
17380:
1.243 albertel 17381: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
17382: a random seed, all arguments are optional, if they aren't sent it uses the
17383: environment to derive them. Note: if symb isn't sent and it can't get one
17384: from &symbread it will use the current time as its return value
1.191 harris41 17385:
17386: =item *
17387:
1.243 albertel 17388: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
17389: unfakeable, receipt
1.191 harris41 17390:
17391: =item *
17392:
1.620 albertel 17393: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 17394:
17395: =item *
17396:
1.243 albertel 17397: countacc($url) : count the number of accesses to a given URL
1.191 harris41 17398:
17399: =item *
17400:
1.243 albertel 17401: 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 17402:
17403: =item *
17404:
1.243 albertel 17405: 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 17406:
17407: =item *
17408:
1.243 albertel 17409: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 17410:
17411: =item *
17412:
1.243 albertel 17413: devalidate($symb) : devalidate temporary spreadsheet calculations,
17414: forcing spreadsheet to reevaluate the resource scores next time.
17415:
1.1195 raeburn 17416: =item *
17417:
1.1196 raeburn 17418: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
17419: when viewing in course context.
1.1195 raeburn 17420:
1.1196 raeburn 17421: input: six args -- filename (decluttered), course number, course domain,
17422: url, symb (if registered) and group (if this is a
17423: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 17424:
1.1196 raeburn 17425: output: array of five scalars --
1.1195 raeburn 17426: $cfile -- url for file editing if editable on current server
17427: $home -- homeserver of resource (i.e., for author if published,
17428: or course if uploaded.).
17429: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 17430: $forceedit -- 1 if icon/link should be to go to edit mode
17431: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 17432:
17433: =item *
17434:
17435: is_course_upload($file,$cnum,$cdom)
17436:
17437: Used in course context to determine if current file was uploaded to
17438: the course (i.e., would be found in /userfiles/docs on the course's
17439: homeserver.
17440:
17441: input: 3 args -- filename (decluttered), course number and course domain.
17442: output: boolean -- 1 if file was uploaded.
17443:
1.243 albertel 17444: =back
17445:
17446: =head2 Storing/Retreiving Data
17447:
17448: =over 4
1.191 harris41 17449:
17450: =item *
17451:
1.1269 raeburn 17452: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
17453: permanently for this url; hashref needs to be given and should be a \%hashname;
17454: the remaining args aren't required and if they aren't passed or are '' they will
17455: be derived from the env (with the exception of $laststore, which is an
17456: optional arg used when a user's submission is stored in grading).
17457: $laststore is $version=$timestamp, where $version is the most recent version
17458: number retrieved for the corresponding $symb in the $namespace db file, and
17459: $timestamp is the timestamp for that transaction (UNIX time).
17460: $laststore is currently only passed when cstore() is called by
17461: structuretags::finalize_storage().
1.191 harris41 17462:
17463: =item *
17464:
1.1269 raeburn 17465: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
17466: but uses critical subroutine
1.191 harris41 17467:
17468: =item *
17469:
1.243 albertel 17470: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
17471: all args are optional
1.191 harris41 17472:
17473: =item *
17474:
1.717 albertel 17475: dumpstore($namespace,$udom,$uname,$regexp,$range) :
17476: dumps the complete (or key matching regexp) namespace into a hash
17477: ($udom, $uname, $regexp, $range are optional) for a namespace that is
17478: normally &store()ed into
17479:
17480: $range should be either an integer '100' (give me the first 100
17481: matching records)
17482: or be two integers sperated by a - with no spaces
17483: '30-50' (give me the 30th through the 50th matching
17484: records)
17485:
17486:
17487: =item *
17488:
1.1269 raeburn 17489: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 17490: replaces a &store() version of data with a replacement set of data
17491: for a particular resource in a namespace passed in the $storehash hash
1.1269 raeburn 17492: reference. If $tolog is true, the transaction is logged in the courselog
17493: with an action=PUTSTORE.
1.717 albertel 17494:
17495: =item *
17496:
1.243 albertel 17497: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
17498: works very similar to store/cstore, but all data is stored in a
17499: temporary location and can be reset using tmpreset, $storehash should
17500: be a hash reference, returns nothing on success
1.191 harris41 17501:
17502: =item *
17503:
1.243 albertel 17504: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
17505: similar to restore, but all data is stored in a temporary location and
17506: can be reset using tmpreset. Returns a hash of values on success,
17507: error string otherwise.
1.191 harris41 17508:
17509: =item *
17510:
1.243 albertel 17511: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
17512: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 17513:
17514: =item *
17515:
1.243 albertel 17516: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
17517: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 17518:
17519: =item *
17520:
1.243 albertel 17521: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
17522: namesp ($udom and $uname are optional)
1.191 harris41 17523:
17524: =item *
17525:
1.702 albertel 17526: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 17527: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 17528: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 17529:
1.702 albertel 17530: $range should be either an integer '100' (give me the first 100
17531: matching records)
17532: or be two integers sperated by a - with no spaces
17533: '30-50' (give me the 30th through the 50th matching
17534: records)
1.449 matthew 17535: =item *
17536:
17537: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
17538: $store can be a scalar, an array reference, or if the amount to be
17539: incremented is > 1, a hash reference.
17540:
17541: ($udom and $uname are optional)
1.191 harris41 17542:
17543: =item *
17544:
1.243 albertel 17545: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
17546: ($udom and $uname are optional)
1.191 harris41 17547:
17548: =item *
17549:
1.243 albertel 17550: cput($namespace,$storehash,$udom,$uname) : critical put
17551: ($udom and $uname are optional)
1.191 harris41 17552:
17553: =item *
17554:
1.748 albertel 17555: newput($namespace,$storehash,$udom,$uname) :
17556:
17557: Attempts to store the items in the $storehash, but only if they don't
17558: currently exist, if this succeeds you can be certain that you have
17559: successfully created a new key value pair in the $namespace db.
17560:
17561:
17562: Args:
17563: $namespace: name of database to store values to
17564: $storehash: hashref to store to the db
17565: $udom: (optional) domain of user containing the db
17566: $uname: (optional) name of user caontaining the db
17567:
17568: Returns:
17569: 'ok' -> succeeded in storing all keys of $storehash
17570: 'key_exists: <key>' -> failed to anything out of $storehash, as at
17571: least <key> already existed in the db (other
17572: requested keys may also already exist)
1.967 bisitz 17573: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 17574: 'con_lost' -> unable to contact request server
17575: 'refused' -> action was not allowed by remote machine
17576:
17577:
17578: =item *
17579:
1.243 albertel 17580: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
17581: reference filled in from namesp (encrypts the return communication)
17582: ($udom and $uname are optional)
1.191 harris41 17583:
17584: =item *
17585:
1.243 albertel 17586: log($udom,$name,$home,$message) : write to permanent log for user; use
17587: critical subroutine
17588:
1.806 raeburn 17589: =item *
17590:
1.860 raeburn 17591: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
17592: array reference filled in from namespace found in domain level on either
17593: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 17594:
17595: =item *
17596:
1.860 raeburn 17597: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
17598: domain level either on specified domain server ($uhome) or primary domain
17599: server ($udom and $uhome are optional)
1.806 raeburn 17600:
1.943 raeburn 17601: =item *
17602:
1.1240 raeburn 17603: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
17604: for: authentication, language, quotas, timezone, date locale, and portal URL in
17605: the target domain.
17606:
17607: May also include additional key => value pairs for the following groups:
17608:
17609: =over
17610:
17611: =item
17612: disk quotas (MB allocated by default to portfolios and authoring spaces).
17613:
17614: =over
17615:
17616: =item defaultquota, authorquota
17617:
17618: =back
17619:
17620: =item
17621: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
17622: portfolio for users).
17623:
17624: =over
17625:
17626: =item
17627: aboutme, blog, webdav, portfolio
17628:
17629: =back
17630:
17631: =item
17632: requestcourses: ability to request courses, and how requests are processed.
17633:
17634: =over
17635:
17636: =item
1.1305 raeburn 17637: official, unofficial, community, textbook, placement
1.1240 raeburn 17638:
17639: =back
17640:
17641: =item
17642: inststatus: types of institutional affiliation, and order in which they are displayed.
17643:
17644: =over
17645:
17646: =item
1.1256 raeburn 17647: inststatustypes, inststatusorder, inststatusguest
1.1240 raeburn 17648:
17649: =back
17650:
17651: =item
17652: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
17653: for course's uploaded content.
17654:
17655: =over
17656:
17657: =item
1.1246 raeburn 17658: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
1.1305 raeburn 17659: communityquota, textbookquota, placementquota
1.1240 raeburn 17660:
17661: =back
17662:
17663: =item
17664: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
17665: on your servers.
17666:
17667: =over
17668:
17669: =item
17670: remotesessions, hostedsessions
17671:
17672: =back
17673:
17674: =back
17675:
17676: In cases where a domain coordinator has never used the "Set Domain Configuration"
17677: utility to create a configuration.db file on a domain's primary library server
17678: only the following domain defaults: auth_def, auth_arg_def, lang_def
17679: -- corresponding values are authentication type (internal, krb4, krb5,
17680: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
17681: will be available. Values are retrieved from cache (if current), unless the
17682: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
17683: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
17684:
17685: Typical usage:
1.943 raeburn 17686:
1.1240 raeburn 17687: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 17688:
1.243 albertel 17689: =back
17690:
17691: =head2 Network Status Functions
17692:
17693: =over 4
1.191 harris41 17694:
17695: =item *
17696:
1.1137 raeburn 17697: dirlist() : return directory list based on URI (first arg).
17698:
17699: Inputs: 1 required, 5 optional.
17700:
17701: =over
17702:
17703: =item
17704: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
17705:
17706: =item
17707: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
17708:
17709: =item
17710: $username - username of user/course to be listed. Extracted from $uri if absent.
17711:
17712: =item
17713: $getpropath - boolean: 1 if prepend path using &propath().
17714:
17715: =item
17716: $getuserdir - boolean: 1 if prepend path for "userfiles".
17717:
17718: =item
17719: $alternateRoot - path to prepend in place of path from $uri.
17720:
17721: =back
17722:
17723: Returns: Array of up to two items.
17724:
17725: =over
17726:
17727: a reference to an array of files/subdirectories
17728:
17729: =over
17730:
17731: Each element in the array of files/subdirectories is a & separated list of
17732: item name and the result of running stat on the item. If dirlist was requested
17733: for a file instead of a directory, the item name will be ''. For a directory
17734: listing, if the item is a metadata file, the element will end &N&M
17735: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
17736: default copyright set (1).
17737:
17738: =back
17739:
17740: a scalar containing error condition (if encountered).
17741:
17742: =over
17743:
17744: =item
17745: no_host (no homeserver identified for $username:$domain).
17746:
17747: =item
17748: no_such_host (server contacted for listing not identified as valid host).
17749:
17750: =item
17751: con_lost (connection to remote server failed).
17752:
17753: =item
17754: refused (invalid $username:$domain received on lond side).
17755:
17756: =item
17757: no_such_dir (directory at specified path on lond side does not exist).
17758:
17759: =item
17760: empty (directory at specified path on lond side is empty).
17761:
17762: =over
17763:
17764: This is currently not encountered because the &ls3, &ls2,
17765: &ls (_handler) routines on the lond side do not filter out
17766: . and .. from a directory listing.
17767:
17768: =back
17769:
17770: =back
17771:
17772: =back
1.191 harris41 17773:
17774: =item *
17775:
1.243 albertel 17776: spareserver() : find server with least workload from spare.tab
17777:
1.986 foxr 17778:
17779: =item *
17780:
17781: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
17782: if there is no corresponding loncapa host.
17783:
1.243 albertel 17784: =back
17785:
1.986 foxr 17786:
1.243 albertel 17787: =head2 Apache Request
17788:
17789: =over 4
1.191 harris41 17790:
17791: =item *
17792:
1.243 albertel 17793: ssi($url,%hash) : server side include, does a complete request cycle on url to
17794: localhost, posts hash
17795:
17796: =back
17797:
17798: =head2 Data to String to Data
17799:
17800: =over 4
1.191 harris41 17801:
17802: =item *
17803:
1.243 albertel 17804: hash2str(%hash) : convert a hash into a string complete with escaping and '='
17805: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 17806:
17807: =item *
17808:
1.243 albertel 17809: hashref2str($hashref) : convert a hashref into a string complete with
17810: escaping and '=' and '&' separators, supports elements that are
17811: arrayrefs and hashrefs
1.191 harris41 17812:
17813: =item *
17814:
1.243 albertel 17815: arrayref2str($arrayref) : convert an arrayref into a string complete
17816: with escaping and '&' separators, supports elements that are arrayrefs
17817: and hashrefs
1.191 harris41 17818:
17819: =item *
17820:
1.243 albertel 17821: str2hash($string) : convert string to hash using unescaping and
17822: splitting on '=' and '&', supports elements that are arrayrefs and
17823: hashrefs
1.191 harris41 17824:
17825: =item *
17826:
1.243 albertel 17827: str2array($string) : convert string to hash using unescaping and
17828: splitting on '&', supports elements that are arrayrefs and hashrefs
17829:
17830: =back
17831:
17832: =head2 Logging Routines
17833:
17834:
17835: These routines allow one to make log messages in the lonnet.log and
17836: lonnet.perm logfiles.
1.191 harris41 17837:
1.1119 foxr 17838: =over 4
17839:
1.191 harris41 17840: =item *
17841:
1.243 albertel 17842: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 17843:
17844: =item *
17845:
1.243 albertel 17846: logthis() : append message to the normal lonnet.log file, it gets
17847: preiodically rolled over and deleted.
1.191 harris41 17848:
17849: =item *
17850:
1.243 albertel 17851: logperm() : append a permanent message to lonnet.perm.log, this log
17852: file never gets deleted by any automated portion of the system, only
17853: messages of critical importance should go in here.
17854:
1.1119 foxr 17855:
1.243 albertel 17856: =back
17857:
17858: =head2 General File Helper Routines
17859:
17860: =over 4
1.191 harris41 17861:
17862: =item *
17863:
1.481 raeburn 17864: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
17865: (a) files in /uploaded
17866: (i) If a local copy of the file exists -
17867: compares modification date of local copy with last-modified date for
17868: definitive version stored on home server for course. If local copy is
17869: stale, requests a new version from the home server and stores it.
17870: If the original has been removed from the home server, then local copy
17871: is unlinked.
17872: (ii) If local copy does not exist -
17873: requests the file from the home server and stores it.
17874:
17875: If $caller is 'uploadrep':
17876: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
17877: for request for files originally uploaded via DOCS.
17878: - returns 'ok' if fresh local copy now available, -1 otherwise.
17879:
17880: Otherwise:
17881: This indicates a call from the content generation phase of the request.
17882: - returns the entire contents of the file or -1.
17883:
17884: (b) files in /res
17885: - returns the entire contents of a file or -1;
17886: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 17887:
1.712 albertel 17888:
17889: =item *
17890:
17891: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
17892: reference
17893:
17894: returns either a stat() list of data about the file or an empty list
17895: if the file doesn't exist or couldn't find out about it (connection
17896: problems or user unknown)
17897:
1.191 harris41 17898: =item *
17899:
1.243 albertel 17900: filelocation($dir,$file) : returns file system location of a file
17901: based on URI; meant to be "fairly clean" absolute reference, $dir is a
17902: directory that relative $file lookups are to looked in ($dir of /a/dir
17903: and a file of ../bob will become /a/bob)
1.191 harris41 17904:
17905: =item *
17906:
17907: hreflocation($dir,$file) : returns file system location or a URL; same as
17908: filelocation except for hrefs
17909:
17910: =item *
17911:
1.1261 raeburn 17912: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
17913: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 17914:
1.243 albertel 17915: =back
17916:
1.608 albertel 17917: =head2 Usererfile file routines (/uploaded*)
17918:
17919: =over 4
17920:
17921: =item *
17922:
17923: userfileupload(): main rotine for putting a file in a user or course's
17924: filespace, arguments are,
17925:
1.620 albertel 17926: formname - required - this is the name of the element in $env where the
1.608 albertel 17927: filename, and the contents of the file to create/modifed exist
1.620 albertel 17928: the filename is in $env{'form.'.$formname.'.filename'} and the
17929: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 17930: context - if coursedoc, store the file in the course of the active role
17931: of the current user;
17932: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
17933: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 17934: subdir - required - subdirectory to put the file in under ../userfiles/
17935: if undefined, it will be placed in "unknown"
17936:
17937: (This routine calls clean_filename() to remove any dangerous
17938: characters from the filename, and then calls finuserfileupload() to
17939: complete the transaction)
17940:
17941: returns either the url of the uploaded file (/uploaded/....) if successful
17942: and /adm/notfound.html if unsuccessful
17943:
17944: =item *
17945:
17946: clean_filename(): routine for cleaing a filename up for storage in
17947: userfile space, argument is:
17948:
17949: filename - proposed filename
17950:
17951: returns: the new clean filename
17952:
17953: =item *
17954:
1.1090 raeburn 17955: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 17956: userspace, probably shouldn't be called directly
17957:
17958: docuname: username or courseid of destination for the file
17959: docudom: domain of user/course of destination for the file
17960: formname: same as for userfileupload()
1.1090 raeburn 17961: fname: filename (including subdirectories) for the file
17962: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
1.1401 raeburn 17963: if hashref, and context is scantron, will convert csv format to standard format
1.1090 raeburn 17964: allfiles: reference to hash used to store objects found by parser
17965: codebase: reference to hash used for codebases of java objects found by parser
17966: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
17967: thumbheight: height (pixels) of thumbnail to be created for uploaded image
17968: resizewidth: width to be used to resize image using resizeImage from ImageMagick
17969: resizeheight: height to be used to resize image using resizeImage from ImageMagick
17970: context: if 'overwrite', will move the uploaded file from its temporary location to
17971: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 17972: mimetype: reference to scalar to accommodate mime type determined
17973: from File::MMagic if $parser = parse.
1.608 albertel 17974:
17975: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 17976: and /adm/notfound.html if unsuccessful (or an error message if context
17977: was 'overwrite').
17978:
1.608 albertel 17979:
17980: =item *
17981:
17982: renameuserfile(): renames an existing userfile to a new name
17983:
17984: Args:
17985: docuname: username or courseid of destination for the file
17986: docudom: domain of user/course of destination for the file
17987: old: current file name (including any subdirs under userfiles)
17988: new: desired file name (including any subdirs under userfiles)
17989:
17990: =item *
17991:
17992: mkdiruserfile(): creates a directory is a userfiles dir
17993:
17994: Args:
17995: docuname: username or courseid of destination for the file
17996: docudom: domain of user/course of destination for the file
17997: dir: dir to create (including any subdirs under userfiles)
17998:
17999: =item *
18000:
18001: removeuserfile(): removes a file that exists in userfiles
18002:
18003: Args:
18004: docuname: username or courseid of destination for the file
18005: docudom: domain of user/course of destination for the file
18006: fname: filname to delete (including any subdirs under userfiles)
18007:
18008: =item *
18009:
18010: removeuploadedurl(): convience function for removeuserfile()
18011:
18012: Args:
18013: url: a full /uploaded/... url to delete
18014:
1.747 albertel 18015: =item *
18016:
18017: get_portfile_permissions():
18018: Args:
18019: domain: domain of user or course contain the portfolio files
18020: user: name of user or num of course contain the portfolio files
18021: Returns:
18022: hashref of a dump of the proper file_permissions.db
18023:
18024:
18025: =item *
18026:
18027: get_access_controls():
18028:
18029: Args:
18030: current_permissions: the hash ref returned from get_portfile_permissions()
18031: group: (optional) the group you want the files associated with
18032: file: (optional) the file you want access info on
18033:
18034: Returns:
1.749 raeburn 18035: a hash (keys are file names) of hashes containing
18036: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
18037: values are XML containing access control settings (see below)
1.747 albertel 18038:
18039: Internal notes:
18040:
1.749 raeburn 18041: access controls are stored in file_permissions.db as key=value pairs.
18042: key -> path to file/file_name\0uniqueID:scope_end_start
18043: where scope -> public,guest,course,group,domains or users.
18044: end -> UNIX time for end of access (0 -> no end date)
18045: start -> UNIX time for start of access
18046:
18047: value -> XML description of access control
18048: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
18049: <start></start>
18050: <end></end>
18051:
18052: <password></password> for scope type = guest
18053:
18054: <domain></domain> for scope type = course or group
18055: <number></number>
18056: <roles id="">
18057: <role></role>
18058: <access></access>
18059: <section></section>
18060: <group></group>
18061: </roles>
18062:
18063: <dom></dom> for scope type = domains
18064:
18065: <users> for scope type = users
18066: <user>
18067: <uname></uname>
18068: <udom></udom>
18069: </user>
18070: </users>
18071: </scope>
18072:
18073: Access data is also aggregated for each file in an additional key=value pair:
18074: key -> path to file/file_name\0accesscontrol
18075: value -> reference to hash
18076: hash contains key = value pairs
18077: where key = uniqueID:scope_end_start
18078: value = UNIX time record was last updated
18079:
18080: Used to improve speed of look-ups of access controls for each file.
18081:
18082: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
18083:
1.1198 raeburn 18084: =item *
18085:
1.749 raeburn 18086: modify_access_controls():
18087:
18088: Modifies access controls for a portfolio file
18089: Args
18090: 1. file name
18091: 2. reference to hash of required changes,
18092: 3. domain
18093: 4. username
18094: where domain,username are the domain of the portfolio owner
18095: (either a user or a course)
18096:
18097: Returns:
18098: 1. result of additions or updates ('ok' or 'error', with error message).
18099: 2. result of deletions ('ok' or 'error', with error message).
18100: 3. reference to hash of any new or updated access controls.
18101: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
18102: key = integer (inbound ID)
1.1198 raeburn 18103: value = uniqueID
18104:
18105: =item *
18106:
18107: get_timebased_id():
18108:
18109: Attempts to get a unique timestamp-based suffix for use with items added to a
18110: course via the Course Editor (e.g., folders, composite pages,
18111: group bulletin boards).
18112:
18113: Args: (first three required; six others optional)
18114:
18115: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
18116: docssequence, or name of group
18117:
18118: 2. keyid (alphanumeric): name of temporary locking key in hash,
18119: e.g., num, boardids
18120:
18121: 3. namespace: name of gdbm file used to store suffixes already assigned;
18122: file will be named nohist_namespace.db
18123:
18124: 4. cdom: domain of course; default is current course domain from %env
18125:
18126: 5. cnum: course number; default is current course number from %env
18127:
18128: 6. idtype: set to concat if an additional digit is to be appended to the
18129: unix timestamp to form the suffix, if the plain timestamp is already
18130: in use. Default is to not do this, but simply increment the unix
18131: timestamp by 1 until a unique key is obtained.
18132:
18133: 7. who: holder of locking key; defaults to user:domain for user.
18134:
18135: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
18136: retrying); default is 3.
18137:
18138: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
18139:
18140: Returns:
18141:
18142: 1. suffix obtained (numeric)
18143:
18144: 2. result of deleting locking key (ok if deleted, or lock never obtained)
18145:
18146: 3. error: contains (localized) error message if an error occurred.
18147:
1.747 albertel 18148:
1.608 albertel 18149: =back
18150:
1.243 albertel 18151: =head2 HTTP Helper Routines
18152:
18153: =over 4
18154:
1.191 harris41 18155: =item *
18156:
18157: escape() : unpack non-word characters into CGI-compatible hex codes
18158:
18159: =item *
18160:
18161: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
18162:
1.243 albertel 18163: =back
18164:
18165: =head1 PRIVATE SUBROUTINES
18166:
18167: =head2 Underlying communication routines (Shouldn't call)
18168:
18169: =over 4
18170:
18171: =item *
18172:
18173: subreply() : tries to pass a message to lonc, returns con_lost if incapable
18174:
18175: =item *
18176:
18177: reply() : uses subreply to send a message to remote machine, logs all failures
18178:
18179: =item *
18180:
18181: critical() : passes a critical message to another server; if cannot
18182: get through then place message in connection buffer directory and
18183: returns con_delayed, if incapable of saving message, returns
18184: con_failed
18185:
18186: =item *
18187:
18188: reconlonc() : tries to reconnect lonc client processes.
18189:
18190: =back
18191:
18192: =head2 Resource Access Logging
18193:
18194: =over 4
18195:
18196: =item *
18197:
18198: flushcourselogs() : flush (save) buffer logs and access logs
18199:
18200: =item *
18201:
18202: courselog($what) : save message for course in hash
18203:
18204: =item *
18205:
18206: courseacclog($what) : save message for course using &courselog(). Perform
18207: special processing for specific resource types (problems, exams, quizzes, etc).
18208:
1.191 harris41 18209: =item *
18210:
18211: goodbye() : flush course logs and log shutting down; it is called in srm.conf
18212: as a PerlChildExitHandler
1.243 albertel 18213:
18214: =back
18215:
18216: =head2 Other
18217:
18218: =over 4
18219:
18220: =item *
18221:
18222: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 18223:
18224: =back
18225:
18226: =cut
1.877 foxr 18227:
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