Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1172.2.90
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1172.2.90! raeburn 4: # $Id: lonnet.pm,v 1.1172.2.89 2017/01/22 17:41:07 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.8 www 74: use LWP::UserAgent();
1.486 www 75: use HTTP::Date;
1.977 amueller 76: use Image::Magick;
77:
1.1172.2.36 raeburn 78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.1138 raeburn 79: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
80: %managerstab);
1.871 albertel 81:
82: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
83: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
84: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 85: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 86:
1.1 albertel 87: use IO::Socket;
1.31 www 88: use GDBM_File;
1.208 albertel 89: use HTML::LCParser;
1.88 www 90: use Fcntl qw(:flock);
1.870 albertel 91: use Storable qw(thaw nfreeze);
1.1172.2.79 raeburn 92: use Time::HiRes qw( sleep gettimeofday tv_interval );
1.599 albertel 93: use Cache::Memcached;
1.676 albertel 94: use Digest::MD5;
1.790 albertel 95: use Math::Random;
1.1024 raeburn 96: use File::MMagic;
1.807 albertel 97: use LONCAPA qw(:DEFAULT :match);
1.740 www 98: use LONCAPA::Configuration;
1.1160 www 99: use LONCAPA::lonmetadata;
1.1172.2.22 raeburn 100: use LONCAPA::Lond;
1.1117 foxr 101:
1.1090 raeburn 102: use File::Copy;
1.676 albertel 103:
1.195 www 104: my $readit;
1.1172.2.79 raeburn 105: my $max_connection_retries = 20; # Or some such value.
1.1 albertel 106:
1.619 albertel 107: require Exporter;
108:
109: our @ISA = qw (Exporter);
110: our @EXPORT = qw(%env);
111:
1.1172.2.9 raeburn 112: # ------------------------------------ Logging (parameters, docs, slots, roles)
1.729 www 113: {
114: my $logid;
1.1172.2.9 raeburn 115: sub write_log {
116: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
117: if ($context eq 'course') {
118: if (($cnum eq '') || ($cdom eq '')) {
119: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
120: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
121: }
1.957 raeburn 122: }
1.1172.2.13 raeburn 123: $logid ++;
1.957 raeburn 124: my $now = time();
125: my $id=$now.'00000'.$$.'00000'.$logid;
1.1172.2.9 raeburn 126: my $logentry = {
127: $id => {
128: 'exe_uname' => $env{'user.name'},
129: 'exe_udom' => $env{'user.domain'},
130: 'exe_time' => $now,
131: 'exe_ip' => $ENV{'REMOTE_ADDR'},
132: 'delflag' => $delflag,
133: 'logentry' => $storehash,
134: 'uname' => $uname,
135: 'udom' => $udom,
136: }
137: };
138: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
1.729 www 139: }
140: }
1.1 albertel 141:
1.163 harris41 142: sub logtouch {
143: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 144: unless (-e "$execdir/logs/lonnet.log") {
145: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 146: close $fh;
147: }
148: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
149: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
150: }
151:
1.1 albertel 152: sub logthis {
153: my $message=shift;
154: my $execdir=$perlvar{'lonDaemons'};
155: my $now=time;
156: my $local=localtime($now);
1.448 albertel 157: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986 foxr 158: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
159: print $fh $logstring;
1.448 albertel 160: close($fh);
161: }
1.1 albertel 162: return 1;
163: }
164:
165: sub logperm {
166: my $message=shift;
167: my $execdir=$perlvar{'lonDaemons'};
168: my $now=time;
169: my $local=localtime($now);
1.448 albertel 170: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
171: print $fh "$now:$message:$local\n";
172: close($fh);
173: }
1.1 albertel 174: return 1;
175: }
176:
1.850 albertel 177: sub create_connection {
1.853 albertel 178: my ($hostname,$lonid) = @_;
1.851 albertel 179: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 180: Type => SOCK_STREAM,
181: Timeout => 10);
182: return 0 if (!$client);
1.890 albertel 183: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 184: my $result = <$client>;
185: chomp($result);
186: return 1 if ($result eq 'done');
187: return 0;
188: }
189:
1.983 raeburn 190: sub get_server_timezone {
191: my ($cnum,$cdom) = @_;
192: my $home=&homeserver($cnum,$cdom);
193: if ($home ne 'no_host') {
194: my $cachetime = 24*3600;
195: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
196: if (defined($cached)) {
197: return $timezone;
198: } else {
199: my $timezone = &reply('servertimezone',$home);
200: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
201: }
202: }
203: }
1.850 albertel 204:
1.1106 raeburn 205: sub get_server_distarch {
206: my ($lonhost,$ignore_cache) = @_;
207: if (defined($lonhost)) {
208: if (!defined(&hostname($lonhost))) {
209: return;
210: }
211: my $cachetime = 12*3600;
212: if (!$ignore_cache) {
213: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
214: if (defined($cached)) {
215: return $distarch;
216: }
217: }
218: my $rep = &reply('serverdistarch',$lonhost);
219: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
220: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
221: $rep eq '') {
222: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
223: }
224: }
225: return;
226: }
227:
1.993 raeburn 228: sub get_server_loncaparev {
1.1073 raeburn 229: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
1.993 raeburn 230: if (defined($lonhost)) {
231: if (!defined(&hostname($lonhost))) {
232: undef($lonhost);
233: }
234: }
235: if (!defined($lonhost)) {
236: if (defined(&domain($dom,'primary'))) {
237: $lonhost=&domain($dom,'primary');
238: if ($lonhost eq 'no_host') {
239: undef($lonhost);
240: }
241: }
242: }
243: if (defined($lonhost)) {
1.1073 raeburn 244: my $cachetime = 12*3600;
245: if (!$ignore_cache) {
246: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
247: if (defined($cached)) {
248: return $loncaparev;
249: }
250: }
251: my ($answer,$loncaparev);
252: my @ids=¤t_machine_ids();
253: if (grep(/^\Q$lonhost\E$/,@ids)) {
254: $answer = $perlvar{'lonVersion'};
1.1081 raeburn 255: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 256: $loncaparev = $1;
257: }
258: } else {
259: $answer = &reply('serverloncaparev',$lonhost);
260: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
261: if ($caller eq 'loncron') {
262: my $ua=new LWP::UserAgent;
1.1082 raeburn 263: $ua->timeout(4);
1.1073 raeburn 264: my $protocol = $protocol{$lonhost};
265: $protocol = 'http' if ($protocol ne 'https');
266: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
267: my $request=new HTTP::Request('GET',$url);
268: my $response=$ua->request($request);
269: unless ($response->is_error()) {
270: my $content = $response->content;
1.1081 raeburn 271: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
1.1073 raeburn 272: $loncaparev = $1;
273: }
274: }
275: } else {
276: $loncaparev = $loncaparevs{$lonhost};
277: }
1.1081 raeburn 278: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 279: $loncaparev = $1;
280: }
1.993 raeburn 281: }
1.1073 raeburn 282: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
1.993 raeburn 283: }
284: }
285:
1.1074 raeburn 286: sub get_server_homeID {
287: my ($hostname,$ignore_cache,$caller) = @_;
288: unless ($ignore_cache) {
289: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
290: if (defined($cached)) {
291: return $serverhomeID;
292: }
293: }
294: my $cachetime = 12*3600;
295: my $serverhomeID;
296: if ($caller eq 'loncron') {
297: my @machine_ids = &machine_ids($hostname);
298: foreach my $id (@machine_ids) {
299: my $response = &reply('serverhomeID',$id);
300: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
301: $serverhomeID = $response;
302: last;
303: }
304: }
305: if ($serverhomeID eq '') {
306: $serverhomeID = $machine_ids[-1];
307: }
308: } else {
309: $serverhomeID = $serverhomeIDs{$hostname};
310: }
311: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
312: }
313:
1.1121 raeburn 314: sub get_remote_globals {
315: my ($lonhost,$whathash,$ignore_cache) = @_;
1.1125 raeburn 316: my ($result,%returnhash,%whatneeded);
317: if (ref($whathash) eq 'HASH') {
1.1121 raeburn 318: foreach my $what (sort(keys(%{$whathash}))) {
319: my $hashid = $lonhost.'-'.$what;
1.1125 raeburn 320: my ($response,$cached);
1.1121 raeburn 321: unless ($ignore_cache) {
1.1125 raeburn 322: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
1.1121 raeburn 323: }
324: if (defined($cached)) {
1.1125 raeburn 325: $returnhash{$what} = $response;
1.1121 raeburn 326: } else {
1.1125 raeburn 327: $whatneeded{$what} = 1;
1.1121 raeburn 328: }
329: }
1.1125 raeburn 330: if (keys(%whatneeded) == 0) {
331: $result = 'ok';
332: } else {
1.1121 raeburn 333: my $requested = &freeze_escape(\%whatneeded);
334: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
1.1125 raeburn 335: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
336: ($rep eq 'unknown_cmd')) {
337: $result = $rep;
338: } else {
339: $result = 'ok';
1.1121 raeburn 340: my @pairs=split(/\&/,$rep);
1.1125 raeburn 341: foreach my $item (@pairs) {
342: my ($key,$value)=split(/=/,$item,2);
343: my $what = &unescape($key);
344: my $hashid = $lonhost.'-'.$what;
345: $returnhash{$what}=&thaw_unescape($value);
346: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
1.1121 raeburn 347: }
348: }
349: }
350: }
1.1125 raeburn 351: return ($result,\%returnhash);
1.1121 raeburn 352: }
353:
1.1124 raeburn 354: sub remote_devalidate_cache {
1.1172.2.35 raeburn 355: my ($lonhost,$cachekeys) = @_;
356: my $items;
357: return unless (ref($cachekeys) eq 'ARRAY');
358: my $cachestr = join('&',@{$cachekeys});
359: return &reply('devalidatecache:'.&escape($cachestr),$lonhost);
1.1124 raeburn 360: }
361:
1.1 albertel 362: # -------------------------------------------------- Non-critical communication
363: sub subreply {
364: my ($cmd,$server)=@_;
1.838 albertel 365: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 366: #
367: # With loncnew process trimming, there's a timing hole between lonc server
368: # process exit and the master server picking up the listen on the AF_UNIX
369: # socket. In that time interval, a lock file will exist:
370:
371: my $lockfile=$peerfile.".lock";
372: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
1.1172.2.79 raeburn 373: sleep(0.1);
1.549 foxr 374: }
375: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 376: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 377: #
1.550 foxr 378: # We'll give the connection a few tries before abandoning it. If
379: # connection is not possible, we'll con_lost back to the client.
380: #
381: my $client;
382: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
383: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
384: Type => SOCK_STREAM,
385: Timeout => 10);
1.869 albertel 386: if ($client) {
1.550 foxr 387: last; # Connected!
1.850 albertel 388: } else {
1.853 albertel 389: &create_connection(&hostname($server),$server);
1.550 foxr 390: }
1.1172.2.79 raeburn 391: sleep(0.1); # Try again later if failed connection.
1.550 foxr 392: }
393: my $answer;
394: if ($client) {
1.704 albertel 395: print $client "sethost:$server:$cmd\n";
1.550 foxr 396: $answer=<$client>;
397: if (!$answer) { $answer="con_lost"; }
398: chomp($answer);
399: } else {
400: $answer = 'con_lost'; # Failed connection.
401: }
1.1 albertel 402: return $answer;
403: }
404:
405: sub reply {
406: my ($cmd,$server)=@_;
1.838 albertel 407: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 408: my $answer=subreply($cmd,$server);
1.65 www 409: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 410: &logthis("<font color=\"blue\">WARNING:".
1.12 www 411: " $cmd to $server returned $answer</font>");
412: }
1.1 albertel 413: return $answer;
414: }
415:
416: # ----------------------------------------------------------- Send USR1 to lonc
417:
418: sub reconlonc {
1.891 albertel 419: my ($lonid) = @_;
420: if ($lonid) {
1.1172.2.72 raeburn 421: my $hostname = &hostname($lonid);
1.891 albertel 422: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
423: if ($hostname && -e $peerfile) {
424: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
425: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
426: Type => SOCK_STREAM,
427: Timeout => 10);
428: if ($client) {
429: print $client ("reset_retries\n");
430: my $answer=<$client>;
431: #reset just this one.
432: }
433: }
434: return;
435: }
436:
1.836 www 437: &logthis("Trying to reconnect lonc");
1.1 albertel 438: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 439: if (open(my $fh,"<$loncfile")) {
1.1 albertel 440: my $loncpid=<$fh>;
441: chomp($loncpid);
442: if (kill 0 => $loncpid) {
443: &logthis("lonc at pid $loncpid responding, sending USR1");
444: kill USR1 => $loncpid;
445: sleep 1;
1.836 www 446: } else {
1.12 www 447: &logthis(
1.672 albertel 448: "<font color=\"blue\">WARNING:".
1.12 www 449: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 450: }
451: } else {
1.836 www 452: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 453: }
454: }
455:
456: # ------------------------------------------------------ Critical communication
1.12 www 457:
1.1 albertel 458: sub critical {
459: my ($cmd,$server)=@_;
1.838 albertel 460: unless (&hostname($server)) {
1.672 albertel 461: &logthis("<font color=\"blue\">WARNING:".
1.89 www 462: " Critical message to unknown server ($server)</font>");
463: return 'no_such_host';
464: }
1.1 albertel 465: my $answer=reply($cmd,$server);
466: if ($answer eq 'con_lost') {
1.1172.2.72 raeburn 467: &reconlonc($server);
1.589 albertel 468: my $answer=reply($cmd,$server);
1.1 albertel 469: if ($answer eq 'con_lost') {
470: my $now=time;
471: my $middlename=$cmd;
1.5 www 472: $middlename=substr($middlename,0,16);
1.1 albertel 473: $middlename=~s/\W//g;
474: my $dfilename=
1.305 www 475: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
476: $dumpcount++;
1.1 albertel 477: {
1.448 albertel 478: my $dfh;
479: if (open($dfh,">$dfilename")) {
480: print $dfh "$cmd\n";
481: close($dfh);
482: }
1.1 albertel 483: }
1.1172.2.79 raeburn 484: sleep 1;
1.1 albertel 485: my $wcmd='';
486: {
1.448 albertel 487: my $dfh;
488: if (open($dfh,"<$dfilename")) {
489: $wcmd=<$dfh>;
490: close($dfh);
491: }
1.1 albertel 492: }
493: chomp($wcmd);
1.7 www 494: if ($wcmd eq $cmd) {
1.672 albertel 495: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 496: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 497: &logperm("D:$server:$cmd");
498: return 'con_delayed';
499: } else {
1.672 albertel 500: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 501: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 502: &logperm("F:$server:$cmd");
503: return 'con_failed';
504: }
505: }
506: }
507: return $answer;
1.405 albertel 508: }
509:
1.755 albertel 510: # ------------------------------------------- check if return value is an error
511:
512: sub error {
513: my ($result) = @_;
1.756 albertel 514: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 515: if ($2 == 2) { return undef; }
516: return $1;
517: }
518: return undef;
519: }
520:
1.783 albertel 521: sub convert_and_load_session_env {
522: my ($lonidsdir,$handle)=@_;
523: my @profile;
524: {
1.917 albertel 525: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
526: if (!$opened) {
1.915 albertel 527: return 0;
528: }
1.783 albertel 529: flock($idf,LOCK_SH);
530: @profile=<$idf>;
531: close($idf);
532: }
533: my %temp_env;
534: foreach my $line (@profile) {
1.786 albertel 535: if ($line !~ m/=/) {
536: return 0;
537: }
1.783 albertel 538: chomp($line);
539: my ($envname,$envvalue)=split(/=/,$line,2);
540: $temp_env{&unescape($envname)} = &unescape($envvalue);
541: }
542: unlink("$lonidsdir/$handle.id");
543: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
544: 0640)) {
545: %disk_env = %temp_env;
546: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
547: untie(%disk_env);
548: }
1.786 albertel 549: return 1;
1.783 albertel 550: }
551:
1.374 www 552: # ------------------------------------------- Transfer profile into environment
1.780 albertel 553: my $env_loaded;
554: sub transfer_profile_to_env {
1.788 albertel 555: my ($lonidsdir,$handle,$force_transfer) = @_;
556: if (!$force_transfer && $env_loaded) { return; }
1.374 www 557:
1.720 albertel 558: if (!defined($lonidsdir)) {
559: $lonidsdir = $perlvar{'lonIDsDir'};
560: }
561: if (!defined($handle)) {
562: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
563: }
564:
1.786 albertel 565: my $convert;
566: {
1.917 albertel 567: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
568: if (!$opened) {
1.915 albertel 569: return;
570: }
1.786 albertel 571: flock($idf,LOCK_SH);
572: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
573: &GDBM_READER(),0640)) {
574: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
575: untie(%disk_env);
576: } else {
577: $convert = 1;
578: }
579: }
580: if ($convert) {
581: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
582: &logthis("Failed to load session, or convert session.");
583: }
1.374 www 584: }
1.783 albertel 585:
1.786 albertel 586: my %remove;
1.783 albertel 587: while ( my $envname = each(%env) ) {
1.433 matthew 588: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
589: if ($time < time-300) {
1.783 albertel 590: $remove{$key}++;
1.433 matthew 591: }
592: }
593: }
1.783 albertel 594:
1.619 albertel 595: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 596: $env_loaded=1;
1.783 albertel 597: foreach my $expired_key (keys(%remove)) {
1.433 matthew 598: &delenv($expired_key);
1.374 www 599: }
1.1 albertel 600: }
601:
1.916 albertel 602: # ---------------------------------------------------- Check for valid session
603: sub check_for_valid_session {
1.1172.2.36 raeburn 604: my ($r,$name,$userhashref) = @_;
1.916 albertel 605: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1155 raeburn 606: if ($name eq '') {
607: $name = 'lonID';
608: }
609: my $lonid=$cookies{$name};
1.916 albertel 610: return undef if (!$lonid);
611:
612: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1155 raeburn 613: my $lonidsdir;
614: if ($name eq 'lonDAV') {
615: $lonidsdir=$r->dir_config('lonDAVsessDir');
616: } else {
617: $lonidsdir=$r->dir_config('lonIDsDir');
618: }
1.916 albertel 619: return undef if (!-e "$lonidsdir/$handle.id");
620:
1.917 albertel 621: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
622: return undef if (!$opened);
1.916 albertel 623:
624: flock($idf,LOCK_SH);
625: my %disk_env;
626: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
627: &GDBM_READER(),0640)) {
628: return undef;
629: }
630:
631: if (!defined($disk_env{'user.name'})
632: || !defined($disk_env{'user.domain'})) {
633: return undef;
634: }
1.1172.2.18 raeburn 635:
1.1172.2.36 raeburn 636: if (ref($userhashref) eq 'HASH') {
637: $userhashref->{'name'} = $disk_env{'user.name'};
638: $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1172.2.18 raeburn 639: }
640:
1.916 albertel 641: return $handle;
642: }
643:
1.830 albertel 644: sub timed_flock {
645: my ($file,$lock_type) = @_;
646: my $failed=0;
647: eval {
648: local $SIG{__DIE__}='DEFAULT';
649: local $SIG{ALRM}=sub {
650: $failed=1;
651: die("failed lock");
652: };
653: alarm(13);
654: flock($file,$lock_type);
655: alarm(0);
656: };
657: if ($failed) {
658: return undef;
659: } else {
660: return 1;
661: }
662: }
663:
1.5 www 664: # ---------------------------------------------------------- Append Environment
665:
666: sub appenv {
1.949 raeburn 667: my ($newenv,$roles) = @_;
668: if (ref($newenv) eq 'HASH') {
669: foreach my $key (keys(%{$newenv})) {
670: my $refused = 0;
671: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
672: $refused = 1;
673: if (ref($roles) eq 'ARRAY') {
1.1172.2.40 raeburn 674: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949 raeburn 675: if (grep(/^\Q$role\E$/,@{$roles})) {
676: $refused = 0;
677: }
678: }
679: }
680: if ($refused) {
681: &logthis("<font color=\"blue\">WARNING: ".
682: "Attempt to modify environment ".$key." to ".$newenv->{$key}
683: .'</font>');
684: delete($newenv->{$key});
685: } else {
686: $env{$key}=$newenv->{$key};
687: }
688: }
689: my $opened = open(my $env_file,'+<',$env{'user.environment'});
690: if ($opened
691: && &timed_flock($env_file,LOCK_EX)
692: &&
693: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
694: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
695: while (my ($key,$value) = each(%{$newenv})) {
696: $disk_env{$key} = $value;
697: }
698: untie(%disk_env);
1.35 www 699: }
1.191 harris41 700: }
1.56 www 701: return 'ok';
702: }
703: # ----------------------------------------------------- Delete from Environment
704:
705: sub delenv {
1.1104 raeburn 706: my ($delthis,$regexp,$roles) = @_;
707: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
708: my $refused = 1;
709: if (ref($roles) eq 'ARRAY') {
710: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
711: if (grep(/^\Q$role\E$/,@{$roles})) {
712: $refused = 0;
713: }
714: }
715: if ($refused) {
716: &logthis("<font color=\"blue\">WARNING: ".
717: "Attempt to delete from environment ".$delthis);
718: return 'error';
719: }
1.56 www 720: }
1.917 albertel 721: my $opened = open(my $env_file,'+<',$env{'user.environment'});
722: if ($opened
1.915 albertel 723: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 724: &&
725: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
726: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 727: foreach my $key (keys(%disk_env)) {
1.987 raeburn 728: if ($regexp) {
729: if ($key=~/^$delthis/) {
730: delete($env{$key});
731: delete($disk_env{$key});
732: }
733: } else {
734: if ($key=~/^\Q$delthis\E/) {
735: delete($env{$key});
736: delete($disk_env{$key});
737: }
738: }
1.448 albertel 739: }
1.783 albertel 740: untie(%disk_env);
1.5 www 741: }
742: return 'ok';
1.369 albertel 743: }
744:
1.790 albertel 745: sub get_env_multiple {
746: my ($name) = @_;
747: my @values;
748: if (defined($env{$name})) {
749: # exists is it an array
750: if (ref($env{$name})) {
751: @values=@{ $env{$name} };
752: } else {
753: $values[0]=$env{$name};
754: }
755: }
756: return(@values);
757: }
758:
1.958 www 759: # ------------------------------------------------------------------- Locking
760:
761: sub set_lock {
762: my ($text)=@_;
763: $locknum++;
764: my $id=$$.'-'.$locknum;
765: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
766: 'session.lock.'.$id => $text});
767: return $id;
768: }
769:
770: sub get_locks {
771: my $num=0;
772: my %texts=();
773: foreach my $lock (split(/\,/,$env{'session.locks'})) {
774: if ($lock=~/\w/) {
775: $num++;
776: $texts{$lock}=$env{'session.lock.'.$lock};
777: }
778: }
779: return ($num,%texts);
780: }
781:
782: sub remove_lock {
783: my ($id)=@_;
784: my $newlocks='';
785: foreach my $lock (split(/\,/,$env{'session.locks'})) {
786: if (($lock=~/\w/) && ($lock ne $id)) {
787: $newlocks.=','.$lock;
788: }
789: }
790: &appenv({'session.locks' => $newlocks});
791: &delenv('session.lock.'.$id);
792: }
793:
794: sub remove_all_locks {
795: my $activelocks=$env{'session.locks'};
796: foreach my $lock (split(/\,/,$env{'session.locks'})) {
797: if ($lock=~/\w/) {
798: &remove_lock($lock);
799: }
800: }
801: }
802:
803:
1.369 albertel 804: # ------------------------------------------ Find out current server userload
805: sub userload {
806: my $numusers=0;
807: {
808: opendir(LONIDS,$perlvar{'lonIDsDir'});
809: my $filename;
810: my $curtime=time;
811: while ($filename=readdir(LONIDS)) {
1.925 albertel 812: next if ($filename eq '.' || $filename eq '..');
813: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 814: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 815: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 816: }
817: closedir(LONIDS);
818: }
819: my $userloadpercent=0;
820: my $maxuserload=$perlvar{'lonUserLoadLim'};
821: if ($maxuserload) {
1.371 albertel 822: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 823: }
1.372 albertel 824: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 825: return $userloadpercent;
1.283 www 826: }
827:
1.1 albertel 828: # ------------------------------ Find server with least workload from spare.tab
1.11 www 829:
1.1 albertel 830: sub spareserver {
1.1083 raeburn 831: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 832: my $spare_server;
1.370 albertel 833: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 834: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
835: : $userloadpercent;
1.1083 raeburn 836: my ($uint_dom,$remotesessions);
837: if (($udom ne '') && (&domain($udom) ne '')) {
838: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
839: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
840: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
841: $remotesessions = $udomdefaults{'remotesessions'};
842: }
1.1123 raeburn 843: my $spareshash = &this_host_spares($udom);
844: if (ref($spareshash) eq 'HASH') {
845: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
846: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1.1172.2.62 raeburn 847: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
848: $try_server));
1.1123 raeburn 849: ($spare_server, $lowest_load) =
850: &compare_server_load($try_server, $spare_server, $lowest_load);
851: }
1.1083 raeburn 852: }
1.784 albertel 853:
1.1123 raeburn 854: my $found_server = ($spare_server ne '' && $lowest_load < 100);
855:
856: if (!$found_server) {
857: if (ref($spareshash->{'default'}) eq 'ARRAY') {
858: foreach my $try_server (@{ $spareshash->{'default'} }) {
1.1172.2.62 raeburn 859: next unless (&spare_can_host($udom,$uint_dom,
860: $remotesessions,$try_server));
1.1123 raeburn 861: ($spare_server, $lowest_load) =
862: &compare_server_load($try_server, $spare_server, $lowest_load);
863: }
864: }
865: }
1.784 albertel 866: }
867:
868: if (!$want_server_name) {
1.968 raeburn 869: my $protocol = 'http';
870: if ($protocol{$spare_server} eq 'https') {
871: $protocol = $protocol{$spare_server};
872: }
1.1001 raeburn 873: if (defined($spare_server)) {
874: my $hostname = &hostname($spare_server);
1.1083 raeburn 875: if (defined($hostname)) {
1.1001 raeburn 876: $spare_server = $protocol.'://'.$hostname;
877: }
878: }
1.784 albertel 879: }
880: return $spare_server;
881: }
882:
883: sub compare_server_load {
1.1172.2.41 raeburn 884: my ($try_server, $spare_server, $lowest_load, $required) = @_;
885:
886: if ($required) {
887: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
888: my $remoterev = &get_server_loncaparev(undef,$try_server);
889: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
890: if (($major eq '' && $minor eq '') ||
891: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
892: return ($spare_server,$lowest_load);
893: }
894: }
1.784 albertel 895:
896: my $loadans = &reply('load', $try_server);
897: my $userloadans = &reply('userload',$try_server);
898:
899: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 900: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 901: }
902:
903: my $load;
904: if ($loadans =~ /\d/) {
905: if ($userloadans =~ /\d/) {
906: #both are numbers, pick the bigger one
907: $load = ($loadans > $userloadans) ? $loadans
908: : $userloadans;
1.411 albertel 909: } else {
1.784 albertel 910: $load = $loadans;
1.411 albertel 911: }
1.784 albertel 912: } else {
913: $load = $userloadans;
914: }
915:
916: if (($load =~ /\d/) && ($load < $lowest_load)) {
917: $spare_server = $try_server;
918: $lowest_load = $load;
1.370 albertel 919: }
1.784 albertel 920: return ($spare_server,$lowest_load);
1.202 matthew 921: }
1.914 albertel 922:
923: # --------------------------- ask offload servers if user already has a session
924: sub find_existing_session {
925: my ($udom,$uname) = @_;
1.1123 raeburn 926: my $spareshash = &this_host_spares($udom);
927: if (ref($spareshash) eq 'HASH') {
928: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
929: foreach my $try_server (@{ $spareshash->{'primary'} }) {
930: return $try_server if (&has_user_session($try_server, $udom, $uname));
931: }
932: }
933: if (ref($spareshash->{'default'}) eq 'ARRAY') {
934: foreach my $try_server (@{ $spareshash->{'default'} }) {
935: return $try_server if (&has_user_session($try_server, $udom, $uname));
936: }
937: }
1.914 albertel 938: }
939: return;
940: }
941:
942: # -------------------------------- ask if server already has a session for user
943: sub has_user_session {
944: my ($lonid,$udom,$uname) = @_;
945: my $result = &reply(join(':','userhassession',
946: map {&escape($_)} ($udom,$uname)),$lonid);
947: return 1 if ($result eq 'ok');
948:
949: return 0;
950: }
951:
1.1076 raeburn 952: # --------- determine least loaded server in a user's domain which allows login
953:
954: sub choose_server {
1.1172.2.47 raeburn 955: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076 raeburn 956: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 957: my %servers = &get_servers($udom);
1.1076 raeburn 958: my $lowest_load = 30000;
1.1172.2.47 raeburn 959: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
960: if ($skiploadbal) {
961: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
962: unless (defined($cached)) {
963: my $cachetime = 60*60*24;
964: my %domconfig =
965: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
966: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
967: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
968: $cachetime);
969: }
970: }
971: }
1.1076 raeburn 972: foreach my $lonhost (keys(%servers)) {
1.1115 raeburn 973: my $loginvia;
1.1172.2.47 raeburn 974: if ($skiploadbal) {
975: if (ref($balancers) eq 'HASH') {
976: next if (exists($balancers->{$lonhost}));
977: }
978: }
1.1115 raeburn 979: if ($checkloginvia) {
980: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 981: if ($loginvia) {
982: my ($server,$path) = split(/:/,$loginvia);
983: ($login_host, $lowest_load) =
1.1172.2.41 raeburn 984: &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116 raeburn 985: if ($login_host eq $server) {
986: $portal_path = $path;
1.1151 raeburn 987: $isredirect = 1;
1.1116 raeburn 988: }
989: } else {
990: ($login_host, $lowest_load) =
1.1172.2.41 raeburn 991: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116 raeburn 992: if ($login_host eq $lonhost) {
993: $portal_path = '';
1.1151 raeburn 994: $isredirect = '';
1.1116 raeburn 995: }
996: }
997: } else {
1.1076 raeburn 998: ($login_host, $lowest_load) =
1.1172.2.41 raeburn 999: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076 raeburn 1000: }
1001: }
1002: if ($login_host ne '') {
1.1116 raeburn 1003: $hostname = &hostname($login_host);
1.1076 raeburn 1004: }
1.1172.2.88 raeburn 1005: return ($login_host,$hostname,$portal_path,$isredirect,$lowest_load);
1.1076 raeburn 1006: }
1007:
1.202 matthew 1008: # --------------------------------------------- Try to change a user's password
1009:
1010: sub changepass {
1.799 raeburn 1011: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 1012: $currentpass = &escape($currentpass);
1013: $newpass = &escape($newpass);
1.1030 raeburn 1014: my $lonhost = $perlvar{'lonHostID'};
1015: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 1016: $server);
1017: if (! $answer) {
1018: &logthis("No reply on password change request to $server ".
1019: "by $uname in domain $udom.");
1020: } elsif ($answer =~ "^ok") {
1021: &logthis("$uname in $udom successfully changed their password ".
1022: "on $server.");
1023: } elsif ($answer =~ "^pwchange_failure") {
1024: &logthis("$uname in $udom was unable to change their password ".
1025: "on $server. The action was blocked by either lcpasswd ".
1026: "or pwchange");
1027: } elsif ($answer =~ "^non_authorized") {
1028: &logthis("$uname in $udom did not get their password correct when ".
1029: "attempting to change it on $server.");
1030: } elsif ($answer =~ "^auth_mode_error") {
1031: &logthis("$uname in $udom attempted to change their password despite ".
1032: "not being locally or internally authenticated on $server.");
1033: } elsif ($answer =~ "^unknown_user") {
1034: &logthis("$uname in $udom attempted to change their password ".
1035: "on $server but were unable to because $server is not ".
1036: "their home server.");
1037: } elsif ($answer =~ "^refused") {
1038: &logthis("$server refused to change $uname in $udom password because ".
1039: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1040: } elsif ($answer =~ "invalid_client") {
1041: &logthis("$server refused to change $uname in $udom password because ".
1042: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 1043: }
1044: return $answer;
1.1 albertel 1045: }
1046:
1.169 harris41 1047: # ----------------------- Try to determine user's current authentication scheme
1048:
1049: sub queryauthenticate {
1050: my ($uname,$udom)=@_;
1.456 albertel 1051: my $uhome=&homeserver($uname,$udom);
1052: if (!$uhome) {
1053: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1054: return 'no_host';
1055: }
1056: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1057: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1058: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1059: }
1.456 albertel 1060: return $answer;
1.169 harris41 1061: }
1062:
1.1 albertel 1063: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1064:
1.1 albertel 1065: sub authenticate {
1.1073 raeburn 1066: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1067: $upass=&escape($upass);
1068: $uname= &LONCAPA::clean_username($uname);
1.836 www 1069: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1070: my $newhome;
1.836 www 1071: if ((!$uhome) || ($uhome eq 'no_host')) {
1072: # Maybe the machine was offline and only re-appeared again recently?
1073: &reconlonc();
1074: # One more
1.952 raeburn 1075: $uhome=&homeserver($uname,$udom,1);
1076: if (($uhome eq 'no_host') && $checkdefauth) {
1077: if (defined(&domain($udom,'primary'))) {
1078: $newhome=&domain($udom,'primary');
1079: }
1080: if ($newhome ne '') {
1081: $uhome = $newhome;
1082: }
1083: }
1.836 www 1084: if ((!$uhome) || ($uhome eq 'no_host')) {
1085: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1086: return 'no_host';
1087: }
1.1 albertel 1088: }
1.1073 raeburn 1089: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1090: if ($answer eq 'authorized') {
1.952 raeburn 1091: if ($newhome) {
1092: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1093: return 'no_account_on_host';
1094: } else {
1095: &logthis("User $uname at $udom authorized by $uhome");
1096: return $uhome;
1097: }
1.471 albertel 1098: }
1099: if ($answer eq 'non_authorized') {
1100: &logthis("User $uname at $udom rejected by $uhome");
1101: return 'no_host';
1.9 www 1102: }
1.471 albertel 1103: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1104: return 'no_host';
1105: }
1106:
1.1073 raeburn 1107: sub can_host_session {
1.1074 raeburn 1108: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1109: my $canhost = 1;
1.1074 raeburn 1110: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1111: if (ref($remotesessions) eq 'HASH') {
1112: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1113: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1114: $canhost = 0;
1115: } else {
1116: $canhost = 1;
1117: }
1118: }
1119: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1120: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1121: $canhost = 1;
1122: } else {
1123: $canhost = 0;
1124: }
1125: }
1126: if ($canhost) {
1127: if ($remotesessions->{'version'} ne '') {
1128: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1129: if ($reqmajor ne '' && $reqminor ne '') {
1130: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1131: my $major = $1;
1132: my $minor = $2;
1133: if (($major < $reqmajor ) ||
1134: (($major == $reqmajor) && ($minor < $reqminor))) {
1135: $canhost = 0;
1136: }
1137: } else {
1138: $canhost = 0;
1139: }
1140: }
1141: }
1142: }
1143: }
1144: if ($canhost) {
1145: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1146: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1147: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1148: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1149: if (($uint_dom ne '') &&
1150: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1151: $canhost = 0;
1152: } else {
1153: $canhost = 1;
1154: }
1155: }
1156: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1157: if (($uint_dom ne '') &&
1158: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1159: $canhost = 1;
1160: } else {
1161: $canhost = 0;
1162: }
1163: }
1164: }
1165: }
1166: return $canhost;
1167: }
1168:
1.1083 raeburn 1169: sub spare_can_host {
1170: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1171: my $canhost=1;
1.1172.2.62 raeburn 1172: my $try_server_hostname = &hostname($try_server);
1173: my $serverhomeID = &get_server_homeID($try_server_hostname);
1174: my $serverhomedom = &host_domain($serverhomeID);
1175: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1176: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1177: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1178: $canhost = 0;
1179: }
1180: }
1181: if (($canhost) && ($uint_dom)) {
1182: my @intdoms;
1183: my $internet_names = &get_internet_names($try_server);
1184: if (ref($internet_names) eq 'ARRAY') {
1185: @intdoms = @{$internet_names};
1186: }
1187: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1188: my $remoterev = &get_server_loncaparev(undef,$try_server);
1189: $canhost = &can_host_session($udom,$try_server,$remoterev,
1190: $remotesessions,
1191: $defdomdefaults{'hostedsessions'});
1192: }
1.1083 raeburn 1193: }
1194: return $canhost;
1195: }
1196:
1.1123 raeburn 1197: sub this_host_spares {
1198: my ($dom) = @_;
1.1126 raeburn 1199: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1200: my @hosts = ¤t_machine_ids();
1201: foreach my $lonhost (@hosts) {
1202: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1203: $dom_in_use = $dom;
1204: $lonhost_in_use = $lonhost;
1.1123 raeburn 1205: last;
1206: }
1207: }
1.1126 raeburn 1208: if ($dom_in_use ne '') {
1209: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1210: }
1211: if (ref($result) ne 'HASH') {
1212: $lonhost_in_use = $perlvar{'lonHostID'};
1213: $dom_in_use = &host_domain($lonhost_in_use);
1214: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1215: if (ref($result) ne 'HASH') {
1216: $result = \%spareid;
1217: }
1218: }
1219: return $result;
1220: }
1221:
1222: sub spares_for_offload {
1223: my ($dom_in_use,$lonhost_in_use) = @_;
1224: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1225: if (defined($cached)) {
1226: return $result;
1227: } else {
1.1126 raeburn 1228: my $cachetime = 60*60*24;
1229: my %domconfig =
1230: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1231: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1232: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1233: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1234: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1235: }
1236: }
1237: }
1238: }
1.1126 raeburn 1239: return;
1.1123 raeburn 1240: }
1241:
1.1129 raeburn 1242: sub get_lonbalancer_config {
1243: my ($servers) = @_;
1244: my ($currbalancer,$currtargets);
1245: if (ref($servers) eq 'HASH') {
1246: foreach my $server (keys(%{$servers})) {
1247: my %what = (
1248: spareid => 1,
1249: perlvar => 1,
1250: );
1251: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1252: if ($result eq 'ok') {
1253: if (ref($returnhash) eq 'HASH') {
1254: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1255: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1256: $currbalancer = $server;
1257: $currtargets = {};
1258: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1259: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1260: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1261: }
1262: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1263: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1264: }
1265: }
1266: last;
1267: }
1268: }
1269: }
1270: }
1271: }
1272: }
1273: return ($currbalancer,$currtargets);
1274: }
1275:
1276: sub check_loadbalancing {
1.1172.2.88 raeburn 1277: my ($uname,$udom,$caller) = @_;
1.1172.2.12 raeburn 1278: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1279: $rule_in_effect,$offloadto,$otherserver);
1.1129 raeburn 1280: my $lonhost = $perlvar{'lonHostID'};
1.1172.2.4 raeburn 1281: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1282: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1283: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1284: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1285: my $serverhomedom = &host_domain($lonhost);
1.1172.2.75 raeburn 1286: my $domneedscache;
1.1129 raeburn 1287: my $cachetime = 60*60*24;
1288:
1289: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1290: $dom_in_use = $udom;
1291: $homeintdom = 1;
1292: } else {
1293: $dom_in_use = $serverhomedom;
1294: }
1295: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1296: unless (defined($cached)) {
1297: my %domconfig =
1298: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1299: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1300: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1172.2.75 raeburn 1301: } else {
1302: $domneedscache = $dom_in_use;
1.1129 raeburn 1303: }
1304: }
1305: if (ref($result) eq 'HASH') {
1.1172.2.12 raeburn 1306: ($is_balancer,$currtargets,$currrules) =
1307: &check_balancer_result($result,@hosts);
1.1129 raeburn 1308: if ($is_balancer) {
1309: if (ref($currrules) eq 'HASH') {
1310: if ($homeintdom) {
1311: if ($uname ne '') {
1312: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1313: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1314: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1315: $rule_in_effect = $currrules->{'_LC_author'};
1316: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1317: $rule_in_effect = $currrules->{'_LC_adv'}
1318: }
1319: }
1320: if ($rule_in_effect eq '') {
1321: my %userenv = &userenvironment($udom,$uname,'inststatus');
1322: if ($userenv{'inststatus'} ne '') {
1323: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1324: my ($othertitle,$usertypes,$types) =
1325: &Apache::loncommon::sorted_inst_types($udom);
1326: if (ref($types) eq 'ARRAY') {
1327: foreach my $type (@{$types}) {
1328: if (grep(/^\Q$type\E$/,@statuses)) {
1329: if (exists($currrules->{$type})) {
1330: $rule_in_effect = $currrules->{$type};
1331: }
1332: }
1333: }
1334: }
1335: } else {
1336: if (exists($currrules->{'default'})) {
1337: $rule_in_effect = $currrules->{'default'};
1338: }
1339: }
1340: }
1341: } else {
1342: if (exists($currrules->{'default'})) {
1343: $rule_in_effect = $currrules->{'default'};
1344: }
1345: }
1346: } else {
1347: if ($currrules->{'_LC_external'} ne '') {
1348: $rule_in_effect = $currrules->{'_LC_external'};
1349: }
1350: }
1351: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1352: $uname,$udom);
1353: }
1354: }
1355: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1172.2.35 raeburn 1356: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1357: unless (defined($cached)) {
1358: my %domconfig =
1359: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1360: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1172.2.75 raeburn 1361: $result = &do_cache_new('loadbalancing',$serverhomedom,$domconfig{'loadbalancing'},$cachetime);
1362: } else {
1363: $domneedscache = $serverhomedom;
1.1129 raeburn 1364: }
1365: }
1366: if (ref($result) eq 'HASH') {
1.1172.2.12 raeburn 1367: ($is_balancer,$currtargets,$currrules) =
1368: &check_balancer_result($result,@hosts);
1369: if ($is_balancer) {
1.1129 raeburn 1370: if (ref($currrules) eq 'HASH') {
1371: if ($currrules->{'_LC_internetdom'} ne '') {
1372: $rule_in_effect = $currrules->{'_LC_internetdom'};
1373: }
1374: }
1375: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1376: $uname,$udom);
1377: }
1378: } else {
1379: if ($perlvar{'lonBalancer'} eq 'yes') {
1380: $is_balancer = 1;
1381: $offloadto = &this_host_spares($dom_in_use);
1382: }
1.1172.2.75 raeburn 1383: unless (defined($cached)) {
1384: $domneedscache = $serverhomedom;
1385: }
1.1129 raeburn 1386: }
1387: } else {
1388: if ($perlvar{'lonBalancer'} eq 'yes') {
1389: $is_balancer = 1;
1390: $offloadto = &this_host_spares($dom_in_use);
1391: }
1.1172.2.75 raeburn 1392: unless (defined($cached)) {
1393: $domneedscache = $serverhomedom;
1394: }
1395: }
1396: if ($domneedscache) {
1397: &do_cache_new('loadbalancing',$domneedscache,$is_balancer,$cachetime);
1.1129 raeburn 1398: }
1.1172.2.5 raeburn 1399: if ($is_balancer) {
1400: my $lowest_load = 30000;
1401: if (ref($offloadto) eq 'HASH') {
1402: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1403: foreach my $try_server (@{$offloadto->{'primary'}}) {
1404: ($otherserver,$lowest_load) =
1405: &compare_server_load($try_server,$otherserver,$lowest_load);
1406: }
1.1129 raeburn 1407: }
1.1172.2.5 raeburn 1408: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1409:
1.1172.2.5 raeburn 1410: if (!$found_server) {
1411: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1412: foreach my $try_server (@{$offloadto->{'default'}}) {
1413: ($otherserver,$lowest_load) =
1414: &compare_server_load($try_server,$otherserver,$lowest_load);
1415: }
1416: }
1417: }
1418: } elsif (ref($offloadto) eq 'ARRAY') {
1419: if (@{$offloadto} == 1) {
1420: $otherserver = $offloadto->[0];
1421: } elsif (@{$offloadto} > 1) {
1422: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1423: ($otherserver,$lowest_load) =
1424: &compare_server_load($try_server,$otherserver,$lowest_load);
1425: }
1426: }
1427: }
1.1172.2.88 raeburn 1428: unless ($caller eq 'login') {
1429: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1430: $is_balancer = 0;
1431: if ($uname ne '' && $udom ne '') {
1432: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1.1172.2.5 raeburn 1433:
1.1172.2.88 raeburn 1434: &appenv({'user.loadbalexempt' => $lonhost,
1435: 'user.loadbalcheck.time' => time});
1436: }
1.1172.2.5 raeburn 1437: }
1.1129 raeburn 1438: }
1439: }
1440: }
1441: return ($is_balancer,$otherserver);
1442: }
1443:
1.1172.2.12 raeburn 1444: sub check_balancer_result {
1445: my ($result,@hosts) = @_;
1446: my ($is_balancer,$currtargets,$currrules);
1447: if (ref($result) eq 'HASH') {
1448: if ($result->{'lonhost'} ne '') {
1449: my $currbalancer = $result->{'lonhost'};
1450: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1451: $is_balancer = 1;
1452: $currtargets = $result->{'targets'};
1453: $currrules = $result->{'rules'};
1454: }
1455: } else {
1456: foreach my $key (keys(%{$result})) {
1457: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1458: (ref($result->{$key}) eq 'HASH')) {
1459: $is_balancer = 1;
1460: $currrules = $result->{$key}{'rules'};
1461: $currtargets = $result->{$key}{'targets'};
1462: last;
1463: }
1464: }
1465: }
1466: }
1467: return ($is_balancer,$currtargets,$currrules);
1468: }
1469:
1.1129 raeburn 1470: sub get_loadbalancer_targets {
1471: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1472: my $offloadto;
1.1172.2.4 raeburn 1473: if ($rule_in_effect eq 'none') {
1474: return [$perlvar{'lonHostID'}];
1475: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1476: $offloadto = $currtargets;
1477: } else {
1478: if ($rule_in_effect eq 'homeserver') {
1479: my $homeserver = &homeserver($uname,$udom);
1480: if ($homeserver ne 'no_host') {
1481: $offloadto = [$homeserver];
1482: }
1483: } elsif ($rule_in_effect eq 'externalbalancer') {
1484: my %domconfig =
1485: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1486: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1487: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1488: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1489: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1490: }
1491: }
1492: } else {
1.1172.2.7 raeburn 1493: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1494: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1495: if (&hostname($remotebalancer) ne '') {
1496: $offloadto = [$remotebalancer];
1497: }
1498: }
1499: } elsif (&hostname($rule_in_effect) ne '') {
1500: $offloadto = [$rule_in_effect];
1501: }
1502: }
1503: return $offloadto;
1504: }
1505:
1.1127 raeburn 1506: sub internet_dom_servers {
1507: my ($dom) = @_;
1508: my (%uniqservers,%servers);
1509: my $primaryserver = &hostname(&domain($dom,'primary'));
1510: my @machinedoms = &machine_domains($primaryserver);
1511: foreach my $mdom (@machinedoms) {
1512: my %currservers = %servers;
1513: my %server = &get_servers($mdom);
1514: %servers = (%currservers,%server);
1515: }
1516: my %by_hostname;
1517: foreach my $id (keys(%servers)) {
1518: push(@{$by_hostname{$servers{$id}}},$id);
1519: }
1520: foreach my $hostname (sort(keys(%by_hostname))) {
1521: if (@{$by_hostname{$hostname}} > 1) {
1522: my $match = 0;
1523: foreach my $id (@{$by_hostname{$hostname}}) {
1524: if (&host_domain($id) eq $dom) {
1525: $uniqservers{$id} = $hostname;
1526: $match = 1;
1527: }
1528: }
1529: unless ($match) {
1530: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1531: }
1532: } else {
1533: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1534: }
1535: }
1536: return %uniqservers;
1537: }
1538:
1.1 albertel 1539: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1540:
1.599 albertel 1541: my %homecache;
1.1 albertel 1542: sub homeserver {
1.230 stredwic 1543: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1544: my $index="$uname:$udom";
1.426 albertel 1545:
1.599 albertel 1546: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1547:
1548: my %servers = &get_servers($udom,'library');
1549: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1550: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1551: exists($badServerCache{$tryserver}));
1.841 albertel 1552:
1553: my $answer=reply("home:$udom:$uname",$tryserver);
1554: if ($answer eq 'found') {
1555: delete($badServerCache{$tryserver});
1556: return $homecache{$index}=$tryserver;
1557: } elsif ($answer eq 'no_host') {
1558: $badServerCache{$tryserver}=1;
1559: }
1.1 albertel 1560: }
1561: return 'no_host';
1.70 www 1562: }
1563:
1564: # ------------------------------------- Find the usernames behind a list of IDs
1565:
1566: sub idget {
1567: my ($udom,@ids)=@_;
1568: my %returnhash=();
1569:
1.841 albertel 1570: my %servers = &get_servers($udom,'library');
1571: foreach my $tryserver (keys(%servers)) {
1.1172.2.73 raeburn 1572: my $idlist=join('&', map { &escape($_); } @ids);
1.841 albertel 1573: $idlist=~tr/A-Z/a-z/;
1574: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1575: my @answer=();
1576: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1577: @answer=split(/\&/,$reply);
1578: } ;
1579: my $i;
1580: for ($i=0;$i<=$#ids;$i++) {
1581: if ($answer[$i]) {
1.1172.2.73 raeburn 1582: $returnhash{$ids[$i]}=&unescape($answer[$i]);
1.841 albertel 1583: }
1584: }
1585: }
1.70 www 1586: return %returnhash;
1587: }
1588:
1589: # ------------------------------------- Find the IDs behind a list of usernames
1590:
1591: sub idrget {
1592: my ($udom,@unames)=@_;
1593: my %returnhash=();
1.800 albertel 1594: foreach my $uname (@unames) {
1595: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1596: }
1.70 www 1597: return %returnhash;
1598: }
1599:
1600: # ------------------------------- Store away a list of names and associated IDs
1601:
1602: sub idput {
1603: my ($udom,%ids)=@_;
1604: my %servers=();
1.800 albertel 1605: foreach my $uname (keys(%ids)) {
1606: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1607: my $uhom=&homeserver($uname,$udom);
1.70 www 1608: if ($uhom ne 'no_host') {
1.800 albertel 1609: my $id=&escape($ids{$uname});
1.70 www 1610: $id=~tr/A-Z/a-z/;
1.800 albertel 1611: my $esc_unam=&escape($uname);
1.70 www 1612: if ($servers{$uhom}) {
1.800 albertel 1613: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 1614: } else {
1.800 albertel 1615: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 1616: }
1617: }
1.191 harris41 1618: }
1.800 albertel 1619: foreach my $server (keys(%servers)) {
1620: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 1621: }
1.344 www 1622: }
1623:
1.1172.2.30 raeburn 1624: # ---------------------------------------- Delete unwanted IDs from ids.db file
1625:
1626: sub iddel {
1627: my ($udom,$idshashref,$uhome)=@_;
1628: my %result=();
1629: unless (ref($idshashref) eq 'HASH') {
1630: return %result;
1631: }
1632: my %servers=();
1633: while (my ($id,$uname) = each(%{$idshashref})) {
1634: my $uhom;
1635: if ($uhome) {
1636: $uhom = $uhome;
1637: } else {
1638: $uhom=&homeserver($uname,$udom);
1639: }
1640: if ($uhom ne 'no_host') {
1641: if ($servers{$uhom}) {
1642: $servers{$uhom}.='&'.&escape($id);
1643: } else {
1644: $servers{$uhom}=&escape($id);
1645: }
1646: }
1647: }
1648: foreach my $server (keys(%servers)) {
1649: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1650: }
1651: return %result;
1652: }
1653:
1.1023 raeburn 1654: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 1655: sub dump_dom {
1.1165 droeschl 1656: my ($namespace, $udom, $regexp) = @_;
1657:
1658: $udom ||= $env{'user.domain'};
1659:
1660: return () unless $udom;
1661:
1662: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 1663: }
1664:
1.1023 raeburn 1665: # ------------------------------------------ get items from domain db files
1.806 raeburn 1666:
1667: sub get_dom {
1.860 raeburn 1668: my ($namespace,$storearr,$udom,$uhome)=@_;
1.1172.2.57 raeburn 1669: return if ($udom eq 'public');
1.806 raeburn 1670: my $items='';
1671: foreach my $item (@$storearr) {
1672: $items.=&escape($item).'&';
1673: }
1674: $items=~s/\&$//;
1.860 raeburn 1675: if (!$udom) {
1676: $udom=$env{'user.domain'};
1.1172.2.57 raeburn 1677: return if ($udom eq 'public');
1.860 raeburn 1678: if (defined(&domain($udom,'primary'))) {
1679: $uhome=&domain($udom,'primary');
1680: } else {
1.874 albertel 1681: undef($uhome);
1.860 raeburn 1682: }
1683: } else {
1684: if (!$uhome) {
1685: if (defined(&domain($udom,'primary'))) {
1686: $uhome=&domain($udom,'primary');
1687: }
1688: }
1689: }
1690: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1691: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 1692: my %returnhash;
1.875 albertel 1693: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1694: return %returnhash;
1695: }
1.806 raeburn 1696: my @pairs=split(/\&/,$rep);
1697: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1698: return @pairs;
1699: }
1700: my $i=0;
1701: foreach my $item (@$storearr) {
1702: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1703: $i++;
1704: }
1705: return %returnhash;
1706: } else {
1.880 banghart 1707: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1708: }
1709: }
1710:
1711: # -------------------------------------------- put items in domain db files
1712:
1713: sub put_dom {
1.860 raeburn 1714: my ($namespace,$storehash,$udom,$uhome)=@_;
1715: if (!$udom) {
1716: $udom=$env{'user.domain'};
1717: if (defined(&domain($udom,'primary'))) {
1718: $uhome=&domain($udom,'primary');
1719: } else {
1.874 albertel 1720: undef($uhome);
1.860 raeburn 1721: }
1722: } else {
1723: if (!$uhome) {
1724: if (defined(&domain($udom,'primary'))) {
1725: $uhome=&domain($udom,'primary');
1726: }
1727: }
1728: }
1729: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1730: my $items='';
1731: foreach my $item (keys(%$storehash)) {
1732: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1733: }
1734: $items=~s/\&$//;
1735: return &reply("putdom:$udom:$namespace:$items",$uhome);
1736: } else {
1.860 raeburn 1737: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1738: }
1739: }
1740:
1.1023 raeburn 1741: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 1742: sub newput_dom {
1.1023 raeburn 1743: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 1744: my $result;
1745: if (!$udom) {
1746: $udom=$env{'user.domain'};
1747: }
1.1023 raeburn 1748: if ($udom) {
1749: my $uname = &get_domainconfiguser($udom);
1750: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 1751: }
1752: return $result;
1753: }
1754:
1.1023 raeburn 1755: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 1756: sub del_dom {
1.1023 raeburn 1757: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 1758: if (ref($storearr) eq 'ARRAY') {
1759: if (!$udom) {
1760: $udom=$env{'user.domain'};
1761: }
1.1023 raeburn 1762: if ($udom) {
1763: my $uname = &get_domainconfiguser($udom);
1764: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 1765: }
1766: }
1767: }
1768:
1.1023 raeburn 1769: # ----------------------------------construct domainconfig user for a domain
1770: sub get_domainconfiguser {
1771: my ($udom) = @_;
1772: return $udom.'-domainconfig';
1773: }
1774:
1.837 raeburn 1775: sub retrieve_inst_usertypes {
1776: my ($udom) = @_;
1777: my (%returnhash,@order);
1.989 raeburn 1778: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1779: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1780: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1172.2.44 raeburn 1781: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 1782: } else {
1783: if (defined(&domain($udom,'primary'))) {
1784: my $uhome=&domain($udom,'primary');
1785: my $rep=&reply("inst_usertypes:$udom",$uhome);
1786: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1172.2.44 raeburn 1787: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 1788: return (\%returnhash,\@order);
1789: }
1790: my ($hashitems,$orderitems) = split(/:/,$rep);
1791: my @pairs=split(/\&/,$hashitems);
1792: foreach my $item (@pairs) {
1793: my ($key,$value)=split(/=/,$item,2);
1794: $key = &unescape($key);
1795: next if ($key =~ /^error: 2 /);
1796: $returnhash{$key}=&thaw_unescape($value);
1797: }
1798: my @esc_order = split(/\&/,$orderitems);
1799: foreach my $item (@esc_order) {
1800: push(@order,&unescape($item));
1801: }
1802: } else {
1.1172.2.44 raeburn 1803: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 1804: }
1.1172.2.44 raeburn 1805: return (\%returnhash,\@order);
1.837 raeburn 1806: }
1807: }
1808:
1.868 raeburn 1809: sub is_domainimage {
1810: my ($url) = @_;
1.1172.2.74 raeburn 1811: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+[^/]-) {
1.868 raeburn 1812: if (&domain($1) ne '') {
1813: return '1';
1814: }
1815: }
1816: return;
1817: }
1818:
1.899 raeburn 1819: sub inst_directory_query {
1820: my ($srch) = @_;
1821: my $udom = $srch->{'srchdomain'};
1822: my %results;
1823: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1824: my $outcome;
1.899 raeburn 1825: if ($homeserver ne '') {
1.904 albertel 1826: my $queryid=&reply("querysend:instdirsearch:".
1827: &escape($srch->{'srchby'}).':'.
1828: &escape($srch->{'srchterm'}).':'.
1829: &escape($srch->{'srchtype'}),$homeserver);
1830: my $host=&hostname($homeserver);
1831: if ($queryid !~/^\Q$host\E\_/) {
1832: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1833: return;
1834: }
1835: my $response = &get_query_reply($queryid);
1836: my $maxtries = 5;
1837: my $tries = 1;
1838: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1839: $response = &get_query_reply($queryid);
1840: $tries ++;
1841: }
1842:
1843: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1844: if ($response eq 'unavailable') {
1845: $outcome = $response;
1846: } else {
1847: $outcome = 'ok';
1848: my @matches = split(/\n/,$response);
1849: foreach my $match (@matches) {
1850: my ($key,$value) = split(/=/,$match);
1851: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1852: }
1.899 raeburn 1853: }
1854: }
1855: }
1.909 raeburn 1856: return ($outcome,%results);
1.899 raeburn 1857: }
1858:
1859: sub usersearch {
1860: my ($srch) = @_;
1861: my $dom = $srch->{'srchdomain'};
1862: my %results;
1863: my %libserv = &all_library();
1864: my $query = 'usersearch';
1865: foreach my $tryserver (keys(%libserv)) {
1866: if (&host_domain($tryserver) eq $dom) {
1867: my $host=&hostname($tryserver);
1868: my $queryid=
1.911 raeburn 1869: &reply("querysend:".&escape($query).':'.
1870: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1871: &escape($srch->{'srchtype'}).':'.
1872: &escape($srch->{'srchterm'}),$tryserver);
1873: if ($queryid !~/^\Q$host\E\_/) {
1874: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1875: next;
1.899 raeburn 1876: }
1877: my $reply = &get_query_reply($queryid);
1878: my $maxtries = 1;
1879: my $tries = 1;
1880: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1881: $reply = &get_query_reply($queryid);
1882: $tries ++;
1883: }
1884: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1885: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1886: } else {
1.911 raeburn 1887: my @matches;
1888: if ($reply =~ /\n/) {
1889: @matches = split(/\n/,$reply);
1890: } else {
1891: @matches = split(/\&/,$reply);
1892: }
1.899 raeburn 1893: foreach my $match (@matches) {
1894: my ($uname,$udom,%userhash);
1.911 raeburn 1895: foreach my $entry (split(/:/,$match)) {
1896: my ($key,$value) =
1897: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1898: $userhash{$key} = $value;
1899: if ($key eq 'username') {
1900: $uname = $value;
1901: } elsif ($key eq 'domain') {
1902: $udom = $value;
1.911 raeburn 1903: }
1.899 raeburn 1904: }
1905: $results{$uname.':'.$udom} = \%userhash;
1906: }
1907: }
1908: }
1909: }
1910: return %results;
1911: }
1912:
1.912 raeburn 1913: sub get_instuser {
1914: my ($udom,$uname,$id) = @_;
1915: my $homeserver = &domain($udom,'primary');
1916: my ($outcome,%results);
1917: if ($homeserver ne '') {
1918: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1919: &escape($id).':'.&escape($udom),$homeserver);
1920: my $host=&hostname($homeserver);
1921: if ($queryid !~/^\Q$host\E\_/) {
1922: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1923: return;
1924: }
1925: my $response = &get_query_reply($queryid);
1926: my $maxtries = 5;
1927: my $tries = 1;
1928: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1929: $response = &get_query_reply($queryid);
1930: $tries ++;
1931: }
1932: if (!&error($response) && $response ne 'refused') {
1933: if ($response eq 'unavailable') {
1934: $outcome = $response;
1935: } else {
1936: $outcome = 'ok';
1937: my @matches = split(/\n/,$response);
1938: foreach my $match (@matches) {
1939: my ($key,$value) = split(/=/,$match);
1940: $results{&unescape($key)} = &thaw_unescape($value);
1941: }
1942: }
1943: }
1944: }
1945: my %userinfo;
1946: if (ref($results{$uname}) eq 'HASH') {
1947: %userinfo = %{$results{$uname}};
1948: }
1949: return ($outcome,%userinfo);
1950: }
1951:
1.1172.2.69 raeburn 1952: sub get_multiple_instusers {
1953: my ($udom,$users,$caller) = @_;
1954: my ($outcome,$results);
1955: if (ref($users) eq 'HASH') {
1956: my $count = keys(%{$users});
1957: my $requested = &freeze_escape($users);
1958: my $homeserver = &domain($udom,'primary');
1959: if ($homeserver ne '') {
1960: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
1961: my $host=&hostname($homeserver);
1962: if ($queryid !~/^\Q$host\E\_/) {
1963: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
1964: ' for host: '.$homeserver.'in domain '.$udom);
1965: return ($outcome,$results);
1966: }
1967: my $response = &get_query_reply($queryid);
1968: my $maxtries = 5;
1969: if ($count > 100) {
1970: $maxtries = 1+int($count/20);
1971: }
1972: my $tries = 1;
1973: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
1974: $response = &get_query_reply($queryid);
1975: $tries ++;
1976: }
1977: if ($response eq '') {
1978: $results = {};
1979: foreach my $key (keys(%{$users})) {
1980: my ($uname,$id);
1981: if ($caller eq 'id') {
1982: $id = $key;
1983: } else {
1984: $uname = $key;
1985: }
1986: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1987: $outcome = $resp;
1988: if ($resp eq 'ok') {
1989: %{$results} = (%{$results}, %info);
1990: } else {
1991: last;
1992: }
1993: }
1994: } elsif(!&error($response) && ($response ne 'refused')) {
1995: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
1996: $outcome = $response;
1997: } else {
1998: ($outcome,my $userdata) = split(/=/,$response,2);
1999: if ($outcome eq 'ok') {
2000: $results = &thaw_unescape($userdata);
2001: }
2002: }
2003: }
2004: }
2005: }
2006: return ($outcome,$results);
2007: }
2008:
1.912 raeburn 2009: sub inst_rulecheck {
1.923 raeburn 2010: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 2011: my %returnhash;
2012: if ($udom ne '') {
2013: if (ref($rules) eq 'ARRAY') {
2014: @{$rules} = map {&escape($_);} (@{$rules});
2015: my $rulestr = join(':',@{$rules});
2016: my $homeserver=&domain($udom,'primary');
2017: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2018: my $response;
2019: if ($item eq 'username') {
2020: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2021: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2022: $homeserver));
1.923 raeburn 2023: } elsif ($item eq 'id') {
2024: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2025: ':'.&escape($id).':'.$rulestr,
2026: $homeserver));
1.945 raeburn 2027: } elsif ($item eq 'selfcreate') {
2028: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2029: &escape($udom).':'.&escape($uname).
2030: ':'.$rulestr,$homeserver));
1.923 raeburn 2031: }
1.912 raeburn 2032: if ($response ne 'refused') {
2033: my @pairs=split(/\&/,$response);
2034: foreach my $item (@pairs) {
2035: my ($key,$value)=split(/=/,$item,2);
2036: $key = &unescape($key);
2037: next if ($key =~ /^error: 2 /);
2038: $returnhash{$key}=&thaw_unescape($value);
2039: }
2040: }
2041: }
2042: }
2043: }
2044: return %returnhash;
2045: }
2046:
2047: sub inst_userrules {
1.923 raeburn 2048: my ($udom,$check) = @_;
1.912 raeburn 2049: my (%ruleshash,@ruleorder);
2050: if ($udom ne '') {
2051: my $homeserver=&domain($udom,'primary');
2052: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2053: my $response;
2054: if ($check eq 'id') {
2055: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2056: $homeserver);
1.943 raeburn 2057: } elsif ($check eq 'email') {
2058: $response=&reply('instemailrules:'.&escape($udom),
2059: $homeserver);
1.923 raeburn 2060: } else {
2061: $response=&reply('instuserrules:'.&escape($udom),
2062: $homeserver);
2063: }
1.912 raeburn 2064: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2065: ($response ne 'unknown_cmd') &&
1.912 raeburn 2066: ($response ne 'no_such_host')) {
2067: my ($hashitems,$orderitems) = split(/:/,$response);
2068: my @pairs=split(/\&/,$hashitems);
2069: foreach my $item (@pairs) {
2070: my ($key,$value)=split(/=/,$item,2);
2071: $key = &unescape($key);
2072: next if ($key =~ /^error: 2 /);
2073: $ruleshash{$key}=&thaw_unescape($value);
2074: }
2075: my @esc_order = split(/\&/,$orderitems);
2076: foreach my $item (@esc_order) {
2077: push(@ruleorder,&unescape($item));
2078: }
2079: }
2080: }
2081: }
2082: return (\%ruleshash,\@ruleorder);
2083: }
2084:
1.976 raeburn 2085: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2086:
2087: sub get_domain_defaults {
1.1172.2.35 raeburn 2088: my ($domain,$ignore_cache) = @_;
2089: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2090: my $cachetime = 60*60*24;
1.1172.2.35 raeburn 2091: unless ($ignore_cache) {
2092: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2093: if (defined($cached)) {
2094: if (ref($result) eq 'HASH') {
2095: return %{$result};
2096: }
1.943 raeburn 2097: }
2098: }
2099: my %domdefaults;
2100: my %domconfig =
1.989 raeburn 2101: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2102: 'requestcourses','inststatus',
1.1172.2.9 raeburn 2103: 'coursedefaults','usersessions',
1.1172.2.46 raeburn 2104: 'requestauthor','selfenrollment',
1.1172.2.89 raeburn 2105: 'coursecategories','autoenroll',
2106: 'helpsettings'],$domain);
1.1172.2.41 raeburn 2107: my @coursetypes = ('official','unofficial','community','textbook');
1.943 raeburn 2108: if (ref($domconfig{'defaults'}) eq 'HASH') {
2109: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2110: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2111: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2112: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2113: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2114: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.943 raeburn 2115: } else {
2116: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2117: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2118: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2119: }
1.976 raeburn 2120: if (ref($domconfig{'quotas'}) eq 'HASH') {
2121: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2122: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2123: } else {
2124: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1172.2.29 raeburn 2125: }
1.1172.2.6 raeburn 2126: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2127: foreach my $item (@usertools) {
2128: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2129: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2130: }
2131: }
1.1172.2.29 raeburn 2132: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2133: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2134: }
1.976 raeburn 2135: }
1.985 raeburn 2136: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1172.2.37 raeburn 2137: foreach my $item ('official','unofficial','community','textbook') {
1.985 raeburn 2138: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2139: }
2140: }
1.1172.2.9 raeburn 2141: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2142: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2143: }
1.989 raeburn 2144: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1172.2.44 raeburn 2145: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2146: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2147: }
2148: }
1.1047 raeburn 2149: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1172.2.60 raeburn 2150: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2151: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2152: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2153: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2154: }
1.1172.2.41 raeburn 2155: foreach my $type (@coursetypes) {
2156: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2157: unless ($type eq 'community') {
2158: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2159: }
2160: }
2161: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2162: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2163: }
1.1172.2.60 raeburn 2164: if ($domdefaults{'postsubmit'} eq 'on') {
2165: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2166: $domdefaults{$type.'postsubtimeout'} =
2167: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2168: }
2169: }
1.1172.2.30 raeburn 2170: }
1.1172.2.67 raeburn 2171: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2172: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2173: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2174: if (@clonecodes) {
2175: $domdefaults{'canclone'} = join('+',@clonecodes);
2176: }
2177: }
2178: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2179: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2180: }
1.1047 raeburn 2181: }
1.1073 raeburn 2182: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2183: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2184: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2185: }
2186: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2187: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2188: }
1.1172.2.62 raeburn 2189: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2190: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2191: }
1.1073 raeburn 2192: }
1.1172.2.41 raeburn 2193: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2194: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2195: my @settings = ('types','registered','enroll_dates','access_dates','section',
2196: 'approval','limit');
2197: foreach my $type (@coursetypes) {
2198: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2199: my @mgrdc = ();
2200: foreach my $item (@settings) {
2201: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2202: push(@mgrdc,$item);
2203: }
2204: }
2205: if (@mgrdc) {
2206: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2207: }
2208: }
2209: }
2210: }
2211: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2212: foreach my $type (@coursetypes) {
2213: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2214: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2215: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2216: }
2217: }
2218: }
2219: }
2220: }
1.1172.2.46 raeburn 2221: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2222: $domdefaults{'catauth'} = 'std';
2223: $domdefaults{'catunauth'} = 'std';
2224: if ($domconfig{'coursecategories'}{'auth'}) {
2225: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2226: }
2227: if ($domconfig{'coursecategories'}{'unauth'}) {
2228: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2229: }
2230: }
1.1172.2.76 raeburn 2231: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2232: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2233: }
1.1172.2.89 raeburn 2234: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2235: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2236: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2237: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2238: }
2239: }
1.1172.2.23 raeburn 2240: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2241: return %domdefaults;
2242: }
2243:
1.344 www 2244: # --------------------------------------------------- Assign a key to a student
2245:
2246: sub assign_access_key {
1.364 www 2247: #
2248: # a valid key looks like uname:udom#comments
2249: # comments are being appended
2250: #
1.498 www 2251: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2252: $kdom=
1.620 albertel 2253: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2254: $knum=
1.620 albertel 2255: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2256: $cdom=
1.620 albertel 2257: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2258: $cnum=
1.620 albertel 2259: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2260: $udom=$env{'user.name'} unless (defined($udom));
2261: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2262: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2263: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2264: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2265: # assigned to this person
2266: # - this should not happen,
1.345 www 2267: # unless something went wrong
2268: # the first time around
2269: # ready to assign
1.364 www 2270: $logentry=$1.'; '.$logentry;
1.496 www 2271: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2272: $kdom,$knum) eq 'ok') {
1.345 www 2273: # key now belongs to user
1.346 www 2274: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2275: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2276: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2277: return 'ok';
2278: } else {
2279: return
2280: 'error: Count not permanently assign key, will need to be re-entered later.';
2281: }
2282: } else {
2283: return 'error: Could not assign key, try again later.';
2284: }
1.364 www 2285: } elsif (!$existing{$ckey}) {
1.345 www 2286: # the key does not exist
2287: return 'error: The key does not exist';
2288: } else {
2289: # the key is somebody else's
2290: return 'error: The key is already in use';
2291: }
1.344 www 2292: }
2293:
1.364 www 2294: # ------------------------------------------ put an additional comment on a key
2295:
2296: sub comment_access_key {
2297: #
2298: # a valid key looks like uname:udom#comments
2299: # comments are being appended
2300: #
2301: my ($ckey,$cdom,$cnum,$logentry)=@_;
2302: $cdom=
1.620 albertel 2303: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2304: $cnum=
1.620 albertel 2305: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2306: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2307: if ($existing{$ckey}) {
2308: $existing{$ckey}.='; '.$logentry;
2309: # ready to assign
1.367 www 2310: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2311: $cdom,$cnum) eq 'ok') {
2312: return 'ok';
2313: } else {
2314: return 'error: Count not store comment.';
2315: }
2316: } else {
2317: # the key does not exist
2318: return 'error: The key does not exist';
2319: }
2320: }
2321:
1.344 www 2322: # ------------------------------------------------------ Generate a set of keys
2323:
2324: sub generate_access_keys {
1.364 www 2325: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2326: $cdom=
1.620 albertel 2327: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2328: $cnum=
1.620 albertel 2329: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2330: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2331: unless (($cdom) && ($cnum)) { return 0; }
2332: if ($number>10000) { return 0; }
2333: sleep(2); # make sure don't get same seed twice
2334: srand(time()^($$+($$<<15))); # from "Programming Perl"
2335: my $total=0;
2336: for (my $i=1;$i<=$number;$i++) {
2337: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2338: sprintf("%lx",int(100000*rand)).'-'.
2339: sprintf("%lx",int(100000*rand));
2340: $newkey=~s/1/g/g; # folks mix up 1 and l
2341: $newkey=~s/0/h/g; # and also 0 and O
2342: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2343: if ($existing{$newkey}) {
2344: $i--;
2345: } else {
1.364 www 2346: if (&put('accesskeys',
2347: { $newkey => '# generated '.localtime().
1.620 albertel 2348: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 2349: '; '.$logentry },
2350: $cdom,$cnum) eq 'ok') {
1.344 www 2351: $total++;
2352: }
2353: }
2354: }
1.620 albertel 2355: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 2356: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2357: return $total;
2358: }
2359:
2360: # ------------------------------------------------------- Validate an accesskey
2361:
2362: sub validate_access_key {
2363: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2364: $cdom=
1.620 albertel 2365: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2366: $cnum=
1.620 albertel 2367: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2368: $udom=$env{'user.domain'} unless (defined($udom));
2369: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 2370: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 2371: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 2372: }
2373:
2374: # ------------------------------------- Find the section of student in a course
1.652 albertel 2375: sub devalidate_getsection_cache {
2376: my ($udom,$unam,$courseid)=@_;
2377: my $hashid="$udom:$unam:$courseid";
2378: &devalidate_cache_new('getsection',$hashid);
2379: }
1.298 matthew 2380:
1.815 albertel 2381: sub courseid_to_courseurl {
2382: my ($courseid) = @_;
2383: #already url style courseid
2384: return $courseid if ($courseid =~ m{^/});
2385:
2386: if (exists($env{'course.'.$courseid.'.num'})) {
2387: my $cnum = $env{'course.'.$courseid.'.num'};
2388: my $cdom = $env{'course.'.$courseid.'.domain'};
2389: return "/$cdom/$cnum";
2390: }
2391:
2392: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2393: if (exists($courseinfo{'num'})) {
2394: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2395: }
2396:
2397: return undef;
2398: }
2399:
1.298 matthew 2400: sub getsection {
2401: my ($udom,$unam,$courseid)=@_;
1.599 albertel 2402: my $cachetime=1800;
1.551 albertel 2403:
2404: my $hashid="$udom:$unam:$courseid";
1.599 albertel 2405: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 2406: if (defined($cached)) { return $result; }
2407:
1.298 matthew 2408: my %Pending;
2409: my %Expired;
2410: #
2411: # Each role can either have not started yet (pending), be active,
2412: # or have expired.
2413: #
2414: # If there is an active role, we are done.
2415: #
2416: # If there is more than one role which has not started yet,
2417: # choose the one which will start sooner
2418: # If there is one role which has not started yet, return it.
2419: #
2420: # If there is more than one expired role, choose the one which ended last.
2421: # If there is a role which has expired, return it.
2422: #
1.815 albertel 2423: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 2424: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 2425: foreach my $key (keys(%roleshash)) {
1.479 albertel 2426: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 2427: my $section=$1;
2428: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 2429: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 2430: my $now=time;
1.548 albertel 2431: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 2432: $Expired{$end}=$section;
2433: next;
2434: }
1.548 albertel 2435: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 2436: $Pending{$start}=$section;
2437: next;
2438: }
1.599 albertel 2439: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 2440: }
2441: #
2442: # Presumedly there will be few matching roles from the above
2443: # loop and the sorting time will be negligible.
2444: if (scalar(keys(%Pending))) {
2445: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 2446: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 2447: }
2448: if (scalar(keys(%Expired))) {
2449: my @sorted = sort {$a <=> $b} keys(%Expired);
2450: my $time = pop(@sorted);
1.599 albertel 2451: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 2452: }
1.599 albertel 2453: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 2454: }
1.70 www 2455:
1.599 albertel 2456: sub save_cache {
2457: &purge_remembered();
1.722 albertel 2458: #&Apache::loncommon::validate_page();
1.620 albertel 2459: undef(%env);
1.780 albertel 2460: undef($env_loaded);
1.599 albertel 2461: }
1.452 albertel 2462:
1.599 albertel 2463: my $to_remember=-1;
2464: my %remembered;
2465: my %accessed;
2466: my $kicks=0;
2467: my $hits=0;
1.849 albertel 2468: sub make_key {
2469: my ($name,$id) = @_;
1.872 albertel 2470: if (length($id) > 65
2471: && length(&escape($id)) > 200) {
2472: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2473: }
1.849 albertel 2474: return &escape($name.':'.$id);
2475: }
2476:
1.599 albertel 2477: sub devalidate_cache_new {
2478: my ($name,$id,$debug) = @_;
2479: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1172.2.81 raeburn 2480: my $remembered_id=$name.':'.$id;
1.849 albertel 2481: $id=&make_key($name,$id);
1.599 albertel 2482: $memcache->delete($id);
1.1172.2.81 raeburn 2483: delete($remembered{$remembered_id});
2484: delete($accessed{$remembered_id});
1.599 albertel 2485: }
2486:
2487: sub is_cached_new {
2488: my ($name,$id,$debug) = @_;
1.1172.2.81 raeburn 2489: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) for
2490: # keys in %remembered hash, which persists for
2491: # duration of request (no restriction on key length).
2492: if (exists($remembered{$remembered_id})) {
2493: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
2494: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2495: $hits++;
1.1172.2.81 raeburn 2496: return ($remembered{$remembered_id},1);
1.599 albertel 2497: }
1.1172.2.81 raeburn 2498: $id=&make_key($name,$id);
1.599 albertel 2499: my $value = $memcache->get($id);
2500: if (!(defined($value))) {
2501: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 2502: return (undef,undef);
1.416 albertel 2503: }
1.599 albertel 2504: if ($value eq '__undef__') {
2505: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2506: $value=undef;
2507: }
1.1172.2.81 raeburn 2508: &make_room($remembered_id,$value,$debug);
1.599 albertel 2509: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2510: return ($value,1);
2511: }
2512:
2513: sub do_cache_new {
2514: my ($name,$id,$value,$time,$debug) = @_;
1.1172.2.81 raeburn 2515: my $remembered_id=$name.':'.$id;
1.849 albertel 2516: $id=&make_key($name,$id);
1.599 albertel 2517: my $setvalue=$value;
2518: if (!defined($setvalue)) {
2519: $setvalue='__undef__';
2520: }
1.623 albertel 2521: if (!defined($time) ) {
2522: $time=600;
2523: }
1.599 albertel 2524: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 2525: my $result = $memcache->set($id,$setvalue,$time);
2526: if (! $result) {
1.872 albertel 2527: &logthis("caching of id -> $id failed");
1.910 albertel 2528: $memcache->disconnect_all();
1.872 albertel 2529: }
1.600 albertel 2530: # need to make a copy of $value
1.1172.2.81 raeburn 2531: &make_room($remembered_id,$value,$debug);
1.599 albertel 2532: return $value;
2533: }
2534:
2535: sub make_room {
1.1172.2.81 raeburn 2536: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 2537:
1.1172.2.81 raeburn 2538: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 2539: : $value;
1.599 albertel 2540: if ($to_remember<0) { return; }
1.1172.2.81 raeburn 2541: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2542: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2543: my $to_kick;
2544: my $max_time=0;
2545: foreach my $other (keys(%accessed)) {
2546: if (&tv_interval($accessed{$other}) > $max_time) {
2547: $to_kick=$other;
2548: $max_time=&tv_interval($accessed{$other});
2549: }
2550: }
2551: delete($remembered{$to_kick});
2552: delete($accessed{$to_kick});
2553: $kicks++;
2554: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 2555: return;
2556: }
2557:
1.599 albertel 2558: sub purge_remembered {
1.604 albertel 2559: #&logthis("Tossing ".scalar(keys(%remembered)));
2560: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 2561: undef(%remembered);
2562: undef(%accessed);
1.428 albertel 2563: }
1.70 www 2564: # ------------------------------------- Read an entry from a user's environment
2565:
2566: sub userenvironment {
2567: my ($udom,$unam,@what)=@_;
1.976 raeburn 2568: my $items;
2569: foreach my $item (@what) {
2570: $items.=&escape($item).'&';
2571: }
2572: $items=~s/\&$//;
1.70 www 2573: my %returnhash=();
1.1009 raeburn 2574: my $uhome = &homeserver($unam,$udom);
2575: unless ($uhome eq 'no_host') {
2576: my @answer=split(/\&/,
2577: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 2578: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2579: return %returnhash;
2580: }
1.1009 raeburn 2581: my $i;
2582: for ($i=0;$i<=$#what;$i++) {
2583: $returnhash{$what[$i]}=&unescape($answer[$i]);
2584: }
1.70 www 2585: }
2586: return %returnhash;
1.1 albertel 2587: }
2588:
1.617 albertel 2589: # ---------------------------------------------------------- Get a studentphoto
2590: sub studentphoto {
2591: my ($udom,$unam,$ext) = @_;
2592: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 2593: if (defined($env{'request.course.id'})) {
1.708 raeburn 2594: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 2595: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2596: return(&retrievestudentphoto($udom,$unam,$ext));
2597: } else {
2598: my ($result,$perm_reqd)=
1.707 albertel 2599: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2600: if ($result eq 'ok') {
2601: if (!($perm_reqd eq 'yes')) {
2602: return(&retrievestudentphoto($udom,$unam,$ext));
2603: }
2604: }
2605: }
2606: }
2607: } else {
2608: my ($result,$perm_reqd) =
1.707 albertel 2609: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2610: if ($result eq 'ok') {
2611: if (!($perm_reqd eq 'yes')) {
2612: return(&retrievestudentphoto($udom,$unam,$ext));
2613: }
2614: }
2615: }
2616: return '/adm/lonKaputt/lonlogo_broken.gif';
2617: }
2618:
2619: sub retrievestudentphoto {
2620: my ($udom,$unam,$ext,$type) = @_;
2621: my $home=&Apache::lonnet::homeserver($unam,$udom);
2622: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2623: if ($ret eq 'ok') {
2624: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2625: if ($type eq 'thumbnail') {
2626: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2627: }
2628: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2629: return $tokenurl;
2630: } else {
2631: if ($type eq 'thumbnail') {
2632: return '/adm/lonKaputt/genericstudent_tn.gif';
2633: } else {
2634: return '/adm/lonKaputt/lonlogo_broken.gif';
2635: }
1.617 albertel 2636: }
2637: }
2638:
1.263 www 2639: # -------------------------------------------------------------------- New chat
2640:
2641: sub chatsend {
1.724 raeburn 2642: my ($newentry,$anon,$group)=@_;
1.620 albertel 2643: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2644: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2645: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 2646: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 2647: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 2648: &escape($newentry)).':'.$group,$chome);
1.292 www 2649: }
2650:
2651: # ------------------------------------------ Find current version of a resource
2652:
2653: sub getversion {
2654: my $fname=&clutter(shift);
1.1172.2.10 raeburn 2655: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 2656: return ¤tversion(&filelocation('',$fname));
2657: }
2658:
2659: sub currentversion {
2660: my $fname=shift;
2661: my $author=$fname;
2662: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2663: my ($udom,$uname)=split(/\//,$author);
1.1112 www 2664: my $home=&homeserver($uname,$udom);
1.292 www 2665: if ($home eq 'no_host') {
2666: return -1;
2667: }
1.1112 www 2668: my $answer=&reply("currentversion:$fname",$home);
1.292 www 2669: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2670: return -1;
2671: }
1.1112 www 2672: return $answer;
1.263 www 2673: }
2674:
1.1111 www 2675: #
2676: # Return special version number of resource if set by override, empty otherwise
2677: #
2678: sub usedversion {
2679: my $fname=shift;
2680: unless ($fname) { $fname=$env{'request.uri'}; }
2681: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2682: if ($urlversion) { return $urlversion; }
2683: return '';
2684: }
2685:
1.1 albertel 2686: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 2687:
1.1 albertel 2688: sub subscribe {
2689: my $fname=shift;
1.761 raeburn 2690: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 2691: $fname=~s/[\n\r]//g;
1.1 albertel 2692: my $author=$fname;
2693: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2694: my ($udom,$uname)=split(/\//,$author);
2695: my $home=homeserver($uname,$udom);
1.335 albertel 2696: if ($home eq 'no_host') {
2697: return 'not_found';
1.1 albertel 2698: }
2699: my $answer=reply("sub:$fname",$home);
1.64 www 2700: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2701: $answer.=' by '.$home;
2702: }
1.1 albertel 2703: return $answer;
2704: }
2705:
1.8 www 2706: # -------------------------------------------------------------- Replicate file
2707:
2708: sub repcopy {
2709: my $filename=shift;
1.23 www 2710: $filename=~s/\/+/\//g;
1.1142 raeburn 2711: my $londocroot = $perlvar{'lonDocRoot'};
2712: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 2713: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 2714: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2715: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 2716: return &repcopy_userfile($filename);
2717: }
1.532 albertel 2718: $filename=~s/[\n\r]//g;
1.8 www 2719: my $transname="$filename.in.transfer";
1.828 www 2720: # FIXME: this should flock
1.607 raeburn 2721: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 2722: my $remoteurl=subscribe($filename);
1.64 www 2723: if ($remoteurl =~ /^con_lost by/) {
2724: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2725: return 'unavailable';
1.8 www 2726: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 2727: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 2728: return 'not_found';
1.64 www 2729: } elsif ($remoteurl =~ /^rejected by/) {
2730: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2731: return 'forbidden';
1.20 www 2732: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 2733: return 'ok';
1.8 www 2734: } else {
1.290 www 2735: my $author=$filename;
2736: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2737: my ($udom,$uname)=split(/\//,$author);
2738: my $home=homeserver($uname,$udom);
2739: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 2740: my @parts=split(/\//,$filename);
2741: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 2742: if ($path ne "$londocroot/res") {
1.8 www 2743: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 2744: return 'bad_request';
1.8 www 2745: }
2746: my $count;
2747: for ($count=5;$count<$#parts;$count++) {
2748: $path.="/$parts[$count]";
2749: if ((-e $path)!=1) {
2750: mkdir($path,0777);
2751: }
2752: }
2753: my $ua=new LWP::UserAgent;
2754: my $request=new HTTP::Request('GET',"$remoteurl");
2755: my $response=$ua->request($request,$transname);
2756: if ($response->is_error()) {
2757: unlink($transname);
2758: my $message=$response->status_line;
1.672 albertel 2759: &logthis("<font color=\"blue\">WARNING:"
1.12 www 2760: ." LWP get: $message: $filename</font>");
1.607 raeburn 2761: return 'unavailable';
1.8 www 2762: } else {
1.16 www 2763: if ($remoteurl!~/\.meta$/) {
2764: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2765: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2766: if ($mresponse->is_error()) {
2767: unlink($filename.'.meta');
2768: &logthis(
1.672 albertel 2769: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 2770: }
2771: }
1.8 www 2772: rename($transname,$filename);
1.607 raeburn 2773: return 'ok';
1.8 www 2774: }
1.290 www 2775: }
1.8 www 2776: }
1.330 www 2777: }
2778:
2779: # ------------------------------------------------ Get server side include body
2780: sub ssi_body {
1.381 albertel 2781: my ($filelink,%form)=@_;
1.606 matthew 2782: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2783: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2784: }
1.953 www 2785: my $output='';
2786: my $response;
1.980 raeburn 2787: if ($filelink=~/^https?\:/) {
1.954 raeburn 2788: ($output,$response)=&externalssi($filelink);
1.953 www 2789: } else {
1.1004 droeschl 2790: $filelink .= $filelink=~/\?/ ? '&' : '?';
2791: $filelink .= 'inhibitmenu=yes';
1.953 www 2792: ($output,$response)=&ssi($filelink,%form);
2793: }
1.778 albertel 2794: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 2795: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 2796: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 2797: if (wantarray) {
2798: return ($output, $response);
2799: } else {
2800: return $output;
2801: }
1.8 www 2802: }
2803:
1.15 www 2804: # --------------------------------------------------------- Server Side Include
2805:
1.782 albertel 2806: sub absolute_url {
2807: my ($host_name) = @_;
2808: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2809: if ($host_name eq '') {
2810: $host_name = $ENV{'SERVER_NAME'};
2811: }
2812: return $protocol.$host_name;
2813: }
2814:
1.942 foxr 2815: #
2816: # Server side include.
2817: # Parameters:
2818: # fn Possibly encrypted resource name/id.
2819: # form Hash that describes how the rendering should be done
2820: # and other things.
1.944 foxr 2821: # Returns:
1.950 raeburn 2822: # Scalar context: The content of the response.
2823: # Array context: 2 element list of the content and the full response object.
1.942 foxr 2824: #
1.15 www 2825: sub ssi {
2826:
1.944 foxr 2827: my ($fn,%form)=@_;
1.15 www 2828: my $ua=new LWP::UserAgent;
1.23 www 2829: my $request;
1.711 albertel 2830:
2831: $form{'no_update_last_known'}=1;
1.895 albertel 2832: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 2833: if (%form) {
1.782 albertel 2834: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1172.2.58 raeburn 2835: $request->content(join('&',map {
2836: my $name = escape($_);
2837: "$name=" . ( ref($form{$_}) eq 'ARRAY'
2838: ? join("&$name=", map {escape($_) } @{$form{$_}})
2839: : &escape($form{$_}) );
2840: } keys(%form)));
1.23 www 2841: } else {
1.782 albertel 2842: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 2843: }
2844:
1.15 www 2845: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1172.2.2 raeburn 2846: my $response= $ua->request($request);
1.944 foxr 2847: if (wantarray) {
1.1172.2.3 raeburn 2848: return ($response->content, $response);
1.944 foxr 2849: } else {
1.1172.2.3 raeburn 2850: return $response->content;
1.942 foxr 2851: }
1.324 www 2852: }
2853:
2854: sub externalssi {
2855: my ($url)=@_;
2856: my $ua=new LWP::UserAgent;
2857: my $request=new HTTP::Request('GET',$url);
2858: my $response=$ua->request($request);
1.954 raeburn 2859: if (wantarray) {
2860: return ($response->content, $response);
2861: } else {
2862: return $response->content;
2863: }
1.15 www 2864: }
1.254 www 2865:
1.492 albertel 2866: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2867:
2868: sub allowuploaded {
2869: my ($srcurl,$url)=@_;
2870: $url=&clutter(&declutter($url));
2871: my $dir=$url;
2872: $dir=~s/\/[^\/]+$//;
2873: my %httpref=();
2874: my $httpurl=&hreflocation('',$url);
2875: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2876: &Apache::lonnet::appenv(\%httpref);
1.254 www 2877: }
1.477 raeburn 2878:
1.1172.2.13 raeburn 2879: #
2880: # Determine if the current user should be able to edit a particular resource,
2881: # when viewing in course context.
2882: # (a) When viewing resource used to determine if "Edit" item is included in
2883: # Functions.
2884: # (b) When displaying folder contents in course editor, used to determine if
2885: # "Edit" link will be displayed alongside resource.
2886: #
2887: # input: six args -- filename (decluttered), course number, course domain,
2888: # url, symb (if registered) and group (if this is a group
2889: # item -- e.g., bulletin board, group page etc.).
2890: # output: array of five scalars --
2891: # $cfile -- url for file editing if editable on current server
2892: # $home -- homeserver of resource (i.e., for author if published,
2893: # or course if uploaded.).
2894: # $switchserver -- 1 if server switch will be needed.
2895: # $forceedit -- 1 if icon/link should be to go to edit mode
2896: # $forceview -- 1 if icon/link should be to go to view mode
2897: #
2898:
2899: sub can_edit_resource {
2900: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
2901: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
2902: #
2903: # For aboutme pages user can only edit his/her own.
2904: #
2905: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
2906: my ($sdom,$sname) = ($1,$2);
2907: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
2908: $home = $env{'user.home'};
2909: $cfile = $resurl;
2910: if ($env{'form.forceedit'}) {
2911: $forceview = 1;
2912: } else {
2913: $forceedit = 1;
2914: }
2915: return ($cfile,$home,$switchserver,$forceedit,$forceview);
2916: } else {
2917: return;
2918: }
2919: }
2920:
2921: if ($env{'request.course.id'}) {
2922: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
2923: if ($group ne '') {
2924: # if this is a group homepage or group bulletin board, check group privs
2925: my $allowed = 0;
2926: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
2927: if ((&allowed('mdg',$env{'request.course.id'}.
2928: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2929: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2930: $allowed = 1;
2931: }
2932: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
2933: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2934: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2935: $allowed = 1;
2936: }
2937: }
2938: if ($allowed) {
2939: $home=&homeserver($cnum,$cdom);
2940: if ($env{'form.forceedit'}) {
2941: $forceview = 1;
2942: } else {
2943: $forceedit = 1;
2944: }
2945: $cfile = $resurl;
2946: } else {
2947: return;
2948: }
2949: } else {
1.1172.2.15 raeburn 2950: if ($resurl =~ m{^/?adm/viewclasslist$}) {
2951: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
2952: return;
2953: }
2954: } elsif (!$crsedit) {
1.1172.2.13 raeburn 2955: #
2956: # No edit allowed where CC has switched to student role.
2957: #
2958: return;
2959: }
2960: }
2961: }
2962:
2963: if ($file ne '') {
2964: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
2965: if (&is_course_upload($file,$cnum,$cdom)) {
2966: $uploaded = 1;
2967: $incourse = 1;
2968: if ($file =~/\.(htm|html|css|js|txt)$/) {
2969: $cfile = &hreflocation('',$file);
2970: if ($env{'form.forceedit'}) {
2971: $forceview = 1;
2972: } else {
2973: $forceedit = 1;
2974: }
2975: }
2976: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
2977: $incourse = 1;
2978: if ($env{'form.forceedit'}) {
2979: $forceview = 1;
2980: } else {
2981: $forceedit = 1;
2982: }
2983: $cfile = $resurl;
2984: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
2985: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
2986: $incourse = 1;
2987: if ($env{'form.forceedit'}) {
2988: $forceview = 1;
2989: } else {
2990: $forceedit = 1;
2991: }
2992: $cfile = $resurl;
2993: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
2994: $incourse = 1;
2995: $cfile = $resurl.'/smpedit';
2996: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
2997: $incourse = 1;
2998: if ($env{'form.forceedit'}) {
2999: $forceview = 1;
3000: } else {
3001: $forceedit = 1;
3002: }
3003: $cfile = $resurl;
1.1172.2.15 raeburn 3004: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3005: $incourse = 1;
3006: if ($env{'form.forceedit'}) {
3007: $forceview = 1;
3008: } else {
3009: $forceedit = 1;
3010: }
3011: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1172.2.13 raeburn 3012: }
3013: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3014: my $template = '/res/lib/templates/simpleproblem.problem';
3015: if (&is_on_map($template)) {
3016: $incourse = 1;
3017: $forceview = 1;
3018: $cfile = $template;
3019: }
3020: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3021: $incourse = 1;
3022: if ($env{'form.forceedit'}) {
3023: $forceview = 1;
3024: } else {
3025: $forceedit = 1;
3026: }
3027: $cfile = $resurl;
3028: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3029: $incourse = 1;
3030: $forceview = 1;
3031: if ($symb) {
3032: my ($map,$id,$res)=&decode_symb($symb);
3033: $env{'request.symb'} = $symb;
3034: $cfile = &clutter($res);
3035: } else {
3036: $cfile = $env{'form.suppurl'};
3037: $cfile =~ s{^http://}{};
3038: $cfile = '/adm/wrapper/ext/'.$cfile;
3039: }
1.1172.2.31 raeburn 3040: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3041: if ($env{'form.forceedit'}) {
3042: $forceview = 1;
3043: } else {
3044: $forceedit = 1;
3045: }
3046: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1172.2.13 raeburn 3047: }
3048: }
3049: if ($uploaded || $incourse) {
3050: $home=&homeserver($cnum,$cdom);
1.1172.2.14 raeburn 3051: } elsif ($file !~ m{/$}) {
1.1172.2.13 raeburn 3052: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3053: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3054: # Check that the user has permission to edit this resource
3055: my $setpriv = 1;
3056: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3057: if (defined($cfudom)) {
3058: $home=&homeserver($cfuname,$cfudom);
3059: $cfile=$file;
3060: }
3061: }
3062: if (($cfile ne '') && (!$incourse || $uploaded) &&
3063: (($home ne '') && ($home ne 'no_host'))) {
3064: my @ids=¤t_machine_ids();
3065: unless (grep(/^\Q$home\E$/,@ids)) {
3066: $switchserver=1;
3067: }
3068: }
3069: }
3070: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3071: }
3072:
3073: sub is_course_upload {
3074: my ($file,$cnum,$cdom) = @_;
3075: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3076: $uploadpath =~ s{^\/}{};
3077: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3078: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
3079: return 1;
3080: }
3081: return;
3082: }
3083:
3084: sub in_course {
3085: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3086: if ($hideprivileged) {
3087: my $skipuser;
1.1172.2.23 raeburn 3088: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3089: my @possdoms = ($cdom);
3090: if ($coursehash{'checkforpriv'}) {
3091: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3092: }
3093: if (&privileged($uname,$udom,\@possdoms)) {
1.1172.2.13 raeburn 3094: $skipuser = 1;
3095: if ($coursehash{'nothideprivileged'}) {
3096: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3097: my $user;
3098: if ($item =~ /:/) {
3099: $user = $item;
3100: } else {
3101: $user = join(':',split(/[\@]/,$item));
3102: }
3103: if ($user eq $uname.':'.$udom) {
3104: undef($skipuser);
3105: last;
3106: }
3107: }
3108: }
3109: if ($skipuser) {
3110: return 0;
3111: }
3112: }
3113: }
3114: $type ||= 'any';
3115: if (!defined($cdom) || !defined($cnum)) {
3116: my $cid = $env{'request.course.id'};
3117: $cdom = $env{'course.'.$cid.'.domain'};
3118: $cnum = $env{'course.'.$cid.'.num'};
3119: }
3120: my $typesref;
3121: if (($type eq 'any') || ($type eq 'all')) {
3122: $typesref = ['active','previous','future'];
3123: } elsif ($type eq 'previous' || $type eq 'future') {
3124: $typesref = [$type];
3125: }
3126: my %roles = &get_my_roles($uname,$udom,'userroles',
3127: $typesref,undef,[$cdom]);
3128: my ($tmp) = keys(%roles);
3129: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3130: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3131: if (@course_roles > 0) {
3132: return 1;
3133: }
3134: return 0;
3135: }
3136:
1.478 albertel 3137: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 3138: # input: action, courseID, current domain, intended
1.637 raeburn 3139: # path to file, source of file, instruction to parse file for objects,
3140: # ref to hash for embedded objects,
3141: # ref to hash for codebase of java objects.
1.1095 raeburn 3142: # reference to scalar to accommodate mime type determined
3143: # from File::MMagic if $parser = parse.
1.637 raeburn 3144: #
1.485 raeburn 3145: # output: url to file (if action was uploaddoc),
3146: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 3147: #
1.478 albertel 3148: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3149: # course.
1.477 raeburn 3150: #
1.478 albertel 3151: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3152: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3153: # course's home server.
1.477 raeburn 3154: #
1.478 albertel 3155: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3156: # be copied from $source (current location) to
3157: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3158: # and will then be copied to
3159: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3160: # course's home server.
1.485 raeburn 3161: #
1.481 raeburn 3162: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 3163: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 3164: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3165: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3166: # in course's home server.
1.637 raeburn 3167: #
1.477 raeburn 3168:
3169: sub process_coursefile {
1.1095 raeburn 3170: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3171: $mimetype)=@_;
1.477 raeburn 3172: my $fetchresult;
1.638 albertel 3173: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 3174: if ($action eq 'propagate') {
1.638 albertel 3175: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3176: $home);
1.481 raeburn 3177: } else {
1.477 raeburn 3178: my $fpath = '';
3179: my $fname = $file;
1.478 albertel 3180: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 3181: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 3182: my $filepath = &build_filepath($fpath);
1.481 raeburn 3183: if ($action eq 'copy') {
3184: if ($source eq '') {
3185: $fetchresult = 'no source file';
3186: return $fetchresult;
3187: } else {
3188: my $destination = $filepath.'/'.$fname;
3189: rename($source,$destination);
3190: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3191: $home);
1.481 raeburn 3192: }
3193: } elsif ($action eq 'uploaddoc') {
3194: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 3195: print $fh $env{'form.'.$source};
1.481 raeburn 3196: close($fh);
1.637 raeburn 3197: if ($parser eq 'parse') {
1.1024 raeburn 3198: my $mm = new File::MMagic;
1.1095 raeburn 3199: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3200: if ($type eq 'text/html') {
1.1024 raeburn 3201: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3202: unless ($parse_result eq 'ok') {
3203: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3204: }
1.637 raeburn 3205: }
1.1095 raeburn 3206: if (ref($mimetype)) {
3207: $$mimetype = $type;
3208: }
1.637 raeburn 3209: }
1.477 raeburn 3210: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3211: $home);
1.481 raeburn 3212: if ($fetchresult eq 'ok') {
3213: return '/uploaded/'.$fpath.'/'.$fname;
3214: } else {
3215: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3216: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 3217: return '/adm/notfound.html';
3218: }
1.477 raeburn 3219: }
3220: }
1.485 raeburn 3221: unless ( $fetchresult eq 'ok') {
1.477 raeburn 3222: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3223: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 3224: }
3225: return $fetchresult;
3226: }
3227:
1.637 raeburn 3228: sub build_filepath {
3229: my ($fpath) = @_;
3230: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3231: unless ($fpath eq '') {
3232: my @parts=split('/',$fpath);
3233: foreach my $part (@parts) {
3234: $filepath.= '/'.$part;
3235: if ((-e $filepath)!=1) {
3236: mkdir($filepath,0777);
3237: }
3238: }
3239: }
3240: return $filepath;
3241: }
3242:
3243: sub store_edited_file {
1.638 albertel 3244: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 3245: my $file = $primary_url;
3246: $file =~ s#^/uploaded/$docudom/$docuname/##;
3247: my $fpath = '';
3248: my $fname = $file;
3249: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3250: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3251: my $filepath = &build_filepath($fpath);
3252: open(my $fh,'>'.$filepath.'/'.$fname);
3253: print $fh $content;
3254: close($fh);
1.638 albertel 3255: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 3256: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3257: $home);
1.637 raeburn 3258: if ($$fetchresult eq 'ok') {
3259: return '/uploaded/'.$fpath.'/'.$fname;
3260: } else {
1.638 albertel 3261: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3262: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 3263: return '/adm/notfound.html';
3264: }
3265: }
3266:
1.531 albertel 3267: sub clean_filename {
1.831 albertel 3268: my ($fname,$args)=@_;
1.315 www 3269: # Replace Windows backslashes by forward slashes
1.257 www 3270: $fname=~s/\\/\//g;
1.831 albertel 3271: if (!$args->{'keep_path'}) {
3272: # Get rid of everything but the actual filename
3273: $fname=~s/^.*\/([^\/]+)$/$1/;
3274: }
1.315 www 3275: # Replace spaces by underscores
3276: $fname=~s/\s+/\_/g;
3277: # Replace all other weird characters by nothing
1.831 albertel 3278: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 3279: # Replace all .\d. sequences with _\d. so they no longer look like version
3280: # numbers
3281: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 3282: return $fname;
3283: }
1.1051 raeburn 3284: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3285: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3286: # image with the same aspect ratio as the original, but with dimensions which do
3287: # not exceed $resizewidth and $resizeheight.
3288:
1.984 neumanie 3289: sub resizeImage {
1.1051 raeburn 3290: my ($img_path,$resizewidth,$resizeheight) = @_;
3291: my $ima = Image::Magick->new;
3292: my $resized;
3293: if (-e $img_path) {
3294: $ima->Read($img_path);
3295: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3296: my $width = $ima->Get('width');
3297: my $height = $ima->Get('height');
3298: if ($width > $resizewidth) {
3299: my $factor = $width/$resizewidth;
3300: my $newheight = $height/$factor;
3301: $ima->Scale(width=>$resizewidth,height=>$newheight);
3302: $resized = 1;
3303: }
3304: }
3305: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3306: my $width = $ima->Get('width');
3307: my $height = $ima->Get('height');
3308: if ($height > $resizeheight) {
3309: my $factor = $height/$resizeheight;
3310: my $newwidth = $width/$factor;
3311: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3312: $resized = 1;
3313: }
3314: }
3315: if ($resized) {
3316: $ima->Write($img_path);
3317: }
3318: }
3319: return;
1.977 amueller 3320: }
3321:
1.608 albertel 3322: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 3323: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 3324: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 3325: # $context - possible values: coursedoc, existingfile, overwrite,
3326: # canceloverwrite, or ''.
3327: # if 'coursedoc': upload to the current course
3328: # if 'existingfile': write file to tmp/overwrites directory
3329: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3330: # $context is passed as argument to &finishuserfileupload
1.686 albertel 3331: # $subdir - directory in userfile to store the file into
1.858 raeburn 3332: # $parser - instruction to parse file for objects ($parser = parse)
3333: # $allfiles - reference to hash for embedded objects
3334: # $codebase - reference to hash for codebase of java objects
3335: # $desuname - username for permanent storage of uploaded file
3336: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 3337: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3338: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 3339: # $resizewidth - width (pixels) to which to resize uploaded image
3340: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 3341: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 3342: # from File::MMagic.
1.858 raeburn 3343: #
1.686 albertel 3344: # output: url of file in userspace, or error: <message>
3345: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 3346:
1.531 albertel 3347: sub userfileupload {
1.1090 raeburn 3348: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 3349: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 3350: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 3351: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 3352: $fname=&clean_filename($fname);
1.1090 raeburn 3353: # See if there is anything left
1.257 www 3354: unless ($fname) { return 'error: no uploaded file'; }
1.1090 raeburn 3355: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3356: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3357: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3358: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 3359: my $now = time;
1.1090 raeburn 3360: my $filepath;
1.1095 raeburn 3361: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 3362: $filepath = 'tmp/helprequests/'.$now;
3363: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3364: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3365: '_'.$env{'user.domain'}.'/pending';
3366: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3367: my ($docuname,$docudom);
3368: if ($destudom) {
3369: $docudom = $destudom;
3370: } else {
3371: $docudom = $env{'user.domain'};
3372: }
3373: if ($destuname) {
3374: $docuname = $destuname;
3375: } else {
3376: $docuname = $env{'user.name'};
3377: }
3378: if (exists($env{'form.group'})) {
3379: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3380: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3381: }
3382: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3383: if ($context eq 'canceloverwrite') {
3384: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3385: if (-e $tempfile) {
3386: my @info = stat($tempfile);
3387: if ($info[9] eq $env{'form.timestamp'}) {
3388: unlink($tempfile);
3389: }
3390: }
3391: return;
1.523 raeburn 3392: }
3393: }
1.1090 raeburn 3394: # Create the directory if not present
1.741 raeburn 3395: my @parts=split(/\//,$filepath);
3396: my $fullpath = $perlvar{'lonDaemons'};
3397: for (my $i=0;$i<@parts;$i++) {
3398: $fullpath .= '/'.$parts[$i];
3399: if ((-e $fullpath)!=1) {
3400: mkdir($fullpath,0777);
3401: }
3402: }
3403: open(my $fh,'>'.$fullpath.'/'.$fname);
3404: print $fh $env{'form.'.$formname};
3405: close($fh);
1.1090 raeburn 3406: if ($context eq 'existingfile') {
3407: my @info = stat($fullpath.'/'.$fname);
3408: return ($fullpath.'/'.$fname,$info[9]);
3409: } else {
3410: return $fullpath.'/'.$fname;
3411: }
1.523 raeburn 3412: }
1.995 raeburn 3413: if ($subdir eq 'scantron') {
3414: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 3415: } else {
1.995 raeburn 3416: $fname="$subdir/$fname";
3417: }
1.1090 raeburn 3418: if ($context eq 'coursedoc') {
1.638 albertel 3419: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3420: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 3421: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 3422: return &finishuserfileupload($docuname,$docudom,
3423: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 3424: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 3425: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 3426: } else {
1.1172.2.21 raeburn 3427: if ($env{'form.folder'}) {
3428: $fname=$env{'form.folder'}.'/'.$fname;
3429: }
1.638 albertel 3430: return &process_coursefile('uploaddoc',$docuname,$docudom,
3431: $fname,$formname,$parser,
1.1095 raeburn 3432: $allfiles,$codebase,$mimetype);
1.481 raeburn 3433: }
1.719 banghart 3434: } elsif (defined($destuname)) {
3435: my $docuname=$destuname;
3436: my $docudom=$destudom;
1.860 raeburn 3437: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3438: $parser,$allfiles,$codebase,
1.1051 raeburn 3439: $thumbwidth,$thumbheight,
1.1095 raeburn 3440: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3441: } else {
1.638 albertel 3442: my $docuname=$env{'user.name'};
3443: my $docudom=$env{'user.domain'};
1.1172.2.23 raeburn 3444: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 3445: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3446: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3447: }
1.860 raeburn 3448: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3449: $parser,$allfiles,$codebase,
1.1051 raeburn 3450: $thumbwidth,$thumbheight,
1.1095 raeburn 3451: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3452: }
1.271 www 3453: }
3454:
3455: sub finishuserfileupload {
1.860 raeburn 3456: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 3457: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 3458: my $path=$docudom.'/'.$docuname.'/';
1.258 www 3459: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 3460:
1.860 raeburn 3461: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 3462: $file=$fname;
3463: if ($fname=~m|/|) {
3464: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3465: $path.=$fnamepath.'/';
3466: }
1.259 www 3467: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 3468: my $count;
3469: for ($count=4;$count<=$#parts;$count++) {
3470: $filepath.="/$parts[$count]";
3471: if ((-e $filepath)!=1) {
3472: mkdir($filepath,0777);
3473: }
3474: }
1.984 neumanie 3475:
1.258 www 3476: # Save the file
3477: {
1.701 albertel 3478: if (!open(FH,'>'.$filepath.'/'.$file)) {
3479: &logthis('Failed to create '.$filepath.'/'.$file);
3480: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3481: return '/adm/notfound.html';
3482: }
1.1090 raeburn 3483: if ($context eq 'overwrite') {
1.1117 foxr 3484: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 3485: my $target = $filepath.'/'.$file;
3486: if (-e $source) {
3487: my @info = stat($source);
3488: if ($info[9] eq $env{'form.timestamp'}) {
3489: unless (&File::Copy::move($source,$target)) {
3490: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3491: return "Moving from $source failed";
3492: }
3493: } else {
3494: return "Temporary file: $source had unexpected date/time for last modification";
3495: }
3496: } else {
3497: return "Temporary file: $source missing";
3498: }
3499: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 3500: &logthis('Failed to write to '.$filepath.'/'.$file);
3501: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3502: return '/adm/notfound.html';
3503: }
1.570 albertel 3504: close(FH);
1.1051 raeburn 3505: if ($resizewidth && $resizeheight) {
3506: my $mm = new File::MMagic;
3507: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3508: if ($mime_type =~ m{^image/}) {
3509: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3510: }
1.977 amueller 3511: }
1.258 www 3512: }
1.1152 raeburn 3513: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3514: if (ref($mimetype)) {
3515: if ($$mimetype eq '') {
3516: my $mm = new File::MMagic;
3517: my $type = $mm->checktype_filename($filepath.'/'.$file);
3518: $$mimetype = $type;
3519: }
3520: }
3521: }
1.637 raeburn 3522: if ($parser eq 'parse') {
1.1152 raeburn 3523: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 3524: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3525: $allfiles,$codebase);
3526: unless ($parse_result eq 'ok') {
3527: &logthis('Failed to parse '.$filepath.$file.
3528: ' for embedded media: '.$parse_result);
3529: }
1.637 raeburn 3530: }
3531: }
1.860 raeburn 3532: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3533: my $input = $filepath.'/'.$file;
3534: my $output = $filepath.'/'.'tn-'.$file;
3535: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3536: system("convert -sample $thumbsize $input $output");
3537: if (-e $filepath.'/'.'tn-'.$file) {
3538: $fetchthumb = 1;
3539: }
3540: }
1.858 raeburn 3541:
1.259 www 3542: # Notify homeserver to grep it
3543: #
1.984 neumanie 3544: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 3545: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 3546: if ($fetchresult eq 'ok') {
1.860 raeburn 3547: if ($fetchthumb) {
3548: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3549: if ($thumbresult ne 'ok') {
3550: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3551: $docuhome.': '.$thumbresult);
3552: }
3553: }
1.259 www 3554: #
1.258 www 3555: # Return the URL to it
1.494 albertel 3556: return '/uploaded/'.$path.$file;
1.263 www 3557: } else {
1.494 albertel 3558: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3559: ': '.$fetchresult);
1.263 www 3560: return '/adm/notfound.html';
1.858 raeburn 3561: }
1.493 albertel 3562: }
3563:
1.637 raeburn 3564: sub extract_embedded_items {
1.961 raeburn 3565: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 3566: my @state = ();
1.1164 raeburn 3567: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 3568: my %javafiles = (
3569: codebase => '',
3570: code => '',
3571: archive => ''
3572: );
3573: my %mediafiles = (
3574: src => '',
3575: movie => '',
3576: );
1.648 raeburn 3577: my $p;
3578: if ($content) {
3579: $p = HTML::LCParser->new($content);
3580: } else {
1.961 raeburn 3581: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 3582: }
1.641 albertel 3583: while (my $t=$p->get_token()) {
1.640 albertel 3584: if ($t->[0] eq 'S') {
3585: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 3586: push(@state, $tagname);
1.648 raeburn 3587: if (lc($tagname) eq 'allow') {
3588: &add_filetype($allfiles,$attr->{'src'},'src');
3589: }
1.640 albertel 3590: if (lc($tagname) eq 'img') {
3591: &add_filetype($allfiles,$attr->{'src'},'src');
3592: }
1.886 albertel 3593: if (lc($tagname) eq 'a') {
1.1172.2.24 raeburn 3594: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
3595: &add_filetype($allfiles,$attr->{'href'},'href');
3596: }
1.886 albertel 3597: }
1.645 raeburn 3598: if (lc($tagname) eq 'script') {
1.1164 raeburn 3599: my $src;
1.645 raeburn 3600: if ($attr->{'archive'} =~ /\.jar$/i) {
3601: &add_filetype($allfiles,$attr->{'archive'},'archive');
3602: } else {
1.1164 raeburn 3603: if ($attr->{'src'} ne '') {
3604: $src = $attr->{'src'};
3605: &add_filetype($allfiles,$src,'src');
3606: }
3607: }
3608: my $text = $p->get_trimmed_text();
3609: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3610: my @swfargs = split(/,/,$1);
3611: foreach my $item (@swfargs) {
3612: $item =~ s/["']//g;
3613: $item =~ s/^\s+//;
3614: $item =~ s/\s+$//;
3615: }
3616: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3617: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3618: push(@{$related{$swfargs[0]}},$swfargs[2]);
3619: } else {
3620: $related{$swfargs[0]} = [$swfargs[2]];
3621: }
3622: }
1.645 raeburn 3623: }
3624: }
3625: if (lc($tagname) eq 'link') {
3626: if (lc($attr->{'rel'}) eq 'stylesheet') {
3627: &add_filetype($allfiles,$attr->{'href'},'href');
3628: }
3629: }
1.640 albertel 3630: if (lc($tagname) eq 'object' ||
3631: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3632: foreach my $item (keys(%javafiles)) {
3633: $javafiles{$item} = '';
3634: }
1.1164 raeburn 3635: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3636: $lastids{lc($tagname)} = $attr->{'id'};
3637: }
1.640 albertel 3638: }
3639: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3640: my $name = lc($attr->{'name'});
3641: foreach my $item (keys(%javafiles)) {
3642: if ($name eq $item) {
3643: $javafiles{$item} = $attr->{'value'};
3644: last;
3645: }
3646: }
1.1164 raeburn 3647: my $pathfrom;
1.640 albertel 3648: foreach my $item (keys(%mediafiles)) {
3649: if ($name eq $item) {
1.1164 raeburn 3650: $pathfrom = $attr->{'value'};
3651: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3652: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 3653: last;
3654: }
3655: }
1.1164 raeburn 3656: if ($name eq 'flashvars') {
3657: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3658: }
3659: if ($pathfrom ne '') {
3660: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3661: $pathfrom);
3662: }
1.640 albertel 3663: }
3664: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3665: foreach my $item (keys(%javafiles)) {
3666: if ($attr->{$item}) {
3667: $javafiles{$item} = $attr->{$item};
3668: last;
3669: }
3670: }
3671: foreach my $item (keys(%mediafiles)) {
3672: if ($attr->{$item}) {
3673: &add_filetype($allfiles,$attr->{$item},$item);
3674: last;
3675: }
3676: }
1.1164 raeburn 3677: if (lc($tagname) eq 'embed') {
3678: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3679: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3680: $attr->{'src'});
3681: }
3682: }
1.640 albertel 3683: }
1.1172.2.35 raeburn 3684: if (lc($tagname) eq 'iframe') {
3685: my $src = $attr->{'src'} ;
3686: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
3687: &add_filetype($allfiles,$src,'src');
3688: } elsif ($src =~ m{^/}) {
3689: if ($env{'request.course.id'}) {
3690: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3691: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3692: my $url = &hreflocation('',$fullpath);
3693: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
3694: my $relpath = $1;
3695: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
3696: &add_filetype($allfiles,$1,'src');
3697: }
3698: }
3699: }
3700: }
3701: }
1.1164 raeburn 3702: if ($t->[4] =~ m{/>$}) {
1.1172.2.35 raeburn 3703: pop(@state);
1.1164 raeburn 3704: }
1.640 albertel 3705: } elsif ($t->[0] eq 'E') {
3706: my ($tagname) = ($t->[1]);
3707: if ($javafiles{'codebase'} ne '') {
3708: $javafiles{'codebase'} .= '/';
3709: }
3710: if (lc($tagname) eq 'applet' ||
3711: lc($tagname) eq 'object' ||
3712: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3713: ) {
3714: foreach my $item (keys(%javafiles)) {
3715: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3716: my $file=$javafiles{'codebase'}.$javafiles{$item};
3717: &add_filetype($allfiles,$file,$item);
3718: }
3719: }
3720: }
3721: pop @state;
3722: }
3723: }
1.1164 raeburn 3724: foreach my $id (sort(keys(%flashvars))) {
3725: if ($shockwave{$id} ne '') {
3726: my @pairs = split(/\&/,$flashvars{$id});
3727: foreach my $pair (@pairs) {
3728: my ($key,$value) = split(/\=/,$pair);
3729: if ($key eq 'thumb') {
3730: &add_filetype($allfiles,$value,$key);
3731: } elsif ($key eq 'content') {
3732: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3733: my ($ext) = ($value =~ /\.([^.]+)$/);
3734: if ($ext ne '') {
3735: &add_filetype($allfiles,$path.$value,$ext);
3736: }
3737: }
3738: }
3739: }
3740: }
1.637 raeburn 3741: return 'ok';
3742: }
3743:
1.639 albertel 3744: sub add_filetype {
3745: my ($allfiles,$file,$type)=@_;
3746: if (exists($allfiles->{$file})) {
3747: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3748: push(@{$allfiles->{$file}}, &escape($type));
3749: }
3750: } else {
3751: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 3752: }
3753: }
3754:
1.1164 raeburn 3755: sub embedded_dependency {
3756: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3757: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3758: if (($identifier ne '') &&
3759: (ref($related->{$identifier}) eq 'ARRAY') &&
3760: ($pathfrom ne '')) {
3761: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3762: foreach my $dep (@{$related->{$identifier}}) {
3763: &add_filetype($allfiles,$path.$dep,'object');
3764: }
3765: }
3766: }
3767: return;
3768: }
3769:
1.493 albertel 3770: sub removeuploadedurl {
1.984 neumanie 3771: my ($url)=@_;
3772: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 3773: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 3774: }
3775:
3776: sub removeuserfile {
3777: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 3778: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3779: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 3780: if ($result eq 'ok') {
1.798 raeburn 3781: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3782: my $metafile = $fname.'.meta';
3783: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 3784: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 3785: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3786: my $sqlresult =
1.823 albertel 3787: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3788: 'portfolio_metadata',$group,
3789: 'delete');
1.798 raeburn 3790: }
3791: }
3792: return $result;
1.257 www 3793: }
1.15 www 3794:
1.530 albertel 3795: sub mkdiruserfile {
3796: my ($docuname,$docudom,$dir)=@_;
3797: my $home=&homeserver($docuname,$docudom);
3798: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3799: }
3800:
1.531 albertel 3801: sub renameuserfile {
3802: my ($docuname,$docudom,$old,$new)=@_;
3803: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3804: my $result = &reply("renameuserfile:$docudom:$docuname:".
3805: &escape("$old").':'.&escape("$new"),$home);
3806: if ($result eq 'ok') {
3807: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3808: my $oldmeta = $old.'.meta';
3809: my $newmeta = $new.'.meta';
3810: my $metaresult =
3811: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 3812: my $url = "/uploaded/$docudom/$docuname/$old";
3813: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3814: my $sqlresult =
1.823 albertel 3815: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3816: 'portfolio_metadata',$group,
3817: 'delete');
1.798 raeburn 3818: }
3819: }
3820: return $result;
1.531 albertel 3821: }
3822:
1.14 www 3823: # ------------------------------------------------------------------------- Log
3824:
3825: sub log {
3826: my ($dom,$nam,$hom,$what)=@_;
1.47 www 3827: return critical("log:$dom:$nam:$what",$hom);
1.157 www 3828: }
3829:
3830: # ------------------------------------------------------------------ Course Log
1.352 www 3831: #
3832: # This routine flushes several buffers of non-mission-critical nature
3833: #
1.157 www 3834:
3835: sub flushcourselogs {
1.352 www 3836: &logthis('Flushing log buffers');
3837: #
3838: # course logs
3839: # This is a log of all transactions in a course, which can be used
3840: # for data mining purposes
3841: #
3842: # It also collects the courseid database, which lists last transaction
3843: # times and course titles for all courseids
3844: #
3845: my %courseidbuffer=();
1.921 raeburn 3846: foreach my $crsid (keys(%courselogs)) {
1.352 www 3847: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 3848: &escape($courselogs{$crsid}),
3849: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 3850: delete $courselogs{$crsid};
3851: } else {
3852: &logthis('Failed to flush log buffer for '.$crsid);
3853: if (length($courselogs{$crsid})>40000) {
1.672 albertel 3854: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 3855: " exceeded maximum size, deleting.</font>");
3856: delete $courselogs{$crsid};
3857: }
1.352 www 3858: }
1.920 raeburn 3859: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 3860: 'description' => $coursedescrbuf{$crsid},
3861: 'inst_code' => $courseinstcodebuf{$crsid},
3862: 'type' => $coursetypebuf{$crsid},
3863: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 3864: };
1.191 harris41 3865: }
1.352 www 3866: #
3867: # Write course id database (reverse lookup) to homeserver of courses
3868: # Is used in pickcourse
3869: #
1.840 albertel 3870: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 3871: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 3872: $courseidbuffer{$crs_home},
3873: $crs_home,'timeonly');
1.352 www 3874: }
3875: #
3876: # File accesses
3877: # Writes to the dynamic metadata of resources to get hit counts, etc.
3878: #
1.449 matthew 3879: foreach my $entry (keys(%accesshash)) {
1.458 matthew 3880: if ($entry =~ /___count$/) {
3881: my ($dom,$name);
1.807 albertel 3882: ($dom,$name,undef)=
1.811 albertel 3883: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 3884: if (! defined($dom) || $dom eq '' ||
3885: ! defined($name) || $name eq '') {
1.620 albertel 3886: my $cid = $env{'request.course.id'};
3887: $dom = $env{'request.'.$cid.'.domain'};
3888: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 3889: }
1.450 matthew 3890: my $value = $accesshash{$entry};
3891: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3892: my %temphash=($url => $value);
1.449 matthew 3893: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3894: if ($result eq 'ok') {
3895: delete $accesshash{$entry};
3896: }
3897: } else {
1.811 albertel 3898: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 3899: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 3900: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 3901: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3902: delete $accesshash{$entry};
3903: }
1.185 www 3904: }
1.191 harris41 3905: }
1.352 www 3906: #
3907: # Roles
3908: # Reverse lookup of user roles for course faculty/staff and co-authorship
3909: #
1.800 albertel 3910: foreach my $entry (keys(%userrolehash)) {
1.351 www 3911: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 3912: split(/\:/,$entry);
3913: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 3914: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 3915: $rudom,$runame) eq 'ok') {
3916: delete $userrolehash{$entry};
3917: }
3918: }
1.662 raeburn 3919: #
1.1172.2.90! raeburn 3920: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 3921: #
3922: my %domrolebuffer = ();
1.1000 raeburn 3923: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 3924: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 3925: if ($domrolebuffer{$rudom}) {
3926: $domrolebuffer{$rudom}.='&'.&escape($entry).
3927: '='.&escape($domainrolehash{$entry});
3928: } else {
3929: $domrolebuffer{$rudom}.=&escape($entry).
3930: '='.&escape($domainrolehash{$entry});
3931: }
3932: delete $domainrolehash{$entry};
3933: }
3934: foreach my $dom (keys(%domrolebuffer)) {
1.1172.2.82 raeburn 3935: my %servers;
3936: if (defined(&domain($dom,'primary'))) {
3937: my $primary=&domain($dom,'primary');
3938: my $hostname=&hostname($primary);
3939: $servers{$primary} = $hostname;
3940: } else {
3941: %servers = &get_servers($dom,'library');
3942: }
1.841 albertel 3943: foreach my $tryserver (keys(%servers)) {
1.1172.2.82 raeburn 3944: if (&reply('domroleput:'.$dom.':'.
3945: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3946: last;
3947: } else {
1.841 albertel 3948: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3949: }
1.662 raeburn 3950: }
3951: }
1.186 www 3952: $dumpcount++;
1.157 www 3953: }
3954:
3955: sub courselog {
3956: my $what=shift;
1.158 www 3957: $what=time.':'.$what;
1.620 albertel 3958: unless ($env{'request.course.id'}) { return ''; }
3959: $coursedombuf{$env{'request.course.id'}}=
3960: $env{'course.'.$env{'request.course.id'}.'.domain'};
3961: $coursenumbuf{$env{'request.course.id'}}=
3962: $env{'course.'.$env{'request.course.id'}.'.num'};
3963: $coursehombuf{$env{'request.course.id'}}=
3964: $env{'course.'.$env{'request.course.id'}.'.home'};
3965: $coursedescrbuf{$env{'request.course.id'}}=
3966: $env{'course.'.$env{'request.course.id'}.'.description'};
3967: $courseinstcodebuf{$env{'request.course.id'}}=
3968: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3969: $courseownerbuf{$env{'request.course.id'}}=
3970: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 3971: $coursetypebuf{$env{'request.course.id'}}=
3972: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 3973: if (defined $courselogs{$env{'request.course.id'}}) {
3974: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 3975: } else {
1.620 albertel 3976: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 3977: }
1.620 albertel 3978: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 3979: &flushcourselogs();
3980: }
1.158 www 3981: }
3982:
3983: sub courseacclog {
3984: my $fnsymb=shift;
1.620 albertel 3985: unless ($env{'request.course.id'}) { return ''; }
3986: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 3987: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 3988: $what.=':POST';
1.583 matthew 3989: # FIXME: Probably ought to escape things....
1.800 albertel 3990: foreach my $key (keys(%env)) {
3991: if ($key=~/^form\.(.*)/) {
1.975 raeburn 3992: my $formitem = $1;
3993: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3994: $what.=':'.$formitem.'='.$env{$key};
3995: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3996: $what.=':'.$formitem.'='.$env{$key};
3997: }
1.158 www 3998: }
1.191 harris41 3999: }
1.583 matthew 4000: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4001: # FIXME: We should not be depending on a form parameter that someone
4002: # editing lonsearchcat.pm might change in the future.
1.620 albertel 4003: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 4004: $what.= ':POST';
4005: # FIXME: Probably ought to escape things....
4006: foreach my $element ('courseexp','crsfulltext','crsrelated',
4007: 'crsdiscuss') {
1.620 albertel 4008: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 4009: }
4010: }
1.158 www 4011: }
4012: &courselog($what);
1.149 www 4013: }
4014:
1.185 www 4015: sub countacc {
4016: my $url=&declutter(shift);
1.458 matthew 4017: return if (! defined($url) || $url eq '');
1.620 albertel 4018: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 4019: #
4020: # Mark that this url was used in this course
4021: #
1.620 albertel 4022: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 4023: #
4024: # Increase the access count for this resource in this child process
4025: #
1.281 www 4026: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 4027: $accesshash{$key}++;
1.185 www 4028: }
1.349 www 4029:
1.361 www 4030: sub linklog {
4031: my ($from,$to)=@_;
4032: $from=&declutter($from);
4033: $to=&declutter($to);
4034: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4035: $accesshash{$to.'___'.$from.'___goto'}=1;
4036: }
1.1160 www 4037:
4038: sub statslog {
4039: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4040: if ($users<2) { return; }
4041: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4042: 'course' => $env{'request.course.id'},
4043: 'sections' => '"all"',
4044: 'num_students' => $users,
4045: 'part' => $part,
4046: 'symb' => $symb,
4047: 'mean_tries' => $av_attempts,
4048: 'deg_of_diff' => $degdiff});
4049: foreach my $key (keys(%dynstore)) {
4050: $accesshash{$key}=$dynstore{$key};
4051: }
4052: }
1.361 www 4053:
1.349 www 4054: sub userrolelog {
4055: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 4056: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 4057: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4058: $userrolehash
4059: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 4060: =$tend.':'.$tstart;
1.662 raeburn 4061: }
1.1169 droeschl 4062: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 4063: $userrolehash
4064: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4065: =$tend.':'.$tstart;
4066: }
1.1172.2.90! raeburn 4067: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 4068: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4069: $domainrolehash
4070: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4071: = $tend.':'.$tstart;
4072: }
1.351 www 4073: }
4074:
1.957 raeburn 4075: sub courserolelog {
4076: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1172.2.9 raeburn 4077: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4078: my $cdom = $1;
4079: my $cnum = $2;
4080: my $sec = $3;
4081: my $namespace = 'rolelog';
4082: my %storehash = (
4083: role => $trole,
4084: start => $tstart,
4085: end => $tend,
4086: selfenroll => $selfenroll,
4087: context => $context,
4088: );
4089: if ($trole eq 'gr') {
4090: $namespace = 'groupslog';
4091: $storehash{'group'} = $sec;
4092: } else {
4093: $storehash{'section'} = $sec;
4094: }
4095: &write_log('course',$namespace,\%storehash,$delflag,$username,
4096: $domain,$cnum,$cdom);
4097: if (($trole ne 'st') || ($sec ne '')) {
4098: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 4099: }
4100: }
4101: return;
4102: }
4103:
1.1172.2.9 raeburn 4104: sub domainrolelog {
4105: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4106: if ($area =~ m{^/($match_domain)/$}) {
4107: my $cdom = $1;
4108: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4109: my $namespace = 'rolelog';
4110: my %storehash = (
4111: role => $trole,
4112: start => $tstart,
4113: end => $tend,
4114: context => $context,
4115: );
4116: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4117: $domain,$domconfiguser,$cdom);
4118: }
4119: return;
4120:
4121: }
4122:
4123: sub coauthorrolelog {
4124: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4125: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4126: my $audom = $1;
4127: my $auname = $2;
4128: my $namespace = 'rolelog';
4129: my %storehash = (
4130: role => $trole,
4131: start => $tstart,
4132: end => $tend,
4133: context => $context,
4134: );
4135: &write_log('author',$namespace,\%storehash,$delflag,$username,
4136: $domain,$auname,$audom);
4137: }
4138: return;
4139: }
4140:
1.351 www 4141: sub get_course_adv_roles {
1.948 raeburn 4142: my ($cid,$codes) = @_;
1.620 albertel 4143: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 4144: my %coursehash=&coursedescription($cid);
1.988 raeburn 4145: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 4146: my %nothide=();
1.800 albertel 4147: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 4148: if ($user !~ /:/) {
4149: $nothide{join(':',split(/[\@]/,$user))}=1;
4150: } else {
4151: $nothide{$user}=1;
4152: }
1.470 www 4153: }
1.1172.2.23 raeburn 4154: my @possdoms = ($coursehash{'domain'});
4155: if ($coursehash{'checkforpriv'}) {
4156: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4157: }
1.351 www 4158: my %returnhash=();
4159: my %dumphash=
4160: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4161: my $now=time;
1.997 raeburn 4162: my %privileged;
1.1000 raeburn 4163: foreach my $entry (keys(%dumphash)) {
1.800 albertel 4164: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 4165: if (($tstart) && ($tstart<0)) { next; }
4166: if (($tend) && ($tend<$now)) { next; }
4167: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 4168: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 4169: if ($username eq '' || $domain eq '') { next; }
1.1172.2.23 raeburn 4170: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 4171: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 4172: if ($role eq 'cr') { next; }
1.948 raeburn 4173: if ($codes) {
4174: if ($section) { $role .= ':'.$section; }
4175: if ($returnhash{$role}) {
4176: $returnhash{$role}.=','.$username.':'.$domain;
4177: } else {
4178: $returnhash{$role}=$username.':'.$domain;
4179: }
1.351 www 4180: } else {
1.988 raeburn 4181: my $key=&plaintext($role,$crstype);
1.973 bisitz 4182: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 4183: if ($returnhash{$key}) {
4184: $returnhash{$key}.=','.$username.':'.$domain;
4185: } else {
4186: $returnhash{$key}=$username.':'.$domain;
4187: }
1.351 www 4188: }
1.948 raeburn 4189: }
1.400 www 4190: return %returnhash;
4191: }
4192:
4193: sub get_my_roles {
1.937 raeburn 4194: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 4195: unless (defined($uname)) { $uname=$env{'user.name'}; }
4196: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 4197: my (%dumphash,%nothide);
1.1086 raeburn 4198: if ($context eq 'userroles') {
1.1166 raeburn 4199: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 4200: } else {
1.1172.2.23 raeburn 4201: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 4202: if ($hidepriv) {
4203: my %coursehash=&coursedescription($udom.'_'.$uname);
4204: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4205: if ($user !~ /:/) {
4206: $nothide{join(':',split(/[\@]/,$user))} = 1;
4207: } else {
4208: $nothide{$user} = 1;
4209: }
4210: }
4211: }
1.858 raeburn 4212: }
1.400 www 4213: my %returnhash=();
4214: my $now=time;
1.999 raeburn 4215: my %privileged;
1.800 albertel 4216: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 4217: my ($role,$tend,$tstart);
4218: if ($context eq 'userroles') {
1.1149 raeburn 4219: next if ($entry =~ /^rolesdef/);
1.867 raeburn 4220: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4221: } else {
4222: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4223: }
1.400 www 4224: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 4225: my $status = 'active';
1.939 raeburn 4226: if (($tend) && ($tend<=$now)) {
1.832 raeburn 4227: $status = 'previous';
4228: }
4229: if (($tstart) && ($now<$tstart)) {
4230: $status = 'future';
4231: }
4232: if (ref($types) eq 'ARRAY') {
4233: if (!grep(/^\Q$status\E$/,@{$types})) {
4234: next;
4235: }
4236: } else {
4237: if ($status ne 'active') {
4238: next;
4239: }
4240: }
1.867 raeburn 4241: my ($rolecode,$username,$domain,$section,$area);
4242: if ($context eq 'userroles') {
1.1172.2.9 raeburn 4243: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 4244: (undef,$domain,$username,$section) = split(/\//,$area);
4245: } else {
4246: ($role,$username,$domain,$section) = split(/\:/,$entry);
4247: }
1.832 raeburn 4248: if (ref($roledoms) eq 'ARRAY') {
4249: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4250: next;
4251: }
4252: }
4253: if (ref($roles) eq 'ARRAY') {
4254: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 4255: if ($role =~ /^cr\//) {
4256: if (!grep(/^cr$/,@{$roles})) {
4257: next;
4258: }
1.1104 raeburn 4259: } elsif ($role =~ /^gr\//) {
4260: if (!grep(/^gr$/,@{$roles})) {
4261: next;
4262: }
1.922 raeburn 4263: } else {
4264: next;
4265: }
1.832 raeburn 4266: }
1.867 raeburn 4267: }
1.937 raeburn 4268: if ($hidepriv) {
1.1172.2.23 raeburn 4269: my @privroles = ('dc','su');
1.999 raeburn 4270: if ($context eq 'userroles') {
1.1172.2.23 raeburn 4271: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 4272: } else {
1.1172.2.23 raeburn 4273: my $possdoms = [$domain];
4274: if (ref($roledoms) eq 'ARRAY') {
4275: push(@{$possdoms},@{$roledoms});
1.999 raeburn 4276: }
1.1172.2.23 raeburn 4277: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 4278: if (!$nothide{$username.':'.$domain}) {
4279: next;
4280: }
4281: }
1.937 raeburn 4282: }
4283: }
1.933 raeburn 4284: if ($withsec) {
4285: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4286: $tstart.':'.$tend;
4287: } else {
4288: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4289: }
1.832 raeburn 4290: }
1.373 www 4291: return %returnhash;
1.399 www 4292: }
4293:
1.1172.2.89 raeburn 4294: sub get_all_adhocroles {
4295: my ($dom) = @_;
4296: my @roles_by_num = ();
4297: my %domdefaults = &get_domain_defaults($dom);
4298: my (%description,%access_in_dom,%access_info);
4299: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
4300: my $count = 0;
4301: my %domcurrent = %{$domdefaults{'adhocroles'}};
4302: my %ordered;
4303: foreach my $role (sort(keys(%domcurrent))) {
4304: my ($order,$desc,$access_in_dom);
4305: if (ref($domcurrent{$role}) eq 'HASH') {
4306: $order = $domcurrent{$role}{'order'};
4307: $desc = $domcurrent{$role}{'desc'};
4308: $access_in_dom{$role} = $domcurrent{$role}{'access'};
4309: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
4310: }
4311: if ($order eq '') {
4312: $order = $count;
4313: }
4314: $ordered{$order} = $role;
4315: if ($desc ne '') {
4316: $description{$role} = $desc;
4317: } else {
4318: $description{$role}= $role;
4319: }
4320: $count++;
4321: }
4322: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
4323: push(@roles_by_num,$ordered{$item});
4324: }
4325: }
4326: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
4327: }
4328:
4329: sub get_my_adhocroles {
4330: my ($cid,$checkreg) = @_;
4331: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
4332: if ($env{'request.course.id'} eq $cid) {
4333: $cdom = $env{'course.'.$cid.'.domain'};
4334: $cnum = $env{'course.'.$cid.'.num'};
4335: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
4336: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
4337: $cdom = $1;
4338: $cnum = $2;
4339: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
4340: $cdom,$cnum);
4341: }
4342: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
4343: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4344: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
4345: if ($rosterhash{$user} ne '') {
4346: my $type = (split(/:/,$rosterhash{$user}))[5];
4347: return ([],{}) if ($type eq 'auto');
4348: }
4349: }
4350: if (($cdom ne '') && ($cnum ne '')) {
1.1172.2.90! raeburn 4351: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1172.2.89 raeburn 4352: my $then=$env{'user.login.time'};
4353: my $update=$env{'user.update.time'};
1.1172.2.90! raeburn 4354: if (!$update) {
! 4355: $update = $then;
! 4356: }
! 4357: my @liveroles;
! 4358: foreach my $role ('dh','da') {
! 4359: if ($env{"user.role.$role./$cdom/"}) {
! 4360: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
! 4361: my $limit = $update;
! 4362: if ($env{'request.role'} eq "$role./$cdom/") {
! 4363: $limit = $then;
! 4364: }
! 4365: my $activerole = 1;
! 4366: if ($tstart && $tstart>$limit) { $activerole = 0; }
! 4367: if ($tend && $tend <$limit) { $activerole = 0; }
! 4368: if ($activerole) {
! 4369: push(@liveroles,$role);
! 4370: }
! 4371: }
! 4372: }
! 4373: if (@liveroles) {
1.1172.2.89 raeburn 4374: if (&homeserver($cnum,$cdom) ne 'no_host') {
4375: my ($accessref,$accessinfo,%access_in_dom);
4376: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
4377: if (ref($roles_by_num) eq 'ARRAY') {
4378: if (@{$roles_by_num}) {
4379: my %settings;
4380: if ($env{'request.course.id'} eq $cid) {
4381: foreach my $envkey (keys(%env)) {
4382: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
4383: $settings{$1} = $env{$envkey};
4384: }
4385: }
4386: } else {
4387: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
4388: }
4389: my %setincrs;
4390: if ($settings{'internal.adhocaccess'}) {
4391: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
4392: }
4393: my @statuses;
4394: if ($env{'environment.inststatus'}) {
4395: @statuses = split(/,/,$env{'environment.inststatus'});
4396: }
4397: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4398: if (ref($accessref) eq 'HASH') {
4399: %access_in_dom = %{$accessref};
4400: }
4401: foreach my $role (@{$roles_by_num}) {
4402: my ($curraccess,@okstatus,@personnel);
4403: if ($setincrs{$role}) {
4404: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
4405: if ($curraccess eq 'status') {
4406: @okstatus = split(/\&/,$rest);
4407: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4408: @personnel = split(/\&/,$rest);
4409: }
4410: } else {
4411: $curraccess = $access_in_dom{$role};
4412: if (ref($accessinfo) eq 'HASH') {
4413: if ($curraccess eq 'status') {
4414: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4415: @okstatus = @{$accessinfo->{$role}};
4416: }
4417: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4418: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4419: @personnel = @{$accessinfo->{$role}};
4420: }
4421: }
4422: }
4423: }
4424: if ($curraccess eq 'none') {
4425: next;
4426: } elsif ($curraccess eq 'all') {
4427: push(@possroles,$role);
1.1172.2.90! raeburn 4428: } elsif ($curraccess eq 'dh') {
! 4429: if (grep(/^dh$/,@liveroles)) {
! 4430: push(@possroles,$role);
! 4431: } else {
! 4432: next;
! 4433: }
! 4434: } elsif ($curraccess eq 'da') {
! 4435: if (grep(/^da$/,@liveroles)) {
! 4436: push(@possroles,$role);
! 4437: } else {
! 4438: next;
! 4439: }
1.1172.2.89 raeburn 4440: } elsif ($curraccess eq 'status') {
4441: if (@okstatus) {
4442: if (!@statuses) {
4443: if (grep(/^default$/,@okstatus)) {
4444: push(@possroles,$role);
4445: }
4446: } else {
4447: foreach my $status (@okstatus) {
4448: if (grep(/^\Q$status\E$/,@statuses)) {
4449: push(@possroles,$role);
4450: last;
4451: }
4452: }
4453: }
4454: }
4455: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4456: if (grep(/^\Q$user\E$/,@personnel)) {
4457: if ($curraccess eq 'exc') {
4458: push(@possroles,$role);
4459: }
4460: } elsif ($curraccess eq 'inc') {
4461: push(@possroles,$role);
4462: }
4463: }
4464: }
4465: }
4466: }
4467: }
4468: }
4469: }
4470: }
4471: unless (ref($description) eq 'HASH') {
4472: if (ref($roles_by_num) eq 'ARRAY') {
4473: my %desc;
4474: map { $desc{$_} = $_; } (@{$roles_by_num});
4475: $description = \%desc;
4476: } else {
4477: $description = {};
4478: }
4479: }
4480: return (\@possroles,$description);
4481: }
4482:
1.399 www 4483: # ----------------------------------------------------- Frontpage Announcements
4484: #
4485: #
4486:
4487: sub postannounce {
4488: my ($server,$text)=@_;
1.844 albertel 4489: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 4490: unless ($text=~/\w/) { $text=''; }
4491: return &reply('setannounce:'.&escape($text),$server);
4492: }
4493:
4494: sub getannounce {
1.448 albertel 4495:
4496: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 4497: my $announcement='';
1.800 albertel 4498: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 4499: close($fh);
1.399 www 4500: if ($announcement=~/\w/) {
4501: return
4502: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 4503: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 4504: } else {
4505: return '';
4506: }
4507: } else {
4508: return '';
4509: }
1.351 www 4510: }
1.353 www 4511:
4512: # ---------------------------------------------------------- Course ID routines
4513: # Deal with domain's nohist_courseid.db files
4514: #
4515:
4516: sub courseidput {
1.921 raeburn 4517: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 4518: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 4519: my $outcome;
4520: if ($caller eq 'timeonly') {
4521: my $cids = '';
4522: foreach my $item (keys(%$storehash)) {
4523: $cids.=&escape($item).'&';
4524: }
4525: $cids=~s/\&$//;
4526: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4527: $coursehome);
4528: } else {
4529: my $items = '';
4530: foreach my $item (keys(%$storehash)) {
4531: $items.= &escape($item).'='.
4532: &freeze_escape($$storehash{$item}).'&';
4533: }
4534: $items=~s/\&$//;
4535: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4536: $coursehome);
1.918 raeburn 4537: }
4538: if ($outcome eq 'unknown_cmd') {
4539: my $what;
4540: foreach my $cid (keys(%$storehash)) {
4541: $what .= &escape($cid).'=';
1.921 raeburn 4542: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 4543: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 4544: }
4545: $what =~ s/\:$/&/;
4546: }
4547: $what =~ s/\&$//;
4548: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4549: } else {
4550: return $outcome;
4551: }
1.353 www 4552: }
4553:
4554: sub courseiddump {
1.921 raeburn 4555: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 4556: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 4557: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1172.2.38 raeburn 4558: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1172.2.68 raeburn 4559: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 4560: my $as_hash = 1;
4561: my %returnhash;
4562: if (!$domfilter) { $domfilter=''; }
1.845 albertel 4563: my %libserv = &all_library();
4564: foreach my $tryserver (keys(%libserv)) {
4565: if ( ( $hostidflag == 1
4566: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4567: || (!defined($hostidflag)) ) {
4568:
1.918 raeburn 4569: if (($domfilter eq '') ||
4570: (&host_domain($tryserver) eq $domfilter)) {
1.1172.2.22 raeburn 4571: my $rep;
4572: if (grep { $_ eq $tryserver } ¤t_machine_ids()) {
4573: $rep = &LONCAPA::Lond::dump_course_id_handler(
4574: join(":", (&host_domain($tryserver), $sincefilter,
4575: &escape($descfilter), &escape($instcodefilter),
4576: &escape($ownerfilter), &escape($coursefilter),
4577: &escape($typefilter), &escape($regexp_ok),
4578: $as_hash, &escape($selfenrollonly),
4579: &escape($catfilter), $showhidden, $caller,
4580: &escape($cloner), &escape($cc_clone), $cloneonly,
4581: &escape($createdbefore), &escape($createdafter),
1.1172.2.68 raeburn 4582: &escape($creationcontext),$domcloner,$hasuniquecode,
4583: $reqcrsdom,&escape($reqinstcode))));
1.1172.2.22 raeburn 4584: } else {
4585: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4586: $sincefilter.':'.&escape($descfilter).':'.
4587: &escape($instcodefilter).':'.&escape($ownerfilter).
4588: ':'.&escape($coursefilter).':'.&escape($typefilter).
4589: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4590: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4591: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4592: &escape($cc_clone).':'.$cloneonly.':'.
4593: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1172.2.68 raeburn 4594: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
4595: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1172.2.22 raeburn 4596: }
4597:
1.918 raeburn 4598: my @pairs=split(/\&/,$rep);
4599: foreach my $item (@pairs) {
4600: my ($key,$value)=split(/\=/,$item,2);
4601: $key = &unescape($key);
4602: next if ($key =~ /^error: 2 /);
4603: my $result = &thaw_unescape($value);
4604: if (ref($result) eq 'HASH') {
4605: $returnhash{$key}=$result;
4606: } else {
1.921 raeburn 4607: my @responses = split(/:/,$value);
4608: my @items = ('description','inst_code','owner','type');
1.918 raeburn 4609: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 4610: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 4611: }
1.1008 raeburn 4612: }
1.353 www 4613: }
4614: }
4615: }
4616: }
4617: return %returnhash;
4618: }
4619:
1.1055 raeburn 4620: sub courselastaccess {
4621: my ($cdom,$cnum,$hostidref) = @_;
4622: my %returnhash;
4623: if ($cdom && $cnum) {
4624: my $chome = &homeserver($cnum,$cdom);
4625: if ($chome ne 'no_host') {
4626: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4627: &extract_lastaccess(\%returnhash,$rep);
4628: }
4629: } else {
4630: if (!$cdom) { $cdom=''; }
4631: my %libserv = &all_library();
4632: foreach my $tryserver (keys(%libserv)) {
4633: if (ref($hostidref) eq 'ARRAY') {
4634: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4635: }
4636: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4637: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4638: &extract_lastaccess(\%returnhash,$rep);
4639: }
4640: }
4641: }
4642: return %returnhash;
4643: }
4644:
4645: sub extract_lastaccess {
4646: my ($returnhash,$rep) = @_;
4647: if (ref($returnhash) eq 'HASH') {
4648: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4649: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4650: $rep eq '') {
4651: my @pairs=split(/\&/,$rep);
4652: foreach my $item (@pairs) {
4653: my ($key,$value)=split(/\=/,$item,2);
4654: $key = &unescape($key);
4655: next if ($key =~ /^error: 2 /);
4656: $returnhash->{$key} = &thaw_unescape($value);
4657: }
4658: }
4659: }
4660: return;
4661: }
4662:
1.658 raeburn 4663: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 4664:
4665: sub dcmailput {
1.685 raeburn 4666: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 4667: my $status = &Apache::lonnet::critical(
1.740 www 4668: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4669: &escape($message),$server);
1.662 raeburn 4670: return $status;
4671: }
4672:
1.658 raeburn 4673: sub dcmaildump {
4674: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 4675: my %returnhash=();
1.846 albertel 4676:
4677: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 4678: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4679: &escape($enddate).':';
4680: my @esc_senders=map { &escape($_)} @$senders;
4681: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 4682: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 4683: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 4684: if (($key) && ($value)) {
4685: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 4686: }
4687: }
4688: }
4689: return %returnhash;
4690: }
1.662 raeburn 4691: # ---------------------------------------------------------- Domain roles
4692:
4693: sub get_domain_roles {
4694: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 4695: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 4696: $startdate = '.';
4697: }
1.1018 raeburn 4698: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 4699: $enddate = '.';
4700: }
1.922 raeburn 4701: my $rolelist;
4702: if (ref($roles) eq 'ARRAY') {
1.1172.2.23 raeburn 4703: $rolelist = join('&',@{$roles});
1.922 raeburn 4704: }
1.662 raeburn 4705: my %personnel = ();
1.841 albertel 4706:
4707: my %servers = &get_servers($dom,'library');
4708: foreach my $tryserver (keys(%servers)) {
4709: %{$personnel{$tryserver}}=();
4710: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4711: &escape($startdate).':'.
4712: &escape($enddate).':'.
4713: &escape($rolelist), $tryserver))) {
4714: my ($key,$value) = split(/\=/,$line,2);
4715: if (($key) && ($value)) {
4716: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4717: }
4718: }
1.662 raeburn 4719: }
4720: return %personnel;
4721: }
1.658 raeburn 4722:
1.1172.2.89 raeburn 4723: sub get_active_domroles {
4724: my ($dom,$roles) = @_;
4725: return () unless (ref($roles) eq 'ARRAY');
4726: my $now = time;
4727: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
4728: my %domroles;
4729: foreach my $server (keys(%dompersonnel)) {
4730: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
4731: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
4732: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
4733: }
4734: }
4735: return %domroles;
4736: }
4737:
1.1057 www 4738: # ----------------------------------------------------------- Interval timing
1.149 www 4739:
1.1153 www 4740: {
4741: # Caches needed for speedup of navmaps
4742: # We don't want to cache this for very long at all (5 seconds at most)
4743: #
4744: # The user for whom we cache
4745: my $cachedkey='';
4746: # The cached times for this user
4747: my %cachedtimes=();
4748: # When this was last done
1.1172.2.66 raeburn 4749: my $cachedtime='';
1.1153 www 4750:
4751: sub load_all_first_access {
1.1154 raeburn 4752: my ($uname,$udom)=@_;
1.1156 www 4753: if (($cachedkey eq $uname.':'.$udom) &&
1.1172.2.2 raeburn 4754: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
1.1154 raeburn 4755: return;
4756: }
4757: $cachedtime=time;
4758: $cachedkey=$uname.':'.$udom;
4759: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 4760: }
4761:
1.504 albertel 4762: sub get_first_access {
1.1162 raeburn 4763: my ($type,$argsymb,$argmap)=@_;
1.790 albertel 4764: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4765: if ($argsymb) { $symb=$argsymb; }
4766: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 4767: if ($argmap) { $map = $argmap; }
1.926 albertel 4768: if ($type eq 'course') {
4769: $res='course';
4770: } elsif ($type eq 'map') {
1.588 albertel 4771: $res=&symbread($map);
4772: } else {
4773: $res=$symb;
4774: }
1.1153 www 4775: &load_all_first_access($uname,$udom);
4776: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 4777: }
4778:
4779: sub set_first_access {
1.1162 raeburn 4780: my ($type,$interval)=@_;
1.790 albertel 4781: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4782: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 4783: if ($type eq 'course') {
4784: $res='course';
4785: } elsif ($type eq 'map') {
1.588 albertel 4786: $res=&symbread($map);
4787: } else {
4788: $res=$symb;
4789: }
1.1153 www 4790: $cachedkey='';
1.1162 raeburn 4791: my $firstaccess=&get_first_access($type,$symb,$map);
1.505 albertel 4792: if (!$firstaccess) {
1.1162 raeburn 4793: my $start = time;
4794: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4795: $udom,$uname);
4796: if ($putres eq 'ok') {
4797: &put('timerinterval',{"$courseid\0$res"=>$interval},
4798: $udom,$uname);
4799: &appenv(
4800: {
4801: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4802: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4803: }
4804: );
4805: }
4806: return $putres;
1.505 albertel 4807: }
4808: return 'already_set';
1.504 albertel 4809: }
1.1153 www 4810: }
1.1172.2.32 raeburn 4811:
4812: sub checkout {
4813: my ($symb,$tuname,$tudom,$tcrsid)=@_;
4814: my $now=time;
4815: my $lonhost=$perlvar{'lonHostID'};
4816: my $infostr=&escape(
4817: 'CHECKOUTTOKEN&'.
4818: $tuname.'&'.
4819: $tudom.'&'.
4820: $tcrsid.'&'.
4821: $symb.'&'.
4822: $now.'&'.$ENV{'REMOTE_ADDR'});
4823: my $token=&reply('tmpput:'.$infostr,$lonhost);
4824: if ($token=~/^error\:/) {
4825: &logthis("<font color=\"blue\">WARNING: ".
4826: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
4827: "</font>");
4828: return '';
4829: }
4830:
4831: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
4832: $token=~tr/a-z/A-Z/;
4833:
4834: my %infohash=('resource.0.outtoken' => $token,
4835: 'resource.0.checkouttime' => $now,
4836: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
4837:
4838: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
4839: return '';
4840: } else {
4841: &logthis("<font color=\"blue\">WARNING: ".
4842: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
4843: "</font>");
4844: }
4845:
4846: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
4847: &escape('Checkout '.$infostr.' - '.
4848: $token)) ne 'ok') {
4849: return '';
4850: } else {
4851: &logthis("<font color=\"blue\">WARNING: ".
4852: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
4853: "</font>");
4854: }
4855: return $token;
4856: }
4857:
4858: # ------------------------------------------------------------ Check in an item
4859:
4860: sub checkin {
4861: my $token=shift;
4862: my $now=time;
4863: my ($ta,$tb,$lonhost)=split(/\*/,$token);
4864: $lonhost=~tr/A-Z/a-z/;
4865: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
4866: $dtoken=~s/\W/\_/g;
4867: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
4868: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
4869:
4870: unless (($tuname) && ($tudom)) {
4871: &logthis('Check in '.$token.' ('.$dtoken.') failed');
4872: return '';
4873: }
4874:
4875: unless (&allowed('mgr',$tcrsid)) {
4876: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
4877: $env{'user.name'}.' - '.$env{'user.domain'});
4878: return '';
4879: }
4880:
4881: my %infohash=('resource.0.intoken' => $token,
4882: 'resource.0.checkintime' => $now,
4883: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
4884:
4885: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
4886: return '';
4887: }
4888:
4889: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
4890: &escape('Checkin - '.$token)) ne 'ok') {
4891: return '';
4892: }
4893:
4894: return ($symb,$tuname,$tudom,$tcrsid);
4895: }
4896:
1.110 www 4897: # --------------------------------------------- Set Expire Date for Spreadsheet
4898:
4899: sub expirespread {
4900: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 4901: my $cid=$env{'request.course.id'};
1.110 www 4902: if ($cid) {
4903: my $now=time;
4904: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 4905: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4906: $env{'course.'.$cid.'.num'}.
1.110 www 4907: ':nohist_expirationdates:'.
4908: &escape($key).'='.$now,
1.620 albertel 4909: $env{'course.'.$cid.'.home'})
1.110 www 4910: }
4911: return 'ok';
1.14 www 4912: }
4913:
1.109 www 4914: # ----------------------------------------------------- Devalidate Spreadsheets
4915:
4916: sub devalidate {
1.325 www 4917: my ($symb,$uname,$udom)=@_;
1.620 albertel 4918: my $cid=$env{'request.course.id'};
1.109 www 4919: if ($cid) {
1.391 matthew 4920: # delete the stored spreadsheets for
4921: # - the student level sheet of this user in course's homespace
4922: # - the assessment level sheet for this resource
4923: # for this user in user's homespace
1.553 albertel 4924: # - current conditional state info
1.325 www 4925: my $key=$uname.':'.$udom.':';
1.109 www 4926: my $status=
1.299 matthew 4927: &del('nohist_calculatedsheets',
1.391 matthew 4928: [$key.'studentcalc:'],
1.620 albertel 4929: $env{'course.'.$cid.'.domain'},
4930: $env{'course.'.$cid.'.num'})
1.133 albertel 4931: .' '.
4932: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 4933: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 4934: unless ($status eq 'ok ok') {
4935: &logthis('Could not devalidate spreadsheet '.
1.325 www 4936: $uname.' at '.$udom.' for '.
1.109 www 4937: $symb.': '.$status);
1.133 albertel 4938: }
1.553 albertel 4939: &delenv('user.state.'.$cid);
1.109 www 4940: }
4941: }
4942:
1.265 albertel 4943: sub get_scalar {
4944: my ($string,$end) = @_;
4945: my $value;
4946: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4947: $value = $1;
4948: } elsif ($$string =~ s/^([^&]*?)&//) {
4949: $value = $1;
4950: }
4951: return &unescape($value);
4952: }
4953:
4954: sub array2str {
4955: my (@array) = @_;
4956: my $result=&arrayref2str(\@array);
4957: $result=~s/^__ARRAY_REF__//;
4958: $result=~s/__END_ARRAY_REF__$//;
4959: return $result;
4960: }
4961:
1.204 albertel 4962: sub arrayref2str {
4963: my ($arrayref) = @_;
1.265 albertel 4964: my $result='__ARRAY_REF__';
1.204 albertel 4965: foreach my $elem (@$arrayref) {
1.265 albertel 4966: if(ref($elem) eq 'ARRAY') {
4967: $result.=&arrayref2str($elem).'&';
4968: } elsif(ref($elem) eq 'HASH') {
4969: $result.=&hashref2str($elem).'&';
4970: } elsif(ref($elem)) {
4971: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 4972: } else {
4973: $result.=&escape($elem).'&';
4974: }
4975: }
4976: $result=~s/\&$//;
1.265 albertel 4977: $result .= '__END_ARRAY_REF__';
1.204 albertel 4978: return $result;
4979: }
4980:
1.168 albertel 4981: sub hash2str {
1.204 albertel 4982: my (%hash) = @_;
4983: my $result=&hashref2str(\%hash);
1.265 albertel 4984: $result=~s/^__HASH_REF__//;
4985: $result=~s/__END_HASH_REF__$//;
1.204 albertel 4986: return $result;
4987: }
4988:
4989: sub hashref2str {
4990: my ($hashref)=@_;
1.265 albertel 4991: my $result='__HASH_REF__';
1.800 albertel 4992: foreach my $key (sort(keys(%$hashref))) {
4993: if (ref($key) eq 'ARRAY') {
4994: $result.=&arrayref2str($key).'=';
4995: } elsif (ref($key) eq 'HASH') {
4996: $result.=&hashref2str($key).'=';
4997: } elsif (ref($key)) {
1.265 albertel 4998: $result.='=';
1.800 albertel 4999: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 5000: } else {
1.1132 raeburn 5001: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 5002: }
5003:
1.800 albertel 5004: if(ref($hashref->{$key}) eq 'ARRAY') {
5005: $result.=&arrayref2str($hashref->{$key}).'&';
5006: } elsif(ref($hashref->{$key}) eq 'HASH') {
5007: $result.=&hashref2str($hashref->{$key}).'&';
5008: } elsif(ref($hashref->{$key})) {
1.265 albertel 5009: $result.='&';
1.800 albertel 5010: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 5011: } else {
1.800 albertel 5012: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 5013: }
5014: }
1.168 albertel 5015: $result=~s/\&$//;
1.265 albertel 5016: $result .= '__END_HASH_REF__';
1.168 albertel 5017: return $result;
5018: }
5019:
5020: sub str2hash {
1.265 albertel 5021: my ($string)=@_;
5022: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
5023: return %$hash;
5024: }
5025:
5026: sub str2hashref {
1.168 albertel 5027: my ($string) = @_;
1.265 albertel 5028:
5029: my %hash;
5030:
5031: if($string !~ /^__HASH_REF__/) {
5032: if (! ($string eq '' || !defined($string))) {
5033: $hash{'error'}='Not hash reference';
5034: }
5035: return (\%hash, $string);
5036: }
5037:
5038: $string =~ s/^__HASH_REF__//;
5039:
5040: while($string !~ /^__END_HASH_REF__/) {
5041: #key
5042: my $key='';
5043: if($string =~ /^__HASH_REF__/) {
5044: ($key, $string)=&str2hashref($string);
5045: if(defined($key->{'error'})) {
5046: $hash{'error'}='Bad data';
5047: return (\%hash, $string);
5048: }
5049: } elsif($string =~ /^__ARRAY_REF__/) {
5050: ($key, $string)=&str2arrayref($string);
5051: if($key->[0] eq 'Array reference error') {
5052: $hash{'error'}='Bad data';
5053: return (\%hash, $string);
5054: }
5055: } else {
5056: $string =~ s/^(.*?)=//;
1.267 albertel 5057: $key=&unescape($1);
1.265 albertel 5058: }
5059: $string =~ s/^=//;
5060:
5061: #value
5062: my $value='';
5063: if($string =~ /^__HASH_REF__/) {
5064: ($value, $string)=&str2hashref($string);
5065: if(defined($value->{'error'})) {
5066: $hash{'error'}='Bad data';
5067: return (\%hash, $string);
5068: }
5069: } elsif($string =~ /^__ARRAY_REF__/) {
5070: ($value, $string)=&str2arrayref($string);
5071: if($value->[0] eq 'Array reference error') {
5072: $hash{'error'}='Bad data';
5073: return (\%hash, $string);
5074: }
5075: } else {
5076: $value=&get_scalar(\$string,'__END_HASH_REF__');
5077: }
5078: $string =~ s/^&//;
5079:
5080: $hash{$key}=$value;
1.204 albertel 5081: }
1.265 albertel 5082:
5083: $string =~ s/^__END_HASH_REF__//;
5084:
5085: return (\%hash, $string);
1.204 albertel 5086: }
5087:
5088: sub str2array {
1.265 albertel 5089: my ($string)=@_;
5090: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
5091: return @$array;
5092: }
5093:
5094: sub str2arrayref {
1.204 albertel 5095: my ($string) = @_;
1.265 albertel 5096: my @array;
5097:
5098: if($string !~ /^__ARRAY_REF__/) {
5099: if (! ($string eq '' || !defined($string))) {
5100: $array[0]='Array reference error';
5101: }
5102: return (\@array, $string);
5103: }
5104:
5105: $string =~ s/^__ARRAY_REF__//;
5106:
5107: while($string !~ /^__END_ARRAY_REF__/) {
5108: my $value='';
5109: if($string =~ /^__HASH_REF__/) {
5110: ($value, $string)=&str2hashref($string);
5111: if(defined($value->{'error'})) {
5112: $array[0] ='Array reference error';
5113: return (\@array, $string);
5114: }
5115: } elsif($string =~ /^__ARRAY_REF__/) {
5116: ($value, $string)=&str2arrayref($string);
5117: if($value->[0] eq 'Array reference error') {
5118: $array[0] ='Array reference error';
5119: return (\@array, $string);
5120: }
5121: } else {
5122: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5123: }
5124: $string =~ s/^&//;
5125:
5126: push(@array, $value);
1.191 harris41 5127: }
1.265 albertel 5128:
5129: $string =~ s/^__END_ARRAY_REF__//;
5130:
5131: return (\@array, $string);
1.168 albertel 5132: }
5133:
1.167 albertel 5134: # -------------------------------------------------------------------Temp Store
5135:
1.168 albertel 5136: sub tmpreset {
5137: my ($symb,$namespace,$domain,$stuname) = @_;
5138: if (!$symb) {
5139: $symb=&symbread();
1.620 albertel 5140: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5141: }
5142: $symb=escape($symb);
5143:
1.620 albertel 5144: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 5145: $namespace=~s/\//\_/g;
5146: $namespace=~s/\W//g;
5147:
1.620 albertel 5148: if (!$domain) { $domain=$env{'user.domain'}; }
5149: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5150: if ($domain eq 'public' && $stuname eq 'public') {
5151: $stuname=$ENV{'REMOTE_ADDR'};
5152: }
1.1117 foxr 5153: my $path=LONCAPA::tempdir();
1.168 albertel 5154: my %hash;
5155: if (tie(%hash,'GDBM_File',
5156: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5157: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 5158: foreach my $key (keys(%hash)) {
1.180 albertel 5159: if ($key=~ /:$symb/) {
1.168 albertel 5160: delete($hash{$key});
5161: }
5162: }
5163: }
5164: }
5165:
1.167 albertel 5166: sub tmpstore {
1.168 albertel 5167: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5168:
5169: if (!$symb) {
5170: $symb=&symbread();
1.620 albertel 5171: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5172: }
5173: $symb=escape($symb);
5174:
5175: if (!$namespace) {
5176: # I don't think we would ever want to store this for a course.
5177: # it seems this will only be used if we don't have a course.
1.620 albertel 5178: #$namespace=$env{'request.course.id'};
1.168 albertel 5179: #if (!$namespace) {
1.620 albertel 5180: $namespace=$env{'request.state'};
1.168 albertel 5181: #}
5182: }
5183: $namespace=~s/\//\_/g;
5184: $namespace=~s/\W//g;
1.620 albertel 5185: if (!$domain) { $domain=$env{'user.domain'}; }
5186: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5187: if ($domain eq 'public' && $stuname eq 'public') {
5188: $stuname=$ENV{'REMOTE_ADDR'};
5189: }
1.168 albertel 5190: my $now=time;
5191: my %hash;
1.1117 foxr 5192: my $path=LONCAPA::tempdir();
1.168 albertel 5193: if (tie(%hash,'GDBM_File',
5194: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5195: &GDBM_WRCREAT(),0640)) {
1.168 albertel 5196: $hash{"version:$symb"}++;
5197: my $version=$hash{"version:$symb"};
5198: my $allkeys='';
5199: foreach my $key (keys(%$storehash)) {
5200: $allkeys.=$key.':';
1.591 albertel 5201: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 5202: }
5203: $hash{"$version:$symb:timestamp"}=$now;
5204: $allkeys.='timestamp';
5205: $hash{"$version:keys:$symb"}=$allkeys;
5206: if (untie(%hash)) {
5207: return 'ok';
5208: } else {
5209: return "error:$!";
5210: }
5211: } else {
5212: return "error:$!";
5213: }
5214: }
1.167 albertel 5215:
1.168 albertel 5216: # -----------------------------------------------------------------Temp Restore
1.167 albertel 5217:
1.168 albertel 5218: sub tmprestore {
5219: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 5220:
1.168 albertel 5221: if (!$symb) {
5222: $symb=&symbread();
1.620 albertel 5223: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5224: }
5225: $symb=escape($symb);
5226:
1.620 albertel 5227: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 5228:
1.620 albertel 5229: if (!$domain) { $domain=$env{'user.domain'}; }
5230: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5231: if ($domain eq 'public' && $stuname eq 'public') {
5232: $stuname=$ENV{'REMOTE_ADDR'};
5233: }
1.168 albertel 5234: my %returnhash;
5235: $namespace=~s/\//\_/g;
5236: $namespace=~s/\W//g;
5237: my %hash;
1.1117 foxr 5238: my $path=LONCAPA::tempdir();
1.168 albertel 5239: if (tie(%hash,'GDBM_File',
5240: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5241: &GDBM_READER(),0640)) {
1.168 albertel 5242: my $version=$hash{"version:$symb"};
5243: $returnhash{'version'}=$version;
5244: my $scope;
5245: for ($scope=1;$scope<=$version;$scope++) {
5246: my $vkeys=$hash{"$scope:keys:$symb"};
5247: my @keys=split(/:/,$vkeys);
5248: my $key;
5249: $returnhash{"$scope:keys"}=$vkeys;
5250: foreach $key (@keys) {
1.591 albertel 5251: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5252: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 5253: }
5254: }
1.168 albertel 5255: if (!(untie(%hash))) {
5256: return "error:$!";
5257: }
5258: } else {
5259: return "error:$!";
5260: }
5261: return %returnhash;
1.167 albertel 5262: }
5263:
1.9 www 5264: # ----------------------------------------------------------------------- Store
5265:
5266: sub store {
1.1172.2.64 raeburn 5267: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5268: my $home='';
5269:
1.168 albertel 5270: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5271:
1.213 www 5272: $symb=&symbclean($symb);
1.122 albertel 5273: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5274:
1.620 albertel 5275: if (!$domain) { $domain=$env{'user.domain'}; }
5276: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5277:
5278: &devalidate($symb,$stuname,$domain);
1.109 www 5279:
5280: $symb=escape($symb);
1.187 www 5281: if (!$namespace) {
1.620 albertel 5282: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5283: return '';
5284: }
5285: }
1.620 albertel 5286: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5287:
5288: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5289: $$storehash{'host'}=$perlvar{'lonHostID'};
5290:
1.12 www 5291: my $namevalue='';
1.800 albertel 5292: foreach my $key (keys(%$storehash)) {
5293: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5294: }
1.12 www 5295: $namevalue=~s/\&$//;
1.187 www 5296: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1172.2.64 raeburn 5297: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 5298: }
5299:
1.47 www 5300: # -------------------------------------------------------------- Critical Store
5301:
5302: sub cstore {
1.1172.2.64 raeburn 5303: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5304: my $home='';
5305:
1.168 albertel 5306: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5307:
1.213 www 5308: $symb=&symbclean($symb);
1.122 albertel 5309: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5310:
1.620 albertel 5311: if (!$domain) { $domain=$env{'user.domain'}; }
5312: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5313:
5314: &devalidate($symb,$stuname,$domain);
1.109 www 5315:
5316: $symb=escape($symb);
1.187 www 5317: if (!$namespace) {
1.620 albertel 5318: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5319: return '';
5320: }
5321: }
1.620 albertel 5322: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5323:
5324: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5325: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 5326:
1.47 www 5327: my $namevalue='';
1.800 albertel 5328: foreach my $key (keys(%$storehash)) {
5329: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5330: }
1.47 www 5331: $namevalue=~s/\&$//;
1.187 www 5332: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 5333: return critical
1.1172.2.64 raeburn 5334: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 5335: }
5336:
1.9 www 5337: # --------------------------------------------------------------------- Restore
5338:
5339: sub restore {
1.124 www 5340: my ($symb,$namespace,$domain,$stuname) = @_;
5341: my $home='';
5342:
1.168 albertel 5343: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5344:
1.122 albertel 5345: if (!$symb) {
1.1172.2.26 raeburn 5346: return if ($namespace eq 'courserequests');
5347: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 5348: } else {
1.1172.2.26 raeburn 5349: unless ($namespace eq 'courserequests') {
5350: $symb=&escape(&symbclean($symb));
5351: }
1.122 albertel 5352: }
1.188 www 5353: if (!$namespace) {
1.620 albertel 5354: unless ($namespace=$env{'request.course.id'}) {
1.188 www 5355: return '';
5356: }
5357: }
1.620 albertel 5358: if (!$domain) { $domain=$env{'user.domain'}; }
5359: if (!$stuname) { $stuname=$env{'user.name'}; }
5360: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 5361: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5362:
1.12 www 5363: my %returnhash=();
1.800 albertel 5364: foreach my $line (split(/\&/,$answer)) {
5365: my ($name,$value)=split(/\=/,$line);
1.591 albertel 5366: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 5367: }
1.75 www 5368: my $version;
5369: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 5370: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5371: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 5372: }
1.75 www 5373: }
1.13 www 5374: return %returnhash;
1.34 www 5375: }
5376:
5377: # ---------------------------------------------------------- Course Description
1.1118 foxr 5378: #
5379: #
1.34 www 5380:
5381: sub coursedescription {
1.731 albertel 5382: my ($courseid,$args)=@_;
1.34 www 5383: $courseid=~s/^\///;
1.49 www 5384: $courseid=~s/\_/\//g;
1.34 www 5385: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 5386: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 5387: my $normalid=$cdomain.'_'.$cnum;
5388: # need to always cache even if we get errors otherwise we keep
5389: # trying and trying and trying to get the course description.
5390: my %envhash=();
5391: my %returnhash=();
1.731 albertel 5392:
5393: my $expiretime=600;
5394: if ($env{'request.course.id'} eq $normalid) {
5395: $expiretime=120;
5396: }
5397:
5398: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5399: if (!$args->{'freshen_cache'}
5400: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5401: foreach my $key (keys(%env)) {
5402: next if ($key !~ /^\Q$prefix\E(.*)/);
5403: my ($setting) = $1;
5404: $returnhash{$setting} = $env{$key};
5405: }
5406: return %returnhash;
5407: }
5408:
1.1118 foxr 5409: # get the data again
5410:
1.731 albertel 5411: if (!$args->{'one_time'}) {
5412: $envhash{'course.'.$normalid.'.last_cache'}=time;
5413: }
1.811 albertel 5414:
1.34 www 5415: if ($chome ne 'no_host') {
1.302 albertel 5416: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 5417: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 5418: my $username = $env{'user.name'}; # Defult username
5419: if(defined $args->{'user'}) {
5420: $username = $args->{'user'};
5421: }
1.129 albertel 5422: $returnhash{'home'}= $chome;
5423: $returnhash{'domain'} = $cdomain;
5424: $returnhash{'num'} = $cnum;
1.741 raeburn 5425: if (!defined($returnhash{'type'})) {
5426: $returnhash{'type'} = 'Course';
5427: }
1.130 albertel 5428: while (my ($name,$value) = each %returnhash) {
1.53 www 5429: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 5430: }
1.270 www 5431: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 5432: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 5433: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 5434: $envhash{'course.'.$normalid.'.home'}=$chome;
5435: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5436: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 5437: }
5438: }
1.731 albertel 5439: if (!$args->{'one_time'}) {
1.949 raeburn 5440: &appenv(\%envhash);
1.731 albertel 5441: }
1.302 albertel 5442: return %returnhash;
1.461 www 5443: }
5444:
1.1080 raeburn 5445: sub update_released_required {
5446: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5447: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5448: $cid = $env{'request.course.id'};
5449: $cdom = $env{'course.'.$cid.'.domain'};
5450: $cnum = $env{'course.'.$cid.'.num'};
5451: $chome = $env{'course.'.$cid.'.home'};
5452: }
5453: if ($needsrelease) {
5454: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5455: my $needsupdate;
5456: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5457: $needsupdate = 1;
5458: } else {
5459: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5460: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5461: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5462: $needsupdate = 1;
5463: }
5464: }
5465: if ($needsupdate) {
5466: my %needshash = (
5467: 'internal.releaserequired' => $needsrelease,
5468: );
5469: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5470: if ($putresult eq 'ok') {
5471: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5472: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5473: if (ref($crsinfo{$cid}) eq 'HASH') {
5474: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5475: &courseidput($cdom,\%crsinfo,$chome,'notime');
5476: }
5477: }
5478: }
5479: }
5480: return;
5481: }
5482:
1.461 www 5483: # -------------------------------------------------See if a user is privileged
5484:
5485: sub privileged {
1.1172.2.23 raeburn 5486: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 5487: my $now = time;
1.1172.2.23 raeburn 5488: my $roles;
5489: if (ref($possroles) eq 'ARRAY') {
5490: $roles = $possroles;
5491: } else {
5492: $roles = ['dc','su'];
5493: }
5494: if (ref($possdomains) eq 'ARRAY') {
5495: my %privileged = &privileged_by_domain($possdomains,$roles);
5496: foreach my $dom (@{$possdomains}) {
5497: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5498: (ref($privileged{$dom}) eq 'HASH')) {
5499: foreach my $role (@{$roles}) {
5500: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5501: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5502: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5503: return 1 unless (($end && $end < $now) ||
5504: ($start && $start > $now));
5505: }
5506: }
5507: }
5508: }
5509: }
5510: } else {
5511: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5512: my $now = time;
1.1170 droeschl 5513:
1.1172.2.58 raeburn 5514: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 5515: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1172.2.23 raeburn 5516: if (grep(/^\Q$trole\E$/,@{$roles})) {
5517: return 1 unless ($tend && $tend < $now)
5518: or ($tstart && $tstart > $now);
1.1170 droeschl 5519: }
1.1172.2.23 raeburn 5520: }
5521: }
1.461 www 5522: return 0;
1.9 www 5523: }
1.1 albertel 5524:
1.1172.2.23 raeburn 5525: sub privileged_by_domain {
5526: my ($domains,$roles) = @_;
5527: my %privileged = ();
5528: my $cachetime = 60*60*24;
5529: my $now = time;
5530: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5531: return %privileged;
5532: }
5533: foreach my $dom (@{$domains}) {
5534: next if (ref($privileged{$dom}) eq 'HASH');
5535: my $needroles;
5536: foreach my $role (@{$roles}) {
5537: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5538: if (defined($cached)) {
5539: if (ref($result) eq 'HASH') {
5540: $privileged{$dom}{$role} = $result;
5541: }
5542: } else {
5543: $needroles = 1;
5544: }
5545: }
5546: if ($needroles) {
5547: my %dompersonnel = &get_domain_roles($dom,$roles);
5548: $privileged{$dom} = {};
5549: foreach my $server (keys(%dompersonnel)) {
5550: if (ref($dompersonnel{$server}) eq 'HASH') {
5551: foreach my $item (keys(%{$dompersonnel{$server}})) {
5552: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5553: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5554: next if ($end && $end < $now);
5555: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5556: $dompersonnel{$server}{$item};
5557: }
5558: }
5559: }
5560: if (ref($privileged{$dom}) eq 'HASH') {
5561: foreach my $role (@{$roles}) {
5562: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5563: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5564: } else {
5565: my %hash = ();
5566: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5567: }
5568: }
5569: }
5570: }
5571: }
5572: return %privileged;
5573: }
5574:
1.103 harris41 5575: # -------------------------------------------------------- Get user privileges
1.11 www 5576:
5577: sub rolesinit {
1.1169 droeschl 5578: my ($domain, $username) = @_;
5579: my %userroles = ('user.login.time' => time);
5580: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5581:
5582: # firstaccess and timerinterval are related to timed maps/resources.
5583: # also, blocking can be triggered by an activating timer
5584: # it's saved in the user's %env.
5585: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5586: my %timerinterval = &dump('timerinterval', $domain, $username);
5587: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5588: %timerintchk, %timerintenv);
5589:
1.1162 raeburn 5590: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 5591: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 5592: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5593: }
1.1169 droeschl 5594:
1.1162 raeburn 5595: foreach my $key (keys(%timerinterval)) {
5596: my ($cid,$rest) = split(/\0/,$key);
5597: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5598: }
1.1169 droeschl 5599:
1.11 www 5600: my %allroles=();
1.1162 raeburn 5601: my %allgroups=();
1.11 www 5602:
1.1172.2.58 raeburn 5603: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 5604: my $role = $rolesdump{$area};
5605: $area =~ s/\_\w\w$//;
5606:
5607: my ($trole, $tend, $tstart, $group_privs);
5608:
5609: if ($role =~ /^cr/) {
5610: # Custom role, defined by a user
5611: # e.g., user.role.cr/msu/smith/mynewrole
5612: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5613: $trole = $1;
5614: ($tend, $tstart) = split('_', $2);
5615: } else {
5616: $trole = $role;
5617: }
5618: } elsif ($role =~ m|^gr/|) {
5619: # Role of member in a group, defined within a course/community
5620: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5621: ($trole, $tend, $tstart) = split(/_/, $role);
5622: next if $tstart eq '-1';
5623: ($trole, $group_privs) = split(/\//, $trole);
5624: $group_privs = &unescape($group_privs);
5625: } else {
5626: # Just a normal role, defined in roles.tab
5627: ($trole, $tend, $tstart) = split(/_/,$role);
5628: }
5629:
5630: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5631: $username);
5632: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5633:
5634: # role expired or not available yet?
5635: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5636: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5637:
5638: next if $area eq '' or $trole eq '';
5639:
5640: my $spec = "$trole.$area";
5641: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5642:
5643: if ($trole =~ /^cr\//) {
5644: # Custom role, defined by a user
5645: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5646: } elsif ($trole eq 'gr') {
5647: # Role of a member in a group, defined within a course/community
5648: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5649: next;
5650: } else {
5651: # Normal role, defined in roles.tab
5652: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5653: }
5654:
5655: my $cid = $tdomain.'_'.$trest;
5656: unless ($firstaccchk{$cid}) {
5657: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5658: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5659: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5660: $coursetimerstarts{$cid}{$item};
5661: }
5662: }
5663: $firstaccchk{$cid} = 1;
5664: }
5665: unless ($timerintchk{$cid}) {
5666: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5667: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5668: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5669: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 5670: }
1.12 www 5671: }
1.1169 droeschl 5672: $timerintchk{$cid} = 1;
1.191 harris41 5673: }
1.11 www 5674: }
1.1169 droeschl 5675:
5676: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
5677: \%allroles, \%allgroups);
5678: $env{'user.adv'} = $userroles{'user.adv'};
5679:
1.1162 raeburn 5680: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 5681: }
5682:
1.567 raeburn 5683: sub set_arearole {
1.1172.2.19 raeburn 5684: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5685: unless ($nolog) {
1.567 raeburn 5686: # log the associated role with the area
1.1172.2.19 raeburn 5687: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5688: }
1.743 albertel 5689: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 5690: }
5691:
5692: sub custom_roleprivs {
5693: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5694: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1172.2.40 raeburn 5695: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 5696: if (&hostname($homsvr) ne '') {
1.567 raeburn 5697: my ($rdummy,$roledef)=
5698: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5699: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5700: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5701: if (defined($syspriv)) {
1.1043 raeburn 5702: if ($trest =~ /^$match_community$/) {
5703: $syspriv =~ s/bre\&S//;
5704: }
1.567 raeburn 5705: $$allroles{'cm./'}.=':'.$syspriv;
5706: $$allroles{$spec.'./'}.=':'.$syspriv;
5707: }
5708: if ($tdomain ne '') {
5709: if (defined($dompriv)) {
5710: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5711: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5712: }
5713: if (($trest ne '') && (defined($coursepriv))) {
1.1172.2.89 raeburn 5714: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
5715: my $rolename = $1;
5716: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
5717: }
1.567 raeburn 5718: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5719: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5720: }
5721: }
5722: }
5723: }
5724: }
5725:
1.1172.2.89 raeburn 5726: sub course_adhocrole_privs {
5727: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
5728: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
5729: if ($overrides{"internal.adhocpriv.$rolename"}) {
5730: my (%currprivs,%storeprivs);
5731: foreach my $item (split(/:/,$coursepriv)) {
5732: my ($priv,$restrict) = split(/\&/,$item);
5733: $currprivs{$priv} = $restrict;
5734: }
5735: my (%possadd,%possremove,%full);
5736: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
5737: my ($priv,$restrict)=split(/\&/,$item);
5738: $full{$priv} = $restrict;
5739: }
5740: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
5741: next if ($item eq '');
5742: my ($rule,$rest) = split(/=/,$item);
5743: next unless (($rule eq 'off') || ($rule eq 'on'));
5744: foreach my $priv (split(/:/,$rest)) {
5745: if ($priv ne '') {
5746: if ($rule eq 'off') {
5747: $possremove{$priv} = 1;
5748: } else {
5749: $possadd{$priv} = 1;
5750: }
5751: }
5752: }
5753: }
5754: foreach my $priv (sort(keys(%full))) {
5755: if (exists($currprivs{$priv})) {
5756: unless (exists($possremove{$priv})) {
5757: $storeprivs{$priv} = $currprivs{$priv};
5758: }
5759: } elsif (exists($possadd{$priv})) {
5760: $storeprivs{$priv} = $full{$priv};
5761: }
5762: }
5763: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
5764: }
5765: return $coursepriv;
5766: }
5767:
1.678 raeburn 5768: sub group_roleprivs {
5769: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5770: my $access = 1;
5771: my $now = time;
5772: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5773: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5774: if ($access) {
1.811 albertel 5775: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 5776: $$allgroups{$course}{$group} .=':'.$group_privs;
5777: }
5778: }
1.567 raeburn 5779:
5780: sub standard_roleprivs {
5781: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5782: if (defined($pr{$trole.':s'})) {
5783: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5784: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5785: }
5786: if ($tdomain ne '') {
5787: if (defined($pr{$trole.':d'})) {
5788: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5789: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5790: }
5791: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5792: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5793: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5794: }
5795: }
5796: }
5797:
5798: sub set_userprivs {
1.1064 raeburn 5799: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 5800: my $author=0;
5801: my $adv=0;
1.678 raeburn 5802: my %grouproles = ();
5803: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 5804: my @groupkeys;
1.1000 raeburn 5805: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 5806: push(@groupkeys,$role);
5807: }
5808: if (ref($groups_roles) eq 'HASH') {
5809: foreach my $key (keys(%{$groups_roles})) {
5810: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5811: push(@groupkeys,$key);
5812: }
5813: }
5814: }
5815: if (@groupkeys > 0) {
5816: foreach my $role (@groupkeys) {
5817: my ($trole,$area,$sec,$extendedarea);
5818: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5819: $trole = $1;
5820: $area = $2;
5821: $sec = $3;
5822: $extendedarea = $area.$sec;
5823: if (exists($$allgroups{$area})) {
5824: foreach my $group (keys(%{$$allgroups{$area}})) {
5825: my $spec = $trole.'.'.$extendedarea;
5826: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 5827: $$allgroups{$area}{$group};
1.1064 raeburn 5828: }
1.678 raeburn 5829: }
5830: }
5831: }
5832: }
5833: }
1.800 albertel 5834: foreach my $group (keys(%grouproles)) {
5835: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 5836: }
1.800 albertel 5837: foreach my $role (keys(%{$allroles})) {
5838: my %thesepriv;
1.941 raeburn 5839: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 5840: foreach my $item (split(/:/,$$allroles{$role})) {
5841: if ($item ne '') {
5842: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 5843: if ($restrictions eq '') {
5844: $thesepriv{$privilege}='F';
5845: } elsif ($thesepriv{$privilege} ne 'F') {
5846: $thesepriv{$privilege}.=$restrictions;
5847: }
5848: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
5849: }
5850: }
5851: my $thesestr='';
1.1104 raeburn 5852: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 5853: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5854: }
5855: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 5856: }
5857: return ($author,$adv);
5858: }
5859:
1.994 raeburn 5860: sub role_status {
1.1104 raeburn 5861: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 5862: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1172.2.40 raeburn 5863: my ($one,$two) = split(m{\./},$rolekey,2);
5864: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 5865: unless (!defined($$role) || $$role eq '') {
1.1172.2.40 raeburn 5866: $$where = '/'.$two;
1.994 raeburn 5867: $$trolecode=$$role.'.'.$$where;
5868: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5869: $$tstatus='is';
1.1104 raeburn 5870: if ($$tstart && $$tstart>$update) {
1.994 raeburn 5871: $$tstatus='future';
1.1034 raeburn 5872: if ($$tstart<$now) {
5873: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 5874: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 5875: my (%allroles,%allgroups,$group_privs,
5876: %groups_roles,@rolecodes);
1.1002 raeburn 5877: my %userroles = (
5878: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5879: );
1.1064 raeburn 5880: @rolecodes = ('cm');
1.1002 raeburn 5881: my $spec=$$role.'.'.$$where;
5882: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5883: if ($$role =~ /^cr\//) {
5884: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 5885: push(@rolecodes,'cr');
1.1002 raeburn 5886: } elsif ($$role eq 'gr') {
1.1064 raeburn 5887: push(@rolecodes,$$role);
1.1002 raeburn 5888: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5889: $env{'user.name'});
1.1064 raeburn 5890: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 5891: (undef,my $group_privs) = split(/\//,$trole);
5892: $group_privs = &unescape($group_privs);
5893: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 5894: 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 5895: &get_groups_roles($tdomain,$trest,
5896: \%course_roles,\@rolecodes,
5897: \%groups_roles);
1.1002 raeburn 5898: } else {
1.1064 raeburn 5899: push(@rolecodes,$$role);
1.1002 raeburn 5900: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5901: }
1.1064 raeburn 5902: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
5903: &appenv(\%userroles,\@rolecodes);
1.1002 raeburn 5904: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5905: }
5906: }
1.1034 raeburn 5907: $$tstatus = 'is';
1.1002 raeburn 5908: }
1.994 raeburn 5909: }
5910: if ($$tend) {
1.1104 raeburn 5911: if ($$tend<$update) {
1.994 raeburn 5912: $$tstatus='expired';
5913: } elsif ($$tend<$now) {
5914: $$tstatus='will_not';
5915: }
5916: }
5917: }
5918: }
5919: }
5920:
1.1104 raeburn 5921: sub get_groups_roles {
5922: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5923: return unless((ref($cdom_courseroles) eq 'HASH') &&
5924: (ref($rolecodes) eq 'ARRAY') &&
5925: (ref($groups_roles) eq 'HASH'));
5926: if (keys(%{$cdom_courseroles}) > 0) {
5927: my ($cnum) = ($rest =~ /^($match_courseid)/);
5928: if ($cdom ne '' && $cnum ne '') {
5929: foreach my $key (keys(%{$cdom_courseroles})) {
5930: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5931: my $crsrole = $1;
5932: my $crssec = $2;
5933: if ($crsrole =~ /^cr/) {
5934: unless (grep(/^cr$/,@{$rolecodes})) {
5935: push(@{$rolecodes},'cr');
5936: }
5937: } else {
5938: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5939: push(@{$rolecodes},$crsrole);
5940: }
5941: }
5942: my $rolekey = "$crsrole./$cdom/$cnum";
5943: if ($crssec ne '') {
5944: $rolekey .= "/$crssec";
5945: }
5946: $rolekey .= './';
5947: $groups_roles->{$rolekey} = $rolecodes;
5948: }
5949: }
5950: }
5951: }
5952: return;
5953: }
5954:
5955: sub delete_env_groupprivs {
5956: my ($where,$courseroles,$possroles) = @_;
5957: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5958: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5959: unless (ref($courseroles->{$udom}) eq 'HASH') {
5960: %{$courseroles->{$udom}} =
5961: &get_my_roles('','','userroles',['active'],
5962: $possroles,[$udom],1);
5963: }
5964: if (ref($courseroles->{$udom}) eq 'HASH') {
5965: foreach my $item (keys(%{$courseroles->{$udom}})) {
5966: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5967: my $area = '/'.$cdom.'/'.$cnum;
5968: my $privkey = "user.priv.$crsrole.$area";
5969: if ($crssec ne '') {
5970: $privkey .= '/'.$crssec;
5971: }
5972: $privkey .= ".$area/$group";
5973: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5974: }
5975: }
5976: return;
5977: }
5978:
1.994 raeburn 5979: sub check_adhoc_privs {
1.1172.2.86 raeburn 5980: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 5981: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1172.2.86 raeburn 5982: if ($sec) {
5983: $cckey .= '/'.$sec;
5984: }
1.1172.2.9 raeburn 5985: my $setprivs;
1.994 raeburn 5986: if ($env{$cckey}) {
5987: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 5988: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 5989: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1172.2.86 raeburn 5990: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1172.2.9 raeburn 5991: $setprivs = 1;
1.994 raeburn 5992: }
5993: } else {
1.1172.2.87 raeburn 5994: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1172.2.9 raeburn 5995: $setprivs = 1;
1.994 raeburn 5996: }
1.1172.2.9 raeburn 5997: return $setprivs;
1.994 raeburn 5998: }
5999:
6000: sub set_adhoc_privileges {
1.1172.2.84 raeburn 6001: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1172.2.86 raeburn 6002: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 6003: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1172.2.86 raeburn 6004: if ($sec ne '') {
6005: $area .= '/'.$sec;
6006: }
1.994 raeburn 6007: my $spec = $role.'.'.$area;
6008: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1172.2.19 raeburn 6009: $env{'user.name'},1);
1.1172.2.84 raeburn 6010: my %rolehash = ();
1.1172.2.89 raeburn 6011: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
6012: my $rolename = $1;
1.1172.2.84 raeburn 6013: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1172.2.89 raeburn 6014: my %domdef = &get_domain_defaults($dcdom);
6015: if (ref($domdef{'adhocroles'}) eq 'HASH') {
6016: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
6017: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
6018: }
6019: }
1.1172.2.84 raeburn 6020: } else {
6021: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
6022: }
6023: my ($author,$adv)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 6024: &appenv(\%userroles,[$role,'cm']);
6025: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
1.1088 raeburn 6026: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
6027: &appenv( {'request.role' => $spec,
6028: 'request.role.domain' => $dcdom,
1.1172.2.89 raeburn 6029: 'request.course.sec' => $sec,
1.1088 raeburn 6030: }
6031: );
6032: my $tadv=0;
6033: if (&allowed('adv') eq 'F') { $tadv=1; }
6034: &appenv({'request.role.adv' => $tadv});
6035: }
1.994 raeburn 6036: }
6037:
1.12 www 6038: # --------------------------------------------------------------- get interface
6039:
6040: sub get {
1.131 albertel 6041: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6042: my $items='';
1.800 albertel 6043: foreach my $item (@$storearr) {
6044: $items.=&escape($item).'&';
1.191 harris41 6045: }
1.12 www 6046: $items=~s/\&$//;
1.620 albertel 6047: if (!$udomain) { $udomain=$env{'user.domain'}; }
6048: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 6049: my $uhome=&homeserver($uname,$udomain);
6050:
1.133 albertel 6051: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6052: my @pairs=split(/\&/,$rep);
1.273 albertel 6053: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
6054: return @pairs;
6055: }
1.15 www 6056: my %returnhash=();
1.42 www 6057: my $i=0;
1.800 albertel 6058: foreach my $item (@$storearr) {
6059: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6060: $i++;
1.191 harris41 6061: }
1.15 www 6062: return %returnhash;
1.27 www 6063: }
6064:
6065: # --------------------------------------------------------------- del interface
6066:
6067: sub del {
1.133 albertel 6068: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 6069: my $items='';
1.800 albertel 6070: foreach my $item (@$storearr) {
6071: $items.=&escape($item).'&';
1.191 harris41 6072: }
1.984 neumanie 6073:
1.27 www 6074: $items=~s/\&$//;
1.620 albertel 6075: if (!$udomain) { $udomain=$env{'user.domain'}; }
6076: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6077: my $uhome=&homeserver($uname,$udomain);
6078: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6079: }
6080:
6081: # -------------------------------------------------------------- dump interface
6082:
1.1172.2.22 raeburn 6083: sub unserialize {
6084: my ($rep, $escapedkeys) = @_;
6085:
6086: return {} if $rep =~ /^error/;
6087:
6088: my %returnhash=();
6089: foreach my $item (split(/\&/,$rep)) {
6090: my ($key, $value) = split(/=/, $item, 2);
6091: $key = unescape($key) unless $escapedkeys;
6092: next if $key =~ /^error: 2 /;
6093: $returnhash{$key} = &thaw_unescape($value);
6094: }
6095: return \%returnhash;
6096: }
6097:
6098: # see Lond::dump_with_regexp
6099: # if $escapedkeys hash keys won't get unescaped.
1.15 www 6100: sub dump {
1.1172.2.22 raeburn 6101: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755 albertel 6102: if (!$udomain) { $udomain=$env{'user.domain'}; }
6103: if (!$uname) { $uname=$env{'user.name'}; }
6104: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 6105:
1.1172.2.55 raeburn 6106: if ($regexp) {
6107: $regexp=&escape($regexp);
6108: } else {
6109: $regexp='.';
6110: }
1.1172.2.22 raeburn 6111: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
6112: # user is hosted on this machine
1.1172.2.55 raeburn 6113: my $reply = LONCAPA::Lond::dump_with_regexp(join(':', ($udomain,
1.1172.2.27 raeburn 6114: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1172.2.22 raeburn 6115: return %{&unserialize($reply, $escapedkeys)};
6116: }
1.1166 raeburn 6117: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 6118: my @pairs=split(/\&/,$rep);
6119: my %returnhash=();
1.1098 foxr 6120: if (!($rep =~ /^error/ )) {
6121: foreach my $item (@pairs) {
6122: my ($key,$value)=split(/=/,$item,2);
1.1172.2.22 raeburn 6123: $key = &unescape($key) unless ($escapedkeys);
1.1098 foxr 6124: next if ($key =~ /^error: 2 /);
6125: $returnhash{$key}=&thaw_unescape($value);
6126: }
1.755 albertel 6127: }
6128: return %returnhash;
1.407 www 6129: }
6130:
1.1098 foxr 6131:
1.717 albertel 6132: # --------------------------------------------------------- dumpstore interface
6133:
6134: sub dumpstore {
6135: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1172.2.22 raeburn 6136: # same as dump but keys must be escaped. They may contain colon separated
6137: # lists of values that may themself contain colons (e.g. symbs).
6138: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 6139: }
6140:
1.407 www 6141: # -------------------------------------------------------------- keys interface
6142:
6143: sub getkeys {
6144: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 6145: if (!$udomain) { $udomain=$env{'user.domain'}; }
6146: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 6147: my $uhome=&homeserver($uname,$udomain);
6148: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
6149: my @keyarray=();
1.800 albertel 6150: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 6151: next if ($key =~ /^error: 2 /);
1.800 albertel 6152: push(@keyarray,&unescape($key));
1.407 www 6153: }
6154: return @keyarray;
1.318 matthew 6155: }
6156:
1.319 matthew 6157: # --------------------------------------------------------------- currentdump
6158: sub currentdump {
1.328 matthew 6159: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 6160: $courseid = $env{'request.course.id'} if (! defined($courseid));
6161: $sdom = $env{'user.domain'} if (! defined($sdom));
6162: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 6163: my $uhome = &homeserver($sname,$sdom);
1.1172.2.50 raeburn 6164: my $rep;
6165:
6166: if (grep { $_ eq $uhome } current_machine_ids()) {
6167: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
6168: $courseid)));
6169: } else {
6170: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
6171: }
6172:
1.318 matthew 6173: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 6174: #
1.318 matthew 6175: my %returnhash=();
1.319 matthew 6176: #
6177: if ($rep eq "unknown_cmd") {
6178: # an old lond will not know currentdump
6179: # Do a dump and make it look like a currentdump
1.822 albertel 6180: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 6181: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6182: my %hash = @tmp;
6183: @tmp=();
1.424 matthew 6184: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 6185: } else {
6186: my @pairs=split(/\&/,$rep);
1.800 albertel 6187: foreach my $pair (@pairs) {
6188: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 6189: my ($symb,$param) = split(/:/,$key);
6190: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 6191: &thaw_unescape($value);
1.319 matthew 6192: }
1.191 harris41 6193: }
1.12 www 6194: return %returnhash;
1.424 matthew 6195: }
6196:
6197: sub convert_dump_to_currentdump{
6198: my %hash = %{shift()};
6199: my %returnhash;
6200: # Code ripped from lond, essentially. The only difference
6201: # here is the unescaping done by lonnet::dump(). Conceivably
6202: # we might run in to problems with parameter names =~ /^v\./
6203: while (my ($key,$value) = each(%hash)) {
6204: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 6205: $symb = &unescape($symb);
6206: $param = &unescape($param);
1.424 matthew 6207: next if ($v eq 'version' || $symb eq 'keys');
6208: next if (exists($returnhash{$symb}) &&
6209: exists($returnhash{$symb}->{$param}) &&
6210: $returnhash{$symb}->{'v.'.$param} > $v);
6211: $returnhash{$symb}->{$param}=$value;
6212: $returnhash{$symb}->{'v.'.$param}=$v;
6213: }
6214: #
6215: # Remove all of the keys in the hashes which keep track of
6216: # the version of the parameter.
6217: while (my ($symb,$param_hash) = each(%returnhash)) {
6218: # use a foreach because we are going to delete from the hash.
6219: foreach my $key (keys(%$param_hash)) {
6220: delete($param_hash->{$key}) if ($key =~ /^v\./);
6221: }
6222: }
6223: return \%returnhash;
1.12 www 6224: }
6225:
1.627 albertel 6226: # ------------------------------------------------------ critical inc interface
6227:
6228: sub cinc {
6229: return &inc(@_,'critical');
6230: }
6231:
1.449 matthew 6232: # --------------------------------------------------------------- inc interface
6233:
6234: sub inc {
1.627 albertel 6235: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 6236: if (!$udomain) { $udomain=$env{'user.domain'}; }
6237: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 6238: my $uhome=&homeserver($uname,$udomain);
6239: my $items='';
6240: if (! ref($store)) {
6241: # got a single value, so use that instead
6242: $items = &escape($store).'=&';
6243: } elsif (ref($store) eq 'SCALAR') {
6244: $items = &escape($$store).'=&';
6245: } elsif (ref($store) eq 'ARRAY') {
6246: $items = join('=&',map {&escape($_);} @{$store});
6247: } elsif (ref($store) eq 'HASH') {
6248: while (my($key,$value) = each(%{$store})) {
6249: $items.= &escape($key).'='.&escape($value).'&';
6250: }
6251: }
6252: $items=~s/\&$//;
1.627 albertel 6253: if ($critical) {
6254: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6255: } else {
6256: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6257: }
1.449 matthew 6258: }
6259:
1.12 www 6260: # --------------------------------------------------------------- put interface
6261:
6262: sub put {
1.134 albertel 6263: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6264: if (!$udomain) { $udomain=$env{'user.domain'}; }
6265: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6266: my $uhome=&homeserver($uname,$udomain);
1.12 www 6267: my $items='';
1.800 albertel 6268: foreach my $item (keys(%$storehash)) {
6269: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6270: }
1.12 www 6271: $items=~s/\&$//;
1.134 albertel 6272: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 6273: }
6274:
1.631 albertel 6275: # ------------------------------------------------------------ newput interface
6276:
6277: sub newput {
6278: my ($namespace,$storehash,$udomain,$uname)=@_;
6279: if (!$udomain) { $udomain=$env{'user.domain'}; }
6280: if (!$uname) { $uname=$env{'user.name'}; }
6281: my $uhome=&homeserver($uname,$udomain);
6282: my $items='';
6283: foreach my $key (keys(%$storehash)) {
6284: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6285: }
6286: $items=~s/\&$//;
6287: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6288: }
6289:
6290: # --------------------------------------------------------- putstore interface
6291:
1.524 raeburn 6292: sub putstore {
1.1172.2.59 raeburn 6293: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 6294: if (!$udomain) { $udomain=$env{'user.domain'}; }
6295: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 6296: my $uhome=&homeserver($uname,$udomain);
6297: my $items='';
1.715 albertel 6298: foreach my $key (keys(%$storehash)) {
6299: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 6300: }
1.715 albertel 6301: $items=~s/\&$//;
1.716 albertel 6302: my $esc_symb=&escape($symb);
6303: my $esc_v=&escape($version);
1.715 albertel 6304: my $reply =
1.716 albertel 6305: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 6306: $uhome);
1.1172.2.59 raeburn 6307: if (($tolog) && ($reply eq 'ok')) {
6308: my $namevalue='';
6309: foreach my $key (keys(%{$storehash})) {
6310: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6311: }
6312: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6313: '&host='.&escape($perlvar{'lonHostID'}).
6314: '&version='.$esc_v.
6315: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6316: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6317: }
1.715 albertel 6318: if ($reply eq 'unknown_cmd') {
1.716 albertel 6319: # gfall back to way things use to be done
1.715 albertel 6320: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6321: $uname);
1.524 raeburn 6322: }
1.715 albertel 6323: return $reply;
6324: }
6325:
6326: sub old_putstore {
1.716 albertel 6327: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6328: if (!$udomain) { $udomain=$env{'user.domain'}; }
6329: if (!$uname) { $uname=$env{'user.name'}; }
6330: my $uhome=&homeserver($uname,$udomain);
6331: my %newstorehash;
1.800 albertel 6332: foreach my $item (keys(%$storehash)) {
6333: my $key = $version.':'.&escape($symb).':'.$item;
6334: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 6335: }
6336: my $items='';
6337: my %allitems = ();
1.800 albertel 6338: foreach my $item (keys(%newstorehash)) {
6339: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 6340: my $key = $1.':keys:'.$2;
6341: $allitems{$key} .= $3.':';
6342: }
1.800 albertel 6343: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 6344: }
1.800 albertel 6345: foreach my $item (keys(%allitems)) {
6346: $allitems{$item} =~ s/\:$//;
6347: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 6348: }
6349: $items=~s/\&$//;
6350: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 6351: }
6352:
1.47 www 6353: # ------------------------------------------------------ critical put interface
6354:
6355: sub cput {
1.134 albertel 6356: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6357: if (!$udomain) { $udomain=$env{'user.domain'}; }
6358: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6359: my $uhome=&homeserver($uname,$udomain);
1.47 www 6360: my $items='';
1.800 albertel 6361: foreach my $item (keys(%$storehash)) {
6362: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6363: }
1.47 www 6364: $items=~s/\&$//;
1.134 albertel 6365: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6366: }
6367:
6368: # -------------------------------------------------------------- eget interface
6369:
6370: sub eget {
1.133 albertel 6371: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6372: my $items='';
1.800 albertel 6373: foreach my $item (@$storearr) {
6374: $items.=&escape($item).'&';
1.191 harris41 6375: }
1.12 www 6376: $items=~s/\&$//;
1.620 albertel 6377: if (!$udomain) { $udomain=$env{'user.domain'}; }
6378: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6379: my $uhome=&homeserver($uname,$udomain);
6380: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6381: my @pairs=split(/\&/,$rep);
6382: my %returnhash=();
1.42 www 6383: my $i=0;
1.800 albertel 6384: foreach my $item (@$storearr) {
6385: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6386: $i++;
1.191 harris41 6387: }
1.12 www 6388: return %returnhash;
6389: }
6390:
1.667 albertel 6391: # ------------------------------------------------------------ tmpput interface
6392: sub tmpput {
1.802 raeburn 6393: my ($storehash,$server,$context)=@_;
1.667 albertel 6394: my $items='';
1.800 albertel 6395: foreach my $item (keys(%$storehash)) {
6396: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 6397: }
6398: $items=~s/\&$//;
1.802 raeburn 6399: if (defined($context)) {
6400: $items .= ':'.&escape($context);
6401: }
1.667 albertel 6402: return &reply("tmpput:$items",$server);
6403: }
6404:
6405: # ------------------------------------------------------------ tmpget interface
6406: sub tmpget {
1.688 albertel 6407: my ($token,$server)=@_;
6408: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6409: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 6410: my %returnhash;
1.1172.2.85 raeburn 6411: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
6412: return %returnhash;
6413: }
1.667 albertel 6414: foreach my $item (split(/\&/,$rep)) {
6415: my ($key,$value)=split(/=/,$item);
6416: $returnhash{&unescape($key)}=&thaw_unescape($value);
6417: }
6418: return %returnhash;
6419: }
6420:
1.1113 raeburn 6421: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 6422: sub tmpdel {
6423: my ($token,$server)=@_;
6424: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6425: return &reply("tmpdel:$token",$server);
6426: }
6427:
1.1172.2.13 raeburn 6428: # ------------------------------------------------------------ get_timebased_id
6429:
6430: sub get_timebased_id {
6431: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6432: $maxtries) = @_;
6433: my ($newid,$error,$dellock);
6434: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6435: return ('','ok','invalid call to get suffix');
6436: }
6437:
6438: # set defaults for any optional args for which values were not supplied
6439: if ($who eq '') {
6440: $who = $env{'user.name'}.':'.$env{'user.domain'};
6441: }
6442: if (!$locktries) {
6443: $locktries = 3;
6444: }
6445: if (!$maxtries) {
6446: $maxtries = 10;
6447: }
6448:
6449: if (($cdom eq '') || ($cnum eq '')) {
6450: if ($env{'request.course.id'}) {
6451: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6452: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6453: }
6454: if (($cdom eq '') || ($cnum eq '')) {
6455: return ('','ok','call to get suffix not in course context');
6456: }
6457: }
6458:
6459: # construct locking item
6460: my $lockhash = {
6461: $prefix."\0".'locked_'.$keyid => $who,
6462: };
6463: my $tries = 0;
6464:
6465: # attempt to get lock on nohist_$namespace file
6466: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6467: while (($gotlock ne 'ok') && $tries <$locktries) {
6468: $tries ++;
6469: sleep 1;
6470: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6471: }
6472:
6473: # attempt to get unique identifier, based on current timestamp
6474: if ($gotlock eq 'ok') {
6475: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6476: my $id = time;
6477: $newid = $id;
1.1172.2.56 raeburn 6478: if ($idtype eq 'addcode') {
6479: $newid .= &sixnum_code();
6480: }
1.1172.2.13 raeburn 6481: my $idtries = 0;
6482: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6483: if ($idtype eq 'concat') {
6484: $newid = $id.$idtries;
1.1172.2.56 raeburn 6485: } elsif ($idtype eq 'addcode') {
6486: $newid = $newid.&sixnum_code();
1.1172.2.13 raeburn 6487: } else {
6488: $newid ++;
6489: }
6490: $idtries ++;
6491: }
6492: if (!exists($inuse{$prefix."\0".$newid})) {
6493: my %new_item = (
6494: $prefix."\0".$newid => $who,
6495: );
6496: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6497: $cdom,$cnum);
6498: if ($putresult ne 'ok') {
6499: undef($newid);
6500: $error = 'error saving new item: '.$putresult;
6501: }
6502: } else {
1.1172.2.56 raeburn 6503: undef($newid);
1.1172.2.13 raeburn 6504: $error = ('error: no unique suffix available for the new item ');
6505: }
6506: # remove lock
6507: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6508: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6509: } else {
6510: $error = "error: could not obtain lockfile\n";
6511: $dellock = 'ok';
1.1172.2.58 raeburn 6512: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6513: $dellock = 'nolock';
6514: }
1.1172.2.13 raeburn 6515: }
6516: return ($newid,$dellock,$error);
6517: }
6518:
1.1172.2.56 raeburn 6519: sub sixnum_code {
6520: my $code;
6521: for (0..6) {
6522: $code .= int( rand(9) );
6523: }
6524: return $code;
6525: }
6526:
1.765 albertel 6527: # -------------------------------------------------- portfolio access checking
6528:
6529: sub portfolio_access {
1.1172.2.77 raeburn 6530: my ($requrl,$clientip) = @_;
1.765 albertel 6531: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1172.2.77 raeburn 6532: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 6533: if ($result) {
6534: my %setters;
6535: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6536: my ($startblock,$endblock) =
6537: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6538: if ($startblock && $endblock) {
6539: return 'B';
6540: }
6541: } else {
6542: my ($startblock,$endblock) =
6543: &Apache::loncommon::blockcheck(\%setters,'port');
6544: if ($startblock && $endblock) {
6545: return 'B';
6546: }
6547: }
6548: }
1.765 albertel 6549: if ($result eq 'ok') {
1.766 albertel 6550: return 'F';
1.765 albertel 6551: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 6552: return 'A';
1.765 albertel 6553: }
1.766 albertel 6554: return '';
1.765 albertel 6555: }
6556:
6557: sub get_portfolio_access {
1.1172.2.77 raeburn 6558: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 6559:
6560: if (!ref($access_hash)) {
6561: my $current_perms = &get_portfile_permissions($udom,$unum);
6562: my %access_controls = &get_access_controls($current_perms,$group,
6563: $file_name);
6564: $access_hash = $access_controls{$file_name};
6565: }
6566:
1.1172.2.77 raeburn 6567: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 6568: my $now = time;
6569: if (ref($access_hash) eq 'HASH') {
6570: foreach my $key (keys(%{$access_hash})) {
6571: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6572: if ($start > $now) {
6573: next;
6574: }
6575: if ($end && $end<$now) {
6576: next;
6577: }
6578: if ($scope eq 'public') {
6579: $public = $key;
6580: last;
6581: } elsif ($scope eq 'guest') {
6582: $guest = $key;
6583: } elsif ($scope eq 'domains') {
6584: push(@domains,$key);
6585: } elsif ($scope eq 'users') {
6586: push(@users,$key);
6587: } elsif ($scope eq 'course') {
6588: push(@courses,$key);
6589: } elsif ($scope eq 'group') {
6590: push(@groups,$key);
1.1172.2.77 raeburn 6591: } elsif ($scope eq 'ip') {
6592: push(@ips,$key);
1.765 albertel 6593: }
6594: }
6595: if ($public) {
6596: return 'ok';
1.1172.2.77 raeburn 6597: } elsif (@ips > 0) {
6598: my $allowed;
6599: foreach my $ipkey (@ips) {
6600: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6601: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6602: $allowed = 1;
6603: last;
6604: }
6605: }
6606: }
6607: if ($allowed) {
6608: return 'ok';
6609: }
1.765 albertel 6610: }
6611: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6612: if ($guest) {
6613: return $guest;
6614: }
6615: } else {
6616: if (@domains > 0) {
6617: foreach my $domkey (@domains) {
6618: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6619: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6620: return 'ok';
6621: }
6622: }
6623: }
6624: }
6625: if (@users > 0) {
6626: foreach my $userkey (@users) {
1.865 raeburn 6627: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6628: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6629: if (ref($item) eq 'HASH') {
6630: if (($item->{'uname'} eq $env{'user.name'}) &&
6631: ($item->{'udom'} eq $env{'user.domain'})) {
6632: return 'ok';
6633: }
6634: }
6635: }
6636: }
1.765 albertel 6637: }
6638: }
6639: my %roleshash;
6640: my @courses_and_groups = @courses;
6641: push(@courses_and_groups,@groups);
6642: if (@courses_and_groups > 0) {
6643: my (%allgroups,%allroles);
6644: my ($start,$end,$role,$sec,$group);
6645: foreach my $envkey (%env) {
1.1060 raeburn 6646: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6647: my $cid = $2.'_'.$3;
6648: if ($1 eq 'gr') {
6649: $group = $4;
6650: $allgroups{$cid}{$group} = $env{$envkey};
6651: } else {
6652: if ($4 eq '') {
6653: $sec = 'none';
6654: } else {
6655: $sec = $4;
6656: }
6657: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6658: }
1.811 albertel 6659: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6660: my $cid = $2.'_'.$3;
6661: if ($4 eq '') {
6662: $sec = 'none';
6663: } else {
6664: $sec = $4;
6665: }
6666: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6667: }
6668: }
6669: if (keys(%allroles) == 0) {
6670: return;
6671: }
6672: foreach my $key (@courses_and_groups) {
6673: my %content = %{$$access_hash{$key}};
6674: my $cnum = $content{'number'};
6675: my $cdom = $content{'domain'};
6676: my $cid = $cdom.'_'.$cnum;
6677: if (!exists($allroles{$cid})) {
6678: next;
6679: }
6680: foreach my $role_id (keys(%{$content{'roles'}})) {
6681: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6682: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6683: my @status = @{$content{'roles'}{$role_id}{'access'}};
6684: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6685: foreach my $role (keys(%{$allroles{$cid}})) {
6686: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6687: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6688: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6689: if (grep/^all$/,@sections) {
6690: return 'ok';
6691: } else {
6692: if (grep/^$sec$/,@sections) {
6693: return 'ok';
6694: }
6695: }
6696: }
6697: }
6698: if (keys(%{$allgroups{$cid}}) == 0) {
6699: if (grep/^none$/,@groups) {
6700: return 'ok';
6701: }
6702: } else {
6703: if (grep/^all$/,@groups) {
6704: return 'ok';
6705: }
6706: foreach my $group (keys(%{$allgroups{$cid}})) {
6707: if (grep/^$group$/,@groups) {
6708: return 'ok';
6709: }
6710: }
6711: }
6712: }
6713: }
6714: }
6715: }
6716: }
6717: if ($guest) {
6718: return $guest;
6719: }
6720: }
6721: }
6722: return;
6723: }
6724:
6725: sub course_group_datechecker {
6726: my ($dates,$now,$status) = @_;
6727: my ($start,$end) = split(/\./,$dates);
6728: if (!$start && !$end) {
6729: return 'ok';
6730: }
6731: if (grep/^active$/,@{$status}) {
6732: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6733: return 'ok';
6734: }
6735: }
6736: if (grep/^previous$/,@{$status}) {
6737: if ($end > $now ) {
6738: return 'ok';
6739: }
6740: }
6741: if (grep/^future$/,@{$status}) {
6742: if ($start > $now) {
6743: return 'ok';
6744: }
6745: }
6746: return;
6747: }
6748:
6749: sub parse_portfolio_url {
6750: my ($url) = @_;
6751:
6752: my ($type,$udom,$unum,$group,$file_name);
6753:
1.823 albertel 6754: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 6755: $type = 1;
6756: $udom = $1;
6757: $unum = $2;
6758: $file_name = $3;
1.823 albertel 6759: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 6760: $type = 2;
6761: $udom = $1;
6762: $unum = $2;
6763: $group = $3;
6764: $file_name = $3.'/'.$4;
6765: }
6766: if (wantarray) {
6767: return ($type,$udom,$unum,$file_name,$group);
6768: }
6769: return $type;
6770: }
6771:
6772: sub is_portfolio_url {
6773: my ($url) = @_;
6774: return scalar(&parse_portfolio_url($url));
6775: }
6776:
1.798 raeburn 6777: sub is_portfolio_file {
6778: my ($file) = @_;
1.820 raeburn 6779: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 6780: return 1;
6781: }
6782: return;
6783: }
6784:
1.976 raeburn 6785: sub usertools_access {
1.1084 raeburn 6786: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 6787: my ($access,%tools);
6788: if ($context eq '') {
6789: $context = 'tools';
6790: }
6791: if ($context eq 'requestcourses') {
6792: %tools = (
6793: official => 1,
6794: unofficial => 1,
1.1006 raeburn 6795: community => 1,
1.1172.2.37 raeburn 6796: textbook => 1,
1.985 raeburn 6797: );
1.1172.2.9 raeburn 6798: } elsif ($context eq 'requestauthor') {
6799: %tools = (
6800: requestauthor => 1,
6801: );
1.985 raeburn 6802: } else {
6803: %tools = (
6804: aboutme => 1,
6805: blog => 1,
1.1172.2.6 raeburn 6806: webdav => 1,
1.985 raeburn 6807: portfolio => 1,
6808: );
6809: }
1.976 raeburn 6810: return if (!defined($tools{$tool}));
6811:
1.1172.2.35 raeburn 6812: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 6813: $udom = $env{'user.domain'};
6814: $uname = $env{'user.name'};
6815: }
6816:
1.978 raeburn 6817: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6818: if ($action ne 'reload') {
1.985 raeburn 6819: if ($context eq 'requestcourses') {
6820: return $env{'environment.canrequest.'.$tool};
1.1172.2.9 raeburn 6821: } elsif ($context eq 'requestauthor') {
6822: return $env{'environment.canrequest.author'};
1.985 raeburn 6823: } else {
6824: return $env{'environment.availabletools.'.$tool};
6825: }
6826: }
1.976 raeburn 6827: }
6828:
1.1172.2.9 raeburn 6829: my ($toolstatus,$inststatus,$envkey);
6830: if ($context eq 'requestauthor') {
6831: $envkey = $context;
6832: } else {
6833: $envkey = $context.'.'.$tool;
6834: }
1.976 raeburn 6835:
1.985 raeburn 6836: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6837: ($action ne 'reload')) {
1.1172.2.9 raeburn 6838: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 6839: $inststatus = $env{'environment.inststatus'};
6840: } else {
1.1084 raeburn 6841: if (ref($userenvref) eq 'HASH') {
1.1172.2.9 raeburn 6842: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 6843: $inststatus = $userenvref->{'inststatus'};
6844: } else {
1.1172.2.9 raeburn 6845: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6846: $toolstatus = $userenv{$envkey};
1.1084 raeburn 6847: $inststatus = $userenv{'inststatus'};
6848: }
1.976 raeburn 6849: }
6850:
6851: if ($toolstatus ne '') {
6852: if ($toolstatus) {
6853: $access = 1;
6854: } else {
6855: $access = 0;
6856: }
6857: return $access;
6858: }
6859:
1.1084 raeburn 6860: my ($is_adv,%domdef);
6861: if (ref($is_advref) eq 'HASH') {
6862: $is_adv = $is_advref->{'is_adv'};
6863: } else {
6864: $is_adv = &is_advanced_user($udom,$uname);
6865: }
6866: if (ref($domdefref) eq 'HASH') {
6867: %domdef = %{$domdefref};
6868: } else {
6869: %domdef = &get_domain_defaults($udom);
6870: }
1.976 raeburn 6871: if (ref($domdef{$tool}) eq 'HASH') {
6872: if ($is_adv) {
6873: if ($domdef{$tool}{'_LC_adv'} ne '') {
6874: if ($domdef{$tool}{'_LC_adv'}) {
6875: $access = 1;
6876: } else {
6877: $access = 0;
6878: }
6879: return $access;
6880: }
6881: }
6882: if ($inststatus ne '') {
6883: my ($hasaccess,$hasnoaccess);
6884: foreach my $affiliation (split(/:/,$inststatus)) {
6885: if ($domdef{$tool}{$affiliation} ne '') {
6886: if ($domdef{$tool}{$affiliation}) {
6887: $hasaccess = 1;
6888: } else {
6889: $hasnoaccess = 1;
6890: }
6891: }
6892: }
6893: if ($hasaccess || $hasnoaccess) {
6894: if ($hasaccess) {
6895: $access = 1;
6896: } elsif ($hasnoaccess) {
6897: $access = 0;
6898: }
6899: return $access;
6900: }
6901: } else {
6902: if ($domdef{$tool}{'default'} ne '') {
6903: if ($domdef{$tool}{'default'}) {
6904: $access = 1;
6905: } elsif ($domdef{$tool}{'default'} == 0) {
6906: $access = 0;
6907: }
6908: return $access;
6909: }
6910: }
6911: } else {
1.1172.2.6 raeburn 6912: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 6913: $access = 1;
6914: } else {
6915: $access = 0;
6916: }
1.976 raeburn 6917: return $access;
6918: }
6919: }
6920:
1.1050 raeburn 6921: sub is_course_owner {
6922: my ($cdom,$cnum,$udom,$uname) = @_;
6923: if (($udom eq '') || ($uname eq '')) {
6924: $udom = $env{'user.domain'};
6925: $uname = $env{'user.name'};
6926: }
6927: unless (($udom eq '') || ($uname eq '')) {
6928: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6929: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6930: return 1;
6931: } else {
6932: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6933: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6934: return 1;
6935: }
6936: }
6937: }
6938: }
6939: return;
6940: }
6941:
1.976 raeburn 6942: sub is_advanced_user {
6943: my ($udom,$uname) = @_;
1.1085 raeburn 6944: if ($udom ne '' && $uname ne '') {
6945: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 6946: if (wantarray) {
6947: return ($env{'user.adv'},$env{'user.author'});
6948: } else {
6949: return $env{'user.adv'};
6950: }
1.1085 raeburn 6951: }
6952: }
1.976 raeburn 6953: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6954: my %allroles;
1.1128 raeburn 6955: my ($is_adv,$is_author);
1.976 raeburn 6956: foreach my $role (keys(%roleshash)) {
6957: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6958: my $area = '/'.$tdomain.'/'.$trest;
6959: if ($sec ne '') {
6960: $area .= '/'.$sec;
6961: }
6962: if (($area ne '') && ($trole ne '')) {
6963: my $spec=$trole.'.'.$area;
6964: if ($trole =~ /^cr\//) {
6965: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6966: } elsif ($trole ne 'gr') {
6967: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6968: }
1.1128 raeburn 6969: if ($trole eq 'au') {
6970: $is_author = 1;
6971: }
1.976 raeburn 6972: }
6973: }
6974: foreach my $role (keys(%allroles)) {
6975: last if ($is_adv);
6976: foreach my $item (split(/:/,$allroles{$role})) {
6977: if ($item ne '') {
6978: my ($privilege,$restrictions)=split(/&/,$item);
6979: if ($privilege eq 'adv') {
6980: $is_adv = 1;
6981: last;
6982: }
6983: }
6984: }
6985: }
1.1128 raeburn 6986: if (wantarray) {
6987: return ($is_adv,$is_author);
6988: }
1.976 raeburn 6989: return $is_adv;
6990: }
1.798 raeburn 6991:
1.1035 raeburn 6992: sub check_can_request {
1.1036 raeburn 6993: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 6994: my $canreq = 0;
6995: my ($types,$typename) = &Apache::loncommon::course_types();
6996: my @options = ('approval','validate','autolimit');
6997: my $optregex = join('|',@options);
6998: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
6999: foreach my $type (@{$types}) {
7000: if (&usertools_access($env{'user.name'},
7001: $env{'user.domain'},
7002: $type,undef,'requestcourses')) {
7003: $canreq ++;
1.1036 raeburn 7004: if (ref($request_domains) eq 'HASH') {
7005: push(@{$request_domains->{$type}},$env{'user.domain'});
7006: }
1.1035 raeburn 7007: if ($dom eq $env{'user.domain'}) {
7008: $can_request->{$type} = 1;
7009: }
7010: }
7011: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
7012: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
7013: if (@curr > 0) {
1.1036 raeburn 7014: foreach my $item (@curr) {
7015: if (ref($request_domains) eq 'HASH') {
7016: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
7017: if ($otherdom ne '') {
7018: if (ref($request_domains->{$type}) eq 'ARRAY') {
7019: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
7020: push(@{$request_domains->{$type}},$otherdom);
7021: }
7022: } else {
7023: push(@{$request_domains->{$type}},$otherdom);
7024: }
7025: }
7026: }
7027: }
7028: unless($dom eq $env{'user.domain'}) {
7029: $canreq ++;
1.1035 raeburn 7030: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
7031: $can_request->{$type} = 1;
7032: }
7033: }
7034: }
7035: }
7036: }
7037: }
7038: return $canreq;
7039: }
7040:
1.341 www 7041: # ---------------------------------------------- Custom access rule evaluation
7042:
7043: sub customaccess {
7044: my ($priv,$uri)=@_;
1.807 albertel 7045: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 7046: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 7047: $udom = &LONCAPA::clean_domain($udom);
7048: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 7049: my $access=0;
1.800 albertel 7050: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 7051: my ($effect,$realm,$role,$type)=split(/\:/,$right);
7052: if ($type eq 'user') {
7053: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 7054: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 7055: if ($tdom) {
7056: if ($tdom ne $env{'user.domain'}) { next; }
7057: }
1.896 albertel 7058: if ($tuname) {
7059: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 7060: }
7061: $access=($effect eq 'allow');
7062: last;
7063: }
7064: } else {
7065: if ($role) {
7066: if ($role ne $urole) { next; }
7067: }
7068: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7069: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
7070: if ($tdom) {
7071: if ($tdom ne $udom) { next; }
7072: }
7073: if ($tcrs) {
7074: if ($tcrs ne $ucrs) { next; }
7075: }
7076: if ($tsec) {
7077: if ($tsec ne $usec) { next; }
7078: }
7079: $access=($effect eq 'allow');
7080: last;
7081: }
7082: if ($realm eq '' && $role eq '') {
7083: $access=($effect eq 'allow');
7084: }
1.402 bowersj2 7085: }
1.341 www 7086: }
7087: return $access;
7088: }
7089:
1.103 harris41 7090: # ------------------------------------------------- Check for a user privilege
1.12 www 7091:
7092: sub allowed {
1.1172.2.65 raeburn 7093: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
1.705 albertel 7094: my $ver_orguri=$uri;
1.439 www 7095: $uri=&deversion($uri);
1.152 www 7096: my $orguri=$uri;
1.52 www 7097: $uri=&declutter($uri);
1.809 raeburn 7098:
1.810 raeburn 7099: if ($priv eq 'evb') {
7100: # Evade communication block restrictions for specified role in a course
7101: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
7102: return $1;
7103: } else {
7104: return;
7105: }
7106: }
7107:
1.620 albertel 7108: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 7109: # Free bre access to adm and meta resources
1.775 albertel 7110: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 7111: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
7112: && ($priv eq 'bre')) {
1.14 www 7113: return 'F';
1.159 www 7114: }
7115:
1.545 banghart 7116: # Free bre access to user's own portfolio contents
1.714 raeburn 7117: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 7118: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 7119: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 7120: my %setters;
7121: my ($startblock,$endblock) =
7122: &Apache::loncommon::blockcheck(\%setters,'port');
7123: if ($startblock && $endblock) {
7124: return 'B';
7125: } else {
7126: return 'F';
7127: }
1.545 banghart 7128: }
7129:
1.762 raeburn 7130: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 7131: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
7132: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
7133: if (exists($env{'request.course.id'})) {
7134: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7135: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7136: if (($domain eq $cdom) && ($name eq $cnum)) {
7137: my $courseprivid=$env{'request.course.id'};
7138: $courseprivid=~s/\_/\//;
7139: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
7140: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
7141: return $1;
1.762 raeburn 7142: } else {
7143: if ($env{'request.course.sec'}) {
7144: $courseprivid.='/'.$env{'request.course.sec'};
7145: }
7146: if ($env{'user.priv.'.$env{'request.role'}.'./'.
7147: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
7148: return $2;
7149: }
1.714 raeburn 7150: }
7151: }
7152: }
7153: }
7154:
1.159 www 7155: # Free bre to public access
7156:
7157: if ($priv eq 'bre') {
1.238 www 7158: my $copyright=&metadata($uri,'copyright');
1.620 albertel 7159: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 7160: return 'F';
7161: }
1.238 www 7162: if ($copyright eq 'priv') {
7163: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7164: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 7165: return '';
7166: }
7167: }
7168: if ($copyright eq 'domain') {
7169: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7170: unless (($env{'user.domain'} eq $1) ||
7171: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 7172: return '';
7173: }
1.262 matthew 7174: }
1.620 albertel 7175: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 7176: # Library role, so allow browsing of resources in this domain.
7177: return 'F';
1.238 www 7178: }
1.341 www 7179: if ($copyright eq 'custom') {
7180: unless (&customaccess($priv,$uri)) { return ''; }
7181: }
1.14 www 7182: }
1.264 matthew 7183: # Domain coordinator is trying to create a course
1.620 albertel 7184: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 7185: # uri is the requested domain in this case.
7186: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 7187: # a role of dc for the domain in question.
1.620 albertel 7188: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 7189: }
1.29 www 7190:
1.52 www 7191: my $thisallowed='';
7192: my $statecond=0;
7193: my $courseprivid='';
7194:
1.1039 raeburn 7195: my $ownaccess;
1.1043 raeburn 7196: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 7197: if (($priv eq 'bro') && ($env{'user.author'})) {
7198: if ($uri eq '') {
7199: $ownaccess = 1;
7200: } else {
7201: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7202: my $udom = $env{'user.domain'};
7203: my $uname = $env{'user.name'};
7204: if ($uri =~ m{^\Q$udom\E/?$}) {
7205: $ownaccess = 1;
1.1040 raeburn 7206: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 7207: unless ($uri =~ m{\.\./}) {
7208: $ownaccess = 1;
7209: }
7210: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7211: my $now = time;
7212: if ($uri =~ m{^([^/]+)/?$}) {
7213: my $adom = $1;
7214: foreach my $key (keys(%env)) {
1.1042 raeburn 7215: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 7216: my ($start,$end) = split('.',$env{$key});
7217: if (($now >= $start) && (!$end || $end < $now)) {
7218: $ownaccess = 1;
7219: last;
7220: }
7221: }
7222: }
7223: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7224: my $adom = $1;
7225: my $aname = $2;
1.1042 raeburn 7226: foreach my $role ('ca','aa') {
7227: if ($env{"user.role.$role./$adom/$aname"}) {
7228: my ($start,$end) =
7229: split('.',$env{"user.role.$role./$adom/$aname"});
7230: if (($now >= $start) && (!$end || $end < $now)) {
7231: $ownaccess = 1;
7232: last;
7233: }
1.1039 raeburn 7234: }
7235: }
7236: }
7237: }
7238: }
7239: }
7240: }
7241:
1.52 www 7242: # Course
7243:
1.620 albertel 7244: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7245: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7246: $thisallowed.=$1;
7247: }
1.52 www 7248: }
1.29 www 7249:
1.52 www 7250: # Domain
7251:
1.620 albertel 7252: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 7253: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7254: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7255: $thisallowed.=$1;
7256: }
1.12 www 7257: }
1.52 www 7258:
1.1141 raeburn 7259: # User who is not author or co-author might still be able to edit
7260: # resource of an author in the domain (e.g., if Domain Coordinator).
7261: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7262: (&allowed('mdc',$env{'request.course.id'}))) {
7263: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7264: $thisallowed.=$1;
7265: }
7266: }
7267:
1.52 www 7268: # Course: uri itself is a course
1.66 www 7269: my $courseuri=$uri;
7270: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 7271: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 7272:
1.620 albertel 7273: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 7274: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7275: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7276: $thisallowed.=$1;
7277: }
1.12 www 7278: }
1.29 www 7279:
1.665 albertel 7280: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 7281: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 7282: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 7283: $thisallowed='';
1.671 raeburn 7284: my ($match)=&is_on_map($uri);
7285: if ($match) {
7286: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7287: =~/\Q$priv\E\&([^\:]*)/) {
1.1172.2.65 raeburn 7288: my $value = $1;
7289: if ($noblockcheck) {
7290: $thisallowed.=$value;
1.1162 raeburn 7291: } else {
1.1172.2.65 raeburn 7292: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7293: if (@blockers > 0) {
7294: $thisallowed = 'B';
7295: } else {
7296: $thisallowed.=$value;
7297: }
1.1162 raeburn 7298: }
1.671 raeburn 7299: }
7300: } else {
1.705 albertel 7301: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 7302: if ($refuri) {
7303: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 7304: $thisallowed='F';
1.671 raeburn 7305: } else {
7306: $refuri=&declutter($refuri);
7307: my ($match) = &is_on_map($refuri);
7308: if ($match) {
1.1172.2.65 raeburn 7309: if ($noblockcheck) {
1.1162 raeburn 7310: $thisallowed='F';
1.1172.2.65 raeburn 7311: } else {
7312: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7313: if (@blockers > 0) {
7314: $thisallowed = 'B';
7315: } else {
7316: $thisallowed='F';
7317: }
1.1162 raeburn 7318: }
1.671 raeburn 7319: }
1.669 raeburn 7320: }
1.671 raeburn 7321: }
7322: }
1.314 www 7323: }
1.492 albertel 7324:
1.766 albertel 7325: if ($priv eq 'bre'
7326: && $thisallowed ne 'F'
7327: && $thisallowed ne '2'
7328: && &is_portfolio_url($uri)) {
1.1172.2.77 raeburn 7329: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 7330: }
7331:
1.52 www 7332: # Full access at system, domain or course-wide level? Exit.
1.29 www 7333: if ($thisallowed=~/F/) {
7334: return 'F';
7335: }
7336:
1.52 www 7337: # If this is generating or modifying users, exit with special codes
1.29 www 7338:
1.643 www 7339: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7340: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 7341: my ($audom,$auname)=split('/',$uri);
1.643 www 7342: # no author name given, so this just checks on the general right to make a co-author in this domain
7343: unless ($auname) { return $thisallowed; }
7344: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 7345: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7346: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7347: ($audom ne $env{'request.role.domain'}))) { return ''; }
7348: }
1.52 www 7349: return $thisallowed;
7350: }
7351: #
1.103 harris41 7352: # Gathered so far: system, domain and course wide privileges
1.52 www 7353: #
7354: # Course: See if uri or referer is an individual resource that is part of
7355: # the course
7356:
1.620 albertel 7357: if ($env{'request.course.id'}) {
1.232 www 7358:
1.620 albertel 7359: $courseprivid=$env{'request.course.id'};
7360: if ($env{'request.course.sec'}) {
7361: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 7362: }
7363: $courseprivid=~s/\_/\//;
7364: my $checkreferer=1;
1.232 www 7365: my ($match,$cond)=&is_on_map($uri);
7366: if ($match) {
7367: $statecond=$cond;
1.620 albertel 7368: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7369: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7370: my $value = $1;
7371: if ($priv eq 'bre') {
1.1172.2.65 raeburn 7372: if ($noblockcheck) {
1.1162 raeburn 7373: $thisallowed.=$value;
1.1172.2.65 raeburn 7374: } else {
7375: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7376: if (@blockers > 0) {
7377: $thisallowed = 'B';
7378: } else {
7379: $thisallowed.=$value;
7380: }
1.1162 raeburn 7381: }
7382: } else {
7383: $thisallowed.=$value;
7384: }
1.52 www 7385: $checkreferer=0;
7386: }
1.29 www 7387: }
1.83 www 7388:
1.148 www 7389: if ($checkreferer) {
1.620 albertel 7390: my $refuri=$env{'httpref.'.$orguri};
1.148 www 7391: unless ($refuri) {
1.800 albertel 7392: foreach my $key (keys(%env)) {
7393: if ($key=~/^httpref\..*\*/) {
7394: my $pattern=$key;
1.156 www 7395: $pattern=~s/^httpref\.\/res\///;
1.148 www 7396: $pattern=~s/\*/\[\^\/\]\+/g;
7397: $pattern=~s/\//\\\//g;
1.152 www 7398: if ($orguri=~/$pattern/) {
1.800 albertel 7399: $refuri=$env{$key};
1.148 www 7400: }
7401: }
1.191 harris41 7402: }
1.148 www 7403: }
1.232 www 7404:
1.148 www 7405: if ($refuri) {
1.152 www 7406: $refuri=&declutter($refuri);
1.232 www 7407: my ($match,$cond)=&is_on_map($refuri);
7408: if ($match) {
7409: my $refstatecond=$cond;
1.620 albertel 7410: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7411: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7412: my $value = $1;
7413: if ($priv eq 'bre') {
1.1172.2.65 raeburn 7414: if ($noblockcheck) {
1.1162 raeburn 7415: $thisallowed.=$value;
1.1172.2.65 raeburn 7416: } else {
7417: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7418: if (@blockers > 0) {
7419: $thisallowed = 'B';
7420: } else {
7421: $thisallowed.=$value;
7422: }
1.1162 raeburn 7423: }
7424: } else {
7425: $thisallowed.=$value;
7426: }
1.53 www 7427: $uri=$refuri;
7428: $statecond=$refstatecond;
1.52 www 7429: }
7430: }
1.148 www 7431: }
1.29 www 7432: }
1.52 www 7433: }
1.29 www 7434:
1.52 www 7435: #
1.103 harris41 7436: # Gathered now: all privileges that could apply, and condition number
1.52 www 7437: #
7438: #
7439: # Full or no access?
7440: #
1.29 www 7441:
1.52 www 7442: if ($thisallowed=~/F/) {
7443: return 'F';
7444: }
1.29 www 7445:
1.52 www 7446: unless ($thisallowed) {
7447: return '';
7448: }
1.29 www 7449:
1.52 www 7450: # Restrictions exist, deal with them
7451: #
7452: # C:according to course preferences
7453: # R:according to resource settings
7454: # L:unless locked
7455: # X:according to user session state
7456: #
7457:
7458: # Possibly locked functionality, check all courses
1.54 www 7459: # Locks might take effect only after 10 minutes cache expiration for other
7460: # courses, and 2 minutes for current course
1.52 www 7461:
7462: my $envkey;
7463: if ($thisallowed=~/L/) {
1.1000 raeburn 7464: foreach $envkey (keys(%env)) {
1.54 www 7465: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7466: my $courseid=$2;
7467: my $roleid=$1.'.'.$2;
1.92 www 7468: $courseid=~s/^\///;
1.54 www 7469: my $expiretime=600;
1.620 albertel 7470: if ($env{'request.role'} eq $roleid) {
1.54 www 7471: $expiretime=120;
7472: }
7473: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7474: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 7475: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 7476: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 7477: }
1.620 albertel 7478: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7479: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7480: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7481: &log($env{'user.domain'},$env{'user.name'},
7482: $env{'user.home'},
1.57 www 7483: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 7484: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7485: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7486: return '';
7487: }
7488: }
1.620 albertel 7489: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7490: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7491: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7492: &log($env{'user.domain'},$env{'user.name'},
7493: $env{'user.home'},
1.57 www 7494: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 7495: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7496: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7497: return '';
7498: }
7499: }
7500: }
1.29 www 7501: }
1.52 www 7502: }
7503:
7504: #
7505: # Rest of the restrictions depend on selected course
7506: #
7507:
1.620 albertel 7508: unless ($env{'request.course.id'}) {
1.766 albertel 7509: if ($thisallowed eq 'A') {
7510: return 'A';
1.814 raeburn 7511: } elsif ($thisallowed eq 'B') {
7512: return 'B';
1.766 albertel 7513: } else {
7514: return '1';
7515: }
1.52 www 7516: }
1.29 www 7517:
1.52 www 7518: #
7519: # Now user is definitely in a course
7520: #
1.53 www 7521:
7522:
7523: # Course preferences
7524:
7525: if ($thisallowed=~/C/) {
1.620 albertel 7526: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7527: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7528: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 7529: =~/\Q$rolecode\E/) {
1.1103 raeburn 7530: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7531: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7532: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7533: $env{'request.course.id'});
7534: }
1.237 www 7535: return '';
7536: }
7537:
1.620 albertel 7538: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 7539: =~/\Q$unamedom\E/) {
1.1103 raeburn 7540: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7541: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7542: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7543: $env{'request.course.id'});
7544: }
1.54 www 7545: return '';
7546: }
1.53 www 7547: }
7548:
7549: # Resource preferences
7550:
7551: if ($thisallowed=~/R/) {
1.620 albertel 7552: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 7553: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 7554: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7555: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7556: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7557: }
7558: return '';
1.54 www 7559: }
1.53 www 7560: }
1.30 www 7561:
1.246 www 7562: # Restricted by state or randomout?
1.30 www 7563:
1.52 www 7564: if ($thisallowed=~/X/) {
1.620 albertel 7565: if ($env{'acc.randomout'}) {
1.579 albertel 7566: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 7567: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 7568: return '';
7569: }
1.247 www 7570: }
7571: if (&condval($statecond)) {
1.52 www 7572: return '2';
7573: } else {
7574: return '';
7575: }
7576: }
1.30 www 7577:
1.766 albertel 7578: if ($thisallowed eq 'A') {
7579: return 'A';
1.814 raeburn 7580: } elsif ($thisallowed eq 'B') {
7581: return 'B';
1.766 albertel 7582: }
1.52 www 7583: return 'F';
1.232 www 7584: }
1.1162 raeburn 7585:
1.1172.2.13 raeburn 7586: # ------------------------------------------- Check construction space access
7587:
7588: sub constructaccess {
7589: my ($url,$setpriv)=@_;
7590:
7591: # We do not allow editing of previous versions of files
7592: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7593:
7594: # Get username and domain from URL
7595: my ($ownername,$ownerdomain,$ownerhome);
7596:
7597: ($ownerdomain,$ownername) =
1.1172.2.83 raeburn 7598: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)(?:/|$)});
1.1172.2.13 raeburn 7599:
7600: # The URL does not really point to any authorspace, forget it
7601: unless (($ownername) && ($ownerdomain)) { return ''; }
7602:
7603: # Now we need to see if the user has access to the authorspace of
7604: # $ownername at $ownerdomain
7605:
7606: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7607: # Real author for this?
7608: $ownerhome = $env{'user.home'};
7609: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7610: return ($ownername,$ownerdomain,$ownerhome);
7611: }
7612: } else {
7613: # Co-author for this?
7614: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7615: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7616: $ownerhome = &homeserver($ownername,$ownerdomain);
7617: return ($ownername,$ownerdomain,$ownerhome);
7618: }
7619: }
7620:
7621: # We don't have any access right now. If we are not possibly going to do anything about this,
7622: # we might as well leave
7623: unless ($setpriv) { return ''; }
7624:
7625: # Backdoor access?
7626: my $allowed=&allowed('eco',$ownerdomain);
7627: # Nope
7628: unless ($allowed) { return ''; }
7629: # Looks like we may have access, but could be locked by the owner of the construction space
7630: if ($allowed eq 'U') {
7631: my %blocked=&get('environment',['domcoord.author'],
7632: $ownerdomain,$ownername);
7633: # Is blocked by owner
7634: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7635: }
7636: if (($allowed eq 'F') || ($allowed eq 'U')) {
7637: # Grant temporary access
7638: my $then=$env{'user.login.time'};
1.1172.2.16 raeburn 7639: my $update=$env{'user.update.time'};
1.1172.2.13 raeburn 7640: if (!$update) { $update = $then; }
7641: my $refresh=$env{'user.refresh.time'};
7642: if (!$refresh) { $refresh = $update; }
7643: my $now = time;
7644: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7645: $now,'ca','constructaccess');
7646: $ownerhome = &homeserver($ownername,$ownerdomain);
7647: return($ownername,$ownerdomain,$ownerhome);
7648: }
7649: # No business here
7650: return '';
7651: }
7652:
1.1172.2.66 raeburn 7653: # ----------------------------------------------------------- Content Blocking
7654:
7655: {
7656: # Caches for faster Course Contents display where content blocking
7657: # is in operation (i.e., interval param set) for timed quiz.
7658: #
7659: # User for whom data are being temporarily cached.
7660: my $cacheduser='';
7661: # Cached blockers for this user (a hash of blocking items).
7662: my %cachedblockers=();
7663: # When the data were last cached.
7664: my $cachedlast='';
7665:
7666: sub load_all_blockers {
7667: my ($uname,$udom,$blocks)=@_;
7668: if (($uname ne '') && ($udom ne '')) {
7669: if (($cacheduser eq $uname.':'.$udom) &&
7670: (abs($cachedlast-time)<5)) {
7671: return;
7672: }
7673: }
7674: $cachedlast=time;
7675: $cacheduser=$uname.':'.$udom;
7676: %cachedblockers = &get_commblock_resources($blocks);
7677: }
7678:
1.1162 raeburn 7679: sub get_comm_blocks {
7680: my ($cdom,$cnum) = @_;
7681: if ($cdom eq '' || $cnum eq '') {
7682: return unless ($env{'request.course.id'});
7683: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7684: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7685: }
7686: my %commblocks;
7687: my $hashid=$cdom.'_'.$cnum;
7688: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7689: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7690: %commblocks = %{$blocksref};
7691: } else {
7692: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7693: my $cachetime = 600;
7694: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7695: }
7696: return %commblocks;
7697: }
7698:
1.1172.2.66 raeburn 7699: sub get_commblock_resources {
7700: my ($blocks) = @_;
7701: my %blockers = ();
7702: return %blockers unless ($env{'request.course.id'});
7703: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
1.1162 raeburn 7704: my %commblocks;
7705: if (ref($blocks) eq 'HASH') {
7706: %commblocks = %{$blocks};
7707: } else {
7708: %commblocks = &get_comm_blocks();
7709: }
1.1172.2.66 raeburn 7710: return %blockers unless (keys(%commblocks) > 0);
1.1163 raeburn 7711: my $navmap = Apache::lonnavmaps::navmap->new();
1.1172.2.66 raeburn 7712: return %blockers unless (ref($navmap));
7713: my $now = time;
1.1162 raeburn 7714: foreach my $block (keys(%commblocks)) {
7715: if ($block =~ /^(\d+)____(\d+)$/) {
7716: my ($start,$end) = ($1,$2);
7717: if ($start <= $now && $end >= $now) {
7718: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7719: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7720: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1172.2.66 raeburn 7721: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7722: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 7723: }
7724: }
7725: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1172.2.66 raeburn 7726: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7727: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 7728: }
7729: }
7730: }
7731: }
7732: }
7733: } elsif ($block =~ /^firstaccess____(.+)$/) {
7734: my $item = $1;
1.1163 raeburn 7735: my @to_test;
1.1162 raeburn 7736: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7737: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1172.2.66 raeburn 7738: my @interval;
7739: my $type = 'map';
7740: if ($item eq 'course') {
7741: $type = 'course';
7742: @interval=&EXT("resource.0.interval");
7743: } else {
7744: if ($item =~ /___\d+___/) {
7745: $type = 'resource';
7746: @interval=&EXT("resource.0.interval",$item);
7747: if (ref($navmap)) {
7748: my $res = $navmap->getBySymb($item);
7749: push(@to_test,$res);
7750: }
1.1162 raeburn 7751: } else {
1.1172.2.66 raeburn 7752: my $mapsymb = &symbread($item,1);
7753: if ($mapsymb) {
7754: if (ref($navmap)) {
7755: my $mapres = $navmap->getBySymb($mapsymb);
7756: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
7757: foreach my $res (@to_test) {
7758: my $symb = $res->symb();
7759: next if ($symb eq $mapsymb);
7760: if ($symb ne '') {
7761: @interval=&EXT("resource.0.interval",$symb);
7762: if ($interval[1] eq 'map') {
7763: last;
1.1162 raeburn 7764: }
7765: }
7766: }
7767: }
7768: }
7769: }
1.1172.2.66 raeburn 7770: }
7771: if ($interval[0] =~ /^\d+$/) {
7772: my $first_access;
7773: if ($type eq 'resource') {
7774: $first_access=&get_first_access($interval[1],$item);
7775: } elsif ($type eq 'map') {
7776: $first_access=&get_first_access($interval[1],undef,$item);
7777: } else {
7778: $first_access=&get_first_access($interval[1]);
7779: }
7780: if ($first_access) {
7781: my $timesup = $first_access+$interval[0];
7782: if ($timesup > $now) {
7783: my $activeblock;
7784: foreach my $res (@to_test) {
7785: if ($res->answerable()) {
7786: $activeblock = 1;
7787: last;
7788: }
7789: }
7790: if ($activeblock) {
7791: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7792: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7793: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7794: }
7795: }
7796: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7797: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7798: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 7799: }
1.1162 raeburn 7800: }
7801: }
7802: }
7803: }
7804: }
7805: }
7806: }
7807: }
7808: }
1.1172.2.66 raeburn 7809: return %blockers;
1.1162 raeburn 7810: }
7811:
1.1172.2.66 raeburn 7812: sub has_comm_blocking {
7813: my ($priv,$symb,$uri,$blocks) = @_;
7814: my @blockers;
7815: return unless ($env{'request.course.id'});
7816: return unless ($priv eq 'bre');
7817: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7818: return if ($env{'request.state'} eq 'construct');
7819: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
7820: return unless (keys(%cachedblockers) > 0);
7821: my (%possibles,@symbs);
7822: if (!$symb) {
7823: $symb = &symbread($uri,1,1,1,\%possibles);
1.1162 raeburn 7824: }
1.1172.2.66 raeburn 7825: if ($symb) {
7826: @symbs = ($symb);
7827: } elsif (keys(%possibles)) {
7828: @symbs = keys(%possibles);
7829: }
7830: my $noblock;
7831: foreach my $symb (@symbs) {
7832: last if ($noblock);
7833: my ($map,$resid,$resurl)=&decode_symb($symb);
7834: foreach my $block (keys(%cachedblockers)) {
7835: if ($block =~ /^firstaccess____(.+)$/) {
7836: my $item = $1;
7837: if (($item eq $map) || ($item eq $symb)) {
7838: $noblock = 1;
7839: last;
7840: }
1.1162 raeburn 7841: }
1.1172.2.66 raeburn 7842: if (ref($cachedblockers{$block}) eq 'HASH') {
7843: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
7844: if ($cachedblockers{$block}{'resources'}{$symb}) {
7845: unless (grep(/^\Q$block\E$/,@blockers)) {
7846: push(@blockers,$block);
7847: }
7848: }
7849: }
7850: }
7851: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
7852: if ($cachedblockers{$block}{'maps'}{$map}) {
7853: unless (grep(/^\Q$block\E$/,@blockers)) {
7854: push(@blockers,$block);
7855: }
7856: }
1.1162 raeburn 7857: }
7858: }
7859: }
1.1172.2.66 raeburn 7860: return if ($noblock);
7861: return @blockers;
7862: }
1.1162 raeburn 7863: }
7864:
1.1172.2.66 raeburn 7865: # -------------------------------- Deversion and split uri into path an filename
7866:
1.1133 foxr 7867: #
1.1172.2.66 raeburn 7868: # Removes the version from a URI and
1.1133 foxr 7869: # splits it in to its filename and path to the filename.
7870: # Seems like File::Basename could have done this more clearly.
7871: # Parameters:
7872: # $uri - input URI
7873: # Returns:
7874: # Two element list consisting of
7875: # $pathname - the URI up to and excluding the trailing /
7876: # $filename - The part of the URI following the last /
7877: # NOTE:
7878: # Another realization of this is simply:
7879: # use File::Basename;
7880: # ...
7881: # $uri = shift;
7882: # $filename = basename($uri);
7883: # $path = dirname($uri);
7884: # return ($filename, $path);
7885: #
7886: # The implementation below is probably faster however.
7887: #
1.710 albertel 7888: sub split_uri_for_cond {
7889: my $uri=&deversion(&declutter(shift));
7890: my @uriparts=split(/\//,$uri);
7891: my $filename=pop(@uriparts);
7892: my $pathname=join('/',@uriparts);
7893: return ($pathname,$filename);
7894: }
1.232 www 7895: # --------------------------------------------------- Is a resource on the map?
7896:
7897: sub is_on_map {
1.710 albertel 7898: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 7899: #Trying to find the conditional for the file
1.620 albertel 7900: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 7901: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 7902: if ($match) {
1.289 bowersj2 7903: return (1,$1);
7904: } else {
1.434 www 7905: return (0,0);
1.289 bowersj2 7906: }
1.12 www 7907: }
7908:
1.427 www 7909: # --------------------------------------------------------- Get symb from alias
7910:
7911: sub get_symb_from_alias {
7912: my $symb=shift;
7913: my ($map,$resid,$url)=&decode_symb($symb);
7914: # Already is a symb
7915: if ($url) { return $symb; }
7916: # Must be an alias
7917: my $aliassymb='';
7918: my %bighash;
1.620 albertel 7919: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 7920: &GDBM_READER(),0640)) {
7921: my $rid=$bighash{'mapalias_'.$symb};
7922: if ($rid) {
7923: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 7924: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7925: $resid,$bighash{'src_'.$rid});
1.427 www 7926: }
7927: untie %bighash;
7928: }
7929: return $aliassymb;
7930: }
7931:
1.12 www 7932: # ----------------------------------------------------------------- Define Role
7933:
7934: sub definerole {
7935: if (allowed('mcr','/')) {
1.1172.2.84 raeburn 7936: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 7937: foreach my $role (split(':',$sysrole)) {
7938: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7939: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7940: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7941: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7942: return "refused:s:$crole&$cqual";
7943: }
7944: }
1.191 harris41 7945: }
1.800 albertel 7946: foreach my $role (split(':',$domrole)) {
7947: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7948: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7949: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7950: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 7951: return "refused:d:$crole&$cqual";
7952: }
7953: }
1.191 harris41 7954: }
1.800 albertel 7955: foreach my $role (split(':',$courole)) {
7956: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7957: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7958: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7959: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7960: return "refused:c:$crole&$cqual";
7961: }
7962: }
1.191 harris41 7963: }
1.1172.2.84 raeburn 7964: my $uhome;
7965: if (($uname ne '') && ($udom ne '')) {
7966: $uhome = &homeserver($uname,$udom);
7967: return $uhome if ($uhome eq 'no_host');
7968: } else {
7969: $uname = $env{'user.name'};
7970: $udom = $env{'user.domain'};
7971: $uhome = $env{'user.home'};
7972: }
1.620 albertel 7973: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1172.2.84 raeburn 7974: "$udom:$uname:rolesdef_$rolename=".
1.21 www 7975: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1172.2.84 raeburn 7976: return reply($command,$uhome);
1.12 www 7977: } else {
7978: return 'refused';
7979: }
1.105 harris41 7980: }
7981:
7982: # ---------------- Make a metadata query against the network of library servers
7983:
7984: sub metadata_query {
1.1172.2.33 raeburn 7985: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 7986: my %rhash;
1.845 albertel 7987: my %libserv = &all_library();
1.244 matthew 7988: my @server_list = (defined($server_array) ? @$server_array
7989: : keys(%libserv) );
7990: for my $server (@server_list) {
1.1172.2.33 raeburn 7991: my $domains = '';
7992: if (ref($domains_hash) eq 'HASH') {
7993: $domains = $domains_hash->{$server};
7994: }
1.118 harris41 7995: unless ($custom or $customshow) {
1.1172.2.33 raeburn 7996: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 7997: $rhash{$server}=$reply;
7998: }
7999: else {
8000: my $reply=&reply("querysend:".&escape($query).':'.
1.1172.2.33 raeburn 8001: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 8002: $server);
8003: $rhash{$server}=$reply;
8004: }
1.112 harris41 8005: }
1.118 harris41 8006: return \%rhash;
1.240 www 8007: }
8008:
8009: # ----------------------------------------- Send log queries and wait for reply
8010:
8011: sub log_query {
8012: my ($uname,$udom,$query,%filters)=@_;
8013: my $uhome=&homeserver($uname,$udom);
8014: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 8015: my $uhost=&hostname($uhome);
1.800 albertel 8016: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 8017: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
8018: $uhome);
1.479 albertel 8019: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 8020: return get_query_reply($queryid);
8021: }
8022:
1.818 raeburn 8023: # -------------------------- Update MySQL table for portfolio file
8024:
8025: sub update_portfolio_table {
1.821 raeburn 8026: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 8027: if ($group ne '') {
8028: $file_name =~s /^\Q$group\E//;
8029: }
1.818 raeburn 8030: my $homeserver = &homeserver($uname,$udom);
8031: my $queryid=
1.821 raeburn 8032: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
8033: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 8034: my $reply = &get_query_reply($queryid);
8035: return $reply;
8036: }
8037:
1.899 raeburn 8038: # -------------------------- Update MySQL allusers table
8039:
8040: sub update_allusers_table {
8041: my ($uname,$udom,$names) = @_;
8042: my $homeserver = &homeserver($uname,$udom);
8043: my $queryid=
8044: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
8045: 'lastname='.&escape($names->{'lastname'}).'%%'.
8046: 'firstname='.&escape($names->{'firstname'}).'%%'.
8047: 'middlename='.&escape($names->{'middlename'}).'%%'.
8048: 'generation='.&escape($names->{'generation'}).'%%'.
8049: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
8050: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 8051: return;
1.899 raeburn 8052: }
8053:
1.508 raeburn 8054: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 8055:
8056: sub fetch_enrollment_query {
1.511 raeburn 8057: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1172.2.79 raeburn 8058: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 8059: my $maxtries = 1;
1.508 raeburn 8060: if ($context eq 'automated') {
8061: $homeserver = $perlvar{'lonHostID'};
1.1172.2.79 raeburn 8062: $sleep = 2;
8063: $loopmax = 100;
1.547 raeburn 8064: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 8065: } else {
8066: $homeserver = &homeserver($cnum,$dom);
8067: }
1.838 albertel 8068: my $host=&hostname($homeserver);
1.506 raeburn 8069: my $cmd = '';
1.1000 raeburn 8070: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 8071: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 8072: }
8073: $cmd =~ s/%%$//;
8074: $cmd = &escape($cmd);
8075: my $query = 'fetchenrollment';
1.620 albertel 8076: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 8077: unless ($queryid=~/^\Q$host\E\_/) {
8078: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
8079: return 'error: '.$queryid;
8080: }
1.1172.2.79 raeburn 8081: my $reply = &get_query_reply($queryid,$sleep.$loopmax);
1.547 raeburn 8082: my $tries = 1;
8083: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1172.2.79 raeburn 8084: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 8085: $tries ++;
8086: }
1.526 raeburn 8087: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 8088: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 8089: } else {
1.901 albertel 8090: my @responses = split(/:/,$reply);
1.1172.2.82 raeburn 8091: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 8092: foreach my $line (@responses) {
8093: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 8094: $$replyref{$key} = $value;
8095: }
8096: } else {
1.1117 foxr 8097: my $pathname = LONCAPA::tempdir();
1.800 albertel 8098: foreach my $line (@responses) {
8099: my ($key,$value) = split(/=/,$line);
1.506 raeburn 8100: $$replyref{$key} = $value;
8101: if ($value > 0) {
1.800 albertel 8102: foreach my $item (@{$$affiliatesref{$key}}) {
8103: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 8104: my $destname = $pathname.'/'.$filename;
8105: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 8106: if ($xml_classlist =~ /^error/) {
8107: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
8108: } else {
1.506 raeburn 8109: if ( open(FILE,">$destname") ) {
8110: print FILE &unescape($xml_classlist);
8111: close(FILE);
1.526 raeburn 8112: } else {
8113: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 8114: }
8115: }
8116: }
8117: }
8118: }
8119: }
8120: return 'ok';
8121: }
8122: return 'error';
8123: }
8124:
1.242 www 8125: sub get_query_reply {
1.1172.2.79 raeburn 8126: my ($queryid,$sleep,$loopmax) = @_;
8127: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
8128: $sleep = 0.2;
8129: }
8130: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
8131: $loopmax = 100;
8132: }
1.1117 foxr 8133: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 8134: my $reply='';
1.1172.2.79 raeburn 8135: for (1..$loopmax) {
8136: sleep($sleep);
1.240 www 8137: if (-e $replyfile.'.end') {
1.448 albertel 8138: if (open(my $fh,$replyfile)) {
1.904 albertel 8139: $reply = join('',<$fh>);
8140: close($fh);
1.240 www 8141: } else { return 'error: reply_file_error'; }
1.242 www 8142: return &unescape($reply);
8143: }
1.240 www 8144: }
1.242 www 8145: return 'timeout:'.$queryid;
1.240 www 8146: }
8147:
8148: sub courselog_query {
1.241 www 8149: #
8150: # possible filters:
8151: # url: url or symb
8152: # username
8153: # domain
8154: # action: view, submit, grade
8155: # start: timestamp
8156: # end: timestamp
8157: #
1.240 www 8158: my (%filters)=@_;
1.620 albertel 8159: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 8160: if ($filters{'url'}) {
8161: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
8162: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
8163: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
8164: }
1.620 albertel 8165: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
8166: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 8167: return &log_query($cname,$cdom,'courselog',%filters);
8168: }
8169:
8170: sub userlog_query {
1.858 raeburn 8171: #
8172: # possible filters:
8173: # action: log check role
8174: # start: timestamp
8175: # end: timestamp
8176: #
1.240 www 8177: my ($uname,$udom,%filters)=@_;
8178: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 8179: }
8180:
1.506 raeburn 8181: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
8182:
8183: sub auto_run {
1.508 raeburn 8184: my ($cnum,$cdom) = @_;
1.876 raeburn 8185: my $response = 0;
8186: my $settings;
8187: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
8188: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
8189: $settings = $domconfig{'autoenroll'};
8190: if ($settings->{'run'} eq '1') {
8191: $response = 1;
8192: }
8193: } else {
1.934 raeburn 8194: my $homeserver;
8195: if (&is_course($cdom,$cnum)) {
8196: $homeserver = &homeserver($cnum,$cdom);
8197: } else {
8198: $homeserver = &domain($cdom,'primary');
8199: }
8200: if ($homeserver ne 'no_host') {
8201: $response = &reply('autorun:'.$cdom,$homeserver);
8202: }
1.876 raeburn 8203: }
1.506 raeburn 8204: return $response;
8205: }
1.776 albertel 8206:
1.506 raeburn 8207: sub auto_get_sections {
1.508 raeburn 8208: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 8209: my $homeserver;
8210: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8211: $homeserver = &homeserver($cnum,$cdom);
8212: }
8213: if (!defined($homeserver)) {
8214: if ($cdom =~ /^$match_domain$/) {
8215: $homeserver = &domain($cdom,'primary');
8216: }
8217: }
8218: my @secs;
8219: if (defined($homeserver)) {
8220: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
8221: unless ($response eq 'refused') {
8222: @secs = split(/:/,$response);
8223: }
1.506 raeburn 8224: }
8225: return @secs;
8226: }
1.776 albertel 8227:
1.506 raeburn 8228: sub auto_new_course {
1.1099 raeburn 8229: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 8230: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 8231: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 8232: return $response;
8233: }
1.776 albertel 8234:
1.506 raeburn 8235: sub auto_validate_courseID {
1.508 raeburn 8236: my ($cnum,$cdom,$inst_course_id) = @_;
8237: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 8238: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 8239: return $response;
8240: }
1.776 albertel 8241:
1.1007 raeburn 8242: sub auto_validate_instcode {
1.1020 raeburn 8243: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 8244: my ($homeserver,$response);
8245: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8246: $homeserver = &homeserver($cnum,$cdom);
8247: }
8248: if (!defined($homeserver)) {
8249: if ($cdom =~ /^$match_domain$/) {
8250: $homeserver = &domain($cdom,'primary');
8251: }
8252: }
1.1065 raeburn 8253: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8254: &escape($instcode).':'.&escape($owner),$homeserver));
1.1172.2.19 raeburn 8255: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8256: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 8257: }
8258:
1.506 raeburn 8259: sub auto_create_password {
1.873 raeburn 8260: my ($cnum,$cdom,$authparam,$udom) = @_;
8261: my ($homeserver,$response);
1.506 raeburn 8262: my $create_passwd = 0;
8263: my $authchk = '';
1.873 raeburn 8264: if ($udom =~ /^$match_domain$/) {
8265: $homeserver = &domain($udom,'primary');
8266: }
8267: if ($homeserver eq '') {
8268: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8269: $homeserver = &homeserver($cnum,$cdom);
8270: }
8271: }
8272: if ($homeserver eq '') {
8273: $authchk = 'nodomain';
1.506 raeburn 8274: } else {
1.873 raeburn 8275: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8276: if ($response eq 'refused') {
8277: $authchk = 'refused';
8278: } else {
1.901 albertel 8279: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 8280: }
1.506 raeburn 8281: }
8282: return ($authparam,$create_passwd,$authchk);
8283: }
8284:
1.706 raeburn 8285: sub auto_photo_permission {
8286: my ($cnum,$cdom,$students) = @_;
8287: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 8288: my ($outcome,$perm_reqd,$conditions) =
8289: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 8290: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8291: return (undef,undef);
8292: }
1.706 raeburn 8293: return ($outcome,$perm_reqd,$conditions);
8294: }
8295:
8296: sub auto_checkphotos {
8297: my ($uname,$udom,$pid) = @_;
8298: my $homeserver = &homeserver($uname,$udom);
8299: my ($result,$resulttype);
8300: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 8301: &escape($uname).':'.&escape($pid),
8302: $homeserver));
1.709 albertel 8303: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8304: return (undef,undef);
8305: }
1.706 raeburn 8306: if ($outcome) {
8307: ($result,$resulttype) = split(/:/,$outcome);
8308: }
8309: return ($result,$resulttype);
8310: }
8311:
8312: sub auto_photochoice {
8313: my ($cnum,$cdom) = @_;
8314: my $homeserver = &homeserver($cnum,$cdom);
8315: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 8316: &escape($cdom),
8317: $homeserver)));
1.709 albertel 8318: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8319: return (undef,undef);
8320: }
1.706 raeburn 8321: return ($update,$comment);
8322: }
8323:
8324: sub auto_photoupdate {
8325: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8326: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 8327: my $host=&hostname($homeserver);
1.706 raeburn 8328: my $cmd = '';
8329: my $maxtries = 1;
1.800 albertel 8330: foreach my $affiliate (keys(%{$affiliatesref})) {
8331: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 8332: }
8333: $cmd =~ s/%%$//;
8334: $cmd = &escape($cmd);
8335: my $query = 'institutionalphotos';
8336: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8337: unless ($queryid=~/^\Q$host\E\_/) {
8338: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8339: return 'error: '.$queryid;
8340: }
8341: my $reply = &get_query_reply($queryid);
8342: my $tries = 1;
8343: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8344: $reply = &get_query_reply($queryid);
8345: $tries ++;
8346: }
8347: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8348: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8349: } else {
8350: my @responses = split(/:/,$reply);
8351: my $outcome = shift(@responses);
8352: foreach my $item (@responses) {
8353: my ($key,$value) = split(/=/,$item);
8354: $$photo{$key} = $value;
8355: }
8356: return $outcome;
8357: }
8358: return 'error';
8359: }
8360:
1.521 raeburn 8361: sub auto_instcode_format {
1.793 albertel 8362: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8363: $cat_order) = @_;
1.521 raeburn 8364: my $courses = '';
1.772 raeburn 8365: my @homeservers;
1.521 raeburn 8366: if ($caller eq 'global') {
1.841 albertel 8367: my %servers = &get_servers($codedom,'library');
8368: foreach my $tryserver (keys(%servers)) {
8369: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8370: push(@homeservers,$tryserver);
8371: }
1.584 raeburn 8372: }
1.1022 raeburn 8373: } elsif ($caller eq 'requests') {
8374: if ($codedom =~ /^$match_domain$/) {
8375: my $chome = &domain($codedom,'primary');
8376: unless ($chome eq 'no_host') {
8377: push(@homeservers,$chome);
8378: }
8379: }
1.521 raeburn 8380: } else {
1.772 raeburn 8381: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 8382: }
1.793 albertel 8383: foreach my $code (keys(%{$instcodes})) {
8384: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 8385: }
8386: chop($courses);
1.772 raeburn 8387: my $ok_response = 0;
8388: my $response;
8389: while (@homeservers > 0 && $ok_response == 0) {
8390: my $server = shift(@homeservers);
8391: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8392: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8393: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 8394: split(/:/,$response);
1.772 raeburn 8395: %{$codes} = (%{$codes},&str2hash($codes_str));
8396: push(@{$codetitles},&str2array($codetitles_str));
8397: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8398: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8399: $ok_response = 1;
8400: }
8401: }
8402: if ($ok_response) {
1.521 raeburn 8403: return 'ok';
1.772 raeburn 8404: } else {
8405: return $response;
1.521 raeburn 8406: }
8407: }
8408:
1.792 raeburn 8409: sub auto_instcode_defaults {
8410: my ($domain,$returnhash,$code_order) = @_;
8411: my @homeservers;
1.841 albertel 8412:
8413: my %servers = &get_servers($domain,'library');
8414: foreach my $tryserver (keys(%servers)) {
8415: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8416: push(@homeservers,$tryserver);
8417: }
1.792 raeburn 8418: }
1.841 albertel 8419:
1.792 raeburn 8420: my $response;
1.841 albertel 8421: foreach my $server (@homeservers) {
1.792 raeburn 8422: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 8423: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8424:
8425: foreach my $pair (split(/\&/,$response)) {
8426: my ($name,$value)=split(/\=/,$pair);
8427: if ($name eq 'code_order') {
8428: @{$code_order} = split(/\&/,&unescape($value));
8429: } else {
8430: $returnhash->{&unescape($name)}=&unescape($value);
8431: }
8432: }
8433: return 'ok';
1.792 raeburn 8434: }
1.841 albertel 8435:
8436: return $response;
1.1003 raeburn 8437: }
8438:
8439: sub auto_possible_instcodes {
1.1007 raeburn 8440: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8441: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8442: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8443: return;
8444: }
1.1003 raeburn 8445: my (@homeservers,$uhome);
8446: if (defined(&domain($domain,'primary'))) {
8447: $uhome=&domain($domain,'primary');
8448: push(@homeservers,&domain($domain,'primary'));
8449: } else {
8450: my %servers = &get_servers($domain,'library');
8451: foreach my $tryserver (keys(%servers)) {
8452: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8453: push(@homeservers,$tryserver);
8454: }
8455: }
8456: }
8457: my $response;
8458: foreach my $server (@homeservers) {
8459: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8460: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 8461: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8462: split(':',$response);
8463: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8464: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 8465: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 8466: my ($name,$value)=split('=',$item);
8467: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8468: }
8469: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 8470: my ($name,$value)=split('=',$item);
8471: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8472: }
8473: return 'ok';
8474: }
8475: return $response;
8476: }
1.792 raeburn 8477:
1.1010 raeburn 8478: sub auto_courserequest_checks {
8479: my ($dom) = @_;
1.1020 raeburn 8480: my ($homeserver,%validations);
8481: if ($dom =~ /^$match_domain$/) {
8482: $homeserver = &domain($dom,'primary');
8483: }
8484: unless ($homeserver eq 'no_host') {
8485: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8486: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8487: my @items = split(/&/,$response);
8488: foreach my $item (@items) {
8489: my ($key,$value) = split('=',$item);
8490: $validations{&unescape($key)} = &thaw_unescape($value);
8491: }
8492: }
8493: }
1.1010 raeburn 8494: return %validations;
8495: }
8496:
1.1020 raeburn 8497: sub auto_courserequest_validation {
1.1172.2.43 raeburn 8498: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 8499: my ($homeserver,$response);
8500: if ($dom =~ /^$match_domain$/) {
8501: $homeserver = &domain($dom,'primary');
8502: }
1.1172.2.43 raeburn 8503: unless ($homeserver eq 'no_host') {
8504: my $customdata;
8505: if (ref($custominfo) eq 'HASH') {
8506: $customdata = &freeze_escape($custominfo);
8507: }
1.1020 raeburn 8508: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 8509: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1172.2.43 raeburn 8510: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8511: $customdata,$homeserver));
1.1020 raeburn 8512: }
8513: return $response;
8514: }
8515:
1.777 albertel 8516: sub auto_validate_class_sec {
1.918 raeburn 8517: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 8518: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 8519: my $ownerlist;
8520: if (ref($owners) eq 'ARRAY') {
8521: $ownerlist = join(',',@{$owners});
8522: } else {
8523: $ownerlist = $owners;
8524: }
1.773 raeburn 8525: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 8526: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 8527: return $response;
8528: }
8529:
1.1172.2.38 raeburn 8530: sub auto_crsreq_update {
8531: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1172.2.45 raeburn 8532: $code,$accessstart,$accessend,$inbound) = @_;
1.1172.2.38 raeburn 8533: my ($homeserver,%crsreqresponse);
8534: if ($cdom =~ /^$match_domain$/) {
8535: $homeserver = &domain($cdom,'primary');
8536: }
8537: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8538: my $info;
8539: if (ref($inbound) eq 'HASH') {
8540: $info = &freeze_escape($inbound);
8541: }
8542: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8543: ':'.&escape($action).':'.&escape($ownername).':'.
8544: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1172.2.45 raeburn 8545: &escape($title).':'.&escape($code).':'.
8546: &escape($accessstart).':'.&escape($accessend).':'.$info,$homeserver);
1.1172.2.38 raeburn 8547: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8548: my @items = split(/&/,$response);
8549: foreach my $item (@items) {
8550: my ($key,$value) = split('=',$item);
8551: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8552: }
8553: }
8554: }
8555: return \%crsreqresponse;
8556: }
8557:
1.1172.2.78 raeburn 8558: sub auto_export_grades {
8559: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8560: my ($homeserver,%exportresponse);
8561: if ($cdom =~ /^$match_domain$/) {
8562: $homeserver = &domain($cdom,'primary');
8563: }
8564: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8565: my $info;
8566: if (ref($inforef) eq 'HASH') {
8567: $info = &freeze_escape($inforef);
8568: }
8569: if (ref($gradesref) eq 'HASH') {
8570: my $grades = &freeze_escape($gradesref);
8571: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8572: $info.':'.$grades,$homeserver);
8573: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8574: my @items = split(/&/,$response);
8575: foreach my $item (@items) {
8576: my ($key,$value) = split('=',$item);
8577: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8578: }
8579: }
8580: }
8581: }
8582: return \%exportresponse;
8583: }
8584:
1.1172.2.68 raeburn 8585: sub check_instcode_cloning {
8586: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8587: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8588: return;
8589: }
8590: my $canclone;
8591: if (@{$code_order} > 0) {
8592: my $instcoderegexp ='^';
8593: my @clonecodes = split(/\&/,$cloner);
8594: foreach my $item (@{$code_order}) {
8595: if (grep(/^\Q$item\E=/,@clonecodes)) {
8596: foreach my $pair (@clonecodes) {
8597: my ($key,$val) = split(/\=/,$pair,2);
8598: $val = &unescape($val);
8599: if ($key eq $item) {
8600: $instcoderegexp .= '('.$val.')';
8601: last;
8602: }
8603: }
8604: } else {
8605: $instcoderegexp .= $codedefaults->{$item};
8606: }
8607: }
8608: $instcoderegexp .= '$';
8609: my (@from,@to);
8610: eval {
8611: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8612: (@to) = ($clonetocode =~ /$instcoderegexp/);
8613: };
8614: if ((@from > 0) && (@to > 0)) {
8615: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8616: if (!@diffs) {
8617: $canclone = 1;
8618: }
8619: }
8620: }
8621: return $canclone;
8622: }
8623:
8624: sub default_instcode_cloning {
8625: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
8626: my (%codedefaults,@code_order,$canclone);
8627: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
8628: %codedefaults = %{$codedefaultsref};
8629: @code_order = @{$codeorderref};
8630: } elsif ($clonedom) {
8631: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
8632: }
8633: if (($domdefclone) && (@code_order)) {
8634: my @clonecodes = split(/\+/,$domdefclone);
8635: my $instcoderegexp ='^';
8636: foreach my $item (@code_order) {
8637: if (grep(/^\Q$item\E$/,@clonecodes)) {
8638: $instcoderegexp .= '('.$codedefaults{$item}.')';
8639: } else {
8640: $instcoderegexp .= $codedefaults{$item};
8641: }
8642: }
8643: $instcoderegexp .= '$';
8644: my (@from,@to);
8645: eval {
8646: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8647: (@to) = ($clonetocode =~ /$instcoderegexp/);
8648: };
8649: if ((@from > 0) && (@to > 0)) {
8650: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8651: if (!@diffs) {
8652: $canclone = 1;
8653: }
8654: }
8655: }
8656: return $canclone;
8657: }
8658:
1.679 raeburn 8659: # ------------------------------------------------------- Course Group routines
8660:
8661: sub get_coursegroups {
1.809 raeburn 8662: my ($cdom,$cnum,$group,$namespace) = @_;
8663: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 8664: }
8665:
1.679 raeburn 8666: sub modify_coursegroup {
8667: my ($cdom,$cnum,$groupsettings) = @_;
8668: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
8669: }
8670:
1.809 raeburn 8671: sub toggle_coursegroup_status {
8672: my ($cdom,$cnum,$group,$action) = @_;
8673: my ($from_namespace,$to_namespace);
8674: if ($action eq 'delete') {
8675: $from_namespace = 'coursegroups';
8676: $to_namespace = 'deleted_groups';
8677: } else {
8678: $from_namespace = 'deleted_groups';
8679: $to_namespace = 'coursegroups';
8680: }
8681: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 8682: if (my $tmp = &error(%curr_group)) {
8683: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
8684: return ('read error',$tmp);
8685: } else {
8686: my %savedsettings = %curr_group;
1.809 raeburn 8687: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 8688: my $deloutcome;
8689: if ($result eq 'ok') {
1.809 raeburn 8690: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 8691: } else {
8692: return ('write error',$result);
8693: }
8694: if ($deloutcome eq 'ok') {
8695: return 'ok';
8696: } else {
8697: return ('delete error',$deloutcome);
8698: }
8699: }
8700: }
8701:
1.679 raeburn 8702: sub modify_group_roles {
1.957 raeburn 8703: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 8704: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
8705: my $role = 'gr/'.&escape($userprivs);
8706: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 8707: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 8708: if ($result eq 'ok') {
8709: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8710: }
1.679 raeburn 8711: return $result;
8712: }
8713:
8714: sub modify_coursegroup_membership {
8715: my ($cdom,$cnum,$membership) = @_;
8716: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8717: return $result;
8718: }
8719:
1.682 raeburn 8720: sub get_active_groups {
8721: my ($udom,$uname,$cdom,$cnum) = @_;
8722: my $now = time;
8723: my %groups = ();
8724: foreach my $key (keys(%env)) {
1.811 albertel 8725: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 8726: my ($start,$end) = split(/\./,$env{$key});
8727: if (($end!=0) && ($end<$now)) { next; }
8728: if (($start!=0) && ($start>$now)) { next; }
8729: if ($1 eq $cdom && $2 eq $cnum) {
8730: $groups{$3} = $env{$key} ;
8731: }
8732: }
8733: }
8734: return %groups;
8735: }
8736:
1.683 raeburn 8737: sub get_group_membership {
8738: my ($cdom,$cnum,$group) = @_;
8739: return(&dump('groupmembership',$cdom,$cnum,$group));
8740: }
8741:
8742: sub get_users_groups {
8743: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 8744: my @usersgroups;
1.683 raeburn 8745: my $cachetime=1800;
8746:
8747: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 8748: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8749: if (defined($cached)) {
1.734 albertel 8750: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 8751: } else {
8752: $grouplist = '';
1.816 raeburn 8753: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 8754: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 8755: my $access_end = $env{'course.'.$courseid.
8756: '.default_enrollment_end_date'};
8757: my $now = time;
8758: foreach my $key (keys(%roleshash)) {
8759: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8760: my $group = $1;
8761: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8762: my $start = $2;
8763: my $end = $1;
8764: if ($start == -1) { next; } # deleted from group
8765: if (($start!=0) && ($start>$now)) { next; }
8766: if (($end!=0) && ($end<$now)) {
8767: if ($access_end && $access_end < $now) {
8768: if ($access_end - $end < 86400) {
8769: push(@usersgroups,$group);
1.733 raeburn 8770: }
8771: }
1.817 raeburn 8772: next;
1.733 raeburn 8773: }
1.817 raeburn 8774: push(@usersgroups,$group);
1.683 raeburn 8775: }
8776: }
8777: }
1.817 raeburn 8778: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8779: $grouplist = join(':',@usersgroups);
8780: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 8781: }
1.733 raeburn 8782: return @usersgroups;
1.683 raeburn 8783: }
8784:
8785: sub devalidate_getgroups_cache {
8786: my ($udom,$uname,$cdom,$cnum)=@_;
8787: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 8788:
1.683 raeburn 8789: my $hashid="$udom:$uname:$courseid";
8790: &devalidate_cache_new('getgroups',$hashid);
8791: }
8792:
1.12 www 8793: # ------------------------------------------------------------------ Plain Text
8794:
8795: sub plaintext {
1.988 raeburn 8796: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 8797: if ($short =~ m{^cr/}) {
1.758 albertel 8798: return (split('/',$short))[-1];
8799: }
1.742 raeburn 8800: if (!defined($cid)) {
8801: $cid = $env{'request.course.id'};
8802: }
8803: my %rolenames = (
1.1008 raeburn 8804: Course => 'std',
8805: Community => 'alt1',
1.742 raeburn 8806: );
1.1037 raeburn 8807: if ($cid ne '') {
8808: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8809: unless ($forcedefault) {
8810: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8811: &Apache::lonlocal::mt_escape(\$roletext);
8812: return &Apache::lonlocal::mt($roletext);
8813: }
8814: }
8815: }
8816: if ((defined($type)) && (defined($rolenames{$type})) &&
8817: (defined($rolenames{$type})) &&
8818: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 8819: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 8820: } elsif ($cid ne '') {
8821: my $crstype = $env{'course.'.$cid.'.type'};
8822: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8823: (defined($prp{$short}{$rolenames{$crstype}}))) {
8824: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8825: }
1.742 raeburn 8826: }
1.1037 raeburn 8827: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 8828: }
8829:
8830: # ----------------------------------------------------------------- Assign Role
8831:
8832: sub assignrole {
1.957 raeburn 8833: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8834: $context)=@_;
1.21 www 8835: my $mrole;
8836: if ($role =~ /^cr\//) {
1.393 www 8837: my $cwosec=$url;
1.811 albertel 8838: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 8839: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 8840: my $refused = 1;
8841: if ($context eq 'requestcourses') {
8842: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8843: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8844: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8845: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8846: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8847: if ($crsenv{'internal.courseowner'} eq
8848: $env{'user.name'}.':'.$env{'user.domain'}) {
8849: $refused = '';
8850: }
8851: }
8852: }
8853: }
8854: }
8855: if ($refused) {
8856: &logthis('Refused custom assignrole: '.
8857: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8858: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8859: return 'refused';
8860: }
1.104 www 8861: }
1.21 www 8862: $mrole='cr';
1.678 raeburn 8863: } elsif ($role =~ /^gr\//) {
8864: my $cwogrp=$url;
1.811 albertel 8865: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 8866: unless (&allowed('mdg',$cwogrp)) {
8867: &logthis('Refused group assignrole: '.
8868: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8869: $env{'user.name'}.' at '.$env{'user.domain'});
8870: return 'refused';
8871: }
8872: $mrole='gr';
1.21 www 8873: } else {
1.82 www 8874: my $cwosec=$url;
1.811 albertel 8875: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 8876: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8877: my $refused;
8878: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8879: if (!(&allowed('c'.$role,$url))) {
8880: $refused = 1;
8881: }
8882: } else {
8883: $refused = 1;
8884: }
1.947 raeburn 8885: if ($refused) {
1.1045 raeburn 8886: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8887: if (!$selfenroll && $context eq 'course') {
8888: my %crsenv;
8889: if ($role eq 'cc' || $role eq 'co') {
8890: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8891: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8892: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8893: if ($crsenv{'internal.courseowner'} eq
8894: $env{'user.name'}.':'.$env{'user.domain'}) {
8895: $refused = '';
8896: }
8897: }
8898: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8899: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8900: if ($crsenv{'internal.courseowner'} eq
8901: $env{'user.name'}.':'.$env{'user.domain'}) {
8902: $refused = '';
8903: }
8904: }
8905: }
8906: }
8907: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 8908: $refused = '';
1.1017 raeburn 8909: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 8910: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 8911: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 8912: my $wrongcc;
8913: if ($cnum =~ /^$match_community$/) {
8914: $wrongcc = 1 if ($role eq 'cc');
8915: } else {
8916: $wrongcc = 1 if ($role eq 'co');
8917: }
8918: unless ($wrongcc) {
8919: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8920: if ($crsenv{'internal.courseowner'} eq
8921: $env{'user.name'}.':'.$env{'user.domain'}) {
8922: $refused = '';
8923: }
1.1017 raeburn 8924: }
8925: }
1.1172.2.9 raeburn 8926: } elsif ($context eq 'requestauthor') {
8927: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8928: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8929: if ($env{'environment.requestauthor'} eq 'automatic') {
8930: $refused = '';
8931: } else {
8932: my %domdefaults = &get_domain_defaults($udom);
8933: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8934: my $checkbystatus;
8935: if ($env{'user.adv'}) {
8936: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8937: if ($disposition eq 'automatic') {
8938: $refused = '';
8939: } elsif ($disposition eq '') {
8940: $checkbystatus = 1;
8941: }
8942: } else {
8943: $checkbystatus = 1;
8944: }
8945: if ($checkbystatus) {
8946: if ($env{'environment.inststatus'}) {
8947: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8948: foreach my $type (@inststatuses) {
8949: if (($type ne '') &&
8950: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8951: $refused = '';
8952: }
8953: }
8954: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8955: $refused = '';
8956: }
8957: }
8958: }
8959: }
8960: }
1.1017 raeburn 8961: }
8962: if ($refused) {
1.947 raeburn 8963: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8964: ' '.$role.' '.$end.' '.$start.' by '.
8965: $env{'user.name'}.' at '.$env{'user.domain'});
8966: return 'refused';
8967: }
1.932 raeburn 8968: }
1.1131 raeburn 8969: } elsif ($role eq 'au') {
8970: if ($url ne '/'.$udom.'/') {
8971: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8972: ' to assign author role for '.$uname.':'.$udom.
8973: ' in domain: '.$url.' refused (wrong domain).');
8974: return 'refused';
8975: }
1.104 www 8976: }
1.21 www 8977: $mrole=$role;
8978: }
1.620 albertel 8979: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 8980: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 8981: if ($end) { $command.='_'.$end; }
1.21 www 8982: if ($start) {
8983: if ($end) {
1.81 www 8984: $command.='_'.$start;
1.21 www 8985: } else {
1.81 www 8986: $command.='_0_'.$start;
1.21 www 8987: }
8988: }
1.739 raeburn 8989: my $origstart = $start;
8990: my $origend = $end;
1.957 raeburn 8991: my $delflag;
1.357 www 8992: # actually delete
8993: if ($deleteflag) {
1.373 www 8994: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 8995: # modify command to delete the role
1.620 albertel 8996: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 8997: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 8998: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 8999: # set start and finish to negative values for userrolelog
9000: $start=-1;
9001: $end=-1;
1.957 raeburn 9002: $delflag = 1;
1.357 www 9003: }
9004: }
9005: # send command
1.349 www 9006: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 9007: # log new user role if status is ok
1.349 www 9008: if ($answer eq 'ok') {
1.663 raeburn 9009: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1172.2.9 raeburn 9010: if (($role eq 'cc') || ($role eq 'in') ||
9011: ($role eq 'ep') || ($role eq 'ad') ||
9012: ($role eq 'ta') || ($role eq 'st') ||
9013: ($role=~/^cr/) || ($role eq 'gr') ||
9014: ($role eq 'co')) {
1.1172.2.13 raeburn 9015: # for course roles, perform group memberships changes triggered by role change.
9016: unless ($role =~ /^gr/) {
9017: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
9018: $origstart,$selfenroll,$context);
9019: }
1.1172.2.9 raeburn 9020: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9021: $selfenroll,$context);
9022: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1172.2.90! raeburn 9023: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
! 9024: ($role eq 'da')) {
1.1172.2.9 raeburn 9025: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9026: $context);
9027: } elsif (($role eq 'ca') || ($role eq 'aa')) {
9028: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9029: $context);
9030: }
1.1053 raeburn 9031: if ($role eq 'cc') {
9032: &autoupdate_coowners($url,$end,$start,$uname,$udom);
9033: }
1.349 www 9034: }
9035: return $answer;
1.169 harris41 9036: }
9037:
1.1053 raeburn 9038: sub autoupdate_coowners {
9039: my ($url,$end,$start,$uname,$udom) = @_;
9040: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
9041: if (($cdom ne '') && ($cnum ne '')) {
9042: my $now = time;
9043: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
9044: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
9045: my %coursehash = &coursedescription($cdom.'_'.$cnum);
9046: my $instcode = $coursehash{'internal.coursecode'};
9047: if ($instcode ne '') {
1.1056 raeburn 9048: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
9049: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 9050: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 9051: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
9052: if ($result eq 'valid') {
9053: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 9054: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9055: push(@newcoowners,$coowner);
9056: }
9057: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
9058: push(@newcoowners,$uname.':'.$udom);
9059: }
9060: @newcoowners = sort(@newcoowners);
9061: } else {
9062: push(@newcoowners,$uname.':'.$udom);
9063: }
9064: } else {
9065: if ($coursehash{'internal.co-owners'}) {
9066: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9067: unless ($coowner eq $uname.':'.$udom) {
9068: push(@newcoowners,$coowner);
9069: }
9070: }
9071: unless (@newcoowners > 0) {
9072: $delcoowners = 1;
9073: $coowners = '';
9074: }
9075: }
9076: }
9077: if (@newcoowners || $delcoowners) {
9078: &store_coowners($cdom,$cnum,$coursehash{'home'},
9079: $delcoowners,@newcoowners);
9080: }
9081: }
9082: }
9083: }
9084: }
9085: }
9086: }
9087:
9088: sub store_coowners {
9089: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
9090: my $cid = $cdom.'_'.$cnum;
9091: my ($coowners,$delresult,$putresult);
9092: if (@newcoowners) {
9093: $coowners = join(',',@newcoowners);
9094: my %coownershash = (
9095: 'internal.co-owners' => $coowners,
9096: );
9097: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
9098: if ($putresult eq 'ok') {
9099: if ($env{'course.'.$cid.'.num'} eq $cnum) {
9100: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
9101: }
9102: }
9103: }
9104: if ($delcoowners) {
9105: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
9106: if ($delresult eq 'ok') {
9107: if ($env{'course.'.$cid.'.internal.co-owners'}) {
9108: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
9109: }
9110: }
9111: }
9112: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
9113: my %crsinfo =
9114: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
9115: if (ref($crsinfo{$cid}) eq 'HASH') {
9116: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
9117: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
9118: }
9119: }
9120: }
9121:
1.169 harris41 9122: # -------------------------------------------------- Modify user authentication
1.197 www 9123: # Overrides without validation
9124:
1.169 harris41 9125: sub modifyuserauth {
9126: my ($udom,$uname,$umode,$upass)=@_;
9127: my $uhome=&homeserver($uname,$udom);
1.197 www 9128: unless (&allowed('mau',$udom)) { return 'refused'; }
9129: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 9130: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9131: ' in domain '.$env{'request.role.domain'});
1.169 harris41 9132: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
9133: &escape($upass),$uhome);
1.620 albertel 9134: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 9135: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
9136: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9137: &log($udom,,$uname,$uhome,
1.620 albertel 9138: 'Authentication changed by '.$env{'user.domain'}.', '.
9139: $env{'user.name'}.', '.$umode.
1.197 www 9140: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 9141: unless ($reply eq 'ok') {
1.197 www 9142: &logthis('Authentication mode error: '.$reply);
1.169 harris41 9143: return 'error: '.$reply;
9144: }
1.170 harris41 9145: return 'ok';
1.80 www 9146: }
9147:
1.81 www 9148: # --------------------------------------------------------------- Modify a user
1.80 www 9149:
1.81 www 9150: sub modifyuser {
1.206 matthew 9151: my ($udom, $uname, $uid,
9152: $umode, $upass, $first,
9153: $middle, $last, $gene,
1.1058 raeburn 9154: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 9155: $udom= &LONCAPA::clean_domain($udom);
9156: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 9157: my $showcandelete = 'none';
9158: if (ref($candelete) eq 'ARRAY') {
9159: if (@{$candelete} > 0) {
9160: $showcandelete = join(', ',@{$candelete});
9161: }
9162: }
1.81 www 9163: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 9164: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 9165: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 9166: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
9167: ' desiredhome not specified').
1.620 albertel 9168: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9169: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 9170: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 9171: my $newuser;
9172: if ($uhome eq 'no_host') {
9173: $newuser = 1;
9174: }
1.80 www 9175: # ----------------------------------------------------------------- Create User
1.406 albertel 9176: if (($uhome eq 'no_host') &&
9177: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 9178: my $unhome='';
1.844 albertel 9179: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 9180: $unhome = $desiredhome;
1.620 albertel 9181: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
9182: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 9183: } else { # load balancing routine for determining $unhome
1.81 www 9184: my $loadm=10000000;
1.841 albertel 9185: my %servers = &get_servers($udom,'library');
9186: foreach my $tryserver (keys(%servers)) {
9187: my $answer=reply('load',$tryserver);
9188: if (($answer=~/\d+/) && ($answer<$loadm)) {
9189: $loadm=$answer;
9190: $unhome=$tryserver;
9191: }
1.80 www 9192: }
9193: }
9194: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 9195: return 'error: unable to find a home server for '.$uname.
9196: ' in domain '.$udom;
1.80 www 9197: }
9198: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
9199: &escape($upass),$unhome);
9200: unless ($reply eq 'ok') {
9201: return 'error: '.$reply;
9202: }
1.230 stredwic 9203: $uhome=&homeserver($uname,$udom,'true');
1.80 www 9204: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 9205: return 'error: unable verify users home machine.';
1.80 www 9206: }
1.209 matthew 9207: } # End of creation of new user
1.80 www 9208: # ---------------------------------------------------------------------- Add ID
9209: if ($uid) {
9210: $uid=~tr/A-Z/a-z/;
9211: my %uidhash=&idrget($udom,$uname);
1.196 www 9212: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
9213: && (!$forceid)) {
1.80 www 9214: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 9215: return 'error: user id "'.$uid.'" does not match '.
9216: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 9217: }
9218: } else {
9219: &idput($udom,($uname => $uid));
9220: }
9221: }
9222: # -------------------------------------------------------------- Add names, etc
1.313 matthew 9223: my @tmp=&get('environment',
1.899 raeburn 9224: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 9225: 'permanentemail','inststatus'],
1.134 albertel 9226: $udom,$uname);
1.1075 raeburn 9227: my (%names,%oldnames);
1.313 matthew 9228: if ($tmp[0] =~ m/^error:.*/) {
9229: %names=();
9230: } else {
9231: %names = @tmp;
1.1075 raeburn 9232: %oldnames = %names;
1.313 matthew 9233: }
1.388 www 9234: #
1.1058 raeburn 9235: # If name, email and/or uid are blank (e.g., because an uploaded file
9236: # of users did not contain them), do not overwrite existing values
9237: # unless field is in $candelete array ref.
9238: #
9239:
9240: my @fields = ('firstname','middlename','lastname','generation',
9241: 'permanentemail','id');
9242: my %newvalues;
9243: if (ref($candelete) eq 'ARRAY') {
9244: foreach my $field (@fields) {
9245: if (grep(/^\Q$field\E$/,@{$candelete})) {
9246: if ($field eq 'firstname') {
9247: $names{$field} = $first;
9248: } elsif ($field eq 'middlename') {
9249: $names{$field} = $middle;
9250: } elsif ($field eq 'lastname') {
9251: $names{$field} = $last;
9252: } elsif ($field eq 'generation') {
9253: $names{$field} = $gene;
9254: } elsif ($field eq 'permanentemail') {
9255: $names{$field} = $email;
9256: } elsif ($field eq 'id') {
9257: $names{$field} = $uid;
9258: }
9259: }
9260: }
9261: }
1.388 www 9262: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 9263: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 9264: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 9265: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 9266: if ($email) {
9267: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 9268: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 9269: }
1.899 raeburn 9270: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 9271: if (defined($inststatus)) {
9272: $names{'inststatus'} = '';
9273: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9274: if (ref($usertypes) eq 'HASH') {
9275: my @okstatuses;
9276: foreach my $item (split(/:/,$inststatus)) {
9277: if (defined($usertypes->{$item})) {
9278: push(@okstatuses,$item);
9279: }
9280: }
9281: if (@okstatuses) {
9282: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9283: }
9284: }
9285: }
1.1075 raeburn 9286: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 9287: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 9288: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 9289: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9290: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9291: } else {
9292: $logmsg .= ' during self creation';
9293: }
1.1075 raeburn 9294: my $changed;
9295: if ($newuser) {
9296: $changed = 1;
9297: } else {
9298: foreach my $field (@fields) {
9299: if ($names{$field} ne $oldnames{$field}) {
9300: $changed = 1;
9301: last;
9302: }
9303: }
9304: }
9305: unless ($changed) {
9306: $logmsg = 'No changes in user information needed for: '.$logmsg;
9307: &logthis($logmsg);
9308: return 'ok';
9309: }
9310: my $reply = &put('environment', \%names, $udom,$uname);
9311: if ($reply ne 'ok') {
9312: return 'error: '.$reply;
9313: }
1.1087 raeburn 9314: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9315: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9316: }
1.1075 raeburn 9317: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9318: &devalidate_cache_new('namescache',$uname.':'.$udom);
9319: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 9320: &logthis($logmsg);
1.134 albertel 9321: return 'ok';
1.80 www 9322: }
9323:
1.81 www 9324: # -------------------------------------------------------------- Modify student
1.80 www 9325:
1.81 www 9326: sub modifystudent {
9327: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 9328: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1172.2.76 raeburn 9329: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 9330: if (!$cid) {
1.620 albertel 9331: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9332: return 'not_in_class';
9333: }
1.80 www 9334: }
9335: # --------------------------------------------------------------- Make the user
1.81 www 9336: my $reply=&modifyuser
1.209 matthew 9337: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 9338: $desiredhome,$email,$inststatus);
1.80 www 9339: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 9340: # This will cause &modify_student_enrollment to get the uid from the
1.1172.2.31 raeburn 9341: # student's environment
1.297 matthew 9342: $uid = undef if (!$forceid);
1.455 albertel 9343: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1172.2.19 raeburn 9344: $gene,$usec,$end,$start,$type,$locktype,
1.1172.2.76 raeburn 9345: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 9346: return $reply;
9347: }
9348:
9349: sub modify_student_enrollment {
1.1172.2.23 raeburn 9350: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1172.2.76 raeburn 9351: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455 albertel 9352: my ($cdom,$cnum,$chome);
9353: if (!$cid) {
1.620 albertel 9354: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9355: return 'not_in_class';
9356: }
1.620 albertel 9357: $cdom=$env{'course.'.$cid.'.domain'};
9358: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 9359: } else {
9360: ($cdom,$cnum)=split(/_/,$cid);
9361: }
1.620 albertel 9362: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 9363: if (!$chome) {
1.457 raeburn 9364: $chome=&homeserver($cnum,$cdom);
1.297 matthew 9365: }
1.455 albertel 9366: if (!$chome) { return 'unknown_course'; }
1.297 matthew 9367: # Make sure the user exists
1.81 www 9368: my $uhome=&homeserver($uname,$udom);
9369: if (($uhome eq '') || ($uhome eq 'no_host')) {
9370: return 'error: no such user';
9371: }
1.297 matthew 9372: # Get student data if we were not given enough information
9373: if (!defined($first) || $first eq '' ||
9374: !defined($last) || $last eq '' ||
9375: !defined($uid) || $uid eq '' ||
9376: !defined($middle) || $middle eq '' ||
9377: !defined($gene) || $gene eq '') {
1.294 matthew 9378: # They did not supply us with enough data to enroll the student, so
9379: # we need to pick up more information.
1.297 matthew 9380: my %tmp = &get('environment',
1.294 matthew 9381: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 9382: ,$udom,$uname);
9383:
1.800 albertel 9384: #foreach my $key (keys(%tmp)) {
9385: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 9386: #}
1.294 matthew 9387: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9388: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9389: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 9390: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 9391: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9392: }
1.556 albertel 9393: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 9394: my $user = "$uname:$udom";
9395: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 9396: my $reply=cput('classlist',
1.1148 raeburn 9397: {$user =>
1.1172.2.76 raeburn 9398: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 9399: $cdom,$cnum);
1.1148 raeburn 9400: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9401: &devalidate_getsection_cache($udom,$uname,$cid);
9402: } else {
1.81 www 9403: return 'error: '.$reply;
9404: }
1.297 matthew 9405: # Add student role to user
1.83 www 9406: my $uurl='/'.$cid;
1.81 www 9407: $uurl=~s/\_/\//g;
9408: if ($usec) {
9409: $uurl.='/'.$usec;
9410: }
1.1148 raeburn 9411: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9412: $selfenroll,$context);
9413: if ($result ne 'ok') {
9414: if ($old_entry{$user} ne '') {
9415: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9416: } else {
9417: $reply = &del('classlist',[$user],$cdom,$cnum);
9418: }
9419: }
9420: return $result;
1.21 www 9421: }
9422:
1.556 albertel 9423: sub format_name {
9424: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9425: my $name;
9426: if ($first ne 'lastname') {
9427: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9428: } else {
9429: if ($lastname=~/\S/) {
9430: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9431: $name=~s/\s+,/,/;
9432: } else {
9433: $name.= $firstname.' '.$middlename.' '.$generation;
9434: }
9435: }
9436: $name=~s/^\s+//;
9437: $name=~s/\s+$//;
9438: $name=~s/\s+/ /g;
9439: return $name;
9440: }
9441:
1.84 www 9442: # ------------------------------------------------- Write to course preferences
9443:
9444: sub writecoursepref {
9445: my ($courseid,%prefs)=@_;
9446: $courseid=~s/^\///;
9447: $courseid=~s/\_/\//g;
9448: my ($cdomain,$cnum)=split(/\//,$courseid);
9449: my $chome=homeserver($cnum,$cdomain);
9450: if (($chome eq '') || ($chome eq 'no_host')) {
9451: return 'error: no such course';
9452: }
9453: my $cstring='';
1.800 albertel 9454: foreach my $pref (keys(%prefs)) {
9455: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 9456: }
1.84 www 9457: $cstring=~s/\&$//;
9458: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9459: }
9460:
9461: # ---------------------------------------------------------- Make/modify course
9462:
9463: sub createcourse {
1.741 raeburn 9464: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 9465: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 9466: $url=&declutter($url);
9467: my $cid='';
1.1028 raeburn 9468: if ($context eq 'requestcourses') {
9469: my $can_create = 0;
9470: my ($ownername,$ownerdom) = split(':',$course_owner);
9471: if ($udom eq $ownerdom) {
9472: if (&usertools_access($ownername,$ownerdom,$category,undef,
9473: $context)) {
9474: $can_create = 1;
9475: }
9476: } else {
9477: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9478: $category);
9479: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9480: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9481: if (@curr > 0) {
9482: my @options = qw(approval validate autolimit);
9483: my $optregex = join('|',@options);
9484: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9485: $can_create = 1;
9486: }
9487: }
9488: }
9489: }
9490: if ($can_create) {
9491: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9492: unless (&allowed('ccc',$udom)) {
9493: return 'refused';
9494: }
1.1017 raeburn 9495: }
9496: } else {
9497: return 'refused';
9498: }
1.1028 raeburn 9499: } elsif (!&allowed('ccc',$udom)) {
9500: return 'refused';
1.84 www 9501: }
1.1011 raeburn 9502: # --------------------------------------------------------------- Get Unique ID
9503: my $uname;
9504: if ($cnum =~ /^$match_courseid$/) {
9505: my $chome=&homeserver($cnum,$udom,'true');
9506: if (($chome eq '') || ($chome eq 'no_host')) {
9507: $uname = $cnum;
9508: } else {
1.1038 raeburn 9509: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9510: }
9511: } else {
1.1038 raeburn 9512: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9513: }
9514: return $uname if ($uname =~ /^error/);
9515: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 9516: if (!defined($course_server)) {
9517: if (defined(&domain($udom,'primary'))) {
9518: $course_server = &domain($udom,'primary');
9519: } else {
9520: $course_server = $env{'user.home'};
9521: }
9522: }
9523: my %host_servers =
9524: &Apache::lonnet::get_servers($udom,'library');
9525: unless ($host_servers{$course_server}) {
9526: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 9527: }
1.84 www 9528: # ------------------------------------------------------------- Make the course
9529: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 9530: $course_server);
1.84 www 9531: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 9532: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 9533: if (($uhome eq '') || ($uhome eq 'no_host')) {
9534: return 'error: no such course';
9535: }
1.271 www 9536: # ----------------------------------------------------------------- Course made
1.516 raeburn 9537: # log existence
1.1029 raeburn 9538: my $now = time;
1.918 raeburn 9539: my $newcourse = {
9540: $udom.'_'.$uname => {
1.921 raeburn 9541: description => $description,
9542: inst_code => $inst_code,
9543: owner => $course_owner,
9544: type => $crstype,
1.1029 raeburn 9545: creator => $env{'user.name'}.':'.
9546: $env{'user.domain'},
9547: created => $now,
9548: context => $context,
1.918 raeburn 9549: },
9550: };
1.921 raeburn 9551: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 9552: # set toplevel url
1.271 www 9553: my $topurl=$url;
9554: unless ($nonstandard) {
9555: # ------------------------------------------ For standard courses, make top url
9556: my $mapurl=&clutter($url);
1.278 www 9557: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 9558: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 9559: <map>
9560: <resource id="1" type="start"></resource>
9561: <resource id="2" src="$mapurl"></resource>
9562: <resource id="3" type="finish"></resource>
9563: <link index="1" from="1" to="2"></link>
9564: <link index="2" from="2" to="3"></link>
9565: </map>
9566: ENDINITMAP
9567: $topurl=&declutter(
1.638 albertel 9568: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 9569: );
9570: }
9571: # ----------------------------------------------------------- Write preferences
1.84 www 9572: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 9573: ('description' => $description,
9574: 'url' => $topurl,
9575: 'internal.creator' => $env{'user.name'}.':'.
9576: $env{'user.domain'},
9577: 'internal.created' => $now,
9578: 'internal.creationcontext' => $context)
9579: );
1.84 www 9580: return '/'.$udom.'/'.$uname;
9581: }
9582:
1.1011 raeburn 9583: # ------------------------------------------------------------------- Create ID
9584: sub generate_coursenum {
1.1038 raeburn 9585: my ($udom,$crstype) = @_;
1.1011 raeburn 9586: my $domdesc = &domain($udom);
9587: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 9588: my $first;
9589: if ($crstype eq 'Community') {
9590: $first = '0';
9591: } else {
9592: $first = int(1+rand(9));
9593: }
9594: my $uname=$first.
1.1011 raeburn 9595: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9596: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9597: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9598: # ----------------------------------------------- Make sure that does not exist
9599: my $uhome=&homeserver($uname,$udom,'true');
9600: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 9601: if ($crstype eq 'Community') {
9602: $first = '0';
9603: } else {
9604: $first = int(1+rand(9));
9605: }
9606: $uname=$first.
1.1011 raeburn 9607: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9608: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9609: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9610: $uhome=&homeserver($uname,$udom,'true');
9611: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9612: return 'error: unable to generate unique course-ID';
9613: }
9614: }
9615: return $uname;
9616: }
9617:
1.813 albertel 9618: sub is_course {
1.1167 droeschl 9619: my ($cdom, $cnum) = scalar(@_) == 1 ?
9620: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
9621:
9622: return unless $cdom and $cnum;
9623:
9624: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
9625: '.');
9626:
1.1172.2.23 raeburn 9627: return unless(exists($courses{$cdom.'_'.$cnum}));
1.1167 droeschl 9628: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 9629: }
9630:
1.1015 raeburn 9631: sub store_userdata {
9632: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 9633: my $result;
1.1016 raeburn 9634: if ($datakey ne '') {
1.1013 raeburn 9635: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 9636: if ($udom eq '' || $uname eq '') {
9637: $udom = $env{'user.domain'};
9638: $uname = $env{'user.name'};
9639: }
9640: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 9641: if (($uhome eq '') || ($uhome eq 'no_host')) {
9642: $result = 'error: no_host';
9643: } else {
9644: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
9645: $storehash->{'host'} = $perlvar{'lonHostID'};
9646:
9647: my $namevalue='';
9648: foreach my $key (keys(%{$storehash})) {
9649: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
9650: }
9651: $namevalue=~s/\&$//;
1.1172.2.26 raeburn 9652: unless ($namespace eq 'courserequests') {
9653: $datakey = &escape($datakey);
9654: }
1.1105 raeburn 9655: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
9656: $namevalue,$uhome);
1.1013 raeburn 9657: }
9658: } else {
9659: $result = 'error: data to store was not a hash reference';
9660: }
9661: } else {
9662: $result= 'error: invalid requestkey';
9663: }
9664: return $result;
9665: }
9666:
1.21 www 9667: # ---------------------------------------------------------- Assign Custom Role
9668:
9669: sub assigncustomrole {
1.957 raeburn 9670: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9671: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 9672: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 9673: }
9674:
9675: # ----------------------------------------------------------------- Revoke Role
9676:
9677: sub revokerole {
1.957 raeburn 9678: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9679: my $now=time;
1.965 raeburn 9680: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 9681: }
9682:
9683: # ---------------------------------------------------------- Revoke Custom Role
9684:
9685: sub revokecustomrole {
1.957 raeburn 9686: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9687: my $now=time;
1.357 www 9688: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 9689: $deleteflag,$selfenroll,$context);
1.17 www 9690: }
9691:
1.533 banghart 9692: # ------------------------------------------------------------ Disk usage
1.535 albertel 9693: sub diskusage {
1.955 raeburn 9694: my ($udom,$uname,$directorypath,$getpropath)=@_;
9695: $directorypath =~ s/\/$//;
9696: my $listing=&reply('du2:'.&escape($directorypath).':'
9697: .&escape($getpropath).':'.&escape($uname).':'
9698: .&escape($udom),homeserver($uname,$udom));
9699: if ($listing eq 'unknown_cmd') {
9700: if ($getpropath) {
9701: $directorypath = &propath($udom,$uname).'/'.$directorypath;
9702: }
9703: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
9704: }
1.514 albertel 9705: return $listing;
1.512 banghart 9706: }
9707:
1.566 banghart 9708: sub is_locked {
1.1096 raeburn 9709: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 9710: my @check;
9711: my $is_locked;
1.1093 raeburn 9712: push (@check,$file_name);
1.613 albertel 9713: my %locked = &get('file_permissions',\@check,
1.620 albertel 9714: $env{'user.domain'},$env{'user.name'});
1.615 albertel 9715: my ($tmp)=keys(%locked);
9716: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 9717:
1.566 banghart 9718: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 9719: $is_locked = 'false';
9720: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 9721: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 9722: $is_locked = 'true';
1.1096 raeburn 9723: if (ref($which) eq 'ARRAY') {
9724: push(@{$which},$entry);
9725: } else {
9726: last;
9727: }
1.745 raeburn 9728: }
9729: }
1.566 banghart 9730: } else {
9731: $is_locked = 'false';
9732: }
1.1093 raeburn 9733: return $is_locked;
1.566 banghart 9734: }
9735:
1.759 albertel 9736: sub declutter_portfile {
9737: my ($file) = @_;
1.833 albertel 9738: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 9739: return $file;
9740: }
9741:
1.559 banghart 9742: # ------------------------------------------------------------- Mark as Read Only
9743:
9744: sub mark_as_readonly {
9745: my ($domain,$user,$files,$what) = @_;
1.613 albertel 9746: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 9747: my ($tmp)=keys(%current_permissions);
9748: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 9749: foreach my $file (@{$files}) {
1.759 albertel 9750: $file = &declutter_portfile($file);
1.561 banghart 9751: push(@{$current_permissions{$file}},$what);
1.559 banghart 9752: }
1.613 albertel 9753: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 9754: return;
9755: }
9756:
1.572 banghart 9757: # ------------------------------------------------------------Save Selected Files
9758:
9759: sub save_selected_files {
9760: my ($user, $path, @files) = @_;
9761: my $filename = $user."savedfiles";
1.573 banghart 9762: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 9763: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 9764: foreach my $file (@files) {
1.620 albertel 9765: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 9766: }
9767: foreach my $file (@other_files) {
1.574 banghart 9768: print (OUT $file."\n");
1.572 banghart 9769: }
1.574 banghart 9770: close (OUT);
1.572 banghart 9771: return 'ok';
9772: }
9773:
1.574 banghart 9774: sub clear_selected_files {
9775: my ($user) = @_;
9776: my $filename = $user."savedfiles";
1.1117 foxr 9777: open (OUT, '>'.LONCAPA::tempdir().$filename);
1.574 banghart 9778: print (OUT undef);
9779: close (OUT);
9780: return ("ok");
9781: }
9782:
1.572 banghart 9783: sub files_in_path {
9784: my ($user, $path) = @_;
9785: my $filename = $user."savedfiles";
9786: my %return_files;
1.1117 foxr 9787: open (IN, '<'.LONCAPA::tempdir().$filename);
1.573 banghart 9788: while (my $line_in = <IN>) {
1.574 banghart 9789: chomp ($line_in);
9790: my @paths_and_file = split (m!/!, $line_in);
9791: my $file_part = pop (@paths_and_file);
9792: my $path_part = join ('/', @paths_and_file);
1.573 banghart 9793: $path_part.='/';
9794: my $path_and_file = $path_part.$file_part;
9795: if ($path_part eq $path) {
9796: $return_files{$file_part}= 'selected';
9797: }
9798: }
1.574 banghart 9799: close (IN);
9800: return (\%return_files);
1.572 banghart 9801: }
9802:
9803: # called in portfolio select mode, to show files selected NOT in current directory
9804: sub files_not_in_path {
9805: my ($user, $path) = @_;
9806: my $filename = $user."savedfiles";
9807: my @return_files;
9808: my $path_part;
1.1117 foxr 9809: open(IN, '<'.LONCAPA::.$filename);
1.800 albertel 9810: while (my $line = <IN>) {
1.572 banghart 9811: #ok, I know it's clunky, but I want it to work
1.800 albertel 9812: my @paths_and_file = split(m|/|, $line);
9813: my $file_part = pop(@paths_and_file);
9814: chomp($file_part);
9815: my $path_part = join('/', @paths_and_file);
1.572 banghart 9816: $path_part .= '/';
9817: my $path_and_file = $path_part.$file_part;
9818: if ($path_part ne $path) {
1.800 albertel 9819: push(@return_files, ($path_and_file));
1.572 banghart 9820: }
9821: }
1.800 albertel 9822: close(OUT);
1.574 banghart 9823: return (@return_files);
1.572 banghart 9824: }
9825:
1.745 raeburn 9826: #----------------------------------------------Get portfolio file permissions
1.629 banghart 9827:
1.745 raeburn 9828: sub get_portfile_permissions {
9829: my ($domain,$user) = @_;
1.613 albertel 9830: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 9831: my ($tmp)=keys(%current_permissions);
9832: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 9833: return \%current_permissions;
9834: }
9835:
9836: #---------------------------------------------Get portfolio file access controls
9837:
1.749 raeburn 9838: sub get_access_controls {
1.745 raeburn 9839: my ($current_permissions,$group,$file) = @_;
1.769 albertel 9840: my %access;
9841: my $real_file = $file;
9842: $file =~ s/\.meta$//;
1.745 raeburn 9843: if (defined($file)) {
1.749 raeburn 9844: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9845: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 9846: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 9847: }
9848: }
1.745 raeburn 9849: } else {
1.749 raeburn 9850: foreach my $key (keys(%{$current_permissions})) {
9851: if ($key =~ /\0accesscontrol$/) {
9852: if (defined($group)) {
9853: if ($key !~ m-^\Q$group\E/-) {
9854: next;
9855: }
9856: }
9857: my ($fullpath) = split(/\0/,$key);
9858: if (ref($$current_permissions{$key}) eq 'HASH') {
9859: foreach my $control (keys(%{$$current_permissions{$key}})) {
9860: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9861: }
9862: }
9863: }
9864: }
9865: }
9866: return %access;
9867: }
9868:
9869: sub modify_access_controls {
9870: my ($file_name,$changes,$domain,$user)=@_;
9871: my ($outcome,$deloutcome);
9872: my %store_permissions;
9873: my %new_values;
9874: my %new_control;
9875: my %translation;
9876: my @deletions = ();
9877: my $now = time;
9878: if (exists($$changes{'activate'})) {
9879: if (ref($$changes{'activate'}) eq 'HASH') {
9880: my @newitems = sort(keys(%{$$changes{'activate'}}));
9881: my $numnew = scalar(@newitems);
9882: for (my $i=0; $i<$numnew; $i++) {
9883: my $newkey = $newitems[$i];
9884: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 9885: if ($newkey =~ /^\d+:/) {
9886: $newkey =~ s/^(\d+)/$newid/;
9887: $translation{$1} = $newid;
9888: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9889: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9890: $translation{$1} = $newid;
9891: }
1.749 raeburn 9892: $new_values{$file_name."\0".$newkey} =
9893: $$changes{'activate'}{$newitems[$i]};
9894: $new_control{$newkey} = $now;
9895: }
9896: }
9897: }
9898: my %todelete;
9899: my %changed_items;
9900: foreach my $action ('delete','update') {
9901: if (exists($$changes{$action})) {
9902: if (ref($$changes{$action}) eq 'HASH') {
9903: foreach my $key (keys(%{$$changes{$action}})) {
9904: my ($itemnum) = ($key =~ /^([^:]+):/);
9905: if ($action eq 'delete') {
9906: $todelete{$itemnum} = 1;
9907: } else {
9908: $changed_items{$itemnum} = $key;
9909: }
9910: }
1.745 raeburn 9911: }
9912: }
1.749 raeburn 9913: }
9914: # get lock on access controls for file.
9915: my $lockhash = {
9916: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9917: ':'.$env{'user.domain'},
9918: };
9919: my $tries = 0;
9920: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9921:
1.1172.2.79 raeburn 9922: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 9923: $tries ++;
1.1172.2.79 raeburn 9924: sleep(0.1);
1.749 raeburn 9925: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9926: }
9927: if ($gotlock eq 'ok') {
9928: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9929: my ($tmp)=keys(%curr_permissions);
9930: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9931: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9932: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9933: if (ref($curr_controls) eq 'HASH') {
9934: foreach my $control_item (keys(%{$curr_controls})) {
9935: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9936: if (defined($todelete{$itemnum})) {
9937: push(@deletions,$file_name."\0".$control_item);
9938: } else {
9939: if (defined($changed_items{$itemnum})) {
9940: $new_control{$changed_items{$itemnum}} = $now;
9941: push(@deletions,$file_name."\0".$control_item);
9942: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9943: } else {
9944: $new_control{$control_item} = $$curr_controls{$control_item};
9945: }
9946: }
1.745 raeburn 9947: }
9948: }
9949: }
1.970 raeburn 9950: my ($group);
9951: if (&is_course($domain,$user)) {
9952: ($group,my $file) = split(/\//,$file_name,2);
9953: }
1.749 raeburn 9954: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9955: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9956: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9957: # remove lock
9958: my @del_lock = ($file_name."\0".'locked_access_records');
9959: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 9960: my $sqlresult =
1.970 raeburn 9961: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 9962: $group);
1.749 raeburn 9963: } else {
9964: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 9965: }
1.749 raeburn 9966: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 9967: }
9968:
1.827 raeburn 9969: sub make_public_indefinitely {
9970: my ($requrl) = @_;
9971: my $now = time;
9972: my $action = 'activate';
9973: my $aclnum = 0;
9974: if (&is_portfolio_url($requrl)) {
9975: my (undef,$udom,$unum,$file_name,$group) =
9976: &parse_portfolio_url($requrl);
9977: my $current_perms = &get_portfile_permissions($udom,$unum);
9978: my %access_controls = &get_access_controls($current_perms,
9979: $group,$file_name);
9980: foreach my $key (keys(%{$access_controls{$file_name}})) {
9981: my ($num,$scope,$end,$start) =
9982: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
9983: if ($scope eq 'public') {
9984: if ($start <= $now && $end == 0) {
9985: $action = 'none';
9986: } else {
9987: $action = 'update';
9988: $aclnum = $num;
9989: }
9990: last;
9991: }
9992: }
9993: if ($action eq 'none') {
9994: return 'ok';
9995: } else {
9996: my %changes;
9997: my $newend = 0;
9998: my $newstart = $now;
9999: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
10000: $changes{$action}{$newkey} = {
10001: type => 'public',
10002: time => {
10003: start => $newstart,
10004: end => $newend,
10005: },
10006: };
10007: my ($outcome,$deloutcome,$new_values,$translation) =
10008: &modify_access_controls($file_name,\%changes,$udom,$unum);
10009: return $outcome;
10010: }
10011: } else {
10012: return 'invalid';
10013: }
10014: }
10015:
1.745 raeburn 10016: #------------------------------------------------------Get Marked as Read Only
10017:
10018: sub get_marked_as_readonly {
10019: my ($domain,$user,$what,$group) = @_;
10020: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 10021: my @readonly_files;
1.629 banghart 10022: my $cmp1=$what;
10023: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 10024: while (my ($file_name,$value) = each(%{$current_permissions})) {
10025: if (defined($group)) {
10026: if ($file_name !~ m-^\Q$group\E/-) {
10027: next;
10028: }
10029: }
1.561 banghart 10030: if (ref($value) eq "ARRAY"){
10031: foreach my $stored_what (@{$value}) {
1.629 banghart 10032: my $cmp2=$stored_what;
1.759 albertel 10033: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 10034: $cmp2=join('',@{$stored_what});
1.745 raeburn 10035: }
1.629 banghart 10036: if ($cmp1 eq $cmp2) {
1.561 banghart 10037: push(@readonly_files, $file_name);
1.745 raeburn 10038: last;
1.563 banghart 10039: } elsif (!defined($what)) {
10040: push(@readonly_files, $file_name);
1.745 raeburn 10041: last;
1.561 banghart 10042: }
10043: }
1.745 raeburn 10044: }
1.561 banghart 10045: }
10046: return @readonly_files;
10047: }
1.577 banghart 10048: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 10049:
1.577 banghart 10050: sub get_marked_as_readonly_hash {
1.745 raeburn 10051: my ($current_permissions,$group,$what) = @_;
1.577 banghart 10052: my %readonly_files;
1.745 raeburn 10053: while (my ($file_name,$value) = each(%{$current_permissions})) {
10054: if (defined($group)) {
10055: if ($file_name !~ m-^\Q$group\E/-) {
10056: next;
10057: }
10058: }
1.577 banghart 10059: if (ref($value) eq "ARRAY"){
10060: foreach my $stored_what (@{$value}) {
1.745 raeburn 10061: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 10062: foreach my $lock_descriptor(@{$stored_what}) {
10063: if ($lock_descriptor eq 'graded') {
10064: $readonly_files{$file_name} = 'graded';
10065: } elsif ($lock_descriptor eq 'handback') {
10066: $readonly_files{$file_name} = 'handback';
10067: } else {
10068: if (!exists($readonly_files{$file_name})) {
10069: $readonly_files{$file_name} = 'locked';
10070: }
10071: }
1.745 raeburn 10072: }
1.750 banghart 10073: }
1.577 banghart 10074: }
10075: }
10076: }
10077: return %readonly_files;
10078: }
1.559 banghart 10079: # ------------------------------------------------------------ Unmark as Read Only
10080:
10081: sub unmark_as_readonly {
1.629 banghart 10082: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10083: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 10084: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 10085: $file_name = &declutter_portfile($file_name);
1.634 albertel 10086: my $symb_crs = $what;
10087: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 10088: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 10089: my ($tmp)=keys(%current_permissions);
10090: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 10091: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 10092: foreach my $file (@readonly_files) {
1.759 albertel 10093: my $clean_file = &declutter_portfile($file);
10094: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 10095: my $current_locks = $current_permissions{$file};
1.563 banghart 10096: my @new_locks;
10097: my @del_keys;
10098: if (ref($current_locks) eq "ARRAY"){
10099: foreach my $locker (@{$current_locks}) {
1.632 albertel 10100: my $compare=$locker;
1.749 raeburn 10101: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 10102: $compare=join('',@{$locker});
1.746 raeburn 10103: if ($compare ne $symb_crs) {
10104: push(@new_locks, $locker);
10105: }
1.563 banghart 10106: }
10107: }
1.650 albertel 10108: if (scalar(@new_locks) > 0) {
1.563 banghart 10109: $current_permissions{$file} = \@new_locks;
10110: } else {
10111: push(@del_keys, $file);
1.613 albertel 10112: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 10113: delete($current_permissions{$file});
1.563 banghart 10114: }
10115: }
1.561 banghart 10116: }
1.613 albertel 10117: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 10118: return;
10119: }
1.512 banghart 10120:
1.17 www 10121: # ------------------------------------------------------------ Directory lister
10122:
10123: sub dirlist {
1.955 raeburn 10124: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 10125: $uri=~s/^\///;
10126: $uri=~s/\/$//;
1.253 stredwic 10127: my ($udom, $uname);
1.955 raeburn 10128: if ($getuserdir) {
1.253 stredwic 10129: $udom = $userdomain;
10130: $uname = $username;
1.955 raeburn 10131: } else {
10132: (undef,$udom,$uname)=split(/\//,$uri);
10133: if(defined($userdomain)) {
10134: $udom = $userdomain;
10135: }
10136: if(defined($username)) {
10137: $uname = $username;
10138: }
1.253 stredwic 10139: }
1.955 raeburn 10140: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 10141:
1.955 raeburn 10142: $dirRoot = $perlvar{'lonDocRoot'};
10143: if (defined($getpropath)) {
10144: $dirRoot = &propath($udom,$uname);
1.253 stredwic 10145: $dirRoot =~ s/\/$//;
1.955 raeburn 10146: } elsif (defined($getuserdir)) {
10147: my $subdir=$uname.'__';
10148: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10149: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10150: ."/$udom/$subdir/$uname";
10151: } elsif (defined($alternateRoot)) {
10152: $dirRoot = $alternateRoot;
1.751 banghart 10153: }
1.253 stredwic 10154:
10155: if($udom) {
10156: if($uname) {
1.1135 raeburn 10157: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 10158: if ($uhome eq 'no_host') {
10159: return ([],'no_host');
10160: }
1.955 raeburn 10161: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 10162: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 10163: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 10164: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10165: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 10166: } else {
10167: @listing_results = map { &unescape($_); } split(/:/,$listing);
10168: }
1.605 matthew 10169: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10170: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 10171: @listing_results = split(/:/,$listing);
10172: } else {
10173: @listing_results = map { &unescape($_); } split(/:/,$listing);
10174: }
1.1135 raeburn 10175: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 10176: ($listing eq 'rejected') || ($listing eq 'refused') ||
10177: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10178: return ([],$listing);
10179: } else {
10180: return (\@listing_results);
1.1135 raeburn 10181: }
1.955 raeburn 10182: } elsif(!$alternateRoot) {
1.1136 raeburn 10183: my (%allusers,%listerror);
1.841 albertel 10184: my %servers = &get_servers($udom,'library');
1.955 raeburn 10185: foreach my $tryserver (keys(%servers)) {
10186: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10187: &escape($udom),$tryserver);
10188: if ($listing eq 'unknown_cmd') {
10189: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10190: $udom, $tryserver);
10191: } else {
10192: @listing_results = map { &unescape($_); } split(/:/,$listing);
10193: }
1.841 albertel 10194: if ($listing eq 'unknown_cmd') {
10195: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10196: $udom, $tryserver);
10197: @listing_results = split(/:/,$listing);
10198: } else {
10199: @listing_results =
10200: map { &unescape($_); } split(/:/,$listing);
10201: }
1.1136 raeburn 10202: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10203: ($listing eq 'rejected') || ($listing eq 'refused') ||
10204: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10205: $listerror{$tryserver} = $listing;
10206: } else {
1.841 albertel 10207: foreach my $line (@listing_results) {
10208: my ($entry) = split(/&/,$line,2);
10209: $allusers{$entry} = 1;
10210: }
10211: }
1.253 stredwic 10212: }
1.1136 raeburn 10213: my @alluserslist=();
1.800 albertel 10214: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 10215: push(@alluserslist,$user.'&user');
1.253 stredwic 10216: }
1.1172.2.80 raeburn 10217: if (!%listerror) {
10218: # no errors
10219: return (\@alluserslist);
10220: } elsif (scalar(keys(%servers)) == 1) {
10221: # one library server, one error
10222: my ($key) = keys(%listerror);
10223: return (\@alluserslist, $listerror{$key});
10224: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
10225: # con_lost indicates that we might miss data from at least one
10226: # library server
10227: return (\@alluserslist, 'con_lost');
10228: } else {
10229: # multiple library servers and no con_lost -> data should be
10230: # complete.
10231: return (\@alluserslist);
10232: }
10233:
1.253 stredwic 10234: } else {
1.1136 raeburn 10235: return ([],'missing username');
1.253 stredwic 10236: }
1.955 raeburn 10237: } elsif(!defined($getpropath)) {
1.1136 raeburn 10238: my $path = $perlvar{'lonDocRoot'}.'/res/';
10239: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10240: return (\@all_domains);
1.955 raeburn 10241: } else {
1.1136 raeburn 10242: return ([],'missing domain');
1.275 stredwic 10243: }
10244: }
10245:
10246: # --------------------------------------------- GetFileTimestamp
10247: # This function utilizes dirlist and returns the date stamp for
10248: # when it was last modified. It will also return an error of -1
10249: # if an error occurs
10250:
10251: sub GetFileTimestamp {
1.955 raeburn 10252: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 10253: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10254: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 10255: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10256: undef,$getuserdir);
10257: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10258: return -1;
10259: }
10260: if (ref($fileref) eq 'ARRAY') {
10261: my @stats = split('&',$fileref->[0]);
1.375 matthew 10262: # @stats contains first the filename, then the stat output
10263: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 10264: } else {
10265: return -1;
1.253 stredwic 10266: }
1.26 www 10267: }
10268:
1.712 albertel 10269: sub stat_file {
10270: my ($uri) = @_;
1.787 albertel 10271: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 10272:
1.955 raeburn 10273: my ($udom,$uname,$file);
1.712 albertel 10274: if ($uri =~ m-^/(uploaded|editupload)/-) {
10275: ($udom,$uname,$file) =
1.811 albertel 10276: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 10277: $file = 'userfiles/'.$file;
10278: }
10279: if ($uri =~ m-^/res/-) {
10280: ($udom,$uname) =
1.807 albertel 10281: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 10282: $file = $uri;
10283: }
10284:
10285: if (!$udom || !$uname || !$file) {
10286: # unable to handle the uri
10287: return ();
10288: }
1.956 raeburn 10289: my $getpropath;
10290: if ($file =~ /^userfiles\//) {
10291: $getpropath = 1;
10292: }
1.1136 raeburn 10293: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10294: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10295: return ();
10296: } else {
10297: if (ref($listref) eq 'ARRAY') {
10298: my @stats = split('&',$listref->[0]);
10299: shift(@stats); #filename is first
10300: return @stats;
10301: }
1.712 albertel 10302: }
10303: return ();
10304: }
10305:
1.26 www 10306: # -------------------------------------------------------- Value of a Condition
10307:
1.713 albertel 10308: # gets the value of a specific preevaluated condition
10309: # stored in the string $env{user.state.<cid>}
10310: # or looks up a condition reference in the bighash and if if hasn't
10311: # already been evaluated recurses into docondval to get the value of
10312: # the condition, then memoizing it to
10313: # $env{user.state.<cid>.<condition>}
1.40 www 10314: sub directcondval {
10315: my $number=shift;
1.620 albertel 10316: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 10317: &Apache::lonuserstate::evalstate();
10318: }
1.713 albertel 10319: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
10320: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
10321: } elsif ($number =~ /^_/) {
10322: my $sub_condition;
10323: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10324: &GDBM_READER(),0640)) {
10325: $sub_condition=$bighash{'conditions'.$number};
10326: untie(%bighash);
10327: }
10328: my $value = &docondval($sub_condition);
1.949 raeburn 10329: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 10330: return $value;
10331: }
1.620 albertel 10332: if ($env{'user.state.'.$env{'request.course.id'}}) {
10333: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 10334: } else {
10335: return 2;
10336: }
10337: }
10338:
1.713 albertel 10339: # get the collection of conditions for this resource
1.26 www 10340: sub condval {
10341: my $condidx=shift;
1.54 www 10342: my $allpathcond='';
1.713 albertel 10343: foreach my $cond (split(/\|/,$condidx)) {
10344: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
10345: $allpathcond.=
10346: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
10347: }
1.191 harris41 10348: }
1.54 www 10349: $allpathcond=~s/\|$//;
1.713 albertel 10350: return &docondval($allpathcond);
10351: }
10352:
10353: #evaluates an expression of conditions
10354: sub docondval {
10355: my ($allpathcond) = @_;
10356: my $result=0;
10357: if ($env{'request.course.id'}
10358: && defined($allpathcond)) {
10359: my $operand='|';
10360: my @stack;
10361: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
10362: if ($chunk eq '(') {
10363: push @stack,($operand,$result);
10364: } elsif ($chunk eq ')') {
10365: my $before=pop @stack;
10366: if (pop @stack eq '&') {
10367: $result=$result>$before?$before:$result;
10368: } else {
10369: $result=$result>$before?$result:$before;
10370: }
10371: } elsif (($chunk eq '&') || ($chunk eq '|')) {
10372: $operand=$chunk;
10373: } else {
10374: my $new=directcondval($chunk);
10375: if ($operand eq '&') {
10376: $result=$result>$new?$new:$result;
10377: } else {
10378: $result=$result>$new?$result:$new;
10379: }
10380: }
10381: }
1.26 www 10382: }
10383: return $result;
1.421 albertel 10384: }
10385:
10386: # ---------------------------------------------------- Devalidate courseresdata
10387:
10388: sub devalidatecourseresdata {
10389: my ($coursenum,$coursedomain)=@_;
10390: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 10391: &devalidate_cache_new('courseres',$hashid);
1.28 www 10392: }
10393:
1.763 www 10394:
1.200 www 10395: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 10396: #
10397: # Parameters:
10398: # $coursenum - Number of the course.
10399: # $coursedomain - Domain at which the course was created.
10400: # Returns:
10401: # A hash of the course parameters along (I think) with timestamps
10402: # and version info.
1.877 foxr 10403:
1.624 albertel 10404: sub get_courseresdata {
10405: my ($coursenum,$coursedomain)=@_;
1.200 www 10406: my $coursehom=&homeserver($coursenum,$coursedomain);
10407: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 10408: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 10409: my %dumpreply;
1.417 albertel 10410: unless (defined($cached)) {
1.624 albertel 10411: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 10412: $result=\%dumpreply;
1.251 albertel 10413: my ($tmp) = keys(%dumpreply);
10414: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 10415: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 10416: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
10417: return $tmp;
1.416 albertel 10418: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 10419: $result=undef;
1.599 albertel 10420: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 10421: }
10422: }
1.624 albertel 10423: return $result;
10424: }
10425:
1.633 albertel 10426: sub devalidateuserresdata {
10427: my ($uname,$udom)=@_;
10428: my $hashid="$udom:$uname";
10429: &devalidate_cache_new('userres',$hashid);
10430: }
10431:
1.624 albertel 10432: sub get_userresdata {
10433: my ($uname,$udom)=@_;
10434: #most student don\'t have any data set, check if there is some data
10435: if (&EXT_cache_status($udom,$uname)) { return undef; }
10436:
10437: my $hashid="$udom:$uname";
10438: my ($result,$cached)=&is_cached_new('userres',$hashid);
10439: if (!defined($cached)) {
10440: my %resourcedata=&dump('resourcedata',$udom,$uname);
10441: $result=\%resourcedata;
10442: &do_cache_new('userres',$hashid,$result,600);
10443: }
10444: my ($tmp)=keys(%$result);
10445: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
10446: return $result;
10447: }
10448: #error 2 occurs when the .db doesn't exist
10449: if ($tmp!~/error: 2 /) {
1.1172.2.71 raeburn 10450: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
10451: &logthis("<font color=\"blue\">WARNING:".
10452: " Trying to get resource data for ".
10453: $uname." at ".$udom.": ".
10454: $tmp."</font>");
10455: }
1.624 albertel 10456: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 10457: #&EXT_cache_set($udom,$uname);
10458: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 10459: undef($tmp); # not really an error so don't send it back
1.624 albertel 10460: }
10461: return $tmp;
10462: }
1.879 foxr 10463: #----------------------------------------------- resdata - return resource data
10464: # Purpose:
10465: # Return resource data for either users or for a course.
10466: # Parameters:
10467: # $name - Course/user name.
10468: # $domain - Name of the domain the user/course is registered on.
10469: # $type - Type of thing $name is (must be 'course' or 'user'
10470: # @which - Array of names of resources desired.
10471: # Returns:
10472: # The value of the first reasource in @which that is found in the
10473: # resource hash.
10474: # Exceptional Conditions:
10475: # If the $type passed in is not valid (not the string 'course' or
10476: # 'user', an undefined reference is returned.
10477: # If none of the resources are found, an undef is returned
1.624 albertel 10478: sub resdata {
10479: my ($name,$domain,$type,@which)=@_;
10480: my $result;
10481: if ($type eq 'course') {
10482: $result=&get_courseresdata($name,$domain);
10483: } elsif ($type eq 'user') {
10484: $result=&get_userresdata($name,$domain);
10485: }
10486: if (!ref($result)) { return $result; }
1.251 albertel 10487: foreach my $item (@which) {
1.927 albertel 10488: if (defined($result->{$item->[0]})) {
10489: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 10490: }
1.250 albertel 10491: }
1.291 albertel 10492: return undef;
1.200 www 10493: }
10494:
1.1172.2.31 raeburn 10495: sub get_numsuppfiles {
10496: my ($cnum,$cdom,$ignorecache)=@_;
10497: my $hashid=$cnum.':'.$cdom;
10498: my ($suppcount,$cached);
10499: unless ($ignorecache) {
10500: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
10501: }
10502: unless (defined($cached)) {
10503: my $chome=&homeserver($cnum,$cdom);
10504: unless ($chome eq 'no_host') {
10505: ($suppcount,my $errors) = (0,0);
10506: my $suppmap = 'supplemental.sequence';
10507: ($suppcount,$errors) =
10508: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
10509: }
10510: &do_cache_new('suppcount',$hashid,$suppcount,600);
10511: }
10512: return $suppcount;
10513: }
10514:
1.379 matthew 10515: #
10516: # EXT resource caching routines
10517: #
10518:
10519: sub clear_EXT_cache_status {
1.383 albertel 10520: &delenv('cache.EXT.');
1.379 matthew 10521: }
10522:
10523: sub EXT_cache_status {
10524: my ($target_domain,$target_user) = @_;
1.383 albertel 10525: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 10526: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 10527: # We know already the user has no data
10528: return 1;
10529: } else {
10530: return 0;
10531: }
10532: }
10533:
10534: sub EXT_cache_set {
10535: my ($target_domain,$target_user) = @_;
1.383 albertel 10536: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 10537: #&appenv({$cachename => time});
1.379 matthew 10538: }
10539:
1.28 www 10540: # --------------------------------------------------------- Value of a Variable
1.58 www 10541: sub EXT {
1.715 albertel 10542:
1.1172.2.28 raeburn 10543: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68 www 10544: unless ($varname) { return ''; }
1.218 albertel 10545: #get real user name/domain, courseid and symb
10546: my $courseid;
1.359 albertel 10547: my $publicuser;
1.427 www 10548: if ($symbparm) {
10549: $symbparm=&get_symb_from_alias($symbparm);
10550: }
1.218 albertel 10551: if (!($uname && $udom)) {
1.790 albertel 10552: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 10553: if (!$symbparm) { $symbparm=$cursymb; }
10554: } else {
1.620 albertel 10555: $courseid=$env{'request.course.id'};
1.218 albertel 10556: }
1.48 www 10557: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
10558: my $rest;
1.320 albertel 10559: if (defined($therest[0])) {
1.48 www 10560: $rest=join('.',@therest);
10561: } else {
10562: $rest='';
10563: }
1.320 albertel 10564:
1.57 www 10565: my $qualifierrest=$qualifier;
10566: if ($rest) { $qualifierrest.='.'.$rest; }
10567: my $spacequalifierrest=$space;
10568: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 10569: if ($realm eq 'user') {
1.48 www 10570: # --------------------------------------------------------------- user.resource
10571: if ($space eq 'resource') {
1.651 albertel 10572: if ( (defined($Apache::lonhomework::parsing_a_problem)
10573: || defined($Apache::lonhomework::parsing_a_task))
10574: &&
1.744 albertel 10575: ($symbparm eq &symbread()) ) {
10576: # if we are in the middle of processing the resource the
10577: # get the value we are planning on committing
10578: if (defined($Apache::lonhomework::results{$qualifierrest})) {
10579: return $Apache::lonhomework::results{$qualifierrest};
10580: } else {
10581: return $Apache::lonhomework::history{$qualifierrest};
10582: }
1.335 albertel 10583: } else {
1.359 albertel 10584: my %restored;
1.620 albertel 10585: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 10586: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
10587: } else {
10588: %restored=&restore($symbparm,$courseid,$udom,$uname);
10589: }
1.335 albertel 10590: return $restored{$qualifierrest};
10591: }
1.48 www 10592: # ----------------------------------------------------------------- user.access
10593: } elsif ($space eq 'access') {
1.218 albertel 10594: # FIXME - not supporting calls for a specific user
1.48 www 10595: return &allowed($qualifier,$rest);
10596: # ------------------------------------------ user.preferences, user.environment
10597: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 10598: if (($uname eq $env{'user.name'}) &&
10599: ($udom eq $env{'user.domain'})) {
10600: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 10601: } else {
1.359 albertel 10602: my %returnhash;
10603: if (!$publicuser) {
10604: %returnhash=&userenvironment($udom,$uname,
10605: $qualifierrest);
10606: }
1.218 albertel 10607: return $returnhash{$qualifierrest};
10608: }
1.48 www 10609: # ----------------------------------------------------------------- user.course
10610: } elsif ($space eq 'course') {
1.218 albertel 10611: # FIXME - not supporting calls for a specific user
1.620 albertel 10612: return $env{join('.',('request.course',$qualifier))};
1.48 www 10613: # ------------------------------------------------------------------- user.role
10614: } elsif ($space eq 'role') {
1.218 albertel 10615: # FIXME - not supporting calls for a specific user
1.620 albertel 10616: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 10617: if ($qualifier eq 'value') {
10618: return $role;
10619: } elsif ($qualifier eq 'extent') {
10620: return $where;
10621: }
10622: # ----------------------------------------------------------------- user.domain
10623: } elsif ($space eq 'domain') {
1.218 albertel 10624: return $udom;
1.48 www 10625: # ------------------------------------------------------------------- user.name
10626: } elsif ($space eq 'name') {
1.218 albertel 10627: return $uname;
1.48 www 10628: # ---------------------------------------------------- Any other user namespace
1.29 www 10629: } else {
1.359 albertel 10630: my %reply;
10631: if (!$publicuser) {
10632: %reply=&get($space,[$qualifierrest],$udom,$uname);
10633: }
10634: return $reply{$qualifierrest};
1.48 www 10635: }
1.236 www 10636: } elsif ($realm eq 'query') {
10637: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 10638: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
10639: [$spacequalifierrest]);
1.620 albertel 10640: return $env{'form.'.$spacequalifierrest};
1.236 www 10641: } elsif ($realm eq 'request') {
1.48 www 10642: # ------------------------------------------------------------- request.browser
10643: if ($space eq 'browser') {
1.1145 bisitz 10644: return $env{'browser.'.$qualifier};
1.57 www 10645: # ------------------------------------------------------------ request.filename
10646: } else {
1.620 albertel 10647: return $env{'request.'.$spacequalifierrest};
1.29 www 10648: }
1.28 www 10649: } elsif ($realm eq 'course') {
1.48 www 10650: # ---------------------------------------------------------- course.description
1.620 albertel 10651: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 10652: } elsif ($realm eq 'resource') {
1.165 www 10653:
1.620 albertel 10654: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 10655: if (!$symbparm) { $symbparm=&symbread(); }
10656: }
1.693 albertel 10657:
1.1172.2.30 raeburn 10658: if ($qualifier eq '') {
10659: if ($space eq 'title') {
10660: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
10661: return &gettitle($symbparm);
10662: }
1.693 albertel 10663:
1.1172.2.30 raeburn 10664: if ($space eq 'map') {
10665: my ($map) = &decode_symb($symbparm);
10666: return &symbread($map);
10667: }
10668: if ($space eq 'maptitle') {
10669: my ($map) = &decode_symb($symbparm);
10670: return &gettitle($map);
10671: }
10672: if ($space eq 'filename') {
10673: if ($symbparm) {
10674: return &clutter((&decode_symb($symbparm))[2]);
10675: }
10676: return &hreflocation('',$env{'request.filename'});
1.905 albertel 10677: }
1.1172.2.30 raeburn 10678:
10679: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
10680: if ($space eq 'visibleparts') {
10681: my $navmap = Apache::lonnavmaps::navmap->new();
10682: my $item;
10683: if (ref($navmap)) {
10684: my $res = $navmap->getBySymb($symbparm);
10685: my $parts = $res->parts();
10686: if (ref($parts) eq 'ARRAY') {
10687: $item = join(',',@{$parts});
10688: }
10689: undef($navmap);
10690: }
10691: return $item;
10692: }
10693: }
10694: }
1.693 albertel 10695:
10696: my ($section, $group, @groups);
1.593 albertel 10697: my ($courselevelm,$courselevel);
1.1172.2.28 raeburn 10698: if (($courseid eq '') && ($cid)) {
10699: $courseid = $cid;
10700: }
10701: if (($symbparm && $courseid) &&
10702: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 10703:
1.218 albertel 10704: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 10705:
1.60 www 10706: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 10707: my $symbp=$symbparm;
1.735 albertel 10708: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 10709:
10710: my $symbparm=$symbp.'.'.$spacequalifierrest;
10711: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
10712:
1.620 albertel 10713: if (($env{'user.name'} eq $uname) &&
10714: ($env{'user.domain'} eq $udom)) {
10715: $section=$env{'request.course.sec'};
1.733 raeburn 10716: @groups = split(/:/,$env{'request.course.groups'});
10717: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 10718: } else {
1.539 albertel 10719: if (! defined($usection)) {
1.551 albertel 10720: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 10721: } else {
10722: $section = $usection;
10723: }
1.733 raeburn 10724: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 10725: }
10726:
10727: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10728: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10729: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10730:
1.593 albertel 10731: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 10732: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 10733: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 10734:
1.60 www 10735: # ----------------------------------------------------------- first, check user
1.624 albertel 10736:
10737: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 10738: ([$courselevelr,'resource'],
10739: [$courselevelm,'map' ],
10740: [$courselevel, 'course' ]));
1.931 albertel 10741: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 10742:
1.594 albertel 10743: # ------------------------------------------------ second, check some of course
1.684 raeburn 10744: my $coursereply;
1.691 raeburn 10745: if (@groups > 0) {
10746: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10747: $mapparm,$spacequalifierrest);
1.927 albertel 10748: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 10749: }
1.96 www 10750:
1.684 raeburn 10751: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 10752: $env{'course.'.$courseid.'.domain'},
10753: 'course',
10754: ([$seclevelr, 'resource'],
10755: [$seclevelm, 'map' ],
10756: [$seclevel, 'course' ],
10757: [$courselevelr,'resource']));
10758: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 10759:
1.60 www 10760: # ------------------------------------------------------ third, check map parms
1.218 albertel 10761: my %parmhash=();
10762: my $thisparm='';
10763: if (tie(%parmhash,'GDBM_File',
1.620 albertel 10764: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 10765: &GDBM_READER(),0640)) {
1.218 albertel 10766: $thisparm=$parmhash{$symbparm};
10767: untie(%parmhash);
10768: }
1.927 albertel 10769: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 10770: }
1.594 albertel 10771: # ------------------------------------------ fourth, look in resource metadata
1.71 www 10772:
1.218 albertel 10773: $spacequalifierrest=~s/\./\_/;
1.282 albertel 10774: my $filename;
10775: if (!$symbparm) { $symbparm=&symbread(); }
10776: if ($symbparm) {
1.409 www 10777: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 10778: } else {
1.620 albertel 10779: $filename=$env{'request.filename'};
1.282 albertel 10780: }
10781: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 10782: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 10783: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 10784: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 10785:
1.927 albertel 10786: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 10787: if ($symbparm && defined($courseid) &&
1.620 albertel 10788: $courseid eq $env{'request.course.id'}) {
1.624 albertel 10789: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10790: $env{'course.'.$courseid.'.domain'},
10791: 'course',
1.927 albertel 10792: ([$courselevelm,'map' ],
10793: [$courselevel, 'course']));
10794: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 10795: }
1.145 www 10796: # ------------------------------------------------------------------ Cascade up
1.218 albertel 10797: unless ($space eq '0') {
1.336 albertel 10798: my @parts=split(/_/,$space);
10799: my $id=pop(@parts);
10800: my $part=join('_',@parts);
10801: if ($part eq '') { $part='0'; }
1.927 albertel 10802: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 10803: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 10804: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 10805: }
1.395 albertel 10806: if ($recurse) { return undef; }
10807: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 10808: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 10809: # ---------------------------------------------------- Any other user namespace
10810: } elsif ($realm eq 'environment') {
10811: # ----------------------------------------------------------------- environment
1.620 albertel 10812: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10813: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 10814: } else {
1.770 albertel 10815: if ($uname eq 'anonymous' && $udom eq '') {
10816: return '';
10817: }
1.219 albertel 10818: my %returnhash=&userenvironment($udom,$uname,
10819: $spacequalifierrest);
10820: return $returnhash{$spacequalifierrest};
10821: }
1.28 www 10822: } elsif ($realm eq 'system') {
1.48 www 10823: # ----------------------------------------------------------------- system.time
10824: if ($space eq 'time') {
10825: return time;
10826: }
1.696 albertel 10827: } elsif ($realm eq 'server') {
10828: # ----------------------------------------------------------------- system.time
10829: if ($space eq 'name') {
10830: return $ENV{'SERVER_NAME'};
10831: }
1.28 www 10832: }
1.48 www 10833: return '';
1.61 www 10834: }
10835:
1.927 albertel 10836: sub get_reply {
10837: my ($reply_value) = @_;
1.940 raeburn 10838: if (ref($reply_value) eq 'ARRAY') {
10839: if (wantarray) {
10840: return @$reply_value;
10841: }
10842: return $reply_value->[0];
10843: } else {
10844: return $reply_value;
1.927 albertel 10845: }
10846: }
10847:
1.691 raeburn 10848: sub check_group_parms {
10849: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
10850: my @groupitems = ();
10851: my $resultitem;
1.927 albertel 10852: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 10853: foreach my $group (@{$groups}) {
10854: foreach my $level (@levels) {
1.927 albertel 10855: my $item = $courseid.'.['.$group.'].'.$level->[0];
10856: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 10857: }
10858: }
10859: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10860: $env{'course.'.$courseid.'.domain'},
10861: 'course',@groupitems);
10862: return $coursereply;
10863: }
10864:
10865: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 10866: my ($courseid,@groups) = @_;
10867: @groups = sort(@groups);
1.691 raeburn 10868: return @groups;
10869: }
10870:
1.395 albertel 10871: sub packages_tab_default {
10872: my ($uri,$varname)=@_;
10873: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 10874:
10875: my (@extension,@specifics,$do_default);
10876: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 10877: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 10878: if ($pack_type eq 'default') {
10879: $do_default=1;
10880: } elsif ($pack_type eq 'extension') {
10881: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 10882: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 10883: # only look at packages defaults for packages that this id is
1.738 albertel 10884: push(@specifics,[$package,$pack_type,$pack_part]);
10885: }
10886: }
10887: # first look for a package that matches the requested part id
10888: foreach my $package (@specifics) {
10889: my (undef,$pack_type,$pack_part)=@{$package};
10890: next if ($pack_part ne $part);
10891: if (defined($packagetab{"$pack_type&$name&default"})) {
10892: return $packagetab{"$pack_type&$name&default"};
10893: }
10894: }
10895: # look for any possible matching non extension_ package
10896: foreach my $package (@specifics) {
10897: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 10898: if (defined($packagetab{"$pack_type&$name&default"})) {
10899: return $packagetab{"$pack_type&$name&default"};
10900: }
1.585 albertel 10901: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 10902: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10903: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 10904: }
10905: }
1.738 albertel 10906: # look for any posible extension_ match
10907: foreach my $package (@extension) {
10908: my ($package,$pack_type)=@{$package};
10909: if (defined($packagetab{"$pack_type&$name&default"})) {
10910: return $packagetab{"$pack_type&$name&default"};
10911: }
10912: if (defined($packagetab{$package."&$name&default"})) {
10913: return $packagetab{$package."&$name&default"};
10914: }
10915: }
10916: # look for a global default setting
10917: if ($do_default && defined($packagetab{"default&$name&default"})) {
10918: return $packagetab{"default&$name&default"};
10919: }
1.395 albertel 10920: return undef;
10921: }
10922:
1.334 albertel 10923: sub add_prefix_and_part {
10924: my ($prefix,$part)=@_;
10925: my $keyroot;
10926: if (defined($prefix) && $prefix !~ /^__/) {
10927: # prefix that has a part already
10928: $keyroot=$prefix;
10929: } elsif (defined($prefix)) {
10930: # prefix that is missing a part
10931: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10932: } else {
10933: # no prefix at all
10934: if (defined($part)) { $keyroot='_'.$part; }
10935: }
10936: return $keyroot;
10937: }
10938:
1.71 www 10939: # ---------------------------------------------------------------- Get metadata
10940:
1.599 albertel 10941: my %metaentry;
1.1070 www 10942: my %importedpartids;
1.71 www 10943: sub metadata {
1.176 www 10944: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 10945: $uri=&declutter($uri);
1.288 albertel 10946: # if it is a non metadata possible uri return quickly
1.529 albertel 10947: if (($uri eq '') ||
10948: (($uri =~ m|^/*adm/|) &&
1.1172.2.20 raeburn 10949: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard)$})) ||
1.1108 raeburn 10950: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 10951: return undef;
10952: }
1.1172.2.49 raeburn 10953: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 10954: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 10955: return undef;
1.288 albertel 10956: }
1.73 www 10957: my $filename=$uri;
10958: $uri=~s/\.meta$//;
1.172 www 10959: #
10960: # Is the metadata already cached?
1.177 www 10961: # Look at timestamp of caching
1.172 www 10962: # Everything is cached by the main uri, libraries are never directly cached
10963: #
1.428 albertel 10964: if (!defined($liburi)) {
1.599 albertel 10965: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 10966: if (defined($cached)) { return $result->{':'.$what}; }
10967: }
10968: {
1.1069 www 10969: # Imported parts would go here
1.1070 www 10970: my %importedids=();
10971: my @origfileimportpartids=();
1.1069 www 10972: my $importedparts=0;
1.172 www 10973: #
10974: # Is this a recursive call for a library?
10975: #
1.599 albertel 10976: # if (! exists($metacache{$uri})) {
10977: # $metacache{$uri}={};
10978: # }
1.924 albertel 10979: my $cachetime = 60*60;
1.171 www 10980: if ($liburi) {
10981: $liburi=&declutter($liburi);
10982: $filename=$liburi;
1.401 bowersj2 10983: } else {
1.599 albertel 10984: &devalidate_cache_new('meta',$uri);
10985: undef(%metaentry);
1.401 bowersj2 10986: }
1.140 www 10987: my %metathesekeys=();
1.73 www 10988: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 10989: my $metastring;
1.1140 www 10990: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 10991: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 10992: $metastring =
1.929 albertel 10993: &Apache::lonnet::ssi_body($which,
1.924 albertel 10994: ('grade_target' => 'meta'));
10995: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 10996: } elsif (($uri !~ m -^(editupload)/-) &&
10997: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 10998: my $file=&filelocation('',&clutter($filename));
1.599 albertel 10999: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 11000: $metastring=&getfile($file);
1.489 albertel 11001: }
1.208 albertel 11002: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 11003: my $token;
1.140 www 11004: undef %metathesekeys;
1.71 www 11005: while ($token=$parser->get_token) {
1.339 albertel 11006: if ($token->[0] eq 'S') {
11007: if (defined($token->[2]->{'package'})) {
1.172 www 11008: #
11009: # This is a package - get package info
11010: #
1.339 albertel 11011: my $package=$token->[2]->{'package'};
11012: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11013: if (defined($token->[2]->{'id'})) {
11014: $keyroot.='_'.$token->[2]->{'id'};
11015: }
1.599 albertel 11016: if ($metaentry{':packages'}) {
11017: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 11018: } else {
1.599 albertel 11019: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 11020: }
1.736 albertel 11021: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 11022: my $part=$keyroot;
11023: $part=~s/^\_//;
1.736 albertel 11024: if ($pack_entry=~/^\Q$package\E\&/ ||
11025: $pack_entry=~/^\Q$package\E_0\&/) {
11026: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 11027: # ignore package.tab specified default values
11028: # here &package_tab_default() will fetch those
11029: if ($subp eq 'default') { next; }
1.736 albertel 11030: my $value=$packagetab{$pack_entry};
1.432 albertel 11031: my $unikey;
11032: if ($pack =~ /_0$/) {
11033: $unikey='parameter_0_'.$name;
11034: $part=0;
11035: } else {
11036: $unikey='parameter'.$keyroot.'_'.$name;
11037: }
1.339 albertel 11038: if ($subp eq 'display') {
11039: $value.=' [Part: '.$part.']';
11040: }
1.599 albertel 11041: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 11042: $metathesekeys{$unikey}=1;
1.599 albertel 11043: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11044: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 11045: }
1.599 albertel 11046: if (defined($metaentry{':'.$unikey.'.default'})) {
11047: $metaentry{':'.$unikey}=
11048: $metaentry{':'.$unikey.'.default'};
1.356 albertel 11049: }
1.339 albertel 11050: }
11051: }
11052: } else {
1.172 www 11053: #
11054: # This is not a package - some other kind of start tag
1.339 albertel 11055: #
11056: my $entry=$token->[1];
1.1068 www 11057: my $unikey='';
1.175 www 11058:
1.339 albertel 11059: if ($entry eq 'import') {
1.175 www 11060: #
11061: # Importing a library here
1.339 albertel 11062: #
1.1067 www 11063: my $location=$parser->get_text('/import');
11064: my $dir=$filename;
11065: $dir=~s|[^/]*$||;
11066: $location=&filelocation($dir,$location);
1.1069 www 11067:
1.1068 www 11068: my $importmode=$token->[2]->{'importmode'};
11069: if ($importmode eq 'problem') {
1.1069 www 11070: # Import as problem/response
1.1068 www 11071: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11072: } elsif ($importmode eq 'part') {
11073: # Import as part(s)
1.1069 www 11074: $importedparts=1;
11075: # We need to get the original file and the imported file to get the part order correct
11076: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
11077: # Load and inspect original file
1.1070 www 11078: if ($#origfileimportpartids<0) {
11079: undef(%importedpartids);
11080: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11081: my $origfile=&getfile($origfilelocation);
11082: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11083: }
11084:
1.1069 www 11085: # Load and inspect imported file
11086: my $impfile=&getfile($location);
11087: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11088: if ($#impfilepartids>=0) {
11089: # This problem had parts
1.1070 www 11090: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 11091: } else {
11092: # Importing by turning a single problem into a problem part
11093: # It gets the import-tags ID as part-ID
11094: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 11095: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 11096: }
1.1068 www 11097: } else {
11098: # Normal import
11099: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11100: if (defined($token->[2]->{'id'})) {
11101: $unikey.='_'.$token->[2]->{'id'};
11102: }
1.1067 www 11103: }
11104:
1.339 albertel 11105: if ($depthcount<20) {
1.736 albertel 11106: my $metadata =
11107: &metadata($uri,'keys', $location,$unikey,
11108: $depthcount+1);
11109: foreach my $meta (split(',',$metadata)) {
11110: $metaentry{':'.$meta}=$metaentry{':'.$meta};
11111: $metathesekeys{$meta}=1;
1.339 albertel 11112: }
1.1068 www 11113:
11114: }
1.1067 www 11115: } else {
11116: #
11117: # Not importing, some other kind of non-package, non-library start tag
11118: #
11119: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
11120: if (defined($token->[2]->{'id'})) {
11121: $unikey.='_'.$token->[2]->{'id'};
11122: }
1.339 albertel 11123: if (defined($token->[2]->{'name'})) {
11124: $unikey.='_'.$token->[2]->{'name'};
11125: }
11126: $metathesekeys{$unikey}=1;
1.736 albertel 11127: foreach my $param (@{$token->[3]}) {
11128: $metaentry{':'.$unikey.'.'.$param} =
11129: $token->[2]->{$param};
1.339 albertel 11130: }
11131: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 11132: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 11133: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
11134: # only ws inside the tag, and not in default, so use default
11135: # as value
1.599 albertel 11136: $metaentry{':'.$unikey}=$default;
1.908 albertel 11137: } elsif ( $internaltext =~ /\S/ ) {
11138: # something interesting inside the tag
11139: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 11140: } else {
1.908 albertel 11141: # no interesting values, don't set a default
1.339 albertel 11142: }
1.172 www 11143: # end of not-a-package not-a-library import
1.339 albertel 11144: }
1.172 www 11145: # end of not-a-package start tag
1.339 albertel 11146: }
1.172 www 11147: # the next is the end of "start tag"
1.339 albertel 11148: }
11149: }
1.483 albertel 11150: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 11151: $extension = lc($extension);
11152: if ($extension eq 'htm') { $extension='html'; }
11153:
1.737 albertel 11154: foreach my $key (keys(%packagetab)) {
1.483 albertel 11155: #no specific packages #how's our extension
11156: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 11157: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 11158: \%metathesekeys);
11159: }
1.883 albertel 11160:
11161: if (!exists($metaentry{':packages'})
11162: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 11163: foreach my $key (keys(%packagetab)) {
1.483 albertel 11164: #no specific packages well let's get default then
11165: if ($key!~/^default&/) { next; }
1.488 albertel 11166: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 11167: \%metathesekeys);
11168: }
11169: }
1.338 www 11170: # are there custom rights to evaluate
1.599 albertel 11171: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 11172:
1.338 www 11173: #
11174: # Importing a rights file here
1.339 albertel 11175: #
11176: unless ($depthcount) {
1.599 albertel 11177: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 11178: my $dir=$filename;
11179: $dir=~s|[^/]*$||;
11180: $location=&filelocation($dir,$location);
1.736 albertel 11181: my $rights_metadata =
11182: &metadata($uri,'keys',$location,'_rights',
11183: $depthcount+1);
11184: foreach my $rights (split(',',$rights_metadata)) {
11185: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
11186: $metathesekeys{$rights}=1;
1.339 albertel 11187: }
11188: }
11189: }
1.737 albertel 11190: # uniqifiy package listing
11191: my %seen;
11192: my @uniq_packages =
11193: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
11194: $metaentry{':packages'} = join(',',@uniq_packages);
11195:
1.1070 www 11196: if ($importedparts) {
11197: # We had imported parts and need to rebuild partorder
11198: $metaentry{':partorder'}='';
11199: $metathesekeys{'partorder'}=1;
11200: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
11201: if ($origfileimportpartids[$index] eq 'part') {
11202: # original part, part of the problem
11203: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
11204: } else {
11205: # we have imported parts at this position
11206: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
11207: }
11208: }
11209: $metaentry{':partorder'}=~s/^\,//;
11210: }
11211:
1.737 albertel 11212: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 11213: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1172.2.58 raeburn 11214: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.924 albertel 11215: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 11216: # this is the end of "was not already recently cached
1.71 www 11217: }
1.599 albertel 11218: return $metaentry{':'.$what};
1.261 albertel 11219: }
11220:
1.488 albertel 11221: sub metadata_create_package_def {
1.483 albertel 11222: my ($uri,$key,$package,$metathesekeys)=@_;
11223: my ($pack,$name,$subp)=split(/\&/,$key);
11224: if ($subp eq 'default') { next; }
11225:
1.599 albertel 11226: if (defined($metaentry{':packages'})) {
11227: $metaentry{':packages'}.=','.$package;
1.483 albertel 11228: } else {
1.599 albertel 11229: $metaentry{':packages'}=$package;
1.483 albertel 11230: }
11231: my $value=$packagetab{$key};
11232: my $unikey;
11233: $unikey='parameter_0_'.$name;
1.599 albertel 11234: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 11235: $$metathesekeys{$unikey}=1;
1.599 albertel 11236: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11237: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 11238: }
1.599 albertel 11239: if (defined($metaentry{':'.$unikey.'.default'})) {
11240: $metaentry{':'.$unikey}=
11241: $metaentry{':'.$unikey.'.default'};
1.483 albertel 11242: }
11243: }
11244:
1.261 albertel 11245: sub metadata_generate_part0 {
11246: my ($metadata,$metacache,$uri) = @_;
11247: my %allnames;
1.737 albertel 11248: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 11249: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 11250: my $part=$$metacache{':'.$metakey.'.part'};
11251: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 11252: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 11253: $allnames{$name}=$part;
11254: }
11255: }
11256: }
11257: foreach my $name (keys(%allnames)) {
11258: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 11259: my $key=":parameter_0_$name";
1.261 albertel 11260: $$metacache{"$key.part"}='0';
11261: $$metacache{"$key.name"}=$name;
1.428 albertel 11262: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 11263: $allnames{$name}.'_'.$name.
11264: '.type'};
1.428 albertel 11265: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 11266: '.display'};
1.644 www 11267: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 11268: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 11269: $$metacache{"$key.display"}=$olddis;
11270: }
1.71 www 11271: }
11272:
1.764 albertel 11273: # ------------------------------------------------------ Devalidate title cache
11274:
11275: sub devalidate_title_cache {
11276: my ($url)=@_;
11277: if (!$env{'request.course.id'}) { return; }
11278: my $symb=&symbread($url);
11279: if (!$symb) { return; }
11280: my $key=$env{'request.course.id'}."\0".$symb;
11281: &devalidate_cache_new('title',$key);
11282: }
11283:
1.1014 droeschl 11284: # ------------------------------------------------- Get the title of a course
11285:
11286: sub current_course_title {
11287: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
11288: }
1.301 www 11289: # ------------------------------------------------- Get the title of a resource
11290:
11291: sub gettitle {
11292: my $urlsymb=shift;
11293: my $symb=&symbread($urlsymb);
1.534 albertel 11294: if ($symb) {
1.620 albertel 11295: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 11296: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 11297: if (defined($cached)) {
11298: return $result;
11299: }
1.534 albertel 11300: my ($map,$resid,$url)=&decode_symb($symb);
11301: my $title='';
1.907 albertel 11302: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
11303: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
11304: } else {
11305: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11306: &GDBM_READER(),0640)) {
11307: my $mapid=$bighash{'map_pc_'.&clutter($map)};
11308: $title=$bighash{'title_'.$mapid.'.'.$resid};
11309: untie(%bighash);
11310: }
1.534 albertel 11311: }
11312: $title=~s/\&colon\;/\:/gs;
11313: if ($title) {
1.1159 www 11314: # Remember both $symb and $title for dynamic metadata
11315: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 11316: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 11317: # Cache this title and then return it
1.599 albertel 11318: return &do_cache_new('title',$key,$title,600);
1.534 albertel 11319: }
11320: $urlsymb=$url;
11321: }
11322: my $title=&metadata($urlsymb,'title');
11323: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
11324: return $title;
1.301 www 11325: }
1.613 albertel 11326:
1.614 albertel 11327: sub get_slot {
11328: my ($which,$cnum,$cdom)=@_;
11329: if (!$cnum || !$cdom) {
1.790 albertel 11330: (undef,my $courseid)=&whichuser();
1.620 albertel 11331: $cdom=$env{'course.'.$courseid.'.domain'};
11332: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 11333: }
1.703 albertel 11334: my $key=join("\0",'slots',$cdom,$cnum,$which);
11335: my %slotinfo;
11336: if (exists($remembered{$key})) {
11337: $slotinfo{$which} = $remembered{$key};
11338: } else {
11339: %slotinfo=&get('slots',[$which],$cdom,$cnum);
11340: &Apache::lonhomework::showhash(%slotinfo);
11341: my ($tmp)=keys(%slotinfo);
11342: if ($tmp=~/^error:/) { return (); }
11343: $remembered{$key} = $slotinfo{$which};
11344: }
1.616 albertel 11345: if (ref($slotinfo{$which}) eq 'HASH') {
11346: return %{$slotinfo{$which}};
11347: }
11348: return $slotinfo{$which};
1.614 albertel 11349: }
1.1150 raeburn 11350:
11351: sub get_reservable_slots {
11352: my ($cnum,$cdom,$uname,$udom) = @_;
11353: my $now = time;
11354: my $reservable_info;
11355: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
11356: if (exists($remembered{$key})) {
11357: $reservable_info = $remembered{$key};
11358: } else {
11359: my %resv;
11360: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
11361: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
11362: $reservable_info = \%resv;
11363: $remembered{$key} = $reservable_info;
11364: }
11365: return $reservable_info;
11366: }
11367:
11368: sub get_course_slots {
11369: my ($cnum,$cdom) = @_;
11370: my $hashid=$cnum.':'.$cdom;
11371: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
11372: if (defined($cached)) {
11373: if (ref($result) eq 'HASH') {
11374: return %{$result};
11375: }
11376: } else {
11377: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
11378: my ($tmp) = keys(%slots);
11379: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1172.2.23 raeburn 11380: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 11381: return %slots;
11382: }
11383: }
11384: return;
11385: }
11386:
11387: sub devalidate_slots_cache {
11388: my ($cnum,$cdom)=@_;
11389: my $hashid=$cnum.':'.$cdom;
11390: &devalidate_cache_new('allslots',$hashid);
11391: }
11392:
1.1172.2.8 raeburn 11393: sub get_coursechange {
11394: my ($cdom,$cnum) = @_;
11395: if ($cdom eq '' || $cnum eq '') {
11396: return unless ($env{'request.course.id'});
11397: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
11398: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11399: }
11400: my $hashid=$cdom.'_'.$cnum;
11401: my ($change,$cached)=&is_cached_new('crschange',$hashid);
11402: if ((defined($cached)) && ($change ne '')) {
11403: return $change;
11404: } else {
11405: my %crshash;
11406: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
11407: if ($crshash{'internal.contentchange'} eq '') {
11408: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
11409: if ($change eq '') {
11410: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
11411: $change = $crshash{'internal.created'};
11412: }
11413: } else {
11414: $change = $crshash{'internal.contentchange'};
11415: }
11416: my $cachetime = 600;
11417: &do_cache_new('crschange',$hashid,$change,$cachetime);
11418: }
11419: return $change;
11420: }
11421:
11422: sub devalidate_coursechange_cache {
11423: my ($cnum,$cdom)=@_;
11424: my $hashid=$cnum.':'.$cdom;
11425: &devalidate_cache_new('crschange',$hashid);
11426: }
11427:
1.31 www 11428: # ------------------------------------------------- Update symbolic store links
11429:
11430: sub symblist {
11431: my ($mapname,%newhash)=@_;
1.438 www 11432: $mapname=&deversion(&declutter($mapname));
1.31 www 11433: my %hash;
1.620 albertel 11434: if (($env{'request.course.fn'}) && (%newhash)) {
11435: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 11436: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 11437: foreach my $url (keys(%newhash)) {
1.711 albertel 11438: next if ($url eq 'last_known'
11439: && $env{'form.no_update_last_known'});
11440: $hash{declutter($url)}=&encode_symb($mapname,
11441: $newhash{$url}->[1],
11442: $newhash{$url}->[0]);
1.191 harris41 11443: }
1.31 www 11444: if (untie(%hash)) {
11445: return 'ok';
11446: }
11447: }
11448: }
11449: return 'error';
1.212 www 11450: }
11451:
11452: # --------------------------------------------------------------- Verify a symb
11453:
11454: sub symbverify {
1.1172.2.11 raeburn 11455: my ($symb,$thisurl,$encstate)=@_;
1.510 www 11456: my $thisfn=$thisurl;
1.439 www 11457: $thisfn=&declutter($thisfn);
1.215 www 11458: # direct jump to resource in page or to a sequence - will construct own symbs
11459: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
11460: # check URL part
1.409 www 11461: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 11462:
1.431 www 11463: unless ($url eq $thisfn) { return 0; }
1.213 www 11464:
1.216 www 11465: $symb=&symbclean($symb);
1.510 www 11466: $thisurl=&deversion($thisurl);
1.439 www 11467: $thisfn=&deversion($thisfn);
1.213 www 11468:
11469: my %bighash;
11470: my $okay=0;
1.431 www 11471:
1.620 albertel 11472: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 11473: &GDBM_READER(),0640)) {
1.1172.2.13 raeburn 11474: my $noclutter;
1.1032 raeburn 11475: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
11476: $thisurl =~ s/\?.+$//;
1.1172.2.13 raeburn 11477: if ($map =~ m{^uploaded/.+\.page$}) {
11478: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
11479: $thisurl =~ s{^\Qhttp://https://\E}{https://};
11480: $noclutter = 1;
11481: }
11482: }
11483: my $ids;
11484: if ($noclutter) {
11485: $ids=$bighash{'ids_'.$thisurl};
11486: } else {
11487: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 11488: }
1.1102 raeburn 11489: unless ($ids) {
1.1172.2.13 raeburn 11490: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
1.1102 raeburn 11491: $ids=$bighash{$idkey};
1.216 www 11492: }
11493: if ($ids) {
11494: # ------------------------------------------------------------------- Has ID(s)
1.1172.2.13 raeburn 11495: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
11496: $symb =~ s/\?.+$//;
11497: }
1.800 albertel 11498: foreach my $id (split(/\,/,$ids)) {
11499: my ($mapid,$resid)=split(/\./,$id);
1.216 www 11500: if (
11501: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1172.2.13 raeburn 11502: eq $symb) {
1.1172.2.11 raeburn 11503: if (ref($encstate)) {
11504: $$encstate = $bighash{'encrypted_'.$id};
11505: }
1.1172.2.13 raeburn 11506: if (($env{'request.role.adv'}) ||
11507: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
1.1101 raeburn 11508: ($thisurl eq '/adm/navmaps')) {
1.1172.2.13 raeburn 11509: $okay=1;
11510: last;
11511: }
11512: }
11513: }
1.216 www 11514: }
1.213 www 11515: untie(%bighash);
11516: }
11517: return $okay;
1.31 www 11518: }
11519:
1.210 www 11520: # --------------------------------------------------------------- Clean-up symb
11521:
11522: sub symbclean {
11523: my $symb=shift;
1.568 albertel 11524: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 11525: # remove version from map
11526: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 11527:
1.210 www 11528: # remove version from URL
11529: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 11530:
1.507 www 11531: # remove wrapper
11532:
1.510 www 11533: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 11534: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 11535: return $symb;
1.409 www 11536: }
11537:
11538: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 11539:
11540: sub encode_symb {
11541: my ($map,$resid,$url)=@_;
11542: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
11543: }
1.409 www 11544:
11545: sub decode_symb {
1.568 albertel 11546: my $symb=shift;
11547: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11548: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 11549: return (&fixversion($map),$resid,&fixversion($url));
11550: }
11551:
11552: sub fixversion {
11553: my $fn=shift;
1.609 banghart 11554: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 11555: my %bighash;
11556: my $uri=&clutter($fn);
1.620 albertel 11557: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 11558: # is this cached?
1.599 albertel 11559: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 11560: if (defined($cached)) { return $result; }
11561: # unfortunately not cached, or expired
1.620 albertel 11562: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 11563: &GDBM_READER(),0640)) {
11564: if ($bighash{'version_'.$uri}) {
11565: my $version=$bighash{'version_'.$uri};
1.444 www 11566: unless (($version eq 'mostrecent') ||
11567: ($version==&getversion($uri))) {
1.440 www 11568: $uri=~s/\.(\w+)$/\.$version\.$1/;
11569: }
11570: }
11571: untie %bighash;
1.413 www 11572: }
1.599 albertel 11573: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 11574: }
11575:
11576: sub deversion {
11577: my $url=shift;
11578: $url=~s/\.\d+\.(\w+)$/\.$1/;
11579: return $url;
1.210 www 11580: }
11581:
1.31 www 11582: # ------------------------------------------------------ Return symb list entry
11583:
11584: sub symbread {
1.1172.2.66 raeburn 11585: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
1.1172.2.54 raeburn 11586: my $cache_str='request.symbread.cached.'.$thisfn;
1.1172.2.66 raeburn 11587: if (defined($env{$cache_str})) {
11588: if ($ignorecachednull) {
11589: return $env{$cache_str} unless ($env{$cache_str} eq '');
11590: } else {
11591: return $env{$cache_str};
11592: }
11593: }
1.242 www 11594: # no filename provided? try from environment
1.1172.2.54 raeburn 11595: unless ($thisfn) {
1.620 albertel 11596: if ($env{'request.symb'}) {
1.1172.2.13 raeburn 11597: return $env{$cache_str}=&symbclean($env{'request.symb'});
11598: }
11599: $thisfn=$env{'request.filename'};
1.44 www 11600: }
1.569 albertel 11601: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 11602: # is that filename actually a symb? Verify, clean, and return
11603: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 11604: if (&symbverify($thisfn,$1)) {
1.620 albertel 11605: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 11606: }
1.242 www 11607: }
1.44 www 11608: $thisfn=declutter($thisfn);
1.31 www 11609: my %hash;
1.37 www 11610: my %bighash;
11611: my $syval='';
1.620 albertel 11612: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 11613: my $targetfn = $thisfn;
1.609 banghart 11614: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 11615: $targetfn = 'adm/wrapper/'.$thisfn;
11616: }
1.687 albertel 11617: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
11618: $targetfn=$1;
11619: }
1.620 albertel 11620: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 11621: &GDBM_READER(),0640)) {
1.481 raeburn 11622: $syval=$hash{$targetfn};
1.37 www 11623: untie(%hash);
11624: }
11625: # ---------------------------------------------------------- There was an entry
11626: if ($syval) {
1.601 albertel 11627: #unless ($syval=~/\_\d+$/) {
1.620 albertel 11628: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 11629: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 11630: #return $env{$cache_str}='';
1.601 albertel 11631: #}
11632: #$syval.=$1;
11633: #}
1.37 www 11634: } else {
11635: # ------------------------------------------------------- Was not in symb table
1.620 albertel 11636: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 11637: &GDBM_READER(),0640)) {
1.37 www 11638: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 11639: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 11640: unless ($ids) {
11641: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 11642: }
11643: unless ($ids) {
11644: # alias?
11645: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 11646: }
1.37 www 11647: if ($ids) {
11648: # ------------------------------------------------------------------- Has ID(s)
11649: my @possibilities=split(/\,/,$ids);
1.39 www 11650: if ($#possibilities==0) {
11651: # ----------------------------------------------- There is only one possibility
1.37 www 11652: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 11653: $syval=&encode_symb($bighash{'map_id_'.$mapid},
11654: $resid,$thisfn);
1.1172.2.66 raeburn 11655: if (ref($possibles) eq 'HASH') {
11656: $possibles->{$syval} = 1;
11657: }
11658: if ($checkforblock) {
11659: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
11660: if (@blockers) {
11661: $syval = '';
11662: return;
11663: }
11664: }
11665: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 11666: # ------------------------------------------ There is more than one possibility
11667: my $realpossible=0;
1.800 albertel 11668: foreach my $id (@possibilities) {
11669: my $file=$bighash{'src_'.$id};
1.1172.2.66 raeburn 11670: my $canaccess;
11671: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11672: $canaccess = 1;
11673: } else {
11674: $canaccess = &allowed('bre',$file);
11675: }
11676: if ($canaccess) {
11677: my ($mapid,$resid)=split(/\./,$id);
11678: if ($bighash{'map_type_'.$mapid} ne 'page') {
11679: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
11680: $resid,$thisfn);
11681: if (ref($possibles) eq 'HASH') {
11682: $possibles->{$syval} = 1;
11683: }
11684: if ($checkforblock) {
11685: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
11686: unless (@blockers > 0) {
11687: $syval = $poss_syval;
11688: $realpossible++;
11689: }
11690: } else {
11691: $syval = $poss_syval;
11692: $realpossible++;
11693: }
11694: }
1.39 www 11695: }
1.191 harris41 11696: }
1.39 www 11697: if ($realpossible!=1) { $syval=''; }
1.249 www 11698: } else {
11699: $syval='';
1.37 www 11700: }
11701: }
1.1172.2.66 raeburn 11702: untie(%bighash);
1.481 raeburn 11703: }
1.31 www 11704: }
1.62 www 11705: if ($syval) {
1.620 albertel 11706: return $env{$cache_str}=$syval;
1.62 www 11707: }
1.31 www 11708: }
1.949 raeburn 11709: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 11710: return $env{$cache_str}='';
1.31 www 11711: }
11712:
11713: # ---------------------------------------------------------- Return random seed
11714:
1.32 www 11715: sub numval {
11716: my $txt=shift;
11717: $txt=~tr/A-J/0-9/;
11718: $txt=~tr/a-j/0-9/;
11719: $txt=~tr/K-T/0-9/;
11720: $txt=~tr/k-t/0-9/;
11721: $txt=~tr/U-Z/0-5/;
11722: $txt=~tr/u-z/0-5/;
11723: $txt=~s/\D//g;
1.564 albertel 11724: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 11725: return int($txt);
1.368 albertel 11726: }
11727:
1.484 albertel 11728: sub numval2 {
11729: my $txt=shift;
11730: $txt=~tr/A-J/0-9/;
11731: $txt=~tr/a-j/0-9/;
11732: $txt=~tr/K-T/0-9/;
11733: $txt=~tr/k-t/0-9/;
11734: $txt=~tr/U-Z/0-5/;
11735: $txt=~tr/u-z/0-5/;
11736: $txt=~s/\D//g;
11737: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11738: my $total;
11739: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 11740: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 11741: return int($total);
11742: }
11743:
1.575 albertel 11744: sub numval3 {
11745: use integer;
11746: my $txt=shift;
11747: $txt=~tr/A-J/0-9/;
11748: $txt=~tr/a-j/0-9/;
11749: $txt=~tr/K-T/0-9/;
11750: $txt=~tr/k-t/0-9/;
11751: $txt=~tr/U-Z/0-5/;
11752: $txt=~tr/u-z/0-5/;
11753: $txt=~s/\D//g;
11754: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11755: my $total;
11756: foreach my $val (@txts) { $total+=$val; }
11757: if ($_64bit) { $total=(($total<<32)>>32); }
11758: return $total;
11759: }
11760:
1.675 albertel 11761: sub digest {
11762: my ($data)=@_;
11763: my $digest=&Digest::MD5::md5($data);
11764: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11765: my ($e,$f);
11766: {
11767: use integer;
11768: $e=($a+$b);
11769: $f=($c+$d);
11770: if ($_64bit) {
11771: $e=(($e<<32)>>32);
11772: $f=(($f<<32)>>32);
11773: }
11774: }
11775: if (wantarray) {
11776: return ($e,$f);
11777: } else {
11778: my $g;
11779: {
11780: use integer;
11781: $g=($e+$f);
11782: if ($_64bit) {
11783: $g=(($g<<32)>>32);
11784: }
11785: }
11786: return $g;
11787: }
11788: }
11789:
1.368 albertel 11790: sub latest_rnd_algorithm_id {
1.675 albertel 11791: return '64bit5';
1.366 albertel 11792: }
1.32 www 11793:
1.503 albertel 11794: sub get_rand_alg {
11795: my ($courseid)=@_;
1.790 albertel 11796: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 11797: if ($courseid) {
1.620 albertel 11798: return $env{"course.$courseid.rndseed"};
1.503 albertel 11799: }
11800: return &latest_rnd_algorithm_id();
11801: }
11802:
1.562 albertel 11803: sub validCODE {
11804: my ($CODE)=@_;
11805: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11806: return 0;
11807: }
11808:
1.491 albertel 11809: sub getCODE {
1.620 albertel 11810: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 11811: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11812: defined($Apache::lonhomework::parsing_a_task) ) &&
11813: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 11814: return $Apache::lonhomework::history{'resource.CODE'};
11815: }
11816: return undef;
11817: }
1.1133 foxr 11818: #
11819: # Determines the random seed for a specific context:
11820: #
11821: # parameters:
11822: # symb - in course context the symb for the seed.
11823: # course_id - The course id of the form domain_coursenum.
11824: # domain - Domain for the user.
11825: # course - Course for the user.
11826: # cenv - environment of the course.
11827: #
11828: # NOTE:
11829: # All parameters are picked out of the environment if missing
11830: # or not defined.
11831: # If a symb cannot be determined the current time is used instead.
11832: #
11833: # For a given well defined symb, courside, domain, username,
11834: # and course environment, the seed is reproducible.
11835: #
1.31 www 11836: sub rndseed {
1.1133 foxr 11837: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 11838: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 11839: if (!defined($symb)) {
1.366 albertel 11840: unless ($symb=$wsymb) { return time; }
11841: }
1.1146 foxr 11842: if (!defined $courseid) {
11843: $courseid=$wcourseid;
11844: }
11845: if (!defined $domain) { $domain=$wdomain; }
11846: if (!defined $username) { $username=$wusername }
1.1133 foxr 11847:
11848: my $which;
11849: if (defined($cenv->{'rndseed'})) {
11850: $which = $cenv->{'rndseed'};
11851: } else {
11852: $which =&get_rand_alg($courseid);
11853: }
1.491 albertel 11854: if (defined(&getCODE())) {
1.675 albertel 11855: if ($which eq '64bit5') {
11856: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
11857: } elsif ($which eq '64bit4') {
1.575 albertel 11858: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
11859: } else {
11860: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
11861: }
1.675 albertel 11862: } elsif ($which eq '64bit5') {
11863: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 11864: } elsif ($which eq '64bit4') {
11865: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 11866: } elsif ($which eq '64bit3') {
11867: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 11868: } elsif ($which eq '64bit2') {
11869: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 11870: } elsif ($which eq '64bit') {
11871: return &rndseed_64bit($symb,$courseid,$domain,$username);
11872: }
11873: return &rndseed_32bit($symb,$courseid,$domain,$username);
11874: }
11875:
11876: sub rndseed_32bit {
11877: my ($symb,$courseid,$domain,$username)=@_;
11878: {
11879: use integer;
11880: my $symbchck=unpack("%32C*",$symb) << 27;
11881: my $symbseed=numval($symb) << 22;
11882: my $namechck=unpack("%32C*",$username) << 17;
11883: my $nameseed=numval($username) << 12;
11884: my $domainseed=unpack("%32C*",$domain) << 7;
11885: my $courseseed=unpack("%32C*",$courseid);
11886: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 11887: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11888: #&logthis("rndseed :$num:$symb");
1.564 albertel 11889: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 11890: return $num;
11891: }
11892: }
11893:
11894: sub rndseed_64bit {
11895: my ($symb,$courseid,$domain,$username)=@_;
11896: {
11897: use integer;
11898: my $symbchck=unpack("%32S*",$symb) << 21;
11899: my $symbseed=numval($symb) << 10;
11900: my $namechck=unpack("%32S*",$username);
11901:
11902: my $nameseed=numval($username) << 21;
11903: my $domainseed=unpack("%32S*",$domain) << 10;
11904: my $courseseed=unpack("%32S*",$courseid);
11905:
11906: my $num1=$symbchck+$symbseed+$namechck;
11907: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11908: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11909: #&logthis("rndseed :$num:$symb");
1.564 albertel 11910: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 11911: return "$num1,$num2";
1.155 albertel 11912: }
1.366 albertel 11913: }
11914:
1.443 albertel 11915: sub rndseed_64bit2 {
11916: my ($symb,$courseid,$domain,$username)=@_;
11917: {
11918: use integer;
11919: # strings need to be an even # of cahracters long, it it is odd the
11920: # last characters gets thrown away
11921: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11922: my $symbseed=numval($symb) << 10;
11923: my $namechck=unpack("%32S*",$username.' ');
11924:
11925: my $nameseed=numval($username) << 21;
1.501 albertel 11926: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11927: my $courseseed=unpack("%32S*",$courseid.' ');
11928:
11929: my $num1=$symbchck+$symbseed+$namechck;
11930: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11931: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11932: #&logthis("rndseed :$num:$symb");
1.803 albertel 11933: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 11934: return "$num1,$num2";
11935: }
11936: }
11937:
11938: sub rndseed_64bit3 {
11939: my ($symb,$courseid,$domain,$username)=@_;
11940: {
11941: use integer;
11942: # strings need to be an even # of cahracters long, it it is odd the
11943: # last characters gets thrown away
11944: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11945: my $symbseed=numval2($symb) << 10;
11946: my $namechck=unpack("%32S*",$username.' ');
11947:
11948: my $nameseed=numval2($username) << 21;
1.443 albertel 11949: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11950: my $courseseed=unpack("%32S*",$courseid.' ');
11951:
11952: my $num1=$symbchck+$symbseed+$namechck;
11953: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11954: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11955: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 11956: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 11957:
1.503 albertel 11958: return "$num1:$num2";
1.443 albertel 11959: }
11960: }
11961:
1.575 albertel 11962: sub rndseed_64bit4 {
11963: my ($symb,$courseid,$domain,$username)=@_;
11964: {
11965: use integer;
11966: # strings need to be an even # of cahracters long, it it is odd the
11967: # last characters gets thrown away
11968: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11969: my $symbseed=numval3($symb) << 10;
11970: my $namechck=unpack("%32S*",$username.' ');
11971:
11972: my $nameseed=numval3($username) << 21;
11973: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11974: my $courseseed=unpack("%32S*",$courseid.' ');
11975:
11976: my $num1=$symbchck+$symbseed+$namechck;
11977: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11978: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11979: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 11980: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 11981:
1.575 albertel 11982: return "$num1:$num2";
11983: }
11984: }
11985:
1.675 albertel 11986: sub rndseed_64bit5 {
11987: my ($symb,$courseid,$domain,$username)=@_;
11988: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
11989: return "$num1:$num2";
11990: }
11991:
1.366 albertel 11992: sub rndseed_CODE_64bit {
11993: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 11994: {
1.366 albertel 11995: use integer;
1.443 albertel 11996: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 11997: my $symbseed=numval2($symb);
1.491 albertel 11998: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11999: my $CODEseed=numval(&getCODE());
1.443 albertel 12000: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 12001: my $num1=$symbseed+$CODEchck;
12002: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12003: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12004: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 12005: if ($_64bit) { $num1=(($num1<<32)>>32); }
12006: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 12007: return "$num1:$num2";
1.366 albertel 12008: }
12009: }
12010:
1.575 albertel 12011: sub rndseed_CODE_64bit4 {
12012: my ($symb,$courseid,$domain,$username)=@_;
12013: {
12014: use integer;
12015: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12016: my $symbseed=numval3($symb);
12017: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12018: my $CODEseed=numval3(&getCODE());
12019: my $courseseed=unpack("%32S*",$courseid.' ');
12020: my $num1=$symbseed+$CODEchck;
12021: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12022: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12023: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 12024: if ($_64bit) { $num1=(($num1<<32)>>32); }
12025: if ($_64bit) { $num2=(($num2<<32)>>32); }
12026: return "$num1:$num2";
12027: }
12028: }
12029:
1.675 albertel 12030: sub rndseed_CODE_64bit5 {
12031: my ($symb,$courseid,$domain,$username)=@_;
12032: my $code = &getCODE();
12033: my ($num1,$num2)=&digest("$symb,$courseid,$code");
12034: return "$num1:$num2";
12035: }
12036:
1.366 albertel 12037: sub setup_random_from_rndseed {
12038: my ($rndseed)=@_;
1.503 albertel 12039: if ($rndseed =~/([,:])/) {
1.1172.2.51 raeburn 12040: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
12041: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
12042: &Math::Random::random_set_seed_from_phrase($rndseed);
12043: } else {
12044: &Math::Random::random_set_seed($num1,$num2);
12045: }
1.366 albertel 12046: } else {
12047: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 12048: }
1.36 albertel 12049: }
12050:
1.474 albertel 12051: sub latest_receipt_algorithm_id {
1.835 albertel 12052: return 'receipt3';
1.474 albertel 12053: }
12054:
1.480 www 12055: sub recunique {
12056: my $fucourseid=shift;
12057: my $unique;
1.835 albertel 12058: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
12059: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 12060: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 12061: } else {
12062: $unique=$perlvar{'lonReceipt'};
12063: }
12064: return unpack("%32C*",$unique);
12065: }
12066:
12067: sub recprefix {
12068: my $fucourseid=shift;
12069: my $prefix;
1.835 albertel 12070: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
12071: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 12072: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 12073: } else {
12074: $prefix=$perlvar{'lonHostID'};
12075: }
12076: return unpack("%32C*",$prefix);
12077: }
12078:
1.76 www 12079: sub ireceipt {
1.474 albertel 12080: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 12081:
12082: my $return =&recprefix($fucourseid).'-';
12083:
12084: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
12085: $env{'request.state'} eq 'construct') {
12086: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
12087: return $return;
12088: }
12089:
1.76 www 12090: my $cuname=unpack("%32C*",$funame);
12091: my $cudom=unpack("%32C*",$fudom);
12092: my $cucourseid=unpack("%32C*",$fucourseid);
12093: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 12094: my $cunique=&recunique($fucourseid);
1.474 albertel 12095: my $cpart=unpack("%32S*",$part);
1.835 albertel 12096: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
12097:
1.790 albertel 12098: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 12099:
12100: $return.= ($cunique%$cuname+
12101: $cunique%$cudom+
12102: $cusymb%$cuname+
12103: $cusymb%$cudom+
12104: $cucourseid%$cuname+
12105: $cucourseid%$cudom+
12106: $cpart%$cuname+
12107: $cpart%$cudom);
12108: } else {
12109: $return.= ($cunique%$cuname+
12110: $cunique%$cudom+
12111: $cusymb%$cuname+
12112: $cusymb%$cudom+
12113: $cucourseid%$cuname+
12114: $cucourseid%$cudom);
12115: }
12116: return $return;
1.76 www 12117: }
12118:
12119: sub receipt {
1.474 albertel 12120: my ($part)=@_;
1.790 albertel 12121: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 12122: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 12123: }
1.260 ng 12124:
1.790 albertel 12125: sub whichuser {
12126: my ($passedsymb)=@_;
12127: my ($symb,$courseid,$domain,$name,$publicuser);
12128: if (defined($env{'form.grade_symb'})) {
12129: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
12130: my $allowed=&allowed('vgr',$tmp_courseid);
12131: if (!$allowed &&
12132: exists($env{'request.course.sec'}) &&
12133: $env{'request.course.sec'} !~ /^\s*$/) {
12134: $allowed=&allowed('vgr',$tmp_courseid.
12135: '/'.$env{'request.course.sec'});
12136: }
12137: if ($allowed) {
12138: ($symb)=&get_env_multiple('form.grade_symb');
12139: $courseid=$tmp_courseid;
12140: ($domain)=&get_env_multiple('form.grade_domain');
12141: ($name)=&get_env_multiple('form.grade_username');
12142: return ($symb,$courseid,$domain,$name,$publicuser);
12143: }
12144: }
12145: if (!$passedsymb) {
12146: $symb=&symbread();
12147: } else {
12148: $symb=$passedsymb;
12149: }
12150: $courseid=$env{'request.course.id'};
12151: $domain=$env{'user.domain'};
12152: $name=$env{'user.name'};
12153: if ($name eq 'public' && $domain eq 'public') {
12154: if (!defined($env{'form.username'})) {
12155: $env{'form.username'}.=time.rand(10000000);
12156: }
12157: $name.=$env{'form.username'};
12158: }
12159: return ($symb,$courseid,$domain,$name,$publicuser);
12160:
12161: }
12162:
1.36 albertel 12163: # ------------------------------------------------------------ Serves up a file
1.472 albertel 12164: # returns either the contents of the file or
12165: # -1 if the file doesn't exist
1.481 raeburn 12166: #
12167: # if the target is a file that was uploaded via DOCS,
12168: # a check will be made to see if a current copy exists on the local server,
12169: # if it does this will be served, otherwise a copy will be retrieved from
12170: # the home server for the course and stored in /home/httpd/html/userfiles on
12171: # the local server.
1.472 albertel 12172:
1.36 albertel 12173: sub getfile {
1.538 albertel 12174: my ($file) = @_;
1.609 banghart 12175: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 12176: &repcopy($file);
12177: return &readfile($file);
12178: }
12179:
12180: sub repcopy_userfile {
12181: my ($file)=@_;
1.1142 raeburn 12182: my $londocroot = $perlvar{'lonDocRoot'};
12183: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 12184: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 12185: my ($cdom,$cnum,$filename) =
1.811 albertel 12186: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 12187: my $uri="/uploaded/$cdom/$cnum/$filename";
12188: if (-e "$file") {
1.828 www 12189: # we already have a local copy, check it out
1.538 albertel 12190: my @fileinfo = stat($file);
1.828 www 12191: my $rtncode;
12192: my $info;
1.538 albertel 12193: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 12194: if ($lwpresp ne 'ok') {
1.828 www 12195: # there is no such file anymore, even though we had a local copy
1.482 albertel 12196: if ($rtncode eq '404') {
1.538 albertel 12197: unlink($file);
1.482 albertel 12198: }
12199: return -1;
12200: }
12201: if ($info < $fileinfo[9]) {
1.828 www 12202: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 12203: return 'ok';
1.828 www 12204: } else {
12205: # the file is outdated, get rid of it
12206: unlink($file);
1.482 albertel 12207: }
1.828 www 12208: }
12209: # one way or the other, at this point, we don't have the file
12210: # construct the correct path for the file
12211: my @parts = ($cdom,$cnum);
12212: if ($filename =~ m|^(.+)/[^/]+$|) {
12213: push @parts, split(/\//,$1);
12214: }
12215: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
12216: foreach my $part (@parts) {
12217: $path .= '/'.$part;
12218: if (!-e $path) {
12219: mkdir($path,0770);
1.482 albertel 12220: }
12221: }
1.828 www 12222: # now the path exists for sure
12223: # get a user agent
12224: my $ua=new LWP::UserAgent;
12225: my $transferfile=$file.'.in.transfer';
12226: # FIXME: this should flock
12227: if (-e $transferfile) { return 'ok'; }
12228: my $request;
12229: $uri=~s/^\///;
1.980 raeburn 12230: my $homeserver = &homeserver($cnum,$cdom);
12231: my $protocol = $protocol{$homeserver};
12232: $protocol = 'http' if ($protocol ne 'https');
12233: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 12234: my $response=$ua->request($request,$transferfile);
12235: # did it work?
12236: if ($response->is_error()) {
12237: unlink($transferfile);
12238: &logthis("Userfile repcopy failed for $uri");
12239: return -1;
12240: }
12241: # worked, rename the transfer file
12242: rename($transferfile,$file);
1.607 raeburn 12243: return 'ok';
1.481 raeburn 12244: }
12245:
1.517 albertel 12246: sub tokenwrapper {
12247: my $uri=shift;
1.980 raeburn 12248: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 12249: $uri=~s|^/||;
1.620 albertel 12250: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 12251: my $token=$1;
1.552 albertel 12252: my (undef,$udom,$uname,$file)=split('/',$uri,4);
12253: if ($udom && $uname && $file) {
12254: $file=~s|(\?\.*)*$||;
1.949 raeburn 12255: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 12256: my $homeserver = &homeserver($uname,$udom);
12257: my $protocol = $protocol{$homeserver};
12258: $protocol = 'http' if ($protocol ne 'https');
12259: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 12260: (($uri=~/\?/)?'&':'?').'token='.$token.
12261: '&tokenissued='.$perlvar{'lonHostID'};
12262: } else {
12263: return '/adm/notfound.html';
12264: }
12265: }
12266:
1.828 www 12267: # call with reqtype HEAD: get last modification time
12268: # call with reqtype GET: get the file contents
12269: # Do not call this with reqtype GET for large files! It loads everything into memory
12270: #
1.481 raeburn 12271: sub getuploaded {
12272: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
12273: $uri=~s/^\///;
1.980 raeburn 12274: my $homeserver = &homeserver($cnum,$cdom);
12275: my $protocol = $protocol{$homeserver};
12276: $protocol = 'http' if ($protocol ne 'https');
12277: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 12278: my $ua=new LWP::UserAgent;
12279: my $request=new HTTP::Request($reqtype,$uri);
12280: my $response=$ua->request($request);
12281: $$rtncode = $response->code;
1.482 albertel 12282: if (! $response->is_success()) {
12283: return 'failed';
12284: }
12285: if ($reqtype eq 'HEAD') {
1.486 www 12286: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 12287: } elsif ($reqtype eq 'GET') {
12288: $$info = $response->content;
1.472 albertel 12289: }
1.482 albertel 12290: return 'ok';
1.36 albertel 12291: }
12292:
1.481 raeburn 12293: sub readfile {
12294: my $file = shift;
12295: if ( (! -e $file ) || ($file eq '') ) { return -1; };
12296: my $fh;
12297: open($fh,"<$file");
12298: my $a='';
1.800 albertel 12299: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 12300: return $a;
12301: }
12302:
1.36 albertel 12303: sub filelocation {
1.590 banghart 12304: my ($dir,$file) = @_;
12305: my $location;
12306: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 12307:
12308: if ($file =~ m-^/adm/-) {
12309: $file=~s-^/adm/wrapper/-/-;
12310: $file=~s-^/adm/coursedocs/showdoc/-/-;
12311: }
1.882 albertel 12312:
1.1139 www 12313: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 12314: $location = $file;
1.609 banghart 12315: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 12316: my ($udom,$uname,$filename)=
1.811 albertel 12317: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 12318: my $home=&homeserver($uname,$udom);
12319: my $is_me=0;
12320: my @ids=¤t_machine_ids();
12321: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
12322: if ($is_me) {
1.1117 foxr 12323: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 12324: } else {
12325: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
12326: $udom.'/'.$uname.'/'.$filename;
12327: }
1.882 albertel 12328: } elsif ($file =~ m-^/adm/-) {
12329: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 12330: } else {
12331: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 12332: $file=~s:^/(res|priv)/:/:;
12333: my $space=$1;
1.590 banghart 12334: if ( !( $file =~ m:^/:) ) {
12335: $location = $dir. '/'.$file;
12336: } else {
1.1142 raeburn 12337: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 12338: }
1.59 albertel 12339: }
1.590 banghart 12340: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 12341: while ($location=~m{/\.\./}) {
12342: if ($location =~ m{/[^/]+/\.\./}) {
12343: $location=~ s{/[^/]+/\.\./}{/}g;
12344: } else {
12345: $location=~ s{/\.\./}{/}g;
12346: }
12347: } #remove dir/..
1.590 banghart 12348: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
12349: return $location;
1.46 www 12350: }
1.36 albertel 12351:
1.46 www 12352: sub hreflocation {
12353: my ($dir,$file)=@_;
1.980 raeburn 12354: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 12355: $file=filelocation($dir,$file);
1.700 albertel 12356: } elsif ($file=~m-^/adm/-) {
12357: $file=~s-^/adm/wrapper/-/-;
12358: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 12359: }
12360: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
12361: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
12362: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 12363: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
12364: {/uploaded/$1/$2/}x;
1.46 www 12365: }
1.913 albertel 12366: if ($file=~ m{^/userfiles/}) {
12367: $file =~ s{^/userfiles/}{/uploaded/};
12368: }
1.462 albertel 12369: return $file;
1.465 albertel 12370: }
12371:
1.1139 www 12372:
12373:
12374:
12375:
1.465 albertel 12376: sub current_machine_domains {
1.853 albertel 12377: return &machine_domains(&hostname($perlvar{'lonHostID'}));
12378: }
12379:
12380: sub machine_domains {
12381: my ($hostname) = @_;
1.465 albertel 12382: my @domains;
1.838 albertel 12383: my %hostname = &all_hostnames();
1.465 albertel 12384: while( my($id, $name) = each(%hostname)) {
1.467 matthew 12385: # &logthis("-$id-$name-$hostname-");
1.465 albertel 12386: if ($hostname eq $name) {
1.844 albertel 12387: push(@domains,&host_domain($id));
1.465 albertel 12388: }
12389: }
12390: return @domains;
12391: }
12392:
12393: sub current_machine_ids {
1.853 albertel 12394: return &machine_ids(&hostname($perlvar{'lonHostID'}));
12395: }
12396:
12397: sub machine_ids {
12398: my ($hostname) = @_;
12399: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 12400: my @ids;
1.888 albertel 12401: my %name_to_host = &all_names();
1.889 albertel 12402: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
12403: return @{ $name_to_host{$hostname} };
12404: }
12405: return;
1.31 www 12406: }
12407:
1.824 raeburn 12408: sub additional_machine_domains {
12409: my @domains;
12410: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
12411: while( my $line = <$fh>) {
12412: $line =~ s/\s//g;
12413: push(@domains,$line);
12414: }
12415: return @domains;
12416: }
12417:
12418: sub default_login_domain {
12419: my $domain = $perlvar{'lonDefDomain'};
12420: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
12421: foreach my $posdom (¤t_machine_domains(),
12422: &additional_machine_domains()) {
12423: if (lc($posdom) eq lc($testdomain)) {
12424: $domain=$posdom;
12425: last;
12426: }
12427: }
12428: return $domain;
12429: }
12430:
1.31 www 12431: # ------------------------------------------------------------- Declutters URLs
12432:
12433: sub declutter {
12434: my $thisfn=shift;
1.569 albertel 12435: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1172.2.49 raeburn 12436: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
12437: $thisfn=~s{^/home/httpd/html}{};
12438: }
1.31 www 12439: $thisfn=~s/^\///;
1.697 albertel 12440: $thisfn=~s|^adm/wrapper/||;
12441: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 12442: $thisfn=~s/^res\///;
1.1172 bisitz 12443: $thisfn=~s/^priv\///;
1.1032 raeburn 12444: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
12445: $thisfn=~s/\?.+$//;
12446: }
1.268 www 12447: return $thisfn;
12448: }
12449:
12450: # ------------------------------------------------------------- Clutter up URLs
12451:
12452: sub clutter {
12453: my $thisfn='/'.&declutter(shift);
1.887 albertel 12454: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 12455: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 12456: $thisfn='/res'.$thisfn;
12457: }
1.1031 raeburn 12458: if ($thisfn !~m|^/adm|) {
12459: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 12460: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 12461: } else {
12462: my ($ext) = ($thisfn =~ /\.(\w+)$/);
12463: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 12464: if ($embstyle eq 'ssi'
12465: || ($embstyle eq 'hdn')
12466: || ($embstyle eq 'rat')
12467: || ($embstyle eq 'prv')
12468: || ($embstyle eq 'ign')) {
12469: #do nothing with these
12470: } elsif (($embstyle eq 'img')
1.695 albertel 12471: || ($embstyle eq 'emb')
12472: || ($embstyle eq 'wrp')) {
12473: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 12474: } elsif ($embstyle eq 'unk'
12475: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 12476: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 12477: } else {
1.718 www 12478: # &logthis("Got a blank emb style");
1.695 albertel 12479: }
1.694 albertel 12480: }
12481: }
1.31 www 12482: return $thisfn;
1.12 www 12483: }
12484:
1.787 albertel 12485: sub clutter_with_no_wrapper {
12486: my $uri = &clutter(shift);
12487: if ($uri =~ m-^/adm/-) {
12488: $uri =~ s-^/adm/wrapper/-/-;
12489: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
12490: }
12491: return $uri;
12492: }
12493:
1.557 albertel 12494: sub freeze_escape {
12495: my ($value)=@_;
12496: if (ref($value)) {
12497: $value=&nfreeze($value);
12498: return '__FROZEN__'.&escape($value);
12499: }
12500: return &escape($value);
12501: }
12502:
1.11 www 12503:
1.557 albertel 12504: sub thaw_unescape {
12505: my ($value)=@_;
12506: if ($value =~ /^__FROZEN__/) {
12507: substr($value,0,10,undef);
12508: $value=&unescape($value);
12509: return &thaw($value);
12510: }
12511: return &unescape($value);
12512: }
12513:
1.436 albertel 12514: sub correct_line_ends {
12515: my ($result)=@_;
12516: $$result =~s/\r\n/\n/mg;
12517: $$result =~s/\r/\n/mg;
1.415 albertel 12518: }
1.1 albertel 12519: # ================================================================ Main Program
12520:
1.184 www 12521: sub goodbye {
1.204 albertel 12522: &logthis("Starting Shut down");
1.443 albertel 12523: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 12524: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 12525: #converted
1.599 albertel 12526: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 12527: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
12528: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
12529: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 12530: #1.1 only
1.870 albertel 12531: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
12532: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
12533: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
12534: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
12535: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 12536: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
12537: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 12538: &flushcourselogs();
12539: &logthis("Shutting down");
12540: }
12541:
1.852 albertel 12542: sub get_dns {
1.1172.2.17 raeburn 12543: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 12544: if (!$ignore_cache) {
12545: my ($content,$cached)=
12546: &Apache::lonnet::is_cached_new('dns',$url);
12547: if ($cached) {
1.1172.2.17 raeburn 12548: &$func($content,$hashref);
1.869 albertel 12549: return;
12550: }
12551: }
12552:
12553: my %alldns;
1.852 albertel 12554: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12555: foreach my $dns (<$config>) {
12556: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 12557: my $line = $1;
12558: my ($host,$protocol) = split(/:/,$line);
12559: if ($protocol ne 'https') {
12560: $protocol = 'http';
12561: }
12562: $alldns{$host} = $protocol;
1.869 albertel 12563: }
12564: while (%alldns) {
1.1172.2.52 raeburn 12565: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.852 albertel 12566: my $ua=new LWP::UserAgent;
1.1134 raeburn 12567: $ua->timeout(30);
1.979 raeburn 12568: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 12569: my $response=$ua->request($request);
1.979 raeburn 12570: delete($alldns{$dns});
1.852 albertel 12571: next if ($response->is_error());
12572: my @content = split("\n",$response->content);
1.1172.2.17 raeburn 12573: unless ($nocache) {
1.1172.2.23 raeburn 12574: &do_cache_new('dns',$url,\@content,30*24*60*60);
1.1172.2.17 raeburn 12575: }
12576: &$func(\@content,$hashref);
1.869 albertel 12577: return;
1.852 albertel 12578: }
12579: close($config);
1.871 albertel 12580: my $which = (split('/',$url))[3];
12581: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
12582: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 12583: my @content = <$config>;
1.1172.2.17 raeburn 12584: &$func(\@content,$hashref);
12585: return;
12586: }
12587:
12588: # ------------------------------------------------------Get DNS checksums file
12589: sub parse_dns_checksums_tab {
12590: my ($lines,$hashref) = @_;
1.1172.2.53 raeburn 12591: my $lonhost = $perlvar{'lonHostID'};
12592: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1172.2.17 raeburn 12593: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1172.2.53 raeburn 12594: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
12595: my $webconfdir = '/etc/httpd/conf';
12596: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
12597: $webconfdir = '/etc/apache2';
12598: } elsif ($distro =~ /^sles(\d+)$/) {
12599: if ($1 >= 10) {
12600: $webconfdir = '/etc/apache2';
12601: }
12602: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
12603: if ($1 >= 10.0) {
12604: $webconfdir = '/etc/apache2';
12605: }
12606: }
1.1172.2.17 raeburn 12607: my ($release,$timestamp) = split(/\-/,$loncaparev);
12608: my (%chksum,%revnum);
12609: if (ref($lines) eq 'ARRAY') {
12610: chomp(@{$lines});
1.1172.2.34 raeburn 12611: my $version = shift(@{$lines});
12612: if ($version eq $release) {
1.1172.2.17 raeburn 12613: foreach my $line (@{$lines}) {
1.1172.2.34 raeburn 12614: my ($file,$version,$shasum) = split(/,/,$line);
1.1172.2.53 raeburn 12615: if ($file =~ m{^/etc/httpd/conf}) {
12616: if ($webconfdir eq '/etc/apache2') {
12617: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
12618: }
12619: }
1.1172.2.34 raeburn 12620: $chksum{$file} = $shasum;
12621: $revnum{$file} = $version;
1.1172.2.17 raeburn 12622: }
12623: if (ref($hashref) eq 'HASH') {
12624: %{$hashref} = (
12625: sums => \%chksum,
12626: versions => \%revnum,
12627: );
12628: }
12629: }
12630: }
1.869 albertel 12631: return;
1.852 albertel 12632: }
1.1172.2.17 raeburn 12633:
12634: sub fetch_dns_checksums {
12635: my %checksums;
1.1172.2.34 raeburn 12636: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1172.2.48 raeburn 12637: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1172.2.34 raeburn 12638: my ($release,$timestamp) = split(/\-/,$loncaparev);
12639: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1172.2.17 raeburn 12640: \%checksums);
12641: return \%checksums;
12642: }
12643:
1.327 albertel 12644: # ------------------------------------------------------------ Read domain file
12645: {
1.852 albertel 12646: my $loaded;
1.846 albertel 12647: my %domain;
12648:
1.852 albertel 12649: sub parse_domain_tab {
12650: my ($lines) = @_;
12651: foreach my $line (@$lines) {
12652: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 12653:
1.846 albertel 12654: chomp($line);
1.852 albertel 12655: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 12656: my %this_domain;
12657: foreach my $field ('description', 'auth_def', 'auth_arg_def',
12658: 'lang_def', 'city', 'longi', 'lati',
12659: 'primary') {
12660: $this_domain{$field} = shift(@elements);
12661: }
12662: $domain{$name} = \%this_domain;
1.852 albertel 12663: }
12664: }
1.864 albertel 12665:
12666: sub reset_domain_info {
12667: undef($loaded);
12668: undef(%domain);
12669: }
12670:
1.852 albertel 12671: sub load_domain_tab {
1.1172.2.70 raeburn 12672: my ($ignore_cache,$nocache) = @_;
12673: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 12674: my $fh;
12675: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
12676: my @lines = <$fh>;
12677: &parse_domain_tab(\@lines);
1.448 albertel 12678: }
1.852 albertel 12679: close($fh);
12680: $loaded = 1;
1.327 albertel 12681: }
1.846 albertel 12682:
12683: sub domain {
1.852 albertel 12684: &load_domain_tab() if (!$loaded);
12685:
1.846 albertel 12686: my ($name,$what) = @_;
12687: return if ( !exists($domain{$name}) );
12688:
12689: if (!$what) {
12690: return $domain{$name}{'description'};
12691: }
12692: return $domain{$name}{$what};
12693: }
1.974 raeburn 12694:
12695: sub domain_info {
12696: &load_domain_tab() if (!$loaded);
12697: return %domain;
12698: }
12699:
1.327 albertel 12700: }
12701:
12702:
1.1 albertel 12703: # ------------------------------------------------------------- Read hosts file
12704: {
1.838 albertel 12705: my %hostname;
1.844 albertel 12706: my %hostdom;
1.845 albertel 12707: my %libserv;
1.852 albertel 12708: my $loaded;
1.888 albertel 12709: my %name_to_host;
1.1074 raeburn 12710: my %internetdom;
1.1107 raeburn 12711: my %LC_dns_serv;
1.852 albertel 12712:
12713: sub parse_hosts_tab {
12714: my ($file) = @_;
12715: foreach my $configline (@$file) {
12716: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 12717: chomp($configline);
12718: if ($configline =~ /^\^/) {
12719: if ($configline =~ /^\^([\w.\-]+)/) {
12720: $LC_dns_serv{$1} = 1;
12721: }
12722: next;
12723: }
1.1074 raeburn 12724: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 12725: $name=~s/\s//g;
12726: if ($id && $domain && $role && $name) {
12727: $hostname{$id}=$name;
1.888 albertel 12728: push(@{$name_to_host{$name}}, $id);
1.852 albertel 12729: $hostdom{$id}=$domain;
12730: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 12731: if (defined($protocol)) {
12732: if ($protocol eq 'https') {
12733: $protocol{$id} = $protocol;
12734: } else {
12735: $protocol{$id} = 'http';
12736: }
1.968 raeburn 12737: } else {
1.969 raeburn 12738: $protocol{$id} = 'http';
1.968 raeburn 12739: }
1.1074 raeburn 12740: if (defined($intdom)) {
12741: $internetdom{$id} = $intdom;
12742: }
1.852 albertel 12743: }
12744: }
12745: }
1.864 albertel 12746:
12747: sub reset_hosts_info {
1.897 albertel 12748: &purge_remembered();
1.864 albertel 12749: &reset_domain_info();
12750: &reset_hosts_ip_info();
1.892 albertel 12751: undef(%name_to_host);
1.864 albertel 12752: undef(%hostname);
12753: undef(%hostdom);
12754: undef(%libserv);
12755: undef($loaded);
12756: }
1.1 albertel 12757:
1.852 albertel 12758: sub load_hosts_tab {
1.1172.2.70 raeburn 12759: my ($ignore_cache,$nocache) = @_;
12760: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.852 albertel 12761: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12762: my @config = <$config>;
12763: &parse_hosts_tab(\@config);
12764: close($config);
12765: $loaded=1;
1.1 albertel 12766: }
1.852 albertel 12767:
1.838 albertel 12768: sub hostname {
1.852 albertel 12769: &load_hosts_tab() if (!$loaded);
12770:
1.838 albertel 12771: my ($lonid) = @_;
12772: return $hostname{$lonid};
12773: }
1.845 albertel 12774:
1.838 albertel 12775: sub all_hostnames {
1.852 albertel 12776: &load_hosts_tab() if (!$loaded);
12777:
1.838 albertel 12778: return %hostname;
12779: }
1.845 albertel 12780:
1.888 albertel 12781: sub all_names {
1.1172.2.70 raeburn 12782: my ($ignore_cache,$nocache) = @_;
12783: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 12784:
12785: return %name_to_host;
12786: }
12787:
1.974 raeburn 12788: sub all_host_domain {
12789: &load_hosts_tab() if (!$loaded);
12790: return %hostdom;
12791: }
12792:
1.845 albertel 12793: sub is_library {
1.852 albertel 12794: &load_hosts_tab() if (!$loaded);
12795:
1.845 albertel 12796: return exists($libserv{$_[0]});
12797: }
12798:
12799: sub all_library {
1.852 albertel 12800: &load_hosts_tab() if (!$loaded);
12801:
1.845 albertel 12802: return %libserv;
12803: }
12804:
1.1062 droeschl 12805: sub unique_library {
12806: #2x reverse removes all hostnames that appear more than once
12807: my %unique = reverse &all_library();
12808: return reverse %unique;
12809: }
12810:
1.841 albertel 12811: sub get_servers {
1.852 albertel 12812: &load_hosts_tab() if (!$loaded);
12813:
1.841 albertel 12814: my ($domain,$type) = @_;
12815: my %possible_hosts = ($type eq 'library') ? %libserv
12816: : %hostname;
12817: my %result;
1.842 albertel 12818: if (ref($domain) eq 'ARRAY') {
12819: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 12820: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 12821: $result{$host} = $hostname;
12822: }
12823: }
12824: } else {
12825: while ( my ($host,$hostname) = each(%possible_hosts)) {
12826: if ($hostdom{$host} eq $domain) {
12827: $result{$host} = $hostname;
12828: }
1.841 albertel 12829: }
12830: }
12831: return %result;
12832: }
1.845 albertel 12833:
1.1062 droeschl 12834: sub get_unique_servers {
12835: my %unique = reverse &get_servers(@_);
12836: return reverse %unique;
12837: }
12838:
1.844 albertel 12839: sub host_domain {
1.852 albertel 12840: &load_hosts_tab() if (!$loaded);
12841:
1.844 albertel 12842: my ($lonid) = @_;
12843: return $hostdom{$lonid};
12844: }
12845:
1.841 albertel 12846: sub all_domains {
1.852 albertel 12847: &load_hosts_tab() if (!$loaded);
12848:
1.841 albertel 12849: my %seen;
12850: my @uniq = grep(!$seen{$_}++, values(%hostdom));
12851: return @uniq;
12852: }
1.1074 raeburn 12853:
12854: sub internet_dom {
12855: &load_hosts_tab() if (!$loaded);
12856:
12857: my ($lonid) = @_;
12858: return $internetdom{$lonid};
12859: }
1.1107 raeburn 12860:
12861: sub is_LC_dns {
12862: &load_hosts_tab() if (!$loaded);
12863:
12864: my ($hostname) = @_;
12865: return exists($LC_dns_serv{$hostname});
12866: }
12867:
1.1 albertel 12868: }
12869:
1.847 albertel 12870: {
12871: my %iphost;
1.856 albertel 12872: my %name_to_ip;
12873: my %lonid_to_ip;
1.869 albertel 12874:
1.847 albertel 12875: sub get_hosts_from_ip {
12876: my ($ip) = @_;
12877: my %iphosts = &get_iphost();
12878: if (ref($iphosts{$ip})) {
12879: return @{$iphosts{$ip}};
12880: }
12881: return;
1.839 albertel 12882: }
1.864 albertel 12883:
12884: sub reset_hosts_ip_info {
12885: undef(%iphost);
12886: undef(%name_to_ip);
12887: undef(%lonid_to_ip);
12888: }
1.856 albertel 12889:
12890: sub get_host_ip {
12891: my ($lonid) = @_;
12892: if (exists($lonid_to_ip{$lonid})) {
12893: return $lonid_to_ip{$lonid};
12894: }
12895: my $name=&hostname($lonid);
12896: my $ip = gethostbyname($name);
12897: return if (!$ip || length($ip) ne 4);
12898: $ip=inet_ntoa($ip);
12899: $name_to_ip{$name} = $ip;
12900: $lonid_to_ip{$lonid} = $ip;
12901: return $ip;
12902: }
1.847 albertel 12903:
12904: sub get_iphost {
1.1172.2.70 raeburn 12905: my ($ignore_cache,$nocache) = @_;
1.894 albertel 12906:
1.869 albertel 12907: if (!$ignore_cache) {
12908: if (%iphost) {
12909: return %iphost;
12910: }
12911: my ($ip_info,$cached)=
12912: &Apache::lonnet::is_cached_new('iphost','iphost');
12913: if ($cached) {
12914: %iphost = %{$ip_info->[0]};
12915: %name_to_ip = %{$ip_info->[1]};
12916: %lonid_to_ip = %{$ip_info->[2]};
12917: return %iphost;
12918: }
12919: }
1.894 albertel 12920:
12921: # get yesterday's info for fallback
12922: my %old_name_to_ip;
12923: my ($ip_info,$cached)=
12924: &Apache::lonnet::is_cached_new('iphost','iphost');
12925: if ($cached) {
12926: %old_name_to_ip = %{$ip_info->[1]};
12927: }
12928:
1.1172.2.70 raeburn 12929: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 12930: foreach my $name (keys(%name_to_host)) {
1.847 albertel 12931: my $ip;
12932: if (!exists($name_to_ip{$name})) {
12933: $ip = gethostbyname($name);
12934: if (!$ip || length($ip) ne 4) {
1.894 albertel 12935: if (defined($old_name_to_ip{$name})) {
12936: $ip = $old_name_to_ip{$name};
12937: &logthis("Can't find $name defaulting to old $ip");
12938: } else {
12939: &logthis("Name $name no IP found");
12940: next;
12941: }
12942: } else {
12943: $ip=inet_ntoa($ip);
1.847 albertel 12944: }
12945: $name_to_ip{$name} = $ip;
12946: } else {
12947: $ip = $name_to_ip{$name};
1.653 albertel 12948: }
1.888 albertel 12949: foreach my $id (@{ $name_to_host{$name} }) {
12950: $lonid_to_ip{$id} = $ip;
12951: }
12952: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 12953: }
1.1172.2.70 raeburn 12954: unless ($nocache) {
12955: &do_cache_new('iphost','iphost',
12956: [\%iphost,\%name_to_ip,\%lonid_to_ip],
12957: 48*60*60);
12958: }
1.869 albertel 12959:
1.847 albertel 12960: return %iphost;
1.598 albertel 12961: }
12962:
1.992 raeburn 12963: #
12964: # Given a DNS returns the loncapa host name for that DNS
12965: #
12966: sub host_from_dns {
12967: my ($dns) = @_;
12968: my @hosts;
12969: my $ip;
12970:
1.993 raeburn 12971: if (exists($name_to_ip{$dns})) {
1.992 raeburn 12972: $ip = $name_to_ip{$dns};
12973: }
12974: if (!$ip) {
12975: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
12976: if (length($ip) == 4) {
12977: $ip = &IO::Socket::inet_ntoa($ip);
12978: }
12979: }
12980: if ($ip) {
12981: @hosts = get_hosts_from_ip($ip);
12982: return $hosts[0];
12983: }
12984: return undef;
1.986 foxr 12985: }
1.992 raeburn 12986:
1.1074 raeburn 12987: sub get_internet_names {
12988: my ($lonid) = @_;
12989: return if ($lonid eq '');
12990: my ($idnref,$cached)=
12991: &Apache::lonnet::is_cached_new('internetnames',$lonid);
12992: if ($cached) {
12993: return $idnref;
12994: }
12995: my $ip = &get_host_ip($lonid);
12996: my @hosts = &get_hosts_from_ip($ip);
12997: my %iphost = &get_iphost();
12998: my (@idns,%seen);
12999: foreach my $id (@hosts) {
13000: my $dom = &host_domain($id);
13001: my $prim_id = &domain($dom,'primary');
13002: my $prim_ip = &get_host_ip($prim_id);
13003: next if ($seen{$prim_ip});
13004: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
13005: foreach my $id (@{$iphost{$prim_ip}}) {
13006: my $intdom = &internet_dom($id);
13007: unless (grep(/^\Q$intdom\E$/,@idns)) {
13008: push(@idns,$intdom);
13009: }
13010: }
13011: }
13012: $seen{$prim_ip} = 1;
13013: }
1.1172.2.23 raeburn 13014: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 13015: }
13016:
1.986 foxr 13017: }
13018:
1.1079 raeburn 13019: sub all_loncaparevs {
1.1172.2.39 raeburn 13020: 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 13021: }
13022:
1.1172.2.27 raeburn 13023: # ------------------------------------------------------- Read loncaparev table
13024: {
13025: sub load_loncaparevs {
13026: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
13027: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
13028: while (my $configline=<$config>) {
13029: chomp($configline);
13030: my ($hostid,$loncaparev)=split(/:/,$configline);
13031: $loncaparevs{$hostid}=$loncaparev;
13032: }
13033: close($config);
13034: }
13035: }
13036: }
13037: }
13038:
13039: # ----------------------------------------------------- Read serverhostID table
13040: {
13041: sub load_serverhomeIDs {
13042: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
13043: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
13044: while (my $configline=<$config>) {
13045: chomp($configline);
13046: my ($name,$id)=split(/:/,$configline);
13047: $serverhomeIDs{$name}=$id;
13048: }
13049: close($config);
13050: }
13051: }
13052: }
13053: }
13054:
13055:
1.862 albertel 13056: BEGIN {
13057:
13058: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
13059: unless ($readit) {
13060: {
13061: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
13062: %perlvar = (%perlvar,%{$configvars});
13063: }
13064:
13065:
1.1 albertel 13066: # ------------------------------------------------------ Read spare server file
13067: {
1.448 albertel 13068: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 13069:
13070: while (my $configline=<$config>) {
13071: chomp($configline);
1.284 matthew 13072: if ($configline) {
1.784 albertel 13073: my ($host,$type) = split(':',$configline,2);
1.785 albertel 13074: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 13075: push(@{ $spareid{$type} }, $host);
1.1 albertel 13076: }
13077: }
1.448 albertel 13078: close($config);
1.1 albertel 13079: }
1.11 www 13080: # ------------------------------------------------------------ Read permissions
13081: {
1.448 albertel 13082: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 13083:
13084: while (my $configline=<$config>) {
1.448 albertel 13085: chomp($configline);
13086: if ($configline) {
13087: my ($role,$perm)=split(/ /,$configline);
13088: if ($perm ne '') { $pr{$role}=$perm; }
13089: }
1.11 www 13090: }
1.448 albertel 13091: close($config);
1.11 www 13092: }
13093:
13094: # -------------------------------------------- Read plain texts for permissions
13095: {
1.448 albertel 13096: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 13097:
13098: while (my $configline=<$config>) {
1.448 albertel 13099: chomp($configline);
13100: if ($configline) {
1.742 raeburn 13101: my ($short,@plain)=split(/:/,$configline);
13102: %{$prp{$short}} = ();
13103: if (@plain > 0) {
13104: $prp{$short}{'std'} = $plain[0];
13105: for (my $i=1; $i<@plain; $i++) {
13106: $prp{$short}{'alt'.$i} = $plain[$i];
13107: }
13108: }
1.448 albertel 13109: }
1.135 www 13110: }
1.448 albertel 13111: close($config);
1.135 www 13112: }
13113:
13114: # ---------------------------------------------------------- Read package table
13115: {
1.448 albertel 13116: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 13117:
13118: while (my $configline=<$config>) {
1.483 albertel 13119: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 13120: chomp($configline);
13121: my ($short,$plain)=split(/:/,$configline);
13122: my ($pack,$name)=split(/\&/,$short);
13123: if ($plain ne '') {
13124: $packagetab{$pack.'&'.$name.'&name'}=$name;
13125: $packagetab{$short}=$plain;
13126: }
1.11 www 13127: }
1.448 albertel 13128: close($config);
1.329 matthew 13129: }
13130:
1.1172.2.27 raeburn 13131: # --------------------------------------------------------- Read loncaparev table
1.1073 raeburn 13132:
1.1172.2.27 raeburn 13133: &load_loncaparevs();
13134:
13135: # ------------------------------------------------------- Read serverhostID table
13136:
13137: &load_serverhomeIDs();
1.1074 raeburn 13138:
1.1172.2.27 raeburn 13139: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 13140: {
13141: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
13142: if (-e $file) {
13143: my $parser = HTML::LCParser->new($file);
13144: while (my $token = $parser->get_token()) {
13145: if ($token->[0] eq 'S') {
13146: my $item = $token->[1];
13147: my $name = $token->[2]{'name'};
13148: my $value = $token->[2]{'value'};
13149: if ($item ne '' && $name ne '' && $value ne '') {
13150: my $release = $parser->get_text();
13151: $release =~ s/(^\s*|\s*$ )//gx;
13152: $needsrelease{$item.':'.$name.':'.$value} = $release;
13153: }
13154: }
13155: }
13156: }
1.1073 raeburn 13157: }
13158:
1.1138 raeburn 13159: # ---------------------------------------------------------- Read managers table
13160: {
13161: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
13162: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
13163: while (my $configline=<$config>) {
13164: chomp($configline);
13165: next if ($configline =~ /^\#/);
13166: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
13167: $managerstab{$configline} = 1;
13168: }
13169: }
13170: close($config);
13171: }
13172: }
13173: }
13174:
1.329 matthew 13175: # ------------- set up temporary directory
13176: {
1.1117 foxr 13177: $tmpdir = LONCAPA::tempdir();
1.329 matthew 13178:
1.11 www 13179: }
13180:
1.794 albertel 13181: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
13182: 'compress_threshold'=> 20_000,
13183: });
1.185 www 13184:
1.281 www 13185: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 13186: $dumpcount=0;
1.958 www 13187: $locknum=0;
1.22 www 13188:
1.163 harris41 13189: &logtouch();
1.672 albertel 13190: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 13191: $readit=1;
1.564 albertel 13192: {
13193: use integer;
13194: my $test=(2**32)+1;
1.568 albertel 13195: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 13196: &logthis(" Detected 64bit platform ($_64bit)");
13197: }
1.195 www 13198: }
1.1 albertel 13199: }
1.179 www 13200:
1.1 albertel 13201: 1;
1.191 harris41 13202: __END__
13203:
1.243 albertel 13204: =pod
13205:
1.191 harris41 13206: =head1 NAME
13207:
1.243 albertel 13208: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 13209:
13210: =head1 SYNOPSIS
13211:
1.243 albertel 13212: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 13213:
13214: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
13215:
1.243 albertel 13216: Common parameters:
13217:
13218: =over 4
13219:
13220: =item *
13221:
13222: $uname : an internal username (if $cname expecting a course Id specifically)
13223:
13224: =item *
13225:
13226: $udom : a domain (if $cdom expecting a course's domain specifically)
13227:
13228: =item *
13229:
13230: $symb : a resource instance identifier
13231:
13232: =item *
13233:
13234: $namespace : the name of a .db file that contains the data needed or
13235: being set.
13236:
13237: =back
13238:
1.394 bowersj2 13239: =head1 OVERVIEW
1.191 harris41 13240:
1.394 bowersj2 13241: lonnet provides subroutines which interact with the
13242: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
13243: about classes, users, and resources.
1.243 albertel 13244:
13245: For many of these objects you can also use this to store data about
13246: them or modify them in various ways.
1.191 harris41 13247:
1.394 bowersj2 13248: =head2 Symbs
1.191 harris41 13249:
1.394 bowersj2 13250: To identify a specific instance of a resource, LON-CAPA uses symbols
13251: or "symbs"X<symb>. These identifiers are built from the URL of the
13252: map, the resource number of the resource in the map, and the URL of
13253: the resource itself. The latter is somewhat redundant, but might help
13254: if maps change.
13255:
13256: An example is
13257:
13258: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
13259:
13260: The respective map entry is
13261:
13262: <resource id="19" src="/res/msu/korte/tests/part12.problem"
13263: title="Problem 2">
13264: </resource>
13265:
13266: Symbs are used by the random number generator, as well as to store and
13267: restore data specific to a certain instance of for example a problem.
13268:
13269: =head2 Storing And Retrieving Data
13270:
13271: X<store()>X<cstore()>X<restore()>Three of the most important functions
13272: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
13273: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
13274: is is the non-critical message twin of cstore. These functions are for
13275: handlers to store a perl hash to a user's permanent data space in an
13276: easy manner, and to retrieve it again on another call. It is expected
13277: that a handler would use this once at the beginning to retrieve data,
13278: and then again once at the end to send only the new data back.
13279:
13280: The data is stored in the user's data directory on the user's
13281: homeserver under the ID of the course.
13282:
13283: The hash that is returned by restore will have all of the previous
13284: value for all of the elements of the hash.
13285:
13286: Example:
13287:
13288: #creating a hash
13289: my %hash;
13290: $hash{'foo'}='bar';
13291:
13292: #storing it
13293: &Apache::lonnet::cstore(\%hash);
13294:
13295: #changing a value
13296: $hash{'foo'}='notbar';
13297:
13298: #adding a new value
13299: $hash{'bar'}='foo';
13300: &Apache::lonnet::cstore(\%hash);
13301:
13302: #retrieving the hash
13303: my %history=&Apache::lonnet::restore();
13304:
13305: #print the hash
13306: foreach my $key (sort(keys(%history))) {
13307: print("\%history{$key} = $history{$key}");
13308: }
13309:
13310: Will print out:
1.191 harris41 13311:
1.394 bowersj2 13312: %history{1:foo} = bar
13313: %history{1:keys} = foo:timestamp
13314: %history{1:timestamp} = 990455579
13315: %history{2:bar} = foo
13316: %history{2:foo} = notbar
13317: %history{2:keys} = foo:bar:timestamp
13318: %history{2:timestamp} = 990455580
13319: %history{bar} = foo
13320: %history{foo} = notbar
13321: %history{timestamp} = 990455580
13322: %history{version} = 2
13323:
13324: Note that the special hash entries C<keys>, C<version> and
13325: C<timestamp> were added to the hash. C<version> will be equal to the
13326: total number of versions of the data that have been stored. The
13327: C<timestamp> attribute will be the UNIX time the hash was
13328: stored. C<keys> is available in every historical section to list which
13329: keys were added or changed at a specific historical revision of a
13330: hash.
13331:
13332: B<Warning>: do not store the hash that restore returns directly. This
13333: will cause a mess since it will restore the historical keys as if the
13334: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 13335:
1.394 bowersj2 13336: Calling convention:
1.191 harris41 13337:
1.1172.2.27 raeburn 13338: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1172.2.64 raeburn 13339: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 13340:
1.394 bowersj2 13341: For more detailed information, see lonnet specific documentation.
1.191 harris41 13342:
1.394 bowersj2 13343: =head1 RETURN MESSAGES
1.191 harris41 13344:
1.394 bowersj2 13345: =over 4
1.191 harris41 13346:
1.394 bowersj2 13347: =item * B<con_lost>: unable to contact remote host
1.191 harris41 13348:
1.394 bowersj2 13349: =item * B<con_delayed>: unable to contact remote host, message will be delivered
13350: when the connection is brought back up
1.191 harris41 13351:
1.394 bowersj2 13352: =item * B<con_failed>: unable to contact remote host and unable to save message
13353: for later delivery
1.191 harris41 13354:
1.967 bisitz 13355: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 13356:
1.394 bowersj2 13357: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 13358: that was requested
1.191 harris41 13359:
1.243 albertel 13360: =back
1.191 harris41 13361:
1.243 albertel 13362: =head1 PUBLIC SUBROUTINES
1.191 harris41 13363:
1.243 albertel 13364: =head2 Session Environment Functions
1.191 harris41 13365:
1.243 albertel 13366: =over 4
1.191 harris41 13367:
1.394 bowersj2 13368: =item *
13369: X<appenv()>
1.949 raeburn 13370: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 13371: the user envirnoment file, and will be restored for each access this
1.620 albertel 13372: user makes during this session, also modifies the %env for the current
1.949 raeburn 13373: process. Optional rolesarrayref - if defined contains a reference to an array
13374: of roles which are exempt from the restriction on modifying user.role entries
13375: in the user's environment.db and in %env.
1.191 harris41 13376:
13377: =item *
1.394 bowersj2 13378: X<delenv()>
1.987 raeburn 13379: B<delenv($delthis,$regexp)>: removes all items from the session
13380: environment file that begin with $delthis. If the
13381: optional second arg - $regexp - is true, $delthis is treated as a
13382: regular expression, otherwise \Q$delthis\E is used.
13383: The values are also deleted from the current processes %env.
1.191 harris41 13384:
1.795 albertel 13385: =item * get_env_multiple($name)
13386:
13387: gets $name from the %env hash, it seemlessly handles the cases where multiple
13388: values may be defined and end up as an array ref.
13389:
13390: returns an array of values
13391:
1.243 albertel 13392: =back
13393:
13394: =head2 User Information
1.191 harris41 13395:
1.243 albertel 13396: =over 4
1.191 harris41 13397:
13398: =item *
1.394 bowersj2 13399: X<queryauthenticate()>
13400: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 13401: authentication scheme
13402:
13403: =item *
1.394 bowersj2 13404: X<authenticate()>
1.1073 raeburn 13405: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 13406: authenticate user from domain's lib servers (first use the current
13407: one). C<$upass> should be the users password.
1.1073 raeburn 13408: $checkdefauth is optional (value is 1 if a check should be made to
13409: authenticate user using default authentication method, and allow
13410: account creation if username does not have account in the domain).
13411: $clientcancheckhost is optional (value is 1 if checking whether the
13412: server can host will occur on the client side in lonauth.pm).
1.191 harris41 13413:
13414: =item *
1.394 bowersj2 13415: X<homeserver()>
13416: B<homeserver($uname,$udom)>: find the server which has
13417: the user's directory and files (there must be only one), this caches
13418: the answer, and also caches if there is a borken connection.
1.191 harris41 13419:
13420: =item *
1.394 bowersj2 13421: X<idget()>
13422: B<idget($udom,@ids)>: find the usernames behind a list of IDs
13423: (IDs are a unique resource in a domain, there must be only 1 ID per
13424: username, and only 1 username per ID in a specific domain) (returns
13425: hash: id=>name,id=>name)
1.191 harris41 13426:
13427: =item *
1.394 bowersj2 13428: X<idrget()>
13429: B<idrget($udom,@unames)>: find the IDs behind a list of
13430: usernames (returns hash: name=>id,name=>id)
1.191 harris41 13431:
13432: =item *
1.394 bowersj2 13433: X<idput()>
13434: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 13435:
13436: =item *
1.394 bowersj2 13437: X<rolesinit()>
1.1169 droeschl 13438: B<rolesinit($udom,$username)>: get user privileges.
13439: returns user role, first access and timer interval hashes
1.243 albertel 13440:
13441: =item *
1.1171 droeschl 13442: X<privileged()>
13443: B<privileged($username,$domain)>: returns a true if user has a
13444: privileged and active role (i.e. su or dc), false otherwise.
13445:
13446: =item *
1.551 albertel 13447: X<getsection()>
13448: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 13449: course $cname, return section name/number or '' for "not in course"
13450: and '-1' for "no section"
13451:
13452: =item *
1.394 bowersj2 13453: X<userenvironment()>
13454: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 13455: passed in @what from the requested user's environment, returns a hash
13456:
1.858 raeburn 13457: =item *
13458: X<userlog_query()>
1.859 albertel 13459: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
13460: activity.log file. %filters defines filters applied when parsing the
13461: log file. These can be start or end timestamps, or the type of action
13462: - log to look for Login or Logout events, check for Checkin or
13463: Checkout, role for role selection. The response is in the form
13464: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
13465: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 13466:
1.243 albertel 13467: =back
13468:
13469: =head2 User Roles
13470:
13471: =over 4
13472:
13473: =item *
13474:
1.1172.2.65 raeburn 13475: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
13476: returns codes for allowed actions.
13477:
13478: The first argument is required, all others are optional.
13479:
13480: $priv is the privilege being checked.
13481: $uri contains additional information about what is being checked for access (e.g.,
13482: URL, course ID etc.).
13483: $symb is the unique resource instance identifier in a course; if needed,
13484: but not provided, it will be retrieved via a call to &symbread().
13485: $role is the role for which a priv is being checked (only used if priv is evb).
13486: $clientip is the user's IP address (only used when checking for access to portfolio
13487: files).
13488: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
13489: prevents recursive calls to &allowed.
13490:
1.243 albertel 13491: F: full access
13492: U,I,K: authentication modes (cxx only)
13493: '': forbidden
13494: 1: user needs to choose course
13495: 2: browse allowed
1.766 albertel 13496: A: passphrase authentication needed
1.1172.2.65 raeburn 13497: B: access temporarily blocked because of a blocking event in a course.
1.243 albertel 13498:
13499: =item *
13500:
1.1172.2.13 raeburn 13501: constructaccess($url,$setpriv) : check for access to construction space URL
13502:
13503: See if the owner domain and name in the URL match those in the
13504: expected environment. If so, return three element list
13505: ($ownername,$ownerdomain,$ownerhome).
13506:
13507: Otherwise return the null string.
13508:
13509: If second argument 'setpriv' is true, it assigns the privileges,
13510: and returns the same three element list, unless the owner has
13511: blocked "ad hoc" Domain Coordinator access to the Author Space,
13512: in which case the null string is returned.
13513:
13514: =item *
13515:
1.1172.2.84 raeburn 13516: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
13517: define a custom role rolename set privileges in format of lonTabs/roles.tab
13518: for system, domain, and course level. $uname and $udom are optional (current
13519: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 13520:
13521: =item *
13522:
1.988 raeburn 13523: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
13524: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 13525: $type is Course (default) or Community.
1.988 raeburn 13526: If $forcedefault evaluates to true, text returned will be default
13527: text for $type. Otherwise, if this is a course, the text returned
13528: will be a custom name for the role (if defined in the course's
13529: environment). If no custom name is defined the default is returned.
13530:
1.832 raeburn 13531: =item *
13532:
1.1172.2.23 raeburn 13533: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 13534: All arguments are optional. Returns a hash of a roles, either for
13535: co-author/assistant author roles for a user's Construction Space
1.906 albertel 13536: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 13537: In the hash, keys are set to colon-separated $uname,$udom,$role, and
13538: (optionally) if $withsec is true, a fourth colon-separated item - $section.
13539: For each key, value is set to colon-separated start and end times for
13540: the role. If no username and domain are specified, will default to
1.934 raeburn 13541: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 13542: of role statuses (active, future or previous), roles
13543: (e.g., cc,in, st etc.) and domains of the roles which can be used
13544: to restrict the list of roles reported. If no array ref is
13545: provided for types, will default to return only active roles.
1.834 albertel 13546:
1.1172.2.13 raeburn 13547: =item *
13548:
13549: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
13550: user: $uname:$udom has a role in the course: $cdom_$cnum.
13551:
13552: Additional optional arguments are: $type (if role checking is to be restricted
13553: to certain user status types -- previous (expired roles), active (currently
13554: available roles) or future (roles available in the future), and
13555: $hideprivileged -- if true will not report course roles for users who
1.1172.2.23 raeburn 13556: have active Domain Coordinator role in course's domain or in additional
13557: domains (specified in 'Domains to check for privileged users' in course
13558: environment -- set via: Course Settings -> Classlists and staff listing).
13559:
13560: =item *
13561:
13562: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
13563: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
13564: $possdomains and $possroles are optional array refs -- to domains to check and
13565: roles to check. If $possdomains is not specified, a dump will be done of the
13566: users' roles.db to check for a dc or su role in any domain. This can be
13567: time consuming if &privileged is called repeatedly (e.g., when displaying a
13568: classlist), so in such cases, supplying a $possdomains array is preferred, as
13569: this then allows &privileged_by_domain() to be used, which caches the identity
13570: of privileged users, eliminating the need for repeated calls to &dump().
13571:
13572: =item *
13573:
13574: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
13575: where the outer hash keys are domains specified in the $possdomains array ref,
13576: next inner hash keys are privileged roles specified in the $roles array ref,
13577: and the innermost hash contains key = value pairs for username:domain = end:start
13578: for active or future "privileged" users with that role in that domain. To avoid
13579: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
13580: innerhash are cached using priv_$role and $dom as the identifiers.
1.1172.2.13 raeburn 13581:
1.243 albertel 13582: =back
13583:
13584: =head2 User Modification
13585:
13586: =over 4
13587:
13588: =item *
13589:
1.957 raeburn 13590: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 13591: user for the level given by URL. Optional start and end dates (leave empty
13592: string or zero for "no date")
1.191 harris41 13593:
13594: =item *
13595:
1.243 albertel 13596: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
13597: change a users, password, possible return values are: ok,
13598: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
13599: refused
1.191 harris41 13600:
13601: =item *
13602:
1.243 albertel 13603: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 13604:
13605: =item *
13606:
1.1058 raeburn 13607: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
13608: $forceid,$desiredhome,$email,$inststatus,$candelete) :
13609:
13610: will update user information (firstname,middlename,lastname,generation,
13611: permanentemail), and if forceid is true, student/employee ID also.
13612: A user's institutional affiliation(s) can also be updated.
13613: User information fields will not be overwritten with empty entries
13614: unless the field is included in the $candelete array reference.
13615: This array is included when a single user is modified via "Manage Users",
13616: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 13617:
13618: =item *
13619:
1.286 matthew 13620: modifystudent
13621:
1.957 raeburn 13622: modify a student's enrollment and identification information.
1.1172.2.31 raeburn 13623: The course id is resolved based on the current user's environment.
13624: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 13625: associated with a course.
13626:
1.297 matthew 13627: This call is essentially a wrapper for lonnet::modifyuser and
13628: lonnet::modify_student_enrollment
1.286 matthew 13629:
13630: Inputs:
13631:
13632: =over 4
13633:
1.957 raeburn 13634: =item B<$udom> Student's loncapa domain
1.286 matthew 13635:
1.957 raeburn 13636: =item B<$uname> Student's loncapa login name
1.286 matthew 13637:
1.964 bisitz 13638: =item B<$uid> Student/Employee ID
1.286 matthew 13639:
1.957 raeburn 13640: =item B<$umode> Student's authentication mode
1.286 matthew 13641:
1.957 raeburn 13642: =item B<$upass> Student's password
1.286 matthew 13643:
1.957 raeburn 13644: =item B<$first> Student's first name
1.286 matthew 13645:
1.957 raeburn 13646: =item B<$middle> Student's middle name
1.286 matthew 13647:
1.957 raeburn 13648: =item B<$last> Student's last name
1.286 matthew 13649:
1.957 raeburn 13650: =item B<$gene> Student's generation
1.286 matthew 13651:
1.957 raeburn 13652: =item B<$usec> Student's section in course
1.286 matthew 13653:
13654: =item B<$end> Unix time of the roles expiration
13655:
13656: =item B<$start> Unix time of the roles start date
13657:
13658: =item B<$forceid> If defined, allow $uid to be changed
13659:
13660: =item B<$desiredhome> server to use as home server for student
13661:
1.957 raeburn 13662: =item B<$email> Student's permanent e-mail address
13663:
13664: =item B<$type> Type of enrollment (auto or manual)
13665:
1.963 raeburn 13666: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
13667:
13668: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 13669:
1.963 raeburn 13670: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 13671:
1.963 raeburn 13672: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 13673:
1.1172.2.19 raeburn 13674: =item B<$inststatus> institutional status of user - : separated string of escaped status types
13675:
13676: =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 13677:
1.286 matthew 13678: =back
1.297 matthew 13679:
13680: =item *
13681:
13682: modify_student_enrollment
13683:
1.1172.2.31 raeburn 13684: Change a student's enrollment status in a class. The environment variable
1.297 matthew 13685: 'role.request.course' must be defined for this function to proceed.
13686:
13687: Inputs:
13688:
13689: =over 4
13690:
1.1172.2.31 raeburn 13691: =item $udom, student's domain
1.297 matthew 13692:
1.1172.2.31 raeburn 13693: =item $uname, student's name
1.297 matthew 13694:
1.1172.2.31 raeburn 13695: =item $uid, student's user id
1.297 matthew 13696:
1.1172.2.31 raeburn 13697: =item $first, student's first name
1.297 matthew 13698:
13699: =item $middle
13700:
13701: =item $last
13702:
13703: =item $gene
13704:
13705: =item $usec
13706:
13707: =item $end
13708:
13709: =item $start
13710:
1.957 raeburn 13711: =item $type
13712:
13713: =item $locktype
13714:
13715: =item $cid
13716:
13717: =item $selfenroll
13718:
13719: =item $context
13720:
1.1172.2.19 raeburn 13721: =item $credits, number of credits student will earn from this class
13722:
1.1172.2.76 raeburn 13723: =item $instsec, institutional course section code for student
13724:
1.297 matthew 13725: =back
13726:
1.191 harris41 13727:
13728: =item *
13729:
1.243 albertel 13730: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
13731: custom role; give a custom role to a user for the level given by URL. Specify
13732: name and domain of role author, and role name
1.191 harris41 13733:
13734: =item *
13735:
1.243 albertel 13736: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 13737:
13738: =item *
13739:
1.243 albertel 13740: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
13741:
13742: =back
13743:
13744: =head2 Course Infomation
13745:
13746: =over 4
1.191 harris41 13747:
13748: =item *
13749:
1.1118 foxr 13750: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 13751: specified course id, including all environment settings for the
13752: course, the description of the course will be in the hash under the
13753: key 'description'
1.191 harris41 13754:
1.1118 foxr 13755: $options is an optional parameter that if supplied is a hash reference that controls
13756: what how this function works. It has the following key/values:
13757:
13758: =over 4
13759:
13760: =item freshen_cache
13761:
13762: If defined, and the environment cache for the course is valid, it is
13763: returned in the returned hash.
13764:
13765: =item one_time
13766:
13767: If defined, the last cache time is set to _now_
13768:
13769: =item user
13770:
13771: If defined, the supplied username is used instead of the current user.
13772:
13773:
13774: =back
13775:
1.191 harris41 13776: =item *
13777:
1.624 albertel 13778: resdata($name,$domain,$type,@which) : request for current parameter
13779: setting for a specific $type, where $type is either 'course' or 'user',
13780: @what should be a list of parameters to ask about. This routine caches
1.1172.2.31 raeburn 13781: answers for 10 minutes.
1.243 albertel 13782:
1.877 foxr 13783: =item *
13784:
13785: get_courseresdata($courseid, $domain) : dump the entire course resource
13786: data base, returning a hash that is keyed by the resource name and has
13787: values that are the resource value. I believe that the timestamps and
13788: versions are also returned.
13789:
1.1172.2.31 raeburn 13790: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
13791: supplemental content area. This routine caches the number of files for
13792: 10 minutes.
13793:
1.243 albertel 13794: =back
13795:
13796: =head2 Course Modification
13797:
13798: =over 4
1.191 harris41 13799:
13800: =item *
13801:
1.243 albertel 13802: writecoursepref($courseid,%prefs) : write preferences (environment
13803: database) for a course
1.191 harris41 13804:
13805: =item *
13806:
1.1011 raeburn 13807: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
13808:
13809: =item *
13810:
1.1038 raeburn 13811: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 13812:
1.1167 droeschl 13813: =item *
13814:
13815: is_course($courseid), is_course($cdom, $cnum)
13816:
13817: Accepts either a combined $courseid (in the form of domain_courseid) or the
13818: two component version $cdom, $cnum. It checks if the specified course exists.
13819:
13820: Returns:
13821: undef if the course doesn't exist, otherwise
13822: in scalar context the combined courseid.
13823: in list context the two components of the course identifier, domain and
13824: courseid.
13825:
1.243 albertel 13826: =back
13827:
13828: =head2 Resource Subroutines
13829:
13830: =over 4
1.191 harris41 13831:
13832: =item *
13833:
1.243 albertel 13834: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 13835:
13836: =item *
13837:
1.243 albertel 13838: repcopy($filename) : subscribes to the requested file, and attempts to
13839: replicate from the owning library server, Might return
1.607 raeburn 13840: 'unavailable', 'not_found', 'forbidden', 'ok', or
13841: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 13842: resource. Expects the local filesystem pathname
13843: (/home/httpd/html/res/....)
13844:
13845: =back
13846:
13847: =head2 Resource Information
13848:
13849: =over 4
1.191 harris41 13850:
13851: =item *
13852:
1.1172.2.28 raeburn 13853: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
13854: and returns the value of a variety of different possible values,
13855: $varname should be a request string, and the other parameters can be
13856: used to specify who and what one is asking about. Ordinarily, $cid
13857: does not need to be specified, as it is retrived from
13858: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
13859: within lonuserstate::loadmap() when initializing a course, before
13860: $env{'request.course.id'} has been set, so it needs to be provided
13861: in that one case.
1.243 albertel 13862:
13863: Possible values for $varname are environment.lastname (or other item
13864: from the envirnment hash), user.name (or someother aspect about the
13865: user), resource.0.maxtries (or some other part and parameter of a
13866: resource)
1.204 albertel 13867:
13868: =item *
13869:
1.243 albertel 13870: directcondval($number) : get current value of a condition; reads from a state
13871: string
1.204 albertel 13872:
13873: =item *
13874:
1.243 albertel 13875: condval($condidx) : value of condition index based on state
1.204 albertel 13876:
13877: =item *
13878:
1.243 albertel 13879: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
13880: resource's metadata, $what should be either a specific key, or either
13881: 'keys' (to get a list of possible keys) or 'packages' to get a list of
13882: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
13883:
13884: this function automatically caches all requests
1.191 harris41 13885:
13886: =item *
13887:
1.243 albertel 13888: metadata_query($query,$custom,$customshow) : make a metadata query against the
13889: network of library servers; returns file handle of where SQL and regex results
13890: will be stored for query
1.191 harris41 13891:
13892: =item *
13893:
1.1172.2.66 raeburn 13894: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
13895: return symbolic list entry (all arguments optional).
13896:
13897: Args: filename is the filename (including path) for the file for which a symb
13898: is required; donotrecurse, if true will prevent calls to allowed() being made
13899: to check access status if more than one resource was found in the bighash
13900: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
13901: a randompick); ignorecachednull, if true will prevent a symb of '' being
13902: returned if $env{$cache_str} is defined as ''; checkforblock if true will
13903: cause possible symbs to be checked to determine if they are subject to content
13904: blocking, if so they will not be included as possible symbs; possibles is a
13905: ref to a hash, which, as a side effect, will be populated with all possible
13906: symbs (content blocking not tested).
13907:
1.243 albertel 13908: returns the data handle
1.191 harris41 13909:
13910: =item *
13911:
1.1172.2.17 raeburn 13912: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
1.1172.2.11 raeburn 13913: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 13914: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1172.2.11 raeburn 13915: on failure, user must be in a course, as it assumes the existence of
13916: the course initial hash, and uses $env('request.course.id'}. The third
13917: arg is an optional reference to a scalar. If this arg is passed in the
13918: call to symbverify, it will be set to 1 if the symb has been set to be
13919: encrypted; otherwise it will be null.
1.243 albertel 13920:
1.191 harris41 13921: =item *
13922:
1.243 albertel 13923: symbclean($symb) : removes versions numbers from a symb, returns the
13924: cleaned symb
1.191 harris41 13925:
13926: =item *
13927:
1.243 albertel 13928: is_on_map($uri) : checks if the $uri is somewhere on the current
13929: course map, user must be in a course for it to work.
1.191 harris41 13930:
13931: =item *
13932:
1.243 albertel 13933: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 13934:
13935: =item *
13936:
1.243 albertel 13937: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13938: a random seed, all arguments are optional, if they aren't sent it uses the
13939: environment to derive them. Note: if symb isn't sent and it can't get one
13940: from &symbread it will use the current time as its return value
1.191 harris41 13941:
13942: =item *
13943:
1.243 albertel 13944: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13945: unfakeable, receipt
1.191 harris41 13946:
13947: =item *
13948:
1.620 albertel 13949: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 13950:
13951: =item *
13952:
1.243 albertel 13953: countacc($url) : count the number of accesses to a given URL
1.191 harris41 13954:
13955: =item *
13956:
1.243 albertel 13957: 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 13958:
13959: =item *
13960:
1.243 albertel 13961: 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 13962:
13963: =item *
13964:
1.243 albertel 13965: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 13966:
13967: =item *
13968:
1.243 albertel 13969: devalidate($symb) : devalidate temporary spreadsheet calculations,
13970: forcing spreadsheet to reevaluate the resource scores next time.
13971:
1.1172.2.13 raeburn 13972: =item *
13973:
13974: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
13975: when viewing in course context.
13976:
13977: input: six args -- filename (decluttered), course number, course domain,
13978: url, symb (if registered) and group (if this is a
13979: group item -- e.g., bulletin board, group page etc.).
13980:
13981: output: array of five scalars --
13982: $cfile -- url for file editing if editable on current server
13983: $home -- homeserver of resource (i.e., for author if published,
13984: or course if uploaded.).
13985: $switchserver -- 1 if server switch will be needed.
13986: $forceedit -- 1 if icon/link should be to go to edit mode
13987: $forceview -- 1 if icon/link should be to go to view mode
13988:
13989: =item *
13990:
13991: is_course_upload($file,$cnum,$cdom)
13992:
13993: Used in course context to determine if current file was uploaded to
13994: the course (i.e., would be found in /userfiles/docs on the course's
13995: homeserver.
13996:
13997: input: 3 args -- filename (decluttered), course number and course domain.
13998: output: boolean -- 1 if file was uploaded.
13999:
1.243 albertel 14000: =back
14001:
14002: =head2 Storing/Retreiving Data
14003:
14004: =over 4
1.191 harris41 14005:
14006: =item *
14007:
1.1172.2.64 raeburn 14008: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
14009: permanently for this url; hashref needs to be given and should be a \%hashname;
14010: the remaining args aren't required and if they aren't passed or are '' they will
14011: be derived from the env (with the exception of $laststore, which is an
14012: optional arg used when a user's submission is stored in grading).
14013: $laststore is $version=$timestamp, where $version is the most recent version
14014: number retrieved for the corresponding $symb in the $namespace db file, and
14015: $timestamp is the timestamp for that transaction (UNIX time).
14016: $laststore is currently only passed when cstore() is called by
14017: structuretags::finalize_storage().
1.191 harris41 14018:
14019: =item *
14020:
1.1172.2.64 raeburn 14021: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
14022: but uses critical subroutine
1.191 harris41 14023:
14024: =item *
14025:
1.243 albertel 14026: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
14027: all args are optional
1.191 harris41 14028:
14029: =item *
14030:
1.717 albertel 14031: dumpstore($namespace,$udom,$uname,$regexp,$range) :
14032: dumps the complete (or key matching regexp) namespace into a hash
14033: ($udom, $uname, $regexp, $range are optional) for a namespace that is
14034: normally &store()ed into
14035:
14036: $range should be either an integer '100' (give me the first 100
14037: matching records)
14038: or be two integers sperated by a - with no spaces
14039: '30-50' (give me the 30th through the 50th matching
14040: records)
14041:
14042:
14043: =item *
14044:
1.1172.2.59 raeburn 14045: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 14046: replaces a &store() version of data with a replacement set of data
14047: for a particular resource in a namespace passed in the $storehash hash
1.1172.2.59 raeburn 14048: reference. If $tolog is true, the transaction is logged in the courselog
14049: with an action=PUTSTORE.
1.717 albertel 14050:
14051: =item *
14052:
1.243 albertel 14053: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
14054: works very similar to store/cstore, but all data is stored in a
14055: temporary location and can be reset using tmpreset, $storehash should
14056: be a hash reference, returns nothing on success
1.191 harris41 14057:
14058: =item *
14059:
1.243 albertel 14060: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
14061: similar to restore, but all data is stored in a temporary location and
14062: can be reset using tmpreset. Returns a hash of values on success,
14063: error string otherwise.
1.191 harris41 14064:
14065: =item *
14066:
1.243 albertel 14067: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
14068: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 14069:
14070: =item *
14071:
1.243 albertel 14072: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14073: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 14074:
14075: =item *
14076:
1.243 albertel 14077: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
14078: namesp ($udom and $uname are optional)
1.191 harris41 14079:
14080: =item *
14081:
1.702 albertel 14082: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 14083: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 14084: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 14085:
1.702 albertel 14086: $range should be either an integer '100' (give me the first 100
14087: matching records)
14088: or be two integers sperated by a - with no spaces
14089: '30-50' (give me the 30th through the 50th matching
14090: records)
1.449 matthew 14091: =item *
14092:
14093: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
14094: $store can be a scalar, an array reference, or if the amount to be
14095: incremented is > 1, a hash reference.
14096:
14097: ($udom and $uname are optional)
1.191 harris41 14098:
14099: =item *
14100:
1.243 albertel 14101: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
14102: ($udom and $uname are optional)
1.191 harris41 14103:
14104: =item *
14105:
1.243 albertel 14106: cput($namespace,$storehash,$udom,$uname) : critical put
14107: ($udom and $uname are optional)
1.191 harris41 14108:
14109: =item *
14110:
1.748 albertel 14111: newput($namespace,$storehash,$udom,$uname) :
14112:
14113: Attempts to store the items in the $storehash, but only if they don't
14114: currently exist, if this succeeds you can be certain that you have
14115: successfully created a new key value pair in the $namespace db.
14116:
14117:
14118: Args:
14119: $namespace: name of database to store values to
14120: $storehash: hashref to store to the db
14121: $udom: (optional) domain of user containing the db
14122: $uname: (optional) name of user caontaining the db
14123:
14124: Returns:
14125: 'ok' -> succeeded in storing all keys of $storehash
14126: 'key_exists: <key>' -> failed to anything out of $storehash, as at
14127: least <key> already existed in the db (other
14128: requested keys may also already exist)
1.967 bisitz 14129: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 14130: 'con_lost' -> unable to contact request server
14131: 'refused' -> action was not allowed by remote machine
14132:
14133:
14134: =item *
14135:
1.243 albertel 14136: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14137: reference filled in from namesp (encrypts the return communication)
14138: ($udom and $uname are optional)
1.191 harris41 14139:
14140: =item *
14141:
1.243 albertel 14142: log($udom,$name,$home,$message) : write to permanent log for user; use
14143: critical subroutine
14144:
1.806 raeburn 14145: =item *
14146:
1.860 raeburn 14147: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
14148: array reference filled in from namespace found in domain level on either
14149: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 14150:
14151: =item *
14152:
1.860 raeburn 14153: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
14154: domain level either on specified domain server ($uhome) or primary domain
14155: server ($udom and $uhome are optional)
1.806 raeburn 14156:
1.943 raeburn 14157: =item *
14158:
1.1172.2.35 raeburn 14159: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
14160: for: authentication, language, quotas, timezone, date locale, and portal URL in
14161: the target domain.
14162:
14163: May also include additional key => value pairs for the following groups:
14164:
14165: =over
14166:
14167: =item
14168: disk quotas (MB allocated by default to portfolios and authoring spaces).
14169:
14170: =over
14171:
14172: =item defaultquota, authorquota
14173:
14174: =back
14175:
14176: =item
14177: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
14178: portfolio for users).
14179:
14180: =over
14181:
14182: =item
14183: aboutme, blog, webdav, portfolio
14184:
14185: =back
14186:
14187: =item
14188: requestcourses: ability to request courses, and how requests are processed.
14189:
14190: =over
14191:
14192: =item
1.1172.2.37 raeburn 14193: official, unofficial, community, textbook
1.1172.2.35 raeburn 14194:
14195: =back
14196:
14197: =item
14198: inststatus: types of institutional affiliation, and order in which they are displayed.
14199:
14200: =over
14201:
14202: =item
1.1172.2.44 raeburn 14203: inststatustypes, inststatusorder, inststatusguest
1.1172.2.35 raeburn 14204:
14205: =back
14206:
14207: =item
14208: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
14209: for course's uploaded content.
14210:
14211: =over
14212:
14213: =item
1.1172.2.68 raeburn 14214: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
14215: communityquota, textbookquota
1.1172.2.35 raeburn 14216:
14217: =back
14218:
14219: =item
14220: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
14221: on your servers.
14222:
14223: =over
14224:
14225: =item
14226: remotesessions, hostedsessions
14227:
14228: =back
14229:
14230: =back
14231:
14232: In cases where a domain coordinator has never used the "Set Domain Configuration"
14233: utility to create a configuration.db file on a domain's primary library server
14234: only the following domain defaults: auth_def, auth_arg_def, lang_def
14235: -- corresponding values are authentication type (internal, krb4, krb5,
14236: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
14237: will be available. Values are retrieved from cache (if current), unless the
14238: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
14239: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
14240:
14241: Typical usage:
1.943 raeburn 14242:
1.1172.2.35 raeburn 14243: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 14244:
1.243 albertel 14245: =back
14246:
14247: =head2 Network Status Functions
14248:
14249: =over 4
1.191 harris41 14250:
14251: =item *
14252:
1.1137 raeburn 14253: dirlist() : return directory list based on URI (first arg).
14254:
14255: Inputs: 1 required, 5 optional.
14256:
14257: =over
14258:
14259: =item
14260: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
14261:
14262: =item
14263: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
14264:
14265: =item
14266: $username - username of user/course to be listed. Extracted from $uri if absent.
14267:
14268: =item
14269: $getpropath - boolean: 1 if prepend path using &propath().
14270:
14271: =item
14272: $getuserdir - boolean: 1 if prepend path for "userfiles".
14273:
14274: =item
14275: $alternateRoot - path to prepend in place of path from $uri.
14276:
14277: =back
14278:
14279: Returns: Array of up to two items.
14280:
14281: =over
14282:
14283: a reference to an array of files/subdirectories
14284:
14285: =over
14286:
14287: Each element in the array of files/subdirectories is a & separated list of
14288: item name and the result of running stat on the item. If dirlist was requested
14289: for a file instead of a directory, the item name will be ''. For a directory
14290: listing, if the item is a metadata file, the element will end &N&M
14291: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
14292: default copyright set (1).
14293:
14294: =back
14295:
14296: a scalar containing error condition (if encountered).
14297:
14298: =over
14299:
14300: =item
14301: no_host (no homeserver identified for $username:$domain).
14302:
14303: =item
14304: no_such_host (server contacted for listing not identified as valid host).
14305:
14306: =item
14307: con_lost (connection to remote server failed).
14308:
14309: =item
14310: refused (invalid $username:$domain received on lond side).
14311:
14312: =item
14313: no_such_dir (directory at specified path on lond side does not exist).
14314:
14315: =item
14316: empty (directory at specified path on lond side is empty).
14317:
14318: =over
14319:
14320: This is currently not encountered because the &ls3, &ls2,
14321: &ls (_handler) routines on the lond side do not filter out
14322: . and .. from a directory listing.
14323:
14324: =back
14325:
14326: =back
14327:
14328: =back
1.191 harris41 14329:
14330: =item *
14331:
1.243 albertel 14332: spareserver() : find server with least workload from spare.tab
14333:
1.986 foxr 14334:
14335: =item *
14336:
14337: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
14338: if there is no corresponding loncapa host.
14339:
1.243 albertel 14340: =back
14341:
1.986 foxr 14342:
1.243 albertel 14343: =head2 Apache Request
14344:
14345: =over 4
1.191 harris41 14346:
14347: =item *
14348:
1.243 albertel 14349: ssi($url,%hash) : server side include, does a complete request cycle on url to
14350: localhost, posts hash
14351:
14352: =back
14353:
14354: =head2 Data to String to Data
14355:
14356: =over 4
1.191 harris41 14357:
14358: =item *
14359:
1.243 albertel 14360: hash2str(%hash) : convert a hash into a string complete with escaping and '='
14361: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 14362:
14363: =item *
14364:
1.243 albertel 14365: hashref2str($hashref) : convert a hashref into a string complete with
14366: escaping and '=' and '&' separators, supports elements that are
14367: arrayrefs and hashrefs
1.191 harris41 14368:
14369: =item *
14370:
1.243 albertel 14371: arrayref2str($arrayref) : convert an arrayref into a string complete
14372: with escaping and '&' separators, supports elements that are arrayrefs
14373: and hashrefs
1.191 harris41 14374:
14375: =item *
14376:
1.243 albertel 14377: str2hash($string) : convert string to hash using unescaping and
14378: splitting on '=' and '&', supports elements that are arrayrefs and
14379: hashrefs
1.191 harris41 14380:
14381: =item *
14382:
1.243 albertel 14383: str2array($string) : convert string to hash using unescaping and
14384: splitting on '&', supports elements that are arrayrefs and hashrefs
14385:
14386: =back
14387:
14388: =head2 Logging Routines
14389:
14390:
14391: These routines allow one to make log messages in the lonnet.log and
14392: lonnet.perm logfiles.
1.191 harris41 14393:
1.1119 foxr 14394: =over 4
14395:
1.191 harris41 14396: =item *
14397:
1.243 albertel 14398: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 14399:
14400: =item *
14401:
1.243 albertel 14402: logthis() : append message to the normal lonnet.log file, it gets
14403: preiodically rolled over and deleted.
1.191 harris41 14404:
14405: =item *
14406:
1.243 albertel 14407: logperm() : append a permanent message to lonnet.perm.log, this log
14408: file never gets deleted by any automated portion of the system, only
14409: messages of critical importance should go in here.
14410:
1.1119 foxr 14411:
1.243 albertel 14412: =back
14413:
14414: =head2 General File Helper Routines
14415:
14416: =over 4
1.191 harris41 14417:
14418: =item *
14419:
1.481 raeburn 14420: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
14421: (a) files in /uploaded
14422: (i) If a local copy of the file exists -
14423: compares modification date of local copy with last-modified date for
14424: definitive version stored on home server for course. If local copy is
14425: stale, requests a new version from the home server and stores it.
14426: If the original has been removed from the home server, then local copy
14427: is unlinked.
14428: (ii) If local copy does not exist -
14429: requests the file from the home server and stores it.
14430:
14431: If $caller is 'uploadrep':
14432: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
14433: for request for files originally uploaded via DOCS.
14434: - returns 'ok' if fresh local copy now available, -1 otherwise.
14435:
14436: Otherwise:
14437: This indicates a call from the content generation phase of the request.
14438: - returns the entire contents of the file or -1.
14439:
14440: (b) files in /res
14441: - returns the entire contents of a file or -1;
14442: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 14443:
1.712 albertel 14444:
14445: =item *
14446:
14447: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
14448: reference
14449:
14450: returns either a stat() list of data about the file or an empty list
14451: if the file doesn't exist or couldn't find out about it (connection
14452: problems or user unknown)
14453:
1.191 harris41 14454: =item *
14455:
1.243 albertel 14456: filelocation($dir,$file) : returns file system location of a file
14457: based on URI; meant to be "fairly clean" absolute reference, $dir is a
14458: directory that relative $file lookups are to looked in ($dir of /a/dir
14459: and a file of ../bob will become /a/bob)
1.191 harris41 14460:
14461: =item *
14462:
14463: hreflocation($dir,$file) : returns file system location or a URL; same as
14464: filelocation except for hrefs
14465:
14466: =item *
14467:
1.1172.2.49 raeburn 14468: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
14469: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 14470:
1.243 albertel 14471: =back
14472:
1.608 albertel 14473: =head2 Usererfile file routines (/uploaded*)
14474:
14475: =over 4
14476:
14477: =item *
14478:
14479: userfileupload(): main rotine for putting a file in a user or course's
14480: filespace, arguments are,
14481:
1.620 albertel 14482: formname - required - this is the name of the element in $env where the
1.608 albertel 14483: filename, and the contents of the file to create/modifed exist
1.620 albertel 14484: the filename is in $env{'form.'.$formname.'.filename'} and the
14485: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 14486: context - if coursedoc, store the file in the course of the active role
14487: of the current user;
14488: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
14489: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 14490: subdir - required - subdirectory to put the file in under ../userfiles/
14491: if undefined, it will be placed in "unknown"
14492:
14493: (This routine calls clean_filename() to remove any dangerous
14494: characters from the filename, and then calls finuserfileupload() to
14495: complete the transaction)
14496:
14497: returns either the url of the uploaded file (/uploaded/....) if successful
14498: and /adm/notfound.html if unsuccessful
14499:
14500: =item *
14501:
14502: clean_filename(): routine for cleaing a filename up for storage in
14503: userfile space, argument is:
14504:
14505: filename - proposed filename
14506:
14507: returns: the new clean filename
14508:
14509: =item *
14510:
1.1090 raeburn 14511: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 14512: userspace, probably shouldn't be called directly
14513:
14514: docuname: username or courseid of destination for the file
14515: docudom: domain of user/course of destination for the file
14516: formname: same as for userfileupload()
1.1090 raeburn 14517: fname: filename (including subdirectories) for the file
14518: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
14519: allfiles: reference to hash used to store objects found by parser
14520: codebase: reference to hash used for codebases of java objects found by parser
14521: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
14522: thumbheight: height (pixels) of thumbnail to be created for uploaded image
14523: resizewidth: width to be used to resize image using resizeImage from ImageMagick
14524: resizeheight: height to be used to resize image using resizeImage from ImageMagick
14525: context: if 'overwrite', will move the uploaded file from its temporary location to
14526: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 14527: mimetype: reference to scalar to accommodate mime type determined
14528: from File::MMagic if $parser = parse.
1.608 albertel 14529:
14530: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 14531: and /adm/notfound.html if unsuccessful (or an error message if context
14532: was 'overwrite').
14533:
1.608 albertel 14534:
14535: =item *
14536:
14537: renameuserfile(): renames an existing userfile to a new name
14538:
14539: Args:
14540: docuname: username or courseid of destination for the file
14541: docudom: domain of user/course of destination for the file
14542: old: current file name (including any subdirs under userfiles)
14543: new: desired file name (including any subdirs under userfiles)
14544:
14545: =item *
14546:
14547: mkdiruserfile(): creates a directory is a userfiles dir
14548:
14549: Args:
14550: docuname: username or courseid of destination for the file
14551: docudom: domain of user/course of destination for the file
14552: dir: dir to create (including any subdirs under userfiles)
14553:
14554: =item *
14555:
14556: removeuserfile(): removes a file that exists in userfiles
14557:
14558: Args:
14559: docuname: username or courseid of destination for the file
14560: docudom: domain of user/course of destination for the file
14561: fname: filname to delete (including any subdirs under userfiles)
14562:
14563: =item *
14564:
14565: removeuploadedurl(): convience function for removeuserfile()
14566:
14567: Args:
14568: url: a full /uploaded/... url to delete
14569:
1.747 albertel 14570: =item *
14571:
14572: get_portfile_permissions():
14573: Args:
14574: domain: domain of user or course contain the portfolio files
14575: user: name of user or num of course contain the portfolio files
14576: Returns:
14577: hashref of a dump of the proper file_permissions.db
14578:
14579:
14580: =item *
14581:
14582: get_access_controls():
14583:
14584: Args:
14585: current_permissions: the hash ref returned from get_portfile_permissions()
14586: group: (optional) the group you want the files associated with
14587: file: (optional) the file you want access info on
14588:
14589: Returns:
1.749 raeburn 14590: a hash (keys are file names) of hashes containing
14591: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
14592: values are XML containing access control settings (see below)
1.747 albertel 14593:
14594: Internal notes:
14595:
1.749 raeburn 14596: access controls are stored in file_permissions.db as key=value pairs.
14597: key -> path to file/file_name\0uniqueID:scope_end_start
14598: where scope -> public,guest,course,group,domains or users.
14599: end -> UNIX time for end of access (0 -> no end date)
14600: start -> UNIX time for start of access
14601:
14602: value -> XML description of access control
14603: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
14604: <start></start>
14605: <end></end>
14606:
14607: <password></password> for scope type = guest
14608:
14609: <domain></domain> for scope type = course or group
14610: <number></number>
14611: <roles id="">
14612: <role></role>
14613: <access></access>
14614: <section></section>
14615: <group></group>
14616: </roles>
14617:
14618: <dom></dom> for scope type = domains
14619:
14620: <users> for scope type = users
14621: <user>
14622: <uname></uname>
14623: <udom></udom>
14624: </user>
14625: </users>
14626: </scope>
14627:
14628: Access data is also aggregated for each file in an additional key=value pair:
14629: key -> path to file/file_name\0accesscontrol
14630: value -> reference to hash
14631: hash contains key = value pairs
14632: where key = uniqueID:scope_end_start
14633: value = UNIX time record was last updated
14634:
14635: Used to improve speed of look-ups of access controls for each file.
14636:
14637: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
14638:
1.1172.2.13 raeburn 14639: =item *
14640:
1.749 raeburn 14641: modify_access_controls():
14642:
14643: Modifies access controls for a portfolio file
14644: Args
14645: 1. file name
14646: 2. reference to hash of required changes,
14647: 3. domain
14648: 4. username
14649: where domain,username are the domain of the portfolio owner
14650: (either a user or a course)
14651:
14652: Returns:
14653: 1. result of additions or updates ('ok' or 'error', with error message).
14654: 2. result of deletions ('ok' or 'error', with error message).
14655: 3. reference to hash of any new or updated access controls.
14656: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
14657: key = integer (inbound ID)
1.1172.2.13 raeburn 14658: value = uniqueID
14659:
14660: =item *
14661:
14662: get_timebased_id():
14663:
14664: Attempts to get a unique timestamp-based suffix for use with items added to a
14665: course via the Course Editor (e.g., folders, composite pages,
14666: group bulletin boards).
14667:
14668: Args: (first three required; six others optional)
14669:
14670: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
14671: docssequence, or name of group
14672:
14673: 2. keyid (alphanumeric): name of temporary locking key in hash,
14674: e.g., num, boardids
14675:
14676: 3. namespace: name of gdbm file used to store suffixes already assigned;
14677: file will be named nohist_namespace.db
14678:
14679: 4. cdom: domain of course; default is current course domain from %env
14680:
14681: 5. cnum: course number; default is current course number from %env
14682:
14683: 6. idtype: set to concat if an additional digit is to be appended to the
14684: unix timestamp to form the suffix, if the plain timestamp is already
14685: in use. Default is to not do this, but simply increment the unix
14686: timestamp by 1 until a unique key is obtained.
14687:
14688: 7. who: holder of locking key; defaults to user:domain for user.
14689:
14690: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
14691: retrying); default is 3.
14692:
14693: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
14694:
14695: Returns:
14696:
14697: 1. suffix obtained (numeric)
14698:
14699: 2. result of deleting locking key (ok if deleted, or lock never obtained)
14700:
14701: 3. error: contains (localized) error message if an error occurred.
14702:
1.747 albertel 14703:
1.608 albertel 14704: =back
14705:
1.243 albertel 14706: =head2 HTTP Helper Routines
14707:
14708: =over 4
14709:
1.191 harris41 14710: =item *
14711:
14712: escape() : unpack non-word characters into CGI-compatible hex codes
14713:
14714: =item *
14715:
14716: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
14717:
1.243 albertel 14718: =back
14719:
14720: =head1 PRIVATE SUBROUTINES
14721:
14722: =head2 Underlying communication routines (Shouldn't call)
14723:
14724: =over 4
14725:
14726: =item *
14727:
14728: subreply() : tries to pass a message to lonc, returns con_lost if incapable
14729:
14730: =item *
14731:
14732: reply() : uses subreply to send a message to remote machine, logs all failures
14733:
14734: =item *
14735:
14736: critical() : passes a critical message to another server; if cannot
14737: get through then place message in connection buffer directory and
14738: returns con_delayed, if incapable of saving message, returns
14739: con_failed
14740:
14741: =item *
14742:
14743: reconlonc() : tries to reconnect lonc client processes.
14744:
14745: =back
14746:
14747: =head2 Resource Access Logging
14748:
14749: =over 4
14750:
14751: =item *
14752:
14753: flushcourselogs() : flush (save) buffer logs and access logs
14754:
14755: =item *
14756:
14757: courselog($what) : save message for course in hash
14758:
14759: =item *
14760:
14761: courseacclog($what) : save message for course using &courselog(). Perform
14762: special processing for specific resource types (problems, exams, quizzes, etc).
14763:
1.191 harris41 14764: =item *
14765:
14766: goodbye() : flush course logs and log shutting down; it is called in srm.conf
14767: as a PerlChildExitHandler
1.243 albertel 14768:
14769: =back
14770:
14771: =head2 Other
14772:
14773: =over 4
14774:
14775: =item *
14776:
14777: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 14778:
14779: =back
14780:
14781: =cut
1.877 foxr 14782:
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