Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1177
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1177 ! raeburn 4: # $Id: lonnet.pm,v 1.1176 2012/05/30 20:29:45 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.1173 foxr 78: use Encode;
79:
1.871 albertel 80: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.1138 raeburn 81: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
82: %managerstab);
1.871 albertel 83:
84: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
85: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
86: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 87: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 88:
1.1 albertel 89: use IO::Socket;
1.31 www 90: use GDBM_File;
1.208 albertel 91: use HTML::LCParser;
1.88 www 92: use Fcntl qw(:flock);
1.870 albertel 93: use Storable qw(thaw nfreeze);
1.539 albertel 94: use Time::HiRes qw( gettimeofday tv_interval );
1.599 albertel 95: use Cache::Memcached;
1.676 albertel 96: use Digest::MD5;
1.790 albertel 97: use Math::Random;
1.1024 raeburn 98: use File::MMagic;
1.807 albertel 99: use LONCAPA qw(:DEFAULT :match);
1.740 www 100: use LONCAPA::Configuration;
1.1160 www 101: use LONCAPA::lonmetadata;
1.1167 droeschl 102: use LONCAPA::Lond;
1.1117 foxr 103:
1.1090 raeburn 104: use File::Copy;
1.676 albertel 105:
1.195 www 106: my $readit;
1.550 foxr 107: my $max_connection_retries = 10; # Or some such value.
1.1 albertel 108:
1.619 albertel 109: require Exporter;
110:
111: our @ISA = qw (Exporter);
112: our @EXPORT = qw(%env);
113:
1.449 matthew 114:
1.1 albertel 115: # --------------------------------------------------------------------- Logging
1.729 www 116: {
117: my $logid;
118: sub instructor_log {
1.957 raeburn 119: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
120: if (($cnum eq '') || ($cdom eq '')) {
121: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
122: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
123: }
1.729 www 124: $logid++;
1.957 raeburn 125: my $now = time();
126: my $id=$now.'00000'.$$.'00000'.$logid;
1.729 www 127: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 128: { $id => {
129: 'exe_uname' => $env{'user.name'},
130: 'exe_udom' => $env{'user.domain'},
1.957 raeburn 131: 'exe_time' => $now,
1.730 www 132: 'exe_ip' => $ENV{'REMOTE_ADDR'},
133: 'delflag' => $delflag,
134: 'logentry' => $storehash,
135: 'uname' => $uname,
136: 'udom' => $udom,
137: }
1.957 raeburn 138: },$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 {
355: my ($lonhost,$name,$id) = @_;
1.1130 raeburn 356: my $response = &reply('devalidatecache:'.&escape($name).':'.&escape($id),$lonhost);
1.1124 raeburn 357: return $response;
358: }
359:
1.1 albertel 360: # -------------------------------------------------- Non-critical communication
361: sub subreply {
362: my ($cmd,$server)=@_;
1.838 albertel 363: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 364: #
365: # With loncnew process trimming, there's a timing hole between lonc server
366: # process exit and the master server picking up the listen on the AF_UNIX
367: # socket. In that time interval, a lock file will exist:
368:
369: my $lockfile=$peerfile.".lock";
370: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
371: sleep(1);
372: }
373: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 374: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 375: #
1.550 foxr 376: # We'll give the connection a few tries before abandoning it. If
377: # connection is not possible, we'll con_lost back to the client.
378: #
379: my $client;
380: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
381: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
382: Type => SOCK_STREAM,
383: Timeout => 10);
1.869 albertel 384: if ($client) {
1.550 foxr 385: last; # Connected!
1.850 albertel 386: } else {
1.853 albertel 387: &create_connection(&hostname($server),$server);
1.550 foxr 388: }
1.850 albertel 389: sleep(1); # Try again later if failed connection.
1.550 foxr 390: }
391: my $answer;
392: if ($client) {
1.704 albertel 393: print $client "sethost:$server:$cmd\n";
1.550 foxr 394: $answer=<$client>;
395: if (!$answer) { $answer="con_lost"; }
396: chomp($answer);
397: } else {
398: $answer = 'con_lost'; # Failed connection.
399: }
1.1 albertel 400: return $answer;
401: }
402:
403: sub reply {
404: my ($cmd,$server)=@_;
1.838 albertel 405: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 406: my $answer=subreply($cmd,$server);
1.65 www 407: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 408: &logthis("<font color=\"blue\">WARNING:".
1.12 www 409: " $cmd to $server returned $answer</font>");
410: }
1.1 albertel 411: return $answer;
412: }
413:
414: # ----------------------------------------------------------- Send USR1 to lonc
415:
416: sub reconlonc {
1.891 albertel 417: my ($lonid) = @_;
418: my $hostname = &hostname($lonid);
419: if ($lonid) {
420: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
421: if ($hostname && -e $peerfile) {
422: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
423: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
424: Type => SOCK_STREAM,
425: Timeout => 10);
426: if ($client) {
427: print $client ("reset_retries\n");
428: my $answer=<$client>;
429: #reset just this one.
430: }
431: }
432: return;
433: }
434:
1.836 www 435: &logthis("Trying to reconnect lonc");
1.1 albertel 436: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 437: if (open(my $fh,"<$loncfile")) {
1.1 albertel 438: my $loncpid=<$fh>;
439: chomp($loncpid);
440: if (kill 0 => $loncpid) {
441: &logthis("lonc at pid $loncpid responding, sending USR1");
442: kill USR1 => $loncpid;
443: sleep 1;
1.836 www 444: } else {
1.12 www 445: &logthis(
1.672 albertel 446: "<font color=\"blue\">WARNING:".
1.12 www 447: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 448: }
449: } else {
1.836 www 450: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 451: }
452: }
453:
454: # ------------------------------------------------------ Critical communication
1.12 www 455:
1.1 albertel 456: sub critical {
457: my ($cmd,$server)=@_;
1.838 albertel 458: unless (&hostname($server)) {
1.672 albertel 459: &logthis("<font color=\"blue\">WARNING:".
1.89 www 460: " Critical message to unknown server ($server)</font>");
461: return 'no_such_host';
462: }
1.1 albertel 463: my $answer=reply($cmd,$server);
464: if ($answer eq 'con_lost') {
465: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 466: my $answer=reply($cmd,$server);
1.1 albertel 467: if ($answer eq 'con_lost') {
468: my $now=time;
469: my $middlename=$cmd;
1.5 www 470: $middlename=substr($middlename,0,16);
1.1 albertel 471: $middlename=~s/\W//g;
472: my $dfilename=
1.305 www 473: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
474: $dumpcount++;
1.1 albertel 475: {
1.448 albertel 476: my $dfh;
477: if (open($dfh,">$dfilename")) {
478: print $dfh "$cmd\n";
479: close($dfh);
480: }
1.1 albertel 481: }
482: sleep 2;
483: my $wcmd='';
484: {
1.448 albertel 485: my $dfh;
486: if (open($dfh,"<$dfilename")) {
487: $wcmd=<$dfh>;
488: close($dfh);
489: }
1.1 albertel 490: }
491: chomp($wcmd);
1.7 www 492: if ($wcmd eq $cmd) {
1.672 albertel 493: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 494: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 495: &logperm("D:$server:$cmd");
496: return 'con_delayed';
497: } else {
1.672 albertel 498: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 499: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 500: &logperm("F:$server:$cmd");
501: return 'con_failed';
502: }
503: }
504: }
505: return $answer;
1.405 albertel 506: }
507:
1.755 albertel 508: # ------------------------------------------- check if return value is an error
509:
510: sub error {
511: my ($result) = @_;
1.756 albertel 512: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 513: if ($2 == 2) { return undef; }
514: return $1;
515: }
516: return undef;
517: }
518:
1.783 albertel 519: sub convert_and_load_session_env {
520: my ($lonidsdir,$handle)=@_;
521: my @profile;
522: {
1.917 albertel 523: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
524: if (!$opened) {
1.915 albertel 525: return 0;
526: }
1.783 albertel 527: flock($idf,LOCK_SH);
528: @profile=<$idf>;
529: close($idf);
530: }
531: my %temp_env;
532: foreach my $line (@profile) {
1.786 albertel 533: if ($line !~ m/=/) {
534: return 0;
535: }
1.783 albertel 536: chomp($line);
537: my ($envname,$envvalue)=split(/=/,$line,2);
538: $temp_env{&unescape($envname)} = &unescape($envvalue);
539: }
540: unlink("$lonidsdir/$handle.id");
541: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
542: 0640)) {
543: %disk_env = %temp_env;
544: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
545: untie(%disk_env);
546: }
1.786 albertel 547: return 1;
1.783 albertel 548: }
549:
1.374 www 550: # ------------------------------------------- Transfer profile into environment
1.780 albertel 551: my $env_loaded;
552: sub transfer_profile_to_env {
1.788 albertel 553: my ($lonidsdir,$handle,$force_transfer) = @_;
554: if (!$force_transfer && $env_loaded) { return; }
1.374 www 555:
1.720 albertel 556: if (!defined($lonidsdir)) {
557: $lonidsdir = $perlvar{'lonIDsDir'};
558: }
559: if (!defined($handle)) {
560: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
561: }
562:
1.786 albertel 563: my $convert;
564: {
1.917 albertel 565: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
566: if (!$opened) {
1.915 albertel 567: return;
568: }
1.786 albertel 569: flock($idf,LOCK_SH);
570: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
571: &GDBM_READER(),0640)) {
572: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
573: untie(%disk_env);
574: } else {
575: $convert = 1;
576: }
577: }
578: if ($convert) {
579: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
580: &logthis("Failed to load session, or convert session.");
581: }
1.374 www 582: }
1.783 albertel 583:
1.786 albertel 584: my %remove;
1.783 albertel 585: while ( my $envname = each(%env) ) {
1.433 matthew 586: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
587: if ($time < time-300) {
1.783 albertel 588: $remove{$key}++;
1.433 matthew 589: }
590: }
591: }
1.783 albertel 592:
1.619 albertel 593: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 594: $env_loaded=1;
1.783 albertel 595: foreach my $expired_key (keys(%remove)) {
1.433 matthew 596: &delenv($expired_key);
1.374 www 597: }
1.1 albertel 598: }
599:
1.916 albertel 600: # ---------------------------------------------------- Check for valid session
601: sub check_for_valid_session {
1.1155 raeburn 602: my ($r,$name) = @_;
1.916 albertel 603: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1155 raeburn 604: if ($name eq '') {
605: $name = 'lonID';
606: }
607: my $lonid=$cookies{$name};
1.916 albertel 608: return undef if (!$lonid);
609:
610: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1155 raeburn 611: my $lonidsdir;
612: if ($name eq 'lonDAV') {
613: $lonidsdir=$r->dir_config('lonDAVsessDir');
614: } else {
615: $lonidsdir=$r->dir_config('lonIDsDir');
616: }
1.916 albertel 617: return undef if (!-e "$lonidsdir/$handle.id");
618:
1.917 albertel 619: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
620: return undef if (!$opened);
1.916 albertel 621:
622: flock($idf,LOCK_SH);
623: my %disk_env;
624: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
625: &GDBM_READER(),0640)) {
626: return undef;
627: }
628:
629: if (!defined($disk_env{'user.name'})
630: || !defined($disk_env{'user.domain'})) {
631: return undef;
632: }
633: return $handle;
634: }
635:
1.830 albertel 636: sub timed_flock {
637: my ($file,$lock_type) = @_;
638: my $failed=0;
639: eval {
640: local $SIG{__DIE__}='DEFAULT';
641: local $SIG{ALRM}=sub {
642: $failed=1;
643: die("failed lock");
644: };
645: alarm(13);
646: flock($file,$lock_type);
647: alarm(0);
648: };
649: if ($failed) {
650: return undef;
651: } else {
652: return 1;
653: }
654: }
655:
1.5 www 656: # ---------------------------------------------------------- Append Environment
657:
658: sub appenv {
1.949 raeburn 659: my ($newenv,$roles) = @_;
660: if (ref($newenv) eq 'HASH') {
661: foreach my $key (keys(%{$newenv})) {
662: my $refused = 0;
663: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
664: $refused = 1;
665: if (ref($roles) eq 'ARRAY') {
666: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
667: if (grep(/^\Q$role\E$/,@{$roles})) {
668: $refused = 0;
669: }
670: }
671: }
672: if ($refused) {
673: &logthis("<font color=\"blue\">WARNING: ".
674: "Attempt to modify environment ".$key." to ".$newenv->{$key}
675: .'</font>');
676: delete($newenv->{$key});
677: } else {
678: $env{$key}=$newenv->{$key};
679: }
680: }
681: my $opened = open(my $env_file,'+<',$env{'user.environment'});
682: if ($opened
683: && &timed_flock($env_file,LOCK_EX)
684: &&
685: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
686: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
687: while (my ($key,$value) = each(%{$newenv})) {
688: $disk_env{$key} = $value;
689: }
690: untie(%disk_env);
1.35 www 691: }
1.191 harris41 692: }
1.56 www 693: return 'ok';
694: }
695: # ----------------------------------------------------- Delete from Environment
696:
697: sub delenv {
1.1104 raeburn 698: my ($delthis,$regexp,$roles) = @_;
699: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
700: my $refused = 1;
701: if (ref($roles) eq 'ARRAY') {
702: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
703: if (grep(/^\Q$role\E$/,@{$roles})) {
704: $refused = 0;
705: }
706: }
707: if ($refused) {
708: &logthis("<font color=\"blue\">WARNING: ".
709: "Attempt to delete from environment ".$delthis);
710: return 'error';
711: }
1.56 www 712: }
1.917 albertel 713: my $opened = open(my $env_file,'+<',$env{'user.environment'});
714: if ($opened
1.915 albertel 715: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 716: &&
717: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
718: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 719: foreach my $key (keys(%disk_env)) {
1.987 raeburn 720: if ($regexp) {
721: if ($key=~/^$delthis/) {
722: delete($env{$key});
723: delete($disk_env{$key});
724: }
725: } else {
726: if ($key=~/^\Q$delthis\E/) {
727: delete($env{$key});
728: delete($disk_env{$key});
729: }
730: }
1.448 albertel 731: }
1.783 albertel 732: untie(%disk_env);
1.5 www 733: }
734: return 'ok';
1.369 albertel 735: }
736:
1.790 albertel 737: sub get_env_multiple {
738: my ($name) = @_;
739: my @values;
740: if (defined($env{$name})) {
741: # exists is it an array
742: if (ref($env{$name})) {
743: @values=@{ $env{$name} };
744: } else {
745: $values[0]=$env{$name};
746: }
747: }
748: return(@values);
749: }
750:
1.958 www 751: # ------------------------------------------------------------------- Locking
752:
753: sub set_lock {
754: my ($text)=@_;
755: $locknum++;
756: my $id=$$.'-'.$locknum;
757: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
758: 'session.lock.'.$id => $text});
759: return $id;
760: }
761:
762: sub get_locks {
763: my $num=0;
764: my %texts=();
765: foreach my $lock (split(/\,/,$env{'session.locks'})) {
766: if ($lock=~/\w/) {
767: $num++;
768: $texts{$lock}=$env{'session.lock.'.$lock};
769: }
770: }
771: return ($num,%texts);
772: }
773:
774: sub remove_lock {
775: my ($id)=@_;
776: my $newlocks='';
777: foreach my $lock (split(/\,/,$env{'session.locks'})) {
778: if (($lock=~/\w/) && ($lock ne $id)) {
779: $newlocks.=','.$lock;
780: }
781: }
782: &appenv({'session.locks' => $newlocks});
783: &delenv('session.lock.'.$id);
784: }
785:
786: sub remove_all_locks {
787: my $activelocks=$env{'session.locks'};
788: foreach my $lock (split(/\,/,$env{'session.locks'})) {
789: if ($lock=~/\w/) {
790: &remove_lock($lock);
791: }
792: }
793: }
794:
795:
1.369 albertel 796: # ------------------------------------------ Find out current server userload
797: sub userload {
798: my $numusers=0;
799: {
800: opendir(LONIDS,$perlvar{'lonIDsDir'});
801: my $filename;
802: my $curtime=time;
803: while ($filename=readdir(LONIDS)) {
1.925 albertel 804: next if ($filename eq '.' || $filename eq '..');
805: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 806: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 807: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 808: }
809: closedir(LONIDS);
810: }
811: my $userloadpercent=0;
812: my $maxuserload=$perlvar{'lonUserLoadLim'};
813: if ($maxuserload) {
1.371 albertel 814: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 815: }
1.372 albertel 816: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 817: return $userloadpercent;
1.283 www 818: }
819:
1.1 albertel 820: # ------------------------------ Find server with least workload from spare.tab
1.11 www 821:
1.1 albertel 822: sub spareserver {
1.1083 raeburn 823: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 824: my $spare_server;
1.370 albertel 825: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 826: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
827: : $userloadpercent;
1.1083 raeburn 828: my ($uint_dom,$remotesessions);
829: if (($udom ne '') && (&domain($udom) ne '')) {
830: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
831: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
832: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
833: $remotesessions = $udomdefaults{'remotesessions'};
834: }
1.1123 raeburn 835: my $spareshash = &this_host_spares($udom);
836: if (ref($spareshash) eq 'HASH') {
837: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
838: foreach my $try_server (@{ $spareshash->{'primary'} }) {
839: if ($uint_dom) {
840: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
841: $try_server));
842: }
843: ($spare_server, $lowest_load) =
844: &compare_server_load($try_server, $spare_server, $lowest_load);
845: }
1.1083 raeburn 846: }
1.784 albertel 847:
1.1123 raeburn 848: my $found_server = ($spare_server ne '' && $lowest_load < 100);
849:
850: if (!$found_server) {
851: if (ref($spareshash->{'default'}) eq 'ARRAY') {
852: foreach my $try_server (@{ $spareshash->{'default'} }) {
853: if ($uint_dom) {
854: next unless (&spare_can_host($udom,$uint_dom,
855: $remotesessions,$try_server));
856: }
857: ($spare_server, $lowest_load) =
858: &compare_server_load($try_server, $spare_server, $lowest_load);
859: }
860: }
861: }
1.784 albertel 862: }
863:
864: if (!$want_server_name) {
1.968 raeburn 865: my $protocol = 'http';
866: if ($protocol{$spare_server} eq 'https') {
867: $protocol = $protocol{$spare_server};
868: }
1.1001 raeburn 869: if (defined($spare_server)) {
870: my $hostname = &hostname($spare_server);
1.1083 raeburn 871: if (defined($hostname)) {
1.1001 raeburn 872: $spare_server = $protocol.'://'.$hostname;
873: }
874: }
1.784 albertel 875: }
876: return $spare_server;
877: }
878:
879: sub compare_server_load {
880: my ($try_server, $spare_server, $lowest_load) = @_;
881:
882: my $loadans = &reply('load', $try_server);
883: my $userloadans = &reply('userload',$try_server);
884:
885: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 886: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 887: }
888:
889: my $load;
890: if ($loadans =~ /\d/) {
891: if ($userloadans =~ /\d/) {
892: #both are numbers, pick the bigger one
893: $load = ($loadans > $userloadans) ? $loadans
894: : $userloadans;
1.411 albertel 895: } else {
1.784 albertel 896: $load = $loadans;
1.411 albertel 897: }
1.784 albertel 898: } else {
899: $load = $userloadans;
900: }
901:
902: if (($load =~ /\d/) && ($load < $lowest_load)) {
903: $spare_server = $try_server;
904: $lowest_load = $load;
1.370 albertel 905: }
1.784 albertel 906: return ($spare_server,$lowest_load);
1.202 matthew 907: }
1.914 albertel 908:
909: # --------------------------- ask offload servers if user already has a session
910: sub find_existing_session {
911: my ($udom,$uname) = @_;
1.1123 raeburn 912: my $spareshash = &this_host_spares($udom);
913: if (ref($spareshash) eq 'HASH') {
914: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
915: foreach my $try_server (@{ $spareshash->{'primary'} }) {
916: return $try_server if (&has_user_session($try_server, $udom, $uname));
917: }
918: }
919: if (ref($spareshash->{'default'}) eq 'ARRAY') {
920: foreach my $try_server (@{ $spareshash->{'default'} }) {
921: return $try_server if (&has_user_session($try_server, $udom, $uname));
922: }
923: }
1.914 albertel 924: }
925: return;
926: }
927:
928: # -------------------------------- ask if server already has a session for user
929: sub has_user_session {
930: my ($lonid,$udom,$uname) = @_;
931: my $result = &reply(join(':','userhassession',
932: map {&escape($_)} ($udom,$uname)),$lonid);
933: return 1 if ($result eq 'ok');
934:
935: return 0;
936: }
937:
1.1076 raeburn 938: # --------- determine least loaded server in a user's domain which allows login
939:
940: sub choose_server {
1.1115 raeburn 941: my ($udom,$checkloginvia) = @_;
1.1076 raeburn 942: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 943: my %servers = &get_servers($udom);
1.1076 raeburn 944: my $lowest_load = 30000;
1.1151 raeburn 945: my ($login_host,$hostname,$portal_path,$isredirect);
1.1076 raeburn 946: foreach my $lonhost (keys(%servers)) {
1.1115 raeburn 947: my $loginvia;
948: if ($checkloginvia) {
949: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 950: if ($loginvia) {
951: my ($server,$path) = split(/:/,$loginvia);
952: ($login_host, $lowest_load) =
953: &compare_server_load($server, $login_host, $lowest_load);
954: if ($login_host eq $server) {
955: $portal_path = $path;
1.1151 raeburn 956: $isredirect = 1;
1.1116 raeburn 957: }
958: } else {
959: ($login_host, $lowest_load) =
960: &compare_server_load($lonhost, $login_host, $lowest_load);
961: if ($login_host eq $lonhost) {
962: $portal_path = '';
1.1151 raeburn 963: $isredirect = '';
1.1116 raeburn 964: }
965: }
966: } else {
1.1076 raeburn 967: ($login_host, $lowest_load) =
1.1116 raeburn 968: &compare_server_load($lonhost, $login_host, $lowest_load);
1.1076 raeburn 969: }
970: }
971: if ($login_host ne '') {
1.1116 raeburn 972: $hostname = &hostname($login_host);
1.1076 raeburn 973: }
1.1151 raeburn 974: return ($login_host,$hostname,$portal_path,$isredirect);
1.1076 raeburn 975: }
976:
1.202 matthew 977: # --------------------------------------------- Try to change a user's password
978:
979: sub changepass {
1.799 raeburn 980: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 981: $currentpass = &escape($currentpass);
982: $newpass = &escape($newpass);
1.1030 raeburn 983: my $lonhost = $perlvar{'lonHostID'};
984: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 985: $server);
986: if (! $answer) {
987: &logthis("No reply on password change request to $server ".
988: "by $uname in domain $udom.");
989: } elsif ($answer =~ "^ok") {
990: &logthis("$uname in $udom successfully changed their password ".
991: "on $server.");
992: } elsif ($answer =~ "^pwchange_failure") {
993: &logthis("$uname in $udom was unable to change their password ".
994: "on $server. The action was blocked by either lcpasswd ".
995: "or pwchange");
996: } elsif ($answer =~ "^non_authorized") {
997: &logthis("$uname in $udom did not get their password correct when ".
998: "attempting to change it on $server.");
999: } elsif ($answer =~ "^auth_mode_error") {
1000: &logthis("$uname in $udom attempted to change their password despite ".
1001: "not being locally or internally authenticated on $server.");
1002: } elsif ($answer =~ "^unknown_user") {
1003: &logthis("$uname in $udom attempted to change their password ".
1004: "on $server but were unable to because $server is not ".
1005: "their home server.");
1006: } elsif ($answer =~ "^refused") {
1007: &logthis("$server refused to change $uname in $udom password because ".
1008: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1009: } elsif ($answer =~ "invalid_client") {
1010: &logthis("$server refused to change $uname in $udom password because ".
1011: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 1012: }
1013: return $answer;
1.1 albertel 1014: }
1015:
1.169 harris41 1016: # ----------------------- Try to determine user's current authentication scheme
1017:
1018: sub queryauthenticate {
1019: my ($uname,$udom)=@_;
1.456 albertel 1020: my $uhome=&homeserver($uname,$udom);
1021: if (!$uhome) {
1022: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1023: return 'no_host';
1024: }
1025: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1026: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1027: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1028: }
1.456 albertel 1029: return $answer;
1.169 harris41 1030: }
1031:
1.1 albertel 1032: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1033:
1.1 albertel 1034: sub authenticate {
1.1073 raeburn 1035: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1036: $upass=&escape($upass);
1037: $uname= &LONCAPA::clean_username($uname);
1.836 www 1038: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1039: my $newhome;
1.836 www 1040: if ((!$uhome) || ($uhome eq 'no_host')) {
1041: # Maybe the machine was offline and only re-appeared again recently?
1042: &reconlonc();
1043: # One more
1.952 raeburn 1044: $uhome=&homeserver($uname,$udom,1);
1045: if (($uhome eq 'no_host') && $checkdefauth) {
1046: if (defined(&domain($udom,'primary'))) {
1047: $newhome=&domain($udom,'primary');
1048: }
1049: if ($newhome ne '') {
1050: $uhome = $newhome;
1051: }
1052: }
1.836 www 1053: if ((!$uhome) || ($uhome eq 'no_host')) {
1054: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1055: return 'no_host';
1056: }
1.1 albertel 1057: }
1.1073 raeburn 1058: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1059: if ($answer eq 'authorized') {
1.952 raeburn 1060: if ($newhome) {
1061: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1062: return 'no_account_on_host';
1063: } else {
1064: &logthis("User $uname at $udom authorized by $uhome");
1065: return $uhome;
1066: }
1.471 albertel 1067: }
1068: if ($answer eq 'non_authorized') {
1069: &logthis("User $uname at $udom rejected by $uhome");
1070: return 'no_host';
1.9 www 1071: }
1.471 albertel 1072: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1073: return 'no_host';
1074: }
1075:
1.1073 raeburn 1076: sub can_host_session {
1.1074 raeburn 1077: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1078: my $canhost = 1;
1.1074 raeburn 1079: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1080: if (ref($remotesessions) eq 'HASH') {
1081: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1082: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1083: $canhost = 0;
1084: } else {
1085: $canhost = 1;
1086: }
1087: }
1088: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1089: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1090: $canhost = 1;
1091: } else {
1092: $canhost = 0;
1093: }
1094: }
1095: if ($canhost) {
1096: if ($remotesessions->{'version'} ne '') {
1097: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1098: if ($reqmajor ne '' && $reqminor ne '') {
1099: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1100: my $major = $1;
1101: my $minor = $2;
1102: if (($major < $reqmajor ) ||
1103: (($major == $reqmajor) && ($minor < $reqminor))) {
1104: $canhost = 0;
1105: }
1106: } else {
1107: $canhost = 0;
1108: }
1109: }
1110: }
1111: }
1112: }
1113: if ($canhost) {
1114: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1115: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1116: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1117: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1118: if (($uint_dom ne '') &&
1119: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1120: $canhost = 0;
1121: } else {
1122: $canhost = 1;
1123: }
1124: }
1125: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1126: if (($uint_dom ne '') &&
1127: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1128: $canhost = 1;
1129: } else {
1130: $canhost = 0;
1131: }
1132: }
1133: }
1134: }
1135: return $canhost;
1136: }
1137:
1.1083 raeburn 1138: sub spare_can_host {
1139: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1140: my $canhost=1;
1141: my @intdoms;
1142: my $internet_names = &Apache::lonnet::get_internet_names($try_server);
1143: if (ref($internet_names) eq 'ARRAY') {
1144: @intdoms = @{$internet_names};
1145: }
1146: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1147: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
1148: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1149: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
1150: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
1151: $canhost = &can_host_session($udom,$try_server,$remoterev,
1152: $remotesessions,
1153: $defdomdefaults{'hostedsessions'});
1154: }
1155: return $canhost;
1156: }
1157:
1.1123 raeburn 1158: sub this_host_spares {
1159: my ($dom) = @_;
1.1126 raeburn 1160: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1161: my @hosts = ¤t_machine_ids();
1162: foreach my $lonhost (@hosts) {
1163: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1164: $dom_in_use = $dom;
1165: $lonhost_in_use = $lonhost;
1.1123 raeburn 1166: last;
1167: }
1168: }
1.1126 raeburn 1169: if ($dom_in_use ne '') {
1170: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1171: }
1172: if (ref($result) ne 'HASH') {
1173: $lonhost_in_use = $perlvar{'lonHostID'};
1174: $dom_in_use = &host_domain($lonhost_in_use);
1175: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1176: if (ref($result) ne 'HASH') {
1177: $result = \%spareid;
1178: }
1179: }
1180: return $result;
1181: }
1182:
1183: sub spares_for_offload {
1184: my ($dom_in_use,$lonhost_in_use) = @_;
1185: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1186: if (defined($cached)) {
1187: return $result;
1188: } else {
1.1126 raeburn 1189: my $cachetime = 60*60*24;
1190: my %domconfig =
1191: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1192: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1193: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1194: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1195: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1196: }
1197: }
1198: }
1199: }
1.1126 raeburn 1200: return;
1.1123 raeburn 1201: }
1202:
1.1129 raeburn 1203: sub get_lonbalancer_config {
1204: my ($servers) = @_;
1205: my ($currbalancer,$currtargets);
1206: if (ref($servers) eq 'HASH') {
1207: foreach my $server (keys(%{$servers})) {
1208: my %what = (
1209: spareid => 1,
1210: perlvar => 1,
1211: );
1212: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1213: if ($result eq 'ok') {
1214: if (ref($returnhash) eq 'HASH') {
1215: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1216: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1217: $currbalancer = $server;
1218: $currtargets = {};
1219: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1220: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1221: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1222: }
1223: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1224: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1225: }
1226: }
1227: last;
1228: }
1229: }
1230: }
1231: }
1232: }
1233: }
1234: return ($currbalancer,$currtargets);
1235: }
1236:
1237: sub check_loadbalancing {
1238: my ($uname,$udom) = @_;
1239: my ($is_balancer,$dom_in_use,$homeintdom,$rule_in_effect,
1240: $offloadto,$otherserver);
1241: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1242: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1243: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1244: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1245: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1246: my $serverhomedom = &host_domain($lonhost);
1247:
1248: my $cachetime = 60*60*24;
1249:
1250: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1251: $dom_in_use = $udom;
1252: $homeintdom = 1;
1253: } else {
1254: $dom_in_use = $serverhomedom;
1255: }
1256: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1257: unless (defined($cached)) {
1258: my %domconfig =
1259: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1260: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1261: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129 raeburn 1262: }
1263: }
1264: if (ref($result) eq 'HASH') {
1265: my $currbalancer = $result->{'lonhost'};
1266: my $currtargets = $result->{'targets'};
1267: my $currrules = $result->{'rules'};
1268: if ($currbalancer ne '') {
1269: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1270: $is_balancer = 1;
1271: }
1272: }
1273: if ($is_balancer) {
1274: if (ref($currrules) eq 'HASH') {
1275: if ($homeintdom) {
1276: if ($uname ne '') {
1277: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1278: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1279: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1280: $rule_in_effect = $currrules->{'_LC_author'};
1281: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1282: $rule_in_effect = $currrules->{'_LC_adv'}
1283: }
1284: }
1285: if ($rule_in_effect eq '') {
1286: my %userenv = &userenvironment($udom,$uname,'inststatus');
1287: if ($userenv{'inststatus'} ne '') {
1288: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1289: my ($othertitle,$usertypes,$types) =
1290: &Apache::loncommon::sorted_inst_types($udom);
1291: if (ref($types) eq 'ARRAY') {
1292: foreach my $type (@{$types}) {
1293: if (grep(/^\Q$type\E$/,@statuses)) {
1294: if (exists($currrules->{$type})) {
1295: $rule_in_effect = $currrules->{$type};
1296: }
1297: }
1298: }
1299: }
1300: } else {
1301: if (exists($currrules->{'default'})) {
1302: $rule_in_effect = $currrules->{'default'};
1303: }
1304: }
1305: }
1306: } else {
1307: if (exists($currrules->{'default'})) {
1308: $rule_in_effect = $currrules->{'default'};
1309: }
1310: }
1311: } else {
1312: if ($currrules->{'_LC_external'} ne '') {
1313: $rule_in_effect = $currrules->{'_LC_external'};
1314: }
1315: }
1316: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1317: $uname,$udom);
1318: }
1319: }
1320: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1321: my ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1322: unless (defined($cached)) {
1323: my %domconfig =
1324: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1325: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1326: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129 raeburn 1327: }
1328: }
1329: if (ref($result) eq 'HASH') {
1330: my $currbalancer = $result->{'lonhost'};
1331: my $currtargets = $result->{'targets'};
1332: my $currrules = $result->{'rules'};
1333:
1334: if ($currbalancer eq $lonhost) {
1335: $is_balancer = 1;
1336: if (ref($currrules) eq 'HASH') {
1337: if ($currrules->{'_LC_internetdom'} ne '') {
1338: $rule_in_effect = $currrules->{'_LC_internetdom'};
1339: }
1340: }
1341: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1342: $uname,$udom);
1343: }
1344: } else {
1345: if ($perlvar{'lonBalancer'} eq 'yes') {
1346: $is_balancer = 1;
1347: $offloadto = &this_host_spares($dom_in_use);
1348: }
1349: }
1350: } else {
1351: if ($perlvar{'lonBalancer'} eq 'yes') {
1352: $is_balancer = 1;
1353: $offloadto = &this_host_spares($dom_in_use);
1354: }
1355: }
1.1176 raeburn 1356: if ($is_balancer) {
1357: my $lowest_load = 30000;
1358: if (ref($offloadto) eq 'HASH') {
1359: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1360: foreach my $try_server (@{$offloadto->{'primary'}}) {
1361: ($otherserver,$lowest_load) =
1362: &compare_server_load($try_server,$otherserver,$lowest_load);
1363: }
1.1129 raeburn 1364: }
1.1176 raeburn 1365: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1366:
1.1176 raeburn 1367: if (!$found_server) {
1368: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1369: foreach my $try_server (@{$offloadto->{'default'}}) {
1370: ($otherserver,$lowest_load) =
1371: &compare_server_load($try_server,$otherserver,$lowest_load);
1372: }
1373: }
1374: }
1375: } elsif (ref($offloadto) eq 'ARRAY') {
1376: if (@{$offloadto} == 1) {
1377: $otherserver = $offloadto->[0];
1378: } elsif (@{$offloadto} > 1) {
1379: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1380: ($otherserver,$lowest_load) =
1381: &compare_server_load($try_server,$otherserver,$lowest_load);
1382: }
1383: }
1384: }
1.1176 raeburn 1385: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1386: $is_balancer = 0;
1387: if ($uname ne '' && $udom ne '') {
1388: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1389:
1390: &appenv({'user.loadbalexempt' => $lonhost,
1391: 'user.loadbalcheck.time' => time});
1392: }
1.1129 raeburn 1393: }
1394: }
1395: }
1396: return ($is_balancer,$otherserver);
1397: }
1398:
1399: sub get_loadbalancer_targets {
1400: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1401: my $offloadto;
1.1175 raeburn 1402: if ($rule_in_effect eq 'none') {
1403: return [$perlvar{'lonHostID'}];
1404: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1405: $offloadto = $currtargets;
1406: } else {
1407: if ($rule_in_effect eq 'homeserver') {
1408: my $homeserver = &homeserver($uname,$udom);
1409: if ($homeserver ne 'no_host') {
1410: $offloadto = [$homeserver];
1411: }
1412: } elsif ($rule_in_effect eq 'externalbalancer') {
1413: my %domconfig =
1414: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1415: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1416: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1417: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1418: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1419: }
1420: }
1421: } else {
1422: my %servers = &dom_servers($udom);
1423: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1424: if (&hostname($remotebalancer) ne '') {
1425: $offloadto = [$remotebalancer];
1426: }
1427: }
1428: } elsif (&hostname($rule_in_effect) ne '') {
1429: $offloadto = [$rule_in_effect];
1430: }
1431: }
1432: return $offloadto;
1433: }
1434:
1.1127 raeburn 1435: sub internet_dom_servers {
1436: my ($dom) = @_;
1437: my (%uniqservers,%servers);
1438: my $primaryserver = &hostname(&domain($dom,'primary'));
1439: my @machinedoms = &machine_domains($primaryserver);
1440: foreach my $mdom (@machinedoms) {
1441: my %currservers = %servers;
1442: my %server = &get_servers($mdom);
1443: %servers = (%currservers,%server);
1444: }
1445: my %by_hostname;
1446: foreach my $id (keys(%servers)) {
1447: push(@{$by_hostname{$servers{$id}}},$id);
1448: }
1449: foreach my $hostname (sort(keys(%by_hostname))) {
1450: if (@{$by_hostname{$hostname}} > 1) {
1451: my $match = 0;
1452: foreach my $id (@{$by_hostname{$hostname}}) {
1453: if (&host_domain($id) eq $dom) {
1454: $uniqservers{$id} = $hostname;
1455: $match = 1;
1456: }
1457: }
1458: unless ($match) {
1459: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1460: }
1461: } else {
1462: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1463: }
1464: }
1465: return %uniqservers;
1466: }
1467:
1.1 albertel 1468: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1469:
1.599 albertel 1470: my %homecache;
1.1 albertel 1471: sub homeserver {
1.230 stredwic 1472: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1473: my $index="$uname:$udom";
1.426 albertel 1474:
1.599 albertel 1475: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1476:
1477: my %servers = &get_servers($udom,'library');
1478: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1479: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1480: exists($badServerCache{$tryserver}));
1.841 albertel 1481:
1482: my $answer=reply("home:$udom:$uname",$tryserver);
1483: if ($answer eq 'found') {
1484: delete($badServerCache{$tryserver});
1485: return $homecache{$index}=$tryserver;
1486: } elsif ($answer eq 'no_host') {
1487: $badServerCache{$tryserver}=1;
1488: }
1.1 albertel 1489: }
1490: return 'no_host';
1.70 www 1491: }
1492:
1493: # ------------------------------------- Find the usernames behind a list of IDs
1494:
1495: sub idget {
1496: my ($udom,@ids)=@_;
1497: my %returnhash=();
1498:
1.841 albertel 1499: my %servers = &get_servers($udom,'library');
1500: foreach my $tryserver (keys(%servers)) {
1501: my $idlist=join('&',@ids);
1502: $idlist=~tr/A-Z/a-z/;
1503: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1504: my @answer=();
1505: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1506: @answer=split(/\&/,$reply);
1507: } ;
1508: my $i;
1509: for ($i=0;$i<=$#ids;$i++) {
1510: if ($answer[$i]) {
1511: $returnhash{$ids[$i]}=$answer[$i];
1512: }
1513: }
1514: }
1.70 www 1515: return %returnhash;
1516: }
1517:
1518: # ------------------------------------- Find the IDs behind a list of usernames
1519:
1520: sub idrget {
1521: my ($udom,@unames)=@_;
1522: my %returnhash=();
1.800 albertel 1523: foreach my $uname (@unames) {
1524: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1525: }
1.70 www 1526: return %returnhash;
1527: }
1528:
1529: # ------------------------------- Store away a list of names and associated IDs
1530:
1531: sub idput {
1532: my ($udom,%ids)=@_;
1533: my %servers=();
1.800 albertel 1534: foreach my $uname (keys(%ids)) {
1535: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1536: my $uhom=&homeserver($uname,$udom);
1.70 www 1537: if ($uhom ne 'no_host') {
1.800 albertel 1538: my $id=&escape($ids{$uname});
1.70 www 1539: $id=~tr/A-Z/a-z/;
1.800 albertel 1540: my $esc_unam=&escape($uname);
1.70 www 1541: if ($servers{$uhom}) {
1.800 albertel 1542: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 1543: } else {
1.800 albertel 1544: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 1545: }
1546: }
1.191 harris41 1547: }
1.800 albertel 1548: foreach my $server (keys(%servers)) {
1549: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 1550: }
1.344 www 1551: }
1552:
1.1023 raeburn 1553: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 1554: sub dump_dom {
1.1165 droeschl 1555: my ($namespace, $udom, $regexp) = @_;
1556:
1557: $udom ||= $env{'user.domain'};
1558:
1559: return () unless $udom;
1560:
1561: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 1562: }
1563:
1.1023 raeburn 1564: # ------------------------------------------ get items from domain db files
1.806 raeburn 1565:
1566: sub get_dom {
1.860 raeburn 1567: my ($namespace,$storearr,$udom,$uhome)=@_;
1.806 raeburn 1568: my $items='';
1569: foreach my $item (@$storearr) {
1570: $items.=&escape($item).'&';
1571: }
1572: $items=~s/\&$//;
1.860 raeburn 1573: if (!$udom) {
1574: $udom=$env{'user.domain'};
1575: if (defined(&domain($udom,'primary'))) {
1576: $uhome=&domain($udom,'primary');
1577: } else {
1.874 albertel 1578: undef($uhome);
1.860 raeburn 1579: }
1580: } else {
1581: if (!$uhome) {
1582: if (defined(&domain($udom,'primary'))) {
1583: $uhome=&domain($udom,'primary');
1584: }
1585: }
1586: }
1587: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1588: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 1589: my %returnhash;
1.875 albertel 1590: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1591: return %returnhash;
1592: }
1.806 raeburn 1593: my @pairs=split(/\&/,$rep);
1594: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1595: return @pairs;
1596: }
1597: my $i=0;
1598: foreach my $item (@$storearr) {
1599: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1600: $i++;
1601: }
1602: return %returnhash;
1603: } else {
1.880 banghart 1604: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1605: }
1606: }
1607:
1608: # -------------------------------------------- put items in domain db files
1609:
1610: sub put_dom {
1.860 raeburn 1611: my ($namespace,$storehash,$udom,$uhome)=@_;
1612: if (!$udom) {
1613: $udom=$env{'user.domain'};
1614: if (defined(&domain($udom,'primary'))) {
1615: $uhome=&domain($udom,'primary');
1616: } else {
1.874 albertel 1617: undef($uhome);
1.860 raeburn 1618: }
1619: } else {
1620: if (!$uhome) {
1621: if (defined(&domain($udom,'primary'))) {
1622: $uhome=&domain($udom,'primary');
1623: }
1624: }
1625: }
1626: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1627: my $items='';
1628: foreach my $item (keys(%$storehash)) {
1629: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1630: }
1631: $items=~s/\&$//;
1632: return &reply("putdom:$udom:$namespace:$items",$uhome);
1633: } else {
1.860 raeburn 1634: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1635: }
1636: }
1637:
1.1023 raeburn 1638: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 1639: sub newput_dom {
1.1023 raeburn 1640: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 1641: my $result;
1642: if (!$udom) {
1643: $udom=$env{'user.domain'};
1644: }
1.1023 raeburn 1645: if ($udom) {
1646: my $uname = &get_domainconfiguser($udom);
1647: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 1648: }
1649: return $result;
1650: }
1651:
1.1023 raeburn 1652: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 1653: sub del_dom {
1.1023 raeburn 1654: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 1655: if (ref($storearr) eq 'ARRAY') {
1656: if (!$udom) {
1657: $udom=$env{'user.domain'};
1658: }
1.1023 raeburn 1659: if ($udom) {
1660: my $uname = &get_domainconfiguser($udom);
1661: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 1662: }
1663: }
1664: }
1665:
1.1023 raeburn 1666: # ----------------------------------construct domainconfig user for a domain
1667: sub get_domainconfiguser {
1668: my ($udom) = @_;
1669: return $udom.'-domainconfig';
1670: }
1671:
1.837 raeburn 1672: sub retrieve_inst_usertypes {
1673: my ($udom) = @_;
1674: my (%returnhash,@order);
1.989 raeburn 1675: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1676: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1677: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1678: %returnhash = %{$domdefs{'inststatustypes'}};
1679: @order = @{$domdefs{'inststatusorder'}};
1680: } else {
1681: if (defined(&domain($udom,'primary'))) {
1682: my $uhome=&domain($udom,'primary');
1683: my $rep=&reply("inst_usertypes:$udom",$uhome);
1684: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1685: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1686: return (\%returnhash,\@order);
1687: }
1688: my ($hashitems,$orderitems) = split(/:/,$rep);
1689: my @pairs=split(/\&/,$hashitems);
1690: foreach my $item (@pairs) {
1691: my ($key,$value)=split(/=/,$item,2);
1692: $key = &unescape($key);
1693: next if ($key =~ /^error: 2 /);
1694: $returnhash{$key}=&thaw_unescape($value);
1695: }
1696: my @esc_order = split(/\&/,$orderitems);
1697: foreach my $item (@esc_order) {
1698: push(@order,&unescape($item));
1699: }
1700: } else {
1701: &logthis("get_dom failed - no primary domain server for $udom");
1.837 raeburn 1702: }
1703: }
1704: return (\%returnhash,\@order);
1705: }
1706:
1.868 raeburn 1707: sub is_domainimage {
1708: my ($url) = @_;
1709: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1710: if (&domain($1) ne '') {
1711: return '1';
1712: }
1713: }
1714: return;
1715: }
1716:
1.899 raeburn 1717: sub inst_directory_query {
1718: my ($srch) = @_;
1719: my $udom = $srch->{'srchdomain'};
1720: my %results;
1721: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1722: my $outcome;
1.899 raeburn 1723: if ($homeserver ne '') {
1.904 albertel 1724: my $queryid=&reply("querysend:instdirsearch:".
1725: &escape($srch->{'srchby'}).':'.
1726: &escape($srch->{'srchterm'}).':'.
1727: &escape($srch->{'srchtype'}),$homeserver);
1728: my $host=&hostname($homeserver);
1729: if ($queryid !~/^\Q$host\E\_/) {
1730: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1731: return;
1732: }
1733: my $response = &get_query_reply($queryid);
1734: my $maxtries = 5;
1735: my $tries = 1;
1736: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1737: $response = &get_query_reply($queryid);
1738: $tries ++;
1739: }
1740:
1741: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1742: if ($response eq 'unavailable') {
1743: $outcome = $response;
1744: } else {
1745: $outcome = 'ok';
1746: my @matches = split(/\n/,$response);
1747: foreach my $match (@matches) {
1748: my ($key,$value) = split(/=/,$match);
1749: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1750: }
1.899 raeburn 1751: }
1752: }
1753: }
1.909 raeburn 1754: return ($outcome,%results);
1.899 raeburn 1755: }
1756:
1757: sub usersearch {
1758: my ($srch) = @_;
1759: my $dom = $srch->{'srchdomain'};
1760: my %results;
1761: my %libserv = &all_library();
1762: my $query = 'usersearch';
1763: foreach my $tryserver (keys(%libserv)) {
1764: if (&host_domain($tryserver) eq $dom) {
1765: my $host=&hostname($tryserver);
1766: my $queryid=
1.911 raeburn 1767: &reply("querysend:".&escape($query).':'.
1768: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1769: &escape($srch->{'srchtype'}).':'.
1770: &escape($srch->{'srchterm'}),$tryserver);
1771: if ($queryid !~/^\Q$host\E\_/) {
1772: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1773: next;
1.899 raeburn 1774: }
1775: my $reply = &get_query_reply($queryid);
1776: my $maxtries = 1;
1777: my $tries = 1;
1778: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1779: $reply = &get_query_reply($queryid);
1780: $tries ++;
1781: }
1782: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1783: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1784: } else {
1.911 raeburn 1785: my @matches;
1786: if ($reply =~ /\n/) {
1787: @matches = split(/\n/,$reply);
1788: } else {
1789: @matches = split(/\&/,$reply);
1790: }
1.899 raeburn 1791: foreach my $match (@matches) {
1792: my ($uname,$udom,%userhash);
1.911 raeburn 1793: foreach my $entry (split(/:/,$match)) {
1794: my ($key,$value) =
1795: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1796: $userhash{$key} = $value;
1797: if ($key eq 'username') {
1798: $uname = $value;
1799: } elsif ($key eq 'domain') {
1800: $udom = $value;
1.911 raeburn 1801: }
1.899 raeburn 1802: }
1803: $results{$uname.':'.$udom} = \%userhash;
1804: }
1805: }
1806: }
1807: }
1808: return %results;
1809: }
1810:
1.912 raeburn 1811: sub get_instuser {
1812: my ($udom,$uname,$id) = @_;
1813: my $homeserver = &domain($udom,'primary');
1814: my ($outcome,%results);
1815: if ($homeserver ne '') {
1816: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1817: &escape($id).':'.&escape($udom),$homeserver);
1818: my $host=&hostname($homeserver);
1819: if ($queryid !~/^\Q$host\E\_/) {
1820: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1821: return;
1822: }
1823: my $response = &get_query_reply($queryid);
1824: my $maxtries = 5;
1825: my $tries = 1;
1826: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1827: $response = &get_query_reply($queryid);
1828: $tries ++;
1829: }
1830: if (!&error($response) && $response ne 'refused') {
1831: if ($response eq 'unavailable') {
1832: $outcome = $response;
1833: } else {
1834: $outcome = 'ok';
1835: my @matches = split(/\n/,$response);
1836: foreach my $match (@matches) {
1837: my ($key,$value) = split(/=/,$match);
1838: $results{&unescape($key)} = &thaw_unescape($value);
1839: }
1840: }
1841: }
1842: }
1843: my %userinfo;
1844: if (ref($results{$uname}) eq 'HASH') {
1845: %userinfo = %{$results{$uname}};
1846: }
1847: return ($outcome,%userinfo);
1848: }
1849:
1850: sub inst_rulecheck {
1.923 raeburn 1851: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 1852: my %returnhash;
1853: if ($udom ne '') {
1854: if (ref($rules) eq 'ARRAY') {
1855: @{$rules} = map {&escape($_);} (@{$rules});
1856: my $rulestr = join(':',@{$rules});
1857: my $homeserver=&domain($udom,'primary');
1858: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1859: my $response;
1860: if ($item eq 'username') {
1861: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1862: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 1863: $homeserver));
1.923 raeburn 1864: } elsif ($item eq 'id') {
1865: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1866: ':'.&escape($id).':'.$rulestr,
1867: $homeserver));
1.945 raeburn 1868: } elsif ($item eq 'selfcreate') {
1869: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 1870: &escape($udom).':'.&escape($uname).
1871: ':'.$rulestr,$homeserver));
1.923 raeburn 1872: }
1.912 raeburn 1873: if ($response ne 'refused') {
1874: my @pairs=split(/\&/,$response);
1875: foreach my $item (@pairs) {
1876: my ($key,$value)=split(/=/,$item,2);
1877: $key = &unescape($key);
1878: next if ($key =~ /^error: 2 /);
1879: $returnhash{$key}=&thaw_unescape($value);
1880: }
1881: }
1882: }
1883: }
1884: }
1885: return %returnhash;
1886: }
1887:
1888: sub inst_userrules {
1.923 raeburn 1889: my ($udom,$check) = @_;
1.912 raeburn 1890: my (%ruleshash,@ruleorder);
1891: if ($udom ne '') {
1892: my $homeserver=&domain($udom,'primary');
1893: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1894: my $response;
1895: if ($check eq 'id') {
1896: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 1897: $homeserver);
1.943 raeburn 1898: } elsif ($check eq 'email') {
1899: $response=&reply('instemailrules:'.&escape($udom),
1900: $homeserver);
1.923 raeburn 1901: } else {
1902: $response=&reply('instuserrules:'.&escape($udom),
1903: $homeserver);
1904: }
1.912 raeburn 1905: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 1906: ($response ne 'unknown_cmd') &&
1.912 raeburn 1907: ($response ne 'no_such_host')) {
1908: my ($hashitems,$orderitems) = split(/:/,$response);
1909: my @pairs=split(/\&/,$hashitems);
1910: foreach my $item (@pairs) {
1911: my ($key,$value)=split(/=/,$item,2);
1912: $key = &unescape($key);
1913: next if ($key =~ /^error: 2 /);
1914: $ruleshash{$key}=&thaw_unescape($value);
1915: }
1916: my @esc_order = split(/\&/,$orderitems);
1917: foreach my $item (@esc_order) {
1918: push(@ruleorder,&unescape($item));
1919: }
1920: }
1921: }
1922: }
1923: return (\%ruleshash,\@ruleorder);
1924: }
1925:
1.976 raeburn 1926: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 1927:
1928: sub get_domain_defaults {
1929: my ($domain) = @_;
1930: my $cachetime = 60*60*24;
1931: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1932: if (defined($cached)) {
1933: if (ref($result) eq 'HASH') {
1934: return %{$result};
1935: }
1936: }
1937: my %domdefaults;
1938: my %domconfig =
1.989 raeburn 1939: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 1940: 'requestcourses','inststatus',
1.1073 raeburn 1941: 'coursedefaults','usersessions'],$domain);
1.943 raeburn 1942: if (ref($domconfig{'defaults'}) eq 'HASH') {
1943: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1944: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1945: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 1946: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 1947: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 1948: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.943 raeburn 1949: } else {
1950: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1951: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1952: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1953: }
1.976 raeburn 1954: if (ref($domconfig{'quotas'}) eq 'HASH') {
1955: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1956: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1957: } else {
1958: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1959: }
1.1177 ! raeburn 1960: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 1961: foreach my $item (@usertools) {
1962: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1963: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1964: }
1965: }
1966: }
1.985 raeburn 1967: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1006 raeburn 1968: foreach my $item ('official','unofficial','community') {
1.985 raeburn 1969: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1970: }
1971: }
1.989 raeburn 1972: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1973: foreach my $item ('inststatustypes','inststatusorder') {
1974: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1975: }
1976: }
1.1047 raeburn 1977: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1978: foreach my $item ('canuse_pdfforms') {
1979: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1980: }
1981: }
1.1073 raeburn 1982: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1983: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
1984: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
1985: }
1986: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
1987: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
1988: }
1989: }
1.943 raeburn 1990: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1991: $cachetime);
1992: return %domdefaults;
1993: }
1994:
1.344 www 1995: # --------------------------------------------------- Assign a key to a student
1996:
1997: sub assign_access_key {
1.364 www 1998: #
1999: # a valid key looks like uname:udom#comments
2000: # comments are being appended
2001: #
1.498 www 2002: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2003: $kdom=
1.620 albertel 2004: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2005: $knum=
1.620 albertel 2006: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2007: $cdom=
1.620 albertel 2008: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2009: $cnum=
1.620 albertel 2010: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2011: $udom=$env{'user.name'} unless (defined($udom));
2012: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2013: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2014: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2015: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2016: # assigned to this person
2017: # - this should not happen,
1.345 www 2018: # unless something went wrong
2019: # the first time around
2020: # ready to assign
1.364 www 2021: $logentry=$1.'; '.$logentry;
1.496 www 2022: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2023: $kdom,$knum) eq 'ok') {
1.345 www 2024: # key now belongs to user
1.346 www 2025: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2026: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2027: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2028: return 'ok';
2029: } else {
2030: return
2031: 'error: Count not permanently assign key, will need to be re-entered later.';
2032: }
2033: } else {
2034: return 'error: Could not assign key, try again later.';
2035: }
1.364 www 2036: } elsif (!$existing{$ckey}) {
1.345 www 2037: # the key does not exist
2038: return 'error: The key does not exist';
2039: } else {
2040: # the key is somebody else's
2041: return 'error: The key is already in use';
2042: }
1.344 www 2043: }
2044:
1.364 www 2045: # ------------------------------------------ put an additional comment on a key
2046:
2047: sub comment_access_key {
2048: #
2049: # a valid key looks like uname:udom#comments
2050: # comments are being appended
2051: #
2052: my ($ckey,$cdom,$cnum,$logentry)=@_;
2053: $cdom=
1.620 albertel 2054: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2055: $cnum=
1.620 albertel 2056: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2057: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2058: if ($existing{$ckey}) {
2059: $existing{$ckey}.='; '.$logentry;
2060: # ready to assign
1.367 www 2061: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2062: $cdom,$cnum) eq 'ok') {
2063: return 'ok';
2064: } else {
2065: return 'error: Count not store comment.';
2066: }
2067: } else {
2068: # the key does not exist
2069: return 'error: The key does not exist';
2070: }
2071: }
2072:
1.344 www 2073: # ------------------------------------------------------ Generate a set of keys
2074:
2075: sub generate_access_keys {
1.364 www 2076: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2077: $cdom=
1.620 albertel 2078: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2079: $cnum=
1.620 albertel 2080: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2081: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2082: unless (($cdom) && ($cnum)) { return 0; }
2083: if ($number>10000) { return 0; }
2084: sleep(2); # make sure don't get same seed twice
2085: srand(time()^($$+($$<<15))); # from "Programming Perl"
2086: my $total=0;
2087: for (my $i=1;$i<=$number;$i++) {
2088: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2089: sprintf("%lx",int(100000*rand)).'-'.
2090: sprintf("%lx",int(100000*rand));
2091: $newkey=~s/1/g/g; # folks mix up 1 and l
2092: $newkey=~s/0/h/g; # and also 0 and O
2093: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2094: if ($existing{$newkey}) {
2095: $i--;
2096: } else {
1.364 www 2097: if (&put('accesskeys',
2098: { $newkey => '# generated '.localtime().
1.620 albertel 2099: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 2100: '; '.$logentry },
2101: $cdom,$cnum) eq 'ok') {
1.344 www 2102: $total++;
2103: }
2104: }
2105: }
1.620 albertel 2106: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 2107: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2108: return $total;
2109: }
2110:
2111: # ------------------------------------------------------- Validate an accesskey
2112:
2113: sub validate_access_key {
2114: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2115: $cdom=
1.620 albertel 2116: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2117: $cnum=
1.620 albertel 2118: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2119: $udom=$env{'user.domain'} unless (defined($udom));
2120: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 2121: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 2122: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 2123: }
2124:
2125: # ------------------------------------- Find the section of student in a course
1.652 albertel 2126: sub devalidate_getsection_cache {
2127: my ($udom,$unam,$courseid)=@_;
2128: my $hashid="$udom:$unam:$courseid";
2129: &devalidate_cache_new('getsection',$hashid);
2130: }
1.298 matthew 2131:
1.815 albertel 2132: sub courseid_to_courseurl {
2133: my ($courseid) = @_;
2134: #already url style courseid
2135: return $courseid if ($courseid =~ m{^/});
2136:
2137: if (exists($env{'course.'.$courseid.'.num'})) {
2138: my $cnum = $env{'course.'.$courseid.'.num'};
2139: my $cdom = $env{'course.'.$courseid.'.domain'};
2140: return "/$cdom/$cnum";
2141: }
2142:
2143: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2144: if (exists($courseinfo{'num'})) {
2145: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2146: }
2147:
2148: return undef;
2149: }
2150:
1.298 matthew 2151: sub getsection {
2152: my ($udom,$unam,$courseid)=@_;
1.599 albertel 2153: my $cachetime=1800;
1.551 albertel 2154:
2155: my $hashid="$udom:$unam:$courseid";
1.599 albertel 2156: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 2157: if (defined($cached)) { return $result; }
2158:
1.298 matthew 2159: my %Pending;
2160: my %Expired;
2161: #
2162: # Each role can either have not started yet (pending), be active,
2163: # or have expired.
2164: #
2165: # If there is an active role, we are done.
2166: #
2167: # If there is more than one role which has not started yet,
2168: # choose the one which will start sooner
2169: # If there is one role which has not started yet, return it.
2170: #
2171: # If there is more than one expired role, choose the one which ended last.
2172: # If there is a role which has expired, return it.
2173: #
1.815 albertel 2174: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 2175: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 2176: foreach my $key (keys(%roleshash)) {
1.479 albertel 2177: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 2178: my $section=$1;
2179: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 2180: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 2181: my $now=time;
1.548 albertel 2182: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 2183: $Expired{$end}=$section;
2184: next;
2185: }
1.548 albertel 2186: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 2187: $Pending{$start}=$section;
2188: next;
2189: }
1.599 albertel 2190: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 2191: }
2192: #
2193: # Presumedly there will be few matching roles from the above
2194: # loop and the sorting time will be negligible.
2195: if (scalar(keys(%Pending))) {
2196: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 2197: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 2198: }
2199: if (scalar(keys(%Expired))) {
2200: my @sorted = sort {$a <=> $b} keys(%Expired);
2201: my $time = pop(@sorted);
1.599 albertel 2202: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 2203: }
1.599 albertel 2204: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 2205: }
1.70 www 2206:
1.599 albertel 2207: sub save_cache {
2208: &purge_remembered();
1.722 albertel 2209: #&Apache::loncommon::validate_page();
1.620 albertel 2210: undef(%env);
1.780 albertel 2211: undef($env_loaded);
1.599 albertel 2212: }
1.452 albertel 2213:
1.599 albertel 2214: my $to_remember=-1;
2215: my %remembered;
2216: my %accessed;
2217: my $kicks=0;
2218: my $hits=0;
1.849 albertel 2219: sub make_key {
2220: my ($name,$id) = @_;
1.872 albertel 2221: if (length($id) > 65
2222: && length(&escape($id)) > 200) {
2223: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2224: }
1.849 albertel 2225: return &escape($name.':'.$id);
2226: }
2227:
1.599 albertel 2228: sub devalidate_cache_new {
2229: my ($name,$id,$debug) = @_;
2230: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 2231: $id=&make_key($name,$id);
1.599 albertel 2232: $memcache->delete($id);
2233: delete($remembered{$id});
2234: delete($accessed{$id});
2235: }
2236:
2237: sub is_cached_new {
2238: my ($name,$id,$debug) = @_;
1.849 albertel 2239: $id=&make_key($name,$id);
1.599 albertel 2240: if (exists($remembered{$id})) {
1.1133 foxr 2241: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
1.599 albertel 2242: $accessed{$id}=[&gettimeofday()];
2243: $hits++;
2244: return ($remembered{$id},1);
2245: }
2246: my $value = $memcache->get($id);
2247: if (!(defined($value))) {
2248: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 2249: return (undef,undef);
1.416 albertel 2250: }
1.599 albertel 2251: if ($value eq '__undef__') {
2252: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2253: $value=undef;
2254: }
2255: &make_room($id,$value,$debug);
2256: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2257: return ($value,1);
2258: }
2259:
2260: sub do_cache_new {
2261: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 2262: $id=&make_key($name,$id);
1.599 albertel 2263: my $setvalue=$value;
2264: if (!defined($setvalue)) {
2265: $setvalue='__undef__';
2266: }
1.623 albertel 2267: if (!defined($time) ) {
2268: $time=600;
2269: }
1.599 albertel 2270: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 2271: my $result = $memcache->set($id,$setvalue,$time);
2272: if (! $result) {
1.872 albertel 2273: &logthis("caching of id -> $id failed");
1.910 albertel 2274: $memcache->disconnect_all();
1.872 albertel 2275: }
1.600 albertel 2276: # need to make a copy of $value
1.919 albertel 2277: &make_room($id,$value,$debug);
1.599 albertel 2278: return $value;
2279: }
2280:
2281: sub make_room {
2282: my ($id,$value,$debug)=@_;
1.919 albertel 2283:
2284: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2285: : $value;
1.599 albertel 2286: if ($to_remember<0) { return; }
2287: $accessed{$id}=[&gettimeofday()];
2288: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2289: my $to_kick;
2290: my $max_time=0;
2291: foreach my $other (keys(%accessed)) {
2292: if (&tv_interval($accessed{$other}) > $max_time) {
2293: $to_kick=$other;
2294: $max_time=&tv_interval($accessed{$other});
2295: }
2296: }
2297: delete($remembered{$to_kick});
2298: delete($accessed{$to_kick});
2299: $kicks++;
2300: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 2301: return;
2302: }
2303:
1.599 albertel 2304: sub purge_remembered {
1.604 albertel 2305: #&logthis("Tossing ".scalar(keys(%remembered)));
2306: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 2307: undef(%remembered);
2308: undef(%accessed);
1.428 albertel 2309: }
1.70 www 2310: # ------------------------------------- Read an entry from a user's environment
2311:
2312: sub userenvironment {
2313: my ($udom,$unam,@what)=@_;
1.976 raeburn 2314: my $items;
2315: foreach my $item (@what) {
2316: $items.=&escape($item).'&';
2317: }
2318: $items=~s/\&$//;
1.70 www 2319: my %returnhash=();
1.1009 raeburn 2320: my $uhome = &homeserver($unam,$udom);
2321: unless ($uhome eq 'no_host') {
2322: my @answer=split(/\&/,
2323: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 2324: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2325: return %returnhash;
2326: }
1.1009 raeburn 2327: my $i;
2328: for ($i=0;$i<=$#what;$i++) {
2329: $returnhash{$what[$i]}=&unescape($answer[$i]);
2330: }
1.70 www 2331: }
2332: return %returnhash;
1.1 albertel 2333: }
2334:
1.617 albertel 2335: # ---------------------------------------------------------- Get a studentphoto
2336: sub studentphoto {
2337: my ($udom,$unam,$ext) = @_;
2338: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 2339: if (defined($env{'request.course.id'})) {
1.708 raeburn 2340: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 2341: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2342: return(&retrievestudentphoto($udom,$unam,$ext));
2343: } else {
2344: my ($result,$perm_reqd)=
1.707 albertel 2345: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2346: if ($result eq 'ok') {
2347: if (!($perm_reqd eq 'yes')) {
2348: return(&retrievestudentphoto($udom,$unam,$ext));
2349: }
2350: }
2351: }
2352: }
2353: } else {
2354: my ($result,$perm_reqd) =
1.707 albertel 2355: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2356: if ($result eq 'ok') {
2357: if (!($perm_reqd eq 'yes')) {
2358: return(&retrievestudentphoto($udom,$unam,$ext));
2359: }
2360: }
2361: }
2362: return '/adm/lonKaputt/lonlogo_broken.gif';
2363: }
2364:
2365: sub retrievestudentphoto {
2366: my ($udom,$unam,$ext,$type) = @_;
2367: my $home=&Apache::lonnet::homeserver($unam,$udom);
2368: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2369: if ($ret eq 'ok') {
2370: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2371: if ($type eq 'thumbnail') {
2372: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2373: }
2374: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2375: return $tokenurl;
2376: } else {
2377: if ($type eq 'thumbnail') {
2378: return '/adm/lonKaputt/genericstudent_tn.gif';
2379: } else {
2380: return '/adm/lonKaputt/lonlogo_broken.gif';
2381: }
1.617 albertel 2382: }
2383: }
2384:
1.263 www 2385: # -------------------------------------------------------------------- New chat
2386:
2387: sub chatsend {
1.724 raeburn 2388: my ($newentry,$anon,$group)=@_;
1.620 albertel 2389: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2390: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2391: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 2392: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 2393: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 2394: &escape($newentry)).':'.$group,$chome);
1.292 www 2395: }
2396:
2397: # ------------------------------------------ Find current version of a resource
2398:
2399: sub getversion {
2400: my $fname=&clutter(shift);
2401: unless ($fname=~/^\/res\//) { return -1; }
2402: return ¤tversion(&filelocation('',$fname));
2403: }
2404:
2405: sub currentversion {
2406: my $fname=shift;
2407: my $author=$fname;
2408: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2409: my ($udom,$uname)=split(/\//,$author);
1.1112 www 2410: my $home=&homeserver($uname,$udom);
1.292 www 2411: if ($home eq 'no_host') {
2412: return -1;
2413: }
1.1112 www 2414: my $answer=&reply("currentversion:$fname",$home);
1.292 www 2415: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2416: return -1;
2417: }
1.1112 www 2418: return $answer;
1.263 www 2419: }
2420:
1.1111 www 2421: #
2422: # Return special version number of resource if set by override, empty otherwise
2423: #
2424: sub usedversion {
2425: my $fname=shift;
2426: unless ($fname) { $fname=$env{'request.uri'}; }
2427: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2428: if ($urlversion) { return $urlversion; }
2429: return '';
2430: }
2431:
1.1 albertel 2432: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 2433:
1.1 albertel 2434: sub subscribe {
2435: my $fname=shift;
1.761 raeburn 2436: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 2437: $fname=~s/[\n\r]//g;
1.1 albertel 2438: my $author=$fname;
2439: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2440: my ($udom,$uname)=split(/\//,$author);
2441: my $home=homeserver($uname,$udom);
1.335 albertel 2442: if ($home eq 'no_host') {
2443: return 'not_found';
1.1 albertel 2444: }
2445: my $answer=reply("sub:$fname",$home);
1.64 www 2446: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2447: $answer.=' by '.$home;
2448: }
1.1 albertel 2449: return $answer;
2450: }
2451:
1.8 www 2452: # -------------------------------------------------------------- Replicate file
2453:
2454: sub repcopy {
2455: my $filename=shift;
1.23 www 2456: $filename=~s/\/+/\//g;
1.1142 raeburn 2457: my $londocroot = $perlvar{'lonDocRoot'};
2458: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 2459: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 2460: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2461: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 2462: return &repcopy_userfile($filename);
2463: }
1.532 albertel 2464: $filename=~s/[\n\r]//g;
1.8 www 2465: my $transname="$filename.in.transfer";
1.828 www 2466: # FIXME: this should flock
1.607 raeburn 2467: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 2468: my $remoteurl=subscribe($filename);
1.64 www 2469: if ($remoteurl =~ /^con_lost by/) {
2470: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2471: return 'unavailable';
1.8 www 2472: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 2473: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 2474: return 'not_found';
1.64 www 2475: } elsif ($remoteurl =~ /^rejected by/) {
2476: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2477: return 'forbidden';
1.20 www 2478: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 2479: return 'ok';
1.8 www 2480: } else {
1.290 www 2481: my $author=$filename;
2482: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2483: my ($udom,$uname)=split(/\//,$author);
2484: my $home=homeserver($uname,$udom);
2485: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 2486: my @parts=split(/\//,$filename);
2487: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 2488: if ($path ne "$londocroot/res") {
1.8 www 2489: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 2490: return 'bad_request';
1.8 www 2491: }
2492: my $count;
2493: for ($count=5;$count<$#parts;$count++) {
2494: $path.="/$parts[$count]";
2495: if ((-e $path)!=1) {
2496: mkdir($path,0777);
2497: }
2498: }
2499: my $ua=new LWP::UserAgent;
2500: my $request=new HTTP::Request('GET',"$remoteurl");
2501: my $response=$ua->request($request,$transname);
2502: if ($response->is_error()) {
2503: unlink($transname);
2504: my $message=$response->status_line;
1.672 albertel 2505: &logthis("<font color=\"blue\">WARNING:"
1.12 www 2506: ." LWP get: $message: $filename</font>");
1.607 raeburn 2507: return 'unavailable';
1.8 www 2508: } else {
1.16 www 2509: if ($remoteurl!~/\.meta$/) {
2510: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2511: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2512: if ($mresponse->is_error()) {
2513: unlink($filename.'.meta');
2514: &logthis(
1.672 albertel 2515: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 2516: }
2517: }
1.8 www 2518: rename($transname,$filename);
1.607 raeburn 2519: return 'ok';
1.8 www 2520: }
1.290 www 2521: }
1.8 www 2522: }
1.330 www 2523: }
2524:
2525: # ------------------------------------------------ Get server side include body
2526: sub ssi_body {
1.381 albertel 2527: my ($filelink,%form)=@_;
1.606 matthew 2528: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2529: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2530: }
1.953 www 2531: my $output='';
2532: my $response;
1.980 raeburn 2533: if ($filelink=~/^https?\:/) {
1.954 raeburn 2534: ($output,$response)=&externalssi($filelink);
1.953 www 2535: } else {
1.1004 droeschl 2536: $filelink .= $filelink=~/\?/ ? '&' : '?';
2537: $filelink .= 'inhibitmenu=yes';
1.953 www 2538: ($output,$response)=&ssi($filelink,%form);
2539: }
1.778 albertel 2540: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 2541: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 2542: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 2543: if (wantarray) {
2544: return ($output, $response);
2545: } else {
2546: return $output;
2547: }
1.8 www 2548: }
2549:
1.15 www 2550: # --------------------------------------------------------- Server Side Include
2551:
1.782 albertel 2552: sub absolute_url {
2553: my ($host_name) = @_;
2554: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2555: if ($host_name eq '') {
2556: $host_name = $ENV{'SERVER_NAME'};
2557: }
2558: return $protocol.$host_name;
2559: }
2560:
1.942 foxr 2561: #
2562: # Server side include.
2563: # Parameters:
2564: # fn Possibly encrypted resource name/id.
2565: # form Hash that describes how the rendering should be done
2566: # and other things.
1.944 foxr 2567: # Returns:
1.950 raeburn 2568: # Scalar context: The content of the response.
2569: # Array context: 2 element list of the content and the full response object.
1.942 foxr 2570: #
1.15 www 2571: sub ssi {
2572:
1.944 foxr 2573: my ($fn,%form)=@_;
1.15 www 2574: my $ua=new LWP::UserAgent;
1.23 www 2575: my $request;
1.711 albertel 2576:
2577: $form{'no_update_last_known'}=1;
1.895 albertel 2578: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 2579: if (%form) {
1.782 albertel 2580: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000 raeburn 2581: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23 www 2582: } else {
1.782 albertel 2583: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 2584: }
2585:
1.15 www 2586: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1173 foxr 2587: my $response= $ua->request($request);
2588: my $content = Encode::decode_utf8($response->content);
1.944 foxr 2589: if (wantarray) {
1.1173 foxr 2590: return ($content, $response);
1.944 foxr 2591: } else {
1.1173 foxr 2592: return $content;
1.942 foxr 2593: }
1.324 www 2594: }
2595:
2596: sub externalssi {
2597: my ($url)=@_;
2598: my $ua=new LWP::UserAgent;
2599: my $request=new HTTP::Request('GET',$url);
2600: my $response=$ua->request($request);
1.954 raeburn 2601: if (wantarray) {
2602: return ($response->content, $response);
2603: } else {
2604: return $response->content;
2605: }
1.15 www 2606: }
1.254 www 2607:
1.492 albertel 2608: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2609:
2610: sub allowuploaded {
2611: my ($srcurl,$url)=@_;
2612: $url=&clutter(&declutter($url));
2613: my $dir=$url;
2614: $dir=~s/\/[^\/]+$//;
2615: my %httpref=();
2616: my $httpurl=&hreflocation('',$url);
2617: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2618: &Apache::lonnet::appenv(\%httpref);
1.254 www 2619: }
1.477 raeburn 2620:
1.478 albertel 2621: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 2622: # input: action, courseID, current domain, intended
1.637 raeburn 2623: # path to file, source of file, instruction to parse file for objects,
2624: # ref to hash for embedded objects,
2625: # ref to hash for codebase of java objects.
1.1095 raeburn 2626: # reference to scalar to accommodate mime type determined
2627: # from File::MMagic if $parser = parse.
1.637 raeburn 2628: #
1.485 raeburn 2629: # output: url to file (if action was uploaddoc),
2630: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 2631: #
1.478 albertel 2632: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2633: # course.
1.477 raeburn 2634: #
1.478 albertel 2635: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2636: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2637: # course's home server.
1.477 raeburn 2638: #
1.478 albertel 2639: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2640: # be copied from $source (current location) to
2641: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2642: # and will then be copied to
2643: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2644: # course's home server.
1.485 raeburn 2645: #
1.481 raeburn 2646: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 2647: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 2648: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2649: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2650: # in course's home server.
1.637 raeburn 2651: #
1.477 raeburn 2652:
2653: sub process_coursefile {
1.1095 raeburn 2654: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
2655: $mimetype)=@_;
1.477 raeburn 2656: my $fetchresult;
1.638 albertel 2657: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 2658: if ($action eq 'propagate') {
1.638 albertel 2659: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2660: $home);
1.481 raeburn 2661: } else {
1.477 raeburn 2662: my $fpath = '';
2663: my $fname = $file;
1.478 albertel 2664: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 2665: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 2666: my $filepath = &build_filepath($fpath);
1.481 raeburn 2667: if ($action eq 'copy') {
2668: if ($source eq '') {
2669: $fetchresult = 'no source file';
2670: return $fetchresult;
2671: } else {
2672: my $destination = $filepath.'/'.$fname;
2673: rename($source,$destination);
2674: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2675: $home);
1.481 raeburn 2676: }
2677: } elsif ($action eq 'uploaddoc') {
2678: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 2679: print $fh $env{'form.'.$source};
1.481 raeburn 2680: close($fh);
1.637 raeburn 2681: if ($parser eq 'parse') {
1.1024 raeburn 2682: my $mm = new File::MMagic;
1.1095 raeburn 2683: my $type = $mm->checktype_filename($filepath.'/'.$fname);
2684: if ($type eq 'text/html') {
1.1024 raeburn 2685: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2686: unless ($parse_result eq 'ok') {
2687: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2688: }
1.637 raeburn 2689: }
1.1095 raeburn 2690: if (ref($mimetype)) {
2691: $$mimetype = $type;
2692: }
1.637 raeburn 2693: }
1.477 raeburn 2694: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2695: $home);
1.481 raeburn 2696: if ($fetchresult eq 'ok') {
2697: return '/uploaded/'.$fpath.'/'.$fname;
2698: } else {
2699: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2700: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 2701: return '/adm/notfound.html';
2702: }
1.477 raeburn 2703: }
2704: }
1.485 raeburn 2705: unless ( $fetchresult eq 'ok') {
1.477 raeburn 2706: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2707: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 2708: }
2709: return $fetchresult;
2710: }
2711:
1.637 raeburn 2712: sub build_filepath {
2713: my ($fpath) = @_;
2714: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2715: unless ($fpath eq '') {
2716: my @parts=split('/',$fpath);
2717: foreach my $part (@parts) {
2718: $filepath.= '/'.$part;
2719: if ((-e $filepath)!=1) {
2720: mkdir($filepath,0777);
2721: }
2722: }
2723: }
2724: return $filepath;
2725: }
2726:
2727: sub store_edited_file {
1.638 albertel 2728: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 2729: my $file = $primary_url;
2730: $file =~ s#^/uploaded/$docudom/$docuname/##;
2731: my $fpath = '';
2732: my $fname = $file;
2733: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2734: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2735: my $filepath = &build_filepath($fpath);
2736: open(my $fh,'>'.$filepath.'/'.$fname);
2737: print $fh $content;
2738: close($fh);
1.638 albertel 2739: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 2740: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2741: $home);
1.637 raeburn 2742: if ($$fetchresult eq 'ok') {
2743: return '/uploaded/'.$fpath.'/'.$fname;
2744: } else {
1.638 albertel 2745: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2746: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 2747: return '/adm/notfound.html';
2748: }
2749: }
2750:
1.531 albertel 2751: sub clean_filename {
1.831 albertel 2752: my ($fname,$args)=@_;
1.315 www 2753: # Replace Windows backslashes by forward slashes
1.257 www 2754: $fname=~s/\\/\//g;
1.831 albertel 2755: if (!$args->{'keep_path'}) {
2756: # Get rid of everything but the actual filename
2757: $fname=~s/^.*\/([^\/]+)$/$1/;
2758: }
1.315 www 2759: # Replace spaces by underscores
2760: $fname=~s/\s+/\_/g;
2761: # Replace all other weird characters by nothing
1.831 albertel 2762: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 2763: # Replace all .\d. sequences with _\d. so they no longer look like version
2764: # numbers
2765: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 2766: return $fname;
2767: }
1.1051 raeburn 2768: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2769: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2770: # image with the same aspect ratio as the original, but with dimensions which do
2771: # not exceed $resizewidth and $resizeheight.
2772:
1.984 neumanie 2773: sub resizeImage {
1.1051 raeburn 2774: my ($img_path,$resizewidth,$resizeheight) = @_;
2775: my $ima = Image::Magick->new;
2776: my $resized;
2777: if (-e $img_path) {
2778: $ima->Read($img_path);
2779: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2780: my $width = $ima->Get('width');
2781: my $height = $ima->Get('height');
2782: if ($width > $resizewidth) {
2783: my $factor = $width/$resizewidth;
2784: my $newheight = $height/$factor;
2785: $ima->Scale(width=>$resizewidth,height=>$newheight);
2786: $resized = 1;
2787: }
2788: }
2789: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2790: my $width = $ima->Get('width');
2791: my $height = $ima->Get('height');
2792: if ($height > $resizeheight) {
2793: my $factor = $height/$resizeheight;
2794: my $newwidth = $width/$factor;
2795: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2796: $resized = 1;
2797: }
2798: }
2799: if ($resized) {
2800: $ima->Write($img_path);
2801: }
2802: }
2803: return;
1.977 amueller 2804: }
2805:
1.608 albertel 2806: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 2807: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 2808: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 2809: # $context - possible values: coursedoc, existingfile, overwrite,
2810: # canceloverwrite, or ''.
2811: # if 'coursedoc': upload to the current course
2812: # if 'existingfile': write file to tmp/overwrites directory
2813: # if 'canceloverwrite': delete file written to tmp/overwrites directory
2814: # $context is passed as argument to &finishuserfileupload
1.686 albertel 2815: # $subdir - directory in userfile to store the file into
1.858 raeburn 2816: # $parser - instruction to parse file for objects ($parser = parse)
2817: # $allfiles - reference to hash for embedded objects
2818: # $codebase - reference to hash for codebase of java objects
2819: # $desuname - username for permanent storage of uploaded file
2820: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 2821: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2822: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 2823: # $resizewidth - width (pixels) to which to resize uploaded image
2824: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 2825: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 2826: # from File::MMagic.
1.858 raeburn 2827: #
1.686 albertel 2828: # output: url of file in userspace, or error: <message>
2829: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 2830:
1.531 albertel 2831: sub userfileupload {
1.1090 raeburn 2832: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 2833: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 2834: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 2835: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 2836: $fname=&clean_filename($fname);
1.1090 raeburn 2837: # See if there is anything left
1.257 www 2838: unless ($fname) { return 'error: no uploaded file'; }
1.1090 raeburn 2839: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
2840: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
2841: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
2842: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 2843: my $now = time;
1.1090 raeburn 2844: my $filepath;
1.1095 raeburn 2845: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 2846: $filepath = 'tmp/helprequests/'.$now;
2847: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
2848: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2849: '_'.$env{'user.domain'}.'/pending';
2850: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
2851: my ($docuname,$docudom);
2852: if ($destudom) {
2853: $docudom = $destudom;
2854: } else {
2855: $docudom = $env{'user.domain'};
2856: }
2857: if ($destuname) {
2858: $docuname = $destuname;
2859: } else {
2860: $docuname = $env{'user.name'};
2861: }
2862: if (exists($env{'form.group'})) {
2863: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2864: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2865: }
2866: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
2867: if ($context eq 'canceloverwrite') {
2868: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
2869: if (-e $tempfile) {
2870: my @info = stat($tempfile);
2871: if ($info[9] eq $env{'form.timestamp'}) {
2872: unlink($tempfile);
2873: }
2874: }
2875: return;
1.523 raeburn 2876: }
2877: }
1.1090 raeburn 2878: # Create the directory if not present
1.741 raeburn 2879: my @parts=split(/\//,$filepath);
2880: my $fullpath = $perlvar{'lonDaemons'};
2881: for (my $i=0;$i<@parts;$i++) {
2882: $fullpath .= '/'.$parts[$i];
2883: if ((-e $fullpath)!=1) {
2884: mkdir($fullpath,0777);
2885: }
2886: }
2887: open(my $fh,'>'.$fullpath.'/'.$fname);
2888: print $fh $env{'form.'.$formname};
2889: close($fh);
1.1090 raeburn 2890: if ($context eq 'existingfile') {
2891: my @info = stat($fullpath.'/'.$fname);
2892: return ($fullpath.'/'.$fname,$info[9]);
2893: } else {
2894: return $fullpath.'/'.$fname;
2895: }
1.523 raeburn 2896: }
1.995 raeburn 2897: if ($subdir eq 'scantron') {
2898: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 2899: } else {
1.995 raeburn 2900: $fname="$subdir/$fname";
2901: }
1.1090 raeburn 2902: if ($context eq 'coursedoc') {
1.638 albertel 2903: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2904: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 2905: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 2906: return &finishuserfileupload($docuname,$docudom,
2907: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 2908: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 2909: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 2910: } else {
1.620 albertel 2911: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 2912: return &process_coursefile('uploaddoc',$docuname,$docudom,
2913: $fname,$formname,$parser,
1.1095 raeburn 2914: $allfiles,$codebase,$mimetype);
1.481 raeburn 2915: }
1.719 banghart 2916: } elsif (defined($destuname)) {
2917: my $docuname=$destuname;
2918: my $docudom=$destudom;
1.860 raeburn 2919: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2920: $parser,$allfiles,$codebase,
1.1051 raeburn 2921: $thumbwidth,$thumbheight,
1.1095 raeburn 2922: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 2923: } else {
1.638 albertel 2924: my $docuname=$env{'user.name'};
2925: my $docudom=$env{'user.domain'};
1.714 raeburn 2926: if (exists($env{'form.group'})) {
2927: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2928: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2929: }
1.860 raeburn 2930: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2931: $parser,$allfiles,$codebase,
1.1051 raeburn 2932: $thumbwidth,$thumbheight,
1.1095 raeburn 2933: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 2934: }
1.271 www 2935: }
2936:
2937: sub finishuserfileupload {
1.860 raeburn 2938: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 2939: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 2940: my $path=$docudom.'/'.$docuname.'/';
1.258 www 2941: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 2942:
1.860 raeburn 2943: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 2944: $file=$fname;
2945: if ($fname=~m|/|) {
2946: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2947: $path.=$fnamepath.'/';
2948: }
1.259 www 2949: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 2950: my $count;
2951: for ($count=4;$count<=$#parts;$count++) {
2952: $filepath.="/$parts[$count]";
2953: if ((-e $filepath)!=1) {
2954: mkdir($filepath,0777);
2955: }
2956: }
1.984 neumanie 2957:
1.258 www 2958: # Save the file
2959: {
1.701 albertel 2960: if (!open(FH,'>'.$filepath.'/'.$file)) {
2961: &logthis('Failed to create '.$filepath.'/'.$file);
2962: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2963: return '/adm/notfound.html';
2964: }
1.1090 raeburn 2965: if ($context eq 'overwrite') {
1.1117 foxr 2966: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 2967: my $target = $filepath.'/'.$file;
2968: if (-e $source) {
2969: my @info = stat($source);
2970: if ($info[9] eq $env{'form.timestamp'}) {
2971: unless (&File::Copy::move($source,$target)) {
2972: &logthis('Failed to overwrite '.$filepath.'/'.$file);
2973: return "Moving from $source failed";
2974: }
2975: } else {
2976: return "Temporary file: $source had unexpected date/time for last modification";
2977: }
2978: } else {
2979: return "Temporary file: $source missing";
2980: }
2981: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 2982: &logthis('Failed to write to '.$filepath.'/'.$file);
2983: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2984: return '/adm/notfound.html';
2985: }
1.570 albertel 2986: close(FH);
1.1051 raeburn 2987: if ($resizewidth && $resizeheight) {
2988: my $mm = new File::MMagic;
2989: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2990: if ($mime_type =~ m{^image/}) {
2991: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2992: }
1.977 amueller 2993: }
1.258 www 2994: }
1.1152 raeburn 2995: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
2996: if (ref($mimetype)) {
2997: if ($$mimetype eq '') {
2998: my $mm = new File::MMagic;
2999: my $type = $mm->checktype_filename($filepath.'/'.$file);
3000: $$mimetype = $type;
3001: }
3002: }
3003: }
1.637 raeburn 3004: if ($parser eq 'parse') {
1.1152 raeburn 3005: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 3006: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3007: $allfiles,$codebase);
3008: unless ($parse_result eq 'ok') {
3009: &logthis('Failed to parse '.$filepath.$file.
3010: ' for embedded media: '.$parse_result);
3011: }
1.637 raeburn 3012: }
3013: }
1.860 raeburn 3014: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3015: my $input = $filepath.'/'.$file;
3016: my $output = $filepath.'/'.'tn-'.$file;
3017: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3018: system("convert -sample $thumbsize $input $output");
3019: if (-e $filepath.'/'.'tn-'.$file) {
3020: $fetchthumb = 1;
3021: }
3022: }
1.858 raeburn 3023:
1.259 www 3024: # Notify homeserver to grep it
3025: #
1.984 neumanie 3026: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 3027: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 3028: if ($fetchresult eq 'ok') {
1.860 raeburn 3029: if ($fetchthumb) {
3030: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3031: if ($thumbresult ne 'ok') {
3032: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3033: $docuhome.': '.$thumbresult);
3034: }
3035: }
1.259 www 3036: #
1.258 www 3037: # Return the URL to it
1.494 albertel 3038: return '/uploaded/'.$path.$file;
1.263 www 3039: } else {
1.494 albertel 3040: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3041: ': '.$fetchresult);
1.263 www 3042: return '/adm/notfound.html';
1.858 raeburn 3043: }
1.493 albertel 3044: }
3045:
1.637 raeburn 3046: sub extract_embedded_items {
1.961 raeburn 3047: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 3048: my @state = ();
1.1164 raeburn 3049: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 3050: my %javafiles = (
3051: codebase => '',
3052: code => '',
3053: archive => ''
3054: );
3055: my %mediafiles = (
3056: src => '',
3057: movie => '',
3058: );
1.648 raeburn 3059: my $p;
3060: if ($content) {
3061: $p = HTML::LCParser->new($content);
3062: } else {
1.961 raeburn 3063: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 3064: }
1.641 albertel 3065: while (my $t=$p->get_token()) {
1.640 albertel 3066: if ($t->[0] eq 'S') {
3067: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 3068: push(@state, $tagname);
1.648 raeburn 3069: if (lc($tagname) eq 'allow') {
3070: &add_filetype($allfiles,$attr->{'src'},'src');
3071: }
1.640 albertel 3072: if (lc($tagname) eq 'img') {
3073: &add_filetype($allfiles,$attr->{'src'},'src');
3074: }
1.886 albertel 3075: if (lc($tagname) eq 'a') {
3076: &add_filetype($allfiles,$attr->{'href'},'href');
3077: }
1.645 raeburn 3078: if (lc($tagname) eq 'script') {
1.1164 raeburn 3079: my $src;
1.645 raeburn 3080: if ($attr->{'archive'} =~ /\.jar$/i) {
3081: &add_filetype($allfiles,$attr->{'archive'},'archive');
3082: } else {
1.1164 raeburn 3083: if ($attr->{'src'} ne '') {
3084: $src = $attr->{'src'};
3085: &add_filetype($allfiles,$src,'src');
3086: }
3087: }
3088: my $text = $p->get_trimmed_text();
3089: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3090: my @swfargs = split(/,/,$1);
3091: foreach my $item (@swfargs) {
3092: $item =~ s/["']//g;
3093: $item =~ s/^\s+//;
3094: $item =~ s/\s+$//;
3095: }
3096: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3097: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3098: push(@{$related{$swfargs[0]}},$swfargs[2]);
3099: } else {
3100: $related{$swfargs[0]} = [$swfargs[2]];
3101: }
3102: }
1.645 raeburn 3103: }
3104: }
3105: if (lc($tagname) eq 'link') {
3106: if (lc($attr->{'rel'}) eq 'stylesheet') {
3107: &add_filetype($allfiles,$attr->{'href'},'href');
3108: }
3109: }
1.640 albertel 3110: if (lc($tagname) eq 'object' ||
3111: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3112: foreach my $item (keys(%javafiles)) {
3113: $javafiles{$item} = '';
3114: }
1.1164 raeburn 3115: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3116: $lastids{lc($tagname)} = $attr->{'id'};
3117: }
1.640 albertel 3118: }
3119: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3120: my $name = lc($attr->{'name'});
3121: foreach my $item (keys(%javafiles)) {
3122: if ($name eq $item) {
3123: $javafiles{$item} = $attr->{'value'};
3124: last;
3125: }
3126: }
1.1164 raeburn 3127: my $pathfrom;
1.640 albertel 3128: foreach my $item (keys(%mediafiles)) {
3129: if ($name eq $item) {
1.1164 raeburn 3130: $pathfrom = $attr->{'value'};
3131: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3132: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 3133: last;
3134: }
3135: }
1.1164 raeburn 3136: if ($name eq 'flashvars') {
3137: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3138: }
3139: if ($pathfrom ne '') {
3140: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3141: $pathfrom);
3142: }
1.640 albertel 3143: }
3144: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3145: foreach my $item (keys(%javafiles)) {
3146: if ($attr->{$item}) {
3147: $javafiles{$item} = $attr->{$item};
3148: last;
3149: }
3150: }
3151: foreach my $item (keys(%mediafiles)) {
3152: if ($attr->{$item}) {
3153: &add_filetype($allfiles,$attr->{$item},$item);
3154: last;
3155: }
3156: }
1.1164 raeburn 3157: if (lc($tagname) eq 'embed') {
3158: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3159: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3160: $attr->{'src'});
3161: }
3162: }
1.640 albertel 3163: }
1.1164 raeburn 3164: if ($t->[4] =~ m{/>$}) {
3165: pop(@state);
3166: }
1.640 albertel 3167: } elsif ($t->[0] eq 'E') {
3168: my ($tagname) = ($t->[1]);
3169: if ($javafiles{'codebase'} ne '') {
3170: $javafiles{'codebase'} .= '/';
3171: }
3172: if (lc($tagname) eq 'applet' ||
3173: lc($tagname) eq 'object' ||
3174: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3175: ) {
3176: foreach my $item (keys(%javafiles)) {
3177: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3178: my $file=$javafiles{'codebase'}.$javafiles{$item};
3179: &add_filetype($allfiles,$file,$item);
3180: }
3181: }
3182: }
3183: pop @state;
3184: }
3185: }
1.1164 raeburn 3186: foreach my $id (sort(keys(%flashvars))) {
3187: if ($shockwave{$id} ne '') {
3188: my @pairs = split(/\&/,$flashvars{$id});
3189: foreach my $pair (@pairs) {
3190: my ($key,$value) = split(/\=/,$pair);
3191: if ($key eq 'thumb') {
3192: &add_filetype($allfiles,$value,$key);
3193: } elsif ($key eq 'content') {
3194: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3195: my ($ext) = ($value =~ /\.([^.]+)$/);
3196: if ($ext ne '') {
3197: &add_filetype($allfiles,$path.$value,$ext);
3198: }
3199: }
3200: }
3201: }
3202: }
1.637 raeburn 3203: return 'ok';
3204: }
3205:
1.639 albertel 3206: sub add_filetype {
3207: my ($allfiles,$file,$type)=@_;
3208: if (exists($allfiles->{$file})) {
3209: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3210: push(@{$allfiles->{$file}}, &escape($type));
3211: }
3212: } else {
3213: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 3214: }
3215: }
3216:
1.1164 raeburn 3217: sub embedded_dependency {
3218: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3219: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3220: if (($identifier ne '') &&
3221: (ref($related->{$identifier}) eq 'ARRAY') &&
3222: ($pathfrom ne '')) {
3223: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3224: foreach my $dep (@{$related->{$identifier}}) {
3225: &add_filetype($allfiles,$path.$dep,'object');
3226: }
3227: }
3228: }
3229: return;
3230: }
3231:
1.493 albertel 3232: sub removeuploadedurl {
1.984 neumanie 3233: my ($url)=@_;
3234: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 3235: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 3236: }
3237:
3238: sub removeuserfile {
3239: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 3240: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3241: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 3242: if ($result eq 'ok') {
1.798 raeburn 3243: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3244: my $metafile = $fname.'.meta';
3245: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 3246: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 3247: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3248: my $sqlresult =
1.823 albertel 3249: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3250: 'portfolio_metadata',$group,
3251: 'delete');
1.798 raeburn 3252: }
3253: }
3254: return $result;
1.257 www 3255: }
1.15 www 3256:
1.530 albertel 3257: sub mkdiruserfile {
3258: my ($docuname,$docudom,$dir)=@_;
3259: my $home=&homeserver($docuname,$docudom);
3260: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3261: }
3262:
1.531 albertel 3263: sub renameuserfile {
3264: my ($docuname,$docudom,$old,$new)=@_;
3265: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3266: my $result = &reply("renameuserfile:$docudom:$docuname:".
3267: &escape("$old").':'.&escape("$new"),$home);
3268: if ($result eq 'ok') {
3269: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3270: my $oldmeta = $old.'.meta';
3271: my $newmeta = $new.'.meta';
3272: my $metaresult =
3273: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 3274: my $url = "/uploaded/$docudom/$docuname/$old";
3275: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3276: my $sqlresult =
1.823 albertel 3277: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3278: 'portfolio_metadata',$group,
3279: 'delete');
1.798 raeburn 3280: }
3281: }
3282: return $result;
1.531 albertel 3283: }
3284:
1.14 www 3285: # ------------------------------------------------------------------------- Log
3286:
3287: sub log {
3288: my ($dom,$nam,$hom,$what)=@_;
1.47 www 3289: return critical("log:$dom:$nam:$what",$hom);
1.157 www 3290: }
3291:
3292: # ------------------------------------------------------------------ Course Log
1.352 www 3293: #
3294: # This routine flushes several buffers of non-mission-critical nature
3295: #
1.157 www 3296:
3297: sub flushcourselogs {
1.352 www 3298: &logthis('Flushing log buffers');
3299: #
3300: # course logs
3301: # This is a log of all transactions in a course, which can be used
3302: # for data mining purposes
3303: #
3304: # It also collects the courseid database, which lists last transaction
3305: # times and course titles for all courseids
3306: #
3307: my %courseidbuffer=();
1.921 raeburn 3308: foreach my $crsid (keys(%courselogs)) {
1.352 www 3309: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 3310: &escape($courselogs{$crsid}),
3311: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 3312: delete $courselogs{$crsid};
3313: } else {
3314: &logthis('Failed to flush log buffer for '.$crsid);
3315: if (length($courselogs{$crsid})>40000) {
1.672 albertel 3316: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 3317: " exceeded maximum size, deleting.</font>");
3318: delete $courselogs{$crsid};
3319: }
1.352 www 3320: }
1.920 raeburn 3321: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 3322: 'description' => $coursedescrbuf{$crsid},
3323: 'inst_code' => $courseinstcodebuf{$crsid},
3324: 'type' => $coursetypebuf{$crsid},
3325: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 3326: };
1.191 harris41 3327: }
1.352 www 3328: #
3329: # Write course id database (reverse lookup) to homeserver of courses
3330: # Is used in pickcourse
3331: #
1.840 albertel 3332: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 3333: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 3334: $courseidbuffer{$crs_home},
3335: $crs_home,'timeonly');
1.352 www 3336: }
3337: #
3338: # File accesses
3339: # Writes to the dynamic metadata of resources to get hit counts, etc.
3340: #
1.449 matthew 3341: foreach my $entry (keys(%accesshash)) {
1.458 matthew 3342: if ($entry =~ /___count$/) {
3343: my ($dom,$name);
1.807 albertel 3344: ($dom,$name,undef)=
1.811 albertel 3345: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 3346: if (! defined($dom) || $dom eq '' ||
3347: ! defined($name) || $name eq '') {
1.620 albertel 3348: my $cid = $env{'request.course.id'};
3349: $dom = $env{'request.'.$cid.'.domain'};
3350: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 3351: }
1.450 matthew 3352: my $value = $accesshash{$entry};
3353: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3354: my %temphash=($url => $value);
1.449 matthew 3355: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3356: if ($result eq 'ok') {
3357: delete $accesshash{$entry};
3358: }
3359: } else {
1.811 albertel 3360: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 3361: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 3362: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 3363: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3364: delete $accesshash{$entry};
3365: }
1.185 www 3366: }
1.191 harris41 3367: }
1.352 www 3368: #
3369: # Roles
3370: # Reverse lookup of user roles for course faculty/staff and co-authorship
3371: #
1.800 albertel 3372: foreach my $entry (keys(%userrolehash)) {
1.351 www 3373: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 3374: split(/\:/,$entry);
3375: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 3376: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 3377: $rudom,$runame) eq 'ok') {
3378: delete $userrolehash{$entry};
3379: }
3380: }
1.662 raeburn 3381: #
3382: # Reverse lookup of domain roles (dc, ad, li, sc, au)
3383: #
3384: my %domrolebuffer = ();
1.1000 raeburn 3385: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 3386: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 3387: if ($domrolebuffer{$rudom}) {
3388: $domrolebuffer{$rudom}.='&'.&escape($entry).
3389: '='.&escape($domainrolehash{$entry});
3390: } else {
3391: $domrolebuffer{$rudom}.=&escape($entry).
3392: '='.&escape($domainrolehash{$entry});
3393: }
3394: delete $domainrolehash{$entry};
3395: }
3396: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 3397: my %servers = &get_servers($dom,'library');
3398: foreach my $tryserver (keys(%servers)) {
3399: unless (&reply('domroleput:'.$dom.':'.
3400: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3401: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3402: }
1.662 raeburn 3403: }
3404: }
1.186 www 3405: $dumpcount++;
1.157 www 3406: }
3407:
3408: sub courselog {
3409: my $what=shift;
1.158 www 3410: $what=time.':'.$what;
1.620 albertel 3411: unless ($env{'request.course.id'}) { return ''; }
3412: $coursedombuf{$env{'request.course.id'}}=
3413: $env{'course.'.$env{'request.course.id'}.'.domain'};
3414: $coursenumbuf{$env{'request.course.id'}}=
3415: $env{'course.'.$env{'request.course.id'}.'.num'};
3416: $coursehombuf{$env{'request.course.id'}}=
3417: $env{'course.'.$env{'request.course.id'}.'.home'};
3418: $coursedescrbuf{$env{'request.course.id'}}=
3419: $env{'course.'.$env{'request.course.id'}.'.description'};
3420: $courseinstcodebuf{$env{'request.course.id'}}=
3421: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3422: $courseownerbuf{$env{'request.course.id'}}=
3423: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 3424: $coursetypebuf{$env{'request.course.id'}}=
3425: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 3426: if (defined $courselogs{$env{'request.course.id'}}) {
3427: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 3428: } else {
1.620 albertel 3429: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 3430: }
1.620 albertel 3431: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 3432: &flushcourselogs();
3433: }
1.158 www 3434: }
3435:
3436: sub courseacclog {
3437: my $fnsymb=shift;
1.620 albertel 3438: unless ($env{'request.course.id'}) { return ''; }
3439: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 3440: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 3441: $what.=':POST';
1.583 matthew 3442: # FIXME: Probably ought to escape things....
1.800 albertel 3443: foreach my $key (keys(%env)) {
3444: if ($key=~/^form\.(.*)/) {
1.975 raeburn 3445: my $formitem = $1;
3446: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3447: $what.=':'.$formitem.'='.$env{$key};
3448: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3449: $what.=':'.$formitem.'='.$env{$key};
3450: }
1.158 www 3451: }
1.191 harris41 3452: }
1.583 matthew 3453: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
3454: # FIXME: We should not be depending on a form parameter that someone
3455: # editing lonsearchcat.pm might change in the future.
1.620 albertel 3456: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 3457: $what.= ':POST';
3458: # FIXME: Probably ought to escape things....
3459: foreach my $element ('courseexp','crsfulltext','crsrelated',
3460: 'crsdiscuss') {
1.620 albertel 3461: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 3462: }
3463: }
1.158 www 3464: }
3465: &courselog($what);
1.149 www 3466: }
3467:
1.185 www 3468: sub countacc {
3469: my $url=&declutter(shift);
1.458 matthew 3470: return if (! defined($url) || $url eq '');
1.620 albertel 3471: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 3472: #
3473: # Mark that this url was used in this course
3474: #
1.620 albertel 3475: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 3476: #
3477: # Increase the access count for this resource in this child process
3478: #
1.281 www 3479: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 3480: $accesshash{$key}++;
1.185 www 3481: }
1.349 www 3482:
1.361 www 3483: sub linklog {
3484: my ($from,$to)=@_;
3485: $from=&declutter($from);
3486: $to=&declutter($to);
3487: $accesshash{$from.'___'.$to.'___comefrom'}=1;
3488: $accesshash{$to.'___'.$from.'___goto'}=1;
3489: }
1.1160 www 3490:
3491: sub statslog {
3492: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
3493: if ($users<2) { return; }
3494: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
3495: 'course' => $env{'request.course.id'},
3496: 'sections' => '"all"',
3497: 'num_students' => $users,
3498: 'part' => $part,
3499: 'symb' => $symb,
3500: 'mean_tries' => $av_attempts,
3501: 'deg_of_diff' => $degdiff});
3502: foreach my $key (keys(%dynstore)) {
3503: $accesshash{$key}=$dynstore{$key};
3504: }
3505: }
1.361 www 3506:
1.349 www 3507: sub userrolelog {
3508: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 3509: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 3510: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3511: $userrolehash
3512: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 3513: =$tend.':'.$tstart;
1.662 raeburn 3514: }
1.1169 droeschl 3515: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 3516: $userrolehash
3517: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
3518: =$tend.':'.$tstart;
3519: }
1.1169 droeschl 3520: if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
1.662 raeburn 3521: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3522: $domainrolehash
3523: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3524: = $tend.':'.$tstart;
3525: }
1.351 www 3526: }
3527:
1.957 raeburn 3528: sub courserolelog {
3529: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
3530: if (($trole eq 'cc') || ($trole eq 'in') ||
3531: ($trole eq 'ep') || ($trole eq 'ad') ||
3532: ($trole eq 'ta') || ($trole eq 'st') ||
1.1044 raeburn 3533: ($trole=~/^cr/) || ($trole eq 'gr') ||
3534: ($trole eq 'co')) {
1.957 raeburn 3535: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
3536: my $cdom = $1;
3537: my $cnum = $2;
3538: my $sec = $3;
3539: my $namespace = 'rolelog';
3540: my %storehash = (
3541: role => $trole,
3542: start => $tstart,
3543: end => $tend,
3544: selfenroll => $selfenroll,
3545: context => $context,
3546: );
3547: if ($trole eq 'gr') {
3548: $namespace = 'groupslog';
3549: $storehash{'group'} = $sec;
3550: } else {
3551: $storehash{'section'} = $sec;
3552: }
3553: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
1.996 raeburn 3554: if (($trole ne 'st') || ($sec ne '')) {
3555: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
3556: }
1.957 raeburn 3557: }
3558: }
3559: return;
3560: }
3561:
1.351 www 3562: sub get_course_adv_roles {
1.948 raeburn 3563: my ($cid,$codes) = @_;
1.620 albertel 3564: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 3565: my %coursehash=&coursedescription($cid);
1.988 raeburn 3566: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 3567: my %nothide=();
1.800 albertel 3568: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 3569: if ($user !~ /:/) {
3570: $nothide{join(':',split(/[\@]/,$user))}=1;
3571: } else {
3572: $nothide{$user}=1;
3573: }
1.470 www 3574: }
1.351 www 3575: my %returnhash=();
3576: my %dumphash=
3577: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
3578: my $now=time;
1.997 raeburn 3579: my %privileged;
1.1000 raeburn 3580: foreach my $entry (keys(%dumphash)) {
1.800 albertel 3581: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 3582: if (($tstart) && ($tstart<0)) { next; }
3583: if (($tend) && ($tend<$now)) { next; }
3584: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 3585: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 3586: if ($username eq '' || $domain eq '') { next; }
1.997 raeburn 3587: unless (ref($privileged{$domain}) eq 'HASH') {
3588: my %dompersonnel =
1.998 raeburn 3589: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
1.997 raeburn 3590: $privileged{$domain} = {};
3591: foreach my $server (keys(%dompersonnel)) {
1.999 raeburn 3592: if (ref($dompersonnel{$server}) eq 'HASH') {
1.997 raeburn 3593: foreach my $user (keys(%{$dompersonnel{$server}})) {
3594: my ($trole,$uname,$udom) = split(/:/,$user);
3595: $privileged{$udom}{$uname} = 1;
3596: }
3597: }
3598: }
3599: }
3600: if ((exists($privileged{$domain}{$username})) &&
3601: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 3602: if ($role eq 'cr') { next; }
1.948 raeburn 3603: if ($codes) {
3604: if ($section) { $role .= ':'.$section; }
3605: if ($returnhash{$role}) {
3606: $returnhash{$role}.=','.$username.':'.$domain;
3607: } else {
3608: $returnhash{$role}=$username.':'.$domain;
3609: }
1.351 www 3610: } else {
1.988 raeburn 3611: my $key=&plaintext($role,$crstype);
1.973 bisitz 3612: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 3613: if ($returnhash{$key}) {
3614: $returnhash{$key}.=','.$username.':'.$domain;
3615: } else {
3616: $returnhash{$key}=$username.':'.$domain;
3617: }
1.351 www 3618: }
1.948 raeburn 3619: }
1.400 www 3620: return %returnhash;
3621: }
3622:
3623: sub get_my_roles {
1.937 raeburn 3624: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 3625: unless (defined($uname)) { $uname=$env{'user.name'}; }
3626: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 3627: my (%dumphash,%nothide);
1.1086 raeburn 3628: if ($context eq 'userroles') {
1.1166 raeburn 3629: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 3630: } else {
3631: %dumphash=
1.400 www 3632: &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 3633: if ($hidepriv) {
3634: my %coursehash=&coursedescription($udom.'_'.$uname);
3635: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3636: if ($user !~ /:/) {
3637: $nothide{join(':',split(/[\@]/,$user))} = 1;
3638: } else {
3639: $nothide{$user} = 1;
3640: }
3641: }
3642: }
1.858 raeburn 3643: }
1.400 www 3644: my %returnhash=();
3645: my $now=time;
1.999 raeburn 3646: my %privileged;
1.800 albertel 3647: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 3648: my ($role,$tend,$tstart);
3649: if ($context eq 'userroles') {
1.1149 raeburn 3650: next if ($entry =~ /^rolesdef/);
1.867 raeburn 3651: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
3652: } else {
3653: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
3654: }
1.400 www 3655: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 3656: my $status = 'active';
1.939 raeburn 3657: if (($tend) && ($tend<=$now)) {
1.832 raeburn 3658: $status = 'previous';
3659: }
3660: if (($tstart) && ($now<$tstart)) {
3661: $status = 'future';
3662: }
3663: if (ref($types) eq 'ARRAY') {
3664: if (!grep(/^\Q$status\E$/,@{$types})) {
3665: next;
3666: }
3667: } else {
3668: if ($status ne 'active') {
3669: next;
3670: }
3671: }
1.867 raeburn 3672: my ($rolecode,$username,$domain,$section,$area);
3673: if ($context eq 'userroles') {
3674: ($area,$rolecode) = split(/_/,$entry);
3675: (undef,$domain,$username,$section) = split(/\//,$area);
3676: } else {
3677: ($role,$username,$domain,$section) = split(/\:/,$entry);
3678: }
1.832 raeburn 3679: if (ref($roledoms) eq 'ARRAY') {
3680: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
3681: next;
3682: }
3683: }
3684: if (ref($roles) eq 'ARRAY') {
3685: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 3686: if ($role =~ /^cr\//) {
3687: if (!grep(/^cr$/,@{$roles})) {
3688: next;
3689: }
1.1104 raeburn 3690: } elsif ($role =~ /^gr\//) {
3691: if (!grep(/^gr$/,@{$roles})) {
3692: next;
3693: }
1.922 raeburn 3694: } else {
3695: next;
3696: }
1.832 raeburn 3697: }
1.867 raeburn 3698: }
1.937 raeburn 3699: if ($hidepriv) {
1.999 raeburn 3700: if ($context eq 'userroles') {
3701: if ((&privileged($username,$domain)) &&
3702: (!$nothide{$username.':'.$domain})) {
3703: next;
3704: }
3705: } else {
3706: unless (ref($privileged{$domain}) eq 'HASH') {
3707: my %dompersonnel =
3708: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
3709: $privileged{$domain} = {};
3710: if (keys(%dompersonnel)) {
3711: foreach my $server (keys(%dompersonnel)) {
3712: if (ref($dompersonnel{$server}) eq 'HASH') {
3713: foreach my $user (keys(%{$dompersonnel{$server}})) {
3714: my ($trole,$uname,$udom) = split(/:/,$user);
3715: $privileged{$udom}{$uname} = $trole;
3716: }
3717: }
3718: }
3719: }
3720: }
3721: if (exists($privileged{$domain}{$username})) {
3722: if (!$nothide{$username.':'.$domain}) {
3723: next;
3724: }
3725: }
1.937 raeburn 3726: }
3727: }
1.933 raeburn 3728: if ($withsec) {
3729: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
3730: $tstart.':'.$tend;
3731: } else {
3732: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
3733: }
1.832 raeburn 3734: }
1.373 www 3735: return %returnhash;
1.399 www 3736: }
3737:
3738: # ----------------------------------------------------- Frontpage Announcements
3739: #
3740: #
3741:
3742: sub postannounce {
3743: my ($server,$text)=@_;
1.844 albertel 3744: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 3745: unless ($text=~/\w/) { $text=''; }
3746: return &reply('setannounce:'.&escape($text),$server);
3747: }
3748:
3749: sub getannounce {
1.448 albertel 3750:
3751: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 3752: my $announcement='';
1.800 albertel 3753: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 3754: close($fh);
1.399 www 3755: if ($announcement=~/\w/) {
3756: return
3757: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 3758: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 3759: } else {
3760: return '';
3761: }
3762: } else {
3763: return '';
3764: }
1.351 www 3765: }
1.353 www 3766:
3767: # ---------------------------------------------------------- Course ID routines
3768: # Deal with domain's nohist_courseid.db files
3769: #
3770:
3771: sub courseidput {
1.921 raeburn 3772: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 3773: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 3774: my $outcome;
3775: if ($caller eq 'timeonly') {
3776: my $cids = '';
3777: foreach my $item (keys(%$storehash)) {
3778: $cids.=&escape($item).'&';
3779: }
3780: $cids=~s/\&$//;
3781: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3782: $coursehome);
3783: } else {
3784: my $items = '';
3785: foreach my $item (keys(%$storehash)) {
3786: $items.= &escape($item).'='.
3787: &freeze_escape($$storehash{$item}).'&';
3788: }
3789: $items=~s/\&$//;
3790: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3791: $coursehome);
1.918 raeburn 3792: }
3793: if ($outcome eq 'unknown_cmd') {
3794: my $what;
3795: foreach my $cid (keys(%$storehash)) {
3796: $what .= &escape($cid).'=';
1.921 raeburn 3797: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 3798: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 3799: }
3800: $what =~ s/\:$/&/;
3801: }
3802: $what =~ s/\&$//;
3803: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3804: } else {
3805: return $outcome;
3806: }
1.353 www 3807: }
3808:
3809: sub courseiddump {
1.921 raeburn 3810: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 3811: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 3812: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1071 raeburn 3813: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
1.918 raeburn 3814: my $as_hash = 1;
3815: my %returnhash;
3816: if (!$domfilter) { $domfilter=''; }
1.845 albertel 3817: my %libserv = &all_library();
3818: foreach my $tryserver (keys(%libserv)) {
3819: if ( ( $hostidflag == 1
3820: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3821: || (!defined($hostidflag)) ) {
3822:
1.918 raeburn 3823: if (($domfilter eq '') ||
3824: (&host_domain($tryserver) eq $domfilter)) {
3825: my $rep =
3826: &reply('courseiddump:'.&host_domain($tryserver).':'.
3827: $sincefilter.':'.&escape($descfilter).':'.
3828: &escape($instcodefilter).':'.&escape($ownerfilter).
3829: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947 raeburn 3830: ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962 raeburn 3831: &escape($selfenrollonly).':'.&escape($catfilter).':'.
1.1008 raeburn 3832: $showhidden.':'.$caller.':'.&escape($cloner).':'.
1.1029 raeburn 3833: &escape($cc_clone).':'.$cloneonly.':'.
3834: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1071 raeburn 3835: &escape($creationcontext).':'.$domcloner,
3836: $tryserver);
1.918 raeburn 3837: my @pairs=split(/\&/,$rep);
3838: foreach my $item (@pairs) {
3839: my ($key,$value)=split(/\=/,$item,2);
3840: $key = &unescape($key);
3841: next if ($key =~ /^error: 2 /);
3842: my $result = &thaw_unescape($value);
3843: if (ref($result) eq 'HASH') {
3844: $returnhash{$key}=$result;
3845: } else {
1.921 raeburn 3846: my @responses = split(/:/,$value);
3847: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3848: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3849: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3850: }
1.1008 raeburn 3851: }
1.353 www 3852: }
3853: }
3854: }
3855: }
3856: return %returnhash;
3857: }
3858:
1.1055 raeburn 3859: sub courselastaccess {
3860: my ($cdom,$cnum,$hostidref) = @_;
3861: my %returnhash;
3862: if ($cdom && $cnum) {
3863: my $chome = &homeserver($cnum,$cdom);
3864: if ($chome ne 'no_host') {
3865: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3866: &extract_lastaccess(\%returnhash,$rep);
3867: }
3868: } else {
3869: if (!$cdom) { $cdom=''; }
3870: my %libserv = &all_library();
3871: foreach my $tryserver (keys(%libserv)) {
3872: if (ref($hostidref) eq 'ARRAY') {
3873: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3874: }
3875: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3876: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3877: &extract_lastaccess(\%returnhash,$rep);
3878: }
3879: }
3880: }
3881: return %returnhash;
3882: }
3883:
3884: sub extract_lastaccess {
3885: my ($returnhash,$rep) = @_;
3886: if (ref($returnhash) eq 'HASH') {
3887: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3888: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3889: $rep eq '') {
3890: my @pairs=split(/\&/,$rep);
3891: foreach my $item (@pairs) {
3892: my ($key,$value)=split(/\=/,$item,2);
3893: $key = &unescape($key);
3894: next if ($key =~ /^error: 2 /);
3895: $returnhash->{$key} = &thaw_unescape($value);
3896: }
3897: }
3898: }
3899: return;
3900: }
3901:
1.658 raeburn 3902: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3903:
3904: sub dcmailput {
1.685 raeburn 3905: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3906: my $status = &Apache::lonnet::critical(
1.740 www 3907: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3908: &escape($message),$server);
1.662 raeburn 3909: return $status;
3910: }
3911:
1.658 raeburn 3912: sub dcmaildump {
3913: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3914: my %returnhash=();
1.846 albertel 3915:
3916: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3917: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3918: &escape($enddate).':';
3919: my @esc_senders=map { &escape($_)} @$senders;
3920: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3921: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3922: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3923: if (($key) && ($value)) {
3924: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3925: }
3926: }
3927: }
3928: return %returnhash;
3929: }
1.662 raeburn 3930: # ---------------------------------------------------------- Domain roles
3931:
3932: sub get_domain_roles {
3933: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 3934: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 3935: $startdate = '.';
3936: }
1.1018 raeburn 3937: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 3938: $enddate = '.';
3939: }
1.922 raeburn 3940: my $rolelist;
3941: if (ref($roles) eq 'ARRAY') {
3942: $rolelist = join(':',@{$roles});
3943: }
1.662 raeburn 3944: my %personnel = ();
1.841 albertel 3945:
3946: my %servers = &get_servers($dom,'library');
3947: foreach my $tryserver (keys(%servers)) {
3948: %{$personnel{$tryserver}}=();
3949: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3950: &escape($startdate).':'.
3951: &escape($enddate).':'.
3952: &escape($rolelist), $tryserver))) {
3953: my ($key,$value) = split(/\=/,$line,2);
3954: if (($key) && ($value)) {
3955: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3956: }
3957: }
1.662 raeburn 3958: }
3959: return %personnel;
3960: }
1.658 raeburn 3961:
1.1057 www 3962: # ----------------------------------------------------------- Interval timing
1.149 www 3963:
1.1153 www 3964: {
3965: # Caches needed for speedup of navmaps
3966: # We don't want to cache this for very long at all (5 seconds at most)
3967: #
3968: # The user for whom we cache
3969: my $cachedkey='';
3970: # The cached times for this user
3971: my %cachedtimes=();
3972: # When this was last done
3973: my $cachedtime=();
3974:
3975: sub load_all_first_access {
1.1154 raeburn 3976: my ($uname,$udom)=@_;
1.1156 www 3977: if (($cachedkey eq $uname.':'.$udom) &&
1.1174 raeburn 3978: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
1.1154 raeburn 3979: return;
3980: }
3981: $cachedtime=time;
3982: $cachedkey=$uname.':'.$udom;
3983: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 3984: }
3985:
1.504 albertel 3986: sub get_first_access {
1.1162 raeburn 3987: my ($type,$argsymb,$argmap)=@_;
1.790 albertel 3988: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3989: if ($argsymb) { $symb=$argsymb; }
3990: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 3991: if ($argmap) { $map = $argmap; }
1.926 albertel 3992: if ($type eq 'course') {
3993: $res='course';
3994: } elsif ($type eq 'map') {
1.588 albertel 3995: $res=&symbread($map);
3996: } else {
3997: $res=$symb;
3998: }
1.1153 www 3999: &load_all_first_access($uname,$udom);
4000: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 4001: }
4002:
4003: sub set_first_access {
1.1162 raeburn 4004: my ($type,$interval)=@_;
1.790 albertel 4005: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4006: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 4007: if ($type eq 'course') {
4008: $res='course';
4009: } elsif ($type eq 'map') {
1.588 albertel 4010: $res=&symbread($map);
4011: } else {
4012: $res=$symb;
4013: }
1.1153 www 4014: $cachedkey='';
1.1162 raeburn 4015: my $firstaccess=&get_first_access($type,$symb,$map);
1.505 albertel 4016: if (!$firstaccess) {
1.1162 raeburn 4017: my $start = time;
4018: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4019: $udom,$uname);
4020: if ($putres eq 'ok') {
4021: &put('timerinterval',{"$courseid\0$res"=>$interval},
4022: $udom,$uname);
4023: &appenv(
4024: {
4025: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4026: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4027: }
4028: );
4029: }
4030: return $putres;
1.505 albertel 4031: }
4032: return 'already_set';
1.504 albertel 4033: }
1.1153 www 4034: }
1.110 www 4035: # --------------------------------------------- Set Expire Date for Spreadsheet
4036:
4037: sub expirespread {
4038: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 4039: my $cid=$env{'request.course.id'};
1.110 www 4040: if ($cid) {
4041: my $now=time;
4042: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 4043: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4044: $env{'course.'.$cid.'.num'}.
1.110 www 4045: ':nohist_expirationdates:'.
4046: &escape($key).'='.$now,
1.620 albertel 4047: $env{'course.'.$cid.'.home'})
1.110 www 4048: }
4049: return 'ok';
1.14 www 4050: }
4051:
1.109 www 4052: # ----------------------------------------------------- Devalidate Spreadsheets
4053:
4054: sub devalidate {
1.325 www 4055: my ($symb,$uname,$udom)=@_;
1.620 albertel 4056: my $cid=$env{'request.course.id'};
1.109 www 4057: if ($cid) {
1.391 matthew 4058: # delete the stored spreadsheets for
4059: # - the student level sheet of this user in course's homespace
4060: # - the assessment level sheet for this resource
4061: # for this user in user's homespace
1.553 albertel 4062: # - current conditional state info
1.325 www 4063: my $key=$uname.':'.$udom.':';
1.109 www 4064: my $status=
1.299 matthew 4065: &del('nohist_calculatedsheets',
1.391 matthew 4066: [$key.'studentcalc:'],
1.620 albertel 4067: $env{'course.'.$cid.'.domain'},
4068: $env{'course.'.$cid.'.num'})
1.133 albertel 4069: .' '.
4070: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 4071: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 4072: unless ($status eq 'ok ok') {
4073: &logthis('Could not devalidate spreadsheet '.
1.325 www 4074: $uname.' at '.$udom.' for '.
1.109 www 4075: $symb.': '.$status);
1.133 albertel 4076: }
1.553 albertel 4077: &delenv('user.state.'.$cid);
1.109 www 4078: }
4079: }
4080:
1.265 albertel 4081: sub get_scalar {
4082: my ($string,$end) = @_;
4083: my $value;
4084: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4085: $value = $1;
4086: } elsif ($$string =~ s/^([^&]*?)&//) {
4087: $value = $1;
4088: }
4089: return &unescape($value);
4090: }
4091:
4092: sub array2str {
4093: my (@array) = @_;
4094: my $result=&arrayref2str(\@array);
4095: $result=~s/^__ARRAY_REF__//;
4096: $result=~s/__END_ARRAY_REF__$//;
4097: return $result;
4098: }
4099:
1.204 albertel 4100: sub arrayref2str {
4101: my ($arrayref) = @_;
1.265 albertel 4102: my $result='__ARRAY_REF__';
1.204 albertel 4103: foreach my $elem (@$arrayref) {
1.265 albertel 4104: if(ref($elem) eq 'ARRAY') {
4105: $result.=&arrayref2str($elem).'&';
4106: } elsif(ref($elem) eq 'HASH') {
4107: $result.=&hashref2str($elem).'&';
4108: } elsif(ref($elem)) {
4109: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 4110: } else {
4111: $result.=&escape($elem).'&';
4112: }
4113: }
4114: $result=~s/\&$//;
1.265 albertel 4115: $result .= '__END_ARRAY_REF__';
1.204 albertel 4116: return $result;
4117: }
4118:
1.168 albertel 4119: sub hash2str {
1.204 albertel 4120: my (%hash) = @_;
4121: my $result=&hashref2str(\%hash);
1.265 albertel 4122: $result=~s/^__HASH_REF__//;
4123: $result=~s/__END_HASH_REF__$//;
1.204 albertel 4124: return $result;
4125: }
4126:
4127: sub hashref2str {
4128: my ($hashref)=@_;
1.265 albertel 4129: my $result='__HASH_REF__';
1.800 albertel 4130: foreach my $key (sort(keys(%$hashref))) {
4131: if (ref($key) eq 'ARRAY') {
4132: $result.=&arrayref2str($key).'=';
4133: } elsif (ref($key) eq 'HASH') {
4134: $result.=&hashref2str($key).'=';
4135: } elsif (ref($key)) {
1.265 albertel 4136: $result.='=';
1.800 albertel 4137: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 4138: } else {
1.1132 raeburn 4139: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 4140: }
4141:
1.800 albertel 4142: if(ref($hashref->{$key}) eq 'ARRAY') {
4143: $result.=&arrayref2str($hashref->{$key}).'&';
4144: } elsif(ref($hashref->{$key}) eq 'HASH') {
4145: $result.=&hashref2str($hashref->{$key}).'&';
4146: } elsif(ref($hashref->{$key})) {
1.265 albertel 4147: $result.='&';
1.800 albertel 4148: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 4149: } else {
1.800 albertel 4150: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 4151: }
4152: }
1.168 albertel 4153: $result=~s/\&$//;
1.265 albertel 4154: $result .= '__END_HASH_REF__';
1.168 albertel 4155: return $result;
4156: }
4157:
4158: sub str2hash {
1.265 albertel 4159: my ($string)=@_;
4160: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4161: return %$hash;
4162: }
4163:
4164: sub str2hashref {
1.168 albertel 4165: my ($string) = @_;
1.265 albertel 4166:
4167: my %hash;
4168:
4169: if($string !~ /^__HASH_REF__/) {
4170: if (! ($string eq '' || !defined($string))) {
4171: $hash{'error'}='Not hash reference';
4172: }
4173: return (\%hash, $string);
4174: }
4175:
4176: $string =~ s/^__HASH_REF__//;
4177:
4178: while($string !~ /^__END_HASH_REF__/) {
4179: #key
4180: my $key='';
4181: if($string =~ /^__HASH_REF__/) {
4182: ($key, $string)=&str2hashref($string);
4183: if(defined($key->{'error'})) {
4184: $hash{'error'}='Bad data';
4185: return (\%hash, $string);
4186: }
4187: } elsif($string =~ /^__ARRAY_REF__/) {
4188: ($key, $string)=&str2arrayref($string);
4189: if($key->[0] eq 'Array reference error') {
4190: $hash{'error'}='Bad data';
4191: return (\%hash, $string);
4192: }
4193: } else {
4194: $string =~ s/^(.*?)=//;
1.267 albertel 4195: $key=&unescape($1);
1.265 albertel 4196: }
4197: $string =~ s/^=//;
4198:
4199: #value
4200: my $value='';
4201: if($string =~ /^__HASH_REF__/) {
4202: ($value, $string)=&str2hashref($string);
4203: if(defined($value->{'error'})) {
4204: $hash{'error'}='Bad data';
4205: return (\%hash, $string);
4206: }
4207: } elsif($string =~ /^__ARRAY_REF__/) {
4208: ($value, $string)=&str2arrayref($string);
4209: if($value->[0] eq 'Array reference error') {
4210: $hash{'error'}='Bad data';
4211: return (\%hash, $string);
4212: }
4213: } else {
4214: $value=&get_scalar(\$string,'__END_HASH_REF__');
4215: }
4216: $string =~ s/^&//;
4217:
4218: $hash{$key}=$value;
1.204 albertel 4219: }
1.265 albertel 4220:
4221: $string =~ s/^__END_HASH_REF__//;
4222:
4223: return (\%hash, $string);
1.204 albertel 4224: }
4225:
4226: sub str2array {
1.265 albertel 4227: my ($string)=@_;
4228: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4229: return @$array;
4230: }
4231:
4232: sub str2arrayref {
1.204 albertel 4233: my ($string) = @_;
1.265 albertel 4234: my @array;
4235:
4236: if($string !~ /^__ARRAY_REF__/) {
4237: if (! ($string eq '' || !defined($string))) {
4238: $array[0]='Array reference error';
4239: }
4240: return (\@array, $string);
4241: }
4242:
4243: $string =~ s/^__ARRAY_REF__//;
4244:
4245: while($string !~ /^__END_ARRAY_REF__/) {
4246: my $value='';
4247: if($string =~ /^__HASH_REF__/) {
4248: ($value, $string)=&str2hashref($string);
4249: if(defined($value->{'error'})) {
4250: $array[0] ='Array reference error';
4251: return (\@array, $string);
4252: }
4253: } elsif($string =~ /^__ARRAY_REF__/) {
4254: ($value, $string)=&str2arrayref($string);
4255: if($value->[0] eq 'Array reference error') {
4256: $array[0] ='Array reference error';
4257: return (\@array, $string);
4258: }
4259: } else {
4260: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4261: }
4262: $string =~ s/^&//;
4263:
4264: push(@array, $value);
1.191 harris41 4265: }
1.265 albertel 4266:
4267: $string =~ s/^__END_ARRAY_REF__//;
4268:
4269: return (\@array, $string);
1.168 albertel 4270: }
4271:
1.167 albertel 4272: # -------------------------------------------------------------------Temp Store
4273:
1.168 albertel 4274: sub tmpreset {
4275: my ($symb,$namespace,$domain,$stuname) = @_;
4276: if (!$symb) {
4277: $symb=&symbread();
1.620 albertel 4278: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4279: }
4280: $symb=escape($symb);
4281:
1.620 albertel 4282: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 4283: $namespace=~s/\//\_/g;
4284: $namespace=~s/\W//g;
4285:
1.620 albertel 4286: if (!$domain) { $domain=$env{'user.domain'}; }
4287: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4288: if ($domain eq 'public' && $stuname eq 'public') {
4289: $stuname=$ENV{'REMOTE_ADDR'};
4290: }
1.1117 foxr 4291: my $path=LONCAPA::tempdir();
1.168 albertel 4292: my %hash;
4293: if (tie(%hash,'GDBM_File',
4294: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4295: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 4296: foreach my $key (keys(%hash)) {
1.180 albertel 4297: if ($key=~ /:$symb/) {
1.168 albertel 4298: delete($hash{$key});
4299: }
4300: }
4301: }
4302: }
4303:
1.167 albertel 4304: sub tmpstore {
1.168 albertel 4305: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4306:
4307: if (!$symb) {
4308: $symb=&symbread();
1.620 albertel 4309: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4310: }
4311: $symb=escape($symb);
4312:
4313: if (!$namespace) {
4314: # I don't think we would ever want to store this for a course.
4315: # it seems this will only be used if we don't have a course.
1.620 albertel 4316: #$namespace=$env{'request.course.id'};
1.168 albertel 4317: #if (!$namespace) {
1.620 albertel 4318: $namespace=$env{'request.state'};
1.168 albertel 4319: #}
4320: }
4321: $namespace=~s/\//\_/g;
4322: $namespace=~s/\W//g;
1.620 albertel 4323: if (!$domain) { $domain=$env{'user.domain'}; }
4324: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4325: if ($domain eq 'public' && $stuname eq 'public') {
4326: $stuname=$ENV{'REMOTE_ADDR'};
4327: }
1.168 albertel 4328: my $now=time;
4329: my %hash;
1.1117 foxr 4330: my $path=LONCAPA::tempdir();
1.168 albertel 4331: if (tie(%hash,'GDBM_File',
4332: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4333: &GDBM_WRCREAT(),0640)) {
1.168 albertel 4334: $hash{"version:$symb"}++;
4335: my $version=$hash{"version:$symb"};
4336: my $allkeys='';
4337: foreach my $key (keys(%$storehash)) {
4338: $allkeys.=$key.':';
1.591 albertel 4339: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 4340: }
4341: $hash{"$version:$symb:timestamp"}=$now;
4342: $allkeys.='timestamp';
4343: $hash{"$version:keys:$symb"}=$allkeys;
4344: if (untie(%hash)) {
4345: return 'ok';
4346: } else {
4347: return "error:$!";
4348: }
4349: } else {
4350: return "error:$!";
4351: }
4352: }
1.167 albertel 4353:
1.168 albertel 4354: # -----------------------------------------------------------------Temp Restore
1.167 albertel 4355:
1.168 albertel 4356: sub tmprestore {
4357: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 4358:
1.168 albertel 4359: if (!$symb) {
4360: $symb=&symbread();
1.620 albertel 4361: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4362: }
4363: $symb=escape($symb);
4364:
1.620 albertel 4365: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 4366:
1.620 albertel 4367: if (!$domain) { $domain=$env{'user.domain'}; }
4368: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4369: if ($domain eq 'public' && $stuname eq 'public') {
4370: $stuname=$ENV{'REMOTE_ADDR'};
4371: }
1.168 albertel 4372: my %returnhash;
4373: $namespace=~s/\//\_/g;
4374: $namespace=~s/\W//g;
4375: my %hash;
1.1117 foxr 4376: my $path=LONCAPA::tempdir();
1.168 albertel 4377: if (tie(%hash,'GDBM_File',
4378: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4379: &GDBM_READER(),0640)) {
1.168 albertel 4380: my $version=$hash{"version:$symb"};
4381: $returnhash{'version'}=$version;
4382: my $scope;
4383: for ($scope=1;$scope<=$version;$scope++) {
4384: my $vkeys=$hash{"$scope:keys:$symb"};
4385: my @keys=split(/:/,$vkeys);
4386: my $key;
4387: $returnhash{"$scope:keys"}=$vkeys;
4388: foreach $key (@keys) {
1.591 albertel 4389: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4390: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 4391: }
4392: }
1.168 albertel 4393: if (!(untie(%hash))) {
4394: return "error:$!";
4395: }
4396: } else {
4397: return "error:$!";
4398: }
4399: return %returnhash;
1.167 albertel 4400: }
4401:
1.9 www 4402: # ----------------------------------------------------------------------- Store
4403:
4404: sub store {
1.124 www 4405: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4406: my $home='';
4407:
1.168 albertel 4408: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4409:
1.213 www 4410: $symb=&symbclean($symb);
1.122 albertel 4411: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 4412:
1.620 albertel 4413: if (!$domain) { $domain=$env{'user.domain'}; }
4414: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 4415:
4416: &devalidate($symb,$stuname,$domain);
1.109 www 4417:
4418: $symb=escape($symb);
1.187 www 4419: if (!$namespace) {
1.620 albertel 4420: unless ($namespace=$env{'request.course.id'}) {
1.187 www 4421: return '';
4422: }
4423: }
1.620 albertel 4424: if (!$home) { $home=$env{'user.home'}; }
1.447 www 4425:
4426: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4427: $$storehash{'host'}=$perlvar{'lonHostID'};
4428:
1.12 www 4429: my $namevalue='';
1.800 albertel 4430: foreach my $key (keys(%$storehash)) {
4431: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 4432: }
1.12 www 4433: $namevalue=~s/\&$//;
1.187 www 4434: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 4435: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 4436: }
4437:
1.47 www 4438: # -------------------------------------------------------------- Critical Store
4439:
4440: sub cstore {
1.124 www 4441: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4442: my $home='';
4443:
1.168 albertel 4444: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4445:
1.213 www 4446: $symb=&symbclean($symb);
1.122 albertel 4447: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 4448:
1.620 albertel 4449: if (!$domain) { $domain=$env{'user.domain'}; }
4450: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 4451:
4452: &devalidate($symb,$stuname,$domain);
1.109 www 4453:
4454: $symb=escape($symb);
1.187 www 4455: if (!$namespace) {
1.620 albertel 4456: unless ($namespace=$env{'request.course.id'}) {
1.187 www 4457: return '';
4458: }
4459: }
1.620 albertel 4460: if (!$home) { $home=$env{'user.home'}; }
1.447 www 4461:
4462: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4463: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 4464:
1.47 www 4465: my $namevalue='';
1.800 albertel 4466: foreach my $key (keys(%$storehash)) {
4467: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 4468: }
1.47 www 4469: $namevalue=~s/\&$//;
1.187 www 4470: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 4471: return critical
4472: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 4473: }
4474:
1.9 www 4475: # --------------------------------------------------------------------- Restore
4476:
4477: sub restore {
1.124 www 4478: my ($symb,$namespace,$domain,$stuname) = @_;
4479: my $home='';
4480:
1.168 albertel 4481: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4482:
1.122 albertel 4483: if (!$symb) {
4484: unless ($symb=escape(&symbread())) { return ''; }
4485: } else {
1.213 www 4486: $symb=&escape(&symbclean($symb));
1.122 albertel 4487: }
1.188 www 4488: if (!$namespace) {
1.620 albertel 4489: unless ($namespace=$env{'request.course.id'}) {
1.188 www 4490: return '';
4491: }
4492: }
1.620 albertel 4493: if (!$domain) { $domain=$env{'user.domain'}; }
4494: if (!$stuname) { $stuname=$env{'user.name'}; }
4495: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 4496: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
4497:
1.12 www 4498: my %returnhash=();
1.800 albertel 4499: foreach my $line (split(/\&/,$answer)) {
4500: my ($name,$value)=split(/\=/,$line);
1.591 albertel 4501: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 4502: }
1.75 www 4503: my $version;
4504: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 4505: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
4506: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 4507: }
1.75 www 4508: }
1.13 www 4509: return %returnhash;
1.34 www 4510: }
4511:
4512: # ---------------------------------------------------------- Course Description
1.1118 foxr 4513: #
4514: #
1.34 www 4515:
4516: sub coursedescription {
1.731 albertel 4517: my ($courseid,$args)=@_;
1.34 www 4518: $courseid=~s/^\///;
1.49 www 4519: $courseid=~s/\_/\//g;
1.34 www 4520: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 4521: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 4522: my $normalid=$cdomain.'_'.$cnum;
4523: # need to always cache even if we get errors otherwise we keep
4524: # trying and trying and trying to get the course description.
4525: my %envhash=();
4526: my %returnhash=();
1.731 albertel 4527:
4528: my $expiretime=600;
4529: if ($env{'request.course.id'} eq $normalid) {
4530: $expiretime=120;
4531: }
4532:
4533: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
4534: if (!$args->{'freshen_cache'}
4535: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
4536: foreach my $key (keys(%env)) {
4537: next if ($key !~ /^\Q$prefix\E(.*)/);
4538: my ($setting) = $1;
4539: $returnhash{$setting} = $env{$key};
4540: }
4541: return %returnhash;
4542: }
4543:
1.1118 foxr 4544: # get the data again
4545:
1.731 albertel 4546: if (!$args->{'one_time'}) {
4547: $envhash{'course.'.$normalid.'.last_cache'}=time;
4548: }
1.811 albertel 4549:
1.34 www 4550: if ($chome ne 'no_host') {
1.302 albertel 4551: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 4552: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 4553: my $username = $env{'user.name'}; # Defult username
4554: if(defined $args->{'user'}) {
4555: $username = $args->{'user'};
4556: }
1.129 albertel 4557: $returnhash{'home'}= $chome;
4558: $returnhash{'domain'} = $cdomain;
4559: $returnhash{'num'} = $cnum;
1.741 raeburn 4560: if (!defined($returnhash{'type'})) {
4561: $returnhash{'type'} = 'Course';
4562: }
1.130 albertel 4563: while (my ($name,$value) = each %returnhash) {
1.53 www 4564: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 4565: }
1.270 www 4566: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 4567: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 4568: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 4569: $envhash{'course.'.$normalid.'.home'}=$chome;
4570: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
4571: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 4572: }
4573: }
1.731 albertel 4574: if (!$args->{'one_time'}) {
1.949 raeburn 4575: &appenv(\%envhash);
1.731 albertel 4576: }
1.302 albertel 4577: return %returnhash;
1.461 www 4578: }
4579:
1.1080 raeburn 4580: sub update_released_required {
4581: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
4582: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
4583: $cid = $env{'request.course.id'};
4584: $cdom = $env{'course.'.$cid.'.domain'};
4585: $cnum = $env{'course.'.$cid.'.num'};
4586: $chome = $env{'course.'.$cid.'.home'};
4587: }
4588: if ($needsrelease) {
4589: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
4590: my $needsupdate;
4591: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
4592: $needsupdate = 1;
4593: } else {
4594: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
4595: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
4596: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
4597: $needsupdate = 1;
4598: }
4599: }
4600: if ($needsupdate) {
4601: my %needshash = (
4602: 'internal.releaserequired' => $needsrelease,
4603: );
4604: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
4605: if ($putresult eq 'ok') {
4606: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
4607: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
4608: if (ref($crsinfo{$cid}) eq 'HASH') {
4609: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
4610: &courseidput($cdom,\%crsinfo,$chome,'notime');
4611: }
4612: }
4613: }
4614: }
4615: return;
4616: }
4617:
1.461 www 4618: # -------------------------------------------------See if a user is privileged
4619:
4620: sub privileged {
4621: my ($username,$domain)=@_;
1.1170 droeschl 4622:
4623: my %rolesdump = &dump("roles", $domain, $username) or return 0;
4624: my $now = time;
4625:
4626: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys %rolesdump}) {
4627: my ($trole, $tend, $tstart) = split(/_/, $role);
4628: if (($trole eq 'dc') || ($trole eq 'su')) {
4629: return 1 unless ($tend && $tend < $now)
4630: or ($tstart && $tstart > $now);
4631: }
1.461 www 4632: }
1.1170 droeschl 4633:
1.461 www 4634: return 0;
1.9 www 4635: }
1.1 albertel 4636:
1.103 harris41 4637: # -------------------------------------------------------- Get user privileges
1.11 www 4638:
4639: sub rolesinit {
1.1169 droeschl 4640: my ($domain, $username) = @_;
4641: my %userroles = ('user.login.time' => time);
4642: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
4643:
4644: # firstaccess and timerinterval are related to timed maps/resources.
4645: # also, blocking can be triggered by an activating timer
4646: # it's saved in the user's %env.
4647: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
4648: my %timerinterval = &dump('timerinterval', $domain, $username);
4649: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
4650: %timerintchk, %timerintenv);
4651:
1.1162 raeburn 4652: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 4653: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 4654: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
4655: }
1.1169 droeschl 4656:
1.1162 raeburn 4657: foreach my $key (keys(%timerinterval)) {
4658: my ($cid,$rest) = split(/\0/,$key);
4659: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
4660: }
1.1169 droeschl 4661:
1.11 www 4662: my %allroles=();
1.1162 raeburn 4663: my %allgroups=();
1.11 www 4664:
1.1169 droeschl 4665: for my $area (grep { ! /^rolesdef_/ } keys %rolesdump) {
4666: my $role = $rolesdump{$area};
4667: $area =~ s/\_\w\w$//;
4668:
4669: my ($trole, $tend, $tstart, $group_privs);
4670:
4671: if ($role =~ /^cr/) {
4672: # Custom role, defined by a user
4673: # e.g., user.role.cr/msu/smith/mynewrole
4674: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
4675: $trole = $1;
4676: ($tend, $tstart) = split('_', $2);
4677: } else {
4678: $trole = $role;
4679: }
4680: } elsif ($role =~ m|^gr/|) {
4681: # Role of member in a group, defined within a course/community
4682: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
4683: ($trole, $tend, $tstart) = split(/_/, $role);
4684: next if $tstart eq '-1';
4685: ($trole, $group_privs) = split(/\//, $trole);
4686: $group_privs = &unescape($group_privs);
4687: } else {
4688: # Just a normal role, defined in roles.tab
4689: ($trole, $tend, $tstart) = split(/_/,$role);
4690: }
4691:
4692: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
4693: $username);
4694: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
4695:
4696: # role expired or not available yet?
4697: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
4698: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
4699:
4700: next if $area eq '' or $trole eq '';
4701:
4702: my $spec = "$trole.$area";
4703: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
4704:
4705: if ($trole =~ /^cr\//) {
4706: # Custom role, defined by a user
4707: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4708: } elsif ($trole eq 'gr') {
4709: # Role of a member in a group, defined within a course/community
4710: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
4711: next;
4712: } else {
4713: # Normal role, defined in roles.tab
4714: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4715: }
4716:
4717: my $cid = $tdomain.'_'.$trest;
4718: unless ($firstaccchk{$cid}) {
4719: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
4720: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
4721: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
4722: $coursetimerstarts{$cid}{$item};
4723: }
4724: }
4725: $firstaccchk{$cid} = 1;
4726: }
4727: unless ($timerintchk{$cid}) {
4728: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
4729: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
4730: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
4731: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 4732: }
1.12 www 4733: }
1.1169 droeschl 4734: $timerintchk{$cid} = 1;
1.191 harris41 4735: }
1.11 www 4736: }
1.1169 droeschl 4737:
4738: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
4739: \%allroles, \%allgroups);
4740: $env{'user.adv'} = $userroles{'user.adv'};
4741:
1.1162 raeburn 4742: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 4743: }
4744:
1.567 raeburn 4745: sub set_arearole {
4746: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
4747: # log the associated role with the area
4748: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 4749: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 4750: }
4751:
4752: sub custom_roleprivs {
4753: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
4754: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
4755: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 4756: if (&hostname($homsvr) ne '') {
1.567 raeburn 4757: my ($rdummy,$roledef)=
4758: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
4759: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
4760: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
4761: if (defined($syspriv)) {
1.1043 raeburn 4762: if ($trest =~ /^$match_community$/) {
4763: $syspriv =~ s/bre\&S//;
4764: }
1.567 raeburn 4765: $$allroles{'cm./'}.=':'.$syspriv;
4766: $$allroles{$spec.'./'}.=':'.$syspriv;
4767: }
4768: if ($tdomain ne '') {
4769: if (defined($dompriv)) {
4770: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
4771: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
4772: }
4773: if (($trest ne '') && (defined($coursepriv))) {
4774: $$allroles{'cm.'.$area}.=':'.$coursepriv;
4775: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
4776: }
4777: }
4778: }
4779: }
4780: }
4781:
1.678 raeburn 4782: sub group_roleprivs {
4783: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4784: my $access = 1;
4785: my $now = time;
4786: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4787: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4788: if ($access) {
1.811 albertel 4789: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 4790: $$allgroups{$course}{$group} .=':'.$group_privs;
4791: }
4792: }
1.567 raeburn 4793:
4794: sub standard_roleprivs {
4795: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4796: if (defined($pr{$trole.':s'})) {
4797: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4798: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4799: }
4800: if ($tdomain ne '') {
4801: if (defined($pr{$trole.':d'})) {
4802: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4803: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4804: }
4805: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4806: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4807: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4808: }
4809: }
4810: }
4811:
4812: sub set_userprivs {
1.1064 raeburn 4813: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 4814: my $author=0;
4815: my $adv=0;
1.678 raeburn 4816: my %grouproles = ();
4817: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 4818: my @groupkeys;
1.1000 raeburn 4819: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 4820: push(@groupkeys,$role);
4821: }
4822: if (ref($groups_roles) eq 'HASH') {
4823: foreach my $key (keys(%{$groups_roles})) {
4824: unless (grep(/^\Q$key\E$/,@groupkeys)) {
4825: push(@groupkeys,$key);
4826: }
4827: }
4828: }
4829: if (@groupkeys > 0) {
4830: foreach my $role (@groupkeys) {
4831: my ($trole,$area,$sec,$extendedarea);
4832: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
4833: $trole = $1;
4834: $area = $2;
4835: $sec = $3;
4836: $extendedarea = $area.$sec;
4837: if (exists($$allgroups{$area})) {
4838: foreach my $group (keys(%{$$allgroups{$area}})) {
4839: my $spec = $trole.'.'.$extendedarea;
4840: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 4841: $$allgroups{$area}{$group};
1.1064 raeburn 4842: }
1.678 raeburn 4843: }
4844: }
4845: }
4846: }
4847: }
1.800 albertel 4848: foreach my $group (keys(%grouproles)) {
4849: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 4850: }
1.800 albertel 4851: foreach my $role (keys(%{$allroles})) {
4852: my %thesepriv;
1.941 raeburn 4853: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 4854: foreach my $item (split(/:/,$$allroles{$role})) {
4855: if ($item ne '') {
4856: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 4857: if ($restrictions eq '') {
4858: $thesepriv{$privilege}='F';
4859: } elsif ($thesepriv{$privilege} ne 'F') {
4860: $thesepriv{$privilege}.=$restrictions;
4861: }
4862: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4863: }
4864: }
4865: my $thesestr='';
1.1104 raeburn 4866: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 4867: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4868: }
4869: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 4870: }
4871: return ($author,$adv);
4872: }
4873:
1.994 raeburn 4874: sub role_status {
1.1104 raeburn 4875: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 4876: my @pwhere = ();
4877: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4878: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4879: unless (!defined($$role) || $$role eq '') {
4880: $$where=join('.',@pwhere);
4881: $$trolecode=$$role.'.'.$$where;
4882: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4883: $$tstatus='is';
1.1104 raeburn 4884: if ($$tstart && $$tstart>$update) {
1.994 raeburn 4885: $$tstatus='future';
1.1034 raeburn 4886: if ($$tstart<$now) {
4887: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 4888: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 4889: my (%allroles,%allgroups,$group_privs,
4890: %groups_roles,@rolecodes);
1.1002 raeburn 4891: my %userroles = (
4892: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4893: );
1.1064 raeburn 4894: @rolecodes = ('cm');
1.1002 raeburn 4895: my $spec=$$role.'.'.$$where;
4896: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4897: if ($$role =~ /^cr\//) {
4898: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 4899: push(@rolecodes,'cr');
1.1002 raeburn 4900: } elsif ($$role eq 'gr') {
1.1064 raeburn 4901: push(@rolecodes,$$role);
1.1002 raeburn 4902: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4903: $env{'user.name'});
1.1064 raeburn 4904: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 4905: (undef,my $group_privs) = split(/\//,$trole);
4906: $group_privs = &unescape($group_privs);
4907: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 4908: 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 4909: &get_groups_roles($tdomain,$trest,
4910: \%course_roles,\@rolecodes,
4911: \%groups_roles);
1.1002 raeburn 4912: } else {
1.1064 raeburn 4913: push(@rolecodes,$$role);
1.1002 raeburn 4914: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4915: }
1.1064 raeburn 4916: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4917: &appenv(\%userroles,\@rolecodes);
1.1002 raeburn 4918: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4919: }
4920: }
1.1034 raeburn 4921: $$tstatus = 'is';
1.1002 raeburn 4922: }
1.994 raeburn 4923: }
4924: if ($$tend) {
1.1104 raeburn 4925: if ($$tend<$update) {
1.994 raeburn 4926: $$tstatus='expired';
4927: } elsif ($$tend<$now) {
4928: $$tstatus='will_not';
4929: }
4930: }
4931: }
4932: }
4933: }
4934:
1.1104 raeburn 4935: sub get_groups_roles {
4936: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
4937: return unless((ref($cdom_courseroles) eq 'HASH') &&
4938: (ref($rolecodes) eq 'ARRAY') &&
4939: (ref($groups_roles) eq 'HASH'));
4940: if (keys(%{$cdom_courseroles}) > 0) {
4941: my ($cnum) = ($rest =~ /^($match_courseid)/);
4942: if ($cdom ne '' && $cnum ne '') {
4943: foreach my $key (keys(%{$cdom_courseroles})) {
4944: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
4945: my $crsrole = $1;
4946: my $crssec = $2;
4947: if ($crsrole =~ /^cr/) {
4948: unless (grep(/^cr$/,@{$rolecodes})) {
4949: push(@{$rolecodes},'cr');
4950: }
4951: } else {
4952: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
4953: push(@{$rolecodes},$crsrole);
4954: }
4955: }
4956: my $rolekey = "$crsrole./$cdom/$cnum";
4957: if ($crssec ne '') {
4958: $rolekey .= "/$crssec";
4959: }
4960: $rolekey .= './';
4961: $groups_roles->{$rolekey} = $rolecodes;
4962: }
4963: }
4964: }
4965: }
4966: return;
4967: }
4968:
4969: sub delete_env_groupprivs {
4970: my ($where,$courseroles,$possroles) = @_;
4971: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
4972: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
4973: unless (ref($courseroles->{$udom}) eq 'HASH') {
4974: %{$courseroles->{$udom}} =
4975: &get_my_roles('','','userroles',['active'],
4976: $possroles,[$udom],1);
4977: }
4978: if (ref($courseroles->{$udom}) eq 'HASH') {
4979: foreach my $item (keys(%{$courseroles->{$udom}})) {
4980: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
4981: my $area = '/'.$cdom.'/'.$cnum;
4982: my $privkey = "user.priv.$crsrole.$area";
4983: if ($crssec ne '') {
4984: $privkey .= '/'.$crssec;
4985: }
4986: $privkey .= ".$area/$group";
4987: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
4988: }
4989: }
4990: return;
4991: }
4992:
1.994 raeburn 4993: sub check_adhoc_privs {
1.1104 raeburn 4994: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
1.994 raeburn 4995: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4996: if ($env{$cckey}) {
4997: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 4998: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 4999: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1088 raeburn 5000: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.994 raeburn 5001: }
5002: } else {
1.1088 raeburn 5003: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.994 raeburn 5004: }
5005: }
5006:
5007: sub set_adhoc_privileges {
5008: # role can be cc or ca
1.1088 raeburn 5009: my ($dcdom,$pickedcourse,$role,$caller) = @_;
1.994 raeburn 5010: my $area = '/'.$dcdom.'/'.$pickedcourse;
5011: my $spec = $role.'.'.$area;
5012: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
5013: $env{'user.name'});
5014: my %ccrole = ();
5015: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
5016: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
5017: &appenv(\%userroles,[$role,'cm']);
5018: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
1.1088 raeburn 5019: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
5020: &appenv( {'request.role' => $spec,
5021: 'request.role.domain' => $dcdom,
5022: 'request.course.sec' => ''
5023: }
5024: );
5025: my $tadv=0;
5026: if (&allowed('adv') eq 'F') { $tadv=1; }
5027: &appenv({'request.role.adv' => $tadv});
5028: }
1.994 raeburn 5029: }
5030:
1.12 www 5031: # --------------------------------------------------------------- get interface
5032:
5033: sub get {
1.131 albertel 5034: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 5035: my $items='';
1.800 albertel 5036: foreach my $item (@$storearr) {
5037: $items.=&escape($item).'&';
1.191 harris41 5038: }
1.12 www 5039: $items=~s/\&$//;
1.620 albertel 5040: if (!$udomain) { $udomain=$env{'user.domain'}; }
5041: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 5042: my $uhome=&homeserver($uname,$udomain);
5043:
1.133 albertel 5044: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 5045: my @pairs=split(/\&/,$rep);
1.273 albertel 5046: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
5047: return @pairs;
5048: }
1.15 www 5049: my %returnhash=();
1.42 www 5050: my $i=0;
1.800 albertel 5051: foreach my $item (@$storearr) {
5052: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 5053: $i++;
1.191 harris41 5054: }
1.15 www 5055: return %returnhash;
1.27 www 5056: }
5057:
5058: # --------------------------------------------------------------- del interface
5059:
5060: sub del {
1.133 albertel 5061: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 5062: my $items='';
1.800 albertel 5063: foreach my $item (@$storearr) {
5064: $items.=&escape($item).'&';
1.191 harris41 5065: }
1.984 neumanie 5066:
1.27 www 5067: $items=~s/\&$//;
1.620 albertel 5068: if (!$udomain) { $udomain=$env{'user.domain'}; }
5069: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 5070: my $uhome=&homeserver($uname,$udomain);
5071: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 5072: }
5073:
5074: # -------------------------------------------------------------- dump interface
5075:
5076: sub dump {
1.1166 raeburn 5077: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.755 albertel 5078: if (!$udomain) { $udomain=$env{'user.domain'}; }
5079: if (!$uname) { $uname=$env{'user.name'}; }
5080: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 5081:
1.755 albertel 5082: if ($regexp) {
5083: $regexp=&escape($regexp);
5084: } else {
5085: $regexp='.';
5086: }
1.1166 raeburn 5087: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 5088: my @pairs=split(/\&/,$rep);
5089: my %returnhash=();
1.1098 foxr 5090: if (!($rep =~ /^error/ )) {
5091: foreach my $item (@pairs) {
5092: my ($key,$value)=split(/=/,$item,2);
5093: $key = &unescape($key);
5094: next if ($key =~ /^error: 2 /);
5095: $returnhash{$key}=&thaw_unescape($value);
5096: }
1.755 albertel 5097: }
5098: return %returnhash;
1.407 www 5099: }
5100:
1.1098 foxr 5101:
1.717 albertel 5102: # --------------------------------------------------------- dumpstore interface
5103:
5104: sub dumpstore {
5105: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 5106: if (!$udomain) { $udomain=$env{'user.domain'}; }
5107: if (!$uname) { $uname=$env{'user.name'}; }
5108: my $uhome=&homeserver($uname,$udomain);
5109: if ($regexp) {
5110: $regexp=&escape($regexp);
5111: } else {
5112: $regexp='.';
5113: }
5114: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
5115: my @pairs=split(/\&/,$rep);
5116: my %returnhash=();
5117: foreach my $item (@pairs) {
5118: my ($key,$value)=split(/=/,$item,2);
5119: next if ($key =~ /^error: 2 /);
5120: $returnhash{$key}=&thaw_unescape($value);
5121: }
5122: return %returnhash;
1.717 albertel 5123: }
5124:
1.407 www 5125: # -------------------------------------------------------------- keys interface
5126:
5127: sub getkeys {
5128: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 5129: if (!$udomain) { $udomain=$env{'user.domain'}; }
5130: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 5131: my $uhome=&homeserver($uname,$udomain);
5132: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
5133: my @keyarray=();
1.800 albertel 5134: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 5135: next if ($key =~ /^error: 2 /);
1.800 albertel 5136: push(@keyarray,&unescape($key));
1.407 www 5137: }
5138: return @keyarray;
1.318 matthew 5139: }
5140:
1.319 matthew 5141: # --------------------------------------------------------------- currentdump
5142: sub currentdump {
1.328 matthew 5143: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 5144: $courseid = $env{'request.course.id'} if (! defined($courseid));
5145: $sdom = $env{'user.domain'} if (! defined($sdom));
5146: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 5147: my $uhome = &homeserver($sname,$sdom);
5148: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 5149: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 5150: #
1.318 matthew 5151: my %returnhash=();
1.319 matthew 5152: #
5153: if ($rep eq "unknown_cmd") {
5154: # an old lond will not know currentdump
5155: # Do a dump and make it look like a currentdump
1.822 albertel 5156: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 5157: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5158: my %hash = @tmp;
5159: @tmp=();
1.424 matthew 5160: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 5161: } else {
5162: my @pairs=split(/\&/,$rep);
1.800 albertel 5163: foreach my $pair (@pairs) {
5164: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 5165: my ($symb,$param) = split(/:/,$key);
5166: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 5167: &thaw_unescape($value);
1.319 matthew 5168: }
1.191 harris41 5169: }
1.12 www 5170: return %returnhash;
1.424 matthew 5171: }
5172:
5173: sub convert_dump_to_currentdump{
5174: my %hash = %{shift()};
5175: my %returnhash;
5176: # Code ripped from lond, essentially. The only difference
5177: # here is the unescaping done by lonnet::dump(). Conceivably
5178: # we might run in to problems with parameter names =~ /^v\./
5179: while (my ($key,$value) = each(%hash)) {
5180: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 5181: $symb = &unescape($symb);
5182: $param = &unescape($param);
1.424 matthew 5183: next if ($v eq 'version' || $symb eq 'keys');
5184: next if (exists($returnhash{$symb}) &&
5185: exists($returnhash{$symb}->{$param}) &&
5186: $returnhash{$symb}->{'v.'.$param} > $v);
5187: $returnhash{$symb}->{$param}=$value;
5188: $returnhash{$symb}->{'v.'.$param}=$v;
5189: }
5190: #
5191: # Remove all of the keys in the hashes which keep track of
5192: # the version of the parameter.
5193: while (my ($symb,$param_hash) = each(%returnhash)) {
5194: # use a foreach because we are going to delete from the hash.
5195: foreach my $key (keys(%$param_hash)) {
5196: delete($param_hash->{$key}) if ($key =~ /^v\./);
5197: }
5198: }
5199: return \%returnhash;
1.12 www 5200: }
5201:
1.627 albertel 5202: # ------------------------------------------------------ critical inc interface
5203:
5204: sub cinc {
5205: return &inc(@_,'critical');
5206: }
5207:
1.449 matthew 5208: # --------------------------------------------------------------- inc interface
5209:
5210: sub inc {
1.627 albertel 5211: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 5212: if (!$udomain) { $udomain=$env{'user.domain'}; }
5213: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 5214: my $uhome=&homeserver($uname,$udomain);
5215: my $items='';
5216: if (! ref($store)) {
5217: # got a single value, so use that instead
5218: $items = &escape($store).'=&';
5219: } elsif (ref($store) eq 'SCALAR') {
5220: $items = &escape($$store).'=&';
5221: } elsif (ref($store) eq 'ARRAY') {
5222: $items = join('=&',map {&escape($_);} @{$store});
5223: } elsif (ref($store) eq 'HASH') {
5224: while (my($key,$value) = each(%{$store})) {
5225: $items.= &escape($key).'='.&escape($value).'&';
5226: }
5227: }
5228: $items=~s/\&$//;
1.627 albertel 5229: if ($critical) {
5230: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
5231: } else {
5232: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
5233: }
1.449 matthew 5234: }
5235:
1.12 www 5236: # --------------------------------------------------------------- put interface
5237:
5238: sub put {
1.134 albertel 5239: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 5240: if (!$udomain) { $udomain=$env{'user.domain'}; }
5241: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 5242: my $uhome=&homeserver($uname,$udomain);
1.12 www 5243: my $items='';
1.800 albertel 5244: foreach my $item (keys(%$storehash)) {
5245: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 5246: }
1.12 www 5247: $items=~s/\&$//;
1.134 albertel 5248: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 5249: }
5250:
1.631 albertel 5251: # ------------------------------------------------------------ newput interface
5252:
5253: sub newput {
5254: my ($namespace,$storehash,$udomain,$uname)=@_;
5255: if (!$udomain) { $udomain=$env{'user.domain'}; }
5256: if (!$uname) { $uname=$env{'user.name'}; }
5257: my $uhome=&homeserver($uname,$udomain);
5258: my $items='';
5259: foreach my $key (keys(%$storehash)) {
5260: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5261: }
5262: $items=~s/\&$//;
5263: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
5264: }
5265:
5266: # --------------------------------------------------------- putstore interface
5267:
1.524 raeburn 5268: sub putstore {
1.715 albertel 5269: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 5270: if (!$udomain) { $udomain=$env{'user.domain'}; }
5271: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 5272: my $uhome=&homeserver($uname,$udomain);
5273: my $items='';
1.715 albertel 5274: foreach my $key (keys(%$storehash)) {
5275: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 5276: }
1.715 albertel 5277: $items=~s/\&$//;
1.716 albertel 5278: my $esc_symb=&escape($symb);
5279: my $esc_v=&escape($version);
1.715 albertel 5280: my $reply =
1.716 albertel 5281: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 5282: $uhome);
5283: if ($reply eq 'unknown_cmd') {
1.716 albertel 5284: # gfall back to way things use to be done
1.715 albertel 5285: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5286: $uname);
1.524 raeburn 5287: }
1.715 albertel 5288: return $reply;
5289: }
5290:
5291: sub old_putstore {
1.716 albertel 5292: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5293: if (!$udomain) { $udomain=$env{'user.domain'}; }
5294: if (!$uname) { $uname=$env{'user.name'}; }
5295: my $uhome=&homeserver($uname,$udomain);
5296: my %newstorehash;
1.800 albertel 5297: foreach my $item (keys(%$storehash)) {
5298: my $key = $version.':'.&escape($symb).':'.$item;
5299: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 5300: }
5301: my $items='';
5302: my %allitems = ();
1.800 albertel 5303: foreach my $item (keys(%newstorehash)) {
5304: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 5305: my $key = $1.':keys:'.$2;
5306: $allitems{$key} .= $3.':';
5307: }
1.800 albertel 5308: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 5309: }
1.800 albertel 5310: foreach my $item (keys(%allitems)) {
5311: $allitems{$item} =~ s/\:$//;
5312: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 5313: }
5314: $items=~s/\&$//;
5315: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 5316: }
5317:
1.47 www 5318: # ------------------------------------------------------ critical put interface
5319:
5320: sub cput {
1.134 albertel 5321: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 5322: if (!$udomain) { $udomain=$env{'user.domain'}; }
5323: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 5324: my $uhome=&homeserver($uname,$udomain);
1.47 www 5325: my $items='';
1.800 albertel 5326: foreach my $item (keys(%$storehash)) {
5327: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 5328: }
1.47 www 5329: $items=~s/\&$//;
1.134 albertel 5330: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 5331: }
5332:
5333: # -------------------------------------------------------------- eget interface
5334:
5335: sub eget {
1.133 albertel 5336: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 5337: my $items='';
1.800 albertel 5338: foreach my $item (@$storearr) {
5339: $items.=&escape($item).'&';
1.191 harris41 5340: }
1.12 www 5341: $items=~s/\&$//;
1.620 albertel 5342: if (!$udomain) { $udomain=$env{'user.domain'}; }
5343: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 5344: my $uhome=&homeserver($uname,$udomain);
5345: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 5346: my @pairs=split(/\&/,$rep);
5347: my %returnhash=();
1.42 www 5348: my $i=0;
1.800 albertel 5349: foreach my $item (@$storearr) {
5350: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 5351: $i++;
1.191 harris41 5352: }
1.12 www 5353: return %returnhash;
5354: }
5355:
1.667 albertel 5356: # ------------------------------------------------------------ tmpput interface
5357: sub tmpput {
1.802 raeburn 5358: my ($storehash,$server,$context)=@_;
1.667 albertel 5359: my $items='';
1.800 albertel 5360: foreach my $item (keys(%$storehash)) {
5361: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 5362: }
5363: $items=~s/\&$//;
1.802 raeburn 5364: if (defined($context)) {
5365: $items .= ':'.&escape($context);
5366: }
1.667 albertel 5367: return &reply("tmpput:$items",$server);
5368: }
5369:
5370: # ------------------------------------------------------------ tmpget interface
5371: sub tmpget {
1.688 albertel 5372: my ($token,$server)=@_;
5373: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5374: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 5375: my %returnhash;
5376: foreach my $item (split(/\&/,$rep)) {
5377: my ($key,$value)=split(/=/,$item);
1.951 raeburn 5378: next if ($key =~ /^error: 2 /);
1.667 albertel 5379: $returnhash{&unescape($key)}=&thaw_unescape($value);
5380: }
5381: return %returnhash;
5382: }
5383:
1.1113 raeburn 5384: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 5385: sub tmpdel {
5386: my ($token,$server)=@_;
5387: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5388: return &reply("tmpdel:$token",$server);
5389: }
5390:
1.765 albertel 5391: # -------------------------------------------------- portfolio access checking
5392:
5393: sub portfolio_access {
1.766 albertel 5394: my ($requrl) = @_;
1.765 albertel 5395: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
5396: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 5397: if ($result) {
5398: my %setters;
5399: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5400: my ($startblock,$endblock) =
5401: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
5402: if ($startblock && $endblock) {
5403: return 'B';
5404: }
5405: } else {
5406: my ($startblock,$endblock) =
5407: &Apache::loncommon::blockcheck(\%setters,'port');
5408: if ($startblock && $endblock) {
5409: return 'B';
5410: }
5411: }
5412: }
1.765 albertel 5413: if ($result eq 'ok') {
1.766 albertel 5414: return 'F';
1.765 albertel 5415: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 5416: return 'A';
1.765 albertel 5417: }
1.766 albertel 5418: return '';
1.765 albertel 5419: }
5420:
5421: sub get_portfolio_access {
1.767 albertel 5422: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
5423:
5424: if (!ref($access_hash)) {
5425: my $current_perms = &get_portfile_permissions($udom,$unum);
5426: my %access_controls = &get_access_controls($current_perms,$group,
5427: $file_name);
5428: $access_hash = $access_controls{$file_name};
5429: }
5430:
1.765 albertel 5431: my ($public,$guest,@domains,@users,@courses,@groups);
5432: my $now = time;
5433: if (ref($access_hash) eq 'HASH') {
5434: foreach my $key (keys(%{$access_hash})) {
5435: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5436: if ($start > $now) {
5437: next;
5438: }
5439: if ($end && $end<$now) {
5440: next;
5441: }
5442: if ($scope eq 'public') {
5443: $public = $key;
5444: last;
5445: } elsif ($scope eq 'guest') {
5446: $guest = $key;
5447: } elsif ($scope eq 'domains') {
5448: push(@domains,$key);
5449: } elsif ($scope eq 'users') {
5450: push(@users,$key);
5451: } elsif ($scope eq 'course') {
5452: push(@courses,$key);
5453: } elsif ($scope eq 'group') {
5454: push(@groups,$key);
5455: }
5456: }
5457: if ($public) {
5458: return 'ok';
5459: }
5460: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5461: if ($guest) {
5462: return $guest;
5463: }
5464: } else {
5465: if (@domains > 0) {
5466: foreach my $domkey (@domains) {
5467: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
5468: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
5469: return 'ok';
5470: }
5471: }
5472: }
5473: }
5474: if (@users > 0) {
5475: foreach my $userkey (@users) {
1.865 raeburn 5476: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
5477: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
5478: if (ref($item) eq 'HASH') {
5479: if (($item->{'uname'} eq $env{'user.name'}) &&
5480: ($item->{'udom'} eq $env{'user.domain'})) {
5481: return 'ok';
5482: }
5483: }
5484: }
5485: }
1.765 albertel 5486: }
5487: }
5488: my %roleshash;
5489: my @courses_and_groups = @courses;
5490: push(@courses_and_groups,@groups);
5491: if (@courses_and_groups > 0) {
5492: my (%allgroups,%allroles);
5493: my ($start,$end,$role,$sec,$group);
5494: foreach my $envkey (%env) {
1.1060 raeburn 5495: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 5496: my $cid = $2.'_'.$3;
5497: if ($1 eq 'gr') {
5498: $group = $4;
5499: $allgroups{$cid}{$group} = $env{$envkey};
5500: } else {
5501: if ($4 eq '') {
5502: $sec = 'none';
5503: } else {
5504: $sec = $4;
5505: }
5506: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5507: }
1.811 albertel 5508: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 5509: my $cid = $2.'_'.$3;
5510: if ($4 eq '') {
5511: $sec = 'none';
5512: } else {
5513: $sec = $4;
5514: }
5515: $allroles{$cid}{$1}{$sec} = $env{$envkey};
5516: }
5517: }
5518: if (keys(%allroles) == 0) {
5519: return;
5520: }
5521: foreach my $key (@courses_and_groups) {
5522: my %content = %{$$access_hash{$key}};
5523: my $cnum = $content{'number'};
5524: my $cdom = $content{'domain'};
5525: my $cid = $cdom.'_'.$cnum;
5526: if (!exists($allroles{$cid})) {
5527: next;
5528: }
5529: foreach my $role_id (keys(%{$content{'roles'}})) {
5530: my @sections = @{$content{'roles'}{$role_id}{'section'}};
5531: my @groups = @{$content{'roles'}{$role_id}{'group'}};
5532: my @status = @{$content{'roles'}{$role_id}{'access'}};
5533: my @roles = @{$content{'roles'}{$role_id}{'role'}};
5534: foreach my $role (keys(%{$allroles{$cid}})) {
5535: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
5536: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
5537: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
5538: if (grep/^all$/,@sections) {
5539: return 'ok';
5540: } else {
5541: if (grep/^$sec$/,@sections) {
5542: return 'ok';
5543: }
5544: }
5545: }
5546: }
5547: if (keys(%{$allgroups{$cid}}) == 0) {
5548: if (grep/^none$/,@groups) {
5549: return 'ok';
5550: }
5551: } else {
5552: if (grep/^all$/,@groups) {
5553: return 'ok';
5554: }
5555: foreach my $group (keys(%{$allgroups{$cid}})) {
5556: if (grep/^$group$/,@groups) {
5557: return 'ok';
5558: }
5559: }
5560: }
5561: }
5562: }
5563: }
5564: }
5565: }
5566: if ($guest) {
5567: return $guest;
5568: }
5569: }
5570: }
5571: return;
5572: }
5573:
5574: sub course_group_datechecker {
5575: my ($dates,$now,$status) = @_;
5576: my ($start,$end) = split(/\./,$dates);
5577: if (!$start && !$end) {
5578: return 'ok';
5579: }
5580: if (grep/^active$/,@{$status}) {
5581: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
5582: return 'ok';
5583: }
5584: }
5585: if (grep/^previous$/,@{$status}) {
5586: if ($end > $now ) {
5587: return 'ok';
5588: }
5589: }
5590: if (grep/^future$/,@{$status}) {
5591: if ($start > $now) {
5592: return 'ok';
5593: }
5594: }
5595: return;
5596: }
5597:
5598: sub parse_portfolio_url {
5599: my ($url) = @_;
5600:
5601: my ($type,$udom,$unum,$group,$file_name);
5602:
1.823 albertel 5603: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 5604: $type = 1;
5605: $udom = $1;
5606: $unum = $2;
5607: $file_name = $3;
1.823 albertel 5608: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 5609: $type = 2;
5610: $udom = $1;
5611: $unum = $2;
5612: $group = $3;
5613: $file_name = $3.'/'.$4;
5614: }
5615: if (wantarray) {
5616: return ($type,$udom,$unum,$file_name,$group);
5617: }
5618: return $type;
5619: }
5620:
5621: sub is_portfolio_url {
5622: my ($url) = @_;
5623: return scalar(&parse_portfolio_url($url));
5624: }
5625:
1.798 raeburn 5626: sub is_portfolio_file {
5627: my ($file) = @_;
1.820 raeburn 5628: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 5629: return 1;
5630: }
5631: return;
5632: }
5633:
1.976 raeburn 5634: sub usertools_access {
1.1084 raeburn 5635: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 5636: my ($access,%tools);
5637: if ($context eq '') {
5638: $context = 'tools';
5639: }
5640: if ($context eq 'requestcourses') {
5641: %tools = (
5642: official => 1,
5643: unofficial => 1,
1.1006 raeburn 5644: community => 1,
1.985 raeburn 5645: );
5646: } else {
5647: %tools = (
5648: aboutme => 1,
5649: blog => 1,
1.1177 ! raeburn 5650: webdav => 1,
1.985 raeburn 5651: portfolio => 1,
5652: );
5653: }
1.976 raeburn 5654: return if (!defined($tools{$tool}));
5655:
5656: if ((!defined($udom)) || (!defined($uname))) {
5657: $udom = $env{'user.domain'};
5658: $uname = $env{'user.name'};
5659: }
5660:
1.978 raeburn 5661: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
5662: if ($action ne 'reload') {
1.985 raeburn 5663: if ($context eq 'requestcourses') {
5664: return $env{'environment.canrequest.'.$tool};
5665: } else {
5666: return $env{'environment.availabletools.'.$tool};
5667: }
5668: }
1.976 raeburn 5669: }
5670:
5671: my ($toolstatus,$inststatus);
5672:
1.985 raeburn 5673: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
5674: ($action ne 'reload')) {
5675: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 5676: $inststatus = $env{'environment.inststatus'};
5677: } else {
1.1084 raeburn 5678: if (ref($userenvref) eq 'HASH') {
5679: $toolstatus = $userenvref->{$context.'.'.$tool};
5680: $inststatus = $userenvref->{'inststatus'};
5681: } else {
5682: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
5683: $toolstatus = $userenv{$context.'.'.$tool};
5684: $inststatus = $userenv{'inststatus'};
5685: }
1.976 raeburn 5686: }
5687:
5688: if ($toolstatus ne '') {
5689: if ($toolstatus) {
5690: $access = 1;
5691: } else {
5692: $access = 0;
5693: }
5694: return $access;
5695: }
5696:
1.1084 raeburn 5697: my ($is_adv,%domdef);
5698: if (ref($is_advref) eq 'HASH') {
5699: $is_adv = $is_advref->{'is_adv'};
5700: } else {
5701: $is_adv = &is_advanced_user($udom,$uname);
5702: }
5703: if (ref($domdefref) eq 'HASH') {
5704: %domdef = %{$domdefref};
5705: } else {
5706: %domdef = &get_domain_defaults($udom);
5707: }
1.976 raeburn 5708: if (ref($domdef{$tool}) eq 'HASH') {
5709: if ($is_adv) {
5710: if ($domdef{$tool}{'_LC_adv'} ne '') {
5711: if ($domdef{$tool}{'_LC_adv'}) {
5712: $access = 1;
5713: } else {
5714: $access = 0;
5715: }
5716: return $access;
5717: }
5718: }
5719: if ($inststatus ne '') {
5720: my ($hasaccess,$hasnoaccess);
5721: foreach my $affiliation (split(/:/,$inststatus)) {
5722: if ($domdef{$tool}{$affiliation} ne '') {
5723: if ($domdef{$tool}{$affiliation}) {
5724: $hasaccess = 1;
5725: } else {
5726: $hasnoaccess = 1;
5727: }
5728: }
5729: }
5730: if ($hasaccess || $hasnoaccess) {
5731: if ($hasaccess) {
5732: $access = 1;
5733: } elsif ($hasnoaccess) {
5734: $access = 0;
5735: }
5736: return $access;
5737: }
5738: } else {
5739: if ($domdef{$tool}{'default'} ne '') {
5740: if ($domdef{$tool}{'default'}) {
5741: $access = 1;
5742: } elsif ($domdef{$tool}{'default'} == 0) {
5743: $access = 0;
5744: }
5745: return $access;
5746: }
5747: }
5748: } else {
1.1177 ! raeburn 5749: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 5750: $access = 1;
5751: } else {
5752: $access = 0;
5753: }
1.976 raeburn 5754: return $access;
5755: }
5756: }
5757:
1.1050 raeburn 5758: sub is_course_owner {
5759: my ($cdom,$cnum,$udom,$uname) = @_;
5760: if (($udom eq '') || ($uname eq '')) {
5761: $udom = $env{'user.domain'};
5762: $uname = $env{'user.name'};
5763: }
5764: unless (($udom eq '') || ($uname eq '')) {
5765: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
5766: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
5767: return 1;
5768: } else {
5769: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
5770: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
5771: return 1;
5772: }
5773: }
5774: }
5775: }
5776: return;
5777: }
5778:
1.976 raeburn 5779: sub is_advanced_user {
5780: my ($udom,$uname) = @_;
1.1085 raeburn 5781: if ($udom ne '' && $uname ne '') {
5782: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 5783: if (wantarray) {
5784: return ($env{'user.adv'},$env{'user.author'});
5785: } else {
5786: return $env{'user.adv'};
5787: }
1.1085 raeburn 5788: }
5789: }
1.976 raeburn 5790: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
5791: my %allroles;
1.1128 raeburn 5792: my ($is_adv,$is_author);
1.976 raeburn 5793: foreach my $role (keys(%roleshash)) {
5794: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
5795: my $area = '/'.$tdomain.'/'.$trest;
5796: if ($sec ne '') {
5797: $area .= '/'.$sec;
5798: }
5799: if (($area ne '') && ($trole ne '')) {
5800: my $spec=$trole.'.'.$area;
5801: if ($trole =~ /^cr\//) {
5802: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5803: } elsif ($trole ne 'gr') {
5804: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5805: }
1.1128 raeburn 5806: if ($trole eq 'au') {
5807: $is_author = 1;
5808: }
1.976 raeburn 5809: }
5810: }
5811: foreach my $role (keys(%allroles)) {
5812: last if ($is_adv);
5813: foreach my $item (split(/:/,$allroles{$role})) {
5814: if ($item ne '') {
5815: my ($privilege,$restrictions)=split(/&/,$item);
5816: if ($privilege eq 'adv') {
5817: $is_adv = 1;
5818: last;
5819: }
5820: }
5821: }
5822: }
1.1128 raeburn 5823: if (wantarray) {
5824: return ($is_adv,$is_author);
5825: }
1.976 raeburn 5826: return $is_adv;
5827: }
1.798 raeburn 5828:
1.1035 raeburn 5829: sub check_can_request {
1.1036 raeburn 5830: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 5831: my $canreq = 0;
5832: my ($types,$typename) = &Apache::loncommon::course_types();
5833: my @options = ('approval','validate','autolimit');
5834: my $optregex = join('|',@options);
5835: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
5836: foreach my $type (@{$types}) {
5837: if (&usertools_access($env{'user.name'},
5838: $env{'user.domain'},
5839: $type,undef,'requestcourses')) {
5840: $canreq ++;
1.1036 raeburn 5841: if (ref($request_domains) eq 'HASH') {
5842: push(@{$request_domains->{$type}},$env{'user.domain'});
5843: }
1.1035 raeburn 5844: if ($dom eq $env{'user.domain'}) {
5845: $can_request->{$type} = 1;
5846: }
5847: }
5848: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
5849: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
5850: if (@curr > 0) {
1.1036 raeburn 5851: foreach my $item (@curr) {
5852: if (ref($request_domains) eq 'HASH') {
5853: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
5854: if ($otherdom ne '') {
5855: if (ref($request_domains->{$type}) eq 'ARRAY') {
5856: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
5857: push(@{$request_domains->{$type}},$otherdom);
5858: }
5859: } else {
5860: push(@{$request_domains->{$type}},$otherdom);
5861: }
5862: }
5863: }
5864: }
5865: unless($dom eq $env{'user.domain'}) {
5866: $canreq ++;
1.1035 raeburn 5867: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
5868: $can_request->{$type} = 1;
5869: }
5870: }
5871: }
5872: }
5873: }
5874: }
5875: return $canreq;
5876: }
5877:
1.341 www 5878: # ---------------------------------------------- Custom access rule evaluation
5879:
5880: sub customaccess {
5881: my ($priv,$uri)=@_;
1.807 albertel 5882: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 5883: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 5884: $udom = &LONCAPA::clean_domain($udom);
5885: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 5886: my $access=0;
1.800 albertel 5887: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 5888: my ($effect,$realm,$role,$type)=split(/\:/,$right);
5889: if ($type eq 'user') {
5890: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 5891: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 5892: if ($tdom) {
5893: if ($tdom ne $env{'user.domain'}) { next; }
5894: }
1.896 albertel 5895: if ($tuname) {
5896: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 5897: }
5898: $access=($effect eq 'allow');
5899: last;
5900: }
5901: } else {
5902: if ($role) {
5903: if ($role ne $urole) { next; }
5904: }
5905: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5906: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
5907: if ($tdom) {
5908: if ($tdom ne $udom) { next; }
5909: }
5910: if ($tcrs) {
5911: if ($tcrs ne $ucrs) { next; }
5912: }
5913: if ($tsec) {
5914: if ($tsec ne $usec) { next; }
5915: }
5916: $access=($effect eq 'allow');
5917: last;
5918: }
5919: if ($realm eq '' && $role eq '') {
5920: $access=($effect eq 'allow');
5921: }
1.402 bowersj2 5922: }
1.341 www 5923: }
5924: return $access;
5925: }
5926:
1.103 harris41 5927: # ------------------------------------------------- Check for a user privilege
1.12 www 5928:
5929: sub allowed {
1.810 raeburn 5930: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 5931: my $ver_orguri=$uri;
1.439 www 5932: $uri=&deversion($uri);
1.152 www 5933: my $orguri=$uri;
1.52 www 5934: $uri=&declutter($uri);
1.809 raeburn 5935:
1.810 raeburn 5936: if ($priv eq 'evb') {
5937: # Evade communication block restrictions for specified role in a course
5938: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
5939: return $1;
5940: } else {
5941: return;
5942: }
5943: }
5944:
1.620 albertel 5945: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 5946: # Free bre access to adm and meta resources
1.775 albertel 5947: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 5948: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5949: && ($priv eq 'bre')) {
1.14 www 5950: return 'F';
1.159 www 5951: }
5952:
1.545 banghart 5953: # Free bre access to user's own portfolio contents
1.714 raeburn 5954: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 5955: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 5956: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 5957: my %setters;
5958: my ($startblock,$endblock) =
5959: &Apache::loncommon::blockcheck(\%setters,'port');
5960: if ($startblock && $endblock) {
5961: return 'B';
5962: } else {
5963: return 'F';
5964: }
1.545 banghart 5965: }
5966:
1.762 raeburn 5967: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 5968: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5969: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5970: if (exists($env{'request.course.id'})) {
5971: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5972: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5973: if (($domain eq $cdom) && ($name eq $cnum)) {
5974: my $courseprivid=$env{'request.course.id'};
5975: $courseprivid=~s/\_/\//;
5976: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5977: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5978: return $1;
1.762 raeburn 5979: } else {
5980: if ($env{'request.course.sec'}) {
5981: $courseprivid.='/'.$env{'request.course.sec'};
5982: }
5983: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5984: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5985: return $2;
5986: }
1.714 raeburn 5987: }
5988: }
5989: }
5990: }
5991:
1.159 www 5992: # Free bre to public access
5993:
5994: if ($priv eq 'bre') {
1.238 www 5995: my $copyright=&metadata($uri,'copyright');
1.620 albertel 5996: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 5997: return 'F';
5998: }
1.238 www 5999: if ($copyright eq 'priv') {
6000: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 6001: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 6002: return '';
6003: }
6004: }
6005: if ($copyright eq 'domain') {
6006: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 6007: unless (($env{'user.domain'} eq $1) ||
6008: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 6009: return '';
6010: }
1.262 matthew 6011: }
1.620 albertel 6012: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 6013: # Library role, so allow browsing of resources in this domain.
6014: return 'F';
1.238 www 6015: }
1.341 www 6016: if ($copyright eq 'custom') {
6017: unless (&customaccess($priv,$uri)) { return ''; }
6018: }
1.14 www 6019: }
1.264 matthew 6020: # Domain coordinator is trying to create a course
1.620 albertel 6021: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 6022: # uri is the requested domain in this case.
6023: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 6024: # a role of dc for the domain in question.
1.620 albertel 6025: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 6026: }
1.29 www 6027:
1.52 www 6028: my $thisallowed='';
6029: my $statecond=0;
6030: my $courseprivid='';
6031:
1.1039 raeburn 6032: my $ownaccess;
1.1043 raeburn 6033: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 6034: if (($priv eq 'bro') && ($env{'user.author'})) {
6035: if ($uri eq '') {
6036: $ownaccess = 1;
6037: } else {
6038: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
6039: my $udom = $env{'user.domain'};
6040: my $uname = $env{'user.name'};
6041: if ($uri =~ m{^\Q$udom\E/?$}) {
6042: $ownaccess = 1;
1.1040 raeburn 6043: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 6044: unless ($uri =~ m{\.\./}) {
6045: $ownaccess = 1;
6046: }
6047: } elsif (($udom ne 'public') && ($uname ne 'public')) {
6048: my $now = time;
6049: if ($uri =~ m{^([^/]+)/?$}) {
6050: my $adom = $1;
6051: foreach my $key (keys(%env)) {
1.1042 raeburn 6052: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 6053: my ($start,$end) = split('.',$env{$key});
6054: if (($now >= $start) && (!$end || $end < $now)) {
6055: $ownaccess = 1;
6056: last;
6057: }
6058: }
6059: }
6060: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
6061: my $adom = $1;
6062: my $aname = $2;
1.1042 raeburn 6063: foreach my $role ('ca','aa') {
6064: if ($env{"user.role.$role./$adom/$aname"}) {
6065: my ($start,$end) =
6066: split('.',$env{"user.role.$role./$adom/$aname"});
6067: if (($now >= $start) && (!$end || $end < $now)) {
6068: $ownaccess = 1;
6069: last;
6070: }
1.1039 raeburn 6071: }
6072: }
6073: }
6074: }
6075: }
6076: }
6077: }
6078:
1.52 www 6079: # Course
6080:
1.620 albertel 6081: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6082: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6083: $thisallowed.=$1;
6084: }
1.52 www 6085: }
1.29 www 6086:
1.52 www 6087: # Domain
6088:
1.620 albertel 6089: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 6090: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6091: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6092: $thisallowed.=$1;
6093: }
1.12 www 6094: }
1.52 www 6095:
1.1141 raeburn 6096: # User who is not author or co-author might still be able to edit
6097: # resource of an author in the domain (e.g., if Domain Coordinator).
6098: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
6099: (&allowed('mdc',$env{'request.course.id'}))) {
6100: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
6101: $thisallowed.=$1;
6102: }
6103: }
6104:
1.52 www 6105: # Course: uri itself is a course
1.66 www 6106: my $courseuri=$uri;
6107: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 6108: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 6109:
1.620 albertel 6110: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 6111: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6112: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6113: $thisallowed.=$1;
6114: }
1.12 www 6115: }
1.29 www 6116:
1.665 albertel 6117: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 6118: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 6119: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 6120: $thisallowed='';
1.671 raeburn 6121: my ($match)=&is_on_map($uri);
6122: if ($match) {
6123: if ($env{'user.priv.'.$env{'request.role'}.'./'}
6124: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 6125: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6126: if (@blockers > 0) {
6127: $thisallowed = 'B';
6128: } else {
6129: $thisallowed.=$1;
6130: }
1.671 raeburn 6131: }
6132: } else {
1.705 albertel 6133: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 6134: if ($refuri) {
6135: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 6136: $thisallowed='F';
1.671 raeburn 6137: } else {
6138: $refuri=&declutter($refuri);
6139: my ($match) = &is_on_map($refuri);
6140: if ($match) {
1.1162 raeburn 6141: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6142: if (@blockers > 0) {
6143: $thisallowed = 'B';
6144: } else {
6145: $thisallowed='F';
6146: }
1.671 raeburn 6147: }
1.669 raeburn 6148: }
1.671 raeburn 6149: }
6150: }
1.314 www 6151: }
1.492 albertel 6152:
1.766 albertel 6153: if ($priv eq 'bre'
6154: && $thisallowed ne 'F'
6155: && $thisallowed ne '2'
6156: && &is_portfolio_url($uri)) {
6157: $thisallowed = &portfolio_access($uri);
6158: }
6159:
1.52 www 6160: # Full access at system, domain or course-wide level? Exit.
1.29 www 6161: if ($thisallowed=~/F/) {
6162: return 'F';
6163: }
6164:
1.52 www 6165: # If this is generating or modifying users, exit with special codes
1.29 www 6166:
1.643 www 6167: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6168: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 6169: my ($audom,$auname)=split('/',$uri);
1.643 www 6170: # no author name given, so this just checks on the general right to make a co-author in this domain
6171: unless ($auname) { return $thisallowed; }
6172: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 6173: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6174: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6175: ($audom ne $env{'request.role.domain'}))) { return ''; }
6176: }
1.52 www 6177: return $thisallowed;
6178: }
6179: #
1.103 harris41 6180: # Gathered so far: system, domain and course wide privileges
1.52 www 6181: #
6182: # Course: See if uri or referer is an individual resource that is part of
6183: # the course
6184:
1.620 albertel 6185: if ($env{'request.course.id'}) {
1.232 www 6186:
1.620 albertel 6187: $courseprivid=$env{'request.course.id'};
6188: if ($env{'request.course.sec'}) {
6189: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 6190: }
6191: $courseprivid=~s/\_/\//;
6192: my $checkreferer=1;
1.232 www 6193: my ($match,$cond)=&is_on_map($uri);
6194: if ($match) {
6195: $statecond=$cond;
1.620 albertel 6196: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 6197: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 6198: my $value = $1;
6199: if ($priv eq 'bre') {
6200: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6201: if (@blockers > 0) {
6202: $thisallowed = 'B';
6203: } else {
6204: $thisallowed.=$value;
6205: }
6206: } else {
6207: $thisallowed.=$value;
6208: }
1.52 www 6209: $checkreferer=0;
6210: }
1.29 www 6211: }
1.83 www 6212:
1.148 www 6213: if ($checkreferer) {
1.620 albertel 6214: my $refuri=$env{'httpref.'.$orguri};
1.148 www 6215: unless ($refuri) {
1.800 albertel 6216: foreach my $key (keys(%env)) {
6217: if ($key=~/^httpref\..*\*/) {
6218: my $pattern=$key;
1.156 www 6219: $pattern=~s/^httpref\.\/res\///;
1.148 www 6220: $pattern=~s/\*/\[\^\/\]\+/g;
6221: $pattern=~s/\//\\\//g;
1.152 www 6222: if ($orguri=~/$pattern/) {
1.800 albertel 6223: $refuri=$env{$key};
1.148 www 6224: }
6225: }
1.191 harris41 6226: }
1.148 www 6227: }
1.232 www 6228:
1.148 www 6229: if ($refuri) {
1.152 www 6230: $refuri=&declutter($refuri);
1.232 www 6231: my ($match,$cond)=&is_on_map($refuri);
6232: if ($match) {
6233: my $refstatecond=$cond;
1.620 albertel 6234: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 6235: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 6236: my $value = $1;
6237: if ($priv eq 'bre') {
6238: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6239: if (@blockers > 0) {
6240: $thisallowed = 'B';
6241: } else {
6242: $thisallowed.=$value;
6243: }
6244: } else {
6245: $thisallowed.=$value;
6246: }
1.53 www 6247: $uri=$refuri;
6248: $statecond=$refstatecond;
1.52 www 6249: }
6250: }
1.148 www 6251: }
1.29 www 6252: }
1.52 www 6253: }
1.29 www 6254:
1.52 www 6255: #
1.103 harris41 6256: # Gathered now: all privileges that could apply, and condition number
1.52 www 6257: #
6258: #
6259: # Full or no access?
6260: #
1.29 www 6261:
1.52 www 6262: if ($thisallowed=~/F/) {
6263: return 'F';
6264: }
1.29 www 6265:
1.52 www 6266: unless ($thisallowed) {
6267: return '';
6268: }
1.29 www 6269:
1.52 www 6270: # Restrictions exist, deal with them
6271: #
6272: # C:according to course preferences
6273: # R:according to resource settings
6274: # L:unless locked
6275: # X:according to user session state
6276: #
6277:
6278: # Possibly locked functionality, check all courses
1.54 www 6279: # Locks might take effect only after 10 minutes cache expiration for other
6280: # courses, and 2 minutes for current course
1.52 www 6281:
6282: my $envkey;
6283: if ($thisallowed=~/L/) {
1.1000 raeburn 6284: foreach $envkey (keys(%env)) {
1.54 www 6285: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
6286: my $courseid=$2;
6287: my $roleid=$1.'.'.$2;
1.92 www 6288: $courseid=~s/^\///;
1.54 www 6289: my $expiretime=600;
1.620 albertel 6290: if ($env{'request.role'} eq $roleid) {
1.54 www 6291: $expiretime=120;
6292: }
6293: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
6294: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 6295: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 6296: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 6297: }
1.620 albertel 6298: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
6299: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
6300: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
6301: &log($env{'user.domain'},$env{'user.name'},
6302: $env{'user.home'},
1.57 www 6303: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 6304: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 6305: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 6306: return '';
6307: }
6308: }
1.620 albertel 6309: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
6310: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
6311: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
6312: &log($env{'user.domain'},$env{'user.name'},
6313: $env{'user.home'},
1.57 www 6314: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 6315: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 6316: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 6317: return '';
6318: }
6319: }
6320: }
1.29 www 6321: }
1.52 www 6322: }
6323:
6324: #
6325: # Rest of the restrictions depend on selected course
6326: #
6327:
1.620 albertel 6328: unless ($env{'request.course.id'}) {
1.766 albertel 6329: if ($thisallowed eq 'A') {
6330: return 'A';
1.814 raeburn 6331: } elsif ($thisallowed eq 'B') {
6332: return 'B';
1.766 albertel 6333: } else {
6334: return '1';
6335: }
1.52 www 6336: }
1.29 www 6337:
1.52 www 6338: #
6339: # Now user is definitely in a course
6340: #
1.53 www 6341:
6342:
6343: # Course preferences
6344:
6345: if ($thisallowed=~/C/) {
1.620 albertel 6346: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6347: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
6348: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 6349: =~/\Q$rolecode\E/) {
1.1103 raeburn 6350: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 6351: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6352: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
6353: $env{'request.course.id'});
6354: }
1.237 www 6355: return '';
6356: }
6357:
1.620 albertel 6358: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 6359: =~/\Q$unamedom\E/) {
1.1103 raeburn 6360: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 6361: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
6362: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
6363: $env{'request.course.id'});
6364: }
1.54 www 6365: return '';
6366: }
1.53 www 6367: }
6368:
6369: # Resource preferences
6370:
6371: if ($thisallowed=~/R/) {
1.620 albertel 6372: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 6373: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 6374: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 6375: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6376: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
6377: }
6378: return '';
1.54 www 6379: }
1.53 www 6380: }
1.30 www 6381:
1.246 www 6382: # Restricted by state or randomout?
1.30 www 6383:
1.52 www 6384: if ($thisallowed=~/X/) {
1.620 albertel 6385: if ($env{'acc.randomout'}) {
1.579 albertel 6386: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 6387: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 6388: return '';
6389: }
1.247 www 6390: }
6391: if (&condval($statecond)) {
1.52 www 6392: return '2';
6393: } else {
6394: return '';
6395: }
6396: }
1.30 www 6397:
1.766 albertel 6398: if ($thisallowed eq 'A') {
6399: return 'A';
1.814 raeburn 6400: } elsif ($thisallowed eq 'B') {
6401: return 'B';
1.766 albertel 6402: }
1.52 www 6403: return 'F';
1.232 www 6404: }
1.1162 raeburn 6405:
6406: sub get_comm_blocks {
6407: my ($cdom,$cnum) = @_;
6408: if ($cdom eq '' || $cnum eq '') {
6409: return unless ($env{'request.course.id'});
6410: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6411: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6412: }
6413: my %commblocks;
6414: my $hashid=$cdom.'_'.$cnum;
6415: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
6416: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
6417: %commblocks = %{$blocksref};
6418: } else {
6419: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
6420: my $cachetime = 600;
6421: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
6422: }
6423: return %commblocks;
6424: }
6425:
6426: sub has_comm_blocking {
6427: my ($priv,$symb,$uri,$blocks) = @_;
6428: return unless ($env{'request.course.id'});
6429: return unless ($priv eq 'bre');
6430: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
6431: my %commblocks;
6432: if (ref($blocks) eq 'HASH') {
6433: %commblocks = %{$blocks};
6434: } else {
6435: %commblocks = &get_comm_blocks();
6436: }
6437: return unless (keys(%commblocks) > 0);
6438: if (!$symb) { $symb=&symbread($uri,1); }
6439: my ($map,$resid,undef)=&decode_symb($symb);
6440: my %tocheck = (
6441: maps => $map,
6442: resources => $symb,
6443: );
6444: my @blockers;
6445: my $now = time;
1.1163 raeburn 6446: my $navmap = Apache::lonnavmaps::navmap->new();
1.1162 raeburn 6447: foreach my $block (keys(%commblocks)) {
6448: if ($block =~ /^(\d+)____(\d+)$/) {
6449: my ($start,$end) = ($1,$2);
6450: if ($start <= $now && $end >= $now) {
6451: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
6452: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
6453: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
6454: if ($commblocks{$block}{'blocks'}{'docs'}{'maps'}{$map}) {
6455: unless (grep(/^\Q$block\E$/,@blockers)) {
6456: push(@blockers,$block);
6457: }
6458: }
6459: }
6460: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
6461: if ($commblocks{$block}{'blocks'}{'docs'}{'resources'}{$symb}) {
6462: unless (grep(/^\Q$block\E$/,@blockers)) {
6463: push(@blockers,$block);
6464: }
6465: }
6466: }
6467: }
6468: }
6469: }
6470: } elsif ($block =~ /^firstaccess____(.+)$/) {
6471: my $item = $1;
1.1163 raeburn 6472: my @to_test;
1.1162 raeburn 6473: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
6474: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
6475: my $check_interval;
6476: if (&check_docs_block($commblocks{$block}{'blocks'}{'docs'},\%tocheck)) {
6477: my @interval;
6478: my $type = 'map';
6479: if ($item eq 'course') {
6480: $type = 'course';
6481: @interval=&EXT("resource.0.interval");
6482: } else {
6483: if ($item =~ /___\d+___/) {
6484: $type = 'resource';
6485: @interval=&EXT("resource.0.interval",$item);
1.1163 raeburn 6486: if (ref($navmap)) {
6487: my $res = $navmap->getBySymb($item);
6488: push(@to_test,$res);
6489: }
1.1162 raeburn 6490: } else {
6491: my $mapsymb = &symbread($item,1);
6492: if ($mapsymb) {
6493: if (ref($navmap)) {
6494: my $mapres = $navmap->getBySymb($mapsymb);
1.1163 raeburn 6495: @to_test = $mapres->retrieveResources($mapres,undef,0,1);
6496: foreach my $res (@to_test) {
1.1162 raeburn 6497: my $symb = $res->symb();
6498: next if ($symb eq $mapsymb);
6499: if ($symb ne '') {
6500: @interval=&EXT("resource.0.interval",$symb);
6501: last;
6502: }
6503: }
6504: }
6505: }
6506: }
6507: }
6508: if ($interval[0] =~ /\d+/) {
6509: my $first_access;
6510: if ($type eq 'resource') {
6511: $first_access=&get_first_access($interval[1],$item);
6512: } elsif ($type eq 'map') {
6513: $first_access=&get_first_access($interval[1],undef,$item);
6514: } else {
6515: $first_access=&get_first_access($interval[1]);
6516: }
6517: if ($first_access) {
6518: my $timesup = $first_access+$interval[0];
6519: if ($timesup > $now) {
1.1163 raeburn 6520: foreach my $res (@to_test) {
6521: if ($res->is_problem()) {
6522: if ($res->completable()) {
6523: unless (grep(/^\Q$block\E$/,@blockers)) {
6524: push(@blockers,$block);
6525: }
6526: last;
6527: }
6528: }
1.1162 raeburn 6529: }
6530: }
6531: }
6532: }
6533: }
6534: }
6535: }
6536: }
6537: }
6538: return @blockers;
6539: }
6540:
6541: sub check_docs_block {
6542: my ($docsblock,$tocheck) =@_;
6543: if ((ref($docsblock) ne 'HASH') || (ref($tocheck) ne 'HASH')) {
6544: return;
6545: }
6546: if (ref($docsblock->{'maps'}) eq 'HASH') {
6547: if ($tocheck->{'maps'}) {
6548: if ($docsblock->{'maps'}{$tocheck->{'maps'}}) {
6549: return 1;
6550: }
6551: }
6552: }
6553: if (ref($docsblock->{'resources'}) eq 'HASH') {
6554: if ($tocheck->{'resources'}) {
6555: if ($docsblock->{'resources'}{$tocheck->{'resources'}}) {
6556: return 1;
6557: }
6558: }
6559: }
6560: return;
6561: }
6562:
1.1133 foxr 6563: #
6564: # Removes the versino from a URI and
6565: # splits it in to its filename and path to the filename.
6566: # Seems like File::Basename could have done this more clearly.
6567: # Parameters:
6568: # $uri - input URI
6569: # Returns:
6570: # Two element list consisting of
6571: # $pathname - the URI up to and excluding the trailing /
6572: # $filename - The part of the URI following the last /
6573: # NOTE:
6574: # Another realization of this is simply:
6575: # use File::Basename;
6576: # ...
6577: # $uri = shift;
6578: # $filename = basename($uri);
6579: # $path = dirname($uri);
6580: # return ($filename, $path);
6581: #
6582: # The implementation below is probably faster however.
6583: #
1.710 albertel 6584: sub split_uri_for_cond {
6585: my $uri=&deversion(&declutter(shift));
6586: my @uriparts=split(/\//,$uri);
6587: my $filename=pop(@uriparts);
6588: my $pathname=join('/',@uriparts);
6589: return ($pathname,$filename);
6590: }
1.232 www 6591: # --------------------------------------------------- Is a resource on the map?
6592:
6593: sub is_on_map {
1.710 albertel 6594: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 6595: #Trying to find the conditional for the file
1.620 albertel 6596: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 6597: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 6598: if ($match) {
1.289 bowersj2 6599: return (1,$1);
6600: } else {
1.434 www 6601: return (0,0);
1.289 bowersj2 6602: }
1.12 www 6603: }
6604:
1.427 www 6605: # --------------------------------------------------------- Get symb from alias
6606:
6607: sub get_symb_from_alias {
6608: my $symb=shift;
6609: my ($map,$resid,$url)=&decode_symb($symb);
6610: # Already is a symb
6611: if ($url) { return $symb; }
6612: # Must be an alias
6613: my $aliassymb='';
6614: my %bighash;
1.620 albertel 6615: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 6616: &GDBM_READER(),0640)) {
6617: my $rid=$bighash{'mapalias_'.$symb};
6618: if ($rid) {
6619: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 6620: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
6621: $resid,$bighash{'src_'.$rid});
1.427 www 6622: }
6623: untie %bighash;
6624: }
6625: return $aliassymb;
6626: }
6627:
1.12 www 6628: # ----------------------------------------------------------------- Define Role
6629:
6630: sub definerole {
6631: if (allowed('mcr','/')) {
6632: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 6633: foreach my $role (split(':',$sysrole)) {
6634: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 6635: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
6636: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
6637: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 6638: return "refused:s:$crole&$cqual";
6639: }
6640: }
1.191 harris41 6641: }
1.800 albertel 6642: foreach my $role (split(':',$domrole)) {
6643: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 6644: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
6645: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
6646: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 6647: return "refused:d:$crole&$cqual";
6648: }
6649: }
1.191 harris41 6650: }
1.800 albertel 6651: foreach my $role (split(':',$courole)) {
6652: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 6653: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
6654: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
6655: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 6656: return "refused:c:$crole&$cqual";
6657: }
6658: }
1.191 harris41 6659: }
1.620 albertel 6660: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
6661: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 6662: "rolesdef_$rolename=".
6663: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 6664: return reply($command,$env{'user.home'});
1.12 www 6665: } else {
6666: return 'refused';
6667: }
1.105 harris41 6668: }
6669:
6670: # ---------------- Make a metadata query against the network of library servers
6671:
6672: sub metadata_query {
1.244 matthew 6673: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 6674: my %rhash;
1.845 albertel 6675: my %libserv = &all_library();
1.244 matthew 6676: my @server_list = (defined($server_array) ? @$server_array
6677: : keys(%libserv) );
6678: for my $server (@server_list) {
1.118 harris41 6679: unless ($custom or $customshow) {
6680: my $reply=&reply("querysend:".&escape($query),$server);
6681: $rhash{$server}=$reply;
6682: }
6683: else {
6684: my $reply=&reply("querysend:".&escape($query).':'.
6685: &escape($custom).':'.&escape($customshow),
6686: $server);
6687: $rhash{$server}=$reply;
6688: }
1.112 harris41 6689: }
1.118 harris41 6690: return \%rhash;
1.240 www 6691: }
6692:
6693: # ----------------------------------------- Send log queries and wait for reply
6694:
6695: sub log_query {
6696: my ($uname,$udom,$query,%filters)=@_;
6697: my $uhome=&homeserver($uname,$udom);
6698: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 6699: my $uhost=&hostname($uhome);
1.800 albertel 6700: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 6701: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
6702: $uhome);
1.479 albertel 6703: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 6704: return get_query_reply($queryid);
6705: }
6706:
1.818 raeburn 6707: # -------------------------- Update MySQL table for portfolio file
6708:
6709: sub update_portfolio_table {
1.821 raeburn 6710: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 6711: if ($group ne '') {
6712: $file_name =~s /^\Q$group\E//;
6713: }
1.818 raeburn 6714: my $homeserver = &homeserver($uname,$udom);
6715: my $queryid=
1.821 raeburn 6716: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
6717: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 6718: my $reply = &get_query_reply($queryid);
6719: return $reply;
6720: }
6721:
1.899 raeburn 6722: # -------------------------- Update MySQL allusers table
6723:
6724: sub update_allusers_table {
6725: my ($uname,$udom,$names) = @_;
6726: my $homeserver = &homeserver($uname,$udom);
6727: my $queryid=
6728: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
6729: 'lastname='.&escape($names->{'lastname'}).'%%'.
6730: 'firstname='.&escape($names->{'firstname'}).'%%'.
6731: 'middlename='.&escape($names->{'middlename'}).'%%'.
6732: 'generation='.&escape($names->{'generation'}).'%%'.
6733: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
6734: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 6735: return;
1.899 raeburn 6736: }
6737:
1.508 raeburn 6738: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 6739:
6740: sub fetch_enrollment_query {
1.511 raeburn 6741: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 6742: my $homeserver;
1.547 raeburn 6743: my $maxtries = 1;
1.508 raeburn 6744: if ($context eq 'automated') {
6745: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 6746: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 6747: } else {
6748: $homeserver = &homeserver($cnum,$dom);
6749: }
1.838 albertel 6750: my $host=&hostname($homeserver);
1.506 raeburn 6751: my $cmd = '';
1.1000 raeburn 6752: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 6753: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 6754: }
6755: $cmd =~ s/%%$//;
6756: $cmd = &escape($cmd);
6757: my $query = 'fetchenrollment';
1.620 albertel 6758: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 6759: unless ($queryid=~/^\Q$host\E\_/) {
6760: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
6761: return 'error: '.$queryid;
6762: }
1.506 raeburn 6763: my $reply = &get_query_reply($queryid);
1.547 raeburn 6764: my $tries = 1;
6765: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
6766: $reply = &get_query_reply($queryid);
6767: $tries ++;
6768: }
1.526 raeburn 6769: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 6770: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 6771: } else {
1.901 albertel 6772: my @responses = split(/:/,$reply);
1.515 raeburn 6773: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 6774: foreach my $line (@responses) {
6775: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 6776: $$replyref{$key} = $value;
6777: }
6778: } else {
1.1117 foxr 6779: my $pathname = LONCAPA::tempdir();
1.800 albertel 6780: foreach my $line (@responses) {
6781: my ($key,$value) = split(/=/,$line);
1.506 raeburn 6782: $$replyref{$key} = $value;
6783: if ($value > 0) {
1.800 albertel 6784: foreach my $item (@{$$affiliatesref{$key}}) {
6785: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 6786: my $destname = $pathname.'/'.$filename;
6787: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 6788: if ($xml_classlist =~ /^error/) {
6789: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
6790: } else {
1.506 raeburn 6791: if ( open(FILE,">$destname") ) {
6792: print FILE &unescape($xml_classlist);
6793: close(FILE);
1.526 raeburn 6794: } else {
6795: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 6796: }
6797: }
6798: }
6799: }
6800: }
6801: }
6802: return 'ok';
6803: }
6804: return 'error';
6805: }
6806:
1.242 www 6807: sub get_query_reply {
6808: my $queryid=shift;
1.1117 foxr 6809: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 6810: my $reply='';
6811: for (1..100) {
6812: sleep 2;
6813: if (-e $replyfile.'.end') {
1.448 albertel 6814: if (open(my $fh,$replyfile)) {
1.904 albertel 6815: $reply = join('',<$fh>);
6816: close($fh);
1.240 www 6817: } else { return 'error: reply_file_error'; }
1.242 www 6818: return &unescape($reply);
6819: }
1.240 www 6820: }
1.242 www 6821: return 'timeout:'.$queryid;
1.240 www 6822: }
6823:
6824: sub courselog_query {
1.241 www 6825: #
6826: # possible filters:
6827: # url: url or symb
6828: # username
6829: # domain
6830: # action: view, submit, grade
6831: # start: timestamp
6832: # end: timestamp
6833: #
1.240 www 6834: my (%filters)=@_;
1.620 albertel 6835: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 6836: if ($filters{'url'}) {
6837: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
6838: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
6839: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
6840: }
1.620 albertel 6841: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
6842: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 6843: return &log_query($cname,$cdom,'courselog',%filters);
6844: }
6845:
6846: sub userlog_query {
1.858 raeburn 6847: #
6848: # possible filters:
6849: # action: log check role
6850: # start: timestamp
6851: # end: timestamp
6852: #
1.240 www 6853: my ($uname,$udom,%filters)=@_;
6854: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 6855: }
6856:
1.506 raeburn 6857: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
6858:
6859: sub auto_run {
1.508 raeburn 6860: my ($cnum,$cdom) = @_;
1.876 raeburn 6861: my $response = 0;
6862: my $settings;
6863: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
6864: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
6865: $settings = $domconfig{'autoenroll'};
6866: if ($settings->{'run'} eq '1') {
6867: $response = 1;
6868: }
6869: } else {
1.934 raeburn 6870: my $homeserver;
6871: if (&is_course($cdom,$cnum)) {
6872: $homeserver = &homeserver($cnum,$cdom);
6873: } else {
6874: $homeserver = &domain($cdom,'primary');
6875: }
6876: if ($homeserver ne 'no_host') {
6877: $response = &reply('autorun:'.$cdom,$homeserver);
6878: }
1.876 raeburn 6879: }
1.506 raeburn 6880: return $response;
6881: }
1.776 albertel 6882:
1.506 raeburn 6883: sub auto_get_sections {
1.508 raeburn 6884: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 6885: my $homeserver;
6886: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6887: $homeserver = &homeserver($cnum,$cdom);
6888: }
6889: if (!defined($homeserver)) {
6890: if ($cdom =~ /^$match_domain$/) {
6891: $homeserver = &domain($cdom,'primary');
6892: }
6893: }
6894: my @secs;
6895: if (defined($homeserver)) {
6896: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
6897: unless ($response eq 'refused') {
6898: @secs = split(/:/,$response);
6899: }
1.506 raeburn 6900: }
6901: return @secs;
6902: }
1.776 albertel 6903:
1.506 raeburn 6904: sub auto_new_course {
1.1099 raeburn 6905: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 6906: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 6907: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 6908: return $response;
6909: }
1.776 albertel 6910:
1.506 raeburn 6911: sub auto_validate_courseID {
1.508 raeburn 6912: my ($cnum,$cdom,$inst_course_id) = @_;
6913: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 6914: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 6915: return $response;
6916: }
1.776 albertel 6917:
1.1007 raeburn 6918: sub auto_validate_instcode {
1.1020 raeburn 6919: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 6920: my ($homeserver,$response);
6921: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6922: $homeserver = &homeserver($cnum,$cdom);
6923: }
6924: if (!defined($homeserver)) {
6925: if ($cdom =~ /^$match_domain$/) {
6926: $homeserver = &domain($cdom,'primary');
6927: }
6928: }
1.1065 raeburn 6929: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
6930: &escape($instcode).':'.&escape($owner),$homeserver));
1.1027 raeburn 6931: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
6932: return ($outcome,$description);
1.1007 raeburn 6933: }
6934:
1.506 raeburn 6935: sub auto_create_password {
1.873 raeburn 6936: my ($cnum,$cdom,$authparam,$udom) = @_;
6937: my ($homeserver,$response);
1.506 raeburn 6938: my $create_passwd = 0;
6939: my $authchk = '';
1.873 raeburn 6940: if ($udom =~ /^$match_domain$/) {
6941: $homeserver = &domain($udom,'primary');
6942: }
6943: if ($homeserver eq '') {
6944: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
6945: $homeserver = &homeserver($cnum,$cdom);
6946: }
6947: }
6948: if ($homeserver eq '') {
6949: $authchk = 'nodomain';
1.506 raeburn 6950: } else {
1.873 raeburn 6951: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
6952: if ($response eq 'refused') {
6953: $authchk = 'refused';
6954: } else {
1.901 albertel 6955: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 6956: }
1.506 raeburn 6957: }
6958: return ($authparam,$create_passwd,$authchk);
6959: }
6960:
1.706 raeburn 6961: sub auto_photo_permission {
6962: my ($cnum,$cdom,$students) = @_;
6963: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 6964: my ($outcome,$perm_reqd,$conditions) =
6965: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 6966: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6967: return (undef,undef);
6968: }
1.706 raeburn 6969: return ($outcome,$perm_reqd,$conditions);
6970: }
6971:
6972: sub auto_checkphotos {
6973: my ($uname,$udom,$pid) = @_;
6974: my $homeserver = &homeserver($uname,$udom);
6975: my ($result,$resulttype);
6976: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 6977: &escape($uname).':'.&escape($pid),
6978: $homeserver));
1.709 albertel 6979: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6980: return (undef,undef);
6981: }
1.706 raeburn 6982: if ($outcome) {
6983: ($result,$resulttype) = split(/:/,$outcome);
6984: }
6985: return ($result,$resulttype);
6986: }
6987:
6988: sub auto_photochoice {
6989: my ($cnum,$cdom) = @_;
6990: my $homeserver = &homeserver($cnum,$cdom);
6991: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 6992: &escape($cdom),
6993: $homeserver)));
1.709 albertel 6994: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
6995: return (undef,undef);
6996: }
1.706 raeburn 6997: return ($update,$comment);
6998: }
6999:
7000: sub auto_photoupdate {
7001: my ($affiliatesref,$dom,$cnum,$photo) = @_;
7002: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 7003: my $host=&hostname($homeserver);
1.706 raeburn 7004: my $cmd = '';
7005: my $maxtries = 1;
1.800 albertel 7006: foreach my $affiliate (keys(%{$affiliatesref})) {
7007: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 7008: }
7009: $cmd =~ s/%%$//;
7010: $cmd = &escape($cmd);
7011: my $query = 'institutionalphotos';
7012: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
7013: unless ($queryid=~/^\Q$host\E\_/) {
7014: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
7015: return 'error: '.$queryid;
7016: }
7017: my $reply = &get_query_reply($queryid);
7018: my $tries = 1;
7019: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7020: $reply = &get_query_reply($queryid);
7021: $tries ++;
7022: }
7023: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7024: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7025: } else {
7026: my @responses = split(/:/,$reply);
7027: my $outcome = shift(@responses);
7028: foreach my $item (@responses) {
7029: my ($key,$value) = split(/=/,$item);
7030: $$photo{$key} = $value;
7031: }
7032: return $outcome;
7033: }
7034: return 'error';
7035: }
7036:
1.521 raeburn 7037: sub auto_instcode_format {
1.793 albertel 7038: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
7039: $cat_order) = @_;
1.521 raeburn 7040: my $courses = '';
1.772 raeburn 7041: my @homeservers;
1.521 raeburn 7042: if ($caller eq 'global') {
1.841 albertel 7043: my %servers = &get_servers($codedom,'library');
7044: foreach my $tryserver (keys(%servers)) {
7045: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7046: push(@homeservers,$tryserver);
7047: }
1.584 raeburn 7048: }
1.1022 raeburn 7049: } elsif ($caller eq 'requests') {
7050: if ($codedom =~ /^$match_domain$/) {
7051: my $chome = &domain($codedom,'primary');
7052: unless ($chome eq 'no_host') {
7053: push(@homeservers,$chome);
7054: }
7055: }
1.521 raeburn 7056: } else {
1.772 raeburn 7057: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 7058: }
1.793 albertel 7059: foreach my $code (keys(%{$instcodes})) {
7060: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 7061: }
7062: chop($courses);
1.772 raeburn 7063: my $ok_response = 0;
7064: my $response;
7065: while (@homeservers > 0 && $ok_response == 0) {
7066: my $server = shift(@homeservers);
7067: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
7068: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
7069: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 7070: split(/:/,$response);
1.772 raeburn 7071: %{$codes} = (%{$codes},&str2hash($codes_str));
7072: push(@{$codetitles},&str2array($codetitles_str));
7073: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
7074: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
7075: $ok_response = 1;
7076: }
7077: }
7078: if ($ok_response) {
1.521 raeburn 7079: return 'ok';
1.772 raeburn 7080: } else {
7081: return $response;
1.521 raeburn 7082: }
7083: }
7084:
1.792 raeburn 7085: sub auto_instcode_defaults {
7086: my ($domain,$returnhash,$code_order) = @_;
7087: my @homeservers;
1.841 albertel 7088:
7089: my %servers = &get_servers($domain,'library');
7090: foreach my $tryserver (keys(%servers)) {
7091: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7092: push(@homeservers,$tryserver);
7093: }
1.792 raeburn 7094: }
1.841 albertel 7095:
1.792 raeburn 7096: my $response;
1.841 albertel 7097: foreach my $server (@homeservers) {
1.792 raeburn 7098: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 7099: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7100:
7101: foreach my $pair (split(/\&/,$response)) {
7102: my ($name,$value)=split(/\=/,$pair);
7103: if ($name eq 'code_order') {
7104: @{$code_order} = split(/\&/,&unescape($value));
7105: } else {
7106: $returnhash->{&unescape($name)}=&unescape($value);
7107: }
7108: }
7109: return 'ok';
1.792 raeburn 7110: }
1.841 albertel 7111:
7112: return $response;
1.1003 raeburn 7113: }
7114:
7115: sub auto_possible_instcodes {
1.1007 raeburn 7116: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
7117: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
7118: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
7119: return;
7120: }
1.1003 raeburn 7121: my (@homeservers,$uhome);
7122: if (defined(&domain($domain,'primary'))) {
7123: $uhome=&domain($domain,'primary');
7124: push(@homeservers,&domain($domain,'primary'));
7125: } else {
7126: my %servers = &get_servers($domain,'library');
7127: foreach my $tryserver (keys(%servers)) {
7128: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7129: push(@homeservers,$tryserver);
7130: }
7131: }
7132: }
7133: my $response;
7134: foreach my $server (@homeservers) {
7135: $response=&reply('autopossibleinstcodes:'.$domain,$server);
7136: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 7137: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
7138: split(':',$response);
7139: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
7140: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 7141: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 7142: my ($name,$value)=split('=',$item);
7143: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 7144: }
7145: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 7146: my ($name,$value)=split('=',$item);
7147: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 7148: }
7149: return 'ok';
7150: }
7151: return $response;
7152: }
1.792 raeburn 7153:
1.1010 raeburn 7154: sub auto_courserequest_checks {
7155: my ($dom) = @_;
1.1020 raeburn 7156: my ($homeserver,%validations);
7157: if ($dom =~ /^$match_domain$/) {
7158: $homeserver = &domain($dom,'primary');
7159: }
7160: unless ($homeserver eq 'no_host') {
7161: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
7162: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
7163: my @items = split(/&/,$response);
7164: foreach my $item (@items) {
7165: my ($key,$value) = split('=',$item);
7166: $validations{&unescape($key)} = &thaw_unescape($value);
7167: }
7168: }
7169: }
1.1010 raeburn 7170: return %validations;
7171: }
7172:
1.1020 raeburn 7173: sub auto_courserequest_validation {
7174: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
7175: my ($homeserver,$response);
7176: if ($dom =~ /^$match_domain$/) {
7177: $homeserver = &domain($dom,'primary');
7178: }
7179: unless ($homeserver eq 'no_host') {
1.1021 raeburn 7180:
1.1020 raeburn 7181: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 7182: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 7183: ':'.&escape($instcode).':'.&escape($instseclist),
7184: $homeserver));
7185: }
7186: return $response;
7187: }
7188:
1.777 albertel 7189: sub auto_validate_class_sec {
1.918 raeburn 7190: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 7191: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 7192: my $ownerlist;
7193: if (ref($owners) eq 'ARRAY') {
7194: $ownerlist = join(',',@{$owners});
7195: } else {
7196: $ownerlist = $owners;
7197: }
1.773 raeburn 7198: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 7199: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 7200: return $response;
7201: }
7202:
1.679 raeburn 7203: # ------------------------------------------------------- Course Group routines
7204:
7205: sub get_coursegroups {
1.809 raeburn 7206: my ($cdom,$cnum,$group,$namespace) = @_;
7207: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 7208: }
7209:
1.679 raeburn 7210: sub modify_coursegroup {
7211: my ($cdom,$cnum,$groupsettings) = @_;
7212: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
7213: }
7214:
1.809 raeburn 7215: sub toggle_coursegroup_status {
7216: my ($cdom,$cnum,$group,$action) = @_;
7217: my ($from_namespace,$to_namespace);
7218: if ($action eq 'delete') {
7219: $from_namespace = 'coursegroups';
7220: $to_namespace = 'deleted_groups';
7221: } else {
7222: $from_namespace = 'deleted_groups';
7223: $to_namespace = 'coursegroups';
7224: }
7225: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 7226: if (my $tmp = &error(%curr_group)) {
7227: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
7228: return ('read error',$tmp);
7229: } else {
7230: my %savedsettings = %curr_group;
1.809 raeburn 7231: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 7232: my $deloutcome;
7233: if ($result eq 'ok') {
1.809 raeburn 7234: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 7235: } else {
7236: return ('write error',$result);
7237: }
7238: if ($deloutcome eq 'ok') {
7239: return 'ok';
7240: } else {
7241: return ('delete error',$deloutcome);
7242: }
7243: }
7244: }
7245:
1.679 raeburn 7246: sub modify_group_roles {
1.957 raeburn 7247: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 7248: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
7249: my $role = 'gr/'.&escape($userprivs);
7250: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 7251: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 7252: if ($result eq 'ok') {
7253: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
7254: }
1.679 raeburn 7255: return $result;
7256: }
7257:
7258: sub modify_coursegroup_membership {
7259: my ($cdom,$cnum,$membership) = @_;
7260: my $result = &put('groupmembership',$membership,$cdom,$cnum);
7261: return $result;
7262: }
7263:
1.682 raeburn 7264: sub get_active_groups {
7265: my ($udom,$uname,$cdom,$cnum) = @_;
7266: my $now = time;
7267: my %groups = ();
7268: foreach my $key (keys(%env)) {
1.811 albertel 7269: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 7270: my ($start,$end) = split(/\./,$env{$key});
7271: if (($end!=0) && ($end<$now)) { next; }
7272: if (($start!=0) && ($start>$now)) { next; }
7273: if ($1 eq $cdom && $2 eq $cnum) {
7274: $groups{$3} = $env{$key} ;
7275: }
7276: }
7277: }
7278: return %groups;
7279: }
7280:
1.683 raeburn 7281: sub get_group_membership {
7282: my ($cdom,$cnum,$group) = @_;
7283: return(&dump('groupmembership',$cdom,$cnum,$group));
7284: }
7285:
7286: sub get_users_groups {
7287: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 7288: my @usersgroups;
1.683 raeburn 7289: my $cachetime=1800;
7290:
7291: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 7292: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
7293: if (defined($cached)) {
1.734 albertel 7294: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 7295: } else {
7296: $grouplist = '';
1.816 raeburn 7297: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 7298: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 7299: my $access_end = $env{'course.'.$courseid.
7300: '.default_enrollment_end_date'};
7301: my $now = time;
7302: foreach my $key (keys(%roleshash)) {
7303: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
7304: my $group = $1;
7305: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
7306: my $start = $2;
7307: my $end = $1;
7308: if ($start == -1) { next; } # deleted from group
7309: if (($start!=0) && ($start>$now)) { next; }
7310: if (($end!=0) && ($end<$now)) {
7311: if ($access_end && $access_end < $now) {
7312: if ($access_end - $end < 86400) {
7313: push(@usersgroups,$group);
1.733 raeburn 7314: }
7315: }
1.817 raeburn 7316: next;
1.733 raeburn 7317: }
1.817 raeburn 7318: push(@usersgroups,$group);
1.683 raeburn 7319: }
7320: }
7321: }
1.817 raeburn 7322: @usersgroups = &sort_course_groups($courseid,@usersgroups);
7323: $grouplist = join(':',@usersgroups);
7324: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 7325: }
1.733 raeburn 7326: return @usersgroups;
1.683 raeburn 7327: }
7328:
7329: sub devalidate_getgroups_cache {
7330: my ($udom,$uname,$cdom,$cnum)=@_;
7331: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 7332:
1.683 raeburn 7333: my $hashid="$udom:$uname:$courseid";
7334: &devalidate_cache_new('getgroups',$hashid);
7335: }
7336:
1.12 www 7337: # ------------------------------------------------------------------ Plain Text
7338:
7339: sub plaintext {
1.988 raeburn 7340: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 7341: if ($short =~ m{^cr/}) {
1.758 albertel 7342: return (split('/',$short))[-1];
7343: }
1.742 raeburn 7344: if (!defined($cid)) {
7345: $cid = $env{'request.course.id'};
7346: }
7347: my %rolenames = (
1.1008 raeburn 7348: Course => 'std',
7349: Community => 'alt1',
1.742 raeburn 7350: );
1.1037 raeburn 7351: if ($cid ne '') {
7352: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
7353: unless ($forcedefault) {
7354: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
7355: &Apache::lonlocal::mt_escape(\$roletext);
7356: return &Apache::lonlocal::mt($roletext);
7357: }
7358: }
7359: }
7360: if ((defined($type)) && (defined($rolenames{$type})) &&
7361: (defined($rolenames{$type})) &&
7362: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 7363: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 7364: } elsif ($cid ne '') {
7365: my $crstype = $env{'course.'.$cid.'.type'};
7366: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
7367: (defined($prp{$short}{$rolenames{$crstype}}))) {
7368: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
7369: }
1.742 raeburn 7370: }
1.1037 raeburn 7371: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 7372: }
7373:
7374: # ----------------------------------------------------------------- Assign Role
7375:
7376: sub assignrole {
1.957 raeburn 7377: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
7378: $context)=@_;
1.21 www 7379: my $mrole;
7380: if ($role =~ /^cr\//) {
1.393 www 7381: my $cwosec=$url;
1.811 albertel 7382: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 7383: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 7384: my $refused = 1;
7385: if ($context eq 'requestcourses') {
7386: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
7387: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
7388: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
7389: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7390: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7391: if ($crsenv{'internal.courseowner'} eq
7392: $env{'user.name'}.':'.$env{'user.domain'}) {
7393: $refused = '';
7394: }
7395: }
7396: }
7397: }
7398: }
7399: if ($refused) {
7400: &logthis('Refused custom assignrole: '.
7401: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
7402: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
7403: return 'refused';
7404: }
1.104 www 7405: }
1.21 www 7406: $mrole='cr';
1.678 raeburn 7407: } elsif ($role =~ /^gr\//) {
7408: my $cwogrp=$url;
1.811 albertel 7409: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 7410: unless (&allowed('mdg',$cwogrp)) {
7411: &logthis('Refused group assignrole: '.
7412: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
7413: $env{'user.name'}.' at '.$env{'user.domain'});
7414: return 'refused';
7415: }
7416: $mrole='gr';
1.21 www 7417: } else {
1.82 www 7418: my $cwosec=$url;
1.811 albertel 7419: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 7420: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
7421: my $refused;
7422: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
7423: if (!(&allowed('c'.$role,$url))) {
7424: $refused = 1;
7425: }
7426: } else {
7427: $refused = 1;
7428: }
1.947 raeburn 7429: if ($refused) {
1.1045 raeburn 7430: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
7431: if (!$selfenroll && $context eq 'course') {
7432: my %crsenv;
7433: if ($role eq 'cc' || $role eq 'co') {
7434: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7435: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
7436: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
7437: if ($crsenv{'internal.courseowner'} eq
7438: $env{'user.name'}.':'.$env{'user.domain'}) {
7439: $refused = '';
7440: }
7441: }
7442: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
7443: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
7444: if ($crsenv{'internal.courseowner'} eq
7445: $env{'user.name'}.':'.$env{'user.domain'}) {
7446: $refused = '';
7447: }
7448: }
7449: }
7450: }
7451: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 7452: $refused = '';
1.1017 raeburn 7453: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 7454: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 7455: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 7456: my $wrongcc;
7457: if ($cnum =~ /^$match_community$/) {
7458: $wrongcc = 1 if ($role eq 'cc');
7459: } else {
7460: $wrongcc = 1 if ($role eq 'co');
7461: }
7462: unless ($wrongcc) {
7463: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
7464: if ($crsenv{'internal.courseowner'} eq
7465: $env{'user.name'}.':'.$env{'user.domain'}) {
7466: $refused = '';
7467: }
1.1017 raeburn 7468: }
7469: }
7470: }
7471: if ($refused) {
1.947 raeburn 7472: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
7473: ' '.$role.' '.$end.' '.$start.' by '.
7474: $env{'user.name'}.' at '.$env{'user.domain'});
7475: return 'refused';
7476: }
1.932 raeburn 7477: }
1.1131 raeburn 7478: } elsif ($role eq 'au') {
7479: if ($url ne '/'.$udom.'/') {
7480: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
7481: ' to assign author role for '.$uname.':'.$udom.
7482: ' in domain: '.$url.' refused (wrong domain).');
7483: return 'refused';
7484: }
1.104 www 7485: }
1.21 www 7486: $mrole=$role;
7487: }
1.620 albertel 7488: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 7489: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 7490: if ($end) { $command.='_'.$end; }
1.21 www 7491: if ($start) {
7492: if ($end) {
1.81 www 7493: $command.='_'.$start;
1.21 www 7494: } else {
1.81 www 7495: $command.='_0_'.$start;
1.21 www 7496: }
7497: }
1.739 raeburn 7498: my $origstart = $start;
7499: my $origend = $end;
1.957 raeburn 7500: my $delflag;
1.357 www 7501: # actually delete
7502: if ($deleteflag) {
1.373 www 7503: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 7504: # modify command to delete the role
1.620 albertel 7505: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 7506: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 7507: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 7508: # set start and finish to negative values for userrolelog
7509: $start=-1;
7510: $end=-1;
1.957 raeburn 7511: $delflag = 1;
1.357 www 7512: }
7513: }
7514: # send command
1.349 www 7515: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 7516: # log new user role if status is ok
1.349 www 7517: if ($answer eq 'ok') {
1.663 raeburn 7518: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 7519: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 7520: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 7521: unless ($role =~ /^gr/) {
7522: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 7523: $origstart,$selfenroll,$context);
1.739 raeburn 7524: }
1.1053 raeburn 7525: if ($role eq 'cc') {
7526: &autoupdate_coowners($url,$end,$start,$uname,$udom);
7527: }
1.349 www 7528: }
7529: return $answer;
1.169 harris41 7530: }
7531:
1.1053 raeburn 7532: sub autoupdate_coowners {
7533: my ($url,$end,$start,$uname,$udom) = @_;
7534: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
7535: if (($cdom ne '') && ($cnum ne '')) {
7536: my $now = time;
7537: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
7538: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
7539: my %coursehash = &coursedescription($cdom.'_'.$cnum);
7540: my $instcode = $coursehash{'internal.coursecode'};
7541: if ($instcode ne '') {
1.1056 raeburn 7542: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
7543: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 7544: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 7545: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
7546: if ($result eq 'valid') {
7547: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 7548: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7549: push(@newcoowners,$coowner);
7550: }
7551: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
7552: push(@newcoowners,$uname.':'.$udom);
7553: }
7554: @newcoowners = sort(@newcoowners);
7555: } else {
7556: push(@newcoowners,$uname.':'.$udom);
7557: }
7558: } else {
7559: if ($coursehash{'internal.co-owners'}) {
7560: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
7561: unless ($coowner eq $uname.':'.$udom) {
7562: push(@newcoowners,$coowner);
7563: }
7564: }
7565: unless (@newcoowners > 0) {
7566: $delcoowners = 1;
7567: $coowners = '';
7568: }
7569: }
7570: }
7571: if (@newcoowners || $delcoowners) {
7572: &store_coowners($cdom,$cnum,$coursehash{'home'},
7573: $delcoowners,@newcoowners);
7574: }
7575: }
7576: }
7577: }
7578: }
7579: }
7580: }
7581:
7582: sub store_coowners {
7583: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
7584: my $cid = $cdom.'_'.$cnum;
7585: my ($coowners,$delresult,$putresult);
7586: if (@newcoowners) {
7587: $coowners = join(',',@newcoowners);
7588: my %coownershash = (
7589: 'internal.co-owners' => $coowners,
7590: );
7591: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
7592: if ($putresult eq 'ok') {
7593: if ($env{'course.'.$cid.'.num'} eq $cnum) {
7594: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
7595: }
7596: }
7597: }
7598: if ($delcoowners) {
7599: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
7600: if ($delresult eq 'ok') {
7601: if ($env{'course.'.$cid.'.internal.co-owners'}) {
7602: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
7603: }
7604: }
7605: }
7606: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
7607: my %crsinfo =
7608: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
7609: if (ref($crsinfo{$cid}) eq 'HASH') {
7610: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
7611: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
7612: }
7613: }
7614: }
7615:
1.169 harris41 7616: # -------------------------------------------------- Modify user authentication
1.197 www 7617: # Overrides without validation
7618:
1.169 harris41 7619: sub modifyuserauth {
7620: my ($udom,$uname,$umode,$upass)=@_;
7621: my $uhome=&homeserver($uname,$udom);
1.197 www 7622: unless (&allowed('mau',$udom)) { return 'refused'; }
7623: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 7624: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7625: ' in domain '.$env{'request.role.domain'});
1.169 harris41 7626: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
7627: &escape($upass),$uhome);
1.620 albertel 7628: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 7629: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
7630: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
7631: &log($udom,,$uname,$uhome,
1.620 albertel 7632: 'Authentication changed by '.$env{'user.domain'}.', '.
7633: $env{'user.name'}.', '.$umode.
1.197 www 7634: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 7635: unless ($reply eq 'ok') {
1.197 www 7636: &logthis('Authentication mode error: '.$reply);
1.169 harris41 7637: return 'error: '.$reply;
7638: }
1.170 harris41 7639: return 'ok';
1.80 www 7640: }
7641:
1.81 www 7642: # --------------------------------------------------------------- Modify a user
1.80 www 7643:
1.81 www 7644: sub modifyuser {
1.206 matthew 7645: my ($udom, $uname, $uid,
7646: $umode, $upass, $first,
7647: $middle, $last, $gene,
1.1058 raeburn 7648: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 7649: $udom= &LONCAPA::clean_domain($udom);
7650: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 7651: my $showcandelete = 'none';
7652: if (ref($candelete) eq 'ARRAY') {
7653: if (@{$candelete} > 0) {
7654: $showcandelete = join(', ',@{$candelete});
7655: }
7656: }
1.81 www 7657: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 7658: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 7659: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 7660: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
7661: ' desiredhome not specified').
1.620 albertel 7662: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
7663: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 7664: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 7665: my $newuser;
7666: if ($uhome eq 'no_host') {
7667: $newuser = 1;
7668: }
1.80 www 7669: # ----------------------------------------------------------------- Create User
1.406 albertel 7670: if (($uhome eq 'no_host') &&
7671: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 7672: my $unhome='';
1.844 albertel 7673: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 7674: $unhome = $desiredhome;
1.620 albertel 7675: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
7676: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 7677: } else { # load balancing routine for determining $unhome
1.81 www 7678: my $loadm=10000000;
1.841 albertel 7679: my %servers = &get_servers($udom,'library');
7680: foreach my $tryserver (keys(%servers)) {
7681: my $answer=reply('load',$tryserver);
7682: if (($answer=~/\d+/) && ($answer<$loadm)) {
7683: $loadm=$answer;
7684: $unhome=$tryserver;
7685: }
1.80 www 7686: }
7687: }
7688: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 7689: return 'error: unable to find a home server for '.$uname.
7690: ' in domain '.$udom;
1.80 www 7691: }
7692: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
7693: &escape($upass),$unhome);
7694: unless ($reply eq 'ok') {
7695: return 'error: '.$reply;
7696: }
1.230 stredwic 7697: $uhome=&homeserver($uname,$udom,'true');
1.80 www 7698: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 7699: return 'error: unable verify users home machine.';
1.80 www 7700: }
1.209 matthew 7701: } # End of creation of new user
1.80 www 7702: # ---------------------------------------------------------------------- Add ID
7703: if ($uid) {
7704: $uid=~tr/A-Z/a-z/;
7705: my %uidhash=&idrget($udom,$uname);
1.196 www 7706: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
7707: && (!$forceid)) {
1.80 www 7708: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 7709: return 'error: user id "'.$uid.'" does not match '.
7710: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 7711: }
7712: } else {
7713: &idput($udom,($uname => $uid));
7714: }
7715: }
7716: # -------------------------------------------------------------- Add names, etc
1.313 matthew 7717: my @tmp=&get('environment',
1.899 raeburn 7718: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 7719: 'permanentemail','inststatus'],
1.134 albertel 7720: $udom,$uname);
1.1075 raeburn 7721: my (%names,%oldnames);
1.313 matthew 7722: if ($tmp[0] =~ m/^error:.*/) {
7723: %names=();
7724: } else {
7725: %names = @tmp;
1.1075 raeburn 7726: %oldnames = %names;
1.313 matthew 7727: }
1.388 www 7728: #
1.1058 raeburn 7729: # If name, email and/or uid are blank (e.g., because an uploaded file
7730: # of users did not contain them), do not overwrite existing values
7731: # unless field is in $candelete array ref.
7732: #
7733:
7734: my @fields = ('firstname','middlename','lastname','generation',
7735: 'permanentemail','id');
7736: my %newvalues;
7737: if (ref($candelete) eq 'ARRAY') {
7738: foreach my $field (@fields) {
7739: if (grep(/^\Q$field\E$/,@{$candelete})) {
7740: if ($field eq 'firstname') {
7741: $names{$field} = $first;
7742: } elsif ($field eq 'middlename') {
7743: $names{$field} = $middle;
7744: } elsif ($field eq 'lastname') {
7745: $names{$field} = $last;
7746: } elsif ($field eq 'generation') {
7747: $names{$field} = $gene;
7748: } elsif ($field eq 'permanentemail') {
7749: $names{$field} = $email;
7750: } elsif ($field eq 'id') {
7751: $names{$field} = $uid;
7752: }
7753: }
7754: }
7755: }
1.388 www 7756: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 7757: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 7758: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 7759: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 7760: if ($email) {
7761: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 7762: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 7763: }
1.899 raeburn 7764: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 7765: if (defined($inststatus)) {
7766: $names{'inststatus'} = '';
7767: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
7768: if (ref($usertypes) eq 'HASH') {
7769: my @okstatuses;
7770: foreach my $item (split(/:/,$inststatus)) {
7771: if (defined($usertypes->{$item})) {
7772: push(@okstatuses,$item);
7773: }
7774: }
7775: if (@okstatuses) {
7776: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
7777: }
7778: }
7779: }
1.1075 raeburn 7780: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 7781: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 7782: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 7783: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
7784: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
7785: } else {
7786: $logmsg .= ' during self creation';
7787: }
1.1075 raeburn 7788: my $changed;
7789: if ($newuser) {
7790: $changed = 1;
7791: } else {
7792: foreach my $field (@fields) {
7793: if ($names{$field} ne $oldnames{$field}) {
7794: $changed = 1;
7795: last;
7796: }
7797: }
7798: }
7799: unless ($changed) {
7800: $logmsg = 'No changes in user information needed for: '.$logmsg;
7801: &logthis($logmsg);
7802: return 'ok';
7803: }
7804: my $reply = &put('environment', \%names, $udom,$uname);
7805: if ($reply ne 'ok') {
7806: return 'error: '.$reply;
7807: }
1.1087 raeburn 7808: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
7809: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
7810: }
1.1075 raeburn 7811: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
7812: &devalidate_cache_new('namescache',$uname.':'.$udom);
7813: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 7814: &logthis($logmsg);
1.134 albertel 7815: return 'ok';
1.80 www 7816: }
7817:
1.81 www 7818: # -------------------------------------------------------------- Modify student
1.80 www 7819:
1.81 www 7820: sub modifystudent {
7821: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 7822: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 7823: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 7824: if (!$cid) {
1.620 albertel 7825: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 7826: return 'not_in_class';
7827: }
1.80 www 7828: }
7829: # --------------------------------------------------------------- Make the user
1.81 www 7830: my $reply=&modifyuser
1.209 matthew 7831: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 7832: $desiredhome,$email,$inststatus);
1.80 www 7833: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 7834: # This will cause &modify_student_enrollment to get the uid from the
7835: # students environment
7836: $uid = undef if (!$forceid);
1.455 albertel 7837: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 7838: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 7839: return $reply;
7840: }
7841:
7842: sub modify_student_enrollment {
1.957 raeburn 7843: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 7844: my ($cdom,$cnum,$chome);
7845: if (!$cid) {
1.620 albertel 7846: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 7847: return 'not_in_class';
7848: }
1.620 albertel 7849: $cdom=$env{'course.'.$cid.'.domain'};
7850: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 7851: } else {
7852: ($cdom,$cnum)=split(/_/,$cid);
7853: }
1.620 albertel 7854: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 7855: if (!$chome) {
1.457 raeburn 7856: $chome=&homeserver($cnum,$cdom);
1.297 matthew 7857: }
1.455 albertel 7858: if (!$chome) { return 'unknown_course'; }
1.297 matthew 7859: # Make sure the user exists
1.81 www 7860: my $uhome=&homeserver($uname,$udom);
7861: if (($uhome eq '') || ($uhome eq 'no_host')) {
7862: return 'error: no such user';
7863: }
1.297 matthew 7864: # Get student data if we were not given enough information
7865: if (!defined($first) || $first eq '' ||
7866: !defined($last) || $last eq '' ||
7867: !defined($uid) || $uid eq '' ||
7868: !defined($middle) || $middle eq '' ||
7869: !defined($gene) || $gene eq '') {
1.294 matthew 7870: # They did not supply us with enough data to enroll the student, so
7871: # we need to pick up more information.
1.297 matthew 7872: my %tmp = &get('environment',
1.294 matthew 7873: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 7874: ,$udom,$uname);
7875:
1.800 albertel 7876: #foreach my $key (keys(%tmp)) {
7877: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 7878: #}
1.294 matthew 7879: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
7880: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
7881: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 7882: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 7883: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
7884: }
1.556 albertel 7885: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 7886: my $user = "$uname:$udom";
7887: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 7888: my $reply=cput('classlist',
1.1148 raeburn 7889: {$user =>
1.515 raeburn 7890: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 7891: $cdom,$cnum);
1.1148 raeburn 7892: if (($reply eq 'ok') || ($reply eq 'delayed')) {
7893: &devalidate_getsection_cache($udom,$uname,$cid);
7894: } else {
1.81 www 7895: return 'error: '.$reply;
7896: }
1.297 matthew 7897: # Add student role to user
1.83 www 7898: my $uurl='/'.$cid;
1.81 www 7899: $uurl=~s/\_/\//g;
7900: if ($usec) {
7901: $uurl.='/'.$usec;
7902: }
1.1148 raeburn 7903: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
7904: $selfenroll,$context);
7905: if ($result ne 'ok') {
7906: if ($old_entry{$user} ne '') {
7907: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
7908: } else {
7909: $reply = &del('classlist',[$user],$cdom,$cnum);
7910: }
7911: }
7912: return $result;
1.21 www 7913: }
7914:
1.556 albertel 7915: sub format_name {
7916: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
7917: my $name;
7918: if ($first ne 'lastname') {
7919: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
7920: } else {
7921: if ($lastname=~/\S/) {
7922: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
7923: $name=~s/\s+,/,/;
7924: } else {
7925: $name.= $firstname.' '.$middlename.' '.$generation;
7926: }
7927: }
7928: $name=~s/^\s+//;
7929: $name=~s/\s+$//;
7930: $name=~s/\s+/ /g;
7931: return $name;
7932: }
7933:
1.84 www 7934: # ------------------------------------------------- Write to course preferences
7935:
7936: sub writecoursepref {
7937: my ($courseid,%prefs)=@_;
7938: $courseid=~s/^\///;
7939: $courseid=~s/\_/\//g;
7940: my ($cdomain,$cnum)=split(/\//,$courseid);
7941: my $chome=homeserver($cnum,$cdomain);
7942: if (($chome eq '') || ($chome eq 'no_host')) {
7943: return 'error: no such course';
7944: }
7945: my $cstring='';
1.800 albertel 7946: foreach my $pref (keys(%prefs)) {
7947: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 7948: }
1.84 www 7949: $cstring=~s/\&$//;
7950: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
7951: }
7952:
7953: # ---------------------------------------------------------- Make/modify course
7954:
7955: sub createcourse {
1.741 raeburn 7956: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 7957: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 7958: $url=&declutter($url);
7959: my $cid='';
1.1028 raeburn 7960: if ($context eq 'requestcourses') {
7961: my $can_create = 0;
7962: my ($ownername,$ownerdom) = split(':',$course_owner);
7963: if ($udom eq $ownerdom) {
7964: if (&usertools_access($ownername,$ownerdom,$category,undef,
7965: $context)) {
7966: $can_create = 1;
7967: }
7968: } else {
7969: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
7970: $category);
7971: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
7972: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
7973: if (@curr > 0) {
7974: my @options = qw(approval validate autolimit);
7975: my $optregex = join('|',@options);
7976: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
7977: $can_create = 1;
7978: }
7979: }
7980: }
7981: }
7982: if ($can_create) {
7983: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
7984: unless (&allowed('ccc',$udom)) {
7985: return 'refused';
7986: }
1.1017 raeburn 7987: }
7988: } else {
7989: return 'refused';
7990: }
1.1028 raeburn 7991: } elsif (!&allowed('ccc',$udom)) {
7992: return 'refused';
1.84 www 7993: }
1.1011 raeburn 7994: # --------------------------------------------------------------- Get Unique ID
7995: my $uname;
7996: if ($cnum =~ /^$match_courseid$/) {
7997: my $chome=&homeserver($cnum,$udom,'true');
7998: if (($chome eq '') || ($chome eq 'no_host')) {
7999: $uname = $cnum;
8000: } else {
1.1038 raeburn 8001: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 8002: }
8003: } else {
1.1038 raeburn 8004: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 8005: }
8006: return $uname if ($uname =~ /^error/);
8007: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 8008: if (!defined($course_server)) {
8009: if (defined(&domain($udom,'primary'))) {
8010: $course_server = &domain($udom,'primary');
8011: } else {
8012: $course_server = $env{'user.home'};
8013: }
8014: }
8015: my %host_servers =
8016: &Apache::lonnet::get_servers($udom,'library');
8017: unless ($host_servers{$course_server}) {
8018: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 8019: }
1.84 www 8020: # ------------------------------------------------------------- Make the course
8021: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 8022: $course_server);
1.84 www 8023: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 8024: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 8025: if (($uhome eq '') || ($uhome eq 'no_host')) {
8026: return 'error: no such course';
8027: }
1.271 www 8028: # ----------------------------------------------------------------- Course made
1.516 raeburn 8029: # log existence
1.1029 raeburn 8030: my $now = time;
1.918 raeburn 8031: my $newcourse = {
8032: $udom.'_'.$uname => {
1.921 raeburn 8033: description => $description,
8034: inst_code => $inst_code,
8035: owner => $course_owner,
8036: type => $crstype,
1.1029 raeburn 8037: creator => $env{'user.name'}.':'.
8038: $env{'user.domain'},
8039: created => $now,
8040: context => $context,
1.918 raeburn 8041: },
8042: };
1.921 raeburn 8043: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 8044: # set toplevel url
1.271 www 8045: my $topurl=$url;
8046: unless ($nonstandard) {
8047: # ------------------------------------------ For standard courses, make top url
8048: my $mapurl=&clutter($url);
1.278 www 8049: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 8050: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 8051: <map>
8052: <resource id="1" type="start"></resource>
8053: <resource id="2" src="$mapurl"></resource>
8054: <resource id="3" type="finish"></resource>
8055: <link index="1" from="1" to="2"></link>
8056: <link index="2" from="2" to="3"></link>
8057: </map>
8058: ENDINITMAP
8059: $topurl=&declutter(
1.638 albertel 8060: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 8061: );
8062: }
8063: # ----------------------------------------------------------- Write preferences
1.84 www 8064: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 8065: ('description' => $description,
8066: 'url' => $topurl,
8067: 'internal.creator' => $env{'user.name'}.':'.
8068: $env{'user.domain'},
8069: 'internal.created' => $now,
8070: 'internal.creationcontext' => $context)
8071: );
1.84 www 8072: return '/'.$udom.'/'.$uname;
8073: }
8074:
1.1011 raeburn 8075: # ------------------------------------------------------------------- Create ID
8076: sub generate_coursenum {
1.1038 raeburn 8077: my ($udom,$crstype) = @_;
1.1011 raeburn 8078: my $domdesc = &domain($udom);
8079: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 8080: my $first;
8081: if ($crstype eq 'Community') {
8082: $first = '0';
8083: } else {
8084: $first = int(1+rand(9));
8085: }
8086: my $uname=$first.
1.1011 raeburn 8087: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8088: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8089: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8090: # ----------------------------------------------- Make sure that does not exist
8091: my $uhome=&homeserver($uname,$udom,'true');
8092: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 8093: if ($crstype eq 'Community') {
8094: $first = '0';
8095: } else {
8096: $first = int(1+rand(9));
8097: }
8098: $uname=$first.
1.1011 raeburn 8099: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8100: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8101: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8102: $uhome=&homeserver($uname,$udom,'true');
8103: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8104: return 'error: unable to generate unique course-ID';
8105: }
8106: }
8107: return $uname;
8108: }
8109:
1.813 albertel 8110: sub is_course {
1.1167 droeschl 8111: my ($cdom, $cnum) = scalar(@_) == 1 ?
8112: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
8113:
8114: return unless $cdom and $cnum;
8115:
8116: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
8117: '.');
8118:
8119: return unless exists($courses{$cdom.'_'.$cnum});
8120: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 8121: }
8122:
1.1015 raeburn 8123: sub store_userdata {
8124: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 8125: my $result;
1.1016 raeburn 8126: if ($datakey ne '') {
1.1013 raeburn 8127: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 8128: if ($udom eq '' || $uname eq '') {
8129: $udom = $env{'user.domain'};
8130: $uname = $env{'user.name'};
8131: }
8132: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 8133: if (($uhome eq '') || ($uhome eq 'no_host')) {
8134: $result = 'error: no_host';
8135: } else {
8136: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
8137: $storehash->{'host'} = $perlvar{'lonHostID'};
8138:
8139: my $namevalue='';
8140: foreach my $key (keys(%{$storehash})) {
8141: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
8142: }
8143: $namevalue=~s/\&$//;
1.1105 raeburn 8144: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
8145: $namevalue,$uhome);
1.1013 raeburn 8146: }
8147: } else {
8148: $result = 'error: data to store was not a hash reference';
8149: }
8150: } else {
8151: $result= 'error: invalid requestkey';
8152: }
8153: return $result;
8154: }
8155:
1.21 www 8156: # ---------------------------------------------------------- Assign Custom Role
8157:
8158: sub assigncustomrole {
1.957 raeburn 8159: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 8160: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 8161: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 8162: }
8163:
8164: # ----------------------------------------------------------------- Revoke Role
8165:
8166: sub revokerole {
1.957 raeburn 8167: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 8168: my $now=time;
1.965 raeburn 8169: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 8170: }
8171:
8172: # ---------------------------------------------------------- Revoke Custom Role
8173:
8174: sub revokecustomrole {
1.957 raeburn 8175: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 8176: my $now=time;
1.357 www 8177: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 8178: $deleteflag,$selfenroll,$context);
1.17 www 8179: }
8180:
1.533 banghart 8181: # ------------------------------------------------------------ Disk usage
1.535 albertel 8182: sub diskusage {
1.955 raeburn 8183: my ($udom,$uname,$directorypath,$getpropath)=@_;
8184: $directorypath =~ s/\/$//;
8185: my $listing=&reply('du2:'.&escape($directorypath).':'
8186: .&escape($getpropath).':'.&escape($uname).':'
8187: .&escape($udom),homeserver($uname,$udom));
8188: if ($listing eq 'unknown_cmd') {
8189: if ($getpropath) {
8190: $directorypath = &propath($udom,$uname).'/'.$directorypath;
8191: }
8192: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
8193: }
1.514 albertel 8194: return $listing;
1.512 banghart 8195: }
8196:
1.566 banghart 8197: sub is_locked {
1.1096 raeburn 8198: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 8199: my @check;
8200: my $is_locked;
1.1093 raeburn 8201: push (@check,$file_name);
1.613 albertel 8202: my %locked = &get('file_permissions',\@check,
1.620 albertel 8203: $env{'user.domain'},$env{'user.name'});
1.615 albertel 8204: my ($tmp)=keys(%locked);
8205: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 8206:
1.566 banghart 8207: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 8208: $is_locked = 'false';
8209: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 8210: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 8211: $is_locked = 'true';
1.1096 raeburn 8212: if (ref($which) eq 'ARRAY') {
8213: push(@{$which},$entry);
8214: } else {
8215: last;
8216: }
1.745 raeburn 8217: }
8218: }
1.566 banghart 8219: } else {
8220: $is_locked = 'false';
8221: }
1.1093 raeburn 8222: return $is_locked;
1.566 banghart 8223: }
8224:
1.759 albertel 8225: sub declutter_portfile {
8226: my ($file) = @_;
1.833 albertel 8227: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 8228: return $file;
8229: }
8230:
1.559 banghart 8231: # ------------------------------------------------------------- Mark as Read Only
8232:
8233: sub mark_as_readonly {
8234: my ($domain,$user,$files,$what) = @_;
1.613 albertel 8235: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 8236: my ($tmp)=keys(%current_permissions);
8237: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 8238: foreach my $file (@{$files}) {
1.759 albertel 8239: $file = &declutter_portfile($file);
1.561 banghart 8240: push(@{$current_permissions{$file}},$what);
1.559 banghart 8241: }
1.613 albertel 8242: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 8243: return;
8244: }
8245:
1.572 banghart 8246: # ------------------------------------------------------------Save Selected Files
8247:
8248: sub save_selected_files {
8249: my ($user, $path, @files) = @_;
8250: my $filename = $user."savedfiles";
1.573 banghart 8251: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 8252: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 8253: foreach my $file (@files) {
1.620 albertel 8254: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 8255: }
8256: foreach my $file (@other_files) {
1.574 banghart 8257: print (OUT $file."\n");
1.572 banghart 8258: }
1.574 banghart 8259: close (OUT);
1.572 banghart 8260: return 'ok';
8261: }
8262:
1.574 banghart 8263: sub clear_selected_files {
8264: my ($user) = @_;
8265: my $filename = $user."savedfiles";
1.1117 foxr 8266: open (OUT, '>'.LONCAPA::tempdir().$filename);
1.574 banghart 8267: print (OUT undef);
8268: close (OUT);
8269: return ("ok");
8270: }
8271:
1.572 banghart 8272: sub files_in_path {
8273: my ($user, $path) = @_;
8274: my $filename = $user."savedfiles";
8275: my %return_files;
1.1117 foxr 8276: open (IN, '<'.LONCAPA::tempdir().$filename);
1.573 banghart 8277: while (my $line_in = <IN>) {
1.574 banghart 8278: chomp ($line_in);
8279: my @paths_and_file = split (m!/!, $line_in);
8280: my $file_part = pop (@paths_and_file);
8281: my $path_part = join ('/', @paths_and_file);
1.573 banghart 8282: $path_part.='/';
8283: my $path_and_file = $path_part.$file_part;
8284: if ($path_part eq $path) {
8285: $return_files{$file_part}= 'selected';
8286: }
8287: }
1.574 banghart 8288: close (IN);
8289: return (\%return_files);
1.572 banghart 8290: }
8291:
8292: # called in portfolio select mode, to show files selected NOT in current directory
8293: sub files_not_in_path {
8294: my ($user, $path) = @_;
8295: my $filename = $user."savedfiles";
8296: my @return_files;
8297: my $path_part;
1.1117 foxr 8298: open(IN, '<'.LONCAPA::.$filename);
1.800 albertel 8299: while (my $line = <IN>) {
1.572 banghart 8300: #ok, I know it's clunky, but I want it to work
1.800 albertel 8301: my @paths_and_file = split(m|/|, $line);
8302: my $file_part = pop(@paths_and_file);
8303: chomp($file_part);
8304: my $path_part = join('/', @paths_and_file);
1.572 banghart 8305: $path_part .= '/';
8306: my $path_and_file = $path_part.$file_part;
8307: if ($path_part ne $path) {
1.800 albertel 8308: push(@return_files, ($path_and_file));
1.572 banghart 8309: }
8310: }
1.800 albertel 8311: close(OUT);
1.574 banghart 8312: return (@return_files);
1.572 banghart 8313: }
8314:
1.745 raeburn 8315: #----------------------------------------------Get portfolio file permissions
1.629 banghart 8316:
1.745 raeburn 8317: sub get_portfile_permissions {
8318: my ($domain,$user) = @_;
1.613 albertel 8319: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 8320: my ($tmp)=keys(%current_permissions);
8321: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 8322: return \%current_permissions;
8323: }
8324:
8325: #---------------------------------------------Get portfolio file access controls
8326:
1.749 raeburn 8327: sub get_access_controls {
1.745 raeburn 8328: my ($current_permissions,$group,$file) = @_;
1.769 albertel 8329: my %access;
8330: my $real_file = $file;
8331: $file =~ s/\.meta$//;
1.745 raeburn 8332: if (defined($file)) {
1.749 raeburn 8333: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
8334: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 8335: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 8336: }
8337: }
1.745 raeburn 8338: } else {
1.749 raeburn 8339: foreach my $key (keys(%{$current_permissions})) {
8340: if ($key =~ /\0accesscontrol$/) {
8341: if (defined($group)) {
8342: if ($key !~ m-^\Q$group\E/-) {
8343: next;
8344: }
8345: }
8346: my ($fullpath) = split(/\0/,$key);
8347: if (ref($$current_permissions{$key}) eq 'HASH') {
8348: foreach my $control (keys(%{$$current_permissions{$key}})) {
8349: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
8350: }
8351: }
8352: }
8353: }
8354: }
8355: return %access;
8356: }
8357:
8358: sub modify_access_controls {
8359: my ($file_name,$changes,$domain,$user)=@_;
8360: my ($outcome,$deloutcome);
8361: my %store_permissions;
8362: my %new_values;
8363: my %new_control;
8364: my %translation;
8365: my @deletions = ();
8366: my $now = time;
8367: if (exists($$changes{'activate'})) {
8368: if (ref($$changes{'activate'}) eq 'HASH') {
8369: my @newitems = sort(keys(%{$$changes{'activate'}}));
8370: my $numnew = scalar(@newitems);
8371: for (my $i=0; $i<$numnew; $i++) {
8372: my $newkey = $newitems[$i];
8373: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 8374: if ($newkey =~ /^\d+:/) {
8375: $newkey =~ s/^(\d+)/$newid/;
8376: $translation{$1} = $newid;
8377: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
8378: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
8379: $translation{$1} = $newid;
8380: }
1.749 raeburn 8381: $new_values{$file_name."\0".$newkey} =
8382: $$changes{'activate'}{$newitems[$i]};
8383: $new_control{$newkey} = $now;
8384: }
8385: }
8386: }
8387: my %todelete;
8388: my %changed_items;
8389: foreach my $action ('delete','update') {
8390: if (exists($$changes{$action})) {
8391: if (ref($$changes{$action}) eq 'HASH') {
8392: foreach my $key (keys(%{$$changes{$action}})) {
8393: my ($itemnum) = ($key =~ /^([^:]+):/);
8394: if ($action eq 'delete') {
8395: $todelete{$itemnum} = 1;
8396: } else {
8397: $changed_items{$itemnum} = $key;
8398: }
8399: }
1.745 raeburn 8400: }
8401: }
1.749 raeburn 8402: }
8403: # get lock on access controls for file.
8404: my $lockhash = {
8405: $file_name."\0".'locked_access_records' => $env{'user.name'}.
8406: ':'.$env{'user.domain'},
8407: };
8408: my $tries = 0;
8409: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8410:
8411: while (($gotlock ne 'ok') && $tries <3) {
8412: $tries ++;
8413: sleep 1;
8414: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
8415: }
8416: if ($gotlock eq 'ok') {
8417: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
8418: my ($tmp)=keys(%curr_permissions);
8419: if ($tmp=~/^error:/) { undef(%curr_permissions); }
8420: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
8421: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
8422: if (ref($curr_controls) eq 'HASH') {
8423: foreach my $control_item (keys(%{$curr_controls})) {
8424: my ($itemnum) = ($control_item =~ /^([^:]+):/);
8425: if (defined($todelete{$itemnum})) {
8426: push(@deletions,$file_name."\0".$control_item);
8427: } else {
8428: if (defined($changed_items{$itemnum})) {
8429: $new_control{$changed_items{$itemnum}} = $now;
8430: push(@deletions,$file_name."\0".$control_item);
8431: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
8432: } else {
8433: $new_control{$control_item} = $$curr_controls{$control_item};
8434: }
8435: }
1.745 raeburn 8436: }
8437: }
8438: }
1.970 raeburn 8439: my ($group);
8440: if (&is_course($domain,$user)) {
8441: ($group,my $file) = split(/\//,$file_name,2);
8442: }
1.749 raeburn 8443: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
8444: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
8445: $outcome = &put('file_permissions',\%new_values,$domain,$user);
8446: # remove lock
8447: my @del_lock = ($file_name."\0".'locked_access_records');
8448: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 8449: my $sqlresult =
1.970 raeburn 8450: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 8451: $group);
1.749 raeburn 8452: } else {
8453: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 8454: }
1.749 raeburn 8455: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 8456: }
8457:
1.827 raeburn 8458: sub make_public_indefinitely {
8459: my ($requrl) = @_;
8460: my $now = time;
8461: my $action = 'activate';
8462: my $aclnum = 0;
8463: if (&is_portfolio_url($requrl)) {
8464: my (undef,$udom,$unum,$file_name,$group) =
8465: &parse_portfolio_url($requrl);
8466: my $current_perms = &get_portfile_permissions($udom,$unum);
8467: my %access_controls = &get_access_controls($current_perms,
8468: $group,$file_name);
8469: foreach my $key (keys(%{$access_controls{$file_name}})) {
8470: my ($num,$scope,$end,$start) =
8471: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
8472: if ($scope eq 'public') {
8473: if ($start <= $now && $end == 0) {
8474: $action = 'none';
8475: } else {
8476: $action = 'update';
8477: $aclnum = $num;
8478: }
8479: last;
8480: }
8481: }
8482: if ($action eq 'none') {
8483: return 'ok';
8484: } else {
8485: my %changes;
8486: my $newend = 0;
8487: my $newstart = $now;
8488: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
8489: $changes{$action}{$newkey} = {
8490: type => 'public',
8491: time => {
8492: start => $newstart,
8493: end => $newend,
8494: },
8495: };
8496: my ($outcome,$deloutcome,$new_values,$translation) =
8497: &modify_access_controls($file_name,\%changes,$udom,$unum);
8498: return $outcome;
8499: }
8500: } else {
8501: return 'invalid';
8502: }
8503: }
8504:
1.745 raeburn 8505: #------------------------------------------------------Get Marked as Read Only
8506:
8507: sub get_marked_as_readonly {
8508: my ($domain,$user,$what,$group) = @_;
8509: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 8510: my @readonly_files;
1.629 banghart 8511: my $cmp1=$what;
8512: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 8513: while (my ($file_name,$value) = each(%{$current_permissions})) {
8514: if (defined($group)) {
8515: if ($file_name !~ m-^\Q$group\E/-) {
8516: next;
8517: }
8518: }
1.561 banghart 8519: if (ref($value) eq "ARRAY"){
8520: foreach my $stored_what (@{$value}) {
1.629 banghart 8521: my $cmp2=$stored_what;
1.759 albertel 8522: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 8523: $cmp2=join('',@{$stored_what});
1.745 raeburn 8524: }
1.629 banghart 8525: if ($cmp1 eq $cmp2) {
1.561 banghart 8526: push(@readonly_files, $file_name);
1.745 raeburn 8527: last;
1.563 banghart 8528: } elsif (!defined($what)) {
8529: push(@readonly_files, $file_name);
1.745 raeburn 8530: last;
1.561 banghart 8531: }
8532: }
1.745 raeburn 8533: }
1.561 banghart 8534: }
8535: return @readonly_files;
8536: }
1.577 banghart 8537: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 8538:
1.577 banghart 8539: sub get_marked_as_readonly_hash {
1.745 raeburn 8540: my ($current_permissions,$group,$what) = @_;
1.577 banghart 8541: my %readonly_files;
1.745 raeburn 8542: while (my ($file_name,$value) = each(%{$current_permissions})) {
8543: if (defined($group)) {
8544: if ($file_name !~ m-^\Q$group\E/-) {
8545: next;
8546: }
8547: }
1.577 banghart 8548: if (ref($value) eq "ARRAY"){
8549: foreach my $stored_what (@{$value}) {
1.745 raeburn 8550: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 8551: foreach my $lock_descriptor(@{$stored_what}) {
8552: if ($lock_descriptor eq 'graded') {
8553: $readonly_files{$file_name} = 'graded';
8554: } elsif ($lock_descriptor eq 'handback') {
8555: $readonly_files{$file_name} = 'handback';
8556: } else {
8557: if (!exists($readonly_files{$file_name})) {
8558: $readonly_files{$file_name} = 'locked';
8559: }
8560: }
1.745 raeburn 8561: }
1.750 banghart 8562: }
1.577 banghart 8563: }
8564: }
8565: }
8566: return %readonly_files;
8567: }
1.559 banghart 8568: # ------------------------------------------------------------ Unmark as Read Only
8569:
8570: sub unmark_as_readonly {
1.629 banghart 8571: # unmarks $file_name (if $file_name is defined), or all files locked by $what
8572: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 8573: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 8574: $file_name = &declutter_portfile($file_name);
1.634 albertel 8575: my $symb_crs = $what;
8576: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 8577: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 8578: my ($tmp)=keys(%current_permissions);
8579: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 8580: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 8581: foreach my $file (@readonly_files) {
1.759 albertel 8582: my $clean_file = &declutter_portfile($file);
8583: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 8584: my $current_locks = $current_permissions{$file};
1.563 banghart 8585: my @new_locks;
8586: my @del_keys;
8587: if (ref($current_locks) eq "ARRAY"){
8588: foreach my $locker (@{$current_locks}) {
1.632 albertel 8589: my $compare=$locker;
1.749 raeburn 8590: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 8591: $compare=join('',@{$locker});
1.746 raeburn 8592: if ($compare ne $symb_crs) {
8593: push(@new_locks, $locker);
8594: }
1.563 banghart 8595: }
8596: }
1.650 albertel 8597: if (scalar(@new_locks) > 0) {
1.563 banghart 8598: $current_permissions{$file} = \@new_locks;
8599: } else {
8600: push(@del_keys, $file);
1.613 albertel 8601: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 8602: delete($current_permissions{$file});
1.563 banghart 8603: }
8604: }
1.561 banghart 8605: }
1.613 albertel 8606: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 8607: return;
8608: }
1.512 banghart 8609:
1.17 www 8610: # ------------------------------------------------------------ Directory lister
8611:
8612: sub dirlist {
1.955 raeburn 8613: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 8614: $uri=~s/^\///;
8615: $uri=~s/\/$//;
1.253 stredwic 8616: my ($udom, $uname);
1.955 raeburn 8617: if ($getuserdir) {
1.253 stredwic 8618: $udom = $userdomain;
8619: $uname = $username;
1.955 raeburn 8620: } else {
8621: (undef,$udom,$uname)=split(/\//,$uri);
8622: if(defined($userdomain)) {
8623: $udom = $userdomain;
8624: }
8625: if(defined($username)) {
8626: $uname = $username;
8627: }
1.253 stredwic 8628: }
1.955 raeburn 8629: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 8630:
1.955 raeburn 8631: $dirRoot = $perlvar{'lonDocRoot'};
8632: if (defined($getpropath)) {
8633: $dirRoot = &propath($udom,$uname);
1.253 stredwic 8634: $dirRoot =~ s/\/$//;
1.955 raeburn 8635: } elsif (defined($getuserdir)) {
8636: my $subdir=$uname.'__';
8637: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
8638: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
8639: ."/$udom/$subdir/$uname";
8640: } elsif (defined($alternateRoot)) {
8641: $dirRoot = $alternateRoot;
1.751 banghart 8642: }
1.253 stredwic 8643:
8644: if($udom) {
8645: if($uname) {
1.1135 raeburn 8646: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 8647: if ($uhome eq 'no_host') {
8648: return ([],'no_host');
8649: }
1.955 raeburn 8650: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 8651: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 8652: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 8653: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 8654: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 8655: } else {
8656: @listing_results = map { &unescape($_); } split(/:/,$listing);
8657: }
1.605 matthew 8658: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 8659: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 8660: @listing_results = split(/:/,$listing);
8661: } else {
8662: @listing_results = map { &unescape($_); } split(/:/,$listing);
8663: }
1.1135 raeburn 8664: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 8665: ($listing eq 'rejected') || ($listing eq 'refused') ||
8666: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8667: return ([],$listing);
8668: } else {
8669: return (\@listing_results);
1.1135 raeburn 8670: }
1.955 raeburn 8671: } elsif(!$alternateRoot) {
1.1136 raeburn 8672: my (%allusers,%listerror);
1.841 albertel 8673: my %servers = &get_servers($udom,'library');
1.955 raeburn 8674: foreach my $tryserver (keys(%servers)) {
8675: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
8676: &escape($udom),$tryserver);
8677: if ($listing eq 'unknown_cmd') {
8678: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
8679: $udom, $tryserver);
8680: } else {
8681: @listing_results = map { &unescape($_); } split(/:/,$listing);
8682: }
1.841 albertel 8683: if ($listing eq 'unknown_cmd') {
8684: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
8685: $udom, $tryserver);
8686: @listing_results = split(/:/,$listing);
8687: } else {
8688: @listing_results =
8689: map { &unescape($_); } split(/:/,$listing);
8690: }
1.1136 raeburn 8691: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
8692: ($listing eq 'rejected') || ($listing eq 'refused') ||
8693: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
8694: $listerror{$tryserver} = $listing;
8695: } else {
1.841 albertel 8696: foreach my $line (@listing_results) {
8697: my ($entry) = split(/&/,$line,2);
8698: $allusers{$entry} = 1;
8699: }
8700: }
1.253 stredwic 8701: }
1.1136 raeburn 8702: my @alluserslist=();
1.800 albertel 8703: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 8704: push(@alluserslist,$user.'&user');
1.253 stredwic 8705: }
1.1136 raeburn 8706: return (\@alluserslist);
1.253 stredwic 8707: } else {
1.1136 raeburn 8708: return ([],'missing username');
1.253 stredwic 8709: }
1.955 raeburn 8710: } elsif(!defined($getpropath)) {
1.1136 raeburn 8711: my $path = $perlvar{'lonDocRoot'}.'/res/';
8712: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
8713: return (\@all_domains);
1.955 raeburn 8714: } else {
1.1136 raeburn 8715: return ([],'missing domain');
1.275 stredwic 8716: }
8717: }
8718:
8719: # --------------------------------------------- GetFileTimestamp
8720: # This function utilizes dirlist and returns the date stamp for
8721: # when it was last modified. It will also return an error of -1
8722: # if an error occurs
8723:
8724: sub GetFileTimestamp {
1.955 raeburn 8725: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 8726: $studentDomain = &LONCAPA::clean_domain($studentDomain);
8727: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 8728: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
8729: undef,$getuserdir);
8730: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8731: return -1;
8732: }
8733: if (ref($fileref) eq 'ARRAY') {
8734: my @stats = split('&',$fileref->[0]);
1.375 matthew 8735: # @stats contains first the filename, then the stat output
8736: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 8737: } else {
8738: return -1;
1.253 stredwic 8739: }
1.26 www 8740: }
8741:
1.712 albertel 8742: sub stat_file {
8743: my ($uri) = @_;
1.787 albertel 8744: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 8745:
1.955 raeburn 8746: my ($udom,$uname,$file);
1.712 albertel 8747: if ($uri =~ m-^/(uploaded|editupload)/-) {
8748: ($udom,$uname,$file) =
1.811 albertel 8749: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 8750: $file = 'userfiles/'.$file;
8751: }
8752: if ($uri =~ m-^/res/-) {
8753: ($udom,$uname) =
1.807 albertel 8754: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 8755: $file = $uri;
8756: }
8757:
8758: if (!$udom || !$uname || !$file) {
8759: # unable to handle the uri
8760: return ();
8761: }
1.956 raeburn 8762: my $getpropath;
8763: if ($file =~ /^userfiles\//) {
8764: $getpropath = 1;
8765: }
1.1136 raeburn 8766: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
8767: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
8768: return ();
8769: } else {
8770: if (ref($listref) eq 'ARRAY') {
8771: my @stats = split('&',$listref->[0]);
8772: shift(@stats); #filename is first
8773: return @stats;
8774: }
1.712 albertel 8775: }
8776: return ();
8777: }
8778:
1.26 www 8779: # -------------------------------------------------------- Value of a Condition
8780:
1.713 albertel 8781: # gets the value of a specific preevaluated condition
8782: # stored in the string $env{user.state.<cid>}
8783: # or looks up a condition reference in the bighash and if if hasn't
8784: # already been evaluated recurses into docondval to get the value of
8785: # the condition, then memoizing it to
8786: # $env{user.state.<cid>.<condition>}
1.40 www 8787: sub directcondval {
8788: my $number=shift;
1.620 albertel 8789: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 8790: &Apache::lonuserstate::evalstate();
8791: }
1.713 albertel 8792: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
8793: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
8794: } elsif ($number =~ /^_/) {
8795: my $sub_condition;
8796: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8797: &GDBM_READER(),0640)) {
8798: $sub_condition=$bighash{'conditions'.$number};
8799: untie(%bighash);
8800: }
8801: my $value = &docondval($sub_condition);
1.949 raeburn 8802: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 8803: return $value;
8804: }
1.620 albertel 8805: if ($env{'user.state.'.$env{'request.course.id'}}) {
8806: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 8807: } else {
8808: return 2;
8809: }
8810: }
8811:
1.713 albertel 8812: # get the collection of conditions for this resource
1.26 www 8813: sub condval {
8814: my $condidx=shift;
1.54 www 8815: my $allpathcond='';
1.713 albertel 8816: foreach my $cond (split(/\|/,$condidx)) {
8817: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
8818: $allpathcond.=
8819: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
8820: }
1.191 harris41 8821: }
1.54 www 8822: $allpathcond=~s/\|$//;
1.713 albertel 8823: return &docondval($allpathcond);
8824: }
8825:
8826: #evaluates an expression of conditions
8827: sub docondval {
8828: my ($allpathcond) = @_;
8829: my $result=0;
8830: if ($env{'request.course.id'}
8831: && defined($allpathcond)) {
8832: my $operand='|';
8833: my @stack;
8834: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
8835: if ($chunk eq '(') {
8836: push @stack,($operand,$result);
8837: } elsif ($chunk eq ')') {
8838: my $before=pop @stack;
8839: if (pop @stack eq '&') {
8840: $result=$result>$before?$before:$result;
8841: } else {
8842: $result=$result>$before?$result:$before;
8843: }
8844: } elsif (($chunk eq '&') || ($chunk eq '|')) {
8845: $operand=$chunk;
8846: } else {
8847: my $new=directcondval($chunk);
8848: if ($operand eq '&') {
8849: $result=$result>$new?$new:$result;
8850: } else {
8851: $result=$result>$new?$result:$new;
8852: }
8853: }
8854: }
1.26 www 8855: }
8856: return $result;
1.421 albertel 8857: }
8858:
8859: # ---------------------------------------------------- Devalidate courseresdata
8860:
8861: sub devalidatecourseresdata {
8862: my ($coursenum,$coursedomain)=@_;
8863: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 8864: &devalidate_cache_new('courseres',$hashid);
1.28 www 8865: }
8866:
1.763 www 8867:
1.200 www 8868: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 8869: #
8870: # Parameters:
8871: # $coursenum - Number of the course.
8872: # $coursedomain - Domain at which the course was created.
8873: # Returns:
8874: # A hash of the course parameters along (I think) with timestamps
8875: # and version info.
1.877 foxr 8876:
1.624 albertel 8877: sub get_courseresdata {
8878: my ($coursenum,$coursedomain)=@_;
1.200 www 8879: my $coursehom=&homeserver($coursenum,$coursedomain);
8880: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 8881: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 8882: my %dumpreply;
1.417 albertel 8883: unless (defined($cached)) {
1.624 albertel 8884: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 8885: $result=\%dumpreply;
1.251 albertel 8886: my ($tmp) = keys(%dumpreply);
8887: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 8888: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 8889: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
8890: return $tmp;
1.416 albertel 8891: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 8892: $result=undef;
1.599 albertel 8893: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 8894: }
8895: }
1.624 albertel 8896: return $result;
8897: }
8898:
1.633 albertel 8899: sub devalidateuserresdata {
8900: my ($uname,$udom)=@_;
8901: my $hashid="$udom:$uname";
8902: &devalidate_cache_new('userres',$hashid);
8903: }
8904:
1.624 albertel 8905: sub get_userresdata {
8906: my ($uname,$udom)=@_;
8907: #most student don\'t have any data set, check if there is some data
8908: if (&EXT_cache_status($udom,$uname)) { return undef; }
8909:
8910: my $hashid="$udom:$uname";
8911: my ($result,$cached)=&is_cached_new('userres',$hashid);
8912: if (!defined($cached)) {
8913: my %resourcedata=&dump('resourcedata',$udom,$uname);
8914: $result=\%resourcedata;
8915: &do_cache_new('userres',$hashid,$result,600);
8916: }
8917: my ($tmp)=keys(%$result);
8918: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
8919: return $result;
8920: }
8921: #error 2 occurs when the .db doesn't exist
8922: if ($tmp!~/error: 2 /) {
1.672 albertel 8923: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 8924: " Trying to get resource data for ".
8925: $uname." at ".$udom.": ".
8926: $tmp."</font>");
8927: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 8928: #&EXT_cache_set($udom,$uname);
8929: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 8930: undef($tmp); # not really an error so don't send it back
1.624 albertel 8931: }
8932: return $tmp;
8933: }
1.879 foxr 8934: #----------------------------------------------- resdata - return resource data
8935: # Purpose:
8936: # Return resource data for either users or for a course.
8937: # Parameters:
8938: # $name - Course/user name.
8939: # $domain - Name of the domain the user/course is registered on.
8940: # $type - Type of thing $name is (must be 'course' or 'user'
8941: # @which - Array of names of resources desired.
8942: # Returns:
8943: # The value of the first reasource in @which that is found in the
8944: # resource hash.
8945: # Exceptional Conditions:
8946: # If the $type passed in is not valid (not the string 'course' or
8947: # 'user', an undefined reference is returned.
8948: # If none of the resources are found, an undef is returned
1.624 albertel 8949: sub resdata {
8950: my ($name,$domain,$type,@which)=@_;
8951: my $result;
8952: if ($type eq 'course') {
8953: $result=&get_courseresdata($name,$domain);
8954: } elsif ($type eq 'user') {
8955: $result=&get_userresdata($name,$domain);
8956: }
8957: if (!ref($result)) { return $result; }
1.251 albertel 8958: foreach my $item (@which) {
1.927 albertel 8959: if (defined($result->{$item->[0]})) {
8960: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 8961: }
1.250 albertel 8962: }
1.291 albertel 8963: return undef;
1.200 www 8964: }
8965:
1.379 matthew 8966: #
8967: # EXT resource caching routines
8968: #
8969:
8970: sub clear_EXT_cache_status {
1.383 albertel 8971: &delenv('cache.EXT.');
1.379 matthew 8972: }
8973:
8974: sub EXT_cache_status {
8975: my ($target_domain,$target_user) = @_;
1.383 albertel 8976: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 8977: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 8978: # We know already the user has no data
8979: return 1;
8980: } else {
8981: return 0;
8982: }
8983: }
8984:
8985: sub EXT_cache_set {
8986: my ($target_domain,$target_user) = @_;
1.383 albertel 8987: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 8988: #&appenv({$cachename => time});
1.379 matthew 8989: }
8990:
1.28 www 8991: # --------------------------------------------------------- Value of a Variable
1.58 www 8992: sub EXT {
1.715 albertel 8993:
1.395 albertel 8994: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 8995: unless ($varname) { return ''; }
1.218 albertel 8996: #get real user name/domain, courseid and symb
8997: my $courseid;
1.359 albertel 8998: my $publicuser;
1.427 www 8999: if ($symbparm) {
9000: $symbparm=&get_symb_from_alias($symbparm);
9001: }
1.218 albertel 9002: if (!($uname && $udom)) {
1.790 albertel 9003: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 9004: if (!$symbparm) { $symbparm=$cursymb; }
9005: } else {
1.620 albertel 9006: $courseid=$env{'request.course.id'};
1.218 albertel 9007: }
1.48 www 9008: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
9009: my $rest;
1.320 albertel 9010: if (defined($therest[0])) {
1.48 www 9011: $rest=join('.',@therest);
9012: } else {
9013: $rest='';
9014: }
1.320 albertel 9015:
1.57 www 9016: my $qualifierrest=$qualifier;
9017: if ($rest) { $qualifierrest.='.'.$rest; }
9018: my $spacequalifierrest=$space;
9019: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 9020: if ($realm eq 'user') {
1.48 www 9021: # --------------------------------------------------------------- user.resource
9022: if ($space eq 'resource') {
1.651 albertel 9023: if ( (defined($Apache::lonhomework::parsing_a_problem)
9024: || defined($Apache::lonhomework::parsing_a_task))
9025: &&
1.744 albertel 9026: ($symbparm eq &symbread()) ) {
9027: # if we are in the middle of processing the resource the
9028: # get the value we are planning on committing
9029: if (defined($Apache::lonhomework::results{$qualifierrest})) {
9030: return $Apache::lonhomework::results{$qualifierrest};
9031: } else {
9032: return $Apache::lonhomework::history{$qualifierrest};
9033: }
1.335 albertel 9034: } else {
1.359 albertel 9035: my %restored;
1.620 albertel 9036: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 9037: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
9038: } else {
9039: %restored=&restore($symbparm,$courseid,$udom,$uname);
9040: }
1.335 albertel 9041: return $restored{$qualifierrest};
9042: }
1.48 www 9043: # ----------------------------------------------------------------- user.access
9044: } elsif ($space eq 'access') {
1.218 albertel 9045: # FIXME - not supporting calls for a specific user
1.48 www 9046: return &allowed($qualifier,$rest);
9047: # ------------------------------------------ user.preferences, user.environment
9048: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 9049: if (($uname eq $env{'user.name'}) &&
9050: ($udom eq $env{'user.domain'})) {
9051: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 9052: } else {
1.359 albertel 9053: my %returnhash;
9054: if (!$publicuser) {
9055: %returnhash=&userenvironment($udom,$uname,
9056: $qualifierrest);
9057: }
1.218 albertel 9058: return $returnhash{$qualifierrest};
9059: }
1.48 www 9060: # ----------------------------------------------------------------- user.course
9061: } elsif ($space eq 'course') {
1.218 albertel 9062: # FIXME - not supporting calls for a specific user
1.620 albertel 9063: return $env{join('.',('request.course',$qualifier))};
1.48 www 9064: # ------------------------------------------------------------------- user.role
9065: } elsif ($space eq 'role') {
1.218 albertel 9066: # FIXME - not supporting calls for a specific user
1.620 albertel 9067: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 9068: if ($qualifier eq 'value') {
9069: return $role;
9070: } elsif ($qualifier eq 'extent') {
9071: return $where;
9072: }
9073: # ----------------------------------------------------------------- user.domain
9074: } elsif ($space eq 'domain') {
1.218 albertel 9075: return $udom;
1.48 www 9076: # ------------------------------------------------------------------- user.name
9077: } elsif ($space eq 'name') {
1.218 albertel 9078: return $uname;
1.48 www 9079: # ---------------------------------------------------- Any other user namespace
1.29 www 9080: } else {
1.359 albertel 9081: my %reply;
9082: if (!$publicuser) {
9083: %reply=&get($space,[$qualifierrest],$udom,$uname);
9084: }
9085: return $reply{$qualifierrest};
1.48 www 9086: }
1.236 www 9087: } elsif ($realm eq 'query') {
9088: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 9089: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
9090: [$spacequalifierrest]);
1.620 albertel 9091: return $env{'form.'.$spacequalifierrest};
1.236 www 9092: } elsif ($realm eq 'request') {
1.48 www 9093: # ------------------------------------------------------------- request.browser
9094: if ($space eq 'browser') {
1.1145 bisitz 9095: return $env{'browser.'.$qualifier};
1.57 www 9096: # ------------------------------------------------------------ request.filename
9097: } else {
1.620 albertel 9098: return $env{'request.'.$spacequalifierrest};
1.29 www 9099: }
1.28 www 9100: } elsif ($realm eq 'course') {
1.48 www 9101: # ---------------------------------------------------------- course.description
1.620 albertel 9102: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 9103: } elsif ($realm eq 'resource') {
1.165 www 9104:
1.620 albertel 9105: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 9106: if (!$symbparm) { $symbparm=&symbread(); }
9107: }
1.693 albertel 9108:
9109: if ($space eq 'title') {
9110: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
9111: return &gettitle($symbparm);
9112: }
9113:
9114: if ($space eq 'map') {
9115: my ($map) = &decode_symb($symbparm);
9116: return &symbread($map);
9117: }
1.905 albertel 9118: if ($space eq 'filename') {
9119: if ($symbparm) {
9120: return &clutter((&decode_symb($symbparm))[2]);
9121: }
9122: return &hreflocation('',$env{'request.filename'});
9123: }
1.693 albertel 9124:
9125: my ($section, $group, @groups);
1.593 albertel 9126: my ($courselevelm,$courselevel);
1.539 albertel 9127: if ($symbparm && defined($courseid) &&
1.620 albertel 9128: $courseid eq $env{'request.course.id'}) {
1.165 www 9129:
1.218 albertel 9130: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 9131:
1.60 www 9132: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 9133: my $symbp=$symbparm;
1.735 albertel 9134: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 9135:
9136: my $symbparm=$symbp.'.'.$spacequalifierrest;
9137: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
9138:
1.620 albertel 9139: if (($env{'user.name'} eq $uname) &&
9140: ($env{'user.domain'} eq $udom)) {
9141: $section=$env{'request.course.sec'};
1.733 raeburn 9142: @groups = split(/:/,$env{'request.course.groups'});
9143: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 9144: } else {
1.539 albertel 9145: if (! defined($usection)) {
1.551 albertel 9146: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 9147: } else {
9148: $section = $usection;
9149: }
1.733 raeburn 9150: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 9151: }
9152:
9153: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
9154: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
9155: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
9156:
1.593 albertel 9157: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 9158: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 9159: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 9160:
1.60 www 9161: # ----------------------------------------------------------- first, check user
1.624 albertel 9162:
9163: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 9164: ([$courselevelr,'resource'],
9165: [$courselevelm,'map' ],
9166: [$courselevel, 'course' ]));
1.931 albertel 9167: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 9168:
1.594 albertel 9169: # ------------------------------------------------ second, check some of course
1.684 raeburn 9170: my $coursereply;
1.691 raeburn 9171: if (@groups > 0) {
9172: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
9173: $mapparm,$spacequalifierrest);
1.927 albertel 9174: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 9175: }
1.96 www 9176:
1.684 raeburn 9177: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 9178: $env{'course.'.$courseid.'.domain'},
9179: 'course',
9180: ([$seclevelr, 'resource'],
9181: [$seclevelm, 'map' ],
9182: [$seclevel, 'course' ],
9183: [$courselevelr,'resource']));
9184: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 9185:
1.60 www 9186: # ------------------------------------------------------ third, check map parms
1.218 albertel 9187: my %parmhash=();
9188: my $thisparm='';
9189: if (tie(%parmhash,'GDBM_File',
1.620 albertel 9190: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 9191: &GDBM_READER(),0640)) {
1.218 albertel 9192: $thisparm=$parmhash{$symbparm};
9193: untie(%parmhash);
9194: }
1.927 albertel 9195: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 9196: }
1.594 albertel 9197: # ------------------------------------------ fourth, look in resource metadata
1.71 www 9198:
1.218 albertel 9199: $spacequalifierrest=~s/\./\_/;
1.282 albertel 9200: my $filename;
9201: if (!$symbparm) { $symbparm=&symbread(); }
9202: if ($symbparm) {
1.409 www 9203: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 9204: } else {
1.620 albertel 9205: $filename=$env{'request.filename'};
1.282 albertel 9206: }
9207: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 9208: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 9209: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 9210: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 9211:
1.927 albertel 9212: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 9213: if ($symbparm && defined($courseid) &&
1.620 albertel 9214: $courseid eq $env{'request.course.id'}) {
1.624 albertel 9215: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
9216: $env{'course.'.$courseid.'.domain'},
9217: 'course',
1.927 albertel 9218: ([$courselevelm,'map' ],
9219: [$courselevel, 'course']));
9220: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 9221: }
1.145 www 9222: # ------------------------------------------------------------------ Cascade up
1.218 albertel 9223: unless ($space eq '0') {
1.336 albertel 9224: my @parts=split(/_/,$space);
9225: my $id=pop(@parts);
9226: my $part=join('_',@parts);
9227: if ($part eq '') { $part='0'; }
1.927 albertel 9228: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 9229: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 9230: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 9231: }
1.395 albertel 9232: if ($recurse) { return undef; }
9233: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 9234: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 9235: # ---------------------------------------------------- Any other user namespace
9236: } elsif ($realm eq 'environment') {
9237: # ----------------------------------------------------------------- environment
1.620 albertel 9238: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
9239: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 9240: } else {
1.770 albertel 9241: if ($uname eq 'anonymous' && $udom eq '') {
9242: return '';
9243: }
1.219 albertel 9244: my %returnhash=&userenvironment($udom,$uname,
9245: $spacequalifierrest);
9246: return $returnhash{$spacequalifierrest};
9247: }
1.28 www 9248: } elsif ($realm eq 'system') {
1.48 www 9249: # ----------------------------------------------------------------- system.time
9250: if ($space eq 'time') {
9251: return time;
9252: }
1.696 albertel 9253: } elsif ($realm eq 'server') {
9254: # ----------------------------------------------------------------- system.time
9255: if ($space eq 'name') {
9256: return $ENV{'SERVER_NAME'};
9257: }
1.28 www 9258: }
1.48 www 9259: return '';
1.61 www 9260: }
9261:
1.927 albertel 9262: sub get_reply {
9263: my ($reply_value) = @_;
1.940 raeburn 9264: if (ref($reply_value) eq 'ARRAY') {
9265: if (wantarray) {
9266: return @$reply_value;
9267: }
9268: return $reply_value->[0];
9269: } else {
9270: return $reply_value;
1.927 albertel 9271: }
9272: }
9273:
1.691 raeburn 9274: sub check_group_parms {
9275: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
9276: my @groupitems = ();
9277: my $resultitem;
1.927 albertel 9278: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 9279: foreach my $group (@{$groups}) {
9280: foreach my $level (@levels) {
1.927 albertel 9281: my $item = $courseid.'.['.$group.'].'.$level->[0];
9282: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 9283: }
9284: }
9285: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
9286: $env{'course.'.$courseid.'.domain'},
9287: 'course',@groupitems);
9288: return $coursereply;
9289: }
9290:
9291: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 9292: my ($courseid,@groups) = @_;
9293: @groups = sort(@groups);
1.691 raeburn 9294: return @groups;
9295: }
9296:
1.395 albertel 9297: sub packages_tab_default {
9298: my ($uri,$varname)=@_;
9299: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 9300:
9301: my (@extension,@specifics,$do_default);
9302: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 9303: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 9304: if ($pack_type eq 'default') {
9305: $do_default=1;
9306: } elsif ($pack_type eq 'extension') {
9307: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 9308: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 9309: # only look at packages defaults for packages that this id is
1.738 albertel 9310: push(@specifics,[$package,$pack_type,$pack_part]);
9311: }
9312: }
9313: # first look for a package that matches the requested part id
9314: foreach my $package (@specifics) {
9315: my (undef,$pack_type,$pack_part)=@{$package};
9316: next if ($pack_part ne $part);
9317: if (defined($packagetab{"$pack_type&$name&default"})) {
9318: return $packagetab{"$pack_type&$name&default"};
9319: }
9320: }
9321: # look for any possible matching non extension_ package
9322: foreach my $package (@specifics) {
9323: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 9324: if (defined($packagetab{"$pack_type&$name&default"})) {
9325: return $packagetab{"$pack_type&$name&default"};
9326: }
1.585 albertel 9327: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 9328: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
9329: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 9330: }
9331: }
1.738 albertel 9332: # look for any posible extension_ match
9333: foreach my $package (@extension) {
9334: my ($package,$pack_type)=@{$package};
9335: if (defined($packagetab{"$pack_type&$name&default"})) {
9336: return $packagetab{"$pack_type&$name&default"};
9337: }
9338: if (defined($packagetab{$package."&$name&default"})) {
9339: return $packagetab{$package."&$name&default"};
9340: }
9341: }
9342: # look for a global default setting
9343: if ($do_default && defined($packagetab{"default&$name&default"})) {
9344: return $packagetab{"default&$name&default"};
9345: }
1.395 albertel 9346: return undef;
9347: }
9348:
1.334 albertel 9349: sub add_prefix_and_part {
9350: my ($prefix,$part)=@_;
9351: my $keyroot;
9352: if (defined($prefix) && $prefix !~ /^__/) {
9353: # prefix that has a part already
9354: $keyroot=$prefix;
9355: } elsif (defined($prefix)) {
9356: # prefix that is missing a part
9357: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
9358: } else {
9359: # no prefix at all
9360: if (defined($part)) { $keyroot='_'.$part; }
9361: }
9362: return $keyroot;
9363: }
9364:
1.71 www 9365: # ---------------------------------------------------------------- Get metadata
9366:
1.599 albertel 9367: my %metaentry;
1.1070 www 9368: my %importedpartids;
1.71 www 9369: sub metadata {
1.176 www 9370: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 9371: $uri=&declutter($uri);
1.288 albertel 9372: # if it is a non metadata possible uri return quickly
1.529 albertel 9373: if (($uri eq '') ||
9374: (($uri =~ m|^/*adm/|) &&
1.698 albertel 9375: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.1108 raeburn 9376: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 9377: return undef;
9378: }
1.1140 www 9379: if (($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/)
1.924 albertel 9380: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 9381: return undef;
1.288 albertel 9382: }
1.73 www 9383: my $filename=$uri;
9384: $uri=~s/\.meta$//;
1.172 www 9385: #
9386: # Is the metadata already cached?
1.177 www 9387: # Look at timestamp of caching
1.172 www 9388: # Everything is cached by the main uri, libraries are never directly cached
9389: #
1.428 albertel 9390: if (!defined($liburi)) {
1.599 albertel 9391: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 9392: if (defined($cached)) { return $result->{':'.$what}; }
9393: }
9394: {
1.1069 www 9395: # Imported parts would go here
1.1070 www 9396: my %importedids=();
9397: my @origfileimportpartids=();
1.1069 www 9398: my $importedparts=0;
1.172 www 9399: #
9400: # Is this a recursive call for a library?
9401: #
1.599 albertel 9402: # if (! exists($metacache{$uri})) {
9403: # $metacache{$uri}={};
9404: # }
1.924 albertel 9405: my $cachetime = 60*60;
1.171 www 9406: if ($liburi) {
9407: $liburi=&declutter($liburi);
9408: $filename=$liburi;
1.401 bowersj2 9409: } else {
1.599 albertel 9410: &devalidate_cache_new('meta',$uri);
9411: undef(%metaentry);
1.401 bowersj2 9412: }
1.140 www 9413: my %metathesekeys=();
1.73 www 9414: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 9415: my $metastring;
1.1140 www 9416: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 9417: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 9418: $metastring =
1.929 albertel 9419: &Apache::lonnet::ssi_body($which,
1.924 albertel 9420: ('grade_target' => 'meta'));
9421: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 9422: } elsif (($uri !~ m -^(editupload)/-) &&
9423: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 9424: my $file=&filelocation('',&clutter($filename));
1.599 albertel 9425: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 9426: $metastring=&getfile($file);
1.489 albertel 9427: }
1.208 albertel 9428: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 9429: my $token;
1.140 www 9430: undef %metathesekeys;
1.71 www 9431: while ($token=$parser->get_token) {
1.339 albertel 9432: if ($token->[0] eq 'S') {
9433: if (defined($token->[2]->{'package'})) {
1.172 www 9434: #
9435: # This is a package - get package info
9436: #
1.339 albertel 9437: my $package=$token->[2]->{'package'};
9438: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9439: if (defined($token->[2]->{'id'})) {
9440: $keyroot.='_'.$token->[2]->{'id'};
9441: }
1.599 albertel 9442: if ($metaentry{':packages'}) {
9443: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 9444: } else {
1.599 albertel 9445: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 9446: }
1.736 albertel 9447: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 9448: my $part=$keyroot;
9449: $part=~s/^\_//;
1.736 albertel 9450: if ($pack_entry=~/^\Q$package\E\&/ ||
9451: $pack_entry=~/^\Q$package\E_0\&/) {
9452: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 9453: # ignore package.tab specified default values
9454: # here &package_tab_default() will fetch those
9455: if ($subp eq 'default') { next; }
1.736 albertel 9456: my $value=$packagetab{$pack_entry};
1.432 albertel 9457: my $unikey;
9458: if ($pack =~ /_0$/) {
9459: $unikey='parameter_0_'.$name;
9460: $part=0;
9461: } else {
9462: $unikey='parameter'.$keyroot.'_'.$name;
9463: }
1.339 albertel 9464: if ($subp eq 'display') {
9465: $value.=' [Part: '.$part.']';
9466: }
1.599 albertel 9467: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 9468: $metathesekeys{$unikey}=1;
1.599 albertel 9469: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9470: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 9471: }
1.599 albertel 9472: if (defined($metaentry{':'.$unikey.'.default'})) {
9473: $metaentry{':'.$unikey}=
9474: $metaentry{':'.$unikey.'.default'};
1.356 albertel 9475: }
1.339 albertel 9476: }
9477: }
9478: } else {
1.172 www 9479: #
9480: # This is not a package - some other kind of start tag
1.339 albertel 9481: #
9482: my $entry=$token->[1];
1.1068 www 9483: my $unikey='';
1.175 www 9484:
1.339 albertel 9485: if ($entry eq 'import') {
1.175 www 9486: #
9487: # Importing a library here
1.339 albertel 9488: #
1.1067 www 9489: my $location=$parser->get_text('/import');
9490: my $dir=$filename;
9491: $dir=~s|[^/]*$||;
9492: $location=&filelocation($dir,$location);
1.1069 www 9493:
1.1068 www 9494: my $importmode=$token->[2]->{'importmode'};
9495: if ($importmode eq 'problem') {
1.1069 www 9496: # Import as problem/response
1.1068 www 9497: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9498: } elsif ($importmode eq 'part') {
9499: # Import as part(s)
1.1069 www 9500: $importedparts=1;
9501: # We need to get the original file and the imported file to get the part order correct
9502: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
9503: # Load and inspect original file
1.1070 www 9504: if ($#origfileimportpartids<0) {
9505: undef(%importedpartids);
9506: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
9507: my $origfile=&getfile($origfilelocation);
9508: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9509: }
9510:
1.1069 www 9511: # Load and inspect imported file
9512: my $impfile=&getfile($location);
9513: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
9514: if ($#impfilepartids>=0) {
9515: # This problem had parts
1.1070 www 9516: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 9517: } else {
9518: # Importing by turning a single problem into a problem part
9519: # It gets the import-tags ID as part-ID
9520: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 9521: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 9522: }
1.1068 www 9523: } else {
9524: # Normal import
9525: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
9526: if (defined($token->[2]->{'id'})) {
9527: $unikey.='_'.$token->[2]->{'id'};
9528: }
1.1067 www 9529: }
9530:
1.339 albertel 9531: if ($depthcount<20) {
1.736 albertel 9532: my $metadata =
9533: &metadata($uri,'keys', $location,$unikey,
9534: $depthcount+1);
9535: foreach my $meta (split(',',$metadata)) {
9536: $metaentry{':'.$meta}=$metaentry{':'.$meta};
9537: $metathesekeys{$meta}=1;
1.339 albertel 9538: }
1.1068 www 9539:
9540: }
1.1067 www 9541: } else {
9542: #
9543: # Not importing, some other kind of non-package, non-library start tag
9544: #
9545: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
9546: if (defined($token->[2]->{'id'})) {
9547: $unikey.='_'.$token->[2]->{'id'};
9548: }
1.339 albertel 9549: if (defined($token->[2]->{'name'})) {
9550: $unikey.='_'.$token->[2]->{'name'};
9551: }
9552: $metathesekeys{$unikey}=1;
1.736 albertel 9553: foreach my $param (@{$token->[3]}) {
9554: $metaentry{':'.$unikey.'.'.$param} =
9555: $token->[2]->{$param};
1.339 albertel 9556: }
9557: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 9558: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 9559: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
9560: # only ws inside the tag, and not in default, so use default
9561: # as value
1.599 albertel 9562: $metaentry{':'.$unikey}=$default;
1.908 albertel 9563: } elsif ( $internaltext =~ /\S/ ) {
9564: # something interesting inside the tag
9565: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 9566: } else {
1.908 albertel 9567: # no interesting values, don't set a default
1.339 albertel 9568: }
1.172 www 9569: # end of not-a-package not-a-library import
1.339 albertel 9570: }
1.172 www 9571: # end of not-a-package start tag
1.339 albertel 9572: }
1.172 www 9573: # the next is the end of "start tag"
1.339 albertel 9574: }
9575: }
1.483 albertel 9576: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 9577: $extension = lc($extension);
9578: if ($extension eq 'htm') { $extension='html'; }
9579:
1.737 albertel 9580: foreach my $key (keys(%packagetab)) {
1.483 albertel 9581: #no specific packages #how's our extension
9582: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 9583: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 9584: \%metathesekeys);
9585: }
1.883 albertel 9586:
9587: if (!exists($metaentry{':packages'})
9588: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 9589: foreach my $key (keys(%packagetab)) {
1.483 albertel 9590: #no specific packages well let's get default then
9591: if ($key!~/^default&/) { next; }
1.488 albertel 9592: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 9593: \%metathesekeys);
9594: }
9595: }
1.338 www 9596: # are there custom rights to evaluate
1.599 albertel 9597: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 9598:
1.338 www 9599: #
9600: # Importing a rights file here
1.339 albertel 9601: #
9602: unless ($depthcount) {
1.599 albertel 9603: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 9604: my $dir=$filename;
9605: $dir=~s|[^/]*$||;
9606: $location=&filelocation($dir,$location);
1.736 albertel 9607: my $rights_metadata =
9608: &metadata($uri,'keys',$location,'_rights',
9609: $depthcount+1);
9610: foreach my $rights (split(',',$rights_metadata)) {
9611: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
9612: $metathesekeys{$rights}=1;
1.339 albertel 9613: }
9614: }
9615: }
1.737 albertel 9616: # uniqifiy package listing
9617: my %seen;
9618: my @uniq_packages =
9619: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
9620: $metaentry{':packages'} = join(',',@uniq_packages);
9621:
1.1070 www 9622: if ($importedparts) {
9623: # We had imported parts and need to rebuild partorder
9624: $metaentry{':partorder'}='';
9625: $metathesekeys{'partorder'}=1;
9626: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
9627: if ($origfileimportpartids[$index] eq 'part') {
9628: # original part, part of the problem
9629: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
9630: } else {
9631: # we have imported parts at this position
9632: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
9633: }
9634: }
9635: $metaentry{':partorder'}=~s/^\,//;
9636: }
9637:
1.737 albertel 9638: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 9639: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
9640: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 9641: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 9642: # this is the end of "was not already recently cached
1.71 www 9643: }
1.599 albertel 9644: return $metaentry{':'.$what};
1.261 albertel 9645: }
9646:
1.488 albertel 9647: sub metadata_create_package_def {
1.483 albertel 9648: my ($uri,$key,$package,$metathesekeys)=@_;
9649: my ($pack,$name,$subp)=split(/\&/,$key);
9650: if ($subp eq 'default') { next; }
9651:
1.599 albertel 9652: if (defined($metaentry{':packages'})) {
9653: $metaentry{':packages'}.=','.$package;
1.483 albertel 9654: } else {
1.599 albertel 9655: $metaentry{':packages'}=$package;
1.483 albertel 9656: }
9657: my $value=$packagetab{$key};
9658: my $unikey;
9659: $unikey='parameter_0_'.$name;
1.599 albertel 9660: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 9661: $$metathesekeys{$unikey}=1;
1.599 albertel 9662: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
9663: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 9664: }
1.599 albertel 9665: if (defined($metaentry{':'.$unikey.'.default'})) {
9666: $metaentry{':'.$unikey}=
9667: $metaentry{':'.$unikey.'.default'};
1.483 albertel 9668: }
9669: }
9670:
1.261 albertel 9671: sub metadata_generate_part0 {
9672: my ($metadata,$metacache,$uri) = @_;
9673: my %allnames;
1.737 albertel 9674: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 9675: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 9676: my $part=$$metacache{':'.$metakey.'.part'};
9677: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 9678: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 9679: $allnames{$name}=$part;
9680: }
9681: }
9682: }
9683: foreach my $name (keys(%allnames)) {
9684: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 9685: my $key=":parameter_0_$name";
1.261 albertel 9686: $$metacache{"$key.part"}='0';
9687: $$metacache{"$key.name"}=$name;
1.428 albertel 9688: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 9689: $allnames{$name}.'_'.$name.
9690: '.type'};
1.428 albertel 9691: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 9692: '.display'};
1.644 www 9693: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 9694: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 9695: $$metacache{"$key.display"}=$olddis;
9696: }
1.71 www 9697: }
9698:
1.764 albertel 9699: # ------------------------------------------------------ Devalidate title cache
9700:
9701: sub devalidate_title_cache {
9702: my ($url)=@_;
9703: if (!$env{'request.course.id'}) { return; }
9704: my $symb=&symbread($url);
9705: if (!$symb) { return; }
9706: my $key=$env{'request.course.id'}."\0".$symb;
9707: &devalidate_cache_new('title',$key);
9708: }
9709:
1.1014 droeschl 9710: # ------------------------------------------------- Get the title of a course
9711:
9712: sub current_course_title {
9713: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
9714: }
1.301 www 9715: # ------------------------------------------------- Get the title of a resource
9716:
9717: sub gettitle {
9718: my $urlsymb=shift;
9719: my $symb=&symbread($urlsymb);
1.534 albertel 9720: if ($symb) {
1.620 albertel 9721: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 9722: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 9723: if (defined($cached)) {
9724: return $result;
9725: }
1.534 albertel 9726: my ($map,$resid,$url)=&decode_symb($symb);
9727: my $title='';
1.907 albertel 9728: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
9729: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
9730: } else {
9731: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9732: &GDBM_READER(),0640)) {
9733: my $mapid=$bighash{'map_pc_'.&clutter($map)};
9734: $title=$bighash{'title_'.$mapid.'.'.$resid};
9735: untie(%bighash);
9736: }
1.534 albertel 9737: }
9738: $title=~s/\&colon\;/\:/gs;
9739: if ($title) {
1.1159 www 9740: # Remember both $symb and $title for dynamic metadata
9741: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 9742: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 9743: # Cache this title and then return it
1.599 albertel 9744: return &do_cache_new('title',$key,$title,600);
1.534 albertel 9745: }
9746: $urlsymb=$url;
9747: }
9748: my $title=&metadata($urlsymb,'title');
9749: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
9750: return $title;
1.301 www 9751: }
1.613 albertel 9752:
1.614 albertel 9753: sub get_slot {
9754: my ($which,$cnum,$cdom)=@_;
9755: if (!$cnum || !$cdom) {
1.790 albertel 9756: (undef,my $courseid)=&whichuser();
1.620 albertel 9757: $cdom=$env{'course.'.$courseid.'.domain'};
9758: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 9759: }
1.703 albertel 9760: my $key=join("\0",'slots',$cdom,$cnum,$which);
9761: my %slotinfo;
9762: if (exists($remembered{$key})) {
9763: $slotinfo{$which} = $remembered{$key};
9764: } else {
9765: %slotinfo=&get('slots',[$which],$cdom,$cnum);
9766: &Apache::lonhomework::showhash(%slotinfo);
9767: my ($tmp)=keys(%slotinfo);
9768: if ($tmp=~/^error:/) { return (); }
9769: $remembered{$key} = $slotinfo{$which};
9770: }
1.616 albertel 9771: if (ref($slotinfo{$which}) eq 'HASH') {
9772: return %{$slotinfo{$which}};
9773: }
9774: return $slotinfo{$which};
1.614 albertel 9775: }
1.1150 raeburn 9776:
9777: sub get_reservable_slots {
9778: my ($cnum,$cdom,$uname,$udom) = @_;
9779: my $now = time;
9780: my $reservable_info;
9781: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
9782: if (exists($remembered{$key})) {
9783: $reservable_info = $remembered{$key};
9784: } else {
9785: my %resv;
9786: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
9787: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
9788: $reservable_info = \%resv;
9789: $remembered{$key} = $reservable_info;
9790: }
9791: return $reservable_info;
9792: }
9793:
9794: sub get_course_slots {
9795: my ($cnum,$cdom) = @_;
9796: my $hashid=$cnum.':'.$cdom;
9797: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
9798: if (defined($cached)) {
9799: if (ref($result) eq 'HASH') {
9800: return %{$result};
9801: }
9802: } else {
9803: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
9804: my ($tmp) = keys(%slots);
9805: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9806: &Apache::lonnet::do_cache_new('allslots',$hashid,\%slots,600);
9807: return %slots;
9808: }
9809: }
9810: return;
9811: }
9812:
9813: sub devalidate_slots_cache {
9814: my ($cnum,$cdom)=@_;
9815: my $hashid=$cnum.':'.$cdom;
9816: &devalidate_cache_new('allslots',$hashid);
9817: }
9818:
1.31 www 9819: # ------------------------------------------------- Update symbolic store links
9820:
9821: sub symblist {
9822: my ($mapname,%newhash)=@_;
1.438 www 9823: $mapname=&deversion(&declutter($mapname));
1.31 www 9824: my %hash;
1.620 albertel 9825: if (($env{'request.course.fn'}) && (%newhash)) {
9826: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 9827: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 9828: foreach my $url (keys(%newhash)) {
1.711 albertel 9829: next if ($url eq 'last_known'
9830: && $env{'form.no_update_last_known'});
9831: $hash{declutter($url)}=&encode_symb($mapname,
9832: $newhash{$url}->[1],
9833: $newhash{$url}->[0]);
1.191 harris41 9834: }
1.31 www 9835: if (untie(%hash)) {
9836: return 'ok';
9837: }
9838: }
9839: }
9840: return 'error';
1.212 www 9841: }
9842:
9843: # --------------------------------------------------------------- Verify a symb
9844:
9845: sub symbverify {
1.510 www 9846: my ($symb,$thisurl)=@_;
9847: my $thisfn=$thisurl;
1.439 www 9848: $thisfn=&declutter($thisfn);
1.215 www 9849: # direct jump to resource in page or to a sequence - will construct own symbs
9850: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
9851: # check URL part
1.409 www 9852: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 9853:
1.431 www 9854: unless ($url eq $thisfn) { return 0; }
1.213 www 9855:
1.216 www 9856: $symb=&symbclean($symb);
1.510 www 9857: $thisurl=&deversion($thisurl);
1.439 www 9858: $thisfn=&deversion($thisfn);
1.213 www 9859:
9860: my %bighash;
9861: my $okay=0;
1.431 www 9862:
1.620 albertel 9863: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 9864: &GDBM_READER(),0640)) {
1.1032 raeburn 9865: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
9866: $thisurl =~ s/\?.+$//;
9867: }
1.510 www 9868: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1102 raeburn 9869: unless ($ids) {
9870: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
9871: $ids=$bighash{$idkey};
1.216 www 9872: }
9873: if ($ids) {
9874: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 9875: foreach my $id (split(/\,/,$ids)) {
9876: my ($mapid,$resid)=split(/\./,$id);
1.1032 raeburn 9877: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
9878: $symb =~ s/\?.+$//;
9879: }
1.216 www 9880: if (
9881: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
9882: eq $symb) {
1.620 albertel 9883: if (($env{'request.role.adv'}) ||
1.1101 raeburn 9884: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
9885: ($thisurl eq '/adm/navmaps')) {
1.582 albertel 9886: $okay=1;
9887: }
9888: }
1.216 www 9889: }
9890: }
1.213 www 9891: untie(%bighash);
9892: }
9893: return $okay;
1.31 www 9894: }
9895:
1.210 www 9896: # --------------------------------------------------------------- Clean-up symb
9897:
9898: sub symbclean {
9899: my $symb=shift;
1.568 albertel 9900: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 9901: # remove version from map
9902: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 9903:
1.210 www 9904: # remove version from URL
9905: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 9906:
1.507 www 9907: # remove wrapper
9908:
1.510 www 9909: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 9910: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 9911: return $symb;
1.409 www 9912: }
9913:
9914: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 9915:
9916: sub encode_symb {
9917: my ($map,$resid,$url)=@_;
9918: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
9919: }
1.409 www 9920:
9921: sub decode_symb {
1.568 albertel 9922: my $symb=shift;
9923: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
9924: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 9925: return (&fixversion($map),$resid,&fixversion($url));
9926: }
9927:
9928: sub fixversion {
9929: my $fn=shift;
1.609 banghart 9930: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 9931: my %bighash;
9932: my $uri=&clutter($fn);
1.620 albertel 9933: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 9934: # is this cached?
1.599 albertel 9935: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 9936: if (defined($cached)) { return $result; }
9937: # unfortunately not cached, or expired
1.620 albertel 9938: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 9939: &GDBM_READER(),0640)) {
9940: if ($bighash{'version_'.$uri}) {
9941: my $version=$bighash{'version_'.$uri};
1.444 www 9942: unless (($version eq 'mostrecent') ||
9943: ($version==&getversion($uri))) {
1.440 www 9944: $uri=~s/\.(\w+)$/\.$version\.$1/;
9945: }
9946: }
9947: untie %bighash;
1.413 www 9948: }
1.599 albertel 9949: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 9950: }
9951:
9952: sub deversion {
9953: my $url=shift;
9954: $url=~s/\.\d+\.(\w+)$/\.$1/;
9955: return $url;
1.210 www 9956: }
9957:
1.31 www 9958: # ------------------------------------------------------ Return symb list entry
9959:
9960: sub symbread {
1.249 www 9961: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 9962: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 9963: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 9964: # no filename provided? try from environment
1.44 www 9965: unless ($thisfn) {
1.620 albertel 9966: if ($env{'request.symb'}) {
9967: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 9968: }
1.620 albertel 9969: $thisfn=$env{'request.filename'};
1.44 www 9970: }
1.569 albertel 9971: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 9972: # is that filename actually a symb? Verify, clean, and return
9973: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 9974: if (&symbverify($thisfn,$1)) {
1.620 albertel 9975: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 9976: }
1.242 www 9977: }
1.44 www 9978: $thisfn=declutter($thisfn);
1.31 www 9979: my %hash;
1.37 www 9980: my %bighash;
9981: my $syval='';
1.620 albertel 9982: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 9983: my $targetfn = $thisfn;
1.609 banghart 9984: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 9985: $targetfn = 'adm/wrapper/'.$thisfn;
9986: }
1.687 albertel 9987: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
9988: $targetfn=$1;
9989: }
1.620 albertel 9990: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 9991: &GDBM_READER(),0640)) {
1.481 raeburn 9992: $syval=$hash{$targetfn};
1.37 www 9993: untie(%hash);
9994: }
9995: # ---------------------------------------------------------- There was an entry
9996: if ($syval) {
1.601 albertel 9997: #unless ($syval=~/\_\d+$/) {
1.620 albertel 9998: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 9999: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 10000: #return $env{$cache_str}='';
1.601 albertel 10001: #}
10002: #$syval.=$1;
10003: #}
1.37 www 10004: } else {
10005: # ------------------------------------------------------- Was not in symb table
1.620 albertel 10006: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 10007: &GDBM_READER(),0640)) {
1.37 www 10008: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 10009: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 10010: unless ($ids) {
10011: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 10012: }
10013: unless ($ids) {
10014: # alias?
10015: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 10016: }
1.37 www 10017: if ($ids) {
10018: # ------------------------------------------------------------------- Has ID(s)
10019: my @possibilities=split(/\,/,$ids);
1.39 www 10020: if ($#possibilities==0) {
10021: # ----------------------------------------------- There is only one possibility
1.37 www 10022: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 10023: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10024: $resid,$thisfn);
1.249 www 10025: } elsif (!$donotrecurse) {
1.39 www 10026: # ------------------------------------------ There is more than one possibility
10027: my $realpossible=0;
1.800 albertel 10028: foreach my $id (@possibilities) {
10029: my $file=$bighash{'src_'.$id};
1.39 www 10030: if (&allowed('bre',$file)) {
1.800 albertel 10031: my ($mapid,$resid)=split(/\./,$id);
1.39 www 10032: if ($bighash{'map_type_'.$mapid} ne 'page') {
10033: $realpossible++;
1.626 albertel 10034: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10035: $resid,$thisfn);
1.39 www 10036: }
10037: }
1.191 harris41 10038: }
1.39 www 10039: if ($realpossible!=1) { $syval=''; }
1.249 www 10040: } else {
10041: $syval='';
1.37 www 10042: }
10043: }
10044: untie(%bighash)
1.481 raeburn 10045: }
1.31 www 10046: }
1.62 www 10047: if ($syval) {
1.620 albertel 10048: return $env{$cache_str}=$syval;
1.62 www 10049: }
1.31 www 10050: }
1.949 raeburn 10051: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 10052: return $env{$cache_str}='';
1.31 www 10053: }
10054:
10055: # ---------------------------------------------------------- Return random seed
10056:
1.32 www 10057: sub numval {
10058: my $txt=shift;
10059: $txt=~tr/A-J/0-9/;
10060: $txt=~tr/a-j/0-9/;
10061: $txt=~tr/K-T/0-9/;
10062: $txt=~tr/k-t/0-9/;
10063: $txt=~tr/U-Z/0-5/;
10064: $txt=~tr/u-z/0-5/;
10065: $txt=~s/\D//g;
1.564 albertel 10066: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 10067: return int($txt);
1.368 albertel 10068: }
10069:
1.484 albertel 10070: sub numval2 {
10071: my $txt=shift;
10072: $txt=~tr/A-J/0-9/;
10073: $txt=~tr/a-j/0-9/;
10074: $txt=~tr/K-T/0-9/;
10075: $txt=~tr/k-t/0-9/;
10076: $txt=~tr/U-Z/0-5/;
10077: $txt=~tr/u-z/0-5/;
10078: $txt=~s/\D//g;
10079: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10080: my $total;
10081: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 10082: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 10083: return int($total);
10084: }
10085:
1.575 albertel 10086: sub numval3 {
10087: use integer;
10088: my $txt=shift;
10089: $txt=~tr/A-J/0-9/;
10090: $txt=~tr/a-j/0-9/;
10091: $txt=~tr/K-T/0-9/;
10092: $txt=~tr/k-t/0-9/;
10093: $txt=~tr/U-Z/0-5/;
10094: $txt=~tr/u-z/0-5/;
10095: $txt=~s/\D//g;
10096: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10097: my $total;
10098: foreach my $val (@txts) { $total+=$val; }
10099: if ($_64bit) { $total=(($total<<32)>>32); }
10100: return $total;
10101: }
10102:
1.675 albertel 10103: sub digest {
10104: my ($data)=@_;
10105: my $digest=&Digest::MD5::md5($data);
10106: my ($a,$b,$c,$d)=unpack("iiii",$digest);
10107: my ($e,$f);
10108: {
10109: use integer;
10110: $e=($a+$b);
10111: $f=($c+$d);
10112: if ($_64bit) {
10113: $e=(($e<<32)>>32);
10114: $f=(($f<<32)>>32);
10115: }
10116: }
10117: if (wantarray) {
10118: return ($e,$f);
10119: } else {
10120: my $g;
10121: {
10122: use integer;
10123: $g=($e+$f);
10124: if ($_64bit) {
10125: $g=(($g<<32)>>32);
10126: }
10127: }
10128: return $g;
10129: }
10130: }
10131:
1.368 albertel 10132: sub latest_rnd_algorithm_id {
1.675 albertel 10133: return '64bit5';
1.366 albertel 10134: }
1.32 www 10135:
1.503 albertel 10136: sub get_rand_alg {
10137: my ($courseid)=@_;
1.790 albertel 10138: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 10139: if ($courseid) {
1.620 albertel 10140: return $env{"course.$courseid.rndseed"};
1.503 albertel 10141: }
10142: return &latest_rnd_algorithm_id();
10143: }
10144:
1.562 albertel 10145: sub validCODE {
10146: my ($CODE)=@_;
10147: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
10148: return 0;
10149: }
10150:
1.491 albertel 10151: sub getCODE {
1.620 albertel 10152: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 10153: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
10154: defined($Apache::lonhomework::parsing_a_task) ) &&
10155: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 10156: return $Apache::lonhomework::history{'resource.CODE'};
10157: }
10158: return undef;
10159: }
1.1133 foxr 10160: #
10161: # Determines the random seed for a specific context:
10162: #
10163: # parameters:
10164: # symb - in course context the symb for the seed.
10165: # course_id - The course id of the form domain_coursenum.
10166: # domain - Domain for the user.
10167: # course - Course for the user.
10168: # cenv - environment of the course.
10169: #
10170: # NOTE:
10171: # All parameters are picked out of the environment if missing
10172: # or not defined.
10173: # If a symb cannot be determined the current time is used instead.
10174: #
10175: # For a given well defined symb, courside, domain, username,
10176: # and course environment, the seed is reproducible.
10177: #
1.31 www 10178: sub rndseed {
1.1133 foxr 10179: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 10180: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 10181: if (!defined($symb)) {
1.366 albertel 10182: unless ($symb=$wsymb) { return time; }
10183: }
1.1146 foxr 10184: if (!defined $courseid) {
10185: $courseid=$wcourseid;
10186: }
10187: if (!defined $domain) { $domain=$wdomain; }
10188: if (!defined $username) { $username=$wusername }
1.1133 foxr 10189:
10190: my $which;
10191: if (defined($cenv->{'rndseed'})) {
10192: $which = $cenv->{'rndseed'};
10193: } else {
10194: $which =&get_rand_alg($courseid);
10195: }
1.491 albertel 10196: if (defined(&getCODE())) {
1.1133 foxr 10197:
1.675 albertel 10198: if ($which eq '64bit5') {
10199: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
10200: } elsif ($which eq '64bit4') {
1.575 albertel 10201: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
10202: } else {
10203: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
10204: }
1.675 albertel 10205: } elsif ($which eq '64bit5') {
10206: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 10207: } elsif ($which eq '64bit4') {
10208: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 10209: } elsif ($which eq '64bit3') {
10210: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 10211: } elsif ($which eq '64bit2') {
10212: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 10213: } elsif ($which eq '64bit') {
10214: return &rndseed_64bit($symb,$courseid,$domain,$username);
10215: }
10216: return &rndseed_32bit($symb,$courseid,$domain,$username);
10217: }
10218:
10219: sub rndseed_32bit {
10220: my ($symb,$courseid,$domain,$username)=@_;
10221: {
10222: use integer;
10223: my $symbchck=unpack("%32C*",$symb) << 27;
10224: my $symbseed=numval($symb) << 22;
10225: my $namechck=unpack("%32C*",$username) << 17;
10226: my $nameseed=numval($username) << 12;
10227: my $domainseed=unpack("%32C*",$domain) << 7;
10228: my $courseseed=unpack("%32C*",$courseid);
10229: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 10230: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10231: #&logthis("rndseed :$num:$symb");
1.564 albertel 10232: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 10233: return $num;
10234: }
10235: }
10236:
10237: sub rndseed_64bit {
10238: my ($symb,$courseid,$domain,$username)=@_;
10239: {
10240: use integer;
10241: my $symbchck=unpack("%32S*",$symb) << 21;
10242: my $symbseed=numval($symb) << 10;
10243: my $namechck=unpack("%32S*",$username);
10244:
10245: my $nameseed=numval($username) << 21;
10246: my $domainseed=unpack("%32S*",$domain) << 10;
10247: my $courseseed=unpack("%32S*",$courseid);
10248:
10249: my $num1=$symbchck+$symbseed+$namechck;
10250: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 10251: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10252: #&logthis("rndseed :$num:$symb");
1.564 albertel 10253: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 10254: return "$num1,$num2";
1.155 albertel 10255: }
1.366 albertel 10256: }
10257:
1.443 albertel 10258: sub rndseed_64bit2 {
10259: my ($symb,$courseid,$domain,$username)=@_;
10260: {
10261: use integer;
10262: # strings need to be an even # of cahracters long, it it is odd the
10263: # last characters gets thrown away
10264: my $symbchck=unpack("%32S*",$symb.' ') << 21;
10265: my $symbseed=numval($symb) << 10;
10266: my $namechck=unpack("%32S*",$username.' ');
10267:
10268: my $nameseed=numval($username) << 21;
1.501 albertel 10269: my $domainseed=unpack("%32S*",$domain.' ') << 10;
10270: my $courseseed=unpack("%32S*",$courseid.' ');
10271:
10272: my $num1=$symbchck+$symbseed+$namechck;
10273: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 10274: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10275: #&logthis("rndseed :$num:$symb");
1.803 albertel 10276: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 10277: return "$num1,$num2";
10278: }
10279: }
10280:
10281: sub rndseed_64bit3 {
10282: my ($symb,$courseid,$domain,$username)=@_;
10283: {
10284: use integer;
10285: # strings need to be an even # of cahracters long, it it is odd the
10286: # last characters gets thrown away
10287: my $symbchck=unpack("%32S*",$symb.' ') << 21;
10288: my $symbseed=numval2($symb) << 10;
10289: my $namechck=unpack("%32S*",$username.' ');
10290:
10291: my $nameseed=numval2($username) << 21;
1.443 albertel 10292: my $domainseed=unpack("%32S*",$domain.' ') << 10;
10293: my $courseseed=unpack("%32S*",$courseid.' ');
10294:
10295: my $num1=$symbchck+$symbseed+$namechck;
10296: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 10297: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10298: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 10299: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 10300:
1.503 albertel 10301: return "$num1:$num2";
1.443 albertel 10302: }
10303: }
10304:
1.575 albertel 10305: sub rndseed_64bit4 {
10306: my ($symb,$courseid,$domain,$username)=@_;
10307: {
10308: use integer;
10309: # strings need to be an even # of cahracters long, it it is odd the
10310: # last characters gets thrown away
10311: my $symbchck=unpack("%32S*",$symb.' ') << 21;
10312: my $symbseed=numval3($symb) << 10;
10313: my $namechck=unpack("%32S*",$username.' ');
10314:
10315: my $nameseed=numval3($username) << 21;
10316: my $domainseed=unpack("%32S*",$domain.' ') << 10;
10317: my $courseseed=unpack("%32S*",$courseid.' ');
10318:
10319: my $num1=$symbchck+$symbseed+$namechck;
10320: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 10321: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
10322: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 10323: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 10324:
1.575 albertel 10325: return "$num1:$num2";
10326: }
10327: }
10328:
1.675 albertel 10329: sub rndseed_64bit5 {
10330: my ($symb,$courseid,$domain,$username)=@_;
10331: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
10332: return "$num1:$num2";
10333: }
10334:
1.366 albertel 10335: sub rndseed_CODE_64bit {
10336: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 10337: {
1.366 albertel 10338: use integer;
1.443 albertel 10339: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 10340: my $symbseed=numval2($symb);
1.491 albertel 10341: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
10342: my $CODEseed=numval(&getCODE());
1.443 albertel 10343: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 10344: my $num1=$symbseed+$CODEchck;
10345: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 10346: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10347: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 10348: if ($_64bit) { $num1=(($num1<<32)>>32); }
10349: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 10350: return "$num1:$num2";
1.366 albertel 10351: }
10352: }
10353:
1.575 albertel 10354: sub rndseed_CODE_64bit4 {
10355: my ($symb,$courseid,$domain,$username)=@_;
10356: {
10357: use integer;
10358: my $symbchck=unpack("%32S*",$symb.' ') << 16;
10359: my $symbseed=numval3($symb);
10360: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
10361: my $CODEseed=numval3(&getCODE());
10362: my $courseseed=unpack("%32S*",$courseid.' ');
10363: my $num1=$symbseed+$CODEchck;
10364: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 10365: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
10366: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 10367: if ($_64bit) { $num1=(($num1<<32)>>32); }
10368: if ($_64bit) { $num2=(($num2<<32)>>32); }
10369: return "$num1:$num2";
10370: }
10371: }
10372:
1.675 albertel 10373: sub rndseed_CODE_64bit5 {
10374: my ($symb,$courseid,$domain,$username)=@_;
10375: my $code = &getCODE();
10376: my ($num1,$num2)=&digest("$symb,$courseid,$code");
10377: return "$num1:$num2";
10378: }
10379:
1.366 albertel 10380: sub setup_random_from_rndseed {
10381: my ($rndseed)=@_;
1.503 albertel 10382: if ($rndseed =~/([,:])/) {
10383: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 10384: &Math::Random::random_set_seed(abs($num1),abs($num2));
10385: } else {
10386: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 10387: }
1.36 albertel 10388: }
10389:
1.474 albertel 10390: sub latest_receipt_algorithm_id {
1.835 albertel 10391: return 'receipt3';
1.474 albertel 10392: }
10393:
1.480 www 10394: sub recunique {
10395: my $fucourseid=shift;
10396: my $unique;
1.835 albertel 10397: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
10398: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 10399: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 10400: } else {
10401: $unique=$perlvar{'lonReceipt'};
10402: }
10403: return unpack("%32C*",$unique);
10404: }
10405:
10406: sub recprefix {
10407: my $fucourseid=shift;
10408: my $prefix;
1.835 albertel 10409: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
10410: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 10411: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 10412: } else {
10413: $prefix=$perlvar{'lonHostID'};
10414: }
10415: return unpack("%32C*",$prefix);
10416: }
10417:
1.76 www 10418: sub ireceipt {
1.474 albertel 10419: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 10420:
10421: my $return =&recprefix($fucourseid).'-';
10422:
10423: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
10424: $env{'request.state'} eq 'construct') {
10425: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
10426: return $return;
10427: }
10428:
1.76 www 10429: my $cuname=unpack("%32C*",$funame);
10430: my $cudom=unpack("%32C*",$fudom);
10431: my $cucourseid=unpack("%32C*",$fucourseid);
10432: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 10433: my $cunique=&recunique($fucourseid);
1.474 albertel 10434: my $cpart=unpack("%32S*",$part);
1.835 albertel 10435: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
10436:
1.790 albertel 10437: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 10438:
10439: $return.= ($cunique%$cuname+
10440: $cunique%$cudom+
10441: $cusymb%$cuname+
10442: $cusymb%$cudom+
10443: $cucourseid%$cuname+
10444: $cucourseid%$cudom+
10445: $cpart%$cuname+
10446: $cpart%$cudom);
10447: } else {
10448: $return.= ($cunique%$cuname+
10449: $cunique%$cudom+
10450: $cusymb%$cuname+
10451: $cusymb%$cudom+
10452: $cucourseid%$cuname+
10453: $cucourseid%$cudom);
10454: }
10455: return $return;
1.76 www 10456: }
10457:
10458: sub receipt {
1.474 albertel 10459: my ($part)=@_;
1.790 albertel 10460: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 10461: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 10462: }
1.260 ng 10463:
1.790 albertel 10464: sub whichuser {
10465: my ($passedsymb)=@_;
10466: my ($symb,$courseid,$domain,$name,$publicuser);
10467: if (defined($env{'form.grade_symb'})) {
10468: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
10469: my $allowed=&allowed('vgr',$tmp_courseid);
10470: if (!$allowed &&
10471: exists($env{'request.course.sec'}) &&
10472: $env{'request.course.sec'} !~ /^\s*$/) {
10473: $allowed=&allowed('vgr',$tmp_courseid.
10474: '/'.$env{'request.course.sec'});
10475: }
10476: if ($allowed) {
10477: ($symb)=&get_env_multiple('form.grade_symb');
10478: $courseid=$tmp_courseid;
10479: ($domain)=&get_env_multiple('form.grade_domain');
10480: ($name)=&get_env_multiple('form.grade_username');
10481: return ($symb,$courseid,$domain,$name,$publicuser);
10482: }
10483: }
10484: if (!$passedsymb) {
10485: $symb=&symbread();
10486: } else {
10487: $symb=$passedsymb;
10488: }
10489: $courseid=$env{'request.course.id'};
10490: $domain=$env{'user.domain'};
10491: $name=$env{'user.name'};
10492: if ($name eq 'public' && $domain eq 'public') {
10493: if (!defined($env{'form.username'})) {
10494: $env{'form.username'}.=time.rand(10000000);
10495: }
10496: $name.=$env{'form.username'};
10497: }
10498: return ($symb,$courseid,$domain,$name,$publicuser);
10499:
10500: }
10501:
1.36 albertel 10502: # ------------------------------------------------------------ Serves up a file
1.472 albertel 10503: # returns either the contents of the file or
10504: # -1 if the file doesn't exist
1.481 raeburn 10505: #
10506: # if the target is a file that was uploaded via DOCS,
10507: # a check will be made to see if a current copy exists on the local server,
10508: # if it does this will be served, otherwise a copy will be retrieved from
10509: # the home server for the course and stored in /home/httpd/html/userfiles on
10510: # the local server.
1.472 albertel 10511:
1.36 albertel 10512: sub getfile {
1.538 albertel 10513: my ($file) = @_;
1.609 banghart 10514: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 10515: &repcopy($file);
10516: return &readfile($file);
10517: }
10518:
10519: sub repcopy_userfile {
10520: my ($file)=@_;
1.1142 raeburn 10521: my $londocroot = $perlvar{'lonDocRoot'};
10522: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 10523: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 10524: my ($cdom,$cnum,$filename) =
1.811 albertel 10525: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 10526: my $uri="/uploaded/$cdom/$cnum/$filename";
10527: if (-e "$file") {
1.828 www 10528: # we already have a local copy, check it out
1.538 albertel 10529: my @fileinfo = stat($file);
1.828 www 10530: my $rtncode;
10531: my $info;
1.538 albertel 10532: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 10533: if ($lwpresp ne 'ok') {
1.828 www 10534: # there is no such file anymore, even though we had a local copy
1.482 albertel 10535: if ($rtncode eq '404') {
1.538 albertel 10536: unlink($file);
1.482 albertel 10537: }
10538: return -1;
10539: }
10540: if ($info < $fileinfo[9]) {
1.828 www 10541: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 10542: return 'ok';
1.828 www 10543: } else {
10544: # the file is outdated, get rid of it
10545: unlink($file);
1.482 albertel 10546: }
1.828 www 10547: }
10548: # one way or the other, at this point, we don't have the file
10549: # construct the correct path for the file
10550: my @parts = ($cdom,$cnum);
10551: if ($filename =~ m|^(.+)/[^/]+$|) {
10552: push @parts, split(/\//,$1);
10553: }
10554: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
10555: foreach my $part (@parts) {
10556: $path .= '/'.$part;
10557: if (!-e $path) {
10558: mkdir($path,0770);
1.482 albertel 10559: }
10560: }
1.828 www 10561: # now the path exists for sure
10562: # get a user agent
10563: my $ua=new LWP::UserAgent;
10564: my $transferfile=$file.'.in.transfer';
10565: # FIXME: this should flock
10566: if (-e $transferfile) { return 'ok'; }
10567: my $request;
10568: $uri=~s/^\///;
1.980 raeburn 10569: my $homeserver = &homeserver($cnum,$cdom);
10570: my $protocol = $protocol{$homeserver};
10571: $protocol = 'http' if ($protocol ne 'https');
10572: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 10573: my $response=$ua->request($request,$transferfile);
10574: # did it work?
10575: if ($response->is_error()) {
10576: unlink($transferfile);
10577: &logthis("Userfile repcopy failed for $uri");
10578: return -1;
10579: }
10580: # worked, rename the transfer file
10581: rename($transferfile,$file);
1.607 raeburn 10582: return 'ok';
1.481 raeburn 10583: }
10584:
1.517 albertel 10585: sub tokenwrapper {
10586: my $uri=shift;
1.980 raeburn 10587: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 10588: $uri=~s|^/||;
1.620 albertel 10589: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 10590: my $token=$1;
1.552 albertel 10591: my (undef,$udom,$uname,$file)=split('/',$uri,4);
10592: if ($udom && $uname && $file) {
10593: $file=~s|(\?\.*)*$||;
1.949 raeburn 10594: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 10595: my $homeserver = &homeserver($uname,$udom);
10596: my $protocol = $protocol{$homeserver};
10597: $protocol = 'http' if ($protocol ne 'https');
10598: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 10599: (($uri=~/\?/)?'&':'?').'token='.$token.
10600: '&tokenissued='.$perlvar{'lonHostID'};
10601: } else {
10602: return '/adm/notfound.html';
10603: }
10604: }
10605:
1.828 www 10606: # call with reqtype HEAD: get last modification time
10607: # call with reqtype GET: get the file contents
10608: # Do not call this with reqtype GET for large files! It loads everything into memory
10609: #
1.481 raeburn 10610: sub getuploaded {
10611: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
10612: $uri=~s/^\///;
1.980 raeburn 10613: my $homeserver = &homeserver($cnum,$cdom);
10614: my $protocol = $protocol{$homeserver};
10615: $protocol = 'http' if ($protocol ne 'https');
10616: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 10617: my $ua=new LWP::UserAgent;
10618: my $request=new HTTP::Request($reqtype,$uri);
10619: my $response=$ua->request($request);
10620: $$rtncode = $response->code;
1.482 albertel 10621: if (! $response->is_success()) {
10622: return 'failed';
10623: }
10624: if ($reqtype eq 'HEAD') {
1.486 www 10625: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 10626: } elsif ($reqtype eq 'GET') {
10627: $$info = $response->content;
1.472 albertel 10628: }
1.482 albertel 10629: return 'ok';
1.36 albertel 10630: }
10631:
1.481 raeburn 10632: sub readfile {
10633: my $file = shift;
10634: if ( (! -e $file ) || ($file eq '') ) { return -1; };
10635: my $fh;
10636: open($fh,"<$file");
10637: my $a='';
1.800 albertel 10638: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 10639: return $a;
10640: }
10641:
1.36 albertel 10642: sub filelocation {
1.590 banghart 10643: my ($dir,$file) = @_;
10644: my $location;
10645: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 10646:
10647: if ($file =~ m-^/adm/-) {
10648: $file=~s-^/adm/wrapper/-/-;
10649: $file=~s-^/adm/coursedocs/showdoc/-/-;
10650: }
1.882 albertel 10651:
1.1139 www 10652: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 10653: $location = $file;
1.609 banghart 10654: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 10655: my ($udom,$uname,$filename)=
1.811 albertel 10656: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 10657: my $home=&homeserver($uname,$udom);
10658: my $is_me=0;
10659: my @ids=¤t_machine_ids();
10660: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
10661: if ($is_me) {
1.1117 foxr 10662: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 10663: } else {
10664: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
10665: $udom.'/'.$uname.'/'.$filename;
10666: }
1.882 albertel 10667: } elsif ($file =~ m-^/adm/-) {
10668: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 10669: } else {
10670: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 10671: $file=~s:^/(res|priv)/:/:;
10672: my $space=$1;
1.590 banghart 10673: if ( !( $file =~ m:^/:) ) {
10674: $location = $dir. '/'.$file;
10675: } else {
1.1142 raeburn 10676: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 10677: }
1.59 albertel 10678: }
1.590 banghart 10679: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 10680: while ($location=~m{/\.\./}) {
10681: if ($location =~ m{/[^/]+/\.\./}) {
10682: $location=~ s{/[^/]+/\.\./}{/}g;
10683: } else {
10684: $location=~ s{/\.\./}{/}g;
10685: }
10686: } #remove dir/..
1.590 banghart 10687: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
10688: return $location;
1.46 www 10689: }
1.36 albertel 10690:
1.46 www 10691: sub hreflocation {
10692: my ($dir,$file)=@_;
1.980 raeburn 10693: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 10694: $file=filelocation($dir,$file);
1.700 albertel 10695: } elsif ($file=~m-^/adm/-) {
10696: $file=~s-^/adm/wrapper/-/-;
10697: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 10698: }
10699: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
10700: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
10701: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 10702: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
10703: {/uploaded/$1/$2/}x;
1.46 www 10704: }
1.913 albertel 10705: if ($file=~ m{^/userfiles/}) {
10706: $file =~ s{^/userfiles/}{/uploaded/};
10707: }
1.462 albertel 10708: return $file;
1.465 albertel 10709: }
10710:
1.1139 www 10711:
10712:
10713:
10714:
1.465 albertel 10715: sub current_machine_domains {
1.853 albertel 10716: return &machine_domains(&hostname($perlvar{'lonHostID'}));
10717: }
10718:
10719: sub machine_domains {
10720: my ($hostname) = @_;
1.465 albertel 10721: my @domains;
1.838 albertel 10722: my %hostname = &all_hostnames();
1.465 albertel 10723: while( my($id, $name) = each(%hostname)) {
1.467 matthew 10724: # &logthis("-$id-$name-$hostname-");
1.465 albertel 10725: if ($hostname eq $name) {
1.844 albertel 10726: push(@domains,&host_domain($id));
1.465 albertel 10727: }
10728: }
10729: return @domains;
10730: }
10731:
10732: sub current_machine_ids {
1.853 albertel 10733: return &machine_ids(&hostname($perlvar{'lonHostID'}));
10734: }
10735:
10736: sub machine_ids {
10737: my ($hostname) = @_;
10738: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 10739: my @ids;
1.888 albertel 10740: my %name_to_host = &all_names();
1.889 albertel 10741: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
10742: return @{ $name_to_host{$hostname} };
10743: }
10744: return;
1.31 www 10745: }
10746:
1.824 raeburn 10747: sub additional_machine_domains {
10748: my @domains;
10749: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
10750: while( my $line = <$fh>) {
10751: $line =~ s/\s//g;
10752: push(@domains,$line);
10753: }
10754: return @domains;
10755: }
10756:
10757: sub default_login_domain {
10758: my $domain = $perlvar{'lonDefDomain'};
10759: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
10760: foreach my $posdom (¤t_machine_domains(),
10761: &additional_machine_domains()) {
10762: if (lc($posdom) eq lc($testdomain)) {
10763: $domain=$posdom;
10764: last;
10765: }
10766: }
10767: return $domain;
10768: }
10769:
1.31 www 10770: # ------------------------------------------------------------- Declutters URLs
10771:
10772: sub declutter {
10773: my $thisfn=shift;
1.569 albertel 10774: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 10775: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 10776: $thisfn=~s/^\///;
1.697 albertel 10777: $thisfn=~s|^adm/wrapper/||;
10778: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 10779: $thisfn=~s/^res\///;
1.1172 bisitz 10780: $thisfn=~s/^priv\///;
1.1032 raeburn 10781: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
10782: $thisfn=~s/\?.+$//;
10783: }
1.268 www 10784: return $thisfn;
10785: }
10786:
10787: # ------------------------------------------------------------- Clutter up URLs
10788:
10789: sub clutter {
10790: my $thisfn='/'.&declutter(shift);
1.887 albertel 10791: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 10792: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 10793: $thisfn='/res'.$thisfn;
10794: }
1.1031 raeburn 10795: if ($thisfn !~m|^/adm|) {
10796: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 10797: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 10798: } else {
10799: my ($ext) = ($thisfn =~ /\.(\w+)$/);
10800: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 10801: if ($embstyle eq 'ssi'
10802: || ($embstyle eq 'hdn')
10803: || ($embstyle eq 'rat')
10804: || ($embstyle eq 'prv')
10805: || ($embstyle eq 'ign')) {
10806: #do nothing with these
10807: } elsif (($embstyle eq 'img')
1.695 albertel 10808: || ($embstyle eq 'emb')
10809: || ($embstyle eq 'wrp')) {
10810: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 10811: } elsif ($embstyle eq 'unk'
10812: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 10813: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 10814: } else {
1.718 www 10815: # &logthis("Got a blank emb style");
1.695 albertel 10816: }
1.694 albertel 10817: }
10818: }
1.31 www 10819: return $thisfn;
1.12 www 10820: }
10821:
1.787 albertel 10822: sub clutter_with_no_wrapper {
10823: my $uri = &clutter(shift);
10824: if ($uri =~ m-^/adm/-) {
10825: $uri =~ s-^/adm/wrapper/-/-;
10826: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
10827: }
10828: return $uri;
10829: }
10830:
1.557 albertel 10831: sub freeze_escape {
10832: my ($value)=@_;
10833: if (ref($value)) {
10834: $value=&nfreeze($value);
10835: return '__FROZEN__'.&escape($value);
10836: }
10837: return &escape($value);
10838: }
10839:
1.11 www 10840:
1.557 albertel 10841: sub thaw_unescape {
10842: my ($value)=@_;
10843: if ($value =~ /^__FROZEN__/) {
10844: substr($value,0,10,undef);
10845: $value=&unescape($value);
10846: return &thaw($value);
10847: }
10848: return &unescape($value);
10849: }
10850:
1.436 albertel 10851: sub correct_line_ends {
10852: my ($result)=@_;
10853: $$result =~s/\r\n/\n/mg;
10854: $$result =~s/\r/\n/mg;
1.415 albertel 10855: }
1.1 albertel 10856: # ================================================================ Main Program
10857:
1.184 www 10858: sub goodbye {
1.204 albertel 10859: &logthis("Starting Shut down");
1.443 albertel 10860: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 10861: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 10862: #converted
1.599 albertel 10863: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 10864: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
10865: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
10866: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 10867: #1.1 only
1.870 albertel 10868: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
10869: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
10870: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
10871: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
10872: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 10873: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
10874: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 10875: &flushcourselogs();
10876: &logthis("Shutting down");
10877: }
10878:
1.852 albertel 10879: sub get_dns {
1.869 albertel 10880: my ($url,$func,$ignore_cache) = @_;
10881: if (!$ignore_cache) {
10882: my ($content,$cached)=
10883: &Apache::lonnet::is_cached_new('dns',$url);
10884: if ($cached) {
10885: &$func($content);
10886: return;
10887: }
10888: }
10889:
10890: my %alldns;
1.852 albertel 10891: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
10892: foreach my $dns (<$config>) {
10893: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 10894: my $line = $1;
10895: my ($host,$protocol) = split(/:/,$line);
10896: if ($protocol ne 'https') {
10897: $protocol = 'http';
10898: }
10899: $alldns{$host} = $protocol;
1.869 albertel 10900: }
10901: while (%alldns) {
10902: my ($dns) = keys(%alldns);
1.852 albertel 10903: my $ua=new LWP::UserAgent;
1.1134 raeburn 10904: $ua->timeout(30);
1.979 raeburn 10905: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 10906: my $response=$ua->request($request);
1.979 raeburn 10907: delete($alldns{$dns});
1.852 albertel 10908: next if ($response->is_error());
10909: my @content = split("\n",$response->content);
1.869 albertel 10910: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 10911: &$func(\@content);
1.869 albertel 10912: return;
1.852 albertel 10913: }
10914: close($config);
1.871 albertel 10915: my $which = (split('/',$url))[3];
10916: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
10917: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 10918: my @content = <$config>;
10919: &$func(\@content);
10920: return;
1.852 albertel 10921: }
1.327 albertel 10922: # ------------------------------------------------------------ Read domain file
10923: {
1.852 albertel 10924: my $loaded;
1.846 albertel 10925: my %domain;
10926:
1.852 albertel 10927: sub parse_domain_tab {
10928: my ($lines) = @_;
10929: foreach my $line (@$lines) {
10930: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 10931:
1.846 albertel 10932: chomp($line);
1.852 albertel 10933: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 10934: my %this_domain;
10935: foreach my $field ('description', 'auth_def', 'auth_arg_def',
10936: 'lang_def', 'city', 'longi', 'lati',
10937: 'primary') {
10938: $this_domain{$field} = shift(@elements);
10939: }
10940: $domain{$name} = \%this_domain;
1.852 albertel 10941: }
10942: }
1.864 albertel 10943:
10944: sub reset_domain_info {
10945: undef($loaded);
10946: undef(%domain);
10947: }
10948:
1.852 albertel 10949: sub load_domain_tab {
1.869 albertel 10950: my ($ignore_cache) = @_;
10951: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 10952: my $fh;
10953: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
10954: my @lines = <$fh>;
10955: &parse_domain_tab(\@lines);
1.448 albertel 10956: }
1.852 albertel 10957: close($fh);
10958: $loaded = 1;
1.327 albertel 10959: }
1.846 albertel 10960:
10961: sub domain {
1.852 albertel 10962: &load_domain_tab() if (!$loaded);
10963:
1.846 albertel 10964: my ($name,$what) = @_;
10965: return if ( !exists($domain{$name}) );
10966:
10967: if (!$what) {
10968: return $domain{$name}{'description'};
10969: }
10970: return $domain{$name}{$what};
10971: }
1.974 raeburn 10972:
10973: sub domain_info {
10974: &load_domain_tab() if (!$loaded);
10975: return %domain;
10976: }
10977:
1.327 albertel 10978: }
10979:
10980:
1.1 albertel 10981: # ------------------------------------------------------------- Read hosts file
10982: {
1.838 albertel 10983: my %hostname;
1.844 albertel 10984: my %hostdom;
1.845 albertel 10985: my %libserv;
1.852 albertel 10986: my $loaded;
1.888 albertel 10987: my %name_to_host;
1.1074 raeburn 10988: my %internetdom;
1.1107 raeburn 10989: my %LC_dns_serv;
1.852 albertel 10990:
10991: sub parse_hosts_tab {
10992: my ($file) = @_;
10993: foreach my $configline (@$file) {
10994: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 10995: chomp($configline);
10996: if ($configline =~ /^\^/) {
10997: if ($configline =~ /^\^([\w.\-]+)/) {
10998: $LC_dns_serv{$1} = 1;
10999: }
11000: next;
11001: }
1.1074 raeburn 11002: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 11003: $name=~s/\s//g;
11004: if ($id && $domain && $role && $name) {
11005: $hostname{$id}=$name;
1.888 albertel 11006: push(@{$name_to_host{$name}}, $id);
1.852 albertel 11007: $hostdom{$id}=$domain;
11008: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 11009: if (defined($protocol)) {
11010: if ($protocol eq 'https') {
11011: $protocol{$id} = $protocol;
11012: } else {
11013: $protocol{$id} = 'http';
11014: }
1.968 raeburn 11015: } else {
1.969 raeburn 11016: $protocol{$id} = 'http';
1.968 raeburn 11017: }
1.1074 raeburn 11018: if (defined($intdom)) {
11019: $internetdom{$id} = $intdom;
11020: }
1.852 albertel 11021: }
11022: }
11023: }
1.864 albertel 11024:
11025: sub reset_hosts_info {
1.897 albertel 11026: &purge_remembered();
1.864 albertel 11027: &reset_domain_info();
11028: &reset_hosts_ip_info();
1.892 albertel 11029: undef(%name_to_host);
1.864 albertel 11030: undef(%hostname);
11031: undef(%hostdom);
11032: undef(%libserv);
11033: undef($loaded);
11034: }
1.1 albertel 11035:
1.852 albertel 11036: sub load_hosts_tab {
1.869 albertel 11037: my ($ignore_cache) = @_;
11038: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 11039: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
11040: my @config = <$config>;
11041: &parse_hosts_tab(\@config);
11042: close($config);
11043: $loaded=1;
1.1 albertel 11044: }
1.852 albertel 11045:
1.838 albertel 11046: sub hostname {
1.852 albertel 11047: &load_hosts_tab() if (!$loaded);
11048:
1.838 albertel 11049: my ($lonid) = @_;
11050: return $hostname{$lonid};
11051: }
1.845 albertel 11052:
1.838 albertel 11053: sub all_hostnames {
1.852 albertel 11054: &load_hosts_tab() if (!$loaded);
11055:
1.838 albertel 11056: return %hostname;
11057: }
1.845 albertel 11058:
1.888 albertel 11059: sub all_names {
11060: &load_hosts_tab() if (!$loaded);
11061:
11062: return %name_to_host;
11063: }
11064:
1.974 raeburn 11065: sub all_host_domain {
11066: &load_hosts_tab() if (!$loaded);
11067: return %hostdom;
11068: }
11069:
1.845 albertel 11070: sub is_library {
1.852 albertel 11071: &load_hosts_tab() if (!$loaded);
11072:
1.845 albertel 11073: return exists($libserv{$_[0]});
11074: }
11075:
11076: sub all_library {
1.852 albertel 11077: &load_hosts_tab() if (!$loaded);
11078:
1.845 albertel 11079: return %libserv;
11080: }
11081:
1.1062 droeschl 11082: sub unique_library {
11083: #2x reverse removes all hostnames that appear more than once
11084: my %unique = reverse &all_library();
11085: return reverse %unique;
11086: }
11087:
1.841 albertel 11088: sub get_servers {
1.852 albertel 11089: &load_hosts_tab() if (!$loaded);
11090:
1.841 albertel 11091: my ($domain,$type) = @_;
11092: my %possible_hosts = ($type eq 'library') ? %libserv
11093: : %hostname;
11094: my %result;
1.842 albertel 11095: if (ref($domain) eq 'ARRAY') {
11096: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 11097: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 11098: $result{$host} = $hostname;
11099: }
11100: }
11101: } else {
11102: while ( my ($host,$hostname) = each(%possible_hosts)) {
11103: if ($hostdom{$host} eq $domain) {
11104: $result{$host} = $hostname;
11105: }
1.841 albertel 11106: }
11107: }
11108: return %result;
11109: }
1.845 albertel 11110:
1.1062 droeschl 11111: sub get_unique_servers {
11112: my %unique = reverse &get_servers(@_);
11113: return reverse %unique;
11114: }
11115:
1.844 albertel 11116: sub host_domain {
1.852 albertel 11117: &load_hosts_tab() if (!$loaded);
11118:
1.844 albertel 11119: my ($lonid) = @_;
11120: return $hostdom{$lonid};
11121: }
11122:
1.841 albertel 11123: sub all_domains {
1.852 albertel 11124: &load_hosts_tab() if (!$loaded);
11125:
1.841 albertel 11126: my %seen;
11127: my @uniq = grep(!$seen{$_}++, values(%hostdom));
11128: return @uniq;
11129: }
1.1074 raeburn 11130:
11131: sub internet_dom {
11132: &load_hosts_tab() if (!$loaded);
11133:
11134: my ($lonid) = @_;
11135: return $internetdom{$lonid};
11136: }
1.1107 raeburn 11137:
11138: sub is_LC_dns {
11139: &load_hosts_tab() if (!$loaded);
11140:
11141: my ($hostname) = @_;
11142: return exists($LC_dns_serv{$hostname});
11143: }
11144:
1.1 albertel 11145: }
11146:
1.847 albertel 11147: {
11148: my %iphost;
1.856 albertel 11149: my %name_to_ip;
11150: my %lonid_to_ip;
1.869 albertel 11151:
1.847 albertel 11152: sub get_hosts_from_ip {
11153: my ($ip) = @_;
11154: my %iphosts = &get_iphost();
11155: if (ref($iphosts{$ip})) {
11156: return @{$iphosts{$ip}};
11157: }
11158: return;
1.839 albertel 11159: }
1.864 albertel 11160:
11161: sub reset_hosts_ip_info {
11162: undef(%iphost);
11163: undef(%name_to_ip);
11164: undef(%lonid_to_ip);
11165: }
1.856 albertel 11166:
11167: sub get_host_ip {
11168: my ($lonid) = @_;
11169: if (exists($lonid_to_ip{$lonid})) {
11170: return $lonid_to_ip{$lonid};
11171: }
11172: my $name=&hostname($lonid);
11173: my $ip = gethostbyname($name);
11174: return if (!$ip || length($ip) ne 4);
11175: $ip=inet_ntoa($ip);
11176: $name_to_ip{$name} = $ip;
11177: $lonid_to_ip{$lonid} = $ip;
11178: return $ip;
11179: }
1.847 albertel 11180:
11181: sub get_iphost {
1.869 albertel 11182: my ($ignore_cache) = @_;
1.894 albertel 11183:
1.869 albertel 11184: if (!$ignore_cache) {
11185: if (%iphost) {
11186: return %iphost;
11187: }
11188: my ($ip_info,$cached)=
11189: &Apache::lonnet::is_cached_new('iphost','iphost');
11190: if ($cached) {
11191: %iphost = %{$ip_info->[0]};
11192: %name_to_ip = %{$ip_info->[1]};
11193: %lonid_to_ip = %{$ip_info->[2]};
11194: return %iphost;
11195: }
11196: }
1.894 albertel 11197:
11198: # get yesterday's info for fallback
11199: my %old_name_to_ip;
11200: my ($ip_info,$cached)=
11201: &Apache::lonnet::is_cached_new('iphost','iphost');
11202: if ($cached) {
11203: %old_name_to_ip = %{$ip_info->[1]};
11204: }
11205:
1.888 albertel 11206: my %name_to_host = &all_names();
11207: foreach my $name (keys(%name_to_host)) {
1.847 albertel 11208: my $ip;
11209: if (!exists($name_to_ip{$name})) {
11210: $ip = gethostbyname($name);
11211: if (!$ip || length($ip) ne 4) {
1.894 albertel 11212: if (defined($old_name_to_ip{$name})) {
11213: $ip = $old_name_to_ip{$name};
11214: &logthis("Can't find $name defaulting to old $ip");
11215: } else {
11216: &logthis("Name $name no IP found");
11217: next;
11218: }
11219: } else {
11220: $ip=inet_ntoa($ip);
1.847 albertel 11221: }
11222: $name_to_ip{$name} = $ip;
11223: } else {
11224: $ip = $name_to_ip{$name};
1.653 albertel 11225: }
1.888 albertel 11226: foreach my $id (@{ $name_to_host{$name} }) {
11227: $lonid_to_ip{$id} = $ip;
11228: }
11229: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 11230: }
1.869 albertel 11231: &Apache::lonnet::do_cache_new('iphost','iphost',
11232: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 11233: 48*60*60);
1.869 albertel 11234:
1.847 albertel 11235: return %iphost;
1.598 albertel 11236: }
11237:
1.992 raeburn 11238: #
11239: # Given a DNS returns the loncapa host name for that DNS
11240: #
11241: sub host_from_dns {
11242: my ($dns) = @_;
11243: my @hosts;
11244: my $ip;
11245:
1.993 raeburn 11246: if (exists($name_to_ip{$dns})) {
1.992 raeburn 11247: $ip = $name_to_ip{$dns};
11248: }
11249: if (!$ip) {
11250: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
11251: if (length($ip) == 4) {
11252: $ip = &IO::Socket::inet_ntoa($ip);
11253: }
11254: }
11255: if ($ip) {
11256: @hosts = get_hosts_from_ip($ip);
11257: return $hosts[0];
11258: }
11259: return undef;
1.986 foxr 11260: }
1.992 raeburn 11261:
1.1074 raeburn 11262: sub get_internet_names {
11263: my ($lonid) = @_;
11264: return if ($lonid eq '');
11265: my ($idnref,$cached)=
11266: &Apache::lonnet::is_cached_new('internetnames',$lonid);
11267: if ($cached) {
11268: return $idnref;
11269: }
11270: my $ip = &get_host_ip($lonid);
11271: my @hosts = &get_hosts_from_ip($ip);
11272: my %iphost = &get_iphost();
11273: my (@idns,%seen);
11274: foreach my $id (@hosts) {
11275: my $dom = &host_domain($id);
11276: my $prim_id = &domain($dom,'primary');
11277: my $prim_ip = &get_host_ip($prim_id);
11278: next if ($seen{$prim_ip});
11279: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
11280: foreach my $id (@{$iphost{$prim_ip}}) {
11281: my $intdom = &internet_dom($id);
11282: unless (grep(/^\Q$intdom\E$/,@idns)) {
11283: push(@idns,$intdom);
11284: }
11285: }
11286: }
11287: $seen{$prim_ip} = 1;
11288: }
11289: return &Apache::lonnet::do_cache_new('internetnames',$lonid,\@idns,12*60*60);
11290: }
11291:
1.986 foxr 11292: }
11293:
1.1079 raeburn 11294: sub all_loncaparevs {
11295: 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);
11296: }
11297:
1.862 albertel 11298: BEGIN {
11299:
11300: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
11301: unless ($readit) {
11302: {
11303: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
11304: %perlvar = (%perlvar,%{$configvars});
11305: }
11306:
11307:
1.1 albertel 11308: # ------------------------------------------------------ Read spare server file
11309: {
1.448 albertel 11310: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 11311:
11312: while (my $configline=<$config>) {
11313: chomp($configline);
1.284 matthew 11314: if ($configline) {
1.784 albertel 11315: my ($host,$type) = split(':',$configline,2);
1.785 albertel 11316: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 11317: push(@{ $spareid{$type} }, $host);
1.1 albertel 11318: }
11319: }
1.448 albertel 11320: close($config);
1.1 albertel 11321: }
1.11 www 11322: # ------------------------------------------------------------ Read permissions
11323: {
1.448 albertel 11324: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 11325:
11326: while (my $configline=<$config>) {
1.448 albertel 11327: chomp($configline);
11328: if ($configline) {
11329: my ($role,$perm)=split(/ /,$configline);
11330: if ($perm ne '') { $pr{$role}=$perm; }
11331: }
1.11 www 11332: }
1.448 albertel 11333: close($config);
1.11 www 11334: }
11335:
11336: # -------------------------------------------- Read plain texts for permissions
11337: {
1.448 albertel 11338: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 11339:
11340: while (my $configline=<$config>) {
1.448 albertel 11341: chomp($configline);
11342: if ($configline) {
1.742 raeburn 11343: my ($short,@plain)=split(/:/,$configline);
11344: %{$prp{$short}} = ();
11345: if (@plain > 0) {
11346: $prp{$short}{'std'} = $plain[0];
11347: for (my $i=1; $i<@plain; $i++) {
11348: $prp{$short}{'alt'.$i} = $plain[$i];
11349: }
11350: }
1.448 albertel 11351: }
1.135 www 11352: }
1.448 albertel 11353: close($config);
1.135 www 11354: }
11355:
11356: # ---------------------------------------------------------- Read package table
11357: {
1.448 albertel 11358: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 11359:
11360: while (my $configline=<$config>) {
1.483 albertel 11361: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 11362: chomp($configline);
11363: my ($short,$plain)=split(/:/,$configline);
11364: my ($pack,$name)=split(/\&/,$short);
11365: if ($plain ne '') {
11366: $packagetab{$pack.'&'.$name.'&name'}=$name;
11367: $packagetab{$short}=$plain;
11368: }
1.11 www 11369: }
1.448 albertel 11370: close($config);
1.329 matthew 11371: }
11372:
1.1073 raeburn 11373: # ---------------------------------------------------------- Read loncaparev table
11374: {
11375: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
11376: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
11377: while (my $configline=<$config>) {
11378: chomp($configline);
11379: my ($hostid,$loncaparev)=split(/:/,$configline);
11380: $loncaparevs{$hostid}=$loncaparev;
11381: }
11382: close($config);
11383: }
11384: }
11385: }
11386:
1.1074 raeburn 11387: # ---------------------------------------------------------- Read serverhostID table
11388: {
11389: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
11390: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
11391: while (my $configline=<$config>) {
11392: chomp($configline);
11393: my ($name,$id)=split(/:/,$configline);
11394: $serverhomeIDs{$name}=$id;
11395: }
11396: close($config);
11397: }
11398: }
11399: }
11400:
1.1079 raeburn 11401: {
11402: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
11403: if (-e $file) {
11404: my $parser = HTML::LCParser->new($file);
11405: while (my $token = $parser->get_token()) {
11406: if ($token->[0] eq 'S') {
11407: my $item = $token->[1];
11408: my $name = $token->[2]{'name'};
11409: my $value = $token->[2]{'value'};
11410: if ($item ne '' && $name ne '' && $value ne '') {
11411: my $release = $parser->get_text();
11412: $release =~ s/(^\s*|\s*$ )//gx;
11413: $needsrelease{$item.':'.$name.':'.$value} = $release;
11414: }
11415: }
11416: }
11417: }
1.1073 raeburn 11418: }
11419:
1.1138 raeburn 11420: # ---------------------------------------------------------- Read managers table
11421: {
11422: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
11423: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
11424: while (my $configline=<$config>) {
11425: chomp($configline);
11426: next if ($configline =~ /^\#/);
11427: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
11428: $managerstab{$configline} = 1;
11429: }
11430: }
11431: close($config);
11432: }
11433: }
11434: }
11435:
1.329 matthew 11436: # ------------- set up temporary directory
11437: {
1.1117 foxr 11438: $tmpdir = LONCAPA::tempdir();
1.329 matthew 11439:
1.11 www 11440: }
11441:
1.794 albertel 11442: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
11443: 'compress_threshold'=> 20_000,
11444: });
1.185 www 11445:
1.281 www 11446: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 11447: $dumpcount=0;
1.958 www 11448: $locknum=0;
1.22 www 11449:
1.163 harris41 11450: &logtouch();
1.672 albertel 11451: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 11452: $readit=1;
1.564 albertel 11453: {
11454: use integer;
11455: my $test=(2**32)+1;
1.568 albertel 11456: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 11457: &logthis(" Detected 64bit platform ($_64bit)");
11458: }
1.195 www 11459: }
1.1 albertel 11460: }
1.179 www 11461:
1.1 albertel 11462: 1;
1.191 harris41 11463: __END__
11464:
1.243 albertel 11465: =pod
11466:
1.191 harris41 11467: =head1 NAME
11468:
1.243 albertel 11469: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 11470:
11471: =head1 SYNOPSIS
11472:
1.243 albertel 11473: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 11474:
11475: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
11476:
1.243 albertel 11477: Common parameters:
11478:
11479: =over 4
11480:
11481: =item *
11482:
11483: $uname : an internal username (if $cname expecting a course Id specifically)
11484:
11485: =item *
11486:
11487: $udom : a domain (if $cdom expecting a course's domain specifically)
11488:
11489: =item *
11490:
11491: $symb : a resource instance identifier
11492:
11493: =item *
11494:
11495: $namespace : the name of a .db file that contains the data needed or
11496: being set.
11497:
11498: =back
11499:
1.394 bowersj2 11500: =head1 OVERVIEW
1.191 harris41 11501:
1.394 bowersj2 11502: lonnet provides subroutines which interact with the
11503: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
11504: about classes, users, and resources.
1.243 albertel 11505:
11506: For many of these objects you can also use this to store data about
11507: them or modify them in various ways.
1.191 harris41 11508:
1.394 bowersj2 11509: =head2 Symbs
1.191 harris41 11510:
1.394 bowersj2 11511: To identify a specific instance of a resource, LON-CAPA uses symbols
11512: or "symbs"X<symb>. These identifiers are built from the URL of the
11513: map, the resource number of the resource in the map, and the URL of
11514: the resource itself. The latter is somewhat redundant, but might help
11515: if maps change.
11516:
11517: An example is
11518:
11519: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
11520:
11521: The respective map entry is
11522:
11523: <resource id="19" src="/res/msu/korte/tests/part12.problem"
11524: title="Problem 2">
11525: </resource>
11526:
11527: Symbs are used by the random number generator, as well as to store and
11528: restore data specific to a certain instance of for example a problem.
11529:
11530: =head2 Storing And Retrieving Data
11531:
11532: X<store()>X<cstore()>X<restore()>Three of the most important functions
11533: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
11534: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
11535: is is the non-critical message twin of cstore. These functions are for
11536: handlers to store a perl hash to a user's permanent data space in an
11537: easy manner, and to retrieve it again on another call. It is expected
11538: that a handler would use this once at the beginning to retrieve data,
11539: and then again once at the end to send only the new data back.
11540:
11541: The data is stored in the user's data directory on the user's
11542: homeserver under the ID of the course.
11543:
11544: The hash that is returned by restore will have all of the previous
11545: value for all of the elements of the hash.
11546:
11547: Example:
11548:
11549: #creating a hash
11550: my %hash;
11551: $hash{'foo'}='bar';
11552:
11553: #storing it
11554: &Apache::lonnet::cstore(\%hash);
11555:
11556: #changing a value
11557: $hash{'foo'}='notbar';
11558:
11559: #adding a new value
11560: $hash{'bar'}='foo';
11561: &Apache::lonnet::cstore(\%hash);
11562:
11563: #retrieving the hash
11564: my %history=&Apache::lonnet::restore();
11565:
11566: #print the hash
11567: foreach my $key (sort(keys(%history))) {
11568: print("\%history{$key} = $history{$key}");
11569: }
11570:
11571: Will print out:
1.191 harris41 11572:
1.394 bowersj2 11573: %history{1:foo} = bar
11574: %history{1:keys} = foo:timestamp
11575: %history{1:timestamp} = 990455579
11576: %history{2:bar} = foo
11577: %history{2:foo} = notbar
11578: %history{2:keys} = foo:bar:timestamp
11579: %history{2:timestamp} = 990455580
11580: %history{bar} = foo
11581: %history{foo} = notbar
11582: %history{timestamp} = 990455580
11583: %history{version} = 2
11584:
11585: Note that the special hash entries C<keys>, C<version> and
11586: C<timestamp> were added to the hash. C<version> will be equal to the
11587: total number of versions of the data that have been stored. The
11588: C<timestamp> attribute will be the UNIX time the hash was
11589: stored. C<keys> is available in every historical section to list which
11590: keys were added or changed at a specific historical revision of a
11591: hash.
11592:
11593: B<Warning>: do not store the hash that restore returns directly. This
11594: will cause a mess since it will restore the historical keys as if the
11595: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 11596:
1.394 bowersj2 11597: Calling convention:
1.191 harris41 11598:
1.394 bowersj2 11599: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
11600: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 11601:
1.394 bowersj2 11602: For more detailed information, see lonnet specific documentation.
1.191 harris41 11603:
1.394 bowersj2 11604: =head1 RETURN MESSAGES
1.191 harris41 11605:
1.394 bowersj2 11606: =over 4
1.191 harris41 11607:
1.394 bowersj2 11608: =item * B<con_lost>: unable to contact remote host
1.191 harris41 11609:
1.394 bowersj2 11610: =item * B<con_delayed>: unable to contact remote host, message will be delivered
11611: when the connection is brought back up
1.191 harris41 11612:
1.394 bowersj2 11613: =item * B<con_failed>: unable to contact remote host and unable to save message
11614: for later delivery
1.191 harris41 11615:
1.967 bisitz 11616: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 11617:
1.394 bowersj2 11618: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 11619: that was requested
1.191 harris41 11620:
1.243 albertel 11621: =back
1.191 harris41 11622:
1.243 albertel 11623: =head1 PUBLIC SUBROUTINES
1.191 harris41 11624:
1.243 albertel 11625: =head2 Session Environment Functions
1.191 harris41 11626:
1.243 albertel 11627: =over 4
1.191 harris41 11628:
1.394 bowersj2 11629: =item *
11630: X<appenv()>
1.949 raeburn 11631: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 11632: the user envirnoment file, and will be restored for each access this
1.620 albertel 11633: user makes during this session, also modifies the %env for the current
1.949 raeburn 11634: process. Optional rolesarrayref - if defined contains a reference to an array
11635: of roles which are exempt from the restriction on modifying user.role entries
11636: in the user's environment.db and in %env.
1.191 harris41 11637:
11638: =item *
1.394 bowersj2 11639: X<delenv()>
1.987 raeburn 11640: B<delenv($delthis,$regexp)>: removes all items from the session
11641: environment file that begin with $delthis. If the
11642: optional second arg - $regexp - is true, $delthis is treated as a
11643: regular expression, otherwise \Q$delthis\E is used.
11644: The values are also deleted from the current processes %env.
1.191 harris41 11645:
1.795 albertel 11646: =item * get_env_multiple($name)
11647:
11648: gets $name from the %env hash, it seemlessly handles the cases where multiple
11649: values may be defined and end up as an array ref.
11650:
11651: returns an array of values
11652:
1.243 albertel 11653: =back
11654:
11655: =head2 User Information
1.191 harris41 11656:
1.243 albertel 11657: =over 4
1.191 harris41 11658:
11659: =item *
1.394 bowersj2 11660: X<queryauthenticate()>
11661: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 11662: authentication scheme
11663:
11664: =item *
1.394 bowersj2 11665: X<authenticate()>
1.1073 raeburn 11666: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 11667: authenticate user from domain's lib servers (first use the current
11668: one). C<$upass> should be the users password.
1.1073 raeburn 11669: $checkdefauth is optional (value is 1 if a check should be made to
11670: authenticate user using default authentication method, and allow
11671: account creation if username does not have account in the domain).
11672: $clientcancheckhost is optional (value is 1 if checking whether the
11673: server can host will occur on the client side in lonauth.pm).
1.191 harris41 11674:
11675: =item *
1.394 bowersj2 11676: X<homeserver()>
11677: B<homeserver($uname,$udom)>: find the server which has
11678: the user's directory and files (there must be only one), this caches
11679: the answer, and also caches if there is a borken connection.
1.191 harris41 11680:
11681: =item *
1.394 bowersj2 11682: X<idget()>
11683: B<idget($udom,@ids)>: find the usernames behind a list of IDs
11684: (IDs are a unique resource in a domain, there must be only 1 ID per
11685: username, and only 1 username per ID in a specific domain) (returns
11686: hash: id=>name,id=>name)
1.191 harris41 11687:
11688: =item *
1.394 bowersj2 11689: X<idrget()>
11690: B<idrget($udom,@unames)>: find the IDs behind a list of
11691: usernames (returns hash: name=>id,name=>id)
1.191 harris41 11692:
11693: =item *
1.394 bowersj2 11694: X<idput()>
11695: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 11696:
11697: =item *
1.394 bowersj2 11698: X<rolesinit()>
1.1169 droeschl 11699: B<rolesinit($udom,$username)>: get user privileges.
11700: returns user role, first access and timer interval hashes
1.243 albertel 11701:
11702: =item *
1.1171 droeschl 11703: X<privileged()>
11704: B<privileged($username,$domain)>: returns a true if user has a
11705: privileged and active role (i.e. su or dc), false otherwise.
11706:
11707: =item *
1.551 albertel 11708: X<getsection()>
11709: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 11710: course $cname, return section name/number or '' for "not in course"
11711: and '-1' for "no section"
11712:
11713: =item *
1.394 bowersj2 11714: X<userenvironment()>
11715: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 11716: passed in @what from the requested user's environment, returns a hash
11717:
1.858 raeburn 11718: =item *
11719: X<userlog_query()>
1.859 albertel 11720: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
11721: activity.log file. %filters defines filters applied when parsing the
11722: log file. These can be start or end timestamps, or the type of action
11723: - log to look for Login or Logout events, check for Checkin or
11724: Checkout, role for role selection. The response is in the form
11725: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
11726: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 11727:
1.243 albertel 11728: =back
11729:
11730: =head2 User Roles
11731:
11732: =over 4
11733:
11734: =item *
11735:
1.810 raeburn 11736: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 11737: F: full access
11738: U,I,K: authentication modes (cxx only)
11739: '': forbidden
11740: 1: user needs to choose course
11741: 2: browse allowed
1.766 albertel 11742: A: passphrase authentication needed
1.243 albertel 11743:
11744: =item *
11745:
11746: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
11747: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
11748: and course level
11749:
11750: =item *
11751:
1.988 raeburn 11752: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
11753: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 11754: $type is Course (default) or Community.
1.988 raeburn 11755: If $forcedefault evaluates to true, text returned will be default
11756: text for $type. Otherwise, if this is a course, the text returned
11757: will be a custom name for the role (if defined in the course's
11758: environment). If no custom name is defined the default is returned.
11759:
1.832 raeburn 11760: =item *
11761:
1.935 raeburn 11762: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 11763: All arguments are optional. Returns a hash of a roles, either for
11764: co-author/assistant author roles for a user's Construction Space
1.906 albertel 11765: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 11766: In the hash, keys are set to colon-separated $uname,$udom,$role, and
11767: (optionally) if $withsec is true, a fourth colon-separated item - $section.
11768: For each key, value is set to colon-separated start and end times for
11769: the role. If no username and domain are specified, will default to
1.934 raeburn 11770: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 11771: of role statuses (active, future or previous), roles
11772: (e.g., cc,in, st etc.) and domains of the roles which can be used
11773: to restrict the list of roles reported. If no array ref is
11774: provided for types, will default to return only active roles.
1.834 albertel 11775:
1.243 albertel 11776: =back
11777:
11778: =head2 User Modification
11779:
11780: =over 4
11781:
11782: =item *
11783:
1.957 raeburn 11784: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 11785: user for the level given by URL. Optional start and end dates (leave empty
11786: string or zero for "no date")
1.191 harris41 11787:
11788: =item *
11789:
1.243 albertel 11790: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
11791: change a users, password, possible return values are: ok,
11792: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
11793: refused
1.191 harris41 11794:
11795: =item *
11796:
1.243 albertel 11797: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 11798:
11799: =item *
11800:
1.1058 raeburn 11801: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
11802: $forceid,$desiredhome,$email,$inststatus,$candelete) :
11803:
11804: will update user information (firstname,middlename,lastname,generation,
11805: permanentemail), and if forceid is true, student/employee ID also.
11806: A user's institutional affiliation(s) can also be updated.
11807: User information fields will not be overwritten with empty entries
11808: unless the field is included in the $candelete array reference.
11809: This array is included when a single user is modified via "Manage Users",
11810: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 11811:
11812: =item *
11813:
1.286 matthew 11814: modifystudent
11815:
1.957 raeburn 11816: modify a student's enrollment and identification information.
1.286 matthew 11817: The course id is resolved based on the current users environment.
11818: This means the envoking user must be a course coordinator or otherwise
11819: associated with a course.
11820:
1.297 matthew 11821: This call is essentially a wrapper for lonnet::modifyuser and
11822: lonnet::modify_student_enrollment
1.286 matthew 11823:
11824: Inputs:
11825:
11826: =over 4
11827:
1.957 raeburn 11828: =item B<$udom> Student's loncapa domain
1.286 matthew 11829:
1.957 raeburn 11830: =item B<$uname> Student's loncapa login name
1.286 matthew 11831:
1.964 bisitz 11832: =item B<$uid> Student/Employee ID
1.286 matthew 11833:
1.957 raeburn 11834: =item B<$umode> Student's authentication mode
1.286 matthew 11835:
1.957 raeburn 11836: =item B<$upass> Student's password
1.286 matthew 11837:
1.957 raeburn 11838: =item B<$first> Student's first name
1.286 matthew 11839:
1.957 raeburn 11840: =item B<$middle> Student's middle name
1.286 matthew 11841:
1.957 raeburn 11842: =item B<$last> Student's last name
1.286 matthew 11843:
1.957 raeburn 11844: =item B<$gene> Student's generation
1.286 matthew 11845:
1.957 raeburn 11846: =item B<$usec> Student's section in course
1.286 matthew 11847:
11848: =item B<$end> Unix time of the roles expiration
11849:
11850: =item B<$start> Unix time of the roles start date
11851:
11852: =item B<$forceid> If defined, allow $uid to be changed
11853:
11854: =item B<$desiredhome> server to use as home server for student
11855:
1.957 raeburn 11856: =item B<$email> Student's permanent e-mail address
11857:
11858: =item B<$type> Type of enrollment (auto or manual)
11859:
1.963 raeburn 11860: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
11861:
11862: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 11863:
1.963 raeburn 11864: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 11865:
1.963 raeburn 11866: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 11867:
1.963 raeburn 11868: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 11869:
1.286 matthew 11870: =back
1.297 matthew 11871:
11872: =item *
11873:
11874: modify_student_enrollment
11875:
11876: Change a students enrollment status in a class. The environment variable
11877: 'role.request.course' must be defined for this function to proceed.
11878:
11879: Inputs:
11880:
11881: =over 4
11882:
11883: =item $udom, students domain
11884:
11885: =item $uname, students name
11886:
11887: =item $uid, students user id
11888:
11889: =item $first, students first name
11890:
11891: =item $middle
11892:
11893: =item $last
11894:
11895: =item $gene
11896:
11897: =item $usec
11898:
11899: =item $end
11900:
11901: =item $start
11902:
1.957 raeburn 11903: =item $type
11904:
11905: =item $locktype
11906:
11907: =item $cid
11908:
11909: =item $selfenroll
11910:
11911: =item $context
11912:
1.297 matthew 11913: =back
11914:
1.191 harris41 11915:
11916: =item *
11917:
1.243 albertel 11918: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
11919: custom role; give a custom role to a user for the level given by URL. Specify
11920: name and domain of role author, and role name
1.191 harris41 11921:
11922: =item *
11923:
1.243 albertel 11924: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 11925:
11926: =item *
11927:
1.243 albertel 11928: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
11929:
11930: =back
11931:
11932: =head2 Course Infomation
11933:
11934: =over 4
1.191 harris41 11935:
11936: =item *
11937:
1.1118 foxr 11938: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 11939: specified course id, including all environment settings for the
11940: course, the description of the course will be in the hash under the
11941: key 'description'
1.191 harris41 11942:
1.1118 foxr 11943: $options is an optional parameter that if supplied is a hash reference that controls
11944: what how this function works. It has the following key/values:
11945:
11946: =over 4
11947:
11948: =item freshen_cache
11949:
11950: If defined, and the environment cache for the course is valid, it is
11951: returned in the returned hash.
11952:
11953: =item one_time
11954:
11955: If defined, the last cache time is set to _now_
11956:
11957: =item user
11958:
11959: If defined, the supplied username is used instead of the current user.
11960:
11961:
11962: =back
11963:
1.191 harris41 11964: =item *
11965:
1.624 albertel 11966: resdata($name,$domain,$type,@which) : request for current parameter
11967: setting for a specific $type, where $type is either 'course' or 'user',
11968: @what should be a list of parameters to ask about. This routine caches
11969: answers for 5 minutes.
1.243 albertel 11970:
1.877 foxr 11971: =item *
11972:
11973: get_courseresdata($courseid, $domain) : dump the entire course resource
11974: data base, returning a hash that is keyed by the resource name and has
11975: values that are the resource value. I believe that the timestamps and
11976: versions are also returned.
11977:
11978:
1.243 albertel 11979: =back
11980:
11981: =head2 Course Modification
11982:
11983: =over 4
1.191 harris41 11984:
11985: =item *
11986:
1.243 albertel 11987: writecoursepref($courseid,%prefs) : write preferences (environment
11988: database) for a course
1.191 harris41 11989:
11990: =item *
11991:
1.1011 raeburn 11992: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
11993:
11994: =item *
11995:
1.1038 raeburn 11996: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 11997:
1.1167 droeschl 11998: =item *
11999:
12000: is_course($courseid), is_course($cdom, $cnum)
12001:
12002: Accepts either a combined $courseid (in the form of domain_courseid) or the
12003: two component version $cdom, $cnum. It checks if the specified course exists.
12004:
12005: Returns:
12006: undef if the course doesn't exist, otherwise
12007: in scalar context the combined courseid.
12008: in list context the two components of the course identifier, domain and
12009: courseid.
12010:
1.243 albertel 12011: =back
12012:
12013: =head2 Resource Subroutines
12014:
12015: =over 4
1.191 harris41 12016:
12017: =item *
12018:
1.243 albertel 12019: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 12020:
12021: =item *
12022:
1.243 albertel 12023: repcopy($filename) : subscribes to the requested file, and attempts to
12024: replicate from the owning library server, Might return
1.607 raeburn 12025: 'unavailable', 'not_found', 'forbidden', 'ok', or
12026: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 12027: resource. Expects the local filesystem pathname
12028: (/home/httpd/html/res/....)
12029:
12030: =back
12031:
12032: =head2 Resource Information
12033:
12034: =over 4
1.191 harris41 12035:
12036: =item *
12037:
1.243 albertel 12038: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
12039: a vairety of different possible values, $varname should be a request
12040: string, and the other parameters can be used to specify who and what
12041: one is asking about.
12042:
12043: Possible values for $varname are environment.lastname (or other item
12044: from the envirnment hash), user.name (or someother aspect about the
12045: user), resource.0.maxtries (or some other part and parameter of a
12046: resource)
1.204 albertel 12047:
12048: =item *
12049:
1.243 albertel 12050: directcondval($number) : get current value of a condition; reads from a state
12051: string
1.204 albertel 12052:
12053: =item *
12054:
1.243 albertel 12055: condval($condidx) : value of condition index based on state
1.204 albertel 12056:
12057: =item *
12058:
1.243 albertel 12059: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
12060: resource's metadata, $what should be either a specific key, or either
12061: 'keys' (to get a list of possible keys) or 'packages' to get a list of
12062: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
12063:
12064: this function automatically caches all requests
1.191 harris41 12065:
12066: =item *
12067:
1.243 albertel 12068: metadata_query($query,$custom,$customshow) : make a metadata query against the
12069: network of library servers; returns file handle of where SQL and regex results
12070: will be stored for query
1.191 harris41 12071:
12072: =item *
12073:
1.243 albertel 12074: symbread($filename) : return symbolic list entry (filename argument optional);
12075: returns the data handle
1.191 harris41 12076:
12077: =item *
12078:
1.243 albertel 12079: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 12080: a possible symb for the URL in $thisfn, and if is an encryypted
12081: resource that the user accessed using /enc/ returns a 1 on success, 0
12082: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 12083: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 12084:
1.191 harris41 12085:
12086: =item *
12087:
1.243 albertel 12088: symbclean($symb) : removes versions numbers from a symb, returns the
12089: cleaned symb
1.191 harris41 12090:
12091: =item *
12092:
1.243 albertel 12093: is_on_map($uri) : checks if the $uri is somewhere on the current
12094: course map, user must be in a course for it to work.
1.191 harris41 12095:
12096: =item *
12097:
1.243 albertel 12098: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 12099:
12100: =item *
12101:
1.243 albertel 12102: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
12103: a random seed, all arguments are optional, if they aren't sent it uses the
12104: environment to derive them. Note: if symb isn't sent and it can't get one
12105: from &symbread it will use the current time as its return value
1.191 harris41 12106:
12107: =item *
12108:
1.243 albertel 12109: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
12110: unfakeable, receipt
1.191 harris41 12111:
12112: =item *
12113:
1.620 albertel 12114: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 12115:
12116: =item *
12117:
1.243 albertel 12118: countacc($url) : count the number of accesses to a given URL
1.191 harris41 12119:
12120: =item *
12121:
1.243 albertel 12122: 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 12123:
12124: =item *
12125:
1.243 albertel 12126: 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 12127:
12128: =item *
12129:
1.243 albertel 12130: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 12131:
12132: =item *
12133:
1.243 albertel 12134: devalidate($symb) : devalidate temporary spreadsheet calculations,
12135: forcing spreadsheet to reevaluate the resource scores next time.
12136:
12137: =back
12138:
12139: =head2 Storing/Retreiving Data
12140:
12141: =over 4
1.191 harris41 12142:
12143: =item *
12144:
1.243 albertel 12145: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
12146: for this url; hashref needs to be given and should be a \%hashname; the
12147: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 12148: be derived from the env
1.191 harris41 12149:
12150: =item *
12151:
1.243 albertel 12152: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
12153: uses critical subroutine
1.191 harris41 12154:
12155: =item *
12156:
1.243 albertel 12157: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
12158: all args are optional
1.191 harris41 12159:
12160: =item *
12161:
1.717 albertel 12162: dumpstore($namespace,$udom,$uname,$regexp,$range) :
12163: dumps the complete (or key matching regexp) namespace into a hash
12164: ($udom, $uname, $regexp, $range are optional) for a namespace that is
12165: normally &store()ed into
12166:
12167: $range should be either an integer '100' (give me the first 100
12168: matching records)
12169: or be two integers sperated by a - with no spaces
12170: '30-50' (give me the 30th through the 50th matching
12171: records)
12172:
12173:
12174: =item *
12175:
12176: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
12177: replaces a &store() version of data with a replacement set of data
12178: for a particular resource in a namespace passed in the $storehash hash
12179: reference
12180:
12181: =item *
12182:
1.243 albertel 12183: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
12184: works very similar to store/cstore, but all data is stored in a
12185: temporary location and can be reset using tmpreset, $storehash should
12186: be a hash reference, returns nothing on success
1.191 harris41 12187:
12188: =item *
12189:
1.243 albertel 12190: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
12191: similar to restore, but all data is stored in a temporary location and
12192: can be reset using tmpreset. Returns a hash of values on success,
12193: error string otherwise.
1.191 harris41 12194:
12195: =item *
12196:
1.243 albertel 12197: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
12198: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 12199:
12200: =item *
12201:
1.243 albertel 12202: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
12203: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 12204:
12205: =item *
12206:
1.243 albertel 12207: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
12208: namesp ($udom and $uname are optional)
1.191 harris41 12209:
12210: =item *
12211:
1.702 albertel 12212: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 12213: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 12214: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 12215:
1.702 albertel 12216: $range should be either an integer '100' (give me the first 100
12217: matching records)
12218: or be two integers sperated by a - with no spaces
12219: '30-50' (give me the 30th through the 50th matching
12220: records)
1.449 matthew 12221: =item *
12222:
12223: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
12224: $store can be a scalar, an array reference, or if the amount to be
12225: incremented is > 1, a hash reference.
12226:
12227: ($udom and $uname are optional)
1.191 harris41 12228:
12229: =item *
12230:
1.243 albertel 12231: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
12232: ($udom and $uname are optional)
1.191 harris41 12233:
12234: =item *
12235:
1.243 albertel 12236: cput($namespace,$storehash,$udom,$uname) : critical put
12237: ($udom and $uname are optional)
1.191 harris41 12238:
12239: =item *
12240:
1.748 albertel 12241: newput($namespace,$storehash,$udom,$uname) :
12242:
12243: Attempts to store the items in the $storehash, but only if they don't
12244: currently exist, if this succeeds you can be certain that you have
12245: successfully created a new key value pair in the $namespace db.
12246:
12247:
12248: Args:
12249: $namespace: name of database to store values to
12250: $storehash: hashref to store to the db
12251: $udom: (optional) domain of user containing the db
12252: $uname: (optional) name of user caontaining the db
12253:
12254: Returns:
12255: 'ok' -> succeeded in storing all keys of $storehash
12256: 'key_exists: <key>' -> failed to anything out of $storehash, as at
12257: least <key> already existed in the db (other
12258: requested keys may also already exist)
1.967 bisitz 12259: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 12260: 'con_lost' -> unable to contact request server
12261: 'refused' -> action was not allowed by remote machine
12262:
12263:
12264: =item *
12265:
1.243 albertel 12266: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
12267: reference filled in from namesp (encrypts the return communication)
12268: ($udom and $uname are optional)
1.191 harris41 12269:
12270: =item *
12271:
1.243 albertel 12272: log($udom,$name,$home,$message) : write to permanent log for user; use
12273: critical subroutine
12274:
1.806 raeburn 12275: =item *
12276:
1.860 raeburn 12277: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
12278: array reference filled in from namespace found in domain level on either
12279: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 12280:
12281: =item *
12282:
1.860 raeburn 12283: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
12284: domain level either on specified domain server ($uhome) or primary domain
12285: server ($udom and $uhome are optional)
1.806 raeburn 12286:
1.943 raeburn 12287: =item *
12288:
12289: get_domain_defaults($target_domain) : returns hash with defaults for
12290: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
12291: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
12292: or localauth), initial password or a kerberos realm, language (e.g., en-us).
12293: Values are retrieved from cache (if current), or from domain's configuration.db
12294: (if available), or lastly from values in lonTabs/dns_domain,tab,
12295: or lonTabs/domain.tab.
12296:
12297: %domdefaults = &get_auth_defaults($target_domain);
12298:
1.243 albertel 12299: =back
12300:
12301: =head2 Network Status Functions
12302:
12303: =over 4
1.191 harris41 12304:
12305: =item *
12306:
1.1137 raeburn 12307: dirlist() : return directory list based on URI (first arg).
12308:
12309: Inputs: 1 required, 5 optional.
12310:
12311: =over
12312:
12313: =item
12314: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
12315:
12316: =item
12317: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
12318:
12319: =item
12320: $username - username of user/course to be listed. Extracted from $uri if absent.
12321:
12322: =item
12323: $getpropath - boolean: 1 if prepend path using &propath().
12324:
12325: =item
12326: $getuserdir - boolean: 1 if prepend path for "userfiles".
12327:
12328: =item
12329: $alternateRoot - path to prepend in place of path from $uri.
12330:
12331: =back
12332:
12333: Returns: Array of up to two items.
12334:
12335: =over
12336:
12337: a reference to an array of files/subdirectories
12338:
12339: =over
12340:
12341: Each element in the array of files/subdirectories is a & separated list of
12342: item name and the result of running stat on the item. If dirlist was requested
12343: for a file instead of a directory, the item name will be ''. For a directory
12344: listing, if the item is a metadata file, the element will end &N&M
12345: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
12346: default copyright set (1).
12347:
12348: =back
12349:
12350: a scalar containing error condition (if encountered).
12351:
12352: =over
12353:
12354: =item
12355: no_host (no homeserver identified for $username:$domain).
12356:
12357: =item
12358: no_such_host (server contacted for listing not identified as valid host).
12359:
12360: =item
12361: con_lost (connection to remote server failed).
12362:
12363: =item
12364: refused (invalid $username:$domain received on lond side).
12365:
12366: =item
12367: no_such_dir (directory at specified path on lond side does not exist).
12368:
12369: =item
12370: empty (directory at specified path on lond side is empty).
12371:
12372: =over
12373:
12374: This is currently not encountered because the &ls3, &ls2,
12375: &ls (_handler) routines on the lond side do not filter out
12376: . and .. from a directory listing.
12377:
12378: =back
12379:
12380: =back
12381:
12382: =back
1.191 harris41 12383:
12384: =item *
12385:
1.243 albertel 12386: spareserver() : find server with least workload from spare.tab
12387:
1.986 foxr 12388:
12389: =item *
12390:
12391: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
12392: if there is no corresponding loncapa host.
12393:
1.243 albertel 12394: =back
12395:
1.986 foxr 12396:
1.243 albertel 12397: =head2 Apache Request
12398:
12399: =over 4
1.191 harris41 12400:
12401: =item *
12402:
1.243 albertel 12403: ssi($url,%hash) : server side include, does a complete request cycle on url to
12404: localhost, posts hash
12405:
12406: =back
12407:
12408: =head2 Data to String to Data
12409:
12410: =over 4
1.191 harris41 12411:
12412: =item *
12413:
1.243 albertel 12414: hash2str(%hash) : convert a hash into a string complete with escaping and '='
12415: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 12416:
12417: =item *
12418:
1.243 albertel 12419: hashref2str($hashref) : convert a hashref into a string complete with
12420: escaping and '=' and '&' separators, supports elements that are
12421: arrayrefs and hashrefs
1.191 harris41 12422:
12423: =item *
12424:
1.243 albertel 12425: arrayref2str($arrayref) : convert an arrayref into a string complete
12426: with escaping and '&' separators, supports elements that are arrayrefs
12427: and hashrefs
1.191 harris41 12428:
12429: =item *
12430:
1.243 albertel 12431: str2hash($string) : convert string to hash using unescaping and
12432: splitting on '=' and '&', supports elements that are arrayrefs and
12433: hashrefs
1.191 harris41 12434:
12435: =item *
12436:
1.243 albertel 12437: str2array($string) : convert string to hash using unescaping and
12438: splitting on '&', supports elements that are arrayrefs and hashrefs
12439:
12440: =back
12441:
12442: =head2 Logging Routines
12443:
12444:
12445: These routines allow one to make log messages in the lonnet.log and
12446: lonnet.perm logfiles.
1.191 harris41 12447:
1.1119 foxr 12448: =over 4
12449:
1.191 harris41 12450: =item *
12451:
1.243 albertel 12452: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 12453:
12454: =item *
12455:
1.243 albertel 12456: logthis() : append message to the normal lonnet.log file, it gets
12457: preiodically rolled over and deleted.
1.191 harris41 12458:
12459: =item *
12460:
1.243 albertel 12461: logperm() : append a permanent message to lonnet.perm.log, this log
12462: file never gets deleted by any automated portion of the system, only
12463: messages of critical importance should go in here.
12464:
1.1119 foxr 12465:
1.243 albertel 12466: =back
12467:
12468: =head2 General File Helper Routines
12469:
12470: =over 4
1.191 harris41 12471:
12472: =item *
12473:
1.481 raeburn 12474: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
12475: (a) files in /uploaded
12476: (i) If a local copy of the file exists -
12477: compares modification date of local copy with last-modified date for
12478: definitive version stored on home server for course. If local copy is
12479: stale, requests a new version from the home server and stores it.
12480: If the original has been removed from the home server, then local copy
12481: is unlinked.
12482: (ii) If local copy does not exist -
12483: requests the file from the home server and stores it.
12484:
12485: If $caller is 'uploadrep':
12486: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
12487: for request for files originally uploaded via DOCS.
12488: - returns 'ok' if fresh local copy now available, -1 otherwise.
12489:
12490: Otherwise:
12491: This indicates a call from the content generation phase of the request.
12492: - returns the entire contents of the file or -1.
12493:
12494: (b) files in /res
12495: - returns the entire contents of a file or -1;
12496: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 12497:
1.712 albertel 12498:
12499: =item *
12500:
12501: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
12502: reference
12503:
12504: returns either a stat() list of data about the file or an empty list
12505: if the file doesn't exist or couldn't find out about it (connection
12506: problems or user unknown)
12507:
1.191 harris41 12508: =item *
12509:
1.243 albertel 12510: filelocation($dir,$file) : returns file system location of a file
12511: based on URI; meant to be "fairly clean" absolute reference, $dir is a
12512: directory that relative $file lookups are to looked in ($dir of /a/dir
12513: and a file of ../bob will become /a/bob)
1.191 harris41 12514:
12515: =item *
12516:
12517: hreflocation($dir,$file) : returns file system location or a URL; same as
12518: filelocation except for hrefs
12519:
12520: =item *
12521:
12522: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
12523:
1.243 albertel 12524: =back
12525:
1.608 albertel 12526: =head2 Usererfile file routines (/uploaded*)
12527:
12528: =over 4
12529:
12530: =item *
12531:
12532: userfileupload(): main rotine for putting a file in a user or course's
12533: filespace, arguments are,
12534:
1.620 albertel 12535: formname - required - this is the name of the element in $env where the
1.608 albertel 12536: filename, and the contents of the file to create/modifed exist
1.620 albertel 12537: the filename is in $env{'form.'.$formname.'.filename'} and the
12538: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 12539: context - if coursedoc, store the file in the course of the active role
12540: of the current user;
12541: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
12542: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 12543: subdir - required - subdirectory to put the file in under ../userfiles/
12544: if undefined, it will be placed in "unknown"
12545:
12546: (This routine calls clean_filename() to remove any dangerous
12547: characters from the filename, and then calls finuserfileupload() to
12548: complete the transaction)
12549:
12550: returns either the url of the uploaded file (/uploaded/....) if successful
12551: and /adm/notfound.html if unsuccessful
12552:
12553: =item *
12554:
12555: clean_filename(): routine for cleaing a filename up for storage in
12556: userfile space, argument is:
12557:
12558: filename - proposed filename
12559:
12560: returns: the new clean filename
12561:
12562: =item *
12563:
1.1090 raeburn 12564: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 12565: userspace, probably shouldn't be called directly
12566:
12567: docuname: username or courseid of destination for the file
12568: docudom: domain of user/course of destination for the file
12569: formname: same as for userfileupload()
1.1090 raeburn 12570: fname: filename (including subdirectories) for the file
12571: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
12572: allfiles: reference to hash used to store objects found by parser
12573: codebase: reference to hash used for codebases of java objects found by parser
12574: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
12575: thumbheight: height (pixels) of thumbnail to be created for uploaded image
12576: resizewidth: width to be used to resize image using resizeImage from ImageMagick
12577: resizeheight: height to be used to resize image using resizeImage from ImageMagick
12578: context: if 'overwrite', will move the uploaded file from its temporary location to
12579: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 12580: mimetype: reference to scalar to accommodate mime type determined
12581: from File::MMagic if $parser = parse.
1.608 albertel 12582:
12583: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 12584: and /adm/notfound.html if unsuccessful (or an error message if context
12585: was 'overwrite').
12586:
1.608 albertel 12587:
12588: =item *
12589:
12590: renameuserfile(): renames an existing userfile to a new name
12591:
12592: Args:
12593: docuname: username or courseid of destination for the file
12594: docudom: domain of user/course of destination for the file
12595: old: current file name (including any subdirs under userfiles)
12596: new: desired file name (including any subdirs under userfiles)
12597:
12598: =item *
12599:
12600: mkdiruserfile(): creates a directory is a userfiles dir
12601:
12602: Args:
12603: docuname: username or courseid of destination for the file
12604: docudom: domain of user/course of destination for the file
12605: dir: dir to create (including any subdirs under userfiles)
12606:
12607: =item *
12608:
12609: removeuserfile(): removes a file that exists in userfiles
12610:
12611: Args:
12612: docuname: username or courseid of destination for the file
12613: docudom: domain of user/course of destination for the file
12614: fname: filname to delete (including any subdirs under userfiles)
12615:
12616: =item *
12617:
12618: removeuploadedurl(): convience function for removeuserfile()
12619:
12620: Args:
12621: url: a full /uploaded/... url to delete
12622:
1.747 albertel 12623: =item *
12624:
12625: get_portfile_permissions():
12626: Args:
12627: domain: domain of user or course contain the portfolio files
12628: user: name of user or num of course contain the portfolio files
12629: Returns:
12630: hashref of a dump of the proper file_permissions.db
12631:
12632:
12633: =item *
12634:
12635: get_access_controls():
12636:
12637: Args:
12638: current_permissions: the hash ref returned from get_portfile_permissions()
12639: group: (optional) the group you want the files associated with
12640: file: (optional) the file you want access info on
12641:
12642: Returns:
1.749 raeburn 12643: a hash (keys are file names) of hashes containing
12644: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
12645: values are XML containing access control settings (see below)
1.747 albertel 12646:
12647: Internal notes:
12648:
1.749 raeburn 12649: access controls are stored in file_permissions.db as key=value pairs.
12650: key -> path to file/file_name\0uniqueID:scope_end_start
12651: where scope -> public,guest,course,group,domains or users.
12652: end -> UNIX time for end of access (0 -> no end date)
12653: start -> UNIX time for start of access
12654:
12655: value -> XML description of access control
12656: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
12657: <start></start>
12658: <end></end>
12659:
12660: <password></password> for scope type = guest
12661:
12662: <domain></domain> for scope type = course or group
12663: <number></number>
12664: <roles id="">
12665: <role></role>
12666: <access></access>
12667: <section></section>
12668: <group></group>
12669: </roles>
12670:
12671: <dom></dom> for scope type = domains
12672:
12673: <users> for scope type = users
12674: <user>
12675: <uname></uname>
12676: <udom></udom>
12677: </user>
12678: </users>
12679: </scope>
12680:
12681: Access data is also aggregated for each file in an additional key=value pair:
12682: key -> path to file/file_name\0accesscontrol
12683: value -> reference to hash
12684: hash contains key = value pairs
12685: where key = uniqueID:scope_end_start
12686: value = UNIX time record was last updated
12687:
12688: Used to improve speed of look-ups of access controls for each file.
12689:
12690: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
12691:
12692: modify_access_controls():
12693:
12694: Modifies access controls for a portfolio file
12695: Args
12696: 1. file name
12697: 2. reference to hash of required changes,
12698: 3. domain
12699: 4. username
12700: where domain,username are the domain of the portfolio owner
12701: (either a user or a course)
12702:
12703: Returns:
12704: 1. result of additions or updates ('ok' or 'error', with error message).
12705: 2. result of deletions ('ok' or 'error', with error message).
12706: 3. reference to hash of any new or updated access controls.
12707: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
12708: key = integer (inbound ID)
12709: value = uniqueID
1.747 albertel 12710:
1.608 albertel 12711: =back
12712:
1.243 albertel 12713: =head2 HTTP Helper Routines
12714:
12715: =over 4
12716:
1.191 harris41 12717: =item *
12718:
12719: escape() : unpack non-word characters into CGI-compatible hex codes
12720:
12721: =item *
12722:
12723: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
12724:
1.243 albertel 12725: =back
12726:
12727: =head1 PRIVATE SUBROUTINES
12728:
12729: =head2 Underlying communication routines (Shouldn't call)
12730:
12731: =over 4
12732:
12733: =item *
12734:
12735: subreply() : tries to pass a message to lonc, returns con_lost if incapable
12736:
12737: =item *
12738:
12739: reply() : uses subreply to send a message to remote machine, logs all failures
12740:
12741: =item *
12742:
12743: critical() : passes a critical message to another server; if cannot
12744: get through then place message in connection buffer directory and
12745: returns con_delayed, if incapable of saving message, returns
12746: con_failed
12747:
12748: =item *
12749:
12750: reconlonc() : tries to reconnect lonc client processes.
12751:
12752: =back
12753:
12754: =head2 Resource Access Logging
12755:
12756: =over 4
12757:
12758: =item *
12759:
12760: flushcourselogs() : flush (save) buffer logs and access logs
12761:
12762: =item *
12763:
12764: courselog($what) : save message for course in hash
12765:
12766: =item *
12767:
12768: courseacclog($what) : save message for course using &courselog(). Perform
12769: special processing for specific resource types (problems, exams, quizzes, etc).
12770:
1.191 harris41 12771: =item *
12772:
12773: goodbye() : flush course logs and log shutting down; it is called in srm.conf
12774: as a PerlChildExitHandler
1.243 albertel 12775:
12776: =back
12777:
12778: =head2 Other
12779:
12780: =over 4
12781:
12782: =item *
12783:
12784: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 12785:
12786: =back
12787:
12788: =cut
1.877 foxr 12789:
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