Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1295
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1295 ! raeburn 4: # $Id: lonnet.pm,v 1.1294 2015/10/23 16:01:41 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.1182 foxr 78:
1.1173 foxr 79: use Encode;
80:
1.1245 raeburn 81: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.1138 raeburn 82: $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
83: %managerstab);
1.871 albertel 84:
85: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
86: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
87: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 88: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 89:
1.1 albertel 90: use IO::Socket;
1.31 www 91: use GDBM_File;
1.208 albertel 92: use HTML::LCParser;
1.88 www 93: use Fcntl qw(:flock);
1.870 albertel 94: use Storable qw(thaw nfreeze);
1.1289 damieng 95: use Time::HiRes qw( sleep gettimeofday tv_interval );
1.599 albertel 96: use Cache::Memcached;
1.676 albertel 97: use Digest::MD5;
1.790 albertel 98: use Math::Random;
1.1024 raeburn 99: use File::MMagic;
1.807 albertel 100: use LONCAPA qw(:DEFAULT :match);
1.740 www 101: use LONCAPA::Configuration;
1.1160 www 102: use LONCAPA::lonmetadata;
1.1167 droeschl 103: use LONCAPA::Lond;
1.1117 foxr 104:
1.1090 raeburn 105: use File::Copy;
1.676 albertel 106:
1.195 www 107: my $readit;
1.1288 damieng 108: my $max_connection_retries = 20; # Or some such value.
1.1 albertel 109:
1.619 albertel 110: require Exporter;
111:
112: our @ISA = qw (Exporter);
113: our @EXPORT = qw(%env);
114:
1.449 matthew 115:
1.1187 raeburn 116: # ------------------------------------ Logging (parameters, docs, slots, roles)
1.729 www 117: {
118: my $logid;
1.1187 raeburn 119: sub write_log {
1.1188 raeburn 120: my ($context,$hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
1.1184 raeburn 121: if ($context eq 'course') {
122: if (($cnum eq '') || ($cdom eq '')) {
123: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
124: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
125: }
1.957 raeburn 126: }
1.1184 raeburn 127: $logid ++;
1.957 raeburn 128: my $now = time();
129: my $id=$now.'00000'.$$.'00000'.$logid;
1.1184 raeburn 130: my $logentry = {
131: $id => {
132: 'exe_uname' => $env{'user.name'},
133: 'exe_udom' => $env{'user.domain'},
134: 'exe_time' => $now,
135: 'exe_ip' => $ENV{'REMOTE_ADDR'},
136: 'delflag' => $delflag,
137: 'logentry' => $storehash,
138: 'uname' => $uname,
139: 'udom' => $udom,
140: }
141: };
142: return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
1.729 www 143: }
144: }
1.1 albertel 145:
1.163 harris41 146: sub logtouch {
147: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 148: unless (-e "$execdir/logs/lonnet.log") {
149: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 150: close $fh;
151: }
152: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
153: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
154: }
155:
1.1 albertel 156: sub logthis {
157: my $message=shift;
158: my $execdir=$perlvar{'lonDaemons'};
159: my $now=time;
160: my $local=localtime($now);
1.448 albertel 161: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986 foxr 162: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
163: print $fh $logstring;
1.448 albertel 164: close($fh);
165: }
1.1 albertel 166: return 1;
167: }
168:
169: sub logperm {
170: my $message=shift;
171: my $execdir=$perlvar{'lonDaemons'};
172: my $now=time;
173: my $local=localtime($now);
1.448 albertel 174: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
175: print $fh "$now:$message:$local\n";
176: close($fh);
177: }
1.1 albertel 178: return 1;
179: }
180:
1.850 albertel 181: sub create_connection {
1.853 albertel 182: my ($hostname,$lonid) = @_;
1.851 albertel 183: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 184: Type => SOCK_STREAM,
185: Timeout => 10);
186: return 0 if (!$client);
1.890 albertel 187: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 188: my $result = <$client>;
189: chomp($result);
190: return 1 if ($result eq 'done');
191: return 0;
192: }
193:
1.983 raeburn 194: sub get_server_timezone {
195: my ($cnum,$cdom) = @_;
196: my $home=&homeserver($cnum,$cdom);
197: if ($home ne 'no_host') {
198: my $cachetime = 24*3600;
199: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
200: if (defined($cached)) {
201: return $timezone;
202: } else {
203: my $timezone = &reply('servertimezone',$home);
204: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
205: }
206: }
207: }
1.850 albertel 208:
1.1106 raeburn 209: sub get_server_distarch {
210: my ($lonhost,$ignore_cache) = @_;
211: if (defined($lonhost)) {
212: if (!defined(&hostname($lonhost))) {
213: return;
214: }
215: my $cachetime = 12*3600;
216: if (!$ignore_cache) {
217: my ($distarch,$cached)=&is_cached_new('serverdistarch',$lonhost);
218: if (defined($cached)) {
219: return $distarch;
220: }
221: }
222: my $rep = &reply('serverdistarch',$lonhost);
223: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
224: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
225: $rep eq '') {
226: return &do_cache_new('serverdistarch',$lonhost,$rep,$cachetime);
227: }
228: }
229: return;
230: }
231:
1.993 raeburn 232: sub get_server_loncaparev {
1.1073 raeburn 233: my ($dom,$lonhost,$ignore_cache,$caller) = @_;
1.993 raeburn 234: if (defined($lonhost)) {
235: if (!defined(&hostname($lonhost))) {
236: undef($lonhost);
237: }
238: }
239: if (!defined($lonhost)) {
240: if (defined(&domain($dom,'primary'))) {
241: $lonhost=&domain($dom,'primary');
242: if ($lonhost eq 'no_host') {
243: undef($lonhost);
244: }
245: }
246: }
247: if (defined($lonhost)) {
1.1073 raeburn 248: my $cachetime = 12*3600;
249: if (!$ignore_cache) {
250: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
251: if (defined($cached)) {
252: return $loncaparev;
253: }
254: }
255: my ($answer,$loncaparev);
256: my @ids=¤t_machine_ids();
257: if (grep(/^\Q$lonhost\E$/,@ids)) {
258: $answer = $perlvar{'lonVersion'};
1.1081 raeburn 259: if ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 260: $loncaparev = $1;
261: }
262: } else {
263: $answer = &reply('serverloncaparev',$lonhost);
264: if (($answer eq 'unknown_cmd') || ($answer eq 'con_lost')) {
265: if ($caller eq 'loncron') {
266: my $ua=new LWP::UserAgent;
1.1082 raeburn 267: $ua->timeout(4);
1.1073 raeburn 268: my $protocol = $protocol{$lonhost};
269: $protocol = 'http' if ($protocol ne 'https');
270: my $url = $protocol.'://'.&hostname($lonhost).'/adm/about.html';
271: my $request=new HTTP::Request('GET',$url);
272: my $response=$ua->request($request);
273: unless ($response->is_error()) {
274: my $content = $response->content;
1.1081 raeburn 275: if ($content =~ /<p>VERSION\:\s*([\w.\-]+)<\/p>/) {
1.1073 raeburn 276: $loncaparev = $1;
277: }
278: }
279: } else {
280: $loncaparev = $loncaparevs{$lonhost};
281: }
1.1081 raeburn 282: } elsif ($answer =~ /^[\'\"]?([\w.\-]+)[\'\"]?$/) {
1.1073 raeburn 283: $loncaparev = $1;
284: }
1.993 raeburn 285: }
1.1073 raeburn 286: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
1.993 raeburn 287: }
288: }
289:
1.1074 raeburn 290: sub get_server_homeID {
291: my ($hostname,$ignore_cache,$caller) = @_;
292: unless ($ignore_cache) {
293: my ($serverhomeID,$cached)=&is_cached_new('serverhomeID',$hostname);
294: if (defined($cached)) {
295: return $serverhomeID;
296: }
297: }
298: my $cachetime = 12*3600;
299: my $serverhomeID;
300: if ($caller eq 'loncron') {
301: my @machine_ids = &machine_ids($hostname);
302: foreach my $id (@machine_ids) {
303: my $response = &reply('serverhomeID',$id);
304: unless (($response eq 'unknown_cmd') || ($response eq 'con_lost')) {
305: $serverhomeID = $response;
306: last;
307: }
308: }
309: if ($serverhomeID eq '') {
310: $serverhomeID = $machine_ids[-1];
311: }
312: } else {
313: $serverhomeID = $serverhomeIDs{$hostname};
314: }
315: return &do_cache_new('serverhomeID',$hostname,$serverhomeID,$cachetime);
316: }
317:
1.1121 raeburn 318: sub get_remote_globals {
319: my ($lonhost,$whathash,$ignore_cache) = @_;
1.1125 raeburn 320: my ($result,%returnhash,%whatneeded);
321: if (ref($whathash) eq 'HASH') {
1.1121 raeburn 322: foreach my $what (sort(keys(%{$whathash}))) {
323: my $hashid = $lonhost.'-'.$what;
1.1125 raeburn 324: my ($response,$cached);
1.1121 raeburn 325: unless ($ignore_cache) {
1.1125 raeburn 326: ($response,$cached)=&is_cached_new('lonnetglobal',$hashid);
1.1121 raeburn 327: }
328: if (defined($cached)) {
1.1125 raeburn 329: $returnhash{$what} = $response;
1.1121 raeburn 330: } else {
1.1125 raeburn 331: $whatneeded{$what} = 1;
1.1121 raeburn 332: }
333: }
1.1125 raeburn 334: if (keys(%whatneeded) == 0) {
335: $result = 'ok';
336: } else {
1.1121 raeburn 337: my $requested = &freeze_escape(\%whatneeded);
338: my $rep=&reply('readlonnetglobal:'.$requested,$lonhost);
1.1125 raeburn 339: if (($rep=~/^(refused|rejected|error)/) || ($rep eq 'con_lost') ||
340: ($rep eq 'unknown_cmd')) {
341: $result = $rep;
342: } else {
343: $result = 'ok';
1.1121 raeburn 344: my @pairs=split(/\&/,$rep);
1.1125 raeburn 345: foreach my $item (@pairs) {
346: my ($key,$value)=split(/=/,$item,2);
347: my $what = &unescape($key);
348: my $hashid = $lonhost.'-'.$what;
349: $returnhash{$what}=&thaw_unescape($value);
350: &do_cache_new('lonnetglobal',$hashid,$returnhash{$what},600);
1.1121 raeburn 351: }
352: }
353: }
354: }
1.1125 raeburn 355: return ($result,\%returnhash);
1.1121 raeburn 356: }
357:
1.1124 raeburn 358: sub remote_devalidate_cache {
1.1241 raeburn 359: my ($lonhost,$cachekeys) = @_;
360: my $items;
361: return unless (ref($cachekeys) eq 'ARRAY');
362: my $cachestr = join('&',@{$cachekeys});
363: my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
1.1124 raeburn 364: return $response;
365: }
366:
1.1 albertel 367: # -------------------------------------------------- Non-critical communication
368: sub subreply {
369: my ($cmd,$server)=@_;
1.838 albertel 370: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 371: #
372: # With loncnew process trimming, there's a timing hole between lonc server
373: # process exit and the master server picking up the listen on the AF_UNIX
374: # socket. In that time interval, a lock file will exist:
375:
376: my $lockfile=$peerfile.".lock";
377: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
1.1289 damieng 378: sleep(0.1);
1.549 foxr 379: }
380: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 381: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 382: #
1.550 foxr 383: # We'll give the connection a few tries before abandoning it. If
384: # connection is not possible, we'll con_lost back to the client.
385: #
386: my $client;
387: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
388: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
389: Type => SOCK_STREAM,
390: Timeout => 10);
1.869 albertel 391: if ($client) {
1.550 foxr 392: last; # Connected!
1.850 albertel 393: } else {
1.853 albertel 394: &create_connection(&hostname($server),$server);
1.550 foxr 395: }
1.1289 damieng 396: sleep(0.1); # Try again later if failed connection.
1.550 foxr 397: }
398: my $answer;
399: if ($client) {
1.704 albertel 400: print $client "sethost:$server:$cmd\n";
1.550 foxr 401: $answer=<$client>;
402: if (!$answer) { $answer="con_lost"; }
403: chomp($answer);
404: } else {
405: $answer = 'con_lost'; # Failed connection.
406: }
1.1 albertel 407: return $answer;
408: }
409:
410: sub reply {
411: my ($cmd,$server)=@_;
1.838 albertel 412: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 413: my $answer=subreply($cmd,$server);
1.65 www 414: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 415: &logthis("<font color=\"blue\">WARNING:".
1.12 www 416: " $cmd to $server returned $answer</font>");
417: }
1.1 albertel 418: return $answer;
419: }
420:
421: # ----------------------------------------------------------- Send USR1 to lonc
422:
423: sub reconlonc {
1.891 albertel 424: my ($lonid) = @_;
425: if ($lonid) {
1.1295 ! raeburn 426: my $hostname = &hostname($lonid);
1.891 albertel 427: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
428: if ($hostname && -e $peerfile) {
429: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
430: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
431: Type => SOCK_STREAM,
432: Timeout => 10);
433: if ($client) {
434: print $client ("reset_retries\n");
435: my $answer=<$client>;
436: #reset just this one.
437: }
438: }
439: return;
440: }
441:
1.836 www 442: &logthis("Trying to reconnect lonc");
1.1 albertel 443: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 444: if (open(my $fh,"<$loncfile")) {
1.1 albertel 445: my $loncpid=<$fh>;
446: chomp($loncpid);
447: if (kill 0 => $loncpid) {
448: &logthis("lonc at pid $loncpid responding, sending USR1");
449: kill USR1 => $loncpid;
450: sleep 1;
1.1295 ! raeburn 451: } else {
1.12 www 452: &logthis(
1.672 albertel 453: "<font color=\"blue\">WARNING:".
1.12 www 454: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 455: }
456: } else {
1.836 www 457: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 458: }
459: }
460:
461: # ------------------------------------------------------ Critical communication
1.12 www 462:
1.1 albertel 463: sub critical {
464: my ($cmd,$server)=@_;
1.838 albertel 465: unless (&hostname($server)) {
1.672 albertel 466: &logthis("<font color=\"blue\">WARNING:".
1.89 www 467: " Critical message to unknown server ($server)</font>");
468: return 'no_such_host';
469: }
1.1 albertel 470: my $answer=reply($cmd,$server);
471: if ($answer eq 'con_lost') {
1.1295 ! raeburn 472: &reconlonc($server);
1.589 albertel 473: my $answer=reply($cmd,$server);
1.1 albertel 474: if ($answer eq 'con_lost') {
475: my $now=time;
476: my $middlename=$cmd;
1.5 www 477: $middlename=substr($middlename,0,16);
1.1 albertel 478: $middlename=~s/\W//g;
479: my $dfilename=
1.305 www 480: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
481: $dumpcount++;
1.1 albertel 482: {
1.448 albertel 483: my $dfh;
484: if (open($dfh,">$dfilename")) {
485: print $dfh "$cmd\n";
486: close($dfh);
487: }
1.1 albertel 488: }
1.1288 damieng 489: sleep 1;
1.1 albertel 490: my $wcmd='';
491: {
1.448 albertel 492: my $dfh;
493: if (open($dfh,"<$dfilename")) {
494: $wcmd=<$dfh>;
495: close($dfh);
496: }
1.1 albertel 497: }
498: chomp($wcmd);
1.7 www 499: if ($wcmd eq $cmd) {
1.672 albertel 500: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 501: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 502: &logperm("D:$server:$cmd");
503: return 'con_delayed';
504: } else {
1.672 albertel 505: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 506: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 507: &logperm("F:$server:$cmd");
508: return 'con_failed';
509: }
510: }
511: }
512: return $answer;
1.405 albertel 513: }
514:
1.755 albertel 515: # ------------------------------------------- check if return value is an error
516:
517: sub error {
518: my ($result) = @_;
1.756 albertel 519: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 520: if ($2 == 2) { return undef; }
521: return $1;
522: }
523: return undef;
524: }
525:
1.783 albertel 526: sub convert_and_load_session_env {
527: my ($lonidsdir,$handle)=@_;
528: my @profile;
529: {
1.917 albertel 530: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
531: if (!$opened) {
1.915 albertel 532: return 0;
533: }
1.783 albertel 534: flock($idf,LOCK_SH);
535: @profile=<$idf>;
536: close($idf);
537: }
538: my %temp_env;
539: foreach my $line (@profile) {
1.786 albertel 540: if ($line !~ m/=/) {
541: return 0;
542: }
1.783 albertel 543: chomp($line);
544: my ($envname,$envvalue)=split(/=/,$line,2);
545: $temp_env{&unescape($envname)} = &unescape($envvalue);
546: }
547: unlink("$lonidsdir/$handle.id");
548: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
549: 0640)) {
550: %disk_env = %temp_env;
551: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
552: untie(%disk_env);
553: }
1.786 albertel 554: return 1;
1.783 albertel 555: }
556:
1.374 www 557: # ------------------------------------------- Transfer profile into environment
1.780 albertel 558: my $env_loaded;
559: sub transfer_profile_to_env {
1.788 albertel 560: my ($lonidsdir,$handle,$force_transfer) = @_;
561: if (!$force_transfer && $env_loaded) { return; }
1.374 www 562:
1.720 albertel 563: if (!defined($lonidsdir)) {
564: $lonidsdir = $perlvar{'lonIDsDir'};
565: }
566: if (!defined($handle)) {
567: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
568: }
569:
1.786 albertel 570: my $convert;
571: {
1.917 albertel 572: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
573: if (!$opened) {
1.915 albertel 574: return;
575: }
1.786 albertel 576: flock($idf,LOCK_SH);
577: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
578: &GDBM_READER(),0640)) {
579: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
580: untie(%disk_env);
581: } else {
582: $convert = 1;
583: }
584: }
585: if ($convert) {
586: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
587: &logthis("Failed to load session, or convert session.");
588: }
1.374 www 589: }
1.783 albertel 590:
1.786 albertel 591: my %remove;
1.783 albertel 592: while ( my $envname = each(%env) ) {
1.433 matthew 593: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
594: if ($time < time-300) {
1.783 albertel 595: $remove{$key}++;
1.433 matthew 596: }
597: }
598: }
1.783 albertel 599:
1.619 albertel 600: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 601: $env_loaded=1;
1.783 albertel 602: foreach my $expired_key (keys(%remove)) {
1.433 matthew 603: &delenv($expired_key);
1.374 www 604: }
1.1 albertel 605: }
606:
1.916 albertel 607: # ---------------------------------------------------- Check for valid session
608: sub check_for_valid_session {
1.1245 raeburn 609: my ($r,$name,$userhashref) = @_;
1.916 albertel 610: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1155 raeburn 611: if ($name eq '') {
612: $name = 'lonID';
613: }
614: my $lonid=$cookies{$name};
1.916 albertel 615: return undef if (!$lonid);
616:
617: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1155 raeburn 618: my $lonidsdir;
619: if ($name eq 'lonDAV') {
620: $lonidsdir=$r->dir_config('lonDAVsessDir');
621: } else {
622: $lonidsdir=$r->dir_config('lonIDsDir');
623: }
1.916 albertel 624: return undef if (!-e "$lonidsdir/$handle.id");
625:
1.917 albertel 626: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
627: return undef if (!$opened);
1.916 albertel 628:
629: flock($idf,LOCK_SH);
630: my %disk_env;
631: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
632: &GDBM_READER(),0640)) {
633: return undef;
634: }
635:
636: if (!defined($disk_env{'user.name'})
637: || !defined($disk_env{'user.domain'})) {
638: return undef;
639: }
1.1245 raeburn 640:
641: if (ref($userhashref) eq 'HASH') {
642: $userhashref->{'name'} = $disk_env{'user.name'};
643: $userhashref->{'domain'} = $disk_env{'user.domain'};
1.1212 raeburn 644: }
1.1245 raeburn 645:
1.916 albertel 646: return $handle;
647: }
648:
1.830 albertel 649: sub timed_flock {
650: my ($file,$lock_type) = @_;
651: my $failed=0;
652: eval {
653: local $SIG{__DIE__}='DEFAULT';
654: local $SIG{ALRM}=sub {
655: $failed=1;
656: die("failed lock");
657: };
658: alarm(13);
659: flock($file,$lock_type);
660: alarm(0);
661: };
662: if ($failed) {
663: return undef;
664: } else {
665: return 1;
666: }
667: }
668:
1.5 www 669: # ---------------------------------------------------------- Append Environment
670:
671: sub appenv {
1.949 raeburn 672: my ($newenv,$roles) = @_;
673: if (ref($newenv) eq 'HASH') {
674: foreach my $key (keys(%{$newenv})) {
675: my $refused = 0;
676: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
677: $refused = 1;
678: if (ref($roles) eq 'ARRAY') {
1.1250 raeburn 679: my ($type,$role) = ($key =~ m{^user\.(role|priv)\.(.+?)\./});
1.949 raeburn 680: if (grep(/^\Q$role\E$/,@{$roles})) {
681: $refused = 0;
682: }
683: }
684: }
685: if ($refused) {
686: &logthis("<font color=\"blue\">WARNING: ".
687: "Attempt to modify environment ".$key." to ".$newenv->{$key}
688: .'</font>');
689: delete($newenv->{$key});
690: } else {
691: $env{$key}=$newenv->{$key};
692: }
693: }
694: my $opened = open(my $env_file,'+<',$env{'user.environment'});
695: if ($opened
696: && &timed_flock($env_file,LOCK_EX)
697: &&
698: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
699: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
700: while (my ($key,$value) = each(%{$newenv})) {
701: $disk_env{$key} = $value;
702: }
703: untie(%disk_env);
1.35 www 704: }
1.191 harris41 705: }
1.56 www 706: return 'ok';
707: }
708: # ----------------------------------------------------- Delete from Environment
709:
710: sub delenv {
1.1104 raeburn 711: my ($delthis,$regexp,$roles) = @_;
712: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
713: my $refused = 1;
714: if (ref($roles) eq 'ARRAY') {
715: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
716: if (grep(/^\Q$role\E$/,@{$roles})) {
717: $refused = 0;
718: }
719: }
720: if ($refused) {
721: &logthis("<font color=\"blue\">WARNING: ".
722: "Attempt to delete from environment ".$delthis);
723: return 'error';
724: }
1.56 www 725: }
1.917 albertel 726: my $opened = open(my $env_file,'+<',$env{'user.environment'});
727: if ($opened
1.915 albertel 728: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 729: &&
730: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
731: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 732: foreach my $key (keys(%disk_env)) {
1.987 raeburn 733: if ($regexp) {
734: if ($key=~/^$delthis/) {
735: delete($env{$key});
736: delete($disk_env{$key});
737: }
738: } else {
739: if ($key=~/^\Q$delthis\E/) {
740: delete($env{$key});
741: delete($disk_env{$key});
742: }
743: }
1.448 albertel 744: }
1.783 albertel 745: untie(%disk_env);
1.5 www 746: }
747: return 'ok';
1.369 albertel 748: }
749:
1.790 albertel 750: sub get_env_multiple {
751: my ($name) = @_;
752: my @values;
753: if (defined($env{$name})) {
754: # exists is it an array
755: if (ref($env{$name})) {
756: @values=@{ $env{$name} };
757: } else {
758: $values[0]=$env{$name};
759: }
760: }
761: return(@values);
762: }
763:
1.958 www 764: # ------------------------------------------------------------------- Locking
765:
766: sub set_lock {
767: my ($text)=@_;
768: $locknum++;
769: my $id=$$.'-'.$locknum;
770: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
771: 'session.lock.'.$id => $text});
772: return $id;
773: }
774:
775: sub get_locks {
776: my $num=0;
777: my %texts=();
778: foreach my $lock (split(/\,/,$env{'session.locks'})) {
779: if ($lock=~/\w/) {
780: $num++;
781: $texts{$lock}=$env{'session.lock.'.$lock};
782: }
783: }
784: return ($num,%texts);
785: }
786:
787: sub remove_lock {
788: my ($id)=@_;
789: my $newlocks='';
790: foreach my $lock (split(/\,/,$env{'session.locks'})) {
791: if (($lock=~/\w/) && ($lock ne $id)) {
792: $newlocks.=','.$lock;
793: }
794: }
795: &appenv({'session.locks' => $newlocks});
796: &delenv('session.lock.'.$id);
797: }
798:
799: sub remove_all_locks {
800: my $activelocks=$env{'session.locks'};
801: foreach my $lock (split(/\,/,$env{'session.locks'})) {
802: if ($lock=~/\w/) {
803: &remove_lock($lock);
804: }
805: }
806: }
807:
808:
1.369 albertel 809: # ------------------------------------------ Find out current server userload
810: sub userload {
811: my $numusers=0;
812: {
813: opendir(LONIDS,$perlvar{'lonIDsDir'});
814: my $filename;
815: my $curtime=time;
816: while ($filename=readdir(LONIDS)) {
1.925 albertel 817: next if ($filename eq '.' || $filename eq '..');
818: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 819: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 820: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 821: }
822: closedir(LONIDS);
823: }
824: my $userloadpercent=0;
825: my $maxuserload=$perlvar{'lonUserLoadLim'};
826: if ($maxuserload) {
1.371 albertel 827: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 828: }
1.372 albertel 829: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 830: return $userloadpercent;
1.283 www 831: }
832:
1.1 albertel 833: # ------------------------------ Find server with least workload from spare.tab
1.11 www 834:
1.1 albertel 835: sub spareserver {
1.1083 raeburn 836: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 837: my $spare_server;
1.370 albertel 838: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 839: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
840: : $userloadpercent;
1.1083 raeburn 841: my ($uint_dom,$remotesessions);
842: if (($udom ne '') && (&domain($udom) ne '')) {
843: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
844: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
845: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
846: $remotesessions = $udomdefaults{'remotesessions'};
847: }
1.1123 raeburn 848: my $spareshash = &this_host_spares($udom);
849: if (ref($spareshash) eq 'HASH') {
850: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
851: foreach my $try_server (@{ $spareshash->{'primary'} }) {
1.1279 raeburn 852: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
853: $try_server));
1.1123 raeburn 854: ($spare_server, $lowest_load) =
855: &compare_server_load($try_server, $spare_server, $lowest_load);
856: }
1.1083 raeburn 857: }
1.784 albertel 858:
1.1123 raeburn 859: my $found_server = ($spare_server ne '' && $lowest_load < 100);
860:
861: if (!$found_server) {
862: if (ref($spareshash->{'default'}) eq 'ARRAY') {
863: foreach my $try_server (@{ $spareshash->{'default'} }) {
1.1279 raeburn 864: next unless (&spare_can_host($udom,$uint_dom,
865: $remotesessions,$try_server));
1.1123 raeburn 866: ($spare_server, $lowest_load) =
867: &compare_server_load($try_server, $spare_server, $lowest_load);
868: }
869: }
870: }
1.784 albertel 871: }
872:
873: if (!$want_server_name) {
1.968 raeburn 874: my $protocol = 'http';
875: if ($protocol{$spare_server} eq 'https') {
876: $protocol = $protocol{$spare_server};
877: }
1.1001 raeburn 878: if (defined($spare_server)) {
879: my $hostname = &hostname($spare_server);
1.1083 raeburn 880: if (defined($hostname)) {
1.1001 raeburn 881: $spare_server = $protocol.'://'.$hostname;
882: }
883: }
1.784 albertel 884: }
885: return $spare_server;
886: }
887:
888: sub compare_server_load {
1.1253 raeburn 889: my ($try_server, $spare_server, $lowest_load, $required) = @_;
890:
891: if ($required) {
892: my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
893: my $remoterev = &get_server_loncaparev(undef,$try_server);
894: my ($major,$minor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
895: if (($major eq '' && $minor eq '') ||
896: (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
897: return ($spare_server,$lowest_load);
898: }
899: }
1.784 albertel 900:
901: my $loadans = &reply('load', $try_server);
902: my $userloadans = &reply('userload',$try_server);
903:
904: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 905: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 906: }
907:
908: my $load;
909: if ($loadans =~ /\d/) {
910: if ($userloadans =~ /\d/) {
911: #both are numbers, pick the bigger one
912: $load = ($loadans > $userloadans) ? $loadans
913: : $userloadans;
1.411 albertel 914: } else {
1.784 albertel 915: $load = $loadans;
1.411 albertel 916: }
1.784 albertel 917: } else {
918: $load = $userloadans;
919: }
920:
921: if (($load =~ /\d/) && ($load < $lowest_load)) {
922: $spare_server = $try_server;
923: $lowest_load = $load;
1.370 albertel 924: }
1.784 albertel 925: return ($spare_server,$lowest_load);
1.202 matthew 926: }
1.914 albertel 927:
928: # --------------------------- ask offload servers if user already has a session
929: sub find_existing_session {
930: my ($udom,$uname) = @_;
1.1123 raeburn 931: my $spareshash = &this_host_spares($udom);
932: if (ref($spareshash) eq 'HASH') {
933: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
934: foreach my $try_server (@{ $spareshash->{'primary'} }) {
935: return $try_server if (&has_user_session($try_server, $udom, $uname));
936: }
937: }
938: if (ref($spareshash->{'default'}) eq 'ARRAY') {
939: foreach my $try_server (@{ $spareshash->{'default'} }) {
940: return $try_server if (&has_user_session($try_server, $udom, $uname));
941: }
942: }
1.914 albertel 943: }
944: return;
945: }
946:
947: # -------------------------------- ask if server already has a session for user
948: sub has_user_session {
949: my ($lonid,$udom,$uname) = @_;
950: my $result = &reply(join(':','userhassession',
951: map {&escape($_)} ($udom,$uname)),$lonid);
952: return 1 if ($result eq 'ok');
953:
954: return 0;
955: }
956:
1.1076 raeburn 957: # --------- determine least loaded server in a user's domain which allows login
958:
959: sub choose_server {
1.1259 raeburn 960: my ($udom,$checkloginvia,$required,$skiploadbal) = @_;
1.1076 raeburn 961: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 962: my %servers = &get_servers($udom);
1.1076 raeburn 963: my $lowest_load = 30000;
1.1259 raeburn 964: my ($login_host,$hostname,$portal_path,$isredirect,$balancers);
965: if ($skiploadbal) {
966: ($balancers,my $cached)=&is_cached_new('loadbalancing',$udom);
967: unless (defined($cached)) {
968: my $cachetime = 60*60*24;
969: my %domconfig =
970: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
971: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
972: $balancers = &do_cache_new('loadbalancing',$udom,$domconfig{'loadbalancing'},
973: $cachetime);
974: }
975: }
976: }
1.1076 raeburn 977: foreach my $lonhost (keys(%servers)) {
1.1259 raeburn 978: if ($skiploadbal) {
979: if (ref($balancers) eq 'HASH') {
980: next if (exists($balancers->{$lonhost}));
981: }
982: }
1.1115 raeburn 983: my $loginvia;
984: if ($checkloginvia) {
985: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 986: if ($loginvia) {
987: my ($server,$path) = split(/:/,$loginvia);
988: ($login_host, $lowest_load) =
1.1253 raeburn 989: &compare_server_load($server, $login_host, $lowest_load, $required);
1.1116 raeburn 990: if ($login_host eq $server) {
991: $portal_path = $path;
1.1151 raeburn 992: $isredirect = 1;
1.1116 raeburn 993: }
994: } else {
995: ($login_host, $lowest_load) =
1.1253 raeburn 996: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1116 raeburn 997: if ($login_host eq $lonhost) {
998: $portal_path = '';
1.1151 raeburn 999: $isredirect = '';
1.1116 raeburn 1000: }
1001: }
1002: } else {
1.1076 raeburn 1003: ($login_host, $lowest_load) =
1.1253 raeburn 1004: &compare_server_load($lonhost, $login_host, $lowest_load, $required);
1.1076 raeburn 1005: }
1006: }
1007: if ($login_host ne '') {
1.1116 raeburn 1008: $hostname = &hostname($login_host);
1.1076 raeburn 1009: }
1.1151 raeburn 1010: return ($login_host,$hostname,$portal_path,$isredirect);
1.1076 raeburn 1011: }
1012:
1.202 matthew 1013: # --------------------------------------------- Try to change a user's password
1014:
1015: sub changepass {
1.799 raeburn 1016: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 1017: $currentpass = &escape($currentpass);
1018: $newpass = &escape($newpass);
1.1030 raeburn 1019: my $lonhost = $perlvar{'lonHostID'};
1020: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 1021: $server);
1022: if (! $answer) {
1023: &logthis("No reply on password change request to $server ".
1024: "by $uname in domain $udom.");
1025: } elsif ($answer =~ "^ok") {
1026: &logthis("$uname in $udom successfully changed their password ".
1027: "on $server.");
1028: } elsif ($answer =~ "^pwchange_failure") {
1029: &logthis("$uname in $udom was unable to change their password ".
1030: "on $server. The action was blocked by either lcpasswd ".
1031: "or pwchange");
1032: } elsif ($answer =~ "^non_authorized") {
1033: &logthis("$uname in $udom did not get their password correct when ".
1034: "attempting to change it on $server.");
1035: } elsif ($answer =~ "^auth_mode_error") {
1036: &logthis("$uname in $udom attempted to change their password despite ".
1037: "not being locally or internally authenticated on $server.");
1038: } elsif ($answer =~ "^unknown_user") {
1039: &logthis("$uname in $udom attempted to change their password ".
1040: "on $server but were unable to because $server is not ".
1041: "their home server.");
1042: } elsif ($answer =~ "^refused") {
1043: &logthis("$server refused to change $uname in $udom password because ".
1044: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1045: } elsif ($answer =~ "invalid_client") {
1046: &logthis("$server refused to change $uname in $udom password because ".
1047: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 1048: }
1049: return $answer;
1.1 albertel 1050: }
1051:
1.169 harris41 1052: # ----------------------- Try to determine user's current authentication scheme
1053:
1054: sub queryauthenticate {
1055: my ($uname,$udom)=@_;
1.456 albertel 1056: my $uhome=&homeserver($uname,$udom);
1057: if (!$uhome) {
1058: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1059: return 'no_host';
1060: }
1061: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1062: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1063: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1064: }
1.456 albertel 1065: return $answer;
1.169 harris41 1066: }
1067:
1.1 albertel 1068: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1069:
1.1 albertel 1070: sub authenticate {
1.1073 raeburn 1071: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1072: $upass=&escape($upass);
1073: $uname= &LONCAPA::clean_username($uname);
1.836 www 1074: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1075: my $newhome;
1.836 www 1076: if ((!$uhome) || ($uhome eq 'no_host')) {
1077: # Maybe the machine was offline and only re-appeared again recently?
1078: &reconlonc();
1079: # One more
1.952 raeburn 1080: $uhome=&homeserver($uname,$udom,1);
1081: if (($uhome eq 'no_host') && $checkdefauth) {
1082: if (defined(&domain($udom,'primary'))) {
1083: $newhome=&domain($udom,'primary');
1084: }
1085: if ($newhome ne '') {
1086: $uhome = $newhome;
1087: }
1088: }
1.836 www 1089: if ((!$uhome) || ($uhome eq 'no_host')) {
1090: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1091: return 'no_host';
1092: }
1.1 albertel 1093: }
1.1073 raeburn 1094: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1095: if ($answer eq 'authorized') {
1.952 raeburn 1096: if ($newhome) {
1097: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1098: return 'no_account_on_host';
1099: } else {
1100: &logthis("User $uname at $udom authorized by $uhome");
1101: return $uhome;
1102: }
1.471 albertel 1103: }
1104: if ($answer eq 'non_authorized') {
1105: &logthis("User $uname at $udom rejected by $uhome");
1106: return 'no_host';
1.9 www 1107: }
1.471 albertel 1108: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1109: return 'no_host';
1110: }
1111:
1.1073 raeburn 1112: sub can_host_session {
1.1074 raeburn 1113: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1114: my $canhost = 1;
1.1074 raeburn 1115: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1116: if (ref($remotesessions) eq 'HASH') {
1117: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1118: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1119: $canhost = 0;
1120: } else {
1121: $canhost = 1;
1122: }
1123: }
1124: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1125: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1126: $canhost = 1;
1127: } else {
1128: $canhost = 0;
1129: }
1130: }
1131: if ($canhost) {
1132: if ($remotesessions->{'version'} ne '') {
1133: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1134: if ($reqmajor ne '' && $reqminor ne '') {
1135: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1136: my $major = $1;
1137: my $minor = $2;
1138: if (($major < $reqmajor ) ||
1139: (($major == $reqmajor) && ($minor < $reqminor))) {
1140: $canhost = 0;
1141: }
1142: } else {
1143: $canhost = 0;
1144: }
1145: }
1146: }
1147: }
1148: }
1149: if ($canhost) {
1150: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1151: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1152: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1153: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1154: if (($uint_dom ne '') &&
1155: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1156: $canhost = 0;
1157: } else {
1158: $canhost = 1;
1159: }
1160: }
1161: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1162: if (($uint_dom ne '') &&
1163: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1164: $canhost = 1;
1165: } else {
1166: $canhost = 0;
1167: }
1168: }
1169: }
1170: }
1171: return $canhost;
1172: }
1173:
1.1083 raeburn 1174: sub spare_can_host {
1175: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1176: my $canhost=1;
1.1279 raeburn 1177: my $try_server_hostname = &hostname($try_server);
1178: my $serverhomeID = &get_server_homeID($try_server_hostname);
1179: my $serverhomedom = &host_domain($serverhomeID);
1180: my %defdomdefaults = &get_domain_defaults($serverhomedom);
1181: if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
1182: if ($defdomdefaults{'offloadnow'}{$try_server}) {
1183: $canhost = 0;
1184: }
1185: }
1186: if (($canhost) && ($uint_dom)) {
1187: my @intdoms;
1188: my $internet_names = &get_internet_names($try_server);
1189: if (ref($internet_names) eq 'ARRAY') {
1190: @intdoms = @{$internet_names};
1191: }
1192: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1193: my $remoterev = &get_server_loncaparev(undef,$try_server);
1194: $canhost = &can_host_session($udom,$try_server,$remoterev,
1195: $remotesessions,
1196: $defdomdefaults{'hostedsessions'});
1197: }
1.1083 raeburn 1198: }
1199: return $canhost;
1200: }
1201:
1.1123 raeburn 1202: sub this_host_spares {
1203: my ($dom) = @_;
1.1126 raeburn 1204: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1205: my @hosts = ¤t_machine_ids();
1206: foreach my $lonhost (@hosts) {
1207: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1208: $dom_in_use = $dom;
1209: $lonhost_in_use = $lonhost;
1.1123 raeburn 1210: last;
1211: }
1212: }
1.1126 raeburn 1213: if ($dom_in_use ne '') {
1214: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1215: }
1216: if (ref($result) ne 'HASH') {
1217: $lonhost_in_use = $perlvar{'lonHostID'};
1218: $dom_in_use = &host_domain($lonhost_in_use);
1219: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1220: if (ref($result) ne 'HASH') {
1221: $result = \%spareid;
1222: }
1223: }
1224: return $result;
1225: }
1226:
1227: sub spares_for_offload {
1228: my ($dom_in_use,$lonhost_in_use) = @_;
1229: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1230: if (defined($cached)) {
1231: return $result;
1232: } else {
1.1126 raeburn 1233: my $cachetime = 60*60*24;
1234: my %domconfig =
1235: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1236: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1237: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1238: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1239: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1240: }
1241: }
1242: }
1243: }
1.1126 raeburn 1244: return;
1.1123 raeburn 1245: }
1246:
1.1129 raeburn 1247: sub get_lonbalancer_config {
1248: my ($servers) = @_;
1249: my ($currbalancer,$currtargets);
1250: if (ref($servers) eq 'HASH') {
1251: foreach my $server (keys(%{$servers})) {
1252: my %what = (
1253: spareid => 1,
1254: perlvar => 1,
1255: );
1256: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1257: if ($result eq 'ok') {
1258: if (ref($returnhash) eq 'HASH') {
1259: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1260: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1261: $currbalancer = $server;
1262: $currtargets = {};
1263: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1264: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1265: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1266: }
1267: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1268: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1269: }
1270: }
1271: last;
1272: }
1273: }
1274: }
1275: }
1276: }
1277: }
1278: return ($currbalancer,$currtargets);
1279: }
1280:
1281: sub check_loadbalancing {
1282: my ($uname,$udom) = @_;
1.1191 raeburn 1283: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1284: $rule_in_effect,$offloadto,$otherserver);
1.1129 raeburn 1285: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1286: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1287: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1288: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1289: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1290: my $serverhomedom = &host_domain($lonhost);
1291:
1292: my $cachetime = 60*60*24;
1293:
1294: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1295: $dom_in_use = $udom;
1296: $homeintdom = 1;
1297: } else {
1298: $dom_in_use = $serverhomedom;
1299: }
1300: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1301: unless (defined($cached)) {
1302: my %domconfig =
1303: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1304: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1305: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129 raeburn 1306: }
1307: }
1308: if (ref($result) eq 'HASH') {
1.1191 raeburn 1309: ($is_balancer,$currtargets,$currrules) =
1310: &check_balancer_result($result,@hosts);
1.1129 raeburn 1311: if ($is_balancer) {
1312: if (ref($currrules) eq 'HASH') {
1313: if ($homeintdom) {
1314: if ($uname ne '') {
1315: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1316: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1317: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1318: $rule_in_effect = $currrules->{'_LC_author'};
1319: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1320: $rule_in_effect = $currrules->{'_LC_adv'}
1321: }
1322: }
1323: if ($rule_in_effect eq '') {
1324: my %userenv = &userenvironment($udom,$uname,'inststatus');
1325: if ($userenv{'inststatus'} ne '') {
1326: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1327: my ($othertitle,$usertypes,$types) =
1328: &Apache::loncommon::sorted_inst_types($udom);
1329: if (ref($types) eq 'ARRAY') {
1330: foreach my $type (@{$types}) {
1331: if (grep(/^\Q$type\E$/,@statuses)) {
1332: if (exists($currrules->{$type})) {
1333: $rule_in_effect = $currrules->{$type};
1334: }
1335: }
1336: }
1337: }
1338: } else {
1339: if (exists($currrules->{'default'})) {
1340: $rule_in_effect = $currrules->{'default'};
1341: }
1342: }
1343: }
1344: } else {
1345: if (exists($currrules->{'default'})) {
1346: $rule_in_effect = $currrules->{'default'};
1347: }
1348: }
1349: } else {
1350: if ($currrules->{'_LC_external'} ne '') {
1351: $rule_in_effect = $currrules->{'_LC_external'};
1352: }
1353: }
1354: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1355: $uname,$udom);
1356: }
1357: }
1358: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1.1239 raeburn 1359: ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1.1129 raeburn 1360: unless (defined($cached)) {
1361: my %domconfig =
1362: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1363: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1364: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129 raeburn 1365: }
1366: }
1367: if (ref($result) eq 'HASH') {
1.1191 raeburn 1368: ($is_balancer,$currtargets,$currrules) =
1369: &check_balancer_result($result,@hosts);
1370: if ($is_balancer) {
1.1129 raeburn 1371: if (ref($currrules) eq 'HASH') {
1372: if ($currrules->{'_LC_internetdom'} ne '') {
1373: $rule_in_effect = $currrules->{'_LC_internetdom'};
1374: }
1375: }
1376: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1377: $uname,$udom);
1378: }
1379: } else {
1380: if ($perlvar{'lonBalancer'} eq 'yes') {
1381: $is_balancer = 1;
1382: $offloadto = &this_host_spares($dom_in_use);
1383: }
1384: }
1385: } else {
1386: if ($perlvar{'lonBalancer'} eq 'yes') {
1387: $is_balancer = 1;
1388: $offloadto = &this_host_spares($dom_in_use);
1389: }
1390: }
1.1176 raeburn 1391: if ($is_balancer) {
1392: my $lowest_load = 30000;
1393: if (ref($offloadto) eq 'HASH') {
1394: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1395: foreach my $try_server (@{$offloadto->{'primary'}}) {
1396: ($otherserver,$lowest_load) =
1397: &compare_server_load($try_server,$otherserver,$lowest_load);
1398: }
1.1129 raeburn 1399: }
1.1176 raeburn 1400: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1401:
1.1176 raeburn 1402: if (!$found_server) {
1403: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1404: foreach my $try_server (@{$offloadto->{'default'}}) {
1405: ($otherserver,$lowest_load) =
1406: &compare_server_load($try_server,$otherserver,$lowest_load);
1407: }
1408: }
1409: }
1410: } elsif (ref($offloadto) eq 'ARRAY') {
1411: if (@{$offloadto} == 1) {
1412: $otherserver = $offloadto->[0];
1413: } elsif (@{$offloadto} > 1) {
1414: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1415: ($otherserver,$lowest_load) =
1416: &compare_server_load($try_server,$otherserver,$lowest_load);
1417: }
1418: }
1419: }
1.1176 raeburn 1420: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1421: $is_balancer = 0;
1422: if ($uname ne '' && $udom ne '') {
1423: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1424:
1425: &appenv({'user.loadbalexempt' => $lonhost,
1426: 'user.loadbalcheck.time' => time});
1427: }
1.1129 raeburn 1428: }
1429: }
1430: }
1431: return ($is_balancer,$otherserver);
1432: }
1433:
1.1191 raeburn 1434: sub check_balancer_result {
1435: my ($result,@hosts) = @_;
1436: my ($is_balancer,$currtargets,$currrules);
1437: if (ref($result) eq 'HASH') {
1438: if ($result->{'lonhost'} ne '') {
1439: my $currbalancer = $result->{'lonhost'};
1440: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1441: $is_balancer = 1;
1442: $currtargets = $result->{'targets'};
1443: $currrules = $result->{'rules'};
1444: }
1445: } else {
1446: foreach my $key (keys(%{$result})) {
1447: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1448: (ref($result->{$key}) eq 'HASH')) {
1449: $is_balancer = 1;
1450: $currrules = $result->{$key}{'rules'};
1451: $currtargets = $result->{$key}{'targets'};
1452: last;
1453: }
1454: }
1455: }
1456: }
1457: return ($is_balancer,$currtargets,$currrules);
1458: }
1459:
1.1129 raeburn 1460: sub get_loadbalancer_targets {
1461: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1462: my $offloadto;
1.1175 raeburn 1463: if ($rule_in_effect eq 'none') {
1464: return [$perlvar{'lonHostID'}];
1465: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1466: $offloadto = $currtargets;
1467: } else {
1468: if ($rule_in_effect eq 'homeserver') {
1469: my $homeserver = &homeserver($uname,$udom);
1470: if ($homeserver ne 'no_host') {
1471: $offloadto = [$homeserver];
1472: }
1473: } elsif ($rule_in_effect eq 'externalbalancer') {
1474: my %domconfig =
1475: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1476: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1477: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1478: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1479: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1480: }
1481: }
1482: } else {
1.1178 raeburn 1483: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1484: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1485: if (&hostname($remotebalancer) ne '') {
1486: $offloadto = [$remotebalancer];
1487: }
1488: }
1489: } elsif (&hostname($rule_in_effect) ne '') {
1490: $offloadto = [$rule_in_effect];
1491: }
1492: }
1493: return $offloadto;
1494: }
1495:
1.1127 raeburn 1496: sub internet_dom_servers {
1497: my ($dom) = @_;
1498: my (%uniqservers,%servers);
1499: my $primaryserver = &hostname(&domain($dom,'primary'));
1500: my @machinedoms = &machine_domains($primaryserver);
1501: foreach my $mdom (@machinedoms) {
1502: my %currservers = %servers;
1503: my %server = &get_servers($mdom);
1504: %servers = (%currservers,%server);
1505: }
1506: my %by_hostname;
1507: foreach my $id (keys(%servers)) {
1508: push(@{$by_hostname{$servers{$id}}},$id);
1509: }
1510: foreach my $hostname (sort(keys(%by_hostname))) {
1511: if (@{$by_hostname{$hostname}} > 1) {
1512: my $match = 0;
1513: foreach my $id (@{$by_hostname{$hostname}}) {
1514: if (&host_domain($id) eq $dom) {
1515: $uniqservers{$id} = $hostname;
1516: $match = 1;
1517: }
1518: }
1519: unless ($match) {
1520: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1521: }
1522: } else {
1523: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1524: }
1525: }
1526: return %uniqservers;
1527: }
1528:
1.1 albertel 1529: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1530:
1.599 albertel 1531: my %homecache;
1.1 albertel 1532: sub homeserver {
1.230 stredwic 1533: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1534: my $index="$uname:$udom";
1.426 albertel 1535:
1.599 albertel 1536: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1537:
1538: my %servers = &get_servers($udom,'library');
1539: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1540: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1541: exists($badServerCache{$tryserver}));
1.841 albertel 1542:
1543: my $answer=reply("home:$udom:$uname",$tryserver);
1544: if ($answer eq 'found') {
1545: delete($badServerCache{$tryserver});
1546: return $homecache{$index}=$tryserver;
1547: } elsif ($answer eq 'no_host') {
1548: $badServerCache{$tryserver}=1;
1549: }
1.1 albertel 1550: }
1551: return 'no_host';
1.70 www 1552: }
1553:
1554: # ------------------------------------- Find the usernames behind a list of IDs
1555:
1556: sub idget {
1557: my ($udom,@ids)=@_;
1558: my %returnhash=();
1559:
1.841 albertel 1560: my %servers = &get_servers($udom,'library');
1561: foreach my $tryserver (keys(%servers)) {
1562: my $idlist=join('&',@ids);
1563: $idlist=~tr/A-Z/a-z/;
1564: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1565: my @answer=();
1566: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1567: @answer=split(/\&/,$reply);
1568: } ;
1569: my $i;
1570: for ($i=0;$i<=$#ids;$i++) {
1571: if ($answer[$i]) {
1572: $returnhash{$ids[$i]}=$answer[$i];
1573: }
1574: }
1575: }
1.70 www 1576: return %returnhash;
1577: }
1578:
1579: # ------------------------------------- Find the IDs behind a list of usernames
1580:
1581: sub idrget {
1582: my ($udom,@unames)=@_;
1583: my %returnhash=();
1.800 albertel 1584: foreach my $uname (@unames) {
1585: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1586: }
1.70 www 1587: return %returnhash;
1588: }
1589:
1590: # ------------------------------- Store away a list of names and associated IDs
1591:
1592: sub idput {
1593: my ($udom,%ids)=@_;
1594: my %servers=();
1.800 albertel 1595: foreach my $uname (keys(%ids)) {
1596: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1597: my $uhom=&homeserver($uname,$udom);
1.70 www 1598: if ($uhom ne 'no_host') {
1.800 albertel 1599: my $id=&escape($ids{$uname});
1.70 www 1600: $id=~tr/A-Z/a-z/;
1.800 albertel 1601: my $esc_unam=&escape($uname);
1.70 www 1602: if ($servers{$uhom}) {
1.800 albertel 1603: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 1604: } else {
1.800 albertel 1605: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 1606: }
1607: }
1.191 harris41 1608: }
1.800 albertel 1609: foreach my $server (keys(%servers)) {
1610: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 1611: }
1.344 www 1612: }
1613:
1.1231 raeburn 1614: # ---------------------------------------- Delete unwanted IDs from ids.db file
1615:
1616: sub iddel {
1617: my ($udom,$idshashref,$uhome)=@_;
1618: my %result=();
1619: unless (ref($idshashref) eq 'HASH') {
1620: return %result;
1621: }
1622: my %servers=();
1623: while (my ($id,$uname) = each(%{$idshashref})) {
1624: my $uhom;
1625: if ($uhome) {
1626: $uhom = $uhome;
1627: } else {
1628: $uhom=&homeserver($uname,$udom);
1629: }
1630: if ($uhom ne 'no_host') {
1631: if ($servers{$uhom}) {
1632: $servers{$uhom}.='&'.&escape($id);
1633: } else {
1634: $servers{$uhom}=&escape($id);
1635: }
1636: }
1637: }
1638: foreach my $server (keys(%servers)) {
1639: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1640: }
1641: return %result;
1642: }
1643:
1.1023 raeburn 1644: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 1645: sub dump_dom {
1.1165 droeschl 1646: my ($namespace, $udom, $regexp) = @_;
1647:
1648: $udom ||= $env{'user.domain'};
1649:
1650: return () unless $udom;
1651:
1652: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 1653: }
1654:
1.1023 raeburn 1655: # ------------------------------------------ get items from domain db files
1.806 raeburn 1656:
1657: sub get_dom {
1.860 raeburn 1658: my ($namespace,$storearr,$udom,$uhome)=@_;
1.1267 raeburn 1659: return if ($udom eq 'public');
1.806 raeburn 1660: my $items='';
1661: foreach my $item (@$storearr) {
1662: $items.=&escape($item).'&';
1663: }
1664: $items=~s/\&$//;
1.860 raeburn 1665: if (!$udom) {
1666: $udom=$env{'user.domain'};
1.1267 raeburn 1667: return if ($udom eq 'public');
1.860 raeburn 1668: if (defined(&domain($udom,'primary'))) {
1669: $uhome=&domain($udom,'primary');
1670: } else {
1.874 albertel 1671: undef($uhome);
1.860 raeburn 1672: }
1673: } else {
1674: if (!$uhome) {
1675: if (defined(&domain($udom,'primary'))) {
1676: $uhome=&domain($udom,'primary');
1677: }
1678: }
1679: }
1680: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1681: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 1682: my %returnhash;
1.875 albertel 1683: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1684: return %returnhash;
1685: }
1.806 raeburn 1686: my @pairs=split(/\&/,$rep);
1687: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1688: return @pairs;
1689: }
1690: my $i=0;
1691: foreach my $item (@$storearr) {
1692: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1693: $i++;
1694: }
1695: return %returnhash;
1696: } else {
1.880 banghart 1697: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1698: }
1699: }
1700:
1701: # -------------------------------------------- put items in domain db files
1702:
1703: sub put_dom {
1.860 raeburn 1704: my ($namespace,$storehash,$udom,$uhome)=@_;
1705: if (!$udom) {
1706: $udom=$env{'user.domain'};
1707: if (defined(&domain($udom,'primary'))) {
1708: $uhome=&domain($udom,'primary');
1709: } else {
1.874 albertel 1710: undef($uhome);
1.860 raeburn 1711: }
1712: } else {
1713: if (!$uhome) {
1714: if (defined(&domain($udom,'primary'))) {
1715: $uhome=&domain($udom,'primary');
1716: }
1717: }
1718: }
1719: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1720: my $items='';
1721: foreach my $item (keys(%$storehash)) {
1722: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1723: }
1724: $items=~s/\&$//;
1725: return &reply("putdom:$udom:$namespace:$items",$uhome);
1726: } else {
1.860 raeburn 1727: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1728: }
1729: }
1730:
1.1023 raeburn 1731: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 1732: sub newput_dom {
1.1023 raeburn 1733: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 1734: my $result;
1735: if (!$udom) {
1736: $udom=$env{'user.domain'};
1737: }
1.1023 raeburn 1738: if ($udom) {
1739: my $uname = &get_domainconfiguser($udom);
1740: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 1741: }
1742: return $result;
1743: }
1744:
1.1023 raeburn 1745: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 1746: sub del_dom {
1.1023 raeburn 1747: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 1748: if (ref($storearr) eq 'ARRAY') {
1749: if (!$udom) {
1750: $udom=$env{'user.domain'};
1751: }
1.1023 raeburn 1752: if ($udom) {
1753: my $uname = &get_domainconfiguser($udom);
1754: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 1755: }
1756: }
1757: }
1758:
1.1023 raeburn 1759: # ----------------------------------construct domainconfig user for a domain
1760: sub get_domainconfiguser {
1761: my ($udom) = @_;
1762: return $udom.'-domainconfig';
1763: }
1764:
1.837 raeburn 1765: sub retrieve_inst_usertypes {
1766: my ($udom) = @_;
1767: my (%returnhash,@order);
1.989 raeburn 1768: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1769: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1770: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1.1256 raeburn 1771: return ($domdefs{'inststatustypes'},$domdefs{'inststatusorder'});
1.989 raeburn 1772: } else {
1773: if (defined(&domain($udom,'primary'))) {
1774: my $uhome=&domain($udom,'primary');
1775: my $rep=&reply("inst_usertypes:$udom",$uhome);
1776: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1.1256 raeburn 1777: &logthis("retrieve_inst_usertypes failed - $rep returned from $uhome in domain: $udom");
1.989 raeburn 1778: return (\%returnhash,\@order);
1779: }
1780: my ($hashitems,$orderitems) = split(/:/,$rep);
1781: my @pairs=split(/\&/,$hashitems);
1782: foreach my $item (@pairs) {
1783: my ($key,$value)=split(/=/,$item,2);
1784: $key = &unescape($key);
1785: next if ($key =~ /^error: 2 /);
1786: $returnhash{$key}=&thaw_unescape($value);
1787: }
1788: my @esc_order = split(/\&/,$orderitems);
1789: foreach my $item (@esc_order) {
1790: push(@order,&unescape($item));
1791: }
1792: } else {
1.1256 raeburn 1793: &logthis("retrieve_inst_usertypes failed - no primary domain server for $udom");
1.837 raeburn 1794: }
1.1256 raeburn 1795: return (\%returnhash,\@order);
1.837 raeburn 1796: }
1797: }
1798:
1.868 raeburn 1799: sub is_domainimage {
1800: my ($url) = @_;
1801: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1802: if (&domain($1) ne '') {
1803: return '1';
1804: }
1805: }
1806: return;
1807: }
1808:
1.899 raeburn 1809: sub inst_directory_query {
1810: my ($srch) = @_;
1811: my $udom = $srch->{'srchdomain'};
1812: my %results;
1813: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1814: my $outcome;
1.899 raeburn 1815: if ($homeserver ne '') {
1.904 albertel 1816: my $queryid=&reply("querysend:instdirsearch:".
1817: &escape($srch->{'srchby'}).':'.
1818: &escape($srch->{'srchterm'}).':'.
1819: &escape($srch->{'srchtype'}),$homeserver);
1820: my $host=&hostname($homeserver);
1821: if ($queryid !~/^\Q$host\E\_/) {
1822: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1823: return;
1824: }
1825: my $response = &get_query_reply($queryid);
1826: my $maxtries = 5;
1827: my $tries = 1;
1828: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1829: $response = &get_query_reply($queryid);
1830: $tries ++;
1831: }
1832:
1833: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1834: if ($response eq 'unavailable') {
1835: $outcome = $response;
1836: } else {
1837: $outcome = 'ok';
1838: my @matches = split(/\n/,$response);
1839: foreach my $match (@matches) {
1840: my ($key,$value) = split(/=/,$match);
1841: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1842: }
1.899 raeburn 1843: }
1844: }
1845: }
1.909 raeburn 1846: return ($outcome,%results);
1.899 raeburn 1847: }
1848:
1849: sub usersearch {
1850: my ($srch) = @_;
1851: my $dom = $srch->{'srchdomain'};
1852: my %results;
1853: my %libserv = &all_library();
1854: my $query = 'usersearch';
1855: foreach my $tryserver (keys(%libserv)) {
1856: if (&host_domain($tryserver) eq $dom) {
1857: my $host=&hostname($tryserver);
1858: my $queryid=
1.911 raeburn 1859: &reply("querysend:".&escape($query).':'.
1860: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1861: &escape($srch->{'srchtype'}).':'.
1862: &escape($srch->{'srchterm'}),$tryserver);
1863: if ($queryid !~/^\Q$host\E\_/) {
1864: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1865: next;
1.899 raeburn 1866: }
1867: my $reply = &get_query_reply($queryid);
1868: my $maxtries = 1;
1869: my $tries = 1;
1870: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1871: $reply = &get_query_reply($queryid);
1872: $tries ++;
1873: }
1874: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1875: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1876: } else {
1.911 raeburn 1877: my @matches;
1878: if ($reply =~ /\n/) {
1879: @matches = split(/\n/,$reply);
1880: } else {
1881: @matches = split(/\&/,$reply);
1882: }
1.899 raeburn 1883: foreach my $match (@matches) {
1884: my ($uname,$udom,%userhash);
1.911 raeburn 1885: foreach my $entry (split(/:/,$match)) {
1886: my ($key,$value) =
1887: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1888: $userhash{$key} = $value;
1889: if ($key eq 'username') {
1890: $uname = $value;
1891: } elsif ($key eq 'domain') {
1892: $udom = $value;
1.911 raeburn 1893: }
1.899 raeburn 1894: }
1895: $results{$uname.':'.$udom} = \%userhash;
1896: }
1897: }
1898: }
1899: }
1900: return %results;
1901: }
1902:
1.912 raeburn 1903: sub get_instuser {
1904: my ($udom,$uname,$id) = @_;
1905: my $homeserver = &domain($udom,'primary');
1906: my ($outcome,%results);
1907: if ($homeserver ne '') {
1908: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1909: &escape($id).':'.&escape($udom),$homeserver);
1910: my $host=&hostname($homeserver);
1911: if ($queryid !~/^\Q$host\E\_/) {
1912: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1913: return;
1914: }
1915: my $response = &get_query_reply($queryid);
1916: my $maxtries = 5;
1917: my $tries = 1;
1918: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1919: $response = &get_query_reply($queryid);
1920: $tries ++;
1921: }
1922: if (!&error($response) && $response ne 'refused') {
1923: if ($response eq 'unavailable') {
1924: $outcome = $response;
1925: } else {
1926: $outcome = 'ok';
1927: my @matches = split(/\n/,$response);
1928: foreach my $match (@matches) {
1929: my ($key,$value) = split(/=/,$match);
1930: $results{&unescape($key)} = &thaw_unescape($value);
1931: }
1932: }
1933: }
1934: }
1935: my %userinfo;
1936: if (ref($results{$uname}) eq 'HASH') {
1937: %userinfo = %{$results{$uname}};
1938: }
1939: return ($outcome,%userinfo);
1940: }
1941:
1.1290 raeburn 1942: sub get_multiple_instusers {
1943: my ($udom,$users,$caller) = @_;
1944: my ($outcome,$results);
1945: if (ref($users) eq 'HASH') {
1946: my $count = keys(%{$users});
1947: my $requested = &freeze_escape($users);
1948: my $homeserver = &domain($udom,'primary');
1949: if ($homeserver ne '') {
1950: my $queryid=&reply('querysend:getmultinstusers:::'.$caller.'='.$requested,$homeserver);
1951: my $host=&hostname($homeserver);
1952: if ($queryid !~/^\Q$host\E\_/) {
1953: &logthis('get_multiple_instusers invalid queryid: '.$queryid.
1954: ' for host: '.$homeserver.'in domain '.$udom);
1955: return ($outcome,$results);
1956: }
1957: my $response = &get_query_reply($queryid);
1958: my $maxtries = 5;
1959: if ($count > 100) {
1960: $maxtries = 1+int($count/20);
1961: }
1962: my $tries = 1;
1963: while (($response=~/^timeout/) && ($tries <= $maxtries)) {
1964: $response = &get_query_reply($queryid);
1965: $tries ++;
1966: }
1967: if ($response eq '') {
1968: $results = {};
1969: foreach my $key (keys(%{$users})) {
1970: my ($uname,$id);
1971: if ($caller eq 'id') {
1972: $id = $key;
1973: } else {
1974: $uname = $key;
1975: }
1976: my ($resp,%info) = &get_instuser($udom,$uname,$id);
1.1291 raeburn 1977: $outcome = $resp;
1.1290 raeburn 1978: if ($resp eq 'ok') {
1979: %{$results} = (%{$results}, %info);
1980: } else {
1981: last;
1982: }
1983: }
1984: } elsif(!&error($response) && ($response ne 'refused')) {
1985: if (($response eq 'unavailable') || ($response eq 'invalid') || ($response eq 'timeout')) {
1986: $outcome = $response;
1987: } else {
1.1291 raeburn 1988: ($outcome,my $userdata) = split(/=/,$response,2);
1.1290 raeburn 1989: if ($outcome eq 'ok') {
1990: $results = &thaw_unescape($userdata);
1991: }
1992: }
1993: }
1994: }
1995: }
1996: return ($outcome,$results);
1997: }
1998:
1.912 raeburn 1999: sub inst_rulecheck {
1.923 raeburn 2000: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 2001: my %returnhash;
2002: if ($udom ne '') {
2003: if (ref($rules) eq 'ARRAY') {
2004: @{$rules} = map {&escape($_);} (@{$rules});
2005: my $rulestr = join(':',@{$rules});
2006: my $homeserver=&domain($udom,'primary');
2007: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2008: my $response;
2009: if ($item eq 'username') {
2010: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
2011: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 2012: $homeserver));
1.923 raeburn 2013: } elsif ($item eq 'id') {
2014: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
2015: ':'.&escape($id).':'.$rulestr,
2016: $homeserver));
1.945 raeburn 2017: } elsif ($item eq 'selfcreate') {
2018: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 2019: &escape($udom).':'.&escape($uname).
2020: ':'.$rulestr,$homeserver));
1.923 raeburn 2021: }
1.912 raeburn 2022: if ($response ne 'refused') {
2023: my @pairs=split(/\&/,$response);
2024: foreach my $item (@pairs) {
2025: my ($key,$value)=split(/=/,$item,2);
2026: $key = &unescape($key);
2027: next if ($key =~ /^error: 2 /);
2028: $returnhash{$key}=&thaw_unescape($value);
2029: }
2030: }
2031: }
2032: }
2033: }
2034: return %returnhash;
2035: }
2036:
2037: sub inst_userrules {
1.923 raeburn 2038: my ($udom,$check) = @_;
1.912 raeburn 2039: my (%ruleshash,@ruleorder);
2040: if ($udom ne '') {
2041: my $homeserver=&domain($udom,'primary');
2042: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 2043: my $response;
2044: if ($check eq 'id') {
2045: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 2046: $homeserver);
1.943 raeburn 2047: } elsif ($check eq 'email') {
2048: $response=&reply('instemailrules:'.&escape($udom),
2049: $homeserver);
1.923 raeburn 2050: } else {
2051: $response=&reply('instuserrules:'.&escape($udom),
2052: $homeserver);
2053: }
1.912 raeburn 2054: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 2055: ($response ne 'unknown_cmd') &&
1.912 raeburn 2056: ($response ne 'no_such_host')) {
2057: my ($hashitems,$orderitems) = split(/:/,$response);
2058: my @pairs=split(/\&/,$hashitems);
2059: foreach my $item (@pairs) {
2060: my ($key,$value)=split(/=/,$item,2);
2061: $key = &unescape($key);
2062: next if ($key =~ /^error: 2 /);
2063: $ruleshash{$key}=&thaw_unescape($value);
2064: }
2065: my @esc_order = split(/\&/,$orderitems);
2066: foreach my $item (@esc_order) {
2067: push(@ruleorder,&unescape($item));
2068: }
2069: }
2070: }
2071: }
2072: return (\%ruleshash,\@ruleorder);
2073: }
2074:
1.976 raeburn 2075: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 2076:
2077: sub get_domain_defaults {
1.1240 raeburn 2078: my ($domain,$ignore_cache) = @_;
1.1242 raeburn 2079: return if (($domain eq '') || ($domain eq 'public'));
1.943 raeburn 2080: my $cachetime = 60*60*24;
1.1240 raeburn 2081: unless ($ignore_cache) {
2082: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
2083: if (defined($cached)) {
2084: if (ref($result) eq 'HASH') {
2085: return %{$result};
2086: }
1.943 raeburn 2087: }
2088: }
2089: my %domdefaults;
2090: my %domconfig =
1.989 raeburn 2091: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 2092: 'requestcourses','inststatus',
1.1183 raeburn 2093: 'coursedefaults','usersessions',
1.1258 raeburn 2094: 'requestauthor','selfenrollment',
2095: 'coursecategories'],$domain);
1.1254 raeburn 2096: my @coursetypes = ('official','unofficial','community','textbook');
1.943 raeburn 2097: if (ref($domconfig{'defaults'}) eq 'HASH') {
2098: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2099: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2100: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2101: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2102: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2103: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.943 raeburn 2104: } else {
2105: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2106: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2107: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2108: }
1.976 raeburn 2109: if (ref($domconfig{'quotas'}) eq 'HASH') {
2110: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2111: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2112: } else {
2113: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2114: }
1.1177 raeburn 2115: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2116: foreach my $item (@usertools) {
2117: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2118: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2119: }
2120: }
1.1229 raeburn 2121: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2122: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2123: }
1.976 raeburn 2124: }
1.985 raeburn 2125: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1246 raeburn 2126: foreach my $item ('official','unofficial','community','textbook') {
1.985 raeburn 2127: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2128: }
2129: }
1.1183 raeburn 2130: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2131: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2132: }
1.989 raeburn 2133: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1.1256 raeburn 2134: foreach my $item ('inststatustypes','inststatusorder','inststatusguest') {
1.989 raeburn 2135: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2136: }
2137: }
1.1047 raeburn 2138: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2139: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1277 raeburn 2140: $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
2141: $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
2142: if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
2143: $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
2144: }
1.1254 raeburn 2145: foreach my $type (@coursetypes) {
2146: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2147: unless ($type eq 'community') {
2148: $domdefaults{$type.'credits'} = $domconfig{'coursedefaults'}{'coursecredits'}{$type};
2149: }
2150: }
2151: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2152: $domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
2153: }
1.1277 raeburn 2154: if ($domdefaults{'postsubmit'} eq 'on') {
2155: if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
2156: $domdefaults{$type.'postsubtimeout'} =
2157: $domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
2158: }
2159: }
1.1230 raeburn 2160: }
1.1286 raeburn 2161: if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
2162: if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
2163: my @clonecodes = @{$domconfig{'coursedefaults'}{'canclone'}{'instcode'}};
2164: if (@clonecodes) {
2165: $domdefaults{'canclone'} = join('+',@clonecodes);
2166: }
2167: }
2168: } elsif ($domconfig{'coursedefaults'}{'canclone'}) {
2169: $domdefaults{'canclone'}=$domconfig{'coursedefaults'}{'canclone'};
2170: }
1.1047 raeburn 2171: }
1.1073 raeburn 2172: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2173: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2174: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2175: }
2176: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2177: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2178: }
1.1279 raeburn 2179: if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
2180: $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
2181: }
1.1073 raeburn 2182: }
1.1254 raeburn 2183: if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
2184: if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
2185: my @settings = ('types','registered','enroll_dates','access_dates','section',
2186: 'approval','limit');
2187: foreach my $type (@coursetypes) {
2188: if (ref($domconfig{'selfenrollment'}{'admin'}{$type}) eq 'HASH') {
2189: my @mgrdc = ();
2190: foreach my $item (@settings) {
2191: if ($domconfig{'selfenrollment'}{'admin'}{$type}{$item} eq '0') {
2192: push(@mgrdc,$item);
2193: }
2194: }
2195: if (@mgrdc) {
2196: $domdefaults{$type.'selfenrolladmdc'} = join(',',@mgrdc);
2197: }
2198: }
2199: }
2200: }
2201: if (ref($domconfig{'selfenrollment'}{'default'}) eq 'HASH') {
2202: foreach my $type (@coursetypes) {
2203: if (ref($domconfig{'selfenrollment'}{'default'}{$type}) eq 'HASH') {
2204: foreach my $item (keys(%{$domconfig{'selfenrollment'}{'default'}{$type}})) {
2205: $domdefaults{$type.'selfenroll'.$item} = $domconfig{'selfenrollment'}{'default'}{$type}{$item};
2206: }
2207: }
2208: }
2209: }
2210: }
1.1258 raeburn 2211: if (ref($domconfig{'coursecategories'}) eq 'HASH') {
2212: $domdefaults{'catauth'} = 'std';
2213: $domdefaults{'catunauth'} = 'std';
2214: if ($domconfig{'coursecategories'}{'auth'}) {
2215: $domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
2216: }
2217: if ($domconfig{'coursecategories'}{'unauth'}) {
2218: $domdefaults{'catunauth'} = $domconfig{'coursecategories'}{'unauth'};
2219: }
2220: }
1.1219 raeburn 2221: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2222: return %domdefaults;
2223: }
2224:
1.344 www 2225: # --------------------------------------------------- Assign a key to a student
2226:
2227: sub assign_access_key {
1.364 www 2228: #
2229: # a valid key looks like uname:udom#comments
2230: # comments are being appended
2231: #
1.498 www 2232: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2233: $kdom=
1.620 albertel 2234: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2235: $knum=
1.620 albertel 2236: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2237: $cdom=
1.620 albertel 2238: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2239: $cnum=
1.620 albertel 2240: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2241: $udom=$env{'user.name'} unless (defined($udom));
2242: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2243: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2244: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2245: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2246: # assigned to this person
2247: # - this should not happen,
1.345 www 2248: # unless something went wrong
2249: # the first time around
2250: # ready to assign
1.364 www 2251: $logentry=$1.'; '.$logentry;
1.496 www 2252: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2253: $kdom,$knum) eq 'ok') {
1.345 www 2254: # key now belongs to user
1.346 www 2255: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2256: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2257: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2258: return 'ok';
2259: } else {
2260: return
2261: 'error: Count not permanently assign key, will need to be re-entered later.';
2262: }
2263: } else {
2264: return 'error: Could not assign key, try again later.';
2265: }
1.364 www 2266: } elsif (!$existing{$ckey}) {
1.345 www 2267: # the key does not exist
2268: return 'error: The key does not exist';
2269: } else {
2270: # the key is somebody else's
2271: return 'error: The key is already in use';
2272: }
1.344 www 2273: }
2274:
1.364 www 2275: # ------------------------------------------ put an additional comment on a key
2276:
2277: sub comment_access_key {
2278: #
2279: # a valid key looks like uname:udom#comments
2280: # comments are being appended
2281: #
2282: my ($ckey,$cdom,$cnum,$logentry)=@_;
2283: $cdom=
1.620 albertel 2284: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2285: $cnum=
1.620 albertel 2286: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2287: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2288: if ($existing{$ckey}) {
2289: $existing{$ckey}.='; '.$logentry;
2290: # ready to assign
1.367 www 2291: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2292: $cdom,$cnum) eq 'ok') {
2293: return 'ok';
2294: } else {
2295: return 'error: Count not store comment.';
2296: }
2297: } else {
2298: # the key does not exist
2299: return 'error: The key does not exist';
2300: }
2301: }
2302:
1.344 www 2303: # ------------------------------------------------------ Generate a set of keys
2304:
2305: sub generate_access_keys {
1.364 www 2306: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2307: $cdom=
1.620 albertel 2308: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2309: $cnum=
1.620 albertel 2310: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2311: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2312: unless (($cdom) && ($cnum)) { return 0; }
2313: if ($number>10000) { return 0; }
2314: sleep(2); # make sure don't get same seed twice
2315: srand(time()^($$+($$<<15))); # from "Programming Perl"
2316: my $total=0;
2317: for (my $i=1;$i<=$number;$i++) {
2318: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2319: sprintf("%lx",int(100000*rand)).'-'.
2320: sprintf("%lx",int(100000*rand));
2321: $newkey=~s/1/g/g; # folks mix up 1 and l
2322: $newkey=~s/0/h/g; # and also 0 and O
2323: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2324: if ($existing{$newkey}) {
2325: $i--;
2326: } else {
1.364 www 2327: if (&put('accesskeys',
2328: { $newkey => '# generated '.localtime().
1.620 albertel 2329: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 2330: '; '.$logentry },
2331: $cdom,$cnum) eq 'ok') {
1.344 www 2332: $total++;
2333: }
2334: }
2335: }
1.620 albertel 2336: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 2337: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2338: return $total;
2339: }
2340:
2341: # ------------------------------------------------------- Validate an accesskey
2342:
2343: sub validate_access_key {
2344: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2345: $cdom=
1.620 albertel 2346: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2347: $cnum=
1.620 albertel 2348: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2349: $udom=$env{'user.domain'} unless (defined($udom));
2350: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 2351: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 2352: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 2353: }
2354:
2355: # ------------------------------------- Find the section of student in a course
1.652 albertel 2356: sub devalidate_getsection_cache {
2357: my ($udom,$unam,$courseid)=@_;
2358: my $hashid="$udom:$unam:$courseid";
2359: &devalidate_cache_new('getsection',$hashid);
2360: }
1.298 matthew 2361:
1.815 albertel 2362: sub courseid_to_courseurl {
2363: my ($courseid) = @_;
2364: #already url style courseid
2365: return $courseid if ($courseid =~ m{^/});
2366:
2367: if (exists($env{'course.'.$courseid.'.num'})) {
2368: my $cnum = $env{'course.'.$courseid.'.num'};
2369: my $cdom = $env{'course.'.$courseid.'.domain'};
2370: return "/$cdom/$cnum";
2371: }
2372:
2373: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2374: if (exists($courseinfo{'num'})) {
2375: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2376: }
2377:
2378: return undef;
2379: }
2380:
1.298 matthew 2381: sub getsection {
2382: my ($udom,$unam,$courseid)=@_;
1.599 albertel 2383: my $cachetime=1800;
1.551 albertel 2384:
2385: my $hashid="$udom:$unam:$courseid";
1.599 albertel 2386: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 2387: if (defined($cached)) { return $result; }
2388:
1.298 matthew 2389: my %Pending;
2390: my %Expired;
2391: #
2392: # Each role can either have not started yet (pending), be active,
2393: # or have expired.
2394: #
2395: # If there is an active role, we are done.
2396: #
2397: # If there is more than one role which has not started yet,
2398: # choose the one which will start sooner
2399: # If there is one role which has not started yet, return it.
2400: #
2401: # If there is more than one expired role, choose the one which ended last.
2402: # If there is a role which has expired, return it.
2403: #
1.815 albertel 2404: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 2405: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 2406: foreach my $key (keys(%roleshash)) {
1.479 albertel 2407: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 2408: my $section=$1;
2409: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 2410: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 2411: my $now=time;
1.548 albertel 2412: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 2413: $Expired{$end}=$section;
2414: next;
2415: }
1.548 albertel 2416: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 2417: $Pending{$start}=$section;
2418: next;
2419: }
1.599 albertel 2420: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 2421: }
2422: #
2423: # Presumedly there will be few matching roles from the above
2424: # loop and the sorting time will be negligible.
2425: if (scalar(keys(%Pending))) {
2426: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 2427: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 2428: }
2429: if (scalar(keys(%Expired))) {
2430: my @sorted = sort {$a <=> $b} keys(%Expired);
2431: my $time = pop(@sorted);
1.599 albertel 2432: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 2433: }
1.599 albertel 2434: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 2435: }
1.70 www 2436:
1.599 albertel 2437: sub save_cache {
2438: &purge_remembered();
1.722 albertel 2439: #&Apache::loncommon::validate_page();
1.620 albertel 2440: undef(%env);
1.780 albertel 2441: undef($env_loaded);
1.599 albertel 2442: }
1.452 albertel 2443:
1.599 albertel 2444: my $to_remember=-1;
2445: my %remembered;
2446: my %accessed;
2447: my $kicks=0;
2448: my $hits=0;
1.849 albertel 2449: sub make_key {
2450: my ($name,$id) = @_;
1.872 albertel 2451: if (length($id) > 65
2452: && length(&escape($id)) > 200) {
2453: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2454: }
1.849 albertel 2455: return &escape($name.':'.$id);
2456: }
2457:
1.599 albertel 2458: sub devalidate_cache_new {
2459: my ($name,$id,$debug) = @_;
2460: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 2461: $id=&make_key($name,$id);
1.599 albertel 2462: $memcache->delete($id);
2463: delete($remembered{$id});
2464: delete($accessed{$id});
2465: }
2466:
2467: sub is_cached_new {
2468: my ($name,$id,$debug) = @_;
1.849 albertel 2469: $id=&make_key($name,$id);
1.599 albertel 2470: if (exists($remembered{$id})) {
1.1133 foxr 2471: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
1.599 albertel 2472: $accessed{$id}=[&gettimeofday()];
2473: $hits++;
2474: return ($remembered{$id},1);
2475: }
2476: my $value = $memcache->get($id);
2477: if (!(defined($value))) {
2478: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 2479: return (undef,undef);
1.416 albertel 2480: }
1.599 albertel 2481: if ($value eq '__undef__') {
2482: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2483: $value=undef;
2484: }
2485: &make_room($id,$value,$debug);
2486: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2487: return ($value,1);
2488: }
2489:
2490: sub do_cache_new {
2491: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 2492: $id=&make_key($name,$id);
1.599 albertel 2493: my $setvalue=$value;
2494: if (!defined($setvalue)) {
2495: $setvalue='__undef__';
2496: }
1.623 albertel 2497: if (!defined($time) ) {
2498: $time=600;
2499: }
1.599 albertel 2500: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 2501: my $result = $memcache->set($id,$setvalue,$time);
2502: if (! $result) {
1.872 albertel 2503: &logthis("caching of id -> $id failed");
1.910 albertel 2504: $memcache->disconnect_all();
1.872 albertel 2505: }
1.600 albertel 2506: # need to make a copy of $value
1.919 albertel 2507: &make_room($id,$value,$debug);
1.599 albertel 2508: return $value;
2509: }
2510:
2511: sub make_room {
2512: my ($id,$value,$debug)=@_;
1.919 albertel 2513:
2514: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2515: : $value;
1.599 albertel 2516: if ($to_remember<0) { return; }
2517: $accessed{$id}=[&gettimeofday()];
2518: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2519: my $to_kick;
2520: my $max_time=0;
2521: foreach my $other (keys(%accessed)) {
2522: if (&tv_interval($accessed{$other}) > $max_time) {
2523: $to_kick=$other;
2524: $max_time=&tv_interval($accessed{$other});
2525: }
2526: }
2527: delete($remembered{$to_kick});
2528: delete($accessed{$to_kick});
2529: $kicks++;
2530: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 2531: return;
2532: }
2533:
1.599 albertel 2534: sub purge_remembered {
1.604 albertel 2535: #&logthis("Tossing ".scalar(keys(%remembered)));
2536: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 2537: undef(%remembered);
2538: undef(%accessed);
1.428 albertel 2539: }
1.70 www 2540: # ------------------------------------- Read an entry from a user's environment
2541:
2542: sub userenvironment {
2543: my ($udom,$unam,@what)=@_;
1.976 raeburn 2544: my $items;
2545: foreach my $item (@what) {
2546: $items.=&escape($item).'&';
2547: }
2548: $items=~s/\&$//;
1.70 www 2549: my %returnhash=();
1.1009 raeburn 2550: my $uhome = &homeserver($unam,$udom);
2551: unless ($uhome eq 'no_host') {
2552: my @answer=split(/\&/,
2553: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 2554: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2555: return %returnhash;
2556: }
1.1009 raeburn 2557: my $i;
2558: for ($i=0;$i<=$#what;$i++) {
2559: $returnhash{$what[$i]}=&unescape($answer[$i]);
2560: }
1.70 www 2561: }
2562: return %returnhash;
1.1 albertel 2563: }
2564:
1.617 albertel 2565: # ---------------------------------------------------------- Get a studentphoto
2566: sub studentphoto {
2567: my ($udom,$unam,$ext) = @_;
2568: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 2569: if (defined($env{'request.course.id'})) {
1.708 raeburn 2570: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 2571: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2572: return(&retrievestudentphoto($udom,$unam,$ext));
2573: } else {
2574: my ($result,$perm_reqd)=
1.707 albertel 2575: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2576: if ($result eq 'ok') {
2577: if (!($perm_reqd eq 'yes')) {
2578: return(&retrievestudentphoto($udom,$unam,$ext));
2579: }
2580: }
2581: }
2582: }
2583: } else {
2584: my ($result,$perm_reqd) =
1.707 albertel 2585: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2586: if ($result eq 'ok') {
2587: if (!($perm_reqd eq 'yes')) {
2588: return(&retrievestudentphoto($udom,$unam,$ext));
2589: }
2590: }
2591: }
2592: return '/adm/lonKaputt/lonlogo_broken.gif';
2593: }
2594:
2595: sub retrievestudentphoto {
2596: my ($udom,$unam,$ext,$type) = @_;
2597: my $home=&Apache::lonnet::homeserver($unam,$udom);
2598: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2599: if ($ret eq 'ok') {
2600: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2601: if ($type eq 'thumbnail') {
2602: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2603: }
2604: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2605: return $tokenurl;
2606: } else {
2607: if ($type eq 'thumbnail') {
2608: return '/adm/lonKaputt/genericstudent_tn.gif';
2609: } else {
2610: return '/adm/lonKaputt/lonlogo_broken.gif';
2611: }
1.617 albertel 2612: }
2613: }
2614:
1.263 www 2615: # -------------------------------------------------------------------- New chat
2616:
2617: sub chatsend {
1.724 raeburn 2618: my ($newentry,$anon,$group)=@_;
1.620 albertel 2619: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2620: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2621: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 2622: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 2623: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 2624: &escape($newentry)).':'.$group,$chome);
1.292 www 2625: }
2626:
2627: # ------------------------------------------ Find current version of a resource
2628:
2629: sub getversion {
2630: my $fname=&clutter(shift);
1.1189 raeburn 2631: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 2632: return ¤tversion(&filelocation('',$fname));
2633: }
2634:
2635: sub currentversion {
2636: my $fname=shift;
2637: my $author=$fname;
2638: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2639: my ($udom,$uname)=split(/\//,$author);
1.1112 www 2640: my $home=&homeserver($uname,$udom);
1.292 www 2641: if ($home eq 'no_host') {
2642: return -1;
2643: }
1.1112 www 2644: my $answer=&reply("currentversion:$fname",$home);
1.292 www 2645: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2646: return -1;
2647: }
1.1112 www 2648: return $answer;
1.263 www 2649: }
2650:
1.1111 www 2651: #
2652: # Return special version number of resource if set by override, empty otherwise
2653: #
2654: sub usedversion {
2655: my $fname=shift;
2656: unless ($fname) { $fname=$env{'request.uri'}; }
2657: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2658: if ($urlversion) { return $urlversion; }
2659: return '';
2660: }
2661:
1.1 albertel 2662: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 2663:
1.1 albertel 2664: sub subscribe {
2665: my $fname=shift;
1.761 raeburn 2666: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 2667: $fname=~s/[\n\r]//g;
1.1 albertel 2668: my $author=$fname;
2669: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2670: my ($udom,$uname)=split(/\//,$author);
2671: my $home=homeserver($uname,$udom);
1.335 albertel 2672: if ($home eq 'no_host') {
2673: return 'not_found';
1.1 albertel 2674: }
2675: my $answer=reply("sub:$fname",$home);
1.64 www 2676: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2677: $answer.=' by '.$home;
2678: }
1.1 albertel 2679: return $answer;
2680: }
2681:
1.8 www 2682: # -------------------------------------------------------------- Replicate file
2683:
2684: sub repcopy {
2685: my $filename=shift;
1.23 www 2686: $filename=~s/\/+/\//g;
1.1142 raeburn 2687: my $londocroot = $perlvar{'lonDocRoot'};
2688: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 2689: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 2690: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2691: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 2692: return &repcopy_userfile($filename);
2693: }
1.532 albertel 2694: $filename=~s/[\n\r]//g;
1.8 www 2695: my $transname="$filename.in.transfer";
1.828 www 2696: # FIXME: this should flock
1.607 raeburn 2697: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 2698: my $remoteurl=subscribe($filename);
1.64 www 2699: if ($remoteurl =~ /^con_lost by/) {
2700: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2701: return 'unavailable';
1.8 www 2702: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 2703: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 2704: return 'not_found';
1.64 www 2705: } elsif ($remoteurl =~ /^rejected by/) {
2706: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2707: return 'forbidden';
1.20 www 2708: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 2709: return 'ok';
1.8 www 2710: } else {
1.290 www 2711: my $author=$filename;
2712: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2713: my ($udom,$uname)=split(/\//,$author);
2714: my $home=homeserver($uname,$udom);
2715: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 2716: my @parts=split(/\//,$filename);
2717: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 2718: if ($path ne "$londocroot/res") {
1.8 www 2719: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 2720: return 'bad_request';
1.8 www 2721: }
2722: my $count;
2723: for ($count=5;$count<$#parts;$count++) {
2724: $path.="/$parts[$count]";
2725: if ((-e $path)!=1) {
2726: mkdir($path,0777);
2727: }
2728: }
2729: my $ua=new LWP::UserAgent;
2730: my $request=new HTTP::Request('GET',"$remoteurl");
2731: my $response=$ua->request($request,$transname);
2732: if ($response->is_error()) {
2733: unlink($transname);
2734: my $message=$response->status_line;
1.672 albertel 2735: &logthis("<font color=\"blue\">WARNING:"
1.12 www 2736: ." LWP get: $message: $filename</font>");
1.607 raeburn 2737: return 'unavailable';
1.8 www 2738: } else {
1.16 www 2739: if ($remoteurl!~/\.meta$/) {
2740: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2741: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2742: if ($mresponse->is_error()) {
2743: unlink($filename.'.meta');
2744: &logthis(
1.672 albertel 2745: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 2746: }
2747: }
1.8 www 2748: rename($transname,$filename);
1.607 raeburn 2749: return 'ok';
1.8 www 2750: }
1.290 www 2751: }
1.8 www 2752: }
1.330 www 2753: }
2754:
2755: # ------------------------------------------------ Get server side include body
2756: sub ssi_body {
1.381 albertel 2757: my ($filelink,%form)=@_;
1.606 matthew 2758: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2759: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2760: }
1.953 www 2761: my $output='';
2762: my $response;
1.980 raeburn 2763: if ($filelink=~/^https?\:/) {
1.954 raeburn 2764: ($output,$response)=&externalssi($filelink);
1.953 www 2765: } else {
1.1004 droeschl 2766: $filelink .= $filelink=~/\?/ ? '&' : '?';
2767: $filelink .= 'inhibitmenu=yes';
1.953 www 2768: ($output,$response)=&ssi($filelink,%form);
2769: }
1.778 albertel 2770: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 2771: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 2772: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 2773: if (wantarray) {
2774: return ($output, $response);
2775: } else {
2776: return $output;
2777: }
1.8 www 2778: }
2779:
1.15 www 2780: # --------------------------------------------------------- Server Side Include
2781:
1.782 albertel 2782: sub absolute_url {
2783: my ($host_name) = @_;
2784: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2785: if ($host_name eq '') {
2786: $host_name = $ENV{'SERVER_NAME'};
2787: }
2788: return $protocol.$host_name;
2789: }
2790:
1.942 foxr 2791: #
2792: # Server side include.
2793: # Parameters:
2794: # fn Possibly encrypted resource name/id.
2795: # form Hash that describes how the rendering should be done
2796: # and other things.
1.944 foxr 2797: # Returns:
1.950 raeburn 2798: # Scalar context: The content of the response.
2799: # Array context: 2 element list of the content and the full response object.
1.942 foxr 2800: #
1.15 www 2801: sub ssi {
2802:
1.944 foxr 2803: my ($fn,%form)=@_;
1.15 www 2804: my $ua=new LWP::UserAgent;
1.23 www 2805: my $request;
1.711 albertel 2806:
2807: $form{'no_update_last_known'}=1;
1.895 albertel 2808: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 2809: if (%form) {
1.782 albertel 2810: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1272 droeschl 2811: $request->content(join('&',map {
2812: my $name = escape($_);
2813: "$name=" . ( ref($form{$_}) eq 'ARRAY'
2814: ? join("&$name=", map {escape($_) } @{$form{$_}})
2815: : &escape($form{$_}) );
2816: } keys(%form)));
1.23 www 2817: } else {
1.782 albertel 2818: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 2819: }
2820:
1.15 www 2821: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1173 foxr 2822: my $response= $ua->request($request);
1.1182 foxr 2823: my $content = $response->content;
2824:
2825:
1.944 foxr 2826: if (wantarray) {
1.1173 foxr 2827: return ($content, $response);
1.944 foxr 2828: } else {
1.1173 foxr 2829: return $content;
1.942 foxr 2830: }
1.324 www 2831: }
2832:
2833: sub externalssi {
2834: my ($url)=@_;
2835: my $ua=new LWP::UserAgent;
2836: my $request=new HTTP::Request('GET',$url);
2837: my $response=$ua->request($request);
1.954 raeburn 2838: if (wantarray) {
2839: return ($response->content, $response);
2840: } else {
2841: return $response->content;
2842: }
1.15 www 2843: }
1.254 www 2844:
1.492 albertel 2845: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2846:
2847: sub allowuploaded {
2848: my ($srcurl,$url)=@_;
2849: $url=&clutter(&declutter($url));
2850: my $dir=$url;
2851: $dir=~s/\/[^\/]+$//;
2852: my %httpref=();
2853: my $httpurl=&hreflocation('',$url);
2854: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2855: &Apache::lonnet::appenv(\%httpref);
1.254 www 2856: }
1.477 raeburn 2857:
1.1193 raeburn 2858: #
2859: # Determine if the current user should be able to edit a particular resource,
2860: # when viewing in course context.
2861: # (a) When viewing resource used to determine if "Edit" item is included in
2862: # Functions.
2863: # (b) When displaying folder contents in course editor, used to determine if
2864: # "Edit" link will be displayed alongside resource.
2865: #
1.1196 raeburn 2866: # input: six args -- filename (decluttered), course number, course domain,
2867: # url, symb (if registered) and group (if this is a group
2868: # item -- e.g., bulletin board, group page etc.).
2869: # output: array of five scalars --
1.1193 raeburn 2870: # $cfile -- url for file editing if editable on current server
2871: # $home -- homeserver of resource (i.e., for author if published,
2872: # or course if uploaded.).
2873: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 2874: # $forceedit -- 1 if icon/link should be to go to edit mode
2875: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 2876: #
2877:
2878: sub can_edit_resource {
1.1194 raeburn 2879: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
2880: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
2881: #
2882: # For aboutme pages user can only edit his/her own.
2883: #
1.1199 raeburn 2884: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 2885: my ($sdom,$sname) = ($1,$2);
2886: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
2887: $home = $env{'user.home'};
2888: $cfile = $resurl;
2889: if ($env{'form.forceedit'}) {
2890: $forceview = 1;
2891: } else {
2892: $forceedit = 1;
2893: }
2894: return ($cfile,$home,$switchserver,$forceedit,$forceview);
2895: } else {
2896: return;
2897: }
2898: }
2899:
2900: if ($env{'request.course.id'}) {
2901: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
2902: if ($group ne '') {
2903: # if this is a group homepage or group bulletin board, check group privs
2904: my $allowed = 0;
1.1197 raeburn 2905: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
2906: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 2907: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 2908: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2909: $allowed = 1;
2910: }
1.1197 raeburn 2911: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
2912: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2913: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 2914: $allowed = 1;
2915: }
2916: }
2917: if ($allowed) {
2918: $home=&homeserver($cnum,$cdom);
2919: if ($env{'form.forceedit'}) {
2920: $forceview = 1;
2921: } else {
2922: $forceedit = 1;
2923: }
2924: $cfile = $resurl;
2925: } else {
2926: return;
2927: }
2928: } else {
1.1208 raeburn 2929: if ($resurl =~ m{^/?adm/viewclasslist$}) {
2930: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
2931: return;
2932: }
2933: } elsif (!$crsedit) {
1.1194 raeburn 2934: #
2935: # No edit allowed where CC has switched to student role.
2936: #
2937: return;
2938: }
2939: }
2940: }
2941:
1.1193 raeburn 2942: if ($file ne '') {
2943: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 2944: if (&is_course_upload($file,$cnum,$cdom)) {
2945: $uploaded = 1;
2946: $incourse = 1;
1.1193 raeburn 2947: if ($file =~/\.(htm|html|css|js|txt)$/) {
2948: $cfile = &hreflocation('',$file);
1.1201 raeburn 2949: if ($env{'form.forceedit'}) {
2950: $forceview = 1;
2951: } else {
2952: $forceedit = 1;
2953: }
1.1194 raeburn 2954: }
2955: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
2956: $incourse = 1;
2957: if ($env{'form.forceedit'}) {
2958: $forceview = 1;
2959: } else {
2960: $forceedit = 1;
2961: }
2962: $cfile = $resurl;
2963: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
2964: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
2965: $incourse = 1;
2966: if ($env{'form.forceedit'}) {
2967: $forceview = 1;
2968: } else {
2969: $forceedit = 1;
2970: }
2971: $cfile = $resurl;
1.1199 raeburn 2972: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 2973: $incourse = 1;
2974: $cfile = $resurl.'/smpedit';
1.1199 raeburn 2975: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 2976: $incourse = 1;
1.1199 raeburn 2977: if ($env{'form.forceedit'}) {
2978: $forceview = 1;
2979: } else {
2980: $forceedit = 1;
2981: }
2982: $cfile = $resurl;
1.1208 raeburn 2983: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
2984: $incourse = 1;
2985: if ($env{'form.forceedit'}) {
2986: $forceview = 1;
2987: } else {
2988: $forceedit = 1;
2989: }
2990: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 2991: }
2992: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
2993: my $template = '/res/lib/templates/simpleproblem.problem';
2994: if (&is_on_map($template)) {
2995: $incourse = 1;
2996: $forceview = 1;
2997: $cfile = $template;
1.1193 raeburn 2998: }
1.1199 raeburn 2999: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
3000: $incourse = 1;
3001: if ($env{'form.forceedit'}) {
3002: $forceview = 1;
3003: } else {
3004: $forceedit = 1;
3005: }
3006: $cfile = $resurl;
3007: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
3008: $incourse = 1;
3009: $forceview = 1;
3010: if ($symb) {
3011: my ($map,$id,$res)=&decode_symb($symb);
3012: $env{'request.symb'} = $symb;
3013: $cfile = &clutter($res);
3014: } else {
3015: $cfile = $env{'form.suppurl'};
3016: $cfile =~ s{^http://}{};
3017: $cfile = '/adm/wrapper/ext/'.$cfile;
3018: }
1.1234 raeburn 3019: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
3020: if ($env{'form.forceedit'}) {
3021: $forceview = 1;
3022: } else {
3023: $forceedit = 1;
3024: }
3025: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 3026: }
3027: }
1.1194 raeburn 3028: if ($uploaded || $incourse) {
3029: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 3030: } elsif ($file !~ m{/$}) {
1.1193 raeburn 3031: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
3032: $file=~s{^($match_domain/$match_username)}{/priv/$1};
3033: # Check that the user has permission to edit this resource
3034: my $setpriv = 1;
3035: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
3036: if (defined($cfudom)) {
3037: $home=&homeserver($cfuname,$cfudom);
3038: $cfile=$file;
3039: }
3040: }
1.1194 raeburn 3041: if (($cfile ne '') && (!$incourse || $uploaded) &&
3042: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 3043: my @ids=¤t_machine_ids();
3044: unless (grep(/^\Q$home\E$/,@ids)) {
3045: $switchserver=1;
3046: }
3047: }
3048: }
1.1194 raeburn 3049: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 3050: }
3051:
3052: sub is_course_upload {
3053: my ($file,$cnum,$cdom) = @_;
3054: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
3055: $uploadpath =~ s{^\/}{};
1.1201 raeburn 3056: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
3057: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 3058: return 1;
3059: }
3060: return;
3061: }
3062:
1.1194 raeburn 3063: sub in_course {
1.1195 raeburn 3064: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
3065: if ($hideprivileged) {
3066: my $skipuser;
1.1219 raeburn 3067: my %coursehash = &coursedescription($cdom.'_'.$cnum);
3068: my @possdoms = ($cdom);
3069: if ($coursehash{'checkforpriv'}) {
3070: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3071: }
3072: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 3073: $skipuser = 1;
3074: if ($coursehash{'nothideprivileged'}) {
3075: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3076: my $user;
3077: if ($item =~ /:/) {
3078: $user = $item;
3079: } else {
3080: $user = join(':',split(/[\@]/,$item));
3081: }
3082: if ($user eq $uname.':'.$udom) {
3083: undef($skipuser);
3084: last;
3085: }
3086: }
3087: }
3088: if ($skipuser) {
3089: return 0;
3090: }
3091: }
3092: }
1.1194 raeburn 3093: $type ||= 'any';
3094: if (!defined($cdom) || !defined($cnum)) {
3095: my $cid = $env{'request.course.id'};
3096: $cdom = $env{'course.'.$cid.'.domain'};
3097: $cnum = $env{'course.'.$cid.'.num'};
3098: }
3099: my $typesref;
1.1195 raeburn 3100: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 3101: $typesref = ['active','previous','future'];
3102: } elsif ($type eq 'previous' || $type eq 'future') {
3103: $typesref = [$type];
3104: }
3105: my %roles = &get_my_roles($uname,$udom,'userroles',
3106: $typesref,undef,[$cdom]);
3107: my ($tmp) = keys(%roles);
3108: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
3109: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
3110: if (@course_roles > 0) {
3111: return 1;
3112: }
3113: return 0;
3114: }
3115:
1.478 albertel 3116: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 3117: # input: action, courseID, current domain, intended
1.637 raeburn 3118: # path to file, source of file, instruction to parse file for objects,
3119: # ref to hash for embedded objects,
3120: # ref to hash for codebase of java objects.
1.1095 raeburn 3121: # reference to scalar to accommodate mime type determined
3122: # from File::MMagic if $parser = parse.
1.637 raeburn 3123: #
1.485 raeburn 3124: # output: url to file (if action was uploaddoc),
3125: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 3126: #
1.478 albertel 3127: # Allows directory structure to be used within lonUsers/../userfiles/ for a
3128: # course.
1.477 raeburn 3129: #
1.478 albertel 3130: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3131: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
3132: # course's home server.
1.477 raeburn 3133: #
1.478 albertel 3134: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
3135: # be copied from $source (current location) to
3136: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3137: # and will then be copied to
3138: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
3139: # course's home server.
1.485 raeburn 3140: #
1.481 raeburn 3141: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 3142: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 3143: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
3144: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
3145: # in course's home server.
1.637 raeburn 3146: #
1.477 raeburn 3147:
3148: sub process_coursefile {
1.1095 raeburn 3149: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
3150: $mimetype)=@_;
1.477 raeburn 3151: my $fetchresult;
1.638 albertel 3152: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 3153: if ($action eq 'propagate') {
1.638 albertel 3154: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
3155: $home);
1.481 raeburn 3156: } else {
1.477 raeburn 3157: my $fpath = '';
3158: my $fname = $file;
1.478 albertel 3159: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 3160: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 3161: my $filepath = &build_filepath($fpath);
1.481 raeburn 3162: if ($action eq 'copy') {
3163: if ($source eq '') {
3164: $fetchresult = 'no source file';
3165: return $fetchresult;
3166: } else {
3167: my $destination = $filepath.'/'.$fname;
3168: rename($source,$destination);
3169: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3170: $home);
1.481 raeburn 3171: }
3172: } elsif ($action eq 'uploaddoc') {
3173: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 3174: print $fh $env{'form.'.$source};
1.481 raeburn 3175: close($fh);
1.637 raeburn 3176: if ($parser eq 'parse') {
1.1024 raeburn 3177: my $mm = new File::MMagic;
1.1095 raeburn 3178: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3179: if ($type eq 'text/html') {
1.1024 raeburn 3180: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3181: unless ($parse_result eq 'ok') {
3182: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3183: }
1.637 raeburn 3184: }
1.1095 raeburn 3185: if (ref($mimetype)) {
3186: $$mimetype = $type;
3187: }
1.637 raeburn 3188: }
1.477 raeburn 3189: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3190: $home);
1.481 raeburn 3191: if ($fetchresult eq 'ok') {
3192: return '/uploaded/'.$fpath.'/'.$fname;
3193: } else {
3194: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3195: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 3196: return '/adm/notfound.html';
3197: }
1.477 raeburn 3198: }
3199: }
1.485 raeburn 3200: unless ( $fetchresult eq 'ok') {
1.477 raeburn 3201: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3202: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 3203: }
3204: return $fetchresult;
3205: }
3206:
1.637 raeburn 3207: sub build_filepath {
3208: my ($fpath) = @_;
3209: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3210: unless ($fpath eq '') {
3211: my @parts=split('/',$fpath);
3212: foreach my $part (@parts) {
3213: $filepath.= '/'.$part;
3214: if ((-e $filepath)!=1) {
3215: mkdir($filepath,0777);
3216: }
3217: }
3218: }
3219: return $filepath;
3220: }
3221:
3222: sub store_edited_file {
1.638 albertel 3223: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 3224: my $file = $primary_url;
3225: $file =~ s#^/uploaded/$docudom/$docuname/##;
3226: my $fpath = '';
3227: my $fname = $file;
3228: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3229: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3230: my $filepath = &build_filepath($fpath);
3231: open(my $fh,'>'.$filepath.'/'.$fname);
3232: print $fh $content;
3233: close($fh);
1.638 albertel 3234: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 3235: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3236: $home);
1.637 raeburn 3237: if ($$fetchresult eq 'ok') {
3238: return '/uploaded/'.$fpath.'/'.$fname;
3239: } else {
1.638 albertel 3240: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3241: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 3242: return '/adm/notfound.html';
3243: }
3244: }
3245:
1.531 albertel 3246: sub clean_filename {
1.831 albertel 3247: my ($fname,$args)=@_;
1.315 www 3248: # Replace Windows backslashes by forward slashes
1.257 www 3249: $fname=~s/\\/\//g;
1.831 albertel 3250: if (!$args->{'keep_path'}) {
3251: # Get rid of everything but the actual filename
3252: $fname=~s/^.*\/([^\/]+)$/$1/;
3253: }
1.315 www 3254: # Replace spaces by underscores
3255: $fname=~s/\s+/\_/g;
3256: # Replace all other weird characters by nothing
1.831 albertel 3257: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 3258: # Replace all .\d. sequences with _\d. so they no longer look like version
3259: # numbers
3260: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 3261: return $fname;
3262: }
1.1051 raeburn 3263: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3264: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3265: # image with the same aspect ratio as the original, but with dimensions which do
3266: # not exceed $resizewidth and $resizeheight.
3267:
1.984 neumanie 3268: sub resizeImage {
1.1051 raeburn 3269: my ($img_path,$resizewidth,$resizeheight) = @_;
3270: my $ima = Image::Magick->new;
3271: my $resized;
3272: if (-e $img_path) {
3273: $ima->Read($img_path);
3274: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3275: my $width = $ima->Get('width');
3276: my $height = $ima->Get('height');
3277: if ($width > $resizewidth) {
3278: my $factor = $width/$resizewidth;
3279: my $newheight = $height/$factor;
3280: $ima->Scale(width=>$resizewidth,height=>$newheight);
3281: $resized = 1;
3282: }
3283: }
3284: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3285: my $width = $ima->Get('width');
3286: my $height = $ima->Get('height');
3287: if ($height > $resizeheight) {
3288: my $factor = $height/$resizeheight;
3289: my $newwidth = $width/$factor;
3290: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3291: $resized = 1;
3292: }
3293: }
3294: if ($resized) {
3295: $ima->Write($img_path);
3296: }
3297: }
3298: return;
1.977 amueller 3299: }
3300:
1.608 albertel 3301: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 3302: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 3303: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 3304: # $context - possible values: coursedoc, existingfile, overwrite,
3305: # canceloverwrite, or ''.
3306: # if 'coursedoc': upload to the current course
3307: # if 'existingfile': write file to tmp/overwrites directory
3308: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3309: # $context is passed as argument to &finishuserfileupload
1.686 albertel 3310: # $subdir - directory in userfile to store the file into
1.858 raeburn 3311: # $parser - instruction to parse file for objects ($parser = parse)
3312: # $allfiles - reference to hash for embedded objects
3313: # $codebase - reference to hash for codebase of java objects
3314: # $desuname - username for permanent storage of uploaded file
3315: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 3316: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3317: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 3318: # $resizewidth - width (pixels) to which to resize uploaded image
3319: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 3320: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 3321: # from File::MMagic.
1.858 raeburn 3322: #
1.686 albertel 3323: # output: url of file in userspace, or error: <message>
3324: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 3325:
1.531 albertel 3326: sub userfileupload {
1.1090 raeburn 3327: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 3328: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 3329: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 3330: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 3331: $fname=&clean_filename($fname);
1.1090 raeburn 3332: # See if there is anything left
1.257 www 3333: unless ($fname) { return 'error: no uploaded file'; }
1.1090 raeburn 3334: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3335: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3336: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3337: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 3338: my $now = time;
1.1090 raeburn 3339: my $filepath;
1.1095 raeburn 3340: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 3341: $filepath = 'tmp/helprequests/'.$now;
3342: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3343: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3344: '_'.$env{'user.domain'}.'/pending';
3345: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3346: my ($docuname,$docudom);
3347: if ($destudom) {
3348: $docudom = $destudom;
3349: } else {
3350: $docudom = $env{'user.domain'};
3351: }
3352: if ($destuname) {
3353: $docuname = $destuname;
3354: } else {
3355: $docuname = $env{'user.name'};
3356: }
3357: if (exists($env{'form.group'})) {
3358: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3359: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3360: }
3361: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3362: if ($context eq 'canceloverwrite') {
3363: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3364: if (-e $tempfile) {
3365: my @info = stat($tempfile);
3366: if ($info[9] eq $env{'form.timestamp'}) {
3367: unlink($tempfile);
3368: }
3369: }
3370: return;
1.523 raeburn 3371: }
3372: }
1.1090 raeburn 3373: # Create the directory if not present
1.741 raeburn 3374: my @parts=split(/\//,$filepath);
3375: my $fullpath = $perlvar{'lonDaemons'};
3376: for (my $i=0;$i<@parts;$i++) {
3377: $fullpath .= '/'.$parts[$i];
3378: if ((-e $fullpath)!=1) {
3379: mkdir($fullpath,0777);
3380: }
3381: }
3382: open(my $fh,'>'.$fullpath.'/'.$fname);
3383: print $fh $env{'form.'.$formname};
3384: close($fh);
1.1090 raeburn 3385: if ($context eq 'existingfile') {
3386: my @info = stat($fullpath.'/'.$fname);
3387: return ($fullpath.'/'.$fname,$info[9]);
3388: } else {
3389: return $fullpath.'/'.$fname;
3390: }
1.523 raeburn 3391: }
1.995 raeburn 3392: if ($subdir eq 'scantron') {
3393: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 3394: } else {
1.995 raeburn 3395: $fname="$subdir/$fname";
3396: }
1.1090 raeburn 3397: if ($context eq 'coursedoc') {
1.638 albertel 3398: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3399: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 3400: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 3401: return &finishuserfileupload($docuname,$docudom,
3402: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 3403: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 3404: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 3405: } else {
1.1218 raeburn 3406: if ($env{'form.folder'}) {
3407: $fname=$env{'form.folder'}.'/'.$fname;
3408: }
1.638 albertel 3409: return &process_coursefile('uploaddoc',$docuname,$docudom,
3410: $fname,$formname,$parser,
1.1095 raeburn 3411: $allfiles,$codebase,$mimetype);
1.481 raeburn 3412: }
1.719 banghart 3413: } elsif (defined($destuname)) {
3414: my $docuname=$destuname;
3415: my $docudom=$destudom;
1.860 raeburn 3416: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3417: $parser,$allfiles,$codebase,
1.1051 raeburn 3418: $thumbwidth,$thumbheight,
1.1095 raeburn 3419: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3420: } else {
1.638 albertel 3421: my $docuname=$env{'user.name'};
3422: my $docudom=$env{'user.domain'};
1.1220 raeburn 3423: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 3424: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3425: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3426: }
1.860 raeburn 3427: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3428: $parser,$allfiles,$codebase,
1.1051 raeburn 3429: $thumbwidth,$thumbheight,
1.1095 raeburn 3430: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3431: }
1.271 www 3432: }
3433:
3434: sub finishuserfileupload {
1.860 raeburn 3435: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 3436: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 3437: my $path=$docudom.'/'.$docuname.'/';
1.258 www 3438: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 3439:
1.860 raeburn 3440: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 3441: $file=$fname;
3442: if ($fname=~m|/|) {
3443: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3444: $path.=$fnamepath.'/';
3445: }
1.259 www 3446: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 3447: my $count;
3448: for ($count=4;$count<=$#parts;$count++) {
3449: $filepath.="/$parts[$count]";
3450: if ((-e $filepath)!=1) {
3451: mkdir($filepath,0777);
3452: }
3453: }
1.984 neumanie 3454:
1.258 www 3455: # Save the file
3456: {
1.701 albertel 3457: if (!open(FH,'>'.$filepath.'/'.$file)) {
3458: &logthis('Failed to create '.$filepath.'/'.$file);
3459: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3460: return '/adm/notfound.html';
3461: }
1.1090 raeburn 3462: if ($context eq 'overwrite') {
1.1117 foxr 3463: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 3464: my $target = $filepath.'/'.$file;
3465: if (-e $source) {
3466: my @info = stat($source);
3467: if ($info[9] eq $env{'form.timestamp'}) {
3468: unless (&File::Copy::move($source,$target)) {
3469: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3470: return "Moving from $source failed";
3471: }
3472: } else {
3473: return "Temporary file: $source had unexpected date/time for last modification";
3474: }
3475: } else {
3476: return "Temporary file: $source missing";
3477: }
3478: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 3479: &logthis('Failed to write to '.$filepath.'/'.$file);
3480: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3481: return '/adm/notfound.html';
3482: }
1.570 albertel 3483: close(FH);
1.1051 raeburn 3484: if ($resizewidth && $resizeheight) {
3485: my $mm = new File::MMagic;
3486: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3487: if ($mime_type =~ m{^image/}) {
3488: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3489: }
1.977 amueller 3490: }
1.258 www 3491: }
1.1152 raeburn 3492: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3493: if (ref($mimetype)) {
3494: if ($$mimetype eq '') {
3495: my $mm = new File::MMagic;
3496: my $type = $mm->checktype_filename($filepath.'/'.$file);
3497: $$mimetype = $type;
3498: }
3499: }
3500: }
1.637 raeburn 3501: if ($parser eq 'parse') {
1.1152 raeburn 3502: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 3503: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3504: $allfiles,$codebase);
3505: unless ($parse_result eq 'ok') {
3506: &logthis('Failed to parse '.$filepath.$file.
3507: ' for embedded media: '.$parse_result);
3508: }
1.637 raeburn 3509: }
3510: }
1.860 raeburn 3511: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3512: my $input = $filepath.'/'.$file;
3513: my $output = $filepath.'/'.'tn-'.$file;
3514: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3515: system("convert -sample $thumbsize $input $output");
3516: if (-e $filepath.'/'.'tn-'.$file) {
3517: $fetchthumb = 1;
3518: }
3519: }
1.858 raeburn 3520:
1.259 www 3521: # Notify homeserver to grep it
3522: #
1.984 neumanie 3523: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 3524: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 3525: if ($fetchresult eq 'ok') {
1.860 raeburn 3526: if ($fetchthumb) {
3527: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3528: if ($thumbresult ne 'ok') {
3529: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3530: $docuhome.': '.$thumbresult);
3531: }
3532: }
1.259 www 3533: #
1.258 www 3534: # Return the URL to it
1.494 albertel 3535: return '/uploaded/'.$path.$file;
1.263 www 3536: } else {
1.494 albertel 3537: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3538: ': '.$fetchresult);
1.263 www 3539: return '/adm/notfound.html';
1.858 raeburn 3540: }
1.493 albertel 3541: }
3542:
1.637 raeburn 3543: sub extract_embedded_items {
1.961 raeburn 3544: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 3545: my @state = ();
1.1164 raeburn 3546: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 3547: my %javafiles = (
3548: codebase => '',
3549: code => '',
3550: archive => ''
3551: );
3552: my %mediafiles = (
3553: src => '',
3554: movie => '',
3555: );
1.648 raeburn 3556: my $p;
3557: if ($content) {
3558: $p = HTML::LCParser->new($content);
3559: } else {
1.961 raeburn 3560: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 3561: }
1.641 albertel 3562: while (my $t=$p->get_token()) {
1.640 albertel 3563: if ($t->[0] eq 'S') {
3564: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 3565: push(@state, $tagname);
1.648 raeburn 3566: if (lc($tagname) eq 'allow') {
3567: &add_filetype($allfiles,$attr->{'src'},'src');
3568: }
1.640 albertel 3569: if (lc($tagname) eq 'img') {
3570: &add_filetype($allfiles,$attr->{'src'},'src');
3571: }
1.886 albertel 3572: if (lc($tagname) eq 'a') {
1.1222 raeburn 3573: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 3574: &add_filetype($allfiles,$attr->{'href'},'href');
3575: }
1.886 albertel 3576: }
1.645 raeburn 3577: if (lc($tagname) eq 'script') {
1.1164 raeburn 3578: my $src;
1.645 raeburn 3579: if ($attr->{'archive'} =~ /\.jar$/i) {
3580: &add_filetype($allfiles,$attr->{'archive'},'archive');
3581: } else {
1.1164 raeburn 3582: if ($attr->{'src'} ne '') {
3583: $src = $attr->{'src'};
3584: &add_filetype($allfiles,$src,'src');
3585: }
3586: }
3587: my $text = $p->get_trimmed_text();
3588: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3589: my @swfargs = split(/,/,$1);
3590: foreach my $item (@swfargs) {
3591: $item =~ s/["']//g;
3592: $item =~ s/^\s+//;
3593: $item =~ s/\s+$//;
3594: }
3595: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3596: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3597: push(@{$related{$swfargs[0]}},$swfargs[2]);
3598: } else {
3599: $related{$swfargs[0]} = [$swfargs[2]];
3600: }
3601: }
1.645 raeburn 3602: }
3603: }
3604: if (lc($tagname) eq 'link') {
3605: if (lc($attr->{'rel'}) eq 'stylesheet') {
3606: &add_filetype($allfiles,$attr->{'href'},'href');
3607: }
3608: }
1.640 albertel 3609: if (lc($tagname) eq 'object' ||
3610: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3611: foreach my $item (keys(%javafiles)) {
3612: $javafiles{$item} = '';
3613: }
1.1164 raeburn 3614: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3615: $lastids{lc($tagname)} = $attr->{'id'};
3616: }
1.640 albertel 3617: }
3618: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3619: my $name = lc($attr->{'name'});
3620: foreach my $item (keys(%javafiles)) {
3621: if ($name eq $item) {
3622: $javafiles{$item} = $attr->{'value'};
3623: last;
3624: }
3625: }
1.1164 raeburn 3626: my $pathfrom;
1.640 albertel 3627: foreach my $item (keys(%mediafiles)) {
3628: if ($name eq $item) {
1.1164 raeburn 3629: $pathfrom = $attr->{'value'};
3630: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3631: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 3632: last;
3633: }
3634: }
1.1164 raeburn 3635: if ($name eq 'flashvars') {
3636: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3637: }
3638: if ($pathfrom ne '') {
3639: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3640: $pathfrom);
3641: }
1.640 albertel 3642: }
3643: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3644: foreach my $item (keys(%javafiles)) {
3645: if ($attr->{$item}) {
3646: $javafiles{$item} = $attr->{$item};
3647: last;
3648: }
3649: }
3650: foreach my $item (keys(%mediafiles)) {
3651: if ($attr->{$item}) {
3652: &add_filetype($allfiles,$attr->{$item},$item);
3653: last;
3654: }
3655: }
1.1164 raeburn 3656: if (lc($tagname) eq 'embed') {
3657: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3658: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3659: $attr->{'src'});
3660: }
3661: }
1.640 albertel 3662: }
1.1243 raeburn 3663: if (lc($tagname) eq 'iframe') {
3664: my $src = $attr->{'src'} ;
3665: if (($src ne '') && ($src !~ m{^(/|https?://)})) {
3666: &add_filetype($allfiles,$src,'src');
3667: } elsif ($src =~ m{^/}) {
3668: if ($env{'request.course.id'}) {
3669: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
3670: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
3671: my $url = &hreflocation('',$fullpath);
3672: if ($url =~ m{^/uploaded/$cdom/$cnum/docs/(\w+/\d+)/}) {
3673: my $relpath = $1;
3674: if ($src =~ m{^/uploaded/$cdom/$cnum/docs/\Q$relpath\E/(.+)$}) {
3675: &add_filetype($allfiles,$1,'src');
3676: }
3677: }
3678: }
3679: }
3680: }
1.1164 raeburn 3681: if ($t->[4] =~ m{/>$}) {
1.1243 raeburn 3682: pop(@state);
1.1164 raeburn 3683: }
1.640 albertel 3684: } elsif ($t->[0] eq 'E') {
3685: my ($tagname) = ($t->[1]);
3686: if ($javafiles{'codebase'} ne '') {
3687: $javafiles{'codebase'} .= '/';
3688: }
3689: if (lc($tagname) eq 'applet' ||
3690: lc($tagname) eq 'object' ||
3691: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3692: ) {
3693: foreach my $item (keys(%javafiles)) {
3694: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3695: my $file=$javafiles{'codebase'}.$javafiles{$item};
3696: &add_filetype($allfiles,$file,$item);
3697: }
3698: }
3699: }
3700: pop @state;
3701: }
3702: }
1.1164 raeburn 3703: foreach my $id (sort(keys(%flashvars))) {
3704: if ($shockwave{$id} ne '') {
3705: my @pairs = split(/\&/,$flashvars{$id});
3706: foreach my $pair (@pairs) {
3707: my ($key,$value) = split(/\=/,$pair);
3708: if ($key eq 'thumb') {
3709: &add_filetype($allfiles,$value,$key);
3710: } elsif ($key eq 'content') {
3711: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3712: my ($ext) = ($value =~ /\.([^.]+)$/);
3713: if ($ext ne '') {
3714: &add_filetype($allfiles,$path.$value,$ext);
3715: }
3716: }
3717: }
3718: }
3719: }
1.637 raeburn 3720: return 'ok';
3721: }
3722:
1.639 albertel 3723: sub add_filetype {
3724: my ($allfiles,$file,$type)=@_;
3725: if (exists($allfiles->{$file})) {
3726: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3727: push(@{$allfiles->{$file}}, &escape($type));
3728: }
3729: } else {
3730: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 3731: }
3732: }
3733:
1.1164 raeburn 3734: sub embedded_dependency {
3735: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3736: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3737: if (($identifier ne '') &&
3738: (ref($related->{$identifier}) eq 'ARRAY') &&
3739: ($pathfrom ne '')) {
3740: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3741: foreach my $dep (@{$related->{$identifier}}) {
3742: &add_filetype($allfiles,$path.$dep,'object');
3743: }
3744: }
3745: }
3746: return;
3747: }
3748:
1.493 albertel 3749: sub removeuploadedurl {
1.984 neumanie 3750: my ($url)=@_;
3751: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 3752: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 3753: }
3754:
3755: sub removeuserfile {
3756: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 3757: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3758: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 3759: if ($result eq 'ok') {
1.798 raeburn 3760: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3761: my $metafile = $fname.'.meta';
3762: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 3763: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 3764: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3765: my $sqlresult =
1.823 albertel 3766: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3767: 'portfolio_metadata',$group,
3768: 'delete');
1.798 raeburn 3769: }
3770: }
3771: return $result;
1.257 www 3772: }
1.15 www 3773:
1.530 albertel 3774: sub mkdiruserfile {
3775: my ($docuname,$docudom,$dir)=@_;
3776: my $home=&homeserver($docuname,$docudom);
3777: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3778: }
3779:
1.531 albertel 3780: sub renameuserfile {
3781: my ($docuname,$docudom,$old,$new)=@_;
3782: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3783: my $result = &reply("renameuserfile:$docudom:$docuname:".
3784: &escape("$old").':'.&escape("$new"),$home);
3785: if ($result eq 'ok') {
3786: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3787: my $oldmeta = $old.'.meta';
3788: my $newmeta = $new.'.meta';
3789: my $metaresult =
3790: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 3791: my $url = "/uploaded/$docudom/$docuname/$old";
3792: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3793: my $sqlresult =
1.823 albertel 3794: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3795: 'portfolio_metadata',$group,
3796: 'delete');
1.798 raeburn 3797: }
3798: }
3799: return $result;
1.531 albertel 3800: }
3801:
1.14 www 3802: # ------------------------------------------------------------------------- Log
3803:
3804: sub log {
3805: my ($dom,$nam,$hom,$what)=@_;
1.47 www 3806: return critical("log:$dom:$nam:$what",$hom);
1.157 www 3807: }
3808:
3809: # ------------------------------------------------------------------ Course Log
1.352 www 3810: #
3811: # This routine flushes several buffers of non-mission-critical nature
3812: #
1.157 www 3813:
3814: sub flushcourselogs {
1.352 www 3815: &logthis('Flushing log buffers');
3816: #
3817: # course logs
3818: # This is a log of all transactions in a course, which can be used
3819: # for data mining purposes
3820: #
3821: # It also collects the courseid database, which lists last transaction
3822: # times and course titles for all courseids
3823: #
3824: my %courseidbuffer=();
1.921 raeburn 3825: foreach my $crsid (keys(%courselogs)) {
1.352 www 3826: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 3827: &escape($courselogs{$crsid}),
3828: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 3829: delete $courselogs{$crsid};
3830: } else {
3831: &logthis('Failed to flush log buffer for '.$crsid);
3832: if (length($courselogs{$crsid})>40000) {
1.672 albertel 3833: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 3834: " exceeded maximum size, deleting.</font>");
3835: delete $courselogs{$crsid};
3836: }
1.352 www 3837: }
1.920 raeburn 3838: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 3839: 'description' => $coursedescrbuf{$crsid},
3840: 'inst_code' => $courseinstcodebuf{$crsid},
3841: 'type' => $coursetypebuf{$crsid},
3842: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 3843: };
1.191 harris41 3844: }
1.352 www 3845: #
3846: # Write course id database (reverse lookup) to homeserver of courses
3847: # Is used in pickcourse
3848: #
1.840 albertel 3849: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 3850: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 3851: $courseidbuffer{$crs_home},
3852: $crs_home,'timeonly');
1.352 www 3853: }
3854: #
3855: # File accesses
3856: # Writes to the dynamic metadata of resources to get hit counts, etc.
3857: #
1.449 matthew 3858: foreach my $entry (keys(%accesshash)) {
1.458 matthew 3859: if ($entry =~ /___count$/) {
3860: my ($dom,$name);
1.807 albertel 3861: ($dom,$name,undef)=
1.811 albertel 3862: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 3863: if (! defined($dom) || $dom eq '' ||
3864: ! defined($name) || $name eq '') {
1.620 albertel 3865: my $cid = $env{'request.course.id'};
3866: $dom = $env{'request.'.$cid.'.domain'};
3867: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 3868: }
1.450 matthew 3869: my $value = $accesshash{$entry};
3870: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3871: my %temphash=($url => $value);
1.449 matthew 3872: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3873: if ($result eq 'ok') {
3874: delete $accesshash{$entry};
3875: }
3876: } else {
1.811 albertel 3877: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 3878: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 3879: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 3880: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3881: delete $accesshash{$entry};
3882: }
1.185 www 3883: }
1.191 harris41 3884: }
1.352 www 3885: #
3886: # Roles
3887: # Reverse lookup of user roles for course faculty/staff and co-authorship
3888: #
1.800 albertel 3889: foreach my $entry (keys(%userrolehash)) {
1.351 www 3890: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 3891: split(/\:/,$entry);
3892: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 3893: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 3894: $rudom,$runame) eq 'ok') {
3895: delete $userrolehash{$entry};
3896: }
3897: }
1.662 raeburn 3898: #
3899: # Reverse lookup of domain roles (dc, ad, li, sc, au)
3900: #
3901: my %domrolebuffer = ();
1.1000 raeburn 3902: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 3903: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 3904: if ($domrolebuffer{$rudom}) {
3905: $domrolebuffer{$rudom}.='&'.&escape($entry).
3906: '='.&escape($domainrolehash{$entry});
3907: } else {
3908: $domrolebuffer{$rudom}.=&escape($entry).
3909: '='.&escape($domainrolehash{$entry});
3910: }
3911: delete $domainrolehash{$entry};
3912: }
3913: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 3914: my %servers = &get_servers($dom,'library');
3915: foreach my $tryserver (keys(%servers)) {
3916: unless (&reply('domroleput:'.$dom.':'.
3917: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3918: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3919: }
1.662 raeburn 3920: }
3921: }
1.186 www 3922: $dumpcount++;
1.157 www 3923: }
3924:
3925: sub courselog {
3926: my $what=shift;
1.158 www 3927: $what=time.':'.$what;
1.620 albertel 3928: unless ($env{'request.course.id'}) { return ''; }
3929: $coursedombuf{$env{'request.course.id'}}=
3930: $env{'course.'.$env{'request.course.id'}.'.domain'};
3931: $coursenumbuf{$env{'request.course.id'}}=
3932: $env{'course.'.$env{'request.course.id'}.'.num'};
3933: $coursehombuf{$env{'request.course.id'}}=
3934: $env{'course.'.$env{'request.course.id'}.'.home'};
3935: $coursedescrbuf{$env{'request.course.id'}}=
3936: $env{'course.'.$env{'request.course.id'}.'.description'};
3937: $courseinstcodebuf{$env{'request.course.id'}}=
3938: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3939: $courseownerbuf{$env{'request.course.id'}}=
3940: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 3941: $coursetypebuf{$env{'request.course.id'}}=
3942: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 3943: if (defined $courselogs{$env{'request.course.id'}}) {
3944: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 3945: } else {
1.620 albertel 3946: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 3947: }
1.620 albertel 3948: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 3949: &flushcourselogs();
3950: }
1.158 www 3951: }
3952:
3953: sub courseacclog {
3954: my $fnsymb=shift;
1.620 albertel 3955: unless ($env{'request.course.id'}) { return ''; }
3956: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 3957: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 3958: $what.=':POST';
1.583 matthew 3959: # FIXME: Probably ought to escape things....
1.800 albertel 3960: foreach my $key (keys(%env)) {
3961: if ($key=~/^form\.(.*)/) {
1.975 raeburn 3962: my $formitem = $1;
3963: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3964: $what.=':'.$formitem.'='.$env{$key};
3965: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3966: $what.=':'.$formitem.'='.$env{$key};
3967: }
1.158 www 3968: }
1.191 harris41 3969: }
1.583 matthew 3970: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
3971: # FIXME: We should not be depending on a form parameter that someone
3972: # editing lonsearchcat.pm might change in the future.
1.620 albertel 3973: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 3974: $what.= ':POST';
3975: # FIXME: Probably ought to escape things....
3976: foreach my $element ('courseexp','crsfulltext','crsrelated',
3977: 'crsdiscuss') {
1.620 albertel 3978: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 3979: }
3980: }
1.158 www 3981: }
3982: &courselog($what);
1.149 www 3983: }
3984:
1.185 www 3985: sub countacc {
3986: my $url=&declutter(shift);
1.458 matthew 3987: return if (! defined($url) || $url eq '');
1.620 albertel 3988: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 3989: #
3990: # Mark that this url was used in this course
3991: #
1.620 albertel 3992: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 3993: #
3994: # Increase the access count for this resource in this child process
3995: #
1.281 www 3996: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 3997: $accesshash{$key}++;
1.185 www 3998: }
1.349 www 3999:
1.361 www 4000: sub linklog {
4001: my ($from,$to)=@_;
4002: $from=&declutter($from);
4003: $to=&declutter($to);
4004: $accesshash{$from.'___'.$to.'___comefrom'}=1;
4005: $accesshash{$to.'___'.$from.'___goto'}=1;
4006: }
1.1160 www 4007:
4008: sub statslog {
4009: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
4010: if ($users<2) { return; }
4011: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
4012: 'course' => $env{'request.course.id'},
4013: 'sections' => '"all"',
4014: 'num_students' => $users,
4015: 'part' => $part,
4016: 'symb' => $symb,
4017: 'mean_tries' => $av_attempts,
4018: 'deg_of_diff' => $degdiff});
4019: foreach my $key (keys(%dynstore)) {
4020: $accesshash{$key}=$dynstore{$key};
4021: }
4022: }
1.361 www 4023:
1.349 www 4024: sub userrolelog {
4025: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 4026: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 4027: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4028: $userrolehash
4029: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 4030: =$tend.':'.$tstart;
1.662 raeburn 4031: }
1.1169 droeschl 4032: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 4033: $userrolehash
4034: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
4035: =$tend.':'.$tstart;
4036: }
1.1169 droeschl 4037: if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
1.662 raeburn 4038: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
4039: $domainrolehash
4040: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
4041: = $tend.':'.$tstart;
4042: }
1.351 www 4043: }
4044:
1.957 raeburn 4045: sub courserolelog {
4046: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184 raeburn 4047: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
4048: my $cdom = $1;
4049: my $cnum = $2;
4050: my $sec = $3;
4051: my $namespace = 'rolelog';
4052: my %storehash = (
4053: role => $trole,
4054: start => $tstart,
4055: end => $tend,
4056: selfenroll => $selfenroll,
4057: context => $context,
4058: );
4059: if ($trole eq 'gr') {
4060: $namespace = 'groupslog';
4061: $storehash{'group'} = $sec;
4062: } else {
4063: $storehash{'section'} = $sec;
4064: }
1.1188 raeburn 4065: &write_log('course',$namespace,\%storehash,$delflag,$username,
4066: $domain,$cnum,$cdom);
1.1184 raeburn 4067: if (($trole ne 'st') || ($sec ne '')) {
4068: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 4069: }
4070: }
4071: return;
4072: }
4073:
1.1184 raeburn 4074: sub domainrolelog {
4075: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4076: if ($area =~ m{^/($match_domain)/$}) {
4077: my $cdom = $1;
4078: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
4079: my $namespace = 'rolelog';
4080: my %storehash = (
4081: role => $trole,
4082: start => $tstart,
4083: end => $tend,
4084: context => $context,
4085: );
1.1188 raeburn 4086: &write_log('domain',$namespace,\%storehash,$delflag,$username,
4087: $domain,$domconfiguser,$cdom);
1.1184 raeburn 4088: }
4089: return;
4090:
4091: }
4092:
4093: sub coauthorrolelog {
4094: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
4095: if ($area =~ m{^/($match_domain)/($match_username)$}) {
4096: my $audom = $1;
4097: my $auname = $2;
4098: my $namespace = 'rolelog';
4099: my %storehash = (
4100: role => $trole,
4101: start => $tstart,
4102: end => $tend,
4103: context => $context,
4104: );
1.1188 raeburn 4105: &write_log('author',$namespace,\%storehash,$delflag,$username,
4106: $domain,$auname,$audom);
1.1184 raeburn 4107: }
4108: return;
4109: }
4110:
1.351 www 4111: sub get_course_adv_roles {
1.948 raeburn 4112: my ($cid,$codes) = @_;
1.620 albertel 4113: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 4114: my %coursehash=&coursedescription($cid);
1.988 raeburn 4115: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 4116: my %nothide=();
1.800 albertel 4117: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 4118: if ($user !~ /:/) {
4119: $nothide{join(':',split(/[\@]/,$user))}=1;
4120: } else {
4121: $nothide{$user}=1;
4122: }
1.470 www 4123: }
1.1219 raeburn 4124: my @possdoms = ($coursehash{'domain'});
4125: if ($coursehash{'checkforpriv'}) {
4126: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
4127: }
1.351 www 4128: my %returnhash=();
4129: my %dumphash=
4130: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
4131: my $now=time;
1.997 raeburn 4132: my %privileged;
1.1000 raeburn 4133: foreach my $entry (keys(%dumphash)) {
1.800 albertel 4134: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 4135: if (($tstart) && ($tstart<0)) { next; }
4136: if (($tend) && ($tend<$now)) { next; }
4137: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 4138: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 4139: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 4140: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 4141: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 4142: if ($role eq 'cr') { next; }
1.948 raeburn 4143: if ($codes) {
4144: if ($section) { $role .= ':'.$section; }
4145: if ($returnhash{$role}) {
4146: $returnhash{$role}.=','.$username.':'.$domain;
4147: } else {
4148: $returnhash{$role}=$username.':'.$domain;
4149: }
1.351 www 4150: } else {
1.988 raeburn 4151: my $key=&plaintext($role,$crstype);
1.973 bisitz 4152: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 4153: if ($returnhash{$key}) {
4154: $returnhash{$key}.=','.$username.':'.$domain;
4155: } else {
4156: $returnhash{$key}=$username.':'.$domain;
4157: }
1.351 www 4158: }
1.948 raeburn 4159: }
1.400 www 4160: return %returnhash;
4161: }
4162:
4163: sub get_my_roles {
1.937 raeburn 4164: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 4165: unless (defined($uname)) { $uname=$env{'user.name'}; }
4166: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 4167: my (%dumphash,%nothide);
1.1086 raeburn 4168: if ($context eq 'userroles') {
1.1166 raeburn 4169: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 4170: } else {
1.1219 raeburn 4171: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 4172: if ($hidepriv) {
4173: my %coursehash=&coursedescription($udom.'_'.$uname);
4174: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
4175: if ($user !~ /:/) {
4176: $nothide{join(':',split(/[\@]/,$user))} = 1;
4177: } else {
4178: $nothide{$user} = 1;
4179: }
4180: }
4181: }
1.858 raeburn 4182: }
1.400 www 4183: my %returnhash=();
4184: my $now=time;
1.999 raeburn 4185: my %privileged;
1.800 albertel 4186: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 4187: my ($role,$tend,$tstart);
4188: if ($context eq 'userroles') {
1.1149 raeburn 4189: next if ($entry =~ /^rolesdef/);
1.867 raeburn 4190: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4191: } else {
4192: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4193: }
1.400 www 4194: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 4195: my $status = 'active';
1.939 raeburn 4196: if (($tend) && ($tend<=$now)) {
1.832 raeburn 4197: $status = 'previous';
4198: }
4199: if (($tstart) && ($now<$tstart)) {
4200: $status = 'future';
4201: }
4202: if (ref($types) eq 'ARRAY') {
4203: if (!grep(/^\Q$status\E$/,@{$types})) {
4204: next;
4205: }
4206: } else {
4207: if ($status ne 'active') {
4208: next;
4209: }
4210: }
1.867 raeburn 4211: my ($rolecode,$username,$domain,$section,$area);
4212: if ($context eq 'userroles') {
1.1186 raeburn 4213: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 4214: (undef,$domain,$username,$section) = split(/\//,$area);
4215: } else {
4216: ($role,$username,$domain,$section) = split(/\:/,$entry);
4217: }
1.832 raeburn 4218: if (ref($roledoms) eq 'ARRAY') {
4219: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4220: next;
4221: }
4222: }
4223: if (ref($roles) eq 'ARRAY') {
4224: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 4225: if ($role =~ /^cr\//) {
4226: if (!grep(/^cr$/,@{$roles})) {
4227: next;
4228: }
1.1104 raeburn 4229: } elsif ($role =~ /^gr\//) {
4230: if (!grep(/^gr$/,@{$roles})) {
4231: next;
4232: }
1.922 raeburn 4233: } else {
4234: next;
4235: }
1.832 raeburn 4236: }
1.867 raeburn 4237: }
1.937 raeburn 4238: if ($hidepriv) {
1.1219 raeburn 4239: my @privroles = ('dc','su');
1.999 raeburn 4240: if ($context eq 'userroles') {
1.1219 raeburn 4241: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 4242: } else {
1.1219 raeburn 4243: my $possdoms = [$domain];
4244: if (ref($roledoms) eq 'ARRAY') {
4245: push(@{$possdoms},@{$roledoms});
1.999 raeburn 4246: }
1.1219 raeburn 4247: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 4248: if (!$nothide{$username.':'.$domain}) {
4249: next;
4250: }
4251: }
1.937 raeburn 4252: }
4253: }
1.933 raeburn 4254: if ($withsec) {
4255: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4256: $tstart.':'.$tend;
4257: } else {
4258: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4259: }
1.832 raeburn 4260: }
1.373 www 4261: return %returnhash;
1.399 www 4262: }
4263:
4264: # ----------------------------------------------------- Frontpage Announcements
4265: #
4266: #
4267:
4268: sub postannounce {
4269: my ($server,$text)=@_;
1.844 albertel 4270: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 4271: unless ($text=~/\w/) { $text=''; }
4272: return &reply('setannounce:'.&escape($text),$server);
4273: }
4274:
4275: sub getannounce {
1.448 albertel 4276:
4277: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 4278: my $announcement='';
1.800 albertel 4279: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 4280: close($fh);
1.399 www 4281: if ($announcement=~/\w/) {
4282: return
4283: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 4284: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 4285: } else {
4286: return '';
4287: }
4288: } else {
4289: return '';
4290: }
1.351 www 4291: }
1.353 www 4292:
4293: # ---------------------------------------------------------- Course ID routines
4294: # Deal with domain's nohist_courseid.db files
4295: #
4296:
4297: sub courseidput {
1.921 raeburn 4298: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 4299: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 4300: my $outcome;
4301: if ($caller eq 'timeonly') {
4302: my $cids = '';
4303: foreach my $item (keys(%$storehash)) {
4304: $cids.=&escape($item).'&';
4305: }
4306: $cids=~s/\&$//;
4307: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4308: $coursehome);
4309: } else {
4310: my $items = '';
4311: foreach my $item (keys(%$storehash)) {
4312: $items.= &escape($item).'='.
4313: &freeze_escape($$storehash{$item}).'&';
4314: }
4315: $items=~s/\&$//;
4316: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4317: $coursehome);
1.918 raeburn 4318: }
4319: if ($outcome eq 'unknown_cmd') {
4320: my $what;
4321: foreach my $cid (keys(%$storehash)) {
4322: $what .= &escape($cid).'=';
1.921 raeburn 4323: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 4324: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 4325: }
4326: $what =~ s/\:$/&/;
4327: }
4328: $what =~ s/\&$//;
4329: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4330: } else {
4331: return $outcome;
4332: }
1.353 www 4333: }
4334:
4335: sub courseiddump {
1.921 raeburn 4336: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 4337: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 4338: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1247 raeburn 4339: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner,
1.1287 raeburn 4340: $hasuniquecode,$reqcrsdom,$reqinstcode)=@_;
1.918 raeburn 4341: my $as_hash = 1;
4342: my %returnhash;
4343: if (!$domfilter) { $domfilter=''; }
1.845 albertel 4344: my %libserv = &all_library();
4345: foreach my $tryserver (keys(%libserv)) {
4346: if ( ( $hostidflag == 1
4347: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4348: || (!defined($hostidflag)) ) {
4349:
1.918 raeburn 4350: if (($domfilter eq '') ||
4351: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 4352: my $rep;
4353: if (grep { $_ eq $tryserver } current_machine_ids()) {
4354: $rep = LONCAPA::Lond::dump_course_id_handler(
4355: join(":", (&host_domain($tryserver), $sincefilter,
4356: &escape($descfilter), &escape($instcodefilter),
4357: &escape($ownerfilter), &escape($coursefilter),
4358: &escape($typefilter), &escape($regexp_ok),
4359: $as_hash, &escape($selfenrollonly),
4360: &escape($catfilter), $showhidden, $caller,
4361: &escape($cloner), &escape($cc_clone), $cloneonly,
4362: &escape($createdbefore), &escape($createdafter),
1.1287 raeburn 4363: &escape($creationcontext),$domcloner,$hasuniquecode,
4364: $reqcrsdom,&escape($reqinstcode))));
1.1180 droeschl 4365: } else {
4366: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4367: $sincefilter.':'.&escape($descfilter).':'.
4368: &escape($instcodefilter).':'.&escape($ownerfilter).
4369: ':'.&escape($coursefilter).':'.&escape($typefilter).
4370: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4371: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4372: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4373: &escape($cc_clone).':'.$cloneonly.':'.
4374: &escape($createdbefore).':'.&escape($createdafter).':'.
1.1287 raeburn 4375: &escape($creationcontext).':'.$domcloner.':'.$hasuniquecode.
4376: ':'.$reqcrsdom.':'.&escape($reqinstcode),$tryserver);
1.1180 droeschl 4377: }
4378:
1.918 raeburn 4379: my @pairs=split(/\&/,$rep);
4380: foreach my $item (@pairs) {
4381: my ($key,$value)=split(/\=/,$item,2);
4382: $key = &unescape($key);
4383: next if ($key =~ /^error: 2 /);
4384: my $result = &thaw_unescape($value);
4385: if (ref($result) eq 'HASH') {
4386: $returnhash{$key}=$result;
4387: } else {
1.921 raeburn 4388: my @responses = split(/:/,$value);
4389: my @items = ('description','inst_code','owner','type');
1.918 raeburn 4390: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 4391: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 4392: }
1.1008 raeburn 4393: }
1.353 www 4394: }
4395: }
4396: }
4397: }
4398: return %returnhash;
4399: }
4400:
1.1055 raeburn 4401: sub courselastaccess {
4402: my ($cdom,$cnum,$hostidref) = @_;
4403: my %returnhash;
4404: if ($cdom && $cnum) {
4405: my $chome = &homeserver($cnum,$cdom);
4406: if ($chome ne 'no_host') {
4407: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4408: &extract_lastaccess(\%returnhash,$rep);
4409: }
4410: } else {
4411: if (!$cdom) { $cdom=''; }
4412: my %libserv = &all_library();
4413: foreach my $tryserver (keys(%libserv)) {
4414: if (ref($hostidref) eq 'ARRAY') {
4415: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4416: }
4417: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4418: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4419: &extract_lastaccess(\%returnhash,$rep);
4420: }
4421: }
4422: }
4423: return %returnhash;
4424: }
4425:
4426: sub extract_lastaccess {
4427: my ($returnhash,$rep) = @_;
4428: if (ref($returnhash) eq 'HASH') {
4429: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4430: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4431: $rep eq '') {
4432: my @pairs=split(/\&/,$rep);
4433: foreach my $item (@pairs) {
4434: my ($key,$value)=split(/\=/,$item,2);
4435: $key = &unescape($key);
4436: next if ($key =~ /^error: 2 /);
4437: $returnhash->{$key} = &thaw_unescape($value);
4438: }
4439: }
4440: }
4441: return;
4442: }
4443:
1.658 raeburn 4444: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 4445:
4446: sub dcmailput {
1.685 raeburn 4447: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 4448: my $status = &Apache::lonnet::critical(
1.740 www 4449: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4450: &escape($message),$server);
1.662 raeburn 4451: return $status;
4452: }
4453:
1.658 raeburn 4454: sub dcmaildump {
4455: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 4456: my %returnhash=();
1.846 albertel 4457:
4458: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 4459: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4460: &escape($enddate).':';
4461: my @esc_senders=map { &escape($_)} @$senders;
4462: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 4463: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 4464: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 4465: if (($key) && ($value)) {
4466: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 4467: }
4468: }
4469: }
4470: return %returnhash;
4471: }
1.662 raeburn 4472: # ---------------------------------------------------------- Domain roles
4473:
4474: sub get_domain_roles {
4475: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 4476: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 4477: $startdate = '.';
4478: }
1.1018 raeburn 4479: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 4480: $enddate = '.';
4481: }
1.922 raeburn 4482: my $rolelist;
4483: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 4484: $rolelist = join('&',@{$roles});
1.922 raeburn 4485: }
1.662 raeburn 4486: my %personnel = ();
1.841 albertel 4487:
4488: my %servers = &get_servers($dom,'library');
4489: foreach my $tryserver (keys(%servers)) {
4490: %{$personnel{$tryserver}}=();
4491: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4492: &escape($startdate).':'.
4493: &escape($enddate).':'.
4494: &escape($rolelist), $tryserver))) {
4495: my ($key,$value) = split(/\=/,$line,2);
4496: if (($key) && ($value)) {
4497: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4498: }
4499: }
1.662 raeburn 4500: }
4501: return %personnel;
4502: }
1.658 raeburn 4503:
1.1057 www 4504: # ----------------------------------------------------------- Interval timing
1.149 www 4505:
1.1153 www 4506: {
4507: # Caches needed for speedup of navmaps
4508: # We don't want to cache this for very long at all (5 seconds at most)
4509: #
4510: # The user for whom we cache
4511: my $cachedkey='';
4512: # The cached times for this user
4513: my %cachedtimes=();
4514: # When this was last done
1.1282 raeburn 4515: my $cachedtime='';
1.1153 www 4516:
4517: sub load_all_first_access {
1.1154 raeburn 4518: my ($uname,$udom)=@_;
1.1156 www 4519: if (($cachedkey eq $uname.':'.$udom) &&
1.1174 raeburn 4520: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
1.1154 raeburn 4521: return;
4522: }
4523: $cachedtime=time;
4524: $cachedkey=$uname.':'.$udom;
4525: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 4526: }
4527:
1.504 albertel 4528: sub get_first_access {
1.1162 raeburn 4529: my ($type,$argsymb,$argmap)=@_;
1.790 albertel 4530: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4531: if ($argsymb) { $symb=$argsymb; }
4532: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 4533: if ($argmap) { $map = $argmap; }
1.926 albertel 4534: if ($type eq 'course') {
4535: $res='course';
4536: } elsif ($type eq 'map') {
1.588 albertel 4537: $res=&symbread($map);
4538: } else {
4539: $res=$symb;
4540: }
1.1153 www 4541: &load_all_first_access($uname,$udom);
4542: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 4543: }
4544:
4545: sub set_first_access {
1.1162 raeburn 4546: my ($type,$interval)=@_;
1.790 albertel 4547: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4548: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 4549: if ($type eq 'course') {
4550: $res='course';
4551: } elsif ($type eq 'map') {
1.588 albertel 4552: $res=&symbread($map);
4553: } else {
4554: $res=$symb;
4555: }
1.1153 www 4556: $cachedkey='';
1.1162 raeburn 4557: my $firstaccess=&get_first_access($type,$symb,$map);
1.505 albertel 4558: if (!$firstaccess) {
1.1162 raeburn 4559: my $start = time;
4560: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4561: $udom,$uname);
4562: if ($putres eq 'ok') {
4563: &put('timerinterval',{"$courseid\0$res"=>$interval},
4564: $udom,$uname);
4565: &appenv(
4566: {
4567: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4568: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4569: }
4570: );
4571: }
4572: return $putres;
1.505 albertel 4573: }
4574: return 'already_set';
1.504 albertel 4575: }
1.1153 www 4576: }
1.1282 raeburn 4577:
1.110 www 4578: # --------------------------------------------- Set Expire Date for Spreadsheet
4579:
4580: sub expirespread {
4581: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 4582: my $cid=$env{'request.course.id'};
1.110 www 4583: if ($cid) {
4584: my $now=time;
4585: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 4586: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4587: $env{'course.'.$cid.'.num'}.
1.110 www 4588: ':nohist_expirationdates:'.
4589: &escape($key).'='.$now,
1.620 albertel 4590: $env{'course.'.$cid.'.home'})
1.110 www 4591: }
4592: return 'ok';
1.14 www 4593: }
4594:
1.109 www 4595: # ----------------------------------------------------- Devalidate Spreadsheets
4596:
4597: sub devalidate {
1.325 www 4598: my ($symb,$uname,$udom)=@_;
1.620 albertel 4599: my $cid=$env{'request.course.id'};
1.109 www 4600: if ($cid) {
1.391 matthew 4601: # delete the stored spreadsheets for
4602: # - the student level sheet of this user in course's homespace
4603: # - the assessment level sheet for this resource
4604: # for this user in user's homespace
1.553 albertel 4605: # - current conditional state info
1.325 www 4606: my $key=$uname.':'.$udom.':';
1.109 www 4607: my $status=
1.299 matthew 4608: &del('nohist_calculatedsheets',
1.391 matthew 4609: [$key.'studentcalc:'],
1.620 albertel 4610: $env{'course.'.$cid.'.domain'},
4611: $env{'course.'.$cid.'.num'})
1.133 albertel 4612: .' '.
4613: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 4614: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 4615: unless ($status eq 'ok ok') {
4616: &logthis('Could not devalidate spreadsheet '.
1.325 www 4617: $uname.' at '.$udom.' for '.
1.109 www 4618: $symb.': '.$status);
1.133 albertel 4619: }
1.553 albertel 4620: &delenv('user.state.'.$cid);
1.109 www 4621: }
4622: }
4623:
1.265 albertel 4624: sub get_scalar {
4625: my ($string,$end) = @_;
4626: my $value;
4627: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4628: $value = $1;
4629: } elsif ($$string =~ s/^([^&]*?)&//) {
4630: $value = $1;
4631: }
4632: return &unescape($value);
4633: }
4634:
4635: sub array2str {
4636: my (@array) = @_;
4637: my $result=&arrayref2str(\@array);
4638: $result=~s/^__ARRAY_REF__//;
4639: $result=~s/__END_ARRAY_REF__$//;
4640: return $result;
4641: }
4642:
1.204 albertel 4643: sub arrayref2str {
4644: my ($arrayref) = @_;
1.265 albertel 4645: my $result='__ARRAY_REF__';
1.204 albertel 4646: foreach my $elem (@$arrayref) {
1.265 albertel 4647: if(ref($elem) eq 'ARRAY') {
4648: $result.=&arrayref2str($elem).'&';
4649: } elsif(ref($elem) eq 'HASH') {
4650: $result.=&hashref2str($elem).'&';
4651: } elsif(ref($elem)) {
4652: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 4653: } else {
4654: $result.=&escape($elem).'&';
4655: }
4656: }
4657: $result=~s/\&$//;
1.265 albertel 4658: $result .= '__END_ARRAY_REF__';
1.204 albertel 4659: return $result;
4660: }
4661:
1.168 albertel 4662: sub hash2str {
1.204 albertel 4663: my (%hash) = @_;
4664: my $result=&hashref2str(\%hash);
1.265 albertel 4665: $result=~s/^__HASH_REF__//;
4666: $result=~s/__END_HASH_REF__$//;
1.204 albertel 4667: return $result;
4668: }
4669:
4670: sub hashref2str {
4671: my ($hashref)=@_;
1.265 albertel 4672: my $result='__HASH_REF__';
1.800 albertel 4673: foreach my $key (sort(keys(%$hashref))) {
4674: if (ref($key) eq 'ARRAY') {
4675: $result.=&arrayref2str($key).'=';
4676: } elsif (ref($key) eq 'HASH') {
4677: $result.=&hashref2str($key).'=';
4678: } elsif (ref($key)) {
1.265 albertel 4679: $result.='=';
1.800 albertel 4680: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 4681: } else {
1.1132 raeburn 4682: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 4683: }
4684:
1.800 albertel 4685: if(ref($hashref->{$key}) eq 'ARRAY') {
4686: $result.=&arrayref2str($hashref->{$key}).'&';
4687: } elsif(ref($hashref->{$key}) eq 'HASH') {
4688: $result.=&hashref2str($hashref->{$key}).'&';
4689: } elsif(ref($hashref->{$key})) {
1.265 albertel 4690: $result.='&';
1.800 albertel 4691: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 4692: } else {
1.800 albertel 4693: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 4694: }
4695: }
1.168 albertel 4696: $result=~s/\&$//;
1.265 albertel 4697: $result .= '__END_HASH_REF__';
1.168 albertel 4698: return $result;
4699: }
4700:
4701: sub str2hash {
1.265 albertel 4702: my ($string)=@_;
4703: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4704: return %$hash;
4705: }
4706:
4707: sub str2hashref {
1.168 albertel 4708: my ($string) = @_;
1.265 albertel 4709:
4710: my %hash;
4711:
4712: if($string !~ /^__HASH_REF__/) {
4713: if (! ($string eq '' || !defined($string))) {
4714: $hash{'error'}='Not hash reference';
4715: }
4716: return (\%hash, $string);
4717: }
4718:
4719: $string =~ s/^__HASH_REF__//;
4720:
4721: while($string !~ /^__END_HASH_REF__/) {
4722: #key
4723: my $key='';
4724: if($string =~ /^__HASH_REF__/) {
4725: ($key, $string)=&str2hashref($string);
4726: if(defined($key->{'error'})) {
4727: $hash{'error'}='Bad data';
4728: return (\%hash, $string);
4729: }
4730: } elsif($string =~ /^__ARRAY_REF__/) {
4731: ($key, $string)=&str2arrayref($string);
4732: if($key->[0] eq 'Array reference error') {
4733: $hash{'error'}='Bad data';
4734: return (\%hash, $string);
4735: }
4736: } else {
4737: $string =~ s/^(.*?)=//;
1.267 albertel 4738: $key=&unescape($1);
1.265 albertel 4739: }
4740: $string =~ s/^=//;
4741:
4742: #value
4743: my $value='';
4744: if($string =~ /^__HASH_REF__/) {
4745: ($value, $string)=&str2hashref($string);
4746: if(defined($value->{'error'})) {
4747: $hash{'error'}='Bad data';
4748: return (\%hash, $string);
4749: }
4750: } elsif($string =~ /^__ARRAY_REF__/) {
4751: ($value, $string)=&str2arrayref($string);
4752: if($value->[0] eq 'Array reference error') {
4753: $hash{'error'}='Bad data';
4754: return (\%hash, $string);
4755: }
4756: } else {
4757: $value=&get_scalar(\$string,'__END_HASH_REF__');
4758: }
4759: $string =~ s/^&//;
4760:
4761: $hash{$key}=$value;
1.204 albertel 4762: }
1.265 albertel 4763:
4764: $string =~ s/^__END_HASH_REF__//;
4765:
4766: return (\%hash, $string);
1.204 albertel 4767: }
4768:
4769: sub str2array {
1.265 albertel 4770: my ($string)=@_;
4771: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4772: return @$array;
4773: }
4774:
4775: sub str2arrayref {
1.204 albertel 4776: my ($string) = @_;
1.265 albertel 4777: my @array;
4778:
4779: if($string !~ /^__ARRAY_REF__/) {
4780: if (! ($string eq '' || !defined($string))) {
4781: $array[0]='Array reference error';
4782: }
4783: return (\@array, $string);
4784: }
4785:
4786: $string =~ s/^__ARRAY_REF__//;
4787:
4788: while($string !~ /^__END_ARRAY_REF__/) {
4789: my $value='';
4790: if($string =~ /^__HASH_REF__/) {
4791: ($value, $string)=&str2hashref($string);
4792: if(defined($value->{'error'})) {
4793: $array[0] ='Array reference error';
4794: return (\@array, $string);
4795: }
4796: } elsif($string =~ /^__ARRAY_REF__/) {
4797: ($value, $string)=&str2arrayref($string);
4798: if($value->[0] eq 'Array reference error') {
4799: $array[0] ='Array reference error';
4800: return (\@array, $string);
4801: }
4802: } else {
4803: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4804: }
4805: $string =~ s/^&//;
4806:
4807: push(@array, $value);
1.191 harris41 4808: }
1.265 albertel 4809:
4810: $string =~ s/^__END_ARRAY_REF__//;
4811:
4812: return (\@array, $string);
1.168 albertel 4813: }
4814:
1.167 albertel 4815: # -------------------------------------------------------------------Temp Store
4816:
1.168 albertel 4817: sub tmpreset {
4818: my ($symb,$namespace,$domain,$stuname) = @_;
4819: if (!$symb) {
4820: $symb=&symbread();
1.620 albertel 4821: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4822: }
4823: $symb=escape($symb);
4824:
1.620 albertel 4825: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 4826: $namespace=~s/\//\_/g;
4827: $namespace=~s/\W//g;
4828:
1.620 albertel 4829: if (!$domain) { $domain=$env{'user.domain'}; }
4830: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4831: if ($domain eq 'public' && $stuname eq 'public') {
4832: $stuname=$ENV{'REMOTE_ADDR'};
4833: }
1.1117 foxr 4834: my $path=LONCAPA::tempdir();
1.168 albertel 4835: my %hash;
4836: if (tie(%hash,'GDBM_File',
4837: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4838: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 4839: foreach my $key (keys(%hash)) {
1.180 albertel 4840: if ($key=~ /:$symb/) {
1.168 albertel 4841: delete($hash{$key});
4842: }
4843: }
4844: }
4845: }
4846:
1.167 albertel 4847: sub tmpstore {
1.168 albertel 4848: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4849:
4850: if (!$symb) {
4851: $symb=&symbread();
1.620 albertel 4852: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4853: }
4854: $symb=escape($symb);
4855:
4856: if (!$namespace) {
4857: # I don't think we would ever want to store this for a course.
4858: # it seems this will only be used if we don't have a course.
1.620 albertel 4859: #$namespace=$env{'request.course.id'};
1.168 albertel 4860: #if (!$namespace) {
1.620 albertel 4861: $namespace=$env{'request.state'};
1.168 albertel 4862: #}
4863: }
4864: $namespace=~s/\//\_/g;
4865: $namespace=~s/\W//g;
1.620 albertel 4866: if (!$domain) { $domain=$env{'user.domain'}; }
4867: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4868: if ($domain eq 'public' && $stuname eq 'public') {
4869: $stuname=$ENV{'REMOTE_ADDR'};
4870: }
1.168 albertel 4871: my $now=time;
4872: my %hash;
1.1117 foxr 4873: my $path=LONCAPA::tempdir();
1.168 albertel 4874: if (tie(%hash,'GDBM_File',
4875: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4876: &GDBM_WRCREAT(),0640)) {
1.168 albertel 4877: $hash{"version:$symb"}++;
4878: my $version=$hash{"version:$symb"};
4879: my $allkeys='';
4880: foreach my $key (keys(%$storehash)) {
4881: $allkeys.=$key.':';
1.591 albertel 4882: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 4883: }
4884: $hash{"$version:$symb:timestamp"}=$now;
4885: $allkeys.='timestamp';
4886: $hash{"$version:keys:$symb"}=$allkeys;
4887: if (untie(%hash)) {
4888: return 'ok';
4889: } else {
4890: return "error:$!";
4891: }
4892: } else {
4893: return "error:$!";
4894: }
4895: }
1.167 albertel 4896:
1.168 albertel 4897: # -----------------------------------------------------------------Temp Restore
1.167 albertel 4898:
1.168 albertel 4899: sub tmprestore {
4900: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 4901:
1.168 albertel 4902: if (!$symb) {
4903: $symb=&symbread();
1.620 albertel 4904: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4905: }
4906: $symb=escape($symb);
4907:
1.620 albertel 4908: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 4909:
1.620 albertel 4910: if (!$domain) { $domain=$env{'user.domain'}; }
4911: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4912: if ($domain eq 'public' && $stuname eq 'public') {
4913: $stuname=$ENV{'REMOTE_ADDR'};
4914: }
1.168 albertel 4915: my %returnhash;
4916: $namespace=~s/\//\_/g;
4917: $namespace=~s/\W//g;
4918: my %hash;
1.1117 foxr 4919: my $path=LONCAPA::tempdir();
1.168 albertel 4920: if (tie(%hash,'GDBM_File',
4921: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4922: &GDBM_READER(),0640)) {
1.168 albertel 4923: my $version=$hash{"version:$symb"};
4924: $returnhash{'version'}=$version;
4925: my $scope;
4926: for ($scope=1;$scope<=$version;$scope++) {
4927: my $vkeys=$hash{"$scope:keys:$symb"};
4928: my @keys=split(/:/,$vkeys);
4929: my $key;
4930: $returnhash{"$scope:keys"}=$vkeys;
4931: foreach $key (@keys) {
1.591 albertel 4932: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4933: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 4934: }
4935: }
1.168 albertel 4936: if (!(untie(%hash))) {
4937: return "error:$!";
4938: }
4939: } else {
4940: return "error:$!";
4941: }
4942: return %returnhash;
1.167 albertel 4943: }
4944:
1.9 www 4945: # ----------------------------------------------------------------------- Store
4946:
4947: sub store {
1.1269 raeburn 4948: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 4949: my $home='';
4950:
1.168 albertel 4951: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4952:
1.213 www 4953: $symb=&symbclean($symb);
1.122 albertel 4954: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 4955:
1.620 albertel 4956: if (!$domain) { $domain=$env{'user.domain'}; }
4957: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 4958:
4959: &devalidate($symb,$stuname,$domain);
1.109 www 4960:
4961: $symb=escape($symb);
1.187 www 4962: if (!$namespace) {
1.620 albertel 4963: unless ($namespace=$env{'request.course.id'}) {
1.187 www 4964: return '';
4965: }
4966: }
1.620 albertel 4967: if (!$home) { $home=$env{'user.home'}; }
1.447 www 4968:
4969: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4970: $$storehash{'host'}=$perlvar{'lonHostID'};
4971:
1.12 www 4972: my $namevalue='';
1.800 albertel 4973: foreach my $key (keys(%$storehash)) {
4974: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 4975: }
1.12 www 4976: $namevalue=~s/\&$//;
1.187 www 4977: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.1269 raeburn 4978: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.9 www 4979: }
4980:
1.47 www 4981: # -------------------------------------------------------------- Critical Store
4982:
4983: sub cstore {
1.1269 raeburn 4984: my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
1.124 www 4985: my $home='';
4986:
1.168 albertel 4987: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4988:
1.213 www 4989: $symb=&symbclean($symb);
1.122 albertel 4990: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 4991:
1.620 albertel 4992: if (!$domain) { $domain=$env{'user.domain'}; }
4993: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 4994:
4995: &devalidate($symb,$stuname,$domain);
1.109 www 4996:
4997: $symb=escape($symb);
1.187 www 4998: if (!$namespace) {
1.620 albertel 4999: unless ($namespace=$env{'request.course.id'}) {
1.187 www 5000: return '';
5001: }
5002: }
1.620 albertel 5003: if (!$home) { $home=$env{'user.home'}; }
1.447 www 5004:
5005: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
5006: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 5007:
1.47 www 5008: my $namevalue='';
1.800 albertel 5009: foreach my $key (keys(%$storehash)) {
5010: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 5011: }
1.47 www 5012: $namevalue=~s/\&$//;
1.187 www 5013: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 5014: return critical
1.1269 raeburn 5015: ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
1.47 www 5016: }
5017:
1.9 www 5018: # --------------------------------------------------------------------- Restore
5019:
5020: sub restore {
1.124 www 5021: my ($symb,$namespace,$domain,$stuname) = @_;
5022: my $home='';
5023:
1.168 albertel 5024: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 5025:
1.122 albertel 5026: if (!$symb) {
1.1224 raeburn 5027: return if ($namespace eq 'courserequests');
5028: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 5029: } else {
1.1224 raeburn 5030: unless ($namespace eq 'courserequests') {
5031: $symb=&escape(&symbclean($symb));
5032: }
1.122 albertel 5033: }
1.188 www 5034: if (!$namespace) {
1.620 albertel 5035: unless ($namespace=$env{'request.course.id'}) {
1.188 www 5036: return '';
5037: }
5038: }
1.620 albertel 5039: if (!$domain) { $domain=$env{'user.domain'}; }
5040: if (!$stuname) { $stuname=$env{'user.name'}; }
5041: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 5042: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
5043:
1.12 www 5044: my %returnhash=();
1.800 albertel 5045: foreach my $line (split(/\&/,$answer)) {
5046: my ($name,$value)=split(/\=/,$line);
1.591 albertel 5047: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 5048: }
1.75 www 5049: my $version;
5050: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 5051: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
5052: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 5053: }
1.75 www 5054: }
1.13 www 5055: return %returnhash;
1.34 www 5056: }
5057:
5058: # ---------------------------------------------------------- Course Description
1.1118 foxr 5059: #
5060: #
1.34 www 5061:
5062: sub coursedescription {
1.731 albertel 5063: my ($courseid,$args)=@_;
1.34 www 5064: $courseid=~s/^\///;
1.49 www 5065: $courseid=~s/\_/\//g;
1.34 www 5066: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 5067: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 5068: my $normalid=$cdomain.'_'.$cnum;
5069: # need to always cache even if we get errors otherwise we keep
5070: # trying and trying and trying to get the course description.
5071: my %envhash=();
5072: my %returnhash=();
1.731 albertel 5073:
5074: my $expiretime=600;
5075: if ($env{'request.course.id'} eq $normalid) {
5076: $expiretime=120;
5077: }
5078:
5079: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
5080: if (!$args->{'freshen_cache'}
5081: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
5082: foreach my $key (keys(%env)) {
5083: next if ($key !~ /^\Q$prefix\E(.*)/);
5084: my ($setting) = $1;
5085: $returnhash{$setting} = $env{$key};
5086: }
5087: return %returnhash;
5088: }
5089:
1.1118 foxr 5090: # get the data again
5091:
1.731 albertel 5092: if (!$args->{'one_time'}) {
5093: $envhash{'course.'.$normalid.'.last_cache'}=time;
5094: }
1.811 albertel 5095:
1.34 www 5096: if ($chome ne 'no_host') {
1.302 albertel 5097: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 5098: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 5099: my $username = $env{'user.name'}; # Defult username
5100: if(defined $args->{'user'}) {
5101: $username = $args->{'user'};
5102: }
1.129 albertel 5103: $returnhash{'home'}= $chome;
5104: $returnhash{'domain'} = $cdomain;
5105: $returnhash{'num'} = $cnum;
1.741 raeburn 5106: if (!defined($returnhash{'type'})) {
5107: $returnhash{'type'} = 'Course';
5108: }
1.130 albertel 5109: while (my ($name,$value) = each %returnhash) {
1.53 www 5110: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 5111: }
1.270 www 5112: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 5113: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 5114: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 5115: $envhash{'course.'.$normalid.'.home'}=$chome;
5116: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
5117: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 5118: }
5119: }
1.731 albertel 5120: if (!$args->{'one_time'}) {
1.949 raeburn 5121: &appenv(\%envhash);
1.731 albertel 5122: }
1.302 albertel 5123: return %returnhash;
1.461 www 5124: }
5125:
1.1080 raeburn 5126: sub update_released_required {
5127: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
5128: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
5129: $cid = $env{'request.course.id'};
5130: $cdom = $env{'course.'.$cid.'.domain'};
5131: $cnum = $env{'course.'.$cid.'.num'};
5132: $chome = $env{'course.'.$cid.'.home'};
5133: }
5134: if ($needsrelease) {
5135: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
5136: my $needsupdate;
5137: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
5138: $needsupdate = 1;
5139: } else {
5140: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
5141: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
5142: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
5143: $needsupdate = 1;
5144: }
5145: }
5146: if ($needsupdate) {
5147: my %needshash = (
5148: 'internal.releaserequired' => $needsrelease,
5149: );
5150: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
5151: if ($putresult eq 'ok') {
5152: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
5153: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
5154: if (ref($crsinfo{$cid}) eq 'HASH') {
5155: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
5156: &courseidput($cdom,\%crsinfo,$chome,'notime');
5157: }
5158: }
5159: }
5160: }
5161: return;
5162: }
5163:
1.461 www 5164: # -------------------------------------------------See if a user is privileged
5165:
5166: sub privileged {
1.1219 raeburn 5167: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 5168: my $now = time;
1.1219 raeburn 5169: my $roles;
5170: if (ref($possroles) eq 'ARRAY') {
5171: $roles = $possroles;
5172: } else {
5173: $roles = ['dc','su'];
5174: }
5175: if (ref($possdomains) eq 'ARRAY') {
5176: my %privileged = &privileged_by_domain($possdomains,$roles);
5177: foreach my $dom (@{$possdomains}) {
5178: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
5179: (ref($privileged{$dom}) eq 'HASH')) {
5180: foreach my $role (@{$roles}) {
5181: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5182: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
5183: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
5184: return 1 unless (($end && $end < $now) ||
5185: ($start && $start > $now));
5186: }
5187: }
5188: }
5189: }
5190: }
5191: } else {
5192: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5193: my $now = time;
1.1170 droeschl 5194:
1.1275 musolffc 5195: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
1.1170 droeschl 5196: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 5197: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 5198: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 5199: or ($tstart && $tstart > $now);
1.1170 droeschl 5200: }
1.1219 raeburn 5201: }
5202: }
5203: return 0;
5204: }
1.1170 droeschl 5205:
1.1219 raeburn 5206: sub privileged_by_domain {
5207: my ($domains,$roles) = @_;
5208: my %privileged = ();
5209: my $cachetime = 60*60*24;
5210: my $now = time;
5211: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5212: return %privileged;
5213: }
5214: foreach my $dom (@{$domains}) {
5215: next if (ref($privileged{$dom}) eq 'HASH');
5216: my $needroles;
5217: foreach my $role (@{$roles}) {
5218: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5219: if (defined($cached)) {
5220: if (ref($result) eq 'HASH') {
5221: $privileged{$dom}{$role} = $result;
5222: }
5223: } else {
5224: $needroles = 1;
5225: }
5226: }
5227: if ($needroles) {
5228: my %dompersonnel = &get_domain_roles($dom,$roles);
5229: $privileged{$dom} = {};
5230: foreach my $server (keys(%dompersonnel)) {
5231: if (ref($dompersonnel{$server}) eq 'HASH') {
5232: foreach my $item (keys(%{$dompersonnel{$server}})) {
5233: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5234: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5235: next if ($end && $end < $now);
5236: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5237: $dompersonnel{$server}{$item};
5238: }
5239: }
5240: }
5241: if (ref($privileged{$dom}) eq 'HASH') {
5242: foreach my $role (@{$roles}) {
5243: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5244: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5245: } else {
5246: my %hash = ();
5247: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5248: }
5249: }
5250: }
5251: }
5252: }
5253: return %privileged;
1.9 www 5254: }
1.1 albertel 5255:
1.103 harris41 5256: # -------------------------------------------------------- Get user privileges
1.11 www 5257:
5258: sub rolesinit {
1.1169 droeschl 5259: my ($domain, $username) = @_;
5260: my %userroles = ('user.login.time' => time);
5261: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5262:
5263: # firstaccess and timerinterval are related to timed maps/resources.
5264: # also, blocking can be triggered by an activating timer
5265: # it's saved in the user's %env.
5266: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5267: my %timerinterval = &dump('timerinterval', $domain, $username);
5268: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5269: %timerintchk, %timerintenv);
5270:
1.1162 raeburn 5271: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 5272: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 5273: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5274: }
1.1169 droeschl 5275:
1.1162 raeburn 5276: foreach my $key (keys(%timerinterval)) {
5277: my ($cid,$rest) = split(/\0/,$key);
5278: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5279: }
1.1169 droeschl 5280:
1.11 www 5281: my %allroles=();
1.1162 raeburn 5282: my %allgroups=();
1.11 www 5283:
1.1274 raeburn 5284: for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
1.1169 droeschl 5285: my $role = $rolesdump{$area};
5286: $area =~ s/\_\w\w$//;
5287:
5288: my ($trole, $tend, $tstart, $group_privs);
5289:
5290: if ($role =~ /^cr/) {
5291: # Custom role, defined by a user
5292: # e.g., user.role.cr/msu/smith/mynewrole
5293: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5294: $trole = $1;
5295: ($tend, $tstart) = split('_', $2);
5296: } else {
5297: $trole = $role;
5298: }
5299: } elsif ($role =~ m|^gr/|) {
5300: # Role of member in a group, defined within a course/community
5301: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5302: ($trole, $tend, $tstart) = split(/_/, $role);
5303: next if $tstart eq '-1';
5304: ($trole, $group_privs) = split(/\//, $trole);
5305: $group_privs = &unescape($group_privs);
5306: } else {
5307: # Just a normal role, defined in roles.tab
5308: ($trole, $tend, $tstart) = split(/_/,$role);
5309: }
5310:
5311: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5312: $username);
5313: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5314:
5315: # role expired or not available yet?
5316: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5317: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5318:
5319: next if $area eq '' or $trole eq '';
5320:
5321: my $spec = "$trole.$area";
5322: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5323:
5324: if ($trole =~ /^cr\//) {
5325: # Custom role, defined by a user
5326: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5327: } elsif ($trole eq 'gr') {
5328: # Role of a member in a group, defined within a course/community
5329: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5330: next;
5331: } else {
5332: # Normal role, defined in roles.tab
5333: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5334: }
5335:
5336: my $cid = $tdomain.'_'.$trest;
5337: unless ($firstaccchk{$cid}) {
5338: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5339: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5340: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5341: $coursetimerstarts{$cid}{$item};
5342: }
5343: }
5344: $firstaccchk{$cid} = 1;
5345: }
5346: unless ($timerintchk{$cid}) {
5347: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5348: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5349: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5350: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 5351: }
1.12 www 5352: }
1.1169 droeschl 5353: $timerintchk{$cid} = 1;
1.191 harris41 5354: }
1.11 www 5355: }
1.1169 droeschl 5356:
5357: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
5358: \%allroles, \%allgroups);
5359: $env{'user.adv'} = $userroles{'user.adv'};
5360:
1.1162 raeburn 5361: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 5362: }
5363:
1.567 raeburn 5364: sub set_arearole {
1.1215 raeburn 5365: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5366: unless ($nolog) {
1.567 raeburn 5367: # log the associated role with the area
1.1215 raeburn 5368: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5369: }
1.743 albertel 5370: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 5371: }
5372:
5373: sub custom_roleprivs {
5374: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5375: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
1.1250 raeburn 5376: my $homsvr = &homeserver($rauthor,$rdomain);
1.838 albertel 5377: if (&hostname($homsvr) ne '') {
1.567 raeburn 5378: my ($rdummy,$roledef)=
5379: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5380: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5381: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5382: if (defined($syspriv)) {
1.1043 raeburn 5383: if ($trest =~ /^$match_community$/) {
5384: $syspriv =~ s/bre\&S//;
5385: }
1.567 raeburn 5386: $$allroles{'cm./'}.=':'.$syspriv;
5387: $$allroles{$spec.'./'}.=':'.$syspriv;
5388: }
5389: if ($tdomain ne '') {
5390: if (defined($dompriv)) {
5391: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5392: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5393: }
5394: if (($trest ne '') && (defined($coursepriv))) {
5395: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5396: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5397: }
5398: }
5399: }
5400: }
5401: }
5402:
1.678 raeburn 5403: sub group_roleprivs {
5404: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5405: my $access = 1;
5406: my $now = time;
5407: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5408: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5409: if ($access) {
1.811 albertel 5410: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 5411: $$allgroups{$course}{$group} .=':'.$group_privs;
5412: }
5413: }
1.567 raeburn 5414:
5415: sub standard_roleprivs {
5416: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5417: if (defined($pr{$trole.':s'})) {
5418: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5419: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5420: }
5421: if ($tdomain ne '') {
5422: if (defined($pr{$trole.':d'})) {
5423: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5424: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5425: }
5426: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5427: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5428: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5429: }
5430: }
5431: }
5432:
5433: sub set_userprivs {
1.1064 raeburn 5434: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 5435: my $author=0;
5436: my $adv=0;
1.678 raeburn 5437: my %grouproles = ();
5438: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 5439: my @groupkeys;
1.1000 raeburn 5440: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 5441: push(@groupkeys,$role);
5442: }
5443: if (ref($groups_roles) eq 'HASH') {
5444: foreach my $key (keys(%{$groups_roles})) {
5445: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5446: push(@groupkeys,$key);
5447: }
5448: }
5449: }
5450: if (@groupkeys > 0) {
5451: foreach my $role (@groupkeys) {
5452: my ($trole,$area,$sec,$extendedarea);
5453: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5454: $trole = $1;
5455: $area = $2;
5456: $sec = $3;
5457: $extendedarea = $area.$sec;
5458: if (exists($$allgroups{$area})) {
5459: foreach my $group (keys(%{$$allgroups{$area}})) {
5460: my $spec = $trole.'.'.$extendedarea;
5461: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 5462: $$allgroups{$area}{$group};
1.1064 raeburn 5463: }
1.678 raeburn 5464: }
5465: }
5466: }
5467: }
5468: }
1.800 albertel 5469: foreach my $group (keys(%grouproles)) {
5470: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 5471: }
1.800 albertel 5472: foreach my $role (keys(%{$allroles})) {
5473: my %thesepriv;
1.941 raeburn 5474: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 5475: foreach my $item (split(/:/,$$allroles{$role})) {
5476: if ($item ne '') {
5477: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 5478: if ($restrictions eq '') {
5479: $thesepriv{$privilege}='F';
5480: } elsif ($thesepriv{$privilege} ne 'F') {
5481: $thesepriv{$privilege}.=$restrictions;
5482: }
5483: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
5484: }
5485: }
5486: my $thesestr='';
1.1104 raeburn 5487: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 5488: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5489: }
5490: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 5491: }
5492: return ($author,$adv);
5493: }
5494:
1.994 raeburn 5495: sub role_status {
1.1104 raeburn 5496: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 5497: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
1.1250 raeburn 5498: my ($one,$two) = split(m{\./},$rolekey,2);
5499: (undef,undef,$$role) = split(/\./,$one,3);
1.994 raeburn 5500: unless (!defined($$role) || $$role eq '') {
1.1251 raeburn 5501: $$where = '/'.$two;
1.994 raeburn 5502: $$trolecode=$$role.'.'.$$where;
5503: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5504: $$tstatus='is';
1.1104 raeburn 5505: if ($$tstart && $$tstart>$update) {
1.994 raeburn 5506: $$tstatus='future';
1.1034 raeburn 5507: if ($$tstart<$now) {
5508: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 5509: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 5510: my (%allroles,%allgroups,$group_privs,
5511: %groups_roles,@rolecodes);
1.1002 raeburn 5512: my %userroles = (
5513: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5514: );
1.1064 raeburn 5515: @rolecodes = ('cm');
1.1002 raeburn 5516: my $spec=$$role.'.'.$$where;
5517: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5518: if ($$role =~ /^cr\//) {
5519: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 5520: push(@rolecodes,'cr');
1.1002 raeburn 5521: } elsif ($$role eq 'gr') {
1.1064 raeburn 5522: push(@rolecodes,$$role);
1.1002 raeburn 5523: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5524: $env{'user.name'});
1.1064 raeburn 5525: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 5526: (undef,my $group_privs) = split(/\//,$trole);
5527: $group_privs = &unescape($group_privs);
5528: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 5529: 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 5530: &get_groups_roles($tdomain,$trest,
5531: \%course_roles,\@rolecodes,
5532: \%groups_roles);
1.1002 raeburn 5533: } else {
1.1064 raeburn 5534: push(@rolecodes,$$role);
1.1002 raeburn 5535: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5536: }
1.1064 raeburn 5537: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
5538: &appenv(\%userroles,\@rolecodes);
1.1002 raeburn 5539: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5540: }
5541: }
1.1034 raeburn 5542: $$tstatus = 'is';
1.1002 raeburn 5543: }
1.994 raeburn 5544: }
5545: if ($$tend) {
1.1104 raeburn 5546: if ($$tend<$update) {
1.994 raeburn 5547: $$tstatus='expired';
5548: } elsif ($$tend<$now) {
5549: $$tstatus='will_not';
5550: }
5551: }
5552: }
5553: }
5554: }
5555:
1.1104 raeburn 5556: sub get_groups_roles {
5557: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5558: return unless((ref($cdom_courseroles) eq 'HASH') &&
5559: (ref($rolecodes) eq 'ARRAY') &&
5560: (ref($groups_roles) eq 'HASH'));
5561: if (keys(%{$cdom_courseroles}) > 0) {
5562: my ($cnum) = ($rest =~ /^($match_courseid)/);
5563: if ($cdom ne '' && $cnum ne '') {
5564: foreach my $key (keys(%{$cdom_courseroles})) {
5565: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5566: my $crsrole = $1;
5567: my $crssec = $2;
5568: if ($crsrole =~ /^cr/) {
5569: unless (grep(/^cr$/,@{$rolecodes})) {
5570: push(@{$rolecodes},'cr');
5571: }
5572: } else {
5573: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5574: push(@{$rolecodes},$crsrole);
5575: }
5576: }
5577: my $rolekey = "$crsrole./$cdom/$cnum";
5578: if ($crssec ne '') {
5579: $rolekey .= "/$crssec";
5580: }
5581: $rolekey .= './';
5582: $groups_roles->{$rolekey} = $rolecodes;
5583: }
5584: }
5585: }
5586: }
5587: return;
5588: }
5589:
5590: sub delete_env_groupprivs {
5591: my ($where,$courseroles,$possroles) = @_;
5592: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5593: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5594: unless (ref($courseroles->{$udom}) eq 'HASH') {
5595: %{$courseroles->{$udom}} =
5596: &get_my_roles('','','userroles',['active'],
5597: $possroles,[$udom],1);
5598: }
5599: if (ref($courseroles->{$udom}) eq 'HASH') {
5600: foreach my $item (keys(%{$courseroles->{$udom}})) {
5601: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5602: my $area = '/'.$cdom.'/'.$cnum;
5603: my $privkey = "user.priv.$crsrole.$area";
5604: if ($crssec ne '') {
5605: $privkey .= '/'.$crssec;
5606: }
5607: $privkey .= ".$area/$group";
5608: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5609: }
5610: }
5611: return;
5612: }
5613:
1.994 raeburn 5614: sub check_adhoc_privs {
1.1104 raeburn 5615: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
1.994 raeburn 5616: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1185 raeburn 5617: my $setprivs;
1.994 raeburn 5618: if ($env{$cckey}) {
5619: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 5620: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 5621: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1088 raeburn 5622: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.1185 raeburn 5623: $setprivs = 1;
1.994 raeburn 5624: }
5625: } else {
1.1088 raeburn 5626: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.1185 raeburn 5627: $setprivs = 1;
1.994 raeburn 5628: }
1.1185 raeburn 5629: return $setprivs;
1.994 raeburn 5630: }
5631:
5632: sub set_adhoc_privileges {
5633: # role can be cc or ca
1.1088 raeburn 5634: my ($dcdom,$pickedcourse,$role,$caller) = @_;
1.994 raeburn 5635: my $area = '/'.$dcdom.'/'.$pickedcourse;
5636: my $spec = $role.'.'.$area;
5637: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 5638: $env{'user.name'},1);
1.994 raeburn 5639: my %ccrole = ();
5640: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
5641: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
5642: &appenv(\%userroles,[$role,'cm']);
5643: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
1.1088 raeburn 5644: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
5645: &appenv( {'request.role' => $spec,
5646: 'request.role.domain' => $dcdom,
5647: 'request.course.sec' => ''
5648: }
5649: );
5650: my $tadv=0;
5651: if (&allowed('adv') eq 'F') { $tadv=1; }
5652: &appenv({'request.role.adv' => $tadv});
5653: }
1.994 raeburn 5654: }
5655:
1.12 www 5656: # --------------------------------------------------------------- get interface
5657:
5658: sub get {
1.131 albertel 5659: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 5660: my $items='';
1.800 albertel 5661: foreach my $item (@$storearr) {
5662: $items.=&escape($item).'&';
1.191 harris41 5663: }
1.12 www 5664: $items=~s/\&$//;
1.620 albertel 5665: if (!$udomain) { $udomain=$env{'user.domain'}; }
5666: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 5667: my $uhome=&homeserver($uname,$udomain);
5668:
1.133 albertel 5669: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 5670: my @pairs=split(/\&/,$rep);
1.273 albertel 5671: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
5672: return @pairs;
5673: }
1.15 www 5674: my %returnhash=();
1.42 www 5675: my $i=0;
1.800 albertel 5676: foreach my $item (@$storearr) {
5677: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 5678: $i++;
1.191 harris41 5679: }
1.15 www 5680: return %returnhash;
1.27 www 5681: }
5682:
5683: # --------------------------------------------------------------- del interface
5684:
5685: sub del {
1.133 albertel 5686: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 5687: my $items='';
1.800 albertel 5688: foreach my $item (@$storearr) {
5689: $items.=&escape($item).'&';
1.191 harris41 5690: }
1.984 neumanie 5691:
1.27 www 5692: $items=~s/\&$//;
1.620 albertel 5693: if (!$udomain) { $udomain=$env{'user.domain'}; }
5694: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 5695: my $uhome=&homeserver($uname,$udomain);
5696: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 5697: }
5698:
5699: # -------------------------------------------------------------- dump interface
5700:
1.1180 droeschl 5701: sub unserialize {
5702: my ($rep, $escapedkeys) = @_;
5703:
5704: return {} if $rep =~ /^error/;
5705:
5706: my %returnhash=();
1.1252 raeburn 5707: foreach my $item (split(/\&/,$rep)) {
1.1180 droeschl 5708: my ($key, $value) = split(/=/, $item, 2);
5709: $key = unescape($key) unless $escapedkeys;
5710: next if $key =~ /^error: 2 /;
1.1252 raeburn 5711: $returnhash{$key} = &thaw_unescape($value);
1.1180 droeschl 5712: }
5713: #return %returnhash;
5714: return \%returnhash;
5715: }
5716:
5717: # see Lond::dump_with_regexp
5718: # if $escapedkeys hash keys won't get unescaped.
1.15 www 5719: sub dump {
1.1180 droeschl 5720: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755 albertel 5721: if (!$udomain) { $udomain=$env{'user.domain'}; }
5722: if (!$uname) { $uname=$env{'user.name'}; }
5723: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 5724:
1.1266 raeburn 5725: if ($regexp) {
5726: $regexp=&escape($regexp);
5727: } else {
5728: $regexp='.';
5729: }
1.1180 droeschl 5730: if (grep { $_ eq $uhome } current_machine_ids()) {
5731: # user is hosted on this machine
1.1266 raeburn 5732: my $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 5733: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 5734: return %{unserialize($reply, $escapedkeys)};
5735: }
1.1166 raeburn 5736: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 5737: my @pairs=split(/\&/,$rep);
5738: my %returnhash=();
1.1098 foxr 5739: if (!($rep =~ /^error/ )) {
5740: foreach my $item (@pairs) {
5741: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 5742: $key = unescape($key) unless $escapedkeys;
5743: #$key = &unescape($key);
1.1098 foxr 5744: next if ($key =~ /^error: 2 /);
5745: $returnhash{$key}=&thaw_unescape($value);
5746: }
1.755 albertel 5747: }
5748: return %returnhash;
1.407 www 5749: }
5750:
1.1098 foxr 5751:
1.717 albertel 5752: # --------------------------------------------------------- dumpstore interface
5753:
5754: sub dumpstore {
5755: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 5756: # same as dump but keys must be escaped. They may contain colon separated
5757: # lists of values that may themself contain colons (e.g. symbs).
5758: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 5759: }
5760:
1.407 www 5761: # -------------------------------------------------------------- keys interface
5762:
5763: sub getkeys {
5764: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 5765: if (!$udomain) { $udomain=$env{'user.domain'}; }
5766: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 5767: my $uhome=&homeserver($uname,$udomain);
5768: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
5769: my @keyarray=();
1.800 albertel 5770: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 5771: next if ($key =~ /^error: 2 /);
1.800 albertel 5772: push(@keyarray,&unescape($key));
1.407 www 5773: }
5774: return @keyarray;
1.318 matthew 5775: }
5776:
1.319 matthew 5777: # --------------------------------------------------------------- currentdump
5778: sub currentdump {
1.328 matthew 5779: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 5780: $courseid = $env{'request.course.id'} if (! defined($courseid));
5781: $sdom = $env{'user.domain'} if (! defined($sdom));
5782: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 5783: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 5784: my $rep;
5785:
5786: if (grep { $_ eq $uhome } current_machine_ids()) {
5787: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
5788: $courseid)));
5789: } else {
5790: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
5791: }
5792:
1.318 matthew 5793: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 5794: #
1.318 matthew 5795: my %returnhash=();
1.319 matthew 5796: #
5797: if ($rep eq "unknown_cmd") {
5798: # an old lond will not know currentdump
5799: # Do a dump and make it look like a currentdump
1.822 albertel 5800: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 5801: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5802: my %hash = @tmp;
5803: @tmp=();
1.424 matthew 5804: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 5805: } else {
5806: my @pairs=split(/\&/,$rep);
1.800 albertel 5807: foreach my $pair (@pairs) {
5808: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 5809: my ($symb,$param) = split(/:/,$key);
5810: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 5811: &thaw_unescape($value);
1.319 matthew 5812: }
1.191 harris41 5813: }
1.12 www 5814: return %returnhash;
1.424 matthew 5815: }
5816:
5817: sub convert_dump_to_currentdump{
5818: my %hash = %{shift()};
5819: my %returnhash;
5820: # Code ripped from lond, essentially. The only difference
5821: # here is the unescaping done by lonnet::dump(). Conceivably
5822: # we might run in to problems with parameter names =~ /^v\./
5823: while (my ($key,$value) = each(%hash)) {
5824: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 5825: $symb = &unescape($symb);
5826: $param = &unescape($param);
1.424 matthew 5827: next if ($v eq 'version' || $symb eq 'keys');
5828: next if (exists($returnhash{$symb}) &&
5829: exists($returnhash{$symb}->{$param}) &&
5830: $returnhash{$symb}->{'v.'.$param} > $v);
5831: $returnhash{$symb}->{$param}=$value;
5832: $returnhash{$symb}->{'v.'.$param}=$v;
5833: }
5834: #
5835: # Remove all of the keys in the hashes which keep track of
5836: # the version of the parameter.
5837: while (my ($symb,$param_hash) = each(%returnhash)) {
5838: # use a foreach because we are going to delete from the hash.
5839: foreach my $key (keys(%$param_hash)) {
5840: delete($param_hash->{$key}) if ($key =~ /^v\./);
5841: }
5842: }
5843: return \%returnhash;
1.12 www 5844: }
5845:
1.627 albertel 5846: # ------------------------------------------------------ critical inc interface
5847:
5848: sub cinc {
5849: return &inc(@_,'critical');
5850: }
5851:
1.449 matthew 5852: # --------------------------------------------------------------- inc interface
5853:
5854: sub inc {
1.627 albertel 5855: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 5856: if (!$udomain) { $udomain=$env{'user.domain'}; }
5857: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 5858: my $uhome=&homeserver($uname,$udomain);
5859: my $items='';
5860: if (! ref($store)) {
5861: # got a single value, so use that instead
5862: $items = &escape($store).'=&';
5863: } elsif (ref($store) eq 'SCALAR') {
5864: $items = &escape($$store).'=&';
5865: } elsif (ref($store) eq 'ARRAY') {
5866: $items = join('=&',map {&escape($_);} @{$store});
5867: } elsif (ref($store) eq 'HASH') {
5868: while (my($key,$value) = each(%{$store})) {
5869: $items.= &escape($key).'='.&escape($value).'&';
5870: }
5871: }
5872: $items=~s/\&$//;
1.627 albertel 5873: if ($critical) {
5874: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
5875: } else {
5876: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
5877: }
1.449 matthew 5878: }
5879:
1.12 www 5880: # --------------------------------------------------------------- put interface
5881:
5882: sub put {
1.134 albertel 5883: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 5884: if (!$udomain) { $udomain=$env{'user.domain'}; }
5885: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 5886: my $uhome=&homeserver($uname,$udomain);
1.12 www 5887: my $items='';
1.800 albertel 5888: foreach my $item (keys(%$storehash)) {
5889: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 5890: }
1.12 www 5891: $items=~s/\&$//;
1.134 albertel 5892: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 5893: }
5894:
1.631 albertel 5895: # ------------------------------------------------------------ newput interface
5896:
5897: sub newput {
5898: my ($namespace,$storehash,$udomain,$uname)=@_;
5899: if (!$udomain) { $udomain=$env{'user.domain'}; }
5900: if (!$uname) { $uname=$env{'user.name'}; }
5901: my $uhome=&homeserver($uname,$udomain);
5902: my $items='';
5903: foreach my $key (keys(%$storehash)) {
5904: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5905: }
5906: $items=~s/\&$//;
5907: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
5908: }
5909:
5910: # --------------------------------------------------------- putstore interface
5911:
1.524 raeburn 5912: sub putstore {
1.1269 raeburn 5913: my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
1.620 albertel 5914: if (!$udomain) { $udomain=$env{'user.domain'}; }
5915: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 5916: my $uhome=&homeserver($uname,$udomain);
5917: my $items='';
1.715 albertel 5918: foreach my $key (keys(%$storehash)) {
5919: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 5920: }
1.715 albertel 5921: $items=~s/\&$//;
1.716 albertel 5922: my $esc_symb=&escape($symb);
5923: my $esc_v=&escape($version);
1.715 albertel 5924: my $reply =
1.716 albertel 5925: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 5926: $uhome);
1.1269 raeburn 5927: if (($tolog) && ($reply eq 'ok')) {
5928: my $namevalue='';
5929: foreach my $key (keys(%{$storehash})) {
5930: $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
5931: }
5932: $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
5933: '&host='.&escape($perlvar{'lonHostID'}).
5934: '&version='.$esc_v.
5935: '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
5936: &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
5937: }
1.715 albertel 5938: if ($reply eq 'unknown_cmd') {
1.716 albertel 5939: # gfall back to way things use to be done
1.715 albertel 5940: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5941: $uname);
1.524 raeburn 5942: }
1.715 albertel 5943: return $reply;
5944: }
5945:
5946: sub old_putstore {
1.716 albertel 5947: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5948: if (!$udomain) { $udomain=$env{'user.domain'}; }
5949: if (!$uname) { $uname=$env{'user.name'}; }
5950: my $uhome=&homeserver($uname,$udomain);
5951: my %newstorehash;
1.800 albertel 5952: foreach my $item (keys(%$storehash)) {
5953: my $key = $version.':'.&escape($symb).':'.$item;
5954: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 5955: }
5956: my $items='';
5957: my %allitems = ();
1.800 albertel 5958: foreach my $item (keys(%newstorehash)) {
5959: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 5960: my $key = $1.':keys:'.$2;
5961: $allitems{$key} .= $3.':';
5962: }
1.800 albertel 5963: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 5964: }
1.800 albertel 5965: foreach my $item (keys(%allitems)) {
5966: $allitems{$item} =~ s/\:$//;
5967: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 5968: }
5969: $items=~s/\&$//;
5970: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 5971: }
5972:
1.47 www 5973: # ------------------------------------------------------ critical put interface
5974:
5975: sub cput {
1.134 albertel 5976: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 5977: if (!$udomain) { $udomain=$env{'user.domain'}; }
5978: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 5979: my $uhome=&homeserver($uname,$udomain);
1.47 www 5980: my $items='';
1.800 albertel 5981: foreach my $item (keys(%$storehash)) {
5982: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 5983: }
1.47 www 5984: $items=~s/\&$//;
1.134 albertel 5985: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 5986: }
5987:
5988: # -------------------------------------------------------------- eget interface
5989:
5990: sub eget {
1.133 albertel 5991: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 5992: my $items='';
1.800 albertel 5993: foreach my $item (@$storearr) {
5994: $items.=&escape($item).'&';
1.191 harris41 5995: }
1.12 www 5996: $items=~s/\&$//;
1.620 albertel 5997: if (!$udomain) { $udomain=$env{'user.domain'}; }
5998: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 5999: my $uhome=&homeserver($uname,$udomain);
6000: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 6001: my @pairs=split(/\&/,$rep);
6002: my %returnhash=();
1.42 www 6003: my $i=0;
1.800 albertel 6004: foreach my $item (@$storearr) {
6005: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 6006: $i++;
1.191 harris41 6007: }
1.12 www 6008: return %returnhash;
6009: }
6010:
1.667 albertel 6011: # ------------------------------------------------------------ tmpput interface
6012: sub tmpput {
1.802 raeburn 6013: my ($storehash,$server,$context)=@_;
1.667 albertel 6014: my $items='';
1.800 albertel 6015: foreach my $item (keys(%$storehash)) {
6016: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 6017: }
6018: $items=~s/\&$//;
1.802 raeburn 6019: if (defined($context)) {
6020: $items .= ':'.&escape($context);
6021: }
1.667 albertel 6022: return &reply("tmpput:$items",$server);
6023: }
6024:
6025: # ------------------------------------------------------------ tmpget interface
6026: sub tmpget {
1.688 albertel 6027: my ($token,$server)=@_;
6028: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6029: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 6030: my %returnhash;
6031: foreach my $item (split(/\&/,$rep)) {
6032: my ($key,$value)=split(/=/,$item);
1.951 raeburn 6033: next if ($key =~ /^error: 2 /);
1.667 albertel 6034: $returnhash{&unescape($key)}=&thaw_unescape($value);
6035: }
6036: return %returnhash;
6037: }
6038:
1.1113 raeburn 6039: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 6040: sub tmpdel {
6041: my ($token,$server)=@_;
6042: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
6043: return &reply("tmpdel:$token",$server);
6044: }
6045:
1.1198 raeburn 6046: # ------------------------------------------------------------ get_timebased_id
6047:
6048: sub get_timebased_id {
6049: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
6050: $maxtries) = @_;
6051: my ($newid,$error,$dellock);
6052: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
6053: return ('','ok','invalid call to get suffix');
6054: }
6055:
6056: # set defaults for any optional args for which values were not supplied
6057: if ($who eq '') {
6058: $who = $env{'user.name'}.':'.$env{'user.domain'};
6059: }
6060: if (!$locktries) {
6061: $locktries = 3;
6062: }
6063: if (!$maxtries) {
6064: $maxtries = 10;
6065: }
6066:
6067: if (($cdom eq '') || ($cnum eq '')) {
6068: if ($env{'request.course.id'}) {
6069: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6070: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6071: }
6072: if (($cdom eq '') || ($cnum eq '')) {
6073: return ('','ok','call to get suffix not in course context');
6074: }
6075: }
6076:
6077: # construct locking item
6078: my $lockhash = {
6079: $prefix."\0".'locked_'.$keyid => $who,
6080: };
6081: my $tries = 0;
6082:
6083: # attempt to get lock on nohist_$namespace file
6084: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6085: while (($gotlock ne 'ok') && $tries <$locktries) {
6086: $tries ++;
6087: sleep 1;
6088: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
6089: }
6090:
6091: # attempt to get unique identifier, based on current timestamp
6092: if ($gotlock eq 'ok') {
6093: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
6094: my $id = time;
6095: $newid = $id;
1.1268 raeburn 6096: if ($idtype eq 'addcode') {
6097: $newid .= &sixnum_code();
6098: }
1.1198 raeburn 6099: my $idtries = 0;
6100: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
6101: if ($idtype eq 'concat') {
6102: $newid = $id.$idtries;
1.1268 raeburn 6103: } elsif ($idtype eq 'addcode') {
6104: $newid = $newid.&sixnum_code();
1.1198 raeburn 6105: } else {
6106: $newid ++;
6107: }
6108: $idtries ++;
6109: }
6110: if (!exists($inuse{$prefix."\0".$newid})) {
6111: my %new_item = (
6112: $prefix."\0".$newid => $who,
6113: );
6114: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
6115: $cdom,$cnum);
6116: if ($putresult ne 'ok') {
6117: undef($newid);
6118: $error = 'error saving new item: '.$putresult;
6119: }
6120: } else {
1.1268 raeburn 6121: undef($newid);
1.1198 raeburn 6122: $error = ('error: no unique suffix available for the new item ');
6123: }
6124: # remove lock
6125: my @del_lock = ($prefix."\0".'locked_'.$keyid);
6126: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
6127: } else {
6128: $error = "error: could not obtain lockfile\n";
6129: $dellock = 'ok';
1.1276 raeburn 6130: if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
6131: $dellock = 'nolock';
6132: }
1.1198 raeburn 6133: }
6134: return ($newid,$dellock,$error);
6135: }
6136:
1.1268 raeburn 6137: sub sixnum_code {
6138: my $code;
6139: for (0..6) {
6140: $code .= int( rand(9) );
6141: }
6142: return $code;
6143: }
6144:
1.765 albertel 6145: # -------------------------------------------------- portfolio access checking
6146:
6147: sub portfolio_access {
1.1270 raeburn 6148: my ($requrl,$clientip) = @_;
1.765 albertel 6149: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
1.1270 raeburn 6150: my $result = &get_portfolio_access($udom,$unum,$file_name,$group,$clientip);
1.814 raeburn 6151: if ($result) {
6152: my %setters;
6153: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6154: my ($startblock,$endblock) =
6155: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
6156: if ($startblock && $endblock) {
6157: return 'B';
6158: }
6159: } else {
6160: my ($startblock,$endblock) =
6161: &Apache::loncommon::blockcheck(\%setters,'port');
6162: if ($startblock && $endblock) {
6163: return 'B';
6164: }
6165: }
6166: }
1.765 albertel 6167: if ($result eq 'ok') {
1.766 albertel 6168: return 'F';
1.765 albertel 6169: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 6170: return 'A';
1.765 albertel 6171: }
1.766 albertel 6172: return '';
1.765 albertel 6173: }
6174:
6175: sub get_portfolio_access {
1.1270 raeburn 6176: my ($udom,$unum,$file_name,$group,$clientip,$access_hash) = @_;
1.767 albertel 6177:
6178: if (!ref($access_hash)) {
6179: my $current_perms = &get_portfile_permissions($udom,$unum);
6180: my %access_controls = &get_access_controls($current_perms,$group,
6181: $file_name);
6182: $access_hash = $access_controls{$file_name};
6183: }
6184:
1.1270 raeburn 6185: my ($public,$guest,@domains,@users,@courses,@groups,@ips);
1.765 albertel 6186: my $now = time;
6187: if (ref($access_hash) eq 'HASH') {
6188: foreach my $key (keys(%{$access_hash})) {
6189: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
6190: if ($start > $now) {
6191: next;
6192: }
6193: if ($end && $end<$now) {
6194: next;
6195: }
6196: if ($scope eq 'public') {
6197: $public = $key;
6198: last;
6199: } elsif ($scope eq 'guest') {
6200: $guest = $key;
6201: } elsif ($scope eq 'domains') {
6202: push(@domains,$key);
6203: } elsif ($scope eq 'users') {
6204: push(@users,$key);
6205: } elsif ($scope eq 'course') {
6206: push(@courses,$key);
6207: } elsif ($scope eq 'group') {
6208: push(@groups,$key);
1.1270 raeburn 6209: } elsif ($scope eq 'ip') {
6210: push(@ips,$key);
1.765 albertel 6211: }
6212: }
6213: if ($public) {
6214: return 'ok';
1.1270 raeburn 6215: } elsif (@ips > 0) {
6216: my $allowed;
6217: foreach my $ipkey (@ips) {
6218: if (ref($access_hash->{$ipkey}{'ip'}) eq 'ARRAY') {
6219: if (&Apache::loncommon::check_ip_acc(join(',',@{$access_hash->{$ipkey}{'ip'}}),$clientip)) {
6220: $allowed = 1;
6221: last;
6222: }
6223: }
6224: }
6225: if ($allowed) {
6226: return 'ok';
6227: }
1.765 albertel 6228: }
6229: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6230: if ($guest) {
6231: return $guest;
6232: }
6233: } else {
6234: if (@domains > 0) {
6235: foreach my $domkey (@domains) {
6236: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6237: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6238: return 'ok';
6239: }
6240: }
6241: }
6242: }
6243: if (@users > 0) {
6244: foreach my $userkey (@users) {
1.865 raeburn 6245: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6246: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6247: if (ref($item) eq 'HASH') {
6248: if (($item->{'uname'} eq $env{'user.name'}) &&
6249: ($item->{'udom'} eq $env{'user.domain'})) {
6250: return 'ok';
6251: }
6252: }
6253: }
6254: }
1.765 albertel 6255: }
6256: }
6257: my %roleshash;
6258: my @courses_and_groups = @courses;
6259: push(@courses_and_groups,@groups);
6260: if (@courses_and_groups > 0) {
6261: my (%allgroups,%allroles);
6262: my ($start,$end,$role,$sec,$group);
6263: foreach my $envkey (%env) {
1.1060 raeburn 6264: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6265: my $cid = $2.'_'.$3;
6266: if ($1 eq 'gr') {
6267: $group = $4;
6268: $allgroups{$cid}{$group} = $env{$envkey};
6269: } else {
6270: if ($4 eq '') {
6271: $sec = 'none';
6272: } else {
6273: $sec = $4;
6274: }
6275: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6276: }
1.811 albertel 6277: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6278: my $cid = $2.'_'.$3;
6279: if ($4 eq '') {
6280: $sec = 'none';
6281: } else {
6282: $sec = $4;
6283: }
6284: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6285: }
6286: }
6287: if (keys(%allroles) == 0) {
6288: return;
6289: }
6290: foreach my $key (@courses_and_groups) {
6291: my %content = %{$$access_hash{$key}};
6292: my $cnum = $content{'number'};
6293: my $cdom = $content{'domain'};
6294: my $cid = $cdom.'_'.$cnum;
6295: if (!exists($allroles{$cid})) {
6296: next;
6297: }
6298: foreach my $role_id (keys(%{$content{'roles'}})) {
6299: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6300: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6301: my @status = @{$content{'roles'}{$role_id}{'access'}};
6302: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6303: foreach my $role (keys(%{$allroles{$cid}})) {
6304: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6305: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6306: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6307: if (grep/^all$/,@sections) {
6308: return 'ok';
6309: } else {
6310: if (grep/^$sec$/,@sections) {
6311: return 'ok';
6312: }
6313: }
6314: }
6315: }
6316: if (keys(%{$allgroups{$cid}}) == 0) {
6317: if (grep/^none$/,@groups) {
6318: return 'ok';
6319: }
6320: } else {
6321: if (grep/^all$/,@groups) {
6322: return 'ok';
6323: }
6324: foreach my $group (keys(%{$allgroups{$cid}})) {
6325: if (grep/^$group$/,@groups) {
6326: return 'ok';
6327: }
6328: }
6329: }
6330: }
6331: }
6332: }
6333: }
6334: }
6335: if ($guest) {
6336: return $guest;
6337: }
6338: }
6339: }
6340: return;
6341: }
6342:
6343: sub course_group_datechecker {
6344: my ($dates,$now,$status) = @_;
6345: my ($start,$end) = split(/\./,$dates);
6346: if (!$start && !$end) {
6347: return 'ok';
6348: }
6349: if (grep/^active$/,@{$status}) {
6350: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6351: return 'ok';
6352: }
6353: }
6354: if (grep/^previous$/,@{$status}) {
6355: if ($end > $now ) {
6356: return 'ok';
6357: }
6358: }
6359: if (grep/^future$/,@{$status}) {
6360: if ($start > $now) {
6361: return 'ok';
6362: }
6363: }
6364: return;
6365: }
6366:
6367: sub parse_portfolio_url {
6368: my ($url) = @_;
6369:
6370: my ($type,$udom,$unum,$group,$file_name);
6371:
1.823 albertel 6372: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 6373: $type = 1;
6374: $udom = $1;
6375: $unum = $2;
6376: $file_name = $3;
1.823 albertel 6377: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 6378: $type = 2;
6379: $udom = $1;
6380: $unum = $2;
6381: $group = $3;
6382: $file_name = $3.'/'.$4;
6383: }
6384: if (wantarray) {
6385: return ($type,$udom,$unum,$file_name,$group);
6386: }
6387: return $type;
6388: }
6389:
6390: sub is_portfolio_url {
6391: my ($url) = @_;
6392: return scalar(&parse_portfolio_url($url));
6393: }
6394:
1.798 raeburn 6395: sub is_portfolio_file {
6396: my ($file) = @_;
1.820 raeburn 6397: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 6398: return 1;
6399: }
6400: return;
6401: }
6402:
1.976 raeburn 6403: sub usertools_access {
1.1084 raeburn 6404: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 6405: my ($access,%tools);
6406: if ($context eq '') {
6407: $context = 'tools';
6408: }
6409: if ($context eq 'requestcourses') {
6410: %tools = (
6411: official => 1,
6412: unofficial => 1,
1.1006 raeburn 6413: community => 1,
1.1246 raeburn 6414: textbook => 1,
1.985 raeburn 6415: );
1.1183 raeburn 6416: } elsif ($context eq 'requestauthor') {
6417: %tools = (
6418: requestauthor => 1,
6419: );
1.985 raeburn 6420: } else {
6421: %tools = (
6422: aboutme => 1,
6423: blog => 1,
1.1177 raeburn 6424: webdav => 1,
1.985 raeburn 6425: portfolio => 1,
6426: );
6427: }
1.976 raeburn 6428: return if (!defined($tools{$tool}));
6429:
1.1242 raeburn 6430: if (($udom eq '') || ($uname eq '')) {
1.976 raeburn 6431: $udom = $env{'user.domain'};
6432: $uname = $env{'user.name'};
6433: }
6434:
1.978 raeburn 6435: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6436: if ($action ne 'reload') {
1.985 raeburn 6437: if ($context eq 'requestcourses') {
6438: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 6439: } elsif ($context eq 'requestauthor') {
6440: return $env{'environment.canrequest.author'};
1.985 raeburn 6441: } else {
6442: return $env{'environment.availabletools.'.$tool};
6443: }
6444: }
1.976 raeburn 6445: }
6446:
1.1183 raeburn 6447: my ($toolstatus,$inststatus,$envkey);
6448: if ($context eq 'requestauthor') {
6449: $envkey = $context;
6450: } else {
6451: $envkey = $context.'.'.$tool;
6452: }
1.976 raeburn 6453:
1.985 raeburn 6454: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6455: ($action ne 'reload')) {
1.1183 raeburn 6456: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 6457: $inststatus = $env{'environment.inststatus'};
6458: } else {
1.1084 raeburn 6459: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 6460: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 6461: $inststatus = $userenvref->{'inststatus'};
6462: } else {
1.1183 raeburn 6463: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6464: $toolstatus = $userenv{$envkey};
1.1084 raeburn 6465: $inststatus = $userenv{'inststatus'};
6466: }
1.976 raeburn 6467: }
6468:
6469: if ($toolstatus ne '') {
6470: if ($toolstatus) {
6471: $access = 1;
6472: } else {
6473: $access = 0;
6474: }
6475: return $access;
6476: }
6477:
1.1084 raeburn 6478: my ($is_adv,%domdef);
6479: if (ref($is_advref) eq 'HASH') {
6480: $is_adv = $is_advref->{'is_adv'};
6481: } else {
6482: $is_adv = &is_advanced_user($udom,$uname);
6483: }
6484: if (ref($domdefref) eq 'HASH') {
6485: %domdef = %{$domdefref};
6486: } else {
6487: %domdef = &get_domain_defaults($udom);
6488: }
1.976 raeburn 6489: if (ref($domdef{$tool}) eq 'HASH') {
6490: if ($is_adv) {
6491: if ($domdef{$tool}{'_LC_adv'} ne '') {
6492: if ($domdef{$tool}{'_LC_adv'}) {
6493: $access = 1;
6494: } else {
6495: $access = 0;
6496: }
6497: return $access;
6498: }
6499: }
6500: if ($inststatus ne '') {
6501: my ($hasaccess,$hasnoaccess);
6502: foreach my $affiliation (split(/:/,$inststatus)) {
6503: if ($domdef{$tool}{$affiliation} ne '') {
6504: if ($domdef{$tool}{$affiliation}) {
6505: $hasaccess = 1;
6506: } else {
6507: $hasnoaccess = 1;
6508: }
6509: }
6510: }
6511: if ($hasaccess || $hasnoaccess) {
6512: if ($hasaccess) {
6513: $access = 1;
6514: } elsif ($hasnoaccess) {
6515: $access = 0;
6516: }
6517: return $access;
6518: }
6519: } else {
6520: if ($domdef{$tool}{'default'} ne '') {
6521: if ($domdef{$tool}{'default'}) {
6522: $access = 1;
6523: } elsif ($domdef{$tool}{'default'} == 0) {
6524: $access = 0;
6525: }
6526: return $access;
6527: }
6528: }
6529: } else {
1.1177 raeburn 6530: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 6531: $access = 1;
6532: } else {
6533: $access = 0;
6534: }
1.976 raeburn 6535: return $access;
6536: }
6537: }
6538:
1.1050 raeburn 6539: sub is_course_owner {
6540: my ($cdom,$cnum,$udom,$uname) = @_;
6541: if (($udom eq '') || ($uname eq '')) {
6542: $udom = $env{'user.domain'};
6543: $uname = $env{'user.name'};
6544: }
6545: unless (($udom eq '') || ($uname eq '')) {
6546: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6547: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6548: return 1;
6549: } else {
6550: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6551: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6552: return 1;
6553: }
6554: }
6555: }
6556: }
6557: return;
6558: }
6559:
1.976 raeburn 6560: sub is_advanced_user {
6561: my ($udom,$uname) = @_;
1.1085 raeburn 6562: if ($udom ne '' && $uname ne '') {
6563: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 6564: if (wantarray) {
6565: return ($env{'user.adv'},$env{'user.author'});
6566: } else {
6567: return $env{'user.adv'};
6568: }
1.1085 raeburn 6569: }
6570: }
1.976 raeburn 6571: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6572: my %allroles;
1.1128 raeburn 6573: my ($is_adv,$is_author);
1.976 raeburn 6574: foreach my $role (keys(%roleshash)) {
6575: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6576: my $area = '/'.$tdomain.'/'.$trest;
6577: if ($sec ne '') {
6578: $area .= '/'.$sec;
6579: }
6580: if (($area ne '') && ($trole ne '')) {
6581: my $spec=$trole.'.'.$area;
6582: if ($trole =~ /^cr\//) {
6583: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6584: } elsif ($trole ne 'gr') {
6585: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6586: }
1.1128 raeburn 6587: if ($trole eq 'au') {
6588: $is_author = 1;
6589: }
1.976 raeburn 6590: }
6591: }
6592: foreach my $role (keys(%allroles)) {
6593: last if ($is_adv);
6594: foreach my $item (split(/:/,$allroles{$role})) {
6595: if ($item ne '') {
6596: my ($privilege,$restrictions)=split(/&/,$item);
6597: if ($privilege eq 'adv') {
6598: $is_adv = 1;
6599: last;
6600: }
6601: }
6602: }
6603: }
1.1128 raeburn 6604: if (wantarray) {
6605: return ($is_adv,$is_author);
6606: }
1.976 raeburn 6607: return $is_adv;
6608: }
1.798 raeburn 6609:
1.1035 raeburn 6610: sub check_can_request {
1.1036 raeburn 6611: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 6612: my $canreq = 0;
6613: my ($types,$typename) = &Apache::loncommon::course_types();
6614: my @options = ('approval','validate','autolimit');
6615: my $optregex = join('|',@options);
6616: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
6617: foreach my $type (@{$types}) {
6618: if (&usertools_access($env{'user.name'},
6619: $env{'user.domain'},
6620: $type,undef,'requestcourses')) {
6621: $canreq ++;
1.1036 raeburn 6622: if (ref($request_domains) eq 'HASH') {
6623: push(@{$request_domains->{$type}},$env{'user.domain'});
6624: }
1.1035 raeburn 6625: if ($dom eq $env{'user.domain'}) {
6626: $can_request->{$type} = 1;
6627: }
6628: }
6629: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
6630: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
6631: if (@curr > 0) {
1.1036 raeburn 6632: foreach my $item (@curr) {
6633: if (ref($request_domains) eq 'HASH') {
6634: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
6635: if ($otherdom ne '') {
6636: if (ref($request_domains->{$type}) eq 'ARRAY') {
6637: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
6638: push(@{$request_domains->{$type}},$otherdom);
6639: }
6640: } else {
6641: push(@{$request_domains->{$type}},$otherdom);
6642: }
6643: }
6644: }
6645: }
6646: unless($dom eq $env{'user.domain'}) {
6647: $canreq ++;
1.1035 raeburn 6648: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
6649: $can_request->{$type} = 1;
6650: }
6651: }
6652: }
6653: }
6654: }
6655: }
6656: return $canreq;
6657: }
6658:
1.341 www 6659: # ---------------------------------------------- Custom access rule evaluation
6660:
6661: sub customaccess {
6662: my ($priv,$uri)=@_;
1.807 albertel 6663: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 6664: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 6665: $udom = &LONCAPA::clean_domain($udom);
6666: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 6667: my $access=0;
1.800 albertel 6668: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 6669: my ($effect,$realm,$role,$type)=split(/\:/,$right);
6670: if ($type eq 'user') {
6671: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 6672: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 6673: if ($tdom) {
6674: if ($tdom ne $env{'user.domain'}) { next; }
6675: }
1.896 albertel 6676: if ($tuname) {
6677: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 6678: }
6679: $access=($effect eq 'allow');
6680: last;
6681: }
6682: } else {
6683: if ($role) {
6684: if ($role ne $urole) { next; }
6685: }
6686: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6687: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
6688: if ($tdom) {
6689: if ($tdom ne $udom) { next; }
6690: }
6691: if ($tcrs) {
6692: if ($tcrs ne $ucrs) { next; }
6693: }
6694: if ($tsec) {
6695: if ($tsec ne $usec) { next; }
6696: }
6697: $access=($effect eq 'allow');
6698: last;
6699: }
6700: if ($realm eq '' && $role eq '') {
6701: $access=($effect eq 'allow');
6702: }
1.402 bowersj2 6703: }
1.341 www 6704: }
6705: return $access;
6706: }
6707:
1.103 harris41 6708: # ------------------------------------------------- Check for a user privilege
1.12 www 6709:
6710: sub allowed {
1.1281 raeburn 6711: my ($priv,$uri,$symb,$role,$clientip,$noblockcheck)=@_;
1.705 albertel 6712: my $ver_orguri=$uri;
1.439 www 6713: $uri=&deversion($uri);
1.152 www 6714: my $orguri=$uri;
1.52 www 6715: $uri=&declutter($uri);
1.809 raeburn 6716:
1.810 raeburn 6717: if ($priv eq 'evb') {
6718: # Evade communication block restrictions for specified role in a course
6719: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
6720: return $1;
6721: } else {
6722: return;
6723: }
6724: }
6725:
1.620 albertel 6726: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 6727: # Free bre access to adm and meta resources
1.775 albertel 6728: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 6729: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
6730: && ($priv eq 'bre')) {
1.14 www 6731: return 'F';
1.159 www 6732: }
6733:
1.545 banghart 6734: # Free bre access to user's own portfolio contents
1.714 raeburn 6735: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 6736: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 6737: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 6738: my %setters;
6739: my ($startblock,$endblock) =
6740: &Apache::loncommon::blockcheck(\%setters,'port');
6741: if ($startblock && $endblock) {
6742: return 'B';
6743: } else {
6744: return 'F';
6745: }
1.545 banghart 6746: }
6747:
1.762 raeburn 6748: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 6749: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
6750: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
6751: if (exists($env{'request.course.id'})) {
6752: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6753: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6754: if (($domain eq $cdom) && ($name eq $cnum)) {
6755: my $courseprivid=$env{'request.course.id'};
6756: $courseprivid=~s/\_/\//;
6757: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
6758: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
6759: return $1;
1.762 raeburn 6760: } else {
6761: if ($env{'request.course.sec'}) {
6762: $courseprivid.='/'.$env{'request.course.sec'};
6763: }
6764: if ($env{'user.priv.'.$env{'request.role'}.'./'.
6765: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
6766: return $2;
6767: }
1.714 raeburn 6768: }
6769: }
6770: }
6771: }
6772:
1.159 www 6773: # Free bre to public access
6774:
6775: if ($priv eq 'bre') {
1.238 www 6776: my $copyright=&metadata($uri,'copyright');
1.620 albertel 6777: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 6778: return 'F';
6779: }
1.238 www 6780: if ($copyright eq 'priv') {
6781: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 6782: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 6783: return '';
6784: }
6785: }
6786: if ($copyright eq 'domain') {
6787: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 6788: unless (($env{'user.domain'} eq $1) ||
6789: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 6790: return '';
6791: }
1.262 matthew 6792: }
1.620 albertel 6793: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 6794: # Library role, so allow browsing of resources in this domain.
6795: return 'F';
1.238 www 6796: }
1.341 www 6797: if ($copyright eq 'custom') {
6798: unless (&customaccess($priv,$uri)) { return ''; }
6799: }
1.14 www 6800: }
1.264 matthew 6801: # Domain coordinator is trying to create a course
1.620 albertel 6802: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 6803: # uri is the requested domain in this case.
6804: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 6805: # a role of dc for the domain in question.
1.620 albertel 6806: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 6807: }
1.29 www 6808:
1.52 www 6809: my $thisallowed='';
6810: my $statecond=0;
6811: my $courseprivid='';
6812:
1.1039 raeburn 6813: my $ownaccess;
1.1043 raeburn 6814: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 6815: if (($priv eq 'bro') && ($env{'user.author'})) {
6816: if ($uri eq '') {
6817: $ownaccess = 1;
6818: } else {
6819: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
6820: my $udom = $env{'user.domain'};
6821: my $uname = $env{'user.name'};
6822: if ($uri =~ m{^\Q$udom\E/?$}) {
6823: $ownaccess = 1;
1.1040 raeburn 6824: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 6825: unless ($uri =~ m{\.\./}) {
6826: $ownaccess = 1;
6827: }
6828: } elsif (($udom ne 'public') && ($uname ne 'public')) {
6829: my $now = time;
6830: if ($uri =~ m{^([^/]+)/?$}) {
6831: my $adom = $1;
6832: foreach my $key (keys(%env)) {
1.1042 raeburn 6833: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 6834: my ($start,$end) = split('.',$env{$key});
6835: if (($now >= $start) && (!$end || $end < $now)) {
6836: $ownaccess = 1;
6837: last;
6838: }
6839: }
6840: }
6841: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
6842: my $adom = $1;
6843: my $aname = $2;
1.1042 raeburn 6844: foreach my $role ('ca','aa') {
6845: if ($env{"user.role.$role./$adom/$aname"}) {
6846: my ($start,$end) =
6847: split('.',$env{"user.role.$role./$adom/$aname"});
6848: if (($now >= $start) && (!$end || $end < $now)) {
6849: $ownaccess = 1;
6850: last;
6851: }
1.1039 raeburn 6852: }
6853: }
6854: }
6855: }
6856: }
6857: }
6858: }
6859:
1.52 www 6860: # Course
6861:
1.620 albertel 6862: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6863: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6864: $thisallowed.=$1;
6865: }
1.52 www 6866: }
1.29 www 6867:
1.52 www 6868: # Domain
6869:
1.620 albertel 6870: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 6871: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6872: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6873: $thisallowed.=$1;
6874: }
1.12 www 6875: }
1.52 www 6876:
1.1141 raeburn 6877: # User who is not author or co-author might still be able to edit
6878: # resource of an author in the domain (e.g., if Domain Coordinator).
6879: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
6880: (&allowed('mdc',$env{'request.course.id'}))) {
6881: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
6882: $thisallowed.=$1;
6883: }
6884: }
6885:
1.52 www 6886: # Course: uri itself is a course
1.66 www 6887: my $courseuri=$uri;
6888: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 6889: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 6890:
1.620 albertel 6891: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 6892: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6893: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6894: $thisallowed.=$1;
6895: }
1.12 www 6896: }
1.29 www 6897:
1.665 albertel 6898: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 6899: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 6900: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 6901: $thisallowed='';
1.671 raeburn 6902: my ($match)=&is_on_map($uri);
6903: if ($match) {
6904: if ($env{'user.priv.'.$env{'request.role'}.'./'}
6905: =~/\Q$priv\E\&([^\:]*)/) {
1.1281 raeburn 6906: my $value = $1;
6907: if ($noblockcheck) {
6908: $thisallowed.=$value;
1.1162 raeburn 6909: } else {
1.1281 raeburn 6910: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6911: if (@blockers > 0) {
6912: $thisallowed = 'B';
6913: } else {
6914: $thisallowed.=$value;
6915: }
1.1162 raeburn 6916: }
1.671 raeburn 6917: }
6918: } else {
1.705 albertel 6919: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 6920: if ($refuri) {
6921: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 6922: $thisallowed='F';
1.671 raeburn 6923: } else {
6924: $refuri=&declutter($refuri);
6925: my ($match) = &is_on_map($refuri);
6926: if ($match) {
1.1281 raeburn 6927: if ($noblockcheck) {
6928: $thisallowed='F';
1.1162 raeburn 6929: } else {
1.1281 raeburn 6930: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6931: if (@blockers > 0) {
6932: $thisallowed = 'B';
6933: } else {
6934: $thisallowed='F';
6935: }
1.1162 raeburn 6936: }
1.671 raeburn 6937: }
1.669 raeburn 6938: }
1.671 raeburn 6939: }
6940: }
1.314 www 6941: }
1.492 albertel 6942:
1.766 albertel 6943: if ($priv eq 'bre'
6944: && $thisallowed ne 'F'
6945: && $thisallowed ne '2'
6946: && &is_portfolio_url($uri)) {
1.1270 raeburn 6947: $thisallowed = &portfolio_access($uri,$clientip);
1.766 albertel 6948: }
1.1250 raeburn 6949:
1.52 www 6950: # Full access at system, domain or course-wide level? Exit.
1.29 www 6951: if ($thisallowed=~/F/) {
6952: return 'F';
6953: }
6954:
1.52 www 6955: # If this is generating or modifying users, exit with special codes
1.29 www 6956:
1.643 www 6957: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6958: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 6959: my ($audom,$auname)=split('/',$uri);
1.643 www 6960: # no author name given, so this just checks on the general right to make a co-author in this domain
6961: unless ($auname) { return $thisallowed; }
6962: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 6963: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6964: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6965: ($audom ne $env{'request.role.domain'}))) { return ''; }
6966: }
1.52 www 6967: return $thisallowed;
6968: }
6969: #
1.103 harris41 6970: # Gathered so far: system, domain and course wide privileges
1.52 www 6971: #
6972: # Course: See if uri or referer is an individual resource that is part of
6973: # the course
6974:
1.620 albertel 6975: if ($env{'request.course.id'}) {
1.232 www 6976:
1.620 albertel 6977: $courseprivid=$env{'request.course.id'};
6978: if ($env{'request.course.sec'}) {
6979: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 6980: }
6981: $courseprivid=~s/\_/\//;
6982: my $checkreferer=1;
1.232 www 6983: my ($match,$cond)=&is_on_map($uri);
6984: if ($match) {
6985: $statecond=$cond;
1.620 albertel 6986: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 6987: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 6988: my $value = $1;
6989: if ($priv eq 'bre') {
1.1281 raeburn 6990: if ($noblockcheck) {
6991: $thisallowed.=$value;
1.1162 raeburn 6992: } else {
1.1281 raeburn 6993: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6994: if (@blockers > 0) {
6995: $thisallowed = 'B';
6996: } else {
6997: $thisallowed.=$value;
6998: }
1.1162 raeburn 6999: }
7000: } else {
7001: $thisallowed.=$value;
7002: }
1.52 www 7003: $checkreferer=0;
7004: }
1.29 www 7005: }
1.83 www 7006:
1.148 www 7007: if ($checkreferer) {
1.620 albertel 7008: my $refuri=$env{'httpref.'.$orguri};
1.148 www 7009: unless ($refuri) {
1.800 albertel 7010: foreach my $key (keys(%env)) {
7011: if ($key=~/^httpref\..*\*/) {
7012: my $pattern=$key;
1.156 www 7013: $pattern=~s/^httpref\.\/res\///;
1.148 www 7014: $pattern=~s/\*/\[\^\/\]\+/g;
7015: $pattern=~s/\//\\\//g;
1.152 www 7016: if ($orguri=~/$pattern/) {
1.800 albertel 7017: $refuri=$env{$key};
1.148 www 7018: }
7019: }
1.191 harris41 7020: }
1.148 www 7021: }
1.232 www 7022:
1.148 www 7023: if ($refuri) {
1.152 www 7024: $refuri=&declutter($refuri);
1.232 www 7025: my ($match,$cond)=&is_on_map($refuri);
7026: if ($match) {
7027: my $refstatecond=$cond;
1.620 albertel 7028: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 7029: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 7030: my $value = $1;
7031: if ($priv eq 'bre') {
1.1281 raeburn 7032: if ($noblockcheck) {
7033: $thisallowed.=$value;
1.1162 raeburn 7034: } else {
1.1281 raeburn 7035: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
7036: if (@blockers > 0) {
7037: $thisallowed = 'B';
7038: } else {
7039: $thisallowed.=$value;
7040: }
1.1162 raeburn 7041: }
7042: } else {
7043: $thisallowed.=$value;
7044: }
1.53 www 7045: $uri=$refuri;
7046: $statecond=$refstatecond;
1.52 www 7047: }
7048: }
1.148 www 7049: }
1.29 www 7050: }
1.52 www 7051: }
1.29 www 7052:
1.52 www 7053: #
1.103 harris41 7054: # Gathered now: all privileges that could apply, and condition number
1.52 www 7055: #
7056: #
7057: # Full or no access?
7058: #
1.29 www 7059:
1.52 www 7060: if ($thisallowed=~/F/) {
7061: return 'F';
7062: }
1.29 www 7063:
1.52 www 7064: unless ($thisallowed) {
7065: return '';
7066: }
1.29 www 7067:
1.52 www 7068: # Restrictions exist, deal with them
7069: #
7070: # C:according to course preferences
7071: # R:according to resource settings
7072: # L:unless locked
7073: # X:according to user session state
7074: #
7075:
7076: # Possibly locked functionality, check all courses
1.54 www 7077: # Locks might take effect only after 10 minutes cache expiration for other
7078: # courses, and 2 minutes for current course
1.52 www 7079:
7080: my $envkey;
7081: if ($thisallowed=~/L/) {
1.1000 raeburn 7082: foreach $envkey (keys(%env)) {
1.54 www 7083: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
7084: my $courseid=$2;
7085: my $roleid=$1.'.'.$2;
1.92 www 7086: $courseid=~s/^\///;
1.54 www 7087: my $expiretime=600;
1.620 albertel 7088: if ($env{'request.role'} eq $roleid) {
1.54 www 7089: $expiretime=120;
7090: }
7091: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
7092: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 7093: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 7094: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 7095: }
1.620 albertel 7096: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
7097: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
7098: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
7099: &log($env{'user.domain'},$env{'user.name'},
7100: $env{'user.home'},
1.57 www 7101: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 7102: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7103: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7104: return '';
7105: }
7106: }
1.620 albertel 7107: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
7108: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
7109: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
7110: &log($env{'user.domain'},$env{'user.name'},
7111: $env{'user.home'},
1.57 www 7112: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 7113: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 7114: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 7115: return '';
7116: }
7117: }
7118: }
1.29 www 7119: }
1.52 www 7120: }
7121:
7122: #
7123: # Rest of the restrictions depend on selected course
7124: #
7125:
1.620 albertel 7126: unless ($env{'request.course.id'}) {
1.766 albertel 7127: if ($thisallowed eq 'A') {
7128: return 'A';
1.814 raeburn 7129: } elsif ($thisallowed eq 'B') {
7130: return 'B';
1.766 albertel 7131: } else {
7132: return '1';
7133: }
1.52 www 7134: }
1.29 www 7135:
1.52 www 7136: #
7137: # Now user is definitely in a course
7138: #
1.53 www 7139:
7140:
7141: # Course preferences
7142:
7143: if ($thisallowed=~/C/) {
1.620 albertel 7144: my $rolecode=(split(/\./,$env{'request.role'}))[0];
7145: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
7146: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 7147: =~/\Q$rolecode\E/) {
1.1103 raeburn 7148: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7149: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7150: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
7151: $env{'request.course.id'});
7152: }
1.237 www 7153: return '';
7154: }
7155:
1.620 albertel 7156: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 7157: =~/\Q$unamedom\E/) {
1.1103 raeburn 7158: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7159: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
7160: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
7161: $env{'request.course.id'});
7162: }
1.54 www 7163: return '';
7164: }
1.53 www 7165: }
7166:
7167: # Resource preferences
7168:
7169: if ($thisallowed=~/R/) {
1.620 albertel 7170: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 7171: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 7172: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 7173: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
7174: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
7175: }
7176: return '';
1.54 www 7177: }
1.53 www 7178: }
1.30 www 7179:
1.246 www 7180: # Restricted by state or randomout?
1.30 www 7181:
1.52 www 7182: if ($thisallowed=~/X/) {
1.620 albertel 7183: if ($env{'acc.randomout'}) {
1.579 albertel 7184: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 7185: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 7186: return '';
7187: }
1.247 www 7188: }
7189: if (&condval($statecond)) {
1.52 www 7190: return '2';
7191: } else {
7192: return '';
7193: }
7194: }
1.30 www 7195:
1.766 albertel 7196: if ($thisallowed eq 'A') {
7197: return 'A';
1.814 raeburn 7198: } elsif ($thisallowed eq 'B') {
7199: return 'B';
1.766 albertel 7200: }
1.52 www 7201: return 'F';
1.232 www 7202: }
1.1162 raeburn 7203:
1.1192 raeburn 7204: # ------------------------------------------- Check construction space access
7205:
7206: sub constructaccess {
7207: my ($url,$setpriv)=@_;
7208:
7209: # We do not allow editing of previous versions of files
7210: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
7211:
7212: # Get username and domain from URL
7213: my ($ownername,$ownerdomain,$ownerhome);
7214:
7215: ($ownerdomain,$ownername) =
7216: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)/});
7217:
7218: # The URL does not really point to any authorspace, forget it
7219: unless (($ownername) && ($ownerdomain)) { return ''; }
7220:
7221: # Now we need to see if the user has access to the authorspace of
7222: # $ownername at $ownerdomain
7223:
7224: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
7225: # Real author for this?
7226: $ownerhome = $env{'user.home'};
7227: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
7228: return ($ownername,$ownerdomain,$ownerhome);
7229: }
7230: } else {
7231: # Co-author for this?
7232: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
7233: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
7234: $ownerhome = &homeserver($ownername,$ownerdomain);
7235: return ($ownername,$ownerdomain,$ownerhome);
7236: }
7237: }
7238:
7239: # We don't have any access right now. If we are not possibly going to do anything about this,
7240: # we might as well leave
7241: unless ($setpriv) { return ''; }
7242:
7243: # Backdoor access?
7244: my $allowed=&allowed('eco',$ownerdomain);
7245: # Nope
7246: unless ($allowed) { return ''; }
7247: # Looks like we may have access, but could be locked by the owner of the construction space
7248: if ($allowed eq 'U') {
7249: my %blocked=&get('environment',['domcoord.author'],
7250: $ownerdomain,$ownername);
7251: # Is blocked by owner
7252: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7253: }
7254: if (($allowed eq 'F') || ($allowed eq 'U')) {
7255: # Grant temporary access
7256: my $then=$env{'user.login.time'};
1.1209 raeburn 7257: my $update=$env{'user.update.time'};
1.1192 raeburn 7258: if (!$update) { $update = $then; }
7259: my $refresh=$env{'user.refresh.time'};
7260: if (!$refresh) { $refresh = $update; }
7261: my $now = time;
7262: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7263: $now,'ca','constructaccess');
7264: $ownerhome = &homeserver($ownername,$ownerdomain);
7265: return($ownername,$ownerdomain,$ownerhome);
7266: }
7267: # No business here
7268: return '';
7269: }
7270:
1.1282 raeburn 7271: # ----------------------------------------------------------- Content Blocking
7272:
7273: {
7274: # Caches for faster Course Contents display where content blocking
7275: # is in operation (i.e., interval param set) for timed quiz.
7276: #
7277: # User for whom data are being temporarily cached.
7278: my $cacheduser='';
7279: # Cached blockers for this user (a hash of blocking items).
7280: my %cachedblockers=();
7281: # When the data were last cached.
7282: my $cachedlast='';
7283:
7284: sub load_all_blockers {
7285: my ($uname,$udom,$blocks)=@_;
7286: if (($uname ne '') && ($udom ne '')) {
7287: if (($cacheduser eq $uname.':'.$udom) &&
7288: (abs($cachedlast-time)<5)) {
7289: return;
7290: }
7291: }
7292: $cachedlast=time;
7293: $cacheduser=$uname.':'.$udom;
7294: %cachedblockers = &get_commblock_resources($blocks);
7295: }
7296:
1.1162 raeburn 7297: sub get_comm_blocks {
7298: my ($cdom,$cnum) = @_;
7299: if ($cdom eq '' || $cnum eq '') {
7300: return unless ($env{'request.course.id'});
7301: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7302: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7303: }
7304: my %commblocks;
7305: my $hashid=$cdom.'_'.$cnum;
7306: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7307: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7308: %commblocks = %{$blocksref};
7309: } else {
7310: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7311: my $cachetime = 600;
7312: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7313: }
7314: return %commblocks;
7315: }
7316:
1.1282 raeburn 7317: sub get_commblock_resources {
7318: my ($blocks) = @_;
7319: my %blockers = ();
7320: return %blockers unless ($env{'request.course.id'});
7321: return %blockers if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
1.1162 raeburn 7322: my %commblocks;
7323: if (ref($blocks) eq 'HASH') {
7324: %commblocks = %{$blocks};
7325: } else {
7326: %commblocks = &get_comm_blocks();
7327: }
1.1282 raeburn 7328: return %blockers unless (keys(%commblocks) > 0);
7329: my $navmap = Apache::lonnavmaps::navmap->new();
7330: return %blockers unless (ref($navmap));
1.1162 raeburn 7331: my $now = time;
7332: foreach my $block (keys(%commblocks)) {
7333: if ($block =~ /^(\d+)____(\d+)$/) {
7334: my ($start,$end) = ($1,$2);
7335: if ($start <= $now && $end >= $now) {
7336: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7337: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7338: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
1.1282 raeburn 7339: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7340: $blockers{$block}{maps} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
1.1162 raeburn 7341: }
7342: }
7343: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
1.1282 raeburn 7344: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7345: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1162 raeburn 7346: }
7347: }
7348: }
7349: }
7350: }
7351: } elsif ($block =~ /^firstaccess____(.+)$/) {
7352: my $item = $1;
1.1163 raeburn 7353: my @to_test;
1.1162 raeburn 7354: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7355: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
1.1282 raeburn 7356: my @interval;
7357: my $type = 'map';
7358: if ($item eq 'course') {
7359: $type = 'course';
7360: @interval=&EXT("resource.0.interval");
7361: } else {
7362: if ($item =~ /___\d+___/) {
7363: $type = 'resource';
7364: @interval=&EXT("resource.0.interval",$item);
7365: if (ref($navmap)) {
7366: my $res = $navmap->getBySymb($item);
7367: push(@to_test,$res);
7368: }
1.1162 raeburn 7369: } else {
1.1282 raeburn 7370: my $mapsymb = &symbread($item,1);
7371: if ($mapsymb) {
7372: if (ref($navmap)) {
7373: my $mapres = $navmap->getBySymb($mapsymb);
7374: @to_test = $mapres->retrieveResources($mapres,undef,0,0,0,1);
7375: foreach my $res (@to_test) {
7376: my $symb = $res->symb();
7377: next if ($symb eq $mapsymb);
7378: if ($symb ne '') {
7379: @interval=&EXT("resource.0.interval",$symb);
7380: if ($interval[1] eq 'map') {
7381: last;
1.1162 raeburn 7382: }
7383: }
7384: }
7385: }
7386: }
7387: }
1.1282 raeburn 7388: }
1.1292 raeburn 7389: if ($interval[0] =~ /^\d+/) {
7390: my ($timelimit) = split(/_/,$interval[0]);
1.1282 raeburn 7391: my $first_access;
7392: if ($type eq 'resource') {
7393: $first_access=&get_first_access($interval[1],$item);
7394: } elsif ($type eq 'map') {
7395: $first_access=&get_first_access($interval[1],undef,$item);
7396: } else {
7397: $first_access=&get_first_access($interval[1]);
7398: }
7399: if ($first_access) {
1.1292 raeburn 7400: my $timesup = $first_access+$timelimit;
1.1282 raeburn 7401: if ($timesup > $now) {
7402: my $activeblock;
7403: foreach my $res (@to_test) {
1.1283 raeburn 7404: if ($res->answerable()) {
1.1282 raeburn 7405: $activeblock = 1;
7406: last;
7407: }
7408: }
7409: if ($activeblock) {
7410: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7411: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'maps'}})) {
7412: $blockers{$block}{'maps'} = $commblocks{$block}{'blocks'}{'docs'}{'maps'};
7413: }
7414: }
7415: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7416: if (keys(%{$commblocks{$block}{'blocks'}{'docs'}{'resources'}})) {
7417: $blockers{$block}{'resources'} = $commblocks{$block}{'blocks'}{'docs'}{'resources'};
1.1163 raeburn 7418: }
1.1162 raeburn 7419: }
7420: }
7421: }
7422: }
7423: }
7424: }
7425: }
7426: }
7427: }
1.1282 raeburn 7428: return %blockers;
1.1162 raeburn 7429: }
7430:
1.1282 raeburn 7431: sub has_comm_blocking {
7432: my ($priv,$symb,$uri,$blocks) = @_;
7433: my @blockers;
7434: return unless ($env{'request.course.id'});
7435: return unless ($priv eq 'bre');
7436: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7437: return if ($env{'request.state'} eq 'construct');
7438: &load_all_blockers($env{'user.name'},$env{'user.domain'},$blocks);
7439: return unless (keys(%cachedblockers) > 0);
7440: my (%possibles,@symbs);
7441: if (!$symb) {
7442: $symb = &symbread($uri,1,1,1,\%possibles);
1.1162 raeburn 7443: }
1.1282 raeburn 7444: if ($symb) {
7445: @symbs = ($symb);
7446: } elsif (keys(%possibles)) {
7447: @symbs = keys(%possibles);
7448: }
7449: my $noblock;
7450: foreach my $symb (@symbs) {
7451: last if ($noblock);
7452: my ($map,$resid,$resurl)=&decode_symb($symb);
7453: foreach my $block (keys(%cachedblockers)) {
7454: if ($block =~ /^firstaccess____(.+)$/) {
7455: my $item = $1;
7456: if (($item eq $map) || ($item eq $symb)) {
7457: $noblock = 1;
7458: last;
7459: }
7460: }
7461: if (ref($cachedblockers{$block}) eq 'HASH') {
7462: if (ref($cachedblockers{$block}{'resources'}) eq 'HASH') {
7463: if ($cachedblockers{$block}{'resources'}{$symb}) {
7464: unless (grep(/^\Q$block\E$/,@blockers)) {
7465: push(@blockers,$block);
7466: }
7467: }
7468: }
1.1162 raeburn 7469: }
1.1282 raeburn 7470: if (ref($cachedblockers{$block}{'maps'}) eq 'HASH') {
7471: if ($cachedblockers{$block}{'maps'}{$map}) {
7472: unless (grep(/^\Q$block\E$/,@blockers)) {
7473: push(@blockers,$block);
7474: }
7475: }
1.1162 raeburn 7476: }
7477: }
7478: }
1.1282 raeburn 7479: return if ($noblock);
7480: return @blockers;
7481: }
1.1162 raeburn 7482: }
7483:
1.1282 raeburn 7484: # -------------------------------- Deversion and split uri into path an filename
7485:
1.1133 foxr 7486: #
1.1282 raeburn 7487: # Removes the version from a URI and
1.1133 foxr 7488: # splits it in to its filename and path to the filename.
7489: # Seems like File::Basename could have done this more clearly.
7490: # Parameters:
7491: # $uri - input URI
7492: # Returns:
7493: # Two element list consisting of
7494: # $pathname - the URI up to and excluding the trailing /
7495: # $filename - The part of the URI following the last /
7496: # NOTE:
7497: # Another realization of this is simply:
7498: # use File::Basename;
7499: # ...
7500: # $uri = shift;
7501: # $filename = basename($uri);
7502: # $path = dirname($uri);
7503: # return ($filename, $path);
7504: #
7505: # The implementation below is probably faster however.
7506: #
1.710 albertel 7507: sub split_uri_for_cond {
7508: my $uri=&deversion(&declutter(shift));
7509: my @uriparts=split(/\//,$uri);
7510: my $filename=pop(@uriparts);
7511: my $pathname=join('/',@uriparts);
7512: return ($pathname,$filename);
7513: }
1.232 www 7514: # --------------------------------------------------- Is a resource on the map?
7515:
7516: sub is_on_map {
1.710 albertel 7517: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 7518: #Trying to find the conditional for the file
1.620 albertel 7519: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 7520: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 7521: if ($match) {
1.289 bowersj2 7522: return (1,$1);
7523: } else {
1.434 www 7524: return (0,0);
1.289 bowersj2 7525: }
1.12 www 7526: }
7527:
1.427 www 7528: # --------------------------------------------------------- Get symb from alias
7529:
7530: sub get_symb_from_alias {
7531: my $symb=shift;
7532: my ($map,$resid,$url)=&decode_symb($symb);
7533: # Already is a symb
7534: if ($url) { return $symb; }
7535: # Must be an alias
7536: my $aliassymb='';
7537: my %bighash;
1.620 albertel 7538: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 7539: &GDBM_READER(),0640)) {
7540: my $rid=$bighash{'mapalias_'.$symb};
7541: if ($rid) {
7542: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 7543: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7544: $resid,$bighash{'src_'.$rid});
1.427 www 7545: }
7546: untie %bighash;
7547: }
7548: return $aliassymb;
7549: }
7550:
1.12 www 7551: # ----------------------------------------------------------------- Define Role
7552:
7553: sub definerole {
7554: if (allowed('mcr','/')) {
7555: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 7556: foreach my $role (split(':',$sysrole)) {
7557: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7558: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7559: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7560: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7561: return "refused:s:$crole&$cqual";
7562: }
7563: }
1.191 harris41 7564: }
1.800 albertel 7565: foreach my $role (split(':',$domrole)) {
7566: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7567: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7568: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7569: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 7570: return "refused:d:$crole&$cqual";
7571: }
7572: }
1.191 harris41 7573: }
1.800 albertel 7574: foreach my $role (split(':',$courole)) {
7575: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7576: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7577: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7578: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7579: return "refused:c:$crole&$cqual";
7580: }
7581: }
1.191 harris41 7582: }
1.620 albertel 7583: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7584: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 7585: "rolesdef_$rolename=".
7586: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 7587: return reply($command,$env{'user.home'});
1.12 www 7588: } else {
7589: return 'refused';
7590: }
1.105 harris41 7591: }
7592:
7593: # ---------------- Make a metadata query against the network of library servers
7594:
7595: sub metadata_query {
1.1237 raeburn 7596: my ($query,$custom,$customshow,$server_array,$domains_hash)=@_;
1.120 harris41 7597: my %rhash;
1.845 albertel 7598: my %libserv = &all_library();
1.244 matthew 7599: my @server_list = (defined($server_array) ? @$server_array
7600: : keys(%libserv) );
7601: for my $server (@server_list) {
1.1237 raeburn 7602: my $domains = '';
7603: if (ref($domains_hash) eq 'HASH') {
7604: $domains = $domains_hash->{$server};
7605: }
1.118 harris41 7606: unless ($custom or $customshow) {
1.1237 raeburn 7607: my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
1.118 harris41 7608: $rhash{$server}=$reply;
7609: }
7610: else {
7611: my $reply=&reply("querysend:".&escape($query).':'.
1.1237 raeburn 7612: &escape($custom).':'.&escape($customshow).':'.&escape($domains),
1.118 harris41 7613: $server);
7614: $rhash{$server}=$reply;
7615: }
1.112 harris41 7616: }
1.118 harris41 7617: return \%rhash;
1.240 www 7618: }
7619:
7620: # ----------------------------------------- Send log queries and wait for reply
7621:
7622: sub log_query {
7623: my ($uname,$udom,$query,%filters)=@_;
7624: my $uhome=&homeserver($uname,$udom);
7625: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 7626: my $uhost=&hostname($uhome);
1.800 albertel 7627: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 7628: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
7629: $uhome);
1.479 albertel 7630: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 7631: return get_query_reply($queryid);
7632: }
7633:
1.818 raeburn 7634: # -------------------------- Update MySQL table for portfolio file
7635:
7636: sub update_portfolio_table {
1.821 raeburn 7637: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 7638: if ($group ne '') {
7639: $file_name =~s /^\Q$group\E//;
7640: }
1.818 raeburn 7641: my $homeserver = &homeserver($uname,$udom);
7642: my $queryid=
1.821 raeburn 7643: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
7644: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 7645: my $reply = &get_query_reply($queryid);
7646: return $reply;
7647: }
7648:
1.899 raeburn 7649: # -------------------------- Update MySQL allusers table
7650:
7651: sub update_allusers_table {
7652: my ($uname,$udom,$names) = @_;
7653: my $homeserver = &homeserver($uname,$udom);
7654: my $queryid=
7655: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
7656: 'lastname='.&escape($names->{'lastname'}).'%%'.
7657: 'firstname='.&escape($names->{'firstname'}).'%%'.
7658: 'middlename='.&escape($names->{'middlename'}).'%%'.
7659: 'generation='.&escape($names->{'generation'}).'%%'.
7660: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
7661: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 7662: return;
1.899 raeburn 7663: }
7664:
1.508 raeburn 7665: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 7666:
7667: sub fetch_enrollment_query {
1.511 raeburn 7668: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 7669: my $homeserver;
1.547 raeburn 7670: my $maxtries = 1;
1.508 raeburn 7671: if ($context eq 'automated') {
7672: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 7673: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 7674: } else {
7675: $homeserver = &homeserver($cnum,$dom);
7676: }
1.838 albertel 7677: my $host=&hostname($homeserver);
1.506 raeburn 7678: my $cmd = '';
1.1000 raeburn 7679: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 7680: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 7681: }
7682: $cmd =~ s/%%$//;
7683: $cmd = &escape($cmd);
7684: my $query = 'fetchenrollment';
1.620 albertel 7685: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 7686: unless ($queryid=~/^\Q$host\E\_/) {
7687: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
7688: return 'error: '.$queryid;
7689: }
1.506 raeburn 7690: my $reply = &get_query_reply($queryid);
1.547 raeburn 7691: my $tries = 1;
7692: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7693: $reply = &get_query_reply($queryid);
7694: $tries ++;
7695: }
1.526 raeburn 7696: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 7697: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 7698: } else {
1.901 albertel 7699: my @responses = split(/:/,$reply);
1.515 raeburn 7700: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 7701: foreach my $line (@responses) {
7702: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 7703: $$replyref{$key} = $value;
7704: }
7705: } else {
1.1117 foxr 7706: my $pathname = LONCAPA::tempdir();
1.800 albertel 7707: foreach my $line (@responses) {
7708: my ($key,$value) = split(/=/,$line);
1.506 raeburn 7709: $$replyref{$key} = $value;
7710: if ($value > 0) {
1.800 albertel 7711: foreach my $item (@{$$affiliatesref{$key}}) {
7712: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 7713: my $destname = $pathname.'/'.$filename;
7714: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 7715: if ($xml_classlist =~ /^error/) {
7716: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
7717: } else {
1.506 raeburn 7718: if ( open(FILE,">$destname") ) {
7719: print FILE &unescape($xml_classlist);
7720: close(FILE);
1.526 raeburn 7721: } else {
7722: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 7723: }
7724: }
7725: }
7726: }
7727: }
7728: }
7729: return 'ok';
7730: }
7731: return 'error';
7732: }
7733:
1.242 www 7734: sub get_query_reply {
7735: my $queryid=shift;
1.1117 foxr 7736: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 7737: my $reply='';
7738: for (1..100) {
1.1289 damieng 7739: sleep(0.2);
1.240 www 7740: if (-e $replyfile.'.end') {
1.448 albertel 7741: if (open(my $fh,$replyfile)) {
1.904 albertel 7742: $reply = join('',<$fh>);
7743: close($fh);
1.240 www 7744: } else { return 'error: reply_file_error'; }
1.242 www 7745: return &unescape($reply);
7746: }
1.240 www 7747: }
1.242 www 7748: return 'timeout:'.$queryid;
1.240 www 7749: }
7750:
7751: sub courselog_query {
1.241 www 7752: #
7753: # possible filters:
7754: # url: url or symb
7755: # username
7756: # domain
7757: # action: view, submit, grade
7758: # start: timestamp
7759: # end: timestamp
7760: #
1.240 www 7761: my (%filters)=@_;
1.620 albertel 7762: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 7763: if ($filters{'url'}) {
7764: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
7765: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
7766: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
7767: }
1.620 albertel 7768: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
7769: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 7770: return &log_query($cname,$cdom,'courselog',%filters);
7771: }
7772:
7773: sub userlog_query {
1.858 raeburn 7774: #
7775: # possible filters:
7776: # action: log check role
7777: # start: timestamp
7778: # end: timestamp
7779: #
1.240 www 7780: my ($uname,$udom,%filters)=@_;
7781: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 7782: }
7783:
1.506 raeburn 7784: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
7785:
7786: sub auto_run {
1.508 raeburn 7787: my ($cnum,$cdom) = @_;
1.876 raeburn 7788: my $response = 0;
7789: my $settings;
7790: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
7791: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
7792: $settings = $domconfig{'autoenroll'};
7793: if ($settings->{'run'} eq '1') {
7794: $response = 1;
7795: }
7796: } else {
1.934 raeburn 7797: my $homeserver;
7798: if (&is_course($cdom,$cnum)) {
7799: $homeserver = &homeserver($cnum,$cdom);
7800: } else {
7801: $homeserver = &domain($cdom,'primary');
7802: }
7803: if ($homeserver ne 'no_host') {
7804: $response = &reply('autorun:'.$cdom,$homeserver);
7805: }
1.876 raeburn 7806: }
1.506 raeburn 7807: return $response;
7808: }
1.776 albertel 7809:
1.506 raeburn 7810: sub auto_get_sections {
1.508 raeburn 7811: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 7812: my $homeserver;
7813: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7814: $homeserver = &homeserver($cnum,$cdom);
7815: }
7816: if (!defined($homeserver)) {
7817: if ($cdom =~ /^$match_domain$/) {
7818: $homeserver = &domain($cdom,'primary');
7819: }
7820: }
7821: my @secs;
7822: if (defined($homeserver)) {
7823: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
7824: unless ($response eq 'refused') {
7825: @secs = split(/:/,$response);
7826: }
1.506 raeburn 7827: }
7828: return @secs;
7829: }
1.776 albertel 7830:
1.506 raeburn 7831: sub auto_new_course {
1.1099 raeburn 7832: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 7833: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 7834: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 7835: return $response;
7836: }
1.776 albertel 7837:
1.506 raeburn 7838: sub auto_validate_courseID {
1.508 raeburn 7839: my ($cnum,$cdom,$inst_course_id) = @_;
7840: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 7841: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 7842: return $response;
7843: }
1.776 albertel 7844:
1.1007 raeburn 7845: sub auto_validate_instcode {
1.1020 raeburn 7846: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 7847: my ($homeserver,$response);
7848: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7849: $homeserver = &homeserver($cnum,$cdom);
7850: }
7851: if (!defined($homeserver)) {
7852: if ($cdom =~ /^$match_domain$/) {
7853: $homeserver = &domain($cdom,'primary');
7854: }
7855: }
1.1065 raeburn 7856: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
7857: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 7858: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
7859: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 7860: }
7861:
1.506 raeburn 7862: sub auto_create_password {
1.873 raeburn 7863: my ($cnum,$cdom,$authparam,$udom) = @_;
7864: my ($homeserver,$response);
1.506 raeburn 7865: my $create_passwd = 0;
7866: my $authchk = '';
1.873 raeburn 7867: if ($udom =~ /^$match_domain$/) {
7868: $homeserver = &domain($udom,'primary');
7869: }
7870: if ($homeserver eq '') {
7871: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7872: $homeserver = &homeserver($cnum,$cdom);
7873: }
7874: }
7875: if ($homeserver eq '') {
7876: $authchk = 'nodomain';
1.506 raeburn 7877: } else {
1.873 raeburn 7878: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
7879: if ($response eq 'refused') {
7880: $authchk = 'refused';
7881: } else {
1.901 albertel 7882: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 7883: }
1.506 raeburn 7884: }
7885: return ($authparam,$create_passwd,$authchk);
7886: }
7887:
1.706 raeburn 7888: sub auto_photo_permission {
7889: my ($cnum,$cdom,$students) = @_;
7890: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 7891: my ($outcome,$perm_reqd,$conditions) =
7892: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 7893: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7894: return (undef,undef);
7895: }
1.706 raeburn 7896: return ($outcome,$perm_reqd,$conditions);
7897: }
7898:
7899: sub auto_checkphotos {
7900: my ($uname,$udom,$pid) = @_;
7901: my $homeserver = &homeserver($uname,$udom);
7902: my ($result,$resulttype);
7903: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 7904: &escape($uname).':'.&escape($pid),
7905: $homeserver));
1.709 albertel 7906: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7907: return (undef,undef);
7908: }
1.706 raeburn 7909: if ($outcome) {
7910: ($result,$resulttype) = split(/:/,$outcome);
7911: }
7912: return ($result,$resulttype);
7913: }
7914:
7915: sub auto_photochoice {
7916: my ($cnum,$cdom) = @_;
7917: my $homeserver = &homeserver($cnum,$cdom);
7918: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 7919: &escape($cdom),
7920: $homeserver)));
1.709 albertel 7921: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7922: return (undef,undef);
7923: }
1.706 raeburn 7924: return ($update,$comment);
7925: }
7926:
7927: sub auto_photoupdate {
7928: my ($affiliatesref,$dom,$cnum,$photo) = @_;
7929: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 7930: my $host=&hostname($homeserver);
1.706 raeburn 7931: my $cmd = '';
7932: my $maxtries = 1;
1.800 albertel 7933: foreach my $affiliate (keys(%{$affiliatesref})) {
7934: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 7935: }
7936: $cmd =~ s/%%$//;
7937: $cmd = &escape($cmd);
7938: my $query = 'institutionalphotos';
7939: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
7940: unless ($queryid=~/^\Q$host\E\_/) {
7941: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
7942: return 'error: '.$queryid;
7943: }
7944: my $reply = &get_query_reply($queryid);
7945: my $tries = 1;
7946: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7947: $reply = &get_query_reply($queryid);
7948: $tries ++;
7949: }
7950: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7951: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7952: } else {
7953: my @responses = split(/:/,$reply);
7954: my $outcome = shift(@responses);
7955: foreach my $item (@responses) {
7956: my ($key,$value) = split(/=/,$item);
7957: $$photo{$key} = $value;
7958: }
7959: return $outcome;
7960: }
7961: return 'error';
7962: }
7963:
1.521 raeburn 7964: sub auto_instcode_format {
1.793 albertel 7965: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
7966: $cat_order) = @_;
1.521 raeburn 7967: my $courses = '';
1.772 raeburn 7968: my @homeservers;
1.521 raeburn 7969: if ($caller eq 'global') {
1.841 albertel 7970: my %servers = &get_servers($codedom,'library');
7971: foreach my $tryserver (keys(%servers)) {
7972: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7973: push(@homeservers,$tryserver);
7974: }
1.584 raeburn 7975: }
1.1022 raeburn 7976: } elsif ($caller eq 'requests') {
7977: if ($codedom =~ /^$match_domain$/) {
7978: my $chome = &domain($codedom,'primary');
7979: unless ($chome eq 'no_host') {
7980: push(@homeservers,$chome);
7981: }
7982: }
1.521 raeburn 7983: } else {
1.772 raeburn 7984: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 7985: }
1.793 albertel 7986: foreach my $code (keys(%{$instcodes})) {
7987: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 7988: }
7989: chop($courses);
1.772 raeburn 7990: my $ok_response = 0;
7991: my $response;
7992: while (@homeservers > 0 && $ok_response == 0) {
7993: my $server = shift(@homeservers);
7994: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
7995: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
7996: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 7997: split(/:/,$response);
1.772 raeburn 7998: %{$codes} = (%{$codes},&str2hash($codes_str));
7999: push(@{$codetitles},&str2array($codetitles_str));
8000: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
8001: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
8002: $ok_response = 1;
8003: }
8004: }
8005: if ($ok_response) {
1.521 raeburn 8006: return 'ok';
1.772 raeburn 8007: } else {
8008: return $response;
1.521 raeburn 8009: }
8010: }
8011:
1.792 raeburn 8012: sub auto_instcode_defaults {
8013: my ($domain,$returnhash,$code_order) = @_;
8014: my @homeservers;
1.841 albertel 8015:
8016: my %servers = &get_servers($domain,'library');
8017: foreach my $tryserver (keys(%servers)) {
8018: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8019: push(@homeservers,$tryserver);
8020: }
1.792 raeburn 8021: }
1.841 albertel 8022:
1.792 raeburn 8023: my $response;
1.841 albertel 8024: foreach my $server (@homeservers) {
1.792 raeburn 8025: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 8026: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
8027:
8028: foreach my $pair (split(/\&/,$response)) {
8029: my ($name,$value)=split(/\=/,$pair);
8030: if ($name eq 'code_order') {
8031: @{$code_order} = split(/\&/,&unescape($value));
8032: } else {
8033: $returnhash->{&unescape($name)}=&unescape($value);
8034: }
8035: }
8036: return 'ok';
1.792 raeburn 8037: }
1.841 albertel 8038:
8039: return $response;
1.1003 raeburn 8040: }
8041:
8042: sub auto_possible_instcodes {
1.1007 raeburn 8043: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
8044: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
8045: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8046: return;
8047: }
1.1003 raeburn 8048: my (@homeservers,$uhome);
8049: if (defined(&domain($domain,'primary'))) {
8050: $uhome=&domain($domain,'primary');
8051: push(@homeservers,&domain($domain,'primary'));
8052: } else {
8053: my %servers = &get_servers($domain,'library');
8054: foreach my $tryserver (keys(%servers)) {
8055: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
8056: push(@homeservers,$tryserver);
8057: }
8058: }
8059: }
8060: my $response;
8061: foreach my $server (@homeservers) {
8062: $response=&reply('autopossibleinstcodes:'.$domain,$server);
8063: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 8064: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
8065: split(':',$response);
8066: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
8067: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 8068: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 8069: my ($name,$value)=split('=',$item);
8070: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8071: }
8072: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 8073: my ($name,$value)=split('=',$item);
8074: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 8075: }
8076: return 'ok';
8077: }
8078: return $response;
8079: }
1.792 raeburn 8080:
1.1010 raeburn 8081: sub auto_courserequest_checks {
8082: my ($dom) = @_;
1.1020 raeburn 8083: my ($homeserver,%validations);
8084: if ($dom =~ /^$match_domain$/) {
8085: $homeserver = &domain($dom,'primary');
8086: }
8087: unless ($homeserver eq 'no_host') {
8088: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
8089: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8090: my @items = split(/&/,$response);
8091: foreach my $item (@items) {
8092: my ($key,$value) = split('=',$item);
8093: $validations{&unescape($key)} = &thaw_unescape($value);
8094: }
8095: }
8096: }
1.1010 raeburn 8097: return %validations;
8098: }
8099:
1.1020 raeburn 8100: sub auto_courserequest_validation {
1.1255 raeburn 8101: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist,$custominfo) = @_;
1.1020 raeburn 8102: my ($homeserver,$response);
8103: if ($dom =~ /^$match_domain$/) {
8104: $homeserver = &domain($dom,'primary');
8105: }
1.1255 raeburn 8106: unless ($homeserver eq 'no_host') {
8107: my $customdata;
8108: if (ref($custominfo) eq 'HASH') {
8109: $customdata = &freeze_escape($custominfo);
8110: }
1.1020 raeburn 8111: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 8112: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1255 raeburn 8113: ':'.&escape($instcode).':'.&escape($instseclist).':'.
8114: $customdata,$homeserver));
1.1020 raeburn 8115: }
8116: return $response;
8117: }
8118:
1.777 albertel 8119: sub auto_validate_class_sec {
1.918 raeburn 8120: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 8121: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 8122: my $ownerlist;
8123: if (ref($owners) eq 'ARRAY') {
8124: $ownerlist = join(',',@{$owners});
8125: } else {
8126: $ownerlist = $owners;
8127: }
1.773 raeburn 8128: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 8129: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 8130: return $response;
8131: }
8132:
1.1248 raeburn 8133: sub auto_crsreq_update {
8134: my ($cdom,$cnum,$crstype,$action,$ownername,$ownerdomain,$fullname,$title,
1.1257 raeburn 8135: $code,$accessstart,$accessend,$inbound) = @_;
1.1248 raeburn 8136: my ($homeserver,%crsreqresponse);
8137: if ($cdom =~ /^$match_domain$/) {
8138: $homeserver = &domain($cdom,'primary');
8139: }
8140: unless (($homeserver eq 'no_host') || ($homeserver eq '')) {
8141: my $info;
8142: if (ref($inbound) eq 'HASH') {
8143: $info = &freeze_escape($inbound);
8144: }
8145: my $response=&reply('autocrsrequpdate:'.$cdom.':'.$cnum.':'.&escape($crstype).
8146: ':'.&escape($action).':'.&escape($ownername).':'.
8147: &escape($ownerdomain).':'.&escape($fullname).':'.
1.1257 raeburn 8148: &escape($title).':'.&escape($code).':'.
8149: &escape($accessstart).':'.&escape($accessend).':'.$info,
8150: $homeserver);
1.1248 raeburn 8151: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
8152: my @items = split(/&/,$response);
8153: foreach my $item (@items) {
8154: my ($key,$value) = split('=',$item);
8155: $crsreqresponse{&unescape($key)} = &thaw_unescape($value);
8156: }
8157: }
8158: }
8159: return \%crsreqresponse;
8160: }
8161:
1.1287 raeburn 8162: sub check_instcode_cloning {
8163: my ($codedefaults,$code_order,$cloner,$clonefromcode,$clonetocode) = @_;
8164: unless ((ref($codedefaults) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
8165: return;
8166: }
8167: my $canclone;
8168: if (@{$code_order} > 0) {
8169: my $instcoderegexp ='^';
8170: my @clonecodes = split(/\&/,$cloner);
8171: foreach my $item (@{$code_order}) {
8172: if (grep(/^\Q$item\E=/,@clonecodes)) {
8173: foreach my $pair (@clonecodes) {
8174: my ($key,$val) = split(/\=/,$pair,2);
8175: $val = &unescape($val);
8176: if ($key eq $item) {
8177: $instcoderegexp .= '('.$val.')';
8178: last;
8179: }
8180: }
8181: } else {
8182: $instcoderegexp .= $codedefaults->{$item};
8183: }
8184: }
8185: $instcoderegexp .= '$';
8186: my (@from,@to);
8187: eval {
8188: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8189: (@to) = ($clonetocode =~ /$instcoderegexp/);
8190: };
8191: if ((@from > 0) && (@to > 0)) {
8192: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8193: if (!@diffs) {
8194: $canclone = 1;
8195: }
8196: }
8197: }
8198: return $canclone;
8199: }
8200:
8201: sub default_instcode_cloning {
8202: my ($clonedom,$domdefclone,$clonefromcode,$clonetocode,$codedefaultsref,$codeorderref) = @_;
8203: my (%codedefaults,@code_order,$canclone);
8204: if ((ref($codedefaultsref) eq 'HASH') && (ref($codeorderref) eq 'ARRAY')) {
8205: %codedefaults = %{$codedefaultsref};
8206: @code_order = @{$codeorderref};
8207: } elsif ($clonedom) {
8208: &auto_instcode_defaults($clonedom,\%codedefaults,\@code_order);
8209: }
8210: if (($domdefclone) && (@code_order)) {
8211: my @clonecodes = split(/\+/,$domdefclone);
8212: my $instcoderegexp ='^';
8213: foreach my $item (@code_order) {
8214: if (grep(/^\Q$item\E$/,@clonecodes)) {
8215: $instcoderegexp .= '('.$codedefaults{$item}.')';
8216: } else {
8217: $instcoderegexp .= $codedefaults{$item};
8218: }
8219: }
8220: $instcoderegexp .= '$';
8221: my (@from,@to);
8222: eval {
8223: (@from) = ($clonefromcode =~ /$instcoderegexp/);
8224: (@to) = ($clonetocode =~ /$instcoderegexp/);
8225: };
8226: if ((@from > 0) && (@to > 0)) {
8227: my @diffs = &Apache::loncommon::compare_arrays(\@from,\@to);
8228: if (!@diffs) {
8229: $canclone = 1;
8230: }
8231: }
8232: }
8233: return $canclone;
8234: }
8235:
1.679 raeburn 8236: # ------------------------------------------------------- Course Group routines
8237:
8238: sub get_coursegroups {
1.809 raeburn 8239: my ($cdom,$cnum,$group,$namespace) = @_;
8240: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 8241: }
8242:
1.679 raeburn 8243: sub modify_coursegroup {
8244: my ($cdom,$cnum,$groupsettings) = @_;
8245: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
8246: }
8247:
1.809 raeburn 8248: sub toggle_coursegroup_status {
8249: my ($cdom,$cnum,$group,$action) = @_;
8250: my ($from_namespace,$to_namespace);
8251: if ($action eq 'delete') {
8252: $from_namespace = 'coursegroups';
8253: $to_namespace = 'deleted_groups';
8254: } else {
8255: $from_namespace = 'deleted_groups';
8256: $to_namespace = 'coursegroups';
8257: }
8258: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 8259: if (my $tmp = &error(%curr_group)) {
8260: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
8261: return ('read error',$tmp);
8262: } else {
8263: my %savedsettings = %curr_group;
1.809 raeburn 8264: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 8265: my $deloutcome;
8266: if ($result eq 'ok') {
1.809 raeburn 8267: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 8268: } else {
8269: return ('write error',$result);
8270: }
8271: if ($deloutcome eq 'ok') {
8272: return 'ok';
8273: } else {
8274: return ('delete error',$deloutcome);
8275: }
8276: }
8277: }
8278:
1.679 raeburn 8279: sub modify_group_roles {
1.957 raeburn 8280: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 8281: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
8282: my $role = 'gr/'.&escape($userprivs);
8283: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 8284: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 8285: if ($result eq 'ok') {
8286: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
8287: }
1.679 raeburn 8288: return $result;
8289: }
8290:
8291: sub modify_coursegroup_membership {
8292: my ($cdom,$cnum,$membership) = @_;
8293: my $result = &put('groupmembership',$membership,$cdom,$cnum);
8294: return $result;
8295: }
8296:
1.682 raeburn 8297: sub get_active_groups {
8298: my ($udom,$uname,$cdom,$cnum) = @_;
8299: my $now = time;
8300: my %groups = ();
8301: foreach my $key (keys(%env)) {
1.811 albertel 8302: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 8303: my ($start,$end) = split(/\./,$env{$key});
8304: if (($end!=0) && ($end<$now)) { next; }
8305: if (($start!=0) && ($start>$now)) { next; }
8306: if ($1 eq $cdom && $2 eq $cnum) {
8307: $groups{$3} = $env{$key} ;
8308: }
8309: }
8310: }
8311: return %groups;
8312: }
8313:
1.683 raeburn 8314: sub get_group_membership {
8315: my ($cdom,$cnum,$group) = @_;
8316: return(&dump('groupmembership',$cdom,$cnum,$group));
8317: }
8318:
8319: sub get_users_groups {
8320: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 8321: my @usersgroups;
1.683 raeburn 8322: my $cachetime=1800;
8323:
8324: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 8325: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
8326: if (defined($cached)) {
1.734 albertel 8327: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 8328: } else {
8329: $grouplist = '';
1.816 raeburn 8330: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 8331: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 8332: my $access_end = $env{'course.'.$courseid.
8333: '.default_enrollment_end_date'};
8334: my $now = time;
8335: foreach my $key (keys(%roleshash)) {
8336: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
8337: my $group = $1;
8338: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
8339: my $start = $2;
8340: my $end = $1;
8341: if ($start == -1) { next; } # deleted from group
8342: if (($start!=0) && ($start>$now)) { next; }
8343: if (($end!=0) && ($end<$now)) {
8344: if ($access_end && $access_end < $now) {
8345: if ($access_end - $end < 86400) {
8346: push(@usersgroups,$group);
1.733 raeburn 8347: }
8348: }
1.817 raeburn 8349: next;
1.733 raeburn 8350: }
1.817 raeburn 8351: push(@usersgroups,$group);
1.683 raeburn 8352: }
8353: }
8354: }
1.817 raeburn 8355: @usersgroups = &sort_course_groups($courseid,@usersgroups);
8356: $grouplist = join(':',@usersgroups);
8357: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 8358: }
1.733 raeburn 8359: return @usersgroups;
1.683 raeburn 8360: }
8361:
8362: sub devalidate_getgroups_cache {
8363: my ($udom,$uname,$cdom,$cnum)=@_;
8364: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 8365:
1.683 raeburn 8366: my $hashid="$udom:$uname:$courseid";
8367: &devalidate_cache_new('getgroups',$hashid);
8368: }
8369:
1.12 www 8370: # ------------------------------------------------------------------ Plain Text
8371:
8372: sub plaintext {
1.988 raeburn 8373: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 8374: if ($short =~ m{^cr/}) {
1.758 albertel 8375: return (split('/',$short))[-1];
8376: }
1.742 raeburn 8377: if (!defined($cid)) {
8378: $cid = $env{'request.course.id'};
8379: }
8380: my %rolenames = (
1.1008 raeburn 8381: Course => 'std',
8382: Community => 'alt1',
1.742 raeburn 8383: );
1.1037 raeburn 8384: if ($cid ne '') {
8385: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
8386: unless ($forcedefault) {
8387: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
8388: &Apache::lonlocal::mt_escape(\$roletext);
8389: return &Apache::lonlocal::mt($roletext);
8390: }
8391: }
8392: }
8393: if ((defined($type)) && (defined($rolenames{$type})) &&
8394: (defined($rolenames{$type})) &&
8395: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 8396: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 8397: } elsif ($cid ne '') {
8398: my $crstype = $env{'course.'.$cid.'.type'};
8399: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
8400: (defined($prp{$short}{$rolenames{$crstype}}))) {
8401: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
8402: }
1.742 raeburn 8403: }
1.1037 raeburn 8404: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 8405: }
8406:
8407: # ----------------------------------------------------------------- Assign Role
8408:
8409: sub assignrole {
1.957 raeburn 8410: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
8411: $context)=@_;
1.21 www 8412: my $mrole;
8413: if ($role =~ /^cr\//) {
1.393 www 8414: my $cwosec=$url;
1.811 albertel 8415: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 8416: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 8417: my $refused = 1;
8418: if ($context eq 'requestcourses') {
8419: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8420: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8421: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8422: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8423: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8424: if ($crsenv{'internal.courseowner'} eq
8425: $env{'user.name'}.':'.$env{'user.domain'}) {
8426: $refused = '';
8427: }
8428: }
8429: }
8430: }
8431: }
8432: if ($refused) {
8433: &logthis('Refused custom assignrole: '.
8434: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8435: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8436: return 'refused';
8437: }
1.104 www 8438: }
1.21 www 8439: $mrole='cr';
1.678 raeburn 8440: } elsif ($role =~ /^gr\//) {
8441: my $cwogrp=$url;
1.811 albertel 8442: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 8443: unless (&allowed('mdg',$cwogrp)) {
8444: &logthis('Refused group assignrole: '.
8445: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8446: $env{'user.name'}.' at '.$env{'user.domain'});
8447: return 'refused';
8448: }
8449: $mrole='gr';
1.21 www 8450: } else {
1.82 www 8451: my $cwosec=$url;
1.811 albertel 8452: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 8453: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8454: my $refused;
8455: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8456: if (!(&allowed('c'.$role,$url))) {
8457: $refused = 1;
8458: }
8459: } else {
8460: $refused = 1;
8461: }
1.947 raeburn 8462: if ($refused) {
1.1045 raeburn 8463: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8464: if (!$selfenroll && $context eq 'course') {
8465: my %crsenv;
8466: if ($role eq 'cc' || $role eq 'co') {
8467: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8468: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8469: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8470: if ($crsenv{'internal.courseowner'} eq
8471: $env{'user.name'}.':'.$env{'user.domain'}) {
8472: $refused = '';
8473: }
8474: }
8475: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8476: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8477: if ($crsenv{'internal.courseowner'} eq
8478: $env{'user.name'}.':'.$env{'user.domain'}) {
8479: $refused = '';
8480: }
8481: }
8482: }
8483: }
8484: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 8485: $refused = '';
1.1017 raeburn 8486: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 8487: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 8488: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 8489: my $wrongcc;
8490: if ($cnum =~ /^$match_community$/) {
8491: $wrongcc = 1 if ($role eq 'cc');
8492: } else {
8493: $wrongcc = 1 if ($role eq 'co');
8494: }
8495: unless ($wrongcc) {
8496: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8497: if ($crsenv{'internal.courseowner'} eq
8498: $env{'user.name'}.':'.$env{'user.domain'}) {
8499: $refused = '';
8500: }
1.1017 raeburn 8501: }
8502: }
1.1183 raeburn 8503: } elsif ($context eq 'requestauthor') {
8504: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8505: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8506: if ($env{'environment.requestauthor'} eq 'automatic') {
8507: $refused = '';
8508: } else {
8509: my %domdefaults = &get_domain_defaults($udom);
8510: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8511: my $checkbystatus;
8512: if ($env{'user.adv'}) {
8513: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8514: if ($disposition eq 'automatic') {
8515: $refused = '';
8516: } elsif ($disposition eq '') {
8517: $checkbystatus = 1;
8518: }
8519: } else {
8520: $checkbystatus = 1;
8521: }
8522: if ($checkbystatus) {
8523: if ($env{'environment.inststatus'}) {
8524: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8525: foreach my $type (@inststatuses) {
8526: if (($type ne '') &&
8527: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8528: $refused = '';
8529: }
8530: }
8531: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8532: $refused = '';
8533: }
8534: }
8535: }
8536: }
8537: }
1.1017 raeburn 8538: }
8539: if ($refused) {
1.947 raeburn 8540: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8541: ' '.$role.' '.$end.' '.$start.' by '.
8542: $env{'user.name'}.' at '.$env{'user.domain'});
8543: return 'refused';
8544: }
1.932 raeburn 8545: }
1.1131 raeburn 8546: } elsif ($role eq 'au') {
8547: if ($url ne '/'.$udom.'/') {
8548: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8549: ' to assign author role for '.$uname.':'.$udom.
8550: ' in domain: '.$url.' refused (wrong domain).');
8551: return 'refused';
8552: }
1.104 www 8553: }
1.21 www 8554: $mrole=$role;
8555: }
1.620 albertel 8556: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 8557: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 8558: if ($end) { $command.='_'.$end; }
1.21 www 8559: if ($start) {
8560: if ($end) {
1.81 www 8561: $command.='_'.$start;
1.21 www 8562: } else {
1.81 www 8563: $command.='_0_'.$start;
1.21 www 8564: }
8565: }
1.739 raeburn 8566: my $origstart = $start;
8567: my $origend = $end;
1.957 raeburn 8568: my $delflag;
1.357 www 8569: # actually delete
8570: if ($deleteflag) {
1.373 www 8571: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 8572: # modify command to delete the role
1.620 albertel 8573: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 8574: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 8575: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 8576: # set start and finish to negative values for userrolelog
8577: $start=-1;
8578: $end=-1;
1.957 raeburn 8579: $delflag = 1;
1.357 www 8580: }
8581: }
8582: # send command
1.349 www 8583: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 8584: # log new user role if status is ok
1.349 www 8585: if ($answer eq 'ok') {
1.663 raeburn 8586: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 8587: if (($role eq 'cc') || ($role eq 'in') ||
8588: ($role eq 'ep') || ($role eq 'ad') ||
8589: ($role eq 'ta') || ($role eq 'st') ||
8590: ($role=~/^cr/) || ($role eq 'gr') ||
8591: ($role eq 'co')) {
1.1200 raeburn 8592: # for course roles, perform group memberships changes triggered by role change.
8593: unless ($role =~ /^gr/) {
8594: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
8595: $origstart,$selfenroll,$context);
8596: }
1.1184 raeburn 8597: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8598: $selfenroll,$context);
8599: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
8600: ($role eq 'au') || ($role eq 'dc')) {
8601: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8602: $context);
8603: } elsif (($role eq 'ca') || ($role eq 'aa')) {
8604: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8605: $context);
8606: }
1.1053 raeburn 8607: if ($role eq 'cc') {
8608: &autoupdate_coowners($url,$end,$start,$uname,$udom);
8609: }
1.349 www 8610: }
8611: return $answer;
1.169 harris41 8612: }
8613:
1.1053 raeburn 8614: sub autoupdate_coowners {
8615: my ($url,$end,$start,$uname,$udom) = @_;
8616: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
8617: if (($cdom ne '') && ($cnum ne '')) {
8618: my $now = time;
8619: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
8620: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
8621: my %coursehash = &coursedescription($cdom.'_'.$cnum);
8622: my $instcode = $coursehash{'internal.coursecode'};
8623: if ($instcode ne '') {
1.1056 raeburn 8624: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
8625: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 8626: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 8627: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
8628: if ($result eq 'valid') {
8629: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 8630: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8631: push(@newcoowners,$coowner);
8632: }
8633: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
8634: push(@newcoowners,$uname.':'.$udom);
8635: }
8636: @newcoowners = sort(@newcoowners);
8637: } else {
8638: push(@newcoowners,$uname.':'.$udom);
8639: }
8640: } else {
8641: if ($coursehash{'internal.co-owners'}) {
8642: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8643: unless ($coowner eq $uname.':'.$udom) {
8644: push(@newcoowners,$coowner);
8645: }
8646: }
8647: unless (@newcoowners > 0) {
8648: $delcoowners = 1;
8649: $coowners = '';
8650: }
8651: }
8652: }
8653: if (@newcoowners || $delcoowners) {
8654: &store_coowners($cdom,$cnum,$coursehash{'home'},
8655: $delcoowners,@newcoowners);
8656: }
8657: }
8658: }
8659: }
8660: }
8661: }
8662: }
8663:
8664: sub store_coowners {
8665: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
8666: my $cid = $cdom.'_'.$cnum;
8667: my ($coowners,$delresult,$putresult);
8668: if (@newcoowners) {
8669: $coowners = join(',',@newcoowners);
8670: my %coownershash = (
8671: 'internal.co-owners' => $coowners,
8672: );
8673: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
8674: if ($putresult eq 'ok') {
8675: if ($env{'course.'.$cid.'.num'} eq $cnum) {
8676: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
8677: }
8678: }
8679: }
8680: if ($delcoowners) {
8681: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
8682: if ($delresult eq 'ok') {
8683: if ($env{'course.'.$cid.'.internal.co-owners'}) {
8684: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
8685: }
8686: }
8687: }
8688: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
8689: my %crsinfo =
8690: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
8691: if (ref($crsinfo{$cid}) eq 'HASH') {
8692: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
8693: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
8694: }
8695: }
8696: }
8697:
1.169 harris41 8698: # -------------------------------------------------- Modify user authentication
1.197 www 8699: # Overrides without validation
8700:
1.169 harris41 8701: sub modifyuserauth {
8702: my ($udom,$uname,$umode,$upass)=@_;
8703: my $uhome=&homeserver($uname,$udom);
1.197 www 8704: unless (&allowed('mau',$udom)) { return 'refused'; }
8705: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 8706: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8707: ' in domain '.$env{'request.role.domain'});
1.169 harris41 8708: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
8709: &escape($upass),$uhome);
1.620 albertel 8710: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 8711: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
8712: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8713: &log($udom,,$uname,$uhome,
1.620 albertel 8714: 'Authentication changed by '.$env{'user.domain'}.', '.
8715: $env{'user.name'}.', '.$umode.
1.197 www 8716: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 8717: unless ($reply eq 'ok') {
1.197 www 8718: &logthis('Authentication mode error: '.$reply);
1.169 harris41 8719: return 'error: '.$reply;
8720: }
1.170 harris41 8721: return 'ok';
1.80 www 8722: }
8723:
1.81 www 8724: # --------------------------------------------------------------- Modify a user
1.80 www 8725:
1.81 www 8726: sub modifyuser {
1.206 matthew 8727: my ($udom, $uname, $uid,
8728: $umode, $upass, $first,
8729: $middle, $last, $gene,
1.1058 raeburn 8730: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 8731: $udom= &LONCAPA::clean_domain($udom);
8732: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 8733: my $showcandelete = 'none';
8734: if (ref($candelete) eq 'ARRAY') {
8735: if (@{$candelete} > 0) {
8736: $showcandelete = join(', ',@{$candelete});
8737: }
8738: }
1.81 www 8739: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 8740: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 8741: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 8742: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
8743: ' desiredhome not specified').
1.620 albertel 8744: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8745: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 8746: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 8747: my $newuser;
8748: if ($uhome eq 'no_host') {
8749: $newuser = 1;
8750: }
1.80 www 8751: # ----------------------------------------------------------------- Create User
1.406 albertel 8752: if (($uhome eq 'no_host') &&
8753: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 8754: my $unhome='';
1.844 albertel 8755: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 8756: $unhome = $desiredhome;
1.620 albertel 8757: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
8758: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 8759: } else { # load balancing routine for determining $unhome
1.81 www 8760: my $loadm=10000000;
1.841 albertel 8761: my %servers = &get_servers($udom,'library');
8762: foreach my $tryserver (keys(%servers)) {
8763: my $answer=reply('load',$tryserver);
8764: if (($answer=~/\d+/) && ($answer<$loadm)) {
8765: $loadm=$answer;
8766: $unhome=$tryserver;
8767: }
1.80 www 8768: }
8769: }
8770: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 8771: return 'error: unable to find a home server for '.$uname.
8772: ' in domain '.$udom;
1.80 www 8773: }
8774: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
8775: &escape($upass),$unhome);
8776: unless ($reply eq 'ok') {
8777: return 'error: '.$reply;
8778: }
1.230 stredwic 8779: $uhome=&homeserver($uname,$udom,'true');
1.80 www 8780: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 8781: return 'error: unable verify users home machine.';
1.80 www 8782: }
1.209 matthew 8783: } # End of creation of new user
1.80 www 8784: # ---------------------------------------------------------------------- Add ID
8785: if ($uid) {
8786: $uid=~tr/A-Z/a-z/;
8787: my %uidhash=&idrget($udom,$uname);
1.196 www 8788: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
8789: && (!$forceid)) {
1.80 www 8790: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 8791: return 'error: user id "'.$uid.'" does not match '.
8792: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 8793: }
8794: } else {
8795: &idput($udom,($uname => $uid));
8796: }
8797: }
8798: # -------------------------------------------------------------- Add names, etc
1.313 matthew 8799: my @tmp=&get('environment',
1.899 raeburn 8800: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 8801: 'permanentemail','inststatus'],
1.134 albertel 8802: $udom,$uname);
1.1075 raeburn 8803: my (%names,%oldnames);
1.313 matthew 8804: if ($tmp[0] =~ m/^error:.*/) {
8805: %names=();
8806: } else {
8807: %names = @tmp;
1.1075 raeburn 8808: %oldnames = %names;
1.313 matthew 8809: }
1.388 www 8810: #
1.1058 raeburn 8811: # If name, email and/or uid are blank (e.g., because an uploaded file
8812: # of users did not contain them), do not overwrite existing values
8813: # unless field is in $candelete array ref.
8814: #
8815:
8816: my @fields = ('firstname','middlename','lastname','generation',
8817: 'permanentemail','id');
8818: my %newvalues;
8819: if (ref($candelete) eq 'ARRAY') {
8820: foreach my $field (@fields) {
8821: if (grep(/^\Q$field\E$/,@{$candelete})) {
8822: if ($field eq 'firstname') {
8823: $names{$field} = $first;
8824: } elsif ($field eq 'middlename') {
8825: $names{$field} = $middle;
8826: } elsif ($field eq 'lastname') {
8827: $names{$field} = $last;
8828: } elsif ($field eq 'generation') {
8829: $names{$field} = $gene;
8830: } elsif ($field eq 'permanentemail') {
8831: $names{$field} = $email;
8832: } elsif ($field eq 'id') {
8833: $names{$field} = $uid;
8834: }
8835: }
8836: }
8837: }
1.388 www 8838: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 8839: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 8840: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 8841: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 8842: if ($email) {
8843: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 8844: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 8845: }
1.899 raeburn 8846: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 8847: if (defined($inststatus)) {
8848: $names{'inststatus'} = '';
8849: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
8850: if (ref($usertypes) eq 'HASH') {
8851: my @okstatuses;
8852: foreach my $item (split(/:/,$inststatus)) {
8853: if (defined($usertypes->{$item})) {
8854: push(@okstatuses,$item);
8855: }
8856: }
8857: if (@okstatuses) {
8858: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
8859: }
8860: }
8861: }
1.1075 raeburn 8862: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 8863: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 8864: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 8865: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
8866: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
8867: } else {
8868: $logmsg .= ' during self creation';
8869: }
1.1075 raeburn 8870: my $changed;
8871: if ($newuser) {
8872: $changed = 1;
8873: } else {
8874: foreach my $field (@fields) {
8875: if ($names{$field} ne $oldnames{$field}) {
8876: $changed = 1;
8877: last;
8878: }
8879: }
8880: }
8881: unless ($changed) {
8882: $logmsg = 'No changes in user information needed for: '.$logmsg;
8883: &logthis($logmsg);
8884: return 'ok';
8885: }
8886: my $reply = &put('environment', \%names, $udom,$uname);
8887: if ($reply ne 'ok') {
8888: return 'error: '.$reply;
8889: }
1.1087 raeburn 8890: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
8891: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
8892: }
1.1075 raeburn 8893: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
8894: &devalidate_cache_new('namescache',$uname.':'.$udom);
8895: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 8896: &logthis($logmsg);
1.134 albertel 8897: return 'ok';
1.80 www 8898: }
8899:
1.81 www 8900: # -------------------------------------------------------------- Modify student
1.80 www 8901:
1.81 www 8902: sub modifystudent {
8903: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 8904: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1216 raeburn 8905: $selfenroll,$context,$inststatus,$credits)=@_;
1.455 albertel 8906: if (!$cid) {
1.620 albertel 8907: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 8908: return 'not_in_class';
8909: }
1.80 www 8910: }
8911: # --------------------------------------------------------------- Make the user
1.81 www 8912: my $reply=&modifyuser
1.209 matthew 8913: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 8914: $desiredhome,$email,$inststatus);
1.80 www 8915: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 8916: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 8917: # student's environment
1.297 matthew 8918: $uid = undef if (!$forceid);
1.455 albertel 8919: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 8920: $gene,$usec,$end,$start,$type,$locktype,
8921: $cid,$selfenroll,$context,$credits);
1.297 matthew 8922: return $reply;
8923: }
8924:
8925: sub modify_student_enrollment {
1.1216 raeburn 8926: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
8927: $locktype,$cid,$selfenroll,$context,$credits) = @_;
1.455 albertel 8928: my ($cdom,$cnum,$chome);
8929: if (!$cid) {
1.620 albertel 8930: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 8931: return 'not_in_class';
8932: }
1.620 albertel 8933: $cdom=$env{'course.'.$cid.'.domain'};
8934: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 8935: } else {
8936: ($cdom,$cnum)=split(/_/,$cid);
8937: }
1.620 albertel 8938: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 8939: if (!$chome) {
1.457 raeburn 8940: $chome=&homeserver($cnum,$cdom);
1.297 matthew 8941: }
1.455 albertel 8942: if (!$chome) { return 'unknown_course'; }
1.297 matthew 8943: # Make sure the user exists
1.81 www 8944: my $uhome=&homeserver($uname,$udom);
8945: if (($uhome eq '') || ($uhome eq 'no_host')) {
8946: return 'error: no such user';
8947: }
1.297 matthew 8948: # Get student data if we were not given enough information
8949: if (!defined($first) || $first eq '' ||
8950: !defined($last) || $last eq '' ||
8951: !defined($uid) || $uid eq '' ||
8952: !defined($middle) || $middle eq '' ||
8953: !defined($gene) || $gene eq '') {
1.294 matthew 8954: # They did not supply us with enough data to enroll the student, so
8955: # we need to pick up more information.
1.297 matthew 8956: my %tmp = &get('environment',
1.294 matthew 8957: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 8958: ,$udom,$uname);
8959:
1.800 albertel 8960: #foreach my $key (keys(%tmp)) {
8961: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 8962: #}
1.294 matthew 8963: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
8964: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
8965: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 8966: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 8967: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
8968: }
1.556 albertel 8969: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 8970: my $user = "$uname:$udom";
8971: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 8972: my $reply=cput('classlist',
1.1148 raeburn 8973: {$user =>
1.1216 raeburn 8974: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits) },
1.487 albertel 8975: $cdom,$cnum);
1.1148 raeburn 8976: if (($reply eq 'ok') || ($reply eq 'delayed')) {
8977: &devalidate_getsection_cache($udom,$uname,$cid);
8978: } else {
1.81 www 8979: return 'error: '.$reply;
8980: }
1.297 matthew 8981: # Add student role to user
1.83 www 8982: my $uurl='/'.$cid;
1.81 www 8983: $uurl=~s/\_/\//g;
8984: if ($usec) {
8985: $uurl.='/'.$usec;
8986: }
1.1148 raeburn 8987: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
8988: $selfenroll,$context);
8989: if ($result ne 'ok') {
8990: if ($old_entry{$user} ne '') {
8991: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
8992: } else {
8993: $reply = &del('classlist',[$user],$cdom,$cnum);
8994: }
8995: }
8996: return $result;
1.21 www 8997: }
8998:
1.556 albertel 8999: sub format_name {
9000: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
9001: my $name;
9002: if ($first ne 'lastname') {
9003: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
9004: } else {
9005: if ($lastname=~/\S/) {
9006: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
9007: $name=~s/\s+,/,/;
9008: } else {
9009: $name.= $firstname.' '.$middlename.' '.$generation;
9010: }
9011: }
9012: $name=~s/^\s+//;
9013: $name=~s/\s+$//;
9014: $name=~s/\s+/ /g;
9015: return $name;
9016: }
9017:
1.84 www 9018: # ------------------------------------------------- Write to course preferences
9019:
9020: sub writecoursepref {
9021: my ($courseid,%prefs)=@_;
9022: $courseid=~s/^\///;
9023: $courseid=~s/\_/\//g;
9024: my ($cdomain,$cnum)=split(/\//,$courseid);
9025: my $chome=homeserver($cnum,$cdomain);
9026: if (($chome eq '') || ($chome eq 'no_host')) {
9027: return 'error: no such course';
9028: }
9029: my $cstring='';
1.800 albertel 9030: foreach my $pref (keys(%prefs)) {
9031: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 9032: }
1.84 www 9033: $cstring=~s/\&$//;
9034: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
9035: }
9036:
9037: # ---------------------------------------------------------- Make/modify course
9038:
9039: sub createcourse {
1.741 raeburn 9040: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 9041: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 9042: $url=&declutter($url);
9043: my $cid='';
1.1028 raeburn 9044: if ($context eq 'requestcourses') {
9045: my $can_create = 0;
9046: my ($ownername,$ownerdom) = split(':',$course_owner);
9047: if ($udom eq $ownerdom) {
9048: if (&usertools_access($ownername,$ownerdom,$category,undef,
9049: $context)) {
9050: $can_create = 1;
9051: }
9052: } else {
9053: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
9054: $category);
9055: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
9056: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
9057: if (@curr > 0) {
9058: my @options = qw(approval validate autolimit);
9059: my $optregex = join('|',@options);
9060: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
9061: $can_create = 1;
9062: }
9063: }
9064: }
9065: }
9066: if ($can_create) {
9067: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
9068: unless (&allowed('ccc',$udom)) {
9069: return 'refused';
9070: }
1.1017 raeburn 9071: }
9072: } else {
9073: return 'refused';
9074: }
1.1028 raeburn 9075: } elsif (!&allowed('ccc',$udom)) {
9076: return 'refused';
1.84 www 9077: }
1.1011 raeburn 9078: # --------------------------------------------------------------- Get Unique ID
9079: my $uname;
9080: if ($cnum =~ /^$match_courseid$/) {
9081: my $chome=&homeserver($cnum,$udom,'true');
9082: if (($chome eq '') || ($chome eq 'no_host')) {
9083: $uname = $cnum;
9084: } else {
1.1038 raeburn 9085: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9086: }
9087: } else {
1.1038 raeburn 9088: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 9089: }
9090: return $uname if ($uname =~ /^error/);
9091: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 9092: if (!defined($course_server)) {
9093: if (defined(&domain($udom,'primary'))) {
9094: $course_server = &domain($udom,'primary');
9095: } else {
9096: $course_server = $env{'user.home'};
9097: }
9098: }
9099: my %host_servers =
9100: &Apache::lonnet::get_servers($udom,'library');
9101: unless ($host_servers{$course_server}) {
9102: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 9103: }
1.84 www 9104: # ------------------------------------------------------------- Make the course
9105: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 9106: $course_server);
1.84 www 9107: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 9108: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 9109: if (($uhome eq '') || ($uhome eq 'no_host')) {
9110: return 'error: no such course';
9111: }
1.271 www 9112: # ----------------------------------------------------------------- Course made
1.516 raeburn 9113: # log existence
1.1029 raeburn 9114: my $now = time;
1.918 raeburn 9115: my $newcourse = {
9116: $udom.'_'.$uname => {
1.921 raeburn 9117: description => $description,
9118: inst_code => $inst_code,
9119: owner => $course_owner,
9120: type => $crstype,
1.1029 raeburn 9121: creator => $env{'user.name'}.':'.
9122: $env{'user.domain'},
9123: created => $now,
9124: context => $context,
1.918 raeburn 9125: },
9126: };
1.921 raeburn 9127: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 9128: # set toplevel url
1.271 www 9129: my $topurl=$url;
9130: unless ($nonstandard) {
9131: # ------------------------------------------ For standard courses, make top url
9132: my $mapurl=&clutter($url);
1.278 www 9133: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 9134: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 9135: <map>
9136: <resource id="1" type="start"></resource>
9137: <resource id="2" src="$mapurl"></resource>
9138: <resource id="3" type="finish"></resource>
9139: <link index="1" from="1" to="2"></link>
9140: <link index="2" from="2" to="3"></link>
9141: </map>
9142: ENDINITMAP
9143: $topurl=&declutter(
1.638 albertel 9144: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 9145: );
9146: }
9147: # ----------------------------------------------------------- Write preferences
1.84 www 9148: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 9149: ('description' => $description,
9150: 'url' => $topurl,
9151: 'internal.creator' => $env{'user.name'}.':'.
9152: $env{'user.domain'},
9153: 'internal.created' => $now,
9154: 'internal.creationcontext' => $context)
9155: );
1.84 www 9156: return '/'.$udom.'/'.$uname;
9157: }
9158:
1.1011 raeburn 9159: # ------------------------------------------------------------------- Create ID
9160: sub generate_coursenum {
1.1038 raeburn 9161: my ($udom,$crstype) = @_;
1.1011 raeburn 9162: my $domdesc = &domain($udom);
9163: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 9164: my $first;
9165: if ($crstype eq 'Community') {
9166: $first = '0';
9167: } else {
9168: $first = int(1+rand(9));
9169: }
9170: my $uname=$first.
1.1011 raeburn 9171: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9172: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9173: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9174: # ----------------------------------------------- Make sure that does not exist
9175: my $uhome=&homeserver($uname,$udom,'true');
9176: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 9177: if ($crstype eq 'Community') {
9178: $first = '0';
9179: } else {
9180: $first = int(1+rand(9));
9181: }
9182: $uname=$first.
1.1011 raeburn 9183: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
9184: substr($$.time,0,5).unpack("H8",pack("I32",time)).
9185: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
9186: $uhome=&homeserver($uname,$udom,'true');
9187: unless (($uhome eq '') || ($uhome eq 'no_host')) {
9188: return 'error: unable to generate unique course-ID';
9189: }
9190: }
9191: return $uname;
9192: }
9193:
1.813 albertel 9194: sub is_course {
1.1167 droeschl 9195: my ($cdom, $cnum) = scalar(@_) == 1 ?
9196: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
9197:
9198: return unless $cdom and $cnum;
9199:
9200: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
9201: '.');
9202:
1.1219 raeburn 9203: return unless(exists($courses{$cdom.'_'.$cnum}));
1.1167 droeschl 9204: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 9205: }
9206:
1.1015 raeburn 9207: sub store_userdata {
9208: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 9209: my $result;
1.1016 raeburn 9210: if ($datakey ne '') {
1.1013 raeburn 9211: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 9212: if ($udom eq '' || $uname eq '') {
9213: $udom = $env{'user.domain'};
9214: $uname = $env{'user.name'};
9215: }
9216: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 9217: if (($uhome eq '') || ($uhome eq 'no_host')) {
9218: $result = 'error: no_host';
9219: } else {
9220: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
9221: $storehash->{'host'} = $perlvar{'lonHostID'};
9222:
9223: my $namevalue='';
9224: foreach my $key (keys(%{$storehash})) {
9225: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
9226: }
9227: $namevalue=~s/\&$//;
1.1224 raeburn 9228: unless ($namespace eq 'courserequests') {
9229: $datakey = &escape($datakey);
9230: }
1.1105 raeburn 9231: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
9232: $namevalue,$uhome);
1.1013 raeburn 9233: }
9234: } else {
9235: $result = 'error: data to store was not a hash reference';
9236: }
9237: } else {
9238: $result= 'error: invalid requestkey';
9239: }
9240: return $result;
9241: }
9242:
1.21 www 9243: # ---------------------------------------------------------- Assign Custom Role
9244:
9245: sub assigncustomrole {
1.957 raeburn 9246: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9247: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 9248: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 9249: }
9250:
9251: # ----------------------------------------------------------------- Revoke Role
9252:
9253: sub revokerole {
1.957 raeburn 9254: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9255: my $now=time;
1.965 raeburn 9256: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 9257: }
9258:
9259: # ---------------------------------------------------------- Revoke Custom Role
9260:
9261: sub revokecustomrole {
1.957 raeburn 9262: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 9263: my $now=time;
1.357 www 9264: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 9265: $deleteflag,$selfenroll,$context);
1.17 www 9266: }
9267:
1.533 banghart 9268: # ------------------------------------------------------------ Disk usage
1.535 albertel 9269: sub diskusage {
1.955 raeburn 9270: my ($udom,$uname,$directorypath,$getpropath)=@_;
9271: $directorypath =~ s/\/$//;
9272: my $listing=&reply('du2:'.&escape($directorypath).':'
9273: .&escape($getpropath).':'.&escape($uname).':'
9274: .&escape($udom),homeserver($uname,$udom));
9275: if ($listing eq 'unknown_cmd') {
9276: if ($getpropath) {
9277: $directorypath = &propath($udom,$uname).'/'.$directorypath;
9278: }
9279: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
9280: }
1.514 albertel 9281: return $listing;
1.512 banghart 9282: }
9283:
1.566 banghart 9284: sub is_locked {
1.1096 raeburn 9285: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 9286: my @check;
9287: my $is_locked;
1.1093 raeburn 9288: push (@check,$file_name);
1.613 albertel 9289: my %locked = &get('file_permissions',\@check,
1.620 albertel 9290: $env{'user.domain'},$env{'user.name'});
1.615 albertel 9291: my ($tmp)=keys(%locked);
9292: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 9293:
1.566 banghart 9294: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 9295: $is_locked = 'false';
9296: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 9297: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 9298: $is_locked = 'true';
1.1096 raeburn 9299: if (ref($which) eq 'ARRAY') {
9300: push(@{$which},$entry);
9301: } else {
9302: last;
9303: }
1.745 raeburn 9304: }
9305: }
1.566 banghart 9306: } else {
9307: $is_locked = 'false';
9308: }
1.1093 raeburn 9309: return $is_locked;
1.566 banghart 9310: }
9311:
1.759 albertel 9312: sub declutter_portfile {
9313: my ($file) = @_;
1.833 albertel 9314: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 9315: return $file;
9316: }
9317:
1.559 banghart 9318: # ------------------------------------------------------------- Mark as Read Only
9319:
9320: sub mark_as_readonly {
9321: my ($domain,$user,$files,$what) = @_;
1.613 albertel 9322: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 9323: my ($tmp)=keys(%current_permissions);
9324: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 9325: foreach my $file (@{$files}) {
1.759 albertel 9326: $file = &declutter_portfile($file);
1.561 banghart 9327: push(@{$current_permissions{$file}},$what);
1.559 banghart 9328: }
1.613 albertel 9329: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 9330: return;
9331: }
9332:
1.572 banghart 9333: # ------------------------------------------------------------Save Selected Files
9334:
9335: sub save_selected_files {
9336: my ($user, $path, @files) = @_;
9337: my $filename = $user."savedfiles";
1.573 banghart 9338: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 9339: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 9340: foreach my $file (@files) {
1.620 albertel 9341: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 9342: }
9343: foreach my $file (@other_files) {
1.574 banghart 9344: print (OUT $file."\n");
1.572 banghart 9345: }
1.574 banghart 9346: close (OUT);
1.572 banghart 9347: return 'ok';
9348: }
9349:
1.574 banghart 9350: sub clear_selected_files {
9351: my ($user) = @_;
9352: my $filename = $user."savedfiles";
1.1117 foxr 9353: open (OUT, '>'.LONCAPA::tempdir().$filename);
1.574 banghart 9354: print (OUT undef);
9355: close (OUT);
9356: return ("ok");
9357: }
9358:
1.572 banghart 9359: sub files_in_path {
9360: my ($user, $path) = @_;
9361: my $filename = $user."savedfiles";
9362: my %return_files;
1.1117 foxr 9363: open (IN, '<'.LONCAPA::tempdir().$filename);
1.573 banghart 9364: while (my $line_in = <IN>) {
1.574 banghart 9365: chomp ($line_in);
9366: my @paths_and_file = split (m!/!, $line_in);
9367: my $file_part = pop (@paths_and_file);
9368: my $path_part = join ('/', @paths_and_file);
1.573 banghart 9369: $path_part.='/';
9370: my $path_and_file = $path_part.$file_part;
9371: if ($path_part eq $path) {
9372: $return_files{$file_part}= 'selected';
9373: }
9374: }
1.574 banghart 9375: close (IN);
9376: return (\%return_files);
1.572 banghart 9377: }
9378:
9379: # called in portfolio select mode, to show files selected NOT in current directory
9380: sub files_not_in_path {
9381: my ($user, $path) = @_;
9382: my $filename = $user."savedfiles";
9383: my @return_files;
9384: my $path_part;
1.1117 foxr 9385: open(IN, '<'.LONCAPA::.$filename);
1.800 albertel 9386: while (my $line = <IN>) {
1.572 banghart 9387: #ok, I know it's clunky, but I want it to work
1.800 albertel 9388: my @paths_and_file = split(m|/|, $line);
9389: my $file_part = pop(@paths_and_file);
9390: chomp($file_part);
9391: my $path_part = join('/', @paths_and_file);
1.572 banghart 9392: $path_part .= '/';
9393: my $path_and_file = $path_part.$file_part;
9394: if ($path_part ne $path) {
1.800 albertel 9395: push(@return_files, ($path_and_file));
1.572 banghart 9396: }
9397: }
1.800 albertel 9398: close(OUT);
1.574 banghart 9399: return (@return_files);
1.572 banghart 9400: }
9401:
1.1273 raeburn 9402: #------------------------------Submitted/Handedback Portfolio Files Versioning
9403:
9404: sub portfiles_versioning {
9405: my ($symb,$domain,$stu_name,$portfiles,$versioned_portfiles) = @_;
9406: my $portfolio_root = '/userfiles/portfolio';
9407: return unless ((ref($portfiles) eq 'ARRAY') && (ref($versioned_portfiles) eq 'ARRAY'));
9408: foreach my $file (@{$portfiles}) {
9409: &unmark_as_readonly($domain,$stu_name,[$symb,$env{'request.course.id'}],$file);
9410: my ($directory,$answer_file) =($file =~ /^(.*?)([^\/]*)$/);
9411: my ($answer_name,$answer_ver,$answer_ext) = &file_name_version_ext($answer_file);
9412: my $getpropath = 1;
9413: my ($dir_list,$listerror) = &dirlist($portfolio_root.$directory,$domain,
9414: $stu_name,$getpropath);
9415: my $version = &get_next_version($answer_name,$answer_ext,$dir_list);
9416: my $new_answer =
9417: &version_selected_portfile($domain,$stu_name,$directory,$answer_file,$version);
9418: if ($new_answer ne 'problem getting file') {
9419: push(@{$versioned_portfiles}, $directory.$new_answer);
9420: &mark_as_readonly($domain,$stu_name,[$directory.$new_answer],
9421: [$symb,$env{'request.course.id'},'graded']);
9422: }
9423: }
9424: }
9425:
9426: sub get_next_version {
9427: my ($answer_name, $answer_ext, $dir_list) = @_;
9428: my $version;
9429: if (ref($dir_list) eq 'ARRAY') {
9430: foreach my $row (@{$dir_list}) {
9431: my ($file) = split(/\&/,$row,2);
9432: my ($file_name,$file_version,$file_ext) =
9433: &file_name_version_ext($file);
9434: if (($file_name eq $answer_name) &&
9435: ($file_ext eq $answer_ext)) {
9436: # gets here if filename and extension match,
9437: # regardless of version
9438: if ($file_version ne '') {
9439: # a versioned file is found so save it for later
9440: if ($file_version > $version) {
9441: $version = $file_version;
9442: }
9443: }
9444: }
9445: }
9446: }
9447: $version ++;
9448: return($version);
9449: }
9450:
9451: sub version_selected_portfile {
9452: my ($domain,$stu_name,$directory,$file_name,$version) = @_;
9453: my ($answer_name,$answer_ver,$answer_ext) =
9454: &file_name_version_ext($file_name);
9455: my $new_answer;
9456: $env{'form.copy'} =
9457: &getfile("/uploaded/$domain/$stu_name/portfolio$directory$file_name");
9458: if($env{'form.copy'} eq '-1') {
9459: $new_answer = 'problem getting file';
9460: } else {
9461: $new_answer = $answer_name.'.'.$version.'.'.$answer_ext;
9462: my $copy_result =
9463: &finishuserfileupload($stu_name,$domain,'copy',
9464: '/portfolio'.$directory.$new_answer);
9465: }
9466: undef($env{'form.copy'});
9467: return ($new_answer);
9468: }
9469:
9470: sub file_name_version_ext {
9471: my ($file)=@_;
9472: my @file_parts = split(/\./, $file);
9473: my ($name,$version,$ext);
9474: if (@file_parts > 1) {
9475: $ext=pop(@file_parts);
9476: if (@file_parts > 1 && $file_parts[-1] =~ /^\d+$/) {
9477: $version=pop(@file_parts);
9478: }
9479: $name=join('.',@file_parts);
9480: } else {
9481: $name=join('.',@file_parts);
9482: }
9483: return($name,$version,$ext);
9484: }
9485:
1.745 raeburn 9486: #----------------------------------------------Get portfolio file permissions
1.629 banghart 9487:
1.745 raeburn 9488: sub get_portfile_permissions {
9489: my ($domain,$user) = @_;
1.613 albertel 9490: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 9491: my ($tmp)=keys(%current_permissions);
9492: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 9493: return \%current_permissions;
9494: }
9495:
9496: #---------------------------------------------Get portfolio file access controls
9497:
1.749 raeburn 9498: sub get_access_controls {
1.745 raeburn 9499: my ($current_permissions,$group,$file) = @_;
1.769 albertel 9500: my %access;
9501: my $real_file = $file;
9502: $file =~ s/\.meta$//;
1.745 raeburn 9503: if (defined($file)) {
1.749 raeburn 9504: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9505: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 9506: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 9507: }
9508: }
1.745 raeburn 9509: } else {
1.749 raeburn 9510: foreach my $key (keys(%{$current_permissions})) {
9511: if ($key =~ /\0accesscontrol$/) {
9512: if (defined($group)) {
9513: if ($key !~ m-^\Q$group\E/-) {
9514: next;
9515: }
9516: }
9517: my ($fullpath) = split(/\0/,$key);
9518: if (ref($$current_permissions{$key}) eq 'HASH') {
9519: foreach my $control (keys(%{$$current_permissions{$key}})) {
9520: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9521: }
9522: }
9523: }
9524: }
9525: }
9526: return %access;
9527: }
9528:
9529: sub modify_access_controls {
9530: my ($file_name,$changes,$domain,$user)=@_;
9531: my ($outcome,$deloutcome);
9532: my %store_permissions;
9533: my %new_values;
9534: my %new_control;
9535: my %translation;
9536: my @deletions = ();
9537: my $now = time;
9538: if (exists($$changes{'activate'})) {
9539: if (ref($$changes{'activate'}) eq 'HASH') {
9540: my @newitems = sort(keys(%{$$changes{'activate'}}));
9541: my $numnew = scalar(@newitems);
9542: for (my $i=0; $i<$numnew; $i++) {
9543: my $newkey = $newitems[$i];
9544: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 9545: if ($newkey =~ /^\d+:/) {
9546: $newkey =~ s/^(\d+)/$newid/;
9547: $translation{$1} = $newid;
9548: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9549: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9550: $translation{$1} = $newid;
9551: }
1.749 raeburn 9552: $new_values{$file_name."\0".$newkey} =
9553: $$changes{'activate'}{$newitems[$i]};
9554: $new_control{$newkey} = $now;
9555: }
9556: }
9557: }
9558: my %todelete;
9559: my %changed_items;
9560: foreach my $action ('delete','update') {
9561: if (exists($$changes{$action})) {
9562: if (ref($$changes{$action}) eq 'HASH') {
9563: foreach my $key (keys(%{$$changes{$action}})) {
9564: my ($itemnum) = ($key =~ /^([^:]+):/);
9565: if ($action eq 'delete') {
9566: $todelete{$itemnum} = 1;
9567: } else {
9568: $changed_items{$itemnum} = $key;
9569: }
9570: }
1.745 raeburn 9571: }
9572: }
1.749 raeburn 9573: }
9574: # get lock on access controls for file.
9575: my $lockhash = {
9576: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9577: ':'.$env{'user.domain'},
9578: };
9579: my $tries = 0;
9580: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9581:
1.1288 damieng 9582: while (($gotlock ne 'ok') && $tries < 10) {
1.749 raeburn 9583: $tries ++;
1.1289 damieng 9584: sleep(0.1);
1.749 raeburn 9585: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9586: }
9587: if ($gotlock eq 'ok') {
9588: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9589: my ($tmp)=keys(%curr_permissions);
9590: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9591: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9592: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9593: if (ref($curr_controls) eq 'HASH') {
9594: foreach my $control_item (keys(%{$curr_controls})) {
9595: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9596: if (defined($todelete{$itemnum})) {
9597: push(@deletions,$file_name."\0".$control_item);
9598: } else {
9599: if (defined($changed_items{$itemnum})) {
9600: $new_control{$changed_items{$itemnum}} = $now;
9601: push(@deletions,$file_name."\0".$control_item);
9602: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9603: } else {
9604: $new_control{$control_item} = $$curr_controls{$control_item};
9605: }
9606: }
1.745 raeburn 9607: }
9608: }
9609: }
1.970 raeburn 9610: my ($group);
9611: if (&is_course($domain,$user)) {
9612: ($group,my $file) = split(/\//,$file_name,2);
9613: }
1.749 raeburn 9614: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9615: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9616: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9617: # remove lock
9618: my @del_lock = ($file_name."\0".'locked_access_records');
9619: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 9620: my $sqlresult =
1.970 raeburn 9621: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 9622: $group);
1.749 raeburn 9623: } else {
9624: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 9625: }
1.749 raeburn 9626: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 9627: }
9628:
1.827 raeburn 9629: sub make_public_indefinitely {
1.1271 raeburn 9630: my (@requrl) = @_;
9631: return &automated_portfile_access('public',\@requrl);
9632: }
9633:
9634: sub automated_portfile_access {
9635: my ($accesstype,$addsref,$delsref,$info) = @_;
1.1273 raeburn 9636: unless (($accesstype eq 'public') || ($accesstype eq 'ip')) {
9637: return 'invalid';
9638: }
1.1271 raeburn 9639: my %urls;
9640: if (ref($addsref) eq 'ARRAY') {
9641: foreach my $requrl (@{$addsref}) {
9642: if (&is_portfolio_url($requrl)) {
9643: unless (exists($urls{$requrl})) {
9644: $urls{$requrl} = 'add';
9645: }
9646: }
9647: }
9648: }
9649: if (ref($delsref) eq 'ARRAY') {
9650: foreach my $requrl (@{$delsref}) {
9651: if (&is_portfolio_url($requrl)) {
9652: unless (exists($urls{$requrl})) {
9653: $urls{$requrl} = 'delete';
9654: }
9655: }
9656: }
9657: }
9658: unless (keys(%urls)) {
9659: return 'invalid';
9660: }
9661: my $ip;
9662: if ($accesstype eq 'ip') {
9663: if (ref($info) eq 'HASH') {
9664: if ($info->{'ip'} ne '') {
9665: $ip = $info->{'ip'};
9666: }
9667: }
9668: if ($ip eq '') {
9669: return 'invalid';
9670: }
9671: }
9672: my $errors;
1.827 raeburn 9673: my $now = time;
1.1271 raeburn 9674: my %current_perms;
9675: foreach my $requrl (sort(keys(%urls))) {
9676: my $action;
9677: if ($urls{$requrl} eq 'add') {
9678: $action = 'activate';
9679: } else {
9680: $action = 'none';
9681: }
9682: my $aclnum = 0;
1.827 raeburn 9683: my (undef,$udom,$unum,$file_name,$group) =
9684: &parse_portfolio_url($requrl);
1.1271 raeburn 9685: unless (exists($current_perms{$unum.':'.$udom})) {
9686: $current_perms{$unum.':'.$udom} = &get_portfile_permissions($udom,$unum);
9687: }
9688: my %access_controls = &get_access_controls($current_perms{$unum.':'.$udom},
1.827 raeburn 9689: $group,$file_name);
9690: foreach my $key (keys(%{$access_controls{$file_name}})) {
9691: my ($num,$scope,$end,$start) =
9692: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
1.1271 raeburn 9693: if ($scope eq $accesstype) {
9694: if (($start <= $now) && ($end == 0)) {
9695: if ($accesstype eq 'ip') {
9696: if (ref($access_controls{$file_name}{$key}) eq 'HASH') {
9697: if (ref($access_controls{$file_name}{$key}{'ip'}) eq 'ARRAY') {
9698: if (grep(/^\Q$ip\E$/,@{$access_controls{$file_name}{$key}{'ip'}})) {
9699: if ($urls{$requrl} eq 'add') {
9700: $action = 'none';
9701: last;
9702: } else {
9703: $action = 'delete';
9704: $aclnum = $num;
9705: last;
9706: }
9707: }
9708: }
9709: }
9710: } elsif ($accesstype eq 'public') {
9711: if ($urls{$requrl} eq 'add') {
9712: $action = 'none';
9713: last;
9714: } else {
9715: $action = 'delete';
9716: $aclnum = $num;
9717: last;
9718: }
9719: }
9720: } elsif ($accesstype eq 'public') {
1.827 raeburn 9721: $action = 'update';
9722: $aclnum = $num;
1.1271 raeburn 9723: last;
1.827 raeburn 9724: }
9725: }
9726: }
9727: if ($action eq 'none') {
1.1271 raeburn 9728: next;
1.827 raeburn 9729: } else {
9730: my %changes;
9731: my $newend = 0;
9732: my $newstart = $now;
1.1271 raeburn 9733: my $newkey = $aclnum.':'.$accesstype.'_'.$newend.'_'.$newstart;
1.827 raeburn 9734: $changes{$action}{$newkey} = {
1.1271 raeburn 9735: type => $accesstype,
1.827 raeburn 9736: time => {
9737: start => $newstart,
9738: end => $newend,
9739: },
9740: };
1.1271 raeburn 9741: if ($accesstype eq 'ip') {
9742: $changes{$action}{$newkey}{'ip'} = [$ip];
9743: }
1.827 raeburn 9744: my ($outcome,$deloutcome,$new_values,$translation) =
9745: &modify_access_controls($file_name,\%changes,$udom,$unum);
1.1271 raeburn 9746: unless ($outcome eq 'ok') {
9747: $errors .= $outcome.' ';
9748: }
1.827 raeburn 9749: }
1.1271 raeburn 9750: }
9751: if ($errors) {
9752: $errors =~ s/\s$//;
9753: return $errors;
1.827 raeburn 9754: } else {
1.1271 raeburn 9755: return 'ok';
1.827 raeburn 9756: }
9757: }
9758:
1.745 raeburn 9759: #------------------------------------------------------Get Marked as Read Only
9760:
9761: sub get_marked_as_readonly {
9762: my ($domain,$user,$what,$group) = @_;
9763: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 9764: my @readonly_files;
1.629 banghart 9765: my $cmp1=$what;
9766: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 9767: while (my ($file_name,$value) = each(%{$current_permissions})) {
9768: if (defined($group)) {
9769: if ($file_name !~ m-^\Q$group\E/-) {
9770: next;
9771: }
9772: }
1.561 banghart 9773: if (ref($value) eq "ARRAY"){
9774: foreach my $stored_what (@{$value}) {
1.629 banghart 9775: my $cmp2=$stored_what;
1.759 albertel 9776: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 9777: $cmp2=join('',@{$stored_what});
1.745 raeburn 9778: }
1.629 banghart 9779: if ($cmp1 eq $cmp2) {
1.561 banghart 9780: push(@readonly_files, $file_name);
1.745 raeburn 9781: last;
1.563 banghart 9782: } elsif (!defined($what)) {
9783: push(@readonly_files, $file_name);
1.745 raeburn 9784: last;
1.561 banghart 9785: }
9786: }
1.745 raeburn 9787: }
1.561 banghart 9788: }
9789: return @readonly_files;
9790: }
1.577 banghart 9791: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 9792:
1.577 banghart 9793: sub get_marked_as_readonly_hash {
1.745 raeburn 9794: my ($current_permissions,$group,$what) = @_;
1.577 banghart 9795: my %readonly_files;
1.745 raeburn 9796: while (my ($file_name,$value) = each(%{$current_permissions})) {
9797: if (defined($group)) {
9798: if ($file_name !~ m-^\Q$group\E/-) {
9799: next;
9800: }
9801: }
1.577 banghart 9802: if (ref($value) eq "ARRAY"){
9803: foreach my $stored_what (@{$value}) {
1.745 raeburn 9804: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 9805: foreach my $lock_descriptor(@{$stored_what}) {
9806: if ($lock_descriptor eq 'graded') {
9807: $readonly_files{$file_name} = 'graded';
9808: } elsif ($lock_descriptor eq 'handback') {
9809: $readonly_files{$file_name} = 'handback';
9810: } else {
9811: if (!exists($readonly_files{$file_name})) {
9812: $readonly_files{$file_name} = 'locked';
9813: }
9814: }
1.745 raeburn 9815: }
1.750 banghart 9816: }
1.577 banghart 9817: }
9818: }
9819: }
9820: return %readonly_files;
9821: }
1.559 banghart 9822: # ------------------------------------------------------------ Unmark as Read Only
9823:
9824: sub unmark_as_readonly {
1.629 banghart 9825: # unmarks $file_name (if $file_name is defined), or all files locked by $what
9826: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 9827: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 9828: $file_name = &declutter_portfile($file_name);
1.634 albertel 9829: my $symb_crs = $what;
9830: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 9831: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 9832: my ($tmp)=keys(%current_permissions);
9833: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 9834: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 9835: foreach my $file (@readonly_files) {
1.759 albertel 9836: my $clean_file = &declutter_portfile($file);
9837: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 9838: my $current_locks = $current_permissions{$file};
1.563 banghart 9839: my @new_locks;
9840: my @del_keys;
9841: if (ref($current_locks) eq "ARRAY"){
9842: foreach my $locker (@{$current_locks}) {
1.632 albertel 9843: my $compare=$locker;
1.749 raeburn 9844: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 9845: $compare=join('',@{$locker});
1.746 raeburn 9846: if ($compare ne $symb_crs) {
9847: push(@new_locks, $locker);
9848: }
1.563 banghart 9849: }
9850: }
1.650 albertel 9851: if (scalar(@new_locks) > 0) {
1.563 banghart 9852: $current_permissions{$file} = \@new_locks;
9853: } else {
9854: push(@del_keys, $file);
1.613 albertel 9855: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 9856: delete($current_permissions{$file});
1.563 banghart 9857: }
9858: }
1.561 banghart 9859: }
1.613 albertel 9860: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 9861: return;
9862: }
1.512 banghart 9863:
1.17 www 9864: # ------------------------------------------------------------ Directory lister
9865:
9866: sub dirlist {
1.955 raeburn 9867: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 9868: $uri=~s/^\///;
9869: $uri=~s/\/$//;
1.253 stredwic 9870: my ($udom, $uname);
1.955 raeburn 9871: if ($getuserdir) {
1.253 stredwic 9872: $udom = $userdomain;
9873: $uname = $username;
1.955 raeburn 9874: } else {
9875: (undef,$udom,$uname)=split(/\//,$uri);
9876: if(defined($userdomain)) {
9877: $udom = $userdomain;
9878: }
9879: if(defined($username)) {
9880: $uname = $username;
9881: }
1.253 stredwic 9882: }
1.955 raeburn 9883: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 9884:
1.955 raeburn 9885: $dirRoot = $perlvar{'lonDocRoot'};
9886: if (defined($getpropath)) {
9887: $dirRoot = &propath($udom,$uname);
1.253 stredwic 9888: $dirRoot =~ s/\/$//;
1.955 raeburn 9889: } elsif (defined($getuserdir)) {
9890: my $subdir=$uname.'__';
9891: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
9892: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
9893: ."/$udom/$subdir/$uname";
9894: } elsif (defined($alternateRoot)) {
9895: $dirRoot = $alternateRoot;
1.751 banghart 9896: }
1.253 stredwic 9897:
9898: if($udom) {
9899: if($uname) {
1.1135 raeburn 9900: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 9901: if ($uhome eq 'no_host') {
9902: return ([],'no_host');
9903: }
1.955 raeburn 9904: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 9905: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 9906: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 9907: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 9908: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 9909: } else {
9910: @listing_results = map { &unescape($_); } split(/:/,$listing);
9911: }
1.605 matthew 9912: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 9913: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 9914: @listing_results = split(/:/,$listing);
9915: } else {
9916: @listing_results = map { &unescape($_); } split(/:/,$listing);
9917: }
1.1135 raeburn 9918: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 9919: ($listing eq 'rejected') || ($listing eq 'refused') ||
9920: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9921: return ([],$listing);
9922: } else {
9923: return (\@listing_results);
1.1135 raeburn 9924: }
1.955 raeburn 9925: } elsif(!$alternateRoot) {
1.1136 raeburn 9926: my (%allusers,%listerror);
1.841 albertel 9927: my %servers = &get_servers($udom,'library');
1.955 raeburn 9928: foreach my $tryserver (keys(%servers)) {
9929: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
9930: &escape($udom),$tryserver);
9931: if ($listing eq 'unknown_cmd') {
9932: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
9933: $udom, $tryserver);
9934: } else {
9935: @listing_results = map { &unescape($_); } split(/:/,$listing);
9936: }
1.841 albertel 9937: if ($listing eq 'unknown_cmd') {
9938: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
9939: $udom, $tryserver);
9940: @listing_results = split(/:/,$listing);
9941: } else {
9942: @listing_results =
9943: map { &unescape($_); } split(/:/,$listing);
9944: }
1.1136 raeburn 9945: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
9946: ($listing eq 'rejected') || ($listing eq 'refused') ||
9947: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9948: $listerror{$tryserver} = $listing;
9949: } else {
1.841 albertel 9950: foreach my $line (@listing_results) {
9951: my ($entry) = split(/&/,$line,2);
9952: $allusers{$entry} = 1;
9953: }
9954: }
1.253 stredwic 9955: }
1.1136 raeburn 9956: my @alluserslist=();
1.800 albertel 9957: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 9958: push(@alluserslist,$user.'&user');
1.253 stredwic 9959: }
1.1136 raeburn 9960: return (\@alluserslist);
1.253 stredwic 9961: } else {
1.1136 raeburn 9962: return ([],'missing username');
1.253 stredwic 9963: }
1.955 raeburn 9964: } elsif(!defined($getpropath)) {
1.1136 raeburn 9965: my $path = $perlvar{'lonDocRoot'}.'/res/';
9966: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
9967: return (\@all_domains);
1.955 raeburn 9968: } else {
1.1136 raeburn 9969: return ([],'missing domain');
1.275 stredwic 9970: }
9971: }
9972:
9973: # --------------------------------------------- GetFileTimestamp
9974: # This function utilizes dirlist and returns the date stamp for
9975: # when it was last modified. It will also return an error of -1
9976: # if an error occurs
9977:
9978: sub GetFileTimestamp {
1.955 raeburn 9979: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 9980: $studentDomain = &LONCAPA::clean_domain($studentDomain);
9981: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 9982: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
9983: undef,$getuserdir);
9984: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
9985: return -1;
9986: }
9987: if (ref($fileref) eq 'ARRAY') {
9988: my @stats = split('&',$fileref->[0]);
1.375 matthew 9989: # @stats contains first the filename, then the stat output
9990: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 9991: } else {
9992: return -1;
1.253 stredwic 9993: }
1.26 www 9994: }
9995:
1.712 albertel 9996: sub stat_file {
9997: my ($uri) = @_;
1.787 albertel 9998: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 9999:
1.955 raeburn 10000: my ($udom,$uname,$file);
1.712 albertel 10001: if ($uri =~ m-^/(uploaded|editupload)/-) {
10002: ($udom,$uname,$file) =
1.811 albertel 10003: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 10004: $file = 'userfiles/'.$file;
10005: }
10006: if ($uri =~ m-^/res/-) {
10007: ($udom,$uname) =
1.807 albertel 10008: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 10009: $file = $uri;
10010: }
10011:
10012: if (!$udom || !$uname || !$file) {
10013: # unable to handle the uri
10014: return ();
10015: }
1.956 raeburn 10016: my $getpropath;
10017: if ($file =~ /^userfiles\//) {
10018: $getpropath = 1;
10019: }
1.1136 raeburn 10020: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
10021: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
10022: return ();
10023: } else {
10024: if (ref($listref) eq 'ARRAY') {
10025: my @stats = split('&',$listref->[0]);
10026: shift(@stats); #filename is first
10027: return @stats;
10028: }
1.712 albertel 10029: }
10030: return ();
10031: }
10032:
1.26 www 10033: # -------------------------------------------------------- Value of a Condition
10034:
1.713 albertel 10035: # gets the value of a specific preevaluated condition
10036: # stored in the string $env{user.state.<cid>}
10037: # or looks up a condition reference in the bighash and if if hasn't
10038: # already been evaluated recurses into docondval to get the value of
10039: # the condition, then memoizing it to
10040: # $env{user.state.<cid>.<condition>}
1.40 www 10041: sub directcondval {
10042: my $number=shift;
1.620 albertel 10043: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 10044: &Apache::lonuserstate::evalstate();
10045: }
1.713 albertel 10046: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
10047: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
10048: } elsif ($number =~ /^_/) {
10049: my $sub_condition;
10050: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10051: &GDBM_READER(),0640)) {
10052: $sub_condition=$bighash{'conditions'.$number};
10053: untie(%bighash);
10054: }
10055: my $value = &docondval($sub_condition);
1.949 raeburn 10056: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 10057: return $value;
10058: }
1.620 albertel 10059: if ($env{'user.state.'.$env{'request.course.id'}}) {
10060: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 10061: } else {
10062: return 2;
10063: }
10064: }
10065:
1.713 albertel 10066: # get the collection of conditions for this resource
1.26 www 10067: sub condval {
10068: my $condidx=shift;
1.54 www 10069: my $allpathcond='';
1.713 albertel 10070: foreach my $cond (split(/\|/,$condidx)) {
10071: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
10072: $allpathcond.=
10073: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
10074: }
1.191 harris41 10075: }
1.54 www 10076: $allpathcond=~s/\|$//;
1.713 albertel 10077: return &docondval($allpathcond);
10078: }
10079:
10080: #evaluates an expression of conditions
10081: sub docondval {
10082: my ($allpathcond) = @_;
10083: my $result=0;
10084: if ($env{'request.course.id'}
10085: && defined($allpathcond)) {
10086: my $operand='|';
10087: my @stack;
10088: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
10089: if ($chunk eq '(') {
10090: push @stack,($operand,$result);
10091: } elsif ($chunk eq ')') {
10092: my $before=pop @stack;
10093: if (pop @stack eq '&') {
10094: $result=$result>$before?$before:$result;
10095: } else {
10096: $result=$result>$before?$result:$before;
10097: }
10098: } elsif (($chunk eq '&') || ($chunk eq '|')) {
10099: $operand=$chunk;
10100: } else {
10101: my $new=directcondval($chunk);
10102: if ($operand eq '&') {
10103: $result=$result>$new?$new:$result;
10104: } else {
10105: $result=$result>$new?$result:$new;
10106: }
10107: }
10108: }
1.26 www 10109: }
10110: return $result;
1.421 albertel 10111: }
10112:
10113: # ---------------------------------------------------- Devalidate courseresdata
10114:
10115: sub devalidatecourseresdata {
10116: my ($coursenum,$coursedomain)=@_;
10117: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 10118: &devalidate_cache_new('courseres',$hashid);
1.28 www 10119: }
10120:
1.763 www 10121:
1.200 www 10122: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 10123: #
10124: # Parameters:
10125: # $coursenum - Number of the course.
10126: # $coursedomain - Domain at which the course was created.
10127: # Returns:
10128: # A hash of the course parameters along (I think) with timestamps
10129: # and version info.
1.877 foxr 10130:
1.624 albertel 10131: sub get_courseresdata {
10132: my ($coursenum,$coursedomain)=@_;
1.200 www 10133: my $coursehom=&homeserver($coursenum,$coursedomain);
10134: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 10135: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 10136: my %dumpreply;
1.417 albertel 10137: unless (defined($cached)) {
1.624 albertel 10138: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 10139: $result=\%dumpreply;
1.251 albertel 10140: my ($tmp) = keys(%dumpreply);
10141: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 10142: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 10143: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
10144: return $tmp;
1.416 albertel 10145: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 10146: $result=undef;
1.599 albertel 10147: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 10148: }
10149: }
1.624 albertel 10150: return $result;
10151: }
10152:
1.633 albertel 10153: sub devalidateuserresdata {
10154: my ($uname,$udom)=@_;
10155: my $hashid="$udom:$uname";
10156: &devalidate_cache_new('userres',$hashid);
10157: }
10158:
1.624 albertel 10159: sub get_userresdata {
10160: my ($uname,$udom)=@_;
10161: #most student don\'t have any data set, check if there is some data
10162: if (&EXT_cache_status($udom,$uname)) { return undef; }
10163:
10164: my $hashid="$udom:$uname";
10165: my ($result,$cached)=&is_cached_new('userres',$hashid);
10166: if (!defined($cached)) {
10167: my %resourcedata=&dump('resourcedata',$udom,$uname);
10168: $result=\%resourcedata;
10169: &do_cache_new('userres',$hashid,$result,600);
10170: }
10171: my ($tmp)=keys(%$result);
10172: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
10173: return $result;
10174: }
10175: #error 2 occurs when the .db doesn't exist
10176: if ($tmp!~/error: 2 /) {
1.1294 raeburn 10177: if ((!defined($cached)) || ($tmp ne 'con_lost')) {
10178: &logthis("<font color=\"blue\">WARNING:".
10179: " Trying to get resource data for ".
10180: $uname." at ".$udom.": ".
10181: $tmp."</font>");
10182: }
1.624 albertel 10183: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 10184: #&EXT_cache_set($udom,$uname);
10185: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 10186: undef($tmp); # not really an error so don't send it back
1.624 albertel 10187: }
10188: return $tmp;
10189: }
1.879 foxr 10190: #----------------------------------------------- resdata - return resource data
10191: # Purpose:
10192: # Return resource data for either users or for a course.
10193: # Parameters:
10194: # $name - Course/user name.
10195: # $domain - Name of the domain the user/course is registered on.
10196: # $type - Type of thing $name is (must be 'course' or 'user'
10197: # @which - Array of names of resources desired.
10198: # Returns:
10199: # The value of the first reasource in @which that is found in the
10200: # resource hash.
10201: # Exceptional Conditions:
10202: # If the $type passed in is not valid (not the string 'course' or
10203: # 'user', an undefined reference is returned.
10204: # If none of the resources are found, an undef is returned
1.624 albertel 10205: sub resdata {
10206: my ($name,$domain,$type,@which)=@_;
10207: my $result;
10208: if ($type eq 'course') {
10209: $result=&get_courseresdata($name,$domain);
10210: } elsif ($type eq 'user') {
10211: $result=&get_userresdata($name,$domain);
10212: }
10213: if (!ref($result)) { return $result; }
1.251 albertel 10214: foreach my $item (@which) {
1.927 albertel 10215: if (defined($result->{$item->[0]})) {
10216: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 10217: }
1.250 albertel 10218: }
1.291 albertel 10219: return undef;
1.200 www 10220: }
10221:
1.1236 raeburn 10222: sub get_numsuppfiles {
10223: my ($cnum,$cdom,$ignorecache)=@_;
10224: my $hashid=$cnum.':'.$cdom;
10225: my ($suppcount,$cached);
10226: unless ($ignorecache) {
10227: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
10228: }
10229: unless (defined($cached)) {
10230: my $chome=&homeserver($cnum,$cdom);
10231: unless ($chome eq 'no_host') {
10232: ($suppcount,my $errors) = (0,0);
10233: my $suppmap = 'supplemental.sequence';
10234: ($suppcount,$errors) =
10235: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
10236: }
10237: &do_cache_new('suppcount',$hashid,$suppcount,600);
10238: }
10239: return $suppcount;
10240: }
10241:
1.379 matthew 10242: #
10243: # EXT resource caching routines
10244: #
10245:
10246: sub clear_EXT_cache_status {
1.383 albertel 10247: &delenv('cache.EXT.');
1.379 matthew 10248: }
10249:
10250: sub EXT_cache_status {
10251: my ($target_domain,$target_user) = @_;
1.383 albertel 10252: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 10253: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 10254: # We know already the user has no data
10255: return 1;
10256: } else {
10257: return 0;
10258: }
10259: }
10260:
10261: sub EXT_cache_set {
10262: my ($target_domain,$target_user) = @_;
1.383 albertel 10263: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 10264: #&appenv({$cachename => time});
1.379 matthew 10265: }
10266:
1.28 www 10267: # --------------------------------------------------------- Value of a Variable
1.58 www 10268: sub EXT {
1.715 albertel 10269:
1.1228 raeburn 10270: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68 www 10271: unless ($varname) { return ''; }
1.218 albertel 10272: #get real user name/domain, courseid and symb
10273: my $courseid;
1.359 albertel 10274: my $publicuser;
1.427 www 10275: if ($symbparm) {
10276: $symbparm=&get_symb_from_alias($symbparm);
10277: }
1.218 albertel 10278: if (!($uname && $udom)) {
1.790 albertel 10279: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 10280: if (!$symbparm) { $symbparm=$cursymb; }
10281: } else {
1.620 albertel 10282: $courseid=$env{'request.course.id'};
1.218 albertel 10283: }
1.48 www 10284: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
10285: my $rest;
1.320 albertel 10286: if (defined($therest[0])) {
1.48 www 10287: $rest=join('.',@therest);
10288: } else {
10289: $rest='';
10290: }
1.320 albertel 10291:
1.57 www 10292: my $qualifierrest=$qualifier;
10293: if ($rest) { $qualifierrest.='.'.$rest; }
10294: my $spacequalifierrest=$space;
10295: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 10296: if ($realm eq 'user') {
1.48 www 10297: # --------------------------------------------------------------- user.resource
10298: if ($space eq 'resource') {
1.651 albertel 10299: if ( (defined($Apache::lonhomework::parsing_a_problem)
10300: || defined($Apache::lonhomework::parsing_a_task))
10301: &&
1.744 albertel 10302: ($symbparm eq &symbread()) ) {
10303: # if we are in the middle of processing the resource the
10304: # get the value we are planning on committing
10305: if (defined($Apache::lonhomework::results{$qualifierrest})) {
10306: return $Apache::lonhomework::results{$qualifierrest};
10307: } else {
10308: return $Apache::lonhomework::history{$qualifierrest};
10309: }
1.335 albertel 10310: } else {
1.359 albertel 10311: my %restored;
1.620 albertel 10312: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 10313: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
10314: } else {
10315: %restored=&restore($symbparm,$courseid,$udom,$uname);
10316: }
1.335 albertel 10317: return $restored{$qualifierrest};
10318: }
1.48 www 10319: # ----------------------------------------------------------------- user.access
10320: } elsif ($space eq 'access') {
1.218 albertel 10321: # FIXME - not supporting calls for a specific user
1.48 www 10322: return &allowed($qualifier,$rest);
10323: # ------------------------------------------ user.preferences, user.environment
10324: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 10325: if (($uname eq $env{'user.name'}) &&
10326: ($udom eq $env{'user.domain'})) {
10327: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 10328: } else {
1.359 albertel 10329: my %returnhash;
10330: if (!$publicuser) {
10331: %returnhash=&userenvironment($udom,$uname,
10332: $qualifierrest);
10333: }
1.218 albertel 10334: return $returnhash{$qualifierrest};
10335: }
1.48 www 10336: # ----------------------------------------------------------------- user.course
10337: } elsif ($space eq 'course') {
1.218 albertel 10338: # FIXME - not supporting calls for a specific user
1.620 albertel 10339: return $env{join('.',('request.course',$qualifier))};
1.48 www 10340: # ------------------------------------------------------------------- user.role
10341: } elsif ($space eq 'role') {
1.218 albertel 10342: # FIXME - not supporting calls for a specific user
1.620 albertel 10343: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 10344: if ($qualifier eq 'value') {
10345: return $role;
10346: } elsif ($qualifier eq 'extent') {
10347: return $where;
10348: }
10349: # ----------------------------------------------------------------- user.domain
10350: } elsif ($space eq 'domain') {
1.218 albertel 10351: return $udom;
1.48 www 10352: # ------------------------------------------------------------------- user.name
10353: } elsif ($space eq 'name') {
1.218 albertel 10354: return $uname;
1.48 www 10355: # ---------------------------------------------------- Any other user namespace
1.29 www 10356: } else {
1.359 albertel 10357: my %reply;
10358: if (!$publicuser) {
10359: %reply=&get($space,[$qualifierrest],$udom,$uname);
10360: }
10361: return $reply{$qualifierrest};
1.48 www 10362: }
1.236 www 10363: } elsif ($realm eq 'query') {
10364: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 10365: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
10366: [$spacequalifierrest]);
1.620 albertel 10367: return $env{'form.'.$spacequalifierrest};
1.236 www 10368: } elsif ($realm eq 'request') {
1.48 www 10369: # ------------------------------------------------------------- request.browser
10370: if ($space eq 'browser') {
1.1145 bisitz 10371: return $env{'browser.'.$qualifier};
1.57 www 10372: # ------------------------------------------------------------ request.filename
10373: } else {
1.620 albertel 10374: return $env{'request.'.$spacequalifierrest};
1.29 www 10375: }
1.28 www 10376: } elsif ($realm eq 'course') {
1.48 www 10377: # ---------------------------------------------------------- course.description
1.620 albertel 10378: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 10379: } elsif ($realm eq 'resource') {
1.165 www 10380:
1.620 albertel 10381: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 10382: if (!$symbparm) { $symbparm=&symbread(); }
10383: }
1.693 albertel 10384:
1.1232 raeburn 10385: if ($qualifier eq '') {
10386: if ($space eq 'title') {
10387: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
10388: return &gettitle($symbparm);
10389: }
1.693 albertel 10390:
1.1232 raeburn 10391: if ($space eq 'map') {
10392: my ($map) = &decode_symb($symbparm);
10393: return &symbread($map);
10394: }
10395: if ($space eq 'maptitle') {
10396: my ($map) = &decode_symb($symbparm);
10397: return &gettitle($map);
10398: }
10399: if ($space eq 'filename') {
10400: if ($symbparm) {
10401: return &clutter((&decode_symb($symbparm))[2]);
10402: }
10403: return &hreflocation('',$env{'request.filename'});
1.905 albertel 10404: }
1.1232 raeburn 10405:
1.1233 raeburn 10406: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
10407: if ($space eq 'visibleparts') {
10408: my $navmap = Apache::lonnavmaps::navmap->new();
10409: my $item;
10410: if (ref($navmap)) {
10411: my $res = $navmap->getBySymb($symbparm);
10412: my $parts = $res->parts();
10413: if (ref($parts) eq 'ARRAY') {
10414: $item = join(',',@{$parts});
10415: }
10416: undef($navmap);
1.1232 raeburn 10417: }
1.1233 raeburn 10418: return $item;
1.1232 raeburn 10419: }
10420: }
10421: }
1.693 albertel 10422:
10423: my ($section, $group, @groups);
1.593 albertel 10424: my ($courselevelm,$courselevel);
1.1228 raeburn 10425: if (($courseid eq '') && ($cid)) {
10426: $courseid = $cid;
10427: }
10428: if (($symbparm && $courseid) &&
10429: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 10430:
1.218 albertel 10431: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 10432:
1.60 www 10433: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 10434: my $symbp=$symbparm;
1.735 albertel 10435: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 10436:
10437: my $symbparm=$symbp.'.'.$spacequalifierrest;
10438: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
10439:
1.620 albertel 10440: if (($env{'user.name'} eq $uname) &&
10441: ($env{'user.domain'} eq $udom)) {
10442: $section=$env{'request.course.sec'};
1.733 raeburn 10443: @groups = split(/:/,$env{'request.course.groups'});
10444: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 10445: } else {
1.539 albertel 10446: if (! defined($usection)) {
1.551 albertel 10447: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 10448: } else {
10449: $section = $usection;
10450: }
1.733 raeburn 10451: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 10452: }
10453:
10454: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
10455: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
10456: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
10457:
1.593 albertel 10458: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 10459: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 10460: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 10461:
1.60 www 10462: # ----------------------------------------------------------- first, check user
1.624 albertel 10463:
10464: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 10465: ([$courselevelr,'resource'],
10466: [$courselevelm,'map' ],
10467: [$courselevel, 'course' ]));
1.931 albertel 10468: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 10469:
1.594 albertel 10470: # ------------------------------------------------ second, check some of course
1.684 raeburn 10471: my $coursereply;
1.691 raeburn 10472: if (@groups > 0) {
10473: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
10474: $mapparm,$spacequalifierrest);
1.927 albertel 10475: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 10476: }
1.96 www 10477:
1.684 raeburn 10478: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 10479: $env{'course.'.$courseid.'.domain'},
10480: 'course',
10481: ([$seclevelr, 'resource'],
10482: [$seclevelm, 'map' ],
10483: [$seclevel, 'course' ],
10484: [$courselevelr,'resource']));
10485: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 10486:
1.60 www 10487: # ------------------------------------------------------ third, check map parms
1.218 albertel 10488: my %parmhash=();
10489: my $thisparm='';
10490: if (tie(%parmhash,'GDBM_File',
1.620 albertel 10491: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 10492: &GDBM_READER(),0640)) {
1.218 albertel 10493: $thisparm=$parmhash{$symbparm};
10494: untie(%parmhash);
10495: }
1.927 albertel 10496: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 10497: }
1.594 albertel 10498: # ------------------------------------------ fourth, look in resource metadata
1.71 www 10499:
1.218 albertel 10500: $spacequalifierrest=~s/\./\_/;
1.282 albertel 10501: my $filename;
10502: if (!$symbparm) { $symbparm=&symbread(); }
10503: if ($symbparm) {
1.409 www 10504: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 10505: } else {
1.620 albertel 10506: $filename=$env{'request.filename'};
1.282 albertel 10507: }
10508: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 10509: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 10510: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 10511: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 10512:
1.927 albertel 10513: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 10514: if ($symbparm && defined($courseid) &&
1.620 albertel 10515: $courseid eq $env{'request.course.id'}) {
1.624 albertel 10516: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
10517: $env{'course.'.$courseid.'.domain'},
10518: 'course',
1.927 albertel 10519: ([$courselevelm,'map' ],
10520: [$courselevel, 'course']));
10521: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 10522: }
1.145 www 10523: # ------------------------------------------------------------------ Cascade up
1.218 albertel 10524: unless ($space eq '0') {
1.336 albertel 10525: my @parts=split(/_/,$space);
10526: my $id=pop(@parts);
10527: my $part=join('_',@parts);
10528: if ($part eq '') { $part='0'; }
1.927 albertel 10529: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 10530: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 10531: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 10532: }
1.395 albertel 10533: if ($recurse) { return undef; }
10534: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 10535: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 10536: # ---------------------------------------------------- Any other user namespace
10537: } elsif ($realm eq 'environment') {
10538: # ----------------------------------------------------------------- environment
1.620 albertel 10539: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
10540: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 10541: } else {
1.770 albertel 10542: if ($uname eq 'anonymous' && $udom eq '') {
10543: return '';
10544: }
1.219 albertel 10545: my %returnhash=&userenvironment($udom,$uname,
10546: $spacequalifierrest);
10547: return $returnhash{$spacequalifierrest};
10548: }
1.28 www 10549: } elsif ($realm eq 'system') {
1.48 www 10550: # ----------------------------------------------------------------- system.time
10551: if ($space eq 'time') {
10552: return time;
10553: }
1.696 albertel 10554: } elsif ($realm eq 'server') {
10555: # ----------------------------------------------------------------- system.time
10556: if ($space eq 'name') {
10557: return $ENV{'SERVER_NAME'};
10558: }
1.28 www 10559: }
1.48 www 10560: return '';
1.61 www 10561: }
10562:
1.927 albertel 10563: sub get_reply {
10564: my ($reply_value) = @_;
1.940 raeburn 10565: if (ref($reply_value) eq 'ARRAY') {
10566: if (wantarray) {
10567: return @$reply_value;
10568: }
10569: return $reply_value->[0];
10570: } else {
10571: return $reply_value;
1.927 albertel 10572: }
10573: }
10574:
1.691 raeburn 10575: sub check_group_parms {
10576: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
10577: my @groupitems = ();
10578: my $resultitem;
1.927 albertel 10579: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 10580: foreach my $group (@{$groups}) {
10581: foreach my $level (@levels) {
1.927 albertel 10582: my $item = $courseid.'.['.$group.'].'.$level->[0];
10583: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 10584: }
10585: }
10586: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10587: $env{'course.'.$courseid.'.domain'},
10588: 'course',@groupitems);
10589: return $coursereply;
10590: }
10591:
10592: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 10593: my ($courseid,@groups) = @_;
10594: @groups = sort(@groups);
1.691 raeburn 10595: return @groups;
10596: }
10597:
1.395 albertel 10598: sub packages_tab_default {
10599: my ($uri,$varname)=@_;
10600: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 10601:
10602: my (@extension,@specifics,$do_default);
10603: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 10604: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 10605: if ($pack_type eq 'default') {
10606: $do_default=1;
10607: } elsif ($pack_type eq 'extension') {
10608: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 10609: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 10610: # only look at packages defaults for packages that this id is
1.738 albertel 10611: push(@specifics,[$package,$pack_type,$pack_part]);
10612: }
10613: }
10614: # first look for a package that matches the requested part id
10615: foreach my $package (@specifics) {
10616: my (undef,$pack_type,$pack_part)=@{$package};
10617: next if ($pack_part ne $part);
10618: if (defined($packagetab{"$pack_type&$name&default"})) {
10619: return $packagetab{"$pack_type&$name&default"};
10620: }
10621: }
10622: # look for any possible matching non extension_ package
10623: foreach my $package (@specifics) {
10624: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 10625: if (defined($packagetab{"$pack_type&$name&default"})) {
10626: return $packagetab{"$pack_type&$name&default"};
10627: }
1.585 albertel 10628: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 10629: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10630: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 10631: }
10632: }
1.738 albertel 10633: # look for any posible extension_ match
10634: foreach my $package (@extension) {
10635: my ($package,$pack_type)=@{$package};
10636: if (defined($packagetab{"$pack_type&$name&default"})) {
10637: return $packagetab{"$pack_type&$name&default"};
10638: }
10639: if (defined($packagetab{$package."&$name&default"})) {
10640: return $packagetab{$package."&$name&default"};
10641: }
10642: }
10643: # look for a global default setting
10644: if ($do_default && defined($packagetab{"default&$name&default"})) {
10645: return $packagetab{"default&$name&default"};
10646: }
1.395 albertel 10647: return undef;
10648: }
10649:
1.334 albertel 10650: sub add_prefix_and_part {
10651: my ($prefix,$part)=@_;
10652: my $keyroot;
10653: if (defined($prefix) && $prefix !~ /^__/) {
10654: # prefix that has a part already
10655: $keyroot=$prefix;
10656: } elsif (defined($prefix)) {
10657: # prefix that is missing a part
10658: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10659: } else {
10660: # no prefix at all
10661: if (defined($part)) { $keyroot='_'.$part; }
10662: }
10663: return $keyroot;
10664: }
10665:
1.71 www 10666: # ---------------------------------------------------------------- Get metadata
10667:
1.599 albertel 10668: my %metaentry;
1.1070 www 10669: my %importedpartids;
1.71 www 10670: sub metadata {
1.176 www 10671: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 10672: $uri=&declutter($uri);
1.288 albertel 10673: # if it is a non metadata possible uri return quickly
1.529 albertel 10674: if (($uri eq '') ||
10675: (($uri =~ m|^/*adm/|) &&
1.1217 raeburn 10676: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard)$})) ||
1.1108 raeburn 10677: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 10678: return undef;
10679: }
1.1261 raeburn 10680: if (($uri =~ /^priv/ || $uri=~m{^home/httpd/html/priv})
1.924 albertel 10681: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 10682: return undef;
1.288 albertel 10683: }
1.73 www 10684: my $filename=$uri;
10685: $uri=~s/\.meta$//;
1.172 www 10686: #
10687: # Is the metadata already cached?
1.177 www 10688: # Look at timestamp of caching
1.172 www 10689: # Everything is cached by the main uri, libraries are never directly cached
10690: #
1.428 albertel 10691: if (!defined($liburi)) {
1.599 albertel 10692: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 10693: if (defined($cached)) { return $result->{':'.$what}; }
10694: }
10695: {
1.1069 www 10696: # Imported parts would go here
1.1070 www 10697: my %importedids=();
10698: my @origfileimportpartids=();
1.1069 www 10699: my $importedparts=0;
1.172 www 10700: #
10701: # Is this a recursive call for a library?
10702: #
1.599 albertel 10703: # if (! exists($metacache{$uri})) {
10704: # $metacache{$uri}={};
10705: # }
1.924 albertel 10706: my $cachetime = 60*60;
1.171 www 10707: if ($liburi) {
10708: $liburi=&declutter($liburi);
10709: $filename=$liburi;
1.401 bowersj2 10710: } else {
1.599 albertel 10711: &devalidate_cache_new('meta',$uri);
10712: undef(%metaentry);
1.401 bowersj2 10713: }
1.140 www 10714: my %metathesekeys=();
1.73 www 10715: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 10716: my $metastring;
1.1140 www 10717: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 10718: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 10719: $metastring =
1.929 albertel 10720: &Apache::lonnet::ssi_body($which,
1.924 albertel 10721: ('grade_target' => 'meta'));
10722: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 10723: } elsif (($uri !~ m -^(editupload)/-) &&
10724: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 10725: my $file=&filelocation('',&clutter($filename));
1.599 albertel 10726: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 10727: $metastring=&getfile($file);
1.489 albertel 10728: }
1.208 albertel 10729: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 10730: my $token;
1.140 www 10731: undef %metathesekeys;
1.71 www 10732: while ($token=$parser->get_token) {
1.339 albertel 10733: if ($token->[0] eq 'S') {
10734: if (defined($token->[2]->{'package'})) {
1.172 www 10735: #
10736: # This is a package - get package info
10737: #
1.339 albertel 10738: my $package=$token->[2]->{'package'};
10739: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10740: if (defined($token->[2]->{'id'})) {
10741: $keyroot.='_'.$token->[2]->{'id'};
10742: }
1.599 albertel 10743: if ($metaentry{':packages'}) {
10744: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 10745: } else {
1.599 albertel 10746: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 10747: }
1.736 albertel 10748: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 10749: my $part=$keyroot;
10750: $part=~s/^\_//;
1.736 albertel 10751: if ($pack_entry=~/^\Q$package\E\&/ ||
10752: $pack_entry=~/^\Q$package\E_0\&/) {
10753: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 10754: # ignore package.tab specified default values
10755: # here &package_tab_default() will fetch those
10756: if ($subp eq 'default') { next; }
1.736 albertel 10757: my $value=$packagetab{$pack_entry};
1.432 albertel 10758: my $unikey;
10759: if ($pack =~ /_0$/) {
10760: $unikey='parameter_0_'.$name;
10761: $part=0;
10762: } else {
10763: $unikey='parameter'.$keyroot.'_'.$name;
10764: }
1.339 albertel 10765: if ($subp eq 'display') {
10766: $value.=' [Part: '.$part.']';
10767: }
1.599 albertel 10768: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 10769: $metathesekeys{$unikey}=1;
1.599 albertel 10770: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10771: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 10772: }
1.599 albertel 10773: if (defined($metaentry{':'.$unikey.'.default'})) {
10774: $metaentry{':'.$unikey}=
10775: $metaentry{':'.$unikey.'.default'};
1.356 albertel 10776: }
1.339 albertel 10777: }
10778: }
10779: } else {
1.172 www 10780: #
10781: # This is not a package - some other kind of start tag
1.339 albertel 10782: #
10783: my $entry=$token->[1];
1.1068 www 10784: my $unikey='';
1.175 www 10785:
1.339 albertel 10786: if ($entry eq 'import') {
1.175 www 10787: #
10788: # Importing a library here
1.339 albertel 10789: #
1.1067 www 10790: my $location=$parser->get_text('/import');
10791: my $dir=$filename;
10792: $dir=~s|[^/]*$||;
10793: $location=&filelocation($dir,$location);
1.1069 www 10794:
1.1068 www 10795: my $importmode=$token->[2]->{'importmode'};
10796: if ($importmode eq 'problem') {
1.1069 www 10797: # Import as problem/response
1.1068 www 10798: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10799: } elsif ($importmode eq 'part') {
10800: # Import as part(s)
1.1069 www 10801: $importedparts=1;
10802: # We need to get the original file and the imported file to get the part order correct
10803: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
10804: # Load and inspect original file
1.1070 www 10805: if ($#origfileimportpartids<0) {
10806: undef(%importedpartids);
10807: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
10808: my $origfile=&getfile($origfilelocation);
10809: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10810: }
10811:
1.1069 www 10812: # Load and inspect imported file
10813: my $impfile=&getfile($location);
10814: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10815: if ($#impfilepartids>=0) {
10816: # This problem had parts
1.1070 www 10817: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 10818: } else {
10819: # Importing by turning a single problem into a problem part
10820: # It gets the import-tags ID as part-ID
10821: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 10822: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 10823: }
1.1068 www 10824: } else {
10825: # Normal import
10826: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10827: if (defined($token->[2]->{'id'})) {
10828: $unikey.='_'.$token->[2]->{'id'};
10829: }
1.1067 www 10830: }
10831:
1.339 albertel 10832: if ($depthcount<20) {
1.736 albertel 10833: my $metadata =
10834: &metadata($uri,'keys', $location,$unikey,
10835: $depthcount+1);
10836: foreach my $meta (split(',',$metadata)) {
10837: $metaentry{':'.$meta}=$metaentry{':'.$meta};
10838: $metathesekeys{$meta}=1;
1.339 albertel 10839: }
1.1068 www 10840:
10841: }
1.1067 www 10842: } else {
10843: #
10844: # Not importing, some other kind of non-package, non-library start tag
10845: #
10846: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
10847: if (defined($token->[2]->{'id'})) {
10848: $unikey.='_'.$token->[2]->{'id'};
10849: }
1.339 albertel 10850: if (defined($token->[2]->{'name'})) {
10851: $unikey.='_'.$token->[2]->{'name'};
10852: }
10853: $metathesekeys{$unikey}=1;
1.736 albertel 10854: foreach my $param (@{$token->[3]}) {
10855: $metaentry{':'.$unikey.'.'.$param} =
10856: $token->[2]->{$param};
1.339 albertel 10857: }
10858: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 10859: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 10860: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
10861: # only ws inside the tag, and not in default, so use default
10862: # as value
1.599 albertel 10863: $metaentry{':'.$unikey}=$default;
1.908 albertel 10864: } elsif ( $internaltext =~ /\S/ ) {
10865: # something interesting inside the tag
10866: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 10867: } else {
1.908 albertel 10868: # no interesting values, don't set a default
1.339 albertel 10869: }
1.172 www 10870: # end of not-a-package not-a-library import
1.339 albertel 10871: }
1.172 www 10872: # end of not-a-package start tag
1.339 albertel 10873: }
1.172 www 10874: # the next is the end of "start tag"
1.339 albertel 10875: }
10876: }
1.483 albertel 10877: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 10878: $extension = lc($extension);
10879: if ($extension eq 'htm') { $extension='html'; }
10880:
1.737 albertel 10881: foreach my $key (keys(%packagetab)) {
1.483 albertel 10882: #no specific packages #how's our extension
10883: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 10884: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 10885: \%metathesekeys);
10886: }
1.883 albertel 10887:
10888: if (!exists($metaentry{':packages'})
10889: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 10890: foreach my $key (keys(%packagetab)) {
1.483 albertel 10891: #no specific packages well let's get default then
10892: if ($key!~/^default&/) { next; }
1.488 albertel 10893: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 10894: \%metathesekeys);
10895: }
10896: }
1.338 www 10897: # are there custom rights to evaluate
1.599 albertel 10898: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 10899:
1.338 www 10900: #
10901: # Importing a rights file here
1.339 albertel 10902: #
10903: unless ($depthcount) {
1.599 albertel 10904: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 10905: my $dir=$filename;
10906: $dir=~s|[^/]*$||;
10907: $location=&filelocation($dir,$location);
1.736 albertel 10908: my $rights_metadata =
10909: &metadata($uri,'keys',$location,'_rights',
10910: $depthcount+1);
10911: foreach my $rights (split(',',$rights_metadata)) {
10912: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
10913: $metathesekeys{$rights}=1;
1.339 albertel 10914: }
10915: }
10916: }
1.737 albertel 10917: # uniqifiy package listing
10918: my %seen;
10919: my @uniq_packages =
10920: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
10921: $metaentry{':packages'} = join(',',@uniq_packages);
10922:
1.1070 www 10923: if ($importedparts) {
10924: # We had imported parts and need to rebuild partorder
10925: $metaentry{':partorder'}='';
10926: $metathesekeys{'partorder'}=1;
10927: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
10928: if ($origfileimportpartids[$index] eq 'part') {
10929: # original part, part of the problem
10930: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
10931: } else {
10932: # we have imported parts at this position
10933: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
10934: }
10935: }
10936: $metaentry{':partorder'}=~s/^\,//;
10937: }
10938:
1.737 albertel 10939: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 10940: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
1.1274 raeburn 10941: $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
1.924 albertel 10942: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 10943: # this is the end of "was not already recently cached
1.71 www 10944: }
1.599 albertel 10945: return $metaentry{':'.$what};
1.261 albertel 10946: }
10947:
1.488 albertel 10948: sub metadata_create_package_def {
1.483 albertel 10949: my ($uri,$key,$package,$metathesekeys)=@_;
10950: my ($pack,$name,$subp)=split(/\&/,$key);
10951: if ($subp eq 'default') { next; }
10952:
1.599 albertel 10953: if (defined($metaentry{':packages'})) {
10954: $metaentry{':packages'}.=','.$package;
1.483 albertel 10955: } else {
1.599 albertel 10956: $metaentry{':packages'}=$package;
1.483 albertel 10957: }
10958: my $value=$packagetab{$key};
10959: my $unikey;
10960: $unikey='parameter_0_'.$name;
1.599 albertel 10961: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 10962: $$metathesekeys{$unikey}=1;
1.599 albertel 10963: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10964: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 10965: }
1.599 albertel 10966: if (defined($metaentry{':'.$unikey.'.default'})) {
10967: $metaentry{':'.$unikey}=
10968: $metaentry{':'.$unikey.'.default'};
1.483 albertel 10969: }
10970: }
10971:
1.261 albertel 10972: sub metadata_generate_part0 {
10973: my ($metadata,$metacache,$uri) = @_;
10974: my %allnames;
1.737 albertel 10975: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 10976: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 10977: my $part=$$metacache{':'.$metakey.'.part'};
10978: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 10979: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 10980: $allnames{$name}=$part;
10981: }
10982: }
10983: }
10984: foreach my $name (keys(%allnames)) {
10985: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 10986: my $key=":parameter_0_$name";
1.261 albertel 10987: $$metacache{"$key.part"}='0';
10988: $$metacache{"$key.name"}=$name;
1.428 albertel 10989: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 10990: $allnames{$name}.'_'.$name.
10991: '.type'};
1.428 albertel 10992: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 10993: '.display'};
1.644 www 10994: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 10995: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 10996: $$metacache{"$key.display"}=$olddis;
10997: }
1.71 www 10998: }
10999:
1.764 albertel 11000: # ------------------------------------------------------ Devalidate title cache
11001:
11002: sub devalidate_title_cache {
11003: my ($url)=@_;
11004: if (!$env{'request.course.id'}) { return; }
11005: my $symb=&symbread($url);
11006: if (!$symb) { return; }
11007: my $key=$env{'request.course.id'}."\0".$symb;
11008: &devalidate_cache_new('title',$key);
11009: }
11010:
1.1014 droeschl 11011: # ------------------------------------------------- Get the title of a course
11012:
11013: sub current_course_title {
11014: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
11015: }
1.301 www 11016: # ------------------------------------------------- Get the title of a resource
11017:
11018: sub gettitle {
11019: my $urlsymb=shift;
11020: my $symb=&symbread($urlsymb);
1.534 albertel 11021: if ($symb) {
1.620 albertel 11022: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 11023: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 11024: if (defined($cached)) {
11025: return $result;
11026: }
1.534 albertel 11027: my ($map,$resid,$url)=&decode_symb($symb);
11028: my $title='';
1.907 albertel 11029: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
11030: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
11031: } else {
11032: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
11033: &GDBM_READER(),0640)) {
11034: my $mapid=$bighash{'map_pc_'.&clutter($map)};
11035: $title=$bighash{'title_'.$mapid.'.'.$resid};
11036: untie(%bighash);
11037: }
1.534 albertel 11038: }
11039: $title=~s/\&colon\;/\:/gs;
11040: if ($title) {
1.1159 www 11041: # Remember both $symb and $title for dynamic metadata
11042: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 11043: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 11044: # Cache this title and then return it
1.599 albertel 11045: return &do_cache_new('title',$key,$title,600);
1.534 albertel 11046: }
11047: $urlsymb=$url;
11048: }
11049: my $title=&metadata($urlsymb,'title');
11050: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
11051: return $title;
1.301 www 11052: }
1.613 albertel 11053:
1.614 albertel 11054: sub get_slot {
11055: my ($which,$cnum,$cdom)=@_;
11056: if (!$cnum || !$cdom) {
1.790 albertel 11057: (undef,my $courseid)=&whichuser();
1.620 albertel 11058: $cdom=$env{'course.'.$courseid.'.domain'};
11059: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 11060: }
1.703 albertel 11061: my $key=join("\0",'slots',$cdom,$cnum,$which);
11062: my %slotinfo;
11063: if (exists($remembered{$key})) {
11064: $slotinfo{$which} = $remembered{$key};
11065: } else {
11066: %slotinfo=&get('slots',[$which],$cdom,$cnum);
11067: &Apache::lonhomework::showhash(%slotinfo);
11068: my ($tmp)=keys(%slotinfo);
11069: if ($tmp=~/^error:/) { return (); }
11070: $remembered{$key} = $slotinfo{$which};
11071: }
1.616 albertel 11072: if (ref($slotinfo{$which}) eq 'HASH') {
11073: return %{$slotinfo{$which}};
11074: }
11075: return $slotinfo{$which};
1.614 albertel 11076: }
1.1150 raeburn 11077:
11078: sub get_reservable_slots {
11079: my ($cnum,$cdom,$uname,$udom) = @_;
11080: my $now = time;
11081: my $reservable_info;
11082: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
11083: if (exists($remembered{$key})) {
11084: $reservable_info = $remembered{$key};
11085: } else {
11086: my %resv;
11087: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
11088: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
11089: $reservable_info = \%resv;
11090: $remembered{$key} = $reservable_info;
11091: }
11092: return $reservable_info;
11093: }
11094:
11095: sub get_course_slots {
11096: my ($cnum,$cdom) = @_;
11097: my $hashid=$cnum.':'.$cdom;
11098: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
11099: if (defined($cached)) {
11100: if (ref($result) eq 'HASH') {
11101: return %{$result};
11102: }
11103: } else {
11104: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
11105: my ($tmp) = keys(%slots);
11106: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 11107: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 11108: return %slots;
11109: }
11110: }
11111: return;
11112: }
11113:
11114: sub devalidate_slots_cache {
11115: my ($cnum,$cdom)=@_;
11116: my $hashid=$cnum.':'.$cdom;
11117: &devalidate_cache_new('allslots',$hashid);
11118: }
11119:
1.1181 raeburn 11120: sub get_coursechange {
11121: my ($cdom,$cnum) = @_;
11122: if ($cdom eq '' || $cnum eq '') {
11123: return unless ($env{'request.course.id'});
11124: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
11125: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
11126: }
11127: my $hashid=$cdom.'_'.$cnum;
11128: my ($change,$cached)=&is_cached_new('crschange',$hashid);
11129: if ((defined($cached)) && ($change ne '')) {
11130: return $change;
11131: } else {
11132: my %crshash;
11133: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
11134: if ($crshash{'internal.contentchange'} eq '') {
11135: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
11136: if ($change eq '') {
11137: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
11138: $change = $crshash{'internal.created'};
11139: }
11140: } else {
11141: $change = $crshash{'internal.contentchange'};
11142: }
11143: my $cachetime = 600;
11144: &do_cache_new('crschange',$hashid,$change,$cachetime);
11145: }
11146: return $change;
11147: }
11148:
11149: sub devalidate_coursechange_cache {
11150: my ($cnum,$cdom)=@_;
11151: my $hashid=$cnum.':'.$cdom;
11152: &devalidate_cache_new('crschange',$hashid);
11153: }
11154:
1.31 www 11155: # ------------------------------------------------- Update symbolic store links
11156:
11157: sub symblist {
11158: my ($mapname,%newhash)=@_;
1.438 www 11159: $mapname=&deversion(&declutter($mapname));
1.31 www 11160: my %hash;
1.620 albertel 11161: if (($env{'request.course.fn'}) && (%newhash)) {
11162: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 11163: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 11164: foreach my $url (keys(%newhash)) {
1.711 albertel 11165: next if ($url eq 'last_known'
11166: && $env{'form.no_update_last_known'});
11167: $hash{declutter($url)}=&encode_symb($mapname,
11168: $newhash{$url}->[1],
11169: $newhash{$url}->[0]);
1.191 harris41 11170: }
1.31 www 11171: if (untie(%hash)) {
11172: return 'ok';
11173: }
11174: }
11175: }
11176: return 'error';
1.212 www 11177: }
11178:
11179: # --------------------------------------------------------------- Verify a symb
11180:
11181: sub symbverify {
1.1190 raeburn 11182: my ($symb,$thisurl,$encstate)=@_;
1.510 www 11183: my $thisfn=$thisurl;
1.439 www 11184: $thisfn=&declutter($thisfn);
1.215 www 11185: # direct jump to resource in page or to a sequence - will construct own symbs
11186: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
11187: # check URL part
1.409 www 11188: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 11189:
1.431 www 11190: unless ($url eq $thisfn) { return 0; }
1.213 www 11191:
1.216 www 11192: $symb=&symbclean($symb);
1.510 www 11193: $thisurl=&deversion($thisurl);
1.439 www 11194: $thisfn=&deversion($thisfn);
1.213 www 11195:
11196: my %bighash;
11197: my $okay=0;
1.431 www 11198:
1.620 albertel 11199: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 11200: &GDBM_READER(),0640)) {
1.1204 raeburn 11201: my $noclutter;
1.1032 raeburn 11202: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
11203: $thisurl =~ s/\?.+$//;
1.1204 raeburn 11204: if ($map =~ m{^uploaded/.+\.page$}) {
11205: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
11206: $thisurl =~ s{^\Qhttp://https://\E}{https://};
11207: $noclutter = 1;
11208: }
11209: }
11210: my $ids;
11211: if ($noclutter) {
11212: $ids=$bighash{'ids_'.$thisurl};
11213: } else {
11214: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 11215: }
1.1102 raeburn 11216: unless ($ids) {
11217: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
11218: $ids=$bighash{$idkey};
1.216 www 11219: }
11220: if ($ids) {
11221: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 11222: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 11223: $symb =~ s/\?.+$//;
1.1202 raeburn 11224: }
1.800 albertel 11225: foreach my $id (split(/\,/,$ids)) {
11226: my ($mapid,$resid)=split(/\./,$id);
1.216 www 11227: if (
11228: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 11229: eq $symb) {
11230: if (ref($encstate)) {
11231: $$encstate = $bighash{'encrypted_'.$id};
11232: }
1.620 albertel 11233: if (($env{'request.role.adv'}) ||
1.1101 raeburn 11234: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
11235: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 11236: $okay=1;
1.1202 raeburn 11237: last;
1.582 albertel 11238: }
11239: }
1.216 www 11240: }
11241: }
1.213 www 11242: untie(%bighash);
11243: }
11244: return $okay;
1.31 www 11245: }
11246:
1.210 www 11247: # --------------------------------------------------------------- Clean-up symb
11248:
11249: sub symbclean {
11250: my $symb=shift;
1.568 albertel 11251: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 11252: # remove version from map
11253: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 11254:
1.210 www 11255: # remove version from URL
11256: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 11257:
1.507 www 11258: # remove wrapper
11259:
1.510 www 11260: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 11261: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 11262: return $symb;
1.409 www 11263: }
11264:
11265: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 11266:
11267: sub encode_symb {
11268: my ($map,$resid,$url)=@_;
11269: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
11270: }
1.409 www 11271:
11272: sub decode_symb {
1.568 albertel 11273: my $symb=shift;
11274: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
11275: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 11276: return (&fixversion($map),$resid,&fixversion($url));
11277: }
11278:
11279: sub fixversion {
11280: my $fn=shift;
1.609 banghart 11281: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 11282: my %bighash;
11283: my $uri=&clutter($fn);
1.620 albertel 11284: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 11285: # is this cached?
1.599 albertel 11286: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 11287: if (defined($cached)) { return $result; }
11288: # unfortunately not cached, or expired
1.620 albertel 11289: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 11290: &GDBM_READER(),0640)) {
11291: if ($bighash{'version_'.$uri}) {
11292: my $version=$bighash{'version_'.$uri};
1.444 www 11293: unless (($version eq 'mostrecent') ||
11294: ($version==&getversion($uri))) {
1.440 www 11295: $uri=~s/\.(\w+)$/\.$version\.$1/;
11296: }
11297: }
11298: untie %bighash;
1.413 www 11299: }
1.599 albertel 11300: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 11301: }
11302:
11303: sub deversion {
11304: my $url=shift;
11305: $url=~s/\.\d+\.(\w+)$/\.$1/;
11306: return $url;
1.210 www 11307: }
11308:
1.31 www 11309: # ------------------------------------------------------ Return symb list entry
11310:
11311: sub symbread {
1.1282 raeburn 11312: my ($thisfn,$donotrecurse,$ignorecachednull,$checkforblock,$possibles)=@_;
1.1265 raeburn 11313: my $cache_str='request.symbread.cached.'.$thisfn;
1.1282 raeburn 11314: if (defined($env{$cache_str})) {
11315: if ($ignorecachednull) {
11316: return $env{$cache_str} unless ($env{$cache_str} eq '');
11317: } else {
11318: return $env{$cache_str};
11319: }
11320: }
1.242 www 11321: # no filename provided? try from environment
1.1265 raeburn 11322: unless ($thisfn) {
1.620 albertel 11323: if ($env{'request.symb'}) {
11324: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 11325: }
1.620 albertel 11326: $thisfn=$env{'request.filename'};
1.44 www 11327: }
1.569 albertel 11328: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 11329: # is that filename actually a symb? Verify, clean, and return
11330: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 11331: if (&symbverify($thisfn,$1)) {
1.620 albertel 11332: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 11333: }
1.242 www 11334: }
1.44 www 11335: $thisfn=declutter($thisfn);
1.31 www 11336: my %hash;
1.37 www 11337: my %bighash;
11338: my $syval='';
1.620 albertel 11339: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 11340: my $targetfn = $thisfn;
1.609 banghart 11341: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 11342: $targetfn = 'adm/wrapper/'.$thisfn;
11343: }
1.687 albertel 11344: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
11345: $targetfn=$1;
11346: }
1.620 albertel 11347: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 11348: &GDBM_READER(),0640)) {
1.481 raeburn 11349: $syval=$hash{$targetfn};
1.37 www 11350: untie(%hash);
11351: }
11352: # ---------------------------------------------------------- There was an entry
11353: if ($syval) {
1.601 albertel 11354: #unless ($syval=~/\_\d+$/) {
1.620 albertel 11355: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 11356: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 11357: #return $env{$cache_str}='';
1.601 albertel 11358: #}
11359: #$syval.=$1;
11360: #}
1.37 www 11361: } else {
11362: # ------------------------------------------------------- Was not in symb table
1.620 albertel 11363: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 11364: &GDBM_READER(),0640)) {
1.37 www 11365: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 11366: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 11367: unless ($ids) {
11368: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 11369: }
11370: unless ($ids) {
11371: # alias?
11372: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 11373: }
1.37 www 11374: if ($ids) {
11375: # ------------------------------------------------------------------- Has ID(s)
11376: my @possibilities=split(/\,/,$ids);
1.39 www 11377: if ($#possibilities==0) {
11378: # ----------------------------------------------- There is only one possibility
1.37 www 11379: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 11380: $syval=&encode_symb($bighash{'map_id_'.$mapid},
11381: $resid,$thisfn);
1.1282 raeburn 11382: if (ref($possibles) eq 'HASH') {
11383: $possibles->{$syval} = 1;
11384: }
11385: if ($checkforblock) {
11386: my @blockers = &has_comm_blocking('bre',$syval,$bighash{'src_'.$ids});
11387: if (@blockers) {
11388: $syval = '';
11389: return;
11390: }
11391: }
11392: } elsif ((!$donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
1.39 www 11393: # ------------------------------------------ There is more than one possibility
11394: my $realpossible=0;
1.800 albertel 11395: foreach my $id (@possibilities) {
11396: my $file=$bighash{'src_'.$id};
1.1282 raeburn 11397: my $canaccess;
11398: if (($donotrecurse) || ($checkforblock) || (ref($possibles) eq 'HASH')) {
11399: $canaccess = 1;
11400: } else {
11401: $canaccess = &allowed('bre',$file);
11402: }
11403: if ($canaccess) {
11404: my ($mapid,$resid)=split(/\./,$id);
11405: if ($bighash{'map_type_'.$mapid} ne 'page') {
11406: my $poss_syval=&encode_symb($bighash{'map_id_'.$mapid},
11407: $resid,$thisfn);
11408: if (ref($possibles) eq 'HASH') {
11409: $possibles->{$syval} = 1;
11410: }
11411: if ($checkforblock) {
11412: my @blockers = &has_comm_blocking('bre',$poss_syval,$file);
11413: unless (@blockers > 0) {
11414: $syval = $poss_syval;
11415: $realpossible++;
11416: }
11417: } else {
11418: $syval = $poss_syval;
11419: $realpossible++;
11420: }
11421: }
1.39 www 11422: }
1.191 harris41 11423: }
1.39 www 11424: if ($realpossible!=1) { $syval=''; }
1.249 www 11425: } else {
11426: $syval='';
1.37 www 11427: }
11428: }
1.1282 raeburn 11429: untie(%bighash);
1.481 raeburn 11430: }
1.31 www 11431: }
1.62 www 11432: if ($syval) {
1.620 albertel 11433: return $env{$cache_str}=$syval;
1.62 www 11434: }
1.31 www 11435: }
1.949 raeburn 11436: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 11437: return $env{$cache_str}='';
1.31 www 11438: }
11439:
11440: # ---------------------------------------------------------- Return random seed
11441:
1.32 www 11442: sub numval {
11443: my $txt=shift;
11444: $txt=~tr/A-J/0-9/;
11445: $txt=~tr/a-j/0-9/;
11446: $txt=~tr/K-T/0-9/;
11447: $txt=~tr/k-t/0-9/;
11448: $txt=~tr/U-Z/0-5/;
11449: $txt=~tr/u-z/0-5/;
11450: $txt=~s/\D//g;
1.564 albertel 11451: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 11452: return int($txt);
1.368 albertel 11453: }
11454:
1.484 albertel 11455: sub numval2 {
11456: my $txt=shift;
11457: $txt=~tr/A-J/0-9/;
11458: $txt=~tr/a-j/0-9/;
11459: $txt=~tr/K-T/0-9/;
11460: $txt=~tr/k-t/0-9/;
11461: $txt=~tr/U-Z/0-5/;
11462: $txt=~tr/u-z/0-5/;
11463: $txt=~s/\D//g;
11464: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11465: my $total;
11466: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 11467: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 11468: return int($total);
11469: }
11470:
1.575 albertel 11471: sub numval3 {
11472: use integer;
11473: my $txt=shift;
11474: $txt=~tr/A-J/0-9/;
11475: $txt=~tr/a-j/0-9/;
11476: $txt=~tr/K-T/0-9/;
11477: $txt=~tr/k-t/0-9/;
11478: $txt=~tr/U-Z/0-5/;
11479: $txt=~tr/u-z/0-5/;
11480: $txt=~s/\D//g;
11481: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
11482: my $total;
11483: foreach my $val (@txts) { $total+=$val; }
11484: if ($_64bit) { $total=(($total<<32)>>32); }
11485: return $total;
11486: }
11487:
1.675 albertel 11488: sub digest {
11489: my ($data)=@_;
11490: my $digest=&Digest::MD5::md5($data);
11491: my ($a,$b,$c,$d)=unpack("iiii",$digest);
11492: my ($e,$f);
11493: {
11494: use integer;
11495: $e=($a+$b);
11496: $f=($c+$d);
11497: if ($_64bit) {
11498: $e=(($e<<32)>>32);
11499: $f=(($f<<32)>>32);
11500: }
11501: }
11502: if (wantarray) {
11503: return ($e,$f);
11504: } else {
11505: my $g;
11506: {
11507: use integer;
11508: $g=($e+$f);
11509: if ($_64bit) {
11510: $g=(($g<<32)>>32);
11511: }
11512: }
11513: return $g;
11514: }
11515: }
11516:
1.368 albertel 11517: sub latest_rnd_algorithm_id {
1.675 albertel 11518: return '64bit5';
1.366 albertel 11519: }
1.32 www 11520:
1.503 albertel 11521: sub get_rand_alg {
11522: my ($courseid)=@_;
1.790 albertel 11523: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 11524: if ($courseid) {
1.620 albertel 11525: return $env{"course.$courseid.rndseed"};
1.503 albertel 11526: }
11527: return &latest_rnd_algorithm_id();
11528: }
11529:
1.562 albertel 11530: sub validCODE {
11531: my ($CODE)=@_;
11532: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
11533: return 0;
11534: }
11535:
1.491 albertel 11536: sub getCODE {
1.620 albertel 11537: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 11538: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
11539: defined($Apache::lonhomework::parsing_a_task) ) &&
11540: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 11541: return $Apache::lonhomework::history{'resource.CODE'};
11542: }
11543: return undef;
11544: }
1.1133 foxr 11545: #
11546: # Determines the random seed for a specific context:
11547: #
11548: # parameters:
11549: # symb - in course context the symb for the seed.
11550: # course_id - The course id of the form domain_coursenum.
11551: # domain - Domain for the user.
11552: # course - Course for the user.
11553: # cenv - environment of the course.
11554: #
11555: # NOTE:
11556: # All parameters are picked out of the environment if missing
11557: # or not defined.
11558: # If a symb cannot be determined the current time is used instead.
11559: #
11560: # For a given well defined symb, courside, domain, username,
11561: # and course environment, the seed is reproducible.
11562: #
1.31 www 11563: sub rndseed {
1.1133 foxr 11564: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 11565: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 11566: if (!defined($symb)) {
1.366 albertel 11567: unless ($symb=$wsymb) { return time; }
11568: }
1.1146 foxr 11569: if (!defined $courseid) {
11570: $courseid=$wcourseid;
11571: }
11572: if (!defined $domain) { $domain=$wdomain; }
11573: if (!defined $username) { $username=$wusername }
1.1133 foxr 11574:
11575: my $which;
11576: if (defined($cenv->{'rndseed'})) {
11577: $which = $cenv->{'rndseed'};
11578: } else {
11579: $which =&get_rand_alg($courseid);
11580: }
1.491 albertel 11581: if (defined(&getCODE())) {
1.1133 foxr 11582:
1.675 albertel 11583: if ($which eq '64bit5') {
11584: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
11585: } elsif ($which eq '64bit4') {
1.575 albertel 11586: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
11587: } else {
11588: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
11589: }
1.675 albertel 11590: } elsif ($which eq '64bit5') {
11591: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 11592: } elsif ($which eq '64bit4') {
11593: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 11594: } elsif ($which eq '64bit3') {
11595: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 11596: } elsif ($which eq '64bit2') {
11597: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 11598: } elsif ($which eq '64bit') {
11599: return &rndseed_64bit($symb,$courseid,$domain,$username);
11600: }
11601: return &rndseed_32bit($symb,$courseid,$domain,$username);
11602: }
11603:
11604: sub rndseed_32bit {
11605: my ($symb,$courseid,$domain,$username)=@_;
11606: {
11607: use integer;
11608: my $symbchck=unpack("%32C*",$symb) << 27;
11609: my $symbseed=numval($symb) << 22;
11610: my $namechck=unpack("%32C*",$username) << 17;
11611: my $nameseed=numval($username) << 12;
11612: my $domainseed=unpack("%32C*",$domain) << 7;
11613: my $courseseed=unpack("%32C*",$courseid);
11614: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 11615: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11616: #&logthis("rndseed :$num:$symb");
1.564 albertel 11617: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 11618: return $num;
11619: }
11620: }
11621:
11622: sub rndseed_64bit {
11623: my ($symb,$courseid,$domain,$username)=@_;
11624: {
11625: use integer;
11626: my $symbchck=unpack("%32S*",$symb) << 21;
11627: my $symbseed=numval($symb) << 10;
11628: my $namechck=unpack("%32S*",$username);
11629:
11630: my $nameseed=numval($username) << 21;
11631: my $domainseed=unpack("%32S*",$domain) << 10;
11632: my $courseseed=unpack("%32S*",$courseid);
11633:
11634: my $num1=$symbchck+$symbseed+$namechck;
11635: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11636: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11637: #&logthis("rndseed :$num:$symb");
1.564 albertel 11638: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 11639: return "$num1,$num2";
1.155 albertel 11640: }
1.366 albertel 11641: }
11642:
1.443 albertel 11643: sub rndseed_64bit2 {
11644: my ($symb,$courseid,$domain,$username)=@_;
11645: {
11646: use integer;
11647: # strings need to be an even # of cahracters long, it it is odd the
11648: # last characters gets thrown away
11649: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11650: my $symbseed=numval($symb) << 10;
11651: my $namechck=unpack("%32S*",$username.' ');
11652:
11653: my $nameseed=numval($username) << 21;
1.501 albertel 11654: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11655: my $courseseed=unpack("%32S*",$courseid.' ');
11656:
11657: my $num1=$symbchck+$symbseed+$namechck;
11658: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11659: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11660: #&logthis("rndseed :$num:$symb");
1.803 albertel 11661: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 11662: return "$num1,$num2";
11663: }
11664: }
11665:
11666: sub rndseed_64bit3 {
11667: my ($symb,$courseid,$domain,$username)=@_;
11668: {
11669: use integer;
11670: # strings need to be an even # of cahracters long, it it is odd the
11671: # last characters gets thrown away
11672: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11673: my $symbseed=numval2($symb) << 10;
11674: my $namechck=unpack("%32S*",$username.' ');
11675:
11676: my $nameseed=numval2($username) << 21;
1.443 albertel 11677: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11678: my $courseseed=unpack("%32S*",$courseid.' ');
11679:
11680: my $num1=$symbchck+$symbseed+$namechck;
11681: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11682: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11683: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 11684: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 11685:
1.503 albertel 11686: return "$num1:$num2";
1.443 albertel 11687: }
11688: }
11689:
1.575 albertel 11690: sub rndseed_64bit4 {
11691: my ($symb,$courseid,$domain,$username)=@_;
11692: {
11693: use integer;
11694: # strings need to be an even # of cahracters long, it it is odd the
11695: # last characters gets thrown away
11696: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11697: my $symbseed=numval3($symb) << 10;
11698: my $namechck=unpack("%32S*",$username.' ');
11699:
11700: my $nameseed=numval3($username) << 21;
11701: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11702: my $courseseed=unpack("%32S*",$courseid.' ');
11703:
11704: my $num1=$symbchck+$symbseed+$namechck;
11705: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11706: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11707: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 11708: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 11709:
1.575 albertel 11710: return "$num1:$num2";
11711: }
11712: }
11713:
1.675 albertel 11714: sub rndseed_64bit5 {
11715: my ($symb,$courseid,$domain,$username)=@_;
11716: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
11717: return "$num1:$num2";
11718: }
11719:
1.366 albertel 11720: sub rndseed_CODE_64bit {
11721: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 11722: {
1.366 albertel 11723: use integer;
1.443 albertel 11724: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 11725: my $symbseed=numval2($symb);
1.491 albertel 11726: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11727: my $CODEseed=numval(&getCODE());
1.443 albertel 11728: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 11729: my $num1=$symbseed+$CODEchck;
11730: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 11731: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11732: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 11733: if ($_64bit) { $num1=(($num1<<32)>>32); }
11734: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 11735: return "$num1:$num2";
1.366 albertel 11736: }
11737: }
11738:
1.575 albertel 11739: sub rndseed_CODE_64bit4 {
11740: my ($symb,$courseid,$domain,$username)=@_;
11741: {
11742: use integer;
11743: my $symbchck=unpack("%32S*",$symb.' ') << 16;
11744: my $symbseed=numval3($symb);
11745: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11746: my $CODEseed=numval3(&getCODE());
11747: my $courseseed=unpack("%32S*",$courseid.' ');
11748: my $num1=$symbseed+$CODEchck;
11749: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 11750: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11751: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 11752: if ($_64bit) { $num1=(($num1<<32)>>32); }
11753: if ($_64bit) { $num2=(($num2<<32)>>32); }
11754: return "$num1:$num2";
11755: }
11756: }
11757:
1.675 albertel 11758: sub rndseed_CODE_64bit5 {
11759: my ($symb,$courseid,$domain,$username)=@_;
11760: my $code = &getCODE();
11761: my ($num1,$num2)=&digest("$symb,$courseid,$code");
11762: return "$num1:$num2";
11763: }
11764:
1.366 albertel 11765: sub setup_random_from_rndseed {
11766: my ($rndseed)=@_;
1.503 albertel 11767: if ($rndseed =~/([,:])/) {
1.1262 raeburn 11768: my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
11769: if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
11770: &Math::Random::random_set_seed_from_phrase($rndseed);
11771: } else {
11772: &Math::Random::random_set_seed($num1,$num2);
11773: }
1.366 albertel 11774: } else {
11775: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 11776: }
1.36 albertel 11777: }
11778:
1.474 albertel 11779: sub latest_receipt_algorithm_id {
1.835 albertel 11780: return 'receipt3';
1.474 albertel 11781: }
11782:
1.480 www 11783: sub recunique {
11784: my $fucourseid=shift;
11785: my $unique;
1.835 albertel 11786: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
11787: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 11788: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 11789: } else {
11790: $unique=$perlvar{'lonReceipt'};
11791: }
11792: return unpack("%32C*",$unique);
11793: }
11794:
11795: sub recprefix {
11796: my $fucourseid=shift;
11797: my $prefix;
1.835 albertel 11798: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
11799: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 11800: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 11801: } else {
11802: $prefix=$perlvar{'lonHostID'};
11803: }
11804: return unpack("%32C*",$prefix);
11805: }
11806:
1.76 www 11807: sub ireceipt {
1.474 albertel 11808: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 11809:
11810: my $return =&recprefix($fucourseid).'-';
11811:
11812: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
11813: $env{'request.state'} eq 'construct') {
11814: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
11815: return $return;
11816: }
11817:
1.76 www 11818: my $cuname=unpack("%32C*",$funame);
11819: my $cudom=unpack("%32C*",$fudom);
11820: my $cucourseid=unpack("%32C*",$fucourseid);
11821: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 11822: my $cunique=&recunique($fucourseid);
1.474 albertel 11823: my $cpart=unpack("%32S*",$part);
1.835 albertel 11824: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
11825:
1.790 albertel 11826: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 11827:
11828: $return.= ($cunique%$cuname+
11829: $cunique%$cudom+
11830: $cusymb%$cuname+
11831: $cusymb%$cudom+
11832: $cucourseid%$cuname+
11833: $cucourseid%$cudom+
11834: $cpart%$cuname+
11835: $cpart%$cudom);
11836: } else {
11837: $return.= ($cunique%$cuname+
11838: $cunique%$cudom+
11839: $cusymb%$cuname+
11840: $cusymb%$cudom+
11841: $cucourseid%$cuname+
11842: $cucourseid%$cudom);
11843: }
11844: return $return;
1.76 www 11845: }
11846:
11847: sub receipt {
1.474 albertel 11848: my ($part)=@_;
1.790 albertel 11849: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 11850: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 11851: }
1.260 ng 11852:
1.790 albertel 11853: sub whichuser {
11854: my ($passedsymb)=@_;
11855: my ($symb,$courseid,$domain,$name,$publicuser);
11856: if (defined($env{'form.grade_symb'})) {
11857: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
11858: my $allowed=&allowed('vgr',$tmp_courseid);
11859: if (!$allowed &&
11860: exists($env{'request.course.sec'}) &&
11861: $env{'request.course.sec'} !~ /^\s*$/) {
11862: $allowed=&allowed('vgr',$tmp_courseid.
11863: '/'.$env{'request.course.sec'});
11864: }
11865: if ($allowed) {
11866: ($symb)=&get_env_multiple('form.grade_symb');
11867: $courseid=$tmp_courseid;
11868: ($domain)=&get_env_multiple('form.grade_domain');
11869: ($name)=&get_env_multiple('form.grade_username');
11870: return ($symb,$courseid,$domain,$name,$publicuser);
11871: }
11872: }
11873: if (!$passedsymb) {
11874: $symb=&symbread();
11875: } else {
11876: $symb=$passedsymb;
11877: }
11878: $courseid=$env{'request.course.id'};
11879: $domain=$env{'user.domain'};
11880: $name=$env{'user.name'};
11881: if ($name eq 'public' && $domain eq 'public') {
11882: if (!defined($env{'form.username'})) {
11883: $env{'form.username'}.=time.rand(10000000);
11884: }
11885: $name.=$env{'form.username'};
11886: }
11887: return ($symb,$courseid,$domain,$name,$publicuser);
11888:
11889: }
11890:
1.36 albertel 11891: # ------------------------------------------------------------ Serves up a file
1.472 albertel 11892: # returns either the contents of the file or
11893: # -1 if the file doesn't exist
1.481 raeburn 11894: #
11895: # if the target is a file that was uploaded via DOCS,
11896: # a check will be made to see if a current copy exists on the local server,
11897: # if it does this will be served, otherwise a copy will be retrieved from
11898: # the home server for the course and stored in /home/httpd/html/userfiles on
11899: # the local server.
1.472 albertel 11900:
1.36 albertel 11901: sub getfile {
1.538 albertel 11902: my ($file) = @_;
1.609 banghart 11903: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 11904: &repcopy($file);
11905: return &readfile($file);
11906: }
11907:
11908: sub repcopy_userfile {
11909: my ($file)=@_;
1.1142 raeburn 11910: my $londocroot = $perlvar{'lonDocRoot'};
11911: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 11912: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 11913: my ($cdom,$cnum,$filename) =
1.811 albertel 11914: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 11915: my $uri="/uploaded/$cdom/$cnum/$filename";
11916: if (-e "$file") {
1.828 www 11917: # we already have a local copy, check it out
1.538 albertel 11918: my @fileinfo = stat($file);
1.828 www 11919: my $rtncode;
11920: my $info;
1.538 albertel 11921: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 11922: if ($lwpresp ne 'ok') {
1.828 www 11923: # there is no such file anymore, even though we had a local copy
1.482 albertel 11924: if ($rtncode eq '404') {
1.538 albertel 11925: unlink($file);
1.482 albertel 11926: }
11927: return -1;
11928: }
11929: if ($info < $fileinfo[9]) {
1.828 www 11930: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 11931: return 'ok';
1.828 www 11932: } else {
11933: # the file is outdated, get rid of it
11934: unlink($file);
1.482 albertel 11935: }
1.828 www 11936: }
11937: # one way or the other, at this point, we don't have the file
11938: # construct the correct path for the file
11939: my @parts = ($cdom,$cnum);
11940: if ($filename =~ m|^(.+)/[^/]+$|) {
11941: push @parts, split(/\//,$1);
11942: }
11943: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
11944: foreach my $part (@parts) {
11945: $path .= '/'.$part;
11946: if (!-e $path) {
11947: mkdir($path,0770);
1.482 albertel 11948: }
11949: }
1.828 www 11950: # now the path exists for sure
11951: # get a user agent
11952: my $ua=new LWP::UserAgent;
11953: my $transferfile=$file.'.in.transfer';
11954: # FIXME: this should flock
11955: if (-e $transferfile) { return 'ok'; }
11956: my $request;
11957: $uri=~s/^\///;
1.980 raeburn 11958: my $homeserver = &homeserver($cnum,$cdom);
11959: my $protocol = $protocol{$homeserver};
11960: $protocol = 'http' if ($protocol ne 'https');
11961: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 11962: my $response=$ua->request($request,$transferfile);
11963: # did it work?
11964: if ($response->is_error()) {
11965: unlink($transferfile);
11966: &logthis("Userfile repcopy failed for $uri");
11967: return -1;
11968: }
11969: # worked, rename the transfer file
11970: rename($transferfile,$file);
1.607 raeburn 11971: return 'ok';
1.481 raeburn 11972: }
11973:
1.517 albertel 11974: sub tokenwrapper {
11975: my $uri=shift;
1.980 raeburn 11976: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 11977: $uri=~s|^/||;
1.620 albertel 11978: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 11979: my $token=$1;
1.552 albertel 11980: my (undef,$udom,$uname,$file)=split('/',$uri,4);
11981: if ($udom && $uname && $file) {
11982: $file=~s|(\?\.*)*$||;
1.949 raeburn 11983: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 11984: my $homeserver = &homeserver($uname,$udom);
11985: my $protocol = $protocol{$homeserver};
11986: $protocol = 'http' if ($protocol ne 'https');
11987: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 11988: (($uri=~/\?/)?'&':'?').'token='.$token.
11989: '&tokenissued='.$perlvar{'lonHostID'};
11990: } else {
11991: return '/adm/notfound.html';
11992: }
11993: }
11994:
1.828 www 11995: # call with reqtype HEAD: get last modification time
11996: # call with reqtype GET: get the file contents
11997: # Do not call this with reqtype GET for large files! It loads everything into memory
11998: #
1.481 raeburn 11999: sub getuploaded {
12000: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
12001: $uri=~s/^\///;
1.980 raeburn 12002: my $homeserver = &homeserver($cnum,$cdom);
12003: my $protocol = $protocol{$homeserver};
12004: $protocol = 'http' if ($protocol ne 'https');
12005: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 12006: my $ua=new LWP::UserAgent;
12007: my $request=new HTTP::Request($reqtype,$uri);
12008: my $response=$ua->request($request);
12009: $$rtncode = $response->code;
1.482 albertel 12010: if (! $response->is_success()) {
12011: return 'failed';
12012: }
12013: if ($reqtype eq 'HEAD') {
1.486 www 12014: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 12015: } elsif ($reqtype eq 'GET') {
12016: $$info = $response->content;
1.472 albertel 12017: }
1.482 albertel 12018: return 'ok';
1.36 albertel 12019: }
12020:
1.481 raeburn 12021: sub readfile {
12022: my $file = shift;
12023: if ( (! -e $file ) || ($file eq '') ) { return -1; };
12024: my $fh;
12025: open($fh,"<$file");
12026: my $a='';
1.800 albertel 12027: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 12028: return $a;
12029: }
12030:
1.36 albertel 12031: sub filelocation {
1.590 banghart 12032: my ($dir,$file) = @_;
12033: my $location;
12034: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 12035:
12036: if ($file =~ m-^/adm/-) {
12037: $file=~s-^/adm/wrapper/-/-;
12038: $file=~s-^/adm/coursedocs/showdoc/-/-;
12039: }
1.882 albertel 12040:
1.1139 www 12041: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 12042: $location = $file;
1.609 banghart 12043: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 12044: my ($udom,$uname,$filename)=
1.811 albertel 12045: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 12046: my $home=&homeserver($uname,$udom);
12047: my $is_me=0;
12048: my @ids=¤t_machine_ids();
12049: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
12050: if ($is_me) {
1.1117 foxr 12051: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 12052: } else {
12053: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
12054: $udom.'/'.$uname.'/'.$filename;
12055: }
1.882 albertel 12056: } elsif ($file =~ m-^/adm/-) {
12057: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 12058: } else {
12059: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 12060: $file=~s:^/(res|priv)/:/:;
12061: my $space=$1;
1.590 banghart 12062: if ( !( $file =~ m:^/:) ) {
12063: $location = $dir. '/'.$file;
12064: } else {
1.1142 raeburn 12065: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 12066: }
1.59 albertel 12067: }
1.590 banghart 12068: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 12069: while ($location=~m{/\.\./}) {
12070: if ($location =~ m{/[^/]+/\.\./}) {
12071: $location=~ s{/[^/]+/\.\./}{/}g;
12072: } else {
12073: $location=~ s{/\.\./}{/}g;
12074: }
12075: } #remove dir/..
1.590 banghart 12076: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
12077: return $location;
1.46 www 12078: }
1.36 albertel 12079:
1.46 www 12080: sub hreflocation {
12081: my ($dir,$file)=@_;
1.980 raeburn 12082: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 12083: $file=filelocation($dir,$file);
1.700 albertel 12084: } elsif ($file=~m-^/adm/-) {
12085: $file=~s-^/adm/wrapper/-/-;
12086: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 12087: }
12088: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
12089: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
12090: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 12091: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
12092: {/uploaded/$1/$2/}x;
1.46 www 12093: }
1.913 albertel 12094: if ($file=~ m{^/userfiles/}) {
12095: $file =~ s{^/userfiles/}{/uploaded/};
12096: }
1.462 albertel 12097: return $file;
1.465 albertel 12098: }
12099:
1.1139 www 12100:
12101:
12102:
12103:
1.465 albertel 12104: sub current_machine_domains {
1.853 albertel 12105: return &machine_domains(&hostname($perlvar{'lonHostID'}));
12106: }
12107:
12108: sub machine_domains {
12109: my ($hostname) = @_;
1.465 albertel 12110: my @domains;
1.838 albertel 12111: my %hostname = &all_hostnames();
1.465 albertel 12112: while( my($id, $name) = each(%hostname)) {
1.467 matthew 12113: # &logthis("-$id-$name-$hostname-");
1.465 albertel 12114: if ($hostname eq $name) {
1.844 albertel 12115: push(@domains,&host_domain($id));
1.465 albertel 12116: }
12117: }
12118: return @domains;
12119: }
12120:
12121: sub current_machine_ids {
1.853 albertel 12122: return &machine_ids(&hostname($perlvar{'lonHostID'}));
12123: }
12124:
12125: sub machine_ids {
12126: my ($hostname) = @_;
12127: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 12128: my @ids;
1.888 albertel 12129: my %name_to_host = &all_names();
1.889 albertel 12130: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
12131: return @{ $name_to_host{$hostname} };
12132: }
12133: return;
1.31 www 12134: }
12135:
1.824 raeburn 12136: sub additional_machine_domains {
12137: my @domains;
12138: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
12139: while( my $line = <$fh>) {
12140: $line =~ s/\s//g;
12141: push(@domains,$line);
12142: }
12143: return @domains;
12144: }
12145:
12146: sub default_login_domain {
12147: my $domain = $perlvar{'lonDefDomain'};
12148: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
12149: foreach my $posdom (¤t_machine_domains(),
12150: &additional_machine_domains()) {
12151: if (lc($posdom) eq lc($testdomain)) {
12152: $domain=$posdom;
12153: last;
12154: }
12155: }
12156: return $domain;
12157: }
12158:
1.31 www 12159: # ------------------------------------------------------------- Declutters URLs
12160:
12161: sub declutter {
12162: my $thisfn=shift;
1.569 albertel 12163: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.1261 raeburn 12164: unless ($thisfn=~m{^/home/httpd/html/priv/}) {
12165: $thisfn=~s{^/home/httpd/html}{};
12166: }
1.31 www 12167: $thisfn=~s/^\///;
1.697 albertel 12168: $thisfn=~s|^adm/wrapper/||;
12169: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 12170: $thisfn=~s/^res\///;
1.1172 bisitz 12171: $thisfn=~s/^priv\///;
1.1032 raeburn 12172: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
12173: $thisfn=~s/\?.+$//;
12174: }
1.268 www 12175: return $thisfn;
12176: }
12177:
12178: # ------------------------------------------------------------- Clutter up URLs
12179:
12180: sub clutter {
12181: my $thisfn='/'.&declutter(shift);
1.887 albertel 12182: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 12183: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 12184: $thisfn='/res'.$thisfn;
12185: }
1.1031 raeburn 12186: if ($thisfn !~m|^/adm|) {
12187: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 12188: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 12189: } else {
12190: my ($ext) = ($thisfn =~ /\.(\w+)$/);
12191: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 12192: if ($embstyle eq 'ssi'
12193: || ($embstyle eq 'hdn')
12194: || ($embstyle eq 'rat')
12195: || ($embstyle eq 'prv')
12196: || ($embstyle eq 'ign')) {
12197: #do nothing with these
12198: } elsif (($embstyle eq 'img')
1.695 albertel 12199: || ($embstyle eq 'emb')
12200: || ($embstyle eq 'wrp')) {
12201: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 12202: } elsif ($embstyle eq 'unk'
12203: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 12204: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 12205: } else {
1.718 www 12206: # &logthis("Got a blank emb style");
1.695 albertel 12207: }
1.694 albertel 12208: }
12209: }
1.31 www 12210: return $thisfn;
1.12 www 12211: }
12212:
1.787 albertel 12213: sub clutter_with_no_wrapper {
12214: my $uri = &clutter(shift);
12215: if ($uri =~ m-^/adm/-) {
12216: $uri =~ s-^/adm/wrapper/-/-;
12217: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
12218: }
12219: return $uri;
12220: }
12221:
1.557 albertel 12222: sub freeze_escape {
12223: my ($value)=@_;
12224: if (ref($value)) {
12225: $value=&nfreeze($value);
12226: return '__FROZEN__'.&escape($value);
12227: }
12228: return &escape($value);
12229: }
12230:
1.11 www 12231:
1.557 albertel 12232: sub thaw_unescape {
12233: my ($value)=@_;
12234: if ($value =~ /^__FROZEN__/) {
12235: substr($value,0,10,undef);
12236: $value=&unescape($value);
12237: return &thaw($value);
12238: }
12239: return &unescape($value);
12240: }
12241:
1.436 albertel 12242: sub correct_line_ends {
12243: my ($result)=@_;
12244: $$result =~s/\r\n/\n/mg;
12245: $$result =~s/\r/\n/mg;
1.415 albertel 12246: }
1.1 albertel 12247: # ================================================================ Main Program
12248:
1.184 www 12249: sub goodbye {
1.204 albertel 12250: &logthis("Starting Shut down");
1.443 albertel 12251: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 12252: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 12253: #converted
1.599 albertel 12254: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 12255: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
12256: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
12257: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 12258: #1.1 only
1.870 albertel 12259: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
12260: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
12261: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
12262: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
12263: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 12264: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
12265: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 12266: &flushcourselogs();
12267: &logthis("Shutting down");
12268: }
12269:
1.852 albertel 12270: sub get_dns {
1.1210 raeburn 12271: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 12272: if (!$ignore_cache) {
12273: my ($content,$cached)=
12274: &Apache::lonnet::is_cached_new('dns',$url);
12275: if ($cached) {
1.1210 raeburn 12276: &$func($content,$hashref);
1.869 albertel 12277: return;
12278: }
12279: }
12280:
12281: my %alldns;
1.852 albertel 12282: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12283: foreach my $dns (<$config>) {
12284: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 12285: my $line = $1;
12286: my ($host,$protocol) = split(/:/,$line);
12287: if ($protocol ne 'https') {
12288: $protocol = 'http';
12289: }
12290: $alldns{$host} = $protocol;
1.869 albertel 12291: }
12292: while (%alldns) {
1.1263 raeburn 12293: my ($dns) = sort { $b cmp $a } keys(%alldns);
1.852 albertel 12294: my $ua=new LWP::UserAgent;
1.1134 raeburn 12295: $ua->timeout(30);
1.979 raeburn 12296: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 12297: my $response=$ua->request($request);
1.979 raeburn 12298: delete($alldns{$dns});
1.852 albertel 12299: next if ($response->is_error());
12300: my @content = split("\n",$response->content);
1.1210 raeburn 12301: unless ($nocache) {
1.1219 raeburn 12302: &do_cache_new('dns',$url,\@content,30*24*60*60);
1.1210 raeburn 12303: }
12304: &$func(\@content,$hashref);
1.869 albertel 12305: return;
1.852 albertel 12306: }
12307: close($config);
1.871 albertel 12308: my $which = (split('/',$url))[3];
12309: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
12310: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 12311: my @content = <$config>;
1.1210 raeburn 12312: &$func(\@content,$hashref);
12313: return;
12314: }
12315:
12316: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 12317: sub parse_dns_checksums_tab {
1.1210 raeburn 12318: my ($lines,$hashref) = @_;
1.1264 raeburn 12319: my $lonhost = $perlvar{'lonHostID'};
12320: my $machine_dom = &Apache::lonnet::host_domain($lonhost);
1.1210 raeburn 12321: my $loncaparev = &get_server_loncaparev($machine_dom);
1.1264 raeburn 12322: my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
12323: my $webconfdir = '/etc/httpd/conf';
12324: if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
12325: $webconfdir = '/etc/apache2';
12326: } elsif ($distro =~ /^sles(\d+)$/) {
12327: if ($1 >= 10) {
12328: $webconfdir = '/etc/apache2';
12329: }
12330: } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
12331: if ($1 >= 10.0) {
12332: $webconfdir = '/etc/apache2';
12333: }
12334: }
1.1210 raeburn 12335: my ($release,$timestamp) = split(/\-/,$loncaparev);
12336: my (%chksum,%revnum);
12337: if (ref($lines) eq 'ARRAY') {
12338: chomp(@{$lines});
1.1238 raeburn 12339: my $version = shift(@{$lines});
12340: if ($version eq $release) {
1.1210 raeburn 12341: foreach my $line (@{$lines}) {
1.1238 raeburn 12342: my ($file,$version,$shasum) = split(/,/,$line);
1.1264 raeburn 12343: if ($file =~ m{^/etc/httpd/conf}) {
12344: if ($webconfdir eq '/etc/apache2') {
12345: $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
12346: }
12347: }
1.1238 raeburn 12348: $chksum{$file} = $shasum;
12349: $revnum{$file} = $version;
1.1210 raeburn 12350: }
12351: if (ref($hashref) eq 'HASH') {
12352: %{$hashref} = (
12353: sums => \%chksum,
12354: versions => \%revnum,
12355: );
12356: }
12357: }
12358: }
1.869 albertel 12359: return;
1.852 albertel 12360: }
1.1210 raeburn 12361:
12362: sub fetch_dns_checksums {
1.1238 raeburn 12363: my %checksums;
12364: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
1.1260 raeburn 12365: my $loncaparev = &get_server_loncaparev($machine_dom,$perlvar{'lonHostID'});
1.1238 raeburn 12366: my ($release,$timestamp) = split(/\-/,$loncaparev);
12367: &get_dns("/adm/dns/checksums/$release",\&parse_dns_checksums_tab,1,1,
1.1211 raeburn 12368: \%checksums);
1.1210 raeburn 12369: return \%checksums;
12370: }
12371:
1.327 albertel 12372: # ------------------------------------------------------------ Read domain file
12373: {
1.852 albertel 12374: my $loaded;
1.846 albertel 12375: my %domain;
12376:
1.852 albertel 12377: sub parse_domain_tab {
12378: my ($lines) = @_;
12379: foreach my $line (@$lines) {
12380: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 12381:
1.846 albertel 12382: chomp($line);
1.852 albertel 12383: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 12384: my %this_domain;
12385: foreach my $field ('description', 'auth_def', 'auth_arg_def',
12386: 'lang_def', 'city', 'longi', 'lati',
12387: 'primary') {
12388: $this_domain{$field} = shift(@elements);
12389: }
12390: $domain{$name} = \%this_domain;
1.852 albertel 12391: }
12392: }
1.864 albertel 12393:
12394: sub reset_domain_info {
12395: undef($loaded);
12396: undef(%domain);
12397: }
12398:
1.852 albertel 12399: sub load_domain_tab {
1.1293 raeburn 12400: my ($ignore_cache,$nocache) = @_;
12401: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache,$nocache);
1.852 albertel 12402: my $fh;
12403: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
12404: my @lines = <$fh>;
12405: &parse_domain_tab(\@lines);
1.448 albertel 12406: }
1.852 albertel 12407: close($fh);
12408: $loaded = 1;
1.327 albertel 12409: }
1.846 albertel 12410:
12411: sub domain {
1.852 albertel 12412: &load_domain_tab() if (!$loaded);
12413:
1.846 albertel 12414: my ($name,$what) = @_;
12415: return if ( !exists($domain{$name}) );
12416:
12417: if (!$what) {
12418: return $domain{$name}{'description'};
12419: }
12420: return $domain{$name}{$what};
12421: }
1.974 raeburn 12422:
12423: sub domain_info {
12424: &load_domain_tab() if (!$loaded);
12425: return %domain;
12426: }
12427:
1.327 albertel 12428: }
12429:
12430:
1.1 albertel 12431: # ------------------------------------------------------------- Read hosts file
12432: {
1.838 albertel 12433: my %hostname;
1.844 albertel 12434: my %hostdom;
1.845 albertel 12435: my %libserv;
1.852 albertel 12436: my $loaded;
1.888 albertel 12437: my %name_to_host;
1.1074 raeburn 12438: my %internetdom;
1.1107 raeburn 12439: my %LC_dns_serv;
1.852 albertel 12440:
12441: sub parse_hosts_tab {
12442: my ($file) = @_;
12443: foreach my $configline (@$file) {
12444: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 12445: chomp($configline);
12446: if ($configline =~ /^\^/) {
12447: if ($configline =~ /^\^([\w.\-]+)/) {
12448: $LC_dns_serv{$1} = 1;
12449: }
12450: next;
12451: }
1.1074 raeburn 12452: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 12453: $name=~s/\s//g;
12454: if ($id && $domain && $role && $name) {
12455: $hostname{$id}=$name;
1.888 albertel 12456: push(@{$name_to_host{$name}}, $id);
1.852 albertel 12457: $hostdom{$id}=$domain;
12458: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 12459: if (defined($protocol)) {
12460: if ($protocol eq 'https') {
12461: $protocol{$id} = $protocol;
12462: } else {
12463: $protocol{$id} = 'http';
12464: }
1.968 raeburn 12465: } else {
1.969 raeburn 12466: $protocol{$id} = 'http';
1.968 raeburn 12467: }
1.1074 raeburn 12468: if (defined($intdom)) {
12469: $internetdom{$id} = $intdom;
12470: }
1.852 albertel 12471: }
12472: }
12473: }
1.864 albertel 12474:
12475: sub reset_hosts_info {
1.897 albertel 12476: &purge_remembered();
1.864 albertel 12477: &reset_domain_info();
12478: &reset_hosts_ip_info();
1.892 albertel 12479: undef(%name_to_host);
1.864 albertel 12480: undef(%hostname);
12481: undef(%hostdom);
12482: undef(%libserv);
12483: undef($loaded);
12484: }
1.1 albertel 12485:
1.852 albertel 12486: sub load_hosts_tab {
1.1293 raeburn 12487: my ($ignore_cache,$nocache) = @_;
12488: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache,$nocache);
1.852 albertel 12489: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
12490: my @config = <$config>;
12491: &parse_hosts_tab(\@config);
12492: close($config);
12493: $loaded=1;
1.1 albertel 12494: }
1.852 albertel 12495:
1.838 albertel 12496: sub hostname {
1.852 albertel 12497: &load_hosts_tab() if (!$loaded);
12498:
1.838 albertel 12499: my ($lonid) = @_;
12500: return $hostname{$lonid};
12501: }
1.845 albertel 12502:
1.838 albertel 12503: sub all_hostnames {
1.852 albertel 12504: &load_hosts_tab() if (!$loaded);
12505:
1.838 albertel 12506: return %hostname;
12507: }
1.845 albertel 12508:
1.888 albertel 12509: sub all_names {
1.1293 raeburn 12510: my ($ignore_cache,$nocache) = @_;
12511: &load_hosts_tab($ignore_cache,$nocache) if (!$loaded);
1.888 albertel 12512:
12513: return %name_to_host;
12514: }
12515:
1.974 raeburn 12516: sub all_host_domain {
12517: &load_hosts_tab() if (!$loaded);
12518: return %hostdom;
12519: }
12520:
1.845 albertel 12521: sub is_library {
1.852 albertel 12522: &load_hosts_tab() if (!$loaded);
12523:
1.845 albertel 12524: return exists($libserv{$_[0]});
12525: }
12526:
12527: sub all_library {
1.852 albertel 12528: &load_hosts_tab() if (!$loaded);
12529:
1.845 albertel 12530: return %libserv;
12531: }
12532:
1.1062 droeschl 12533: sub unique_library {
12534: #2x reverse removes all hostnames that appear more than once
12535: my %unique = reverse &all_library();
12536: return reverse %unique;
12537: }
12538:
1.841 albertel 12539: sub get_servers {
1.852 albertel 12540: &load_hosts_tab() if (!$loaded);
12541:
1.841 albertel 12542: my ($domain,$type) = @_;
12543: my %possible_hosts = ($type eq 'library') ? %libserv
12544: : %hostname;
12545: my %result;
1.842 albertel 12546: if (ref($domain) eq 'ARRAY') {
12547: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 12548: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 12549: $result{$host} = $hostname;
12550: }
12551: }
12552: } else {
12553: while ( my ($host,$hostname) = each(%possible_hosts)) {
12554: if ($hostdom{$host} eq $domain) {
12555: $result{$host} = $hostname;
12556: }
1.841 albertel 12557: }
12558: }
12559: return %result;
12560: }
1.845 albertel 12561:
1.1062 droeschl 12562: sub get_unique_servers {
12563: my %unique = reverse &get_servers(@_);
12564: return reverse %unique;
12565: }
12566:
1.844 albertel 12567: sub host_domain {
1.852 albertel 12568: &load_hosts_tab() if (!$loaded);
12569:
1.844 albertel 12570: my ($lonid) = @_;
12571: return $hostdom{$lonid};
12572: }
12573:
1.841 albertel 12574: sub all_domains {
1.852 albertel 12575: &load_hosts_tab() if (!$loaded);
12576:
1.841 albertel 12577: my %seen;
12578: my @uniq = grep(!$seen{$_}++, values(%hostdom));
12579: return @uniq;
12580: }
1.1074 raeburn 12581:
12582: sub internet_dom {
12583: &load_hosts_tab() if (!$loaded);
12584:
12585: my ($lonid) = @_;
12586: return $internetdom{$lonid};
12587: }
1.1107 raeburn 12588:
12589: sub is_LC_dns {
12590: &load_hosts_tab() if (!$loaded);
12591:
12592: my ($hostname) = @_;
12593: return exists($LC_dns_serv{$hostname});
12594: }
12595:
1.1 albertel 12596: }
12597:
1.847 albertel 12598: {
12599: my %iphost;
1.856 albertel 12600: my %name_to_ip;
12601: my %lonid_to_ip;
1.869 albertel 12602:
1.847 albertel 12603: sub get_hosts_from_ip {
12604: my ($ip) = @_;
12605: my %iphosts = &get_iphost();
12606: if (ref($iphosts{$ip})) {
12607: return @{$iphosts{$ip}};
12608: }
12609: return;
1.839 albertel 12610: }
1.864 albertel 12611:
12612: sub reset_hosts_ip_info {
12613: undef(%iphost);
12614: undef(%name_to_ip);
12615: undef(%lonid_to_ip);
12616: }
1.856 albertel 12617:
12618: sub get_host_ip {
12619: my ($lonid) = @_;
12620: if (exists($lonid_to_ip{$lonid})) {
12621: return $lonid_to_ip{$lonid};
12622: }
12623: my $name=&hostname($lonid);
12624: my $ip = gethostbyname($name);
12625: return if (!$ip || length($ip) ne 4);
12626: $ip=inet_ntoa($ip);
12627: $name_to_ip{$name} = $ip;
12628: $lonid_to_ip{$lonid} = $ip;
12629: return $ip;
12630: }
1.847 albertel 12631:
12632: sub get_iphost {
1.1293 raeburn 12633: my ($ignore_cache,$nocache) = @_;
1.894 albertel 12634:
1.869 albertel 12635: if (!$ignore_cache) {
12636: if (%iphost) {
12637: return %iphost;
12638: }
12639: my ($ip_info,$cached)=
12640: &Apache::lonnet::is_cached_new('iphost','iphost');
12641: if ($cached) {
12642: %iphost = %{$ip_info->[0]};
12643: %name_to_ip = %{$ip_info->[1]};
12644: %lonid_to_ip = %{$ip_info->[2]};
12645: return %iphost;
12646: }
12647: }
1.894 albertel 12648:
12649: # get yesterday's info for fallback
12650: my %old_name_to_ip;
12651: my ($ip_info,$cached)=
12652: &Apache::lonnet::is_cached_new('iphost','iphost');
12653: if ($cached) {
12654: %old_name_to_ip = %{$ip_info->[1]};
12655: }
12656:
1.1293 raeburn 12657: my %name_to_host = &all_names($ignore_cache,$nocache);
1.888 albertel 12658: foreach my $name (keys(%name_to_host)) {
1.847 albertel 12659: my $ip;
12660: if (!exists($name_to_ip{$name})) {
12661: $ip = gethostbyname($name);
12662: if (!$ip || length($ip) ne 4) {
1.894 albertel 12663: if (defined($old_name_to_ip{$name})) {
12664: $ip = $old_name_to_ip{$name};
12665: &logthis("Can't find $name defaulting to old $ip");
12666: } else {
12667: &logthis("Name $name no IP found");
12668: next;
12669: }
12670: } else {
12671: $ip=inet_ntoa($ip);
1.847 albertel 12672: }
12673: $name_to_ip{$name} = $ip;
12674: } else {
12675: $ip = $name_to_ip{$name};
1.653 albertel 12676: }
1.888 albertel 12677: foreach my $id (@{ $name_to_host{$name} }) {
12678: $lonid_to_ip{$id} = $ip;
12679: }
12680: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 12681: }
1.1293 raeburn 12682: unless ($nocache) {
12683: &do_cache_new('iphost','iphost',
12684: [\%iphost,\%name_to_ip,\%lonid_to_ip],
12685: 48*60*60);
12686: }
1.869 albertel 12687:
1.847 albertel 12688: return %iphost;
1.598 albertel 12689: }
12690:
1.992 raeburn 12691: #
12692: # Given a DNS returns the loncapa host name for that DNS
12693: #
12694: sub host_from_dns {
12695: my ($dns) = @_;
12696: my @hosts;
12697: my $ip;
12698:
1.993 raeburn 12699: if (exists($name_to_ip{$dns})) {
1.992 raeburn 12700: $ip = $name_to_ip{$dns};
12701: }
12702: if (!$ip) {
12703: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
12704: if (length($ip) == 4) {
12705: $ip = &IO::Socket::inet_ntoa($ip);
12706: }
12707: }
12708: if ($ip) {
12709: @hosts = get_hosts_from_ip($ip);
12710: return $hosts[0];
12711: }
12712: return undef;
1.986 foxr 12713: }
1.992 raeburn 12714:
1.1074 raeburn 12715: sub get_internet_names {
12716: my ($lonid) = @_;
12717: return if ($lonid eq '');
12718: my ($idnref,$cached)=
12719: &Apache::lonnet::is_cached_new('internetnames',$lonid);
12720: if ($cached) {
12721: return $idnref;
12722: }
12723: my $ip = &get_host_ip($lonid);
12724: my @hosts = &get_hosts_from_ip($ip);
12725: my %iphost = &get_iphost();
12726: my (@idns,%seen);
12727: foreach my $id (@hosts) {
12728: my $dom = &host_domain($id);
12729: my $prim_id = &domain($dom,'primary');
12730: my $prim_ip = &get_host_ip($prim_id);
12731: next if ($seen{$prim_ip});
12732: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
12733: foreach my $id (@{$iphost{$prim_ip}}) {
12734: my $intdom = &internet_dom($id);
12735: unless (grep(/^\Q$intdom\E$/,@idns)) {
12736: push(@idns,$intdom);
12737: }
12738: }
12739: }
12740: $seen{$prim_ip} = 1;
12741: }
1.1219 raeburn 12742: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 12743: }
12744:
1.986 foxr 12745: }
12746:
1.1079 raeburn 12747: sub all_loncaparevs {
1.1249 raeburn 12748: return qw(1.1 1.2 1.3 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11);
1.1079 raeburn 12749: }
12750:
1.1227 raeburn 12751: # ---------------------------------------------------------- Read loncaparev table
12752: {
12753: sub load_loncaparevs {
12754: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
12755: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
12756: while (my $configline=<$config>) {
12757: chomp($configline);
12758: my ($hostid,$loncaparev)=split(/:/,$configline);
12759: $loncaparevs{$hostid}=$loncaparev;
12760: }
12761: close($config);
12762: }
12763: }
12764: }
12765: }
12766:
12767: # ---------------------------------------------------------- Read serverhostID table
12768: {
12769: sub load_serverhomeIDs {
12770: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
12771: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
12772: while (my $configline=<$config>) {
12773: chomp($configline);
12774: my ($name,$id)=split(/:/,$configline);
12775: $serverhomeIDs{$name}=$id;
12776: }
12777: close($config);
12778: }
12779: }
12780: }
12781: }
12782:
12783:
1.862 albertel 12784: BEGIN {
12785:
12786: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
12787: unless ($readit) {
12788: {
12789: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
12790: %perlvar = (%perlvar,%{$configvars});
12791: }
12792:
12793:
1.1 albertel 12794: # ------------------------------------------------------ Read spare server file
12795: {
1.448 albertel 12796: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 12797:
12798: while (my $configline=<$config>) {
12799: chomp($configline);
1.284 matthew 12800: if ($configline) {
1.784 albertel 12801: my ($host,$type) = split(':',$configline,2);
1.785 albertel 12802: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 12803: push(@{ $spareid{$type} }, $host);
1.1 albertel 12804: }
12805: }
1.448 albertel 12806: close($config);
1.1 albertel 12807: }
1.11 www 12808: # ------------------------------------------------------------ Read permissions
12809: {
1.448 albertel 12810: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 12811:
12812: while (my $configline=<$config>) {
1.448 albertel 12813: chomp($configline);
12814: if ($configline) {
12815: my ($role,$perm)=split(/ /,$configline);
12816: if ($perm ne '') { $pr{$role}=$perm; }
12817: }
1.11 www 12818: }
1.448 albertel 12819: close($config);
1.11 www 12820: }
12821:
12822: # -------------------------------------------- Read plain texts for permissions
12823: {
1.448 albertel 12824: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 12825:
12826: while (my $configline=<$config>) {
1.448 albertel 12827: chomp($configline);
12828: if ($configline) {
1.742 raeburn 12829: my ($short,@plain)=split(/:/,$configline);
12830: %{$prp{$short}} = ();
12831: if (@plain > 0) {
12832: $prp{$short}{'std'} = $plain[0];
12833: for (my $i=1; $i<@plain; $i++) {
12834: $prp{$short}{'alt'.$i} = $plain[$i];
12835: }
12836: }
1.448 albertel 12837: }
1.135 www 12838: }
1.448 albertel 12839: close($config);
1.135 www 12840: }
12841:
12842: # ---------------------------------------------------------- Read package table
12843: {
1.448 albertel 12844: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 12845:
12846: while (my $configline=<$config>) {
1.483 albertel 12847: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 12848: chomp($configline);
12849: my ($short,$plain)=split(/:/,$configline);
12850: my ($pack,$name)=split(/\&/,$short);
12851: if ($plain ne '') {
12852: $packagetab{$pack.'&'.$name.'&name'}=$name;
12853: $packagetab{$short}=$plain;
12854: }
1.11 www 12855: }
1.448 albertel 12856: close($config);
1.329 matthew 12857: }
12858:
1.1073 raeburn 12859: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 12860:
12861: &load_loncaparevs();
1.1073 raeburn 12862:
1.1074 raeburn 12863: # ---------------------------------------------------------- Read serverhostID table
12864:
1.1227 raeburn 12865: &load_serverhomeIDs();
12866:
12867: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 12868: {
12869: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
12870: if (-e $file) {
12871: my $parser = HTML::LCParser->new($file);
12872: while (my $token = $parser->get_token()) {
12873: if ($token->[0] eq 'S') {
12874: my $item = $token->[1];
12875: my $name = $token->[2]{'name'};
12876: my $value = $token->[2]{'value'};
1.1285 raeburn 12877: my $valuematch = $token->[2]{'valuematch'};
12878: if ($item ne '' && $name ne '' && ($value ne '' || $valuematch ne '')) {
1.1079 raeburn 12879: my $release = $parser->get_text();
12880: $release =~ s/(^\s*|\s*$ )//gx;
1.1285 raeburn 12881: $needsrelease{$item.':'.$name.':'.$value.':'.$valuematch} = $release;
1.1079 raeburn 12882: }
12883: }
12884: }
12885: }
1.1073 raeburn 12886: }
12887:
1.1138 raeburn 12888: # ---------------------------------------------------------- Read managers table
12889: {
12890: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
12891: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
12892: while (my $configline=<$config>) {
12893: chomp($configline);
12894: next if ($configline =~ /^\#/);
12895: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
12896: $managerstab{$configline} = 1;
12897: }
12898: }
12899: close($config);
12900: }
12901: }
12902: }
12903:
1.329 matthew 12904: # ------------- set up temporary directory
12905: {
1.1117 foxr 12906: $tmpdir = LONCAPA::tempdir();
1.329 matthew 12907:
1.11 www 12908: }
12909:
1.794 albertel 12910: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
12911: 'compress_threshold'=> 20_000,
12912: });
1.185 www 12913:
1.281 www 12914: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 12915: $dumpcount=0;
1.958 www 12916: $locknum=0;
1.22 www 12917:
1.163 harris41 12918: &logtouch();
1.672 albertel 12919: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 12920: $readit=1;
1.564 albertel 12921: {
12922: use integer;
12923: my $test=(2**32)+1;
1.568 albertel 12924: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 12925: &logthis(" Detected 64bit platform ($_64bit)");
12926: }
1.195 www 12927: }
1.1 albertel 12928: }
1.179 www 12929:
1.1 albertel 12930: 1;
1.191 harris41 12931: __END__
12932:
1.243 albertel 12933: =pod
12934:
1.191 harris41 12935: =head1 NAME
12936:
1.243 albertel 12937: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 12938:
12939: =head1 SYNOPSIS
12940:
1.243 albertel 12941: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 12942:
12943: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
12944:
1.243 albertel 12945: Common parameters:
12946:
12947: =over 4
12948:
12949: =item *
12950:
12951: $uname : an internal username (if $cname expecting a course Id specifically)
12952:
12953: =item *
12954:
12955: $udom : a domain (if $cdom expecting a course's domain specifically)
12956:
12957: =item *
12958:
12959: $symb : a resource instance identifier
12960:
12961: =item *
12962:
12963: $namespace : the name of a .db file that contains the data needed or
12964: being set.
12965:
12966: =back
12967:
1.394 bowersj2 12968: =head1 OVERVIEW
1.191 harris41 12969:
1.394 bowersj2 12970: lonnet provides subroutines which interact with the
12971: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
12972: about classes, users, and resources.
1.243 albertel 12973:
12974: For many of these objects you can also use this to store data about
12975: them or modify them in various ways.
1.191 harris41 12976:
1.394 bowersj2 12977: =head2 Symbs
1.191 harris41 12978:
1.394 bowersj2 12979: To identify a specific instance of a resource, LON-CAPA uses symbols
12980: or "symbs"X<symb>. These identifiers are built from the URL of the
12981: map, the resource number of the resource in the map, and the URL of
12982: the resource itself. The latter is somewhat redundant, but might help
12983: if maps change.
12984:
12985: An example is
12986:
12987: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
12988:
12989: The respective map entry is
12990:
12991: <resource id="19" src="/res/msu/korte/tests/part12.problem"
12992: title="Problem 2">
12993: </resource>
12994:
12995: Symbs are used by the random number generator, as well as to store and
12996: restore data specific to a certain instance of for example a problem.
12997:
12998: =head2 Storing And Retrieving Data
12999:
13000: X<store()>X<cstore()>X<restore()>Three of the most important functions
13001: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
13002: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
13003: is is the non-critical message twin of cstore. These functions are for
13004: handlers to store a perl hash to a user's permanent data space in an
13005: easy manner, and to retrieve it again on another call. It is expected
13006: that a handler would use this once at the beginning to retrieve data,
13007: and then again once at the end to send only the new data back.
13008:
13009: The data is stored in the user's data directory on the user's
13010: homeserver under the ID of the course.
13011:
13012: The hash that is returned by restore will have all of the previous
13013: value for all of the elements of the hash.
13014:
13015: Example:
13016:
13017: #creating a hash
13018: my %hash;
13019: $hash{'foo'}='bar';
13020:
13021: #storing it
13022: &Apache::lonnet::cstore(\%hash);
13023:
13024: #changing a value
13025: $hash{'foo'}='notbar';
13026:
13027: #adding a new value
13028: $hash{'bar'}='foo';
13029: &Apache::lonnet::cstore(\%hash);
13030:
13031: #retrieving the hash
13032: my %history=&Apache::lonnet::restore();
13033:
13034: #print the hash
13035: foreach my $key (sort(keys(%history))) {
13036: print("\%history{$key} = $history{$key}");
13037: }
13038:
13039: Will print out:
1.191 harris41 13040:
1.394 bowersj2 13041: %history{1:foo} = bar
13042: %history{1:keys} = foo:timestamp
13043: %history{1:timestamp} = 990455579
13044: %history{2:bar} = foo
13045: %history{2:foo} = notbar
13046: %history{2:keys} = foo:bar:timestamp
13047: %history{2:timestamp} = 990455580
13048: %history{bar} = foo
13049: %history{foo} = notbar
13050: %history{timestamp} = 990455580
13051: %history{version} = 2
13052:
13053: Note that the special hash entries C<keys>, C<version> and
13054: C<timestamp> were added to the hash. C<version> will be equal to the
13055: total number of versions of the data that have been stored. The
13056: C<timestamp> attribute will be the UNIX time the hash was
13057: stored. C<keys> is available in every historical section to list which
13058: keys were added or changed at a specific historical revision of a
13059: hash.
13060:
13061: B<Warning>: do not store the hash that restore returns directly. This
13062: will cause a mess since it will restore the historical keys as if the
13063: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 13064:
1.394 bowersj2 13065: Calling convention:
1.191 harris41 13066:
1.1225 raeburn 13067: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
1.1269 raeburn 13068: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
1.191 harris41 13069:
1.394 bowersj2 13070: For more detailed information, see lonnet specific documentation.
1.191 harris41 13071:
1.394 bowersj2 13072: =head1 RETURN MESSAGES
1.191 harris41 13073:
1.394 bowersj2 13074: =over 4
1.191 harris41 13075:
1.394 bowersj2 13076: =item * B<con_lost>: unable to contact remote host
1.191 harris41 13077:
1.394 bowersj2 13078: =item * B<con_delayed>: unable to contact remote host, message will be delivered
13079: when the connection is brought back up
1.191 harris41 13080:
1.394 bowersj2 13081: =item * B<con_failed>: unable to contact remote host and unable to save message
13082: for later delivery
1.191 harris41 13083:
1.967 bisitz 13084: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 13085:
1.394 bowersj2 13086: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 13087: that was requested
1.191 harris41 13088:
1.243 albertel 13089: =back
1.191 harris41 13090:
1.243 albertel 13091: =head1 PUBLIC SUBROUTINES
1.191 harris41 13092:
1.243 albertel 13093: =head2 Session Environment Functions
1.191 harris41 13094:
1.243 albertel 13095: =over 4
1.191 harris41 13096:
1.394 bowersj2 13097: =item *
13098: X<appenv()>
1.949 raeburn 13099: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 13100: the user envirnoment file, and will be restored for each access this
1.620 albertel 13101: user makes during this session, also modifies the %env for the current
1.949 raeburn 13102: process. Optional rolesarrayref - if defined contains a reference to an array
13103: of roles which are exempt from the restriction on modifying user.role entries
13104: in the user's environment.db and in %env.
1.191 harris41 13105:
13106: =item *
1.394 bowersj2 13107: X<delenv()>
1.987 raeburn 13108: B<delenv($delthis,$regexp)>: removes all items from the session
13109: environment file that begin with $delthis. If the
13110: optional second arg - $regexp - is true, $delthis is treated as a
13111: regular expression, otherwise \Q$delthis\E is used.
13112: The values are also deleted from the current processes %env.
1.191 harris41 13113:
1.795 albertel 13114: =item * get_env_multiple($name)
13115:
13116: gets $name from the %env hash, it seemlessly handles the cases where multiple
13117: values may be defined and end up as an array ref.
13118:
13119: returns an array of values
13120:
1.243 albertel 13121: =back
13122:
13123: =head2 User Information
1.191 harris41 13124:
1.243 albertel 13125: =over 4
1.191 harris41 13126:
13127: =item *
1.394 bowersj2 13128: X<queryauthenticate()>
13129: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 13130: authentication scheme
13131:
13132: =item *
1.394 bowersj2 13133: X<authenticate()>
1.1073 raeburn 13134: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 13135: authenticate user from domain's lib servers (first use the current
13136: one). C<$upass> should be the users password.
1.1073 raeburn 13137: $checkdefauth is optional (value is 1 if a check should be made to
13138: authenticate user using default authentication method, and allow
13139: account creation if username does not have account in the domain).
13140: $clientcancheckhost is optional (value is 1 if checking whether the
13141: server can host will occur on the client side in lonauth.pm).
1.191 harris41 13142:
13143: =item *
1.394 bowersj2 13144: X<homeserver()>
13145: B<homeserver($uname,$udom)>: find the server which has
13146: the user's directory and files (there must be only one), this caches
13147: the answer, and also caches if there is a borken connection.
1.191 harris41 13148:
13149: =item *
1.394 bowersj2 13150: X<idget()>
13151: B<idget($udom,@ids)>: find the usernames behind a list of IDs
13152: (IDs are a unique resource in a domain, there must be only 1 ID per
13153: username, and only 1 username per ID in a specific domain) (returns
13154: hash: id=>name,id=>name)
1.191 harris41 13155:
13156: =item *
1.394 bowersj2 13157: X<idrget()>
13158: B<idrget($udom,@unames)>: find the IDs behind a list of
13159: usernames (returns hash: name=>id,name=>id)
1.191 harris41 13160:
13161: =item *
1.394 bowersj2 13162: X<idput()>
13163: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 13164:
13165: =item *
1.394 bowersj2 13166: X<rolesinit()>
1.1169 droeschl 13167: B<rolesinit($udom,$username)>: get user privileges.
13168: returns user role, first access and timer interval hashes
1.243 albertel 13169:
13170: =item *
1.1171 droeschl 13171: X<privileged()>
13172: B<privileged($username,$domain)>: returns a true if user has a
13173: privileged and active role (i.e. su or dc), false otherwise.
13174:
13175: =item *
1.551 albertel 13176: X<getsection()>
13177: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 13178: course $cname, return section name/number or '' for "not in course"
13179: and '-1' for "no section"
13180:
13181: =item *
1.394 bowersj2 13182: X<userenvironment()>
13183: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 13184: passed in @what from the requested user's environment, returns a hash
13185:
1.858 raeburn 13186: =item *
13187: X<userlog_query()>
1.859 albertel 13188: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
13189: activity.log file. %filters defines filters applied when parsing the
13190: log file. These can be start or end timestamps, or the type of action
13191: - log to look for Login or Logout events, check for Checkin or
13192: Checkout, role for role selection. The response is in the form
13193: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
13194: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 13195:
1.243 albertel 13196: =back
13197:
13198: =head2 User Roles
13199:
13200: =over 4
13201:
13202: =item *
13203:
1.1284 raeburn 13204: allowed($priv,$uri,$symb,$role,$clientip,$noblockcheck) : check for a user privilege;
13205: returns codes for allowed actions.
13206:
13207: The first argument is required, all others are optional.
13208:
13209: $priv is the privilege being checked.
13210: $uri contains additional information about what is being checked for access (e.g.,
13211: URL, course ID etc.).
13212: $symb is the unique resource instance identifier in a course; if needed,
13213: but not provided, it will be retrieved via a call to &symbread().
13214: $role is the role for which a priv is being checked (only used if priv is evb).
13215: $clientip is the user's IP address (only used when checking for access to portfolio
13216: files).
13217: $noblockcheck, if true, skips calls to &has_comm_blocking() for the bre priv. This
13218: prevents recursive calls to &allowed.
13219:
1.243 albertel 13220: F: full access
13221: U,I,K: authentication modes (cxx only)
13222: '': forbidden
13223: 1: user needs to choose course
13224: 2: browse allowed
1.766 albertel 13225: A: passphrase authentication needed
1.1284 raeburn 13226: B: access temporarily blocked because of a blocking event in a course.
1.243 albertel 13227:
13228: =item *
13229:
1.1192 raeburn 13230: constructaccess($url,$setpriv) : check for access to construction space URL
13231:
13232: See if the owner domain and name in the URL match those in the
13233: expected environment. If so, return three element list
13234: ($ownername,$ownerdomain,$ownerhome).
13235:
13236: Otherwise return the null string.
13237:
13238: If second argument 'setpriv' is true, it assigns the privileges,
13239: and returns the same three element list, unless the owner has
13240: blocked "ad hoc" Domain Coordinator access to the Author Space,
13241: in which case the null string is returned.
13242:
13243: =item *
13244:
1.243 albertel 13245: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
13246: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
13247: and course level
13248:
13249: =item *
13250:
1.988 raeburn 13251: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
13252: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 13253: $type is Course (default) or Community.
1.988 raeburn 13254: If $forcedefault evaluates to true, text returned will be default
13255: text for $type. Otherwise, if this is a course, the text returned
13256: will be a custom name for the role (if defined in the course's
13257: environment). If no custom name is defined the default is returned.
13258:
1.832 raeburn 13259: =item *
13260:
1.1219 raeburn 13261: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 13262: All arguments are optional. Returns a hash of a roles, either for
13263: co-author/assistant author roles for a user's Construction Space
1.906 albertel 13264: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 13265: In the hash, keys are set to colon-separated $uname,$udom,$role, and
13266: (optionally) if $withsec is true, a fourth colon-separated item - $section.
13267: For each key, value is set to colon-separated start and end times for
13268: the role. If no username and domain are specified, will default to
1.934 raeburn 13269: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 13270: of role statuses (active, future or previous), roles
13271: (e.g., cc,in, st etc.) and domains of the roles which can be used
13272: to restrict the list of roles reported. If no array ref is
13273: provided for types, will default to return only active roles.
1.834 albertel 13274:
1.1195 raeburn 13275: =item *
13276:
13277: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 13278: user: $uname:$udom has a role in the course: $cdom_$cnum.
13279:
13280: Additional optional arguments are: $type (if role checking is to be restricted
13281: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 13282: available roles) or future (roles available in the future), and
13283: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 13284: have active Domain Coordinator role in course's domain or in additional
13285: domains (specified in 'Domains to check for privileged users' in course
13286: environment -- set via: Course Settings -> Classlists and staff listing).
13287:
13288: =item *
13289:
13290: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
13291: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
13292: $possdomains and $possroles are optional array refs -- to domains to check and
13293: roles to check. If $possdomains is not specified, a dump will be done of the
13294: users' roles.db to check for a dc or su role in any domain. This can be
13295: time consuming if &privileged is called repeatedly (e.g., when displaying a
13296: classlist), so in such cases, supplying a $possdomains array is preferred, as
13297: this then allows &privileged_by_domain() to be used, which caches the identity
13298: of privileged users, eliminating the need for repeated calls to &dump().
13299:
13300: =item *
13301:
13302: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
13303: where the outer hash keys are domains specified in the $possdomains array ref,
13304: next inner hash keys are privileged roles specified in the $roles array ref,
13305: and the innermost hash contains key = value pairs for username:domain = end:start
13306: for active or future "privileged" users with that role in that domain. To avoid
13307: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
13308: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 13309:
1.243 albertel 13310: =back
13311:
13312: =head2 User Modification
13313:
13314: =over 4
13315:
13316: =item *
13317:
1.957 raeburn 13318: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 13319: user for the level given by URL. Optional start and end dates (leave empty
13320: string or zero for "no date")
1.191 harris41 13321:
13322: =item *
13323:
1.243 albertel 13324: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
13325: change a users, password, possible return values are: ok,
13326: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
13327: refused
1.191 harris41 13328:
13329: =item *
13330:
1.243 albertel 13331: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 13332:
13333: =item *
13334:
1.1058 raeburn 13335: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
13336: $forceid,$desiredhome,$email,$inststatus,$candelete) :
13337:
13338: will update user information (firstname,middlename,lastname,generation,
13339: permanentemail), and if forceid is true, student/employee ID also.
13340: A user's institutional affiliation(s) can also be updated.
13341: User information fields will not be overwritten with empty entries
13342: unless the field is included in the $candelete array reference.
13343: This array is included when a single user is modified via "Manage Users",
13344: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 13345:
13346: =item *
13347:
1.286 matthew 13348: modifystudent
13349:
1.957 raeburn 13350: modify a student's enrollment and identification information.
1.1235 raeburn 13351: The course id is resolved based on the current user's environment.
13352: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 13353: associated with a course.
13354:
1.297 matthew 13355: This call is essentially a wrapper for lonnet::modifyuser and
13356: lonnet::modify_student_enrollment
1.286 matthew 13357:
13358: Inputs:
13359:
13360: =over 4
13361:
1.957 raeburn 13362: =item B<$udom> Student's loncapa domain
1.286 matthew 13363:
1.957 raeburn 13364: =item B<$uname> Student's loncapa login name
1.286 matthew 13365:
1.964 bisitz 13366: =item B<$uid> Student/Employee ID
1.286 matthew 13367:
1.957 raeburn 13368: =item B<$umode> Student's authentication mode
1.286 matthew 13369:
1.957 raeburn 13370: =item B<$upass> Student's password
1.286 matthew 13371:
1.957 raeburn 13372: =item B<$first> Student's first name
1.286 matthew 13373:
1.957 raeburn 13374: =item B<$middle> Student's middle name
1.286 matthew 13375:
1.957 raeburn 13376: =item B<$last> Student's last name
1.286 matthew 13377:
1.957 raeburn 13378: =item B<$gene> Student's generation
1.286 matthew 13379:
1.957 raeburn 13380: =item B<$usec> Student's section in course
1.286 matthew 13381:
13382: =item B<$end> Unix time of the roles expiration
13383:
13384: =item B<$start> Unix time of the roles start date
13385:
13386: =item B<$forceid> If defined, allow $uid to be changed
13387:
13388: =item B<$desiredhome> server to use as home server for student
13389:
1.957 raeburn 13390: =item B<$email> Student's permanent e-mail address
13391:
13392: =item B<$type> Type of enrollment (auto or manual)
13393:
1.963 raeburn 13394: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
13395:
13396: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 13397:
1.963 raeburn 13398: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 13399:
1.963 raeburn 13400: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 13401:
1.1216 raeburn 13402: =item B<$inststatus> institutional status of user - : separated string of escaped status types
13403:
13404: =item B<$credits> Number of credits student will earn from this class - only needs to be supplied if value needs to be different from default credits for class.
1.957 raeburn 13405:
1.286 matthew 13406: =back
1.297 matthew 13407:
13408: =item *
13409:
13410: modify_student_enrollment
13411:
1.1235 raeburn 13412: Change a student's enrollment status in a class. The environment variable
1.297 matthew 13413: 'role.request.course' must be defined for this function to proceed.
13414:
13415: Inputs:
13416:
13417: =over 4
13418:
1.1235 raeburn 13419: =item $udom, student's domain
1.297 matthew 13420:
1.1235 raeburn 13421: =item $uname, student's name
1.297 matthew 13422:
1.1235 raeburn 13423: =item $uid, student's user id
1.297 matthew 13424:
1.1235 raeburn 13425: =item $first, student's first name
1.297 matthew 13426:
13427: =item $middle
13428:
13429: =item $last
13430:
13431: =item $gene
13432:
13433: =item $usec
13434:
13435: =item $end
13436:
13437: =item $start
13438:
1.957 raeburn 13439: =item $type
13440:
13441: =item $locktype
13442:
13443: =item $cid
13444:
13445: =item $selfenroll
13446:
13447: =item $context
13448:
1.1216 raeburn 13449: =item $credits, number of credits student will earn from this class
13450:
1.297 matthew 13451: =back
13452:
1.191 harris41 13453:
13454: =item *
13455:
1.243 albertel 13456: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
13457: custom role; give a custom role to a user for the level given by URL. Specify
13458: name and domain of role author, and role name
1.191 harris41 13459:
13460: =item *
13461:
1.243 albertel 13462: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 13463:
13464: =item *
13465:
1.243 albertel 13466: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
13467:
13468: =back
13469:
13470: =head2 Course Infomation
13471:
13472: =over 4
1.191 harris41 13473:
13474: =item *
13475:
1.1118 foxr 13476: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 13477: specified course id, including all environment settings for the
13478: course, the description of the course will be in the hash under the
13479: key 'description'
1.191 harris41 13480:
1.1118 foxr 13481: $options is an optional parameter that if supplied is a hash reference that controls
13482: what how this function works. It has the following key/values:
13483:
13484: =over 4
13485:
13486: =item freshen_cache
13487:
13488: If defined, and the environment cache for the course is valid, it is
13489: returned in the returned hash.
13490:
13491: =item one_time
13492:
13493: If defined, the last cache time is set to _now_
13494:
13495: =item user
13496:
13497: If defined, the supplied username is used instead of the current user.
13498:
13499:
13500: =back
13501:
1.191 harris41 13502: =item *
13503:
1.624 albertel 13504: resdata($name,$domain,$type,@which) : request for current parameter
13505: setting for a specific $type, where $type is either 'course' or 'user',
13506: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 13507: answers for 10 minutes.
1.243 albertel 13508:
1.877 foxr 13509: =item *
13510:
13511: get_courseresdata($courseid, $domain) : dump the entire course resource
13512: data base, returning a hash that is keyed by the resource name and has
13513: values that are the resource value. I believe that the timestamps and
13514: versions are also returned.
13515:
1.1236 raeburn 13516: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
13517: supplemental content area. This routine caches the number of files for
13518: 10 minutes.
13519:
1.243 albertel 13520: =back
13521:
13522: =head2 Course Modification
13523:
13524: =over 4
1.191 harris41 13525:
13526: =item *
13527:
1.243 albertel 13528: writecoursepref($courseid,%prefs) : write preferences (environment
13529: database) for a course
1.191 harris41 13530:
13531: =item *
13532:
1.1011 raeburn 13533: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
13534:
13535: =item *
13536:
1.1038 raeburn 13537: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 13538:
1.1167 droeschl 13539: =item *
13540:
13541: is_course($courseid), is_course($cdom, $cnum)
13542:
13543: Accepts either a combined $courseid (in the form of domain_courseid) or the
13544: two component version $cdom, $cnum. It checks if the specified course exists.
13545:
13546: Returns:
13547: undef if the course doesn't exist, otherwise
13548: in scalar context the combined courseid.
13549: in list context the two components of the course identifier, domain and
13550: courseid.
13551:
1.243 albertel 13552: =back
13553:
13554: =head2 Resource Subroutines
13555:
13556: =over 4
1.191 harris41 13557:
13558: =item *
13559:
1.243 albertel 13560: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 13561:
13562: =item *
13563:
1.243 albertel 13564: repcopy($filename) : subscribes to the requested file, and attempts to
13565: replicate from the owning library server, Might return
1.607 raeburn 13566: 'unavailable', 'not_found', 'forbidden', 'ok', or
13567: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 13568: resource. Expects the local filesystem pathname
13569: (/home/httpd/html/res/....)
13570:
13571: =back
13572:
13573: =head2 Resource Information
13574:
13575: =over 4
1.191 harris41 13576:
13577: =item *
13578:
1.1228 raeburn 13579: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
13580: and returns the value of a variety of different possible values,
13581: $varname should be a request string, and the other parameters can be
13582: used to specify who and what one is asking about. Ordinarily, $cid
13583: does not need to be specified, as it is retrived from
13584: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
13585: within lonuserstate::loadmap() when initializing a course, before
13586: $env{'request.course.id'} has been set, so it needs to be provided
13587: in that one case.
1.243 albertel 13588:
13589: Possible values for $varname are environment.lastname (or other item
13590: from the envirnment hash), user.name (or someother aspect about the
13591: user), resource.0.maxtries (or some other part and parameter of a
13592: resource)
1.204 albertel 13593:
13594: =item *
13595:
1.243 albertel 13596: directcondval($number) : get current value of a condition; reads from a state
13597: string
1.204 albertel 13598:
13599: =item *
13600:
1.243 albertel 13601: condval($condidx) : value of condition index based on state
1.204 albertel 13602:
13603: =item *
13604:
1.243 albertel 13605: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
13606: resource's metadata, $what should be either a specific key, or either
13607: 'keys' (to get a list of possible keys) or 'packages' to get a list of
13608: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
13609:
13610: this function automatically caches all requests
1.191 harris41 13611:
13612: =item *
13613:
1.243 albertel 13614: metadata_query($query,$custom,$customshow) : make a metadata query against the
13615: network of library servers; returns file handle of where SQL and regex results
13616: will be stored for query
1.191 harris41 13617:
13618: =item *
13619:
1.1282 raeburn 13620: symbread($filename,$donotrecurse,$ignorecachednull,$checkforblock,$possibles) :
13621: return symbolic list entry (all arguments optional).
13622:
13623: Args: filename is the filename (including path) for the file for which a symb
13624: is required; donotrecurse, if true will prevent calls to allowed() being made
13625: to check access status if more than one resource was found in the bighash
13626: (see rev. 1.249) to avoid an infinite loop if an ambiguous resource is part of
13627: a randompick); ignorecachednull, if true will prevent a symb of '' being
13628: returned if $env{$cache_str} is defined as ''; checkforblock if true will
13629: cause possible symbs to be checked to determine if they are subject to content
13630: blocking, if so they will not be included as possible symbs; possibles is a
13631: ref to a hash, which, as a side effect, will be populated with all possible
13632: symbs (content blocking not tested).
13633:
1.243 albertel 13634: returns the data handle
1.191 harris41 13635:
13636: =item *
13637:
1.1190 raeburn 13638: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
13639: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 13640: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 13641: on failure, user must be in a course, as it assumes the existence of
13642: the course initial hash, and uses $env('request.course.id'}. The third
13643: arg is an optional reference to a scalar. If this arg is passed in the
13644: call to symbverify, it will be set to 1 if the symb has been set to be
13645: encrypted; otherwise it will be null.
1.191 harris41 13646:
13647: =item *
13648:
1.243 albertel 13649: symbclean($symb) : removes versions numbers from a symb, returns the
13650: cleaned symb
1.191 harris41 13651:
13652: =item *
13653:
1.243 albertel 13654: is_on_map($uri) : checks if the $uri is somewhere on the current
13655: course map, user must be in a course for it to work.
1.191 harris41 13656:
13657: =item *
13658:
1.243 albertel 13659: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 13660:
13661: =item *
13662:
1.243 albertel 13663: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13664: a random seed, all arguments are optional, if they aren't sent it uses the
13665: environment to derive them. Note: if symb isn't sent and it can't get one
13666: from &symbread it will use the current time as its return value
1.191 harris41 13667:
13668: =item *
13669:
1.243 albertel 13670: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13671: unfakeable, receipt
1.191 harris41 13672:
13673: =item *
13674:
1.620 albertel 13675: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 13676:
13677: =item *
13678:
1.243 albertel 13679: countacc($url) : count the number of accesses to a given URL
1.191 harris41 13680:
13681: =item *
13682:
1.243 albertel 13683: 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 13684:
13685: =item *
13686:
1.243 albertel 13687: 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 13688:
13689: =item *
13690:
1.243 albertel 13691: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 13692:
13693: =item *
13694:
1.243 albertel 13695: devalidate($symb) : devalidate temporary spreadsheet calculations,
13696: forcing spreadsheet to reevaluate the resource scores next time.
13697:
1.1195 raeburn 13698: =item *
13699:
1.1196 raeburn 13700: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
13701: when viewing in course context.
1.1195 raeburn 13702:
1.1196 raeburn 13703: input: six args -- filename (decluttered), course number, course domain,
13704: url, symb (if registered) and group (if this is a
13705: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 13706:
1.1196 raeburn 13707: output: array of five scalars --
1.1195 raeburn 13708: $cfile -- url for file editing if editable on current server
13709: $home -- homeserver of resource (i.e., for author if published,
13710: or course if uploaded.).
13711: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 13712: $forceedit -- 1 if icon/link should be to go to edit mode
13713: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 13714:
13715: =item *
13716:
13717: is_course_upload($file,$cnum,$cdom)
13718:
13719: Used in course context to determine if current file was uploaded to
13720: the course (i.e., would be found in /userfiles/docs on the course's
13721: homeserver.
13722:
13723: input: 3 args -- filename (decluttered), course number and course domain.
13724: output: boolean -- 1 if file was uploaded.
13725:
1.243 albertel 13726: =back
13727:
13728: =head2 Storing/Retreiving Data
13729:
13730: =over 4
1.191 harris41 13731:
13732: =item *
13733:
1.1269 raeburn 13734: store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
13735: permanently for this url; hashref needs to be given and should be a \%hashname;
13736: the remaining args aren't required and if they aren't passed or are '' they will
13737: be derived from the env (with the exception of $laststore, which is an
13738: optional arg used when a user's submission is stored in grading).
13739: $laststore is $version=$timestamp, where $version is the most recent version
13740: number retrieved for the corresponding $symb in the $namespace db file, and
13741: $timestamp is the timestamp for that transaction (UNIX time).
13742: $laststore is currently only passed when cstore() is called by
13743: structuretags::finalize_storage().
1.191 harris41 13744:
13745: =item *
13746:
1.1269 raeburn 13747: cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
13748: but uses critical subroutine
1.191 harris41 13749:
13750: =item *
13751:
1.243 albertel 13752: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
13753: all args are optional
1.191 harris41 13754:
13755: =item *
13756:
1.717 albertel 13757: dumpstore($namespace,$udom,$uname,$regexp,$range) :
13758: dumps the complete (or key matching regexp) namespace into a hash
13759: ($udom, $uname, $regexp, $range are optional) for a namespace that is
13760: normally &store()ed into
13761:
13762: $range should be either an integer '100' (give me the first 100
13763: matching records)
13764: or be two integers sperated by a - with no spaces
13765: '30-50' (give me the 30th through the 50th matching
13766: records)
13767:
13768:
13769: =item *
13770:
1.1269 raeburn 13771: putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
1.717 albertel 13772: replaces a &store() version of data with a replacement set of data
13773: for a particular resource in a namespace passed in the $storehash hash
1.1269 raeburn 13774: reference. If $tolog is true, the transaction is logged in the courselog
13775: with an action=PUTSTORE.
1.717 albertel 13776:
13777: =item *
13778:
1.243 albertel 13779: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
13780: works very similar to store/cstore, but all data is stored in a
13781: temporary location and can be reset using tmpreset, $storehash should
13782: be a hash reference, returns nothing on success
1.191 harris41 13783:
13784: =item *
13785:
1.243 albertel 13786: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
13787: similar to restore, but all data is stored in a temporary location and
13788: can be reset using tmpreset. Returns a hash of values on success,
13789: error string otherwise.
1.191 harris41 13790:
13791: =item *
13792:
1.243 albertel 13793: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
13794: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 13795:
13796: =item *
13797:
1.243 albertel 13798: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13799: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 13800:
13801: =item *
13802:
1.243 albertel 13803: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
13804: namesp ($udom and $uname are optional)
1.191 harris41 13805:
13806: =item *
13807:
1.702 albertel 13808: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 13809: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 13810: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 13811:
1.702 albertel 13812: $range should be either an integer '100' (give me the first 100
13813: matching records)
13814: or be two integers sperated by a - with no spaces
13815: '30-50' (give me the 30th through the 50th matching
13816: records)
1.449 matthew 13817: =item *
13818:
13819: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
13820: $store can be a scalar, an array reference, or if the amount to be
13821: incremented is > 1, a hash reference.
13822:
13823: ($udom and $uname are optional)
1.191 harris41 13824:
13825: =item *
13826:
1.243 albertel 13827: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
13828: ($udom and $uname are optional)
1.191 harris41 13829:
13830: =item *
13831:
1.243 albertel 13832: cput($namespace,$storehash,$udom,$uname) : critical put
13833: ($udom and $uname are optional)
1.191 harris41 13834:
13835: =item *
13836:
1.748 albertel 13837: newput($namespace,$storehash,$udom,$uname) :
13838:
13839: Attempts to store the items in the $storehash, but only if they don't
13840: currently exist, if this succeeds you can be certain that you have
13841: successfully created a new key value pair in the $namespace db.
13842:
13843:
13844: Args:
13845: $namespace: name of database to store values to
13846: $storehash: hashref to store to the db
13847: $udom: (optional) domain of user containing the db
13848: $uname: (optional) name of user caontaining the db
13849:
13850: Returns:
13851: 'ok' -> succeeded in storing all keys of $storehash
13852: 'key_exists: <key>' -> failed to anything out of $storehash, as at
13853: least <key> already existed in the db (other
13854: requested keys may also already exist)
1.967 bisitz 13855: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 13856: 'con_lost' -> unable to contact request server
13857: 'refused' -> action was not allowed by remote machine
13858:
13859:
13860: =item *
13861:
1.243 albertel 13862: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13863: reference filled in from namesp (encrypts the return communication)
13864: ($udom and $uname are optional)
1.191 harris41 13865:
13866: =item *
13867:
1.243 albertel 13868: log($udom,$name,$home,$message) : write to permanent log for user; use
13869: critical subroutine
13870:
1.806 raeburn 13871: =item *
13872:
1.860 raeburn 13873: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
13874: array reference filled in from namespace found in domain level on either
13875: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 13876:
13877: =item *
13878:
1.860 raeburn 13879: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
13880: domain level either on specified domain server ($uhome) or primary domain
13881: server ($udom and $uhome are optional)
1.806 raeburn 13882:
1.943 raeburn 13883: =item *
13884:
1.1240 raeburn 13885: get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
13886: for: authentication, language, quotas, timezone, date locale, and portal URL in
13887: the target domain.
13888:
13889: May also include additional key => value pairs for the following groups:
13890:
13891: =over
13892:
13893: =item
13894: disk quotas (MB allocated by default to portfolios and authoring spaces).
13895:
13896: =over
13897:
13898: =item defaultquota, authorquota
13899:
13900: =back
13901:
13902: =item
13903: tools (availability of aboutme page, blog, webDAV access for authoring spaces,
13904: portfolio for users).
13905:
13906: =over
13907:
13908: =item
13909: aboutme, blog, webdav, portfolio
13910:
13911: =back
13912:
13913: =item
13914: requestcourses: ability to request courses, and how requests are processed.
13915:
13916: =over
13917:
13918: =item
1.1246 raeburn 13919: official, unofficial, community, textbook
1.1240 raeburn 13920:
13921: =back
13922:
13923: =item
13924: inststatus: types of institutional affiliation, and order in which they are displayed.
13925:
13926: =over
13927:
13928: =item
1.1256 raeburn 13929: inststatustypes, inststatusorder, inststatusguest
1.1240 raeburn 13930:
13931: =back
13932:
13933: =item
13934: coursedefaults: can PDF forms can be created, default credits for courses, default quotas (MB)
13935: for course's uploaded content.
13936:
13937: =over
13938:
13939: =item
1.1246 raeburn 13940: canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
13941: communityquota, textbookquota
1.1240 raeburn 13942:
13943: =back
13944:
13945: =item
13946: usersessions: set options for hosting of your users in other domains, and hosting of users from other domains
13947: on your servers.
13948:
13949: =over
13950:
13951: =item
13952: remotesessions, hostedsessions
13953:
13954: =back
13955:
13956: =back
13957:
13958: In cases where a domain coordinator has never used the "Set Domain Configuration"
13959: utility to create a configuration.db file on a domain's primary library server
13960: only the following domain defaults: auth_def, auth_arg_def, lang_def
13961: -- corresponding values are authentication type (internal, krb4, krb5,
13962: or localauth), initial password or a kerberos realm, language (e.g., en-us) --
13963: will be available. Values are retrieved from cache (if current), unless the
13964: optional $ignore_cache arg is true, or from domain's configuration.db (if available),
13965: or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
13966:
13967: Typical usage:
1.943 raeburn 13968:
1.1240 raeburn 13969: %domdefaults = &get_domain_defaults($target_domain);
1.943 raeburn 13970:
1.243 albertel 13971: =back
13972:
13973: =head2 Network Status Functions
13974:
13975: =over 4
1.191 harris41 13976:
13977: =item *
13978:
1.1137 raeburn 13979: dirlist() : return directory list based on URI (first arg).
13980:
13981: Inputs: 1 required, 5 optional.
13982:
13983: =over
13984:
13985: =item
13986: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
13987:
13988: =item
13989: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
13990:
13991: =item
13992: $username - username of user/course to be listed. Extracted from $uri if absent.
13993:
13994: =item
13995: $getpropath - boolean: 1 if prepend path using &propath().
13996:
13997: =item
13998: $getuserdir - boolean: 1 if prepend path for "userfiles".
13999:
14000: =item
14001: $alternateRoot - path to prepend in place of path from $uri.
14002:
14003: =back
14004:
14005: Returns: Array of up to two items.
14006:
14007: =over
14008:
14009: a reference to an array of files/subdirectories
14010:
14011: =over
14012:
14013: Each element in the array of files/subdirectories is a & separated list of
14014: item name and the result of running stat on the item. If dirlist was requested
14015: for a file instead of a directory, the item name will be ''. For a directory
14016: listing, if the item is a metadata file, the element will end &N&M
14017: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
14018: default copyright set (1).
14019:
14020: =back
14021:
14022: a scalar containing error condition (if encountered).
14023:
14024: =over
14025:
14026: =item
14027: no_host (no homeserver identified for $username:$domain).
14028:
14029: =item
14030: no_such_host (server contacted for listing not identified as valid host).
14031:
14032: =item
14033: con_lost (connection to remote server failed).
14034:
14035: =item
14036: refused (invalid $username:$domain received on lond side).
14037:
14038: =item
14039: no_such_dir (directory at specified path on lond side does not exist).
14040:
14041: =item
14042: empty (directory at specified path on lond side is empty).
14043:
14044: =over
14045:
14046: This is currently not encountered because the &ls3, &ls2,
14047: &ls (_handler) routines on the lond side do not filter out
14048: . and .. from a directory listing.
14049:
14050: =back
14051:
14052: =back
14053:
14054: =back
1.191 harris41 14055:
14056: =item *
14057:
1.243 albertel 14058: spareserver() : find server with least workload from spare.tab
14059:
1.986 foxr 14060:
14061: =item *
14062:
14063: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
14064: if there is no corresponding loncapa host.
14065:
1.243 albertel 14066: =back
14067:
1.986 foxr 14068:
1.243 albertel 14069: =head2 Apache Request
14070:
14071: =over 4
1.191 harris41 14072:
14073: =item *
14074:
1.243 albertel 14075: ssi($url,%hash) : server side include, does a complete request cycle on url to
14076: localhost, posts hash
14077:
14078: =back
14079:
14080: =head2 Data to String to Data
14081:
14082: =over 4
1.191 harris41 14083:
14084: =item *
14085:
1.243 albertel 14086: hash2str(%hash) : convert a hash into a string complete with escaping and '='
14087: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 14088:
14089: =item *
14090:
1.243 albertel 14091: hashref2str($hashref) : convert a hashref into a string complete with
14092: escaping and '=' and '&' separators, supports elements that are
14093: arrayrefs and hashrefs
1.191 harris41 14094:
14095: =item *
14096:
1.243 albertel 14097: arrayref2str($arrayref) : convert an arrayref into a string complete
14098: with escaping and '&' separators, supports elements that are arrayrefs
14099: and hashrefs
1.191 harris41 14100:
14101: =item *
14102:
1.243 albertel 14103: str2hash($string) : convert string to hash using unescaping and
14104: splitting on '=' and '&', supports elements that are arrayrefs and
14105: hashrefs
1.191 harris41 14106:
14107: =item *
14108:
1.243 albertel 14109: str2array($string) : convert string to hash using unescaping and
14110: splitting on '&', supports elements that are arrayrefs and hashrefs
14111:
14112: =back
14113:
14114: =head2 Logging Routines
14115:
14116:
14117: These routines allow one to make log messages in the lonnet.log and
14118: lonnet.perm logfiles.
1.191 harris41 14119:
1.1119 foxr 14120: =over 4
14121:
1.191 harris41 14122: =item *
14123:
1.243 albertel 14124: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 14125:
14126: =item *
14127:
1.243 albertel 14128: logthis() : append message to the normal lonnet.log file, it gets
14129: preiodically rolled over and deleted.
1.191 harris41 14130:
14131: =item *
14132:
1.243 albertel 14133: logperm() : append a permanent message to lonnet.perm.log, this log
14134: file never gets deleted by any automated portion of the system, only
14135: messages of critical importance should go in here.
14136:
1.1119 foxr 14137:
1.243 albertel 14138: =back
14139:
14140: =head2 General File Helper Routines
14141:
14142: =over 4
1.191 harris41 14143:
14144: =item *
14145:
1.481 raeburn 14146: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
14147: (a) files in /uploaded
14148: (i) If a local copy of the file exists -
14149: compares modification date of local copy with last-modified date for
14150: definitive version stored on home server for course. If local copy is
14151: stale, requests a new version from the home server and stores it.
14152: If the original has been removed from the home server, then local copy
14153: is unlinked.
14154: (ii) If local copy does not exist -
14155: requests the file from the home server and stores it.
14156:
14157: If $caller is 'uploadrep':
14158: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
14159: for request for files originally uploaded via DOCS.
14160: - returns 'ok' if fresh local copy now available, -1 otherwise.
14161:
14162: Otherwise:
14163: This indicates a call from the content generation phase of the request.
14164: - returns the entire contents of the file or -1.
14165:
14166: (b) files in /res
14167: - returns the entire contents of a file or -1;
14168: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 14169:
1.712 albertel 14170:
14171: =item *
14172:
14173: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
14174: reference
14175:
14176: returns either a stat() list of data about the file or an empty list
14177: if the file doesn't exist or couldn't find out about it (connection
14178: problems or user unknown)
14179:
1.191 harris41 14180: =item *
14181:
1.243 albertel 14182: filelocation($dir,$file) : returns file system location of a file
14183: based on URI; meant to be "fairly clean" absolute reference, $dir is a
14184: directory that relative $file lookups are to looked in ($dir of /a/dir
14185: and a file of ../bob will become /a/bob)
1.191 harris41 14186:
14187: =item *
14188:
14189: hreflocation($dir,$file) : returns file system location or a URL; same as
14190: filelocation except for hrefs
14191:
14192: =item *
14193:
1.1261 raeburn 14194: declutter() : declutters URLs -- remove beginning slashes, 'res' etc.
14195: also removes beginning /home/httpd/html unless /priv/ follows it.
1.191 harris41 14196:
1.243 albertel 14197: =back
14198:
1.608 albertel 14199: =head2 Usererfile file routines (/uploaded*)
14200:
14201: =over 4
14202:
14203: =item *
14204:
14205: userfileupload(): main rotine for putting a file in a user or course's
14206: filespace, arguments are,
14207:
1.620 albertel 14208: formname - required - this is the name of the element in $env where the
1.608 albertel 14209: filename, and the contents of the file to create/modifed exist
1.620 albertel 14210: the filename is in $env{'form.'.$formname.'.filename'} and the
14211: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 14212: context - if coursedoc, store the file in the course of the active role
14213: of the current user;
14214: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
14215: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 14216: subdir - required - subdirectory to put the file in under ../userfiles/
14217: if undefined, it will be placed in "unknown"
14218:
14219: (This routine calls clean_filename() to remove any dangerous
14220: characters from the filename, and then calls finuserfileupload() to
14221: complete the transaction)
14222:
14223: returns either the url of the uploaded file (/uploaded/....) if successful
14224: and /adm/notfound.html if unsuccessful
14225:
14226: =item *
14227:
14228: clean_filename(): routine for cleaing a filename up for storage in
14229: userfile space, argument is:
14230:
14231: filename - proposed filename
14232:
14233: returns: the new clean filename
14234:
14235: =item *
14236:
1.1090 raeburn 14237: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 14238: userspace, probably shouldn't be called directly
14239:
14240: docuname: username or courseid of destination for the file
14241: docudom: domain of user/course of destination for the file
14242: formname: same as for userfileupload()
1.1090 raeburn 14243: fname: filename (including subdirectories) for the file
14244: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
14245: allfiles: reference to hash used to store objects found by parser
14246: codebase: reference to hash used for codebases of java objects found by parser
14247: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
14248: thumbheight: height (pixels) of thumbnail to be created for uploaded image
14249: resizewidth: width to be used to resize image using resizeImage from ImageMagick
14250: resizeheight: height to be used to resize image using resizeImage from ImageMagick
14251: context: if 'overwrite', will move the uploaded file from its temporary location to
14252: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 14253: mimetype: reference to scalar to accommodate mime type determined
14254: from File::MMagic if $parser = parse.
1.608 albertel 14255:
14256: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 14257: and /adm/notfound.html if unsuccessful (or an error message if context
14258: was 'overwrite').
14259:
1.608 albertel 14260:
14261: =item *
14262:
14263: renameuserfile(): renames an existing userfile to a new name
14264:
14265: Args:
14266: docuname: username or courseid of destination for the file
14267: docudom: domain of user/course of destination for the file
14268: old: current file name (including any subdirs under userfiles)
14269: new: desired file name (including any subdirs under userfiles)
14270:
14271: =item *
14272:
14273: mkdiruserfile(): creates a directory is a userfiles dir
14274:
14275: Args:
14276: docuname: username or courseid of destination for the file
14277: docudom: domain of user/course of destination for the file
14278: dir: dir to create (including any subdirs under userfiles)
14279:
14280: =item *
14281:
14282: removeuserfile(): removes a file that exists in userfiles
14283:
14284: Args:
14285: docuname: username or courseid of destination for the file
14286: docudom: domain of user/course of destination for the file
14287: fname: filname to delete (including any subdirs under userfiles)
14288:
14289: =item *
14290:
14291: removeuploadedurl(): convience function for removeuserfile()
14292:
14293: Args:
14294: url: a full /uploaded/... url to delete
14295:
1.747 albertel 14296: =item *
14297:
14298: get_portfile_permissions():
14299: Args:
14300: domain: domain of user or course contain the portfolio files
14301: user: name of user or num of course contain the portfolio files
14302: Returns:
14303: hashref of a dump of the proper file_permissions.db
14304:
14305:
14306: =item *
14307:
14308: get_access_controls():
14309:
14310: Args:
14311: current_permissions: the hash ref returned from get_portfile_permissions()
14312: group: (optional) the group you want the files associated with
14313: file: (optional) the file you want access info on
14314:
14315: Returns:
1.749 raeburn 14316: a hash (keys are file names) of hashes containing
14317: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
14318: values are XML containing access control settings (see below)
1.747 albertel 14319:
14320: Internal notes:
14321:
1.749 raeburn 14322: access controls are stored in file_permissions.db as key=value pairs.
14323: key -> path to file/file_name\0uniqueID:scope_end_start
14324: where scope -> public,guest,course,group,domains or users.
14325: end -> UNIX time for end of access (0 -> no end date)
14326: start -> UNIX time for start of access
14327:
14328: value -> XML description of access control
14329: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
14330: <start></start>
14331: <end></end>
14332:
14333: <password></password> for scope type = guest
14334:
14335: <domain></domain> for scope type = course or group
14336: <number></number>
14337: <roles id="">
14338: <role></role>
14339: <access></access>
14340: <section></section>
14341: <group></group>
14342: </roles>
14343:
14344: <dom></dom> for scope type = domains
14345:
14346: <users> for scope type = users
14347: <user>
14348: <uname></uname>
14349: <udom></udom>
14350: </user>
14351: </users>
14352: </scope>
14353:
14354: Access data is also aggregated for each file in an additional key=value pair:
14355: key -> path to file/file_name\0accesscontrol
14356: value -> reference to hash
14357: hash contains key = value pairs
14358: where key = uniqueID:scope_end_start
14359: value = UNIX time record was last updated
14360:
14361: Used to improve speed of look-ups of access controls for each file.
14362:
14363: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
14364:
1.1198 raeburn 14365: =item *
14366:
1.749 raeburn 14367: modify_access_controls():
14368:
14369: Modifies access controls for a portfolio file
14370: Args
14371: 1. file name
14372: 2. reference to hash of required changes,
14373: 3. domain
14374: 4. username
14375: where domain,username are the domain of the portfolio owner
14376: (either a user or a course)
14377:
14378: Returns:
14379: 1. result of additions or updates ('ok' or 'error', with error message).
14380: 2. result of deletions ('ok' or 'error', with error message).
14381: 3. reference to hash of any new or updated access controls.
14382: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
14383: key = integer (inbound ID)
1.1198 raeburn 14384: value = uniqueID
14385:
14386: =item *
14387:
14388: get_timebased_id():
14389:
14390: Attempts to get a unique timestamp-based suffix for use with items added to a
14391: course via the Course Editor (e.g., folders, composite pages,
14392: group bulletin boards).
14393:
14394: Args: (first three required; six others optional)
14395:
14396: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
14397: docssequence, or name of group
14398:
14399: 2. keyid (alphanumeric): name of temporary locking key in hash,
14400: e.g., num, boardids
14401:
14402: 3. namespace: name of gdbm file used to store suffixes already assigned;
14403: file will be named nohist_namespace.db
14404:
14405: 4. cdom: domain of course; default is current course domain from %env
14406:
14407: 5. cnum: course number; default is current course number from %env
14408:
14409: 6. idtype: set to concat if an additional digit is to be appended to the
14410: unix timestamp to form the suffix, if the plain timestamp is already
14411: in use. Default is to not do this, but simply increment the unix
14412: timestamp by 1 until a unique key is obtained.
14413:
14414: 7. who: holder of locking key; defaults to user:domain for user.
14415:
14416: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
14417: retrying); default is 3.
14418:
14419: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
14420:
14421: Returns:
14422:
14423: 1. suffix obtained (numeric)
14424:
14425: 2. result of deleting locking key (ok if deleted, or lock never obtained)
14426:
14427: 3. error: contains (localized) error message if an error occurred.
14428:
1.747 albertel 14429:
1.608 albertel 14430: =back
14431:
1.243 albertel 14432: =head2 HTTP Helper Routines
14433:
14434: =over 4
14435:
1.191 harris41 14436: =item *
14437:
14438: escape() : unpack non-word characters into CGI-compatible hex codes
14439:
14440: =item *
14441:
14442: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
14443:
1.243 albertel 14444: =back
14445:
14446: =head1 PRIVATE SUBROUTINES
14447:
14448: =head2 Underlying communication routines (Shouldn't call)
14449:
14450: =over 4
14451:
14452: =item *
14453:
14454: subreply() : tries to pass a message to lonc, returns con_lost if incapable
14455:
14456: =item *
14457:
14458: reply() : uses subreply to send a message to remote machine, logs all failures
14459:
14460: =item *
14461:
14462: critical() : passes a critical message to another server; if cannot
14463: get through then place message in connection buffer directory and
14464: returns con_delayed, if incapable of saving message, returns
14465: con_failed
14466:
14467: =item *
14468:
14469: reconlonc() : tries to reconnect lonc client processes.
14470:
14471: =back
14472:
14473: =head2 Resource Access Logging
14474:
14475: =over 4
14476:
14477: =item *
14478:
14479: flushcourselogs() : flush (save) buffer logs and access logs
14480:
14481: =item *
14482:
14483: courselog($what) : save message for course in hash
14484:
14485: =item *
14486:
14487: courseacclog($what) : save message for course using &courselog(). Perform
14488: special processing for specific resource types (problems, exams, quizzes, etc).
14489:
1.191 harris41 14490: =item *
14491:
14492: goodbye() : flush course logs and log shutting down; it is called in srm.conf
14493: as a PerlChildExitHandler
1.243 albertel 14494:
14495: =back
14496:
14497: =head2 Other
14498:
14499: =over 4
14500:
14501: =item *
14502:
14503: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 14504:
14505: =back
14506:
14507: =cut
1.877 foxr 14508:
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