Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1172.2.95
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1172.2.95! raeburn 4: # $Id: lonnet.pm,v 1.1172.2.94 2018/04/29 00:53:23 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\_/) {
1.1172.2.92 raeburn 1832: &logthis('institutional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1.904 albertel 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.1172.2.91 raeburn 2115: $domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
2116: $domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
2117: $domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
1.943 raeburn 2118: } else {
2119: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2120: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2121: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2122: }
1.976 raeburn 2123: if (ref($domconfig{'quotas'}) eq 'HASH') {
2124: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2125: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2126: } else {
2127: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1172.2.29 raeburn 2128: }
1.1172.2.6 raeburn 2129: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2130: foreach my $item (@usertools) {
2131: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2132: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2133: }
2134: }
1.1172.2.29 raeburn 2135: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2136: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2137: }
1.976 raeburn 2138: }
1.985 raeburn 2139: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1172.2.37 raeburn 2140: foreach my $item ('official','unofficial','community','textbook') {
1.985 raeburn 2141: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2142: }
2143: }
1.1172.2.9 raeburn 2144: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2145: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2146: }
1.989 raeburn 2147: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1172.2.44 raeburn 2148: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2149: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2150: }
2151: }
1.1047 raeburn 2152: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1172.2.60 raeburn 2153: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2154: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2155: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2156: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2157: }
1.1172.2.41 raeburn 2158: foreach my $type (@coursetypes) {
2159: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2160: unless ($type eq 'community') {
2161: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2162: }
2163: }
2164: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2165: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2166: }
1.1172.2.60 raeburn 2167: if ($domdefaults{'postsubmit'} eq 'on') {
2168: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2169: $domdefaults{$type.'postsubtimeout'} =
2170: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2171: }
2172: }
1.1172.2.30 raeburn 2173: }
1.1172.2.67 raeburn 2174: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2175: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2176: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2177: if (@clonecodes) {
2178: $domdefaults{'canclone'} = join('+',@clonecodes);
2179: }
2180: }
2181: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2182: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2183: }
1.1047 raeburn 2184: }
1.1073 raeburn 2185: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2186: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2187: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2188: }
2189: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2190: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2191: }
1.1172.2.62 raeburn 2192: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2193: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2194: }
1.1073 raeburn 2195: }
1.1172.2.41 raeburn 2196: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2197: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2198: my @settings = ('types','registered','enroll_dates','access_dates','section',
2199: 'approval','limit');
2200: foreach my $type (@coursetypes) {
2201: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2202: my @mgrdc = ();
2203: foreach my $item (@settings) {
2204: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2205: push(@mgrdc,$item);
2206: }
2207: }
2208: if (@mgrdc) {
2209: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2210: }
2211: }
2212: }
2213: }
2214: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2215: foreach my $type (@coursetypes) {
2216: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2217: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2218: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2219: }
2220: }
2221: }
2222: }
2223: }
1.1172.2.46 raeburn 2224: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2225: $domdefaults{'catauth'} = 'std';
2226: $domdefaults{'catunauth'} = 'std';
2227: if ($domconfig{'coursecategories'}{'auth'}) {
2228: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2229: }
2230: if ($domconfig{'coursecategories'}{'unauth'}) {
2231: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2232: }
2233: }
1.1172.2.76 raeburn 2234: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
2235: $domdefaults{'autofailsafe'} = $domconfig{'autoenroll'}{'autofailsafe'};
2236: }
1.1172.2.89 raeburn 2237: if (ref($domconfig{'helpsettings'}) eq 'HASH') {
2238: $domdefaults{'submitbugs'} = $domconfig{'helpsettings'}{'submitbugs'};
2239: if (ref($domconfig{'helpsettings'}{'adhoc'}) eq 'HASH') {
2240: $domdefaults{'adhocroles'} = $domconfig{'helpsettings'}{'adhoc'};
2241: }
2242: }
1.1172.2.23 raeburn 2243: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2244: return %domdefaults;
2245: }
2246:
1.344 www 2247: # --------------------------------------------------- Assign a key to a student
2248:
2249: sub assign_access_key {
1.364 www 2250: #
2251: # a valid key looks like uname:udom#comments
2252: # comments are being appended
2253: #
1.498 www 2254: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2255: $kdom=
1.620 albertel 2256: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2257: $knum=
1.620 albertel 2258: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2259: $cdom=
1.620 albertel 2260: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2261: $cnum=
1.620 albertel 2262: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2263: $udom=$env{'user.name'} unless (defined($udom));
2264: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2265: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2266: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2267: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2268: # assigned to this person
2269: # - this should not happen,
1.345 www 2270: # unless something went wrong
2271: # the first time around
2272: # ready to assign
1.364 www 2273: $logentry=$1.'; '.$logentry;
1.496 www 2274: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2275: $kdom,$knum) eq 'ok') {
1.345 www 2276: # key now belongs to user
1.346 www 2277: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2278: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2279: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2280: return 'ok';
2281: } else {
2282: return
2283: 'error: Count not permanently assign key, will need to be re-entered later.';
2284: }
2285: } else {
2286: return 'error: Could not assign key, try again later.';
2287: }
1.364 www 2288: } elsif (!$existing{$ckey}) {
1.345 www 2289: # the key does not exist
2290: return 'error: The key does not exist';
2291: } else {
2292: # the key is somebody else's
2293: return 'error: The key is already in use';
2294: }
1.344 www 2295: }
2296:
1.364 www 2297: # ------------------------------------------ put an additional comment on a key
2298:
2299: sub comment_access_key {
2300: #
2301: # a valid key looks like uname:udom#comments
2302: # comments are being appended
2303: #
2304: my ($ckey,$cdom,$cnum,$logentry)=@_;
2305: $cdom=
1.620 albertel 2306: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2307: $cnum=
1.620 albertel 2308: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2309: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2310: if ($existing{$ckey}) {
2311: $existing{$ckey}.='; '.$logentry;
2312: # ready to assign
1.367 www 2313: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2314: $cdom,$cnum) eq 'ok') {
2315: return 'ok';
2316: } else {
2317: return 'error: Count not store comment.';
2318: }
2319: } else {
2320: # the key does not exist
2321: return 'error: The key does not exist';
2322: }
2323: }
2324:
1.344 www 2325: # ------------------------------------------------------ Generate a set of keys
2326:
2327: sub generate_access_keys {
1.364 www 2328: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2329: $cdom=
1.620 albertel 2330: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2331: $cnum=
1.620 albertel 2332: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2333: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2334: unless (($cdom) && ($cnum)) { return 0; }
2335: if ($number>10000) { return 0; }
2336: sleep(2); # make sure don't get same seed twice
2337: srand(time()^($$+($$<<15))); # from "Programming Perl"
2338: my $total=0;
2339: for (my $i=1;$i<=$number;$i++) {
2340: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2341: sprintf("%lx",int(100000*rand)).'-'.
2342: sprintf("%lx",int(100000*rand));
2343: $newkey=~s/1/g/g; # folks mix up 1 and l
2344: $newkey=~s/0/h/g; # and also 0 and O
2345: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2346: if ($existing{$newkey}) {
2347: $i--;
2348: } else {
1.364 www 2349: if (&put('accesskeys',
2350: { $newkey => '# generated '.localtime().
1.620 albertel 2351: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 2352: '; '.$logentry },
2353: $cdom,$cnum) eq 'ok') {
1.344 www 2354: $total++;
2355: }
2356: }
2357: }
1.620 albertel 2358: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 2359: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2360: return $total;
2361: }
2362:
2363: # ------------------------------------------------------- Validate an accesskey
2364:
2365: sub validate_access_key {
2366: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2367: $cdom=
1.620 albertel 2368: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2369: $cnum=
1.620 albertel 2370: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2371: $udom=$env{'user.domain'} unless (defined($udom));
2372: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 2373: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 2374: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 2375: }
2376:
2377: # ------------------------------------- Find the section of student in a course
1.652 albertel 2378: sub devalidate_getsection_cache {
2379: my ($udom,$unam,$courseid)=@_;
2380: my $hashid="$udom:$unam:$courseid";
2381: &devalidate_cache_new('getsection',$hashid);
2382: }
1.298 matthew 2383:
1.815 albertel 2384: sub courseid_to_courseurl {
2385: my ($courseid) = @_;
2386: #already url style courseid
2387: return $courseid if ($courseid =~ m{^/});
2388:
2389: if (exists($env{'course.'.$courseid.'.num'})) {
2390: my $cnum = $env{'course.'.$courseid.'.num'};
2391: my $cdom = $env{'course.'.$courseid.'.domain'};
2392: return "/$cdom/$cnum";
2393: }
2394:
2395: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2396: if (exists($courseinfo{'num'})) {
2397: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2398: }
2399:
2400: return undef;
2401: }
2402:
1.298 matthew 2403: sub getsection {
2404: my ($udom,$unam,$courseid)=@_;
1.599 albertel 2405: my $cachetime=1800;
1.551 albertel 2406:
2407: my $hashid="$udom:$unam:$courseid";
1.599 albertel 2408: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 2409: if (defined($cached)) { return $result; }
2410:
1.298 matthew 2411: my %Pending;
2412: my %Expired;
2413: #
2414: # Each role can either have not started yet (pending), be active,
2415: # or have expired.
2416: #
2417: # If there is an active role, we are done.
2418: #
2419: # If there is more than one role which has not started yet,
2420: # choose the one which will start sooner
2421: # If there is one role which has not started yet, return it.
2422: #
2423: # If there is more than one expired role, choose the one which ended last.
2424: # If there is a role which has expired, return it.
2425: #
1.815 albertel 2426: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 2427: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 2428: foreach my $key (keys(%roleshash)) {
1.479 albertel 2429: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 2430: my $section=$1;
2431: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 2432: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 2433: my $now=time;
1.548 albertel 2434: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 2435: $Expired{$end}=$section;
2436: next;
2437: }
1.548 albertel 2438: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 2439: $Pending{$start}=$section;
2440: next;
2441: }
1.599 albertel 2442: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 2443: }
2444: #
2445: # Presumedly there will be few matching roles from the above
2446: # loop and the sorting time will be negligible.
2447: if (scalar(keys(%Pending))) {
2448: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 2449: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 2450: }
2451: if (scalar(keys(%Expired))) {
2452: my @sorted = sort {$a <=> $b} keys(%Expired);
2453: my $time = pop(@sorted);
1.599 albertel 2454: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 2455: }
1.599 albertel 2456: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 2457: }
1.70 www 2458:
1.599 albertel 2459: sub save_cache {
2460: &purge_remembered();
1.722 albertel 2461: #&Apache::loncommon::validate_page();
1.620 albertel 2462: undef(%env);
1.780 albertel 2463: undef($env_loaded);
1.599 albertel 2464: }
1.452 albertel 2465:
1.599 albertel 2466: my $to_remember=-1;
2467: my %remembered;
2468: my %accessed;
2469: my $kicks=0;
2470: my $hits=0;
1.849 albertel 2471: sub make_key {
2472: my ($name,$id) = @_;
1.872 albertel 2473: if (length($id) > 65
2474: && length(&escape($id)) > 200) {
2475: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2476: }
1.849 albertel 2477: return &escape($name.':'.$id);
2478: }
2479:
1.599 albertel 2480: sub devalidate_cache_new {
2481: my ($name,$id,$debug) = @_;
2482: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.1172.2.81 raeburn 2483: my $remembered_id=$name.':'.$id;
1.849 albertel 2484: $id=&make_key($name,$id);
1.599 albertel 2485: $memcache->delete($id);
1.1172.2.81 raeburn 2486: delete($remembered{$remembered_id});
2487: delete($accessed{$remembered_id});
1.599 albertel 2488: }
2489:
2490: sub is_cached_new {
2491: my ($name,$id,$debug) = @_;
1.1172.2.81 raeburn 2492: my $remembered_id=$name.':'.$id; # this is to avoid make_key (which is slow) for
2493: # keys in %remembered hash, which persists for
2494: # duration of request (no restriction on key length).
2495: if (exists($remembered{$remembered_id})) {
2496: if ($debug) { &Apache::lonnet::logthis("Early return $remembered_id of $remembered{$remembered_id} "); }
2497: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2498: $hits++;
1.1172.2.81 raeburn 2499: return ($remembered{$remembered_id},1);
1.599 albertel 2500: }
1.1172.2.81 raeburn 2501: $id=&make_key($name,$id);
1.599 albertel 2502: my $value = $memcache->get($id);
2503: if (!(defined($value))) {
2504: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 2505: return (undef,undef);
1.416 albertel 2506: }
1.599 albertel 2507: if ($value eq '__undef__') {
2508: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2509: $value=undef;
2510: }
1.1172.2.81 raeburn 2511: &make_room($remembered_id,$value,$debug);
1.599 albertel 2512: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2513: return ($value,1);
2514: }
2515:
2516: sub do_cache_new {
2517: my ($name,$id,$value,$time,$debug) = @_;
1.1172.2.81 raeburn 2518: my $remembered_id=$name.':'.$id;
1.849 albertel 2519: $id=&make_key($name,$id);
1.599 albertel 2520: my $setvalue=$value;
2521: if (!defined($setvalue)) {
2522: $setvalue='__undef__';
2523: }
1.623 albertel 2524: if (!defined($time) ) {
2525: $time=600;
2526: }
1.599 albertel 2527: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 2528: my $result = $memcache->set($id,$setvalue,$time);
2529: if (! $result) {
1.872 albertel 2530: &logthis("caching of id -> $id failed");
1.910 albertel 2531: $memcache->disconnect_all();
1.872 albertel 2532: }
1.600 albertel 2533: # need to make a copy of $value
1.1172.2.81 raeburn 2534: &make_room($remembered_id,$value,$debug);
1.599 albertel 2535: return $value;
2536: }
2537:
2538: sub make_room {
1.1172.2.81 raeburn 2539: my ($remembered_id,$value,$debug)=@_;
1.919 albertel 2540:
1.1172.2.81 raeburn 2541: $remembered{$remembered_id}= (ref($value)) ? &Storable::dclone($value)
1.919 albertel 2542: : $value;
1.599 albertel 2543: if ($to_remember<0) { return; }
1.1172.2.81 raeburn 2544: $accessed{$remembered_id}=[&gettimeofday()];
1.599 albertel 2545: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2546: my $to_kick;
2547: my $max_time=0;
2548: foreach my $other (keys(%accessed)) {
2549: if (&tv_interval($accessed{$other}) > $max_time) {
2550: $to_kick=$other;
2551: $max_time=&tv_interval($accessed{$other});
2552: }
2553: }
2554: delete($remembered{$to_kick});
2555: delete($accessed{$to_kick});
2556: $kicks++;
2557: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 2558: return;
2559: }
2560:
1.599 albertel 2561: sub purge_remembered {
1.604 albertel 2562: #&logthis("Tossing ".scalar(keys(%remembered)));
2563: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 2564: undef(%remembered);
2565: undef(%accessed);
1.428 albertel 2566: }
1.70 www 2567: # ------------------------------------- Read an entry from a user's environment
2568:
2569: sub userenvironment {
2570: my ($udom,$unam,@what)=@_;
1.976 raeburn 2571: my $items;
2572: foreach my $item (@what) {
2573: $items.=&escape($item).'&';
2574: }
2575: $items=~s/\&$//;
1.70 www 2576: my %returnhash=();
1.1009 raeburn 2577: my $uhome = &homeserver($unam,$udom);
2578: unless ($uhome eq 'no_host') {
2579: my @answer=split(/\&/,
2580: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 2581: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2582: return %returnhash;
2583: }
1.1009 raeburn 2584: my $i;
2585: for ($i=0;$i<=$#what;$i++) {
2586: $returnhash{$what[$i]}=&unescape($answer[$i]);
2587: }
1.70 www 2588: }
2589: return %returnhash;
1.1 albertel 2590: }
2591:
1.617 albertel 2592: # ---------------------------------------------------------- Get a studentphoto
2593: sub studentphoto {
2594: my ($udom,$unam,$ext) = @_;
2595: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 2596: if (defined($env{'request.course.id'})) {
1.708 raeburn 2597: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 2598: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2599: return(&retrievestudentphoto($udom,$unam,$ext));
2600: } else {
2601: my ($result,$perm_reqd)=
1.707 albertel 2602: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2603: if ($result eq 'ok') {
2604: if (!($perm_reqd eq 'yes')) {
2605: return(&retrievestudentphoto($udom,$unam,$ext));
2606: }
2607: }
2608: }
2609: }
2610: } else {
2611: my ($result,$perm_reqd) =
1.707 albertel 2612: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2613: if ($result eq 'ok') {
2614: if (!($perm_reqd eq 'yes')) {
2615: return(&retrievestudentphoto($udom,$unam,$ext));
2616: }
2617: }
2618: }
2619: return '/adm/lonKaputt/lonlogo_broken.gif';
2620: }
2621:
2622: sub retrievestudentphoto {
2623: my ($udom,$unam,$ext,$type) = @_;
2624: my $home=&Apache::lonnet::homeserver($unam,$udom);
2625: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2626: if ($ret eq 'ok') {
2627: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2628: if ($type eq 'thumbnail') {
2629: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2630: }
2631: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2632: return $tokenurl;
2633: } else {
2634: if ($type eq 'thumbnail') {
2635: return '/adm/lonKaputt/genericstudent_tn.gif';
2636: } else {
2637: return '/adm/lonKaputt/lonlogo_broken.gif';
2638: }
1.617 albertel 2639: }
2640: }
2641:
1.263 www 2642: # -------------------------------------------------------------------- New chat
2643:
2644: sub chatsend {
1.724 raeburn 2645: my ($newentry,$anon,$group)=@_;
1.620 albertel 2646: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2647: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2648: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 2649: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 2650: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 2651: &escape($newentry)).':'.$group,$chome);
1.292 www 2652: }
2653:
2654: # ------------------------------------------ Find current version of a resource
2655:
2656: sub getversion {
2657: my $fname=&clutter(shift);
1.1172.2.10 raeburn 2658: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 2659: return ¤tversion(&filelocation('',$fname));
2660: }
2661:
2662: sub currentversion {
2663: my $fname=shift;
2664: my $author=$fname;
2665: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2666: my ($udom,$uname)=split(/\//,$author);
1.1112 www 2667: my $home=&homeserver($uname,$udom);
1.292 www 2668: if ($home eq 'no_host') {
2669: return -1;
2670: }
1.1112 www 2671: my $answer=&reply("currentversion:$fname",$home);
1.292 www 2672: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2673: return -1;
2674: }
1.1112 www 2675: return $answer;
1.263 www 2676: }
2677:
1.1111 www 2678: #
2679: # Return special version number of resource if set by override, empty otherwise
2680: #
2681: sub usedversion {
2682: my $fname=shift;
2683: unless ($fname) { $fname=$env{'request.uri'}; }
2684: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2685: if ($urlversion) { return $urlversion; }
2686: return '';
2687: }
2688:
1.1 albertel 2689: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 2690:
1.1 albertel 2691: sub subscribe {
2692: my $fname=shift;
1.761 raeburn 2693: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 2694: $fname=~s/[\n\r]//g;
1.1 albertel 2695: my $author=$fname;
2696: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2697: my ($udom,$uname)=split(/\//,$author);
2698: my $home=homeserver($uname,$udom);
1.335 albertel 2699: if ($home eq 'no_host') {
2700: return 'not_found';
1.1 albertel 2701: }
2702: my $answer=reply("sub:$fname",$home);
1.64 www 2703: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2704: $answer.=' by '.$home;
2705: }
1.1 albertel 2706: return $answer;
2707: }
2708:
1.8 www 2709: # -------------------------------------------------------------- Replicate file
2710:
2711: sub repcopy {
2712: my $filename=shift;
1.23 www 2713: $filename=~s/\/+/\//g;
1.1142 raeburn 2714: my $londocroot = $perlvar{'lonDocRoot'};
2715: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 2716: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 2717: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2718: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 2719: return &repcopy_userfile($filename);
2720: }
1.532 albertel 2721: $filename=~s/[\n\r]//g;
1.8 www 2722: my $transname="$filename.in.transfer";
1.828 www 2723: # FIXME: this should flock
1.607 raeburn 2724: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 2725: my $remoteurl=subscribe($filename);
1.64 www 2726: if ($remoteurl =~ /^con_lost by/) {
2727: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2728: return 'unavailable';
1.8 www 2729: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 2730: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 2731: return 'not_found';
1.64 www 2732: } elsif ($remoteurl =~ /^rejected by/) {
2733: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2734: return 'forbidden';
1.20 www 2735: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 2736: return 'ok';
1.8 www 2737: } else {
1.290 www 2738: my $author=$filename;
2739: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2740: my ($udom,$uname)=split(/\//,$author);
2741: my $home=homeserver($uname,$udom);
2742: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 2743: my @parts=split(/\//,$filename);
2744: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 2745: if ($path ne "$londocroot/res") {
1.8 www 2746: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 2747: return 'bad_request';
1.8 www 2748: }
2749: my $count;
2750: for ($count=5;$count<$#parts;$count++) {
2751: $path.="/$parts[$count]";
2752: if ((-e $path)!=1) {
2753: mkdir($path,0777);
2754: }
2755: }
2756: my $ua=new LWP::UserAgent;
2757: my $request=new HTTP::Request('GET',"$remoteurl");
2758: my $response=$ua->request($request,$transname);
2759: if ($response->is_error()) {
2760: unlink($transname);
2761: my $message=$response->status_line;
1.672 albertel 2762: &logthis("<font color=\"blue\">WARNING:"
1.12 www 2763: ." LWP get: $message: $filename</font>");
1.607 raeburn 2764: return 'unavailable';
1.8 www 2765: } else {
1.16 www 2766: if ($remoteurl!~/\.meta$/) {
2767: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2768: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2769: if ($mresponse->is_error()) {
2770: unlink($filename.'.meta');
2771: &logthis(
1.672 albertel 2772: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 2773: }
2774: }
1.8 www 2775: rename($transname,$filename);
1.607 raeburn 2776: return 'ok';
1.8 www 2777: }
1.290 www 2778: }
1.8 www 2779: }
1.330 www 2780: }
2781:
2782: # ------------------------------------------------ Get server side include body
2783: sub ssi_body {
1.381 albertel 2784: my ($filelink,%form)=@_;
1.606 matthew 2785: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2786: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2787: }
1.953 www 2788: my $output='';
2789: my $response;
1.980 raeburn 2790: if ($filelink=~/^https?\:/) {
1.954 raeburn 2791: ($output,$response)=&externalssi($filelink);
1.953 www 2792: } else {
1.1004 droeschl 2793: $filelink .= $filelink=~/\?/ ? '&' : '?';
2794: $filelink .= 'inhibitmenu=yes';
1.953 www 2795: ($output,$response)=&ssi($filelink,%form);
2796: }
1.778 albertel 2797: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 2798: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 2799: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 2800: if (wantarray) {
2801: return ($output, $response);
2802: } else {
2803: return $output;
2804: }
1.8 www 2805: }
2806:
1.15 www 2807: # --------------------------------------------------------- Server Side Include
2808:
1.782 albertel 2809: sub absolute_url {
2810: my ($host_name) = @_;
2811: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2812: if ($host_name eq '') {
2813: $host_name = $ENV{'SERVER_NAME'};
2814: }
2815: return $protocol.$host_name;
2816: }
2817:
1.942 foxr 2818: #
2819: # Server side include.
2820: # Parameters:
2821: # fn Possibly encrypted resource name/id.
2822: # form Hash that describes how the rendering should be done
2823: # and other things.
1.944 foxr 2824: # Returns:
1.950 raeburn 2825: # Scalar context: The content of the response.
2826: # Array context: 2 element list of the content and the full response object.
1.942 foxr 2827: #
1.15 www 2828: sub ssi {
2829:
1.944 foxr 2830: my ($fn,%form)=@_;
1.15 www 2831: my $ua=new LWP::UserAgent;
1.23 www 2832: my $request;
1.711 albertel 2833:
2834: $form{'no_update_last_known'}=1;
1.895 albertel 2835: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 2836: if (%form) {
1.782 albertel 2837: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1172.2.58 raeburn 2838: $request->content(join('&',map {
2839: my $name = escape($_);
2840: "$name=" . ( ref($form{$_}) eq 'ARRAY'
2841: ? join("&$name=", map {escape($_) } @{$form{$_}})
2842: : &escape($form{$_}) );
2843: } keys(%form)));
1.23 www 2844: } else {
1.782 albertel 2845: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 2846: }
2847:
1.15 www 2848: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1172.2.2 raeburn 2849: my $response= $ua->request($request);
1.944 foxr 2850: if (wantarray) {
1.1172.2.3 raeburn 2851: return ($response->content, $response);
1.944 foxr 2852: } else {
1.1172.2.3 raeburn 2853: return $response->content;
1.942 foxr 2854: }
1.324 www 2855: }
2856:
2857: sub externalssi {
2858: my ($url)=@_;
2859: my $ua=new LWP::UserAgent;
2860: my $request=new HTTP::Request('GET',$url);
2861: my $response=$ua->request($request);
1.954 raeburn 2862: if (wantarray) {
2863: return ($response->content, $response);
2864: } else {
2865: return $response->content;
2866: }
1.15 www 2867: }
1.254 www 2868:
1.492 albertel 2869: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2870:
2871: sub allowuploaded {
2872: my ($srcurl,$url)=@_;
2873: $url=&clutter(&declutter($url));
2874: my $dir=$url;
2875: $dir=~s/\/[^\/]+$//;
2876: my %httpref=();
2877: my $httpurl=&hreflocation('',$url);
2878: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2879: &Apache::lonnet::appenv(\%httpref);
1.254 www 2880: }
1.477 raeburn 2881:
1.1172.2.13 raeburn 2882: #
2883: # Determine if the current user should be able to edit a particular resource,
2884: # when viewing in course context.
2885: # (a) When viewing resource used to determine if "Edit" item is included in
2886: # Functions.
2887: # (b) When displaying folder contents in course editor, used to determine if
2888: # "Edit" link will be displayed alongside resource.
2889: #
2890: # input: six args -- filename (decluttered), course number, course domain,
2891: # url, symb (if registered) and group (if this is a group
2892: # item -- e.g., bulletin board, group page etc.).
2893: # output: array of five scalars --
2894: # $cfile -- url for file editing if editable on current server
2895: # $home -- homeserver of resource (i.e., for author if published,
2896: # or course if uploaded.).
2897: # $switchserver -- 1 if server switch will be needed.
2898: # $forceedit -- 1 if icon/link should be to go to edit mode
2899: # $forceview -- 1 if icon/link should be to go to view mode
2900: #
2901:
2902: sub can_edit_resource {
2903: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
2904: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
2905: #
2906: # For aboutme pages user can only edit his/her own.
2907: #
2908: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
2909: my ($sdom,$sname) = ($1,$2);
2910: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
2911: $home = $env{'user.home'};
2912: $cfile = $resurl;
2913: if ($env{'form.forceedit'}) {
2914: $forceview = 1;
2915: } else {
2916: $forceedit = 1;
2917: }
2918: return ($cfile,$home,$switchserver,$forceedit,$forceview);
2919: } else {
2920: return;
2921: }
2922: }
2923:
2924: if ($env{'request.course.id'}) {
2925: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
2926: if ($group ne '') {
2927: # if this is a group homepage or group bulletin board, check group privs
2928: my $allowed = 0;
2929: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
2930: if ((&allowed('mdg',$env{'request.course.id'}.
2931: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2932: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2933: $allowed = 1;
2934: }
2935: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
2936: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2937: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2938: $allowed = 1;
2939: }
2940: }
2941: if ($allowed) {
2942: $home=&homeserver($cnum,$cdom);
2943: if ($env{'form.forceedit'}) {
2944: $forceview = 1;
2945: } else {
2946: $forceedit = 1;
2947: }
2948: $cfile = $resurl;
2949: } else {
2950: return;
2951: }
2952: } else {
1.1172.2.15 raeburn 2953: if ($resurl =~ m{^/?adm/viewclasslist$}) {
2954: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
2955: return;
2956: }
2957: } elsif (!$crsedit) {
1.1172.2.13 raeburn 2958: #
2959: # No edit allowed where CC has switched to student role.
2960: #
2961: return;
2962: }
2963: }
2964: }
2965:
2966: if ($file ne '') {
2967: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
2968: if (&is_course_upload($file,$cnum,$cdom)) {
2969: $uploaded = 1;
2970: $incourse = 1;
2971: if ($file =~/\.(htm|html|css|js|txt)$/) {
2972: $cfile = &hreflocation('',$file);
2973: if ($env{'form.forceedit'}) {
2974: $forceview = 1;
2975: } else {
2976: $forceedit = 1;
2977: }
2978: }
2979: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
2980: $incourse = 1;
2981: if ($env{'form.forceedit'}) {
2982: $forceview = 1;
2983: } else {
2984: $forceedit = 1;
2985: }
2986: $cfile = $resurl;
2987: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
2988: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
2989: $incourse = 1;
2990: if ($env{'form.forceedit'}) {
2991: $forceview = 1;
2992: } else {
2993: $forceedit = 1;
2994: }
2995: $cfile = $resurl;
2996: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
2997: $incourse = 1;
2998: $cfile = $resurl.'/smpedit';
2999: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
3000: $incourse = 1;
3001: if ($env{'form.forceedit'}) {
3002: $forceview = 1;
3003: } else {
3004: $forceedit = 1;
3005: }
3006: $cfile = $resurl;
1.1172.2.15 raeburn 3007: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3008: $incourse = 1;
3009: if ($env{'form.forceedit'}) {
3010: $forceview = 1;
3011: } else {
3012: $forceedit = 1;
3013: }
3014: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1172.2.13 raeburn 3015: }
3016: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
3017: my $template = '/res/lib/templates/simpleproblem.problem';
3018: if (&is_on_map($template)) {
3019: $incourse = 1;
3020: $forceview = 1;
3021: $cfile = $template;
3022: }
3023: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3024: $incourse = 1;
3025: if ($env{'form.forceedit'}) {
3026: $forceview = 1;
3027: } else {
3028: $forceedit = 1;
3029: }
3030: $cfile = $resurl;
3031: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3032: $incourse = 1;
3033: $forceview = 1;
3034: if ($symb) {
3035: my ($map,$id,$res)=&decode_symb($symb);
3036: $env{'request.symb'} = $symb;
3037: $cfile = &clutter($res);
3038: } else {
3039: $cfile = $env{'form.suppurl'};
3040: $cfile =~ s{^http://}{};
3041: $cfile = '/adm/wrapper/ext/'.$cfile;
3042: }
1.1172.2.31 raeburn 3043: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3044: if ($env{'form.forceedit'}) {
3045: $forceview = 1;
3046: } else {
3047: $forceedit = 1;
3048: }
3049: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1172.2.13 raeburn 3050: }
3051: }
3052: if ($uploaded || $incourse) {
3053: $home=&homeserver($cnum,$cdom);
1.1172.2.14 raeburn 3054: } elsif ($file !~ m{/$}) {
1.1172.2.13 raeburn 3055: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3056: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3057: # Check that the user has permission to edit this resource
3058: my $setpriv = 1;
3059: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3060: if (defined($cfudom)) {
3061: $home=&homeserver($cfuname,$cfudom);
3062: $cfile=$file;
3063: }
3064: }
3065: if (($cfile ne '') && (!$incourse || $uploaded) &&
3066: (($home ne '') && ($home ne 'no_host'))) {
3067: my @ids=¤t_machine_ids();
3068: unless (grep(/^\Q$home\E$/,@ids)) {
3069: $switchserver=1;
3070: }
3071: }
3072: }
3073: return ($cfile,$home,$switchserver,$forceedit,$forceview);
3074: }
3075:
3076: sub is_course_upload {
3077: my ($file,$cnum,$cdom) = @_;
3078: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3079: $uploadpath =~ s{^\/}{};
3080: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3081: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
3082: return 1;
3083: }
3084: return;
3085: }
3086:
3087: sub in_course {
3088: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3089: if ($hideprivileged) {
3090: my $skipuser;
1.1172.2.23 raeburn 3091: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3092: my @possdoms = ($cdom);
3093: if ($coursehash{'checkforpriv'}) {
3094: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3095: }
3096: if (&privileged($uname,$udom,\@possdoms)) {
1.1172.2.13 raeburn 3097: $skipuser = 1;
3098: if ($coursehash{'nothideprivileged'}) {
3099: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3100: my $user;
3101: if ($item =~ /:/) {
3102: $user = $item;
3103: } else {
3104: $user = join(':',split(/[\@]/,$item));
3105: }
3106: if ($user eq $uname.':'.$udom) {
3107: undef($skipuser);
3108: last;
3109: }
3110: }
3111: }
3112: if ($skipuser) {
3113: return 0;
3114: }
3115: }
3116: }
3117: $type ||= 'any';
3118: if (!defined($cdom) || !defined($cnum)) {
3119: my $cid = $env{'request.course.id'};
3120: $cdom = $env{'course.'.$cid.'.domain'};
3121: $cnum = $env{'course.'.$cid.'.num'};
3122: }
3123: my $typesref;
3124: if (($type eq 'any') || ($type eq 'all')) {
3125: $typesref = ['active','previous','future'];
3126: } elsif ($type eq 'previous' || $type eq 'future') {
3127: $typesref = [$type];
3128: }
3129: my %roles = &get_my_roles($uname,$udom,'userroles',
3130: $typesref,undef,[$cdom]);
3131: my ($tmp) = keys(%roles);
3132: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3133: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3134: if (@course_roles > 0) {
3135: return 1;
3136: }
3137: return 0;
3138: }
3139:
1.478 albertel 3140: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 3141: # input: action, courseID, current domain, intended
1.637 raeburn 3142: # path to file, source of file, instruction to parse file for objects,
3143: # ref to hash for embedded objects,
3144: # ref to hash for codebase of java objects.
1.1095 raeburn 3145: # reference to scalar to accommodate mime type determined
3146: # from File::MMagic if $parser = parse.
1.637 raeburn 3147: #
1.485 raeburn 3148: # output: url to file (if action was uploaddoc),
3149: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 3150: #
1.478 albertel 3151: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3152: # course.
1.477 raeburn 3153: #
1.478 albertel 3154: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3155: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3156: # course's home server.
1.477 raeburn 3157: #
1.478 albertel 3158: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3159: # be copied from $source (current location) to
3160: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3161: # and will then be copied to
3162: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3163: # course's home server.
1.485 raeburn 3164: #
1.481 raeburn 3165: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 3166: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 3167: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3168: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3169: # in course's home server.
1.637 raeburn 3170: #
1.477 raeburn 3171:
3172: sub process_coursefile {
1.1095 raeburn 3173: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3174: $mimetype)=@_;
1.477 raeburn 3175: my $fetchresult;
1.638 albertel 3176: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 3177: if ($action eq 'propagate') {
1.638 albertel 3178: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3179: $home);
1.481 raeburn 3180: } else {
1.477 raeburn 3181: my $fpath = '';
3182: my $fname = $file;
1.478 albertel 3183: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 3184: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 3185: my $filepath = &build_filepath($fpath);
1.481 raeburn 3186: if ($action eq 'copy') {
3187: if ($source eq '') {
3188: $fetchresult = 'no source file';
3189: return $fetchresult;
3190: } else {
3191: my $destination = $filepath.'/'.$fname;
3192: rename($source,$destination);
3193: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3194: $home);
1.481 raeburn 3195: }
3196: } elsif ($action eq 'uploaddoc') {
3197: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 3198: print $fh $env{'form.'.$source};
1.481 raeburn 3199: close($fh);
1.637 raeburn 3200: if ($parser eq 'parse') {
1.1024 raeburn 3201: my $mm = new File::MMagic;
1.1095 raeburn 3202: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3203: if ($type eq 'text/html') {
1.1024 raeburn 3204: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3205: unless ($parse_result eq 'ok') {
3206: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3207: }
1.637 raeburn 3208: }
1.1095 raeburn 3209: if (ref($mimetype)) {
3210: $$mimetype = $type;
3211: }
1.637 raeburn 3212: }
1.477 raeburn 3213: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3214: $home);
1.481 raeburn 3215: if ($fetchresult eq 'ok') {
3216: return '/uploaded/'.$fpath.'/'.$fname;
3217: } else {
3218: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3219: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 3220: return '/adm/notfound.html';
3221: }
1.477 raeburn 3222: }
3223: }
1.485 raeburn 3224: unless ( $fetchresult eq 'ok') {
1.477 raeburn 3225: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3226: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 3227: }
3228: return $fetchresult;
3229: }
3230:
1.637 raeburn 3231: sub build_filepath {
3232: my ($fpath) = @_;
3233: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3234: unless ($fpath eq '') {
3235: my @parts=split('/',$fpath);
3236: foreach my $part (@parts) {
3237: $filepath.= '/'.$part;
3238: if ((-e $filepath)!=1) {
3239: mkdir($filepath,0777);
3240: }
3241: }
3242: }
3243: return $filepath;
3244: }
3245:
3246: sub store_edited_file {
1.638 albertel 3247: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 3248: my $file = $primary_url;
3249: $file =~ s#^/uploaded/$docudom/$docuname/##;
3250: my $fpath = '';
3251: my $fname = $file;
3252: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3253: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3254: my $filepath = &build_filepath($fpath);
3255: open(my $fh,'>'.$filepath.'/'.$fname);
3256: print $fh $content;
3257: close($fh);
1.638 albertel 3258: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 3259: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3260: $home);
1.637 raeburn 3261: if ($$fetchresult eq 'ok') {
3262: return '/uploaded/'.$fpath.'/'.$fname;
3263: } else {
1.638 albertel 3264: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3265: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 3266: return '/adm/notfound.html';
3267: }
3268: }
3269:
1.531 albertel 3270: sub clean_filename {
1.831 albertel 3271: my ($fname,$args)=@_;
1.315 www 3272: # Replace Windows backslashes by forward slashes
1.257 www 3273: $fname=~s/\\/\//g;
1.831 albertel 3274: if (!$args->{'keep_path'}) {
3275: # Get rid of everything but the actual filename
3276: $fname=~s/^.*\/([^\/]+)$/$1/;
3277: }
1.315 www 3278: # Replace spaces by underscores
3279: $fname=~s/\s+/\_/g;
3280: # Replace all other weird characters by nothing
1.831 albertel 3281: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 3282: # Replace all .\d. sequences with _\d. so they no longer look like version
3283: # numbers
3284: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 3285: return $fname;
3286: }
1.1051 raeburn 3287: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3288: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3289: # image with the same aspect ratio as the original, but with dimensions which do
3290: # not exceed $resizewidth and $resizeheight.
3291:
1.984 neumanie 3292: sub resizeImage {
1.1051 raeburn 3293: my ($img_path,$resizewidth,$resizeheight) = @_;
3294: my $ima = Image::Magick->new;
3295: my $resized;
3296: if (-e $img_path) {
3297: $ima->Read($img_path);
3298: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3299: my $width = $ima->Get('width');
3300: my $height = $ima->Get('height');
3301: if ($width > $resizewidth) {
3302: my $factor = $width/$resizewidth;
3303: my $newheight = $height/$factor;
3304: $ima->Scale(width=>$resizewidth,height=>$newheight);
3305: $resized = 1;
3306: }
3307: }
3308: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3309: my $width = $ima->Get('width');
3310: my $height = $ima->Get('height');
3311: if ($height > $resizeheight) {
3312: my $factor = $height/$resizeheight;
3313: my $newwidth = $width/$factor;
3314: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3315: $resized = 1;
3316: }
3317: }
3318: if ($resized) {
3319: $ima->Write($img_path);
3320: }
3321: }
3322: return;
1.977 amueller 3323: }
3324:
1.608 albertel 3325: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 3326: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 3327: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 3328: # $context - possible values: coursedoc, existingfile, overwrite,
3329: # canceloverwrite, or ''.
3330: # if 'coursedoc': upload to the current course
3331: # if 'existingfile': write file to tmp/overwrites directory
3332: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3333: # $context is passed as argument to &finishuserfileupload
1.686 albertel 3334: # $subdir - directory in userfile to store the file into
1.858 raeburn 3335: # $parser - instruction to parse file for objects ($parser = parse)
3336: # $allfiles - reference to hash for embedded objects
3337: # $codebase - reference to hash for codebase of java objects
3338: # $desuname - username for permanent storage of uploaded file
3339: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 3340: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3341: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 3342: # $resizewidth - width (pixels) to which to resize uploaded image
3343: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 3344: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 3345: # from File::MMagic.
1.858 raeburn 3346: #
1.686 albertel 3347: # output: url of file in userspace, or error: <message>
3348: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 3349:
1.531 albertel 3350: sub userfileupload {
1.1090 raeburn 3351: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 3352: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 3353: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 3354: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 3355: $fname=&clean_filename($fname);
1.1090 raeburn 3356: # See if there is anything left
1.257 www 3357: unless ($fname) { return 'error: no uploaded file'; }
1.1090 raeburn 3358: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3359: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3360: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3361: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 3362: my $now = time;
1.1090 raeburn 3363: my $filepath;
1.1095 raeburn 3364: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 3365: $filepath = 'tmp/helprequests/'.$now;
3366: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3367: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3368: '_'.$env{'user.domain'}.'/pending';
3369: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3370: my ($docuname,$docudom);
3371: if ($destudom) {
3372: $docudom = $destudom;
3373: } else {
3374: $docudom = $env{'user.domain'};
3375: }
3376: if ($destuname) {
3377: $docuname = $destuname;
3378: } else {
3379: $docuname = $env{'user.name'};
3380: }
3381: if (exists($env{'form.group'})) {
3382: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3383: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3384: }
3385: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3386: if ($context eq 'canceloverwrite') {
3387: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3388: if (-e $tempfile) {
3389: my @info = stat($tempfile);
3390: if ($info[9] eq $env{'form.timestamp'}) {
3391: unlink($tempfile);
3392: }
3393: }
3394: return;
1.523 raeburn 3395: }
3396: }
1.1090 raeburn 3397: # Create the directory if not present
1.741 raeburn 3398: my @parts=split(/\//,$filepath);
3399: my $fullpath = $perlvar{'lonDaemons'};
3400: for (my $i=0;$i<@parts;$i++) {
3401: $fullpath .= '/'.$parts[$i];
3402: if ((-e $fullpath)!=1) {
3403: mkdir($fullpath,0777);
3404: }
3405: }
3406: open(my $fh,'>'.$fullpath.'/'.$fname);
3407: print $fh $env{'form.'.$formname};
3408: close($fh);
1.1090 raeburn 3409: if ($context eq 'existingfile') {
3410: my @info = stat($fullpath.'/'.$fname);
3411: return ($fullpath.'/'.$fname,$info[9]);
3412: } else {
3413: return $fullpath.'/'.$fname;
3414: }
1.523 raeburn 3415: }
1.995 raeburn 3416: if ($subdir eq 'scantron') {
3417: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 3418: } else {
1.995 raeburn 3419: $fname="$subdir/$fname";
3420: }
1.1090 raeburn 3421: if ($context eq 'coursedoc') {
1.638 albertel 3422: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3423: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 3424: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 3425: return &finishuserfileupload($docuname,$docudom,
3426: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 3427: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 3428: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 3429: } else {
1.1172.2.21 raeburn 3430: if ($env{'form.folder'}) {
3431: $fname=$env{'form.folder'}.'/'.$fname;
3432: }
1.638 albertel 3433: return &process_coursefile('uploaddoc',$docuname,$docudom,
3434: $fname,$formname,$parser,
1.1095 raeburn 3435: $allfiles,$codebase,$mimetype);
1.481 raeburn 3436: }
1.719 banghart 3437: } elsif (defined($destuname)) {
3438: my $docuname=$destuname;
3439: my $docudom=$destudom;
1.860 raeburn 3440: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3441: $parser,$allfiles,$codebase,
1.1051 raeburn 3442: $thumbwidth,$thumbheight,
1.1095 raeburn 3443: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3444: } else {
1.638 albertel 3445: my $docuname=$env{'user.name'};
3446: my $docudom=$env{'user.domain'};
1.1172.2.23 raeburn 3447: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 3448: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3449: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3450: }
1.860 raeburn 3451: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3452: $parser,$allfiles,$codebase,
1.1051 raeburn 3453: $thumbwidth,$thumbheight,
1.1095 raeburn 3454: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3455: }
1.271 www 3456: }
3457:
3458: sub finishuserfileupload {
1.860 raeburn 3459: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 3460: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 3461: my $path=$docudom.'/'.$docuname.'/';
1.258 www 3462: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 3463:
1.860 raeburn 3464: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 3465: $file=$fname;
3466: if ($fname=~m|/|) {
3467: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3468: $path.=$fnamepath.'/';
3469: }
1.259 www 3470: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 3471: my $count;
3472: for ($count=4;$count<=$#parts;$count++) {
3473: $filepath.="/$parts[$count]";
3474: if ((-e $filepath)!=1) {
3475: mkdir($filepath,0777);
3476: }
3477: }
1.984 neumanie 3478:
1.258 www 3479: # Save the file
3480: {
1.701 albertel 3481: if (!open(FH,'>'.$filepath.'/'.$file)) {
3482: &logthis('Failed to create '.$filepath.'/'.$file);
3483: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3484: return '/adm/notfound.html';
3485: }
1.1090 raeburn 3486: if ($context eq 'overwrite') {
1.1117 foxr 3487: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 3488: my $target = $filepath.'/'.$file;
3489: if (-e $source) {
3490: my @info = stat($source);
3491: if ($info[9] eq $env{'form.timestamp'}) {
3492: unless (&File::Copy::move($source,$target)) {
3493: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3494: return "Moving from $source failed";
3495: }
3496: } else {
3497: return "Temporary file: $source had unexpected date/time for last modification";
3498: }
3499: } else {
3500: return "Temporary file: $source missing";
3501: }
3502: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 3503: &logthis('Failed to write to '.$filepath.'/'.$file);
3504: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3505: return '/adm/notfound.html';
3506: }
1.570 albertel 3507: close(FH);
1.1051 raeburn 3508: if ($resizewidth && $resizeheight) {
3509: my $mm = new File::MMagic;
3510: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3511: if ($mime_type =~ m{^image/}) {
3512: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3513: }
1.977 amueller 3514: }
1.258 www 3515: }
1.1152 raeburn 3516: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3517: if (ref($mimetype)) {
3518: if ($$mimetype eq '') {
3519: my $mm = new File::MMagic;
3520: my $type = $mm->checktype_filename($filepath.'/'.$file);
3521: $$mimetype = $type;
3522: }
3523: }
3524: }
1.637 raeburn 3525: if ($parser eq 'parse') {
1.1152 raeburn 3526: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 3527: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3528: $allfiles,$codebase);
3529: unless ($parse_result eq 'ok') {
3530: &logthis('Failed to parse '.$filepath.$file.
3531: ' for embedded media: '.$parse_result);
3532: }
1.637 raeburn 3533: }
3534: }
1.860 raeburn 3535: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3536: my $input = $filepath.'/'.$file;
3537: my $output = $filepath.'/'.'tn-'.$file;
3538: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3539: system("convert -sample $thumbsize $input $output");
3540: if (-e $filepath.'/'.'tn-'.$file) {
3541: $fetchthumb = 1;
3542: }
3543: }
1.858 raeburn 3544:
1.259 www 3545: # Notify homeserver to grep it
3546: #
1.984 neumanie 3547: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 3548: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 3549: if ($fetchresult eq 'ok') {
1.860 raeburn 3550: if ($fetchthumb) {
3551: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3552: if ($thumbresult ne 'ok') {
3553: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3554: $docuhome.': '.$thumbresult);
3555: }
3556: }
1.259 www 3557: #
1.258 www 3558: # Return the URL to it
1.494 albertel 3559: return '/uploaded/'.$path.$file;
1.263 www 3560: } else {
1.494 albertel 3561: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3562: ': '.$fetchresult);
1.263 www 3563: return '/adm/notfound.html';
1.858 raeburn 3564: }
1.493 albertel 3565: }
3566:
1.637 raeburn 3567: sub extract_embedded_items {
1.961 raeburn 3568: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 3569: my @state = ();
1.1164 raeburn 3570: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 3571: my %javafiles = (
3572: codebase => '',
3573: code => '',
3574: archive => ''
3575: );
3576: my %mediafiles = (
3577: src => '',
3578: movie => '',
3579: );
1.648 raeburn 3580: my $p;
3581: if ($content) {
3582: $p = HTML::LCParser->new($content);
3583: } else {
1.961 raeburn 3584: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 3585: }
1.641 albertel 3586: while (my $t=$p->get_token()) {
1.640 albertel 3587: if ($t->[0] eq 'S') {
3588: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 3589: push(@state, $tagname);
1.648 raeburn 3590: if (lc($tagname) eq 'allow') {
3591: &add_filetype($allfiles,$attr->{'src'},'src');
3592: }
1.640 albertel 3593: if (lc($tagname) eq 'img') {
3594: &add_filetype($allfiles,$attr->{'src'},'src');
3595: }
1.886 albertel 3596: if (lc($tagname) eq 'a') {
1.1172.2.24 raeburn 3597: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
3598: &add_filetype($allfiles,$attr->{'href'},'href');
3599: }
1.886 albertel 3600: }
1.645 raeburn 3601: if (lc($tagname) eq 'script') {
1.1164 raeburn 3602: my $src;
1.645 raeburn 3603: if ($attr->{'archive'} =~ /\.jar$/i) {
3604: &add_filetype($allfiles,$attr->{'archive'},'archive');
3605: } else {
1.1164 raeburn 3606: if ($attr->{'src'} ne '') {
3607: $src = $attr->{'src'};
3608: &add_filetype($allfiles,$src,'src');
3609: }
3610: }
3611: my $text = $p->get_trimmed_text();
3612: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3613: my @swfargs = split(/,/,$1);
3614: foreach my $item (@swfargs) {
3615: $item =~ s/["']//g;
3616: $item =~ s/^\s+//;
3617: $item =~ s/\s+$//;
3618: }
3619: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3620: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3621: push(@{$related{$swfargs[0]}},$swfargs[2]);
3622: } else {
3623: $related{$swfargs[0]} = [$swfargs[2]];
3624: }
3625: }
1.645 raeburn 3626: }
3627: }
3628: if (lc($tagname) eq 'link') {
3629: if (lc($attr->{'rel'}) eq 'stylesheet') {
3630: &add_filetype($allfiles,$attr->{'href'},'href');
3631: }
3632: }
1.640 albertel 3633: if (lc($tagname) eq 'object' ||
3634: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3635: foreach my $item (keys(%javafiles)) {
3636: $javafiles{$item} = '';
3637: }
1.1164 raeburn 3638: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3639: $lastids{lc($tagname)} = $attr->{'id'};
3640: }
1.640 albertel 3641: }
3642: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3643: my $name = lc($attr->{'name'});
3644: foreach my $item (keys(%javafiles)) {
3645: if ($name eq $item) {
3646: $javafiles{$item} = $attr->{'value'};
3647: last;
3648: }
3649: }
1.1164 raeburn 3650: my $pathfrom;
1.640 albertel 3651: foreach my $item (keys(%mediafiles)) {
3652: if ($name eq $item) {
1.1164 raeburn 3653: $pathfrom = $attr->{'value'};
3654: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3655: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 3656: last;
3657: }
3658: }
1.1164 raeburn 3659: if ($name eq 'flashvars') {
3660: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3661: }
3662: if ($pathfrom ne '') {
3663: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3664: $pathfrom);
3665: }
1.640 albertel 3666: }
3667: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3668: foreach my $item (keys(%javafiles)) {
3669: if ($attr->{$item}) {
3670: $javafiles{$item} = $attr->{$item};
3671: last;
3672: }
3673: }
3674: foreach my $item (keys(%mediafiles)) {
3675: if ($attr->{$item}) {
3676: &add_filetype($allfiles,$attr->{$item},$item);
3677: last;
3678: }
3679: }
1.1164 raeburn 3680: if (lc($tagname) eq 'embed') {
3681: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3682: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3683: $attr->{'src'});
3684: }
3685: }
1.640 albertel 3686: }
1.1172.2.35 raeburn 3687: if (lc($tagname) eq 'iframe') {
3688: my $src = $attr->{'src'} ;
3689: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
3690: &add_filetype($allfiles,$src,'src');
3691: } elsif ($src =~ m{^/}) {
3692: if ($env{'request.course.id'}) {
3693: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3694: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3695: my $url = &hreflocation('',$fullpath);
3696: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
3697: my $relpath = $1;
3698: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
3699: &add_filetype($allfiles,$1,'src');
3700: }
3701: }
3702: }
3703: }
3704: }
1.1164 raeburn 3705: if ($t->[4] =~ m{/>$}) {
1.1172.2.35 raeburn 3706: pop(@state);
1.1164 raeburn 3707: }
1.640 albertel 3708: } elsif ($t->[0] eq 'E') {
3709: my ($tagname) = ($t->[1]);
3710: if ($javafiles{'codebase'} ne '') {
3711: $javafiles{'codebase'} .= '/';
3712: }
3713: if (lc($tagname) eq 'applet' ||
3714: lc($tagname) eq 'object' ||
3715: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3716: ) {
3717: foreach my $item (keys(%javafiles)) {
3718: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3719: my $file=$javafiles{'codebase'}.$javafiles{$item};
3720: &add_filetype($allfiles,$file,$item);
3721: }
3722: }
3723: }
3724: pop @state;
3725: }
3726: }
1.1164 raeburn 3727: foreach my $id (sort(keys(%flashvars))) {
3728: if ($shockwave{$id} ne '') {
3729: my @pairs = split(/\&/,$flashvars{$id});
3730: foreach my $pair (@pairs) {
3731: my ($key,$value) = split(/\=/,$pair);
3732: if ($key eq 'thumb') {
3733: &add_filetype($allfiles,$value,$key);
3734: } elsif ($key eq 'content') {
3735: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3736: my ($ext) = ($value =~ /\.([^.]+)$/);
3737: if ($ext ne '') {
3738: &add_filetype($allfiles,$path.$value,$ext);
3739: }
3740: }
3741: }
3742: }
3743: }
1.637 raeburn 3744: return 'ok';
3745: }
3746:
1.639 albertel 3747: sub add_filetype {
3748: my ($allfiles,$file,$type)=@_;
3749: if (exists($allfiles->{$file})) {
3750: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3751: push(@{$allfiles->{$file}}, &escape($type));
3752: }
3753: } else {
3754: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 3755: }
3756: }
3757:
1.1164 raeburn 3758: sub embedded_dependency {
3759: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3760: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3761: if (($identifier ne '') &&
3762: (ref($related->{$identifier}) eq 'ARRAY') &&
3763: ($pathfrom ne '')) {
3764: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3765: foreach my $dep (@{$related->{$identifier}}) {
3766: &add_filetype($allfiles,$path.$dep,'object');
3767: }
3768: }
3769: }
3770: return;
3771: }
3772:
1.493 albertel 3773: sub removeuploadedurl {
1.984 neumanie 3774: my ($url)=@_;
3775: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 3776: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 3777: }
3778:
3779: sub removeuserfile {
3780: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 3781: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3782: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 3783: if ($result eq 'ok') {
1.798 raeburn 3784: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3785: my $metafile = $fname.'.meta';
3786: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 3787: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 3788: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3789: my $sqlresult =
1.823 albertel 3790: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3791: 'portfolio_metadata',$group,
3792: 'delete');
1.798 raeburn 3793: }
3794: }
3795: return $result;
1.257 www 3796: }
1.15 www 3797:
1.530 albertel 3798: sub mkdiruserfile {
3799: my ($docuname,$docudom,$dir)=@_;
3800: my $home=&homeserver($docuname,$docudom);
3801: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3802: }
3803:
1.531 albertel 3804: sub renameuserfile {
3805: my ($docuname,$docudom,$old,$new)=@_;
3806: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3807: my $result = &reply("renameuserfile:$docudom:$docuname:".
3808: &escape("$old").':'.&escape("$new"),$home);
3809: if ($result eq 'ok') {
3810: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3811: my $oldmeta = $old.'.meta';
3812: my $newmeta = $new.'.meta';
3813: my $metaresult =
3814: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 3815: my $url = "/uploaded/$docudom/$docuname/$old";
3816: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3817: my $sqlresult =
1.823 albertel 3818: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3819: 'portfolio_metadata',$group,
3820: 'delete');
1.798 raeburn 3821: }
3822: }
3823: return $result;
1.531 albertel 3824: }
3825:
1.14 www 3826: # ------------------------------------------------------------------------- Log
3827:
3828: sub log {
3829: my ($dom,$nam,$hom,$what)=@_;
1.47 www 3830: return critical("log:$dom:$nam:$what",$hom);
1.157 www 3831: }
3832:
3833: # ------------------------------------------------------------------ Course Log
1.352 www 3834: #
3835: # This routine flushes several buffers of non-mission-critical nature
3836: #
1.157 www 3837:
3838: sub flushcourselogs {
1.352 www 3839: &logthis('Flushing log buffers');
3840: #
3841: # course logs
3842: # This is a log of all transactions in a course, which can be used
3843: # for data mining purposes
3844: #
3845: # It also collects the courseid database, which lists last transaction
3846: # times and course titles for all courseids
3847: #
3848: my %courseidbuffer=();
1.921 raeburn 3849: foreach my $crsid (keys(%courselogs)) {
1.352 www 3850: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 3851: &escape($courselogs{$crsid}),
3852: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 3853: delete $courselogs{$crsid};
3854: } else {
3855: &logthis('Failed to flush log buffer for '.$crsid);
3856: if (length($courselogs{$crsid})>40000) {
1.672 albertel 3857: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 3858: " exceeded maximum size, deleting.</font>");
3859: delete $courselogs{$crsid};
3860: }
1.352 www 3861: }
1.920 raeburn 3862: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 3863: 'description' => $coursedescrbuf{$crsid},
3864: 'inst_code' => $courseinstcodebuf{$crsid},
3865: 'type' => $coursetypebuf{$crsid},
3866: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 3867: };
1.191 harris41 3868: }
1.352 www 3869: #
3870: # Write course id database (reverse lookup) to homeserver of courses
3871: # Is used in pickcourse
3872: #
1.840 albertel 3873: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 3874: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 3875: $courseidbuffer{$crs_home},
3876: $crs_home,'timeonly');
1.352 www 3877: }
3878: #
3879: # File accesses
3880: # Writes to the dynamic metadata of resources to get hit counts, etc.
3881: #
1.449 matthew 3882: foreach my $entry (keys(%accesshash)) {
1.458 matthew 3883: if ($entry =~ /___count$/) {
3884: my ($dom,$name);
1.807 albertel 3885: ($dom,$name,undef)=
1.811 albertel 3886: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 3887: if (! defined($dom) || $dom eq '' ||
3888: ! defined($name) || $name eq '') {
1.620 albertel 3889: my $cid = $env{'request.course.id'};
3890: $dom = $env{'request.'.$cid.'.domain'};
3891: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 3892: }
1.450 matthew 3893: my $value = $accesshash{$entry};
3894: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3895: my %temphash=($url => $value);
1.449 matthew 3896: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3897: if ($result eq 'ok') {
3898: delete $accesshash{$entry};
3899: }
3900: } else {
1.811 albertel 3901: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 3902: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 3903: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 3904: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3905: delete $accesshash{$entry};
3906: }
1.185 www 3907: }
1.191 harris41 3908: }
1.352 www 3909: #
3910: # Roles
3911: # Reverse lookup of user roles for course faculty/staff and co-authorship
3912: #
1.800 albertel 3913: foreach my $entry (keys(%userrolehash)) {
1.351 www 3914: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 3915: split(/\:/,$entry);
3916: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 3917: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 3918: $rudom,$runame) eq 'ok') {
3919: delete $userrolehash{$entry};
3920: }
3921: }
1.662 raeburn 3922: #
1.1172.2.90 raeburn 3923: # Reverse lookup of domain roles (dc, ad, li, sc, dh, da, au)
1.662 raeburn 3924: #
3925: my %domrolebuffer = ();
1.1000 raeburn 3926: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 3927: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 3928: if ($domrolebuffer{$rudom}) {
3929: $domrolebuffer{$rudom}.='&'.&escape($entry).
3930: '='.&escape($domainrolehash{$entry});
3931: } else {
3932: $domrolebuffer{$rudom}.=&escape($entry).
3933: '='.&escape($domainrolehash{$entry});
3934: }
3935: delete $domainrolehash{$entry};
3936: }
3937: foreach my $dom (keys(%domrolebuffer)) {
1.1172.2.82 raeburn 3938: my %servers;
3939: if (defined(&domain($dom,'primary'))) {
3940: my $primary=&domain($dom,'primary');
3941: my $hostname=&hostname($primary);
3942: $servers{$primary} = $hostname;
3943: } else {
3944: %servers = &get_servers($dom,'library');
3945: }
1.841 albertel 3946: foreach my $tryserver (keys(%servers)) {
1.1172.2.82 raeburn 3947: if (&reply('domroleput:'.$dom.':'.
3948: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3949: last;
3950: } else {
1.841 albertel 3951: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3952: }
1.662 raeburn 3953: }
3954: }
1.186 www 3955: $dumpcount++;
1.157 www 3956: }
3957:
3958: sub courselog {
3959: my $what=shift;
1.158 www 3960: $what=time.':'.$what;
1.620 albertel 3961: unless ($env{'request.course.id'}) { return ''; }
3962: $coursedombuf{$env{'request.course.id'}}=
3963: $env{'course.'.$env{'request.course.id'}.'.domain'};
3964: $coursenumbuf{$env{'request.course.id'}}=
3965: $env{'course.'.$env{'request.course.id'}.'.num'};
3966: $coursehombuf{$env{'request.course.id'}}=
3967: $env{'course.'.$env{'request.course.id'}.'.home'};
3968: $coursedescrbuf{$env{'request.course.id'}}=
3969: $env{'course.'.$env{'request.course.id'}.'.description'};
3970: $courseinstcodebuf{$env{'request.course.id'}}=
3971: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3972: $courseownerbuf{$env{'request.course.id'}}=
3973: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 3974: $coursetypebuf{$env{'request.course.id'}}=
3975: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 3976: if (defined $courselogs{$env{'request.course.id'}}) {
3977: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 3978: } else {
1.620 albertel 3979: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 3980: }
1.620 albertel 3981: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 3982: &flushcourselogs();
3983: }
1.158 www 3984: }
3985:
3986: sub courseacclog {
3987: my $fnsymb=shift;
1.620 albertel 3988: unless ($env{'request.course.id'}) { return ''; }
3989: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 3990: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 3991: $what.=':POST';
1.583 matthew 3992: # FIXME: Probably ought to escape things....
1.800 albertel 3993: foreach my $key (keys(%env)) {
3994: if ($key=~/^form\.(.*)/) {
1.975 raeburn 3995: my $formitem = $1;
3996: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3997: $what.=':'.$formitem.'='.$env{$key};
3998: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3999: $what.=':'.$formitem.'='.$env{$key};
4000: }
1.158 www 4001: }
1.191 harris41 4002: }
1.583 matthew 4003: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
4004: # FIXME: We should not be depending on a form parameter that someone
4005: # editing lonsearchcat.pm might change in the future.
1.620 albertel 4006: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 4007: $what.= ':POST';
4008: # FIXME: Probably ought to escape things....
4009: foreach my $element ('courseexp','crsfulltext','crsrelated',
4010: 'crsdiscuss') {
1.620 albertel 4011: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 4012: }
4013: }
1.158 www 4014: }
4015: &courselog($what);
1.149 www 4016: }
4017:
1.185 www 4018: sub countacc {
4019: my $url=&declutter(shift);
1.458 matthew 4020: return if (! defined($url) || $url eq '');
1.620 albertel 4021: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 4022: #
4023: # Mark that this url was used in this course
4024: #
1.620 albertel 4025: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 4026: #
4027: # Increase the access count for this resource in this child process
4028: #
1.281 www 4029: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 4030: $accesshash{$key}++;
1.185 www 4031: }
1.349 www 4032:
1.361 www 4033: sub linklog {
4034: my ($from,$to)=@_;
4035: $from=&declutter($from);
4036: $to=&declutter($to);
4037: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4038: $accesshash{$to.'___'.$from.'___goto'}=1;
4039: }
1.1160 www 4040:
4041: sub statslog {
4042: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4043: if ($users<2) { return; }
4044: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4045: 'course' => $env{'request.course.id'},
4046: 'sections' => '"all"',
4047: 'num_students' => $users,
4048: 'part' => $part,
4049: 'symb' => $symb,
4050: 'mean_tries' => $av_attempts,
4051: 'deg_of_diff' => $degdiff});
4052: foreach my $key (keys(%dynstore)) {
4053: $accesshash{$key}=$dynstore{$key};
4054: }
4055: }
1.361 www 4056:
1.349 www 4057: sub userrolelog {
4058: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 4059: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 4060: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4061: $userrolehash
4062: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 4063: =$tend.':'.$tstart;
1.662 raeburn 4064: }
1.1169 droeschl 4065: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 4066: $userrolehash
4067: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4068: =$tend.':'.$tstart;
4069: }
1.1172.2.90 raeburn 4070: if ($trole =~ /^(dc|ad|li|au|dg|sc|dh|da)/ ) {
1.662 raeburn 4071: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4072: $domainrolehash
4073: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4074: = $tend.':'.$tstart;
4075: }
1.351 www 4076: }
4077:
1.957 raeburn 4078: sub courserolelog {
4079: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1172.2.9 raeburn 4080: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4081: my $cdom = $1;
4082: my $cnum = $2;
4083: my $sec = $3;
4084: my $namespace = 'rolelog';
4085: my %storehash = (
4086: role => $trole,
4087: start => $tstart,
4088: end => $tend,
4089: selfenroll => $selfenroll,
4090: context => $context,
4091: );
4092: if ($trole eq 'gr') {
4093: $namespace = 'groupslog';
4094: $storehash{'group'} = $sec;
4095: } else {
4096: $storehash{'section'} = $sec;
4097: }
4098: &write_log('course',$namespace,\%storehash,$delflag,$username,
4099: $domain,$cnum,$cdom);
4100: if (($trole ne 'st') || ($sec ne '')) {
4101: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 4102: }
4103: }
4104: return;
4105: }
4106:
1.1172.2.9 raeburn 4107: sub domainrolelog {
4108: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4109: if ($area =~ m{^/($match_domain)/$}) {
4110: my $cdom = $1;
4111: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4112: my $namespace = 'rolelog';
4113: my %storehash = (
4114: role => $trole,
4115: start => $tstart,
4116: end => $tend,
4117: context => $context,
4118: );
4119: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4120: $domain,$domconfiguser,$cdom);
4121: }
4122: return;
4123:
4124: }
4125:
4126: sub coauthorrolelog {
4127: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4128: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4129: my $audom = $1;
4130: my $auname = $2;
4131: my $namespace = 'rolelog';
4132: my %storehash = (
4133: role => $trole,
4134: start => $tstart,
4135: end => $tend,
4136: context => $context,
4137: );
4138: &write_log('author',$namespace,\%storehash,$delflag,$username,
4139: $domain,$auname,$audom);
4140: }
4141: return;
4142: }
4143:
1.351 www 4144: sub get_course_adv_roles {
1.948 raeburn 4145: my ($cid,$codes) = @_;
1.620 albertel 4146: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 4147: my %coursehash=&coursedescription($cid);
1.988 raeburn 4148: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 4149: my %nothide=();
1.800 albertel 4150: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 4151: if ($user !~ /:/) {
4152: $nothide{join(':',split(/[\@]/,$user))}=1;
4153: } else {
4154: $nothide{$user}=1;
4155: }
1.470 www 4156: }
1.1172.2.23 raeburn 4157: my @possdoms = ($coursehash{'domain'});
4158: if ($coursehash{'checkforpriv'}) {
4159: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4160: }
1.351 www 4161: my %returnhash=();
4162: my %dumphash=
4163: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4164: my $now=time;
1.997 raeburn 4165: my %privileged;
1.1000 raeburn 4166: foreach my $entry (keys(%dumphash)) {
1.800 albertel 4167: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 4168: if (($tstart) && ($tstart<0)) { next; }
4169: if (($tend) && ($tend<$now)) { next; }
4170: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 4171: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 4172: if ($username eq '' || $domain eq '') { next; }
1.1172.2.23 raeburn 4173: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 4174: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 4175: if ($role eq 'cr') { next; }
1.948 raeburn 4176: if ($codes) {
4177: if ($section) { $role .= ':'.$section; }
4178: if ($returnhash{$role}) {
4179: $returnhash{$role}.=','.$username.':'.$domain;
4180: } else {
4181: $returnhash{$role}=$username.':'.$domain;
4182: }
1.351 www 4183: } else {
1.988 raeburn 4184: my $key=&plaintext($role,$crstype);
1.973 bisitz 4185: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 4186: if ($returnhash{$key}) {
4187: $returnhash{$key}.=','.$username.':'.$domain;
4188: } else {
4189: $returnhash{$key}=$username.':'.$domain;
4190: }
1.351 www 4191: }
1.948 raeburn 4192: }
1.400 www 4193: return %returnhash;
4194: }
4195:
4196: sub get_my_roles {
1.937 raeburn 4197: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 4198: unless (defined($uname)) { $uname=$env{'user.name'}; }
4199: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 4200: my (%dumphash,%nothide);
1.1086 raeburn 4201: if ($context eq 'userroles') {
1.1166 raeburn 4202: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 4203: } else {
1.1172.2.23 raeburn 4204: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 4205: if ($hidepriv) {
4206: my %coursehash=&coursedescription($udom.'_'.$uname);
4207: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4208: if ($user !~ /:/) {
4209: $nothide{join(':',split(/[\@]/,$user))} = 1;
4210: } else {
4211: $nothide{$user} = 1;
4212: }
4213: }
4214: }
1.858 raeburn 4215: }
1.400 www 4216: my %returnhash=();
4217: my $now=time;
1.999 raeburn 4218: my %privileged;
1.800 albertel 4219: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 4220: my ($role,$tend,$tstart);
4221: if ($context eq 'userroles') {
1.1149 raeburn 4222: next if ($entry =~ /^rolesdef/);
1.867 raeburn 4223: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4224: } else {
4225: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4226: }
1.400 www 4227: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 4228: my $status = 'active';
1.939 raeburn 4229: if (($tend) && ($tend<=$now)) {
1.832 raeburn 4230: $status = 'previous';
4231: }
4232: if (($tstart) && ($now<$tstart)) {
4233: $status = 'future';
4234: }
4235: if (ref($types) eq 'ARRAY') {
4236: if (!grep(/^\Q$status\E$/,@{$types})) {
4237: next;
4238: }
4239: } else {
4240: if ($status ne 'active') {
4241: next;
4242: }
4243: }
1.867 raeburn 4244: my ($rolecode,$username,$domain,$section,$area);
4245: if ($context eq 'userroles') {
1.1172.2.9 raeburn 4246: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 4247: (undef,$domain,$username,$section) = split(/\//,$area);
4248: } else {
4249: ($role,$username,$domain,$section) = split(/\:/,$entry);
4250: }
1.832 raeburn 4251: if (ref($roledoms) eq 'ARRAY') {
4252: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4253: next;
4254: }
4255: }
4256: if (ref($roles) eq 'ARRAY') {
4257: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 4258: if ($role =~ /^cr\//) {
4259: if (!grep(/^cr$/,@{$roles})) {
4260: next;
4261: }
1.1104 raeburn 4262: } elsif ($role =~ /^gr\//) {
4263: if (!grep(/^gr$/,@{$roles})) {
4264: next;
4265: }
1.922 raeburn 4266: } else {
4267: next;
4268: }
1.832 raeburn 4269: }
1.867 raeburn 4270: }
1.937 raeburn 4271: if ($hidepriv) {
1.1172.2.23 raeburn 4272: my @privroles = ('dc','su');
1.999 raeburn 4273: if ($context eq 'userroles') {
1.1172.2.23 raeburn 4274: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 4275: } else {
1.1172.2.23 raeburn 4276: my $possdoms = [$domain];
4277: if (ref($roledoms) eq 'ARRAY') {
4278: push(@{$possdoms},@{$roledoms});
1.999 raeburn 4279: }
1.1172.2.23 raeburn 4280: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 4281: if (!$nothide{$username.':'.$domain}) {
4282: next;
4283: }
4284: }
1.937 raeburn 4285: }
4286: }
1.933 raeburn 4287: if ($withsec) {
4288: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4289: $tstart.':'.$tend;
4290: } else {
4291: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4292: }
1.832 raeburn 4293: }
1.373 www 4294: return %returnhash;
1.399 www 4295: }
4296:
1.1172.2.89 raeburn 4297: sub get_all_adhocroles {
4298: my ($dom) = @_;
4299: my @roles_by_num = ();
4300: my %domdefaults = &get_domain_defaults($dom);
4301: my (%description,%access_in_dom,%access_info);
4302: if (ref($domdefaults{'adhocroles'}) eq 'HASH') {
4303: my $count = 0;
4304: my %domcurrent = %{$domdefaults{'adhocroles'}};
4305: my %ordered;
4306: foreach my $role (sort(keys(%domcurrent))) {
4307: my ($order,$desc,$access_in_dom);
4308: if (ref($domcurrent{$role}) eq 'HASH') {
4309: $order = $domcurrent{$role}{'order'};
4310: $desc = $domcurrent{$role}{'desc'};
4311: $access_in_dom{$role} = $domcurrent{$role}{'access'};
4312: $access_info{$role} = $domcurrent{$role}{$access_in_dom{$role}};
4313: }
4314: if ($order eq '') {
4315: $order = $count;
4316: }
4317: $ordered{$order} = $role;
4318: if ($desc ne '') {
4319: $description{$role} = $desc;
4320: } else {
4321: $description{$role}= $role;
4322: }
4323: $count++;
4324: }
4325: foreach my $item (sort {$a <=> $b } (keys(%ordered))) {
4326: push(@roles_by_num,$ordered{$item});
4327: }
4328: }
4329: return (\@roles_by_num,\%description,\%access_in_dom,\%access_info);
4330: }
4331:
4332: sub get_my_adhocroles {
4333: my ($cid,$checkreg) = @_;
4334: my ($cdom,$cnum,%info,@possroles,$description,$roles_by_num);
4335: if ($env{'request.course.id'} eq $cid) {
4336: $cdom = $env{'course.'.$cid.'.domain'};
4337: $cnum = $env{'course.'.$cid.'.num'};
4338: $info{'internal.coursecode'} = $env{'course.'.$cid.'.internal.coursecode'};
4339: } elsif ($cid =~ /^($match_domain)_($match_courseid)$/) {
4340: $cdom = $1;
4341: $cnum = $2;
4342: %info = &Apache::lonnet::get('environment',['internal.coursecode'],
4343: $cdom,$cnum);
4344: }
4345: if (($info{'internal.coursecode'} ne '') && ($checkreg)) {
4346: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4347: my %rosterhash = &get('classlist',[$user],$cdom,$cnum);
4348: if ($rosterhash{$user} ne '') {
4349: my $type = (split(/:/,$rosterhash{$user}))[5];
4350: return ([],{}) if ($type eq 'auto');
4351: }
4352: }
4353: if (($cdom ne '') && ($cnum ne '')) {
1.1172.2.90 raeburn 4354: if (($env{"user.role.dh./$cdom/"}) || ($env{"user.role.da./$cdom/"})) {
1.1172.2.89 raeburn 4355: my $then=$env{'user.login.time'};
4356: my $update=$env{'user.update.time'};
1.1172.2.90 raeburn 4357: if (!$update) {
4358: $update = $then;
4359: }
4360: my @liveroles;
4361: foreach my $role ('dh','da') {
4362: if ($env{"user.role.$role./$cdom/"}) {
4363: my ($tstart,$tend)=split(/\./,$env{"user.role.$role./$cdom/"});
4364: my $limit = $update;
4365: if ($env{'request.role'} eq "$role./$cdom/") {
4366: $limit = $then;
4367: }
4368: my $activerole = 1;
4369: if ($tstart && $tstart>$limit) { $activerole = 0; }
4370: if ($tend && $tend <$limit) { $activerole = 0; }
4371: if ($activerole) {
4372: push(@liveroles,$role);
4373: }
4374: }
4375: }
4376: if (@liveroles) {
1.1172.2.89 raeburn 4377: if (&homeserver($cnum,$cdom) ne 'no_host') {
4378: my ($accessref,$accessinfo,%access_in_dom);
4379: ($roles_by_num,$description,$accessref,$accessinfo) = &get_all_adhocroles($cdom);
4380: if (ref($roles_by_num) eq 'ARRAY') {
4381: if (@{$roles_by_num}) {
4382: my %settings;
4383: if ($env{'request.course.id'} eq $cid) {
4384: foreach my $envkey (keys(%env)) {
4385: if ($envkey =~ /^\Qcourse.$cid.\E(internal\.adhoc.+)$/) {
4386: $settings{$1} = $env{$envkey};
4387: }
4388: }
4389: } else {
4390: %settings = &dump('environment',$cdom,$cnum,'internal\.adhoc');
4391: }
4392: my %setincrs;
4393: if ($settings{'internal.adhocaccess'}) {
4394: map { $setincrs{$_} = 1; } split(/,/,$settings{'internal.adhocaccess'});
4395: }
4396: my @statuses;
4397: if ($env{'environment.inststatus'}) {
4398: @statuses = split(/,/,$env{'environment.inststatus'});
4399: }
4400: my $user = $env{'user.name'}.':'.$env{'user.domain'};
4401: if (ref($accessref) eq 'HASH') {
4402: %access_in_dom = %{$accessref};
4403: }
4404: foreach my $role (@{$roles_by_num}) {
4405: my ($curraccess,@okstatus,@personnel);
4406: if ($setincrs{$role}) {
4407: ($curraccess,my $rest) = split(/=/,$settings{'internal.adhoc.'.$role});
4408: if ($curraccess eq 'status') {
4409: @okstatus = split(/\&/,$rest);
4410: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4411: @personnel = split(/\&/,$rest);
4412: }
4413: } else {
4414: $curraccess = $access_in_dom{$role};
4415: if (ref($accessinfo) eq 'HASH') {
4416: if ($curraccess eq 'status') {
4417: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4418: @okstatus = @{$accessinfo->{$role}};
4419: }
4420: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4421: if (ref($accessinfo->{$role}) eq 'ARRAY') {
4422: @personnel = @{$accessinfo->{$role}};
4423: }
4424: }
4425: }
4426: }
4427: if ($curraccess eq 'none') {
4428: next;
4429: } elsif ($curraccess eq 'all') {
4430: push(@possroles,$role);
1.1172.2.90 raeburn 4431: } elsif ($curraccess eq 'dh') {
4432: if (grep(/^dh$/,@liveroles)) {
4433: push(@possroles,$role);
4434: } else {
4435: next;
4436: }
4437: } elsif ($curraccess eq 'da') {
4438: if (grep(/^da$/,@liveroles)) {
4439: push(@possroles,$role);
4440: } else {
4441: next;
4442: }
1.1172.2.89 raeburn 4443: } elsif ($curraccess eq 'status') {
4444: if (@okstatus) {
4445: if (!@statuses) {
4446: if (grep(/^default$/,@okstatus)) {
4447: push(@possroles,$role);
4448: }
4449: } else {
4450: foreach my $status (@okstatus) {
4451: if (grep(/^\Q$status\E$/,@statuses)) {
4452: push(@possroles,$role);
4453: last;
4454: }
4455: }
4456: }
4457: }
4458: } elsif (($curraccess eq 'exc') || ($curraccess eq 'inc')) {
4459: if (grep(/^\Q$user\E$/,@personnel)) {
4460: if ($curraccess eq 'exc') {
4461: push(@possroles,$role);
4462: }
4463: } elsif ($curraccess eq 'inc') {
4464: push(@possroles,$role);
4465: }
4466: }
4467: }
4468: }
4469: }
4470: }
4471: }
4472: }
4473: }
4474: unless (ref($description) eq 'HASH') {
4475: if (ref($roles_by_num) eq 'ARRAY') {
4476: my %desc;
4477: map { $desc{$_} = $_; } (@{$roles_by_num});
4478: $description = \%desc;
4479: } else {
4480: $description = {};
4481: }
4482: }
4483: return (\@possroles,$description);
4484: }
4485:
1.399 www 4486: # ----------------------------------------------------- Frontpage Announcements
4487: #
4488: #
4489:
4490: sub postannounce {
4491: my ($server,$text)=@_;
1.844 albertel 4492: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 4493: unless ($text=~/\w/) { $text=''; }
4494: return &reply('setannounce:'.&escape($text),$server);
4495: }
4496:
4497: sub getannounce {
1.448 albertel 4498:
4499: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 4500: my $announcement='';
1.800 albertel 4501: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 4502: close($fh);
1.399 www 4503: if ($announcement=~/\w/) {
4504: return
4505: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 4506: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 4507: } else {
4508: return '';
4509: }
4510: } else {
4511: return '';
4512: }
1.351 www 4513: }
1.353 www 4514:
4515: # ---------------------------------------------------------- Course ID routines
4516: # Deal with domain's nohist_courseid.db files
4517: #
4518:
4519: sub courseidput {
1.921 raeburn 4520: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 4521: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 4522: my $outcome;
4523: if ($caller eq 'timeonly') {
4524: my $cids = '';
4525: foreach my $item (keys(%$storehash)) {
4526: $cids.=&escape($item).'&';
4527: }
4528: $cids=~s/\&$//;
4529: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4530: $coursehome);
4531: } else {
4532: my $items = '';
4533: foreach my $item (keys(%$storehash)) {
4534: $items.= &escape($item).'='.
4535: &freeze_escape($$storehash{$item}).'&';
4536: }
4537: $items=~s/\&$//;
4538: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4539: $coursehome);
1.918 raeburn 4540: }
4541: if ($outcome eq 'unknown_cmd') {
4542: my $what;
4543: foreach my $cid (keys(%$storehash)) {
4544: $what .= &escape($cid).'=';
1.921 raeburn 4545: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 4546: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 4547: }
4548: $what =~ s/\:$/&/;
4549: }
4550: $what =~ s/\&$//;
4551: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4552: } else {
4553: return $outcome;
4554: }
1.353 www 4555: }
4556:
4557: sub courseiddump {
1.921 raeburn 4558: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 4559: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 4560: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1172.2.38 raeburn 4561: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1172.2.68 raeburn 4562: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 4563: my $as_hash = 1;
4564: my %returnhash;
4565: if (!$domfilter) { $domfilter=''; }
1.845 albertel 4566: my %libserv = &all_library();
4567: foreach my $tryserver (keys(%libserv)) {
4568: if ( ( $hostidflag == 1
4569: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4570: || (!defined($hostidflag)) ) {
4571:
1.918 raeburn 4572: if (($domfilter eq '') ||
4573: (&host_domain($tryserver) eq $domfilter)) {
1.1172.2.22 raeburn 4574: my $rep;
4575: if (grep { $_ eq $tryserver } ¤t_machine_ids()) {
4576: $rep = &LONCAPA::Lond::dump_course_id_handler(
4577: join(":", (&host_domain($tryserver), $sincefilter,
4578: &escape($descfilter), &escape($instcodefilter),
4579: &escape($ownerfilter), &escape($coursefilter),
4580: &escape($typefilter), &escape($regexp_ok),
4581: $as_hash, &escape($selfenrollonly),
4582: &escape($catfilter), $showhidden, $caller,
4583: &escape($cloner), &escape($cc_clone), $cloneonly,
4584: &escape($createdbefore), &escape($createdafter),
1.1172.2.68 raeburn 4585: &escape($creationcontext),$domcloner,$hasuniquecode,
4586: $reqcrsdom,&escape($reqinstcode))));
1.1172.2.22 raeburn 4587: } else {
4588: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4589: $sincefilter.':'.&escape($descfilter).':'.
4590: &escape($instcodefilter).':'.&escape($ownerfilter).
4591: ':'.&escape($coursefilter).':'.&escape($typefilter).
4592: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4593: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4594: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4595: &escape($cc_clone).':'.$cloneonly.':'.
4596: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1172.2.68 raeburn 4597: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
4598: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1172.2.22 raeburn 4599: }
4600:
1.918 raeburn 4601: my @pairs=split(/\&/,$rep);
4602: foreach my $item (@pairs) {
4603: my ($key,$value)=split(/\=/,$item,2);
4604: $key = &unescape($key);
4605: next if ($key =~ /^error: 2 /);
4606: my $result = &thaw_unescape($value);
4607: if (ref($result) eq 'HASH') {
4608: $returnhash{$key}=$result;
4609: } else {
1.921 raeburn 4610: my @responses = split(/:/,$value);
4611: my @items = ('description','inst_code','owner','type');
1.918 raeburn 4612: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 4613: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 4614: }
1.1008 raeburn 4615: }
1.353 www 4616: }
4617: }
4618: }
4619: }
4620: return %returnhash;
4621: }
4622:
1.1055 raeburn 4623: sub courselastaccess {
4624: my ($cdom,$cnum,$hostidref) = @_;
4625: my %returnhash;
4626: if ($cdom && $cnum) {
4627: my $chome = &homeserver($cnum,$cdom);
4628: if ($chome ne 'no_host') {
4629: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4630: &extract_lastaccess(\%returnhash,$rep);
4631: }
4632: } else {
4633: if (!$cdom) { $cdom=''; }
4634: my %libserv = &all_library();
4635: foreach my $tryserver (keys(%libserv)) {
4636: if (ref($hostidref) eq 'ARRAY') {
4637: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4638: }
4639: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4640: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4641: &extract_lastaccess(\%returnhash,$rep);
4642: }
4643: }
4644: }
4645: return %returnhash;
4646: }
4647:
4648: sub extract_lastaccess {
4649: my ($returnhash,$rep) = @_;
4650: if (ref($returnhash) eq 'HASH') {
4651: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4652: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4653: $rep eq '') {
4654: my @pairs=split(/\&/,$rep);
4655: foreach my $item (@pairs) {
4656: my ($key,$value)=split(/\=/,$item,2);
4657: $key = &unescape($key);
4658: next if ($key =~ /^error: 2 /);
4659: $returnhash->{$key} = &thaw_unescape($value);
4660: }
4661: }
4662: }
4663: return;
4664: }
4665:
1.658 raeburn 4666: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 4667:
4668: sub dcmailput {
1.685 raeburn 4669: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 4670: my $status = &Apache::lonnet::critical(
1.740 www 4671: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4672: &escape($message),$server);
1.662 raeburn 4673: return $status;
4674: }
4675:
1.658 raeburn 4676: sub dcmaildump {
4677: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 4678: my %returnhash=();
1.846 albertel 4679:
4680: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 4681: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4682: &escape($enddate).':';
4683: my @esc_senders=map { &escape($_)} @$senders;
4684: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 4685: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 4686: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 4687: if (($key) && ($value)) {
4688: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 4689: }
4690: }
4691: }
4692: return %returnhash;
4693: }
1.662 raeburn 4694: # ---------------------------------------------------------- Domain roles
4695:
4696: sub get_domain_roles {
4697: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 4698: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 4699: $startdate = '.';
4700: }
1.1018 raeburn 4701: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 4702: $enddate = '.';
4703: }
1.922 raeburn 4704: my $rolelist;
4705: if (ref($roles) eq 'ARRAY') {
1.1172.2.23 raeburn 4706: $rolelist = join('&',@{$roles});
1.922 raeburn 4707: }
1.662 raeburn 4708: my %personnel = ();
1.841 albertel 4709:
4710: my %servers = &get_servers($dom,'library');
4711: foreach my $tryserver (keys(%servers)) {
4712: %{$personnel{$tryserver}}=();
4713: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4714: &escape($startdate).':'.
4715: &escape($enddate).':'.
4716: &escape($rolelist), $tryserver))) {
4717: my ($key,$value) = split(/\=/,$line,2);
4718: if (($key) && ($value)) {
4719: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4720: }
4721: }
1.662 raeburn 4722: }
4723: return %personnel;
4724: }
1.658 raeburn 4725:
1.1172.2.89 raeburn 4726: sub get_active_domroles {
4727: my ($dom,$roles) = @_;
4728: return () unless (ref($roles) eq 'ARRAY');
4729: my $now = time;
4730: my %dompersonnel = &get_domain_roles($dom,$roles,$now,$now);
4731: my %domroles;
4732: foreach my $server (keys(%dompersonnel)) {
4733: foreach my $user (sort(keys(%{$dompersonnel{$server}}))) {
4734: my ($trole,$uname,$udom,$runame,$rudom,$rsec) = split(/:/,$user);
4735: $domroles{$uname.':'.$udom} = $dompersonnel{$server}{$user};
4736: }
4737: }
4738: return %domroles;
4739: }
4740:
1.1057 www 4741: # ----------------------------------------------------------- Interval timing
1.149 www 4742:
1.1153 www 4743: {
4744: # Caches needed for speedup of navmaps
4745: # We don't want to cache this for very long at all (5 seconds at most)
4746: #
4747: # The user for whom we cache
4748: my $cachedkey='';
4749: # The cached times for this user
4750: my %cachedtimes=();
4751: # When this was last done
1.1172.2.66 raeburn 4752: my $cachedtime='';
1.1153 www 4753:
4754: sub load_all_first_access {
1.1154 raeburn 4755: my ($uname,$udom)=@_;
1.1156 www 4756: if (($cachedkey eq $uname.':'.$udom) &&
1.1172.2.2 raeburn 4757: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
1.1154 raeburn 4758: return;
4759: }
4760: $cachedtime=time;
4761: $cachedkey=$uname.':'.$udom;
4762: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 4763: }
4764:
1.504 albertel 4765: sub get_first_access {
1.1162 raeburn 4766: my ($type,$argsymb,$argmap)=@_;
1.790 albertel 4767: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4768: if ($argsymb) { $symb=$argsymb; }
4769: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 4770: if ($argmap) { $map = $argmap; }
1.926 albertel 4771: if ($type eq 'course') {
4772: $res='course';
4773: } elsif ($type eq 'map') {
1.588 albertel 4774: $res=&symbread($map);
4775: } else {
4776: $res=$symb;
4777: }
1.1153 www 4778: &load_all_first_access($uname,$udom);
4779: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 4780: }
4781:
4782: sub set_first_access {
1.1162 raeburn 4783: my ($type,$interval)=@_;
1.790 albertel 4784: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4785: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 4786: if ($type eq 'course') {
4787: $res='course';
4788: } elsif ($type eq 'map') {
1.588 albertel 4789: $res=&symbread($map);
4790: } else {
4791: $res=$symb;
4792: }
1.1153 www 4793: $cachedkey='';
1.1162 raeburn 4794: my $firstaccess=&get_first_access($type,$symb,$map);
1.505 albertel 4795: if (!$firstaccess) {
1.1162 raeburn 4796: my $start = time;
4797: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4798: $udom,$uname);
4799: if ($putres eq 'ok') {
4800: &put('timerinterval',{"$courseid\0$res"=>$interval},
4801: $udom,$uname);
4802: &appenv(
4803: {
4804: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4805: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4806: }
4807: );
4808: }
4809: return $putres;
1.505 albertel 4810: }
4811: return 'already_set';
1.504 albertel 4812: }
1.1153 www 4813: }
1.1172.2.32 raeburn 4814:
4815: sub checkout {
4816: my ($symb,$tuname,$tudom,$tcrsid)=@_;
4817: my $now=time;
4818: my $lonhost=$perlvar{'lonHostID'};
4819: my $infostr=&escape(
4820: 'CHECKOUTTOKEN&'.
4821: $tuname.'&'.
4822: $tudom.'&'.
4823: $tcrsid.'&'.
4824: $symb.'&'.
4825: $now.'&'.$ENV{'REMOTE_ADDR'});
4826: my $token=&reply('tmpput:'.$infostr,$lonhost);
4827: if ($token=~/^error\:/) {
4828: &logthis("<font color=\"blue\">WARNING: ".
4829: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
4830: "</font>");
4831: return '';
4832: }
4833:
4834: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
4835: $token=~tr/a-z/A-Z/;
4836:
4837: my %infohash=('resource.0.outtoken' => $token,
4838: 'resource.0.checkouttime' => $now,
4839: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
4840:
4841: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
4842: return '';
4843: } else {
4844: &logthis("<font color=\"blue\">WARNING: ".
4845: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
4846: "</font>");
4847: }
4848:
4849: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
4850: &escape('Checkout '.$infostr.' - '.
4851: $token)) ne 'ok') {
4852: return '';
4853: } else {
4854: &logthis("<font color=\"blue\">WARNING: ".
4855: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
4856: "</font>");
4857: }
4858: return $token;
4859: }
4860:
4861: # ------------------------------------------------------------ Check in an item
4862:
4863: sub checkin {
4864: my $token=shift;
4865: my $now=time;
4866: my ($ta,$tb,$lonhost)=split(/\*/,$token);
4867: $lonhost=~tr/A-Z/a-z/;
4868: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
4869: $dtoken=~s/\W/\_/g;
4870: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
4871: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
4872:
4873: unless (($tuname) && ($tudom)) {
4874: &logthis('Check in '.$token.' ('.$dtoken.') failed');
4875: return '';
4876: }
4877:
4878: unless (&allowed('mgr',$tcrsid)) {
4879: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
4880: $env{'user.name'}.' - '.$env{'user.domain'});
4881: return '';
4882: }
4883:
4884: my %infohash=('resource.0.intoken' => $token,
4885: 'resource.0.checkintime' => $now,
4886: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
4887:
4888: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
4889: return '';
4890: }
4891:
4892: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
4893: &escape('Checkin - '.$token)) ne 'ok') {
4894: return '';
4895: }
4896:
4897: return ($symb,$tuname,$tudom,$tcrsid);
4898: }
4899:
1.110 www 4900: # --------------------------------------------- Set Expire Date for Spreadsheet
4901:
4902: sub expirespread {
4903: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 4904: my $cid=$env{'request.course.id'};
1.110 www 4905: if ($cid) {
4906: my $now=time;
4907: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 4908: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4909: $env{'course.'.$cid.'.num'}.
1.110 www 4910: ':nohist_expirationdates:'.
4911: &escape($key).'='.$now,
1.620 albertel 4912: $env{'course.'.$cid.'.home'})
1.110 www 4913: }
4914: return 'ok';
1.14 www 4915: }
4916:
1.109 www 4917: # ----------------------------------------------------- Devalidate Spreadsheets
4918:
4919: sub devalidate {
1.325 www 4920: my ($symb,$uname,$udom)=@_;
1.620 albertel 4921: my $cid=$env{'request.course.id'};
1.109 www 4922: if ($cid) {
1.391 matthew 4923: # delete the stored spreadsheets for
4924: # - the student level sheet of this user in course's homespace
4925: # - the assessment level sheet for this resource
4926: # for this user in user's homespace
1.553 albertel 4927: # - current conditional state info
1.325 www 4928: my $key=$uname.':'.$udom.':';
1.109 www 4929: my $status=
1.299 matthew 4930: &del('nohist_calculatedsheets',
1.391 matthew 4931: [$key.'studentcalc:'],
1.620 albertel 4932: $env{'course.'.$cid.'.domain'},
4933: $env{'course.'.$cid.'.num'})
1.133 albertel 4934: .' '.
4935: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 4936: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 4937: unless ($status eq 'ok ok') {
4938: &logthis('Could not devalidate spreadsheet '.
1.325 www 4939: $uname.' at '.$udom.' for '.
1.109 www 4940: $symb.': '.$status);
1.133 albertel 4941: }
1.553 albertel 4942: &delenv('user.state.'.$cid);
1.109 www 4943: }
4944: }
4945:
1.265 albertel 4946: sub get_scalar {
4947: my ($string,$end) = @_;
4948: my $value;
4949: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4950: $value = $1;
4951: } elsif ($$string =~ s/^([^&]*?)&//) {
4952: $value = $1;
4953: }
4954: return &unescape($value);
4955: }
4956:
4957: sub array2str {
4958: my (@array) = @_;
4959: my $result=&arrayref2str(\@array);
4960: $result=~s/^__ARRAY_REF__//;
4961: $result=~s/__END_ARRAY_REF__$//;
4962: return $result;
4963: }
4964:
1.204 albertel 4965: sub arrayref2str {
4966: my ($arrayref) = @_;
1.265 albertel 4967: my $result='__ARRAY_REF__';
1.204 albertel 4968: foreach my $elem (@$arrayref) {
1.265 albertel 4969: if(ref($elem) eq 'ARRAY') {
4970: $result.=&arrayref2str($elem).'&';
4971: } elsif(ref($elem) eq 'HASH') {
4972: $result.=&hashref2str($elem).'&';
4973: } elsif(ref($elem)) {
4974: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 4975: } else {
4976: $result.=&escape($elem).'&';
4977: }
4978: }
4979: $result=~s/\&$//;
1.265 albertel 4980: $result .= '__END_ARRAY_REF__';
1.204 albertel 4981: return $result;
4982: }
4983:
1.168 albertel 4984: sub hash2str {
1.204 albertel 4985: my (%hash) = @_;
4986: my $result=&hashref2str(\%hash);
1.265 albertel 4987: $result=~s/^__HASH_REF__//;
4988: $result=~s/__END_HASH_REF__$//;
1.204 albertel 4989: return $result;
4990: }
4991:
4992: sub hashref2str {
4993: my ($hashref)=@_;
1.265 albertel 4994: my $result='__HASH_REF__';
1.800 albertel 4995: foreach my $key (sort(keys(%$hashref))) {
4996: if (ref($key) eq 'ARRAY') {
4997: $result.=&arrayref2str($key).'=';
4998: } elsif (ref($key) eq 'HASH') {
4999: $result.=&hashref2str($key).'=';
5000: } elsif (ref($key)) {
1.265 albertel 5001: $result.='=';
1.800 albertel 5002: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 5003: } else {
1.1132 raeburn 5004: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 5005: }
5006:
1.800 albertel 5007: if(ref($hashref->{$key}) eq 'ARRAY') {
5008: $result.=&arrayref2str($hashref->{$key}).'&';
5009: } elsif(ref($hashref->{$key}) eq 'HASH') {
5010: $result.=&hashref2str($hashref->{$key}).'&';
5011: } elsif(ref($hashref->{$key})) {
1.265 albertel 5012: $result.='&';
1.800 albertel 5013: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 5014: } else {
1.800 albertel 5015: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 5016: }
5017: }
1.168 albertel 5018: $result=~s/\&$//;
1.265 albertel 5019: $result .= '__END_HASH_REF__';
1.168 albertel 5020: return $result;
5021: }
5022:
5023: sub str2hash {
1.265 albertel 5024: my ($string)=@_;
5025: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
5026: return %$hash;
5027: }
5028:
5029: sub str2hashref {
1.168 albertel 5030: my ($string) = @_;
1.265 albertel 5031:
5032: my %hash;
5033:
5034: if($string !~ /^__HASH_REF__/) {
5035: if (! ($string eq '' || !defined($string))) {
5036: $hash{'error'}='Not hash reference';
5037: }
5038: return (\%hash, $string);
5039: }
5040:
5041: $string =~ s/^__HASH_REF__//;
5042:
5043: while($string !~ /^__END_HASH_REF__/) {
5044: #key
5045: my $key='';
5046: if($string =~ /^__HASH_REF__/) {
5047: ($key, $string)=&str2hashref($string);
5048: if(defined($key->{'error'})) {
5049: $hash{'error'}='Bad data';
5050: return (\%hash, $string);
5051: }
5052: } elsif($string =~ /^__ARRAY_REF__/) {
5053: ($key, $string)=&str2arrayref($string);
5054: if($key->[0] eq 'Array reference error') {
5055: $hash{'error'}='Bad data';
5056: return (\%hash, $string);
5057: }
5058: } else {
5059: $string =~ s/^(.*?)=//;
1.267 albertel 5060: $key=&unescape($1);
1.265 albertel 5061: }
5062: $string =~ s/^=//;
5063:
5064: #value
5065: my $value='';
5066: if($string =~ /^__HASH_REF__/) {
5067: ($value, $string)=&str2hashref($string);
5068: if(defined($value->{'error'})) {
5069: $hash{'error'}='Bad data';
5070: return (\%hash, $string);
5071: }
5072: } elsif($string =~ /^__ARRAY_REF__/) {
5073: ($value, $string)=&str2arrayref($string);
5074: if($value->[0] eq 'Array reference error') {
5075: $hash{'error'}='Bad data';
5076: return (\%hash, $string);
5077: }
5078: } else {
5079: $value=&get_scalar(\$string,'__END_HASH_REF__');
5080: }
5081: $string =~ s/^&//;
5082:
5083: $hash{$key}=$value;
1.204 albertel 5084: }
1.265 albertel 5085:
5086: $string =~ s/^__END_HASH_REF__//;
5087:
5088: return (\%hash, $string);
1.204 albertel 5089: }
5090:
5091: sub str2array {
1.265 albertel 5092: my ($string)=@_;
5093: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
5094: return @$array;
5095: }
5096:
5097: sub str2arrayref {
1.204 albertel 5098: my ($string) = @_;
1.265 albertel 5099: my @array;
5100:
5101: if($string !~ /^__ARRAY_REF__/) {
5102: if (! ($string eq '' || !defined($string))) {
5103: $array[0]='Array reference error';
5104: }
5105: return (\@array, $string);
5106: }
5107:
5108: $string =~ s/^__ARRAY_REF__//;
5109:
5110: while($string !~ /^__END_ARRAY_REF__/) {
5111: my $value='';
5112: if($string =~ /^__HASH_REF__/) {
5113: ($value, $string)=&str2hashref($string);
5114: if(defined($value->{'error'})) {
5115: $array[0] ='Array reference error';
5116: return (\@array, $string);
5117: }
5118: } elsif($string =~ /^__ARRAY_REF__/) {
5119: ($value, $string)=&str2arrayref($string);
5120: if($value->[0] eq 'Array reference error') {
5121: $array[0] ='Array reference error';
5122: return (\@array, $string);
5123: }
5124: } else {
5125: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
5126: }
5127: $string =~ s/^&//;
5128:
5129: push(@array, $value);
1.191 harris41 5130: }
1.265 albertel 5131:
5132: $string =~ s/^__END_ARRAY_REF__//;
5133:
5134: return (\@array, $string);
1.168 albertel 5135: }
5136:
1.167 albertel 5137: # -------------------------------------------------------------------Temp Store
5138:
1.168 albertel 5139: sub tmpreset {
5140: my ($symb,$namespace,$domain,$stuname) = @_;
5141: if (!$symb) {
5142: $symb=&symbread();
1.620 albertel 5143: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5144: }
5145: $symb=escape($symb);
5146:
1.620 albertel 5147: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 5148: $namespace=~s/\//\_/g;
5149: $namespace=~s/\W//g;
5150:
1.620 albertel 5151: if (!$domain) { $domain=$env{'user.domain'}; }
5152: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5153: if ($domain eq 'public' && $stuname eq 'public') {
5154: $stuname=$ENV{'REMOTE_ADDR'};
5155: }
1.1117 foxr 5156: my $path=LONCAPA::tempdir();
1.168 albertel 5157: my %hash;
5158: if (tie(%hash,'GDBM_File',
5159: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5160: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 5161: foreach my $key (keys(%hash)) {
1.180 albertel 5162: if ($key=~ /:$symb/) {
1.168 albertel 5163: delete($hash{$key});
5164: }
5165: }
5166: }
5167: }
5168:
1.167 albertel 5169: sub tmpstore {
1.168 albertel 5170: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
5171:
5172: if (!$symb) {
5173: $symb=&symbread();
1.620 albertel 5174: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5175: }
5176: $symb=escape($symb);
5177:
5178: if (!$namespace) {
5179: # I don't think we would ever want to store this for a course.
5180: # it seems this will only be used if we don't have a course.
1.620 albertel 5181: #$namespace=$env{'request.course.id'};
1.168 albertel 5182: #if (!$namespace) {
1.620 albertel 5183: $namespace=$env{'request.state'};
1.168 albertel 5184: #}
5185: }
5186: $namespace=~s/\//\_/g;
5187: $namespace=~s/\W//g;
1.620 albertel 5188: if (!$domain) { $domain=$env{'user.domain'}; }
5189: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5190: if ($domain eq 'public' && $stuname eq 'public') {
5191: $stuname=$ENV{'REMOTE_ADDR'};
5192: }
1.168 albertel 5193: my $now=time;
5194: my %hash;
1.1117 foxr 5195: my $path=LONCAPA::tempdir();
1.168 albertel 5196: if (tie(%hash,'GDBM_File',
5197: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5198: &GDBM_WRCREAT(),0640)) {
1.168 albertel 5199: $hash{"version:$symb"}++;
5200: my $version=$hash{"version:$symb"};
5201: my $allkeys='';
5202: foreach my $key (keys(%$storehash)) {
5203: $allkeys.=$key.':';
1.591 albertel 5204: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 5205: }
5206: $hash{"$version:$symb:timestamp"}=$now;
5207: $allkeys.='timestamp';
5208: $hash{"$version:keys:$symb"}=$allkeys;
5209: if (untie(%hash)) {
5210: return 'ok';
5211: } else {
5212: return "error:$!";
5213: }
5214: } else {
5215: return "error:$!";
5216: }
5217: }
1.167 albertel 5218:
1.168 albertel 5219: # -----------------------------------------------------------------Temp Restore
1.167 albertel 5220:
1.168 albertel 5221: sub tmprestore {
5222: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 5223:
1.168 albertel 5224: if (!$symb) {
5225: $symb=&symbread();
1.620 albertel 5226: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 5227: }
5228: $symb=escape($symb);
5229:
1.620 albertel 5230: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 5231:
1.620 albertel 5232: if (!$domain) { $domain=$env{'user.domain'}; }
5233: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 5234: if ($domain eq 'public' && $stuname eq 'public') {
5235: $stuname=$ENV{'REMOTE_ADDR'};
5236: }
1.168 albertel 5237: my %returnhash;
5238: $namespace=~s/\//\_/g;
5239: $namespace=~s/\W//g;
5240: my %hash;
1.1117 foxr 5241: my $path=LONCAPA::tempdir();
1.168 albertel 5242: if (tie(%hash,'GDBM_File',
5243: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 5244: &GDBM_READER(),0640)) {
1.168 albertel 5245: my $version=$hash{"version:$symb"};
5246: $returnhash{'version'}=$version;
5247: my $scope;
5248: for ($scope=1;$scope<=$version;$scope++) {
5249: my $vkeys=$hash{"$scope:keys:$symb"};
5250: my @keys=split(/:/,$vkeys);
5251: my $key;
5252: $returnhash{"$scope:keys"}=$vkeys;
5253: foreach $key (@keys) {
1.591 albertel 5254: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
5255: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 5256: }
5257: }
1.168 albertel 5258: if (!(untie(%hash))) {
5259: return "error:$!";
5260: }
5261: } else {
5262: return "error:$!";
5263: }
5264: return %returnhash;
1.167 albertel 5265: }
5266:
1.9 www 5267: # ----------------------------------------------------------------------- Store
5268:
5269: sub store {
1.1172.2.64 raeburn 5270: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5271: my $home='';
5272:
1.168 albertel 5273: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5274:
1.213 www 5275: $symb=&symbclean($symb);
1.122 albertel 5276: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5277:
1.620 albertel 5278: if (!$domain) { $domain=$env{'user.domain'}; }
5279: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5280:
5281: &devalidate($symb,$stuname,$domain);
1.109 www 5282:
5283: $symb=escape($symb);
1.187 www 5284: if (!$namespace) {
1.620 albertel 5285: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5286: return '';
5287: }
5288: }
1.620 albertel 5289: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5290:
5291: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5292: $$storehash{'host'}=$perlvar{'lonHostID'};
5293:
1.12 www 5294: my $namevalue='';
1.800 albertel 5295: foreach my $key (keys(%$storehash)) {
5296: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5297: }
1.12 www 5298: $namevalue=~s/\&$//;
1.187 www 5299: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1172.2.64 raeburn 5300: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 5301: }
5302:
1.47 www 5303: # -------------------------------------------------------------- Critical Store
5304:
5305: sub cstore {
1.1172.2.64 raeburn 5306: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 5307: my $home='';
5308:
1.168 albertel 5309: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5310:
1.213 www 5311: $symb=&symbclean($symb);
1.122 albertel 5312: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 5313:
1.620 albertel 5314: if (!$domain) { $domain=$env{'user.domain'}; }
5315: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 5316:
5317: &devalidate($symb,$stuname,$domain);
1.109 www 5318:
5319: $symb=escape($symb);
1.187 www 5320: if (!$namespace) {
1.620 albertel 5321: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5322: return '';
5323: }
5324: }
1.620 albertel 5325: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5326:
5327: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5328: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 5329:
1.47 www 5330: my $namevalue='';
1.800 albertel 5331: foreach my $key (keys(%$storehash)) {
5332: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5333: }
1.47 www 5334: $namevalue=~s/\&$//;
1.187 www 5335: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 5336: return critical
1.1172.2.64 raeburn 5337: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 5338: }
5339:
1.9 www 5340: # --------------------------------------------------------------------- Restore
5341:
5342: sub restore {
1.124 www 5343: my ($symb,$namespace,$domain,$stuname) = @_;
5344: my $home='';
5345:
1.168 albertel 5346: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5347:
1.122 albertel 5348: if (!$symb) {
1.1172.2.26 raeburn 5349: return if ($namespace eq 'courserequests');
5350: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 5351: } else {
1.1172.2.26 raeburn 5352: unless ($namespace eq 'courserequests') {
5353: $symb=&escape(&symbclean($symb));
5354: }
1.122 albertel 5355: }
1.188 www 5356: if (!$namespace) {
1.620 albertel 5357: unless ($namespace=$env{'request.course.id'}) {
1.188 www 5358: return '';
5359: }
5360: }
1.620 albertel 5361: if (!$domain) { $domain=$env{'user.domain'}; }
5362: if (!$stuname) { $stuname=$env{'user.name'}; }
5363: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 5364: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5365:
1.12 www 5366: my %returnhash=();
1.800 albertel 5367: foreach my $line (split(/\&/,$answer)) {
5368: my ($name,$value)=split(/\=/,$line);
1.591 albertel 5369: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 5370: }
1.75 www 5371: my $version;
5372: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 5373: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5374: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 5375: }
1.75 www 5376: }
1.13 www 5377: return %returnhash;
1.34 www 5378: }
5379:
5380: # ---------------------------------------------------------- Course Description
1.1118 foxr 5381: #
5382: #
1.34 www 5383:
5384: sub coursedescription {
1.731 albertel 5385: my ($courseid,$args)=@_;
1.34 www 5386: $courseid=~s/^\///;
1.49 www 5387: $courseid=~s/\_/\//g;
1.34 www 5388: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 5389: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 5390: my $normalid=$cdomain.'_'.$cnum;
5391: # need to always cache even if we get errors otherwise we keep
5392: # trying and trying and trying to get the course description.
5393: my %envhash=();
5394: my %returnhash=();
1.731 albertel 5395:
5396: my $expiretime=600;
5397: if ($env{'request.course.id'} eq $normalid) {
5398: $expiretime=120;
5399: }
5400:
5401: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5402: if (!$args->{'freshen_cache'}
5403: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5404: foreach my $key (keys(%env)) {
5405: next if ($key !~ /^\Q$prefix\E(.*)/);
5406: my ($setting) = $1;
5407: $returnhash{$setting} = $env{$key};
5408: }
5409: return %returnhash;
5410: }
5411:
1.1118 foxr 5412: # get the data again
5413:
1.731 albertel 5414: if (!$args->{'one_time'}) {
5415: $envhash{'course.'.$normalid.'.last_cache'}=time;
5416: }
1.811 albertel 5417:
1.34 www 5418: if ($chome ne 'no_host') {
1.302 albertel 5419: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 5420: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 5421: my $username = $env{'user.name'}; # Defult username
5422: if(defined $args->{'user'}) {
5423: $username = $args->{'user'};
5424: }
1.129 albertel 5425: $returnhash{'home'}= $chome;
5426: $returnhash{'domain'} = $cdomain;
5427: $returnhash{'num'} = $cnum;
1.741 raeburn 5428: if (!defined($returnhash{'type'})) {
5429: $returnhash{'type'} = 'Course';
5430: }
1.130 albertel 5431: while (my ($name,$value) = each %returnhash) {
1.53 www 5432: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 5433: }
1.270 www 5434: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 5435: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 5436: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 5437: $envhash{'course.'.$normalid.'.home'}=$chome;
5438: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5439: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 5440: }
5441: }
1.731 albertel 5442: if (!$args->{'one_time'}) {
1.949 raeburn 5443: &appenv(\%envhash);
1.731 albertel 5444: }
1.302 albertel 5445: return %returnhash;
1.461 www 5446: }
5447:
1.1080 raeburn 5448: sub update_released_required {
5449: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5450: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5451: $cid = $env{'request.course.id'};
5452: $cdom = $env{'course.'.$cid.'.domain'};
5453: $cnum = $env{'course.'.$cid.'.num'};
5454: $chome = $env{'course.'.$cid.'.home'};
5455: }
5456: if ($needsrelease) {
5457: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5458: my $needsupdate;
5459: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5460: $needsupdate = 1;
5461: } else {
5462: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5463: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5464: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5465: $needsupdate = 1;
5466: }
5467: }
5468: if ($needsupdate) {
5469: my %needshash = (
5470: 'internal.releaserequired' => $needsrelease,
5471: );
5472: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5473: if ($putresult eq 'ok') {
5474: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5475: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5476: if (ref($crsinfo{$cid}) eq 'HASH') {
5477: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5478: &courseidput($cdom,\%crsinfo,$chome,'notime');
5479: }
5480: }
5481: }
5482: }
5483: return;
5484: }
5485:
1.461 www 5486: # -------------------------------------------------See if a user is privileged
5487:
5488: sub privileged {
1.1172.2.23 raeburn 5489: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 5490: my $now = time;
1.1172.2.23 raeburn 5491: my $roles;
5492: if (ref($possroles) eq 'ARRAY') {
5493: $roles = $possroles;
5494: } else {
5495: $roles = ['dc','su'];
5496: }
5497: if (ref($possdomains) eq 'ARRAY') {
5498: my %privileged = &privileged_by_domain($possdomains,$roles);
5499: foreach my $dom (@{$possdomains}) {
5500: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5501: (ref($privileged{$dom}) eq 'HASH')) {
5502: foreach my $role (@{$roles}) {
5503: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5504: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5505: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5506: return 1 unless (($end && $end < $now) ||
5507: ($start && $start > $now));
5508: }
5509: }
5510: }
5511: }
5512: }
5513: } else {
5514: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5515: my $now = time;
1.1170 droeschl 5516:
1.1172.2.58 raeburn 5517: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 5518: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1172.2.23 raeburn 5519: if (grep(/^\Q$trole\E$/,@{$roles})) {
5520: return 1 unless ($tend && $tend < $now)
5521: or ($tstart && $tstart > $now);
1.1170 droeschl 5522: }
1.1172.2.23 raeburn 5523: }
5524: }
1.461 www 5525: return 0;
1.9 www 5526: }
1.1 albertel 5527:
1.1172.2.23 raeburn 5528: sub privileged_by_domain {
5529: my ($domains,$roles) = @_;
5530: my %privileged = ();
5531: my $cachetime = 60*60*24;
5532: my $now = time;
5533: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5534: return %privileged;
5535: }
5536: foreach my $dom (@{$domains}) {
5537: next if (ref($privileged{$dom}) eq 'HASH');
5538: my $needroles;
5539: foreach my $role (@{$roles}) {
5540: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5541: if (defined($cached)) {
5542: if (ref($result) eq 'HASH') {
5543: $privileged{$dom}{$role} = $result;
5544: }
5545: } else {
5546: $needroles = 1;
5547: }
5548: }
5549: if ($needroles) {
5550: my %dompersonnel = &get_domain_roles($dom,$roles);
5551: $privileged{$dom} = {};
5552: foreach my $server (keys(%dompersonnel)) {
5553: if (ref($dompersonnel{$server}) eq 'HASH') {
5554: foreach my $item (keys(%{$dompersonnel{$server}})) {
5555: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5556: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5557: next if ($end && $end < $now);
5558: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5559: $dompersonnel{$server}{$item};
5560: }
5561: }
5562: }
5563: if (ref($privileged{$dom}) eq 'HASH') {
5564: foreach my $role (@{$roles}) {
5565: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5566: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5567: } else {
5568: my %hash = ();
5569: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5570: }
5571: }
5572: }
5573: }
5574: }
5575: return %privileged;
5576: }
5577:
1.103 harris41 5578: # -------------------------------------------------------- Get user privileges
1.11 www 5579:
5580: sub rolesinit {
1.1169 droeschl 5581: my ($domain, $username) = @_;
5582: my %userroles = ('user.login.time' => time);
5583: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5584:
5585: # firstaccess and timerinterval are related to timed maps/resources.
5586: # also, blocking can be triggered by an activating timer
5587: # it's saved in the user's %env.
5588: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5589: my %timerinterval = &dump('timerinterval', $domain, $username);
5590: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5591: %timerintchk, %timerintenv);
5592:
1.1162 raeburn 5593: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 5594: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 5595: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5596: }
1.1169 droeschl 5597:
1.1162 raeburn 5598: foreach my $key (keys(%timerinterval)) {
5599: my ($cid,$rest) = split(/\0/,$key);
5600: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5601: }
1.1169 droeschl 5602:
1.11 www 5603: my %allroles=();
1.1162 raeburn 5604: my %allgroups=();
1.11 www 5605:
1.1172.2.58 raeburn 5606: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 5607: my $role = $rolesdump{$area};
5608: $area =~ s/\_\w\w$//;
5609:
5610: my ($trole, $tend, $tstart, $group_privs);
5611:
5612: if ($role =~ /^cr/) {
5613: # Custom role, defined by a user
5614: # e.g., user.role.cr/msu/smith/mynewrole
5615: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5616: $trole = $1;
5617: ($tend, $tstart) = split('_', $2);
5618: } else {
5619: $trole = $role;
5620: }
5621: } elsif ($role =~ m|^gr/|) {
5622: # Role of member in a group, defined within a course/community
5623: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5624: ($trole, $tend, $tstart) = split(/_/, $role);
5625: next if $tstart eq '-1';
5626: ($trole, $group_privs) = split(/\//, $trole);
5627: $group_privs = &unescape($group_privs);
5628: } else {
5629: # Just a normal role, defined in roles.tab
5630: ($trole, $tend, $tstart) = split(/_/,$role);
5631: }
5632:
5633: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5634: $username);
5635: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5636:
5637: # role expired or not available yet?
5638: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5639: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5640:
5641: next if $area eq '' or $trole eq '';
5642:
5643: my $spec = "$trole.$area";
5644: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5645:
5646: if ($trole =~ /^cr\//) {
5647: # Custom role, defined by a user
5648: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5649: } elsif ($trole eq 'gr') {
5650: # Role of a member in a group, defined within a course/community
5651: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5652: next;
5653: } else {
5654: # Normal role, defined in roles.tab
5655: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5656: }
5657:
5658: my $cid = $tdomain.'_'.$trest;
5659: unless ($firstaccchk{$cid}) {
5660: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5661: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5662: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5663: $coursetimerstarts{$cid}{$item};
5664: }
5665: }
5666: $firstaccchk{$cid} = 1;
5667: }
5668: unless ($timerintchk{$cid}) {
5669: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5670: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5671: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5672: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 5673: }
1.12 www 5674: }
1.1169 droeschl 5675: $timerintchk{$cid} = 1;
1.191 harris41 5676: }
1.11 www 5677: }
1.1169 droeschl 5678:
1.1172.2.91 raeburn 5679: @userroles{'user.author','user.adv','user.rar'} = &set_userprivs(\%userroles,
5680: \%allroles, \%allgroups);
1.1169 droeschl 5681: $env{'user.adv'} = $userroles{'user.adv'};
1.1172.2.91 raeburn 5682: $env{'user.rar'} = $userroles{'user.rar'};
1.1169 droeschl 5683:
1.1162 raeburn 5684: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 5685: }
5686:
1.567 raeburn 5687: sub set_arearole {
1.1172.2.19 raeburn 5688: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5689: unless ($nolog) {
1.567 raeburn 5690: # log the associated role with the area
1.1172.2.19 raeburn 5691: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5692: }
1.743 albertel 5693: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 5694: }
5695:
5696: sub custom_roleprivs {
5697: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5698: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1172.2.40 raeburn 5699: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 5700: if (&hostname($homsvr) ne '') {
1.567 raeburn 5701: my ($rdummy,$roledef)=
5702: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5703: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5704: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5705: if (defined($syspriv)) {
1.1043 raeburn 5706: if ($trest =~ /^$match_community$/) {
5707: $syspriv =~ s/bre\&S//;
5708: }
1.567 raeburn 5709: $$allroles{'cm./'}.=':'.$syspriv;
5710: $$allroles{$spec.'./'}.=':'.$syspriv;
5711: }
5712: if ($tdomain ne '') {
5713: if (defined($dompriv)) {
5714: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5715: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5716: }
5717: if (($trest ne '') && (defined($coursepriv))) {
1.1172.2.89 raeburn 5718: if ($trole =~ m{^cr/$tdomain/$tdomain\Q-domainconfig\E/([^/]+)$}) {
5719: my $rolename = $1;
5720: $coursepriv = &course_adhocrole_privs($rolename,$tdomain,$trest,$coursepriv);
5721: }
1.567 raeburn 5722: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5723: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5724: }
5725: }
5726: }
5727: }
5728: }
5729:
1.1172.2.89 raeburn 5730: sub course_adhocrole_privs {
5731: my ($rolename,$cdom,$cnum,$coursepriv) = @_;
5732: my %overrides = &get('environment',["internal.adhocpriv.$rolename"],$cdom,$cnum);
5733: if ($overrides{"internal.adhocpriv.$rolename"}) {
5734: my (%currprivs,%storeprivs);
5735: foreach my $item (split(/:/,$coursepriv)) {
5736: my ($priv,$restrict) = split(/\&/,$item);
5737: $currprivs{$priv} = $restrict;
5738: }
5739: my (%possadd,%possremove,%full);
5740: foreach my $item (split(/\:/,$Apache::lonnet::pr{'cr:c'})) {
5741: my ($priv,$restrict)=split(/\&/,$item);
5742: $full{$priv} = $restrict;
5743: }
5744: foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
5745: next if ($item eq '');
5746: my ($rule,$rest) = split(/=/,$item);
5747: next unless (($rule eq 'off') || ($rule eq 'on'));
5748: foreach my $priv (split(/:/,$rest)) {
5749: if ($priv ne '') {
5750: if ($rule eq 'off') {
5751: $possremove{$priv} = 1;
5752: } else {
5753: $possadd{$priv} = 1;
5754: }
5755: }
5756: }
5757: }
5758: foreach my $priv (sort(keys(%full))) {
5759: if (exists($currprivs{$priv})) {
5760: unless (exists($possremove{$priv})) {
5761: $storeprivs{$priv} = $currprivs{$priv};
5762: }
5763: } elsif (exists($possadd{$priv})) {
5764: $storeprivs{$priv} = $full{$priv};
5765: }
5766: }
5767: $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
5768: }
5769: return $coursepriv;
5770: }
5771:
1.678 raeburn 5772: sub group_roleprivs {
5773: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5774: my $access = 1;
5775: my $now = time;
5776: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5777: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5778: if ($access) {
1.811 albertel 5779: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 5780: $$allgroups{$course}{$group} .=':'.$group_privs;
5781: }
5782: }
1.567 raeburn 5783:
5784: sub standard_roleprivs {
5785: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5786: if (defined($pr{$trole.':s'})) {
5787: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5788: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5789: }
5790: if ($tdomain ne '') {
5791: if (defined($pr{$trole.':d'})) {
5792: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5793: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5794: }
5795: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5796: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5797: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5798: }
5799: }
5800: }
5801:
5802: sub set_userprivs {
1.1064 raeburn 5803: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 5804: my $author=0;
5805: my $adv=0;
1.1172.2.91 raeburn 5806: my $rar=0;
1.678 raeburn 5807: my %grouproles = ();
5808: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 5809: my @groupkeys;
1.1000 raeburn 5810: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 5811: push(@groupkeys,$role);
5812: }
5813: if (ref($groups_roles) eq 'HASH') {
5814: foreach my $key (keys(%{$groups_roles})) {
5815: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5816: push(@groupkeys,$key);
5817: }
5818: }
5819: }
5820: if (@groupkeys > 0) {
5821: foreach my $role (@groupkeys) {
5822: my ($trole,$area,$sec,$extendedarea);
5823: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5824: $trole = $1;
5825: $area = $2;
5826: $sec = $3;
5827: $extendedarea = $area.$sec;
5828: if (exists($$allgroups{$area})) {
5829: foreach my $group (keys(%{$$allgroups{$area}})) {
5830: my $spec = $trole.'.'.$extendedarea;
5831: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 5832: $$allgroups{$area}{$group};
1.1064 raeburn 5833: }
1.678 raeburn 5834: }
5835: }
5836: }
5837: }
5838: }
1.800 albertel 5839: foreach my $group (keys(%grouproles)) {
5840: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 5841: }
1.800 albertel 5842: foreach my $role (keys(%{$allroles})) {
5843: my %thesepriv;
1.941 raeburn 5844: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 5845: foreach my $item (split(/:/,$$allroles{$role})) {
5846: if ($item ne '') {
5847: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 5848: if ($restrictions eq '') {
5849: $thesepriv{$privilege}='F';
5850: } elsif ($thesepriv{$privilege} ne 'F') {
5851: $thesepriv{$privilege}.=$restrictions;
5852: }
5853: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
1.1172.2.91 raeburn 5854: if ($thesepriv{'rar'} eq 'F') { $rar=1; }
1.567 raeburn 5855: }
5856: }
5857: my $thesestr='';
1.1104 raeburn 5858: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 5859: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5860: }
5861: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 5862: }
1.1172.2.91 raeburn 5863: return ($author,$adv,$rar);
1.567 raeburn 5864: }
5865:
1.994 raeburn 5866: sub role_status {
1.1104 raeburn 5867: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 5868: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1172.2.40 raeburn 5869: my ($one,$two) = split(m{\./},$rolekey,2);
5870: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 5871: unless (!defined($$role) || $$role eq '') {
1.1172.2.40 raeburn 5872: $$where = '/'.$two;
1.994 raeburn 5873: $$trolecode=$$role.'.'.$$where;
5874: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5875: $$tstatus='is';
1.1104 raeburn 5876: if ($$tstart && $$tstart>$update) {
1.994 raeburn 5877: $$tstatus='future';
1.1034 raeburn 5878: if ($$tstart<$now) {
5879: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 5880: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 5881: my (%allroles,%allgroups,$group_privs,
5882: %groups_roles,@rolecodes);
1.1002 raeburn 5883: my %userroles = (
5884: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5885: );
1.1064 raeburn 5886: @rolecodes = ('cm');
1.1002 raeburn 5887: my $spec=$$role.'.'.$$where;
5888: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5889: if ($$role =~ /^cr\//) {
5890: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 5891: push(@rolecodes,'cr');
1.1002 raeburn 5892: } elsif ($$role eq 'gr') {
1.1064 raeburn 5893: push(@rolecodes,$$role);
1.1002 raeburn 5894: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5895: $env{'user.name'});
1.1064 raeburn 5896: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 5897: (undef,my $group_privs) = split(/\//,$trole);
5898: $group_privs = &unescape($group_privs);
5899: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 5900: 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 5901: &get_groups_roles($tdomain,$trest,
5902: \%course_roles,\@rolecodes,
5903: \%groups_roles);
1.1002 raeburn 5904: } else {
1.1064 raeburn 5905: push(@rolecodes,$$role);
1.1002 raeburn 5906: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5907: }
1.1172.2.91 raeburn 5908: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%allroles,\%allgroups,
5909: \%groups_roles);
1.1064 raeburn 5910: &appenv(\%userroles,\@rolecodes);
1.1172.2.92 raeburn 5911: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1002 raeburn 5912: }
5913: }
1.1034 raeburn 5914: $$tstatus = 'is';
1.1002 raeburn 5915: }
1.994 raeburn 5916: }
5917: if ($$tend) {
1.1104 raeburn 5918: if ($$tend<$update) {
1.994 raeburn 5919: $$tstatus='expired';
5920: } elsif ($$tend<$now) {
5921: $$tstatus='will_not';
5922: }
5923: }
5924: }
5925: }
5926: }
5927:
1.1104 raeburn 5928: sub get_groups_roles {
5929: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5930: return unless((ref($cdom_courseroles) eq 'HASH') &&
5931: (ref($rolecodes) eq 'ARRAY') &&
5932: (ref($groups_roles) eq 'HASH'));
5933: if (keys(%{$cdom_courseroles}) > 0) {
5934: my ($cnum) = ($rest =~ /^($match_courseid)/);
5935: if ($cdom ne '' && $cnum ne '') {
5936: foreach my $key (keys(%{$cdom_courseroles})) {
5937: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5938: my $crsrole = $1;
5939: my $crssec = $2;
5940: if ($crsrole =~ /^cr/) {
5941: unless (grep(/^cr$/,@{$rolecodes})) {
5942: push(@{$rolecodes},'cr');
5943: }
5944: } else {
5945: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5946: push(@{$rolecodes},$crsrole);
5947: }
5948: }
5949: my $rolekey = "$crsrole./$cdom/$cnum";
5950: if ($crssec ne '') {
5951: $rolekey .= "/$crssec";
5952: }
5953: $rolekey .= './';
5954: $groups_roles->{$rolekey} = $rolecodes;
5955: }
5956: }
5957: }
5958: }
5959: return;
5960: }
5961:
5962: sub delete_env_groupprivs {
5963: my ($where,$courseroles,$possroles) = @_;
5964: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5965: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5966: unless (ref($courseroles->{$udom}) eq 'HASH') {
5967: %{$courseroles->{$udom}} =
5968: &get_my_roles('','','userroles',['active'],
5969: $possroles,[$udom],1);
5970: }
5971: if (ref($courseroles->{$udom}) eq 'HASH') {
5972: foreach my $item (keys(%{$courseroles->{$udom}})) {
5973: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5974: my $area = '/'.$cdom.'/'.$cnum;
5975: my $privkey = "user.priv.$crsrole.$area";
5976: if ($crssec ne '') {
5977: $privkey .= '/'.$crssec;
5978: }
5979: $privkey .= ".$area/$group";
5980: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5981: }
5982: }
5983: return;
5984: }
5985:
1.994 raeburn 5986: sub check_adhoc_privs {
1.1172.2.86 raeburn 5987: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller,$sec) = @_;
1.994 raeburn 5988: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1172.2.86 raeburn 5989: if ($sec) {
5990: $cckey .= '/'.$sec;
5991: }
1.1172.2.9 raeburn 5992: my $setprivs;
1.994 raeburn 5993: if ($env{$cckey}) {
5994: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 5995: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 5996: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1172.2.86 raeburn 5997: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1172.2.9 raeburn 5998: $setprivs = 1;
1.994 raeburn 5999: }
6000: } else {
1.1172.2.87 raeburn 6001: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller,$sec);
1.1172.2.9 raeburn 6002: $setprivs = 1;
1.994 raeburn 6003: }
1.1172.2.9 raeburn 6004: return $setprivs;
1.994 raeburn 6005: }
6006:
6007: sub set_adhoc_privileges {
1.1172.2.84 raeburn 6008: # role can be cc, ca, or cr/<dom>/<dom>-domainconfig/role
1.1172.2.86 raeburn 6009: my ($dcdom,$pickedcourse,$role,$caller,$sec) = @_;
1.994 raeburn 6010: my $area = '/'.$dcdom.'/'.$pickedcourse;
1.1172.2.86 raeburn 6011: if ($sec ne '') {
6012: $area .= '/'.$sec;
6013: }
1.994 raeburn 6014: my $spec = $role.'.'.$area;
6015: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1172.2.19 raeburn 6016: $env{'user.name'},1);
1.1172.2.84 raeburn 6017: my %rolehash = ();
1.1172.2.89 raeburn 6018: if ($role =~ m{^\Qcr/$dcdom/$dcdom\E\-domainconfig/(\w+)$}) {
6019: my $rolename = $1;
1.1172.2.84 raeburn 6020: &custom_roleprivs(\%rolehash,$role,$dcdom,$pickedcourse,$spec,$area);
1.1172.2.89 raeburn 6021: my %domdef = &get_domain_defaults($dcdom);
6022: if (ref($domdef{'adhocroles'}) eq 'HASH') {
6023: if (ref($domdef{'adhocroles'}{$rolename}) eq 'HASH') {
6024: &appenv({'request.role.desc' => $domdef{'adhocroles'}{$rolename}{'desc'},});
6025: }
6026: }
1.1172.2.84 raeburn 6027: } else {
6028: &standard_roleprivs(\%rolehash,$role,$dcdom,$spec,$pickedcourse,$area);
6029: }
1.1172.2.91 raeburn 6030: my ($author,$adv,$rar)= &set_userprivs(\%userroles,\%rolehash);
1.994 raeburn 6031: &appenv(\%userroles,[$role,'cm']);
1.1172.2.92 raeburn 6032: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$spec);
1.1088 raeburn 6033: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
6034: &appenv( {'request.role' => $spec,
6035: 'request.role.domain' => $dcdom,
1.1172.2.89 raeburn 6036: 'request.course.sec' => $sec,
1.1088 raeburn 6037: }
6038: );
6039: my $tadv=0;
6040: if (&allowed('adv') eq 'F') { $tadv=1; }
6041: &appenv({'request.role.adv' => $tadv});
6042: }
1.994 raeburn 6043: }
6044:
1.12 www 6045: # --------------------------------------------------------------- get interface
6046:
6047: sub get {
1.131 albertel 6048: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6049: my $items='';
1.800 albertel 6050: foreach my $item (@$storearr) {
6051: $items.=&escape($item).'&';
1.191 harris41 6052: }
1.12 www 6053: $items=~s/\&$//;
1.620 albertel 6054: if (!$udomain) { $udomain=$env{'user.domain'}; }
6055: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 6056: my $uhome=&homeserver($uname,$udomain);
6057:
1.133 albertel 6058: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6059: my @pairs=split(/\&/,$rep);
1.273 albertel 6060: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
6061: return @pairs;
6062: }
1.15 www 6063: my %returnhash=();
1.42 www 6064: my $i=0;
1.800 albertel 6065: foreach my $item (@$storearr) {
6066: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6067: $i++;
1.191 harris41 6068: }
1.15 www 6069: return %returnhash;
1.27 www 6070: }
6071:
6072: # --------------------------------------------------------------- del interface
6073:
6074: sub del {
1.133 albertel 6075: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 6076: my $items='';
1.800 albertel 6077: foreach my $item (@$storearr) {
6078: $items.=&escape($item).'&';
1.191 harris41 6079: }
1.984 neumanie 6080:
1.27 www 6081: $items=~s/\&$//;
1.620 albertel 6082: if (!$udomain) { $udomain=$env{'user.domain'}; }
6083: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6084: my $uhome=&homeserver($uname,$udomain);
6085: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 6086: }
6087:
6088: # -------------------------------------------------------------- dump interface
6089:
1.1172.2.22 raeburn 6090: sub unserialize {
6091: my ($rep, $escapedkeys) = @_;
6092:
6093: return {} if $rep =~ /^error/;
6094:
6095: my %returnhash=();
6096: foreach my $item (split(/\&/,$rep)) {
6097: my ($key, $value) = split(/=/, $item, 2);
6098: $key = unescape($key) unless $escapedkeys;
6099: next if $key =~ /^error: 2 /;
6100: $returnhash{$key} = &thaw_unescape($value);
6101: }
6102: return \%returnhash;
6103: }
6104:
6105: # see Lond::dump_with_regexp
6106: # if $escapedkeys hash keys won't get unescaped.
1.15 www 6107: sub dump {
1.1172.2.22 raeburn 6108: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755 albertel 6109: if (!$udomain) { $udomain=$env{'user.domain'}; }
6110: if (!$uname) { $uname=$env{'user.name'}; }
6111: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 6112:
1.1172.2.55 raeburn 6113: if ($regexp) {
6114: $regexp=&escape($regexp);
6115: } else {
6116: $regexp='.';
6117: }
1.1172.2.22 raeburn 6118: if (grep { $_ eq $uhome } ¤t_machine_ids()) {
6119: # user is hosted on this machine
1.1172.2.55 raeburn 6120: my $reply = LONCAPA::Lond::dump_with_regexp(join(':', ($udomain,
1.1172.2.27 raeburn 6121: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1172.2.22 raeburn 6122: return %{&unserialize($reply, $escapedkeys)};
6123: }
1.1166 raeburn 6124: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 6125: my @pairs=split(/\&/,$rep);
6126: my %returnhash=();
1.1098 foxr 6127: if (!($rep =~ /^error/ )) {
6128: foreach my $item (@pairs) {
6129: my ($key,$value)=split(/=/,$item,2);
1.1172.2.22 raeburn 6130: $key = &unescape($key) unless ($escapedkeys);
1.1098 foxr 6131: next if ($key =~ /^error: 2 /);
6132: $returnhash{$key}=&thaw_unescape($value);
6133: }
1.755 albertel 6134: }
6135: return %returnhash;
1.407 www 6136: }
6137:
1.1098 foxr 6138:
1.717 albertel 6139: # --------------------------------------------------------- dumpstore interface
6140:
6141: sub dumpstore {
6142: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1172.2.22 raeburn 6143: # same as dump but keys must be escaped. They may contain colon separated
6144: # lists of values that may themself contain colons (e.g. symbs).
6145: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 6146: }
6147:
1.407 www 6148: # -------------------------------------------------------------- keys interface
6149:
6150: sub getkeys {
6151: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 6152: if (!$udomain) { $udomain=$env{'user.domain'}; }
6153: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 6154: my $uhome=&homeserver($uname,$udomain);
6155: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
6156: my @keyarray=();
1.800 albertel 6157: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 6158: next if ($key =~ /^error: 2 /);
1.800 albertel 6159: push(@keyarray,&unescape($key));
1.407 www 6160: }
6161: return @keyarray;
1.318 matthew 6162: }
6163:
1.319 matthew 6164: # --------------------------------------------------------------- currentdump
6165: sub currentdump {
1.328 matthew 6166: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 6167: $courseid = $env{'request.course.id'} if (! defined($courseid));
6168: $sdom = $env{'user.domain'} if (! defined($sdom));
6169: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 6170: my $uhome = &homeserver($sname,$sdom);
1.1172.2.50 raeburn 6171: my $rep;
6172:
6173: if (grep { $_ eq $uhome } current_machine_ids()) {
6174: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
6175: $courseid)));
6176: } else {
6177: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
6178: }
6179:
1.318 matthew 6180: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 6181: #
1.318 matthew 6182: my %returnhash=();
1.319 matthew 6183: #
6184: if ($rep eq "unknown_cmd") {
6185: # an old lond will not know currentdump
6186: # Do a dump and make it look like a currentdump
1.822 albertel 6187: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 6188: return if ($tmp[0] =~ /^(error:|no_such_host)/);
6189: my %hash = @tmp;
6190: @tmp=();
1.424 matthew 6191: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 6192: } else {
6193: my @pairs=split(/\&/,$rep);
1.800 albertel 6194: foreach my $pair (@pairs) {
6195: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 6196: my ($symb,$param) = split(/:/,$key);
6197: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 6198: &thaw_unescape($value);
1.319 matthew 6199: }
1.191 harris41 6200: }
1.12 www 6201: return %returnhash;
1.424 matthew 6202: }
6203:
6204: sub convert_dump_to_currentdump{
6205: my %hash = %{shift()};
6206: my %returnhash;
6207: # Code ripped from lond, essentially. The only difference
6208: # here is the unescaping done by lonnet::dump(). Conceivably
6209: # we might run in to problems with parameter names =~ /^v\./
6210: while (my ($key,$value) = each(%hash)) {
6211: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 6212: $symb = &unescape($symb);
6213: $param = &unescape($param);
1.424 matthew 6214: next if ($v eq 'version' || $symb eq 'keys');
6215: next if (exists($returnhash{$symb}) &&
6216: exists($returnhash{$symb}->{$param}) &&
6217: $returnhash{$symb}->{'v.'.$param} > $v);
6218: $returnhash{$symb}->{$param}=$value;
6219: $returnhash{$symb}->{'v.'.$param}=$v;
6220: }
6221: #
6222: # Remove all of the keys in the hashes which keep track of
6223: # the version of the parameter.
6224: while (my ($symb,$param_hash) = each(%returnhash)) {
6225: # use a foreach because we are going to delete from the hash.
6226: foreach my $key (keys(%$param_hash)) {
6227: delete($param_hash->{$key}) if ($key =~ /^v\./);
6228: }
6229: }
6230: return \%returnhash;
1.12 www 6231: }
6232:
1.627 albertel 6233: # ------------------------------------------------------ critical inc interface
6234:
6235: sub cinc {
6236: return &inc(@_,'critical');
6237: }
6238:
1.449 matthew 6239: # --------------------------------------------------------------- inc interface
6240:
6241: sub inc {
1.627 albertel 6242: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 6243: if (!$udomain) { $udomain=$env{'user.domain'}; }
6244: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 6245: my $uhome=&homeserver($uname,$udomain);
6246: my $items='';
6247: if (! ref($store)) {
6248: # got a single value, so use that instead
6249: $items = &escape($store).'=&';
6250: } elsif (ref($store) eq 'SCALAR') {
6251: $items = &escape($$store).'=&';
6252: } elsif (ref($store) eq 'ARRAY') {
6253: $items = join('=&',map {&escape($_);} @{$store});
6254: } elsif (ref($store) eq 'HASH') {
6255: while (my($key,$value) = each(%{$store})) {
6256: $items.= &escape($key).'='.&escape($value).'&';
6257: }
6258: }
6259: $items=~s/\&$//;
1.627 albertel 6260: if ($critical) {
6261: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
6262: } else {
6263: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
6264: }
1.449 matthew 6265: }
6266:
1.12 www 6267: # --------------------------------------------------------------- put interface
6268:
6269: sub put {
1.134 albertel 6270: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6271: if (!$udomain) { $udomain=$env{'user.domain'}; }
6272: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6273: my $uhome=&homeserver($uname,$udomain);
1.12 www 6274: my $items='';
1.800 albertel 6275: foreach my $item (keys(%$storehash)) {
6276: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6277: }
1.12 www 6278: $items=~s/\&$//;
1.134 albertel 6279: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 6280: }
6281:
1.631 albertel 6282: # ------------------------------------------------------------ newput interface
6283:
6284: sub newput {
6285: my ($namespace,$storehash,$udomain,$uname)=@_;
6286: if (!$udomain) { $udomain=$env{'user.domain'}; }
6287: if (!$uname) { $uname=$env{'user.name'}; }
6288: my $uhome=&homeserver($uname,$udomain);
6289: my $items='';
6290: foreach my $key (keys(%$storehash)) {
6291: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6292: }
6293: $items=~s/\&$//;
6294: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
6295: }
6296:
6297: # --------------------------------------------------------- putstore interface
6298:
1.524 raeburn 6299: sub putstore {
1.1172.2.59 raeburn 6300: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 6301: if (!$udomain) { $udomain=$env{'user.domain'}; }
6302: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 6303: my $uhome=&homeserver($uname,$udomain);
6304: my $items='';
1.715 albertel 6305: foreach my $key (keys(%$storehash)) {
6306: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 6307: }
1.715 albertel 6308: $items=~s/\&$//;
1.716 albertel 6309: my $esc_symb=&escape($symb);
6310: my $esc_v=&escape($version);
1.715 albertel 6311: my $reply =
1.716 albertel 6312: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 6313: $uhome);
1.1172.2.59 raeburn 6314: if (($tolog) && ($reply eq 'ok')) {
6315: my $namevalue='';
6316: foreach my $key (keys(%{$storehash})) {
6317: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
6318: }
6319: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
6320: '&host='.&escape($perlvar{'lonHostID'}).
6321: '&version='.$esc_v.
6322: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
6323: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
6324: }
1.715 albertel 6325: if ($reply eq 'unknown_cmd') {
1.716 albertel 6326: # gfall back to way things use to be done
1.715 albertel 6327: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
6328: $uname);
1.524 raeburn 6329: }
1.715 albertel 6330: return $reply;
6331: }
6332:
6333: sub old_putstore {
1.716 albertel 6334: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
6335: if (!$udomain) { $udomain=$env{'user.domain'}; }
6336: if (!$uname) { $uname=$env{'user.name'}; }
6337: my $uhome=&homeserver($uname,$udomain);
6338: my %newstorehash;
1.800 albertel 6339: foreach my $item (keys(%$storehash)) {
6340: my $key = $version.':'.&escape($symb).':'.$item;
6341: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 6342: }
6343: my $items='';
6344: my %allitems = ();
1.800 albertel 6345: foreach my $item (keys(%newstorehash)) {
6346: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 6347: my $key = $1.':keys:'.$2;
6348: $allitems{$key} .= $3.':';
6349: }
1.800 albertel 6350: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 6351: }
1.800 albertel 6352: foreach my $item (keys(%allitems)) {
6353: $allitems{$item} =~ s/\:$//;
6354: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 6355: }
6356: $items=~s/\&$//;
6357: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 6358: }
6359:
1.47 www 6360: # ------------------------------------------------------ critical put interface
6361:
6362: sub cput {
1.134 albertel 6363: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 6364: if (!$udomain) { $udomain=$env{'user.domain'}; }
6365: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 6366: my $uhome=&homeserver($uname,$udomain);
1.47 www 6367: my $items='';
1.800 albertel 6368: foreach my $item (keys(%$storehash)) {
6369: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 6370: }
1.47 www 6371: $items=~s/\&$//;
1.134 albertel 6372: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6373: }
6374:
6375: # -------------------------------------------------------------- eget interface
6376:
6377: sub eget {
1.133 albertel 6378: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 6379: my $items='';
1.800 albertel 6380: foreach my $item (@$storearr) {
6381: $items.=&escape($item).'&';
1.191 harris41 6382: }
1.12 www 6383: $items=~s/\&$//;
1.620 albertel 6384: if (!$udomain) { $udomain=$env{'user.domain'}; }
6385: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 6386: my $uhome=&homeserver($uname,$udomain);
6387: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6388: my @pairs=split(/\&/,$rep);
6389: my %returnhash=();
1.42 www 6390: my $i=0;
1.800 albertel 6391: foreach my $item (@$storearr) {
6392: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6393: $i++;
1.191 harris41 6394: }
1.12 www 6395: return %returnhash;
6396: }
6397:
1.667 albertel 6398: # ------------------------------------------------------------ tmpput interface
6399: sub tmpput {
1.802 raeburn 6400: my ($storehash,$server,$context)=@_;
1.667 albertel 6401: my $items='';
1.800 albertel 6402: foreach my $item (keys(%$storehash)) {
6403: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 6404: }
6405: $items=~s/\&$//;
1.802 raeburn 6406: if (defined($context)) {
6407: $items .= ':'.&escape($context);
6408: }
1.667 albertel 6409: return &reply("tmpput:$items",$server);
6410: }
6411:
6412: # ------------------------------------------------------------ tmpget interface
6413: sub tmpget {
1.688 albertel 6414: my ($token,$server)=@_;
6415: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6416: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 6417: my %returnhash;
1.1172.2.85 raeburn 6418: if ($rep =~ /^(con_lost|error|no_such_host)/i) {
6419: return %returnhash;
6420: }
1.667 albertel 6421: foreach my $item (split(/\&/,$rep)) {
6422: my ($key,$value)=split(/=/,$item);
6423: $returnhash{&unescape($key)}=&thaw_unescape($value);
6424: }
6425: return %returnhash;
6426: }
6427:
1.1113 raeburn 6428: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 6429: sub tmpdel {
6430: my ($token,$server)=@_;
6431: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6432: return &reply("tmpdel:$token",$server);
6433: }
6434:
1.1172.2.13 raeburn 6435: # ------------------------------------------------------------ get_timebased_id
6436:
6437: sub get_timebased_id {
6438: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6439: $maxtries) = @_;
6440: my ($newid,$error,$dellock);
6441: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6442: return ('','ok','invalid call to get suffix');
6443: }
6444:
6445: # set defaults for any optional args for which values were not supplied
6446: if ($who eq '') {
6447: $who = $env{'user.name'}.':'.$env{'user.domain'};
6448: }
6449: if (!$locktries) {
6450: $locktries = 3;
6451: }
6452: if (!$maxtries) {
6453: $maxtries = 10;
6454: }
6455:
6456: if (($cdom eq '') || ($cnum eq '')) {
6457: if ($env{'request.course.id'}) {
6458: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6459: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6460: }
6461: if (($cdom eq '') || ($cnum eq '')) {
6462: return ('','ok','call to get suffix not in course context');
6463: }
6464: }
6465:
6466: # construct locking item
6467: my $lockhash = {
6468: $prefix."\0".'locked_'.$keyid => $who,
6469: };
6470: my $tries = 0;
6471:
6472: # attempt to get lock on nohist_$namespace file
6473: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6474: while (($gotlock ne 'ok') && $tries <$locktries) {
6475: $tries ++;
6476: sleep 1;
6477: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6478: }
6479:
6480: # attempt to get unique identifier, based on current timestamp
6481: if ($gotlock eq 'ok') {
6482: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6483: my $id = time;
6484: $newid = $id;
1.1172.2.56 raeburn 6485: if ($idtype eq 'addcode') {
6486: $newid .= &sixnum_code();
6487: }
1.1172.2.13 raeburn 6488: my $idtries = 0;
6489: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6490: if ($idtype eq 'concat') {
6491: $newid = $id.$idtries;
1.1172.2.56 raeburn 6492: } elsif ($idtype eq 'addcode') {
6493: $newid = $newid.&sixnum_code();
1.1172.2.13 raeburn 6494: } else {
6495: $newid ++;
6496: }
6497: $idtries ++;
6498: }
6499: if (!exists($inuse{$prefix."\0".$newid})) {
6500: my %new_item = (
6501: $prefix."\0".$newid => $who,
6502: );
6503: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6504: $cdom,$cnum);
6505: if ($putresult ne 'ok') {
6506: undef($newid);
6507: $error = 'error saving new item: '.$putresult;
6508: }
6509: } else {
1.1172.2.56 raeburn 6510: undef($newid);
1.1172.2.13 raeburn 6511: $error = ('error: no unique suffix available for the new item ');
6512: }
6513: # remove lock
6514: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6515: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6516: } else {
6517: $error = "error: could not obtain lockfile\n";
6518: $dellock = 'ok';
1.1172.2.58 raeburn 6519: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6520: $dellock = 'nolock';
6521: }
1.1172.2.13 raeburn 6522: }
6523: return ($newid,$dellock,$error);
6524: }
6525:
1.1172.2.56 raeburn 6526: sub sixnum_code {
6527: my $code;
6528: for (0..6) {
6529: $code .= int( rand(9) );
6530: }
6531: return $code;
6532: }
6533:
1.765 albertel 6534: # -------------------------------------------------- portfolio access checking
6535:
6536: sub portfolio_access {
1.1172.2.77 raeburn 6537: my ($requrl,$clientip) = @_;
1.765 albertel 6538: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1172.2.77 raeburn 6539: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 6540: if ($result) {
6541: my %setters;
6542: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6543: my ($startblock,$endblock) =
6544: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6545: if ($startblock && $endblock) {
6546: return 'B';
6547: }
6548: } else {
6549: my ($startblock,$endblock) =
6550: &Apache::loncommon::blockcheck(\%setters,'port');
6551: if ($startblock && $endblock) {
6552: return 'B';
6553: }
6554: }
6555: }
1.765 albertel 6556: if ($result eq 'ok') {
1.766 albertel 6557: return 'F';
1.765 albertel 6558: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 6559: return 'A';
1.765 albertel 6560: }
1.766 albertel 6561: return '';
1.765 albertel 6562: }
6563:
6564: sub get_portfolio_access {
1.1172.2.77 raeburn 6565: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 6566:
6567: if (!ref($access_hash)) {
6568: my $current_perms = &get_portfile_permissions($udom,$unum);
6569: my %access_controls = &get_access_controls($current_perms,$group,
6570: $file_name);
6571: $access_hash = $access_controls{$file_name};
6572: }
6573:
1.1172.2.77 raeburn 6574: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 6575: my $now = time;
6576: if (ref($access_hash) eq 'HASH') {
6577: foreach my $key (keys(%{$access_hash})) {
6578: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6579: if ($start > $now) {
6580: next;
6581: }
6582: if ($end && $end<$now) {
6583: next;
6584: }
6585: if ($scope eq 'public') {
6586: $public = $key;
6587: last;
6588: } elsif ($scope eq 'guest') {
6589: $guest = $key;
6590: } elsif ($scope eq 'domains') {
6591: push(@domains,$key);
6592: } elsif ($scope eq 'users') {
6593: push(@users,$key);
6594: } elsif ($scope eq 'course') {
6595: push(@courses,$key);
6596: } elsif ($scope eq 'group') {
6597: push(@groups,$key);
1.1172.2.77 raeburn 6598: } elsif ($scope eq 'ip') {
6599: push(@ips,$key);
1.765 albertel 6600: }
6601: }
6602: if ($public) {
6603: return 'ok';
1.1172.2.77 raeburn 6604: } elsif (@ips > 0) {
6605: my $allowed;
6606: foreach my $ipkey (@ips) {
6607: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6608: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6609: $allowed = 1;
6610: last;
6611: }
6612: }
6613: }
6614: if ($allowed) {
6615: return 'ok';
6616: }
1.765 albertel 6617: }
6618: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6619: if ($guest) {
6620: return $guest;
6621: }
6622: } else {
6623: if (@domains > 0) {
6624: foreach my $domkey (@domains) {
6625: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6626: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6627: return 'ok';
6628: }
6629: }
6630: }
6631: }
6632: if (@users > 0) {
6633: foreach my $userkey (@users) {
1.865 raeburn 6634: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6635: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6636: if (ref($item) eq 'HASH') {
6637: if (($item->{'uname'} eq $env{'user.name'}) &&
6638: ($item->{'udom'} eq $env{'user.domain'})) {
6639: return 'ok';
6640: }
6641: }
6642: }
6643: }
1.765 albertel 6644: }
6645: }
6646: my %roleshash;
6647: my @courses_and_groups = @courses;
6648: push(@courses_and_groups,@groups);
6649: if (@courses_and_groups > 0) {
6650: my (%allgroups,%allroles);
6651: my ($start,$end,$role,$sec,$group);
6652: foreach my $envkey (%env) {
1.1060 raeburn 6653: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6654: my $cid = $2.'_'.$3;
6655: if ($1 eq 'gr') {
6656: $group = $4;
6657: $allgroups{$cid}{$group} = $env{$envkey};
6658: } else {
6659: if ($4 eq '') {
6660: $sec = 'none';
6661: } else {
6662: $sec = $4;
6663: }
6664: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6665: }
1.811 albertel 6666: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6667: my $cid = $2.'_'.$3;
6668: if ($4 eq '') {
6669: $sec = 'none';
6670: } else {
6671: $sec = $4;
6672: }
6673: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6674: }
6675: }
6676: if (keys(%allroles) == 0) {
6677: return;
6678: }
6679: foreach my $key (@courses_and_groups) {
6680: my %content = %{$$access_hash{$key}};
6681: my $cnum = $content{'number'};
6682: my $cdom = $content{'domain'};
6683: my $cid = $cdom.'_'.$cnum;
6684: if (!exists($allroles{$cid})) {
6685: next;
6686: }
6687: foreach my $role_id (keys(%{$content{'roles'}})) {
6688: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6689: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6690: my @status = @{$content{'roles'}{$role_id}{'access'}};
6691: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6692: foreach my $role (keys(%{$allroles{$cid}})) {
6693: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6694: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6695: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6696: if (grep/^all$/,@sections) {
6697: return 'ok';
6698: } else {
6699: if (grep/^$sec$/,@sections) {
6700: return 'ok';
6701: }
6702: }
6703: }
6704: }
6705: if (keys(%{$allgroups{$cid}}) == 0) {
6706: if (grep/^none$/,@groups) {
6707: return 'ok';
6708: }
6709: } else {
6710: if (grep/^all$/,@groups) {
6711: return 'ok';
6712: }
6713: foreach my $group (keys(%{$allgroups{$cid}})) {
6714: if (grep/^$group$/,@groups) {
6715: return 'ok';
6716: }
6717: }
6718: }
6719: }
6720: }
6721: }
6722: }
6723: }
6724: if ($guest) {
6725: return $guest;
6726: }
6727: }
6728: }
6729: return;
6730: }
6731:
6732: sub course_group_datechecker {
6733: my ($dates,$now,$status) = @_;
6734: my ($start,$end) = split(/\./,$dates);
6735: if (!$start && !$end) {
6736: return 'ok';
6737: }
6738: if (grep/^active$/,@{$status}) {
6739: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6740: return 'ok';
6741: }
6742: }
6743: if (grep/^previous$/,@{$status}) {
6744: if ($end > $now ) {
6745: return 'ok';
6746: }
6747: }
6748: if (grep/^future$/,@{$status}) {
6749: if ($start > $now) {
6750: return 'ok';
6751: }
6752: }
6753: return;
6754: }
6755:
6756: sub parse_portfolio_url {
6757: my ($url) = @_;
6758:
6759: my ($type,$udom,$unum,$group,$file_name);
6760:
1.823 albertel 6761: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 6762: $type = 1;
6763: $udom = $1;
6764: $unum = $2;
6765: $file_name = $3;
1.823 albertel 6766: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 6767: $type = 2;
6768: $udom = $1;
6769: $unum = $2;
6770: $group = $3;
6771: $file_name = $3.'/'.$4;
6772: }
6773: if (wantarray) {
6774: return ($type,$udom,$unum,$file_name,$group);
6775: }
6776: return $type;
6777: }
6778:
6779: sub is_portfolio_url {
6780: my ($url) = @_;
6781: return scalar(&parse_portfolio_url($url));
6782: }
6783:
1.798 raeburn 6784: sub is_portfolio_file {
6785: my ($file) = @_;
1.820 raeburn 6786: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 6787: return 1;
6788: }
6789: return;
6790: }
6791:
1.976 raeburn 6792: sub usertools_access {
1.1084 raeburn 6793: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 6794: my ($access,%tools);
6795: if ($context eq '') {
6796: $context = 'tools';
6797: }
6798: if ($context eq 'requestcourses') {
6799: %tools = (
6800: official => 1,
6801: unofficial => 1,
1.1006 raeburn 6802: community => 1,
1.1172.2.37 raeburn 6803: textbook => 1,
1.985 raeburn 6804: );
1.1172.2.9 raeburn 6805: } elsif ($context eq 'requestauthor') {
6806: %tools = (
6807: requestauthor => 1,
6808: );
1.985 raeburn 6809: } else {
6810: %tools = (
6811: aboutme => 1,
6812: blog => 1,
1.1172.2.6 raeburn 6813: webdav => 1,
1.985 raeburn 6814: portfolio => 1,
6815: );
6816: }
1.976 raeburn 6817: return if (!defined($tools{$tool}));
6818:
1.1172.2.35 raeburn 6819: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 6820: $udom = $env{'user.domain'};
6821: $uname = $env{'user.name'};
6822: }
6823:
1.978 raeburn 6824: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6825: if ($action ne 'reload') {
1.985 raeburn 6826: if ($context eq 'requestcourses') {
6827: return $env{'environment.canrequest.'.$tool};
1.1172.2.9 raeburn 6828: } elsif ($context eq 'requestauthor') {
6829: return $env{'environment.canrequest.author'};
1.985 raeburn 6830: } else {
6831: return $env{'environment.availabletools.'.$tool};
6832: }
6833: }
1.976 raeburn 6834: }
6835:
1.1172.2.9 raeburn 6836: my ($toolstatus,$inststatus,$envkey);
6837: if ($context eq 'requestauthor') {
6838: $envkey = $context;
6839: } else {
6840: $envkey = $context.'.'.$tool;
6841: }
1.976 raeburn 6842:
1.985 raeburn 6843: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6844: ($action ne 'reload')) {
1.1172.2.9 raeburn 6845: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 6846: $inststatus = $env{'environment.inststatus'};
6847: } else {
1.1084 raeburn 6848: if (ref($userenvref) eq 'HASH') {
1.1172.2.9 raeburn 6849: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 6850: $inststatus = $userenvref->{'inststatus'};
6851: } else {
1.1172.2.9 raeburn 6852: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6853: $toolstatus = $userenv{$envkey};
1.1084 raeburn 6854: $inststatus = $userenv{'inststatus'};
6855: }
1.976 raeburn 6856: }
6857:
6858: if ($toolstatus ne '') {
6859: if ($toolstatus) {
6860: $access = 1;
6861: } else {
6862: $access = 0;
6863: }
6864: return $access;
6865: }
6866:
1.1084 raeburn 6867: my ($is_adv,%domdef);
6868: if (ref($is_advref) eq 'HASH') {
6869: $is_adv = $is_advref->{'is_adv'};
6870: } else {
6871: $is_adv = &is_advanced_user($udom,$uname);
6872: }
6873: if (ref($domdefref) eq 'HASH') {
6874: %domdef = %{$domdefref};
6875: } else {
6876: %domdef = &get_domain_defaults($udom);
6877: }
1.976 raeburn 6878: if (ref($domdef{$tool}) eq 'HASH') {
6879: if ($is_adv) {
6880: if ($domdef{$tool}{'_LC_adv'} ne '') {
6881: if ($domdef{$tool}{'_LC_adv'}) {
6882: $access = 1;
6883: } else {
6884: $access = 0;
6885: }
6886: return $access;
6887: }
6888: }
6889: if ($inststatus ne '') {
6890: my ($hasaccess,$hasnoaccess);
6891: foreach my $affiliation (split(/:/,$inststatus)) {
6892: if ($domdef{$tool}{$affiliation} ne '') {
6893: if ($domdef{$tool}{$affiliation}) {
6894: $hasaccess = 1;
6895: } else {
6896: $hasnoaccess = 1;
6897: }
6898: }
6899: }
6900: if ($hasaccess || $hasnoaccess) {
6901: if ($hasaccess) {
6902: $access = 1;
6903: } elsif ($hasnoaccess) {
6904: $access = 0;
6905: }
6906: return $access;
6907: }
6908: } else {
6909: if ($domdef{$tool}{'default'} ne '') {
6910: if ($domdef{$tool}{'default'}) {
6911: $access = 1;
6912: } elsif ($domdef{$tool}{'default'} == 0) {
6913: $access = 0;
6914: }
6915: return $access;
6916: }
6917: }
6918: } else {
1.1172.2.6 raeburn 6919: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 6920: $access = 1;
6921: } else {
6922: $access = 0;
6923: }
1.976 raeburn 6924: return $access;
6925: }
6926: }
6927:
1.1050 raeburn 6928: sub is_course_owner {
6929: my ($cdom,$cnum,$udom,$uname) = @_;
6930: if (($udom eq '') || ($uname eq '')) {
6931: $udom = $env{'user.domain'};
6932: $uname = $env{'user.name'};
6933: }
6934: unless (($udom eq '') || ($uname eq '')) {
6935: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6936: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6937: return 1;
6938: } else {
6939: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6940: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6941: return 1;
6942: }
6943: }
6944: }
6945: }
6946: return;
6947: }
6948:
1.976 raeburn 6949: sub is_advanced_user {
6950: my ($udom,$uname) = @_;
1.1085 raeburn 6951: if ($udom ne '' && $uname ne '') {
6952: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 6953: if (wantarray) {
6954: return ($env{'user.adv'},$env{'user.author'});
6955: } else {
6956: return $env{'user.adv'};
6957: }
1.1085 raeburn 6958: }
6959: }
1.976 raeburn 6960: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6961: my %allroles;
1.1128 raeburn 6962: my ($is_adv,$is_author);
1.976 raeburn 6963: foreach my $role (keys(%roleshash)) {
6964: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6965: my $area = '/'.$tdomain.'/'.$trest;
6966: if ($sec ne '') {
6967: $area .= '/'.$sec;
6968: }
6969: if (($area ne '') && ($trole ne '')) {
6970: my $spec=$trole.'.'.$area;
6971: if ($trole =~ /^cr\//) {
6972: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6973: } elsif ($trole ne 'gr') {
6974: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6975: }
1.1128 raeburn 6976: if ($trole eq 'au') {
6977: $is_author = 1;
6978: }
1.976 raeburn 6979: }
6980: }
6981: foreach my $role (keys(%allroles)) {
6982: last if ($is_adv);
6983: foreach my $item (split(/:/,$allroles{$role})) {
6984: if ($item ne '') {
6985: my ($privilege,$restrictions)=split(/&/,$item);
6986: if ($privilege eq 'adv') {
6987: $is_adv = 1;
6988: last;
6989: }
6990: }
6991: }
6992: }
1.1128 raeburn 6993: if (wantarray) {
6994: return ($is_adv,$is_author);
6995: }
1.976 raeburn 6996: return $is_adv;
6997: }
1.798 raeburn 6998:
1.1035 raeburn 6999: sub check_can_request {
1.1036 raeburn 7000: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 7001: my $canreq = 0;
7002: my ($types,$typename) = &Apache::loncommon::course_types();
7003: my @options = ('approval','validate','autolimit');
7004: my $optregex = join('|',@options);
7005: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
7006: foreach my $type (@{$types}) {
7007: if (&usertools_access($env{'user.name'},
7008: $env{'user.domain'},
7009: $type,undef,'requestcourses')) {
7010: $canreq ++;
1.1036 raeburn 7011: if (ref($request_domains) eq 'HASH') {
7012: push(@{$request_domains->{$type}},$env{'user.domain'});
7013: }
1.1035 raeburn 7014: if ($dom eq $env{'user.domain'}) {
7015: $can_request->{$type} = 1;
7016: }
7017: }
7018: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
7019: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
7020: if (@curr > 0) {
1.1036 raeburn 7021: foreach my $item (@curr) {
7022: if (ref($request_domains) eq 'HASH') {
7023: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
7024: if ($otherdom ne '') {
7025: if (ref($request_domains->{$type}) eq 'ARRAY') {
7026: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
7027: push(@{$request_domains->{$type}},$otherdom);
7028: }
7029: } else {
7030: push(@{$request_domains->{$type}},$otherdom);
7031: }
7032: }
7033: }
7034: }
7035: unless($dom eq $env{'user.domain'}) {
7036: $canreq ++;
1.1035 raeburn 7037: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
7038: $can_request->{$type} = 1;
7039: }
7040: }
7041: }
7042: }
7043: }
7044: }
7045: return $canreq;
7046: }
7047:
1.341 www 7048: # ---------------------------------------------- Custom access rule evaluation
7049:
7050: sub customaccess {
7051: my ($priv,$uri)=@_;
1.807 albertel 7052: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 7053: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 7054: $udom = &LONCAPA::clean_domain($udom);
7055: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 7056: my $access=0;
1.800 albertel 7057: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 7058: my ($effect,$realm,$role,$type)=split(/\:/,$right);
7059: if ($type eq 'user') {
7060: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 7061: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 7062: if ($tdom) {
7063: if ($tdom ne $env{'user.domain'}) { next; }
7064: }
1.896 albertel 7065: if ($tuname) {
7066: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 7067: }
7068: $access=($effect eq 'allow');
7069: last;
7070: }
7071: } else {
7072: if ($role) {
7073: if ($role ne $urole) { next; }
7074: }
7075: foreach my $scope (split(/\s*\,\s*/,$realm)) {
7076: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
7077: if ($tdom) {
7078: if ($tdom ne $udom) { next; }
7079: }
7080: if ($tcrs) {
7081: if ($tcrs ne $ucrs) { next; }
7082: }
7083: if ($tsec) {
7084: if ($tsec ne $usec) { next; }
7085: }
7086: $access=($effect eq 'allow');
7087: last;
7088: }
7089: if ($realm eq '' && $role eq '') {
7090: $access=($effect eq 'allow');
7091: }
1.402 bowersj2 7092: }
1.341 www 7093: }
7094: return $access;
7095: }
7096:
1.103 harris41 7097: # ------------------------------------------------- Check for a user privilege
1.12 www 7098:
7099: sub allowed {
1.1172.2.65 raeburn 7100: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
1.705 albertel 7101: my $ver_orguri=$uri;
1.439 www 7102: $uri=&deversion($uri);
1.152 www 7103: my $orguri=$uri;
1.52 www 7104: $uri=&declutter($uri);
1.809 raeburn 7105:
1.810 raeburn 7106: if ($priv eq 'evb') {
7107: # Evade communication block restrictions for specified role in a course
7108: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
7109: return $1;
7110: } else {
7111: return;
7112: }
7113: }
7114:
1.620 albertel 7115: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 7116: # Free bre access to adm and meta resources
1.775 albertel 7117: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 7118: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
7119: && ($priv eq 'bre')) {
1.14 www 7120: return 'F';
1.159 www 7121: }
7122:
1.545 banghart 7123: # Free bre access to user's own portfolio contents
1.714 raeburn 7124: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 7125: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 7126: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 7127: my %setters;
7128: my ($startblock,$endblock) =
7129: &Apache::loncommon::blockcheck(\%setters,'port');
7130: if ($startblock && $endblock) {
7131: return 'B';
7132: } else {
7133: return 'F';
7134: }
1.545 banghart 7135: }
7136:
1.762 raeburn 7137: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 7138: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
7139: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
7140: if (exists($env{'request.course.id'})) {
7141: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7142: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7143: if (($domain eq $cdom) && ($name eq $cnum)) {
7144: my $courseprivid=$env{'request.course.id'};
7145: $courseprivid=~s/\_/\//;
7146: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
7147: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
7148: return $1;
1.762 raeburn 7149: } else {
7150: if ($env{'request.course.sec'}) {
7151: $courseprivid.='/'.$env{'request.course.sec'};
7152: }
7153: if ($env{'user.priv.'.$env{'request.role'}.'./'.
7154: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
7155: return $2;
7156: }
1.714 raeburn 7157: }
7158: }
7159: }
7160: }
7161:
1.159 www 7162: # Free bre to public access
7163:
7164: if ($priv eq 'bre') {
1.238 www 7165: my $copyright=&metadata($uri,'copyright');
1.620 albertel 7166: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 7167: return 'F';
7168: }
1.238 www 7169: if ($copyright eq 'priv') {
7170: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7171: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 7172: return '';
7173: }
7174: }
7175: if ($copyright eq 'domain') {
7176: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 7177: unless (($env{'user.domain'} eq $1) ||
7178: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 7179: return '';
7180: }
1.262 matthew 7181: }
1.620 albertel 7182: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 7183: # Library role, so allow browsing of resources in this domain.
7184: return 'F';
1.238 www 7185: }
1.341 www 7186: if ($copyright eq 'custom') {
7187: unless (&customaccess($priv,$uri)) { return ''; }
7188: }
1.14 www 7189: }
1.264 matthew 7190: # Domain coordinator is trying to create a course
1.620 albertel 7191: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 7192: # uri is the requested domain in this case.
7193: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 7194: # a role of dc for the domain in question.
1.620 albertel 7195: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 7196: }
1.29 www 7197:
1.52 www 7198: my $thisallowed='';
7199: my $statecond=0;
7200: my $courseprivid='';
7201:
1.1039 raeburn 7202: my $ownaccess;
1.1043 raeburn 7203: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 7204: if (($priv eq 'bro') && ($env{'user.author'})) {
7205: if ($uri eq '') {
7206: $ownaccess = 1;
7207: } else {
7208: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
7209: my $udom = $env{'user.domain'};
7210: my $uname = $env{'user.name'};
7211: if ($uri =~ m{^\Q$udom\E/?$}) {
7212: $ownaccess = 1;
1.1040 raeburn 7213: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 7214: unless ($uri =~ m{\.\./}) {
7215: $ownaccess = 1;
7216: }
7217: } elsif (($udom ne 'public') && ($uname ne 'public')) {
7218: my $now = time;
7219: if ($uri =~ m{^([^/]+)/?$}) {
7220: my $adom = $1;
7221: foreach my $key (keys(%env)) {
1.1042 raeburn 7222: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 7223: my ($start,$end) = split('.',$env{$key});
7224: if (($now >= $start) && (!$end || $end < $now)) {
7225: $ownaccess = 1;
7226: last;
7227: }
7228: }
7229: }
7230: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
7231: my $adom = $1;
7232: my $aname = $2;
1.1042 raeburn 7233: foreach my $role ('ca','aa') {
7234: if ($env{"user.role.$role./$adom/$aname"}) {
7235: my ($start,$end) =
7236: split('.',$env{"user.role.$role./$adom/$aname"});
7237: if (($now >= $start) && (!$end || $end < $now)) {
7238: $ownaccess = 1;
7239: last;
7240: }
1.1039 raeburn 7241: }
7242: }
7243: }
7244: }
7245: }
7246: }
7247: }
7248:
1.52 www 7249: # Course
7250:
1.620 albertel 7251: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7252: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7253: $thisallowed.=$1;
7254: }
1.52 www 7255: }
1.29 www 7256:
1.52 www 7257: # Domain
7258:
1.620 albertel 7259: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 7260: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7261: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7262: $thisallowed.=$1;
7263: }
1.12 www 7264: }
1.52 www 7265:
1.1141 raeburn 7266: # User who is not author or co-author might still be able to edit
7267: # resource of an author in the domain (e.g., if Domain Coordinator).
7268: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
7269: (&allowed('mdc',$env{'request.course.id'}))) {
7270: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
7271: $thisallowed.=$1;
7272: }
7273: }
7274:
1.52 www 7275: # Course: uri itself is a course
1.66 www 7276: my $courseuri=$uri;
7277: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 7278: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 7279:
1.620 albertel 7280: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 7281: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 7282: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 7283: $thisallowed.=$1;
7284: }
1.12 www 7285: }
1.29 www 7286:
1.665 albertel 7287: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 7288: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 7289: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 7290: $thisallowed='';
1.671 raeburn 7291: my ($match)=&is_on_map($uri);
7292: if ($match) {
7293: if ($env{'user.priv.'.$env{'request.role'}.'./'}
7294: =~/\Q$priv\E\&([^\:]*)/) {
1.1172.2.65 raeburn 7295: my $value = $1;
7296: if ($noblockcheck) {
7297: $thisallowed.=$value;
1.1162 raeburn 7298: } else {
1.1172.2.65 raeburn 7299: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7300: if (@blockers > 0) {
7301: $thisallowed = 'B';
7302: } else {
7303: $thisallowed.=$value;
7304: }
1.1162 raeburn 7305: }
1.671 raeburn 7306: }
7307: } else {
1.705 albertel 7308: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 7309: if ($refuri) {
7310: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 7311: $thisallowed='F';
1.671 raeburn 7312: } else {
7313: $refuri=&declutter($refuri);
7314: my ($match) = &is_on_map($refuri);
7315: if ($match) {
1.1172.2.65 raeburn 7316: if ($noblockcheck) {
1.1162 raeburn 7317: $thisallowed='F';
1.1172.2.65 raeburn 7318: } else {
7319: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7320: if (@blockers > 0) {
7321: $thisallowed = 'B';
7322: } else {
7323: $thisallowed='F';
7324: }
1.1162 raeburn 7325: }
1.671 raeburn 7326: }
1.669 raeburn 7327: }
1.671 raeburn 7328: }
7329: }
1.314 www 7330: }
1.492 albertel 7331:
1.766 albertel 7332: if ($priv eq 'bre'
7333: && $thisallowed ne 'F'
7334: && $thisallowed ne '2'
7335: && &is_portfolio_url($uri)) {
1.1172.2.77 raeburn 7336: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 7337: }
7338:
1.52 www 7339: # Full access at system, domain or course-wide level? Exit.
1.29 www 7340: if ($thisallowed=~/F/) {
7341: return 'F';
7342: }
7343:
1.52 www 7344: # If this is generating or modifying users, exit with special codes
1.29 www 7345:
1.643 www 7346: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
7347: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 7348: my ($audom,$auname)=split('/',$uri);
1.643 www 7349: # no author name given, so this just checks on the general right to make a co-author in this domain
7350: unless ($auname) { return $thisallowed; }
7351: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 7352: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
7353: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
7354: ($audom ne $env{'request.role.domain'}))) { return ''; }
7355: }
1.52 www 7356: return $thisallowed;
7357: }
7358: #
1.103 harris41 7359: # Gathered so far: system, domain and course wide privileges
1.52 www 7360: #
7361: # Course: See if uri or referer is an individual resource that is part of
7362: # the course
7363:
1.620 albertel 7364: if ($env{'request.course.id'}) {
1.232 www 7365:
1.620 albertel 7366: $courseprivid=$env{'request.course.id'};
7367: if ($env{'request.course.sec'}) {
7368: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 7369: }
7370: $courseprivid=~s/\_/\//;
7371: my $checkreferer=1;
1.232 www 7372: my ($match,$cond)=&is_on_map($uri);
7373: if ($match) {
7374: $statecond=$cond;
1.620 albertel 7375: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7376: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7377: my $value = $1;
7378: if ($priv eq 'bre') {
1.1172.2.65 raeburn 7379: if ($noblockcheck) {
1.1162 raeburn 7380: $thisallowed.=$value;
1.1172.2.65 raeburn 7381: } else {
7382: my @blockers = &has_comm_blocking($priv,$symb,$uri);
7383: if (@blockers > 0) {
7384: $thisallowed = 'B';
7385: } else {
7386: $thisallowed.=$value;
7387: }
1.1162 raeburn 7388: }
7389: } else {
7390: $thisallowed.=$value;
7391: }
1.52 www 7392: $checkreferer=0;
7393: }
1.29 www 7394: }
1.83 www 7395:
1.148 www 7396: if ($checkreferer) {
1.620 albertel 7397: my $refuri=$env{'httpref.'.$orguri};
1.148 www 7398: unless ($refuri) {
1.800 albertel 7399: foreach my $key (keys(%env)) {
7400: if ($key=~/^httpref\..*\*/) {
7401: my $pattern=$key;
1.156 www 7402: $pattern=~s/^httpref\.\/res\///;
1.148 www 7403: $pattern=~s/\*/\[\^\/\]\+/g;
7404: $pattern=~s/\//\\\//g;
1.152 www 7405: if ($orguri=~/$pattern/) {
1.800 albertel 7406: $refuri=$env{$key};
1.148 www 7407: }
7408: }
1.191 harris41 7409: }
1.148 www 7410: }
1.232 www 7411:
1.148 www 7412: if ($refuri) {
1.152 www 7413: $refuri=&declutter($refuri);
1.232 www 7414: my ($match,$cond)=&is_on_map($refuri);
7415: if ($match) {
7416: my $refstatecond=$cond;
1.620 albertel 7417: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7418: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7419: my $value = $1;
7420: if ($priv eq 'bre') {
1.1172.2.65 raeburn 7421: if ($noblockcheck) {
1.1162 raeburn 7422: $thisallowed.=$value;
1.1172.2.65 raeburn 7423: } else {
7424: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7425: if (@blockers > 0) {
7426: $thisallowed = 'B';
7427: } else {
7428: $thisallowed.=$value;
7429: }
1.1162 raeburn 7430: }
7431: } else {
7432: $thisallowed.=$value;
7433: }
1.53 www 7434: $uri=$refuri;
7435: $statecond=$refstatecond;
1.52 www 7436: }
7437: }
1.148 www 7438: }
1.29 www 7439: }
1.52 www 7440: }
1.29 www 7441:
1.52 www 7442: #
1.103 harris41 7443: # Gathered now: all privileges that could apply, and condition number
1.52 www 7444: #
7445: #
7446: # Full or no access?
7447: #
1.29 www 7448:
1.52 www 7449: if ($thisallowed=~/F/) {
7450: return 'F';
7451: }
1.29 www 7452:
1.52 www 7453: unless ($thisallowed) {
7454: return '';
7455: }
1.29 www 7456:
1.52 www 7457: # Restrictions exist, deal with them
7458: #
7459: # C:according to course preferences
7460: # R:according to resource settings
7461: # L:unless locked
7462: # X:according to user session state
7463: #
7464:
7465: # Possibly locked functionality, check all courses
1.54 www 7466: # Locks might take effect only after 10 minutes cache expiration for other
7467: # courses, and 2 minutes for current course
1.52 www 7468:
7469: my $envkey;
7470: if ($thisallowed=~/L/) {
1.1000 raeburn 7471: foreach $envkey (keys(%env)) {
1.54 www 7472: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7473: my $courseid=$2;
7474: my $roleid=$1.'.'.$2;
1.92 www 7475: $courseid=~s/^\///;
1.54 www 7476: my $expiretime=600;
1.620 albertel 7477: if ($env{'request.role'} eq $roleid) {
1.54 www 7478: $expiretime=120;
7479: }
7480: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7481: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 7482: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 7483: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 7484: }
1.620 albertel 7485: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7486: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7487: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7488: &log($env{'user.domain'},$env{'user.name'},
7489: $env{'user.home'},
1.57 www 7490: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 7491: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7492: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7493: return '';
7494: }
7495: }
1.620 albertel 7496: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7497: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7498: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7499: &log($env{'user.domain'},$env{'user.name'},
7500: $env{'user.home'},
1.57 www 7501: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 7502: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7503: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7504: return '';
7505: }
7506: }
7507: }
1.29 www 7508: }
1.52 www 7509: }
7510:
7511: #
7512: # Rest of the restrictions depend on selected course
7513: #
7514:
1.620 albertel 7515: unless ($env{'request.course.id'}) {
1.766 albertel 7516: if ($thisallowed eq 'A') {
7517: return 'A';
1.814 raeburn 7518: } elsif ($thisallowed eq 'B') {
7519: return 'B';
1.766 albertel 7520: } else {
7521: return '1';
7522: }
1.52 www 7523: }
1.29 www 7524:
1.52 www 7525: #
7526: # Now user is definitely in a course
7527: #
1.53 www 7528:
7529:
7530: # Course preferences
7531:
7532: if ($thisallowed=~/C/) {
1.620 albertel 7533: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7534: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7535: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 7536: =~/\Q$rolecode\E/) {
1.1103 raeburn 7537: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7538: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7539: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7540: $env{'request.course.id'});
7541: }
1.237 www 7542: return '';
7543: }
7544:
1.620 albertel 7545: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 7546: =~/\Q$unamedom\E/) {
1.1103 raeburn 7547: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7548: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7549: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7550: $env{'request.course.id'});
7551: }
1.54 www 7552: return '';
7553: }
1.53 www 7554: }
7555:
7556: # Resource preferences
7557:
7558: if ($thisallowed=~/R/) {
1.620 albertel 7559: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 7560: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 7561: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7562: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7563: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7564: }
7565: return '';
1.54 www 7566: }
1.53 www 7567: }
1.30 www 7568:
1.246 www 7569: # Restricted by state or randomout?
1.30 www 7570:
1.52 www 7571: if ($thisallowed=~/X/) {
1.620 albertel 7572: if ($env{'acc.randomout'}) {
1.579 albertel 7573: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 7574: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 7575: return '';
7576: }
1.247 www 7577: }
7578: if (&condval($statecond)) {
1.52 www 7579: return '2';
7580: } else {
7581: return '';
7582: }
7583: }
1.30 www 7584:
1.766 albertel 7585: if ($thisallowed eq 'A') {
7586: return 'A';
1.814 raeburn 7587: } elsif ($thisallowed eq 'B') {
7588: return 'B';
1.766 albertel 7589: }
1.52 www 7590: return 'F';
1.232 www 7591: }
1.1162 raeburn 7592:
1.1172.2.13 raeburn 7593: # ------------------------------------------- Check construction space access
7594:
7595: sub constructaccess {
7596: my ($url,$setpriv)=@_;
7597:
7598: # We do not allow editing of previous versions of files
7599: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7600:
7601: # Get username and domain from URL
7602: my ($ownername,$ownerdomain,$ownerhome);
7603:
7604: ($ownerdomain,$ownername) =
1.1172.2.83 raeburn 7605: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)(?:/|$)});
1.1172.2.13 raeburn 7606:
7607: # The URL does not really point to any authorspace, forget it
7608: unless (($ownername) && ($ownerdomain)) { return ''; }
7609:
7610: # Now we need to see if the user has access to the authorspace of
7611: # $ownername at $ownerdomain
7612:
7613: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7614: # Real author for this?
7615: $ownerhome = $env{'user.home'};
7616: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7617: return ($ownername,$ownerdomain,$ownerhome);
7618: }
7619: } else {
7620: # Co-author for this?
7621: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7622: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7623: $ownerhome = &homeserver($ownername,$ownerdomain);
7624: return ($ownername,$ownerdomain,$ownerhome);
7625: }
7626: }
7627:
7628: # We don't have any access right now. If we are not possibly going to do anything about this,
7629: # we might as well leave
7630: unless ($setpriv) { return ''; }
7631:
7632: # Backdoor access?
7633: my $allowed=&allowed('eco',$ownerdomain);
7634: # Nope
7635: unless ($allowed) { return ''; }
7636: # Looks like we may have access, but could be locked by the owner of the construction space
7637: if ($allowed eq 'U') {
7638: my %blocked=&get('environment',['domcoord.author'],
7639: $ownerdomain,$ownername);
7640: # Is blocked by owner
7641: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7642: }
7643: if (($allowed eq 'F') || ($allowed eq 'U')) {
7644: # Grant temporary access
7645: my $then=$env{'user.login.time'};
1.1172.2.16 raeburn 7646: my $update=$env{'user.update.time'};
1.1172.2.13 raeburn 7647: if (!$update) { $update = $then; }
7648: my $refresh=$env{'user.refresh.time'};
7649: if (!$refresh) { $refresh = $update; }
7650: my $now = time;
7651: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7652: $now,'ca','constructaccess');
7653: $ownerhome = &homeserver($ownername,$ownerdomain);
7654: return($ownername,$ownerdomain,$ownerhome);
7655: }
7656: # No business here
7657: return '';
7658: }
7659:
1.1172.2.66 raeburn 7660: # ----------------------------------------------------------- Content Blocking
7661:
7662: {
7663: # Caches for faster Course Contents display where content blocking
7664: # is in operation (i.e., interval param set) for timed quiz.
7665: #
7666: # User for whom data are being temporarily cached.
7667: my $cacheduser='';
7668: # Cached blockers for this user (a hash of blocking items).
7669: my %cachedblockers=();
7670: # When the data were last cached.
7671: my $cachedlast='';
7672:
7673: sub load_all_blockers {
7674: my ($uname,$udom,$blocks)=@_;
7675: if (($uname ne '') && ($udom ne '')) {
7676: if (($cacheduser eq $uname.':'.$udom) &&
7677: (abs($cachedlast-time)<5)) {
7678: return;
7679: }
7680: }
7681: $cachedlast=time;
7682: $cacheduser=$uname.':'.$udom;
7683: %cachedblockers = &get_commblock_resources($blocks);
7684: }
7685:
1.1162 raeburn 7686: sub get_comm_blocks {
7687: my ($cdom,$cnum) = @_;
7688: if ($cdom eq '' || $cnum eq '') {
7689: return unless ($env{'request.course.id'});
7690: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7691: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7692: }
7693: my %commblocks;
7694: my $hashid=$cdom.'_'.$cnum;
7695: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7696: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7697: %commblocks = %{$blocksref};
7698: } else {
7699: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7700: my $cachetime = 600;
7701: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7702: }
7703: return %commblocks;
7704: }
7705:
1.1172.2.66 raeburn 7706: sub get_commblock_resources {
7707: my ($blocks) = @_;
7708: my %blockers = ();
7709: return %blockers unless ($env{'request.course.id'});
7710: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
1.1162 raeburn 7711: my %commblocks;
7712: if (ref($blocks) eq 'HASH') {
7713: %commblocks = %{$blocks};
7714: } else {
7715: %commblocks = &get_comm_blocks();
7716: }
1.1172.2.66 raeburn 7717: return %blockers unless (keys(%commblocks) > 0);
1.1163 raeburn 7718: my $navmap = Apache::lonnavmaps::navmap->new();
1.1172.2.66 raeburn 7719: return %blockers unless (ref($navmap));
7720: my $now = time;
1.1162 raeburn 7721: foreach my $block (keys(%commblocks)) {
7722: if ($block =~ /^(\d+)____(\d+)$/) {
7723: my ($start,$end) = ($1,$2);
7724: if ($start <= $now && $end >= $now) {
7725: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7726: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7727: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1172.2.66 raeburn 7728: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7729: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 7730: }
7731: }
7732: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1172.2.66 raeburn 7733: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7734: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 7735: }
7736: }
7737: }
7738: }
7739: }
7740: } elsif ($block =~ /^firstaccess____(.+)$/) {
7741: my $item = $1;
1.1163 raeburn 7742: my @to_test;
1.1162 raeburn 7743: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7744: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1172.2.66 raeburn 7745: my @interval;
7746: my $type = 'map';
7747: if ($item eq 'course') {
7748: $type = 'course';
7749: @interval=&EXT("resource.0.interval");
7750: } else {
7751: if ($item =~ /___\d+___/) {
7752: $type = 'resource';
7753: @interval=&EXT("resource.0.interval",$item);
7754: if (ref($navmap)) {
7755: my $res = $navmap->getBySymb($item);
7756: push(@to_test,$res);
7757: }
1.1162 raeburn 7758: } else {
1.1172.2.66 raeburn 7759: my $mapsymb = &symbread($item,1);
7760: if ($mapsymb) {
7761: if (ref($navmap)) {
7762: my $mapres = $navmap->getBySymb($mapsymb);
7763: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
7764: foreach my $res (@to_test) {
7765: my $symb = $res->symb();
7766: next if ($symb eq $mapsymb);
7767: if ($symb ne '') {
7768: @interval=&EXT("resource.0.interval",$symb);
7769: if ($interval[1] eq 'map') {
7770: last;
1.1162 raeburn 7771: }
7772: }
7773: }
7774: }
7775: }
7776: }
1.1172.2.66 raeburn 7777: }
7778: if ($interval[0] =~ /^\d+$/) {
7779: my $first_access;
7780: if ($type eq 'resource') {
7781: $first_access=&get_first_access($interval[1],$item);
7782: } elsif ($type eq 'map') {
7783: $first_access=&get_first_access($interval[1],undef,$item);
7784: } else {
7785: $first_access=&get_first_access($interval[1]);
7786: }
7787: if ($first_access) {
7788: my $timesup = $first_access+$interval[0];
7789: if ($timesup > $now) {
7790: my $activeblock;
7791: foreach my $res (@to_test) {
7792: if ($res->answerable()) {
7793: $activeblock = 1;
7794: last;
7795: }
7796: }
7797: if ($activeblock) {
7798: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7799: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7800: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7801: }
7802: }
7803: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7804: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7805: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 7806: }
1.1162 raeburn 7807: }
7808: }
7809: }
7810: }
7811: }
7812: }
7813: }
7814: }
7815: }
1.1172.2.66 raeburn 7816: return %blockers;
1.1162 raeburn 7817: }
7818:
1.1172.2.66 raeburn 7819: sub has_comm_blocking {
7820: my ($priv,$symb,$uri,$blocks) = @_;
7821: my @blockers;
7822: return unless ($env{'request.course.id'});
7823: return unless ($priv eq 'bre');
7824: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7825: return if ($env{'request.state'} eq 'construct');
7826: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
7827: return unless (keys(%cachedblockers) > 0);
7828: my (%possibles,@symbs);
7829: if (!$symb) {
7830: $symb = &symbread($uri,1,1,1,\%possibles);
1.1162 raeburn 7831: }
1.1172.2.66 raeburn 7832: if ($symb) {
7833: @symbs = ($symb);
7834: } elsif (keys(%possibles)) {
7835: @symbs = keys(%possibles);
7836: }
7837: my $noblock;
7838: foreach my $symb (@symbs) {
7839: last if ($noblock);
7840: my ($map,$resid,$resurl)=&decode_symb($symb);
7841: foreach my $block (keys(%cachedblockers)) {
7842: if ($block =~ /^firstaccess____(.+)$/) {
7843: my $item = $1;
7844: if (($item eq $map) || ($item eq $symb)) {
7845: $noblock = 1;
7846: last;
7847: }
1.1162 raeburn 7848: }
1.1172.2.66 raeburn 7849: if (ref($cachedblockers{$block}) eq 'HASH') {
7850: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
7851: if ($cachedblockers{$block}{'resources'}{$symb}) {
7852: unless (grep(/^\Q$block\E$/,@blockers)) {
7853: push(@blockers,$block);
7854: }
7855: }
7856: }
7857: }
7858: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
7859: if ($cachedblockers{$block}{'maps'}{$map}) {
7860: unless (grep(/^\Q$block\E$/,@blockers)) {
7861: push(@blockers,$block);
7862: }
7863: }
1.1162 raeburn 7864: }
7865: }
7866: }
1.1172.2.66 raeburn 7867: return if ($noblock);
7868: return @blockers;
7869: }
1.1162 raeburn 7870: }
7871:
1.1172.2.66 raeburn 7872: # -------------------------------- Deversion and split uri into path an filename
7873:
1.1133 foxr 7874: #
1.1172.2.66 raeburn 7875: # Removes the version from a URI and
1.1133 foxr 7876: # splits it in to its filename and path to the filename.
7877: # Seems like File::Basename could have done this more clearly.
7878: # Parameters:
7879: # $uri - input URI
7880: # Returns:
7881: # Two element list consisting of
7882: # $pathname - the URI up to and excluding the trailing /
7883: # $filename - The part of the URI following the last /
7884: # NOTE:
7885: # Another realization of this is simply:
7886: # use File::Basename;
7887: # ...
7888: # $uri = shift;
7889: # $filename = basename($uri);
7890: # $path = dirname($uri);
7891: # return ($filename, $path);
7892: #
7893: # The implementation below is probably faster however.
7894: #
1.710 albertel 7895: sub split_uri_for_cond {
7896: my $uri=&deversion(&declutter(shift));
7897: my @uriparts=split(/\//,$uri);
7898: my $filename=pop(@uriparts);
7899: my $pathname=join('/',@uriparts);
7900: return ($pathname,$filename);
7901: }
1.232 www 7902: # --------------------------------------------------- Is a resource on the map?
7903:
7904: sub is_on_map {
1.710 albertel 7905: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 7906: #Trying to find the conditional for the file
1.620 albertel 7907: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 7908: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 7909: if ($match) {
1.289 bowersj2 7910: return (1,$1);
7911: } else {
1.434 www 7912: return (0,0);
1.289 bowersj2 7913: }
1.12 www 7914: }
7915:
1.427 www 7916: # --------------------------------------------------------- Get symb from alias
7917:
7918: sub get_symb_from_alias {
7919: my $symb=shift;
7920: my ($map,$resid,$url)=&decode_symb($symb);
7921: # Already is a symb
7922: if ($url) { return $symb; }
7923: # Must be an alias
7924: my $aliassymb='';
7925: my %bighash;
1.620 albertel 7926: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 7927: &GDBM_READER(),0640)) {
7928: my $rid=$bighash{'mapalias_'.$symb};
7929: if ($rid) {
7930: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 7931: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7932: $resid,$bighash{'src_'.$rid});
1.427 www 7933: }
7934: untie %bighash;
7935: }
7936: return $aliassymb;
7937: }
7938:
1.12 www 7939: # ----------------------------------------------------------------- Define Role
7940:
7941: sub definerole {
7942: if (allowed('mcr','/')) {
1.1172.2.84 raeburn 7943: my ($rolename,$sysrole,$domrole,$courole,$uname,$udom)=@_;
1.800 albertel 7944: foreach my $role (split(':',$sysrole)) {
7945: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7946: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7947: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7948: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7949: return "refused:s:$crole&$cqual";
7950: }
7951: }
1.191 harris41 7952: }
1.800 albertel 7953: foreach my $role (split(':',$domrole)) {
7954: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7955: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7956: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7957: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 7958: return "refused:d:$crole&$cqual";
7959: }
7960: }
1.191 harris41 7961: }
1.800 albertel 7962: foreach my $role (split(':',$courole)) {
7963: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7964: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7965: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7966: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7967: return "refused:c:$crole&$cqual";
7968: }
7969: }
1.191 harris41 7970: }
1.1172.2.84 raeburn 7971: my $uhome;
7972: if (($uname ne '') && ($udom ne '')) {
7973: $uhome = &homeserver($uname,$udom);
7974: return $uhome if ($uhome eq 'no_host');
7975: } else {
7976: $uname = $env{'user.name'};
7977: $udom = $env{'user.domain'};
7978: $uhome = $env{'user.home'};
7979: }
1.620 albertel 7980: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.1172.2.84 raeburn 7981: "$udom:$uname:rolesdef_$rolename=".
1.21 www 7982: escape($sysrole.'_'.$domrole.'_'.$courole);
1.1172.2.84 raeburn 7983: return reply($command,$uhome);
1.12 www 7984: } else {
7985: return 'refused';
7986: }
1.105 harris41 7987: }
7988:
7989: # ---------------- Make a metadata query against the network of library servers
7990:
7991: sub metadata_query {
1.1172.2.33 raeburn 7992: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 7993: my %rhash;
1.845 albertel 7994: my %libserv = &all_library();
1.244 matthew 7995: my @server_list = (defined($server_array) ? @$server_array
7996: : keys(%libserv) );
7997: for my $server (@server_list) {
1.1172.2.33 raeburn 7998: my $domains = '';
7999: if (ref($domains_hash) eq 'HASH') {
8000: $domains = $domains_hash->{$server};
8001: }
1.118 harris41 8002: unless ($custom or $customshow) {
1.1172.2.33 raeburn 8003: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 8004: $rhash{$server}=$reply;
8005: }
8006: else {
8007: my $reply=&reply("querysend:".&escape($query).':'.
1.1172.2.33 raeburn 8008: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 8009: $server);
8010: $rhash{$server}=$reply;
8011: }
1.112 harris41 8012: }
1.118 harris41 8013: return \%rhash;
1.240 www 8014: }
8015:
8016: # ----------------------------------------- Send log queries and wait for reply
8017:
8018: sub log_query {
8019: my ($uname,$udom,$query,%filters)=@_;
8020: my $uhome=&homeserver($uname,$udom);
8021: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 8022: my $uhost=&hostname($uhome);
1.800 albertel 8023: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 8024: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
8025: $uhome);
1.479 albertel 8026: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 8027: return get_query_reply($queryid);
8028: }
8029:
1.818 raeburn 8030: # -------------------------- Update MySQL table for portfolio file
8031:
8032: sub update_portfolio_table {
1.821 raeburn 8033: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 8034: if ($group ne '') {
8035: $file_name =~s /^\Q$group\E//;
8036: }
1.818 raeburn 8037: my $homeserver = &homeserver($uname,$udom);
8038: my $queryid=
1.821 raeburn 8039: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
8040: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 8041: my $reply = &get_query_reply($queryid);
8042: return $reply;
8043: }
8044:
1.899 raeburn 8045: # -------------------------- Update MySQL allusers table
8046:
8047: sub update_allusers_table {
8048: my ($uname,$udom,$names) = @_;
8049: my $homeserver = &homeserver($uname,$udom);
8050: my $queryid=
8051: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
8052: 'lastname='.&escape($names->{'lastname'}).'%%'.
8053: 'firstname='.&escape($names->{'firstname'}).'%%'.
8054: 'middlename='.&escape($names->{'middlename'}).'%%'.
8055: 'generation='.&escape($names->{'generation'}).'%%'.
8056: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
8057: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 8058: return;
1.899 raeburn 8059: }
8060:
1.508 raeburn 8061: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 8062:
8063: sub fetch_enrollment_query {
1.511 raeburn 8064: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.1172.2.79 raeburn 8065: my ($homeserver,$sleep,$loopmax);
1.547 raeburn 8066: my $maxtries = 1;
1.508 raeburn 8067: if ($context eq 'automated') {
8068: $homeserver = $perlvar{'lonHostID'};
1.1172.2.79 raeburn 8069: $sleep = 2;
8070: $loopmax = 100;
1.547 raeburn 8071: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 8072: } else {
8073: $homeserver = &homeserver($cnum,$dom);
8074: }
1.838 albertel 8075: my $host=&hostname($homeserver);
1.506 raeburn 8076: my $cmd = '';
1.1000 raeburn 8077: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 8078: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 8079: }
8080: $cmd =~ s/%%$//;
8081: $cmd = &escape($cmd);
8082: my $query = 'fetchenrollment';
1.620 albertel 8083: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 8084: unless ($queryid=~/^\Q$host\E\_/) {
8085: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
8086: return 'error: '.$queryid;
8087: }
1.1172.2.93 raeburn 8088: my $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 8089: my $tries = 1;
8090: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1.1172.2.79 raeburn 8091: $reply = &get_query_reply($queryid,$sleep,$loopmax);
1.547 raeburn 8092: $tries ++;
8093: }
1.526 raeburn 8094: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 8095: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 8096: } else {
1.901 albertel 8097: my @responses = split(/:/,$reply);
1.1172.2.82 raeburn 8098: if (grep { $_ eq $homeserver } ¤t_machine_ids()) {
1.800 albertel 8099: foreach my $line (@responses) {
8100: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 8101: $$replyref{$key} = $value;
8102: }
8103: } else {
1.1117 foxr 8104: my $pathname = LONCAPA::tempdir();
1.800 albertel 8105: foreach my $line (@responses) {
8106: my ($key,$value) = split(/=/,$line);
1.506 raeburn 8107: $$replyref{$key} = $value;
8108: if ($value > 0) {
1.800 albertel 8109: foreach my $item (@{$$affiliatesref{$key}}) {
8110: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 8111: my $destname = $pathname.'/'.$filename;
8112: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 8113: if ($xml_classlist =~ /^error/) {
8114: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
8115: } else {
1.506 raeburn 8116: if ( open(FILE,">$destname") ) {
8117: print FILE &unescape($xml_classlist);
8118: close(FILE);
1.526 raeburn 8119: } else {
8120: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 8121: }
8122: }
8123: }
8124: }
8125: }
8126: }
8127: return 'ok';
8128: }
8129: return 'error';
8130: }
8131:
1.242 www 8132: sub get_query_reply {
1.1172.2.79 raeburn 8133: my ($queryid,$sleep,$loopmax) = @_;
8134: if (($sleep eq '') || ($sleep !~ /^\d+\.?\d*$/)) {
8135: $sleep = 0.2;
8136: }
8137: if (($loopmax eq '') || ($loopmax =~ /\D/)) {
8138: $loopmax = 100;
8139: }
1.1117 foxr 8140: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 8141: my $reply='';
1.1172.2.79 raeburn 8142: for (1..$loopmax) {
8143: sleep($sleep);
1.240 www 8144: if (-e $replyfile.'.end') {
1.448 albertel 8145: if (open(my $fh,$replyfile)) {
1.904 albertel 8146: $reply = join('',<$fh>);
8147: close($fh);
1.240 www 8148: } else { return 'error: reply_file_error'; }
1.242 www 8149: return &unescape($reply);
8150: }
1.240 www 8151: }
1.242 www 8152: return 'timeout:'.$queryid;
1.240 www 8153: }
8154:
8155: sub courselog_query {
1.241 www 8156: #
8157: # possible filters:
8158: # url: url or symb
8159: # username
8160: # domain
8161: # action: view, submit, grade
8162: # start: timestamp
8163: # end: timestamp
8164: #
1.240 www 8165: my (%filters)=@_;
1.620 albertel 8166: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 8167: if ($filters{'url'}) {
8168: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
8169: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
8170: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
8171: }
1.620 albertel 8172: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
8173: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 8174: return &log_query($cname,$cdom,'courselog',%filters);
8175: }
8176:
8177: sub userlog_query {
1.858 raeburn 8178: #
8179: # possible filters:
8180: # action: log check role
8181: # start: timestamp
8182: # end: timestamp
8183: #
1.240 www 8184: my ($uname,$udom,%filters)=@_;
8185: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 8186: }
8187:
1.506 raeburn 8188: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
8189:
8190: sub auto_run {
1.508 raeburn 8191: my ($cnum,$cdom) = @_;
1.876 raeburn 8192: my $response = 0;
8193: my $settings;
8194: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
8195: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
8196: $settings = $domconfig{'autoenroll'};
8197: if ($settings->{'run'} eq '1') {
8198: $response = 1;
8199: }
8200: } else {
1.934 raeburn 8201: my $homeserver;
8202: if (&is_course($cdom,$cnum)) {
8203: $homeserver = &homeserver($cnum,$cdom);
8204: } else {
8205: $homeserver = &domain($cdom,'primary');
8206: }
8207: if ($homeserver ne 'no_host') {
8208: $response = &reply('autorun:'.$cdom,$homeserver);
8209: }
1.876 raeburn 8210: }
1.506 raeburn 8211: return $response;
8212: }
1.776 albertel 8213:
1.506 raeburn 8214: sub auto_get_sections {
1.508 raeburn 8215: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 8216: my $homeserver;
8217: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8218: $homeserver = &homeserver($cnum,$cdom);
8219: }
8220: if (!defined($homeserver)) {
8221: if ($cdom =~ /^$match_domain$/) {
8222: $homeserver = &domain($cdom,'primary');
8223: }
8224: }
8225: my @secs;
8226: if (defined($homeserver)) {
8227: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
8228: unless ($response eq 'refused') {
8229: @secs = split(/:/,$response);
8230: }
1.506 raeburn 8231: }
8232: return @secs;
8233: }
1.776 albertel 8234:
1.506 raeburn 8235: sub auto_new_course {
1.1099 raeburn 8236: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 8237: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 8238: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 8239: return $response;
8240: }
1.776 albertel 8241:
1.506 raeburn 8242: sub auto_validate_courseID {
1.508 raeburn 8243: my ($cnum,$cdom,$inst_course_id) = @_;
8244: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 8245: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 8246: return $response;
8247: }
1.776 albertel 8248:
1.1007 raeburn 8249: sub auto_validate_instcode {
1.1020 raeburn 8250: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 8251: my ($homeserver,$response);
8252: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8253: $homeserver = &homeserver($cnum,$cdom);
8254: }
8255: if (!defined($homeserver)) {
8256: if ($cdom =~ /^$match_domain$/) {
8257: $homeserver = &domain($cdom,'primary');
8258: }
8259: }
1.1065 raeburn 8260: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
8261: &escape($instcode).':'.&escape($owner),$homeserver));
1.1172.2.19 raeburn 8262: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
8263: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 8264: }
8265:
1.506 raeburn 8266: sub auto_create_password {
1.873 raeburn 8267: my ($cnum,$cdom,$authparam,$udom) = @_;
8268: my ($homeserver,$response);
1.506 raeburn 8269: my $create_passwd = 0;
8270: my $authchk = '';
1.873 raeburn 8271: if ($udom =~ /^$match_domain$/) {
8272: $homeserver = &domain($udom,'primary');
8273: }
8274: if ($homeserver eq '') {
8275: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
8276: $homeserver = &homeserver($cnum,$cdom);
8277: }
8278: }
8279: if ($homeserver eq '') {
8280: $authchk = 'nodomain';
1.506 raeburn 8281: } else {
1.873 raeburn 8282: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
8283: if ($response eq 'refused') {
8284: $authchk = 'refused';
8285: } else {
1.901 albertel 8286: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 8287: }
1.506 raeburn 8288: }
8289: return ($authparam,$create_passwd,$authchk);
8290: }
8291:
1.706 raeburn 8292: sub auto_photo_permission {
8293: my ($cnum,$cdom,$students) = @_;
8294: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 8295: my ($outcome,$perm_reqd,$conditions) =
8296: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 8297: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8298: return (undef,undef);
8299: }
1.706 raeburn 8300: return ($outcome,$perm_reqd,$conditions);
8301: }
8302:
8303: sub auto_checkphotos {
8304: my ($uname,$udom,$pid) = @_;
8305: my $homeserver = &homeserver($uname,$udom);
8306: my ($result,$resulttype);
8307: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 8308: &escape($uname).':'.&escape($pid),
8309: $homeserver));
1.709 albertel 8310: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8311: return (undef,undef);
8312: }
1.706 raeburn 8313: if ($outcome) {
8314: ($result,$resulttype) = split(/:/,$outcome);
8315: }
8316: return ($result,$resulttype);
8317: }
8318:
8319: sub auto_photochoice {
8320: my ($cnum,$cdom) = @_;
8321: my $homeserver = &homeserver($cnum,$cdom);
8322: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 8323: &escape($cdom),
8324: $homeserver)));
1.709 albertel 8325: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
8326: return (undef,undef);
8327: }
1.706 raeburn 8328: return ($update,$comment);
8329: }
8330:
8331: sub auto_photoupdate {
8332: my ($affiliatesref,$dom,$cnum,$photo) = @_;
8333: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 8334: my $host=&hostname($homeserver);
1.706 raeburn 8335: my $cmd = '';
8336: my $maxtries = 1;
1.800 albertel 8337: foreach my $affiliate (keys(%{$affiliatesref})) {
8338: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 8339: }
8340: $cmd =~ s/%%$//;
8341: $cmd = &escape($cmd);
8342: my $query = 'institutionalphotos';
8343: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
8344: unless ($queryid=~/^\Q$host\E\_/) {
8345: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
8346: return 'error: '.$queryid;
8347: }
8348: my $reply = &get_query_reply($queryid);
8349: my $tries = 1;
8350: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
8351: $reply = &get_query_reply($queryid);
8352: $tries ++;
8353: }
8354: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
8355: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
8356: } else {
8357: my @responses = split(/:/,$reply);
8358: my $outcome = shift(@responses);
8359: foreach my $item (@responses) {
8360: my ($key,$value) = split(/=/,$item);
8361: $$photo{$key} = $value;
8362: }
8363: return $outcome;
8364: }
8365: return 'error';
8366: }
8367:
1.521 raeburn 8368: sub auto_instcode_format {
1.793 albertel 8369: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
8370: $cat_order) = @_;
1.521 raeburn 8371: my $courses = '';
1.772 raeburn 8372: my @homeservers;
1.521 raeburn 8373: if ($caller eq 'global') {
1.841 albertel 8374: my %servers = &get_servers($codedom,'library');
8375: foreach my $tryserver (keys(%servers)) {
8376: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8377: push(@homeservers,$tryserver);
8378: }
1.584 raeburn 8379: }
1.1022 raeburn 8380: } elsif ($caller eq 'requests') {
8381: if ($codedom =~ /^$match_domain$/) {
8382: my $chome = &domain($codedom,'primary');
8383: unless ($chome eq 'no_host') {
8384: push(@homeservers,$chome);
8385: }
8386: }
1.521 raeburn 8387: } else {
1.772 raeburn 8388: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 8389: }
1.793 albertel 8390: foreach my $code (keys(%{$instcodes})) {
8391: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 8392: }
8393: chop($courses);
1.772 raeburn 8394: my $ok_response = 0;
8395: my $response;
8396: while (@homeservers > 0 && $ok_response == 0) {
8397: my $server = shift(@homeservers);
8398: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
8399: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
8400: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 8401: split(/:/,$response);
1.772 raeburn 8402: %{$codes} = (%{$codes},&str2hash($codes_str));
8403: push(@{$codetitles},&str2array($codetitles_str));
8404: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8405: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8406: $ok_response = 1;
8407: }
8408: }
8409: if ($ok_response) {
1.521 raeburn 8410: return 'ok';
1.772 raeburn 8411: } else {
8412: return $response;
1.521 raeburn 8413: }
8414: }
8415:
1.792 raeburn 8416: sub auto_instcode_defaults {
8417: my ($domain,$returnhash,$code_order) = @_;
8418: my @homeservers;
1.841 albertel 8419:
8420: my %servers = &get_servers($domain,'library');
8421: foreach my $tryserver (keys(%servers)) {
8422: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8423: push(@homeservers,$tryserver);
8424: }
1.792 raeburn 8425: }
1.841 albertel 8426:
1.792 raeburn 8427: my $response;
1.841 albertel 8428: foreach my $server (@homeservers) {
1.792 raeburn 8429: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 8430: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8431:
8432: foreach my $pair (split(/\&/,$response)) {
8433: my ($name,$value)=split(/\=/,$pair);
8434: if ($name eq 'code_order') {
8435: @{$code_order} = split(/\&/,&unescape($value));
8436: } else {
8437: $returnhash->{&unescape($name)}=&unescape($value);
8438: }
8439: }
8440: return 'ok';
1.792 raeburn 8441: }
1.841 albertel 8442:
8443: return $response;
1.1003 raeburn 8444: }
8445:
8446: sub auto_possible_instcodes {
1.1007 raeburn 8447: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8448: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8449: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8450: return;
8451: }
1.1003 raeburn 8452: my (@homeservers,$uhome);
8453: if (defined(&domain($domain,'primary'))) {
8454: $uhome=&domain($domain,'primary');
8455: push(@homeservers,&domain($domain,'primary'));
8456: } else {
8457: my %servers = &get_servers($domain,'library');
8458: foreach my $tryserver (keys(%servers)) {
8459: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8460: push(@homeservers,$tryserver);
8461: }
8462: }
8463: }
8464: my $response;
8465: foreach my $server (@homeservers) {
8466: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8467: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 8468: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8469: split(':',$response);
8470: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8471: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 8472: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 8473: my ($name,$value)=split('=',$item);
8474: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8475: }
8476: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 8477: my ($name,$value)=split('=',$item);
8478: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8479: }
8480: return 'ok';
8481: }
8482: return $response;
8483: }
1.792 raeburn 8484:
1.1010 raeburn 8485: sub auto_courserequest_checks {
8486: my ($dom) = @_;
1.1020 raeburn 8487: my ($homeserver,%validations);
8488: if ($dom =~ /^$match_domain$/) {
8489: $homeserver = &domain($dom,'primary');
8490: }
8491: unless ($homeserver eq 'no_host') {
8492: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8493: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8494: my @items = split(/&/,$response);
8495: foreach my $item (@items) {
8496: my ($key,$value) = split('=',$item);
8497: $validations{&unescape($key)} = &thaw_unescape($value);
8498: }
8499: }
8500: }
1.1010 raeburn 8501: return %validations;
8502: }
8503:
1.1020 raeburn 8504: sub auto_courserequest_validation {
1.1172.2.43 raeburn 8505: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 8506: my ($homeserver,$response);
8507: if ($dom =~ /^$match_domain$/) {
8508: $homeserver = &domain($dom,'primary');
8509: }
1.1172.2.43 raeburn 8510: unless ($homeserver eq 'no_host') {
8511: my $customdata;
8512: if (ref($custominfo) eq 'HASH') {
8513: $customdata = &freeze_escape($custominfo);
8514: }
1.1020 raeburn 8515: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 8516: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1172.2.43 raeburn 8517: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8518: $customdata,$homeserver));
1.1020 raeburn 8519: }
8520: return $response;
8521: }
8522:
1.777 albertel 8523: sub auto_validate_class_sec {
1.918 raeburn 8524: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 8525: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 8526: my $ownerlist;
8527: if (ref($owners) eq 'ARRAY') {
8528: $ownerlist = join(',',@{$owners});
8529: } else {
8530: $ownerlist = $owners;
8531: }
1.773 raeburn 8532: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 8533: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 8534: return $response;
8535: }
8536:
1.1172.2.94 raeburn 8537: sub auto_validate_instclasses {
8538: my ($cdom,$cnum,$owners,$classesref) = @_;
8539: my ($homeserver,%validations);
8540: $homeserver = &homeserver($cnum,$cdom);
8541: unless ($homeserver eq 'no_host') {
8542: my $ownerlist;
8543: if (ref($owners) eq 'ARRAY') {
8544: $ownerlist = join(',',@{$owners});
8545: } else {
8546: $ownerlist = $owners;
8547: }
8548: if (ref($classesref) eq 'HASH') {
8549: my $classes = &freeze_escape($classesref);
8550: my $response=&reply('autovalidateinstclasses:'.&escape($ownerlist).
8551: ':'.$cdom.':'.$classes,$homeserver);
8552: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8553: my @items = split(/&/,$response);
8554: foreach my $item (@items) {
8555: my ($key,$value) = split('=',$item);
8556: $validations{&unescape($key)} = &thaw_unescape($value);
8557: }
8558: }
8559: }
8560: }
8561: return %validations;
8562: }
8563:
1.1172.2.38 raeburn 8564: sub auto_crsreq_update {
8565: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1172.2.45 raeburn 8566: $code,$accessstart,$accessend,$inbound) = @_;
1.1172.2.38 raeburn 8567: my ($homeserver,%crsreqresponse);
8568: if ($cdom =~ /^$match_domain$/) {
8569: $homeserver = &domain($cdom,'primary');
8570: }
8571: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8572: my $info;
8573: if (ref($inbound) eq 'HASH') {
8574: $info = &freeze_escape($inbound);
8575: }
8576: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8577: ':'.&escape($action).':'.&escape($ownername).':'.
8578: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1172.2.45 raeburn 8579: &escape($title).':'.&escape($code).':'.
8580: &escape($accessstart).':'.&escape($accessend).':'.$info,$homeserver);
1.1172.2.38 raeburn 8581: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8582: my @items = split(/&/,$response);
8583: foreach my $item (@items) {
8584: my ($key,$value) = split('=',$item);
8585: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8586: }
8587: }
8588: }
8589: return \%crsreqresponse;
8590: }
8591:
1.1172.2.78 raeburn 8592: sub auto_export_grades {
8593: my ($cdom,$cnum,$inforef,$gradesref) = @_;
8594: my ($homeserver,%exportresponse);
8595: if ($cdom =~ /^$match_domain$/) {
8596: $homeserver = &domain($cdom,'primary');
8597: }
8598: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8599: my $info;
8600: if (ref($inforef) eq 'HASH') {
8601: $info = &freeze_escape($inforef);
8602: }
8603: if (ref($gradesref) eq 'HASH') {
8604: my $grades = &freeze_escape($gradesref);
8605: my $response=&reply('encrypt:autoexportgrades:'.$cdom.':'.$cnum.':'.
8606: $info.':'.$grades,$homeserver);
8607: unless ($response =~ /(con_lost|error|no_such_host|refused|unknown_command)/) {
8608: my @items = split(/&/,$response);
8609: foreach my $item (@items) {
8610: my ($key,$value) = split('=',$item);
8611: $exportresponse{&unescape($key)} = &thaw_unescape($value);
8612: }
8613: }
8614: }
8615: }
8616: return \%exportresponse;
8617: }
8618:
1.1172.2.68 raeburn 8619: sub check_instcode_cloning {
8620: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8621: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8622: return;
8623: }
8624: my $canclone;
8625: if (@{$code_order} > 0) {
8626: my $instcoderegexp ='^';
8627: my @clonecodes = split(/\&/,$cloner);
8628: foreach my $item (@{$code_order}) {
8629: if (grep(/^\Q$item\E=/,@clonecodes)) {
8630: foreach my $pair (@clonecodes) {
8631: my ($key,$val) = split(/\=/,$pair,2);
8632: $val = &unescape($val);
8633: if ($key eq $item) {
8634: $instcoderegexp .= '('.$val.')';
8635: last;
8636: }
8637: }
8638: } else {
8639: $instcoderegexp .= $codedefaults->{$item};
8640: }
8641: }
8642: $instcoderegexp .= '$';
8643: my (@from,@to);
8644: eval {
8645: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8646: (@to) = ($clonetocode =~ /$instcoderegexp/);
8647: };
8648: if ((@from > 0) && (@to > 0)) {
8649: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8650: if (!@diffs) {
8651: $canclone = 1;
8652: }
8653: }
8654: }
8655: return $canclone;
8656: }
8657:
8658: sub default_instcode_cloning {
8659: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
8660: my (%codedefaults,@code_order,$canclone);
8661: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
8662: %codedefaults = %{$codedefaultsref};
8663: @code_order = @{$codeorderref};
8664: } elsif ($clonedom) {
8665: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
8666: }
8667: if (($domdefclone) && (@code_order)) {
8668: my @clonecodes = split(/\+/,$domdefclone);
8669: my $instcoderegexp ='^';
8670: foreach my $item (@code_order) {
8671: if (grep(/^\Q$item\E$/,@clonecodes)) {
8672: $instcoderegexp .= '('.$codedefaults{$item}.')';
8673: } else {
8674: $instcoderegexp .= $codedefaults{$item};
8675: }
8676: }
8677: $instcoderegexp .= '$';
8678: my (@from,@to);
8679: eval {
8680: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8681: (@to) = ($clonetocode =~ /$instcoderegexp/);
8682: };
8683: if ((@from > 0) && (@to > 0)) {
8684: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8685: if (!@diffs) {
8686: $canclone = 1;
8687: }
8688: }
8689: }
8690: return $canclone;
8691: }
8692:
1.679 raeburn 8693: # ------------------------------------------------------- Course Group routines
8694:
8695: sub get_coursegroups {
1.809 raeburn 8696: my ($cdom,$cnum,$group,$namespace) = @_;
8697: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 8698: }
8699:
1.679 raeburn 8700: sub modify_coursegroup {
8701: my ($cdom,$cnum,$groupsettings) = @_;
8702: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
8703: }
8704:
1.809 raeburn 8705: sub toggle_coursegroup_status {
8706: my ($cdom,$cnum,$group,$action) = @_;
8707: my ($from_namespace,$to_namespace);
8708: if ($action eq 'delete') {
8709: $from_namespace = 'coursegroups';
8710: $to_namespace = 'deleted_groups';
8711: } else {
8712: $from_namespace = 'deleted_groups';
8713: $to_namespace = 'coursegroups';
8714: }
8715: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 8716: if (my $tmp = &error(%curr_group)) {
8717: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
8718: return ('read error',$tmp);
8719: } else {
8720: my %savedsettings = %curr_group;
1.809 raeburn 8721: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 8722: my $deloutcome;
8723: if ($result eq 'ok') {
1.809 raeburn 8724: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 8725: } else {
8726: return ('write error',$result);
8727: }
8728: if ($deloutcome eq 'ok') {
8729: return 'ok';
8730: } else {
8731: return ('delete error',$deloutcome);
8732: }
8733: }
8734: }
8735:
1.679 raeburn 8736: sub modify_group_roles {
1.957 raeburn 8737: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 8738: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
8739: my $role = 'gr/'.&escape($userprivs);
8740: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 8741: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 8742: if ($result eq 'ok') {
8743: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8744: }
1.679 raeburn 8745: return $result;
8746: }
8747:
8748: sub modify_coursegroup_membership {
8749: my ($cdom,$cnum,$membership) = @_;
8750: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8751: return $result;
8752: }
8753:
1.682 raeburn 8754: sub get_active_groups {
8755: my ($udom,$uname,$cdom,$cnum) = @_;
8756: my $now = time;
8757: my %groups = ();
8758: foreach my $key (keys(%env)) {
1.811 albertel 8759: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 8760: my ($start,$end) = split(/\./,$env{$key});
8761: if (($end!=0) && ($end<$now)) { next; }
8762: if (($start!=0) && ($start>$now)) { next; }
8763: if ($1 eq $cdom && $2 eq $cnum) {
8764: $groups{$3} = $env{$key} ;
8765: }
8766: }
8767: }
8768: return %groups;
8769: }
8770:
1.683 raeburn 8771: sub get_group_membership {
8772: my ($cdom,$cnum,$group) = @_;
8773: return(&dump('groupmembership',$cdom,$cnum,$group));
8774: }
8775:
8776: sub get_users_groups {
8777: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 8778: my @usersgroups;
1.683 raeburn 8779: my $cachetime=1800;
8780:
8781: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 8782: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8783: if (defined($cached)) {
1.734 albertel 8784: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 8785: } else {
8786: $grouplist = '';
1.816 raeburn 8787: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 8788: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 8789: my $access_end = $env{'course.'.$courseid.
8790: '.default_enrollment_end_date'};
8791: my $now = time;
8792: foreach my $key (keys(%roleshash)) {
8793: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8794: my $group = $1;
8795: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8796: my $start = $2;
8797: my $end = $1;
8798: if ($start == -1) { next; } # deleted from group
8799: if (($start!=0) && ($start>$now)) { next; }
8800: if (($end!=0) && ($end<$now)) {
8801: if ($access_end && $access_end < $now) {
8802: if ($access_end - $end < 86400) {
8803: push(@usersgroups,$group);
1.733 raeburn 8804: }
8805: }
1.817 raeburn 8806: next;
1.733 raeburn 8807: }
1.817 raeburn 8808: push(@usersgroups,$group);
1.683 raeburn 8809: }
8810: }
8811: }
1.817 raeburn 8812: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8813: $grouplist = join(':',@usersgroups);
8814: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 8815: }
1.733 raeburn 8816: return @usersgroups;
1.683 raeburn 8817: }
8818:
8819: sub devalidate_getgroups_cache {
8820: my ($udom,$uname,$cdom,$cnum)=@_;
8821: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 8822:
1.683 raeburn 8823: my $hashid="$udom:$uname:$courseid";
8824: &devalidate_cache_new('getgroups',$hashid);
8825: }
8826:
1.12 www 8827: # ------------------------------------------------------------------ Plain Text
8828:
8829: sub plaintext {
1.988 raeburn 8830: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 8831: if ($short =~ m{^cr/}) {
1.758 albertel 8832: return (split('/',$short))[-1];
8833: }
1.742 raeburn 8834: if (!defined($cid)) {
8835: $cid = $env{'request.course.id'};
8836: }
8837: my %rolenames = (
1.1008 raeburn 8838: Course => 'std',
8839: Community => 'alt1',
1.742 raeburn 8840: );
1.1037 raeburn 8841: if ($cid ne '') {
8842: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8843: unless ($forcedefault) {
8844: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8845: &Apache::lonlocal::mt_escape(\$roletext);
8846: return &Apache::lonlocal::mt($roletext);
8847: }
8848: }
8849: }
8850: if ((defined($type)) && (defined($rolenames{$type})) &&
8851: (defined($rolenames{$type})) &&
8852: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 8853: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 8854: } elsif ($cid ne '') {
8855: my $crstype = $env{'course.'.$cid.'.type'};
8856: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8857: (defined($prp{$short}{$rolenames{$crstype}}))) {
8858: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8859: }
1.742 raeburn 8860: }
1.1037 raeburn 8861: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 8862: }
8863:
8864: # ----------------------------------------------------------------- Assign Role
8865:
8866: sub assignrole {
1.957 raeburn 8867: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8868: $context)=@_;
1.21 www 8869: my $mrole;
8870: if ($role =~ /^cr\//) {
1.393 www 8871: my $cwosec=$url;
1.811 albertel 8872: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 8873: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 8874: my $refused = 1;
8875: if ($context eq 'requestcourses') {
8876: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8877: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8878: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8879: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8880: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8881: if ($crsenv{'internal.courseowner'} eq
8882: $env{'user.name'}.':'.$env{'user.domain'}) {
8883: $refused = '';
8884: }
8885: }
8886: }
8887: }
8888: }
8889: if ($refused) {
8890: &logthis('Refused custom assignrole: '.
8891: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8892: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8893: return 'refused';
8894: }
1.104 www 8895: }
1.21 www 8896: $mrole='cr';
1.678 raeburn 8897: } elsif ($role =~ /^gr\//) {
8898: my $cwogrp=$url;
1.811 albertel 8899: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 8900: unless (&allowed('mdg',$cwogrp)) {
8901: &logthis('Refused group assignrole: '.
8902: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8903: $env{'user.name'}.' at '.$env{'user.domain'});
8904: return 'refused';
8905: }
8906: $mrole='gr';
1.21 www 8907: } else {
1.82 www 8908: my $cwosec=$url;
1.811 albertel 8909: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 8910: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8911: my $refused;
8912: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8913: if (!(&allowed('c'.$role,$url))) {
8914: $refused = 1;
8915: }
8916: } else {
8917: $refused = 1;
8918: }
1.947 raeburn 8919: if ($refused) {
1.1045 raeburn 8920: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8921: if (!$selfenroll && $context eq 'course') {
8922: my %crsenv;
8923: if ($role eq 'cc' || $role eq 'co') {
8924: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8925: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8926: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8927: if ($crsenv{'internal.courseowner'} eq
8928: $env{'user.name'}.':'.$env{'user.domain'}) {
8929: $refused = '';
8930: }
8931: }
8932: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8933: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8934: if ($crsenv{'internal.courseowner'} eq
8935: $env{'user.name'}.':'.$env{'user.domain'}) {
8936: $refused = '';
8937: }
8938: }
8939: }
8940: }
8941: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 8942: $refused = '';
1.1017 raeburn 8943: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 8944: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 8945: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 8946: my $wrongcc;
8947: if ($cnum =~ /^$match_community$/) {
8948: $wrongcc = 1 if ($role eq 'cc');
8949: } else {
8950: $wrongcc = 1 if ($role eq 'co');
8951: }
8952: unless ($wrongcc) {
8953: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8954: if ($crsenv{'internal.courseowner'} eq
8955: $env{'user.name'}.':'.$env{'user.domain'}) {
8956: $refused = '';
8957: }
1.1017 raeburn 8958: }
8959: }
1.1172.2.9 raeburn 8960: } elsif ($context eq 'requestauthor') {
8961: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8962: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8963: if ($env{'environment.requestauthor'} eq 'automatic') {
8964: $refused = '';
8965: } else {
8966: my %domdefaults = &get_domain_defaults($udom);
8967: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8968: my $checkbystatus;
8969: if ($env{'user.adv'}) {
8970: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8971: if ($disposition eq 'automatic') {
8972: $refused = '';
8973: } elsif ($disposition eq '') {
8974: $checkbystatus = 1;
8975: }
8976: } else {
8977: $checkbystatus = 1;
8978: }
8979: if ($checkbystatus) {
8980: if ($env{'environment.inststatus'}) {
8981: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8982: foreach my $type (@inststatuses) {
8983: if (($type ne '') &&
8984: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8985: $refused = '';
8986: }
8987: }
8988: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8989: $refused = '';
8990: }
8991: }
8992: }
8993: }
8994: }
1.1017 raeburn 8995: }
8996: if ($refused) {
1.947 raeburn 8997: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8998: ' '.$role.' '.$end.' '.$start.' by '.
8999: $env{'user.name'}.' at '.$env{'user.domain'});
9000: return 'refused';
9001: }
1.932 raeburn 9002: }
1.1131 raeburn 9003: } elsif ($role eq 'au') {
9004: if ($url ne '/'.$udom.'/') {
9005: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
9006: ' to assign author role for '.$uname.':'.$udom.
9007: ' in domain: '.$url.' refused (wrong domain).');
9008: return 'refused';
9009: }
1.104 www 9010: }
1.21 www 9011: $mrole=$role;
9012: }
1.620 albertel 9013: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 9014: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 9015: if ($end) { $command.='_'.$end; }
1.21 www 9016: if ($start) {
9017: if ($end) {
1.81 www 9018: $command.='_'.$start;
1.21 www 9019: } else {
1.81 www 9020: $command.='_0_'.$start;
1.21 www 9021: }
9022: }
1.739 raeburn 9023: my $origstart = $start;
9024: my $origend = $end;
1.957 raeburn 9025: my $delflag;
1.357 www 9026: # actually delete
9027: if ($deleteflag) {
1.373 www 9028: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 9029: # modify command to delete the role
1.620 albertel 9030: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 9031: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 9032: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 9033: # set start and finish to negative values for userrolelog
9034: $start=-1;
9035: $end=-1;
1.957 raeburn 9036: $delflag = 1;
1.357 www 9037: }
9038: }
9039: # send command
1.349 www 9040: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 9041: # log new user role if status is ok
1.349 www 9042: if ($answer eq 'ok') {
1.663 raeburn 9043: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1172.2.9 raeburn 9044: if (($role eq 'cc') || ($role eq 'in') ||
9045: ($role eq 'ep') || ($role eq 'ad') ||
9046: ($role eq 'ta') || ($role eq 'st') ||
9047: ($role=~/^cr/) || ($role eq 'gr') ||
9048: ($role eq 'co')) {
1.1172.2.13 raeburn 9049: # for course roles, perform group memberships changes triggered by role change.
9050: unless ($role =~ /^gr/) {
9051: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
9052: $origstart,$selfenroll,$context);
9053: }
1.1172.2.9 raeburn 9054: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9055: $selfenroll,$context);
9056: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
1.1172.2.90 raeburn 9057: ($role eq 'au') || ($role eq 'dc') || ($role eq 'dh') ||
9058: ($role eq 'da')) {
1.1172.2.9 raeburn 9059: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9060: $context);
9061: } elsif (($role eq 'ca') || ($role eq 'aa')) {
9062: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
9063: $context);
9064: }
1.1053 raeburn 9065: if ($role eq 'cc') {
9066: &autoupdate_coowners($url,$end,$start,$uname,$udom);
9067: }
1.349 www 9068: }
9069: return $answer;
1.169 harris41 9070: }
9071:
1.1053 raeburn 9072: sub autoupdate_coowners {
9073: my ($url,$end,$start,$uname,$udom) = @_;
9074: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
9075: if (($cdom ne '') && ($cnum ne '')) {
9076: my $now = time;
9077: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
9078: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
9079: my %coursehash = &coursedescription($cdom.'_'.$cnum);
9080: my $instcode = $coursehash{'internal.coursecode'};
9081: if ($instcode ne '') {
1.1056 raeburn 9082: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
9083: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 9084: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 9085: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
9086: if ($result eq 'valid') {
9087: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 9088: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9089: push(@newcoowners,$coowner);
9090: }
9091: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
9092: push(@newcoowners,$uname.':'.$udom);
9093: }
9094: @newcoowners = sort(@newcoowners);
9095: } else {
9096: push(@newcoowners,$uname.':'.$udom);
9097: }
9098: } else {
9099: if ($coursehash{'internal.co-owners'}) {
9100: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
9101: unless ($coowner eq $uname.':'.$udom) {
9102: push(@newcoowners,$coowner);
9103: }
9104: }
9105: unless (@newcoowners > 0) {
9106: $delcoowners = 1;
9107: $coowners = '';
9108: }
9109: }
9110: }
9111: if (@newcoowners || $delcoowners) {
9112: &store_coowners($cdom,$cnum,$coursehash{'home'},
9113: $delcoowners,@newcoowners);
9114: }
9115: }
9116: }
9117: }
9118: }
9119: }
9120: }
9121:
9122: sub store_coowners {
9123: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
9124: my $cid = $cdom.'_'.$cnum;
9125: my ($coowners,$delresult,$putresult);
9126: if (@newcoowners) {
9127: $coowners = join(',',@newcoowners);
9128: my %coownershash = (
9129: 'internal.co-owners' => $coowners,
9130: );
9131: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
9132: if ($putresult eq 'ok') {
9133: if ($env{'course.'.$cid.'.num'} eq $cnum) {
9134: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
9135: }
9136: }
9137: }
9138: if ($delcoowners) {
9139: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
9140: if ($delresult eq 'ok') {
9141: if ($env{'course.'.$cid.'.internal.co-owners'}) {
9142: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
9143: }
9144: }
9145: }
9146: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
9147: my %crsinfo =
9148: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
9149: if (ref($crsinfo{$cid}) eq 'HASH') {
9150: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
9151: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
9152: }
9153: }
9154: }
9155:
1.169 harris41 9156: # -------------------------------------------------- Modify user authentication
1.197 www 9157: # Overrides without validation
9158:
1.169 harris41 9159: sub modifyuserauth {
9160: my ($udom,$uname,$umode,$upass)=@_;
9161: my $uhome=&homeserver($uname,$udom);
1.197 www 9162: unless (&allowed('mau',$udom)) { return 'refused'; }
9163: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 9164: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9165: ' in domain '.$env{'request.role.domain'});
1.169 harris41 9166: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
9167: &escape($upass),$uhome);
1.620 albertel 9168: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 9169: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
9170: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
9171: &log($udom,,$uname,$uhome,
1.620 albertel 9172: 'Authentication changed by '.$env{'user.domain'}.', '.
9173: $env{'user.name'}.', '.$umode.
1.197 www 9174: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 9175: unless ($reply eq 'ok') {
1.197 www 9176: &logthis('Authentication mode error: '.$reply);
1.169 harris41 9177: return 'error: '.$reply;
9178: }
1.170 harris41 9179: return 'ok';
1.80 www 9180: }
9181:
1.81 www 9182: # --------------------------------------------------------------- Modify a user
1.80 www 9183:
1.81 www 9184: sub modifyuser {
1.206 matthew 9185: my ($udom, $uname, $uid,
9186: $umode, $upass, $first,
9187: $middle, $last, $gene,
1.1058 raeburn 9188: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 9189: $udom= &LONCAPA::clean_domain($udom);
9190: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 9191: my $showcandelete = 'none';
9192: if (ref($candelete) eq 'ARRAY') {
9193: if (@{$candelete} > 0) {
9194: $showcandelete = join(', ',@{$candelete});
9195: }
9196: }
1.81 www 9197: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 9198: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 9199: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 9200: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
9201: ' desiredhome not specified').
1.620 albertel 9202: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
9203: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 9204: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 9205: my $newuser;
9206: if ($uhome eq 'no_host') {
9207: $newuser = 1;
9208: }
1.80 www 9209: # ----------------------------------------------------------------- Create User
1.406 albertel 9210: if (($uhome eq 'no_host') &&
9211: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 9212: my $unhome='';
1.844 albertel 9213: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 9214: $unhome = $desiredhome;
1.620 albertel 9215: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
9216: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 9217: } else { # load balancing routine for determining $unhome
1.81 www 9218: my $loadm=10000000;
1.841 albertel 9219: my %servers = &get_servers($udom,'library');
9220: foreach my $tryserver (keys(%servers)) {
9221: my $answer=reply('load',$tryserver);
9222: if (($answer=~/\d+/) && ($answer<$loadm)) {
9223: $loadm=$answer;
9224: $unhome=$tryserver;
9225: }
1.80 www 9226: }
9227: }
9228: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 9229: return 'error: unable to find a home server for '.$uname.
9230: ' in domain '.$udom;
1.80 www 9231: }
9232: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
9233: &escape($upass),$unhome);
9234: unless ($reply eq 'ok') {
9235: return 'error: '.$reply;
9236: }
1.230 stredwic 9237: $uhome=&homeserver($uname,$udom,'true');
1.80 www 9238: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 9239: return 'error: unable verify users home machine.';
1.80 www 9240: }
1.209 matthew 9241: } # End of creation of new user
1.80 www 9242: # ---------------------------------------------------------------------- Add ID
9243: if ($uid) {
9244: $uid=~tr/A-Z/a-z/;
9245: my %uidhash=&idrget($udom,$uname);
1.196 www 9246: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
9247: && (!$forceid)) {
1.80 www 9248: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 9249: return 'error: user id "'.$uid.'" does not match '.
9250: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 9251: }
9252: } else {
9253: &idput($udom,($uname => $uid));
9254: }
9255: }
9256: # -------------------------------------------------------------- Add names, etc
1.313 matthew 9257: my @tmp=&get('environment',
1.899 raeburn 9258: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 9259: 'permanentemail','inststatus'],
1.134 albertel 9260: $udom,$uname);
1.1075 raeburn 9261: my (%names,%oldnames);
1.313 matthew 9262: if ($tmp[0] =~ m/^error:.*/) {
9263: %names=();
9264: } else {
9265: %names = @tmp;
1.1075 raeburn 9266: %oldnames = %names;
1.313 matthew 9267: }
1.388 www 9268: #
1.1058 raeburn 9269: # If name, email and/or uid are blank (e.g., because an uploaded file
9270: # of users did not contain them), do not overwrite existing values
9271: # unless field is in $candelete array ref.
9272: #
9273:
9274: my @fields = ('firstname','middlename','lastname','generation',
9275: 'permanentemail','id');
9276: my %newvalues;
9277: if (ref($candelete) eq 'ARRAY') {
9278: foreach my $field (@fields) {
9279: if (grep(/^\Q$field\E$/,@{$candelete})) {
9280: if ($field eq 'firstname') {
9281: $names{$field} = $first;
9282: } elsif ($field eq 'middlename') {
9283: $names{$field} = $middle;
9284: } elsif ($field eq 'lastname') {
9285: $names{$field} = $last;
9286: } elsif ($field eq 'generation') {
9287: $names{$field} = $gene;
9288: } elsif ($field eq 'permanentemail') {
9289: $names{$field} = $email;
9290: } elsif ($field eq 'id') {
9291: $names{$field} = $uid;
9292: }
9293: }
9294: }
9295: }
1.388 www 9296: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 9297: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 9298: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 9299: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 9300: if ($email) {
9301: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 9302: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 9303: }
1.899 raeburn 9304: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 9305: if (defined($inststatus)) {
9306: $names{'inststatus'} = '';
9307: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
9308: if (ref($usertypes) eq 'HASH') {
9309: my @okstatuses;
9310: foreach my $item (split(/:/,$inststatus)) {
9311: if (defined($usertypes->{$item})) {
9312: push(@okstatuses,$item);
9313: }
9314: }
9315: if (@okstatuses) {
9316: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
9317: }
9318: }
9319: }
1.1075 raeburn 9320: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 9321: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 9322: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 9323: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
9324: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
9325: } else {
9326: $logmsg .= ' during self creation';
9327: }
1.1075 raeburn 9328: my $changed;
9329: if ($newuser) {
9330: $changed = 1;
9331: } else {
9332: foreach my $field (@fields) {
9333: if ($names{$field} ne $oldnames{$field}) {
9334: $changed = 1;
9335: last;
9336: }
9337: }
9338: }
9339: unless ($changed) {
9340: $logmsg = 'No changes in user information needed for: '.$logmsg;
9341: &logthis($logmsg);
9342: return 'ok';
9343: }
9344: my $reply = &put('environment', \%names, $udom,$uname);
9345: if ($reply ne 'ok') {
9346: return 'error: '.$reply;
9347: }
1.1087 raeburn 9348: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
9349: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
9350: }
1.1075 raeburn 9351: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
9352: &devalidate_cache_new('namescache',$uname.':'.$udom);
9353: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 9354: &logthis($logmsg);
1.134 albertel 9355: return 'ok';
1.80 www 9356: }
9357:
1.81 www 9358: # -------------------------------------------------------------- Modify student
1.80 www 9359:
1.81 www 9360: sub modifystudent {
9361: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 9362: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1172.2.76 raeburn 9363: $selfenroll,$context,$inststatus,$credits,$instsec)=@_;
1.455 albertel 9364: if (!$cid) {
1.620 albertel 9365: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9366: return 'not_in_class';
9367: }
1.80 www 9368: }
9369: # --------------------------------------------------------------- Make the user
1.81 www 9370: my $reply=&modifyuser
1.209 matthew 9371: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 9372: $desiredhome,$email,$inststatus);
1.80 www 9373: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 9374: # This will cause &modify_student_enrollment to get the uid from the
1.1172.2.31 raeburn 9375: # student's environment
1.297 matthew 9376: $uid = undef if (!$forceid);
1.455 albertel 9377: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1172.2.19 raeburn 9378: $gene,$usec,$end,$start,$type,$locktype,
1.1172.2.76 raeburn 9379: $cid,$selfenroll,$context,$credits,$instsec);
1.297 matthew 9380: return $reply;
9381: }
9382:
9383: sub modify_student_enrollment {
1.1172.2.23 raeburn 9384: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
1.1172.2.76 raeburn 9385: $locktype,$cid,$selfenroll,$context,$credits,$instsec) = @_;
1.455 albertel 9386: my ($cdom,$cnum,$chome);
9387: if (!$cid) {
1.620 albertel 9388: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 9389: return 'not_in_class';
9390: }
1.620 albertel 9391: $cdom=$env{'course.'.$cid.'.domain'};
9392: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 9393: } else {
9394: ($cdom,$cnum)=split(/_/,$cid);
9395: }
1.620 albertel 9396: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 9397: if (!$chome) {
1.457 raeburn 9398: $chome=&homeserver($cnum,$cdom);
1.297 matthew 9399: }
1.455 albertel 9400: if (!$chome) { return 'unknown_course'; }
1.297 matthew 9401: # Make sure the user exists
1.81 www 9402: my $uhome=&homeserver($uname,$udom);
9403: if (($uhome eq '') || ($uhome eq 'no_host')) {
9404: return 'error: no such user';
9405: }
1.297 matthew 9406: # Get student data if we were not given enough information
9407: if (!defined($first) || $first eq '' ||
9408: !defined($last) || $last eq '' ||
9409: !defined($uid) || $uid eq '' ||
9410: !defined($middle) || $middle eq '' ||
9411: !defined($gene) || $gene eq '') {
1.294 matthew 9412: # They did not supply us with enough data to enroll the student, so
9413: # we need to pick up more information.
1.297 matthew 9414: my %tmp = &get('environment',
1.294 matthew 9415: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 9416: ,$udom,$uname);
9417:
1.800 albertel 9418: #foreach my $key (keys(%tmp)) {
9419: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 9420: #}
1.294 matthew 9421: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
9422: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
9423: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 9424: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 9425: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
9426: }
1.556 albertel 9427: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 9428: my $user = "$uname:$udom";
9429: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 9430: my $reply=cput('classlist',
1.1148 raeburn 9431: {$user =>
1.1172.2.76 raeburn 9432: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits,$instsec) },
1.487 albertel 9433: $cdom,$cnum);
1.1148 raeburn 9434: if (($reply eq 'ok') || ($reply eq 'delayed')) {
9435: &devalidate_getsection_cache($udom,$uname,$cid);
9436: } else {
1.81 www 9437: return 'error: '.$reply;
9438: }
1.297 matthew 9439: # Add student role to user
1.83 www 9440: my $uurl='/'.$cid;
1.81 www 9441: $uurl=~s/\_/\//g;
9442: if ($usec) {
9443: $uurl.='/'.$usec;
9444: }
1.1148 raeburn 9445: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
9446: $selfenroll,$context);
9447: if ($result ne 'ok') {
9448: if ($old_entry{$user} ne '') {
9449: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
9450: } else {
9451: $reply = &del('classlist',[$user],$cdom,$cnum);
9452: }
9453: }
9454: return $result;
1.21 www 9455: }
9456:
1.556 albertel 9457: sub format_name {
9458: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9459: my $name;
9460: if ($first ne 'lastname') {
9461: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9462: } else {
9463: if ($lastname=~/\S/) {
9464: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9465: $name=~s/\s+,/,/;
9466: } else {
9467: $name.= $firstname.' '.$middlename.' '.$generation;
9468: }
9469: }
9470: $name=~s/^\s+//;
9471: $name=~s/\s+$//;
9472: $name=~s/\s+/ /g;
9473: return $name;
9474: }
9475:
1.84 www 9476: # ------------------------------------------------- Write to course preferences
9477:
9478: sub writecoursepref {
9479: my ($courseid,%prefs)=@_;
9480: $courseid=~s/^\///;
9481: $courseid=~s/\_/\//g;
9482: my ($cdomain,$cnum)=split(/\//,$courseid);
9483: my $chome=homeserver($cnum,$cdomain);
9484: if (($chome eq '') || ($chome eq 'no_host')) {
9485: return 'error: no such course';
9486: }
9487: my $cstring='';
1.800 albertel 9488: foreach my $pref (keys(%prefs)) {
9489: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 9490: }
1.84 www 9491: $cstring=~s/\&$//;
9492: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9493: }
9494:
9495: # ---------------------------------------------------------- Make/modify course
9496:
9497: sub createcourse {
1.741 raeburn 9498: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 9499: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 9500: $url=&declutter($url);
9501: my $cid='';
1.1028 raeburn 9502: if ($context eq 'requestcourses') {
9503: my $can_create = 0;
9504: my ($ownername,$ownerdom) = split(':',$course_owner);
9505: if ($udom eq $ownerdom) {
9506: if (&usertools_access($ownername,$ownerdom,$category,undef,
9507: $context)) {
9508: $can_create = 1;
9509: }
9510: } else {
9511: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9512: $category);
9513: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9514: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9515: if (@curr > 0) {
9516: my @options = qw(approval validate autolimit);
9517: my $optregex = join('|',@options);
9518: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9519: $can_create = 1;
9520: }
9521: }
9522: }
9523: }
9524: if ($can_create) {
9525: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9526: unless (&allowed('ccc',$udom)) {
9527: return 'refused';
9528: }
1.1017 raeburn 9529: }
9530: } else {
9531: return 'refused';
9532: }
1.1028 raeburn 9533: } elsif (!&allowed('ccc',$udom)) {
9534: return 'refused';
1.84 www 9535: }
1.1011 raeburn 9536: # --------------------------------------------------------------- Get Unique ID
9537: my $uname;
9538: if ($cnum =~ /^$match_courseid$/) {
9539: my $chome=&homeserver($cnum,$udom,'true');
9540: if (($chome eq '') || ($chome eq 'no_host')) {
9541: $uname = $cnum;
9542: } else {
1.1038 raeburn 9543: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9544: }
9545: } else {
1.1038 raeburn 9546: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9547: }
9548: return $uname if ($uname =~ /^error/);
9549: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 9550: if (!defined($course_server)) {
9551: if (defined(&domain($udom,'primary'))) {
9552: $course_server = &domain($udom,'primary');
9553: } else {
9554: $course_server = $env{'user.home'};
9555: }
9556: }
9557: my %host_servers =
9558: &Apache::lonnet::get_servers($udom,'library');
9559: unless ($host_servers{$course_server}) {
9560: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 9561: }
1.84 www 9562: # ------------------------------------------------------------- Make the course
9563: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 9564: $course_server);
1.84 www 9565: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 9566: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 9567: if (($uhome eq '') || ($uhome eq 'no_host')) {
9568: return 'error: no such course';
9569: }
1.271 www 9570: # ----------------------------------------------------------------- Course made
1.516 raeburn 9571: # log existence
1.1029 raeburn 9572: my $now = time;
1.918 raeburn 9573: my $newcourse = {
9574: $udom.'_'.$uname => {
1.921 raeburn 9575: description => $description,
9576: inst_code => $inst_code,
9577: owner => $course_owner,
9578: type => $crstype,
1.1029 raeburn 9579: creator => $env{'user.name'}.':'.
9580: $env{'user.domain'},
9581: created => $now,
9582: context => $context,
1.918 raeburn 9583: },
9584: };
1.921 raeburn 9585: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 9586: # set toplevel url
1.271 www 9587: my $topurl=$url;
9588: unless ($nonstandard) {
9589: # ------------------------------------------ For standard courses, make top url
9590: my $mapurl=&clutter($url);
1.278 www 9591: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 9592: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 9593: <map>
9594: <resource id="1" type="start"></resource>
9595: <resource id="2" src="$mapurl"></resource>
9596: <resource id="3" type="finish"></resource>
9597: <link index="1" from="1" to="2"></link>
9598: <link index="2" from="2" to="3"></link>
9599: </map>
9600: ENDINITMAP
9601: $topurl=&declutter(
1.638 albertel 9602: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 9603: );
9604: }
9605: # ----------------------------------------------------------- Write preferences
1.84 www 9606: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 9607: ('description' => $description,
9608: 'url' => $topurl,
9609: 'internal.creator' => $env{'user.name'}.':'.
9610: $env{'user.domain'},
9611: 'internal.created' => $now,
9612: 'internal.creationcontext' => $context)
9613: );
1.84 www 9614: return '/'.$udom.'/'.$uname;
9615: }
9616:
1.1011 raeburn 9617: # ------------------------------------------------------------------- Create ID
9618: sub generate_coursenum {
1.1038 raeburn 9619: my ($udom,$crstype) = @_;
1.1011 raeburn 9620: my $domdesc = &domain($udom);
9621: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 9622: my $first;
9623: if ($crstype eq 'Community') {
9624: $first = '0';
9625: } else {
9626: $first = int(1+rand(9));
9627: }
9628: my $uname=$first.
1.1011 raeburn 9629: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9630: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9631: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9632: # ----------------------------------------------- Make sure that does not exist
9633: my $uhome=&homeserver($uname,$udom,'true');
9634: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 9635: if ($crstype eq 'Community') {
9636: $first = '0';
9637: } else {
9638: $first = int(1+rand(9));
9639: }
9640: $uname=$first.
1.1011 raeburn 9641: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9642: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9643: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9644: $uhome=&homeserver($uname,$udom,'true');
9645: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9646: return 'error: unable to generate unique course-ID';
9647: }
9648: }
9649: return $uname;
9650: }
9651:
1.813 albertel 9652: sub is_course {
1.1167 droeschl 9653: my ($cdom, $cnum) = scalar(@_) == 1 ?
9654: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
1.1172.2.95! raeburn 9655: return unless (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/));
! 9656: my $uhome=&homeserver($cnum,$cdom);
! 9657: my $iscourse;
! 9658: if (grep { $_ eq $uhome } current_machine_ids()) {
! 9659: $iscourse = &LONCAPA::Lond::is_course($cdom,$cnum);
! 9660: } else {
! 9661: my $hashid = $cdom.':'.$cnum;
! 9662: ($iscourse,my $cached) = &is_cached_new('iscourse',$hashid);
! 9663: unless (defined($cached)) {
! 9664: my %courses = &courseiddump($cdom, '.', 1, '.', '.',
! 9665: $cnum,undef,undef,'.');
! 9666: $iscourse = 0;
! 9667: if (exists($courses{$cdom.'_'.$cnum})) {
! 9668: $iscourse = 1;
! 9669: }
! 9670: &do_cache_new('iscourse',$hashid,$iscourse,3600);
! 9671: }
! 9672: }
! 9673: return unless($iscourse);
1.1167 droeschl 9674: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 9675: }
9676:
1.1015 raeburn 9677: sub store_userdata {
9678: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 9679: my $result;
1.1016 raeburn 9680: if ($datakey ne '') {
1.1013 raeburn 9681: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 9682: if ($udom eq '' || $uname eq '') {
9683: $udom = $env{'user.domain'};
9684: $uname = $env{'user.name'};
9685: }
9686: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 9687: if (($uhome eq '') || ($uhome eq 'no_host')) {
9688: $result = 'error: no_host';
9689: } else {
9690: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
9691: $storehash->{'host'} = $perlvar{'lonHostID'};
9692:
9693: my $namevalue='';
9694: foreach my $key (keys(%{$storehash})) {
9695: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
9696: }
9697: $namevalue=~s/\&$//;
1.1172.2.26 raeburn 9698: unless ($namespace eq 'courserequests') {
9699: $datakey = &escape($datakey);
9700: }
1.1105 raeburn 9701: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
9702: $namevalue,$uhome);
1.1013 raeburn 9703: }
9704: } else {
9705: $result = 'error: data to store was not a hash reference';
9706: }
9707: } else {
9708: $result= 'error: invalid requestkey';
9709: }
9710: return $result;
9711: }
9712:
1.21 www 9713: # ---------------------------------------------------------- Assign Custom Role
9714:
9715: sub assigncustomrole {
1.957 raeburn 9716: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9717: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 9718: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 9719: }
9720:
9721: # ----------------------------------------------------------------- Revoke Role
9722:
9723: sub revokerole {
1.957 raeburn 9724: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9725: my $now=time;
1.965 raeburn 9726: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 9727: }
9728:
9729: # ---------------------------------------------------------- Revoke Custom Role
9730:
9731: sub revokecustomrole {
1.957 raeburn 9732: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9733: my $now=time;
1.357 www 9734: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 9735: $deleteflag,$selfenroll,$context);
1.17 www 9736: }
9737:
1.533 banghart 9738: # ------------------------------------------------------------ Disk usage
1.535 albertel 9739: sub diskusage {
1.955 raeburn 9740: my ($udom,$uname,$directorypath,$getpropath)=@_;
9741: $directorypath =~ s/\/$//;
9742: my $listing=&reply('du2:'.&escape($directorypath).':'
9743: .&escape($getpropath).':'.&escape($uname).':'
9744: .&escape($udom),homeserver($uname,$udom));
9745: if ($listing eq 'unknown_cmd') {
9746: if ($getpropath) {
9747: $directorypath = &propath($udom,$uname).'/'.$directorypath;
9748: }
9749: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
9750: }
1.514 albertel 9751: return $listing;
1.512 banghart 9752: }
9753:
1.566 banghart 9754: sub is_locked {
1.1096 raeburn 9755: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 9756: my @check;
9757: my $is_locked;
1.1093 raeburn 9758: push (@check,$file_name);
1.613 albertel 9759: my %locked = &get('file_permissions',\@check,
1.620 albertel 9760: $env{'user.domain'},$env{'user.name'});
1.615 albertel 9761: my ($tmp)=keys(%locked);
9762: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 9763:
1.566 banghart 9764: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 9765: $is_locked = 'false';
9766: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 9767: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 9768: $is_locked = 'true';
1.1096 raeburn 9769: if (ref($which) eq 'ARRAY') {
9770: push(@{$which},$entry);
9771: } else {
9772: last;
9773: }
1.745 raeburn 9774: }
9775: }
1.566 banghart 9776: } else {
9777: $is_locked = 'false';
9778: }
1.1093 raeburn 9779: return $is_locked;
1.566 banghart 9780: }
9781:
1.759 albertel 9782: sub declutter_portfile {
9783: my ($file) = @_;
1.833 albertel 9784: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 9785: return $file;
9786: }
9787:
1.559 banghart 9788: # ------------------------------------------------------------- Mark as Read Only
9789:
9790: sub mark_as_readonly {
9791: my ($domain,$user,$files,$what) = @_;
1.613 albertel 9792: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 9793: my ($tmp)=keys(%current_permissions);
9794: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 9795: foreach my $file (@{$files}) {
1.759 albertel 9796: $file = &declutter_portfile($file);
1.561 banghart 9797: push(@{$current_permissions{$file}},$what);
1.559 banghart 9798: }
1.613 albertel 9799: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 9800: return;
9801: }
9802:
1.572 banghart 9803: # ------------------------------------------------------------Save Selected Files
9804:
9805: sub save_selected_files {
9806: my ($user, $path, @files) = @_;
9807: my $filename = $user."savedfiles";
1.573 banghart 9808: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 9809: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 9810: foreach my $file (@files) {
1.620 albertel 9811: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 9812: }
9813: foreach my $file (@other_files) {
1.574 banghart 9814: print (OUT $file."\n");
1.572 banghart 9815: }
1.574 banghart 9816: close (OUT);
1.572 banghart 9817: return 'ok';
9818: }
9819:
1.574 banghart 9820: sub clear_selected_files {
9821: my ($user) = @_;
9822: my $filename = $user."savedfiles";
1.1117 foxr 9823: open (OUT, '>'.LONCAPA::tempdir().$filename);
1.574 banghart 9824: print (OUT undef);
9825: close (OUT);
9826: return ("ok");
9827: }
9828:
1.572 banghart 9829: sub files_in_path {
9830: my ($user, $path) = @_;
9831: my $filename = $user."savedfiles";
9832: my %return_files;
1.1117 foxr 9833: open (IN, '<'.LONCAPA::tempdir().$filename);
1.573 banghart 9834: while (my $line_in = <IN>) {
1.574 banghart 9835: chomp ($line_in);
9836: my @paths_and_file = split (m!/!, $line_in);
9837: my $file_part = pop (@paths_and_file);
9838: my $path_part = join ('/', @paths_and_file);
1.573 banghart 9839: $path_part.='/';
9840: my $path_and_file = $path_part.$file_part;
9841: if ($path_part eq $path) {
9842: $return_files{$file_part}= 'selected';
9843: }
9844: }
1.574 banghart 9845: close (IN);
9846: return (\%return_files);
1.572 banghart 9847: }
9848:
9849: # called in portfolio select mode, to show files selected NOT in current directory
9850: sub files_not_in_path {
9851: my ($user, $path) = @_;
9852: my $filename = $user."savedfiles";
9853: my @return_files;
9854: my $path_part;
1.1117 foxr 9855: open(IN, '<'.LONCAPA::.$filename);
1.800 albertel 9856: while (my $line = <IN>) {
1.572 banghart 9857: #ok, I know it's clunky, but I want it to work
1.800 albertel 9858: my @paths_and_file = split(m|/|, $line);
9859: my $file_part = pop(@paths_and_file);
9860: chomp($file_part);
9861: my $path_part = join('/', @paths_and_file);
1.572 banghart 9862: $path_part .= '/';
9863: my $path_and_file = $path_part.$file_part;
9864: if ($path_part ne $path) {
1.800 albertel 9865: push(@return_files, ($path_and_file));
1.572 banghart 9866: }
9867: }
1.800 albertel 9868: close(OUT);
1.574 banghart 9869: return (@return_files);
1.572 banghart 9870: }
9871:
1.745 raeburn 9872: #----------------------------------------------Get portfolio file permissions
1.629 banghart 9873:
1.745 raeburn 9874: sub get_portfile_permissions {
9875: my ($domain,$user) = @_;
1.613 albertel 9876: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 9877: my ($tmp)=keys(%current_permissions);
9878: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 9879: return \%current_permissions;
9880: }
9881:
9882: #---------------------------------------------Get portfolio file access controls
9883:
1.749 raeburn 9884: sub get_access_controls {
1.745 raeburn 9885: my ($current_permissions,$group,$file) = @_;
1.769 albertel 9886: my %access;
9887: my $real_file = $file;
9888: $file =~ s/\.meta$//;
1.745 raeburn 9889: if (defined($file)) {
1.749 raeburn 9890: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9891: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 9892: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 9893: }
9894: }
1.745 raeburn 9895: } else {
1.749 raeburn 9896: foreach my $key (keys(%{$current_permissions})) {
9897: if ($key =~ /\0accesscontrol$/) {
9898: if (defined($group)) {
9899: if ($key !~ m-^\Q$group\E/-) {
9900: next;
9901: }
9902: }
9903: my ($fullpath) = split(/\0/,$key);
9904: if (ref($$current_permissions{$key}) eq 'HASH') {
9905: foreach my $control (keys(%{$$current_permissions{$key}})) {
9906: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9907: }
9908: }
9909: }
9910: }
9911: }
9912: return %access;
9913: }
9914:
9915: sub modify_access_controls {
9916: my ($file_name,$changes,$domain,$user)=@_;
9917: my ($outcome,$deloutcome);
9918: my %store_permissions;
9919: my %new_values;
9920: my %new_control;
9921: my %translation;
9922: my @deletions = ();
9923: my $now = time;
9924: if (exists($$changes{'activate'})) {
9925: if (ref($$changes{'activate'}) eq 'HASH') {
9926: my @newitems = sort(keys(%{$$changes{'activate'}}));
9927: my $numnew = scalar(@newitems);
9928: for (my $i=0; $i<$numnew; $i++) {
9929: my $newkey = $newitems[$i];
9930: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 9931: if ($newkey =~ /^\d+:/) {
9932: $newkey =~ s/^(\d+)/$newid/;
9933: $translation{$1} = $newid;
9934: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9935: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9936: $translation{$1} = $newid;
9937: }
1.749 raeburn 9938: $new_values{$file_name."\0".$newkey} =
9939: $$changes{'activate'}{$newitems[$i]};
9940: $new_control{$newkey} = $now;
9941: }
9942: }
9943: }
9944: my %todelete;
9945: my %changed_items;
9946: foreach my $action ('delete','update') {
9947: if (exists($$changes{$action})) {
9948: if (ref($$changes{$action}) eq 'HASH') {
9949: foreach my $key (keys(%{$$changes{$action}})) {
9950: my ($itemnum) = ($key =~ /^([^:]+):/);
9951: if ($action eq 'delete') {
9952: $todelete{$itemnum} = 1;
9953: } else {
9954: $changed_items{$itemnum} = $key;
9955: }
9956: }
1.745 raeburn 9957: }
9958: }
1.749 raeburn 9959: }
9960: # get lock on access controls for file.
9961: my $lockhash = {
9962: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9963: ':'.$env{'user.domain'},
9964: };
9965: my $tries = 0;
9966: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9967:
1.1172.2.79 raeburn 9968: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 9969: $tries ++;
1.1172.2.79 raeburn 9970: sleep(0.1);
1.749 raeburn 9971: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9972: }
9973: if ($gotlock eq 'ok') {
9974: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9975: my ($tmp)=keys(%curr_permissions);
9976: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9977: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9978: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9979: if (ref($curr_controls) eq 'HASH') {
9980: foreach my $control_item (keys(%{$curr_controls})) {
9981: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9982: if (defined($todelete{$itemnum})) {
9983: push(@deletions,$file_name."\0".$control_item);
9984: } else {
9985: if (defined($changed_items{$itemnum})) {
9986: $new_control{$changed_items{$itemnum}} = $now;
9987: push(@deletions,$file_name."\0".$control_item);
9988: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9989: } else {
9990: $new_control{$control_item} = $$curr_controls{$control_item};
9991: }
9992: }
1.745 raeburn 9993: }
9994: }
9995: }
1.970 raeburn 9996: my ($group);
9997: if (&is_course($domain,$user)) {
9998: ($group,my $file) = split(/\//,$file_name,2);
9999: }
1.749 raeburn 10000: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
10001: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
10002: $outcome = &put('file_permissions',\%new_values,$domain,$user);
10003: # remove lock
10004: my @del_lock = ($file_name."\0".'locked_access_records');
10005: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 10006: my $sqlresult =
1.970 raeburn 10007: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 10008: $group);
1.749 raeburn 10009: } else {
10010: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 10011: }
1.749 raeburn 10012: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 10013: }
10014:
1.827 raeburn 10015: sub make_public_indefinitely {
10016: my ($requrl) = @_;
10017: my $now = time;
10018: my $action = 'activate';
10019: my $aclnum = 0;
10020: if (&is_portfolio_url($requrl)) {
10021: my (undef,$udom,$unum,$file_name,$group) =
10022: &parse_portfolio_url($requrl);
10023: my $current_perms = &get_portfile_permissions($udom,$unum);
10024: my %access_controls = &get_access_controls($current_perms,
10025: $group,$file_name);
10026: foreach my $key (keys(%{$access_controls{$file_name}})) {
10027: my ($num,$scope,$end,$start) =
10028: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
10029: if ($scope eq 'public') {
10030: if ($start <= $now && $end == 0) {
10031: $action = 'none';
10032: } else {
10033: $action = 'update';
10034: $aclnum = $num;
10035: }
10036: last;
10037: }
10038: }
10039: if ($action eq 'none') {
10040: return 'ok';
10041: } else {
10042: my %changes;
10043: my $newend = 0;
10044: my $newstart = $now;
10045: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
10046: $changes{$action}{$newkey} = {
10047: type => 'public',
10048: time => {
10049: start => $newstart,
10050: end => $newend,
10051: },
10052: };
10053: my ($outcome,$deloutcome,$new_values,$translation) =
10054: &modify_access_controls($file_name,\%changes,$udom,$unum);
10055: return $outcome;
10056: }
10057: } else {
10058: return 'invalid';
10059: }
10060: }
10061:
1.745 raeburn 10062: #------------------------------------------------------Get Marked as Read Only
10063:
10064: sub get_marked_as_readonly {
10065: my ($domain,$user,$what,$group) = @_;
10066: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 10067: my @readonly_files;
1.629 banghart 10068: my $cmp1=$what;
10069: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 10070: while (my ($file_name,$value) = each(%{$current_permissions})) {
10071: if (defined($group)) {
10072: if ($file_name !~ m-^\Q$group\E/-) {
10073: next;
10074: }
10075: }
1.561 banghart 10076: if (ref($value) eq "ARRAY"){
10077: foreach my $stored_what (@{$value}) {
1.629 banghart 10078: my $cmp2=$stored_what;
1.759 albertel 10079: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 10080: $cmp2=join('',@{$stored_what});
1.745 raeburn 10081: }
1.629 banghart 10082: if ($cmp1 eq $cmp2) {
1.561 banghart 10083: push(@readonly_files, $file_name);
1.745 raeburn 10084: last;
1.563 banghart 10085: } elsif (!defined($what)) {
10086: push(@readonly_files, $file_name);
1.745 raeburn 10087: last;
1.561 banghart 10088: }
10089: }
1.745 raeburn 10090: }
1.561 banghart 10091: }
10092: return @readonly_files;
10093: }
1.577 banghart 10094: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 10095:
1.577 banghart 10096: sub get_marked_as_readonly_hash {
1.745 raeburn 10097: my ($current_permissions,$group,$what) = @_;
1.577 banghart 10098: my %readonly_files;
1.745 raeburn 10099: while (my ($file_name,$value) = each(%{$current_permissions})) {
10100: if (defined($group)) {
10101: if ($file_name !~ m-^\Q$group\E/-) {
10102: next;
10103: }
10104: }
1.577 banghart 10105: if (ref($value) eq "ARRAY"){
10106: foreach my $stored_what (@{$value}) {
1.745 raeburn 10107: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 10108: foreach my $lock_descriptor(@{$stored_what}) {
10109: if ($lock_descriptor eq 'graded') {
10110: $readonly_files{$file_name} = 'graded';
10111: } elsif ($lock_descriptor eq 'handback') {
10112: $readonly_files{$file_name} = 'handback';
10113: } else {
10114: if (!exists($readonly_files{$file_name})) {
10115: $readonly_files{$file_name} = 'locked';
10116: }
10117: }
1.745 raeburn 10118: }
1.750 banghart 10119: }
1.577 banghart 10120: }
10121: }
10122: }
10123: return %readonly_files;
10124: }
1.559 banghart 10125: # ------------------------------------------------------------ Unmark as Read Only
10126:
10127: sub unmark_as_readonly {
1.629 banghart 10128: # unmarks $file_name (if $file_name is defined), or all files locked by $what
10129: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 10130: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 10131: $file_name = &declutter_portfile($file_name);
1.634 albertel 10132: my $symb_crs = $what;
10133: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 10134: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 10135: my ($tmp)=keys(%current_permissions);
10136: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 10137: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 10138: foreach my $file (@readonly_files) {
1.759 albertel 10139: my $clean_file = &declutter_portfile($file);
10140: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 10141: my $current_locks = $current_permissions{$file};
1.563 banghart 10142: my @new_locks;
10143: my @del_keys;
10144: if (ref($current_locks) eq "ARRAY"){
10145: foreach my $locker (@{$current_locks}) {
1.632 albertel 10146: my $compare=$locker;
1.749 raeburn 10147: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 10148: $compare=join('',@{$locker});
1.746 raeburn 10149: if ($compare ne $symb_crs) {
10150: push(@new_locks, $locker);
10151: }
1.563 banghart 10152: }
10153: }
1.650 albertel 10154: if (scalar(@new_locks) > 0) {
1.563 banghart 10155: $current_permissions{$file} = \@new_locks;
10156: } else {
10157: push(@del_keys, $file);
1.613 albertel 10158: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 10159: delete($current_permissions{$file});
1.563 banghart 10160: }
10161: }
1.561 banghart 10162: }
1.613 albertel 10163: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 10164: return;
10165: }
1.512 banghart 10166:
1.17 www 10167: # ------------------------------------------------------------ Directory lister
10168:
10169: sub dirlist {
1.955 raeburn 10170: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 10171: $uri=~s/^\///;
10172: $uri=~s/\/$//;
1.253 stredwic 10173: my ($udom, $uname);
1.955 raeburn 10174: if ($getuserdir) {
1.253 stredwic 10175: $udom = $userdomain;
10176: $uname = $username;
1.955 raeburn 10177: } else {
10178: (undef,$udom,$uname)=split(/\//,$uri);
10179: if(defined($userdomain)) {
10180: $udom = $userdomain;
10181: }
10182: if(defined($username)) {
10183: $uname = $username;
10184: }
1.253 stredwic 10185: }
1.955 raeburn 10186: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 10187:
1.955 raeburn 10188: $dirRoot = $perlvar{'lonDocRoot'};
10189: if (defined($getpropath)) {
10190: $dirRoot = &propath($udom,$uname);
1.253 stredwic 10191: $dirRoot =~ s/\/$//;
1.955 raeburn 10192: } elsif (defined($getuserdir)) {
10193: my $subdir=$uname.'__';
10194: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
10195: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
10196: ."/$udom/$subdir/$uname";
10197: } elsif (defined($alternateRoot)) {
10198: $dirRoot = $alternateRoot;
1.751 banghart 10199: }
1.253 stredwic 10200:
10201: if($udom) {
10202: if($uname) {
1.1135 raeburn 10203: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 10204: if ($uhome eq 'no_host') {
10205: return ([],'no_host');
10206: }
1.955 raeburn 10207: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 10208: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 10209: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 10210: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10211: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 10212: } else {
10213: @listing_results = map { &unescape($_); } split(/:/,$listing);
10214: }
1.605 matthew 10215: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 10216: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 10217: @listing_results = split(/:/,$listing);
10218: } else {
10219: @listing_results = map { &unescape($_); } split(/:/,$listing);
10220: }
1.1135 raeburn 10221: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 10222: ($listing eq 'rejected') || ($listing eq 'refused') ||
10223: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10224: return ([],$listing);
10225: } else {
10226: return (\@listing_results);
1.1135 raeburn 10227: }
1.955 raeburn 10228: } elsif(!$alternateRoot) {
1.1136 raeburn 10229: my (%allusers,%listerror);
1.841 albertel 10230: my %servers = &get_servers($udom,'library');
1.955 raeburn 10231: foreach my $tryserver (keys(%servers)) {
10232: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
10233: &escape($udom),$tryserver);
10234: if ($listing eq 'unknown_cmd') {
10235: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
10236: $udom, $tryserver);
10237: } else {
10238: @listing_results = map { &unescape($_); } split(/:/,$listing);
10239: }
1.841 albertel 10240: if ($listing eq 'unknown_cmd') {
10241: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
10242: $udom, $tryserver);
10243: @listing_results = split(/:/,$listing);
10244: } else {
10245: @listing_results =
10246: map { &unescape($_); } split(/:/,$listing);
10247: }
1.1136 raeburn 10248: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
10249: ($listing eq 'rejected') || ($listing eq 'refused') ||
10250: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
10251: $listerror{$tryserver} = $listing;
10252: } else {
1.841 albertel 10253: foreach my $line (@listing_results) {
10254: my ($entry) = split(/&/,$line,2);
10255: $allusers{$entry} = 1;
10256: }
10257: }
1.253 stredwic 10258: }
1.1136 raeburn 10259: my @alluserslist=();
1.800 albertel 10260: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 10261: push(@alluserslist,$user.'&user');
1.253 stredwic 10262: }
1.1172.2.80 raeburn 10263: if (!%listerror) {
10264: # no errors
10265: return (\@alluserslist);
10266: } elsif (scalar(keys(%servers)) == 1) {
10267: # one library server, one error
10268: my ($key) = keys(%listerror);
10269: return (\@alluserslist, $listerror{$key});
10270: } elsif ( grep { $_ eq 'con_lost' } values(%listerror) ) {
10271: # con_lost indicates that we might miss data from at least one
10272: # library server
10273: return (\@alluserslist, 'con_lost');
10274: } else {
10275: # multiple library servers and no con_lost -> data should be
10276: # complete.
10277: return (\@alluserslist);
10278: }
10279:
1.253 stredwic 10280: } else {
1.1136 raeburn 10281: return ([],'missing username');
1.253 stredwic 10282: }
1.955 raeburn 10283: } elsif(!defined($getpropath)) {
1.1136 raeburn 10284: my $path = $perlvar{'lonDocRoot'}.'/res/';
10285: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
10286: return (\@all_domains);
1.955 raeburn 10287: } else {
1.1136 raeburn 10288: return ([],'missing domain');
1.275 stredwic 10289: }
10290: }
10291:
10292: # --------------------------------------------- GetFileTimestamp
10293: # This function utilizes dirlist and returns the date stamp for
10294: # when it was last modified. It will also return an error of -1
10295: # if an error occurs
10296:
10297: sub GetFileTimestamp {
1.955 raeburn 10298: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 10299: $studentDomain = &LONCAPA::clean_domain($studentDomain);
10300: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 10301: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
10302: undef,$getuserdir);
10303: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10304: return -1;
10305: }
10306: if (ref($fileref) eq 'ARRAY') {
10307: my @stats = split('&',$fileref->[0]);
1.375 matthew 10308: # @stats contains first the filename, then the stat output
10309: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 10310: } else {
10311: return -1;
1.253 stredwic 10312: }
1.26 www 10313: }
10314:
1.712 albertel 10315: sub stat_file {
10316: my ($uri) = @_;
1.787 albertel 10317: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 10318:
1.955 raeburn 10319: my ($udom,$uname,$file);
1.712 albertel 10320: if ($uri =~ m-^/(uploaded|editupload)/-) {
10321: ($udom,$uname,$file) =
1.811 albertel 10322: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 10323: $file = 'userfiles/'.$file;
10324: }
10325: if ($uri =~ m-^/res/-) {
10326: ($udom,$uname) =
1.807 albertel 10327: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 10328: $file = $uri;
10329: }
10330:
10331: if (!$udom || !$uname || !$file) {
10332: # unable to handle the uri
10333: return ();
10334: }
1.956 raeburn 10335: my $getpropath;
10336: if ($file =~ /^userfiles\//) {
10337: $getpropath = 1;
10338: }
1.1136 raeburn 10339: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10340: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10341: return ();
10342: } else {
10343: if (ref($listref) eq 'ARRAY') {
10344: my @stats = split('&',$listref->[0]);
10345: shift(@stats); #filename is first
10346: return @stats;
10347: }
1.712 albertel 10348: }
10349: return ();
10350: }
10351:
1.26 www 10352: # -------------------------------------------------------- Value of a Condition
10353:
1.713 albertel 10354: # gets the value of a specific preevaluated condition
10355: # stored in the string $env{user.state.<cid>}
10356: # or looks up a condition reference in the bighash and if if hasn't
10357: # already been evaluated recurses into docondval to get the value of
10358: # the condition, then memoizing it to
10359: # $env{user.state.<cid>.<condition>}
1.40 www 10360: sub directcondval {
10361: my $number=shift;
1.620 albertel 10362: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 10363: &Apache::lonuserstate::evalstate();
10364: }
1.713 albertel 10365: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
10366: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
10367: } elsif ($number =~ /^_/) {
10368: my $sub_condition;
10369: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10370: &GDBM_READER(),0640)) {
10371: $sub_condition=$bighash{'conditions'.$number};
10372: untie(%bighash);
10373: }
10374: my $value = &docondval($sub_condition);
1.949 raeburn 10375: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 10376: return $value;
10377: }
1.620 albertel 10378: if ($env{'user.state.'.$env{'request.course.id'}}) {
10379: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 10380: } else {
10381: return 2;
10382: }
10383: }
10384:
1.713 albertel 10385: # get the collection of conditions for this resource
1.26 www 10386: sub condval {
10387: my $condidx=shift;
1.54 www 10388: my $allpathcond='';
1.713 albertel 10389: foreach my $cond (split(/\|/,$condidx)) {
10390: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
10391: $allpathcond.=
10392: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
10393: }
1.191 harris41 10394: }
1.54 www 10395: $allpathcond=~s/\|$//;
1.713 albertel 10396: return &docondval($allpathcond);
10397: }
10398:
10399: #evaluates an expression of conditions
10400: sub docondval {
10401: my ($allpathcond) = @_;
10402: my $result=0;
10403: if ($env{'request.course.id'}
10404: && defined($allpathcond)) {
10405: my $operand='|';
10406: my @stack;
10407: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
10408: if ($chunk eq '(') {
10409: push @stack,($operand,$result);
10410: } elsif ($chunk eq ')') {
10411: my $before=pop @stack;
10412: if (pop @stack eq '&') {
10413: $result=$result>$before?$before:$result;
10414: } else {
10415: $result=$result>$before?$result:$before;
10416: }
10417: } elsif (($chunk eq '&') || ($chunk eq '|')) {
10418: $operand=$chunk;
10419: } else {
10420: my $new=directcondval($chunk);
10421: if ($operand eq '&') {
10422: $result=$result>$new?$new:$result;
10423: } else {
10424: $result=$result>$new?$result:$new;
10425: }
10426: }
10427: }
1.26 www 10428: }
10429: return $result;
1.421 albertel 10430: }
10431:
10432: # ---------------------------------------------------- Devalidate courseresdata
10433:
10434: sub devalidatecourseresdata {
10435: my ($coursenum,$coursedomain)=@_;
10436: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 10437: &devalidate_cache_new('courseres',$hashid);
1.28 www 10438: }
10439:
1.763 www 10440:
1.200 www 10441: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 10442: #
10443: # Parameters:
10444: # $coursenum - Number of the course.
10445: # $coursedomain - Domain at which the course was created.
10446: # Returns:
10447: # A hash of the course parameters along (I think) with timestamps
10448: # and version info.
1.877 foxr 10449:
1.624 albertel 10450: sub get_courseresdata {
10451: my ($coursenum,$coursedomain)=@_;
1.200 www 10452: my $coursehom=&homeserver($coursenum,$coursedomain);
10453: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 10454: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 10455: my %dumpreply;
1.417 albertel 10456: unless (defined($cached)) {
1.624 albertel 10457: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 10458: $result=\%dumpreply;
1.251 albertel 10459: my ($tmp) = keys(%dumpreply);
10460: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 10461: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 10462: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
10463: return $tmp;
1.416 albertel 10464: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 10465: $result=undef;
1.599 albertel 10466: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 10467: }
10468: }
1.624 albertel 10469: return $result;
10470: }
10471:
1.633 albertel 10472: sub devalidateuserresdata {
10473: my ($uname,$udom)=@_;
10474: my $hashid="$udom:$uname";
10475: &devalidate_cache_new('userres',$hashid);
10476: }
10477:
1.624 albertel 10478: sub get_userresdata {
10479: my ($uname,$udom)=@_;
10480: #most student don\'t have any data set, check if there is some data
10481: if (&EXT_cache_status($udom,$uname)) { return undef; }
10482:
10483: my $hashid="$udom:$uname";
10484: my ($result,$cached)=&is_cached_new('userres',$hashid);
10485: if (!defined($cached)) {
10486: my %resourcedata=&dump('resourcedata',$udom,$uname);
10487: $result=\%resourcedata;
10488: &do_cache_new('userres',$hashid,$result,600);
10489: }
10490: my ($tmp)=keys(%$result);
10491: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
10492: return $result;
10493: }
10494: #error 2 occurs when the .db doesn't exist
10495: if ($tmp!~/error: 2 /) {
1.1172.2.71 raeburn 10496: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
10497: &logthis("<font color=\"blue\">WARNING:".
10498: " Trying to get resource data for ".
10499: $uname." at ".$udom.": ".
10500: $tmp."</font>");
10501: }
1.624 albertel 10502: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 10503: #&EXT_cache_set($udom,$uname);
10504: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 10505: undef($tmp); # not really an error so don't send it back
1.624 albertel 10506: }
10507: return $tmp;
10508: }
1.879 foxr 10509: #----------------------------------------------- resdata - return resource data
10510: # Purpose:
10511: # Return resource data for either users or for a course.
10512: # Parameters:
10513: # $name - Course/user name.
10514: # $domain - Name of the domain the user/course is registered on.
10515: # $type - Type of thing $name is (must be 'course' or 'user'
10516: # @which - Array of names of resources desired.
10517: # Returns:
10518: # The value of the first reasource in @which that is found in the
10519: # resource hash.
10520: # Exceptional Conditions:
10521: # If the $type passed in is not valid (not the string 'course' or
10522: # 'user', an undefined reference is returned.
10523: # If none of the resources are found, an undef is returned
1.624 albertel 10524: sub resdata {
10525: my ($name,$domain,$type,@which)=@_;
10526: my $result;
10527: if ($type eq 'course') {
10528: $result=&get_courseresdata($name,$domain);
10529: } elsif ($type eq 'user') {
10530: $result=&get_userresdata($name,$domain);
10531: }
10532: if (!ref($result)) { return $result; }
1.251 albertel 10533: foreach my $item (@which) {
1.927 albertel 10534: if (defined($result->{$item->[0]})) {
10535: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 10536: }
1.250 albertel 10537: }
1.291 albertel 10538: return undef;
1.200 www 10539: }
10540:
1.1172.2.31 raeburn 10541: sub get_numsuppfiles {
10542: my ($cnum,$cdom,$ignorecache)=@_;
10543: my $hashid=$cnum.':'.$cdom;
10544: my ($suppcount,$cached);
10545: unless ($ignorecache) {
10546: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
10547: }
10548: unless (defined($cached)) {
10549: my $chome=&homeserver($cnum,$cdom);
10550: unless ($chome eq 'no_host') {
10551: ($suppcount,my $errors) = (0,0);
10552: my $suppmap = 'supplemental.sequence';
10553: ($suppcount,$errors) =
10554: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
10555: }
10556: &do_cache_new('suppcount',$hashid,$suppcount,600);
10557: }
10558: return $suppcount;
10559: }
10560:
1.379 matthew 10561: #
10562: # EXT resource caching routines
10563: #
10564:
10565: sub clear_EXT_cache_status {
1.383 albertel 10566: &delenv('cache.EXT.');
1.379 matthew 10567: }
10568:
10569: sub EXT_cache_status {
10570: my ($target_domain,$target_user) = @_;
1.383 albertel 10571: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 10572: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 10573: # We know already the user has no data
10574: return 1;
10575: } else {
10576: return 0;
10577: }
10578: }
10579:
10580: sub EXT_cache_set {
10581: my ($target_domain,$target_user) = @_;
1.383 albertel 10582: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 10583: #&appenv({$cachename => time});
1.379 matthew 10584: }
10585:
1.28 www 10586: # --------------------------------------------------------- Value of a Variable
1.58 www 10587: sub EXT {
1.715 albertel 10588:
1.1172.2.28 raeburn 10589: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68 www 10590: unless ($varname) { return ''; }
1.218 albertel 10591: #get real user name/domain, courseid and symb
10592: my $courseid;
1.359 albertel 10593: my $publicuser;
1.427 www 10594: if ($symbparm) {
10595: $symbparm=&get_symb_from_alias($symbparm);
10596: }
1.218 albertel 10597: if (!($uname && $udom)) {
1.790 albertel 10598: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 10599: if (!$symbparm) { $symbparm=$cursymb; }
10600: } else {
1.620 albertel 10601: $courseid=$env{'request.course.id'};
1.218 albertel 10602: }
1.48 www 10603: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
10604: my $rest;
1.320 albertel 10605: if (defined($therest[0])) {
1.48 www 10606: $rest=join('.',@therest);
10607: } else {
10608: $rest='';
10609: }
1.320 albertel 10610:
1.57 www 10611: my $qualifierrest=$qualifier;
10612: if ($rest) { $qualifierrest.='.'.$rest; }
10613: my $spacequalifierrest=$space;
10614: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 10615: if ($realm eq 'user') {
1.48 www 10616: # --------------------------------------------------------------- user.resource
10617: if ($space eq 'resource') {
1.651 albertel 10618: if ( (defined($Apache::lonhomework::parsing_a_problem)
10619: || defined($Apache::lonhomework::parsing_a_task))
10620: &&
1.744 albertel 10621: ($symbparm eq &symbread()) ) {
10622: # if we are in the middle of processing the resource the
10623: # get the value we are planning on committing
10624: if (defined($Apache::lonhomework::results{$qualifierrest})) {
10625: return $Apache::lonhomework::results{$qualifierrest};
10626: } else {
10627: return $Apache::lonhomework::history{$qualifierrest};
10628: }
1.335 albertel 10629: } else {
1.359 albertel 10630: my %restored;
1.620 albertel 10631: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 10632: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
10633: } else {
10634: %restored=&restore($symbparm,$courseid,$udom,$uname);
10635: }
1.335 albertel 10636: return $restored{$qualifierrest};
10637: }
1.48 www 10638: # ----------------------------------------------------------------- user.access
10639: } elsif ($space eq 'access') {
1.218 albertel 10640: # FIXME - not supporting calls for a specific user
1.48 www 10641: return &allowed($qualifier,$rest);
10642: # ------------------------------------------ user.preferences, user.environment
10643: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 10644: if (($uname eq $env{'user.name'}) &&
10645: ($udom eq $env{'user.domain'})) {
10646: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 10647: } else {
1.359 albertel 10648: my %returnhash;
10649: if (!$publicuser) {
10650: %returnhash=&userenvironment($udom,$uname,
10651: $qualifierrest);
10652: }
1.218 albertel 10653: return $returnhash{$qualifierrest};
10654: }
1.48 www 10655: # ----------------------------------------------------------------- user.course
10656: } elsif ($space eq 'course') {
1.218 albertel 10657: # FIXME - not supporting calls for a specific user
1.620 albertel 10658: return $env{join('.',('request.course',$qualifier))};
1.48 www 10659: # ------------------------------------------------------------------- user.role
10660: } elsif ($space eq 'role') {
1.218 albertel 10661: # FIXME - not supporting calls for a specific user
1.620 albertel 10662: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 10663: if ($qualifier eq 'value') {
10664: return $role;
10665: } elsif ($qualifier eq 'extent') {
10666: return $where;
10667: }
10668: # ----------------------------------------------------------------- user.domain
10669: } elsif ($space eq 'domain') {
1.218 albertel 10670: return $udom;
1.48 www 10671: # ------------------------------------------------------------------- user.name
10672: } elsif ($space eq 'name') {
1.218 albertel 10673: return $uname;
1.48 www 10674: # ---------------------------------------------------- Any other user namespace
1.29 www 10675: } else {
1.359 albertel 10676: my %reply;
10677: if (!$publicuser) {
10678: %reply=&get($space,[$qualifierrest],$udom,$uname);
10679: }
10680: return $reply{$qualifierrest};
1.48 www 10681: }
1.236 www 10682: } elsif ($realm eq 'query') {
10683: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 10684: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
10685: [$spacequalifierrest]);
1.620 albertel 10686: return $env{'form.'.$spacequalifierrest};
1.236 www 10687: } elsif ($realm eq 'request') {
1.48 www 10688: # ------------------------------------------------------------- request.browser
10689: if ($space eq 'browser') {
1.1145 bisitz 10690: return $env{'browser.'.$qualifier};
1.57 www 10691: # ------------------------------------------------------------ request.filename
10692: } else {
1.620 albertel 10693: return $env{'request.'.$spacequalifierrest};
1.29 www 10694: }
1.28 www 10695: } elsif ($realm eq 'course') {
1.48 www 10696: # ---------------------------------------------------------- course.description
1.620 albertel 10697: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 10698: } elsif ($realm eq 'resource') {
1.165 www 10699:
1.620 albertel 10700: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 10701: if (!$symbparm) { $symbparm=&symbread(); }
10702: }
1.693 albertel 10703:
1.1172.2.30 raeburn 10704: if ($qualifier eq '') {
10705: if ($space eq 'title') {
10706: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
10707: return &gettitle($symbparm);
10708: }
1.693 albertel 10709:
1.1172.2.30 raeburn 10710: if ($space eq 'map') {
10711: my ($map) = &decode_symb($symbparm);
10712: return &symbread($map);
10713: }
10714: if ($space eq 'maptitle') {
10715: my ($map) = &decode_symb($symbparm);
10716: return &gettitle($map);
10717: }
10718: if ($space eq 'filename') {
10719: if ($symbparm) {
10720: return &clutter((&decode_symb($symbparm))[2]);
10721: }
10722: return &hreflocation('',$env{'request.filename'});
1.905 albertel 10723: }
1.1172.2.30 raeburn 10724:
10725: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
10726: if ($space eq 'visibleparts') {
10727: my $navmap = Apache::lonnavmaps::navmap->new();
10728: my $item;
10729: if (ref($navmap)) {
10730: my $res = $navmap->getBySymb($symbparm);
10731: my $parts = $res->parts();
10732: if (ref($parts) eq 'ARRAY') {
10733: $item = join(',',@{$parts});
10734: }
10735: undef($navmap);
10736: }
10737: return $item;
10738: }
10739: }
10740: }
1.693 albertel 10741:
10742: my ($section, $group, @groups);
1.593 albertel 10743: my ($courselevelm,$courselevel);
1.1172.2.28 raeburn 10744: if (($courseid eq '') && ($cid)) {
10745: $courseid = $cid;
10746: }
10747: if (($symbparm && $courseid) &&
10748: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 10749:
1.218 albertel 10750: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 10751:
1.60 www 10752: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 10753: my $symbp=$symbparm;
1.735 albertel 10754: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 10755:
10756: my $symbparm=$symbp.'.'.$spacequalifierrest;
10757: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
10758:
1.620 albertel 10759: if (($env{'user.name'} eq $uname) &&
10760: ($env{'user.domain'} eq $udom)) {
10761: $section=$env{'request.course.sec'};
1.733 raeburn 10762: @groups = split(/:/,$env{'request.course.groups'});
10763: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 10764: } else {
1.539 albertel 10765: if (! defined($usection)) {
1.551 albertel 10766: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 10767: } else {
10768: $section = $usection;
10769: }
1.733 raeburn 10770: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 10771: }
10772:
10773: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10774: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10775: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10776:
1.593 albertel 10777: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 10778: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 10779: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 10780:
1.60 www 10781: # ----------------------------------------------------------- first, check user
1.624 albertel 10782:
10783: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 10784: ([$courselevelr,'resource'],
10785: [$courselevelm,'map' ],
10786: [$courselevel, 'course' ]));
1.931 albertel 10787: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 10788:
1.594 albertel 10789: # ------------------------------------------------ second, check some of course
1.684 raeburn 10790: my $coursereply;
1.691 raeburn 10791: if (@groups > 0) {
10792: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10793: $mapparm,$spacequalifierrest);
1.927 albertel 10794: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 10795: }
1.96 www 10796:
1.684 raeburn 10797: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 10798: $env{'course.'.$courseid.'.domain'},
10799: 'course',
10800: ([$seclevelr, 'resource'],
10801: [$seclevelm, 'map' ],
10802: [$seclevel, 'course' ],
10803: [$courselevelr,'resource']));
10804: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 10805:
1.60 www 10806: # ------------------------------------------------------ third, check map parms
1.218 albertel 10807: my %parmhash=();
10808: my $thisparm='';
10809: if (tie(%parmhash,'GDBM_File',
1.620 albertel 10810: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 10811: &GDBM_READER(),0640)) {
1.218 albertel 10812: $thisparm=$parmhash{$symbparm};
10813: untie(%parmhash);
10814: }
1.927 albertel 10815: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 10816: }
1.594 albertel 10817: # ------------------------------------------ fourth, look in resource metadata
1.71 www 10818:
1.218 albertel 10819: $spacequalifierrest=~s/\./\_/;
1.282 albertel 10820: my $filename;
10821: if (!$symbparm) { $symbparm=&symbread(); }
10822: if ($symbparm) {
1.409 www 10823: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 10824: } else {
1.620 albertel 10825: $filename=$env{'request.filename'};
1.282 albertel 10826: }
10827: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 10828: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 10829: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 10830: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 10831:
1.927 albertel 10832: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 10833: if ($symbparm && defined($courseid) &&
1.620 albertel 10834: $courseid eq $env{'request.course.id'}) {
1.624 albertel 10835: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10836: $env{'course.'.$courseid.'.domain'},
10837: 'course',
1.927 albertel 10838: ([$courselevelm,'map' ],
10839: [$courselevel, 'course']));
10840: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 10841: }
1.145 www 10842: # ------------------------------------------------------------------ Cascade up
1.218 albertel 10843: unless ($space eq '0') {
1.336 albertel 10844: my @parts=split(/_/,$space);
10845: my $id=pop(@parts);
10846: my $part=join('_',@parts);
10847: if ($part eq '') { $part='0'; }
1.927 albertel 10848: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 10849: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 10850: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 10851: }
1.395 albertel 10852: if ($recurse) { return undef; }
10853: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 10854: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 10855: # ---------------------------------------------------- Any other user namespace
10856: } elsif ($realm eq 'environment') {
10857: # ----------------------------------------------------------------- environment
1.620 albertel 10858: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10859: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 10860: } else {
1.770 albertel 10861: if ($uname eq 'anonymous' && $udom eq '') {
10862: return '';
10863: }
1.219 albertel 10864: my %returnhash=&userenvironment($udom,$uname,
10865: $spacequalifierrest);
10866: return $returnhash{$spacequalifierrest};
10867: }
1.28 www 10868: } elsif ($realm eq 'system') {
1.48 www 10869: # ----------------------------------------------------------------- system.time
10870: if ($space eq 'time') {
10871: return time;
10872: }
1.696 albertel 10873: } elsif ($realm eq 'server') {
10874: # ----------------------------------------------------------------- system.time
10875: if ($space eq 'name') {
10876: return $ENV{'SERVER_NAME'};
10877: }
1.28 www 10878: }
1.48 www 10879: return '';
1.61 www 10880: }
10881:
1.927 albertel 10882: sub get_reply {
10883: my ($reply_value) = @_;
1.940 raeburn 10884: if (ref($reply_value) eq 'ARRAY') {
10885: if (wantarray) {
10886: return @$reply_value;
10887: }
10888: return $reply_value->[0];
10889: } else {
10890: return $reply_value;
1.927 albertel 10891: }
10892: }
10893:
1.691 raeburn 10894: sub check_group_parms {
10895: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
10896: my @groupitems = ();
10897: my $resultitem;
1.927 albertel 10898: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 10899: foreach my $group (@{$groups}) {
10900: foreach my $level (@levels) {
1.927 albertel 10901: my $item = $courseid.'.['.$group.'].'.$level->[0];
10902: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 10903: }
10904: }
10905: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10906: $env{'course.'.$courseid.'.domain'},
10907: 'course',@groupitems);
10908: return $coursereply;
10909: }
10910:
10911: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 10912: my ($courseid,@groups) = @_;
10913: @groups = sort(@groups);
1.691 raeburn 10914: return @groups;
10915: }
10916:
1.395 albertel 10917: sub packages_tab_default {
10918: my ($uri,$varname)=@_;
10919: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 10920:
10921: my (@extension,@specifics,$do_default);
10922: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 10923: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 10924: if ($pack_type eq 'default') {
10925: $do_default=1;
10926: } elsif ($pack_type eq 'extension') {
10927: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 10928: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 10929: # only look at packages defaults for packages that this id is
1.738 albertel 10930: push(@specifics,[$package,$pack_type,$pack_part]);
10931: }
10932: }
10933: # first look for a package that matches the requested part id
10934: foreach my $package (@specifics) {
10935: my (undef,$pack_type,$pack_part)=@{$package};
10936: next if ($pack_part ne $part);
10937: if (defined($packagetab{"$pack_type&$name&default"})) {
10938: return $packagetab{"$pack_type&$name&default"};
10939: }
10940: }
10941: # look for any possible matching non extension_ package
10942: foreach my $package (@specifics) {
10943: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 10944: if (defined($packagetab{"$pack_type&$name&default"})) {
10945: return $packagetab{"$pack_type&$name&default"};
10946: }
1.585 albertel 10947: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 10948: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10949: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 10950: }
10951: }
1.738 albertel 10952: # look for any posible extension_ match
10953: foreach my $package (@extension) {
10954: my ($package,$pack_type)=@{$package};
10955: if (defined($packagetab{"$pack_type&$name&default"})) {
10956: return $packagetab{"$pack_type&$name&default"};
10957: }
10958: if (defined($packagetab{$package."&$name&default"})) {
10959: return $packagetab{$package."&$name&default"};
10960: }
10961: }
10962: # look for a global default setting
10963: if ($do_default && defined($packagetab{"default&$name&default"})) {
10964: return $packagetab{"default&$name&default"};
10965: }
1.395 albertel 10966: return undef;
10967: }
10968:
1.334 albertel 10969: sub add_prefix_and_part {
10970: my ($prefix,$part)=@_;
10971: my $keyroot;
10972: if (defined($prefix) && $prefix !~ /^__/) {
10973: # prefix that has a part already
10974: $keyroot=$prefix;
10975: } elsif (defined($prefix)) {
10976: # prefix that is missing a part
10977: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10978: } else {
10979: # no prefix at all
10980: if (defined($part)) { $keyroot='_'.$part; }
10981: }
10982: return $keyroot;
10983: }
10984:
1.71 www 10985: # ---------------------------------------------------------------- Get metadata
10986:
1.599 albertel 10987: my %metaentry;
1.1070 www 10988: my %importedpartids;
1.71 www 10989: sub metadata {
1.176 www 10990: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 10991: $uri=&declutter($uri);
1.288 albertel 10992: # if it is a non metadata possible uri return quickly
1.529 albertel 10993: if (($uri eq '') ||
10994: (($uri =~ m|^/*adm/|) &&
1.1172.2.20 raeburn 10995: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard)$})) ||
1.1108 raeburn 10996: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 10997: return undef;
10998: }
1.1172.2.49 raeburn 10999: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 11000: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 11001: return undef;
1.288 albertel 11002: }
1.73 www 11003: my $filename=$uri;
11004: $uri=~s/\.meta$//;
1.172 www 11005: #
11006: # Is the metadata already cached?
1.177 www 11007: # Look at timestamp of caching
1.172 www 11008: # Everything is cached by the main uri, libraries are never directly cached
11009: #
1.428 albertel 11010: if (!defined($liburi)) {
1.599 albertel 11011: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 11012: if (defined($cached)) { return $result->{':'.$what}; }
11013: }
11014: {
1.1069 www 11015: # Imported parts would go here
1.1070 www 11016: my %importedids=();
11017: my @origfileimportpartids=();
1.1069 www 11018: my $importedparts=0;
1.172 www 11019: #
11020: # Is this a recursive call for a library?
11021: #
1.599 albertel 11022: # if (! exists($metacache{$uri})) {
11023: # $metacache{$uri}={};
11024: # }
1.924 albertel 11025: my $cachetime = 60*60;
1.171 www 11026: if ($liburi) {
11027: $liburi=&declutter($liburi);
11028: $filename=$liburi;
1.401 bowersj2 11029: } else {
1.599 albertel 11030: &devalidate_cache_new('meta',$uri);
11031: undef(%metaentry);
1.401 bowersj2 11032: }
1.140 www 11033: my %metathesekeys=();
1.73 www 11034: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 11035: my $metastring;
1.1140 www 11036: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 11037: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 11038: $metastring =
1.929 albertel 11039: &Apache::lonnet::ssi_body($which,
1.924 albertel 11040: ('grade_target' => 'meta'));
11041: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 11042: } elsif (($uri !~ m -^(editupload)/-) &&
11043: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 11044: my $file=&filelocation('',&clutter($filename));
1.599 albertel 11045: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 11046: $metastring=&getfile($file);
1.489 albertel 11047: }
1.208 albertel 11048: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 11049: my $token;
1.140 www 11050: undef %metathesekeys;
1.71 www 11051: while ($token=$parser->get_token) {
1.339 albertel 11052: if ($token->[0] eq 'S') {
11053: if (defined($token->[2]->{'package'})) {
1.172 www 11054: #
11055: # This is a package - get package info
11056: #
1.339 albertel 11057: my $package=$token->[2]->{'package'};
11058: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11059: if (defined($token->[2]->{'id'})) {
11060: $keyroot.='_'.$token->[2]->{'id'};
11061: }
1.599 albertel 11062: if ($metaentry{':packages'}) {
11063: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 11064: } else {
1.599 albertel 11065: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 11066: }
1.736 albertel 11067: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 11068: my $part=$keyroot;
11069: $part=~s/^\_//;
1.736 albertel 11070: if ($pack_entry=~/^\Q$package\E\&/ ||
11071: $pack_entry=~/^\Q$package\E_0\&/) {
11072: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 11073: # ignore package.tab specified default values
11074: # here &package_tab_default() will fetch those
11075: if ($subp eq 'default') { next; }
1.736 albertel 11076: my $value=$packagetab{$pack_entry};
1.432 albertel 11077: my $unikey;
11078: if ($pack =~ /_0$/) {
11079: $unikey='parameter_0_'.$name;
11080: $part=0;
11081: } else {
11082: $unikey='parameter'.$keyroot.'_'.$name;
11083: }
1.339 albertel 11084: if ($subp eq 'display') {
11085: $value.=' [Part: '.$part.']';
11086: }
1.599 albertel 11087: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 11088: $metathesekeys{$unikey}=1;
1.599 albertel 11089: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11090: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 11091: }
1.599 albertel 11092: if (defined($metaentry{':'.$unikey.'.default'})) {
11093: $metaentry{':'.$unikey}=
11094: $metaentry{':'.$unikey.'.default'};
1.356 albertel 11095: }
1.339 albertel 11096: }
11097: }
11098: } else {
1.172 www 11099: #
11100: # This is not a package - some other kind of start tag
1.339 albertel 11101: #
11102: my $entry=$token->[1];
1.1068 www 11103: my $unikey='';
1.175 www 11104:
1.339 albertel 11105: if ($entry eq 'import') {
1.175 www 11106: #
11107: # Importing a library here
1.339 albertel 11108: #
1.1067 www 11109: my $location=$parser->get_text('/import');
11110: my $dir=$filename;
11111: $dir=~s|[^/]*$||;
11112: $location=&filelocation($dir,$location);
1.1069 www 11113:
1.1068 www 11114: my $importmode=$token->[2]->{'importmode'};
11115: if ($importmode eq 'problem') {
1.1069 www 11116: # Import as problem/response
1.1068 www 11117: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11118: } elsif ($importmode eq 'part') {
11119: # Import as part(s)
1.1069 www 11120: $importedparts=1;
11121: # We need to get the original file and the imported file to get the part order correct
11122: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
11123: # Load and inspect original file
1.1070 www 11124: if ($#origfileimportpartids<0) {
11125: undef(%importedpartids);
11126: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
11127: my $origfile=&getfile($origfilelocation);
11128: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11129: }
11130:
1.1069 www 11131: # Load and inspect imported file
11132: my $impfile=&getfile($location);
11133: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
11134: if ($#impfilepartids>=0) {
11135: # This problem had parts
1.1070 www 11136: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 11137: } else {
11138: # Importing by turning a single problem into a problem part
11139: # It gets the import-tags ID as part-ID
11140: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 11141: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 11142: }
1.1068 www 11143: } else {
11144: # Normal import
11145: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
11146: if (defined($token->[2]->{'id'})) {
11147: $unikey.='_'.$token->[2]->{'id'};
11148: }
1.1067 www 11149: }
11150:
1.339 albertel 11151: if ($depthcount<20) {
1.736 albertel 11152: my $metadata =
11153: &metadata($uri,'keys', $location,$unikey,
11154: $depthcount+1);
11155: foreach my $meta (split(',',$metadata)) {
11156: $metaentry{':'.$meta}=$metaentry{':'.$meta};
11157: $metathesekeys{$meta}=1;
1.339 albertel 11158: }
1.1068 www 11159:
11160: }
1.1067 www 11161: } else {
11162: #
11163: # Not importing, some other kind of non-package, non-library start tag
11164: #
11165: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
11166: if (defined($token->[2]->{'id'})) {
11167: $unikey.='_'.$token->[2]->{'id'};
11168: }
1.339 albertel 11169: if (defined($token->[2]->{'name'})) {
11170: $unikey.='_'.$token->[2]->{'name'};
11171: }
11172: $metathesekeys{$unikey}=1;
1.736 albertel 11173: foreach my $param (@{$token->[3]}) {
11174: $metaentry{':'.$unikey.'.'.$param} =
11175: $token->[2]->{$param};
1.339 albertel 11176: }
11177: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 11178: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 11179: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
11180: # only ws inside the tag, and not in default, so use default
11181: # as value
1.599 albertel 11182: $metaentry{':'.$unikey}=$default;
1.908 albertel 11183: } elsif ( $internaltext =~ /\S/ ) {
11184: # something interesting inside the tag
11185: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 11186: } else {
1.908 albertel 11187: # no interesting values, don't set a default
1.339 albertel 11188: }
1.172 www 11189: # end of not-a-package not-a-library import
1.339 albertel 11190: }
1.172 www 11191: # end of not-a-package start tag
1.339 albertel 11192: }
1.172 www 11193: # the next is the end of "start tag"
1.339 albertel 11194: }
11195: }
1.483 albertel 11196: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 11197: $extension = lc($extension);
11198: if ($extension eq 'htm') { $extension='html'; }
11199:
1.737 albertel 11200: foreach my $key (keys(%packagetab)) {
1.483 albertel 11201: #no specific packages #how's our extension
11202: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 11203: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 11204: \%metathesekeys);
11205: }
1.883 albertel 11206:
11207: if (!exists($metaentry{':packages'})
11208: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 11209: foreach my $key (keys(%packagetab)) {
1.483 albertel 11210: #no specific packages well let's get default then
11211: if ($key!~/^default&/) { next; }
1.488 albertel 11212: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 11213: \%metathesekeys);
11214: }
11215: }
1.338 www 11216: # are there custom rights to evaluate
1.599 albertel 11217: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 11218:
1.338 www 11219: #
11220: # Importing a rights file here
1.339 albertel 11221: #
11222: unless ($depthcount) {
1.599 albertel 11223: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 11224: my $dir=$filename;
11225: $dir=~s|[^/]*$||;
11226: $location=&filelocation($dir,$location);
1.736 albertel 11227: my $rights_metadata =
11228: &metadata($uri,'keys',$location,'_rights',
11229: $depthcount+1);
11230: foreach my $rights (split(',',$rights_metadata)) {
11231: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
11232: $metathesekeys{$rights}=1;
1.339 albertel 11233: }
11234: }
11235: }
1.737 albertel 11236: # uniqifiy package listing
11237: my %seen;
11238: my @uniq_packages =
11239: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
11240: $metaentry{':packages'} = join(',',@uniq_packages);
11241:
1.1070 www 11242: if ($importedparts) {
11243: # We had imported parts and need to rebuild partorder
11244: $metaentry{':partorder'}='';
11245: $metathesekeys{'partorder'}=1;
11246: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
11247: if ($origfileimportpartids[$index] eq 'part') {
11248: # original part, part of the problem
11249: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
11250: } else {
11251: # we have imported parts at this position
11252: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
11253: }
11254: }
11255: $metaentry{':partorder'}=~s/^\,//;
11256: }
11257:
1.737 albertel 11258: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 11259: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1172.2.58 raeburn 11260: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.924 albertel 11261: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 11262: # this is the end of "was not already recently cached
1.71 www 11263: }
1.599 albertel 11264: return $metaentry{':'.$what};
1.261 albertel 11265: }
11266:
1.488 albertel 11267: sub metadata_create_package_def {
1.483 albertel 11268: my ($uri,$key,$package,$metathesekeys)=@_;
11269: my ($pack,$name,$subp)=split(/\&/,$key);
11270: if ($subp eq 'default') { next; }
11271:
1.599 albertel 11272: if (defined($metaentry{':packages'})) {
11273: $metaentry{':packages'}.=','.$package;
1.483 albertel 11274: } else {
1.599 albertel 11275: $metaentry{':packages'}=$package;
1.483 albertel 11276: }
11277: my $value=$packagetab{$key};
11278: my $unikey;
11279: $unikey='parameter_0_'.$name;
1.599 albertel 11280: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 11281: $$metathesekeys{$unikey}=1;
1.599 albertel 11282: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
11283: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 11284: }
1.599 albertel 11285: if (defined($metaentry{':'.$unikey.'.default'})) {
11286: $metaentry{':'.$unikey}=
11287: $metaentry{':'.$unikey.'.default'};
1.483 albertel 11288: }
11289: }
11290:
1.261 albertel 11291: sub metadata_generate_part0 {
11292: my ($metadata,$metacache,$uri) = @_;
11293: my %allnames;
1.737 albertel 11294: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 11295: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 11296: my $part=$$metacache{':'.$metakey.'.part'};
11297: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 11298: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 11299: $allnames{$name}=$part;
11300: }
11301: }
11302: }
11303: foreach my $name (keys(%allnames)) {
11304: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 11305: my $key=":parameter_0_$name";
1.261 albertel 11306: $$metacache{"$key.part"}='0';
11307: $$metacache{"$key.name"}=$name;
1.428 albertel 11308: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 11309: $allnames{$name}.'_'.$name.
11310: '.type'};
1.428 albertel 11311: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 11312: '.display'};
1.644 www 11313: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 11314: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 11315: $$metacache{"$key.display"}=$olddis;
11316: }
1.71 www 11317: }
11318:
1.764 albertel 11319: # ------------------------------------------------------ Devalidate title cache
11320:
11321: sub devalidate_title_cache {
11322: my ($url)=@_;
11323: if (!$env{'request.course.id'}) { return; }
11324: my $symb=&symbread($url);
11325: if (!$symb) { return; }
11326: my $key=$env{'request.course.id'}."\0".$symb;
11327: &devalidate_cache_new('title',$key);
11328: }
11329:
1.1014 droeschl 11330: # ------------------------------------------------- Get the title of a course
11331:
11332: sub current_course_title {
11333: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
11334: }
1.301 www 11335: # ------------------------------------------------- Get the title of a resource
11336:
11337: sub gettitle {
11338: my $urlsymb=shift;
11339: my $symb=&symbread($urlsymb);
1.534 albertel 11340: if ($symb) {
1.620 albertel 11341: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 11342: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 11343: if (defined($cached)) {
11344: return $result;
11345: }
1.534 albertel 11346: my ($map,$resid,$url)=&decode_symb($symb);
11347: my $title='';
1.907 albertel 11348: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
11349: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
11350: } else {
11351: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11352: &GDBM_READER(),0640)) {
11353: my $mapid=$bighash{'map_pc_'.&clutter($map)};
11354: $title=$bighash{'title_'.$mapid.'.'.$resid};
11355: untie(%bighash);
11356: }
1.534 albertel 11357: }
11358: $title=~s/\&colon\;/\:/gs;
11359: if ($title) {
1.1159 www 11360: # Remember both $symb and $title for dynamic metadata
11361: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 11362: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 11363: # Cache this title and then return it
1.599 albertel 11364: return &do_cache_new('title',$key,$title,600);
1.534 albertel 11365: }
11366: $urlsymb=$url;
11367: }
11368: my $title=&metadata($urlsymb,'title');
11369: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
11370: return $title;
1.301 www 11371: }
1.613 albertel 11372:
1.614 albertel 11373: sub get_slot {
11374: my ($which,$cnum,$cdom)=@_;
11375: if (!$cnum || !$cdom) {
1.790 albertel 11376: (undef,my $courseid)=&whichuser();
1.620 albertel 11377: $cdom=$env{'course.'.$courseid.'.domain'};
11378: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 11379: }
1.703 albertel 11380: my $key=join("\0",'slots',$cdom,$cnum,$which);
11381: my %slotinfo;
11382: if (exists($remembered{$key})) {
11383: $slotinfo{$which} = $remembered{$key};
11384: } else {
11385: %slotinfo=&get('slots',[$which],$cdom,$cnum);
11386: &Apache::lonhomework::showhash(%slotinfo);
11387: my ($tmp)=keys(%slotinfo);
11388: if ($tmp=~/^error:/) { return (); }
11389: $remembered{$key} = $slotinfo{$which};
11390: }
1.616 albertel 11391: if (ref($slotinfo{$which}) eq 'HASH') {
11392: return %{$slotinfo{$which}};
11393: }
11394: return $slotinfo{$which};
1.614 albertel 11395: }
1.1150 raeburn 11396:
11397: sub get_reservable_slots {
11398: my ($cnum,$cdom,$uname,$udom) = @_;
11399: my $now = time;
11400: my $reservable_info;
11401: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
11402: if (exists($remembered{$key})) {
11403: $reservable_info = $remembered{$key};
11404: } else {
11405: my %resv;
11406: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
11407: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
11408: $reservable_info = \%resv;
11409: $remembered{$key} = $reservable_info;
11410: }
11411: return $reservable_info;
11412: }
11413:
11414: sub get_course_slots {
11415: my ($cnum,$cdom) = @_;
11416: my $hashid=$cnum.':'.$cdom;
11417: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
11418: if (defined($cached)) {
11419: if (ref($result) eq 'HASH') {
11420: return %{$result};
11421: }
11422: } else {
11423: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
11424: my ($tmp) = keys(%slots);
11425: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1172.2.23 raeburn 11426: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 11427: return %slots;
11428: }
11429: }
11430: return;
11431: }
11432:
11433: sub devalidate_slots_cache {
11434: my ($cnum,$cdom)=@_;
11435: my $hashid=$cnum.':'.$cdom;
11436: &devalidate_cache_new('allslots',$hashid);
11437: }
11438:
1.1172.2.8 raeburn 11439: sub get_coursechange {
11440: my ($cdom,$cnum) = @_;
11441: if ($cdom eq '' || $cnum eq '') {
11442: return unless ($env{'request.course.id'});
11443: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
11444: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11445: }
11446: my $hashid=$cdom.'_'.$cnum;
11447: my ($change,$cached)=&is_cached_new('crschange',$hashid);
11448: if ((defined($cached)) && ($change ne '')) {
11449: return $change;
11450: } else {
11451: my %crshash;
11452: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
11453: if ($crshash{'internal.contentchange'} eq '') {
11454: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
11455: if ($change eq '') {
11456: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
11457: $change = $crshash{'internal.created'};
11458: }
11459: } else {
11460: $change = $crshash{'internal.contentchange'};
11461: }
11462: my $cachetime = 600;
11463: &do_cache_new('crschange',$hashid,$change,$cachetime);
11464: }
11465: return $change;
11466: }
11467:
11468: sub devalidate_coursechange_cache {
11469: my ($cnum,$cdom)=@_;
11470: my $hashid=$cnum.':'.$cdom;
11471: &devalidate_cache_new('crschange',$hashid);
11472: }
11473:
1.31 www 11474: # ------------------------------------------------- Update symbolic store links
11475:
11476: sub symblist {
11477: my ($mapname,%newhash)=@_;
1.438 www 11478: $mapname=&deversion(&declutter($mapname));
1.31 www 11479: my %hash;
1.620 albertel 11480: if (($env{'request.course.fn'}) && (%newhash)) {
11481: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 11482: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 11483: foreach my $url (keys(%newhash)) {
1.711 albertel 11484: next if ($url eq 'last_known'
11485: && $env{'form.no_update_last_known'});
11486: $hash{declutter($url)}=&encode_symb($mapname,
11487: $newhash{$url}->[1],
11488: $newhash{$url}->[0]);
1.191 harris41 11489: }
1.31 www 11490: if (untie(%hash)) {
11491: return 'ok';
11492: }
11493: }
11494: }
11495: return 'error';
1.212 www 11496: }
11497:
11498: # --------------------------------------------------------------- Verify a symb
11499:
11500: sub symbverify {
1.1172.2.11 raeburn 11501: my ($symb,$thisurl,$encstate)=@_;
1.510 www 11502: my $thisfn=$thisurl;
1.439 www 11503: $thisfn=&declutter($thisfn);
1.215 www 11504: # direct jump to resource in page or to a sequence - will construct own symbs
11505: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
11506: # check URL part
1.409 www 11507: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 11508:
1.431 www 11509: unless ($url eq $thisfn) { return 0; }
1.213 www 11510:
1.216 www 11511: $symb=&symbclean($symb);
1.510 www 11512: $thisurl=&deversion($thisurl);
1.439 www 11513: $thisfn=&deversion($thisfn);
1.213 www 11514:
11515: my %bighash;
11516: my $okay=0;
1.431 www 11517:
1.620 albertel 11518: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 11519: &GDBM_READER(),0640)) {
1.1172.2.13 raeburn 11520: my $noclutter;
1.1032 raeburn 11521: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
11522: $thisurl =~ s/\?.+$//;
1.1172.2.13 raeburn 11523: if ($map =~ m{^uploaded/.+\.page$}) {
11524: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
11525: $thisurl =~ s{^\Qhttp://https://\E}{https://};
11526: $noclutter = 1;
11527: }
11528: }
11529: my $ids;
11530: if ($noclutter) {
11531: $ids=$bighash{'ids_'.$thisurl};
11532: } else {
11533: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 11534: }
1.1102 raeburn 11535: unless ($ids) {
1.1172.2.13 raeburn 11536: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
1.1102 raeburn 11537: $ids=$bighash{$idkey};
1.216 www 11538: }
11539: if ($ids) {
11540: # ------------------------------------------------------------------- Has ID(s)
1.1172.2.13 raeburn 11541: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
11542: $symb =~ s/\?.+$//;
11543: }
1.800 albertel 11544: foreach my $id (split(/\,/,$ids)) {
11545: my ($mapid,$resid)=split(/\./,$id);
1.216 www 11546: if (
11547: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1172.2.13 raeburn 11548: eq $symb) {
1.1172.2.11 raeburn 11549: if (ref($encstate)) {
11550: $$encstate = $bighash{'encrypted_'.$id};
11551: }
1.1172.2.13 raeburn 11552: if (($env{'request.role.adv'}) ||
11553: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
1.1101 raeburn 11554: ($thisurl eq '/adm/navmaps')) {
1.1172.2.13 raeburn 11555: $okay=1;
11556: last;
11557: }
11558: }
11559: }
1.216 www 11560: }
1.213 www 11561: untie(%bighash);
11562: }
11563: return $okay;
1.31 www 11564: }
11565:
1.210 www 11566: # --------------------------------------------------------------- Clean-up symb
11567:
11568: sub symbclean {
11569: my $symb=shift;
1.568 albertel 11570: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 11571: # remove version from map
11572: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 11573:
1.210 www 11574: # remove version from URL
11575: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 11576:
1.507 www 11577: # remove wrapper
11578:
1.510 www 11579: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 11580: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 11581: return $symb;
1.409 www 11582: }
11583:
11584: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 11585:
11586: sub encode_symb {
11587: my ($map,$resid,$url)=@_;
11588: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
11589: }
1.409 www 11590:
11591: sub decode_symb {
1.568 albertel 11592: my $symb=shift;
11593: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11594: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 11595: return (&fixversion($map),$resid,&fixversion($url));
11596: }
11597:
11598: sub fixversion {
11599: my $fn=shift;
1.609 banghart 11600: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 11601: my %bighash;
11602: my $uri=&clutter($fn);
1.620 albertel 11603: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 11604: # is this cached?
1.599 albertel 11605: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 11606: if (defined($cached)) { return $result; }
11607: # unfortunately not cached, or expired
1.620 albertel 11608: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 11609: &GDBM_READER(),0640)) {
11610: if ($bighash{'version_'.$uri}) {
11611: my $version=$bighash{'version_'.$uri};
1.444 www 11612: unless (($version eq 'mostrecent') ||
11613: ($version==&getversion($uri))) {
1.440 www 11614: $uri=~s/\.(\w+)$/\.$version\.$1/;
11615: }
11616: }
11617: untie %bighash;
1.413 www 11618: }
1.599 albertel 11619: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 11620: }
11621:
11622: sub deversion {
11623: my $url=shift;
11624: $url=~s/\.\d+\.(\w+)$/\.$1/;
11625: return $url;
1.210 www 11626: }
11627:
1.31 www 11628: # ------------------------------------------------------ Return symb list entry
11629:
11630: sub symbread {
1.1172.2.66 raeburn 11631: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
1.1172.2.54 raeburn 11632: my $cache_str='request.symbread.cached.'.$thisfn;
1.1172.2.66 raeburn 11633: if (defined($env{$cache_str})) {
11634: if ($ignorecachednull) {
11635: return $env{$cache_str} unless ($env{$cache_str} eq '');
11636: } else {
11637: return $env{$cache_str};
11638: }
11639: }
1.242 www 11640: # no filename provided? try from environment
1.1172.2.54 raeburn 11641: unless ($thisfn) {
1.620 albertel 11642: if ($env{'request.symb'}) {
1.1172.2.13 raeburn 11643: return $env{$cache_str}=&symbclean($env{'request.symb'});
11644: }
11645: $thisfn=$env{'request.filename'};
1.44 www 11646: }
1.569 albertel 11647: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 11648: # is that filename actually a symb? Verify, clean, and return
11649: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 11650: if (&symbverify($thisfn,$1)) {
1.620 albertel 11651: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 11652: }
1.242 www 11653: }
1.44 www 11654: $thisfn=declutter($thisfn);
1.31 www 11655: my %hash;
1.37 www 11656: my %bighash;
11657: my $syval='';
1.620 albertel 11658: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 11659: my $targetfn = $thisfn;
1.609 banghart 11660: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 11661: $targetfn = 'adm/wrapper/'.$thisfn;
11662: }
1.687 albertel 11663: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
11664: $targetfn=$1;
11665: }
1.620 albertel 11666: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 11667: &GDBM_READER(),0640)) {
1.481 raeburn 11668: $syval=$hash{$targetfn};
1.37 www 11669: untie(%hash);
11670: }
11671: # ---------------------------------------------------------- There was an entry
11672: if ($syval) {
1.601 albertel 11673: #unless ($syval=~/\_\d+$/) {
1.620 albertel 11674: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 11675: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 11676: #return $env{$cache_str}='';
1.601 albertel 11677: #}
11678: #$syval.=$1;
11679: #}
1.37 www 11680: } else {
11681: # ------------------------------------------------------- Was not in symb table
1.620 albertel 11682: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 11683: &GDBM_READER(),0640)) {
1.37 www 11684: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 11685: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 11686: unless ($ids) {
11687: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 11688: }
11689: unless ($ids) {
11690: # alias?
11691: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 11692: }
1.37 www 11693: if ($ids) {
11694: # ------------------------------------------------------------------- Has ID(s)
11695: my @possibilities=split(/\,/,$ids);
1.39 www 11696: if ($#possibilities==0) {
11697: # ----------------------------------------------- There is only one possibility
1.37 www 11698: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 11699: $syval=&encode_symb($bighash{'map_id_'.$mapid},
11700: $resid,$thisfn);
1.1172.2.66 raeburn 11701: if (ref($possibles) eq 'HASH') {
11702: $possibles->{$syval} = 1;
11703: }
11704: if ($checkforblock) {
11705: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
11706: if (@blockers) {
11707: $syval = '';
11708: return;
11709: }
11710: }
11711: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 11712: # ------------------------------------------ There is more than one possibility
11713: my $realpossible=0;
1.800 albertel 11714: foreach my $id (@possibilities) {
11715: my $file=$bighash{'src_'.$id};
1.1172.2.66 raeburn 11716: my $canaccess;
11717: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11718: $canaccess = 1;
11719: } else {
11720: $canaccess = &allowed('bre',$file);
11721: }
11722: if ($canaccess) {
11723: my ($mapid,$resid)=split(/\./,$id);
11724: if ($bighash{'map_type_'.$mapid} ne 'page') {
11725: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
11726: $resid,$thisfn);
11727: if (ref($possibles) eq 'HASH') {
11728: $possibles->{$syval} = 1;
11729: }
11730: if ($checkforblock) {
11731: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
11732: unless (@blockers > 0) {
11733: $syval = $poss_syval;
11734: $realpossible++;
11735: }
11736: } else {
11737: $syval = $poss_syval;
11738: $realpossible++;
11739: }
11740: }
1.39 www 11741: }
1.191 harris41 11742: }
1.39 www 11743: if ($realpossible!=1) { $syval=''; }
1.249 www 11744: } else {
11745: $syval='';
1.37 www 11746: }
11747: }
1.1172.2.66 raeburn 11748: untie(%bighash);
1.481 raeburn 11749: }
1.31 www 11750: }
1.62 www 11751: if ($syval) {
1.620 albertel 11752: return $env{$cache_str}=$syval;
1.62 www 11753: }
1.31 www 11754: }
1.949 raeburn 11755: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 11756: return $env{$cache_str}='';
1.31 www 11757: }
11758:
11759: # ---------------------------------------------------------- Return random seed
11760:
1.32 www 11761: sub numval {
11762: my $txt=shift;
11763: $txt=~tr/A-J/0-9/;
11764: $txt=~tr/a-j/0-9/;
11765: $txt=~tr/K-T/0-9/;
11766: $txt=~tr/k-t/0-9/;
11767: $txt=~tr/U-Z/0-5/;
11768: $txt=~tr/u-z/0-5/;
11769: $txt=~s/\D//g;
1.564 albertel 11770: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 11771: return int($txt);
1.368 albertel 11772: }
11773:
1.484 albertel 11774: sub numval2 {
11775: my $txt=shift;
11776: $txt=~tr/A-J/0-9/;
11777: $txt=~tr/a-j/0-9/;
11778: $txt=~tr/K-T/0-9/;
11779: $txt=~tr/k-t/0-9/;
11780: $txt=~tr/U-Z/0-5/;
11781: $txt=~tr/u-z/0-5/;
11782: $txt=~s/\D//g;
11783: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11784: my $total;
11785: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 11786: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 11787: return int($total);
11788: }
11789:
1.575 albertel 11790: sub numval3 {
11791: use integer;
11792: my $txt=shift;
11793: $txt=~tr/A-J/0-9/;
11794: $txt=~tr/a-j/0-9/;
11795: $txt=~tr/K-T/0-9/;
11796: $txt=~tr/k-t/0-9/;
11797: $txt=~tr/U-Z/0-5/;
11798: $txt=~tr/u-z/0-5/;
11799: $txt=~s/\D//g;
11800: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11801: my $total;
11802: foreach my $val (@txts) { $total+=$val; }
11803: if ($_64bit) { $total=(($total<<32)>>32); }
11804: return $total;
11805: }
11806:
1.675 albertel 11807: sub digest {
11808: my ($data)=@_;
11809: my $digest=&Digest::MD5::md5($data);
11810: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11811: my ($e,$f);
11812: {
11813: use integer;
11814: $e=($a+$b);
11815: $f=($c+$d);
11816: if ($_64bit) {
11817: $e=(($e<<32)>>32);
11818: $f=(($f<<32)>>32);
11819: }
11820: }
11821: if (wantarray) {
11822: return ($e,$f);
11823: } else {
11824: my $g;
11825: {
11826: use integer;
11827: $g=($e+$f);
11828: if ($_64bit) {
11829: $g=(($g<<32)>>32);
11830: }
11831: }
11832: return $g;
11833: }
11834: }
11835:
1.368 albertel 11836: sub latest_rnd_algorithm_id {
1.675 albertel 11837: return '64bit5';
1.366 albertel 11838: }
1.32 www 11839:
1.503 albertel 11840: sub get_rand_alg {
11841: my ($courseid)=@_;
1.790 albertel 11842: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 11843: if ($courseid) {
1.620 albertel 11844: return $env{"course.$courseid.rndseed"};
1.503 albertel 11845: }
11846: return &latest_rnd_algorithm_id();
11847: }
11848:
1.562 albertel 11849: sub validCODE {
11850: my ($CODE)=@_;
11851: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11852: return 0;
11853: }
11854:
1.491 albertel 11855: sub getCODE {
1.620 albertel 11856: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 11857: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11858: defined($Apache::lonhomework::parsing_a_task) ) &&
11859: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 11860: return $Apache::lonhomework::history{'resource.CODE'};
11861: }
11862: return undef;
11863: }
1.1133 foxr 11864: #
11865: # Determines the random seed for a specific context:
11866: #
11867: # parameters:
11868: # symb - in course context the symb for the seed.
11869: # course_id - The course id of the form domain_coursenum.
11870: # domain - Domain for the user.
11871: # course - Course for the user.
11872: # cenv - environment of the course.
11873: #
11874: # NOTE:
11875: # All parameters are picked out of the environment if missing
11876: # or not defined.
11877: # If a symb cannot be determined the current time is used instead.
11878: #
11879: # For a given well defined symb, courside, domain, username,
11880: # and course environment, the seed is reproducible.
11881: #
1.31 www 11882: sub rndseed {
1.1133 foxr 11883: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 11884: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 11885: if (!defined($symb)) {
1.366 albertel 11886: unless ($symb=$wsymb) { return time; }
11887: }
1.1146 foxr 11888: if (!defined $courseid) {
11889: $courseid=$wcourseid;
11890: }
11891: if (!defined $domain) { $domain=$wdomain; }
11892: if (!defined $username) { $username=$wusername }
1.1133 foxr 11893:
11894: my $which;
11895: if (defined($cenv->{'rndseed'})) {
11896: $which = $cenv->{'rndseed'};
11897: } else {
11898: $which =&get_rand_alg($courseid);
11899: }
1.491 albertel 11900: if (defined(&getCODE())) {
1.675 albertel 11901: if ($which eq '64bit5') {
11902: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
11903: } elsif ($which eq '64bit4') {
1.575 albertel 11904: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
11905: } else {
11906: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
11907: }
1.675 albertel 11908: } elsif ($which eq '64bit5') {
11909: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 11910: } elsif ($which eq '64bit4') {
11911: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 11912: } elsif ($which eq '64bit3') {
11913: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 11914: } elsif ($which eq '64bit2') {
11915: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 11916: } elsif ($which eq '64bit') {
11917: return &rndseed_64bit($symb,$courseid,$domain,$username);
11918: }
11919: return &rndseed_32bit($symb,$courseid,$domain,$username);
11920: }
11921:
11922: sub rndseed_32bit {
11923: my ($symb,$courseid,$domain,$username)=@_;
11924: {
11925: use integer;
11926: my $symbchck=unpack("%32C*",$symb) << 27;
11927: my $symbseed=numval($symb) << 22;
11928: my $namechck=unpack("%32C*",$username) << 17;
11929: my $nameseed=numval($username) << 12;
11930: my $domainseed=unpack("%32C*",$domain) << 7;
11931: my $courseseed=unpack("%32C*",$courseid);
11932: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 11933: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11934: #&logthis("rndseed :$num:$symb");
1.564 albertel 11935: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 11936: return $num;
11937: }
11938: }
11939:
11940: sub rndseed_64bit {
11941: my ($symb,$courseid,$domain,$username)=@_;
11942: {
11943: use integer;
11944: my $symbchck=unpack("%32S*",$symb) << 21;
11945: my $symbseed=numval($symb) << 10;
11946: my $namechck=unpack("%32S*",$username);
11947:
11948: my $nameseed=numval($username) << 21;
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 :$num:$symb");
1.564 albertel 11956: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 11957: return "$num1,$num2";
1.155 albertel 11958: }
1.366 albertel 11959: }
11960:
1.443 albertel 11961: sub rndseed_64bit2 {
11962: my ($symb,$courseid,$domain,$username)=@_;
11963: {
11964: use integer;
11965: # strings need to be an even # of cahracters long, it it is odd the
11966: # last characters gets thrown away
11967: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11968: my $symbseed=numval($symb) << 10;
11969: my $namechck=unpack("%32S*",$username.' ');
11970:
11971: my $nameseed=numval($username) << 21;
1.501 albertel 11972: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11973: my $courseseed=unpack("%32S*",$courseid.' ');
11974:
11975: my $num1=$symbchck+$symbseed+$namechck;
11976: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11977: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11978: #&logthis("rndseed :$num:$symb");
1.803 albertel 11979: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 11980: return "$num1,$num2";
11981: }
11982: }
11983:
11984: sub rndseed_64bit3 {
11985: my ($symb,$courseid,$domain,$username)=@_;
11986: {
11987: use integer;
11988: # strings need to be an even # of cahracters long, it it is odd the
11989: # last characters gets thrown away
11990: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11991: my $symbseed=numval2($symb) << 10;
11992: my $namechck=unpack("%32S*",$username.' ');
11993:
11994: my $nameseed=numval2($username) << 21;
1.443 albertel 11995: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11996: my $courseseed=unpack("%32S*",$courseid.' ');
11997:
11998: my $num1=$symbchck+$symbseed+$namechck;
11999: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12000: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12001: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 12002: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 12003:
1.503 albertel 12004: return "$num1:$num2";
1.443 albertel 12005: }
12006: }
12007:
1.575 albertel 12008: sub rndseed_64bit4 {
12009: my ($symb,$courseid,$domain,$username)=@_;
12010: {
12011: use integer;
12012: # strings need to be an even # of cahracters long, it it is odd the
12013: # last characters gets thrown away
12014: my $symbchck=unpack("%32S*",$symb.' ') << 21;
12015: my $symbseed=numval3($symb) << 10;
12016: my $namechck=unpack("%32S*",$username.' ');
12017:
12018: my $nameseed=numval3($username) << 21;
12019: my $domainseed=unpack("%32S*",$domain.' ') << 10;
12020: my $courseseed=unpack("%32S*",$courseid.' ');
12021:
12022: my $num1=$symbchck+$symbseed+$namechck;
12023: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 12024: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
12025: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 12026: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 12027:
1.575 albertel 12028: return "$num1:$num2";
12029: }
12030: }
12031:
1.675 albertel 12032: sub rndseed_64bit5 {
12033: my ($symb,$courseid,$domain,$username)=@_;
12034: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
12035: return "$num1:$num2";
12036: }
12037:
1.366 albertel 12038: sub rndseed_CODE_64bit {
12039: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 12040: {
1.366 albertel 12041: use integer;
1.443 albertel 12042: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 12043: my $symbseed=numval2($symb);
1.491 albertel 12044: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12045: my $CODEseed=numval(&getCODE());
1.443 albertel 12046: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 12047: my $num1=$symbseed+$CODEchck;
12048: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12049: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12050: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 12051: if ($_64bit) { $num1=(($num1<<32)>>32); }
12052: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 12053: return "$num1:$num2";
1.366 albertel 12054: }
12055: }
12056:
1.575 albertel 12057: sub rndseed_CODE_64bit4 {
12058: my ($symb,$courseid,$domain,$username)=@_;
12059: {
12060: use integer;
12061: my $symbchck=unpack("%32S*",$symb.' ') << 16;
12062: my $symbseed=numval3($symb);
12063: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
12064: my $CODEseed=numval3(&getCODE());
12065: my $courseseed=unpack("%32S*",$courseid.' ');
12066: my $num1=$symbseed+$CODEchck;
12067: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 12068: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
12069: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 12070: if ($_64bit) { $num1=(($num1<<32)>>32); }
12071: if ($_64bit) { $num2=(($num2<<32)>>32); }
12072: return "$num1:$num2";
12073: }
12074: }
12075:
1.675 albertel 12076: sub rndseed_CODE_64bit5 {
12077: my ($symb,$courseid,$domain,$username)=@_;
12078: my $code = &getCODE();
12079: my ($num1,$num2)=&digest("$symb,$courseid,$code");
12080: return "$num1:$num2";
12081: }
12082:
1.366 albertel 12083: sub setup_random_from_rndseed {
12084: my ($rndseed)=@_;
1.503 albertel 12085: if ($rndseed =~/([,:])/) {
1.1172.2.51 raeburn 12086: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
12087: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
12088: &Math::Random::random_set_seed_from_phrase($rndseed);
12089: } else {
12090: &Math::Random::random_set_seed($num1,$num2);
12091: }
1.366 albertel 12092: } else {
12093: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 12094: }
1.36 albertel 12095: }
12096:
1.474 albertel 12097: sub latest_receipt_algorithm_id {
1.835 albertel 12098: return 'receipt3';
1.474 albertel 12099: }
12100:
1.480 www 12101: sub recunique {
12102: my $fucourseid=shift;
12103: my $unique;
1.835 albertel 12104: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
12105: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 12106: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 12107: } else {
12108: $unique=$perlvar{'lonReceipt'};
12109: }
12110: return unpack("%32C*",$unique);
12111: }
12112:
12113: sub recprefix {
12114: my $fucourseid=shift;
12115: my $prefix;
1.835 albertel 12116: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
12117: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 12118: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 12119: } else {
12120: $prefix=$perlvar{'lonHostID'};
12121: }
12122: return unpack("%32C*",$prefix);
12123: }
12124:
1.76 www 12125: sub ireceipt {
1.474 albertel 12126: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 12127:
12128: my $return =&recprefix($fucourseid).'-';
12129:
12130: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
12131: $env{'request.state'} eq 'construct') {
12132: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
12133: return $return;
12134: }
12135:
1.76 www 12136: my $cuname=unpack("%32C*",$funame);
12137: my $cudom=unpack("%32C*",$fudom);
12138: my $cucourseid=unpack("%32C*",$fucourseid);
12139: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 12140: my $cunique=&recunique($fucourseid);
1.474 albertel 12141: my $cpart=unpack("%32S*",$part);
1.835 albertel 12142: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
12143:
1.790 albertel 12144: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 12145:
12146: $return.= ($cunique%$cuname+
12147: $cunique%$cudom+
12148: $cusymb%$cuname+
12149: $cusymb%$cudom+
12150: $cucourseid%$cuname+
12151: $cucourseid%$cudom+
12152: $cpart%$cuname+
12153: $cpart%$cudom);
12154: } else {
12155: $return.= ($cunique%$cuname+
12156: $cunique%$cudom+
12157: $cusymb%$cuname+
12158: $cusymb%$cudom+
12159: $cucourseid%$cuname+
12160: $cucourseid%$cudom);
12161: }
12162: return $return;
1.76 www 12163: }
12164:
12165: sub receipt {
1.474 albertel 12166: my ($part)=@_;
1.790 albertel 12167: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 12168: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 12169: }
1.260 ng 12170:
1.790 albertel 12171: sub whichuser {
12172: my ($passedsymb)=@_;
12173: my ($symb,$courseid,$domain,$name,$publicuser);
12174: if (defined($env{'form.grade_symb'})) {
12175: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
12176: my $allowed=&allowed('vgr',$tmp_courseid);
12177: if (!$allowed &&
12178: exists($env{'request.course.sec'}) &&
12179: $env{'request.course.sec'} !~ /^\s*$/) {
12180: $allowed=&allowed('vgr',$tmp_courseid.
12181: '/'.$env{'request.course.sec'});
12182: }
12183: if ($allowed) {
12184: ($symb)=&get_env_multiple('form.grade_symb');
12185: $courseid=$tmp_courseid;
12186: ($domain)=&get_env_multiple('form.grade_domain');
12187: ($name)=&get_env_multiple('form.grade_username');
12188: return ($symb,$courseid,$domain,$name,$publicuser);
12189: }
12190: }
12191: if (!$passedsymb) {
12192: $symb=&symbread();
12193: } else {
12194: $symb=$passedsymb;
12195: }
12196: $courseid=$env{'request.course.id'};
12197: $domain=$env{'user.domain'};
12198: $name=$env{'user.name'};
12199: if ($name eq 'public' && $domain eq 'public') {
12200: if (!defined($env{'form.username'})) {
12201: $env{'form.username'}.=time.rand(10000000);
12202: }
12203: $name.=$env{'form.username'};
12204: }
12205: return ($symb,$courseid,$domain,$name,$publicuser);
12206:
12207: }
12208:
1.36 albertel 12209: # ------------------------------------------------------------ Serves up a file
1.472 albertel 12210: # returns either the contents of the file or
12211: # -1 if the file doesn't exist
1.481 raeburn 12212: #
12213: # if the target is a file that was uploaded via DOCS,
12214: # a check will be made to see if a current copy exists on the local server,
12215: # if it does this will be served, otherwise a copy will be retrieved from
12216: # the home server for the course and stored in /home/httpd/html/userfiles on
12217: # the local server.
1.472 albertel 12218:
1.36 albertel 12219: sub getfile {
1.538 albertel 12220: my ($file) = @_;
1.609 banghart 12221: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 12222: &repcopy($file);
12223: return &readfile($file);
12224: }
12225:
12226: sub repcopy_userfile {
12227: my ($file)=@_;
1.1142 raeburn 12228: my $londocroot = $perlvar{'lonDocRoot'};
12229: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 12230: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 12231: my ($cdom,$cnum,$filename) =
1.811 albertel 12232: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 12233: my $uri="/uploaded/$cdom/$cnum/$filename";
12234: if (-e "$file") {
1.828 www 12235: # we already have a local copy, check it out
1.538 albertel 12236: my @fileinfo = stat($file);
1.828 www 12237: my $rtncode;
12238: my $info;
1.538 albertel 12239: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 12240: if ($lwpresp ne 'ok') {
1.828 www 12241: # there is no such file anymore, even though we had a local copy
1.482 albertel 12242: if ($rtncode eq '404') {
1.538 albertel 12243: unlink($file);
1.482 albertel 12244: }
12245: return -1;
12246: }
12247: if ($info < $fileinfo[9]) {
1.828 www 12248: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 12249: return 'ok';
1.828 www 12250: } else {
12251: # the file is outdated, get rid of it
12252: unlink($file);
1.482 albertel 12253: }
1.828 www 12254: }
12255: # one way or the other, at this point, we don't have the file
12256: # construct the correct path for the file
12257: my @parts = ($cdom,$cnum);
12258: if ($filename =~ m|^(.+)/[^/]+$|) {
12259: push @parts, split(/\//,$1);
12260: }
12261: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
12262: foreach my $part (@parts) {
12263: $path .= '/'.$part;
12264: if (!-e $path) {
12265: mkdir($path,0770);
1.482 albertel 12266: }
12267: }
1.828 www 12268: # now the path exists for sure
12269: # get a user agent
12270: my $ua=new LWP::UserAgent;
12271: my $transferfile=$file.'.in.transfer';
12272: # FIXME: this should flock
12273: if (-e $transferfile) { return 'ok'; }
12274: my $request;
12275: $uri=~s/^\///;
1.980 raeburn 12276: my $homeserver = &homeserver($cnum,$cdom);
12277: my $protocol = $protocol{$homeserver};
12278: $protocol = 'http' if ($protocol ne 'https');
12279: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 12280: my $response=$ua->request($request,$transferfile);
12281: # did it work?
12282: if ($response->is_error()) {
12283: unlink($transferfile);
12284: &logthis("Userfile repcopy failed for $uri");
12285: return -1;
12286: }
12287: # worked, rename the transfer file
12288: rename($transferfile,$file);
1.607 raeburn 12289: return 'ok';
1.481 raeburn 12290: }
12291:
1.517 albertel 12292: sub tokenwrapper {
12293: my $uri=shift;
1.980 raeburn 12294: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 12295: $uri=~s|^/||;
1.620 albertel 12296: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 12297: my $token=$1;
1.552 albertel 12298: my (undef,$udom,$uname,$file)=split('/',$uri,4);
12299: if ($udom && $uname && $file) {
12300: $file=~s|(\?\.*)*$||;
1.949 raeburn 12301: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 12302: my $homeserver = &homeserver($uname,$udom);
12303: my $protocol = $protocol{$homeserver};
12304: $protocol = 'http' if ($protocol ne 'https');
12305: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 12306: (($uri=~/\?/)?'&':'?').'token='.$token.
12307: '&tokenissued='.$perlvar{'lonHostID'};
12308: } else {
12309: return '/adm/notfound.html';
12310: }
12311: }
12312:
1.828 www 12313: # call with reqtype HEAD: get last modification time
12314: # call with reqtype GET: get the file contents
12315: # Do not call this with reqtype GET for large files! It loads everything into memory
12316: #
1.481 raeburn 12317: sub getuploaded {
12318: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
12319: $uri=~s/^\///;
1.980 raeburn 12320: my $homeserver = &homeserver($cnum,$cdom);
12321: my $protocol = $protocol{$homeserver};
12322: $protocol = 'http' if ($protocol ne 'https');
12323: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 12324: my $ua=new LWP::UserAgent;
12325: my $request=new HTTP::Request($reqtype,$uri);
12326: my $response=$ua->request($request);
12327: $$rtncode = $response->code;
1.482 albertel 12328: if (! $response->is_success()) {
12329: return 'failed';
12330: }
12331: if ($reqtype eq 'HEAD') {
1.486 www 12332: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 12333: } elsif ($reqtype eq 'GET') {
12334: $$info = $response->content;
1.472 albertel 12335: }
1.482 albertel 12336: return 'ok';
1.36 albertel 12337: }
12338:
1.481 raeburn 12339: sub readfile {
12340: my $file = shift;
12341: if ( (! -e $file ) || ($file eq '') ) { return -1; };
12342: my $fh;
12343: open($fh,"<$file");
12344: my $a='';
1.800 albertel 12345: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 12346: return $a;
12347: }
12348:
1.36 albertel 12349: sub filelocation {
1.590 banghart 12350: my ($dir,$file) = @_;
12351: my $location;
12352: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 12353:
12354: if ($file =~ m-^/adm/-) {
12355: $file=~s-^/adm/wrapper/-/-;
12356: $file=~s-^/adm/coursedocs/showdoc/-/-;
12357: }
1.882 albertel 12358:
1.1139 www 12359: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 12360: $location = $file;
1.609 banghart 12361: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 12362: my ($udom,$uname,$filename)=
1.811 albertel 12363: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 12364: my $home=&homeserver($uname,$udom);
12365: my $is_me=0;
12366: my @ids=¤t_machine_ids();
12367: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
12368: if ($is_me) {
1.1117 foxr 12369: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 12370: } else {
12371: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
12372: $udom.'/'.$uname.'/'.$filename;
12373: }
1.882 albertel 12374: } elsif ($file =~ m-^/adm/-) {
12375: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 12376: } else {
12377: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 12378: $file=~s:^/(res|priv)/:/:;
12379: my $space=$1;
1.590 banghart 12380: if ( !( $file =~ m:^/:) ) {
12381: $location = $dir. '/'.$file;
12382: } else {
1.1142 raeburn 12383: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 12384: }
1.59 albertel 12385: }
1.590 banghart 12386: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 12387: while ($location=~m{/\.\./}) {
12388: if ($location =~ m{/[^/]+/\.\./}) {
12389: $location=~ s{/[^/]+/\.\./}{/}g;
12390: } else {
12391: $location=~ s{/\.\./}{/}g;
12392: }
12393: } #remove dir/..
1.590 banghart 12394: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
12395: return $location;
1.46 www 12396: }
1.36 albertel 12397:
1.46 www 12398: sub hreflocation {
12399: my ($dir,$file)=@_;
1.980 raeburn 12400: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 12401: $file=filelocation($dir,$file);
1.700 albertel 12402: } elsif ($file=~m-^/adm/-) {
12403: $file=~s-^/adm/wrapper/-/-;
12404: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 12405: }
12406: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
12407: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
12408: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 12409: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
12410: {/uploaded/$1/$2/}x;
1.46 www 12411: }
1.913 albertel 12412: if ($file=~ m{^/userfiles/}) {
12413: $file =~ s{^/userfiles/}{/uploaded/};
12414: }
1.462 albertel 12415: return $file;
1.465 albertel 12416: }
12417:
1.1139 www 12418:
12419:
12420:
12421:
1.465 albertel 12422: sub current_machine_domains {
1.853 albertel 12423: return &machine_domains(&hostname($perlvar{'lonHostID'}));
12424: }
12425:
12426: sub machine_domains {
12427: my ($hostname) = @_;
1.465 albertel 12428: my @domains;
1.838 albertel 12429: my %hostname = &all_hostnames();
1.465 albertel 12430: while( my($id, $name) = each(%hostname)) {
1.467 matthew 12431: # &logthis("-$id-$name-$hostname-");
1.465 albertel 12432: if ($hostname eq $name) {
1.844 albertel 12433: push(@domains,&host_domain($id));
1.465 albertel 12434: }
12435: }
12436: return @domains;
12437: }
12438:
12439: sub current_machine_ids {
1.853 albertel 12440: return &machine_ids(&hostname($perlvar{'lonHostID'}));
12441: }
12442:
12443: sub machine_ids {
12444: my ($hostname) = @_;
12445: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 12446: my @ids;
1.888 albertel 12447: my %name_to_host = &all_names();
1.889 albertel 12448: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
12449: return @{ $name_to_host{$hostname} };
12450: }
12451: return;
1.31 www 12452: }
12453:
1.824 raeburn 12454: sub additional_machine_domains {
12455: my @domains;
12456: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
12457: while( my $line = <$fh>) {
12458: $line =~ s/\s//g;
12459: push(@domains,$line);
12460: }
12461: return @domains;
12462: }
12463:
12464: sub default_login_domain {
12465: my $domain = $perlvar{'lonDefDomain'};
12466: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
12467: foreach my $posdom (¤t_machine_domains(),
12468: &additional_machine_domains()) {
12469: if (lc($posdom) eq lc($testdomain)) {
12470: $domain=$posdom;
12471: last;
12472: }
12473: }
12474: return $domain;
12475: }
12476:
1.31 www 12477: # ------------------------------------------------------------- Declutters URLs
12478:
12479: sub declutter {
12480: my $thisfn=shift;
1.569 albertel 12481: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1172.2.49 raeburn 12482: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
12483: $thisfn=~s{^/home/httpd/html}{};
12484: }
1.31 www 12485: $thisfn=~s/^\///;
1.697 albertel 12486: $thisfn=~s|^adm/wrapper/||;
12487: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 12488: $thisfn=~s/^res\///;
1.1172 bisitz 12489: $thisfn=~s/^priv\///;
1.1032 raeburn 12490: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
12491: $thisfn=~s/\?.+$//;
12492: }
1.268 www 12493: return $thisfn;
12494: }
12495:
12496: # ------------------------------------------------------------- Clutter up URLs
12497:
12498: sub clutter {
12499: my $thisfn='/'.&declutter(shift);
1.887 albertel 12500: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 12501: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 12502: $thisfn='/res'.$thisfn;
12503: }
1.1031 raeburn 12504: if ($thisfn !~m|^/adm|) {
12505: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 12506: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 12507: } else {
12508: my ($ext) = ($thisfn =~ /\.(\w+)$/);
12509: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 12510: if ($embstyle eq 'ssi'
12511: || ($embstyle eq 'hdn')
12512: || ($embstyle eq 'rat')
12513: || ($embstyle eq 'prv')
12514: || ($embstyle eq 'ign')) {
12515: #do nothing with these
12516: } elsif (($embstyle eq 'img')
1.695 albertel 12517: || ($embstyle eq 'emb')
12518: || ($embstyle eq 'wrp')) {
12519: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 12520: } elsif ($embstyle eq 'unk'
12521: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 12522: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 12523: } else {
1.718 www 12524: # &logthis("Got a blank emb style");
1.695 albertel 12525: }
1.694 albertel 12526: }
12527: }
1.31 www 12528: return $thisfn;
1.12 www 12529: }
12530:
1.787 albertel 12531: sub clutter_with_no_wrapper {
12532: my $uri = &clutter(shift);
12533: if ($uri =~ m-^/adm/-) {
12534: $uri =~ s-^/adm/wrapper/-/-;
12535: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
12536: }
12537: return $uri;
12538: }
12539:
1.557 albertel 12540: sub freeze_escape {
12541: my ($value)=@_;
12542: if (ref($value)) {
12543: $value=&nfreeze($value);
12544: return '__FROZEN__'.&escape($value);
12545: }
12546: return &escape($value);
12547: }
12548:
1.11 www 12549:
1.557 albertel 12550: sub thaw_unescape {
12551: my ($value)=@_;
12552: if ($value =~ /^__FROZEN__/) {
12553: substr($value,0,10,undef);
12554: $value=&unescape($value);
12555: return &thaw($value);
12556: }
12557: return &unescape($value);
12558: }
12559:
1.436 albertel 12560: sub correct_line_ends {
12561: my ($result)=@_;
12562: $$result =~s/\r\n/\n/mg;
12563: $$result =~s/\r/\n/mg;
1.415 albertel 12564: }
1.1 albertel 12565: # ================================================================ Main Program
12566:
1.184 www 12567: sub goodbye {
1.204 albertel 12568: &logthis("Starting Shut down");
1.443 albertel 12569: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 12570: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 12571: #converted
1.599 albertel 12572: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 12573: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
12574: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
12575: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 12576: #1.1 only
1.870 albertel 12577: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
12578: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
12579: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
12580: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
12581: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 12582: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
12583: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 12584: &flushcourselogs();
12585: &logthis("Shutting down");
12586: }
12587:
1.852 albertel 12588: sub get_dns {
1.1172.2.17 raeburn 12589: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 12590: if (!$ignore_cache) {
12591: my ($content,$cached)=
12592: &Apache::lonnet::is_cached_new('dns',$url);
12593: if ($cached) {
1.1172.2.17 raeburn 12594: &$func($content,$hashref);
1.869 albertel 12595: return;
12596: }
12597: }
12598:
12599: my %alldns;
1.852 albertel 12600: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12601: foreach my $dns (<$config>) {
12602: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 12603: my $line = $1;
12604: my ($host,$protocol) = split(/:/,$line);
12605: if ($protocol ne 'https') {
12606: $protocol = 'http';
12607: }
12608: $alldns{$host} = $protocol;
1.869 albertel 12609: }
12610: while (%alldns) {
1.1172.2.52 raeburn 12611: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.852 albertel 12612: my $ua=new LWP::UserAgent;
1.1134 raeburn 12613: $ua->timeout(30);
1.979 raeburn 12614: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 12615: my $response=$ua->request($request);
1.979 raeburn 12616: delete($alldns{$dns});
1.852 albertel 12617: next if ($response->is_error());
12618: my @content = split("\n",$response->content);
1.1172.2.17 raeburn 12619: unless ($nocache) {
1.1172.2.23 raeburn 12620: &do_cache_new('dns',$url,\@content,30*24*60*60);
1.1172.2.17 raeburn 12621: }
12622: &$func(\@content,$hashref);
1.869 albertel 12623: return;
1.852 albertel 12624: }
12625: close($config);
1.871 albertel 12626: my $which = (split('/',$url))[3];
12627: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
12628: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 12629: my @content = <$config>;
1.1172.2.17 raeburn 12630: &$func(\@content,$hashref);
12631: return;
12632: }
12633:
12634: # ------------------------------------------------------Get DNS checksums file
12635: sub parse_dns_checksums_tab {
12636: my ($lines,$hashref) = @_;
1.1172.2.53 raeburn 12637: my $lonhost = $perlvar{'lonHostID'};
12638: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1172.2.17 raeburn 12639: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1172.2.53 raeburn 12640: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
12641: my $webconfdir = '/etc/httpd/conf';
12642: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
12643: $webconfdir = '/etc/apache2';
12644: } elsif ($distro =~ /^sles(\d+)$/) {
12645: if ($1 >= 10) {
12646: $webconfdir = '/etc/apache2';
12647: }
12648: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
12649: if ($1 >= 10.0) {
12650: $webconfdir = '/etc/apache2';
12651: }
12652: }
1.1172.2.17 raeburn 12653: my ($release,$timestamp) = split(/\-/,$loncaparev);
12654: my (%chksum,%revnum);
12655: if (ref($lines) eq 'ARRAY') {
12656: chomp(@{$lines});
1.1172.2.34 raeburn 12657: my $version = shift(@{$lines});
12658: if ($version eq $release) {
1.1172.2.17 raeburn 12659: foreach my $line (@{$lines}) {
1.1172.2.34 raeburn 12660: my ($file,$version,$shasum) = split(/,/,$line);
1.1172.2.53 raeburn 12661: if ($file =~ m{^/etc/httpd/conf}) {
12662: if ($webconfdir eq '/etc/apache2') {
12663: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
12664: }
12665: }
1.1172.2.34 raeburn 12666: $chksum{$file} = $shasum;
12667: $revnum{$file} = $version;
1.1172.2.17 raeburn 12668: }
12669: if (ref($hashref) eq 'HASH') {
12670: %{$hashref} = (
12671: sums => \%chksum,
12672: versions => \%revnum,
12673: );
12674: }
12675: }
12676: }
1.869 albertel 12677: return;
1.852 albertel 12678: }
1.1172.2.17 raeburn 12679:
12680: sub fetch_dns_checksums {
12681: my %checksums;
1.1172.2.34 raeburn 12682: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1172.2.48 raeburn 12683: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1172.2.34 raeburn 12684: my ($release,$timestamp) = split(/\-/,$loncaparev);
12685: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1172.2.17 raeburn 12686: \%checksums);
12687: return \%checksums;
12688: }
12689:
1.327 albertel 12690: # ------------------------------------------------------------ Read domain file
12691: {
1.852 albertel 12692: my $loaded;
1.846 albertel 12693: my %domain;
12694:
1.852 albertel 12695: sub parse_domain_tab {
12696: my ($lines) = @_;
12697: foreach my $line (@$lines) {
12698: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 12699:
1.846 albertel 12700: chomp($line);
1.852 albertel 12701: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 12702: my %this_domain;
12703: foreach my $field ('description', 'auth_def', 'auth_arg_def',
12704: 'lang_def', 'city', 'longi', 'lati',
12705: 'primary') {
12706: $this_domain{$field} = shift(@elements);
12707: }
12708: $domain{$name} = \%this_domain;
1.852 albertel 12709: }
12710: }
1.864 albertel 12711:
12712: sub reset_domain_info {
12713: undef($loaded);
12714: undef(%domain);
12715: }
12716:
1.852 albertel 12717: sub load_domain_tab {
1.1172.2.70 raeburn 12718: my ($ignore_cache,$nocache) = @_;
12719: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 12720: my $fh;
12721: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
12722: my @lines = <$fh>;
12723: &parse_domain_tab(\@lines);
1.448 albertel 12724: }
1.852 albertel 12725: close($fh);
12726: $loaded = 1;
1.327 albertel 12727: }
1.846 albertel 12728:
12729: sub domain {
1.852 albertel 12730: &load_domain_tab() if (!$loaded);
12731:
1.846 albertel 12732: my ($name,$what) = @_;
12733: return if ( !exists($domain{$name}) );
12734:
12735: if (!$what) {
12736: return $domain{$name}{'description'};
12737: }
12738: return $domain{$name}{$what};
12739: }
1.974 raeburn 12740:
12741: sub domain_info {
12742: &load_domain_tab() if (!$loaded);
12743: return %domain;
12744: }
12745:
1.327 albertel 12746: }
12747:
12748:
1.1 albertel 12749: # ------------------------------------------------------------- Read hosts file
12750: {
1.838 albertel 12751: my %hostname;
1.844 albertel 12752: my %hostdom;
1.845 albertel 12753: my %libserv;
1.852 albertel 12754: my $loaded;
1.888 albertel 12755: my %name_to_host;
1.1074 raeburn 12756: my %internetdom;
1.1107 raeburn 12757: my %LC_dns_serv;
1.852 albertel 12758:
12759: sub parse_hosts_tab {
12760: my ($file) = @_;
12761: foreach my $configline (@$file) {
12762: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 12763: chomp($configline);
12764: if ($configline =~ /^\^/) {
12765: if ($configline =~ /^\^([\w.\-]+)/) {
12766: $LC_dns_serv{$1} = 1;
12767: }
12768: next;
12769: }
1.1074 raeburn 12770: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 12771: $name=~s/\s//g;
12772: if ($id && $domain && $role && $name) {
12773: $hostname{$id}=$name;
1.888 albertel 12774: push(@{$name_to_host{$name}}, $id);
1.852 albertel 12775: $hostdom{$id}=$domain;
12776: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 12777: if (defined($protocol)) {
12778: if ($protocol eq 'https') {
12779: $protocol{$id} = $protocol;
12780: } else {
12781: $protocol{$id} = 'http';
12782: }
1.968 raeburn 12783: } else {
1.969 raeburn 12784: $protocol{$id} = 'http';
1.968 raeburn 12785: }
1.1074 raeburn 12786: if (defined($intdom)) {
12787: $internetdom{$id} = $intdom;
12788: }
1.852 albertel 12789: }
12790: }
12791: }
1.864 albertel 12792:
12793: sub reset_hosts_info {
1.897 albertel 12794: &purge_remembered();
1.864 albertel 12795: &reset_domain_info();
12796: &reset_hosts_ip_info();
1.892 albertel 12797: undef(%name_to_host);
1.864 albertel 12798: undef(%hostname);
12799: undef(%hostdom);
12800: undef(%libserv);
12801: undef($loaded);
12802: }
1.1 albertel 12803:
1.852 albertel 12804: sub load_hosts_tab {
1.1172.2.70 raeburn 12805: my ($ignore_cache,$nocache) = @_;
12806: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.852 albertel 12807: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12808: my @config = <$config>;
12809: &parse_hosts_tab(\@config);
12810: close($config);
12811: $loaded=1;
1.1 albertel 12812: }
1.852 albertel 12813:
1.838 albertel 12814: sub hostname {
1.852 albertel 12815: &load_hosts_tab() if (!$loaded);
12816:
1.838 albertel 12817: my ($lonid) = @_;
12818: return $hostname{$lonid};
12819: }
1.845 albertel 12820:
1.838 albertel 12821: sub all_hostnames {
1.852 albertel 12822: &load_hosts_tab() if (!$loaded);
12823:
1.838 albertel 12824: return %hostname;
12825: }
1.845 albertel 12826:
1.888 albertel 12827: sub all_names {
1.1172.2.70 raeburn 12828: my ($ignore_cache,$nocache) = @_;
12829: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 12830:
12831: return %name_to_host;
12832: }
12833:
1.974 raeburn 12834: sub all_host_domain {
12835: &load_hosts_tab() if (!$loaded);
12836: return %hostdom;
12837: }
12838:
1.845 albertel 12839: sub is_library {
1.852 albertel 12840: &load_hosts_tab() if (!$loaded);
12841:
1.845 albertel 12842: return exists($libserv{$_[0]});
12843: }
12844:
12845: sub all_library {
1.852 albertel 12846: &load_hosts_tab() if (!$loaded);
12847:
1.845 albertel 12848: return %libserv;
12849: }
12850:
1.1062 droeschl 12851: sub unique_library {
12852: #2x reverse removes all hostnames that appear more than once
12853: my %unique = reverse &all_library();
12854: return reverse %unique;
12855: }
12856:
1.841 albertel 12857: sub get_servers {
1.852 albertel 12858: &load_hosts_tab() if (!$loaded);
12859:
1.841 albertel 12860: my ($domain,$type) = @_;
12861: my %possible_hosts = ($type eq 'library') ? %libserv
12862: : %hostname;
12863: my %result;
1.842 albertel 12864: if (ref($domain) eq 'ARRAY') {
12865: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 12866: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 12867: $result{$host} = $hostname;
12868: }
12869: }
12870: } else {
12871: while ( my ($host,$hostname) = each(%possible_hosts)) {
12872: if ($hostdom{$host} eq $domain) {
12873: $result{$host} = $hostname;
12874: }
1.841 albertel 12875: }
12876: }
12877: return %result;
12878: }
1.845 albertel 12879:
1.1062 droeschl 12880: sub get_unique_servers {
12881: my %unique = reverse &get_servers(@_);
12882: return reverse %unique;
12883: }
12884:
1.844 albertel 12885: sub host_domain {
1.852 albertel 12886: &load_hosts_tab() if (!$loaded);
12887:
1.844 albertel 12888: my ($lonid) = @_;
12889: return $hostdom{$lonid};
12890: }
12891:
1.841 albertel 12892: sub all_domains {
1.852 albertel 12893: &load_hosts_tab() if (!$loaded);
12894:
1.841 albertel 12895: my %seen;
12896: my @uniq = grep(!$seen{$_}++, values(%hostdom));
12897: return @uniq;
12898: }
1.1074 raeburn 12899:
12900: sub internet_dom {
12901: &load_hosts_tab() if (!$loaded);
12902:
12903: my ($lonid) = @_;
12904: return $internetdom{$lonid};
12905: }
1.1107 raeburn 12906:
12907: sub is_LC_dns {
12908: &load_hosts_tab() if (!$loaded);
12909:
12910: my ($hostname) = @_;
12911: return exists($LC_dns_serv{$hostname});
12912: }
12913:
1.1 albertel 12914: }
12915:
1.847 albertel 12916: {
12917: my %iphost;
1.856 albertel 12918: my %name_to_ip;
12919: my %lonid_to_ip;
1.869 albertel 12920:
1.847 albertel 12921: sub get_hosts_from_ip {
12922: my ($ip) = @_;
12923: my %iphosts = &get_iphost();
12924: if (ref($iphosts{$ip})) {
12925: return @{$iphosts{$ip}};
12926: }
12927: return;
1.839 albertel 12928: }
1.864 albertel 12929:
12930: sub reset_hosts_ip_info {
12931: undef(%iphost);
12932: undef(%name_to_ip);
12933: undef(%lonid_to_ip);
12934: }
1.856 albertel 12935:
12936: sub get_host_ip {
12937: my ($lonid) = @_;
12938: if (exists($lonid_to_ip{$lonid})) {
12939: return $lonid_to_ip{$lonid};
12940: }
12941: my $name=&hostname($lonid);
12942: my $ip = gethostbyname($name);
12943: return if (!$ip || length($ip) ne 4);
12944: $ip=inet_ntoa($ip);
12945: $name_to_ip{$name} = $ip;
12946: $lonid_to_ip{$lonid} = $ip;
12947: return $ip;
12948: }
1.847 albertel 12949:
12950: sub get_iphost {
1.1172.2.70 raeburn 12951: my ($ignore_cache,$nocache) = @_;
1.894 albertel 12952:
1.869 albertel 12953: if (!$ignore_cache) {
12954: if (%iphost) {
12955: return %iphost;
12956: }
12957: my ($ip_info,$cached)=
12958: &Apache::lonnet::is_cached_new('iphost','iphost');
12959: if ($cached) {
12960: %iphost = %{$ip_info->[0]};
12961: %name_to_ip = %{$ip_info->[1]};
12962: %lonid_to_ip = %{$ip_info->[2]};
12963: return %iphost;
12964: }
12965: }
1.894 albertel 12966:
12967: # get yesterday's info for fallback
12968: my %old_name_to_ip;
12969: my ($ip_info,$cached)=
12970: &Apache::lonnet::is_cached_new('iphost','iphost');
12971: if ($cached) {
12972: %old_name_to_ip = %{$ip_info->[1]};
12973: }
12974:
1.1172.2.70 raeburn 12975: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 12976: foreach my $name (keys(%name_to_host)) {
1.847 albertel 12977: my $ip;
12978: if (!exists($name_to_ip{$name})) {
12979: $ip = gethostbyname($name);
12980: if (!$ip || length($ip) ne 4) {
1.894 albertel 12981: if (defined($old_name_to_ip{$name})) {
12982: $ip = $old_name_to_ip{$name};
12983: &logthis("Can't find $name defaulting to old $ip");
12984: } else {
12985: &logthis("Name $name no IP found");
12986: next;
12987: }
12988: } else {
12989: $ip=inet_ntoa($ip);
1.847 albertel 12990: }
12991: $name_to_ip{$name} = $ip;
12992: } else {
12993: $ip = $name_to_ip{$name};
1.653 albertel 12994: }
1.888 albertel 12995: foreach my $id (@{ $name_to_host{$name} }) {
12996: $lonid_to_ip{$id} = $ip;
12997: }
12998: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 12999: }
1.1172.2.70 raeburn 13000: unless ($nocache) {
13001: &do_cache_new('iphost','iphost',
13002: [\%iphost,\%name_to_ip,\%lonid_to_ip],
13003: 48*60*60);
13004: }
1.869 albertel 13005:
1.847 albertel 13006: return %iphost;
1.598 albertel 13007: }
13008:
1.992 raeburn 13009: #
13010: # Given a DNS returns the loncapa host name for that DNS
13011: #
13012: sub host_from_dns {
13013: my ($dns) = @_;
13014: my @hosts;
13015: my $ip;
13016:
1.993 raeburn 13017: if (exists($name_to_ip{$dns})) {
1.992 raeburn 13018: $ip = $name_to_ip{$dns};
13019: }
13020: if (!$ip) {
13021: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
13022: if (length($ip) == 4) {
13023: $ip = &IO::Socket::inet_ntoa($ip);
13024: }
13025: }
13026: if ($ip) {
13027: @hosts = get_hosts_from_ip($ip);
13028: return $hosts[0];
13029: }
13030: return undef;
1.986 foxr 13031: }
1.992 raeburn 13032:
1.1074 raeburn 13033: sub get_internet_names {
13034: my ($lonid) = @_;
13035: return if ($lonid eq '');
13036: my ($idnref,$cached)=
13037: &Apache::lonnet::is_cached_new('internetnames',$lonid);
13038: if ($cached) {
13039: return $idnref;
13040: }
13041: my $ip = &get_host_ip($lonid);
13042: my @hosts = &get_hosts_from_ip($ip);
13043: my %iphost = &get_iphost();
13044: my (@idns,%seen);
13045: foreach my $id (@hosts) {
13046: my $dom = &host_domain($id);
13047: my $prim_id = &domain($dom,'primary');
13048: my $prim_ip = &get_host_ip($prim_id);
13049: next if ($seen{$prim_ip});
13050: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
13051: foreach my $id (@{$iphost{$prim_ip}}) {
13052: my $intdom = &internet_dom($id);
13053: unless (grep(/^\Q$intdom\E$/,@idns)) {
13054: push(@idns,$intdom);
13055: }
13056: }
13057: }
13058: $seen{$prim_ip} = 1;
13059: }
1.1172.2.23 raeburn 13060: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 13061: }
13062:
1.986 foxr 13063: }
13064:
1.1079 raeburn 13065: sub all_loncaparevs {
1.1172.2.39 raeburn 13066: 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 13067: }
13068:
1.1172.2.27 raeburn 13069: # ------------------------------------------------------- Read loncaparev table
13070: {
13071: sub load_loncaparevs {
13072: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
13073: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
13074: while (my $configline=<$config>) {
13075: chomp($configline);
13076: my ($hostid,$loncaparev)=split(/:/,$configline);
13077: $loncaparevs{$hostid}=$loncaparev;
13078: }
13079: close($config);
13080: }
13081: }
13082: }
13083: }
13084:
13085: # ----------------------------------------------------- Read serverhostID table
13086: {
13087: sub load_serverhomeIDs {
13088: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
13089: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
13090: while (my $configline=<$config>) {
13091: chomp($configline);
13092: my ($name,$id)=split(/:/,$configline);
13093: $serverhomeIDs{$name}=$id;
13094: }
13095: close($config);
13096: }
13097: }
13098: }
13099: }
13100:
13101:
1.862 albertel 13102: BEGIN {
13103:
13104: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
13105: unless ($readit) {
13106: {
13107: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
13108: %perlvar = (%perlvar,%{$configvars});
13109: }
13110:
13111:
1.1 albertel 13112: # ------------------------------------------------------ Read spare server file
13113: {
1.448 albertel 13114: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 13115:
13116: while (my $configline=<$config>) {
13117: chomp($configline);
1.284 matthew 13118: if ($configline) {
1.784 albertel 13119: my ($host,$type) = split(':',$configline,2);
1.785 albertel 13120: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 13121: push(@{ $spareid{$type} }, $host);
1.1 albertel 13122: }
13123: }
1.448 albertel 13124: close($config);
1.1 albertel 13125: }
1.11 www 13126: # ------------------------------------------------------------ Read permissions
13127: {
1.448 albertel 13128: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 13129:
13130: while (my $configline=<$config>) {
1.448 albertel 13131: chomp($configline);
13132: if ($configline) {
13133: my ($role,$perm)=split(/ /,$configline);
13134: if ($perm ne '') { $pr{$role}=$perm; }
13135: }
1.11 www 13136: }
1.448 albertel 13137: close($config);
1.11 www 13138: }
13139:
13140: # -------------------------------------------- Read plain texts for permissions
13141: {
1.448 albertel 13142: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 13143:
13144: while (my $configline=<$config>) {
1.448 albertel 13145: chomp($configline);
13146: if ($configline) {
1.742 raeburn 13147: my ($short,@plain)=split(/:/,$configline);
13148: %{$prp{$short}} = ();
13149: if (@plain > 0) {
13150: $prp{$short}{'std'} = $plain[0];
13151: for (my $i=1; $i<@plain; $i++) {
13152: $prp{$short}{'alt'.$i} = $plain[$i];
13153: }
13154: }
1.448 albertel 13155: }
1.135 www 13156: }
1.448 albertel 13157: close($config);
1.135 www 13158: }
13159:
13160: # ---------------------------------------------------------- Read package table
13161: {
1.448 albertel 13162: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 13163:
13164: while (my $configline=<$config>) {
1.483 albertel 13165: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 13166: chomp($configline);
13167: my ($short,$plain)=split(/:/,$configline);
13168: my ($pack,$name)=split(/\&/,$short);
13169: if ($plain ne '') {
13170: $packagetab{$pack.'&'.$name.'&name'}=$name;
13171: $packagetab{$short}=$plain;
13172: }
1.11 www 13173: }
1.448 albertel 13174: close($config);
1.329 matthew 13175: }
13176:
1.1172.2.27 raeburn 13177: # --------------------------------------------------------- Read loncaparev table
1.1073 raeburn 13178:
1.1172.2.27 raeburn 13179: &load_loncaparevs();
13180:
13181: # ------------------------------------------------------- Read serverhostID table
13182:
13183: &load_serverhomeIDs();
1.1074 raeburn 13184:
1.1172.2.27 raeburn 13185: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 13186: {
13187: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
13188: if (-e $file) {
13189: my $parser = HTML::LCParser->new($file);
13190: while (my $token = $parser->get_token()) {
13191: if ($token->[0] eq 'S') {
13192: my $item = $token->[1];
13193: my $name = $token->[2]{'name'};
13194: my $value = $token->[2]{'value'};
13195: if ($item ne '' && $name ne '' && $value ne '') {
13196: my $release = $parser->get_text();
13197: $release =~ s/(^\s*|\s*$ )//gx;
13198: $needsrelease{$item.':'.$name.':'.$value} = $release;
13199: }
13200: }
13201: }
13202: }
1.1073 raeburn 13203: }
13204:
1.1138 raeburn 13205: # ---------------------------------------------------------- Read managers table
13206: {
13207: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
13208: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
13209: while (my $configline=<$config>) {
13210: chomp($configline);
13211: next if ($configline =~ /^\#/);
13212: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
13213: $managerstab{$configline} = 1;
13214: }
13215: }
13216: close($config);
13217: }
13218: }
13219: }
13220:
1.329 matthew 13221: # ------------- set up temporary directory
13222: {
1.1117 foxr 13223: $tmpdir = LONCAPA::tempdir();
1.329 matthew 13224:
1.11 www 13225: }
13226:
1.794 albertel 13227: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
13228: 'compress_threshold'=> 20_000,
13229: });
1.185 www 13230:
1.281 www 13231: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 13232: $dumpcount=0;
1.958 www 13233: $locknum=0;
1.22 www 13234:
1.163 harris41 13235: &logtouch();
1.672 albertel 13236: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 13237: $readit=1;
1.564 albertel 13238: {
13239: use integer;
13240: my $test=(2**32)+1;
1.568 albertel 13241: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 13242: &logthis(" Detected 64bit platform ($_64bit)");
13243: }
1.195 www 13244: }
1.1 albertel 13245: }
1.179 www 13246:
1.1 albertel 13247: 1;
1.191 harris41 13248: __END__
13249:
1.243 albertel 13250: =pod
13251:
1.191 harris41 13252: =head1 NAME
13253:
1.243 albertel 13254: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 13255:
13256: =head1 SYNOPSIS
13257:
1.243 albertel 13258: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 13259:
13260: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
13261:
1.243 albertel 13262: Common parameters:
13263:
13264: =over 4
13265:
13266: =item *
13267:
13268: $uname : an internal username (if $cname expecting a course Id specifically)
13269:
13270: =item *
13271:
13272: $udom : a domain (if $cdom expecting a course's domain specifically)
13273:
13274: =item *
13275:
13276: $symb : a resource instance identifier
13277:
13278: =item *
13279:
13280: $namespace : the name of a .db file that contains the data needed or
13281: being set.
13282:
13283: =back
13284:
1.394 bowersj2 13285: =head1 OVERVIEW
1.191 harris41 13286:
1.394 bowersj2 13287: lonnet provides subroutines which interact with the
13288: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
13289: about classes, users, and resources.
1.243 albertel 13290:
13291: For many of these objects you can also use this to store data about
13292: them or modify them in various ways.
1.191 harris41 13293:
1.394 bowersj2 13294: =head2 Symbs
1.191 harris41 13295:
1.394 bowersj2 13296: To identify a specific instance of a resource, LON-CAPA uses symbols
13297: or "symbs"X<symb>. These identifiers are built from the URL of the
13298: map, the resource number of the resource in the map, and the URL of
13299: the resource itself. The latter is somewhat redundant, but might help
13300: if maps change.
13301:
13302: An example is
13303:
13304: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
13305:
13306: The respective map entry is
13307:
13308: <resource id="19" src="/res/msu/korte/tests/part12.problem"
13309: title="Problem 2">
13310: </resource>
13311:
13312: Symbs are used by the random number generator, as well as to store and
13313: restore data specific to a certain instance of for example a problem.
13314:
13315: =head2 Storing And Retrieving Data
13316:
13317: X<store()>X<cstore()>X<restore()>Three of the most important functions
13318: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
13319: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
13320: is is the non-critical message twin of cstore. These functions are for
13321: handlers to store a perl hash to a user's permanent data space in an
13322: easy manner, and to retrieve it again on another call. It is expected
13323: that a handler would use this once at the beginning to retrieve data,
13324: and then again once at the end to send only the new data back.
13325:
13326: The data is stored in the user's data directory on the user's
13327: homeserver under the ID of the course.
13328:
13329: The hash that is returned by restore will have all of the previous
13330: value for all of the elements of the hash.
13331:
13332: Example:
13333:
13334: #creating a hash
13335: my %hash;
13336: $hash{'foo'}='bar';
13337:
13338: #storing it
13339: &Apache::lonnet::cstore(\%hash);
13340:
13341: #changing a value
13342: $hash{'foo'}='notbar';
13343:
13344: #adding a new value
13345: $hash{'bar'}='foo';
13346: &Apache::lonnet::cstore(\%hash);
13347:
13348: #retrieving the hash
13349: my %history=&Apache::lonnet::restore();
13350:
13351: #print the hash
13352: foreach my $key (sort(keys(%history))) {
13353: print("\%history{$key} = $history{$key}");
13354: }
13355:
13356: Will print out:
1.191 harris41 13357:
1.394 bowersj2 13358: %history{1:foo} = bar
13359: %history{1:keys} = foo:timestamp
13360: %history{1:timestamp} = 990455579
13361: %history{2:bar} = foo
13362: %history{2:foo} = notbar
13363: %history{2:keys} = foo:bar:timestamp
13364: %history{2:timestamp} = 990455580
13365: %history{bar} = foo
13366: %history{foo} = notbar
13367: %history{timestamp} = 990455580
13368: %history{version} = 2
13369:
13370: Note that the special hash entries C<keys>, C<version> and
13371: C<timestamp> were added to the hash. C<version> will be equal to the
13372: total number of versions of the data that have been stored. The
13373: C<timestamp> attribute will be the UNIX time the hash was
13374: stored. C<keys> is available in every historical section to list which
13375: keys were added or changed at a specific historical revision of a
13376: hash.
13377:
13378: B<Warning>: do not store the hash that restore returns directly. This
13379: will cause a mess since it will restore the historical keys as if the
13380: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 13381:
1.394 bowersj2 13382: Calling convention:
1.191 harris41 13383:
1.1172.2.27 raeburn 13384: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1172.2.64 raeburn 13385: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 13386:
1.394 bowersj2 13387: For more detailed information, see lonnet specific documentation.
1.191 harris41 13388:
1.394 bowersj2 13389: =head1 RETURN MESSAGES
1.191 harris41 13390:
1.394 bowersj2 13391: =over 4
1.191 harris41 13392:
1.394 bowersj2 13393: =item * B<con_lost>: unable to contact remote host
1.191 harris41 13394:
1.394 bowersj2 13395: =item * B<con_delayed>: unable to contact remote host, message will be delivered
13396: when the connection is brought back up
1.191 harris41 13397:
1.394 bowersj2 13398: =item * B<con_failed>: unable to contact remote host and unable to save message
13399: for later delivery
1.191 harris41 13400:
1.967 bisitz 13401: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 13402:
1.394 bowersj2 13403: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 13404: that was requested
1.191 harris41 13405:
1.243 albertel 13406: =back
1.191 harris41 13407:
1.243 albertel 13408: =head1 PUBLIC SUBROUTINES
1.191 harris41 13409:
1.243 albertel 13410: =head2 Session Environment Functions
1.191 harris41 13411:
1.243 albertel 13412: =over 4
1.191 harris41 13413:
1.394 bowersj2 13414: =item *
13415: X<appenv()>
1.949 raeburn 13416: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 13417: the user envirnoment file, and will be restored for each access this
1.620 albertel 13418: user makes during this session, also modifies the %env for the current
1.949 raeburn 13419: process. Optional rolesarrayref - if defined contains a reference to an array
13420: of roles which are exempt from the restriction on modifying user.role entries
13421: in the user's environment.db and in %env.
1.191 harris41 13422:
13423: =item *
1.394 bowersj2 13424: X<delenv()>
1.987 raeburn 13425: B<delenv($delthis,$regexp)>: removes all items from the session
13426: environment file that begin with $delthis. If the
13427: optional second arg - $regexp - is true, $delthis is treated as a
13428: regular expression, otherwise \Q$delthis\E is used.
13429: The values are also deleted from the current processes %env.
1.191 harris41 13430:
1.795 albertel 13431: =item * get_env_multiple($name)
13432:
13433: gets $name from the %env hash, it seemlessly handles the cases where multiple
13434: values may be defined and end up as an array ref.
13435:
13436: returns an array of values
13437:
1.243 albertel 13438: =back
13439:
13440: =head2 User Information
1.191 harris41 13441:
1.243 albertel 13442: =over 4
1.191 harris41 13443:
13444: =item *
1.394 bowersj2 13445: X<queryauthenticate()>
13446: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 13447: authentication scheme
13448:
13449: =item *
1.394 bowersj2 13450: X<authenticate()>
1.1073 raeburn 13451: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 13452: authenticate user from domain's lib servers (first use the current
13453: one). C<$upass> should be the users password.
1.1073 raeburn 13454: $checkdefauth is optional (value is 1 if a check should be made to
13455: authenticate user using default authentication method, and allow
13456: account creation if username does not have account in the domain).
13457: $clientcancheckhost is optional (value is 1 if checking whether the
13458: server can host will occur on the client side in lonauth.pm).
1.191 harris41 13459:
13460: =item *
1.394 bowersj2 13461: X<homeserver()>
13462: B<homeserver($uname,$udom)>: find the server which has
13463: the user's directory and files (there must be only one), this caches
13464: the answer, and also caches if there is a borken connection.
1.191 harris41 13465:
13466: =item *
1.394 bowersj2 13467: X<idget()>
13468: B<idget($udom,@ids)>: find the usernames behind a list of IDs
13469: (IDs are a unique resource in a domain, there must be only 1 ID per
13470: username, and only 1 username per ID in a specific domain) (returns
13471: hash: id=>name,id=>name)
1.191 harris41 13472:
13473: =item *
1.394 bowersj2 13474: X<idrget()>
13475: B<idrget($udom,@unames)>: find the IDs behind a list of
13476: usernames (returns hash: name=>id,name=>id)
1.191 harris41 13477:
13478: =item *
1.394 bowersj2 13479: X<idput()>
13480: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 13481:
13482: =item *
1.394 bowersj2 13483: X<rolesinit()>
1.1169 droeschl 13484: B<rolesinit($udom,$username)>: get user privileges.
13485: returns user role, first access and timer interval hashes
1.243 albertel 13486:
13487: =item *
1.1171 droeschl 13488: X<privileged()>
13489: B<privileged($username,$domain)>: returns a true if user has a
13490: privileged and active role (i.e. su or dc), false otherwise.
13491:
13492: =item *
1.551 albertel 13493: X<getsection()>
13494: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 13495: course $cname, return section name/number or '' for "not in course"
13496: and '-1' for "no section"
13497:
13498: =item *
1.394 bowersj2 13499: X<userenvironment()>
13500: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 13501: passed in @what from the requested user's environment, returns a hash
13502:
1.858 raeburn 13503: =item *
13504: X<userlog_query()>
1.859 albertel 13505: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
13506: activity.log file. %filters defines filters applied when parsing the
13507: log file. These can be start or end timestamps, or the type of action
13508: - log to look for Login or Logout events, check for Checkin or
13509: Checkout, role for role selection. The response is in the form
13510: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
13511: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 13512:
1.243 albertel 13513: =back
13514:
13515: =head2 User Roles
13516:
13517: =over 4
13518:
13519: =item *
13520:
1.1172.2.65 raeburn 13521: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
13522: returns codes for allowed actions.
13523:
13524: The first argument is required, all others are optional.
13525:
13526: $priv is the privilege being checked.
13527: $uri contains additional information about what is being checked for access (e.g.,
13528: URL, course ID etc.).
13529: $symb is the unique resource instance identifier in a course; if needed,
13530: but not provided, it will be retrieved via a call to &symbread().
13531: $role is the role for which a priv is being checked (only used if priv is evb).
13532: $clientip is the user's IP address (only used when checking for access to portfolio
13533: files).
13534: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
13535: prevents recursive calls to &allowed.
13536:
1.243 albertel 13537: F: full access
13538: U,I,K: authentication modes (cxx only)
13539: '': forbidden
13540: 1: user needs to choose course
13541: 2: browse allowed
1.766 albertel 13542: A: passphrase authentication needed
1.1172.2.65 raeburn 13543: B: access temporarily blocked because of a blocking event in a course.
1.243 albertel 13544:
13545: =item *
13546:
1.1172.2.13 raeburn 13547: constructaccess($url,$setpriv) : check for access to construction space URL
13548:
13549: See if the owner domain and name in the URL match those in the
13550: expected environment. If so, return three element list
13551: ($ownername,$ownerdomain,$ownerhome).
13552:
13553: Otherwise return the null string.
13554:
13555: If second argument 'setpriv' is true, it assigns the privileges,
13556: and returns the same three element list, unless the owner has
13557: blocked "ad hoc" Domain Coordinator access to the Author Space,
13558: in which case the null string is returned.
13559:
13560: =item *
13561:
1.1172.2.84 raeburn 13562: definerole($rolename,$sysrole,$domrole,$courole,$uname,$udom) : define role;
13563: define a custom role rolename set privileges in format of lonTabs/roles.tab
13564: for system, domain, and course level. $uname and $udom are optional (current
13565: user's username and domain will be used when either of $uname or $udom are absent.
1.243 albertel 13566:
13567: =item *
13568:
1.988 raeburn 13569: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
13570: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 13571: $type is Course (default) or Community.
1.988 raeburn 13572: If $forcedefault evaluates to true, text returned will be default
13573: text for $type. Otherwise, if this is a course, the text returned
13574: will be a custom name for the role (if defined in the course's
13575: environment). If no custom name is defined the default is returned.
13576:
1.832 raeburn 13577: =item *
13578:
1.1172.2.23 raeburn 13579: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 13580: All arguments are optional. Returns a hash of a roles, either for
13581: co-author/assistant author roles for a user's Construction Space
1.906 albertel 13582: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 13583: In the hash, keys are set to colon-separated $uname,$udom,$role, and
13584: (optionally) if $withsec is true, a fourth colon-separated item - $section.
13585: For each key, value is set to colon-separated start and end times for
13586: the role. If no username and domain are specified, will default to
1.934 raeburn 13587: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 13588: of role statuses (active, future or previous), roles
13589: (e.g., cc,in, st etc.) and domains of the roles which can be used
13590: to restrict the list of roles reported. If no array ref is
13591: provided for types, will default to return only active roles.
1.834 albertel 13592:
1.1172.2.13 raeburn 13593: =item *
13594:
13595: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
13596: user: $uname:$udom has a role in the course: $cdom_$cnum.
13597:
13598: Additional optional arguments are: $type (if role checking is to be restricted
13599: to certain user status types -- previous (expired roles), active (currently
13600: available roles) or future (roles available in the future), and
13601: $hideprivileged -- if true will not report course roles for users who
1.1172.2.23 raeburn 13602: have active Domain Coordinator role in course's domain or in additional
13603: domains (specified in 'Domains to check for privileged users' in course
13604: environment -- set via: Course Settings -> Classlists and staff listing).
13605:
13606: =item *
13607:
13608: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
13609: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
13610: $possdomains and $possroles are optional array refs -- to domains to check and
13611: roles to check. If $possdomains is not specified, a dump will be done of the
13612: users' roles.db to check for a dc or su role in any domain. This can be
13613: time consuming if &privileged is called repeatedly (e.g., when displaying a
13614: classlist), so in such cases, supplying a $possdomains array is preferred, as
13615: this then allows &privileged_by_domain() to be used, which caches the identity
13616: of privileged users, eliminating the need for repeated calls to &dump().
13617:
13618: =item *
13619:
13620: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
13621: where the outer hash keys are domains specified in the $possdomains array ref,
13622: next inner hash keys are privileged roles specified in the $roles array ref,
13623: and the innermost hash contains key = value pairs for username:domain = end:start
13624: for active or future "privileged" users with that role in that domain. To avoid
13625: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
13626: innerhash are cached using priv_$role and $dom as the identifiers.
1.1172.2.13 raeburn 13627:
1.243 albertel 13628: =back
13629:
13630: =head2 User Modification
13631:
13632: =over 4
13633:
13634: =item *
13635:
1.957 raeburn 13636: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 13637: user for the level given by URL. Optional start and end dates (leave empty
13638: string or zero for "no date")
1.191 harris41 13639:
13640: =item *
13641:
1.243 albertel 13642: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
13643: change a users, password, possible return values are: ok,
13644: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
13645: refused
1.191 harris41 13646:
13647: =item *
13648:
1.243 albertel 13649: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 13650:
13651: =item *
13652:
1.1058 raeburn 13653: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
13654: $forceid,$desiredhome,$email,$inststatus,$candelete) :
13655:
13656: will update user information (firstname,middlename,lastname,generation,
13657: permanentemail), and if forceid is true, student/employee ID also.
13658: A user's institutional affiliation(s) can also be updated.
13659: User information fields will not be overwritten with empty entries
13660: unless the field is included in the $candelete array reference.
13661: This array is included when a single user is modified via "Manage Users",
13662: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 13663:
13664: =item *
13665:
1.286 matthew 13666: modifystudent
13667:
1.957 raeburn 13668: modify a student's enrollment and identification information.
1.1172.2.31 raeburn 13669: The course id is resolved based on the current user's environment.
13670: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 13671: associated with a course.
13672:
1.297 matthew 13673: This call is essentially a wrapper for lonnet::modifyuser and
13674: lonnet::modify_student_enrollment
1.286 matthew 13675:
13676: Inputs:
13677:
13678: =over 4
13679:
1.957 raeburn 13680: =item B<$udom> Student's loncapa domain
1.286 matthew 13681:
1.957 raeburn 13682: =item B<$uname> Student's loncapa login name
1.286 matthew 13683:
1.964 bisitz 13684: =item B<$uid> Student/Employee ID
1.286 matthew 13685:
1.957 raeburn 13686: =item B<$umode> Student's authentication mode
1.286 matthew 13687:
1.957 raeburn 13688: =item B<$upass> Student's password
1.286 matthew 13689:
1.957 raeburn 13690: =item B<$first> Student's first name
1.286 matthew 13691:
1.957 raeburn 13692: =item B<$middle> Student's middle name
1.286 matthew 13693:
1.957 raeburn 13694: =item B<$last> Student's last name
1.286 matthew 13695:
1.957 raeburn 13696: =item B<$gene> Student's generation
1.286 matthew 13697:
1.957 raeburn 13698: =item B<$usec> Student's section in course
1.286 matthew 13699:
13700: =item B<$end> Unix time of the roles expiration
13701:
13702: =item B<$start> Unix time of the roles start date
13703:
13704: =item B<$forceid> If defined, allow $uid to be changed
13705:
13706: =item B<$desiredhome> server to use as home server for student
13707:
1.957 raeburn 13708: =item B<$email> Student's permanent e-mail address
13709:
13710: =item B<$type> Type of enrollment (auto or manual)
13711:
1.963 raeburn 13712: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
13713:
13714: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 13715:
1.963 raeburn 13716: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 13717:
1.963 raeburn 13718: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 13719:
1.1172.2.19 raeburn 13720: =item B<$inststatus> institutional status of user - : separated string of escaped status types
13721:
13722: =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 13723:
1.286 matthew 13724: =back
1.297 matthew 13725:
13726: =item *
13727:
13728: modify_student_enrollment
13729:
1.1172.2.31 raeburn 13730: Change a student's enrollment status in a class. The environment variable
1.297 matthew 13731: 'role.request.course' must be defined for this function to proceed.
13732:
13733: Inputs:
13734:
13735: =over 4
13736:
1.1172.2.31 raeburn 13737: =item $udom, student's domain
1.297 matthew 13738:
1.1172.2.31 raeburn 13739: =item $uname, student's name
1.297 matthew 13740:
1.1172.2.31 raeburn 13741: =item $uid, student's user id
1.297 matthew 13742:
1.1172.2.31 raeburn 13743: =item $first, student's first name
1.297 matthew 13744:
13745: =item $middle
13746:
13747: =item $last
13748:
13749: =item $gene
13750:
13751: =item $usec
13752:
13753: =item $end
13754:
13755: =item $start
13756:
1.957 raeburn 13757: =item $type
13758:
13759: =item $locktype
13760:
13761: =item $cid
13762:
13763: =item $selfenroll
13764:
13765: =item $context
13766:
1.1172.2.19 raeburn 13767: =item $credits, number of credits student will earn from this class
13768:
1.1172.2.76 raeburn 13769: =item $instsec, institutional course section code for student
13770:
1.297 matthew 13771: =back
13772:
1.191 harris41 13773:
13774: =item *
13775:
1.243 albertel 13776: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
13777: custom role; give a custom role to a user for the level given by URL. Specify
13778: name and domain of role author, and role name
1.191 harris41 13779:
13780: =item *
13781:
1.243 albertel 13782: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 13783:
13784: =item *
13785:
1.243 albertel 13786: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
13787:
13788: =back
13789:
13790: =head2 Course Infomation
13791:
13792: =over 4
1.191 harris41 13793:
13794: =item *
13795:
1.1118 foxr 13796: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 13797: specified course id, including all environment settings for the
13798: course, the description of the course will be in the hash under the
13799: key 'description'
1.191 harris41 13800:
1.1118 foxr 13801: $options is an optional parameter that if supplied is a hash reference that controls
13802: what how this function works. It has the following key/values:
13803:
13804: =over 4
13805:
13806: =item freshen_cache
13807:
13808: If defined, and the environment cache for the course is valid, it is
13809: returned in the returned hash.
13810:
13811: =item one_time
13812:
13813: If defined, the last cache time is set to _now_
13814:
13815: =item user
13816:
13817: If defined, the supplied username is used instead of the current user.
13818:
13819:
13820: =back
13821:
1.191 harris41 13822: =item *
13823:
1.624 albertel 13824: resdata($name,$domain,$type,@which) : request for current parameter
13825: setting for a specific $type, where $type is either 'course' or 'user',
13826: @what should be a list of parameters to ask about. This routine caches
1.1172.2.31 raeburn 13827: answers for 10 minutes.
1.243 albertel 13828:
1.877 foxr 13829: =item *
13830:
13831: get_courseresdata($courseid, $domain) : dump the entire course resource
13832: data base, returning a hash that is keyed by the resource name and has
13833: values that are the resource value. I believe that the timestamps and
13834: versions are also returned.
13835:
1.1172.2.31 raeburn 13836: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
13837: supplemental content area. This routine caches the number of files for
13838: 10 minutes.
13839:
1.243 albertel 13840: =back
13841:
13842: =head2 Course Modification
13843:
13844: =over 4
1.191 harris41 13845:
13846: =item *
13847:
1.243 albertel 13848: writecoursepref($courseid,%prefs) : write preferences (environment
13849: database) for a course
1.191 harris41 13850:
13851: =item *
13852:
1.1011 raeburn 13853: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
13854:
13855: =item *
13856:
1.1038 raeburn 13857: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 13858:
1.1167 droeschl 13859: =item *
13860:
13861: is_course($courseid), is_course($cdom, $cnum)
13862:
13863: Accepts either a combined $courseid (in the form of domain_courseid) or the
13864: two component version $cdom, $cnum. It checks if the specified course exists.
13865:
13866: Returns:
13867: undef if the course doesn't exist, otherwise
13868: in scalar context the combined courseid.
13869: in list context the two components of the course identifier, domain and
13870: courseid.
13871:
1.243 albertel 13872: =back
13873:
13874: =head2 Resource Subroutines
13875:
13876: =over 4
1.191 harris41 13877:
13878: =item *
13879:
1.243 albertel 13880: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 13881:
13882: =item *
13883:
1.243 albertel 13884: repcopy($filename) : subscribes to the requested file, and attempts to
13885: replicate from the owning library server, Might return
1.607 raeburn 13886: 'unavailable', 'not_found', 'forbidden', 'ok', or
13887: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 13888: resource. Expects the local filesystem pathname
13889: (/home/httpd/html/res/....)
13890:
13891: =back
13892:
13893: =head2 Resource Information
13894:
13895: =over 4
1.191 harris41 13896:
13897: =item *
13898:
1.1172.2.28 raeburn 13899: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
13900: and returns the value of a variety of different possible values,
13901: $varname should be a request string, and the other parameters can be
13902: used to specify who and what one is asking about. Ordinarily, $cid
13903: does not need to be specified, as it is retrived from
13904: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
13905: within lonuserstate::loadmap() when initializing a course, before
13906: $env{'request.course.id'} has been set, so it needs to be provided
13907: in that one case.
1.243 albertel 13908:
13909: Possible values for $varname are environment.lastname (or other item
13910: from the envirnment hash), user.name (or someother aspect about the
13911: user), resource.0.maxtries (or some other part and parameter of a
13912: resource)
1.204 albertel 13913:
13914: =item *
13915:
1.243 albertel 13916: directcondval($number) : get current value of a condition; reads from a state
13917: string
1.204 albertel 13918:
13919: =item *
13920:
1.243 albertel 13921: condval($condidx) : value of condition index based on state
1.204 albertel 13922:
13923: =item *
13924:
1.243 albertel 13925: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
13926: resource's metadata, $what should be either a specific key, or either
13927: 'keys' (to get a list of possible keys) or 'packages' to get a list of
13928: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
13929:
13930: this function automatically caches all requests
1.191 harris41 13931:
13932: =item *
13933:
1.243 albertel 13934: metadata_query($query,$custom,$customshow) : make a metadata query against the
13935: network of library servers; returns file handle of where SQL and regex results
13936: will be stored for query
1.191 harris41 13937:
13938: =item *
13939:
1.1172.2.66 raeburn 13940: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
13941: return symbolic list entry (all arguments optional).
13942:
13943: Args: filename is the filename (including path) for the file for which a symb
13944: is required; donotrecurse, if true will prevent calls to allowed() being made
13945: to check access status if more than one resource was found in the bighash
13946: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
13947: a randompick); ignorecachednull, if true will prevent a symb of '' being
13948: returned if $env{$cache_str} is defined as ''; checkforblock if true will
13949: cause possible symbs to be checked to determine if they are subject to content
13950: blocking, if so they will not be included as possible symbs; possibles is a
13951: ref to a hash, which, as a side effect, will be populated with all possible
13952: symbs (content blocking not tested).
13953:
1.243 albertel 13954: returns the data handle
1.191 harris41 13955:
13956: =item *
13957:
1.1172.2.17 raeburn 13958: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
1.1172.2.11 raeburn 13959: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 13960: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1172.2.11 raeburn 13961: on failure, user must be in a course, as it assumes the existence of
13962: the course initial hash, and uses $env('request.course.id'}. The third
13963: arg is an optional reference to a scalar. If this arg is passed in the
13964: call to symbverify, it will be set to 1 if the symb has been set to be
13965: encrypted; otherwise it will be null.
1.243 albertel 13966:
1.191 harris41 13967: =item *
13968:
1.243 albertel 13969: symbclean($symb) : removes versions numbers from a symb, returns the
13970: cleaned symb
1.191 harris41 13971:
13972: =item *
13973:
1.243 albertel 13974: is_on_map($uri) : checks if the $uri is somewhere on the current
13975: course map, user must be in a course for it to work.
1.191 harris41 13976:
13977: =item *
13978:
1.243 albertel 13979: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 13980:
13981: =item *
13982:
1.243 albertel 13983: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13984: a random seed, all arguments are optional, if they aren't sent it uses the
13985: environment to derive them. Note: if symb isn't sent and it can't get one
13986: from &symbread it will use the current time as its return value
1.191 harris41 13987:
13988: =item *
13989:
1.243 albertel 13990: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13991: unfakeable, receipt
1.191 harris41 13992:
13993: =item *
13994:
1.620 albertel 13995: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 13996:
13997: =item *
13998:
1.243 albertel 13999: countacc($url) : count the number of accesses to a given URL
1.191 harris41 14000:
14001: =item *
14002:
1.243 albertel 14003: 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 14004:
14005: =item *
14006:
1.243 albertel 14007: 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 14008:
14009: =item *
14010:
1.243 albertel 14011: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 14012:
14013: =item *
14014:
1.243 albertel 14015: devalidate($symb) : devalidate temporary spreadsheet calculations,
14016: forcing spreadsheet to reevaluate the resource scores next time.
14017:
1.1172.2.13 raeburn 14018: =item *
14019:
14020: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
14021: when viewing in course context.
14022:
14023: input: six args -- filename (decluttered), course number, course domain,
14024: url, symb (if registered) and group (if this is a
14025: group item -- e.g., bulletin board, group page etc.).
14026:
14027: output: array of five scalars --
14028: $cfile -- url for file editing if editable on current server
14029: $home -- homeserver of resource (i.e., for author if published,
14030: or course if uploaded.).
14031: $switchserver -- 1 if server switch will be needed.
14032: $forceedit -- 1 if icon/link should be to go to edit mode
14033: $forceview -- 1 if icon/link should be to go to view mode
14034:
14035: =item *
14036:
14037: is_course_upload($file,$cnum,$cdom)
14038:
14039: Used in course context to determine if current file was uploaded to
14040: the course (i.e., would be found in /userfiles/docs on the course's
14041: homeserver.
14042:
14043: input: 3 args -- filename (decluttered), course number and course domain.
14044: output: boolean -- 1 if file was uploaded.
14045:
1.243 albertel 14046: =back
14047:
14048: =head2 Storing/Retreiving Data
14049:
14050: =over 4
1.191 harris41 14051:
14052: =item *
14053:
1.1172.2.64 raeburn 14054: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
14055: permanently for this url; hashref needs to be given and should be a \%hashname;
14056: the remaining args aren't required and if they aren't passed or are '' they will
14057: be derived from the env (with the exception of $laststore, which is an
14058: optional arg used when a user's submission is stored in grading).
14059: $laststore is $version=$timestamp, where $version is the most recent version
14060: number retrieved for the corresponding $symb in the $namespace db file, and
14061: $timestamp is the timestamp for that transaction (UNIX time).
14062: $laststore is currently only passed when cstore() is called by
14063: structuretags::finalize_storage().
1.191 harris41 14064:
14065: =item *
14066:
1.1172.2.64 raeburn 14067: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
14068: but uses critical subroutine
1.191 harris41 14069:
14070: =item *
14071:
1.243 albertel 14072: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
14073: all args are optional
1.191 harris41 14074:
14075: =item *
14076:
1.717 albertel 14077: dumpstore($namespace,$udom,$uname,$regexp,$range) :
14078: dumps the complete (or key matching regexp) namespace into a hash
14079: ($udom, $uname, $regexp, $range are optional) for a namespace that is
14080: normally &store()ed into
14081:
14082: $range should be either an integer '100' (give me the first 100
14083: matching records)
14084: or be two integers sperated by a - with no spaces
14085: '30-50' (give me the 30th through the 50th matching
14086: records)
14087:
14088:
14089: =item *
14090:
1.1172.2.59 raeburn 14091: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 14092: replaces a &store() version of data with a replacement set of data
14093: for a particular resource in a namespace passed in the $storehash hash
1.1172.2.59 raeburn 14094: reference. If $tolog is true, the transaction is logged in the courselog
14095: with an action=PUTSTORE.
1.717 albertel 14096:
14097: =item *
14098:
1.243 albertel 14099: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
14100: works very similar to store/cstore, but all data is stored in a
14101: temporary location and can be reset using tmpreset, $storehash should
14102: be a hash reference, returns nothing on success
1.191 harris41 14103:
14104: =item *
14105:
1.243 albertel 14106: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
14107: similar to restore, but all data is stored in a temporary location and
14108: can be reset using tmpreset. Returns a hash of values on success,
14109: error string otherwise.
1.191 harris41 14110:
14111: =item *
14112:
1.243 albertel 14113: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
14114: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 14115:
14116: =item *
14117:
1.243 albertel 14118: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14119: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 14120:
14121: =item *
14122:
1.243 albertel 14123: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
14124: namesp ($udom and $uname are optional)
1.191 harris41 14125:
14126: =item *
14127:
1.702 albertel 14128: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 14129: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 14130: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 14131:
1.702 albertel 14132: $range should be either an integer '100' (give me the first 100
14133: matching records)
14134: or be two integers sperated by a - with no spaces
14135: '30-50' (give me the 30th through the 50th matching
14136: records)
1.449 matthew 14137: =item *
14138:
14139: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
14140: $store can be a scalar, an array reference, or if the amount to be
14141: incremented is > 1, a hash reference.
14142:
14143: ($udom and $uname are optional)
1.191 harris41 14144:
14145: =item *
14146:
1.243 albertel 14147: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
14148: ($udom and $uname are optional)
1.191 harris41 14149:
14150: =item *
14151:
1.243 albertel 14152: cput($namespace,$storehash,$udom,$uname) : critical put
14153: ($udom and $uname are optional)
1.191 harris41 14154:
14155: =item *
14156:
1.748 albertel 14157: newput($namespace,$storehash,$udom,$uname) :
14158:
14159: Attempts to store the items in the $storehash, but only if they don't
14160: currently exist, if this succeeds you can be certain that you have
14161: successfully created a new key value pair in the $namespace db.
14162:
14163:
14164: Args:
14165: $namespace: name of database to store values to
14166: $storehash: hashref to store to the db
14167: $udom: (optional) domain of user containing the db
14168: $uname: (optional) name of user caontaining the db
14169:
14170: Returns:
14171: 'ok' -> succeeded in storing all keys of $storehash
14172: 'key_exists: <key>' -> failed to anything out of $storehash, as at
14173: least <key> already existed in the db (other
14174: requested keys may also already exist)
1.967 bisitz 14175: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 14176: 'con_lost' -> unable to contact request server
14177: 'refused' -> action was not allowed by remote machine
14178:
14179:
14180: =item *
14181:
1.243 albertel 14182: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
14183: reference filled in from namesp (encrypts the return communication)
14184: ($udom and $uname are optional)
1.191 harris41 14185:
14186: =item *
14187:
1.243 albertel 14188: log($udom,$name,$home,$message) : write to permanent log for user; use
14189: critical subroutine
14190:
1.806 raeburn 14191: =item *
14192:
1.860 raeburn 14193: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
14194: array reference filled in from namespace found in domain level on either
14195: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 14196:
14197: =item *
14198:
1.860 raeburn 14199: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
14200: domain level either on specified domain server ($uhome) or primary domain
14201: server ($udom and $uhome are optional)
1.806 raeburn 14202:
1.943 raeburn 14203: =item *
14204:
1.1172.2.35 raeburn 14205: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
14206: for: authentication, language, quotas, timezone, date locale, and portal URL in
14207: the target domain.
14208:
14209: May also include additional key => value pairs for the following groups:
14210:
14211: =over
14212:
14213: =item
14214: disk quotas (MB allocated by default to portfolios and authoring spaces).
14215:
14216: =over
14217:
14218: =item defaultquota, authorquota
14219:
14220: =back
14221:
14222: =item
14223: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
14224: portfolio for users).
14225:
14226: =over
14227:
14228: =item
14229: aboutme, blog, webdav, portfolio
14230:
14231: =back
14232:
14233: =item
14234: requestcourses: ability to request courses, and how requests are processed.
14235:
14236: =over
14237:
14238: =item
1.1172.2.37 raeburn 14239: official, unofficial, community, textbook
1.1172.2.35 raeburn 14240:
14241: =back
14242:
14243: =item
14244: inststatus: types of institutional affiliation, and order in which they are displayed.
14245:
14246: =over
14247:
14248: =item
1.1172.2.44 raeburn 14249: inststatustypes, inststatusorder, inststatusguest
1.1172.2.35 raeburn 14250:
14251: =back
14252:
14253: =item
14254: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
14255: for course's uploaded content.
14256:
14257: =over
14258:
14259: =item
1.1172.2.68 raeburn 14260: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
14261: communityquota, textbookquota
1.1172.2.35 raeburn 14262:
14263: =back
14264:
14265: =item
14266: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
14267: on your servers.
14268:
14269: =over
14270:
14271: =item
14272: remotesessions, hostedsessions
14273:
14274: =back
14275:
14276: =back
14277:
14278: In cases where a domain coordinator has never used the "Set Domain Configuration"
14279: utility to create a configuration.db file on a domain's primary library server
14280: only the following domain defaults: auth_def, auth_arg_def, lang_def
14281: -- corresponding values are authentication type (internal, krb4, krb5,
14282: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
14283: will be available. Values are retrieved from cache (if current), unless the
14284: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
14285: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
14286:
14287: Typical usage:
1.943 raeburn 14288:
1.1172.2.35 raeburn 14289: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 14290:
1.243 albertel 14291: =back
14292:
14293: =head2 Network Status Functions
14294:
14295: =over 4
1.191 harris41 14296:
14297: =item *
14298:
1.1137 raeburn 14299: dirlist() : return directory list based on URI (first arg).
14300:
14301: Inputs: 1 required, 5 optional.
14302:
14303: =over
14304:
14305: =item
14306: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
14307:
14308: =item
14309: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
14310:
14311: =item
14312: $username - username of user/course to be listed. Extracted from $uri if absent.
14313:
14314: =item
14315: $getpropath - boolean: 1 if prepend path using &propath().
14316:
14317: =item
14318: $getuserdir - boolean: 1 if prepend path for "userfiles".
14319:
14320: =item
14321: $alternateRoot - path to prepend in place of path from $uri.
14322:
14323: =back
14324:
14325: Returns: Array of up to two items.
14326:
14327: =over
14328:
14329: a reference to an array of files/subdirectories
14330:
14331: =over
14332:
14333: Each element in the array of files/subdirectories is a & separated list of
14334: item name and the result of running stat on the item. If dirlist was requested
14335: for a file instead of a directory, the item name will be ''. For a directory
14336: listing, if the item is a metadata file, the element will end &N&M
14337: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
14338: default copyright set (1).
14339:
14340: =back
14341:
14342: a scalar containing error condition (if encountered).
14343:
14344: =over
14345:
14346: =item
14347: no_host (no homeserver identified for $username:$domain).
14348:
14349: =item
14350: no_such_host (server contacted for listing not identified as valid host).
14351:
14352: =item
14353: con_lost (connection to remote server failed).
14354:
14355: =item
14356: refused (invalid $username:$domain received on lond side).
14357:
14358: =item
14359: no_such_dir (directory at specified path on lond side does not exist).
14360:
14361: =item
14362: empty (directory at specified path on lond side is empty).
14363:
14364: =over
14365:
14366: This is currently not encountered because the &ls3, &ls2,
14367: &ls (_handler) routines on the lond side do not filter out
14368: . and .. from a directory listing.
14369:
14370: =back
14371:
14372: =back
14373:
14374: =back
1.191 harris41 14375:
14376: =item *
14377:
1.243 albertel 14378: spareserver() : find server with least workload from spare.tab
14379:
1.986 foxr 14380:
14381: =item *
14382:
14383: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
14384: if there is no corresponding loncapa host.
14385:
1.243 albertel 14386: =back
14387:
1.986 foxr 14388:
1.243 albertel 14389: =head2 Apache Request
14390:
14391: =over 4
1.191 harris41 14392:
14393: =item *
14394:
1.243 albertel 14395: ssi($url,%hash) : server side include, does a complete request cycle on url to
14396: localhost, posts hash
14397:
14398: =back
14399:
14400: =head2 Data to String to Data
14401:
14402: =over 4
1.191 harris41 14403:
14404: =item *
14405:
1.243 albertel 14406: hash2str(%hash) : convert a hash into a string complete with escaping and '='
14407: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 14408:
14409: =item *
14410:
1.243 albertel 14411: hashref2str($hashref) : convert a hashref into a string complete with
14412: escaping and '=' and '&' separators, supports elements that are
14413: arrayrefs and hashrefs
1.191 harris41 14414:
14415: =item *
14416:
1.243 albertel 14417: arrayref2str($arrayref) : convert an arrayref into a string complete
14418: with escaping and '&' separators, supports elements that are arrayrefs
14419: and hashrefs
1.191 harris41 14420:
14421: =item *
14422:
1.243 albertel 14423: str2hash($string) : convert string to hash using unescaping and
14424: splitting on '=' and '&', supports elements that are arrayrefs and
14425: hashrefs
1.191 harris41 14426:
14427: =item *
14428:
1.243 albertel 14429: str2array($string) : convert string to hash using unescaping and
14430: splitting on '&', supports elements that are arrayrefs and hashrefs
14431:
14432: =back
14433:
14434: =head2 Logging Routines
14435:
14436:
14437: These routines allow one to make log messages in the lonnet.log and
14438: lonnet.perm logfiles.
1.191 harris41 14439:
1.1119 foxr 14440: =over 4
14441:
1.191 harris41 14442: =item *
14443:
1.243 albertel 14444: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 14445:
14446: =item *
14447:
1.243 albertel 14448: logthis() : append message to the normal lonnet.log file, it gets
14449: preiodically rolled over and deleted.
1.191 harris41 14450:
14451: =item *
14452:
1.243 albertel 14453: logperm() : append a permanent message to lonnet.perm.log, this log
14454: file never gets deleted by any automated portion of the system, only
14455: messages of critical importance should go in here.
14456:
1.1119 foxr 14457:
1.243 albertel 14458: =back
14459:
14460: =head2 General File Helper Routines
14461:
14462: =over 4
1.191 harris41 14463:
14464: =item *
14465:
1.481 raeburn 14466: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
14467: (a) files in /uploaded
14468: (i) If a local copy of the file exists -
14469: compares modification date of local copy with last-modified date for
14470: definitive version stored on home server for course. If local copy is
14471: stale, requests a new version from the home server and stores it.
14472: If the original has been removed from the home server, then local copy
14473: is unlinked.
14474: (ii) If local copy does not exist -
14475: requests the file from the home server and stores it.
14476:
14477: If $caller is 'uploadrep':
14478: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
14479: for request for files originally uploaded via DOCS.
14480: - returns 'ok' if fresh local copy now available, -1 otherwise.
14481:
14482: Otherwise:
14483: This indicates a call from the content generation phase of the request.
14484: - returns the entire contents of the file or -1.
14485:
14486: (b) files in /res
14487: - returns the entire contents of a file or -1;
14488: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 14489:
1.712 albertel 14490:
14491: =item *
14492:
14493: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
14494: reference
14495:
14496: returns either a stat() list of data about the file or an empty list
14497: if the file doesn't exist or couldn't find out about it (connection
14498: problems or user unknown)
14499:
1.191 harris41 14500: =item *
14501:
1.243 albertel 14502: filelocation($dir,$file) : returns file system location of a file
14503: based on URI; meant to be "fairly clean" absolute reference, $dir is a
14504: directory that relative $file lookups are to looked in ($dir of /a/dir
14505: and a file of ../bob will become /a/bob)
1.191 harris41 14506:
14507: =item *
14508:
14509: hreflocation($dir,$file) : returns file system location or a URL; same as
14510: filelocation except for hrefs
14511:
14512: =item *
14513:
1.1172.2.49 raeburn 14514: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
14515: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 14516:
1.243 albertel 14517: =back
14518:
1.608 albertel 14519: =head2 Usererfile file routines (/uploaded*)
14520:
14521: =over 4
14522:
14523: =item *
14524:
14525: userfileupload(): main rotine for putting a file in a user or course's
14526: filespace, arguments are,
14527:
1.620 albertel 14528: formname - required - this is the name of the element in $env where the
1.608 albertel 14529: filename, and the contents of the file to create/modifed exist
1.620 albertel 14530: the filename is in $env{'form.'.$formname.'.filename'} and the
14531: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 14532: context - if coursedoc, store the file in the course of the active role
14533: of the current user;
14534: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
14535: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 14536: subdir - required - subdirectory to put the file in under ../userfiles/
14537: if undefined, it will be placed in "unknown"
14538:
14539: (This routine calls clean_filename() to remove any dangerous
14540: characters from the filename, and then calls finuserfileupload() to
14541: complete the transaction)
14542:
14543: returns either the url of the uploaded file (/uploaded/....) if successful
14544: and /adm/notfound.html if unsuccessful
14545:
14546: =item *
14547:
14548: clean_filename(): routine for cleaing a filename up for storage in
14549: userfile space, argument is:
14550:
14551: filename - proposed filename
14552:
14553: returns: the new clean filename
14554:
14555: =item *
14556:
1.1090 raeburn 14557: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 14558: userspace, probably shouldn't be called directly
14559:
14560: docuname: username or courseid of destination for the file
14561: docudom: domain of user/course of destination for the file
14562: formname: same as for userfileupload()
1.1090 raeburn 14563: fname: filename (including subdirectories) for the file
14564: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
14565: allfiles: reference to hash used to store objects found by parser
14566: codebase: reference to hash used for codebases of java objects found by parser
14567: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
14568: thumbheight: height (pixels) of thumbnail to be created for uploaded image
14569: resizewidth: width to be used to resize image using resizeImage from ImageMagick
14570: resizeheight: height to be used to resize image using resizeImage from ImageMagick
14571: context: if 'overwrite', will move the uploaded file from its temporary location to
14572: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 14573: mimetype: reference to scalar to accommodate mime type determined
14574: from File::MMagic if $parser = parse.
1.608 albertel 14575:
14576: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 14577: and /adm/notfound.html if unsuccessful (or an error message if context
14578: was 'overwrite').
14579:
1.608 albertel 14580:
14581: =item *
14582:
14583: renameuserfile(): renames an existing userfile to a new name
14584:
14585: Args:
14586: docuname: username or courseid of destination for the file
14587: docudom: domain of user/course of destination for the file
14588: old: current file name (including any subdirs under userfiles)
14589: new: desired file name (including any subdirs under userfiles)
14590:
14591: =item *
14592:
14593: mkdiruserfile(): creates a directory is a userfiles dir
14594:
14595: Args:
14596: docuname: username or courseid of destination for the file
14597: docudom: domain of user/course of destination for the file
14598: dir: dir to create (including any subdirs under userfiles)
14599:
14600: =item *
14601:
14602: removeuserfile(): removes a file that exists in userfiles
14603:
14604: Args:
14605: docuname: username or courseid of destination for the file
14606: docudom: domain of user/course of destination for the file
14607: fname: filname to delete (including any subdirs under userfiles)
14608:
14609: =item *
14610:
14611: removeuploadedurl(): convience function for removeuserfile()
14612:
14613: Args:
14614: url: a full /uploaded/... url to delete
14615:
1.747 albertel 14616: =item *
14617:
14618: get_portfile_permissions():
14619: Args:
14620: domain: domain of user or course contain the portfolio files
14621: user: name of user or num of course contain the portfolio files
14622: Returns:
14623: hashref of a dump of the proper file_permissions.db
14624:
14625:
14626: =item *
14627:
14628: get_access_controls():
14629:
14630: Args:
14631: current_permissions: the hash ref returned from get_portfile_permissions()
14632: group: (optional) the group you want the files associated with
14633: file: (optional) the file you want access info on
14634:
14635: Returns:
1.749 raeburn 14636: a hash (keys are file names) of hashes containing
14637: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
14638: values are XML containing access control settings (see below)
1.747 albertel 14639:
14640: Internal notes:
14641:
1.749 raeburn 14642: access controls are stored in file_permissions.db as key=value pairs.
14643: key -> path to file/file_name\0uniqueID:scope_end_start
14644: where scope -> public,guest,course,group,domains or users.
14645: end -> UNIX time for end of access (0 -> no end date)
14646: start -> UNIX time for start of access
14647:
14648: value -> XML description of access control
14649: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
14650: <start></start>
14651: <end></end>
14652:
14653: <password></password> for scope type = guest
14654:
14655: <domain></domain> for scope type = course or group
14656: <number></number>
14657: <roles id="">
14658: <role></role>
14659: <access></access>
14660: <section></section>
14661: <group></group>
14662: </roles>
14663:
14664: <dom></dom> for scope type = domains
14665:
14666: <users> for scope type = users
14667: <user>
14668: <uname></uname>
14669: <udom></udom>
14670: </user>
14671: </users>
14672: </scope>
14673:
14674: Access data is also aggregated for each file in an additional key=value pair:
14675: key -> path to file/file_name\0accesscontrol
14676: value -> reference to hash
14677: hash contains key = value pairs
14678: where key = uniqueID:scope_end_start
14679: value = UNIX time record was last updated
14680:
14681: Used to improve speed of look-ups of access controls for each file.
14682:
14683: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
14684:
1.1172.2.13 raeburn 14685: =item *
14686:
1.749 raeburn 14687: modify_access_controls():
14688:
14689: Modifies access controls for a portfolio file
14690: Args
14691: 1. file name
14692: 2. reference to hash of required changes,
14693: 3. domain
14694: 4. username
14695: where domain,username are the domain of the portfolio owner
14696: (either a user or a course)
14697:
14698: Returns:
14699: 1. result of additions or updates ('ok' or 'error', with error message).
14700: 2. result of deletions ('ok' or 'error', with error message).
14701: 3. reference to hash of any new or updated access controls.
14702: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
14703: key = integer (inbound ID)
1.1172.2.13 raeburn 14704: value = uniqueID
14705:
14706: =item *
14707:
14708: get_timebased_id():
14709:
14710: Attempts to get a unique timestamp-based suffix for use with items added to a
14711: course via the Course Editor (e.g., folders, composite pages,
14712: group bulletin boards).
14713:
14714: Args: (first three required; six others optional)
14715:
14716: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
14717: docssequence, or name of group
14718:
14719: 2. keyid (alphanumeric): name of temporary locking key in hash,
14720: e.g., num, boardids
14721:
14722: 3. namespace: name of gdbm file used to store suffixes already assigned;
14723: file will be named nohist_namespace.db
14724:
14725: 4. cdom: domain of course; default is current course domain from %env
14726:
14727: 5. cnum: course number; default is current course number from %env
14728:
14729: 6. idtype: set to concat if an additional digit is to be appended to the
14730: unix timestamp to form the suffix, if the plain timestamp is already
14731: in use. Default is to not do this, but simply increment the unix
14732: timestamp by 1 until a unique key is obtained.
14733:
14734: 7. who: holder of locking key; defaults to user:domain for user.
14735:
14736: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
14737: retrying); default is 3.
14738:
14739: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
14740:
14741: Returns:
14742:
14743: 1. suffix obtained (numeric)
14744:
14745: 2. result of deleting locking key (ok if deleted, or lock never obtained)
14746:
14747: 3. error: contains (localized) error message if an error occurred.
14748:
1.747 albertel 14749:
1.608 albertel 14750: =back
14751:
1.243 albertel 14752: =head2 HTTP Helper Routines
14753:
14754: =over 4
14755:
1.191 harris41 14756: =item *
14757:
14758: escape() : unpack non-word characters into CGI-compatible hex codes
14759:
14760: =item *
14761:
14762: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
14763:
1.243 albertel 14764: =back
14765:
14766: =head1 PRIVATE SUBROUTINES
14767:
14768: =head2 Underlying communication routines (Shouldn't call)
14769:
14770: =over 4
14771:
14772: =item *
14773:
14774: subreply() : tries to pass a message to lonc, returns con_lost if incapable
14775:
14776: =item *
14777:
14778: reply() : uses subreply to send a message to remote machine, logs all failures
14779:
14780: =item *
14781:
14782: critical() : passes a critical message to another server; if cannot
14783: get through then place message in connection buffer directory and
14784: returns con_delayed, if incapable of saving message, returns
14785: con_failed
14786:
14787: =item *
14788:
14789: reconlonc() : tries to reconnect lonc client processes.
14790:
14791: =back
14792:
14793: =head2 Resource Access Logging
14794:
14795: =over 4
14796:
14797: =item *
14798:
14799: flushcourselogs() : flush (save) buffer logs and access logs
14800:
14801: =item *
14802:
14803: courselog($what) : save message for course in hash
14804:
14805: =item *
14806:
14807: courseacclog($what) : save message for course using &courselog(). Perform
14808: special processing for specific resource types (problems, exams, quizzes, etc).
14809:
1.191 harris41 14810: =item *
14811:
14812: goodbye() : flush course logs and log shutting down; it is called in srm.conf
14813: as a PerlChildExitHandler
1.243 albertel 14814:
14815: =back
14816:
14817: =head2 Other
14818:
14819: =over 4
14820:
14821: =item *
14822:
14823: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 14824:
14825: =back
14826:
14827: =cut
1.877 foxr 14828:
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