Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1236
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1236 ! raeburn 4: # $Id: lonnet.pm,v 1.1235 2013/08/06 23:17:39 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.1213 raeburn 81: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir $apache
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.539 albertel 95: use Time::HiRes qw( 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.550 foxr 108: my $max_connection_retries = 10; # 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 {
359: my ($lonhost,$name,$id) = @_;
1.1130 raeburn 360: my $response = &reply('devalidatecache:'.&escape($name).':'.&escape($id),$lonhost);
1.1124 raeburn 361: return $response;
362: }
363:
1.1 albertel 364: # -------------------------------------------------- Non-critical communication
365: sub subreply {
366: my ($cmd,$server)=@_;
1.838 albertel 367: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 368: #
369: # With loncnew process trimming, there's a timing hole between lonc server
370: # process exit and the master server picking up the listen on the AF_UNIX
371: # socket. In that time interval, a lock file will exist:
372:
373: my $lockfile=$peerfile.".lock";
374: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
375: sleep(1);
376: }
377: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 378: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 379: #
1.550 foxr 380: # We'll give the connection a few tries before abandoning it. If
381: # connection is not possible, we'll con_lost back to the client.
382: #
383: my $client;
384: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
385: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
386: Type => SOCK_STREAM,
387: Timeout => 10);
1.869 albertel 388: if ($client) {
1.550 foxr 389: last; # Connected!
1.850 albertel 390: } else {
1.853 albertel 391: &create_connection(&hostname($server),$server);
1.550 foxr 392: }
1.850 albertel 393: sleep(1); # Try again later if failed connection.
1.550 foxr 394: }
395: my $answer;
396: if ($client) {
1.704 albertel 397: print $client "sethost:$server:$cmd\n";
1.550 foxr 398: $answer=<$client>;
399: if (!$answer) { $answer="con_lost"; }
400: chomp($answer);
401: } else {
402: $answer = 'con_lost'; # Failed connection.
403: }
1.1 albertel 404: return $answer;
405: }
406:
407: sub reply {
408: my ($cmd,$server)=@_;
1.838 albertel 409: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 410: my $answer=subreply($cmd,$server);
1.65 www 411: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 412: &logthis("<font color=\"blue\">WARNING:".
1.12 www 413: " $cmd to $server returned $answer</font>");
414: }
1.1 albertel 415: return $answer;
416: }
417:
418: # ----------------------------------------------------------- Send USR1 to lonc
419:
420: sub reconlonc {
1.891 albertel 421: my ($lonid) = @_;
422: my $hostname = &hostname($lonid);
423: if ($lonid) {
424: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
425: if ($hostname && -e $peerfile) {
426: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
427: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
428: Type => SOCK_STREAM,
429: Timeout => 10);
430: if ($client) {
431: print $client ("reset_retries\n");
432: my $answer=<$client>;
433: #reset just this one.
434: }
435: }
436: return;
437: }
438:
1.836 www 439: &logthis("Trying to reconnect lonc");
1.1 albertel 440: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 441: if (open(my $fh,"<$loncfile")) {
1.1 albertel 442: my $loncpid=<$fh>;
443: chomp($loncpid);
444: if (kill 0 => $loncpid) {
445: &logthis("lonc at pid $loncpid responding, sending USR1");
446: kill USR1 => $loncpid;
447: sleep 1;
1.836 www 448: } else {
1.12 www 449: &logthis(
1.672 albertel 450: "<font color=\"blue\">WARNING:".
1.12 www 451: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 452: }
453: } else {
1.836 www 454: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 455: }
456: }
457:
458: # ------------------------------------------------------ Critical communication
1.12 www 459:
1.1 albertel 460: sub critical {
461: my ($cmd,$server)=@_;
1.838 albertel 462: unless (&hostname($server)) {
1.672 albertel 463: &logthis("<font color=\"blue\">WARNING:".
1.89 www 464: " Critical message to unknown server ($server)</font>");
465: return 'no_such_host';
466: }
1.1 albertel 467: my $answer=reply($cmd,$server);
468: if ($answer eq 'con_lost') {
469: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 470: my $answer=reply($cmd,$server);
1.1 albertel 471: if ($answer eq 'con_lost') {
472: my $now=time;
473: my $middlename=$cmd;
1.5 www 474: $middlename=substr($middlename,0,16);
1.1 albertel 475: $middlename=~s/\W//g;
476: my $dfilename=
1.305 www 477: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
478: $dumpcount++;
1.1 albertel 479: {
1.448 albertel 480: my $dfh;
481: if (open($dfh,">$dfilename")) {
482: print $dfh "$cmd\n";
483: close($dfh);
484: }
1.1 albertel 485: }
486: sleep 2;
487: my $wcmd='';
488: {
1.448 albertel 489: my $dfh;
490: if (open($dfh,"<$dfilename")) {
491: $wcmd=<$dfh>;
492: close($dfh);
493: }
1.1 albertel 494: }
495: chomp($wcmd);
1.7 www 496: if ($wcmd eq $cmd) {
1.672 albertel 497: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 498: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 499: &logperm("D:$server:$cmd");
500: return 'con_delayed';
501: } else {
1.672 albertel 502: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 503: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 504: &logperm("F:$server:$cmd");
505: return 'con_failed';
506: }
507: }
508: }
509: return $answer;
1.405 albertel 510: }
511:
1.755 albertel 512: # ------------------------------------------- check if return value is an error
513:
514: sub error {
515: my ($result) = @_;
1.756 albertel 516: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 517: if ($2 == 2) { return undef; }
518: return $1;
519: }
520: return undef;
521: }
522:
1.783 albertel 523: sub convert_and_load_session_env {
524: my ($lonidsdir,$handle)=@_;
525: my @profile;
526: {
1.917 albertel 527: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
528: if (!$opened) {
1.915 albertel 529: return 0;
530: }
1.783 albertel 531: flock($idf,LOCK_SH);
532: @profile=<$idf>;
533: close($idf);
534: }
535: my %temp_env;
536: foreach my $line (@profile) {
1.786 albertel 537: if ($line !~ m/=/) {
538: return 0;
539: }
1.783 albertel 540: chomp($line);
541: my ($envname,$envvalue)=split(/=/,$line,2);
542: $temp_env{&unescape($envname)} = &unescape($envvalue);
543: }
544: unlink("$lonidsdir/$handle.id");
545: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
546: 0640)) {
547: %disk_env = %temp_env;
548: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
549: untie(%disk_env);
550: }
1.786 albertel 551: return 1;
1.783 albertel 552: }
553:
1.374 www 554: # ------------------------------------------- Transfer profile into environment
1.780 albertel 555: my $env_loaded;
556: sub transfer_profile_to_env {
1.788 albertel 557: my ($lonidsdir,$handle,$force_transfer) = @_;
558: if (!$force_transfer && $env_loaded) { return; }
1.374 www 559:
1.720 albertel 560: if (!defined($lonidsdir)) {
561: $lonidsdir = $perlvar{'lonIDsDir'};
562: }
563: if (!defined($handle)) {
564: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
565: }
566:
1.786 albertel 567: my $convert;
568: {
1.917 albertel 569: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
570: if (!$opened) {
1.915 albertel 571: return;
572: }
1.786 albertel 573: flock($idf,LOCK_SH);
574: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
575: &GDBM_READER(),0640)) {
576: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
577: untie(%disk_env);
578: } else {
579: $convert = 1;
580: }
581: }
582: if ($convert) {
583: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
584: &logthis("Failed to load session, or convert session.");
585: }
1.374 www 586: }
1.783 albertel 587:
1.786 albertel 588: my %remove;
1.783 albertel 589: while ( my $envname = each(%env) ) {
1.433 matthew 590: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
591: if ($time < time-300) {
1.783 albertel 592: $remove{$key}++;
1.433 matthew 593: }
594: }
595: }
1.783 albertel 596:
1.619 albertel 597: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 598: $env_loaded=1;
1.783 albertel 599: foreach my $expired_key (keys(%remove)) {
1.433 matthew 600: &delenv($expired_key);
1.374 www 601: }
1.1 albertel 602: }
603:
1.916 albertel 604: # ---------------------------------------------------- Check for valid session
605: sub check_for_valid_session {
1.1155 raeburn 606: my ($r,$name) = @_;
1.916 albertel 607: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
1.1155 raeburn 608: if ($name eq '') {
609: $name = 'lonID';
610: }
611: my $lonid=$cookies{$name};
1.916 albertel 612: return undef if (!$lonid);
613:
614: my $handle=&LONCAPA::clean_handle($lonid->value);
1.1155 raeburn 615: my $lonidsdir;
616: if ($name eq 'lonDAV') {
617: $lonidsdir=$r->dir_config('lonDAVsessDir');
618: } else {
619: $lonidsdir=$r->dir_config('lonIDsDir');
620: }
1.916 albertel 621: return undef if (!-e "$lonidsdir/$handle.id");
622:
1.917 albertel 623: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
624: return undef if (!$opened);
1.916 albertel 625:
626: flock($idf,LOCK_SH);
627: my %disk_env;
628: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
629: &GDBM_READER(),0640)) {
630: return undef;
631: }
632:
633: if (!defined($disk_env{'user.name'})
634: || !defined($disk_env{'user.domain'})) {
635: return undef;
636: }
1.1213 raeburn 637: if (($r->user() eq '') && ($apache >= 2.4)) {
1.1212 raeburn 638: if ($disk_env{'user.domain'} eq $r->dir_config('lonDefDomain')) {
639: $r->user($disk_env{'user.name'});
640: } else {
641: $r->user($disk_env{'user.name'}.':'.$disk_env{'user.domain'});
642: }
643: }
1.916 albertel 644: return $handle;
645: }
646:
1.830 albertel 647: sub timed_flock {
648: my ($file,$lock_type) = @_;
649: my $failed=0;
650: eval {
651: local $SIG{__DIE__}='DEFAULT';
652: local $SIG{ALRM}=sub {
653: $failed=1;
654: die("failed lock");
655: };
656: alarm(13);
657: flock($file,$lock_type);
658: alarm(0);
659: };
660: if ($failed) {
661: return undef;
662: } else {
663: return 1;
664: }
665: }
666:
1.5 www 667: # ---------------------------------------------------------- Append Environment
668:
669: sub appenv {
1.949 raeburn 670: my ($newenv,$roles) = @_;
671: if (ref($newenv) eq 'HASH') {
672: foreach my $key (keys(%{$newenv})) {
673: my $refused = 0;
674: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
675: $refused = 1;
676: if (ref($roles) eq 'ARRAY') {
677: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
678: if (grep(/^\Q$role\E$/,@{$roles})) {
679: $refused = 0;
680: }
681: }
682: }
683: if ($refused) {
684: &logthis("<font color=\"blue\">WARNING: ".
685: "Attempt to modify environment ".$key." to ".$newenv->{$key}
686: .'</font>');
687: delete($newenv->{$key});
688: } else {
689: $env{$key}=$newenv->{$key};
690: }
691: }
692: my $opened = open(my $env_file,'+<',$env{'user.environment'});
693: if ($opened
694: && &timed_flock($env_file,LOCK_EX)
695: &&
696: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
697: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
698: while (my ($key,$value) = each(%{$newenv})) {
699: $disk_env{$key} = $value;
700: }
701: untie(%disk_env);
1.35 www 702: }
1.191 harris41 703: }
1.56 www 704: return 'ok';
705: }
706: # ----------------------------------------------------- Delete from Environment
707:
708: sub delenv {
1.1104 raeburn 709: my ($delthis,$regexp,$roles) = @_;
710: if (($delthis=~/^user\.role/) || ($delthis=~/^user\.priv/)) {
711: my $refused = 1;
712: if (ref($roles) eq 'ARRAY') {
713: my ($type,$role) = ($delthis =~ /^user\.(role|priv)\.([^.]+)\./);
714: if (grep(/^\Q$role\E$/,@{$roles})) {
715: $refused = 0;
716: }
717: }
718: if ($refused) {
719: &logthis("<font color=\"blue\">WARNING: ".
720: "Attempt to delete from environment ".$delthis);
721: return 'error';
722: }
1.56 www 723: }
1.917 albertel 724: my $opened = open(my $env_file,'+<',$env{'user.environment'});
725: if ($opened
1.915 albertel 726: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 727: &&
728: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
729: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 730: foreach my $key (keys(%disk_env)) {
1.987 raeburn 731: if ($regexp) {
732: if ($key=~/^$delthis/) {
733: delete($env{$key});
734: delete($disk_env{$key});
735: }
736: } else {
737: if ($key=~/^\Q$delthis\E/) {
738: delete($env{$key});
739: delete($disk_env{$key});
740: }
741: }
1.448 albertel 742: }
1.783 albertel 743: untie(%disk_env);
1.5 www 744: }
745: return 'ok';
1.369 albertel 746: }
747:
1.790 albertel 748: sub get_env_multiple {
749: my ($name) = @_;
750: my @values;
751: if (defined($env{$name})) {
752: # exists is it an array
753: if (ref($env{$name})) {
754: @values=@{ $env{$name} };
755: } else {
756: $values[0]=$env{$name};
757: }
758: }
759: return(@values);
760: }
761:
1.958 www 762: # ------------------------------------------------------------------- Locking
763:
764: sub set_lock {
765: my ($text)=@_;
766: $locknum++;
767: my $id=$$.'-'.$locknum;
768: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
769: 'session.lock.'.$id => $text});
770: return $id;
771: }
772:
773: sub get_locks {
774: my $num=0;
775: my %texts=();
776: foreach my $lock (split(/\,/,$env{'session.locks'})) {
777: if ($lock=~/\w/) {
778: $num++;
779: $texts{$lock}=$env{'session.lock.'.$lock};
780: }
781: }
782: return ($num,%texts);
783: }
784:
785: sub remove_lock {
786: my ($id)=@_;
787: my $newlocks='';
788: foreach my $lock (split(/\,/,$env{'session.locks'})) {
789: if (($lock=~/\w/) && ($lock ne $id)) {
790: $newlocks.=','.$lock;
791: }
792: }
793: &appenv({'session.locks' => $newlocks});
794: &delenv('session.lock.'.$id);
795: }
796:
797: sub remove_all_locks {
798: my $activelocks=$env{'session.locks'};
799: foreach my $lock (split(/\,/,$env{'session.locks'})) {
800: if ($lock=~/\w/) {
801: &remove_lock($lock);
802: }
803: }
804: }
805:
806:
1.369 albertel 807: # ------------------------------------------ Find out current server userload
808: sub userload {
809: my $numusers=0;
810: {
811: opendir(LONIDS,$perlvar{'lonIDsDir'});
812: my $filename;
813: my $curtime=time;
814: while ($filename=readdir(LONIDS)) {
1.925 albertel 815: next if ($filename eq '.' || $filename eq '..');
816: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 817: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 818: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 819: }
820: closedir(LONIDS);
821: }
822: my $userloadpercent=0;
823: my $maxuserload=$perlvar{'lonUserLoadLim'};
824: if ($maxuserload) {
1.371 albertel 825: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 826: }
1.372 albertel 827: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 828: return $userloadpercent;
1.283 www 829: }
830:
1.1 albertel 831: # ------------------------------ Find server with least workload from spare.tab
1.11 www 832:
1.1 albertel 833: sub spareserver {
1.1083 raeburn 834: my ($loadpercent,$userloadpercent,$want_server_name,$udom) = @_;
1.784 albertel 835: my $spare_server;
1.370 albertel 836: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 837: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
838: : $userloadpercent;
1.1083 raeburn 839: my ($uint_dom,$remotesessions);
840: if (($udom ne '') && (&domain($udom) ne '')) {
841: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
842: $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
843: my %udomdefaults = &Apache::lonnet::get_domain_defaults($udom);
844: $remotesessions = $udomdefaults{'remotesessions'};
845: }
1.1123 raeburn 846: my $spareshash = &this_host_spares($udom);
847: if (ref($spareshash) eq 'HASH') {
848: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
849: foreach my $try_server (@{ $spareshash->{'primary'} }) {
850: if ($uint_dom) {
851: next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
852: $try_server));
853: }
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'} }) {
864: if ($uint_dom) {
865: next unless (&spare_can_host($udom,$uint_dom,
866: $remotesessions,$try_server));
867: }
868: ($spare_server, $lowest_load) =
869: &compare_server_load($try_server, $spare_server, $lowest_load);
870: }
871: }
872: }
1.784 albertel 873: }
874:
875: if (!$want_server_name) {
1.968 raeburn 876: my $protocol = 'http';
877: if ($protocol{$spare_server} eq 'https') {
878: $protocol = $protocol{$spare_server};
879: }
1.1001 raeburn 880: if (defined($spare_server)) {
881: my $hostname = &hostname($spare_server);
1.1083 raeburn 882: if (defined($hostname)) {
1.1001 raeburn 883: $spare_server = $protocol.'://'.$hostname;
884: }
885: }
1.784 albertel 886: }
887: return $spare_server;
888: }
889:
890: sub compare_server_load {
891: my ($try_server, $spare_server, $lowest_load) = @_;
892:
893: my $loadans = &reply('load', $try_server);
894: my $userloadans = &reply('userload',$try_server);
895:
896: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
1.1114 raeburn 897: return ($spare_server, $lowest_load); #didn't get a number from the server
1.784 albertel 898: }
899:
900: my $load;
901: if ($loadans =~ /\d/) {
902: if ($userloadans =~ /\d/) {
903: #both are numbers, pick the bigger one
904: $load = ($loadans > $userloadans) ? $loadans
905: : $userloadans;
1.411 albertel 906: } else {
1.784 albertel 907: $load = $loadans;
1.411 albertel 908: }
1.784 albertel 909: } else {
910: $load = $userloadans;
911: }
912:
913: if (($load =~ /\d/) && ($load < $lowest_load)) {
914: $spare_server = $try_server;
915: $lowest_load = $load;
1.370 albertel 916: }
1.784 albertel 917: return ($spare_server,$lowest_load);
1.202 matthew 918: }
1.914 albertel 919:
920: # --------------------------- ask offload servers if user already has a session
921: sub find_existing_session {
922: my ($udom,$uname) = @_;
1.1123 raeburn 923: my $spareshash = &this_host_spares($udom);
924: if (ref($spareshash) eq 'HASH') {
925: if (ref($spareshash->{'primary'}) eq 'ARRAY') {
926: foreach my $try_server (@{ $spareshash->{'primary'} }) {
927: return $try_server if (&has_user_session($try_server, $udom, $uname));
928: }
929: }
930: if (ref($spareshash->{'default'}) eq 'ARRAY') {
931: foreach my $try_server (@{ $spareshash->{'default'} }) {
932: return $try_server if (&has_user_session($try_server, $udom, $uname));
933: }
934: }
1.914 albertel 935: }
936: return;
937: }
938:
939: # -------------------------------- ask if server already has a session for user
940: sub has_user_session {
941: my ($lonid,$udom,$uname) = @_;
942: my $result = &reply(join(':','userhassession',
943: map {&escape($_)} ($udom,$uname)),$lonid);
944: return 1 if ($result eq 'ok');
945:
946: return 0;
947: }
948:
1.1076 raeburn 949: # --------- determine least loaded server in a user's domain which allows login
950:
951: sub choose_server {
1.1115 raeburn 952: my ($udom,$checkloginvia) = @_;
1.1076 raeburn 953: my %domconfhash = &Apache::loncommon::get_domainconf($udom);
1.1077 raeburn 954: my %servers = &get_servers($udom);
1.1076 raeburn 955: my $lowest_load = 30000;
1.1151 raeburn 956: my ($login_host,$hostname,$portal_path,$isredirect);
1.1076 raeburn 957: foreach my $lonhost (keys(%servers)) {
1.1115 raeburn 958: my $loginvia;
959: if ($checkloginvia) {
960: $loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
1.1116 raeburn 961: if ($loginvia) {
962: my ($server,$path) = split(/:/,$loginvia);
963: ($login_host, $lowest_load) =
964: &compare_server_load($server, $login_host, $lowest_load);
965: if ($login_host eq $server) {
966: $portal_path = $path;
1.1151 raeburn 967: $isredirect = 1;
1.1116 raeburn 968: }
969: } else {
970: ($login_host, $lowest_load) =
971: &compare_server_load($lonhost, $login_host, $lowest_load);
972: if ($login_host eq $lonhost) {
973: $portal_path = '';
1.1151 raeburn 974: $isredirect = '';
1.1116 raeburn 975: }
976: }
977: } else {
1.1076 raeburn 978: ($login_host, $lowest_load) =
1.1116 raeburn 979: &compare_server_load($lonhost, $login_host, $lowest_load);
1.1076 raeburn 980: }
981: }
982: if ($login_host ne '') {
1.1116 raeburn 983: $hostname = &hostname($login_host);
1.1076 raeburn 984: }
1.1151 raeburn 985: return ($login_host,$hostname,$portal_path,$isredirect);
1.1076 raeburn 986: }
987:
1.202 matthew 988: # --------------------------------------------- Try to change a user's password
989:
990: sub changepass {
1.799 raeburn 991: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 992: $currentpass = &escape($currentpass);
993: $newpass = &escape($newpass);
1.1030 raeburn 994: my $lonhost = $perlvar{'lonHostID'};
995: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 996: $server);
997: if (! $answer) {
998: &logthis("No reply on password change request to $server ".
999: "by $uname in domain $udom.");
1000: } elsif ($answer =~ "^ok") {
1001: &logthis("$uname in $udom successfully changed their password ".
1002: "on $server.");
1003: } elsif ($answer =~ "^pwchange_failure") {
1004: &logthis("$uname in $udom was unable to change their password ".
1005: "on $server. The action was blocked by either lcpasswd ".
1006: "or pwchange");
1007: } elsif ($answer =~ "^non_authorized") {
1008: &logthis("$uname in $udom did not get their password correct when ".
1009: "attempting to change it on $server.");
1010: } elsif ($answer =~ "^auth_mode_error") {
1011: &logthis("$uname in $udom attempted to change their password despite ".
1012: "not being locally or internally authenticated on $server.");
1013: } elsif ($answer =~ "^unknown_user") {
1014: &logthis("$uname in $udom attempted to change their password ".
1015: "on $server but were unable to because $server is not ".
1016: "their home server.");
1017: } elsif ($answer =~ "^refused") {
1018: &logthis("$server refused to change $uname in $udom password because ".
1019: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 1020: } elsif ($answer =~ "invalid_client") {
1021: &logthis("$server refused to change $uname in $udom password because ".
1022: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 1023: }
1024: return $answer;
1.1 albertel 1025: }
1026:
1.169 harris41 1027: # ----------------------- Try to determine user's current authentication scheme
1028:
1029: sub queryauthenticate {
1030: my ($uname,$udom)=@_;
1.456 albertel 1031: my $uhome=&homeserver($uname,$udom);
1032: if (!$uhome) {
1033: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
1034: return 'no_host';
1035: }
1036: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
1037: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
1038: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 1039: }
1.456 albertel 1040: return $answer;
1.169 harris41 1041: }
1042:
1.1 albertel 1043: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 1044:
1.1 albertel 1045: sub authenticate {
1.1073 raeburn 1046: my ($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)=@_;
1.807 albertel 1047: $upass=&escape($upass);
1048: $uname= &LONCAPA::clean_username($uname);
1.836 www 1049: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 1050: my $newhome;
1.836 www 1051: if ((!$uhome) || ($uhome eq 'no_host')) {
1052: # Maybe the machine was offline and only re-appeared again recently?
1053: &reconlonc();
1054: # One more
1.952 raeburn 1055: $uhome=&homeserver($uname,$udom,1);
1056: if (($uhome eq 'no_host') && $checkdefauth) {
1057: if (defined(&domain($udom,'primary'))) {
1058: $newhome=&domain($udom,'primary');
1059: }
1060: if ($newhome ne '') {
1061: $uhome = $newhome;
1062: }
1063: }
1.836 www 1064: if ((!$uhome) || ($uhome eq 'no_host')) {
1065: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 1066: return 'no_host';
1067: }
1.1 albertel 1068: }
1.1073 raeburn 1069: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth:$clientcancheckhost",$uhome);
1.471 albertel 1070: if ($answer eq 'authorized') {
1.952 raeburn 1071: if ($newhome) {
1072: &logthis("User $uname at $udom authorized by $uhome, but needs account");
1073: return 'no_account_on_host';
1074: } else {
1075: &logthis("User $uname at $udom authorized by $uhome");
1076: return $uhome;
1077: }
1.471 albertel 1078: }
1079: if ($answer eq 'non_authorized') {
1080: &logthis("User $uname at $udom rejected by $uhome");
1081: return 'no_host';
1.9 www 1082: }
1.471 albertel 1083: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 1084: return 'no_host';
1085: }
1086:
1.1073 raeburn 1087: sub can_host_session {
1.1074 raeburn 1088: my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
1.1073 raeburn 1089: my $canhost = 1;
1.1074 raeburn 1090: my $host_idn = &Apache::lonnet::internet_dom($lonhost);
1.1073 raeburn 1091: if (ref($remotesessions) eq 'HASH') {
1092: if (ref($remotesessions->{'excludedomain'}) eq 'ARRAY') {
1.1074 raeburn 1093: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'excludedomain'}})) {
1.1073 raeburn 1094: $canhost = 0;
1095: } else {
1096: $canhost = 1;
1097: }
1098: }
1099: if (ref($remotesessions->{'includedomain'}) eq 'ARRAY') {
1.1074 raeburn 1100: if (grep(/^\Q$host_idn\E$/,@{$remotesessions->{'includedomain'}})) {
1.1073 raeburn 1101: $canhost = 1;
1102: } else {
1103: $canhost = 0;
1104: }
1105: }
1106: if ($canhost) {
1107: if ($remotesessions->{'version'} ne '') {
1108: my ($reqmajor,$reqminor) = ($remotesessions->{'version'} =~ /^(\d+)\.(\d+)$/);
1109: if ($reqmajor ne '' && $reqminor ne '') {
1110: if ($remoterev =~ /^\'?(\d+)\.(\d+)/) {
1111: my $major = $1;
1112: my $minor = $2;
1113: if (($major < $reqmajor ) ||
1114: (($major == $reqmajor) && ($minor < $reqminor))) {
1115: $canhost = 0;
1116: }
1117: } else {
1118: $canhost = 0;
1119: }
1120: }
1121: }
1122: }
1123: }
1124: if ($canhost) {
1125: if (ref($hostedsessions) eq 'HASH') {
1.1120 raeburn 1126: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1127: my $uint_dom = &Apache::lonnet::internet_dom($uprimary_id);
1.1073 raeburn 1128: if (ref($hostedsessions->{'excludedomain'}) eq 'ARRAY') {
1.1120 raeburn 1129: if (($uint_dom ne '') &&
1130: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'excludedomain'}}))) {
1.1073 raeburn 1131: $canhost = 0;
1132: } else {
1133: $canhost = 1;
1134: }
1135: }
1136: if (ref($hostedsessions->{'includedomain'}) eq 'ARRAY') {
1.1120 raeburn 1137: if (($uint_dom ne '') &&
1138: (grep(/^\Q$uint_dom\E$/,@{$hostedsessions->{'includedomain'}}))) {
1.1073 raeburn 1139: $canhost = 1;
1140: } else {
1141: $canhost = 0;
1142: }
1143: }
1144: }
1145: }
1146: return $canhost;
1147: }
1148:
1.1083 raeburn 1149: sub spare_can_host {
1150: my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
1151: my $canhost=1;
1152: my @intdoms;
1153: my $internet_names = &Apache::lonnet::get_internet_names($try_server);
1154: if (ref($internet_names) eq 'ARRAY') {
1155: @intdoms = @{$internet_names};
1156: }
1157: unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
1158: my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
1159: my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1160: my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
1161: my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
1162: $canhost = &can_host_session($udom,$try_server,$remoterev,
1163: $remotesessions,
1164: $defdomdefaults{'hostedsessions'});
1165: }
1166: return $canhost;
1167: }
1168:
1.1123 raeburn 1169: sub this_host_spares {
1170: my ($dom) = @_;
1.1126 raeburn 1171: my ($dom_in_use,$lonhost_in_use,$result);
1.1123 raeburn 1172: my @hosts = ¤t_machine_ids();
1173: foreach my $lonhost (@hosts) {
1174: if (&host_domain($lonhost) eq $dom) {
1.1126 raeburn 1175: $dom_in_use = $dom;
1176: $lonhost_in_use = $lonhost;
1.1123 raeburn 1177: last;
1178: }
1179: }
1.1126 raeburn 1180: if ($dom_in_use ne '') {
1181: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1182: }
1183: if (ref($result) ne 'HASH') {
1184: $lonhost_in_use = $perlvar{'lonHostID'};
1185: $dom_in_use = &host_domain($lonhost_in_use);
1186: $result = &spares_for_offload($dom_in_use,$lonhost_in_use);
1187: if (ref($result) ne 'HASH') {
1188: $result = \%spareid;
1189: }
1190: }
1191: return $result;
1192: }
1193:
1194: sub spares_for_offload {
1195: my ($dom_in_use,$lonhost_in_use) = @_;
1196: my ($result,$cached)=&is_cached_new('spares',$dom_in_use);
1.1123 raeburn 1197: if (defined($cached)) {
1198: return $result;
1199: } else {
1.1126 raeburn 1200: my $cachetime = 60*60*24;
1201: my %domconfig =
1202: &Apache::lonnet::get_dom('configuration',['usersessions'],$dom_in_use);
1203: if (ref($domconfig{'usersessions'}) eq 'HASH') {
1204: if (ref($domconfig{'usersessions'}{'spares'}) eq 'HASH') {
1205: if (ref($domconfig{'usersessions'}{'spares'}{$lonhost_in_use}) eq 'HASH') {
1206: return &do_cache_new('spares',$dom_in_use,$domconfig{'usersessions'}{'spares'}{$lonhost_in_use},$cachetime);
1.1123 raeburn 1207: }
1208: }
1209: }
1210: }
1.1126 raeburn 1211: return;
1.1123 raeburn 1212: }
1213:
1.1129 raeburn 1214: sub get_lonbalancer_config {
1215: my ($servers) = @_;
1216: my ($currbalancer,$currtargets);
1217: if (ref($servers) eq 'HASH') {
1218: foreach my $server (keys(%{$servers})) {
1219: my %what = (
1220: spareid => 1,
1221: perlvar => 1,
1222: );
1223: my ($result,$returnhash) = &get_remote_globals($server,\%what);
1224: if ($result eq 'ok') {
1225: if (ref($returnhash) eq 'HASH') {
1226: if (ref($returnhash->{'perlvar'}) eq 'HASH') {
1227: if ($returnhash->{'perlvar'}->{'lonBalancer'} eq 'yes') {
1228: $currbalancer = $server;
1229: $currtargets = {};
1230: if (ref($returnhash->{'spareid'}) eq 'HASH') {
1231: if (ref($returnhash->{'spareid'}->{'primary'}) eq 'ARRAY') {
1232: $currtargets->{'primary'} = $returnhash->{'spareid'}->{'primary'};
1233: }
1234: if (ref($returnhash->{'spareid'}->{'default'}) eq 'ARRAY') {
1235: $currtargets->{'default'} = $returnhash->{'spareid'}->{'default'};
1236: }
1237: }
1238: last;
1239: }
1240: }
1241: }
1242: }
1243: }
1244: }
1245: return ($currbalancer,$currtargets);
1246: }
1247:
1248: sub check_loadbalancing {
1249: my ($uname,$udom) = @_;
1.1191 raeburn 1250: my ($is_balancer,$currtargets,$currrules,$dom_in_use,$homeintdom,
1251: $rule_in_effect,$offloadto,$otherserver);
1.1129 raeburn 1252: my $lonhost = $perlvar{'lonHostID'};
1.1175 raeburn 1253: my @hosts = ¤t_machine_ids();
1.1129 raeburn 1254: my $uprimary_id = &Apache::lonnet::domain($udom,'primary');
1255: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
1256: my $intdom = &Apache::lonnet::internet_dom($lonhost);
1257: my $serverhomedom = &host_domain($lonhost);
1258:
1259: my $cachetime = 60*60*24;
1260:
1261: if (($uintdom ne '') && ($uintdom eq $intdom)) {
1262: $dom_in_use = $udom;
1263: $homeintdom = 1;
1264: } else {
1265: $dom_in_use = $serverhomedom;
1266: }
1267: my ($result,$cached)=&is_cached_new('loadbalancing',$dom_in_use);
1268: unless (defined($cached)) {
1269: my %domconfig =
1270: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
1271: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1272: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129 raeburn 1273: }
1274: }
1275: if (ref($result) eq 'HASH') {
1.1191 raeburn 1276: ($is_balancer,$currtargets,$currrules) =
1277: &check_balancer_result($result,@hosts);
1.1129 raeburn 1278: if ($is_balancer) {
1279: if (ref($currrules) eq 'HASH') {
1280: if ($homeintdom) {
1281: if ($uname ne '') {
1282: if (($currrules->{'_LC_adv'} ne '') || ($currrules->{'_LC_author'} ne '')) {
1283: my ($is_adv,$is_author) = &is_advanced_user($udom,$uname);
1284: if (($currrules->{'_LC_author'} ne '') && ($is_author)) {
1285: $rule_in_effect = $currrules->{'_LC_author'};
1286: } elsif (($currrules->{'_LC_adv'} ne '') && ($is_adv)) {
1287: $rule_in_effect = $currrules->{'_LC_adv'}
1288: }
1289: }
1290: if ($rule_in_effect eq '') {
1291: my %userenv = &userenvironment($udom,$uname,'inststatus');
1292: if ($userenv{'inststatus'} ne '') {
1293: my @statuses = map { &unescape($_); } split(/:/,$userenv{'inststatus'});
1294: my ($othertitle,$usertypes,$types) =
1295: &Apache::loncommon::sorted_inst_types($udom);
1296: if (ref($types) eq 'ARRAY') {
1297: foreach my $type (@{$types}) {
1298: if (grep(/^\Q$type\E$/,@statuses)) {
1299: if (exists($currrules->{$type})) {
1300: $rule_in_effect = $currrules->{$type};
1301: }
1302: }
1303: }
1304: }
1305: } else {
1306: if (exists($currrules->{'default'})) {
1307: $rule_in_effect = $currrules->{'default'};
1308: }
1309: }
1310: }
1311: } else {
1312: if (exists($currrules->{'default'})) {
1313: $rule_in_effect = $currrules->{'default'};
1314: }
1315: }
1316: } else {
1317: if ($currrules->{'_LC_external'} ne '') {
1318: $rule_in_effect = $currrules->{'_LC_external'};
1319: }
1320: }
1321: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1322: $uname,$udom);
1323: }
1324: }
1325: } elsif (($homeintdom) && ($udom ne $serverhomedom)) {
1326: my ($result,$cached)=&is_cached_new('loadbalancing',$serverhomedom);
1327: unless (defined($cached)) {
1328: my %domconfig =
1329: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
1330: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1.1130 raeburn 1331: $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
1.1129 raeburn 1332: }
1333: }
1334: if (ref($result) eq 'HASH') {
1.1191 raeburn 1335: ($is_balancer,$currtargets,$currrules) =
1336: &check_balancer_result($result,@hosts);
1337: if ($is_balancer) {
1.1129 raeburn 1338: if (ref($currrules) eq 'HASH') {
1339: if ($currrules->{'_LC_internetdom'} ne '') {
1340: $rule_in_effect = $currrules->{'_LC_internetdom'};
1341: }
1342: }
1343: $offloadto = &get_loadbalancer_targets($rule_in_effect,$currtargets,
1344: $uname,$udom);
1345: }
1346: } else {
1347: if ($perlvar{'lonBalancer'} eq 'yes') {
1348: $is_balancer = 1;
1349: $offloadto = &this_host_spares($dom_in_use);
1350: }
1351: }
1352: } else {
1353: if ($perlvar{'lonBalancer'} eq 'yes') {
1354: $is_balancer = 1;
1355: $offloadto = &this_host_spares($dom_in_use);
1356: }
1357: }
1.1176 raeburn 1358: if ($is_balancer) {
1359: my $lowest_load = 30000;
1360: if (ref($offloadto) eq 'HASH') {
1361: if (ref($offloadto->{'primary'}) eq 'ARRAY') {
1362: foreach my $try_server (@{$offloadto->{'primary'}}) {
1363: ($otherserver,$lowest_load) =
1364: &compare_server_load($try_server,$otherserver,$lowest_load);
1365: }
1.1129 raeburn 1366: }
1.1176 raeburn 1367: my $found_server = ($otherserver ne '' && $lowest_load < 100);
1.1129 raeburn 1368:
1.1176 raeburn 1369: if (!$found_server) {
1370: if (ref($offloadto->{'default'}) eq 'ARRAY') {
1371: foreach my $try_server (@{$offloadto->{'default'}}) {
1372: ($otherserver,$lowest_load) =
1373: &compare_server_load($try_server,$otherserver,$lowest_load);
1374: }
1375: }
1376: }
1377: } elsif (ref($offloadto) eq 'ARRAY') {
1378: if (@{$offloadto} == 1) {
1379: $otherserver = $offloadto->[0];
1380: } elsif (@{$offloadto} > 1) {
1381: foreach my $try_server (@{$offloadto}) {
1.1129 raeburn 1382: ($otherserver,$lowest_load) =
1383: &compare_server_load($try_server,$otherserver,$lowest_load);
1384: }
1385: }
1386: }
1.1176 raeburn 1387: if (($otherserver ne '') && (grep(/^\Q$otherserver\E$/,@hosts))) {
1388: $is_balancer = 0;
1389: if ($uname ne '' && $udom ne '') {
1390: if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
1391:
1392: &appenv({'user.loadbalexempt' => $lonhost,
1393: 'user.loadbalcheck.time' => time});
1394: }
1.1129 raeburn 1395: }
1396: }
1397: }
1398: return ($is_balancer,$otherserver);
1399: }
1400:
1.1191 raeburn 1401: sub check_balancer_result {
1402: my ($result,@hosts) = @_;
1403: my ($is_balancer,$currtargets,$currrules);
1404: if (ref($result) eq 'HASH') {
1405: if ($result->{'lonhost'} ne '') {
1406: my $currbalancer = $result->{'lonhost'};
1407: if (grep(/^\Q$currbalancer\E$/,@hosts)) {
1408: $is_balancer = 1;
1409: $currtargets = $result->{'targets'};
1410: $currrules = $result->{'rules'};
1411: }
1412: } else {
1413: foreach my $key (keys(%{$result})) {
1414: if (($key ne '') && (grep(/^\Q$key\E$/,@hosts)) &&
1415: (ref($result->{$key}) eq 'HASH')) {
1416: $is_balancer = 1;
1417: $currrules = $result->{$key}{'rules'};
1418: $currtargets = $result->{$key}{'targets'};
1419: last;
1420: }
1421: }
1422: }
1423: }
1424: return ($is_balancer,$currtargets,$currrules);
1425: }
1426:
1.1129 raeburn 1427: sub get_loadbalancer_targets {
1428: my ($rule_in_effect,$currtargets,$uname,$udom) = @_;
1429: my $offloadto;
1.1175 raeburn 1430: if ($rule_in_effect eq 'none') {
1431: return [$perlvar{'lonHostID'}];
1432: } elsif ($rule_in_effect eq '') {
1.1129 raeburn 1433: $offloadto = $currtargets;
1434: } else {
1435: if ($rule_in_effect eq 'homeserver') {
1436: my $homeserver = &homeserver($uname,$udom);
1437: if ($homeserver ne 'no_host') {
1438: $offloadto = [$homeserver];
1439: }
1440: } elsif ($rule_in_effect eq 'externalbalancer') {
1441: my %domconfig =
1442: &Apache::lonnet::get_dom('configuration',['loadbalancing'],$udom);
1443: if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
1444: if ($domconfig{'loadbalancing'}{'lonhost'} ne '') {
1445: if (&hostname($domconfig{'loadbalancing'}{'lonhost'}) ne '') {
1446: $offloadto = [$domconfig{'loadbalancing'}{'lonhost'}];
1447: }
1448: }
1449: } else {
1.1178 raeburn 1450: my %servers = &internet_dom_servers($udom);
1.1129 raeburn 1451: my ($remotebalancer,$remotetargets) = &get_lonbalancer_config(\%servers);
1452: if (&hostname($remotebalancer) ne '') {
1453: $offloadto = [$remotebalancer];
1454: }
1455: }
1456: } elsif (&hostname($rule_in_effect) ne '') {
1457: $offloadto = [$rule_in_effect];
1458: }
1459: }
1460: return $offloadto;
1461: }
1462:
1.1127 raeburn 1463: sub internet_dom_servers {
1464: my ($dom) = @_;
1465: my (%uniqservers,%servers);
1466: my $primaryserver = &hostname(&domain($dom,'primary'));
1467: my @machinedoms = &machine_domains($primaryserver);
1468: foreach my $mdom (@machinedoms) {
1469: my %currservers = %servers;
1470: my %server = &get_servers($mdom);
1471: %servers = (%currservers,%server);
1472: }
1473: my %by_hostname;
1474: foreach my $id (keys(%servers)) {
1475: push(@{$by_hostname{$servers{$id}}},$id);
1476: }
1477: foreach my $hostname (sort(keys(%by_hostname))) {
1478: if (@{$by_hostname{$hostname}} > 1) {
1479: my $match = 0;
1480: foreach my $id (@{$by_hostname{$hostname}}) {
1481: if (&host_domain($id) eq $dom) {
1482: $uniqservers{$id} = $hostname;
1483: $match = 1;
1484: }
1485: }
1486: unless ($match) {
1487: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1488: }
1489: } else {
1490: $uniqservers{$by_hostname{$hostname}[0]} = $hostname;
1491: }
1492: }
1493: return %uniqservers;
1494: }
1495:
1.1 albertel 1496: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 1497:
1.599 albertel 1498: my %homecache;
1.1 albertel 1499: sub homeserver {
1.230 stredwic 1500: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 1501: my $index="$uname:$udom";
1.426 albertel 1502:
1.599 albertel 1503: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 1504:
1505: my %servers = &get_servers($udom,'library');
1506: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 1507: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 1508: exists($badServerCache{$tryserver}));
1.841 albertel 1509:
1510: my $answer=reply("home:$udom:$uname",$tryserver);
1511: if ($answer eq 'found') {
1512: delete($badServerCache{$tryserver});
1513: return $homecache{$index}=$tryserver;
1514: } elsif ($answer eq 'no_host') {
1515: $badServerCache{$tryserver}=1;
1516: }
1.1 albertel 1517: }
1518: return 'no_host';
1.70 www 1519: }
1520:
1521: # ------------------------------------- Find the usernames behind a list of IDs
1522:
1523: sub idget {
1524: my ($udom,@ids)=@_;
1525: my %returnhash=();
1526:
1.841 albertel 1527: my %servers = &get_servers($udom,'library');
1528: foreach my $tryserver (keys(%servers)) {
1529: my $idlist=join('&',@ids);
1530: $idlist=~tr/A-Z/a-z/;
1531: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
1532: my @answer=();
1533: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
1534: @answer=split(/\&/,$reply);
1535: } ;
1536: my $i;
1537: for ($i=0;$i<=$#ids;$i++) {
1538: if ($answer[$i]) {
1539: $returnhash{$ids[$i]}=$answer[$i];
1540: }
1541: }
1542: }
1.70 www 1543: return %returnhash;
1544: }
1545:
1546: # ------------------------------------- Find the IDs behind a list of usernames
1547:
1548: sub idrget {
1549: my ($udom,@unames)=@_;
1550: my %returnhash=();
1.800 albertel 1551: foreach my $uname (@unames) {
1552: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 1553: }
1.70 www 1554: return %returnhash;
1555: }
1556:
1557: # ------------------------------- Store away a list of names and associated IDs
1558:
1559: sub idput {
1560: my ($udom,%ids)=@_;
1561: my %servers=();
1.800 albertel 1562: foreach my $uname (keys(%ids)) {
1563: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
1564: my $uhom=&homeserver($uname,$udom);
1.70 www 1565: if ($uhom ne 'no_host') {
1.800 albertel 1566: my $id=&escape($ids{$uname});
1.70 www 1567: $id=~tr/A-Z/a-z/;
1.800 albertel 1568: my $esc_unam=&escape($uname);
1.70 www 1569: if ($servers{$uhom}) {
1.800 albertel 1570: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 1571: } else {
1.800 albertel 1572: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 1573: }
1574: }
1.191 harris41 1575: }
1.800 albertel 1576: foreach my $server (keys(%servers)) {
1577: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 1578: }
1.344 www 1579: }
1580:
1.1231 raeburn 1581: # ---------------------------------------- Delete unwanted IDs from ids.db file
1582:
1583: sub iddel {
1584: my ($udom,$idshashref,$uhome)=@_;
1585: my %result=();
1586: unless (ref($idshashref) eq 'HASH') {
1587: return %result;
1588: }
1589: my %servers=();
1590: while (my ($id,$uname) = each(%{$idshashref})) {
1591: my $uhom;
1592: if ($uhome) {
1593: $uhom = $uhome;
1594: } else {
1595: $uhom=&homeserver($uname,$udom);
1596: }
1597: if ($uhom ne 'no_host') {
1598: if ($servers{$uhom}) {
1599: $servers{$uhom}.='&'.&escape($id);
1600: } else {
1601: $servers{$uhom}=&escape($id);
1602: }
1603: }
1604: }
1605: foreach my $server (keys(%servers)) {
1606: $result{$server} = &critical('iddel:'.$udom.':'.$servers{$server},$uhome);
1607: }
1608: return %result;
1609: }
1610:
1.1023 raeburn 1611: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 1612: sub dump_dom {
1.1165 droeschl 1613: my ($namespace, $udom, $regexp) = @_;
1614:
1615: $udom ||= $env{'user.domain'};
1616:
1617: return () unless $udom;
1618:
1619: return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
1.1012 raeburn 1620: }
1621:
1.1023 raeburn 1622: # ------------------------------------------ get items from domain db files
1.806 raeburn 1623:
1624: sub get_dom {
1.860 raeburn 1625: my ($namespace,$storearr,$udom,$uhome)=@_;
1.806 raeburn 1626: my $items='';
1627: foreach my $item (@$storearr) {
1628: $items.=&escape($item).'&';
1629: }
1630: $items=~s/\&$//;
1.860 raeburn 1631: if (!$udom) {
1632: $udom=$env{'user.domain'};
1633: if (defined(&domain($udom,'primary'))) {
1634: $uhome=&domain($udom,'primary');
1635: } else {
1.874 albertel 1636: undef($uhome);
1.860 raeburn 1637: }
1638: } else {
1639: if (!$uhome) {
1640: if (defined(&domain($udom,'primary'))) {
1641: $uhome=&domain($udom,'primary');
1642: }
1643: }
1644: }
1645: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1646: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 1647: my %returnhash;
1.875 albertel 1648: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1649: return %returnhash;
1650: }
1.806 raeburn 1651: my @pairs=split(/\&/,$rep);
1652: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1653: return @pairs;
1654: }
1655: my $i=0;
1656: foreach my $item (@$storearr) {
1657: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1658: $i++;
1659: }
1660: return %returnhash;
1661: } else {
1.880 banghart 1662: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1663: }
1664: }
1665:
1666: # -------------------------------------------- put items in domain db files
1667:
1668: sub put_dom {
1.860 raeburn 1669: my ($namespace,$storehash,$udom,$uhome)=@_;
1670: if (!$udom) {
1671: $udom=$env{'user.domain'};
1672: if (defined(&domain($udom,'primary'))) {
1673: $uhome=&domain($udom,'primary');
1674: } else {
1.874 albertel 1675: undef($uhome);
1.860 raeburn 1676: }
1677: } else {
1678: if (!$uhome) {
1679: if (defined(&domain($udom,'primary'))) {
1680: $uhome=&domain($udom,'primary');
1681: }
1682: }
1683: }
1684: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1685: my $items='';
1686: foreach my $item (keys(%$storehash)) {
1687: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1688: }
1689: $items=~s/\&$//;
1690: return &reply("putdom:$udom:$namespace:$items",$uhome);
1691: } else {
1.860 raeburn 1692: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1693: }
1694: }
1695:
1.1023 raeburn 1696: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 1697: sub newput_dom {
1.1023 raeburn 1698: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 1699: my $result;
1700: if (!$udom) {
1701: $udom=$env{'user.domain'};
1702: }
1.1023 raeburn 1703: if ($udom) {
1704: my $uname = &get_domainconfiguser($udom);
1705: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 1706: }
1707: return $result;
1708: }
1709:
1.1023 raeburn 1710: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 1711: sub del_dom {
1.1023 raeburn 1712: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 1713: if (ref($storearr) eq 'ARRAY') {
1714: if (!$udom) {
1715: $udom=$env{'user.domain'};
1716: }
1.1023 raeburn 1717: if ($udom) {
1718: my $uname = &get_domainconfiguser($udom);
1719: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 1720: }
1721: }
1722: }
1723:
1.1023 raeburn 1724: # ----------------------------------construct domainconfig user for a domain
1725: sub get_domainconfiguser {
1726: my ($udom) = @_;
1727: return $udom.'-domainconfig';
1728: }
1729:
1.837 raeburn 1730: sub retrieve_inst_usertypes {
1731: my ($udom) = @_;
1732: my (%returnhash,@order);
1.989 raeburn 1733: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1734: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1735: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1736: %returnhash = %{$domdefs{'inststatustypes'}};
1737: @order = @{$domdefs{'inststatusorder'}};
1738: } else {
1739: if (defined(&domain($udom,'primary'))) {
1740: my $uhome=&domain($udom,'primary');
1741: my $rep=&reply("inst_usertypes:$udom",$uhome);
1742: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1743: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1744: return (\%returnhash,\@order);
1745: }
1746: my ($hashitems,$orderitems) = split(/:/,$rep);
1747: my @pairs=split(/\&/,$hashitems);
1748: foreach my $item (@pairs) {
1749: my ($key,$value)=split(/=/,$item,2);
1750: $key = &unescape($key);
1751: next if ($key =~ /^error: 2 /);
1752: $returnhash{$key}=&thaw_unescape($value);
1753: }
1754: my @esc_order = split(/\&/,$orderitems);
1755: foreach my $item (@esc_order) {
1756: push(@order,&unescape($item));
1757: }
1758: } else {
1759: &logthis("get_dom failed - no primary domain server for $udom");
1.837 raeburn 1760: }
1761: }
1762: return (\%returnhash,\@order);
1763: }
1764:
1.868 raeburn 1765: sub is_domainimage {
1766: my ($url) = @_;
1767: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1768: if (&domain($1) ne '') {
1769: return '1';
1770: }
1771: }
1772: return;
1773: }
1774:
1.899 raeburn 1775: sub inst_directory_query {
1776: my ($srch) = @_;
1777: my $udom = $srch->{'srchdomain'};
1778: my %results;
1779: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1780: my $outcome;
1.899 raeburn 1781: if ($homeserver ne '') {
1.904 albertel 1782: my $queryid=&reply("querysend:instdirsearch:".
1783: &escape($srch->{'srchby'}).':'.
1784: &escape($srch->{'srchterm'}).':'.
1785: &escape($srch->{'srchtype'}),$homeserver);
1786: my $host=&hostname($homeserver);
1787: if ($queryid !~/^\Q$host\E\_/) {
1788: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1789: return;
1790: }
1791: my $response = &get_query_reply($queryid);
1792: my $maxtries = 5;
1793: my $tries = 1;
1794: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1795: $response = &get_query_reply($queryid);
1796: $tries ++;
1797: }
1798:
1799: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1800: if ($response eq 'unavailable') {
1801: $outcome = $response;
1802: } else {
1803: $outcome = 'ok';
1804: my @matches = split(/\n/,$response);
1805: foreach my $match (@matches) {
1806: my ($key,$value) = split(/=/,$match);
1807: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1808: }
1.899 raeburn 1809: }
1810: }
1811: }
1.909 raeburn 1812: return ($outcome,%results);
1.899 raeburn 1813: }
1814:
1815: sub usersearch {
1816: my ($srch) = @_;
1817: my $dom = $srch->{'srchdomain'};
1818: my %results;
1819: my %libserv = &all_library();
1820: my $query = 'usersearch';
1821: foreach my $tryserver (keys(%libserv)) {
1822: if (&host_domain($tryserver) eq $dom) {
1823: my $host=&hostname($tryserver);
1824: my $queryid=
1.911 raeburn 1825: &reply("querysend:".&escape($query).':'.
1826: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1827: &escape($srch->{'srchtype'}).':'.
1828: &escape($srch->{'srchterm'}),$tryserver);
1829: if ($queryid !~/^\Q$host\E\_/) {
1830: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1831: next;
1.899 raeburn 1832: }
1833: my $reply = &get_query_reply($queryid);
1834: my $maxtries = 1;
1835: my $tries = 1;
1836: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1837: $reply = &get_query_reply($queryid);
1838: $tries ++;
1839: }
1840: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1841: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1842: } else {
1.911 raeburn 1843: my @matches;
1844: if ($reply =~ /\n/) {
1845: @matches = split(/\n/,$reply);
1846: } else {
1847: @matches = split(/\&/,$reply);
1848: }
1.899 raeburn 1849: foreach my $match (@matches) {
1850: my ($uname,$udom,%userhash);
1.911 raeburn 1851: foreach my $entry (split(/:/,$match)) {
1852: my ($key,$value) =
1853: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1854: $userhash{$key} = $value;
1855: if ($key eq 'username') {
1856: $uname = $value;
1857: } elsif ($key eq 'domain') {
1858: $udom = $value;
1.911 raeburn 1859: }
1.899 raeburn 1860: }
1861: $results{$uname.':'.$udom} = \%userhash;
1862: }
1863: }
1864: }
1865: }
1866: return %results;
1867: }
1868:
1.912 raeburn 1869: sub get_instuser {
1870: my ($udom,$uname,$id) = @_;
1871: my $homeserver = &domain($udom,'primary');
1872: my ($outcome,%results);
1873: if ($homeserver ne '') {
1874: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1875: &escape($id).':'.&escape($udom),$homeserver);
1876: my $host=&hostname($homeserver);
1877: if ($queryid !~/^\Q$host\E\_/) {
1878: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1879: return;
1880: }
1881: my $response = &get_query_reply($queryid);
1882: my $maxtries = 5;
1883: my $tries = 1;
1884: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1885: $response = &get_query_reply($queryid);
1886: $tries ++;
1887: }
1888: if (!&error($response) && $response ne 'refused') {
1889: if ($response eq 'unavailable') {
1890: $outcome = $response;
1891: } else {
1892: $outcome = 'ok';
1893: my @matches = split(/\n/,$response);
1894: foreach my $match (@matches) {
1895: my ($key,$value) = split(/=/,$match);
1896: $results{&unescape($key)} = &thaw_unescape($value);
1897: }
1898: }
1899: }
1900: }
1901: my %userinfo;
1902: if (ref($results{$uname}) eq 'HASH') {
1903: %userinfo = %{$results{$uname}};
1904: }
1905: return ($outcome,%userinfo);
1906: }
1907:
1908: sub inst_rulecheck {
1.923 raeburn 1909: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 1910: my %returnhash;
1911: if ($udom ne '') {
1912: if (ref($rules) eq 'ARRAY') {
1913: @{$rules} = map {&escape($_);} (@{$rules});
1914: my $rulestr = join(':',@{$rules});
1915: my $homeserver=&domain($udom,'primary');
1916: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1917: my $response;
1918: if ($item eq 'username') {
1919: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1920: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 1921: $homeserver));
1.923 raeburn 1922: } elsif ($item eq 'id') {
1923: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1924: ':'.&escape($id).':'.$rulestr,
1925: $homeserver));
1.945 raeburn 1926: } elsif ($item eq 'selfcreate') {
1927: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 1928: &escape($udom).':'.&escape($uname).
1929: ':'.$rulestr,$homeserver));
1.923 raeburn 1930: }
1.912 raeburn 1931: if ($response ne 'refused') {
1932: my @pairs=split(/\&/,$response);
1933: foreach my $item (@pairs) {
1934: my ($key,$value)=split(/=/,$item,2);
1935: $key = &unescape($key);
1936: next if ($key =~ /^error: 2 /);
1937: $returnhash{$key}=&thaw_unescape($value);
1938: }
1939: }
1940: }
1941: }
1942: }
1943: return %returnhash;
1944: }
1945:
1946: sub inst_userrules {
1.923 raeburn 1947: my ($udom,$check) = @_;
1.912 raeburn 1948: my (%ruleshash,@ruleorder);
1949: if ($udom ne '') {
1950: my $homeserver=&domain($udom,'primary');
1951: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1952: my $response;
1953: if ($check eq 'id') {
1954: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 1955: $homeserver);
1.943 raeburn 1956: } elsif ($check eq 'email') {
1957: $response=&reply('instemailrules:'.&escape($udom),
1958: $homeserver);
1.923 raeburn 1959: } else {
1960: $response=&reply('instuserrules:'.&escape($udom),
1961: $homeserver);
1962: }
1.912 raeburn 1963: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 1964: ($response ne 'unknown_cmd') &&
1.912 raeburn 1965: ($response ne 'no_such_host')) {
1966: my ($hashitems,$orderitems) = split(/:/,$response);
1967: my @pairs=split(/\&/,$hashitems);
1968: foreach my $item (@pairs) {
1969: my ($key,$value)=split(/=/,$item,2);
1970: $key = &unescape($key);
1971: next if ($key =~ /^error: 2 /);
1972: $ruleshash{$key}=&thaw_unescape($value);
1973: }
1974: my @esc_order = split(/\&/,$orderitems);
1975: foreach my $item (@esc_order) {
1976: push(@ruleorder,&unescape($item));
1977: }
1978: }
1979: }
1980: }
1981: return (\%ruleshash,\@ruleorder);
1982: }
1983:
1.976 raeburn 1984: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 1985:
1986: sub get_domain_defaults {
1987: my ($domain) = @_;
1988: my $cachetime = 60*60*24;
1989: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1990: if (defined($cached)) {
1991: if (ref($result) eq 'HASH') {
1992: return %{$result};
1993: }
1994: }
1995: my %domdefaults;
1996: my %domconfig =
1.989 raeburn 1997: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 1998: 'requestcourses','inststatus',
1.1183 raeburn 1999: 'coursedefaults','usersessions',
2000: 'requestauthor'],$domain);
1.943 raeburn 2001: if (ref($domconfig{'defaults'}) eq 'HASH') {
2002: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
2003: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
2004: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 2005: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 2006: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.1147 raeburn 2007: $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
1.943 raeburn 2008: } else {
2009: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
2010: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
2011: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
2012: }
1.976 raeburn 2013: if (ref($domconfig{'quotas'}) eq 'HASH') {
2014: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
2015: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
2016: } else {
2017: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1.1229 raeburn 2018: }
1.1177 raeburn 2019: my @usertools = ('aboutme','blog','webdav','portfolio');
1.976 raeburn 2020: foreach my $item (@usertools) {
2021: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
2022: $domdefaults{$item} = $domconfig{'quotas'}{$item};
2023: }
2024: }
1.1229 raeburn 2025: if (ref($domconfig{'quotas'}{'authorquota'}) eq 'HASH') {
2026: $domdefaults{'authorquota'} = $domconfig{'quotas'}{'authorquota'};
2027: }
1.976 raeburn 2028: }
1.985 raeburn 2029: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1006 raeburn 2030: foreach my $item ('official','unofficial','community') {
1.985 raeburn 2031: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
2032: }
2033: }
1.1183 raeburn 2034: if (ref($domconfig{'requestauthor'}) eq 'HASH') {
2035: $domdefaults{'requestauthor'} = $domconfig{'requestauthor'};
2036: }
1.989 raeburn 2037: if (ref($domconfig{'inststatus'}) eq 'HASH') {
2038: foreach my $item ('inststatustypes','inststatusorder') {
2039: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
2040: }
2041: }
1.1047 raeburn 2042: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1.1230 raeburn 2043: $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
1.1216 raeburn 2044: if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
2045: $domdefaults{'officialcredits'} = $domconfig{'coursedefaults'}{'coursecredits'}{'official'};
2046: $domdefaults{'unofficialcredits'} = $domconfig{'coursedefaults'}{'coursecredits'}{'unofficial'};
2047: }
1.1230 raeburn 2048: if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
2049: $domdefaults{'officialquota'} = $domconfig{'coursedefaults'}{'uploadquota'}{'official'};
2050: $domdefaults{'unofficialquota'} = $domconfig{'coursedefaults'}{'uploadquota'}{'unofficial'};
2051: $domdefaults{'communityquota'} = $domconfig{'coursedefaults'}{'uploadquota'}{'community'};
2052: }
1.1047 raeburn 2053: }
1.1073 raeburn 2054: if (ref($domconfig{'usersessions'}) eq 'HASH') {
2055: if (ref($domconfig{'usersessions'}{'remote'}) eq 'HASH') {
2056: $domdefaults{'remotesessions'} = $domconfig{'usersessions'}{'remote'};
2057: }
2058: if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
2059: $domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
2060: }
2061: }
1.1219 raeburn 2062: &do_cache_new('domdefaults',$domain,\%domdefaults,$cachetime);
1.943 raeburn 2063: return %domdefaults;
2064: }
2065:
1.344 www 2066: # --------------------------------------------------- Assign a key to a student
2067:
2068: sub assign_access_key {
1.364 www 2069: #
2070: # a valid key looks like uname:udom#comments
2071: # comments are being appended
2072: #
1.498 www 2073: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
2074: $kdom=
1.620 albertel 2075: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 2076: $knum=
1.620 albertel 2077: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 2078: $cdom=
1.620 albertel 2079: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2080: $cnum=
1.620 albertel 2081: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2082: $udom=$env{'user.name'} unless (defined($udom));
2083: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 2084: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 2085: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 2086: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 2087: # assigned to this person
2088: # - this should not happen,
1.345 www 2089: # unless something went wrong
2090: # the first time around
2091: # ready to assign
1.364 www 2092: $logentry=$1.'; '.$logentry;
1.496 www 2093: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 2094: $kdom,$knum) eq 'ok') {
1.345 www 2095: # key now belongs to user
1.346 www 2096: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 2097: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 2098: &appenv({'environment.'.$envkey => $ckey});
1.345 www 2099: return 'ok';
2100: } else {
2101: return
2102: 'error: Count not permanently assign key, will need to be re-entered later.';
2103: }
2104: } else {
2105: return 'error: Could not assign key, try again later.';
2106: }
1.364 www 2107: } elsif (!$existing{$ckey}) {
1.345 www 2108: # the key does not exist
2109: return 'error: The key does not exist';
2110: } else {
2111: # the key is somebody else's
2112: return 'error: The key is already in use';
2113: }
1.344 www 2114: }
2115:
1.364 www 2116: # ------------------------------------------ put an additional comment on a key
2117:
2118: sub comment_access_key {
2119: #
2120: # a valid key looks like uname:udom#comments
2121: # comments are being appended
2122: #
2123: my ($ckey,$cdom,$cnum,$logentry)=@_;
2124: $cdom=
1.620 albertel 2125: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 2126: $cnum=
1.620 albertel 2127: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 2128: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
2129: if ($existing{$ckey}) {
2130: $existing{$ckey}.='; '.$logentry;
2131: # ready to assign
1.367 www 2132: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 2133: $cdom,$cnum) eq 'ok') {
2134: return 'ok';
2135: } else {
2136: return 'error: Count not store comment.';
2137: }
2138: } else {
2139: # the key does not exist
2140: return 'error: The key does not exist';
2141: }
2142: }
2143:
1.344 www 2144: # ------------------------------------------------------ Generate a set of keys
2145:
2146: sub generate_access_keys {
1.364 www 2147: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 2148: $cdom=
1.620 albertel 2149: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2150: $cnum=
1.620 albertel 2151: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 2152: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 2153: unless (($cdom) && ($cnum)) { return 0; }
2154: if ($number>10000) { return 0; }
2155: sleep(2); # make sure don't get same seed twice
2156: srand(time()^($$+($$<<15))); # from "Programming Perl"
2157: my $total=0;
2158: for (my $i=1;$i<=$number;$i++) {
2159: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
2160: sprintf("%lx",int(100000*rand)).'-'.
2161: sprintf("%lx",int(100000*rand));
2162: $newkey=~s/1/g/g; # folks mix up 1 and l
2163: $newkey=~s/0/h/g; # and also 0 and O
2164: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
2165: if ($existing{$newkey}) {
2166: $i--;
2167: } else {
1.364 www 2168: if (&put('accesskeys',
2169: { $newkey => '# generated '.localtime().
1.620 albertel 2170: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 2171: '; '.$logentry },
2172: $cdom,$cnum) eq 'ok') {
1.344 www 2173: $total++;
2174: }
2175: }
2176: }
1.620 albertel 2177: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 2178: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
2179: return $total;
2180: }
2181:
2182: # ------------------------------------------------------- Validate an accesskey
2183:
2184: sub validate_access_key {
2185: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
2186: $cdom=
1.620 albertel 2187: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 2188: $cnum=
1.620 albertel 2189: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
2190: $udom=$env{'user.domain'} unless (defined($udom));
2191: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 2192: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 2193: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 2194: }
2195:
2196: # ------------------------------------- Find the section of student in a course
1.652 albertel 2197: sub devalidate_getsection_cache {
2198: my ($udom,$unam,$courseid)=@_;
2199: my $hashid="$udom:$unam:$courseid";
2200: &devalidate_cache_new('getsection',$hashid);
2201: }
1.298 matthew 2202:
1.815 albertel 2203: sub courseid_to_courseurl {
2204: my ($courseid) = @_;
2205: #already url style courseid
2206: return $courseid if ($courseid =~ m{^/});
2207:
2208: if (exists($env{'course.'.$courseid.'.num'})) {
2209: my $cnum = $env{'course.'.$courseid.'.num'};
2210: my $cdom = $env{'course.'.$courseid.'.domain'};
2211: return "/$cdom/$cnum";
2212: }
2213:
2214: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
2215: if (exists($courseinfo{'num'})) {
2216: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
2217: }
2218:
2219: return undef;
2220: }
2221:
1.298 matthew 2222: sub getsection {
2223: my ($udom,$unam,$courseid)=@_;
1.599 albertel 2224: my $cachetime=1800;
1.551 albertel 2225:
2226: my $hashid="$udom:$unam:$courseid";
1.599 albertel 2227: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 2228: if (defined($cached)) { return $result; }
2229:
1.298 matthew 2230: my %Pending;
2231: my %Expired;
2232: #
2233: # Each role can either have not started yet (pending), be active,
2234: # or have expired.
2235: #
2236: # If there is an active role, we are done.
2237: #
2238: # If there is more than one role which has not started yet,
2239: # choose the one which will start sooner
2240: # If there is one role which has not started yet, return it.
2241: #
2242: # If there is more than one expired role, choose the one which ended last.
2243: # If there is a role which has expired, return it.
2244: #
1.815 albertel 2245: $courseid = &courseid_to_courseurl($courseid);
1.1166 raeburn 2246: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1.817 raeburn 2247: foreach my $key (keys(%roleshash)) {
1.479 albertel 2248: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 2249: my $section=$1;
2250: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 2251: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 2252: my $now=time;
1.548 albertel 2253: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 2254: $Expired{$end}=$section;
2255: next;
2256: }
1.548 albertel 2257: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 2258: $Pending{$start}=$section;
2259: next;
2260: }
1.599 albertel 2261: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 2262: }
2263: #
2264: # Presumedly there will be few matching roles from the above
2265: # loop and the sorting time will be negligible.
2266: if (scalar(keys(%Pending))) {
2267: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 2268: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 2269: }
2270: if (scalar(keys(%Expired))) {
2271: my @sorted = sort {$a <=> $b} keys(%Expired);
2272: my $time = pop(@sorted);
1.599 albertel 2273: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 2274: }
1.599 albertel 2275: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 2276: }
1.70 www 2277:
1.599 albertel 2278: sub save_cache {
2279: &purge_remembered();
1.722 albertel 2280: #&Apache::loncommon::validate_page();
1.620 albertel 2281: undef(%env);
1.780 albertel 2282: undef($env_loaded);
1.599 albertel 2283: }
1.452 albertel 2284:
1.599 albertel 2285: my $to_remember=-1;
2286: my %remembered;
2287: my %accessed;
2288: my $kicks=0;
2289: my $hits=0;
1.849 albertel 2290: sub make_key {
2291: my ($name,$id) = @_;
1.872 albertel 2292: if (length($id) > 65
2293: && length(&escape($id)) > 200) {
2294: $id=length($id).':'.&Digest::MD5::md5_hex($id);
2295: }
1.849 albertel 2296: return &escape($name.':'.$id);
2297: }
2298:
1.599 albertel 2299: sub devalidate_cache_new {
2300: my ($name,$id,$debug) = @_;
2301: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 2302: $id=&make_key($name,$id);
1.599 albertel 2303: $memcache->delete($id);
2304: delete($remembered{$id});
2305: delete($accessed{$id});
2306: }
2307:
2308: sub is_cached_new {
2309: my ($name,$id,$debug) = @_;
1.849 albertel 2310: $id=&make_key($name,$id);
1.599 albertel 2311: if (exists($remembered{$id})) {
1.1133 foxr 2312: if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
1.599 albertel 2313: $accessed{$id}=[&gettimeofday()];
2314: $hits++;
2315: return ($remembered{$id},1);
2316: }
2317: my $value = $memcache->get($id);
2318: if (!(defined($value))) {
2319: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 2320: return (undef,undef);
1.416 albertel 2321: }
1.599 albertel 2322: if ($value eq '__undef__') {
2323: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
2324: $value=undef;
2325: }
2326: &make_room($id,$value,$debug);
2327: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
2328: return ($value,1);
2329: }
2330:
2331: sub do_cache_new {
2332: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 2333: $id=&make_key($name,$id);
1.599 albertel 2334: my $setvalue=$value;
2335: if (!defined($setvalue)) {
2336: $setvalue='__undef__';
2337: }
1.623 albertel 2338: if (!defined($time) ) {
2339: $time=600;
2340: }
1.599 albertel 2341: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 2342: my $result = $memcache->set($id,$setvalue,$time);
2343: if (! $result) {
1.872 albertel 2344: &logthis("caching of id -> $id failed");
1.910 albertel 2345: $memcache->disconnect_all();
1.872 albertel 2346: }
1.600 albertel 2347: # need to make a copy of $value
1.919 albertel 2348: &make_room($id,$value,$debug);
1.599 albertel 2349: return $value;
2350: }
2351:
2352: sub make_room {
2353: my ($id,$value,$debug)=@_;
1.919 albertel 2354:
2355: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
2356: : $value;
1.599 albertel 2357: if ($to_remember<0) { return; }
2358: $accessed{$id}=[&gettimeofday()];
2359: if (scalar(keys(%remembered)) <= $to_remember) { return; }
2360: my $to_kick;
2361: my $max_time=0;
2362: foreach my $other (keys(%accessed)) {
2363: if (&tv_interval($accessed{$other}) > $max_time) {
2364: $to_kick=$other;
2365: $max_time=&tv_interval($accessed{$other});
2366: }
2367: }
2368: delete($remembered{$to_kick});
2369: delete($accessed{$to_kick});
2370: $kicks++;
2371: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 2372: return;
2373: }
2374:
1.599 albertel 2375: sub purge_remembered {
1.604 albertel 2376: #&logthis("Tossing ".scalar(keys(%remembered)));
2377: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 2378: undef(%remembered);
2379: undef(%accessed);
1.428 albertel 2380: }
1.70 www 2381: # ------------------------------------- Read an entry from a user's environment
2382:
2383: sub userenvironment {
2384: my ($udom,$unam,@what)=@_;
1.976 raeburn 2385: my $items;
2386: foreach my $item (@what) {
2387: $items.=&escape($item).'&';
2388: }
2389: $items=~s/\&$//;
1.70 www 2390: my %returnhash=();
1.1009 raeburn 2391: my $uhome = &homeserver($unam,$udom);
2392: unless ($uhome eq 'no_host') {
2393: my @answer=split(/\&/,
2394: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 2395: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
2396: return %returnhash;
2397: }
1.1009 raeburn 2398: my $i;
2399: for ($i=0;$i<=$#what;$i++) {
2400: $returnhash{$what[$i]}=&unescape($answer[$i]);
2401: }
1.70 www 2402: }
2403: return %returnhash;
1.1 albertel 2404: }
2405:
1.617 albertel 2406: # ---------------------------------------------------------- Get a studentphoto
2407: sub studentphoto {
2408: my ($udom,$unam,$ext) = @_;
2409: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 2410: if (defined($env{'request.course.id'})) {
1.708 raeburn 2411: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 2412: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
2413: return(&retrievestudentphoto($udom,$unam,$ext));
2414: } else {
2415: my ($result,$perm_reqd)=
1.707 albertel 2416: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2417: if ($result eq 'ok') {
2418: if (!($perm_reqd eq 'yes')) {
2419: return(&retrievestudentphoto($udom,$unam,$ext));
2420: }
2421: }
2422: }
2423: }
2424: } else {
2425: my ($result,$perm_reqd) =
1.707 albertel 2426: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 2427: if ($result eq 'ok') {
2428: if (!($perm_reqd eq 'yes')) {
2429: return(&retrievestudentphoto($udom,$unam,$ext));
2430: }
2431: }
2432: }
2433: return '/adm/lonKaputt/lonlogo_broken.gif';
2434: }
2435:
2436: sub retrievestudentphoto {
2437: my ($udom,$unam,$ext,$type) = @_;
2438: my $home=&Apache::lonnet::homeserver($unam,$udom);
2439: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
2440: if ($ret eq 'ok') {
2441: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
2442: if ($type eq 'thumbnail') {
2443: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
2444: }
2445: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
2446: return $tokenurl;
2447: } else {
2448: if ($type eq 'thumbnail') {
2449: return '/adm/lonKaputt/genericstudent_tn.gif';
2450: } else {
2451: return '/adm/lonKaputt/lonlogo_broken.gif';
2452: }
1.617 albertel 2453: }
2454: }
2455:
1.263 www 2456: # -------------------------------------------------------------------- New chat
2457:
2458: sub chatsend {
1.724 raeburn 2459: my ($newentry,$anon,$group)=@_;
1.620 albertel 2460: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
2461: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2462: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 2463: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 2464: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 2465: &escape($newentry)).':'.$group,$chome);
1.292 www 2466: }
2467:
2468: # ------------------------------------------ Find current version of a resource
2469:
2470: sub getversion {
2471: my $fname=&clutter(shift);
1.1189 raeburn 2472: unless ($fname=~m{^(/adm/wrapper|)/res/}) { return -1; }
1.292 www 2473: return ¤tversion(&filelocation('',$fname));
2474: }
2475:
2476: sub currentversion {
2477: my $fname=shift;
2478: my $author=$fname;
2479: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2480: my ($udom,$uname)=split(/\//,$author);
1.1112 www 2481: my $home=&homeserver($uname,$udom);
1.292 www 2482: if ($home eq 'no_host') {
2483: return -1;
2484: }
1.1112 www 2485: my $answer=&reply("currentversion:$fname",$home);
1.292 www 2486: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2487: return -1;
2488: }
1.1112 www 2489: return $answer;
1.263 www 2490: }
2491:
1.1111 www 2492: #
2493: # Return special version number of resource if set by override, empty otherwise
2494: #
2495: sub usedversion {
2496: my $fname=shift;
2497: unless ($fname) { $fname=$env{'request.uri'}; }
2498: my ($urlversion)=($fname=~/\.(\d+)\.\w+$/);
2499: if ($urlversion) { return $urlversion; }
2500: return '';
2501: }
2502:
1.1 albertel 2503: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 2504:
1.1 albertel 2505: sub subscribe {
2506: my $fname=shift;
1.761 raeburn 2507: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 2508: $fname=~s/[\n\r]//g;
1.1 albertel 2509: my $author=$fname;
2510: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2511: my ($udom,$uname)=split(/\//,$author);
2512: my $home=homeserver($uname,$udom);
1.335 albertel 2513: if ($home eq 'no_host') {
2514: return 'not_found';
1.1 albertel 2515: }
2516: my $answer=reply("sub:$fname",$home);
1.64 www 2517: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
2518: $answer.=' by '.$home;
2519: }
1.1 albertel 2520: return $answer;
2521: }
2522:
1.8 www 2523: # -------------------------------------------------------------- Replicate file
2524:
2525: sub repcopy {
2526: my $filename=shift;
1.23 www 2527: $filename=~s/\/+/\//g;
1.1142 raeburn 2528: my $londocroot = $perlvar{'lonDocRoot'};
2529: if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
1.1164 raeburn 2530: if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.1142 raeburn 2531: if ($filename=~m{^\Q$londocroot/userfiles/\E} or
2532: $filename=~m{^/*(uploaded|editupload)/}) {
1.538 albertel 2533: return &repcopy_userfile($filename);
2534: }
1.532 albertel 2535: $filename=~s/[\n\r]//g;
1.8 www 2536: my $transname="$filename.in.transfer";
1.828 www 2537: # FIXME: this should flock
1.607 raeburn 2538: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 2539: my $remoteurl=subscribe($filename);
1.64 www 2540: if ($remoteurl =~ /^con_lost by/) {
2541: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2542: return 'unavailable';
1.8 www 2543: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 2544: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 2545: return 'not_found';
1.64 www 2546: } elsif ($remoteurl =~ /^rejected by/) {
2547: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 2548: return 'forbidden';
1.20 www 2549: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 2550: return 'ok';
1.8 www 2551: } else {
1.290 www 2552: my $author=$filename;
2553: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
2554: my ($udom,$uname)=split(/\//,$author);
2555: my $home=homeserver($uname,$udom);
2556: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 2557: my @parts=split(/\//,$filename);
2558: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1.1142 raeburn 2559: if ($path ne "$londocroot/res") {
1.8 www 2560: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 2561: return 'bad_request';
1.8 www 2562: }
2563: my $count;
2564: for ($count=5;$count<$#parts;$count++) {
2565: $path.="/$parts[$count]";
2566: if ((-e $path)!=1) {
2567: mkdir($path,0777);
2568: }
2569: }
2570: my $ua=new LWP::UserAgent;
2571: my $request=new HTTP::Request('GET',"$remoteurl");
2572: my $response=$ua->request($request,$transname);
2573: if ($response->is_error()) {
2574: unlink($transname);
2575: my $message=$response->status_line;
1.672 albertel 2576: &logthis("<font color=\"blue\">WARNING:"
1.12 www 2577: ." LWP get: $message: $filename</font>");
1.607 raeburn 2578: return 'unavailable';
1.8 www 2579: } else {
1.16 www 2580: if ($remoteurl!~/\.meta$/) {
2581: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
2582: my $mresponse=$ua->request($mrequest,$filename.'.meta');
2583: if ($mresponse->is_error()) {
2584: unlink($filename.'.meta');
2585: &logthis(
1.672 albertel 2586: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 2587: }
2588: }
1.8 www 2589: rename($transname,$filename);
1.607 raeburn 2590: return 'ok';
1.8 www 2591: }
1.290 www 2592: }
1.8 www 2593: }
1.330 www 2594: }
2595:
2596: # ------------------------------------------------ Get server side include body
2597: sub ssi_body {
1.381 albertel 2598: my ($filelink,%form)=@_;
1.606 matthew 2599: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
2600: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
2601: }
1.953 www 2602: my $output='';
2603: my $response;
1.980 raeburn 2604: if ($filelink=~/^https?\:/) {
1.954 raeburn 2605: ($output,$response)=&externalssi($filelink);
1.953 www 2606: } else {
1.1004 droeschl 2607: $filelink .= $filelink=~/\?/ ? '&' : '?';
2608: $filelink .= 'inhibitmenu=yes';
1.953 www 2609: ($output,$response)=&ssi($filelink,%form);
2610: }
1.778 albertel 2611: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 2612: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 2613: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 2614: if (wantarray) {
2615: return ($output, $response);
2616: } else {
2617: return $output;
2618: }
1.8 www 2619: }
2620:
1.15 www 2621: # --------------------------------------------------------- Server Side Include
2622:
1.782 albertel 2623: sub absolute_url {
2624: my ($host_name) = @_;
2625: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
2626: if ($host_name eq '') {
2627: $host_name = $ENV{'SERVER_NAME'};
2628: }
2629: return $protocol.$host_name;
2630: }
2631:
1.942 foxr 2632: #
2633: # Server side include.
2634: # Parameters:
2635: # fn Possibly encrypted resource name/id.
2636: # form Hash that describes how the rendering should be done
2637: # and other things.
1.944 foxr 2638: # Returns:
1.950 raeburn 2639: # Scalar context: The content of the response.
2640: # Array context: 2 element list of the content and the full response object.
1.942 foxr 2641: #
1.15 www 2642: sub ssi {
2643:
1.944 foxr 2644: my ($fn,%form)=@_;
1.15 www 2645: my $ua=new LWP::UserAgent;
1.23 www 2646: my $request;
1.711 albertel 2647:
2648: $form{'no_update_last_known'}=1;
1.895 albertel 2649: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 2650: if (%form) {
1.782 albertel 2651: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000 raeburn 2652: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23 www 2653: } else {
1.782 albertel 2654: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 2655: }
2656:
1.15 www 2657: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1.1173 foxr 2658: my $response= $ua->request($request);
1.1182 foxr 2659: my $content = $response->content;
2660:
2661:
1.944 foxr 2662: if (wantarray) {
1.1173 foxr 2663: return ($content, $response);
1.944 foxr 2664: } else {
1.1173 foxr 2665: return $content;
1.942 foxr 2666: }
1.324 www 2667: }
2668:
2669: sub externalssi {
2670: my ($url)=@_;
2671: my $ua=new LWP::UserAgent;
2672: my $request=new HTTP::Request('GET',$url);
2673: my $response=$ua->request($request);
1.954 raeburn 2674: if (wantarray) {
2675: return ($response->content, $response);
2676: } else {
2677: return $response->content;
2678: }
1.15 www 2679: }
1.254 www 2680:
1.492 albertel 2681: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2682:
2683: sub allowuploaded {
2684: my ($srcurl,$url)=@_;
2685: $url=&clutter(&declutter($url));
2686: my $dir=$url;
2687: $dir=~s/\/[^\/]+$//;
2688: my %httpref=();
2689: my $httpurl=&hreflocation('',$url);
2690: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2691: &Apache::lonnet::appenv(\%httpref);
1.254 www 2692: }
1.477 raeburn 2693:
1.1193 raeburn 2694: #
2695: # Determine if the current user should be able to edit a particular resource,
2696: # when viewing in course context.
2697: # (a) When viewing resource used to determine if "Edit" item is included in
2698: # Functions.
2699: # (b) When displaying folder contents in course editor, used to determine if
2700: # "Edit" link will be displayed alongside resource.
2701: #
1.1196 raeburn 2702: # input: six args -- filename (decluttered), course number, course domain,
2703: # url, symb (if registered) and group (if this is a group
2704: # item -- e.g., bulletin board, group page etc.).
2705: # output: array of five scalars --
1.1193 raeburn 2706: # $cfile -- url for file editing if editable on current server
2707: # $home -- homeserver of resource (i.e., for author if published,
2708: # or course if uploaded.).
2709: # $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 2710: # $forceedit -- 1 if icon/link should be to go to edit mode
2711: # $forceview -- 1 if icon/link should be to go to view mode
1.1193 raeburn 2712: #
2713:
2714: sub can_edit_resource {
1.1194 raeburn 2715: my ($file,$cnum,$cdom,$resurl,$symb,$group) = @_;
2716: my ($cfile,$home,$switchserver,$forceedit,$forceview,$uploaded,$incourse);
2717: #
2718: # For aboutme pages user can only edit his/her own.
2719: #
1.1199 raeburn 2720: if ($resurl =~ m{^/?adm/($match_domain)/($match_username)/aboutme$}) {
1.1194 raeburn 2721: my ($sdom,$sname) = ($1,$2);
2722: if (($sdom eq $env{'user.domain'}) && ($sname eq $env{'user.name'})) {
2723: $home = $env{'user.home'};
2724: $cfile = $resurl;
2725: if ($env{'form.forceedit'}) {
2726: $forceview = 1;
2727: } else {
2728: $forceedit = 1;
2729: }
2730: return ($cfile,$home,$switchserver,$forceedit,$forceview);
2731: } else {
2732: return;
2733: }
2734: }
2735:
2736: if ($env{'request.course.id'}) {
2737: my $crsedit = &Apache::lonnet::allowed('mdc',$env{'request.course.id'});
2738: if ($group ne '') {
2739: # if this is a group homepage or group bulletin board, check group privs
2740: my $allowed = 0;
1.1197 raeburn 2741: if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
2742: if ((&allowed('mdg',$env{'request.course.id'}.
1.1198 raeburn 2743: ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
1.1194 raeburn 2744: (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
2745: $allowed = 1;
2746: }
1.1197 raeburn 2747: } elsif ($resurl =~ m{^/?adm/$cdom/$cnum/\d+/bulletinboard$}) {
2748: if ((&allowed('mdg',$env{'request.course.id'}.($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
2749: (&allowed('cgb',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
1.1194 raeburn 2750: $allowed = 1;
2751: }
2752: }
2753: if ($allowed) {
2754: $home=&homeserver($cnum,$cdom);
2755: if ($env{'form.forceedit'}) {
2756: $forceview = 1;
2757: } else {
2758: $forceedit = 1;
2759: }
2760: $cfile = $resurl;
2761: } else {
2762: return;
2763: }
2764: } else {
1.1208 raeburn 2765: if ($resurl =~ m{^/?adm/viewclasslist$}) {
2766: unless (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
2767: return;
2768: }
2769: } elsif (!$crsedit) {
1.1194 raeburn 2770: #
2771: # No edit allowed where CC has switched to student role.
2772: #
2773: return;
2774: }
2775: }
2776: }
2777:
1.1193 raeburn 2778: if ($file ne '') {
2779: if (($cnum =~ /$match_courseid/) && ($cdom =~ /$match_domain/)) {
1.1194 raeburn 2780: if (&is_course_upload($file,$cnum,$cdom)) {
2781: $uploaded = 1;
2782: $incourse = 1;
1.1193 raeburn 2783: if ($file =~/\.(htm|html|css|js|txt)$/) {
2784: $cfile = &hreflocation('',$file);
1.1201 raeburn 2785: if ($env{'form.forceedit'}) {
2786: $forceview = 1;
2787: } else {
2788: $forceedit = 1;
2789: }
1.1194 raeburn 2790: }
2791: } elsif ($resurl =~ m{^/public/$cdom/$cnum/syllabus}) {
2792: $incourse = 1;
2793: if ($env{'form.forceedit'}) {
2794: $forceview = 1;
2795: } else {
2796: $forceedit = 1;
2797: }
2798: $cfile = $resurl;
2799: } elsif (($resurl ne '') && (&is_on_map($resurl))) {
2800: if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
2801: $incourse = 1;
2802: if ($env{'form.forceedit'}) {
2803: $forceview = 1;
2804: } else {
2805: $forceedit = 1;
2806: }
2807: $cfile = $resurl;
1.1199 raeburn 2808: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem') {
1.1194 raeburn 2809: $incourse = 1;
2810: $cfile = $resurl.'/smpedit';
1.1199 raeburn 2811: } elsif ($resurl =~ m{^/adm/wrapper/ext/}) {
1.1194 raeburn 2812: $incourse = 1;
1.1199 raeburn 2813: if ($env{'form.forceedit'}) {
2814: $forceview = 1;
2815: } else {
2816: $forceedit = 1;
2817: }
2818: $cfile = $resurl;
1.1208 raeburn 2819: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
2820: $incourse = 1;
2821: if ($env{'form.forceedit'}) {
2822: $forceview = 1;
2823: } else {
2824: $forceedit = 1;
2825: }
2826: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1194 raeburn 2827: }
2828: } elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
2829: my $template = '/res/lib/templates/simpleproblem.problem';
2830: if (&is_on_map($template)) {
2831: $incourse = 1;
2832: $forceview = 1;
2833: $cfile = $template;
1.1193 raeburn 2834: }
1.1199 raeburn 2835: } elsif (($resurl =~ m{^/adm/wrapper/ext/}) && ($env{'form.folderpath'} =~ /^supplemental/)) {
2836: $incourse = 1;
2837: if ($env{'form.forceedit'}) {
2838: $forceview = 1;
2839: } else {
2840: $forceedit = 1;
2841: }
2842: $cfile = $resurl;
2843: } elsif (($resurl eq '/adm/extresedit') && ($symb || $env{'form.folderpath'})) {
2844: $incourse = 1;
2845: $forceview = 1;
2846: if ($symb) {
2847: my ($map,$id,$res)=&decode_symb($symb);
2848: $env{'request.symb'} = $symb;
2849: $cfile = &clutter($res);
2850: } else {
2851: $cfile = $env{'form.suppurl'};
2852: $cfile =~ s{^http://}{};
2853: $cfile = '/adm/wrapper/ext/'.$cfile;
2854: }
1.1234 raeburn 2855: } elsif ($resurl =~ m{^/?adm/viewclasslist$}) {
2856: if ($env{'form.forceedit'}) {
2857: $forceview = 1;
2858: } else {
2859: $forceedit = 1;
2860: }
2861: $cfile = ($resurl =~ m{^/} ? $resurl : "/$resurl");
1.1193 raeburn 2862: }
2863: }
1.1194 raeburn 2864: if ($uploaded || $incourse) {
2865: $home=&homeserver($cnum,$cdom);
1.1207 raeburn 2866: } elsif ($file !~ m{/$}) {
1.1193 raeburn 2867: $file=~s{^(priv/$match_domain/$match_username)}{/$1};
2868: $file=~s{^($match_domain/$match_username)}{/priv/$1};
2869: # Check that the user has permission to edit this resource
2870: my $setpriv = 1;
2871: my ($cfuname,$cfudom)=&constructaccess($file,$setpriv);
2872: if (defined($cfudom)) {
2873: $home=&homeserver($cfuname,$cfudom);
2874: $cfile=$file;
2875: }
2876: }
1.1194 raeburn 2877: if (($cfile ne '') && (!$incourse || $uploaded) &&
2878: (($home ne '') && ($home ne 'no_host'))) {
1.1193 raeburn 2879: my @ids=¤t_machine_ids();
2880: unless (grep(/^\Q$home\E$/,@ids)) {
2881: $switchserver=1;
2882: }
2883: }
2884: }
1.1194 raeburn 2885: return ($cfile,$home,$switchserver,$forceedit,$forceview);
1.1193 raeburn 2886: }
2887:
2888: sub is_course_upload {
2889: my ($file,$cnum,$cdom) = @_;
2890: my $uploadpath = &LONCAPA::propath($cdom,$cnum);
2891: $uploadpath =~ s{^\/}{};
1.1201 raeburn 2892: if (($file =~ m{^\Q$uploadpath\E/userfiles/(docs|supplemental)/}) ||
2893: ($file =~ m{^userfiles/\Q$cdom\E/\Q$cnum\E/(docs|supplemental)/})) {
1.1193 raeburn 2894: return 1;
2895: }
2896: return;
2897: }
2898:
1.1194 raeburn 2899: sub in_course {
1.1195 raeburn 2900: my ($udom,$uname,$cdom,$cnum,$type,$hideprivileged) = @_;
2901: if ($hideprivileged) {
2902: my $skipuser;
1.1219 raeburn 2903: my %coursehash = &coursedescription($cdom.'_'.$cnum);
2904: my @possdoms = ($cdom);
2905: if ($coursehash{'checkforpriv'}) {
2906: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
2907: }
2908: if (&privileged($uname,$udom,\@possdoms)) {
1.1195 raeburn 2909: $skipuser = 1;
2910: if ($coursehash{'nothideprivileged'}) {
2911: foreach my $item (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2912: my $user;
2913: if ($item =~ /:/) {
2914: $user = $item;
2915: } else {
2916: $user = join(':',split(/[\@]/,$item));
2917: }
2918: if ($user eq $uname.':'.$udom) {
2919: undef($skipuser);
2920: last;
2921: }
2922: }
2923: }
2924: if ($skipuser) {
2925: return 0;
2926: }
2927: }
2928: }
1.1194 raeburn 2929: $type ||= 'any';
2930: if (!defined($cdom) || !defined($cnum)) {
2931: my $cid = $env{'request.course.id'};
2932: $cdom = $env{'course.'.$cid.'.domain'};
2933: $cnum = $env{'course.'.$cid.'.num'};
2934: }
2935: my $typesref;
1.1195 raeburn 2936: if (($type eq 'any') || ($type eq 'all')) {
1.1194 raeburn 2937: $typesref = ['active','previous','future'];
2938: } elsif ($type eq 'previous' || $type eq 'future') {
2939: $typesref = [$type];
2940: }
2941: my %roles = &get_my_roles($uname,$udom,'userroles',
2942: $typesref,undef,[$cdom]);
2943: my ($tmp) = keys(%roles);
2944: return 0 if ($tmp =~ /^(con_lost|error|no_such_host)/i);
2945: my @course_roles = grep(/^\Q$cnum\E:\Q$cdom\E:/, keys(%roles));
2946: if (@course_roles > 0) {
2947: return 1;
2948: }
2949: return 0;
2950: }
2951:
1.478 albertel 2952: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 2953: # input: action, courseID, current domain, intended
1.637 raeburn 2954: # path to file, source of file, instruction to parse file for objects,
2955: # ref to hash for embedded objects,
2956: # ref to hash for codebase of java objects.
1.1095 raeburn 2957: # reference to scalar to accommodate mime type determined
2958: # from File::MMagic if $parser = parse.
1.637 raeburn 2959: #
1.485 raeburn 2960: # output: url to file (if action was uploaddoc),
2961: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 2962: #
1.478 albertel 2963: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2964: # course.
1.477 raeburn 2965: #
1.478 albertel 2966: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2967: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2968: # course's home server.
1.477 raeburn 2969: #
1.478 albertel 2970: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2971: # be copied from $source (current location) to
2972: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2973: # and will then be copied to
2974: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2975: # course's home server.
1.485 raeburn 2976: #
1.481 raeburn 2977: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 2978: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 2979: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2980: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2981: # in course's home server.
1.637 raeburn 2982: #
1.477 raeburn 2983:
2984: sub process_coursefile {
1.1095 raeburn 2985: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase,
2986: $mimetype)=@_;
1.477 raeburn 2987: my $fetchresult;
1.638 albertel 2988: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 2989: if ($action eq 'propagate') {
1.638 albertel 2990: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2991: $home);
1.481 raeburn 2992: } else {
1.477 raeburn 2993: my $fpath = '';
2994: my $fname = $file;
1.478 albertel 2995: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 2996: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 2997: my $filepath = &build_filepath($fpath);
1.481 raeburn 2998: if ($action eq 'copy') {
2999: if ($source eq '') {
3000: $fetchresult = 'no source file';
3001: return $fetchresult;
3002: } else {
3003: my $destination = $filepath.'/'.$fname;
3004: rename($source,$destination);
3005: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3006: $home);
1.481 raeburn 3007: }
3008: } elsif ($action eq 'uploaddoc') {
3009: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 3010: print $fh $env{'form.'.$source};
1.481 raeburn 3011: close($fh);
1.637 raeburn 3012: if ($parser eq 'parse') {
1.1024 raeburn 3013: my $mm = new File::MMagic;
1.1095 raeburn 3014: my $type = $mm->checktype_filename($filepath.'/'.$fname);
3015: if ($type eq 'text/html') {
1.1024 raeburn 3016: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
3017: unless ($parse_result eq 'ok') {
3018: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
3019: }
1.637 raeburn 3020: }
1.1095 raeburn 3021: if (ref($mimetype)) {
3022: $$mimetype = $type;
3023: }
1.637 raeburn 3024: }
1.477 raeburn 3025: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3026: $home);
1.481 raeburn 3027: if ($fetchresult eq 'ok') {
3028: return '/uploaded/'.$fpath.'/'.$fname;
3029: } else {
3030: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3031: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 3032: return '/adm/notfound.html';
3033: }
1.477 raeburn 3034: }
3035: }
1.485 raeburn 3036: unless ( $fetchresult eq 'ok') {
1.477 raeburn 3037: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 3038: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 3039: }
3040: return $fetchresult;
3041: }
3042:
1.637 raeburn 3043: sub build_filepath {
3044: my ($fpath) = @_;
3045: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
3046: unless ($fpath eq '') {
3047: my @parts=split('/',$fpath);
3048: foreach my $part (@parts) {
3049: $filepath.= '/'.$part;
3050: if ((-e $filepath)!=1) {
3051: mkdir($filepath,0777);
3052: }
3053: }
3054: }
3055: return $filepath;
3056: }
3057:
3058: sub store_edited_file {
1.638 albertel 3059: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 3060: my $file = $primary_url;
3061: $file =~ s#^/uploaded/$docudom/$docuname/##;
3062: my $fpath = '';
3063: my $fname = $file;
3064: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
3065: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
3066: my $filepath = &build_filepath($fpath);
3067: open(my $fh,'>'.$filepath.'/'.$fname);
3068: print $fh $content;
3069: close($fh);
1.638 albertel 3070: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 3071: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 3072: $home);
1.637 raeburn 3073: if ($$fetchresult eq 'ok') {
3074: return '/uploaded/'.$fpath.'/'.$fname;
3075: } else {
1.638 albertel 3076: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
3077: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 3078: return '/adm/notfound.html';
3079: }
3080: }
3081:
1.531 albertel 3082: sub clean_filename {
1.831 albertel 3083: my ($fname,$args)=@_;
1.315 www 3084: # Replace Windows backslashes by forward slashes
1.257 www 3085: $fname=~s/\\/\//g;
1.831 albertel 3086: if (!$args->{'keep_path'}) {
3087: # Get rid of everything but the actual filename
3088: $fname=~s/^.*\/([^\/]+)$/$1/;
3089: }
1.315 www 3090: # Replace spaces by underscores
3091: $fname=~s/\s+/\_/g;
3092: # Replace all other weird characters by nothing
1.831 albertel 3093: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 3094: # Replace all .\d. sequences with _\d. so they no longer look like version
3095: # numbers
3096: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 3097: return $fname;
3098: }
1.1051 raeburn 3099: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
3100: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
3101: # image with the same aspect ratio as the original, but with dimensions which do
3102: # not exceed $resizewidth and $resizeheight.
3103:
1.984 neumanie 3104: sub resizeImage {
1.1051 raeburn 3105: my ($img_path,$resizewidth,$resizeheight) = @_;
3106: my $ima = Image::Magick->new;
3107: my $resized;
3108: if (-e $img_path) {
3109: $ima->Read($img_path);
3110: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
3111: my $width = $ima->Get('width');
3112: my $height = $ima->Get('height');
3113: if ($width > $resizewidth) {
3114: my $factor = $width/$resizewidth;
3115: my $newheight = $height/$factor;
3116: $ima->Scale(width=>$resizewidth,height=>$newheight);
3117: $resized = 1;
3118: }
3119: }
3120: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
3121: my $width = $ima->Get('width');
3122: my $height = $ima->Get('height');
3123: if ($height > $resizeheight) {
3124: my $factor = $height/$resizeheight;
3125: my $newwidth = $width/$factor;
3126: $ima->Scale(width=>$newwidth,height=>$resizeheight);
3127: $resized = 1;
3128: }
3129: }
3130: if ($resized) {
3131: $ima->Write($img_path);
3132: }
3133: }
3134: return;
1.977 amueller 3135: }
3136:
1.608 albertel 3137: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 3138: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.1093 raeburn 3139: # the desired filename is in $env{"form.$formname.filename"}
1.1090 raeburn 3140: # $context - possible values: coursedoc, existingfile, overwrite,
3141: # canceloverwrite, or ''.
3142: # if 'coursedoc': upload to the current course
3143: # if 'existingfile': write file to tmp/overwrites directory
3144: # if 'canceloverwrite': delete file written to tmp/overwrites directory
3145: # $context is passed as argument to &finishuserfileupload
1.686 albertel 3146: # $subdir - directory in userfile to store the file into
1.858 raeburn 3147: # $parser - instruction to parse file for objects ($parser = parse)
3148: # $allfiles - reference to hash for embedded objects
3149: # $codebase - reference to hash for codebase of java objects
3150: # $desuname - username for permanent storage of uploaded file
3151: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 3152: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
3153: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 3154: # $resizewidth - width (pixels) to which to resize uploaded image
3155: # $resizeheight - height (pixels) to which to resize uploaded image
1.1095 raeburn 3156: # $mimetype - reference to scalar to accommodate mime type determined
1.1152 raeburn 3157: # from File::MMagic.
1.858 raeburn 3158: #
1.686 albertel 3159: # output: url of file in userspace, or error: <message>
3160: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 3161:
1.531 albertel 3162: sub userfileupload {
1.1090 raeburn 3163: my ($formname,$context,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1095 raeburn 3164: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight,$mimetype)=@_;
1.531 albertel 3165: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 3166: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 3167: $fname=&clean_filename($fname);
1.1090 raeburn 3168: # See if there is anything left
1.257 www 3169: unless ($fname) { return 'error: no uploaded file'; }
1.1090 raeburn 3170: # Files uploaded to help request form, or uploaded to "create course" page are handled differently
3171: if ((($formname eq 'screenshot') && ($subdir eq 'helprequests')) ||
3172: (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) ||
3173: ($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
1.523 raeburn 3174: my $now = time;
1.1090 raeburn 3175: my $filepath;
1.1095 raeburn 3176: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) {
1.1090 raeburn 3177: $filepath = 'tmp/helprequests/'.$now;
3178: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) {
3179: $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
3180: '_'.$env{'user.domain'}.'/pending';
3181: } elsif (($context eq 'existingfile') || ($context eq 'canceloverwrite')) {
3182: my ($docuname,$docudom);
3183: if ($destudom) {
3184: $docudom = $destudom;
3185: } else {
3186: $docudom = $env{'user.domain'};
3187: }
3188: if ($destuname) {
3189: $docuname = $destuname;
3190: } else {
3191: $docuname = $env{'user.name'};
3192: }
3193: if (exists($env{'form.group'})) {
3194: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3195: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3196: }
3197: $filepath = 'tmp/overwrites/'.$docudom.'/'.$docuname.'/'.$subdir;
3198: if ($context eq 'canceloverwrite') {
3199: my $tempfile = $perlvar{'lonDaemons'}.'/'.$filepath.'/'.$fname;
3200: if (-e $tempfile) {
3201: my @info = stat($tempfile);
3202: if ($info[9] eq $env{'form.timestamp'}) {
3203: unlink($tempfile);
3204: }
3205: }
3206: return;
1.523 raeburn 3207: }
3208: }
1.1090 raeburn 3209: # Create the directory if not present
1.741 raeburn 3210: my @parts=split(/\//,$filepath);
3211: my $fullpath = $perlvar{'lonDaemons'};
3212: for (my $i=0;$i<@parts;$i++) {
3213: $fullpath .= '/'.$parts[$i];
3214: if ((-e $fullpath)!=1) {
3215: mkdir($fullpath,0777);
3216: }
3217: }
3218: open(my $fh,'>'.$fullpath.'/'.$fname);
3219: print $fh $env{'form.'.$formname};
3220: close($fh);
1.1090 raeburn 3221: if ($context eq 'existingfile') {
3222: my @info = stat($fullpath.'/'.$fname);
3223: return ($fullpath.'/'.$fname,$info[9]);
3224: } else {
3225: return $fullpath.'/'.$fname;
3226: }
1.523 raeburn 3227: }
1.995 raeburn 3228: if ($subdir eq 'scantron') {
3229: $fname = 'scantron_orig_'.$fname;
1.1093 raeburn 3230: } else {
1.995 raeburn 3231: $fname="$subdir/$fname";
3232: }
1.1090 raeburn 3233: if ($context eq 'coursedoc') {
1.638 albertel 3234: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3235: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 3236: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 3237: return &finishuserfileupload($docuname,$docudom,
3238: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 3239: $codebase,$thumbwidth,$thumbheight,
1.1095 raeburn 3240: $resizewidth,$resizeheight,$context,$mimetype);
1.481 raeburn 3241: } else {
1.1218 raeburn 3242: if ($env{'form.folder'}) {
3243: $fname=$env{'form.folder'}.'/'.$fname;
3244: }
1.638 albertel 3245: return &process_coursefile('uploaddoc',$docuname,$docudom,
3246: $fname,$formname,$parser,
1.1095 raeburn 3247: $allfiles,$codebase,$mimetype);
1.481 raeburn 3248: }
1.719 banghart 3249: } elsif (defined($destuname)) {
3250: my $docuname=$destuname;
3251: my $docudom=$destudom;
1.860 raeburn 3252: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3253: $parser,$allfiles,$codebase,
1.1051 raeburn 3254: $thumbwidth,$thumbheight,
1.1095 raeburn 3255: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3256: } else {
1.638 albertel 3257: my $docuname=$env{'user.name'};
3258: my $docudom=$env{'user.domain'};
1.1220 raeburn 3259: if ((exists($env{'form.group'})) || ($context eq 'syllabus')) {
1.714 raeburn 3260: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
3261: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
3262: }
1.860 raeburn 3263: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
3264: $parser,$allfiles,$codebase,
1.1051 raeburn 3265: $thumbwidth,$thumbheight,
1.1095 raeburn 3266: $resizewidth,$resizeheight,$context,$mimetype);
1.259 www 3267: }
1.271 www 3268: }
3269:
3270: sub finishuserfileupload {
1.860 raeburn 3271: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1095 raeburn 3272: $thumbwidth,$thumbheight,$resizewidth,$resizeheight,$context,$mimetype) = @_;
1.477 raeburn 3273: my $path=$docudom.'/'.$docuname.'/';
1.258 www 3274: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 3275:
1.860 raeburn 3276: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 3277: $file=$fname;
3278: if ($fname=~m|/|) {
3279: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
3280: $path.=$fnamepath.'/';
3281: }
1.259 www 3282: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 3283: my $count;
3284: for ($count=4;$count<=$#parts;$count++) {
3285: $filepath.="/$parts[$count]";
3286: if ((-e $filepath)!=1) {
3287: mkdir($filepath,0777);
3288: }
3289: }
1.984 neumanie 3290:
1.258 www 3291: # Save the file
3292: {
1.701 albertel 3293: if (!open(FH,'>'.$filepath.'/'.$file)) {
3294: &logthis('Failed to create '.$filepath.'/'.$file);
3295: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
3296: return '/adm/notfound.html';
3297: }
1.1090 raeburn 3298: if ($context eq 'overwrite') {
1.1117 foxr 3299: my $source = LONCAPA::tempdir().'/overwrites/'.$docudom.'/'.$docuname.'/'.$fname;
1.1090 raeburn 3300: my $target = $filepath.'/'.$file;
3301: if (-e $source) {
3302: my @info = stat($source);
3303: if ($info[9] eq $env{'form.timestamp'}) {
3304: unless (&File::Copy::move($source,$target)) {
3305: &logthis('Failed to overwrite '.$filepath.'/'.$file);
3306: return "Moving from $source failed";
3307: }
3308: } else {
3309: return "Temporary file: $source had unexpected date/time for last modification";
3310: }
3311: } else {
3312: return "Temporary file: $source missing";
3313: }
3314: } elsif (!print FH ($env{'form.'.$formname})) {
1.701 albertel 3315: &logthis('Failed to write to '.$filepath.'/'.$file);
3316: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
3317: return '/adm/notfound.html';
3318: }
1.570 albertel 3319: close(FH);
1.1051 raeburn 3320: if ($resizewidth && $resizeheight) {
3321: my $mm = new File::MMagic;
3322: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
3323: if ($mime_type =~ m{^image/}) {
3324: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
3325: }
1.977 amueller 3326: }
1.258 www 3327: }
1.1152 raeburn 3328: if (($context eq 'coursedoc') || ($parser eq 'parse')) {
3329: if (ref($mimetype)) {
3330: if ($$mimetype eq '') {
3331: my $mm = new File::MMagic;
3332: my $type = $mm->checktype_filename($filepath.'/'.$file);
3333: $$mimetype = $type;
3334: }
3335: }
3336: }
1.637 raeburn 3337: if ($parser eq 'parse') {
1.1152 raeburn 3338: if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
1.1024 raeburn 3339: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
3340: $allfiles,$codebase);
3341: unless ($parse_result eq 'ok') {
3342: &logthis('Failed to parse '.$filepath.$file.
3343: ' for embedded media: '.$parse_result);
3344: }
1.637 raeburn 3345: }
3346: }
1.860 raeburn 3347: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
3348: my $input = $filepath.'/'.$file;
3349: my $output = $filepath.'/'.'tn-'.$file;
3350: my $thumbsize = $thumbwidth.'x'.$thumbheight;
3351: system("convert -sample $thumbsize $input $output");
3352: if (-e $filepath.'/'.'tn-'.$file) {
3353: $fetchthumb = 1;
3354: }
3355: }
1.858 raeburn 3356:
1.259 www 3357: # Notify homeserver to grep it
3358: #
1.984 neumanie 3359: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 3360: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 3361: if ($fetchresult eq 'ok') {
1.860 raeburn 3362: if ($fetchthumb) {
3363: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
3364: if ($thumbresult ne 'ok') {
3365: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
3366: $docuhome.': '.$thumbresult);
3367: }
3368: }
1.259 www 3369: #
1.258 www 3370: # Return the URL to it
1.494 albertel 3371: return '/uploaded/'.$path.$file;
1.263 www 3372: } else {
1.494 albertel 3373: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
3374: ': '.$fetchresult);
1.263 www 3375: return '/adm/notfound.html';
1.858 raeburn 3376: }
1.493 albertel 3377: }
3378:
1.637 raeburn 3379: sub extract_embedded_items {
1.961 raeburn 3380: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 3381: my @state = ();
1.1164 raeburn 3382: my (%lastids,%related,%shockwave,%flashvars);
1.637 raeburn 3383: my %javafiles = (
3384: codebase => '',
3385: code => '',
3386: archive => ''
3387: );
3388: my %mediafiles = (
3389: src => '',
3390: movie => '',
3391: );
1.648 raeburn 3392: my $p;
3393: if ($content) {
3394: $p = HTML::LCParser->new($content);
3395: } else {
1.961 raeburn 3396: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 3397: }
1.641 albertel 3398: while (my $t=$p->get_token()) {
1.640 albertel 3399: if ($t->[0] eq 'S') {
3400: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 3401: push(@state, $tagname);
1.648 raeburn 3402: if (lc($tagname) eq 'allow') {
3403: &add_filetype($allfiles,$attr->{'src'},'src');
3404: }
1.640 albertel 3405: if (lc($tagname) eq 'img') {
3406: &add_filetype($allfiles,$attr->{'src'},'src');
3407: }
1.886 albertel 3408: if (lc($tagname) eq 'a') {
1.1222 raeburn 3409: unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
1.1221 raeburn 3410: &add_filetype($allfiles,$attr->{'href'},'href');
3411: }
1.886 albertel 3412: }
1.645 raeburn 3413: if (lc($tagname) eq 'script') {
1.1164 raeburn 3414: my $src;
1.645 raeburn 3415: if ($attr->{'archive'} =~ /\.jar$/i) {
3416: &add_filetype($allfiles,$attr->{'archive'},'archive');
3417: } else {
1.1164 raeburn 3418: if ($attr->{'src'} ne '') {
3419: $src = $attr->{'src'};
3420: &add_filetype($allfiles,$src,'src');
3421: }
3422: }
3423: my $text = $p->get_trimmed_text();
3424: if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
3425: my @swfargs = split(/,/,$1);
3426: foreach my $item (@swfargs) {
3427: $item =~ s/["']//g;
3428: $item =~ s/^\s+//;
3429: $item =~ s/\s+$//;
3430: }
3431: if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
3432: if (ref($related{$swfargs[0]}) eq 'ARRAY') {
3433: push(@{$related{$swfargs[0]}},$swfargs[2]);
3434: } else {
3435: $related{$swfargs[0]} = [$swfargs[2]];
3436: }
3437: }
1.645 raeburn 3438: }
3439: }
3440: if (lc($tagname) eq 'link') {
3441: if (lc($attr->{'rel'}) eq 'stylesheet') {
3442: &add_filetype($allfiles,$attr->{'href'},'href');
3443: }
3444: }
1.640 albertel 3445: if (lc($tagname) eq 'object' ||
3446: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
3447: foreach my $item (keys(%javafiles)) {
3448: $javafiles{$item} = '';
3449: }
1.1164 raeburn 3450: if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
3451: $lastids{lc($tagname)} = $attr->{'id'};
3452: }
1.640 albertel 3453: }
3454: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
3455: my $name = lc($attr->{'name'});
3456: foreach my $item (keys(%javafiles)) {
3457: if ($name eq $item) {
3458: $javafiles{$item} = $attr->{'value'};
3459: last;
3460: }
3461: }
1.1164 raeburn 3462: my $pathfrom;
1.640 albertel 3463: foreach my $item (keys(%mediafiles)) {
3464: if ($name eq $item) {
1.1164 raeburn 3465: $pathfrom = $attr->{'value'};
3466: $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
3467: &add_filetype($allfiles,$pathfrom,$name);
1.640 albertel 3468: last;
3469: }
3470: }
1.1164 raeburn 3471: if ($name eq 'flashvars') {
3472: $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
3473: }
3474: if ($pathfrom ne '') {
3475: &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
3476: $pathfrom);
3477: }
1.640 albertel 3478: }
3479: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
3480: foreach my $item (keys(%javafiles)) {
3481: if ($attr->{$item}) {
3482: $javafiles{$item} = $attr->{$item};
3483: last;
3484: }
3485: }
3486: foreach my $item (keys(%mediafiles)) {
3487: if ($attr->{$item}) {
3488: &add_filetype($allfiles,$attr->{$item},$item);
3489: last;
3490: }
3491: }
1.1164 raeburn 3492: if (lc($tagname) eq 'embed') {
3493: if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
3494: &embedded_dependency($allfiles,\%related,$attr->{'name'},
3495: $attr->{'src'});
3496: }
3497: }
1.640 albertel 3498: }
1.1164 raeburn 3499: if ($t->[4] =~ m{/>$}) {
3500: pop(@state);
3501: }
1.640 albertel 3502: } elsif ($t->[0] eq 'E') {
3503: my ($tagname) = ($t->[1]);
3504: if ($javafiles{'codebase'} ne '') {
3505: $javafiles{'codebase'} .= '/';
3506: }
3507: if (lc($tagname) eq 'applet' ||
3508: lc($tagname) eq 'object' ||
3509: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
3510: ) {
3511: foreach my $item (keys(%javafiles)) {
3512: if ($item ne 'codebase' && $javafiles{$item} ne '') {
3513: my $file=$javafiles{'codebase'}.$javafiles{$item};
3514: &add_filetype($allfiles,$file,$item);
3515: }
3516: }
3517: }
3518: pop @state;
3519: }
3520: }
1.1164 raeburn 3521: foreach my $id (sort(keys(%flashvars))) {
3522: if ($shockwave{$id} ne '') {
3523: my @pairs = split(/\&/,$flashvars{$id});
3524: foreach my $pair (@pairs) {
3525: my ($key,$value) = split(/\=/,$pair);
3526: if ($key eq 'thumb') {
3527: &add_filetype($allfiles,$value,$key);
3528: } elsif ($key eq 'content') {
3529: my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
3530: my ($ext) = ($value =~ /\.([^.]+)$/);
3531: if ($ext ne '') {
3532: &add_filetype($allfiles,$path.$value,$ext);
3533: }
3534: }
3535: }
3536: }
3537: }
1.637 raeburn 3538: return 'ok';
3539: }
3540:
1.639 albertel 3541: sub add_filetype {
3542: my ($allfiles,$file,$type)=@_;
3543: if (exists($allfiles->{$file})) {
3544: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
3545: push(@{$allfiles->{$file}}, &escape($type));
3546: }
3547: } else {
3548: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 3549: }
3550: }
3551:
1.1164 raeburn 3552: sub embedded_dependency {
3553: my ($allfiles,$related,$identifier,$pathfrom) = @_;
3554: if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
3555: if (($identifier ne '') &&
3556: (ref($related->{$identifier}) eq 'ARRAY') &&
3557: ($pathfrom ne '')) {
3558: my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
3559: foreach my $dep (@{$related->{$identifier}}) {
3560: &add_filetype($allfiles,$path.$dep,'object');
3561: }
3562: }
3563: }
3564: return;
3565: }
3566:
1.493 albertel 3567: sub removeuploadedurl {
1.984 neumanie 3568: my ($url)=@_;
3569: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 3570: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 3571: }
3572:
3573: sub removeuserfile {
3574: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 3575: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3576: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 3577: if ($result eq 'ok') {
1.798 raeburn 3578: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
3579: my $metafile = $fname.'.meta';
3580: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 3581: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 3582: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3583: my $sqlresult =
1.823 albertel 3584: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3585: 'portfolio_metadata',$group,
3586: 'delete');
1.798 raeburn 3587: }
3588: }
3589: return $result;
1.257 www 3590: }
1.15 www 3591:
1.530 albertel 3592: sub mkdiruserfile {
3593: my ($docuname,$docudom,$dir)=@_;
3594: my $home=&homeserver($docuname,$docudom);
3595: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
3596: }
3597:
1.531 albertel 3598: sub renameuserfile {
3599: my ($docuname,$docudom,$old,$new)=@_;
3600: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 3601: my $result = &reply("renameuserfile:$docudom:$docuname:".
3602: &escape("$old").':'.&escape("$new"),$home);
3603: if ($result eq 'ok') {
3604: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
3605: my $oldmeta = $old.'.meta';
3606: my $newmeta = $new.'.meta';
3607: my $metaresult =
3608: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 3609: my $url = "/uploaded/$docudom/$docuname/$old";
3610: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 3611: my $sqlresult =
1.823 albertel 3612: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 3613: 'portfolio_metadata',$group,
3614: 'delete');
1.798 raeburn 3615: }
3616: }
3617: return $result;
1.531 albertel 3618: }
3619:
1.14 www 3620: # ------------------------------------------------------------------------- Log
3621:
3622: sub log {
3623: my ($dom,$nam,$hom,$what)=@_;
1.47 www 3624: return critical("log:$dom:$nam:$what",$hom);
1.157 www 3625: }
3626:
3627: # ------------------------------------------------------------------ Course Log
1.352 www 3628: #
3629: # This routine flushes several buffers of non-mission-critical nature
3630: #
1.157 www 3631:
3632: sub flushcourselogs {
1.352 www 3633: &logthis('Flushing log buffers');
3634: #
3635: # course logs
3636: # This is a log of all transactions in a course, which can be used
3637: # for data mining purposes
3638: #
3639: # It also collects the courseid database, which lists last transaction
3640: # times and course titles for all courseids
3641: #
3642: my %courseidbuffer=();
1.921 raeburn 3643: foreach my $crsid (keys(%courselogs)) {
1.352 www 3644: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 3645: &escape($courselogs{$crsid}),
3646: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 3647: delete $courselogs{$crsid};
3648: } else {
3649: &logthis('Failed to flush log buffer for '.$crsid);
3650: if (length($courselogs{$crsid})>40000) {
1.672 albertel 3651: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 3652: " exceeded maximum size, deleting.</font>");
3653: delete $courselogs{$crsid};
3654: }
1.352 www 3655: }
1.920 raeburn 3656: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 3657: 'description' => $coursedescrbuf{$crsid},
3658: 'inst_code' => $courseinstcodebuf{$crsid},
3659: 'type' => $coursetypebuf{$crsid},
3660: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 3661: };
1.191 harris41 3662: }
1.352 www 3663: #
3664: # Write course id database (reverse lookup) to homeserver of courses
3665: # Is used in pickcourse
3666: #
1.840 albertel 3667: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 3668: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 3669: $courseidbuffer{$crs_home},
3670: $crs_home,'timeonly');
1.352 www 3671: }
3672: #
3673: # File accesses
3674: # Writes to the dynamic metadata of resources to get hit counts, etc.
3675: #
1.449 matthew 3676: foreach my $entry (keys(%accesshash)) {
1.458 matthew 3677: if ($entry =~ /___count$/) {
3678: my ($dom,$name);
1.807 albertel 3679: ($dom,$name,undef)=
1.811 albertel 3680: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 3681: if (! defined($dom) || $dom eq '' ||
3682: ! defined($name) || $name eq '') {
1.620 albertel 3683: my $cid = $env{'request.course.id'};
3684: $dom = $env{'request.'.$cid.'.domain'};
3685: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 3686: }
1.450 matthew 3687: my $value = $accesshash{$entry};
3688: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
3689: my %temphash=($url => $value);
1.449 matthew 3690: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
3691: if ($result eq 'ok') {
3692: delete $accesshash{$entry};
3693: }
3694: } else {
1.811 albertel 3695: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.1159 www 3696: if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
1.450 matthew 3697: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 3698: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
3699: delete $accesshash{$entry};
3700: }
1.185 www 3701: }
1.191 harris41 3702: }
1.352 www 3703: #
3704: # Roles
3705: # Reverse lookup of user roles for course faculty/staff and co-authorship
3706: #
1.800 albertel 3707: foreach my $entry (keys(%userrolehash)) {
1.351 www 3708: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 3709: split(/\:/,$entry);
3710: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 3711: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 3712: $rudom,$runame) eq 'ok') {
3713: delete $userrolehash{$entry};
3714: }
3715: }
1.662 raeburn 3716: #
3717: # Reverse lookup of domain roles (dc, ad, li, sc, au)
3718: #
3719: my %domrolebuffer = ();
1.1000 raeburn 3720: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 3721: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 3722: if ($domrolebuffer{$rudom}) {
3723: $domrolebuffer{$rudom}.='&'.&escape($entry).
3724: '='.&escape($domainrolehash{$entry});
3725: } else {
3726: $domrolebuffer{$rudom}.=&escape($entry).
3727: '='.&escape($domainrolehash{$entry});
3728: }
3729: delete $domainrolehash{$entry};
3730: }
3731: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 3732: my %servers = &get_servers($dom,'library');
3733: foreach my $tryserver (keys(%servers)) {
3734: unless (&reply('domroleput:'.$dom.':'.
3735: $domrolebuffer{$dom},$tryserver) eq 'ok') {
3736: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
3737: }
1.662 raeburn 3738: }
3739: }
1.186 www 3740: $dumpcount++;
1.157 www 3741: }
3742:
3743: sub courselog {
3744: my $what=shift;
1.158 www 3745: $what=time.':'.$what;
1.620 albertel 3746: unless ($env{'request.course.id'}) { return ''; }
3747: $coursedombuf{$env{'request.course.id'}}=
3748: $env{'course.'.$env{'request.course.id'}.'.domain'};
3749: $coursenumbuf{$env{'request.course.id'}}=
3750: $env{'course.'.$env{'request.course.id'}.'.num'};
3751: $coursehombuf{$env{'request.course.id'}}=
3752: $env{'course.'.$env{'request.course.id'}.'.home'};
3753: $coursedescrbuf{$env{'request.course.id'}}=
3754: $env{'course.'.$env{'request.course.id'}.'.description'};
3755: $courseinstcodebuf{$env{'request.course.id'}}=
3756: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
3757: $courseownerbuf{$env{'request.course.id'}}=
3758: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 3759: $coursetypebuf{$env{'request.course.id'}}=
3760: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 3761: if (defined $courselogs{$env{'request.course.id'}}) {
3762: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 3763: } else {
1.620 albertel 3764: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 3765: }
1.620 albertel 3766: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 3767: &flushcourselogs();
3768: }
1.158 www 3769: }
3770:
3771: sub courseacclog {
3772: my $fnsymb=shift;
1.620 albertel 3773: unless ($env{'request.course.id'}) { return ''; }
3774: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.1144 www 3775: if ($fnsymb=~/$LONCAPA::assess_re/) {
1.187 www 3776: $what.=':POST';
1.583 matthew 3777: # FIXME: Probably ought to escape things....
1.800 albertel 3778: foreach my $key (keys(%env)) {
3779: if ($key=~/^form\.(.*)/) {
1.975 raeburn 3780: my $formitem = $1;
3781: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
3782: $what.=':'.$formitem.'='.$env{$key};
3783: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
3784: $what.=':'.$formitem.'='.$env{$key};
3785: }
1.158 www 3786: }
1.191 harris41 3787: }
1.583 matthew 3788: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
3789: # FIXME: We should not be depending on a form parameter that someone
3790: # editing lonsearchcat.pm might change in the future.
1.620 albertel 3791: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 3792: $what.= ':POST';
3793: # FIXME: Probably ought to escape things....
3794: foreach my $element ('courseexp','crsfulltext','crsrelated',
3795: 'crsdiscuss') {
1.620 albertel 3796: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 3797: }
3798: }
1.158 www 3799: }
3800: &courselog($what);
1.149 www 3801: }
3802:
1.185 www 3803: sub countacc {
3804: my $url=&declutter(shift);
1.458 matthew 3805: return if (! defined($url) || $url eq '');
1.620 albertel 3806: unless ($env{'request.course.id'}) { return ''; }
1.1158 www 3807: #
3808: # Mark that this url was used in this course
3809: #
1.620 albertel 3810: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.1158 www 3811: #
3812: # Increase the access count for this resource in this child process
3813: #
1.281 www 3814: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 3815: $accesshash{$key}++;
1.185 www 3816: }
1.349 www 3817:
1.361 www 3818: sub linklog {
3819: my ($from,$to)=@_;
3820: $from=&declutter($from);
3821: $to=&declutter($to);
3822: $accesshash{$from.'___'.$to.'___comefrom'}=1;
3823: $accesshash{$to.'___'.$from.'___goto'}=1;
3824: }
1.1160 www 3825:
3826: sub statslog {
3827: my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
3828: if ($users<2) { return; }
3829: my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
3830: 'course' => $env{'request.course.id'},
3831: 'sections' => '"all"',
3832: 'num_students' => $users,
3833: 'part' => $part,
3834: 'symb' => $symb,
3835: 'mean_tries' => $av_attempts,
3836: 'deg_of_diff' => $degdiff});
3837: foreach my $key (keys(%dynstore)) {
3838: $accesshash{$key}=$dynstore{$key};
3839: }
3840: }
1.361 www 3841:
1.349 www 3842: sub userrolelog {
3843: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.1169 droeschl 3844: if ( $trole =~ /^(ca|aa|in|cc|ep|cr|ta|co)/ ) {
1.350 www 3845: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3846: $userrolehash
3847: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 3848: =$tend.':'.$tstart;
1.662 raeburn 3849: }
1.1169 droeschl 3850: if ($env{'request.role'} =~ /dc\./ && $trole =~ /^(au|in|cc|ep|cr|ta|co)/) {
1.898 albertel 3851: $userrolehash
3852: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
3853: =$tend.':'.$tstart;
3854: }
1.1169 droeschl 3855: if ($trole =~ /^(dc|ad|li|au|dg|sc)/ ) {
1.662 raeburn 3856: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
3857: $domainrolehash
3858: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
3859: = $tend.':'.$tstart;
3860: }
1.351 www 3861: }
3862:
1.957 raeburn 3863: sub courserolelog {
3864: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
1.1184 raeburn 3865: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
3866: my $cdom = $1;
3867: my $cnum = $2;
3868: my $sec = $3;
3869: my $namespace = 'rolelog';
3870: my %storehash = (
3871: role => $trole,
3872: start => $tstart,
3873: end => $tend,
3874: selfenroll => $selfenroll,
3875: context => $context,
3876: );
3877: if ($trole eq 'gr') {
3878: $namespace = 'groupslog';
3879: $storehash{'group'} = $sec;
3880: } else {
3881: $storehash{'section'} = $sec;
3882: }
1.1188 raeburn 3883: &write_log('course',$namespace,\%storehash,$delflag,$username,
3884: $domain,$cnum,$cdom);
1.1184 raeburn 3885: if (($trole ne 'st') || ($sec ne '')) {
3886: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
1.957 raeburn 3887: }
3888: }
3889: return;
3890: }
3891:
1.1184 raeburn 3892: sub domainrolelog {
3893: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
3894: if ($area =~ m{^/($match_domain)/$}) {
3895: my $cdom = $1;
3896: my $domconfiguser = &Apache::lonnet::get_domainconfiguser($cdom);
3897: my $namespace = 'rolelog';
3898: my %storehash = (
3899: role => $trole,
3900: start => $tstart,
3901: end => $tend,
3902: context => $context,
3903: );
1.1188 raeburn 3904: &write_log('domain',$namespace,\%storehash,$delflag,$username,
3905: $domain,$domconfiguser,$cdom);
1.1184 raeburn 3906: }
3907: return;
3908:
3909: }
3910:
3911: sub coauthorrolelog {
3912: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$context)=@_;
3913: if ($area =~ m{^/($match_domain)/($match_username)$}) {
3914: my $audom = $1;
3915: my $auname = $2;
3916: my $namespace = 'rolelog';
3917: my %storehash = (
3918: role => $trole,
3919: start => $tstart,
3920: end => $tend,
3921: context => $context,
3922: );
1.1188 raeburn 3923: &write_log('author',$namespace,\%storehash,$delflag,$username,
3924: $domain,$auname,$audom);
1.1184 raeburn 3925: }
3926: return;
3927: }
3928:
1.351 www 3929: sub get_course_adv_roles {
1.948 raeburn 3930: my ($cid,$codes) = @_;
1.620 albertel 3931: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 3932: my %coursehash=&coursedescription($cid);
1.988 raeburn 3933: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 3934: my %nothide=();
1.800 albertel 3935: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 3936: if ($user !~ /:/) {
3937: $nothide{join(':',split(/[\@]/,$user))}=1;
3938: } else {
3939: $nothide{$user}=1;
3940: }
1.470 www 3941: }
1.1219 raeburn 3942: my @possdoms = ($coursehash{'domain'});
3943: if ($coursehash{'checkforpriv'}) {
3944: push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
3945: }
1.351 www 3946: my %returnhash=();
3947: my %dumphash=
3948: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
3949: my $now=time;
1.997 raeburn 3950: my %privileged;
1.1000 raeburn 3951: foreach my $entry (keys(%dumphash)) {
1.800 albertel 3952: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 3953: if (($tstart) && ($tstart<0)) { next; }
3954: if (($tend) && ($tend<$now)) { next; }
3955: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 3956: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 3957: if ($username eq '' || $domain eq '') { next; }
1.1219 raeburn 3958: if ((&privileged($username,$domain,\@possdoms)) &&
1.997 raeburn 3959: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 3960: if ($role eq 'cr') { next; }
1.948 raeburn 3961: if ($codes) {
3962: if ($section) { $role .= ':'.$section; }
3963: if ($returnhash{$role}) {
3964: $returnhash{$role}.=','.$username.':'.$domain;
3965: } else {
3966: $returnhash{$role}=$username.':'.$domain;
3967: }
1.351 www 3968: } else {
1.988 raeburn 3969: my $key=&plaintext($role,$crstype);
1.973 bisitz 3970: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 3971: if ($returnhash{$key}) {
3972: $returnhash{$key}.=','.$username.':'.$domain;
3973: } else {
3974: $returnhash{$key}=$username.':'.$domain;
3975: }
1.351 www 3976: }
1.948 raeburn 3977: }
1.400 www 3978: return %returnhash;
3979: }
3980:
3981: sub get_my_roles {
1.937 raeburn 3982: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 3983: unless (defined($uname)) { $uname=$env{'user.name'}; }
3984: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 3985: my (%dumphash,%nothide);
1.1086 raeburn 3986: if ($context eq 'userroles') {
1.1166 raeburn 3987: %dumphash = &dump('roles',$udom,$uname);
1.858 raeburn 3988: } else {
1.1219 raeburn 3989: %dumphash = &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 3990: if ($hidepriv) {
3991: my %coursehash=&coursedescription($udom.'_'.$uname);
3992: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
3993: if ($user !~ /:/) {
3994: $nothide{join(':',split(/[\@]/,$user))} = 1;
3995: } else {
3996: $nothide{$user} = 1;
3997: }
3998: }
3999: }
1.858 raeburn 4000: }
1.400 www 4001: my %returnhash=();
4002: my $now=time;
1.999 raeburn 4003: my %privileged;
1.800 albertel 4004: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 4005: my ($role,$tend,$tstart);
4006: if ($context eq 'userroles') {
1.1149 raeburn 4007: next if ($entry =~ /^rolesdef/);
1.867 raeburn 4008: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
4009: } else {
4010: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
4011: }
1.400 www 4012: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 4013: my $status = 'active';
1.939 raeburn 4014: if (($tend) && ($tend<=$now)) {
1.832 raeburn 4015: $status = 'previous';
4016: }
4017: if (($tstart) && ($now<$tstart)) {
4018: $status = 'future';
4019: }
4020: if (ref($types) eq 'ARRAY') {
4021: if (!grep(/^\Q$status\E$/,@{$types})) {
4022: next;
4023: }
4024: } else {
4025: if ($status ne 'active') {
4026: next;
4027: }
4028: }
1.867 raeburn 4029: my ($rolecode,$username,$domain,$section,$area);
4030: if ($context eq 'userroles') {
1.1186 raeburn 4031: ($area,$rolecode) = ($entry =~ /^(.+)_([^_]+)$/);
1.867 raeburn 4032: (undef,$domain,$username,$section) = split(/\//,$area);
4033: } else {
4034: ($role,$username,$domain,$section) = split(/\:/,$entry);
4035: }
1.832 raeburn 4036: if (ref($roledoms) eq 'ARRAY') {
4037: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
4038: next;
4039: }
4040: }
4041: if (ref($roles) eq 'ARRAY') {
4042: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 4043: if ($role =~ /^cr\//) {
4044: if (!grep(/^cr$/,@{$roles})) {
4045: next;
4046: }
1.1104 raeburn 4047: } elsif ($role =~ /^gr\//) {
4048: if (!grep(/^gr$/,@{$roles})) {
4049: next;
4050: }
1.922 raeburn 4051: } else {
4052: next;
4053: }
1.832 raeburn 4054: }
1.867 raeburn 4055: }
1.937 raeburn 4056: if ($hidepriv) {
1.1219 raeburn 4057: my @privroles = ('dc','su');
1.999 raeburn 4058: if ($context eq 'userroles') {
1.1219 raeburn 4059: next if (grep(/^\Q$role\E$/,@privroles));
1.999 raeburn 4060: } else {
1.1219 raeburn 4061: my $possdoms = [$domain];
4062: if (ref($roledoms) eq 'ARRAY') {
4063: push(@{$possdoms},@{$roledoms});
1.999 raeburn 4064: }
1.1219 raeburn 4065: if (&privileged($username,$domain,$possdoms,\@privroles)) {
1.999 raeburn 4066: if (!$nothide{$username.':'.$domain}) {
4067: next;
4068: }
4069: }
1.937 raeburn 4070: }
4071: }
1.933 raeburn 4072: if ($withsec) {
4073: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
4074: $tstart.':'.$tend;
4075: } else {
4076: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
4077: }
1.832 raeburn 4078: }
1.373 www 4079: return %returnhash;
1.399 www 4080: }
4081:
4082: # ----------------------------------------------------- Frontpage Announcements
4083: #
4084: #
4085:
4086: sub postannounce {
4087: my ($server,$text)=@_;
1.844 albertel 4088: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 4089: unless ($text=~/\w/) { $text=''; }
4090: return &reply('setannounce:'.&escape($text),$server);
4091: }
4092:
4093: sub getannounce {
1.448 albertel 4094:
4095: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 4096: my $announcement='';
1.800 albertel 4097: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 4098: close($fh);
1.399 www 4099: if ($announcement=~/\w/) {
4100: return
4101: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 4102: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 4103: } else {
4104: return '';
4105: }
4106: } else {
4107: return '';
4108: }
1.351 www 4109: }
1.353 www 4110:
4111: # ---------------------------------------------------------- Course ID routines
4112: # Deal with domain's nohist_courseid.db files
4113: #
4114:
4115: sub courseidput {
1.921 raeburn 4116: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 4117: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 4118: my $outcome;
4119: if ($caller eq 'timeonly') {
4120: my $cids = '';
4121: foreach my $item (keys(%$storehash)) {
4122: $cids.=&escape($item).'&';
4123: }
4124: $cids=~s/\&$//;
4125: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
4126: $coursehome);
4127: } else {
4128: my $items = '';
4129: foreach my $item (keys(%$storehash)) {
4130: $items.= &escape($item).'='.
4131: &freeze_escape($$storehash{$item}).'&';
4132: }
4133: $items=~s/\&$//;
4134: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
4135: $coursehome);
1.918 raeburn 4136: }
4137: if ($outcome eq 'unknown_cmd') {
4138: my $what;
4139: foreach my $cid (keys(%$storehash)) {
4140: $what .= &escape($cid).'=';
1.921 raeburn 4141: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 4142: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 4143: }
4144: $what =~ s/\:$/&/;
4145: }
4146: $what =~ s/\&$//;
4147: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
4148: } else {
4149: return $outcome;
4150: }
1.353 www 4151: }
4152:
4153: sub courseiddump {
1.921 raeburn 4154: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 4155: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 4156: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
1.1071 raeburn 4157: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
1.918 raeburn 4158: my $as_hash = 1;
4159: my %returnhash;
4160: if (!$domfilter) { $domfilter=''; }
1.845 albertel 4161: my %libserv = &all_library();
4162: foreach my $tryserver (keys(%libserv)) {
4163: if ( ( $hostidflag == 1
4164: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
4165: || (!defined($hostidflag)) ) {
4166:
1.918 raeburn 4167: if (($domfilter eq '') ||
4168: (&host_domain($tryserver) eq $domfilter)) {
1.1180 droeschl 4169: my $rep;
4170: if (grep { $_ eq $tryserver } current_machine_ids()) {
4171: $rep = LONCAPA::Lond::dump_course_id_handler(
4172: join(":", (&host_domain($tryserver), $sincefilter,
4173: &escape($descfilter), &escape($instcodefilter),
4174: &escape($ownerfilter), &escape($coursefilter),
4175: &escape($typefilter), &escape($regexp_ok),
4176: $as_hash, &escape($selfenrollonly),
4177: &escape($catfilter), $showhidden, $caller,
4178: &escape($cloner), &escape($cc_clone), $cloneonly,
4179: &escape($createdbefore), &escape($createdafter),
4180: &escape($creationcontext), $domcloner)));
4181: } else {
4182: $rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
4183: $sincefilter.':'.&escape($descfilter).':'.
4184: &escape($instcodefilter).':'.&escape($ownerfilter).
4185: ':'.&escape($coursefilter).':'.&escape($typefilter).
4186: ':'.&escape($regexp_ok).':'.$as_hash.':'.
4187: &escape($selfenrollonly).':'.&escape($catfilter).':'.
4188: $showhidden.':'.$caller.':'.&escape($cloner).':'.
4189: &escape($cc_clone).':'.$cloneonly.':'.
4190: &escape($createdbefore).':'.&escape($createdafter).':'.
4191: &escape($creationcontext).':'.$domcloner,
4192: $tryserver);
4193: }
4194:
1.918 raeburn 4195: my @pairs=split(/\&/,$rep);
4196: foreach my $item (@pairs) {
4197: my ($key,$value)=split(/\=/,$item,2);
4198: $key = &unescape($key);
4199: next if ($key =~ /^error: 2 /);
4200: my $result = &thaw_unescape($value);
4201: if (ref($result) eq 'HASH') {
4202: $returnhash{$key}=$result;
4203: } else {
1.921 raeburn 4204: my @responses = split(/:/,$value);
4205: my @items = ('description','inst_code','owner','type');
1.918 raeburn 4206: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 4207: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 4208: }
1.1008 raeburn 4209: }
1.353 www 4210: }
4211: }
4212: }
4213: }
4214: return %returnhash;
4215: }
4216:
1.1055 raeburn 4217: sub courselastaccess {
4218: my ($cdom,$cnum,$hostidref) = @_;
4219: my %returnhash;
4220: if ($cdom && $cnum) {
4221: my $chome = &homeserver($cnum,$cdom);
4222: if ($chome ne 'no_host') {
4223: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
4224: &extract_lastaccess(\%returnhash,$rep);
4225: }
4226: } else {
4227: if (!$cdom) { $cdom=''; }
4228: my %libserv = &all_library();
4229: foreach my $tryserver (keys(%libserv)) {
4230: if (ref($hostidref) eq 'ARRAY') {
4231: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
4232: }
4233: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
4234: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
4235: &extract_lastaccess(\%returnhash,$rep);
4236: }
4237: }
4238: }
4239: return %returnhash;
4240: }
4241:
4242: sub extract_lastaccess {
4243: my ($returnhash,$rep) = @_;
4244: if (ref($returnhash) eq 'HASH') {
4245: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
4246: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
4247: $rep eq '') {
4248: my @pairs=split(/\&/,$rep);
4249: foreach my $item (@pairs) {
4250: my ($key,$value)=split(/\=/,$item,2);
4251: $key = &unescape($key);
4252: next if ($key =~ /^error: 2 /);
4253: $returnhash->{$key} = &thaw_unescape($value);
4254: }
4255: }
4256: }
4257: return;
4258: }
4259:
1.658 raeburn 4260: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 4261:
4262: sub dcmailput {
1.685 raeburn 4263: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 4264: my $status = &Apache::lonnet::critical(
1.740 www 4265: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
4266: &escape($message),$server);
1.662 raeburn 4267: return $status;
4268: }
4269:
1.658 raeburn 4270: sub dcmaildump {
4271: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 4272: my %returnhash=();
1.846 albertel 4273:
4274: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 4275: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
4276: &escape($enddate).':';
4277: my @esc_senders=map { &escape($_)} @$senders;
4278: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 4279: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 4280: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 4281: if (($key) && ($value)) {
4282: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 4283: }
4284: }
4285: }
4286: return %returnhash;
4287: }
1.662 raeburn 4288: # ---------------------------------------------------------- Domain roles
4289:
4290: sub get_domain_roles {
4291: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 4292: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 4293: $startdate = '.';
4294: }
1.1018 raeburn 4295: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 4296: $enddate = '.';
4297: }
1.922 raeburn 4298: my $rolelist;
4299: if (ref($roles) eq 'ARRAY') {
1.1219 raeburn 4300: $rolelist = join('&',@{$roles});
1.922 raeburn 4301: }
1.662 raeburn 4302: my %personnel = ();
1.841 albertel 4303:
4304: my %servers = &get_servers($dom,'library');
4305: foreach my $tryserver (keys(%servers)) {
4306: %{$personnel{$tryserver}}=();
4307: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
4308: &escape($startdate).':'.
4309: &escape($enddate).':'.
4310: &escape($rolelist), $tryserver))) {
4311: my ($key,$value) = split(/\=/,$line,2);
4312: if (($key) && ($value)) {
4313: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
4314: }
4315: }
1.662 raeburn 4316: }
4317: return %personnel;
4318: }
1.658 raeburn 4319:
1.1057 www 4320: # ----------------------------------------------------------- Interval timing
1.149 www 4321:
1.1153 www 4322: {
4323: # Caches needed for speedup of navmaps
4324: # We don't want to cache this for very long at all (5 seconds at most)
4325: #
4326: # The user for whom we cache
4327: my $cachedkey='';
4328: # The cached times for this user
4329: my %cachedtimes=();
4330: # When this was last done
4331: my $cachedtime=();
4332:
4333: sub load_all_first_access {
1.1154 raeburn 4334: my ($uname,$udom)=@_;
1.1156 www 4335: if (($cachedkey eq $uname.':'.$udom) &&
1.1174 raeburn 4336: (abs($cachedtime-time)<5) && (!$env{'form.markaccess'})) {
1.1154 raeburn 4337: return;
4338: }
4339: $cachedtime=time;
4340: $cachedkey=$uname.':'.$udom;
4341: %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
1.1153 www 4342: }
4343:
1.504 albertel 4344: sub get_first_access {
1.1162 raeburn 4345: my ($type,$argsymb,$argmap)=@_;
1.790 albertel 4346: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4347: if ($argsymb) { $symb=$argsymb; }
4348: my ($map,$id,$res)=&decode_symb($symb);
1.1162 raeburn 4349: if ($argmap) { $map = $argmap; }
1.926 albertel 4350: if ($type eq 'course') {
4351: $res='course';
4352: } elsif ($type eq 'map') {
1.588 albertel 4353: $res=&symbread($map);
4354: } else {
4355: $res=$symb;
4356: }
1.1153 www 4357: &load_all_first_access($uname,$udom);
4358: return $cachedtimes{"$courseid\0$res"};
1.504 albertel 4359: }
4360:
4361: sub set_first_access {
1.1162 raeburn 4362: my ($type,$interval)=@_;
1.790 albertel 4363: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 4364: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 4365: if ($type eq 'course') {
4366: $res='course';
4367: } elsif ($type eq 'map') {
1.588 albertel 4368: $res=&symbread($map);
4369: } else {
4370: $res=$symb;
4371: }
1.1153 www 4372: $cachedkey='';
1.1162 raeburn 4373: my $firstaccess=&get_first_access($type,$symb,$map);
1.505 albertel 4374: if (!$firstaccess) {
1.1162 raeburn 4375: my $start = time;
4376: my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
4377: $udom,$uname);
4378: if ($putres eq 'ok') {
4379: &put('timerinterval',{"$courseid\0$res"=>$interval},
4380: $udom,$uname);
4381: &appenv(
4382: {
4383: 'course.'.$courseid.'.firstaccess.'.$res => $start,
4384: 'course.'.$courseid.'.timerinterval.'.$res => $interval,
4385: }
4386: );
4387: }
4388: return $putres;
1.505 albertel 4389: }
4390: return 'already_set';
1.504 albertel 4391: }
1.1153 www 4392: }
1.110 www 4393: # --------------------------------------------- Set Expire Date for Spreadsheet
4394:
4395: sub expirespread {
4396: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 4397: my $cid=$env{'request.course.id'};
1.110 www 4398: if ($cid) {
4399: my $now=time;
4400: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 4401: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
4402: $env{'course.'.$cid.'.num'}.
1.110 www 4403: ':nohist_expirationdates:'.
4404: &escape($key).'='.$now,
1.620 albertel 4405: $env{'course.'.$cid.'.home'})
1.110 www 4406: }
4407: return 'ok';
1.14 www 4408: }
4409:
1.109 www 4410: # ----------------------------------------------------- Devalidate Spreadsheets
4411:
4412: sub devalidate {
1.325 www 4413: my ($symb,$uname,$udom)=@_;
1.620 albertel 4414: my $cid=$env{'request.course.id'};
1.109 www 4415: if ($cid) {
1.391 matthew 4416: # delete the stored spreadsheets for
4417: # - the student level sheet of this user in course's homespace
4418: # - the assessment level sheet for this resource
4419: # for this user in user's homespace
1.553 albertel 4420: # - current conditional state info
1.325 www 4421: my $key=$uname.':'.$udom.':';
1.109 www 4422: my $status=
1.299 matthew 4423: &del('nohist_calculatedsheets',
1.391 matthew 4424: [$key.'studentcalc:'],
1.620 albertel 4425: $env{'course.'.$cid.'.domain'},
4426: $env{'course.'.$cid.'.num'})
1.133 albertel 4427: .' '.
4428: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 4429: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 4430: unless ($status eq 'ok ok') {
4431: &logthis('Could not devalidate spreadsheet '.
1.325 www 4432: $uname.' at '.$udom.' for '.
1.109 www 4433: $symb.': '.$status);
1.133 albertel 4434: }
1.553 albertel 4435: &delenv('user.state.'.$cid);
1.109 www 4436: }
4437: }
4438:
1.265 albertel 4439: sub get_scalar {
4440: my ($string,$end) = @_;
4441: my $value;
4442: if ($$string =~ s/^([^&]*?)($end)/$2/) {
4443: $value = $1;
4444: } elsif ($$string =~ s/^([^&]*?)&//) {
4445: $value = $1;
4446: }
4447: return &unescape($value);
4448: }
4449:
4450: sub array2str {
4451: my (@array) = @_;
4452: my $result=&arrayref2str(\@array);
4453: $result=~s/^__ARRAY_REF__//;
4454: $result=~s/__END_ARRAY_REF__$//;
4455: return $result;
4456: }
4457:
1.204 albertel 4458: sub arrayref2str {
4459: my ($arrayref) = @_;
1.265 albertel 4460: my $result='__ARRAY_REF__';
1.204 albertel 4461: foreach my $elem (@$arrayref) {
1.265 albertel 4462: if(ref($elem) eq 'ARRAY') {
4463: $result.=&arrayref2str($elem).'&';
4464: } elsif(ref($elem) eq 'HASH') {
4465: $result.=&hashref2str($elem).'&';
4466: } elsif(ref($elem)) {
4467: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 4468: } else {
4469: $result.=&escape($elem).'&';
4470: }
4471: }
4472: $result=~s/\&$//;
1.265 albertel 4473: $result .= '__END_ARRAY_REF__';
1.204 albertel 4474: return $result;
4475: }
4476:
1.168 albertel 4477: sub hash2str {
1.204 albertel 4478: my (%hash) = @_;
4479: my $result=&hashref2str(\%hash);
1.265 albertel 4480: $result=~s/^__HASH_REF__//;
4481: $result=~s/__END_HASH_REF__$//;
1.204 albertel 4482: return $result;
4483: }
4484:
4485: sub hashref2str {
4486: my ($hashref)=@_;
1.265 albertel 4487: my $result='__HASH_REF__';
1.800 albertel 4488: foreach my $key (sort(keys(%$hashref))) {
4489: if (ref($key) eq 'ARRAY') {
4490: $result.=&arrayref2str($key).'=';
4491: } elsif (ref($key) eq 'HASH') {
4492: $result.=&hashref2str($key).'=';
4493: } elsif (ref($key)) {
1.265 albertel 4494: $result.='=';
1.800 albertel 4495: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 4496: } else {
1.1132 raeburn 4497: if (defined($key)) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 4498: }
4499:
1.800 albertel 4500: if(ref($hashref->{$key}) eq 'ARRAY') {
4501: $result.=&arrayref2str($hashref->{$key}).'&';
4502: } elsif(ref($hashref->{$key}) eq 'HASH') {
4503: $result.=&hashref2str($hashref->{$key}).'&';
4504: } elsif(ref($hashref->{$key})) {
1.265 albertel 4505: $result.='&';
1.800 albertel 4506: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 4507: } else {
1.800 albertel 4508: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 4509: }
4510: }
1.168 albertel 4511: $result=~s/\&$//;
1.265 albertel 4512: $result .= '__END_HASH_REF__';
1.168 albertel 4513: return $result;
4514: }
4515:
4516: sub str2hash {
1.265 albertel 4517: my ($string)=@_;
4518: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
4519: return %$hash;
4520: }
4521:
4522: sub str2hashref {
1.168 albertel 4523: my ($string) = @_;
1.265 albertel 4524:
4525: my %hash;
4526:
4527: if($string !~ /^__HASH_REF__/) {
4528: if (! ($string eq '' || !defined($string))) {
4529: $hash{'error'}='Not hash reference';
4530: }
4531: return (\%hash, $string);
4532: }
4533:
4534: $string =~ s/^__HASH_REF__//;
4535:
4536: while($string !~ /^__END_HASH_REF__/) {
4537: #key
4538: my $key='';
4539: if($string =~ /^__HASH_REF__/) {
4540: ($key, $string)=&str2hashref($string);
4541: if(defined($key->{'error'})) {
4542: $hash{'error'}='Bad data';
4543: return (\%hash, $string);
4544: }
4545: } elsif($string =~ /^__ARRAY_REF__/) {
4546: ($key, $string)=&str2arrayref($string);
4547: if($key->[0] eq 'Array reference error') {
4548: $hash{'error'}='Bad data';
4549: return (\%hash, $string);
4550: }
4551: } else {
4552: $string =~ s/^(.*?)=//;
1.267 albertel 4553: $key=&unescape($1);
1.265 albertel 4554: }
4555: $string =~ s/^=//;
4556:
4557: #value
4558: my $value='';
4559: if($string =~ /^__HASH_REF__/) {
4560: ($value, $string)=&str2hashref($string);
4561: if(defined($value->{'error'})) {
4562: $hash{'error'}='Bad data';
4563: return (\%hash, $string);
4564: }
4565: } elsif($string =~ /^__ARRAY_REF__/) {
4566: ($value, $string)=&str2arrayref($string);
4567: if($value->[0] eq 'Array reference error') {
4568: $hash{'error'}='Bad data';
4569: return (\%hash, $string);
4570: }
4571: } else {
4572: $value=&get_scalar(\$string,'__END_HASH_REF__');
4573: }
4574: $string =~ s/^&//;
4575:
4576: $hash{$key}=$value;
1.204 albertel 4577: }
1.265 albertel 4578:
4579: $string =~ s/^__END_HASH_REF__//;
4580:
4581: return (\%hash, $string);
1.204 albertel 4582: }
4583:
4584: sub str2array {
1.265 albertel 4585: my ($string)=@_;
4586: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
4587: return @$array;
4588: }
4589:
4590: sub str2arrayref {
1.204 albertel 4591: my ($string) = @_;
1.265 albertel 4592: my @array;
4593:
4594: if($string !~ /^__ARRAY_REF__/) {
4595: if (! ($string eq '' || !defined($string))) {
4596: $array[0]='Array reference error';
4597: }
4598: return (\@array, $string);
4599: }
4600:
4601: $string =~ s/^__ARRAY_REF__//;
4602:
4603: while($string !~ /^__END_ARRAY_REF__/) {
4604: my $value='';
4605: if($string =~ /^__HASH_REF__/) {
4606: ($value, $string)=&str2hashref($string);
4607: if(defined($value->{'error'})) {
4608: $array[0] ='Array reference error';
4609: return (\@array, $string);
4610: }
4611: } elsif($string =~ /^__ARRAY_REF__/) {
4612: ($value, $string)=&str2arrayref($string);
4613: if($value->[0] eq 'Array reference error') {
4614: $array[0] ='Array reference error';
4615: return (\@array, $string);
4616: }
4617: } else {
4618: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
4619: }
4620: $string =~ s/^&//;
4621:
4622: push(@array, $value);
1.191 harris41 4623: }
1.265 albertel 4624:
4625: $string =~ s/^__END_ARRAY_REF__//;
4626:
4627: return (\@array, $string);
1.168 albertel 4628: }
4629:
1.167 albertel 4630: # -------------------------------------------------------------------Temp Store
4631:
1.168 albertel 4632: sub tmpreset {
4633: my ($symb,$namespace,$domain,$stuname) = @_;
4634: if (!$symb) {
4635: $symb=&symbread();
1.620 albertel 4636: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4637: }
4638: $symb=escape($symb);
4639:
1.620 albertel 4640: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 4641: $namespace=~s/\//\_/g;
4642: $namespace=~s/\W//g;
4643:
1.620 albertel 4644: if (!$domain) { $domain=$env{'user.domain'}; }
4645: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4646: if ($domain eq 'public' && $stuname eq 'public') {
4647: $stuname=$ENV{'REMOTE_ADDR'};
4648: }
1.1117 foxr 4649: my $path=LONCAPA::tempdir();
1.168 albertel 4650: my %hash;
4651: if (tie(%hash,'GDBM_File',
4652: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4653: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 4654: foreach my $key (keys(%hash)) {
1.180 albertel 4655: if ($key=~ /:$symb/) {
1.168 albertel 4656: delete($hash{$key});
4657: }
4658: }
4659: }
4660: }
4661:
1.167 albertel 4662: sub tmpstore {
1.168 albertel 4663: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4664:
4665: if (!$symb) {
4666: $symb=&symbread();
1.620 albertel 4667: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4668: }
4669: $symb=escape($symb);
4670:
4671: if (!$namespace) {
4672: # I don't think we would ever want to store this for a course.
4673: # it seems this will only be used if we don't have a course.
1.620 albertel 4674: #$namespace=$env{'request.course.id'};
1.168 albertel 4675: #if (!$namespace) {
1.620 albertel 4676: $namespace=$env{'request.state'};
1.168 albertel 4677: #}
4678: }
4679: $namespace=~s/\//\_/g;
4680: $namespace=~s/\W//g;
1.620 albertel 4681: if (!$domain) { $domain=$env{'user.domain'}; }
4682: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4683: if ($domain eq 'public' && $stuname eq 'public') {
4684: $stuname=$ENV{'REMOTE_ADDR'};
4685: }
1.168 albertel 4686: my $now=time;
4687: my %hash;
1.1117 foxr 4688: my $path=LONCAPA::tempdir();
1.168 albertel 4689: if (tie(%hash,'GDBM_File',
4690: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4691: &GDBM_WRCREAT(),0640)) {
1.168 albertel 4692: $hash{"version:$symb"}++;
4693: my $version=$hash{"version:$symb"};
4694: my $allkeys='';
4695: foreach my $key (keys(%$storehash)) {
4696: $allkeys.=$key.':';
1.591 albertel 4697: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 4698: }
4699: $hash{"$version:$symb:timestamp"}=$now;
4700: $allkeys.='timestamp';
4701: $hash{"$version:keys:$symb"}=$allkeys;
4702: if (untie(%hash)) {
4703: return 'ok';
4704: } else {
4705: return "error:$!";
4706: }
4707: } else {
4708: return "error:$!";
4709: }
4710: }
1.167 albertel 4711:
1.168 albertel 4712: # -----------------------------------------------------------------Temp Restore
1.167 albertel 4713:
1.168 albertel 4714: sub tmprestore {
4715: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 4716:
1.168 albertel 4717: if (!$symb) {
4718: $symb=&symbread();
1.620 albertel 4719: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 4720: }
4721: $symb=escape($symb);
4722:
1.620 albertel 4723: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 4724:
1.620 albertel 4725: if (!$domain) { $domain=$env{'user.domain'}; }
4726: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 4727: if ($domain eq 'public' && $stuname eq 'public') {
4728: $stuname=$ENV{'REMOTE_ADDR'};
4729: }
1.168 albertel 4730: my %returnhash;
4731: $namespace=~s/\//\_/g;
4732: $namespace=~s/\W//g;
4733: my %hash;
1.1117 foxr 4734: my $path=LONCAPA::tempdir();
1.168 albertel 4735: if (tie(%hash,'GDBM_File',
4736: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 4737: &GDBM_READER(),0640)) {
1.168 albertel 4738: my $version=$hash{"version:$symb"};
4739: $returnhash{'version'}=$version;
4740: my $scope;
4741: for ($scope=1;$scope<=$version;$scope++) {
4742: my $vkeys=$hash{"$scope:keys:$symb"};
4743: my @keys=split(/:/,$vkeys);
4744: my $key;
4745: $returnhash{"$scope:keys"}=$vkeys;
4746: foreach $key (@keys) {
1.591 albertel 4747: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
4748: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 4749: }
4750: }
1.168 albertel 4751: if (!(untie(%hash))) {
4752: return "error:$!";
4753: }
4754: } else {
4755: return "error:$!";
4756: }
4757: return %returnhash;
1.167 albertel 4758: }
4759:
1.9 www 4760: # ----------------------------------------------------------------------- Store
4761:
4762: sub store {
1.124 www 4763: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4764: my $home='';
4765:
1.168 albertel 4766: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4767:
1.213 www 4768: $symb=&symbclean($symb);
1.122 albertel 4769: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 4770:
1.620 albertel 4771: if (!$domain) { $domain=$env{'user.domain'}; }
4772: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 4773:
4774: &devalidate($symb,$stuname,$domain);
1.109 www 4775:
4776: $symb=escape($symb);
1.187 www 4777: if (!$namespace) {
1.620 albertel 4778: unless ($namespace=$env{'request.course.id'}) {
1.187 www 4779: return '';
4780: }
4781: }
1.620 albertel 4782: if (!$home) { $home=$env{'user.home'}; }
1.447 www 4783:
4784: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4785: $$storehash{'host'}=$perlvar{'lonHostID'};
4786:
1.12 www 4787: my $namevalue='';
1.800 albertel 4788: foreach my $key (keys(%$storehash)) {
4789: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 4790: }
1.12 www 4791: $namevalue=~s/\&$//;
1.187 www 4792: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 4793: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 4794: }
4795:
1.47 www 4796: # -------------------------------------------------------------- Critical Store
4797:
4798: sub cstore {
1.124 www 4799: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
4800: my $home='';
4801:
1.168 albertel 4802: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4803:
1.213 www 4804: $symb=&symbclean($symb);
1.122 albertel 4805: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 4806:
1.620 albertel 4807: if (!$domain) { $domain=$env{'user.domain'}; }
4808: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 4809:
4810: &devalidate($symb,$stuname,$domain);
1.109 www 4811:
4812: $symb=escape($symb);
1.187 www 4813: if (!$namespace) {
1.620 albertel 4814: unless ($namespace=$env{'request.course.id'}) {
1.187 www 4815: return '';
4816: }
4817: }
1.620 albertel 4818: if (!$home) { $home=$env{'user.home'}; }
1.447 www 4819:
4820: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
4821: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 4822:
1.47 www 4823: my $namevalue='';
1.800 albertel 4824: foreach my $key (keys(%$storehash)) {
4825: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 4826: }
1.47 www 4827: $namevalue=~s/\&$//;
1.187 www 4828: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 4829: return critical
4830: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 4831: }
4832:
1.9 www 4833: # --------------------------------------------------------------------- Restore
4834:
4835: sub restore {
1.124 www 4836: my ($symb,$namespace,$domain,$stuname) = @_;
4837: my $home='';
4838:
1.168 albertel 4839: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 4840:
1.122 albertel 4841: if (!$symb) {
1.1224 raeburn 4842: return if ($namespace eq 'courserequests');
4843: unless ($symb=escape(&symbread())) { return ''; }
1.122 albertel 4844: } else {
1.1224 raeburn 4845: unless ($namespace eq 'courserequests') {
4846: $symb=&escape(&symbclean($symb));
4847: }
1.122 albertel 4848: }
1.188 www 4849: if (!$namespace) {
1.620 albertel 4850: unless ($namespace=$env{'request.course.id'}) {
1.188 www 4851: return '';
4852: }
4853: }
1.620 albertel 4854: if (!$domain) { $domain=$env{'user.domain'}; }
4855: if (!$stuname) { $stuname=$env{'user.name'}; }
4856: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 4857: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
4858:
1.12 www 4859: my %returnhash=();
1.800 albertel 4860: foreach my $line (split(/\&/,$answer)) {
4861: my ($name,$value)=split(/\=/,$line);
1.591 albertel 4862: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 4863: }
1.75 www 4864: my $version;
4865: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 4866: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
4867: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 4868: }
1.75 www 4869: }
1.13 www 4870: return %returnhash;
1.34 www 4871: }
4872:
4873: # ---------------------------------------------------------- Course Description
1.1118 foxr 4874: #
4875: #
1.34 www 4876:
4877: sub coursedescription {
1.731 albertel 4878: my ($courseid,$args)=@_;
1.34 www 4879: $courseid=~s/^\///;
1.49 www 4880: $courseid=~s/\_/\//g;
1.34 www 4881: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 4882: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 4883: my $normalid=$cdomain.'_'.$cnum;
4884: # need to always cache even if we get errors otherwise we keep
4885: # trying and trying and trying to get the course description.
4886: my %envhash=();
4887: my %returnhash=();
1.731 albertel 4888:
4889: my $expiretime=600;
4890: if ($env{'request.course.id'} eq $normalid) {
4891: $expiretime=120;
4892: }
4893:
4894: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
4895: if (!$args->{'freshen_cache'}
4896: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
4897: foreach my $key (keys(%env)) {
4898: next if ($key !~ /^\Q$prefix\E(.*)/);
4899: my ($setting) = $1;
4900: $returnhash{$setting} = $env{$key};
4901: }
4902: return %returnhash;
4903: }
4904:
1.1118 foxr 4905: # get the data again
4906:
1.731 albertel 4907: if (!$args->{'one_time'}) {
4908: $envhash{'course.'.$normalid.'.last_cache'}=time;
4909: }
1.811 albertel 4910:
1.34 www 4911: if ($chome ne 'no_host') {
1.302 albertel 4912: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 4913: if (!exists($returnhash{'con_lost'})) {
1.1118 foxr 4914: my $username = $env{'user.name'}; # Defult username
4915: if(defined $args->{'user'}) {
4916: $username = $args->{'user'};
4917: }
1.129 albertel 4918: $returnhash{'home'}= $chome;
4919: $returnhash{'domain'} = $cdomain;
4920: $returnhash{'num'} = $cnum;
1.741 raeburn 4921: if (!defined($returnhash{'type'})) {
4922: $returnhash{'type'} = 'Course';
4923: }
1.130 albertel 4924: while (my ($name,$value) = each %returnhash) {
1.53 www 4925: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 4926: }
1.270 www 4927: $returnhash{'url'}=&clutter($returnhash{'url'});
1.1117 foxr 4928: $returnhash{'fn'}=LONCAPA::tempdir() .
1.1118 foxr 4929: $username.'_'.$cdomain.'_'.$cnum;
1.60 www 4930: $envhash{'course.'.$normalid.'.home'}=$chome;
4931: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
4932: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 4933: }
4934: }
1.731 albertel 4935: if (!$args->{'one_time'}) {
1.949 raeburn 4936: &appenv(\%envhash);
1.731 albertel 4937: }
1.302 albertel 4938: return %returnhash;
1.461 www 4939: }
4940:
1.1080 raeburn 4941: sub update_released_required {
4942: my ($needsrelease,$cdom,$cnum,$chome,$cid) = @_;
4943: if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
4944: $cid = $env{'request.course.id'};
4945: $cdom = $env{'course.'.$cid.'.domain'};
4946: $cnum = $env{'course.'.$cid.'.num'};
4947: $chome = $env{'course.'.$cid.'.home'};
4948: }
4949: if ($needsrelease) {
4950: my %curr_reqd_hash = &userenvironment($cdom,$cnum,'internal.releaserequired');
4951: my $needsupdate;
4952: if ($curr_reqd_hash{'internal.releaserequired'} eq '') {
4953: $needsupdate = 1;
4954: } else {
4955: my ($currmajor,$currminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
4956: my ($needsmajor,$needsminor) = split(/\./,$needsrelease);
4957: if (($currmajor < $needsmajor) || ($currmajor == $needsmajor && $currminor < $needsminor)) {
4958: $needsupdate = 1;
4959: }
4960: }
4961: if ($needsupdate) {
4962: my %needshash = (
4963: 'internal.releaserequired' => $needsrelease,
4964: );
4965: my $putresult = &put('environment',\%needshash,$cdom,$cnum);
4966: if ($putresult eq 'ok') {
4967: &appenv({'course.'.$cid.'.internal.releaserequired' => $needsrelease});
4968: my %crsinfo = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
4969: if (ref($crsinfo{$cid}) eq 'HASH') {
4970: $crsinfo{$cid}{'releaserequired'} = $needsrelease;
4971: &courseidput($cdom,\%crsinfo,$chome,'notime');
4972: }
4973: }
4974: }
4975: }
4976: return;
4977: }
4978:
1.461 www 4979: # -------------------------------------------------See if a user is privileged
4980:
4981: sub privileged {
1.1219 raeburn 4982: my ($username,$domain,$possdomains,$possroles)=@_;
1.1170 droeschl 4983: my $now = time;
1.1219 raeburn 4984: my $roles;
4985: if (ref($possroles) eq 'ARRAY') {
4986: $roles = $possroles;
4987: } else {
4988: $roles = ['dc','su'];
4989: }
4990: if (ref($possdomains) eq 'ARRAY') {
4991: my %privileged = &privileged_by_domain($possdomains,$roles);
4992: foreach my $dom (@{$possdomains}) {
4993: if (($username =~ /^$match_username$/) && ($domain =~ /^$match_domain$/) &&
4994: (ref($privileged{$dom}) eq 'HASH')) {
4995: foreach my $role (@{$roles}) {
4996: if (ref($privileged{$dom}{$role}) eq 'HASH') {
4997: if (exists($privileged{$dom}{$role}{$username.':'.$domain})) {
4998: my ($end,$start) = split(/:/,$privileged{$dom}{$role}{$username.':'.$domain});
4999: return 1 unless (($end && $end < $now) ||
5000: ($start && $start > $now));
5001: }
5002: }
5003: }
5004: }
5005: }
5006: } else {
5007: my %rolesdump = &dump("roles", $domain, $username) or return 0;
5008: my $now = time;
1.1170 droeschl 5009:
1.1219 raeburn 5010: for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys %rolesdump}) {
1.1170 droeschl 5011: my ($trole, $tend, $tstart) = split(/_/, $role);
1.1219 raeburn 5012: if (grep(/^\Q$trole\E$/,@{$roles})) {
1.1170 droeschl 5013: return 1 unless ($tend && $tend < $now)
1.1219 raeburn 5014: or ($tstart && $tstart > $now);
1.1170 droeschl 5015: }
1.1219 raeburn 5016: }
5017: }
5018: return 0;
5019: }
1.1170 droeschl 5020:
1.1219 raeburn 5021: sub privileged_by_domain {
5022: my ($domains,$roles) = @_;
5023: my %privileged = ();
5024: my $cachetime = 60*60*24;
5025: my $now = time;
5026: unless ((ref($domains) eq 'ARRAY') && (ref($roles) eq 'ARRAY')) {
5027: return %privileged;
5028: }
5029: foreach my $dom (@{$domains}) {
5030: next if (ref($privileged{$dom}) eq 'HASH');
5031: my $needroles;
5032: foreach my $role (@{$roles}) {
5033: my ($result,$cached)=&is_cached_new('priv_'.$role,$dom);
5034: if (defined($cached)) {
5035: if (ref($result) eq 'HASH') {
5036: $privileged{$dom}{$role} = $result;
5037: }
5038: } else {
5039: $needroles = 1;
5040: }
5041: }
5042: if ($needroles) {
5043: my %dompersonnel = &get_domain_roles($dom,$roles);
5044: $privileged{$dom} = {};
5045: foreach my $server (keys(%dompersonnel)) {
5046: if (ref($dompersonnel{$server}) eq 'HASH') {
5047: foreach my $item (keys(%{$dompersonnel{$server}})) {
5048: my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
5049: my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
5050: next if ($end && $end < $now);
5051: $privileged{$dom}{$trole}{$uname.':'.$udom} =
5052: $dompersonnel{$server}{$item};
5053: }
5054: }
5055: }
5056: if (ref($privileged{$dom}) eq 'HASH') {
5057: foreach my $role (@{$roles}) {
5058: if (ref($privileged{$dom}{$role}) eq 'HASH') {
5059: &do_cache_new('priv_'.$role,$dom,$privileged{$dom}{$role},$cachetime);
5060: } else {
5061: my %hash = ();
5062: &do_cache_new('priv_'.$role,$dom,\%hash,$cachetime);
5063: }
5064: }
5065: }
5066: }
5067: }
5068: return %privileged;
1.9 www 5069: }
1.1 albertel 5070:
1.103 harris41 5071: # -------------------------------------------------------- Get user privileges
1.11 www 5072:
5073: sub rolesinit {
1.1169 droeschl 5074: my ($domain, $username) = @_;
5075: my %userroles = ('user.login.time' => time);
5076: my %rolesdump = &dump("roles", $domain, $username) or return \%userroles;
5077:
5078: # firstaccess and timerinterval are related to timed maps/resources.
5079: # also, blocking can be triggered by an activating timer
5080: # it's saved in the user's %env.
5081: my %firstaccess = &dump('firstaccesstimes', $domain, $username);
5082: my %timerinterval = &dump('timerinterval', $domain, $username);
5083: my (%coursetimerstarts, %firstaccchk, %firstaccenv, %coursetimerintervals,
5084: %timerintchk, %timerintenv);
5085:
1.1162 raeburn 5086: foreach my $key (keys(%firstaccess)) {
1.1169 droeschl 5087: my ($cid, $rest) = split(/\0/, $key);
1.1162 raeburn 5088: $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
5089: }
1.1169 droeschl 5090:
1.1162 raeburn 5091: foreach my $key (keys(%timerinterval)) {
5092: my ($cid,$rest) = split(/\0/,$key);
5093: $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
5094: }
1.1169 droeschl 5095:
1.11 www 5096: my %allroles=();
1.1162 raeburn 5097: my %allgroups=();
1.11 www 5098:
1.1169 droeschl 5099: for my $area (grep { ! /^rolesdef_/ } keys %rolesdump) {
5100: my $role = $rolesdump{$area};
5101: $area =~ s/\_\w\w$//;
5102:
5103: my ($trole, $tend, $tstart, $group_privs);
5104:
5105: if ($role =~ /^cr/) {
5106: # Custom role, defined by a user
5107: # e.g., user.role.cr/msu/smith/mynewrole
5108: if ($role =~ m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
5109: $trole = $1;
5110: ($tend, $tstart) = split('_', $2);
5111: } else {
5112: $trole = $role;
5113: }
5114: } elsif ($role =~ m|^gr/|) {
5115: # Role of member in a group, defined within a course/community
5116: # e.g., user.role.gr/msu/04935610a19ee4a5fmsul1/leopards
5117: ($trole, $tend, $tstart) = split(/_/, $role);
5118: next if $tstart eq '-1';
5119: ($trole, $group_privs) = split(/\//, $trole);
5120: $group_privs = &unescape($group_privs);
5121: } else {
5122: # Just a normal role, defined in roles.tab
5123: ($trole, $tend, $tstart) = split(/_/,$role);
5124: }
5125:
5126: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
5127: $username);
5128: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
5129:
5130: # role expired or not available yet?
5131: $trole = '' if ($tend != 0 && $tend < $userroles{'user.login.time'}) or
5132: ($tstart != 0 && $tstart > $userroles{'user.login.time'});
5133:
5134: next if $area eq '' or $trole eq '';
5135:
5136: my $spec = "$trole.$area";
5137: my ($tdummy, $tdomain, $trest) = split(/\//, $area);
5138:
5139: if ($trole =~ /^cr\//) {
5140: # Custom role, defined by a user
5141: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
5142: } elsif ($trole eq 'gr') {
5143: # Role of a member in a group, defined within a course/community
5144: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
5145: next;
5146: } else {
5147: # Normal role, defined in roles.tab
5148: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
5149: }
5150:
5151: my $cid = $tdomain.'_'.$trest;
5152: unless ($firstaccchk{$cid}) {
5153: if (ref($coursetimerstarts{$cid}) eq 'HASH') {
5154: foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
5155: $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
5156: $coursetimerstarts{$cid}{$item};
5157: }
5158: }
5159: $firstaccchk{$cid} = 1;
5160: }
5161: unless ($timerintchk{$cid}) {
5162: if (ref($coursetimerintervals{$cid}) eq 'HASH') {
5163: foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
5164: $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
5165: $coursetimerintervals{$cid}{$item};
1.1162 raeburn 5166: }
1.12 www 5167: }
1.1169 droeschl 5168: $timerintchk{$cid} = 1;
1.191 harris41 5169: }
1.11 www 5170: }
1.1169 droeschl 5171:
5172: @userroles{'user.author', 'user.adv'} = &set_userprivs(\%userroles,
5173: \%allroles, \%allgroups);
5174: $env{'user.adv'} = $userroles{'user.adv'};
5175:
1.1162 raeburn 5176: return (\%userroles,\%firstaccenv,\%timerintenv);
1.11 www 5177: }
5178:
1.567 raeburn 5179: sub set_arearole {
1.1215 raeburn 5180: my ($trole,$area,$tstart,$tend,$domain,$username,$nolog) = @_;
5181: unless ($nolog) {
1.567 raeburn 5182: # log the associated role with the area
1.1215 raeburn 5183: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
5184: }
1.743 albertel 5185: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 5186: }
5187:
5188: sub custom_roleprivs {
5189: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
5190: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
5191: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 5192: if (&hostname($homsvr) ne '') {
1.567 raeburn 5193: my ($rdummy,$roledef)=
5194: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
5195: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
5196: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
5197: if (defined($syspriv)) {
1.1043 raeburn 5198: if ($trest =~ /^$match_community$/) {
5199: $syspriv =~ s/bre\&S//;
5200: }
1.567 raeburn 5201: $$allroles{'cm./'}.=':'.$syspriv;
5202: $$allroles{$spec.'./'}.=':'.$syspriv;
5203: }
5204: if ($tdomain ne '') {
5205: if (defined($dompriv)) {
5206: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
5207: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
5208: }
5209: if (($trest ne '') && (defined($coursepriv))) {
5210: $$allroles{'cm.'.$area}.=':'.$coursepriv;
5211: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
5212: }
5213: }
5214: }
5215: }
5216: }
5217:
1.678 raeburn 5218: sub group_roleprivs {
5219: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
5220: my $access = 1;
5221: my $now = time;
5222: if (($tend!=0) && ($tend<$now)) { $access = 0; }
5223: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
5224: if ($access) {
1.811 albertel 5225: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 5226: $$allgroups{$course}{$group} .=':'.$group_privs;
5227: }
5228: }
1.567 raeburn 5229:
5230: sub standard_roleprivs {
5231: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
5232: if (defined($pr{$trole.':s'})) {
5233: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
5234: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
5235: }
5236: if ($tdomain ne '') {
5237: if (defined($pr{$trole.':d'})) {
5238: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5239: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
5240: }
5241: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
5242: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
5243: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
5244: }
5245: }
5246: }
5247:
5248: sub set_userprivs {
1.1064 raeburn 5249: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 5250: my $author=0;
5251: my $adv=0;
1.678 raeburn 5252: my %grouproles = ();
5253: if (keys(%{$allgroups}) > 0) {
1.1064 raeburn 5254: my @groupkeys;
1.1000 raeburn 5255: foreach my $role (keys(%{$allroles})) {
1.1064 raeburn 5256: push(@groupkeys,$role);
5257: }
5258: if (ref($groups_roles) eq 'HASH') {
5259: foreach my $key (keys(%{$groups_roles})) {
5260: unless (grep(/^\Q$key\E$/,@groupkeys)) {
5261: push(@groupkeys,$key);
5262: }
5263: }
5264: }
5265: if (@groupkeys > 0) {
5266: foreach my $role (@groupkeys) {
5267: my ($trole,$area,$sec,$extendedarea);
5268: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
5269: $trole = $1;
5270: $area = $2;
5271: $sec = $3;
5272: $extendedarea = $area.$sec;
5273: if (exists($$allgroups{$area})) {
5274: foreach my $group (keys(%{$$allgroups{$area}})) {
5275: my $spec = $trole.'.'.$extendedarea;
5276: $grouproles{$spec.'.'.$area.'/'.$group} =
1.681 raeburn 5277: $$allgroups{$area}{$group};
1.1064 raeburn 5278: }
1.678 raeburn 5279: }
5280: }
5281: }
5282: }
5283: }
1.800 albertel 5284: foreach my $group (keys(%grouproles)) {
5285: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 5286: }
1.800 albertel 5287: foreach my $role (keys(%{$allroles})) {
5288: my %thesepriv;
1.941 raeburn 5289: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 5290: foreach my $item (split(/:/,$$allroles{$role})) {
5291: if ($item ne '') {
5292: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 5293: if ($restrictions eq '') {
5294: $thesepriv{$privilege}='F';
5295: } elsif ($thesepriv{$privilege} ne 'F') {
5296: $thesepriv{$privilege}.=$restrictions;
5297: }
5298: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
5299: }
5300: }
5301: my $thesestr='';
1.1104 raeburn 5302: foreach my $priv (sort(keys(%thesepriv))) {
1.800 albertel 5303: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
5304: }
5305: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 5306: }
5307: return ($author,$adv);
5308: }
5309:
1.994 raeburn 5310: sub role_status {
1.1104 raeburn 5311: my ($rolekey,$update,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 5312: my @pwhere = ();
5313: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
5314: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
5315: unless (!defined($$role) || $$role eq '') {
5316: $$where=join('.',@pwhere);
5317: $$trolecode=$$role.'.'.$$where;
5318: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
5319: $$tstatus='is';
1.1104 raeburn 5320: if ($$tstart && $$tstart>$update) {
1.994 raeburn 5321: $$tstatus='future';
1.1034 raeburn 5322: if ($$tstart<$now) {
5323: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 5324: if (($$where ne '') && ($$role ne '')) {
1.1064 raeburn 5325: my (%allroles,%allgroups,$group_privs,
5326: %groups_roles,@rolecodes);
1.1002 raeburn 5327: my %userroles = (
5328: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
5329: );
1.1064 raeburn 5330: @rolecodes = ('cm');
1.1002 raeburn 5331: my $spec=$$role.'.'.$$where;
5332: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
5333: if ($$role =~ /^cr\//) {
5334: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1064 raeburn 5335: push(@rolecodes,'cr');
1.1002 raeburn 5336: } elsif ($$role eq 'gr') {
1.1064 raeburn 5337: push(@rolecodes,$$role);
1.1002 raeburn 5338: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
5339: $env{'user.name'});
1.1064 raeburn 5340: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 5341: (undef,my $group_privs) = split(/\//,$trole);
5342: $group_privs = &unescape($group_privs);
5343: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1064 raeburn 5344: 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 5345: &get_groups_roles($tdomain,$trest,
5346: \%course_roles,\@rolecodes,
5347: \%groups_roles);
1.1002 raeburn 5348: } else {
1.1064 raeburn 5349: push(@rolecodes,$$role);
1.1002 raeburn 5350: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
5351: }
1.1064 raeburn 5352: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
5353: &appenv(\%userroles,\@rolecodes);
1.1002 raeburn 5354: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
5355: }
5356: }
1.1034 raeburn 5357: $$tstatus = 'is';
1.1002 raeburn 5358: }
1.994 raeburn 5359: }
5360: if ($$tend) {
1.1104 raeburn 5361: if ($$tend<$update) {
1.994 raeburn 5362: $$tstatus='expired';
5363: } elsif ($$tend<$now) {
5364: $$tstatus='will_not';
5365: }
5366: }
5367: }
5368: }
5369: }
5370:
1.1104 raeburn 5371: sub get_groups_roles {
5372: my ($cdom,$rest,$cdom_courseroles,$rolecodes,$groups_roles) = @_;
5373: return unless((ref($cdom_courseroles) eq 'HASH') &&
5374: (ref($rolecodes) eq 'ARRAY') &&
5375: (ref($groups_roles) eq 'HASH'));
5376: if (keys(%{$cdom_courseroles}) > 0) {
5377: my ($cnum) = ($rest =~ /^($match_courseid)/);
5378: if ($cdom ne '' && $cnum ne '') {
5379: foreach my $key (keys(%{$cdom_courseroles})) {
5380: if ($key =~ /^\Q$cnum\E:\Q$cdom\E:([^:]+):?([^:]*)/) {
5381: my $crsrole = $1;
5382: my $crssec = $2;
5383: if ($crsrole =~ /^cr/) {
5384: unless (grep(/^cr$/,@{$rolecodes})) {
5385: push(@{$rolecodes},'cr');
5386: }
5387: } else {
5388: unless(grep(/^\Q$crsrole\E$/,@{$rolecodes})) {
5389: push(@{$rolecodes},$crsrole);
5390: }
5391: }
5392: my $rolekey = "$crsrole./$cdom/$cnum";
5393: if ($crssec ne '') {
5394: $rolekey .= "/$crssec";
5395: }
5396: $rolekey .= './';
5397: $groups_roles->{$rolekey} = $rolecodes;
5398: }
5399: }
5400: }
5401: }
5402: return;
5403: }
5404:
5405: sub delete_env_groupprivs {
5406: my ($where,$courseroles,$possroles) = @_;
5407: return unless((ref($courseroles) eq 'HASH') && (ref($possroles) eq 'ARRAY'));
5408: my ($dummy,$udom,$uname,$group) = split(/\//,$where);
5409: unless (ref($courseroles->{$udom}) eq 'HASH') {
5410: %{$courseroles->{$udom}} =
5411: &get_my_roles('','','userroles',['active'],
5412: $possroles,[$udom],1);
5413: }
5414: if (ref($courseroles->{$udom}) eq 'HASH') {
5415: foreach my $item (keys(%{$courseroles->{$udom}})) {
5416: my ($cnum,$cdom,$crsrole,$crssec) = split(/:/,$item);
5417: my $area = '/'.$cdom.'/'.$cnum;
5418: my $privkey = "user.priv.$crsrole.$area";
5419: if ($crssec ne '') {
5420: $privkey .= '/'.$crssec;
5421: }
5422: $privkey .= ".$area/$group";
5423: &Apache::lonnet::delenv($privkey,undef,[$crsrole]);
5424: }
5425: }
5426: return;
5427: }
5428:
1.994 raeburn 5429: sub check_adhoc_privs {
1.1104 raeburn 5430: my ($cdom,$cnum,$update,$refresh,$now,$checkrole,$caller) = @_;
1.994 raeburn 5431: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
1.1185 raeburn 5432: my $setprivs;
1.994 raeburn 5433: if ($env{$cckey}) {
5434: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1104 raeburn 5435: &role_status($cckey,$update,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 5436: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
1.1088 raeburn 5437: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.1185 raeburn 5438: $setprivs = 1;
1.994 raeburn 5439: }
5440: } else {
1.1088 raeburn 5441: &set_adhoc_privileges($cdom,$cnum,$checkrole,$caller);
1.1185 raeburn 5442: $setprivs = 1;
1.994 raeburn 5443: }
1.1185 raeburn 5444: return $setprivs;
1.994 raeburn 5445: }
5446:
5447: sub set_adhoc_privileges {
5448: # role can be cc or ca
1.1088 raeburn 5449: my ($dcdom,$pickedcourse,$role,$caller) = @_;
1.994 raeburn 5450: my $area = '/'.$dcdom.'/'.$pickedcourse;
5451: my $spec = $role.'.'.$area;
5452: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
1.1215 raeburn 5453: $env{'user.name'},1);
1.994 raeburn 5454: my %ccrole = ();
5455: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
5456: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
5457: &appenv(\%userroles,[$role,'cm']);
5458: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
1.1088 raeburn 5459: unless ($caller eq 'constructaccess' && $env{'request.course.id'}) {
5460: &appenv( {'request.role' => $spec,
5461: 'request.role.domain' => $dcdom,
5462: 'request.course.sec' => ''
5463: }
5464: );
5465: my $tadv=0;
5466: if (&allowed('adv') eq 'F') { $tadv=1; }
5467: &appenv({'request.role.adv' => $tadv});
5468: }
1.994 raeburn 5469: }
5470:
1.12 www 5471: # --------------------------------------------------------------- get interface
5472:
5473: sub get {
1.131 albertel 5474: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 5475: my $items='';
1.800 albertel 5476: foreach my $item (@$storearr) {
5477: $items.=&escape($item).'&';
1.191 harris41 5478: }
1.12 www 5479: $items=~s/\&$//;
1.620 albertel 5480: if (!$udomain) { $udomain=$env{'user.domain'}; }
5481: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 5482: my $uhome=&homeserver($uname,$udomain);
5483:
1.133 albertel 5484: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 5485: my @pairs=split(/\&/,$rep);
1.273 albertel 5486: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
5487: return @pairs;
5488: }
1.15 www 5489: my %returnhash=();
1.42 www 5490: my $i=0;
1.800 albertel 5491: foreach my $item (@$storearr) {
5492: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 5493: $i++;
1.191 harris41 5494: }
1.15 www 5495: return %returnhash;
1.27 www 5496: }
5497:
5498: # --------------------------------------------------------------- del interface
5499:
5500: sub del {
1.133 albertel 5501: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 5502: my $items='';
1.800 albertel 5503: foreach my $item (@$storearr) {
5504: $items.=&escape($item).'&';
1.191 harris41 5505: }
1.984 neumanie 5506:
1.27 www 5507: $items=~s/\&$//;
1.620 albertel 5508: if (!$udomain) { $udomain=$env{'user.domain'}; }
5509: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 5510: my $uhome=&homeserver($uname,$udomain);
5511: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 5512: }
5513:
5514: # -------------------------------------------------------------- dump interface
5515:
1.1180 droeschl 5516: sub unserialize {
5517: my ($rep, $escapedkeys) = @_;
5518:
5519: return {} if $rep =~ /^error/;
5520:
5521: my %returnhash=();
5522: foreach my $item (split /\&/, $rep) {
5523: my ($key, $value) = split(/=/, $item, 2);
5524: $key = unescape($key) unless $escapedkeys;
5525: next if $key =~ /^error: 2 /;
5526: $returnhash{$key} = Apache::lonnet::thaw_unescape($value);
5527: }
5528: #return %returnhash;
5529: return \%returnhash;
5530: }
5531:
5532: # see Lond::dump_with_regexp
5533: # if $escapedkeys hash keys won't get unescaped.
1.15 www 5534: sub dump {
1.1180 droeschl 5535: my ($namespace,$udomain,$uname,$regexp,$range,$escapedkeys)=@_;
1.755 albertel 5536: if (!$udomain) { $udomain=$env{'user.domain'}; }
5537: if (!$uname) { $uname=$env{'user.name'}; }
5538: my $uhome=&homeserver($uname,$udomain);
1.1167 droeschl 5539:
1.1180 droeschl 5540: my $reply;
5541: if (grep { $_ eq $uhome } current_machine_ids()) {
5542: # user is hosted on this machine
5543: $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
1.1226 raeburn 5544: $uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
1.1180 droeschl 5545: return %{unserialize($reply, $escapedkeys)};
5546: }
1.755 albertel 5547: if ($regexp) {
5548: $regexp=&escape($regexp);
5549: } else {
5550: $regexp='.';
5551: }
1.1166 raeburn 5552: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
1.755 albertel 5553: my @pairs=split(/\&/,$rep);
5554: my %returnhash=();
1.1098 foxr 5555: if (!($rep =~ /^error/ )) {
5556: foreach my $item (@pairs) {
5557: my ($key,$value)=split(/=/,$item,2);
1.1180 droeschl 5558: $key = unescape($key) unless $escapedkeys;
5559: #$key = &unescape($key);
1.1098 foxr 5560: next if ($key =~ /^error: 2 /);
5561: $returnhash{$key}=&thaw_unescape($value);
5562: }
1.755 albertel 5563: }
5564: return %returnhash;
1.407 www 5565: }
5566:
1.1098 foxr 5567:
1.717 albertel 5568: # --------------------------------------------------------- dumpstore interface
5569:
5570: sub dumpstore {
5571: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.1180 droeschl 5572: # same as dump but keys must be escaped. They may contain colon separated
5573: # lists of values that may themself contain colons (e.g. symbs).
5574: return &dump($namespace, $udomain, $uname, $regexp, $range, 1);
1.717 albertel 5575: }
5576:
1.407 www 5577: # -------------------------------------------------------------- keys interface
5578:
5579: sub getkeys {
5580: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 5581: if (!$udomain) { $udomain=$env{'user.domain'}; }
5582: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 5583: my $uhome=&homeserver($uname,$udomain);
5584: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
5585: my @keyarray=();
1.800 albertel 5586: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 5587: next if ($key =~ /^error: 2 /);
1.800 albertel 5588: push(@keyarray,&unescape($key));
1.407 www 5589: }
5590: return @keyarray;
1.318 matthew 5591: }
5592:
1.319 matthew 5593: # --------------------------------------------------------------- currentdump
5594: sub currentdump {
1.328 matthew 5595: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 5596: $courseid = $env{'request.course.id'} if (! defined($courseid));
5597: $sdom = $env{'user.domain'} if (! defined($sdom));
5598: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 5599: my $uhome = &homeserver($sname,$sdom);
1.1180 droeschl 5600: my $rep;
5601:
5602: if (grep { $_ eq $uhome } current_machine_ids()) {
5603: $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
5604: $courseid)));
5605: } else {
5606: $rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
5607: }
5608:
1.318 matthew 5609: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 5610: #
1.318 matthew 5611: my %returnhash=();
1.319 matthew 5612: #
5613: if ($rep eq "unknown_cmd") {
5614: # an old lond will not know currentdump
5615: # Do a dump and make it look like a currentdump
1.822 albertel 5616: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 5617: return if ($tmp[0] =~ /^(error:|no_such_host)/);
5618: my %hash = @tmp;
5619: @tmp=();
1.424 matthew 5620: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 5621: } else {
5622: my @pairs=split(/\&/,$rep);
1.800 albertel 5623: foreach my $pair (@pairs) {
5624: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 5625: my ($symb,$param) = split(/:/,$key);
5626: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 5627: &thaw_unescape($value);
1.319 matthew 5628: }
1.191 harris41 5629: }
1.12 www 5630: return %returnhash;
1.424 matthew 5631: }
5632:
5633: sub convert_dump_to_currentdump{
5634: my %hash = %{shift()};
5635: my %returnhash;
5636: # Code ripped from lond, essentially. The only difference
5637: # here is the unescaping done by lonnet::dump(). Conceivably
5638: # we might run in to problems with parameter names =~ /^v\./
5639: while (my ($key,$value) = each(%hash)) {
5640: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 5641: $symb = &unescape($symb);
5642: $param = &unescape($param);
1.424 matthew 5643: next if ($v eq 'version' || $symb eq 'keys');
5644: next if (exists($returnhash{$symb}) &&
5645: exists($returnhash{$symb}->{$param}) &&
5646: $returnhash{$symb}->{'v.'.$param} > $v);
5647: $returnhash{$symb}->{$param}=$value;
5648: $returnhash{$symb}->{'v.'.$param}=$v;
5649: }
5650: #
5651: # Remove all of the keys in the hashes which keep track of
5652: # the version of the parameter.
5653: while (my ($symb,$param_hash) = each(%returnhash)) {
5654: # use a foreach because we are going to delete from the hash.
5655: foreach my $key (keys(%$param_hash)) {
5656: delete($param_hash->{$key}) if ($key =~ /^v\./);
5657: }
5658: }
5659: return \%returnhash;
1.12 www 5660: }
5661:
1.627 albertel 5662: # ------------------------------------------------------ critical inc interface
5663:
5664: sub cinc {
5665: return &inc(@_,'critical');
5666: }
5667:
1.449 matthew 5668: # --------------------------------------------------------------- inc interface
5669:
5670: sub inc {
1.627 albertel 5671: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 5672: if (!$udomain) { $udomain=$env{'user.domain'}; }
5673: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 5674: my $uhome=&homeserver($uname,$udomain);
5675: my $items='';
5676: if (! ref($store)) {
5677: # got a single value, so use that instead
5678: $items = &escape($store).'=&';
5679: } elsif (ref($store) eq 'SCALAR') {
5680: $items = &escape($$store).'=&';
5681: } elsif (ref($store) eq 'ARRAY') {
5682: $items = join('=&',map {&escape($_);} @{$store});
5683: } elsif (ref($store) eq 'HASH') {
5684: while (my($key,$value) = each(%{$store})) {
5685: $items.= &escape($key).'='.&escape($value).'&';
5686: }
5687: }
5688: $items=~s/\&$//;
1.627 albertel 5689: if ($critical) {
5690: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
5691: } else {
5692: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
5693: }
1.449 matthew 5694: }
5695:
1.12 www 5696: # --------------------------------------------------------------- put interface
5697:
5698: sub put {
1.134 albertel 5699: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 5700: if (!$udomain) { $udomain=$env{'user.domain'}; }
5701: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 5702: my $uhome=&homeserver($uname,$udomain);
1.12 www 5703: my $items='';
1.800 albertel 5704: foreach my $item (keys(%$storehash)) {
5705: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 5706: }
1.12 www 5707: $items=~s/\&$//;
1.134 albertel 5708: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 5709: }
5710:
1.631 albertel 5711: # ------------------------------------------------------------ newput interface
5712:
5713: sub newput {
5714: my ($namespace,$storehash,$udomain,$uname)=@_;
5715: if (!$udomain) { $udomain=$env{'user.domain'}; }
5716: if (!$uname) { $uname=$env{'user.name'}; }
5717: my $uhome=&homeserver($uname,$udomain);
5718: my $items='';
5719: foreach my $key (keys(%$storehash)) {
5720: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
5721: }
5722: $items=~s/\&$//;
5723: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
5724: }
5725:
5726: # --------------------------------------------------------- putstore interface
5727:
1.524 raeburn 5728: sub putstore {
1.715 albertel 5729: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 5730: if (!$udomain) { $udomain=$env{'user.domain'}; }
5731: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 5732: my $uhome=&homeserver($uname,$udomain);
5733: my $items='';
1.715 albertel 5734: foreach my $key (keys(%$storehash)) {
5735: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 5736: }
1.715 albertel 5737: $items=~s/\&$//;
1.716 albertel 5738: my $esc_symb=&escape($symb);
5739: my $esc_v=&escape($version);
1.715 albertel 5740: my $reply =
1.716 albertel 5741: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 5742: $uhome);
5743: if ($reply eq 'unknown_cmd') {
1.716 albertel 5744: # gfall back to way things use to be done
1.715 albertel 5745: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
5746: $uname);
1.524 raeburn 5747: }
1.715 albertel 5748: return $reply;
5749: }
5750:
5751: sub old_putstore {
1.716 albertel 5752: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
5753: if (!$udomain) { $udomain=$env{'user.domain'}; }
5754: if (!$uname) { $uname=$env{'user.name'}; }
5755: my $uhome=&homeserver($uname,$udomain);
5756: my %newstorehash;
1.800 albertel 5757: foreach my $item (keys(%$storehash)) {
5758: my $key = $version.':'.&escape($symb).':'.$item;
5759: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 5760: }
5761: my $items='';
5762: my %allitems = ();
1.800 albertel 5763: foreach my $item (keys(%newstorehash)) {
5764: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 5765: my $key = $1.':keys:'.$2;
5766: $allitems{$key} .= $3.':';
5767: }
1.800 albertel 5768: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 5769: }
1.800 albertel 5770: foreach my $item (keys(%allitems)) {
5771: $allitems{$item} =~ s/\:$//;
5772: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 5773: }
5774: $items=~s/\&$//;
5775: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 5776: }
5777:
1.47 www 5778: # ------------------------------------------------------ critical put interface
5779:
5780: sub cput {
1.134 albertel 5781: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 5782: if (!$udomain) { $udomain=$env{'user.domain'}; }
5783: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 5784: my $uhome=&homeserver($uname,$udomain);
1.47 www 5785: my $items='';
1.800 albertel 5786: foreach my $item (keys(%$storehash)) {
5787: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 5788: }
1.47 www 5789: $items=~s/\&$//;
1.134 albertel 5790: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 5791: }
5792:
5793: # -------------------------------------------------------------- eget interface
5794:
5795: sub eget {
1.133 albertel 5796: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 5797: my $items='';
1.800 albertel 5798: foreach my $item (@$storearr) {
5799: $items.=&escape($item).'&';
1.191 harris41 5800: }
1.12 www 5801: $items=~s/\&$//;
1.620 albertel 5802: if (!$udomain) { $udomain=$env{'user.domain'}; }
5803: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 5804: my $uhome=&homeserver($uname,$udomain);
5805: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 5806: my @pairs=split(/\&/,$rep);
5807: my %returnhash=();
1.42 www 5808: my $i=0;
1.800 albertel 5809: foreach my $item (@$storearr) {
5810: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 5811: $i++;
1.191 harris41 5812: }
1.12 www 5813: return %returnhash;
5814: }
5815:
1.667 albertel 5816: # ------------------------------------------------------------ tmpput interface
5817: sub tmpput {
1.802 raeburn 5818: my ($storehash,$server,$context)=@_;
1.667 albertel 5819: my $items='';
1.800 albertel 5820: foreach my $item (keys(%$storehash)) {
5821: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 5822: }
5823: $items=~s/\&$//;
1.802 raeburn 5824: if (defined($context)) {
5825: $items .= ':'.&escape($context);
5826: }
1.667 albertel 5827: return &reply("tmpput:$items",$server);
5828: }
5829:
5830: # ------------------------------------------------------------ tmpget interface
5831: sub tmpget {
1.688 albertel 5832: my ($token,$server)=@_;
5833: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5834: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 5835: my %returnhash;
5836: foreach my $item (split(/\&/,$rep)) {
5837: my ($key,$value)=split(/=/,$item);
1.951 raeburn 5838: next if ($key =~ /^error: 2 /);
1.667 albertel 5839: $returnhash{&unescape($key)}=&thaw_unescape($value);
5840: }
5841: return %returnhash;
5842: }
5843:
1.1113 raeburn 5844: # ------------------------------------------------------------ tmpdel interface
1.688 albertel 5845: sub tmpdel {
5846: my ($token,$server)=@_;
5847: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
5848: return &reply("tmpdel:$token",$server);
5849: }
5850:
1.1198 raeburn 5851: # ------------------------------------------------------------ get_timebased_id
5852:
5853: sub get_timebased_id {
5854: my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
5855: $maxtries) = @_;
5856: my ($newid,$error,$dellock);
5857: unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
5858: return ('','ok','invalid call to get suffix');
5859: }
5860:
5861: # set defaults for any optional args for which values were not supplied
5862: if ($who eq '') {
5863: $who = $env{'user.name'}.':'.$env{'user.domain'};
5864: }
5865: if (!$locktries) {
5866: $locktries = 3;
5867: }
5868: if (!$maxtries) {
5869: $maxtries = 10;
5870: }
5871:
5872: if (($cdom eq '') || ($cnum eq '')) {
5873: if ($env{'request.course.id'}) {
5874: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5875: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5876: }
5877: if (($cdom eq '') || ($cnum eq '')) {
5878: return ('','ok','call to get suffix not in course context');
5879: }
5880: }
5881:
5882: # construct locking item
5883: my $lockhash = {
5884: $prefix."\0".'locked_'.$keyid => $who,
5885: };
5886: my $tries = 0;
5887:
5888: # attempt to get lock on nohist_$namespace file
5889: my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
5890: while (($gotlock ne 'ok') && $tries <$locktries) {
5891: $tries ++;
5892: sleep 1;
5893: $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
5894: }
5895:
5896: # attempt to get unique identifier, based on current timestamp
5897: if ($gotlock eq 'ok') {
5898: my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
5899: my $id = time;
5900: $newid = $id;
5901: my $idtries = 0;
5902: while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
5903: if ($idtype eq 'concat') {
5904: $newid = $id.$idtries;
5905: } else {
5906: $newid ++;
5907: }
5908: $idtries ++;
5909: }
5910: if (!exists($inuse{$prefix."\0".$newid})) {
5911: my %new_item = (
5912: $prefix."\0".$newid => $who,
5913: );
5914: my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
5915: $cdom,$cnum);
5916: if ($putresult ne 'ok') {
5917: undef($newid);
5918: $error = 'error saving new item: '.$putresult;
5919: }
5920: } else {
5921: $error = ('error: no unique suffix available for the new item ');
5922: }
5923: # remove lock
5924: my @del_lock = ($prefix."\0".'locked_'.$keyid);
5925: $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
5926: } else {
5927: $error = "error: could not obtain lockfile\n";
5928: $dellock = 'ok';
5929: }
5930: return ($newid,$dellock,$error);
5931: }
5932:
1.765 albertel 5933: # -------------------------------------------------- portfolio access checking
5934:
5935: sub portfolio_access {
1.766 albertel 5936: my ($requrl) = @_;
1.765 albertel 5937: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
5938: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 5939: if ($result) {
5940: my %setters;
5941: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
5942: my ($startblock,$endblock) =
5943: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
5944: if ($startblock && $endblock) {
5945: return 'B';
5946: }
5947: } else {
5948: my ($startblock,$endblock) =
5949: &Apache::loncommon::blockcheck(\%setters,'port');
5950: if ($startblock && $endblock) {
5951: return 'B';
5952: }
5953: }
5954: }
1.765 albertel 5955: if ($result eq 'ok') {
1.766 albertel 5956: return 'F';
1.765 albertel 5957: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 5958: return 'A';
1.765 albertel 5959: }
1.766 albertel 5960: return '';
1.765 albertel 5961: }
5962:
5963: sub get_portfolio_access {
1.767 albertel 5964: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
5965:
5966: if (!ref($access_hash)) {
5967: my $current_perms = &get_portfile_permissions($udom,$unum);
5968: my %access_controls = &get_access_controls($current_perms,$group,
5969: $file_name);
5970: $access_hash = $access_controls{$file_name};
5971: }
5972:
1.765 albertel 5973: my ($public,$guest,@domains,@users,@courses,@groups);
5974: my $now = time;
5975: if (ref($access_hash) eq 'HASH') {
5976: foreach my $key (keys(%{$access_hash})) {
5977: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
5978: if ($start > $now) {
5979: next;
5980: }
5981: if ($end && $end<$now) {
5982: next;
5983: }
5984: if ($scope eq 'public') {
5985: $public = $key;
5986: last;
5987: } elsif ($scope eq 'guest') {
5988: $guest = $key;
5989: } elsif ($scope eq 'domains') {
5990: push(@domains,$key);
5991: } elsif ($scope eq 'users') {
5992: push(@users,$key);
5993: } elsif ($scope eq 'course') {
5994: push(@courses,$key);
5995: } elsif ($scope eq 'group') {
5996: push(@groups,$key);
5997: }
5998: }
5999: if ($public) {
6000: return 'ok';
6001: }
6002: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
6003: if ($guest) {
6004: return $guest;
6005: }
6006: } else {
6007: if (@domains > 0) {
6008: foreach my $domkey (@domains) {
6009: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
6010: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
6011: return 'ok';
6012: }
6013: }
6014: }
6015: }
6016: if (@users > 0) {
6017: foreach my $userkey (@users) {
1.865 raeburn 6018: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
6019: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
6020: if (ref($item) eq 'HASH') {
6021: if (($item->{'uname'} eq $env{'user.name'}) &&
6022: ($item->{'udom'} eq $env{'user.domain'})) {
6023: return 'ok';
6024: }
6025: }
6026: }
6027: }
1.765 albertel 6028: }
6029: }
6030: my %roleshash;
6031: my @courses_and_groups = @courses;
6032: push(@courses_and_groups,@groups);
6033: if (@courses_and_groups > 0) {
6034: my (%allgroups,%allroles);
6035: my ($start,$end,$role,$sec,$group);
6036: foreach my $envkey (%env) {
1.1060 raeburn 6037: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6038: my $cid = $2.'_'.$3;
6039: if ($1 eq 'gr') {
6040: $group = $4;
6041: $allgroups{$cid}{$group} = $env{$envkey};
6042: } else {
6043: if ($4 eq '') {
6044: $sec = 'none';
6045: } else {
6046: $sec = $4;
6047: }
6048: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6049: }
1.811 albertel 6050: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 6051: my $cid = $2.'_'.$3;
6052: if ($4 eq '') {
6053: $sec = 'none';
6054: } else {
6055: $sec = $4;
6056: }
6057: $allroles{$cid}{$1}{$sec} = $env{$envkey};
6058: }
6059: }
6060: if (keys(%allroles) == 0) {
6061: return;
6062: }
6063: foreach my $key (@courses_and_groups) {
6064: my %content = %{$$access_hash{$key}};
6065: my $cnum = $content{'number'};
6066: my $cdom = $content{'domain'};
6067: my $cid = $cdom.'_'.$cnum;
6068: if (!exists($allroles{$cid})) {
6069: next;
6070: }
6071: foreach my $role_id (keys(%{$content{'roles'}})) {
6072: my @sections = @{$content{'roles'}{$role_id}{'section'}};
6073: my @groups = @{$content{'roles'}{$role_id}{'group'}};
6074: my @status = @{$content{'roles'}{$role_id}{'access'}};
6075: my @roles = @{$content{'roles'}{$role_id}{'role'}};
6076: foreach my $role (keys(%{$allroles{$cid}})) {
6077: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
6078: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
6079: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
6080: if (grep/^all$/,@sections) {
6081: return 'ok';
6082: } else {
6083: if (grep/^$sec$/,@sections) {
6084: return 'ok';
6085: }
6086: }
6087: }
6088: }
6089: if (keys(%{$allgroups{$cid}}) == 0) {
6090: if (grep/^none$/,@groups) {
6091: return 'ok';
6092: }
6093: } else {
6094: if (grep/^all$/,@groups) {
6095: return 'ok';
6096: }
6097: foreach my $group (keys(%{$allgroups{$cid}})) {
6098: if (grep/^$group$/,@groups) {
6099: return 'ok';
6100: }
6101: }
6102: }
6103: }
6104: }
6105: }
6106: }
6107: }
6108: if ($guest) {
6109: return $guest;
6110: }
6111: }
6112: }
6113: return;
6114: }
6115:
6116: sub course_group_datechecker {
6117: my ($dates,$now,$status) = @_;
6118: my ($start,$end) = split(/\./,$dates);
6119: if (!$start && !$end) {
6120: return 'ok';
6121: }
6122: if (grep/^active$/,@{$status}) {
6123: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
6124: return 'ok';
6125: }
6126: }
6127: if (grep/^previous$/,@{$status}) {
6128: if ($end > $now ) {
6129: return 'ok';
6130: }
6131: }
6132: if (grep/^future$/,@{$status}) {
6133: if ($start > $now) {
6134: return 'ok';
6135: }
6136: }
6137: return;
6138: }
6139:
6140: sub parse_portfolio_url {
6141: my ($url) = @_;
6142:
6143: my ($type,$udom,$unum,$group,$file_name);
6144:
1.823 albertel 6145: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 6146: $type = 1;
6147: $udom = $1;
6148: $unum = $2;
6149: $file_name = $3;
1.823 albertel 6150: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 6151: $type = 2;
6152: $udom = $1;
6153: $unum = $2;
6154: $group = $3;
6155: $file_name = $3.'/'.$4;
6156: }
6157: if (wantarray) {
6158: return ($type,$udom,$unum,$file_name,$group);
6159: }
6160: return $type;
6161: }
6162:
6163: sub is_portfolio_url {
6164: my ($url) = @_;
6165: return scalar(&parse_portfolio_url($url));
6166: }
6167:
1.798 raeburn 6168: sub is_portfolio_file {
6169: my ($file) = @_;
1.820 raeburn 6170: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 6171: return 1;
6172: }
6173: return;
6174: }
6175:
1.976 raeburn 6176: sub usertools_access {
1.1084 raeburn 6177: my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
1.985 raeburn 6178: my ($access,%tools);
6179: if ($context eq '') {
6180: $context = 'tools';
6181: }
6182: if ($context eq 'requestcourses') {
6183: %tools = (
6184: official => 1,
6185: unofficial => 1,
1.1006 raeburn 6186: community => 1,
1.985 raeburn 6187: );
1.1183 raeburn 6188: } elsif ($context eq 'requestauthor') {
6189: %tools = (
6190: requestauthor => 1,
6191: );
1.985 raeburn 6192: } else {
6193: %tools = (
6194: aboutme => 1,
6195: blog => 1,
1.1177 raeburn 6196: webdav => 1,
1.985 raeburn 6197: portfolio => 1,
6198: );
6199: }
1.976 raeburn 6200: return if (!defined($tools{$tool}));
6201:
6202: if ((!defined($udom)) || (!defined($uname))) {
6203: $udom = $env{'user.domain'};
6204: $uname = $env{'user.name'};
6205: }
6206:
1.978 raeburn 6207: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
6208: if ($action ne 'reload') {
1.985 raeburn 6209: if ($context eq 'requestcourses') {
6210: return $env{'environment.canrequest.'.$tool};
1.1183 raeburn 6211: } elsif ($context eq 'requestauthor') {
6212: return $env{'environment.canrequest.author'};
1.985 raeburn 6213: } else {
6214: return $env{'environment.availabletools.'.$tool};
6215: }
6216: }
1.976 raeburn 6217: }
6218:
1.1183 raeburn 6219: my ($toolstatus,$inststatus,$envkey);
6220: if ($context eq 'requestauthor') {
6221: $envkey = $context;
6222: } else {
6223: $envkey = $context.'.'.$tool;
6224: }
1.976 raeburn 6225:
1.985 raeburn 6226: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
6227: ($action ne 'reload')) {
1.1183 raeburn 6228: $toolstatus = $env{'environment.'.$envkey};
1.976 raeburn 6229: $inststatus = $env{'environment.inststatus'};
6230: } else {
1.1084 raeburn 6231: if (ref($userenvref) eq 'HASH') {
1.1183 raeburn 6232: $toolstatus = $userenvref->{$envkey};
1.1084 raeburn 6233: $inststatus = $userenvref->{'inststatus'};
6234: } else {
1.1183 raeburn 6235: my %userenv = &userenvironment($udom,$uname,$envkey,'inststatus');
6236: $toolstatus = $userenv{$envkey};
1.1084 raeburn 6237: $inststatus = $userenv{'inststatus'};
6238: }
1.976 raeburn 6239: }
6240:
6241: if ($toolstatus ne '') {
6242: if ($toolstatus) {
6243: $access = 1;
6244: } else {
6245: $access = 0;
6246: }
6247: return $access;
6248: }
6249:
1.1084 raeburn 6250: my ($is_adv,%domdef);
6251: if (ref($is_advref) eq 'HASH') {
6252: $is_adv = $is_advref->{'is_adv'};
6253: } else {
6254: $is_adv = &is_advanced_user($udom,$uname);
6255: }
6256: if (ref($domdefref) eq 'HASH') {
6257: %domdef = %{$domdefref};
6258: } else {
6259: %domdef = &get_domain_defaults($udom);
6260: }
1.976 raeburn 6261: if (ref($domdef{$tool}) eq 'HASH') {
6262: if ($is_adv) {
6263: if ($domdef{$tool}{'_LC_adv'} ne '') {
6264: if ($domdef{$tool}{'_LC_adv'}) {
6265: $access = 1;
6266: } else {
6267: $access = 0;
6268: }
6269: return $access;
6270: }
6271: }
6272: if ($inststatus ne '') {
6273: my ($hasaccess,$hasnoaccess);
6274: foreach my $affiliation (split(/:/,$inststatus)) {
6275: if ($domdef{$tool}{$affiliation} ne '') {
6276: if ($domdef{$tool}{$affiliation}) {
6277: $hasaccess = 1;
6278: } else {
6279: $hasnoaccess = 1;
6280: }
6281: }
6282: }
6283: if ($hasaccess || $hasnoaccess) {
6284: if ($hasaccess) {
6285: $access = 1;
6286: } elsif ($hasnoaccess) {
6287: $access = 0;
6288: }
6289: return $access;
6290: }
6291: } else {
6292: if ($domdef{$tool}{'default'} ne '') {
6293: if ($domdef{$tool}{'default'}) {
6294: $access = 1;
6295: } elsif ($domdef{$tool}{'default'} == 0) {
6296: $access = 0;
6297: }
6298: return $access;
6299: }
6300: }
6301: } else {
1.1177 raeburn 6302: if (($context eq 'tools') && ($tool ne 'webdav')) {
1.985 raeburn 6303: $access = 1;
6304: } else {
6305: $access = 0;
6306: }
1.976 raeburn 6307: return $access;
6308: }
6309: }
6310:
1.1050 raeburn 6311: sub is_course_owner {
6312: my ($cdom,$cnum,$udom,$uname) = @_;
6313: if (($udom eq '') || ($uname eq '')) {
6314: $udom = $env{'user.domain'};
6315: $uname = $env{'user.name'};
6316: }
6317: unless (($udom eq '') || ($uname eq '')) {
6318: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
6319: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
6320: return 1;
6321: } else {
6322: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
6323: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
6324: return 1;
6325: }
6326: }
6327: }
6328: }
6329: return;
6330: }
6331:
1.976 raeburn 6332: sub is_advanced_user {
6333: my ($udom,$uname) = @_;
1.1085 raeburn 6334: if ($udom ne '' && $uname ne '') {
6335: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.1128 raeburn 6336: if (wantarray) {
6337: return ($env{'user.adv'},$env{'user.author'});
6338: } else {
6339: return $env{'user.adv'};
6340: }
1.1085 raeburn 6341: }
6342: }
1.976 raeburn 6343: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
6344: my %allroles;
1.1128 raeburn 6345: my ($is_adv,$is_author);
1.976 raeburn 6346: foreach my $role (keys(%roleshash)) {
6347: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
6348: my $area = '/'.$tdomain.'/'.$trest;
6349: if ($sec ne '') {
6350: $area .= '/'.$sec;
6351: }
6352: if (($area ne '') && ($trole ne '')) {
6353: my $spec=$trole.'.'.$area;
6354: if ($trole =~ /^cr\//) {
6355: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
6356: } elsif ($trole ne 'gr') {
6357: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
6358: }
1.1128 raeburn 6359: if ($trole eq 'au') {
6360: $is_author = 1;
6361: }
1.976 raeburn 6362: }
6363: }
6364: foreach my $role (keys(%allroles)) {
6365: last if ($is_adv);
6366: foreach my $item (split(/:/,$allroles{$role})) {
6367: if ($item ne '') {
6368: my ($privilege,$restrictions)=split(/&/,$item);
6369: if ($privilege eq 'adv') {
6370: $is_adv = 1;
6371: last;
6372: }
6373: }
6374: }
6375: }
1.1128 raeburn 6376: if (wantarray) {
6377: return ($is_adv,$is_author);
6378: }
1.976 raeburn 6379: return $is_adv;
6380: }
1.798 raeburn 6381:
1.1035 raeburn 6382: sub check_can_request {
1.1036 raeburn 6383: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 6384: my $canreq = 0;
6385: my ($types,$typename) = &Apache::loncommon::course_types();
6386: my @options = ('approval','validate','autolimit');
6387: my $optregex = join('|',@options);
6388: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
6389: foreach my $type (@{$types}) {
6390: if (&usertools_access($env{'user.name'},
6391: $env{'user.domain'},
6392: $type,undef,'requestcourses')) {
6393: $canreq ++;
1.1036 raeburn 6394: if (ref($request_domains) eq 'HASH') {
6395: push(@{$request_domains->{$type}},$env{'user.domain'});
6396: }
1.1035 raeburn 6397: if ($dom eq $env{'user.domain'}) {
6398: $can_request->{$type} = 1;
6399: }
6400: }
6401: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
6402: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
6403: if (@curr > 0) {
1.1036 raeburn 6404: foreach my $item (@curr) {
6405: if (ref($request_domains) eq 'HASH') {
6406: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
6407: if ($otherdom ne '') {
6408: if (ref($request_domains->{$type}) eq 'ARRAY') {
6409: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
6410: push(@{$request_domains->{$type}},$otherdom);
6411: }
6412: } else {
6413: push(@{$request_domains->{$type}},$otherdom);
6414: }
6415: }
6416: }
6417: }
6418: unless($dom eq $env{'user.domain'}) {
6419: $canreq ++;
1.1035 raeburn 6420: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
6421: $can_request->{$type} = 1;
6422: }
6423: }
6424: }
6425: }
6426: }
6427: }
6428: return $canreq;
6429: }
6430:
1.341 www 6431: # ---------------------------------------------- Custom access rule evaluation
6432:
6433: sub customaccess {
6434: my ($priv,$uri)=@_;
1.807 albertel 6435: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 6436: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 6437: $udom = &LONCAPA::clean_domain($udom);
6438: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 6439: my $access=0;
1.800 albertel 6440: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 6441: my ($effect,$realm,$role,$type)=split(/\:/,$right);
6442: if ($type eq 'user') {
6443: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 6444: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 6445: if ($tdom) {
6446: if ($tdom ne $env{'user.domain'}) { next; }
6447: }
1.896 albertel 6448: if ($tuname) {
6449: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 6450: }
6451: $access=($effect eq 'allow');
6452: last;
6453: }
6454: } else {
6455: if ($role) {
6456: if ($role ne $urole) { next; }
6457: }
6458: foreach my $scope (split(/\s*\,\s*/,$realm)) {
6459: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
6460: if ($tdom) {
6461: if ($tdom ne $udom) { next; }
6462: }
6463: if ($tcrs) {
6464: if ($tcrs ne $ucrs) { next; }
6465: }
6466: if ($tsec) {
6467: if ($tsec ne $usec) { next; }
6468: }
6469: $access=($effect eq 'allow');
6470: last;
6471: }
6472: if ($realm eq '' && $role eq '') {
6473: $access=($effect eq 'allow');
6474: }
1.402 bowersj2 6475: }
1.341 www 6476: }
6477: return $access;
6478: }
6479:
1.103 harris41 6480: # ------------------------------------------------- Check for a user privilege
1.12 www 6481:
6482: sub allowed {
1.810 raeburn 6483: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 6484: my $ver_orguri=$uri;
1.439 www 6485: $uri=&deversion($uri);
1.152 www 6486: my $orguri=$uri;
1.52 www 6487: $uri=&declutter($uri);
1.809 raeburn 6488:
1.810 raeburn 6489: if ($priv eq 'evb') {
6490: # Evade communication block restrictions for specified role in a course
6491: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
6492: return $1;
6493: } else {
6494: return;
6495: }
6496: }
6497:
1.620 albertel 6498: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 6499: # Free bre access to adm and meta resources
1.775 albertel 6500: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 6501: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
6502: && ($priv eq 'bre')) {
1.14 www 6503: return 'F';
1.159 www 6504: }
6505:
1.545 banghart 6506: # Free bre access to user's own portfolio contents
1.714 raeburn 6507: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 6508: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 6509: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 6510: my %setters;
6511: my ($startblock,$endblock) =
6512: &Apache::loncommon::blockcheck(\%setters,'port');
6513: if ($startblock && $endblock) {
6514: return 'B';
6515: } else {
6516: return 'F';
6517: }
1.545 banghart 6518: }
6519:
1.762 raeburn 6520: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 6521: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
6522: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
6523: if (exists($env{'request.course.id'})) {
6524: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
6525: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
6526: if (($domain eq $cdom) && ($name eq $cnum)) {
6527: my $courseprivid=$env{'request.course.id'};
6528: $courseprivid=~s/\_/\//;
6529: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
6530: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
6531: return $1;
1.762 raeburn 6532: } else {
6533: if ($env{'request.course.sec'}) {
6534: $courseprivid.='/'.$env{'request.course.sec'};
6535: }
6536: if ($env{'user.priv.'.$env{'request.role'}.'./'.
6537: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
6538: return $2;
6539: }
1.714 raeburn 6540: }
6541: }
6542: }
6543: }
6544:
1.159 www 6545: # Free bre to public access
6546:
6547: if ($priv eq 'bre') {
1.238 www 6548: my $copyright=&metadata($uri,'copyright');
1.620 albertel 6549: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 6550: return 'F';
6551: }
1.238 www 6552: if ($copyright eq 'priv') {
6553: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 6554: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 6555: return '';
6556: }
6557: }
6558: if ($copyright eq 'domain') {
6559: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 6560: unless (($env{'user.domain'} eq $1) ||
6561: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 6562: return '';
6563: }
1.262 matthew 6564: }
1.620 albertel 6565: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 6566: # Library role, so allow browsing of resources in this domain.
6567: return 'F';
1.238 www 6568: }
1.341 www 6569: if ($copyright eq 'custom') {
6570: unless (&customaccess($priv,$uri)) { return ''; }
6571: }
1.14 www 6572: }
1.264 matthew 6573: # Domain coordinator is trying to create a course
1.620 albertel 6574: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 6575: # uri is the requested domain in this case.
6576: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 6577: # a role of dc for the domain in question.
1.620 albertel 6578: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 6579: }
1.29 www 6580:
1.52 www 6581: my $thisallowed='';
6582: my $statecond=0;
6583: my $courseprivid='';
6584:
1.1039 raeburn 6585: my $ownaccess;
1.1043 raeburn 6586: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 6587: if (($priv eq 'bro') && ($env{'user.author'})) {
6588: if ($uri eq '') {
6589: $ownaccess = 1;
6590: } else {
6591: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
6592: my $udom = $env{'user.domain'};
6593: my $uname = $env{'user.name'};
6594: if ($uri =~ m{^\Q$udom\E/?$}) {
6595: $ownaccess = 1;
1.1040 raeburn 6596: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 6597: unless ($uri =~ m{\.\./}) {
6598: $ownaccess = 1;
6599: }
6600: } elsif (($udom ne 'public') && ($uname ne 'public')) {
6601: my $now = time;
6602: if ($uri =~ m{^([^/]+)/?$}) {
6603: my $adom = $1;
6604: foreach my $key (keys(%env)) {
1.1042 raeburn 6605: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 6606: my ($start,$end) = split('.',$env{$key});
6607: if (($now >= $start) && (!$end || $end < $now)) {
6608: $ownaccess = 1;
6609: last;
6610: }
6611: }
6612: }
6613: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
6614: my $adom = $1;
6615: my $aname = $2;
1.1042 raeburn 6616: foreach my $role ('ca','aa') {
6617: if ($env{"user.role.$role./$adom/$aname"}) {
6618: my ($start,$end) =
6619: split('.',$env{"user.role.$role./$adom/$aname"});
6620: if (($now >= $start) && (!$end || $end < $now)) {
6621: $ownaccess = 1;
6622: last;
6623: }
1.1039 raeburn 6624: }
6625: }
6626: }
6627: }
6628: }
6629: }
6630: }
6631:
1.52 www 6632: # Course
6633:
1.620 albertel 6634: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6635: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6636: $thisallowed.=$1;
6637: }
1.52 www 6638: }
1.29 www 6639:
1.52 www 6640: # Domain
6641:
1.620 albertel 6642: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 6643: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6644: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6645: $thisallowed.=$1;
6646: }
1.12 www 6647: }
1.52 www 6648:
1.1141 raeburn 6649: # User who is not author or co-author might still be able to edit
6650: # resource of an author in the domain (e.g., if Domain Coordinator).
6651: if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
6652: (&allowed('mdc',$env{'request.course.id'}))) {
6653: if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
6654: $thisallowed.=$1;
6655: }
6656: }
6657:
1.52 www 6658: # Course: uri itself is a course
1.66 www 6659: my $courseuri=$uri;
6660: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 6661: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 6662:
1.620 albertel 6663: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 6664: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 6665: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 6666: $thisallowed.=$1;
6667: }
1.12 www 6668: }
1.29 www 6669:
1.665 albertel 6670: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 6671: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 6672: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 6673: $thisallowed='';
1.671 raeburn 6674: my ($match)=&is_on_map($uri);
6675: if ($match) {
6676: if ($env{'user.priv.'.$env{'request.role'}.'./'}
6677: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 6678: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6679: if (@blockers > 0) {
6680: $thisallowed = 'B';
6681: } else {
6682: $thisallowed.=$1;
6683: }
1.671 raeburn 6684: }
6685: } else {
1.705 albertel 6686: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 6687: if ($refuri) {
6688: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 6689: $thisallowed='F';
1.671 raeburn 6690: } else {
6691: $refuri=&declutter($refuri);
6692: my ($match) = &is_on_map($refuri);
6693: if ($match) {
1.1162 raeburn 6694: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6695: if (@blockers > 0) {
6696: $thisallowed = 'B';
6697: } else {
6698: $thisallowed='F';
6699: }
1.671 raeburn 6700: }
1.669 raeburn 6701: }
1.671 raeburn 6702: }
6703: }
1.314 www 6704: }
1.492 albertel 6705:
1.766 albertel 6706: if ($priv eq 'bre'
6707: && $thisallowed ne 'F'
6708: && $thisallowed ne '2'
6709: && &is_portfolio_url($uri)) {
6710: $thisallowed = &portfolio_access($uri);
6711: }
6712:
1.52 www 6713: # Full access at system, domain or course-wide level? Exit.
1.29 www 6714: if ($thisallowed=~/F/) {
6715: return 'F';
6716: }
6717:
1.52 www 6718: # If this is generating or modifying users, exit with special codes
1.29 www 6719:
1.643 www 6720: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
6721: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 6722: my ($audom,$auname)=split('/',$uri);
1.643 www 6723: # no author name given, so this just checks on the general right to make a co-author in this domain
6724: unless ($auname) { return $thisallowed; }
6725: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 6726: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
6727: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
6728: ($audom ne $env{'request.role.domain'}))) { return ''; }
6729: }
1.52 www 6730: return $thisallowed;
6731: }
6732: #
1.103 harris41 6733: # Gathered so far: system, domain and course wide privileges
1.52 www 6734: #
6735: # Course: See if uri or referer is an individual resource that is part of
6736: # the course
6737:
1.620 albertel 6738: if ($env{'request.course.id'}) {
1.232 www 6739:
1.620 albertel 6740: $courseprivid=$env{'request.course.id'};
6741: if ($env{'request.course.sec'}) {
6742: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 6743: }
6744: $courseprivid=~s/\_/\//;
6745: my $checkreferer=1;
1.232 www 6746: my ($match,$cond)=&is_on_map($uri);
6747: if ($match) {
6748: $statecond=$cond;
1.620 albertel 6749: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 6750: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 6751: my $value = $1;
6752: if ($priv eq 'bre') {
6753: my @blockers = &has_comm_blocking($priv,$symb,$uri);
6754: if (@blockers > 0) {
6755: $thisallowed = 'B';
6756: } else {
6757: $thisallowed.=$value;
6758: }
6759: } else {
6760: $thisallowed.=$value;
6761: }
1.52 www 6762: $checkreferer=0;
6763: }
1.29 www 6764: }
1.83 www 6765:
1.148 www 6766: if ($checkreferer) {
1.620 albertel 6767: my $refuri=$env{'httpref.'.$orguri};
1.148 www 6768: unless ($refuri) {
1.800 albertel 6769: foreach my $key (keys(%env)) {
6770: if ($key=~/^httpref\..*\*/) {
6771: my $pattern=$key;
1.156 www 6772: $pattern=~s/^httpref\.\/res\///;
1.148 www 6773: $pattern=~s/\*/\[\^\/\]\+/g;
6774: $pattern=~s/\//\\\//g;
1.152 www 6775: if ($orguri=~/$pattern/) {
1.800 albertel 6776: $refuri=$env{$key};
1.148 www 6777: }
6778: }
1.191 harris41 6779: }
1.148 www 6780: }
1.232 www 6781:
1.148 www 6782: if ($refuri) {
1.152 www 6783: $refuri=&declutter($refuri);
1.232 www 6784: my ($match,$cond)=&is_on_map($refuri);
6785: if ($match) {
6786: my $refstatecond=$cond;
1.620 albertel 6787: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 6788: =~/\Q$priv\E\&([^\:]*)/) {
1.1162 raeburn 6789: my $value = $1;
6790: if ($priv eq 'bre') {
6791: my @blockers = &has_comm_blocking($priv,$symb,$refuri);
6792: if (@blockers > 0) {
6793: $thisallowed = 'B';
6794: } else {
6795: $thisallowed.=$value;
6796: }
6797: } else {
6798: $thisallowed.=$value;
6799: }
1.53 www 6800: $uri=$refuri;
6801: $statecond=$refstatecond;
1.52 www 6802: }
6803: }
1.148 www 6804: }
1.29 www 6805: }
1.52 www 6806: }
1.29 www 6807:
1.52 www 6808: #
1.103 harris41 6809: # Gathered now: all privileges that could apply, and condition number
1.52 www 6810: #
6811: #
6812: # Full or no access?
6813: #
1.29 www 6814:
1.52 www 6815: if ($thisallowed=~/F/) {
6816: return 'F';
6817: }
1.29 www 6818:
1.52 www 6819: unless ($thisallowed) {
6820: return '';
6821: }
1.29 www 6822:
1.52 www 6823: # Restrictions exist, deal with them
6824: #
6825: # C:according to course preferences
6826: # R:according to resource settings
6827: # L:unless locked
6828: # X:according to user session state
6829: #
6830:
6831: # Possibly locked functionality, check all courses
1.54 www 6832: # Locks might take effect only after 10 minutes cache expiration for other
6833: # courses, and 2 minutes for current course
1.52 www 6834:
6835: my $envkey;
6836: if ($thisallowed=~/L/) {
1.1000 raeburn 6837: foreach $envkey (keys(%env)) {
1.54 www 6838: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
6839: my $courseid=$2;
6840: my $roleid=$1.'.'.$2;
1.92 www 6841: $courseid=~s/^\///;
1.54 www 6842: my $expiretime=600;
1.620 albertel 6843: if ($env{'request.role'} eq $roleid) {
1.54 www 6844: $expiretime=120;
6845: }
6846: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
6847: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 6848: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 6849: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 6850: }
1.620 albertel 6851: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
6852: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
6853: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
6854: &log($env{'user.domain'},$env{'user.name'},
6855: $env{'user.home'},
1.57 www 6856: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 6857: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 6858: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 6859: return '';
6860: }
6861: }
1.620 albertel 6862: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
6863: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
6864: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
6865: &log($env{'user.domain'},$env{'user.name'},
6866: $env{'user.home'},
1.57 www 6867: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 6868: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 6869: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 6870: return '';
6871: }
6872: }
6873: }
1.29 www 6874: }
1.52 www 6875: }
6876:
6877: #
6878: # Rest of the restrictions depend on selected course
6879: #
6880:
1.620 albertel 6881: unless ($env{'request.course.id'}) {
1.766 albertel 6882: if ($thisallowed eq 'A') {
6883: return 'A';
1.814 raeburn 6884: } elsif ($thisallowed eq 'B') {
6885: return 'B';
1.766 albertel 6886: } else {
6887: return '1';
6888: }
1.52 www 6889: }
1.29 www 6890:
1.52 www 6891: #
6892: # Now user is definitely in a course
6893: #
1.53 www 6894:
6895:
6896: # Course preferences
6897:
6898: if ($thisallowed=~/C/) {
1.620 albertel 6899: my $rolecode=(split(/\./,$env{'request.role'}))[0];
6900: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
6901: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 6902: =~/\Q$rolecode\E/) {
1.1103 raeburn 6903: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 6904: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6905: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
6906: $env{'request.course.id'});
6907: }
1.237 www 6908: return '';
6909: }
6910:
1.620 albertel 6911: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 6912: =~/\Q$unamedom\E/) {
1.1103 raeburn 6913: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 6914: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
6915: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
6916: $env{'request.course.id'});
6917: }
1.54 www 6918: return '';
6919: }
1.53 www 6920: }
6921:
6922: # Resource preferences
6923:
6924: if ($thisallowed=~/R/) {
1.620 albertel 6925: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 6926: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.1103 raeburn 6927: if (($priv ne 'pch') && ($priv ne 'plc')) {
1.689 albertel 6928: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
6929: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
6930: }
6931: return '';
1.54 www 6932: }
1.53 www 6933: }
1.30 www 6934:
1.246 www 6935: # Restricted by state or randomout?
1.30 www 6936:
1.52 www 6937: if ($thisallowed=~/X/) {
1.620 albertel 6938: if ($env{'acc.randomout'}) {
1.579 albertel 6939: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 6940: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 6941: return '';
6942: }
1.247 www 6943: }
6944: if (&condval($statecond)) {
1.52 www 6945: return '2';
6946: } else {
6947: return '';
6948: }
6949: }
1.30 www 6950:
1.766 albertel 6951: if ($thisallowed eq 'A') {
6952: return 'A';
1.814 raeburn 6953: } elsif ($thisallowed eq 'B') {
6954: return 'B';
1.766 albertel 6955: }
1.52 www 6956: return 'F';
1.232 www 6957: }
1.1162 raeburn 6958:
1.1192 raeburn 6959: # ------------------------------------------- Check construction space access
6960:
6961: sub constructaccess {
6962: my ($url,$setpriv)=@_;
6963:
6964: # We do not allow editing of previous versions of files
6965: if ($url=~/\.(\d+)\.(\w+)$/) { return ''; }
6966:
6967: # Get username and domain from URL
6968: my ($ownername,$ownerdomain,$ownerhome);
6969:
6970: ($ownerdomain,$ownername) =
6971: ($url=~ m{^(?:\Q$perlvar{'lonDocRoot'}\E|)/priv/($match_domain)/($match_username)/});
6972:
6973: # The URL does not really point to any authorspace, forget it
6974: unless (($ownername) && ($ownerdomain)) { return ''; }
6975:
6976: # Now we need to see if the user has access to the authorspace of
6977: # $ownername at $ownerdomain
6978:
6979: if (($ownername eq $env{'user.name'}) && ($ownerdomain eq $env{'user.domain'})) {
6980: # Real author for this?
6981: $ownerhome = $env{'user.home'};
6982: if (exists($env{'user.priv.au./'.$ownerdomain.'/./'})) {
6983: return ($ownername,$ownerdomain,$ownerhome);
6984: }
6985: } else {
6986: # Co-author for this?
6987: if (exists($env{'user.priv.ca./'.$ownerdomain.'/'.$ownername.'./'}) ||
6988: exists($env{'user.priv.aa./'.$ownerdomain.'/'.$ownername.'./'}) ) {
6989: $ownerhome = &homeserver($ownername,$ownerdomain);
6990: return ($ownername,$ownerdomain,$ownerhome);
6991: }
6992: }
6993:
6994: # We don't have any access right now. If we are not possibly going to do anything about this,
6995: # we might as well leave
6996: unless ($setpriv) { return ''; }
6997:
6998: # Backdoor access?
6999: my $allowed=&allowed('eco',$ownerdomain);
7000: # Nope
7001: unless ($allowed) { return ''; }
7002: # Looks like we may have access, but could be locked by the owner of the construction space
7003: if ($allowed eq 'U') {
7004: my %blocked=&get('environment',['domcoord.author'],
7005: $ownerdomain,$ownername);
7006: # Is blocked by owner
7007: if ($blocked{'domcoord.author'} eq 'blocked') { return ''; }
7008: }
7009: if (($allowed eq 'F') || ($allowed eq 'U')) {
7010: # Grant temporary access
7011: my $then=$env{'user.login.time'};
1.1209 raeburn 7012: my $update=$env{'user.update.time'};
1.1192 raeburn 7013: if (!$update) { $update = $then; }
7014: my $refresh=$env{'user.refresh.time'};
7015: if (!$refresh) { $refresh = $update; }
7016: my $now = time;
7017: &check_adhoc_privs($ownerdomain,$ownername,$update,$refresh,
7018: $now,'ca','constructaccess');
7019: $ownerhome = &homeserver($ownername,$ownerdomain);
7020: return($ownername,$ownerdomain,$ownerhome);
7021: }
7022: # No business here
7023: return '';
7024: }
7025:
1.1162 raeburn 7026: sub get_comm_blocks {
7027: my ($cdom,$cnum) = @_;
7028: if ($cdom eq '' || $cnum eq '') {
7029: return unless ($env{'request.course.id'});
7030: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
7031: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
7032: }
7033: my %commblocks;
7034: my $hashid=$cdom.'_'.$cnum;
7035: my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
7036: if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
7037: %commblocks = %{$blocksref};
7038: } else {
7039: %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
7040: my $cachetime = 600;
7041: &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
7042: }
7043: return %commblocks;
7044: }
7045:
7046: sub has_comm_blocking {
7047: my ($priv,$symb,$uri,$blocks) = @_;
7048: return unless ($env{'request.course.id'});
7049: return unless ($priv eq 'bre');
7050: return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
7051: my %commblocks;
7052: if (ref($blocks) eq 'HASH') {
7053: %commblocks = %{$blocks};
7054: } else {
7055: %commblocks = &get_comm_blocks();
7056: }
7057: return unless (keys(%commblocks) > 0);
7058: if (!$symb) { $symb=&symbread($uri,1); }
7059: my ($map,$resid,undef)=&decode_symb($symb);
7060: my %tocheck = (
7061: maps => $map,
7062: resources => $symb,
7063: );
7064: my @blockers;
7065: my $now = time;
1.1163 raeburn 7066: my $navmap = Apache::lonnavmaps::navmap->new();
1.1162 raeburn 7067: foreach my $block (keys(%commblocks)) {
7068: if ($block =~ /^(\d+)____(\d+)$/) {
7069: my ($start,$end) = ($1,$2);
7070: if ($start <= $now && $end >= $now) {
7071: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7072: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7073: if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
7074: if ($commblocks{$block}{'blocks'}{'docs'}{'maps'}{$map}) {
7075: unless (grep(/^\Q$block\E$/,@blockers)) {
7076: push(@blockers,$block);
7077: }
7078: }
7079: }
7080: if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
7081: if ($commblocks{$block}{'blocks'}{'docs'}{'resources'}{$symb}) {
7082: unless (grep(/^\Q$block\E$/,@blockers)) {
7083: push(@blockers,$block);
7084: }
7085: }
7086: }
7087: }
7088: }
7089: }
7090: } elsif ($block =~ /^firstaccess____(.+)$/) {
7091: my $item = $1;
1.1163 raeburn 7092: my @to_test;
1.1162 raeburn 7093: if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
7094: if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
7095: my $check_interval;
7096: if (&check_docs_block($commblocks{$block}{'blocks'}{'docs'},\%tocheck)) {
7097: my @interval;
7098: my $type = 'map';
7099: if ($item eq 'course') {
7100: $type = 'course';
7101: @interval=&EXT("resource.0.interval");
7102: } else {
7103: if ($item =~ /___\d+___/) {
7104: $type = 'resource';
7105: @interval=&EXT("resource.0.interval",$item);
1.1163 raeburn 7106: if (ref($navmap)) {
7107: my $res = $navmap->getBySymb($item);
7108: push(@to_test,$res);
7109: }
1.1162 raeburn 7110: } else {
7111: my $mapsymb = &symbread($item,1);
7112: if ($mapsymb) {
7113: if (ref($navmap)) {
7114: my $mapres = $navmap->getBySymb($mapsymb);
1.1163 raeburn 7115: @to_test = $mapres->retrieveResources($mapres,undef,0,1);
7116: foreach my $res (@to_test) {
1.1162 raeburn 7117: my $symb = $res->symb();
7118: next if ($symb eq $mapsymb);
7119: if ($symb ne '') {
7120: @interval=&EXT("resource.0.interval",$symb);
7121: last;
7122: }
7123: }
7124: }
7125: }
7126: }
7127: }
7128: if ($interval[0] =~ /\d+/) {
7129: my $first_access;
7130: if ($type eq 'resource') {
7131: $first_access=&get_first_access($interval[1],$item);
7132: } elsif ($type eq 'map') {
7133: $first_access=&get_first_access($interval[1],undef,$item);
7134: } else {
7135: $first_access=&get_first_access($interval[1]);
7136: }
7137: if ($first_access) {
7138: my $timesup = $first_access+$interval[0];
7139: if ($timesup > $now) {
1.1163 raeburn 7140: foreach my $res (@to_test) {
7141: if ($res->is_problem()) {
7142: if ($res->completable()) {
7143: unless (grep(/^\Q$block\E$/,@blockers)) {
7144: push(@blockers,$block);
7145: }
7146: last;
7147: }
7148: }
1.1162 raeburn 7149: }
7150: }
7151: }
7152: }
7153: }
7154: }
7155: }
7156: }
7157: }
7158: return @blockers;
7159: }
7160:
7161: sub check_docs_block {
7162: my ($docsblock,$tocheck) =@_;
7163: if ((ref($docsblock) ne 'HASH') || (ref($tocheck) ne 'HASH')) {
7164: return;
7165: }
7166: if (ref($docsblock->{'maps'}) eq 'HASH') {
7167: if ($tocheck->{'maps'}) {
7168: if ($docsblock->{'maps'}{$tocheck->{'maps'}}) {
7169: return 1;
7170: }
7171: }
7172: }
7173: if (ref($docsblock->{'resources'}) eq 'HASH') {
7174: if ($tocheck->{'resources'}) {
7175: if ($docsblock->{'resources'}{$tocheck->{'resources'}}) {
7176: return 1;
7177: }
7178: }
7179: }
7180: return;
7181: }
7182:
1.1133 foxr 7183: #
7184: # Removes the versino from a URI and
7185: # splits it in to its filename and path to the filename.
7186: # Seems like File::Basename could have done this more clearly.
7187: # Parameters:
7188: # $uri - input URI
7189: # Returns:
7190: # Two element list consisting of
7191: # $pathname - the URI up to and excluding the trailing /
7192: # $filename - The part of the URI following the last /
7193: # NOTE:
7194: # Another realization of this is simply:
7195: # use File::Basename;
7196: # ...
7197: # $uri = shift;
7198: # $filename = basename($uri);
7199: # $path = dirname($uri);
7200: # return ($filename, $path);
7201: #
7202: # The implementation below is probably faster however.
7203: #
1.710 albertel 7204: sub split_uri_for_cond {
7205: my $uri=&deversion(&declutter(shift));
7206: my @uriparts=split(/\//,$uri);
7207: my $filename=pop(@uriparts);
7208: my $pathname=join('/',@uriparts);
7209: return ($pathname,$filename);
7210: }
1.232 www 7211: # --------------------------------------------------- Is a resource on the map?
7212:
7213: sub is_on_map {
1.710 albertel 7214: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 7215: #Trying to find the conditional for the file
1.620 albertel 7216: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 7217: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 7218: if ($match) {
1.289 bowersj2 7219: return (1,$1);
7220: } else {
1.434 www 7221: return (0,0);
1.289 bowersj2 7222: }
1.12 www 7223: }
7224:
1.427 www 7225: # --------------------------------------------------------- Get symb from alias
7226:
7227: sub get_symb_from_alias {
7228: my $symb=shift;
7229: my ($map,$resid,$url)=&decode_symb($symb);
7230: # Already is a symb
7231: if ($url) { return $symb; }
7232: # Must be an alias
7233: my $aliassymb='';
7234: my %bighash;
1.620 albertel 7235: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 7236: &GDBM_READER(),0640)) {
7237: my $rid=$bighash{'mapalias_'.$symb};
7238: if ($rid) {
7239: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 7240: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
7241: $resid,$bighash{'src_'.$rid});
1.427 www 7242: }
7243: untie %bighash;
7244: }
7245: return $aliassymb;
7246: }
7247:
1.12 www 7248: # ----------------------------------------------------------------- Define Role
7249:
7250: sub definerole {
7251: if (allowed('mcr','/')) {
7252: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 7253: foreach my $role (split(':',$sysrole)) {
7254: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7255: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
7256: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
7257: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7258: return "refused:s:$crole&$cqual";
7259: }
7260: }
1.191 harris41 7261: }
1.800 albertel 7262: foreach my $role (split(':',$domrole)) {
7263: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7264: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
7265: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
7266: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 7267: return "refused:d:$crole&$cqual";
7268: }
7269: }
1.191 harris41 7270: }
1.800 albertel 7271: foreach my $role (split(':',$courole)) {
7272: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 7273: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
7274: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
7275: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 7276: return "refused:c:$crole&$cqual";
7277: }
7278: }
1.191 harris41 7279: }
1.620 albertel 7280: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
7281: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 7282: "rolesdef_$rolename=".
7283: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 7284: return reply($command,$env{'user.home'});
1.12 www 7285: } else {
7286: return 'refused';
7287: }
1.105 harris41 7288: }
7289:
7290: # ---------------- Make a metadata query against the network of library servers
7291:
7292: sub metadata_query {
1.244 matthew 7293: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 7294: my %rhash;
1.845 albertel 7295: my %libserv = &all_library();
1.244 matthew 7296: my @server_list = (defined($server_array) ? @$server_array
7297: : keys(%libserv) );
7298: for my $server (@server_list) {
1.118 harris41 7299: unless ($custom or $customshow) {
7300: my $reply=&reply("querysend:".&escape($query),$server);
7301: $rhash{$server}=$reply;
7302: }
7303: else {
7304: my $reply=&reply("querysend:".&escape($query).':'.
7305: &escape($custom).':'.&escape($customshow),
7306: $server);
7307: $rhash{$server}=$reply;
7308: }
1.112 harris41 7309: }
1.118 harris41 7310: return \%rhash;
1.240 www 7311: }
7312:
7313: # ----------------------------------------- Send log queries and wait for reply
7314:
7315: sub log_query {
7316: my ($uname,$udom,$query,%filters)=@_;
7317: my $uhome=&homeserver($uname,$udom);
7318: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 7319: my $uhost=&hostname($uhome);
1.800 albertel 7320: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 7321: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
7322: $uhome);
1.479 albertel 7323: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 7324: return get_query_reply($queryid);
7325: }
7326:
1.818 raeburn 7327: # -------------------------- Update MySQL table for portfolio file
7328:
7329: sub update_portfolio_table {
1.821 raeburn 7330: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 7331: if ($group ne '') {
7332: $file_name =~s /^\Q$group\E//;
7333: }
1.818 raeburn 7334: my $homeserver = &homeserver($uname,$udom);
7335: my $queryid=
1.821 raeburn 7336: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
7337: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 7338: my $reply = &get_query_reply($queryid);
7339: return $reply;
7340: }
7341:
1.899 raeburn 7342: # -------------------------- Update MySQL allusers table
7343:
7344: sub update_allusers_table {
7345: my ($uname,$udom,$names) = @_;
7346: my $homeserver = &homeserver($uname,$udom);
7347: my $queryid=
7348: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
7349: 'lastname='.&escape($names->{'lastname'}).'%%'.
7350: 'firstname='.&escape($names->{'firstname'}).'%%'.
7351: 'middlename='.&escape($names->{'middlename'}).'%%'.
7352: 'generation='.&escape($names->{'generation'}).'%%'.
7353: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
7354: 'id='.&escape($names->{'id'}),$homeserver);
1.1075 raeburn 7355: return;
1.899 raeburn 7356: }
7357:
1.508 raeburn 7358: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 7359:
7360: sub fetch_enrollment_query {
1.511 raeburn 7361: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 7362: my $homeserver;
1.547 raeburn 7363: my $maxtries = 1;
1.508 raeburn 7364: if ($context eq 'automated') {
7365: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 7366: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 7367: } else {
7368: $homeserver = &homeserver($cnum,$dom);
7369: }
1.838 albertel 7370: my $host=&hostname($homeserver);
1.506 raeburn 7371: my $cmd = '';
1.1000 raeburn 7372: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 7373: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 7374: }
7375: $cmd =~ s/%%$//;
7376: $cmd = &escape($cmd);
7377: my $query = 'fetchenrollment';
1.620 albertel 7378: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 7379: unless ($queryid=~/^\Q$host\E\_/) {
7380: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
7381: return 'error: '.$queryid;
7382: }
1.506 raeburn 7383: my $reply = &get_query_reply($queryid);
1.547 raeburn 7384: my $tries = 1;
7385: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7386: $reply = &get_query_reply($queryid);
7387: $tries ++;
7388: }
1.526 raeburn 7389: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 7390: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 7391: } else {
1.901 albertel 7392: my @responses = split(/:/,$reply);
1.515 raeburn 7393: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 7394: foreach my $line (@responses) {
7395: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 7396: $$replyref{$key} = $value;
7397: }
7398: } else {
1.1117 foxr 7399: my $pathname = LONCAPA::tempdir();
1.800 albertel 7400: foreach my $line (@responses) {
7401: my ($key,$value) = split(/=/,$line);
1.506 raeburn 7402: $$replyref{$key} = $value;
7403: if ($value > 0) {
1.800 albertel 7404: foreach my $item (@{$$affiliatesref{$key}}) {
7405: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 7406: my $destname = $pathname.'/'.$filename;
7407: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 7408: if ($xml_classlist =~ /^error/) {
7409: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
7410: } else {
1.506 raeburn 7411: if ( open(FILE,">$destname") ) {
7412: print FILE &unescape($xml_classlist);
7413: close(FILE);
1.526 raeburn 7414: } else {
7415: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 7416: }
7417: }
7418: }
7419: }
7420: }
7421: }
7422: return 'ok';
7423: }
7424: return 'error';
7425: }
7426:
1.242 www 7427: sub get_query_reply {
7428: my $queryid=shift;
1.1117 foxr 7429: my $replyfile=LONCAPA::tempdir().$queryid;
1.240 www 7430: my $reply='';
7431: for (1..100) {
7432: sleep 2;
7433: if (-e $replyfile.'.end') {
1.448 albertel 7434: if (open(my $fh,$replyfile)) {
1.904 albertel 7435: $reply = join('',<$fh>);
7436: close($fh);
1.240 www 7437: } else { return 'error: reply_file_error'; }
1.242 www 7438: return &unescape($reply);
7439: }
1.240 www 7440: }
1.242 www 7441: return 'timeout:'.$queryid;
1.240 www 7442: }
7443:
7444: sub courselog_query {
1.241 www 7445: #
7446: # possible filters:
7447: # url: url or symb
7448: # username
7449: # domain
7450: # action: view, submit, grade
7451: # start: timestamp
7452: # end: timestamp
7453: #
1.240 www 7454: my (%filters)=@_;
1.620 albertel 7455: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 7456: if ($filters{'url'}) {
7457: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
7458: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
7459: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
7460: }
1.620 albertel 7461: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
7462: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 7463: return &log_query($cname,$cdom,'courselog',%filters);
7464: }
7465:
7466: sub userlog_query {
1.858 raeburn 7467: #
7468: # possible filters:
7469: # action: log check role
7470: # start: timestamp
7471: # end: timestamp
7472: #
1.240 www 7473: my ($uname,$udom,%filters)=@_;
7474: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 7475: }
7476:
1.506 raeburn 7477: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
7478:
7479: sub auto_run {
1.508 raeburn 7480: my ($cnum,$cdom) = @_;
1.876 raeburn 7481: my $response = 0;
7482: my $settings;
7483: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
7484: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
7485: $settings = $domconfig{'autoenroll'};
7486: if ($settings->{'run'} eq '1') {
7487: $response = 1;
7488: }
7489: } else {
1.934 raeburn 7490: my $homeserver;
7491: if (&is_course($cdom,$cnum)) {
7492: $homeserver = &homeserver($cnum,$cdom);
7493: } else {
7494: $homeserver = &domain($cdom,'primary');
7495: }
7496: if ($homeserver ne 'no_host') {
7497: $response = &reply('autorun:'.$cdom,$homeserver);
7498: }
1.876 raeburn 7499: }
1.506 raeburn 7500: return $response;
7501: }
1.776 albertel 7502:
1.506 raeburn 7503: sub auto_get_sections {
1.508 raeburn 7504: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 7505: my $homeserver;
7506: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7507: $homeserver = &homeserver($cnum,$cdom);
7508: }
7509: if (!defined($homeserver)) {
7510: if ($cdom =~ /^$match_domain$/) {
7511: $homeserver = &domain($cdom,'primary');
7512: }
7513: }
7514: my @secs;
7515: if (defined($homeserver)) {
7516: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
7517: unless ($response eq 'refused') {
7518: @secs = split(/:/,$response);
7519: }
1.506 raeburn 7520: }
7521: return @secs;
7522: }
1.776 albertel 7523:
1.506 raeburn 7524: sub auto_new_course {
1.1099 raeburn 7525: my ($cnum,$cdom,$inst_course_id,$owner,$coowners) = @_;
1.508 raeburn 7526: my $homeserver = &homeserver($cnum,$cdom);
1.1099 raeburn 7527: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.&escape($owner).':'.$cdom.':'.&escape($coowners),$homeserver));
1.506 raeburn 7528: return $response;
7529: }
1.776 albertel 7530:
1.506 raeburn 7531: sub auto_validate_courseID {
1.508 raeburn 7532: my ($cnum,$cdom,$inst_course_id) = @_;
7533: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 7534: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 7535: return $response;
7536: }
1.776 albertel 7537:
1.1007 raeburn 7538: sub auto_validate_instcode {
1.1020 raeburn 7539: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 7540: my ($homeserver,$response);
7541: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7542: $homeserver = &homeserver($cnum,$cdom);
7543: }
7544: if (!defined($homeserver)) {
7545: if ($cdom =~ /^$match_domain$/) {
7546: $homeserver = &domain($cdom,'primary');
7547: }
7548: }
1.1065 raeburn 7549: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
7550: &escape($instcode).':'.&escape($owner),$homeserver));
1.1216 raeburn 7551: my ($outcome,$description,$defaultcredits) = map { &unescape($_); } split('&',$response,3);
7552: return ($outcome,$description,$defaultcredits);
1.1007 raeburn 7553: }
7554:
1.506 raeburn 7555: sub auto_create_password {
1.873 raeburn 7556: my ($cnum,$cdom,$authparam,$udom) = @_;
7557: my ($homeserver,$response);
1.506 raeburn 7558: my $create_passwd = 0;
7559: my $authchk = '';
1.873 raeburn 7560: if ($udom =~ /^$match_domain$/) {
7561: $homeserver = &domain($udom,'primary');
7562: }
7563: if ($homeserver eq '') {
7564: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
7565: $homeserver = &homeserver($cnum,$cdom);
7566: }
7567: }
7568: if ($homeserver eq '') {
7569: $authchk = 'nodomain';
1.506 raeburn 7570: } else {
1.873 raeburn 7571: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
7572: if ($response eq 'refused') {
7573: $authchk = 'refused';
7574: } else {
1.901 albertel 7575: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 7576: }
1.506 raeburn 7577: }
7578: return ($authparam,$create_passwd,$authchk);
7579: }
7580:
1.706 raeburn 7581: sub auto_photo_permission {
7582: my ($cnum,$cdom,$students) = @_;
7583: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 7584: my ($outcome,$perm_reqd,$conditions) =
7585: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 7586: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7587: return (undef,undef);
7588: }
1.706 raeburn 7589: return ($outcome,$perm_reqd,$conditions);
7590: }
7591:
7592: sub auto_checkphotos {
7593: my ($uname,$udom,$pid) = @_;
7594: my $homeserver = &homeserver($uname,$udom);
7595: my ($result,$resulttype);
7596: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 7597: &escape($uname).':'.&escape($pid),
7598: $homeserver));
1.709 albertel 7599: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7600: return (undef,undef);
7601: }
1.706 raeburn 7602: if ($outcome) {
7603: ($result,$resulttype) = split(/:/,$outcome);
7604: }
7605: return ($result,$resulttype);
7606: }
7607:
7608: sub auto_photochoice {
7609: my ($cnum,$cdom) = @_;
7610: my $homeserver = &homeserver($cnum,$cdom);
7611: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 7612: &escape($cdom),
7613: $homeserver)));
1.709 albertel 7614: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
7615: return (undef,undef);
7616: }
1.706 raeburn 7617: return ($update,$comment);
7618: }
7619:
7620: sub auto_photoupdate {
7621: my ($affiliatesref,$dom,$cnum,$photo) = @_;
7622: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 7623: my $host=&hostname($homeserver);
1.706 raeburn 7624: my $cmd = '';
7625: my $maxtries = 1;
1.800 albertel 7626: foreach my $affiliate (keys(%{$affiliatesref})) {
7627: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 7628: }
7629: $cmd =~ s/%%$//;
7630: $cmd = &escape($cmd);
7631: my $query = 'institutionalphotos';
7632: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
7633: unless ($queryid=~/^\Q$host\E\_/) {
7634: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
7635: return 'error: '.$queryid;
7636: }
7637: my $reply = &get_query_reply($queryid);
7638: my $tries = 1;
7639: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
7640: $reply = &get_query_reply($queryid);
7641: $tries ++;
7642: }
7643: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
7644: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
7645: } else {
7646: my @responses = split(/:/,$reply);
7647: my $outcome = shift(@responses);
7648: foreach my $item (@responses) {
7649: my ($key,$value) = split(/=/,$item);
7650: $$photo{$key} = $value;
7651: }
7652: return $outcome;
7653: }
7654: return 'error';
7655: }
7656:
1.521 raeburn 7657: sub auto_instcode_format {
1.793 albertel 7658: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
7659: $cat_order) = @_;
1.521 raeburn 7660: my $courses = '';
1.772 raeburn 7661: my @homeservers;
1.521 raeburn 7662: if ($caller eq 'global') {
1.841 albertel 7663: my %servers = &get_servers($codedom,'library');
7664: foreach my $tryserver (keys(%servers)) {
7665: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7666: push(@homeservers,$tryserver);
7667: }
1.584 raeburn 7668: }
1.1022 raeburn 7669: } elsif ($caller eq 'requests') {
7670: if ($codedom =~ /^$match_domain$/) {
7671: my $chome = &domain($codedom,'primary');
7672: unless ($chome eq 'no_host') {
7673: push(@homeservers,$chome);
7674: }
7675: }
1.521 raeburn 7676: } else {
1.772 raeburn 7677: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 7678: }
1.793 albertel 7679: foreach my $code (keys(%{$instcodes})) {
7680: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 7681: }
7682: chop($courses);
1.772 raeburn 7683: my $ok_response = 0;
7684: my $response;
7685: while (@homeservers > 0 && $ok_response == 0) {
7686: my $server = shift(@homeservers);
7687: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
7688: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
7689: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 7690: split(/:/,$response);
1.772 raeburn 7691: %{$codes} = (%{$codes},&str2hash($codes_str));
7692: push(@{$codetitles},&str2array($codetitles_str));
7693: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
7694: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
7695: $ok_response = 1;
7696: }
7697: }
7698: if ($ok_response) {
1.521 raeburn 7699: return 'ok';
1.772 raeburn 7700: } else {
7701: return $response;
1.521 raeburn 7702: }
7703: }
7704:
1.792 raeburn 7705: sub auto_instcode_defaults {
7706: my ($domain,$returnhash,$code_order) = @_;
7707: my @homeservers;
1.841 albertel 7708:
7709: my %servers = &get_servers($domain,'library');
7710: foreach my $tryserver (keys(%servers)) {
7711: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7712: push(@homeservers,$tryserver);
7713: }
1.792 raeburn 7714: }
1.841 albertel 7715:
1.792 raeburn 7716: my $response;
1.841 albertel 7717: foreach my $server (@homeservers) {
1.792 raeburn 7718: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 7719: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
7720:
7721: foreach my $pair (split(/\&/,$response)) {
7722: my ($name,$value)=split(/\=/,$pair);
7723: if ($name eq 'code_order') {
7724: @{$code_order} = split(/\&/,&unescape($value));
7725: } else {
7726: $returnhash->{&unescape($name)}=&unescape($value);
7727: }
7728: }
7729: return 'ok';
1.792 raeburn 7730: }
1.841 albertel 7731:
7732: return $response;
1.1003 raeburn 7733: }
7734:
7735: sub auto_possible_instcodes {
1.1007 raeburn 7736: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
7737: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
7738: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
7739: return;
7740: }
1.1003 raeburn 7741: my (@homeservers,$uhome);
7742: if (defined(&domain($domain,'primary'))) {
7743: $uhome=&domain($domain,'primary');
7744: push(@homeservers,&domain($domain,'primary'));
7745: } else {
7746: my %servers = &get_servers($domain,'library');
7747: foreach my $tryserver (keys(%servers)) {
7748: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
7749: push(@homeservers,$tryserver);
7750: }
7751: }
7752: }
7753: my $response;
7754: foreach my $server (@homeservers) {
7755: $response=&reply('autopossibleinstcodes:'.$domain,$server);
7756: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 7757: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
7758: split(':',$response);
7759: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
7760: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 7761: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 7762: my ($name,$value)=split('=',$item);
7763: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 7764: }
7765: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 7766: my ($name,$value)=split('=',$item);
7767: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 7768: }
7769: return 'ok';
7770: }
7771: return $response;
7772: }
1.792 raeburn 7773:
1.1010 raeburn 7774: sub auto_courserequest_checks {
7775: my ($dom) = @_;
1.1020 raeburn 7776: my ($homeserver,%validations);
7777: if ($dom =~ /^$match_domain$/) {
7778: $homeserver = &domain($dom,'primary');
7779: }
7780: unless ($homeserver eq 'no_host') {
7781: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
7782: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
7783: my @items = split(/&/,$response);
7784: foreach my $item (@items) {
7785: my ($key,$value) = split('=',$item);
7786: $validations{&unescape($key)} = &thaw_unescape($value);
7787: }
7788: }
7789: }
1.1010 raeburn 7790: return %validations;
7791: }
7792:
1.1020 raeburn 7793: sub auto_courserequest_validation {
7794: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
7795: my ($homeserver,$response);
7796: if ($dom =~ /^$match_domain$/) {
7797: $homeserver = &domain($dom,'primary');
7798: }
7799: unless ($homeserver eq 'no_host') {
1.1021 raeburn 7800:
1.1020 raeburn 7801: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 7802: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 7803: ':'.&escape($instcode).':'.&escape($instseclist),
7804: $homeserver));
7805: }
7806: return $response;
7807: }
7808:
1.777 albertel 7809: sub auto_validate_class_sec {
1.918 raeburn 7810: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 7811: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 7812: my $ownerlist;
7813: if (ref($owners) eq 'ARRAY') {
7814: $ownerlist = join(',',@{$owners});
7815: } else {
7816: $ownerlist = $owners;
7817: }
1.773 raeburn 7818: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 7819: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 7820: return $response;
7821: }
7822:
1.679 raeburn 7823: # ------------------------------------------------------- Course Group routines
7824:
7825: sub get_coursegroups {
1.809 raeburn 7826: my ($cdom,$cnum,$group,$namespace) = @_;
7827: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 7828: }
7829:
1.679 raeburn 7830: sub modify_coursegroup {
7831: my ($cdom,$cnum,$groupsettings) = @_;
7832: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
7833: }
7834:
1.809 raeburn 7835: sub toggle_coursegroup_status {
7836: my ($cdom,$cnum,$group,$action) = @_;
7837: my ($from_namespace,$to_namespace);
7838: if ($action eq 'delete') {
7839: $from_namespace = 'coursegroups';
7840: $to_namespace = 'deleted_groups';
7841: } else {
7842: $from_namespace = 'deleted_groups';
7843: $to_namespace = 'coursegroups';
7844: }
7845: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 7846: if (my $tmp = &error(%curr_group)) {
7847: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
7848: return ('read error',$tmp);
7849: } else {
7850: my %savedsettings = %curr_group;
1.809 raeburn 7851: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 7852: my $deloutcome;
7853: if ($result eq 'ok') {
1.809 raeburn 7854: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 7855: } else {
7856: return ('write error',$result);
7857: }
7858: if ($deloutcome eq 'ok') {
7859: return 'ok';
7860: } else {
7861: return ('delete error',$deloutcome);
7862: }
7863: }
7864: }
7865:
1.679 raeburn 7866: sub modify_group_roles {
1.957 raeburn 7867: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 7868: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
7869: my $role = 'gr/'.&escape($userprivs);
7870: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 7871: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 7872: if ($result eq 'ok') {
7873: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
7874: }
1.679 raeburn 7875: return $result;
7876: }
7877:
7878: sub modify_coursegroup_membership {
7879: my ($cdom,$cnum,$membership) = @_;
7880: my $result = &put('groupmembership',$membership,$cdom,$cnum);
7881: return $result;
7882: }
7883:
1.682 raeburn 7884: sub get_active_groups {
7885: my ($udom,$uname,$cdom,$cnum) = @_;
7886: my $now = time;
7887: my %groups = ();
7888: foreach my $key (keys(%env)) {
1.811 albertel 7889: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 7890: my ($start,$end) = split(/\./,$env{$key});
7891: if (($end!=0) && ($end<$now)) { next; }
7892: if (($start!=0) && ($start>$now)) { next; }
7893: if ($1 eq $cdom && $2 eq $cnum) {
7894: $groups{$3} = $env{$key} ;
7895: }
7896: }
7897: }
7898: return %groups;
7899: }
7900:
1.683 raeburn 7901: sub get_group_membership {
7902: my ($cdom,$cnum,$group) = @_;
7903: return(&dump('groupmembership',$cdom,$cnum,$group));
7904: }
7905:
7906: sub get_users_groups {
7907: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 7908: my @usersgroups;
1.683 raeburn 7909: my $cachetime=1800;
7910:
7911: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 7912: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
7913: if (defined($cached)) {
1.734 albertel 7914: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 7915: } else {
7916: $grouplist = '';
1.816 raeburn 7917: my $courseurl = &courseid_to_courseurl($courseid);
1.1166 raeburn 7918: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 7919: my $access_end = $env{'course.'.$courseid.
7920: '.default_enrollment_end_date'};
7921: my $now = time;
7922: foreach my $key (keys(%roleshash)) {
7923: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
7924: my $group = $1;
7925: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
7926: my $start = $2;
7927: my $end = $1;
7928: if ($start == -1) { next; } # deleted from group
7929: if (($start!=0) && ($start>$now)) { next; }
7930: if (($end!=0) && ($end<$now)) {
7931: if ($access_end && $access_end < $now) {
7932: if ($access_end - $end < 86400) {
7933: push(@usersgroups,$group);
1.733 raeburn 7934: }
7935: }
1.817 raeburn 7936: next;
1.733 raeburn 7937: }
1.817 raeburn 7938: push(@usersgroups,$group);
1.683 raeburn 7939: }
7940: }
7941: }
1.817 raeburn 7942: @usersgroups = &sort_course_groups($courseid,@usersgroups);
7943: $grouplist = join(':',@usersgroups);
7944: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 7945: }
1.733 raeburn 7946: return @usersgroups;
1.683 raeburn 7947: }
7948:
7949: sub devalidate_getgroups_cache {
7950: my ($udom,$uname,$cdom,$cnum)=@_;
7951: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 7952:
1.683 raeburn 7953: my $hashid="$udom:$uname:$courseid";
7954: &devalidate_cache_new('getgroups',$hashid);
7955: }
7956:
1.12 www 7957: # ------------------------------------------------------------------ Plain Text
7958:
7959: sub plaintext {
1.988 raeburn 7960: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 7961: if ($short =~ m{^cr/}) {
1.758 albertel 7962: return (split('/',$short))[-1];
7963: }
1.742 raeburn 7964: if (!defined($cid)) {
7965: $cid = $env{'request.course.id'};
7966: }
7967: my %rolenames = (
1.1008 raeburn 7968: Course => 'std',
7969: Community => 'alt1',
1.742 raeburn 7970: );
1.1037 raeburn 7971: if ($cid ne '') {
7972: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
7973: unless ($forcedefault) {
7974: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
7975: &Apache::lonlocal::mt_escape(\$roletext);
7976: return &Apache::lonlocal::mt($roletext);
7977: }
7978: }
7979: }
7980: if ((defined($type)) && (defined($rolenames{$type})) &&
7981: (defined($rolenames{$type})) &&
7982: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 7983: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 7984: } elsif ($cid ne '') {
7985: my $crstype = $env{'course.'.$cid.'.type'};
7986: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
7987: (defined($prp{$short}{$rolenames{$crstype}}))) {
7988: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
7989: }
1.742 raeburn 7990: }
1.1037 raeburn 7991: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 7992: }
7993:
7994: # ----------------------------------------------------------------- Assign Role
7995:
7996: sub assignrole {
1.957 raeburn 7997: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
7998: $context)=@_;
1.21 www 7999: my $mrole;
8000: if ($role =~ /^cr\//) {
1.393 www 8001: my $cwosec=$url;
1.811 albertel 8002: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 8003: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 8004: my $refused = 1;
8005: if ($context eq 'requestcourses') {
8006: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
8007: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
8008: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
8009: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8010: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8011: if ($crsenv{'internal.courseowner'} eq
8012: $env{'user.name'}.':'.$env{'user.domain'}) {
8013: $refused = '';
8014: }
8015: }
8016: }
8017: }
8018: }
8019: if ($refused) {
8020: &logthis('Refused custom assignrole: '.
8021: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
8022: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
8023: return 'refused';
8024: }
1.104 www 8025: }
1.21 www 8026: $mrole='cr';
1.678 raeburn 8027: } elsif ($role =~ /^gr\//) {
8028: my $cwogrp=$url;
1.811 albertel 8029: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 8030: unless (&allowed('mdg',$cwogrp)) {
8031: &logthis('Refused group assignrole: '.
8032: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
8033: $env{'user.name'}.' at '.$env{'user.domain'});
8034: return 'refused';
8035: }
8036: $mrole='gr';
1.21 www 8037: } else {
1.82 www 8038: my $cwosec=$url;
1.811 albertel 8039: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 8040: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
8041: my $refused;
8042: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
8043: if (!(&allowed('c'.$role,$url))) {
8044: $refused = 1;
8045: }
8046: } else {
8047: $refused = 1;
8048: }
1.947 raeburn 8049: if ($refused) {
1.1045 raeburn 8050: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
8051: if (!$selfenroll && $context eq 'course') {
8052: my %crsenv;
8053: if ($role eq 'cc' || $role eq 'co') {
8054: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8055: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
8056: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
8057: if ($crsenv{'internal.courseowner'} eq
8058: $env{'user.name'}.':'.$env{'user.domain'}) {
8059: $refused = '';
8060: }
8061: }
8062: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
8063: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
8064: if ($crsenv{'internal.courseowner'} eq
8065: $env{'user.name'}.':'.$env{'user.domain'}) {
8066: $refused = '';
8067: }
8068: }
8069: }
8070: }
8071: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 8072: $refused = '';
1.1017 raeburn 8073: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 8074: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 8075: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 8076: my $wrongcc;
8077: if ($cnum =~ /^$match_community$/) {
8078: $wrongcc = 1 if ($role eq 'cc');
8079: } else {
8080: $wrongcc = 1 if ($role eq 'co');
8081: }
8082: unless ($wrongcc) {
8083: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
8084: if ($crsenv{'internal.courseowner'} eq
8085: $env{'user.name'}.':'.$env{'user.domain'}) {
8086: $refused = '';
8087: }
1.1017 raeburn 8088: }
8089: }
1.1183 raeburn 8090: } elsif ($context eq 'requestauthor') {
8091: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
8092: ($url eq '/'.$udom.'/') && ($role eq 'au')) {
8093: if ($env{'environment.requestauthor'} eq 'automatic') {
8094: $refused = '';
8095: } else {
8096: my %domdefaults = &get_domain_defaults($udom);
8097: if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
8098: my $checkbystatus;
8099: if ($env{'user.adv'}) {
8100: my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
8101: if ($disposition eq 'automatic') {
8102: $refused = '';
8103: } elsif ($disposition eq '') {
8104: $checkbystatus = 1;
8105: }
8106: } else {
8107: $checkbystatus = 1;
8108: }
8109: if ($checkbystatus) {
8110: if ($env{'environment.inststatus'}) {
8111: my @inststatuses = split(/,/,$env{'environment.inststatus'});
8112: foreach my $type (@inststatuses) {
8113: if (($type ne '') &&
8114: ($domdefaults{'requestauthor'}{$type} eq 'automatic')) {
8115: $refused = '';
8116: }
8117: }
8118: } elsif ($domdefaults{'requestauthor'}{'default'} eq 'automatic') {
8119: $refused = '';
8120: }
8121: }
8122: }
8123: }
8124: }
1.1017 raeburn 8125: }
8126: if ($refused) {
1.947 raeburn 8127: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
8128: ' '.$role.' '.$end.' '.$start.' by '.
8129: $env{'user.name'}.' at '.$env{'user.domain'});
8130: return 'refused';
8131: }
1.932 raeburn 8132: }
1.1131 raeburn 8133: } elsif ($role eq 'au') {
8134: if ($url ne '/'.$udom.'/') {
8135: &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
8136: ' to assign author role for '.$uname.':'.$udom.
8137: ' in domain: '.$url.' refused (wrong domain).');
8138: return 'refused';
8139: }
1.104 www 8140: }
1.21 www 8141: $mrole=$role;
8142: }
1.620 albertel 8143: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 8144: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 8145: if ($end) { $command.='_'.$end; }
1.21 www 8146: if ($start) {
8147: if ($end) {
1.81 www 8148: $command.='_'.$start;
1.21 www 8149: } else {
1.81 www 8150: $command.='_0_'.$start;
1.21 www 8151: }
8152: }
1.739 raeburn 8153: my $origstart = $start;
8154: my $origend = $end;
1.957 raeburn 8155: my $delflag;
1.357 www 8156: # actually delete
8157: if ($deleteflag) {
1.373 www 8158: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 8159: # modify command to delete the role
1.620 albertel 8160: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 8161: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 8162: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 8163: # set start and finish to negative values for userrolelog
8164: $start=-1;
8165: $end=-1;
1.957 raeburn 8166: $delflag = 1;
1.357 www 8167: }
8168: }
8169: # send command
1.349 www 8170: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 8171: # log new user role if status is ok
1.349 www 8172: if ($answer eq 'ok') {
1.663 raeburn 8173: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.1184 raeburn 8174: if (($role eq 'cc') || ($role eq 'in') ||
8175: ($role eq 'ep') || ($role eq 'ad') ||
8176: ($role eq 'ta') || ($role eq 'st') ||
8177: ($role=~/^cr/) || ($role eq 'gr') ||
8178: ($role eq 'co')) {
1.1200 raeburn 8179: # for course roles, perform group memberships changes triggered by role change.
8180: unless ($role =~ /^gr/) {
8181: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
8182: $origstart,$selfenroll,$context);
8183: }
1.1184 raeburn 8184: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8185: $selfenroll,$context);
8186: } elsif (($role eq 'li') || ($role eq 'dg') || ($role eq 'sc') ||
8187: ($role eq 'au') || ($role eq 'dc')) {
8188: &domainrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8189: $context);
8190: } elsif (($role eq 'ca') || ($role eq 'aa')) {
8191: &coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
8192: $context);
8193: }
1.1053 raeburn 8194: if ($role eq 'cc') {
8195: &autoupdate_coowners($url,$end,$start,$uname,$udom);
8196: }
1.349 www 8197: }
8198: return $answer;
1.169 harris41 8199: }
8200:
1.1053 raeburn 8201: sub autoupdate_coowners {
8202: my ($url,$end,$start,$uname,$udom) = @_;
8203: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
8204: if (($cdom ne '') && ($cnum ne '')) {
8205: my $now = time;
8206: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
8207: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
8208: my %coursehash = &coursedescription($cdom.'_'.$cnum);
8209: my $instcode = $coursehash{'internal.coursecode'};
8210: if ($instcode ne '') {
1.1056 raeburn 8211: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
8212: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 8213: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 8214: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
8215: if ($result eq 'valid') {
8216: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 8217: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8218: push(@newcoowners,$coowner);
8219: }
8220: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
8221: push(@newcoowners,$uname.':'.$udom);
8222: }
8223: @newcoowners = sort(@newcoowners);
8224: } else {
8225: push(@newcoowners,$uname.':'.$udom);
8226: }
8227: } else {
8228: if ($coursehash{'internal.co-owners'}) {
8229: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
8230: unless ($coowner eq $uname.':'.$udom) {
8231: push(@newcoowners,$coowner);
8232: }
8233: }
8234: unless (@newcoowners > 0) {
8235: $delcoowners = 1;
8236: $coowners = '';
8237: }
8238: }
8239: }
8240: if (@newcoowners || $delcoowners) {
8241: &store_coowners($cdom,$cnum,$coursehash{'home'},
8242: $delcoowners,@newcoowners);
8243: }
8244: }
8245: }
8246: }
8247: }
8248: }
8249: }
8250:
8251: sub store_coowners {
8252: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
8253: my $cid = $cdom.'_'.$cnum;
8254: my ($coowners,$delresult,$putresult);
8255: if (@newcoowners) {
8256: $coowners = join(',',@newcoowners);
8257: my %coownershash = (
8258: 'internal.co-owners' => $coowners,
8259: );
8260: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
8261: if ($putresult eq 'ok') {
8262: if ($env{'course.'.$cid.'.num'} eq $cnum) {
8263: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
8264: }
8265: }
8266: }
8267: if ($delcoowners) {
8268: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
8269: if ($delresult eq 'ok') {
8270: if ($env{'course.'.$cid.'.internal.co-owners'}) {
8271: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
8272: }
8273: }
8274: }
8275: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
8276: my %crsinfo =
8277: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
8278: if (ref($crsinfo{$cid}) eq 'HASH') {
8279: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
8280: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
8281: }
8282: }
8283: }
8284:
1.169 harris41 8285: # -------------------------------------------------- Modify user authentication
1.197 www 8286: # Overrides without validation
8287:
1.169 harris41 8288: sub modifyuserauth {
8289: my ($udom,$uname,$umode,$upass)=@_;
8290: my $uhome=&homeserver($uname,$udom);
1.197 www 8291: unless (&allowed('mau',$udom)) { return 'refused'; }
8292: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 8293: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8294: ' in domain '.$env{'request.role.domain'});
1.169 harris41 8295: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
8296: &escape($upass),$uhome);
1.620 albertel 8297: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 8298: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
8299: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
8300: &log($udom,,$uname,$uhome,
1.620 albertel 8301: 'Authentication changed by '.$env{'user.domain'}.', '.
8302: $env{'user.name'}.', '.$umode.
1.197 www 8303: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 8304: unless ($reply eq 'ok') {
1.197 www 8305: &logthis('Authentication mode error: '.$reply);
1.169 harris41 8306: return 'error: '.$reply;
8307: }
1.170 harris41 8308: return 'ok';
1.80 www 8309: }
8310:
1.81 www 8311: # --------------------------------------------------------------- Modify a user
1.80 www 8312:
1.81 www 8313: sub modifyuser {
1.206 matthew 8314: my ($udom, $uname, $uid,
8315: $umode, $upass, $first,
8316: $middle, $last, $gene,
1.1058 raeburn 8317: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 8318: $udom= &LONCAPA::clean_domain($udom);
8319: $uname=&LONCAPA::clean_username($uname);
1.1059 raeburn 8320: my $showcandelete = 'none';
8321: if (ref($candelete) eq 'ARRAY') {
8322: if (@{$candelete} > 0) {
8323: $showcandelete = join(', ',@{$candelete});
8324: }
8325: }
1.81 www 8326: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 8327: $umode.', '.$first.', '.$middle.', '.
1.1059 raeburn 8328: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 8329: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
8330: ' desiredhome not specified').
1.620 albertel 8331: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
8332: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 8333: my $uhome=&homeserver($uname,$udom,'true');
1.1075 raeburn 8334: my $newuser;
8335: if ($uhome eq 'no_host') {
8336: $newuser = 1;
8337: }
1.80 www 8338: # ----------------------------------------------------------------- Create User
1.406 albertel 8339: if (($uhome eq 'no_host') &&
8340: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 8341: my $unhome='';
1.844 albertel 8342: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 8343: $unhome = $desiredhome;
1.620 albertel 8344: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
8345: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 8346: } else { # load balancing routine for determining $unhome
1.81 www 8347: my $loadm=10000000;
1.841 albertel 8348: my %servers = &get_servers($udom,'library');
8349: foreach my $tryserver (keys(%servers)) {
8350: my $answer=reply('load',$tryserver);
8351: if (($answer=~/\d+/) && ($answer<$loadm)) {
8352: $loadm=$answer;
8353: $unhome=$tryserver;
8354: }
1.80 www 8355: }
8356: }
8357: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 8358: return 'error: unable to find a home server for '.$uname.
8359: ' in domain '.$udom;
1.80 www 8360: }
8361: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
8362: &escape($upass),$unhome);
8363: unless ($reply eq 'ok') {
8364: return 'error: '.$reply;
8365: }
1.230 stredwic 8366: $uhome=&homeserver($uname,$udom,'true');
1.80 www 8367: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 8368: return 'error: unable verify users home machine.';
1.80 www 8369: }
1.209 matthew 8370: } # End of creation of new user
1.80 www 8371: # ---------------------------------------------------------------------- Add ID
8372: if ($uid) {
8373: $uid=~tr/A-Z/a-z/;
8374: my %uidhash=&idrget($udom,$uname);
1.196 www 8375: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
8376: && (!$forceid)) {
1.80 www 8377: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 8378: return 'error: user id "'.$uid.'" does not match '.
8379: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 8380: }
8381: } else {
8382: &idput($udom,($uname => $uid));
8383: }
8384: }
8385: # -------------------------------------------------------------- Add names, etc
1.313 matthew 8386: my @tmp=&get('environment',
1.899 raeburn 8387: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 8388: 'permanentemail','inststatus'],
1.134 albertel 8389: $udom,$uname);
1.1075 raeburn 8390: my (%names,%oldnames);
1.313 matthew 8391: if ($tmp[0] =~ m/^error:.*/) {
8392: %names=();
8393: } else {
8394: %names = @tmp;
1.1075 raeburn 8395: %oldnames = %names;
1.313 matthew 8396: }
1.388 www 8397: #
1.1058 raeburn 8398: # If name, email and/or uid are blank (e.g., because an uploaded file
8399: # of users did not contain them), do not overwrite existing values
8400: # unless field is in $candelete array ref.
8401: #
8402:
8403: my @fields = ('firstname','middlename','lastname','generation',
8404: 'permanentemail','id');
8405: my %newvalues;
8406: if (ref($candelete) eq 'ARRAY') {
8407: foreach my $field (@fields) {
8408: if (grep(/^\Q$field\E$/,@{$candelete})) {
8409: if ($field eq 'firstname') {
8410: $names{$field} = $first;
8411: } elsif ($field eq 'middlename') {
8412: $names{$field} = $middle;
8413: } elsif ($field eq 'lastname') {
8414: $names{$field} = $last;
8415: } elsif ($field eq 'generation') {
8416: $names{$field} = $gene;
8417: } elsif ($field eq 'permanentemail') {
8418: $names{$field} = $email;
8419: } elsif ($field eq 'id') {
8420: $names{$field} = $uid;
8421: }
8422: }
8423: }
8424: }
1.388 www 8425: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 8426: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 8427: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 8428: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 8429: if ($email) {
8430: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 8431: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 8432: }
1.899 raeburn 8433: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 8434: if (defined($inststatus)) {
8435: $names{'inststatus'} = '';
8436: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
8437: if (ref($usertypes) eq 'HASH') {
8438: my @okstatuses;
8439: foreach my $item (split(/:/,$inststatus)) {
8440: if (defined($usertypes->{$item})) {
8441: push(@okstatuses,$item);
8442: }
8443: }
8444: if (@okstatuses) {
8445: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
8446: }
8447: }
8448: }
1.1075 raeburn 8449: my $logmsg = $udom.', '.$uname.', '.$uid.', '.
1.963 raeburn 8450: $umode.', '.$first.', '.$middle.', '.
1.1075 raeburn 8451: $last.', '.$gene.', '.$email.', '.$inststatus;
1.963 raeburn 8452: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
8453: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
8454: } else {
8455: $logmsg .= ' during self creation';
8456: }
1.1075 raeburn 8457: my $changed;
8458: if ($newuser) {
8459: $changed = 1;
8460: } else {
8461: foreach my $field (@fields) {
8462: if ($names{$field} ne $oldnames{$field}) {
8463: $changed = 1;
8464: last;
8465: }
8466: }
8467: }
8468: unless ($changed) {
8469: $logmsg = 'No changes in user information needed for: '.$logmsg;
8470: &logthis($logmsg);
8471: return 'ok';
8472: }
8473: my $reply = &put('environment', \%names, $udom,$uname);
8474: if ($reply ne 'ok') {
8475: return 'error: '.$reply;
8476: }
1.1087 raeburn 8477: if ($names{'permanentemail'} ne $oldnames{'permanentemail'}) {
8478: &Apache::lonnet::devalidate_cache_new('emailscache',$uname.':'.$udom);
8479: }
1.1075 raeburn 8480: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
8481: &devalidate_cache_new('namescache',$uname.':'.$udom);
8482: $logmsg = 'Success modifying user '.$logmsg;
1.963 raeburn 8483: &logthis($logmsg);
1.134 albertel 8484: return 'ok';
1.80 www 8485: }
8486:
1.81 www 8487: # -------------------------------------------------------------- Modify student
1.80 www 8488:
1.81 www 8489: sub modifystudent {
8490: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 8491: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.1216 raeburn 8492: $selfenroll,$context,$inststatus,$credits)=@_;
1.455 albertel 8493: if (!$cid) {
1.620 albertel 8494: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 8495: return 'not_in_class';
8496: }
1.80 www 8497: }
8498: # --------------------------------------------------------------- Make the user
1.81 www 8499: my $reply=&modifyuser
1.209 matthew 8500: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 8501: $desiredhome,$email,$inststatus);
1.80 www 8502: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 8503: # This will cause &modify_student_enrollment to get the uid from the
1.1235 raeburn 8504: # student's environment
1.297 matthew 8505: $uid = undef if (!$forceid);
1.455 albertel 8506: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.1216 raeburn 8507: $gene,$usec,$end,$start,$type,$locktype,
8508: $cid,$selfenroll,$context,$credits);
1.297 matthew 8509: return $reply;
8510: }
8511:
8512: sub modify_student_enrollment {
1.1216 raeburn 8513: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,
8514: $locktype,$cid,$selfenroll,$context,$credits) = @_;
1.455 albertel 8515: my ($cdom,$cnum,$chome);
8516: if (!$cid) {
1.620 albertel 8517: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 8518: return 'not_in_class';
8519: }
1.620 albertel 8520: $cdom=$env{'course.'.$cid.'.domain'};
8521: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 8522: } else {
8523: ($cdom,$cnum)=split(/_/,$cid);
8524: }
1.620 albertel 8525: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 8526: if (!$chome) {
1.457 raeburn 8527: $chome=&homeserver($cnum,$cdom);
1.297 matthew 8528: }
1.455 albertel 8529: if (!$chome) { return 'unknown_course'; }
1.297 matthew 8530: # Make sure the user exists
1.81 www 8531: my $uhome=&homeserver($uname,$udom);
8532: if (($uhome eq '') || ($uhome eq 'no_host')) {
8533: return 'error: no such user';
8534: }
1.297 matthew 8535: # Get student data if we were not given enough information
8536: if (!defined($first) || $first eq '' ||
8537: !defined($last) || $last eq '' ||
8538: !defined($uid) || $uid eq '' ||
8539: !defined($middle) || $middle eq '' ||
8540: !defined($gene) || $gene eq '') {
1.294 matthew 8541: # They did not supply us with enough data to enroll the student, so
8542: # we need to pick up more information.
1.297 matthew 8543: my %tmp = &get('environment',
1.294 matthew 8544: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 8545: ,$udom,$uname);
8546:
1.800 albertel 8547: #foreach my $key (keys(%tmp)) {
8548: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 8549: #}
1.294 matthew 8550: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
8551: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
8552: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 8553: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 8554: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
8555: }
1.556 albertel 8556: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.1148 raeburn 8557: my $user = "$uname:$udom";
8558: my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
1.487 albertel 8559: my $reply=cput('classlist',
1.1148 raeburn 8560: {$user =>
1.1216 raeburn 8561: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype,$credits) },
1.487 albertel 8562: $cdom,$cnum);
1.1148 raeburn 8563: if (($reply eq 'ok') || ($reply eq 'delayed')) {
8564: &devalidate_getsection_cache($udom,$uname,$cid);
8565: } else {
1.81 www 8566: return 'error: '.$reply;
8567: }
1.297 matthew 8568: # Add student role to user
1.83 www 8569: my $uurl='/'.$cid;
1.81 www 8570: $uurl=~s/\_/\//g;
8571: if ($usec) {
8572: $uurl.='/'.$usec;
8573: }
1.1148 raeburn 8574: my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
8575: $selfenroll,$context);
8576: if ($result ne 'ok') {
8577: if ($old_entry{$user} ne '') {
8578: $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
8579: } else {
8580: $reply = &del('classlist',[$user],$cdom,$cnum);
8581: }
8582: }
8583: return $result;
1.21 www 8584: }
8585:
1.556 albertel 8586: sub format_name {
8587: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
8588: my $name;
8589: if ($first ne 'lastname') {
8590: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
8591: } else {
8592: if ($lastname=~/\S/) {
8593: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
8594: $name=~s/\s+,/,/;
8595: } else {
8596: $name.= $firstname.' '.$middlename.' '.$generation;
8597: }
8598: }
8599: $name=~s/^\s+//;
8600: $name=~s/\s+$//;
8601: $name=~s/\s+/ /g;
8602: return $name;
8603: }
8604:
1.84 www 8605: # ------------------------------------------------- Write to course preferences
8606:
8607: sub writecoursepref {
8608: my ($courseid,%prefs)=@_;
8609: $courseid=~s/^\///;
8610: $courseid=~s/\_/\//g;
8611: my ($cdomain,$cnum)=split(/\//,$courseid);
8612: my $chome=homeserver($cnum,$cdomain);
8613: if (($chome eq '') || ($chome eq 'no_host')) {
8614: return 'error: no such course';
8615: }
8616: my $cstring='';
1.800 albertel 8617: foreach my $pref (keys(%prefs)) {
8618: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 8619: }
1.84 www 8620: $cstring=~s/\&$//;
8621: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
8622: }
8623:
8624: # ---------------------------------------------------------- Make/modify course
8625:
8626: sub createcourse {
1.741 raeburn 8627: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 8628: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 8629: $url=&declutter($url);
8630: my $cid='';
1.1028 raeburn 8631: if ($context eq 'requestcourses') {
8632: my $can_create = 0;
8633: my ($ownername,$ownerdom) = split(':',$course_owner);
8634: if ($udom eq $ownerdom) {
8635: if (&usertools_access($ownername,$ownerdom,$category,undef,
8636: $context)) {
8637: $can_create = 1;
8638: }
8639: } else {
8640: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
8641: $category);
8642: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
8643: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
8644: if (@curr > 0) {
8645: my @options = qw(approval validate autolimit);
8646: my $optregex = join('|',@options);
8647: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
8648: $can_create = 1;
8649: }
8650: }
8651: }
8652: }
8653: if ($can_create) {
8654: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
8655: unless (&allowed('ccc',$udom)) {
8656: return 'refused';
8657: }
1.1017 raeburn 8658: }
8659: } else {
8660: return 'refused';
8661: }
1.1028 raeburn 8662: } elsif (!&allowed('ccc',$udom)) {
8663: return 'refused';
1.84 www 8664: }
1.1011 raeburn 8665: # --------------------------------------------------------------- Get Unique ID
8666: my $uname;
8667: if ($cnum =~ /^$match_courseid$/) {
8668: my $chome=&homeserver($cnum,$udom,'true');
8669: if (($chome eq '') || ($chome eq 'no_host')) {
8670: $uname = $cnum;
8671: } else {
1.1038 raeburn 8672: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 8673: }
8674: } else {
1.1038 raeburn 8675: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 8676: }
8677: return $uname if ($uname =~ /^error/);
8678: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 8679: if (!defined($course_server)) {
8680: if (defined(&domain($udom,'primary'))) {
8681: $course_server = &domain($udom,'primary');
8682: } else {
8683: $course_server = $env{'user.home'};
8684: }
8685: }
8686: my %host_servers =
8687: &Apache::lonnet::get_servers($udom,'library');
8688: unless ($host_servers{$course_server}) {
8689: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 8690: }
1.84 www 8691: # ------------------------------------------------------------- Make the course
8692: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 8693: $course_server);
1.84 www 8694: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 8695: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 8696: if (($uhome eq '') || ($uhome eq 'no_host')) {
8697: return 'error: no such course';
8698: }
1.271 www 8699: # ----------------------------------------------------------------- Course made
1.516 raeburn 8700: # log existence
1.1029 raeburn 8701: my $now = time;
1.918 raeburn 8702: my $newcourse = {
8703: $udom.'_'.$uname => {
1.921 raeburn 8704: description => $description,
8705: inst_code => $inst_code,
8706: owner => $course_owner,
8707: type => $crstype,
1.1029 raeburn 8708: creator => $env{'user.name'}.':'.
8709: $env{'user.domain'},
8710: created => $now,
8711: context => $context,
1.918 raeburn 8712: },
8713: };
1.921 raeburn 8714: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 8715: # set toplevel url
1.271 www 8716: my $topurl=$url;
8717: unless ($nonstandard) {
8718: # ------------------------------------------ For standard courses, make top url
8719: my $mapurl=&clutter($url);
1.278 www 8720: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 8721: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 8722: <map>
8723: <resource id="1" type="start"></resource>
8724: <resource id="2" src="$mapurl"></resource>
8725: <resource id="3" type="finish"></resource>
8726: <link index="1" from="1" to="2"></link>
8727: <link index="2" from="2" to="3"></link>
8728: </map>
8729: ENDINITMAP
8730: $topurl=&declutter(
1.638 albertel 8731: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 8732: );
8733: }
8734: # ----------------------------------------------------------- Write preferences
1.84 www 8735: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 8736: ('description' => $description,
8737: 'url' => $topurl,
8738: 'internal.creator' => $env{'user.name'}.':'.
8739: $env{'user.domain'},
8740: 'internal.created' => $now,
8741: 'internal.creationcontext' => $context)
8742: );
1.84 www 8743: return '/'.$udom.'/'.$uname;
8744: }
8745:
1.1011 raeburn 8746: # ------------------------------------------------------------------- Create ID
8747: sub generate_coursenum {
1.1038 raeburn 8748: my ($udom,$crstype) = @_;
1.1011 raeburn 8749: my $domdesc = &domain($udom);
8750: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 8751: my $first;
8752: if ($crstype eq 'Community') {
8753: $first = '0';
8754: } else {
8755: $first = int(1+rand(9));
8756: }
8757: my $uname=$first.
1.1011 raeburn 8758: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8759: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8760: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8761: # ----------------------------------------------- Make sure that does not exist
8762: my $uhome=&homeserver($uname,$udom,'true');
8763: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 8764: if ($crstype eq 'Community') {
8765: $first = '0';
8766: } else {
8767: $first = int(1+rand(9));
8768: }
8769: $uname=$first.
1.1011 raeburn 8770: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
8771: substr($$.time,0,5).unpack("H8",pack("I32",time)).
8772: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
8773: $uhome=&homeserver($uname,$udom,'true');
8774: unless (($uhome eq '') || ($uhome eq 'no_host')) {
8775: return 'error: unable to generate unique course-ID';
8776: }
8777: }
8778: return $uname;
8779: }
8780:
1.813 albertel 8781: sub is_course {
1.1167 droeschl 8782: my ($cdom, $cnum) = scalar(@_) == 1 ?
8783: ($_[0] =~ /^($match_domain)_($match_courseid)$/) : @_;
8784:
8785: return unless $cdom and $cnum;
8786:
8787: my %courses = &courseiddump($cdom, '.', 1, '.', '.', $cnum, undef, undef,
8788: '.');
8789:
1.1219 raeburn 8790: return unless(exists($courses{$cdom.'_'.$cnum}));
1.1167 droeschl 8791: return wantarray ? ($cdom, $cnum) : $cdom.'_'.$cnum;
1.813 albertel 8792: }
8793:
1.1015 raeburn 8794: sub store_userdata {
8795: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 8796: my $result;
1.1016 raeburn 8797: if ($datakey ne '') {
1.1013 raeburn 8798: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 8799: if ($udom eq '' || $uname eq '') {
8800: $udom = $env{'user.domain'};
8801: $uname = $env{'user.name'};
8802: }
8803: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 8804: if (($uhome eq '') || ($uhome eq 'no_host')) {
8805: $result = 'error: no_host';
8806: } else {
8807: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
8808: $storehash->{'host'} = $perlvar{'lonHostID'};
8809:
8810: my $namevalue='';
8811: foreach my $key (keys(%{$storehash})) {
8812: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
8813: }
8814: $namevalue=~s/\&$//;
1.1224 raeburn 8815: unless ($namespace eq 'courserequests') {
8816: $datakey = &escape($datakey);
8817: }
1.1105 raeburn 8818: $result = &reply("store:$udom:$uname:$namespace:$datakey:".
8819: $namevalue,$uhome);
1.1013 raeburn 8820: }
8821: } else {
8822: $result = 'error: data to store was not a hash reference';
8823: }
8824: } else {
8825: $result= 'error: invalid requestkey';
8826: }
8827: return $result;
8828: }
8829:
1.21 www 8830: # ---------------------------------------------------------- Assign Custom Role
8831:
8832: sub assigncustomrole {
1.957 raeburn 8833: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 8834: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 8835: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 8836: }
8837:
8838: # ----------------------------------------------------------------- Revoke Role
8839:
8840: sub revokerole {
1.957 raeburn 8841: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 8842: my $now=time;
1.965 raeburn 8843: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 8844: }
8845:
8846: # ---------------------------------------------------------- Revoke Custom Role
8847:
8848: sub revokecustomrole {
1.957 raeburn 8849: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 8850: my $now=time;
1.357 www 8851: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 8852: $deleteflag,$selfenroll,$context);
1.17 www 8853: }
8854:
1.533 banghart 8855: # ------------------------------------------------------------ Disk usage
1.535 albertel 8856: sub diskusage {
1.955 raeburn 8857: my ($udom,$uname,$directorypath,$getpropath)=@_;
8858: $directorypath =~ s/\/$//;
8859: my $listing=&reply('du2:'.&escape($directorypath).':'
8860: .&escape($getpropath).':'.&escape($uname).':'
8861: .&escape($udom),homeserver($uname,$udom));
8862: if ($listing eq 'unknown_cmd') {
8863: if ($getpropath) {
8864: $directorypath = &propath($udom,$uname).'/'.$directorypath;
8865: }
8866: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
8867: }
1.514 albertel 8868: return $listing;
1.512 banghart 8869: }
8870:
1.566 banghart 8871: sub is_locked {
1.1096 raeburn 8872: my ($file_name, $domain, $user, $which) = @_;
1.566 banghart 8873: my @check;
8874: my $is_locked;
1.1093 raeburn 8875: push (@check,$file_name);
1.613 albertel 8876: my %locked = &get('file_permissions',\@check,
1.620 albertel 8877: $env{'user.domain'},$env{'user.name'});
1.615 albertel 8878: my ($tmp)=keys(%locked);
8879: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 8880:
1.566 banghart 8881: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 8882: $is_locked = 'false';
8883: foreach my $entry (@{$locked{$file_name}}) {
1.1096 raeburn 8884: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 8885: $is_locked = 'true';
1.1096 raeburn 8886: if (ref($which) eq 'ARRAY') {
8887: push(@{$which},$entry);
8888: } else {
8889: last;
8890: }
1.745 raeburn 8891: }
8892: }
1.566 banghart 8893: } else {
8894: $is_locked = 'false';
8895: }
1.1093 raeburn 8896: return $is_locked;
1.566 banghart 8897: }
8898:
1.759 albertel 8899: sub declutter_portfile {
8900: my ($file) = @_;
1.833 albertel 8901: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 8902: return $file;
8903: }
8904:
1.559 banghart 8905: # ------------------------------------------------------------- Mark as Read Only
8906:
8907: sub mark_as_readonly {
8908: my ($domain,$user,$files,$what) = @_;
1.613 albertel 8909: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 8910: my ($tmp)=keys(%current_permissions);
8911: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 8912: foreach my $file (@{$files}) {
1.759 albertel 8913: $file = &declutter_portfile($file);
1.561 banghart 8914: push(@{$current_permissions{$file}},$what);
1.559 banghart 8915: }
1.613 albertel 8916: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 8917: return;
8918: }
8919:
1.572 banghart 8920: # ------------------------------------------------------------Save Selected Files
8921:
8922: sub save_selected_files {
8923: my ($user, $path, @files) = @_;
8924: my $filename = $user."savedfiles";
1.573 banghart 8925: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 8926: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 8927: foreach my $file (@files) {
1.620 albertel 8928: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 8929: }
8930: foreach my $file (@other_files) {
1.574 banghart 8931: print (OUT $file."\n");
1.572 banghart 8932: }
1.574 banghart 8933: close (OUT);
1.572 banghart 8934: return 'ok';
8935: }
8936:
1.574 banghart 8937: sub clear_selected_files {
8938: my ($user) = @_;
8939: my $filename = $user."savedfiles";
1.1117 foxr 8940: open (OUT, '>'.LONCAPA::tempdir().$filename);
1.574 banghart 8941: print (OUT undef);
8942: close (OUT);
8943: return ("ok");
8944: }
8945:
1.572 banghart 8946: sub files_in_path {
8947: my ($user, $path) = @_;
8948: my $filename = $user."savedfiles";
8949: my %return_files;
1.1117 foxr 8950: open (IN, '<'.LONCAPA::tempdir().$filename);
1.573 banghart 8951: while (my $line_in = <IN>) {
1.574 banghart 8952: chomp ($line_in);
8953: my @paths_and_file = split (m!/!, $line_in);
8954: my $file_part = pop (@paths_and_file);
8955: my $path_part = join ('/', @paths_and_file);
1.573 banghart 8956: $path_part.='/';
8957: my $path_and_file = $path_part.$file_part;
8958: if ($path_part eq $path) {
8959: $return_files{$file_part}= 'selected';
8960: }
8961: }
1.574 banghart 8962: close (IN);
8963: return (\%return_files);
1.572 banghart 8964: }
8965:
8966: # called in portfolio select mode, to show files selected NOT in current directory
8967: sub files_not_in_path {
8968: my ($user, $path) = @_;
8969: my $filename = $user."savedfiles";
8970: my @return_files;
8971: my $path_part;
1.1117 foxr 8972: open(IN, '<'.LONCAPA::.$filename);
1.800 albertel 8973: while (my $line = <IN>) {
1.572 banghart 8974: #ok, I know it's clunky, but I want it to work
1.800 albertel 8975: my @paths_and_file = split(m|/|, $line);
8976: my $file_part = pop(@paths_and_file);
8977: chomp($file_part);
8978: my $path_part = join('/', @paths_and_file);
1.572 banghart 8979: $path_part .= '/';
8980: my $path_and_file = $path_part.$file_part;
8981: if ($path_part ne $path) {
1.800 albertel 8982: push(@return_files, ($path_and_file));
1.572 banghart 8983: }
8984: }
1.800 albertel 8985: close(OUT);
1.574 banghart 8986: return (@return_files);
1.572 banghart 8987: }
8988:
1.745 raeburn 8989: #----------------------------------------------Get portfolio file permissions
1.629 banghart 8990:
1.745 raeburn 8991: sub get_portfile_permissions {
8992: my ($domain,$user) = @_;
1.613 albertel 8993: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 8994: my ($tmp)=keys(%current_permissions);
8995: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 8996: return \%current_permissions;
8997: }
8998:
8999: #---------------------------------------------Get portfolio file access controls
9000:
1.749 raeburn 9001: sub get_access_controls {
1.745 raeburn 9002: my ($current_permissions,$group,$file) = @_;
1.769 albertel 9003: my %access;
9004: my $real_file = $file;
9005: $file =~ s/\.meta$//;
1.745 raeburn 9006: if (defined($file)) {
1.749 raeburn 9007: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
9008: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 9009: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 9010: }
9011: }
1.745 raeburn 9012: } else {
1.749 raeburn 9013: foreach my $key (keys(%{$current_permissions})) {
9014: if ($key =~ /\0accesscontrol$/) {
9015: if (defined($group)) {
9016: if ($key !~ m-^\Q$group\E/-) {
9017: next;
9018: }
9019: }
9020: my ($fullpath) = split(/\0/,$key);
9021: if (ref($$current_permissions{$key}) eq 'HASH') {
9022: foreach my $control (keys(%{$$current_permissions{$key}})) {
9023: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
9024: }
9025: }
9026: }
9027: }
9028: }
9029: return %access;
9030: }
9031:
9032: sub modify_access_controls {
9033: my ($file_name,$changes,$domain,$user)=@_;
9034: my ($outcome,$deloutcome);
9035: my %store_permissions;
9036: my %new_values;
9037: my %new_control;
9038: my %translation;
9039: my @deletions = ();
9040: my $now = time;
9041: if (exists($$changes{'activate'})) {
9042: if (ref($$changes{'activate'}) eq 'HASH') {
9043: my @newitems = sort(keys(%{$$changes{'activate'}}));
9044: my $numnew = scalar(@newitems);
9045: for (my $i=0; $i<$numnew; $i++) {
9046: my $newkey = $newitems[$i];
9047: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 9048: if ($newkey =~ /^\d+:/) {
9049: $newkey =~ s/^(\d+)/$newid/;
9050: $translation{$1} = $newid;
9051: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
9052: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
9053: $translation{$1} = $newid;
9054: }
1.749 raeburn 9055: $new_values{$file_name."\0".$newkey} =
9056: $$changes{'activate'}{$newitems[$i]};
9057: $new_control{$newkey} = $now;
9058: }
9059: }
9060: }
9061: my %todelete;
9062: my %changed_items;
9063: foreach my $action ('delete','update') {
9064: if (exists($$changes{$action})) {
9065: if (ref($$changes{$action}) eq 'HASH') {
9066: foreach my $key (keys(%{$$changes{$action}})) {
9067: my ($itemnum) = ($key =~ /^([^:]+):/);
9068: if ($action eq 'delete') {
9069: $todelete{$itemnum} = 1;
9070: } else {
9071: $changed_items{$itemnum} = $key;
9072: }
9073: }
1.745 raeburn 9074: }
9075: }
1.749 raeburn 9076: }
9077: # get lock on access controls for file.
9078: my $lockhash = {
9079: $file_name."\0".'locked_access_records' => $env{'user.name'}.
9080: ':'.$env{'user.domain'},
9081: };
9082: my $tries = 0;
9083: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9084:
9085: while (($gotlock ne 'ok') && $tries <3) {
9086: $tries ++;
9087: sleep 1;
9088: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
9089: }
9090: if ($gotlock eq 'ok') {
9091: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
9092: my ($tmp)=keys(%curr_permissions);
9093: if ($tmp=~/^error:/) { undef(%curr_permissions); }
9094: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
9095: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
9096: if (ref($curr_controls) eq 'HASH') {
9097: foreach my $control_item (keys(%{$curr_controls})) {
9098: my ($itemnum) = ($control_item =~ /^([^:]+):/);
9099: if (defined($todelete{$itemnum})) {
9100: push(@deletions,$file_name."\0".$control_item);
9101: } else {
9102: if (defined($changed_items{$itemnum})) {
9103: $new_control{$changed_items{$itemnum}} = $now;
9104: push(@deletions,$file_name."\0".$control_item);
9105: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
9106: } else {
9107: $new_control{$control_item} = $$curr_controls{$control_item};
9108: }
9109: }
1.745 raeburn 9110: }
9111: }
9112: }
1.970 raeburn 9113: my ($group);
9114: if (&is_course($domain,$user)) {
9115: ($group,my $file) = split(/\//,$file_name,2);
9116: }
1.749 raeburn 9117: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
9118: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
9119: $outcome = &put('file_permissions',\%new_values,$domain,$user);
9120: # remove lock
9121: my @del_lock = ($file_name."\0".'locked_access_records');
9122: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 9123: my $sqlresult =
1.970 raeburn 9124: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 9125: $group);
1.749 raeburn 9126: } else {
9127: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 9128: }
1.749 raeburn 9129: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 9130: }
9131:
1.827 raeburn 9132: sub make_public_indefinitely {
9133: my ($requrl) = @_;
9134: my $now = time;
9135: my $action = 'activate';
9136: my $aclnum = 0;
9137: if (&is_portfolio_url($requrl)) {
9138: my (undef,$udom,$unum,$file_name,$group) =
9139: &parse_portfolio_url($requrl);
9140: my $current_perms = &get_portfile_permissions($udom,$unum);
9141: my %access_controls = &get_access_controls($current_perms,
9142: $group,$file_name);
9143: foreach my $key (keys(%{$access_controls{$file_name}})) {
9144: my ($num,$scope,$end,$start) =
9145: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
9146: if ($scope eq 'public') {
9147: if ($start <= $now && $end == 0) {
9148: $action = 'none';
9149: } else {
9150: $action = 'update';
9151: $aclnum = $num;
9152: }
9153: last;
9154: }
9155: }
9156: if ($action eq 'none') {
9157: return 'ok';
9158: } else {
9159: my %changes;
9160: my $newend = 0;
9161: my $newstart = $now;
9162: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
9163: $changes{$action}{$newkey} = {
9164: type => 'public',
9165: time => {
9166: start => $newstart,
9167: end => $newend,
9168: },
9169: };
9170: my ($outcome,$deloutcome,$new_values,$translation) =
9171: &modify_access_controls($file_name,\%changes,$udom,$unum);
9172: return $outcome;
9173: }
9174: } else {
9175: return 'invalid';
9176: }
9177: }
9178:
1.745 raeburn 9179: #------------------------------------------------------Get Marked as Read Only
9180:
9181: sub get_marked_as_readonly {
9182: my ($domain,$user,$what,$group) = @_;
9183: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 9184: my @readonly_files;
1.629 banghart 9185: my $cmp1=$what;
9186: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 9187: while (my ($file_name,$value) = each(%{$current_permissions})) {
9188: if (defined($group)) {
9189: if ($file_name !~ m-^\Q$group\E/-) {
9190: next;
9191: }
9192: }
1.561 banghart 9193: if (ref($value) eq "ARRAY"){
9194: foreach my $stored_what (@{$value}) {
1.629 banghart 9195: my $cmp2=$stored_what;
1.759 albertel 9196: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 9197: $cmp2=join('',@{$stored_what});
1.745 raeburn 9198: }
1.629 banghart 9199: if ($cmp1 eq $cmp2) {
1.561 banghart 9200: push(@readonly_files, $file_name);
1.745 raeburn 9201: last;
1.563 banghart 9202: } elsif (!defined($what)) {
9203: push(@readonly_files, $file_name);
1.745 raeburn 9204: last;
1.561 banghart 9205: }
9206: }
1.745 raeburn 9207: }
1.561 banghart 9208: }
9209: return @readonly_files;
9210: }
1.577 banghart 9211: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 9212:
1.577 banghart 9213: sub get_marked_as_readonly_hash {
1.745 raeburn 9214: my ($current_permissions,$group,$what) = @_;
1.577 banghart 9215: my %readonly_files;
1.745 raeburn 9216: while (my ($file_name,$value) = each(%{$current_permissions})) {
9217: if (defined($group)) {
9218: if ($file_name !~ m-^\Q$group\E/-) {
9219: next;
9220: }
9221: }
1.577 banghart 9222: if (ref($value) eq "ARRAY"){
9223: foreach my $stored_what (@{$value}) {
1.745 raeburn 9224: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 9225: foreach my $lock_descriptor(@{$stored_what}) {
9226: if ($lock_descriptor eq 'graded') {
9227: $readonly_files{$file_name} = 'graded';
9228: } elsif ($lock_descriptor eq 'handback') {
9229: $readonly_files{$file_name} = 'handback';
9230: } else {
9231: if (!exists($readonly_files{$file_name})) {
9232: $readonly_files{$file_name} = 'locked';
9233: }
9234: }
1.745 raeburn 9235: }
1.750 banghart 9236: }
1.577 banghart 9237: }
9238: }
9239: }
9240: return %readonly_files;
9241: }
1.559 banghart 9242: # ------------------------------------------------------------ Unmark as Read Only
9243:
9244: sub unmark_as_readonly {
1.629 banghart 9245: # unmarks $file_name (if $file_name is defined), or all files locked by $what
9246: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 9247: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 9248: $file_name = &declutter_portfile($file_name);
1.634 albertel 9249: my $symb_crs = $what;
9250: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 9251: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 9252: my ($tmp)=keys(%current_permissions);
9253: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 9254: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 9255: foreach my $file (@readonly_files) {
1.759 albertel 9256: my $clean_file = &declutter_portfile($file);
9257: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 9258: my $current_locks = $current_permissions{$file};
1.563 banghart 9259: my @new_locks;
9260: my @del_keys;
9261: if (ref($current_locks) eq "ARRAY"){
9262: foreach my $locker (@{$current_locks}) {
1.632 albertel 9263: my $compare=$locker;
1.749 raeburn 9264: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 9265: $compare=join('',@{$locker});
1.746 raeburn 9266: if ($compare ne $symb_crs) {
9267: push(@new_locks, $locker);
9268: }
1.563 banghart 9269: }
9270: }
1.650 albertel 9271: if (scalar(@new_locks) > 0) {
1.563 banghart 9272: $current_permissions{$file} = \@new_locks;
9273: } else {
9274: push(@del_keys, $file);
1.613 albertel 9275: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 9276: delete($current_permissions{$file});
1.563 banghart 9277: }
9278: }
1.561 banghart 9279: }
1.613 albertel 9280: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 9281: return;
9282: }
1.512 banghart 9283:
1.17 www 9284: # ------------------------------------------------------------ Directory lister
9285:
9286: sub dirlist {
1.955 raeburn 9287: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 9288: $uri=~s/^\///;
9289: $uri=~s/\/$//;
1.253 stredwic 9290: my ($udom, $uname);
1.955 raeburn 9291: if ($getuserdir) {
1.253 stredwic 9292: $udom = $userdomain;
9293: $uname = $username;
1.955 raeburn 9294: } else {
9295: (undef,$udom,$uname)=split(/\//,$uri);
9296: if(defined($userdomain)) {
9297: $udom = $userdomain;
9298: }
9299: if(defined($username)) {
9300: $uname = $username;
9301: }
1.253 stredwic 9302: }
1.955 raeburn 9303: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 9304:
1.955 raeburn 9305: $dirRoot = $perlvar{'lonDocRoot'};
9306: if (defined($getpropath)) {
9307: $dirRoot = &propath($udom,$uname);
1.253 stredwic 9308: $dirRoot =~ s/\/$//;
1.955 raeburn 9309: } elsif (defined($getuserdir)) {
9310: my $subdir=$uname.'__';
9311: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
9312: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
9313: ."/$udom/$subdir/$uname";
9314: } elsif (defined($alternateRoot)) {
9315: $dirRoot = $alternateRoot;
1.751 banghart 9316: }
1.253 stredwic 9317:
9318: if($udom) {
9319: if($uname) {
1.1135 raeburn 9320: my $uhome = &homeserver($uname,$udom);
1.1136 raeburn 9321: if ($uhome eq 'no_host') {
9322: return ([],'no_host');
9323: }
1.955 raeburn 9324: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 9325: .$getuserdir.':'.&escape($dirRoot)
1.1135 raeburn 9326: .':'.&escape($uname).':'.&escape($udom),$uhome);
1.955 raeburn 9327: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 9328: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
1.955 raeburn 9329: } else {
9330: @listing_results = map { &unescape($_); } split(/:/,$listing);
9331: }
1.605 matthew 9332: if ($listing eq 'unknown_cmd') {
1.1135 raeburn 9333: $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
1.605 matthew 9334: @listing_results = split(/:/,$listing);
9335: } else {
9336: @listing_results = map { &unescape($_); } split(/:/,$listing);
9337: }
1.1135 raeburn 9338: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
1.1136 raeburn 9339: ($listing eq 'rejected') || ($listing eq 'refused') ||
9340: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9341: return ([],$listing);
9342: } else {
9343: return (\@listing_results);
1.1135 raeburn 9344: }
1.955 raeburn 9345: } elsif(!$alternateRoot) {
1.1136 raeburn 9346: my (%allusers,%listerror);
1.841 albertel 9347: my %servers = &get_servers($udom,'library');
1.955 raeburn 9348: foreach my $tryserver (keys(%servers)) {
9349: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
9350: &escape($udom),$tryserver);
9351: if ($listing eq 'unknown_cmd') {
9352: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
9353: $udom, $tryserver);
9354: } else {
9355: @listing_results = map { &unescape($_); } split(/:/,$listing);
9356: }
1.841 albertel 9357: if ($listing eq 'unknown_cmd') {
9358: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
9359: $udom, $tryserver);
9360: @listing_results = split(/:/,$listing);
9361: } else {
9362: @listing_results =
9363: map { &unescape($_); } split(/:/,$listing);
9364: }
1.1136 raeburn 9365: if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
9366: ($listing eq 'rejected') || ($listing eq 'refused') ||
9367: ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
9368: $listerror{$tryserver} = $listing;
9369: } else {
1.841 albertel 9370: foreach my $line (@listing_results) {
9371: my ($entry) = split(/&/,$line,2);
9372: $allusers{$entry} = 1;
9373: }
9374: }
1.253 stredwic 9375: }
1.1136 raeburn 9376: my @alluserslist=();
1.800 albertel 9377: foreach my $user (sort(keys(%allusers))) {
1.1136 raeburn 9378: push(@alluserslist,$user.'&user');
1.253 stredwic 9379: }
1.1136 raeburn 9380: return (\@alluserslist);
1.253 stredwic 9381: } else {
1.1136 raeburn 9382: return ([],'missing username');
1.253 stredwic 9383: }
1.955 raeburn 9384: } elsif(!defined($getpropath)) {
1.1136 raeburn 9385: my $path = $perlvar{'lonDocRoot'}.'/res/';
9386: my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
9387: return (\@all_domains);
1.955 raeburn 9388: } else {
1.1136 raeburn 9389: return ([],'missing domain');
1.275 stredwic 9390: }
9391: }
9392:
9393: # --------------------------------------------- GetFileTimestamp
9394: # This function utilizes dirlist and returns the date stamp for
9395: # when it was last modified. It will also return an error of -1
9396: # if an error occurs
9397:
9398: sub GetFileTimestamp {
1.955 raeburn 9399: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 9400: $studentDomain = &LONCAPA::clean_domain($studentDomain);
9401: $studentName = &LONCAPA::clean_username($studentName);
1.1136 raeburn 9402: my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
9403: undef,$getuserdir);
9404: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
9405: return -1;
9406: }
9407: if (ref($fileref) eq 'ARRAY') {
9408: my @stats = split('&',$fileref->[0]);
1.375 matthew 9409: # @stats contains first the filename, then the stat output
9410: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 9411: } else {
9412: return -1;
1.253 stredwic 9413: }
1.26 www 9414: }
9415:
1.712 albertel 9416: sub stat_file {
9417: my ($uri) = @_;
1.787 albertel 9418: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 9419:
1.955 raeburn 9420: my ($udom,$uname,$file);
1.712 albertel 9421: if ($uri =~ m-^/(uploaded|editupload)/-) {
9422: ($udom,$uname,$file) =
1.811 albertel 9423: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 9424: $file = 'userfiles/'.$file;
9425: }
9426: if ($uri =~ m-^/res/-) {
9427: ($udom,$uname) =
1.807 albertel 9428: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 9429: $file = $uri;
9430: }
9431:
9432: if (!$udom || !$uname || !$file) {
9433: # unable to handle the uri
9434: return ();
9435: }
1.956 raeburn 9436: my $getpropath;
9437: if ($file =~ /^userfiles\//) {
9438: $getpropath = 1;
9439: }
1.1136 raeburn 9440: my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
9441: if (($error eq 'empty') || ($error eq 'no_such_dir')) {
9442: return ();
9443: } else {
9444: if (ref($listref) eq 'ARRAY') {
9445: my @stats = split('&',$listref->[0]);
9446: shift(@stats); #filename is first
9447: return @stats;
9448: }
1.712 albertel 9449: }
9450: return ();
9451: }
9452:
1.26 www 9453: # -------------------------------------------------------- Value of a Condition
9454:
1.713 albertel 9455: # gets the value of a specific preevaluated condition
9456: # stored in the string $env{user.state.<cid>}
9457: # or looks up a condition reference in the bighash and if if hasn't
9458: # already been evaluated recurses into docondval to get the value of
9459: # the condition, then memoizing it to
9460: # $env{user.state.<cid>.<condition>}
1.40 www 9461: sub directcondval {
9462: my $number=shift;
1.620 albertel 9463: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 9464: &Apache::lonuserstate::evalstate();
9465: }
1.713 albertel 9466: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
9467: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
9468: } elsif ($number =~ /^_/) {
9469: my $sub_condition;
9470: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
9471: &GDBM_READER(),0640)) {
9472: $sub_condition=$bighash{'conditions'.$number};
9473: untie(%bighash);
9474: }
9475: my $value = &docondval($sub_condition);
1.949 raeburn 9476: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 9477: return $value;
9478: }
1.620 albertel 9479: if ($env{'user.state.'.$env{'request.course.id'}}) {
9480: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 9481: } else {
9482: return 2;
9483: }
9484: }
9485:
1.713 albertel 9486: # get the collection of conditions for this resource
1.26 www 9487: sub condval {
9488: my $condidx=shift;
1.54 www 9489: my $allpathcond='';
1.713 albertel 9490: foreach my $cond (split(/\|/,$condidx)) {
9491: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
9492: $allpathcond.=
9493: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
9494: }
1.191 harris41 9495: }
1.54 www 9496: $allpathcond=~s/\|$//;
1.713 albertel 9497: return &docondval($allpathcond);
9498: }
9499:
9500: #evaluates an expression of conditions
9501: sub docondval {
9502: my ($allpathcond) = @_;
9503: my $result=0;
9504: if ($env{'request.course.id'}
9505: && defined($allpathcond)) {
9506: my $operand='|';
9507: my @stack;
9508: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
9509: if ($chunk eq '(') {
9510: push @stack,($operand,$result);
9511: } elsif ($chunk eq ')') {
9512: my $before=pop @stack;
9513: if (pop @stack eq '&') {
9514: $result=$result>$before?$before:$result;
9515: } else {
9516: $result=$result>$before?$result:$before;
9517: }
9518: } elsif (($chunk eq '&') || ($chunk eq '|')) {
9519: $operand=$chunk;
9520: } else {
9521: my $new=directcondval($chunk);
9522: if ($operand eq '&') {
9523: $result=$result>$new?$new:$result;
9524: } else {
9525: $result=$result>$new?$result:$new;
9526: }
9527: }
9528: }
1.26 www 9529: }
9530: return $result;
1.421 albertel 9531: }
9532:
9533: # ---------------------------------------------------- Devalidate courseresdata
9534:
9535: sub devalidatecourseresdata {
9536: my ($coursenum,$coursedomain)=@_;
9537: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 9538: &devalidate_cache_new('courseres',$hashid);
1.28 www 9539: }
9540:
1.763 www 9541:
1.200 www 9542: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 9543: #
9544: # Parameters:
9545: # $coursenum - Number of the course.
9546: # $coursedomain - Domain at which the course was created.
9547: # Returns:
9548: # A hash of the course parameters along (I think) with timestamps
9549: # and version info.
1.877 foxr 9550:
1.624 albertel 9551: sub get_courseresdata {
9552: my ($coursenum,$coursedomain)=@_;
1.200 www 9553: my $coursehom=&homeserver($coursenum,$coursedomain);
9554: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 9555: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 9556: my %dumpreply;
1.417 albertel 9557: unless (defined($cached)) {
1.624 albertel 9558: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 9559: $result=\%dumpreply;
1.251 albertel 9560: my ($tmp) = keys(%dumpreply);
9561: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 9562: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 9563: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
9564: return $tmp;
1.416 albertel 9565: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 9566: $result=undef;
1.599 albertel 9567: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 9568: }
9569: }
1.624 albertel 9570: return $result;
9571: }
9572:
1.633 albertel 9573: sub devalidateuserresdata {
9574: my ($uname,$udom)=@_;
9575: my $hashid="$udom:$uname";
9576: &devalidate_cache_new('userres',$hashid);
9577: }
9578:
1.624 albertel 9579: sub get_userresdata {
9580: my ($uname,$udom)=@_;
9581: #most student don\'t have any data set, check if there is some data
9582: if (&EXT_cache_status($udom,$uname)) { return undef; }
9583:
9584: my $hashid="$udom:$uname";
9585: my ($result,$cached)=&is_cached_new('userres',$hashid);
9586: if (!defined($cached)) {
9587: my %resourcedata=&dump('resourcedata',$udom,$uname);
9588: $result=\%resourcedata;
9589: &do_cache_new('userres',$hashid,$result,600);
9590: }
9591: my ($tmp)=keys(%$result);
9592: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
9593: return $result;
9594: }
9595: #error 2 occurs when the .db doesn't exist
9596: if ($tmp!~/error: 2 /) {
1.672 albertel 9597: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 9598: " Trying to get resource data for ".
9599: $uname." at ".$udom.": ".
9600: $tmp."</font>");
9601: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 9602: #&EXT_cache_set($udom,$uname);
9603: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 9604: undef($tmp); # not really an error so don't send it back
1.624 albertel 9605: }
9606: return $tmp;
9607: }
1.879 foxr 9608: #----------------------------------------------- resdata - return resource data
9609: # Purpose:
9610: # Return resource data for either users or for a course.
9611: # Parameters:
9612: # $name - Course/user name.
9613: # $domain - Name of the domain the user/course is registered on.
9614: # $type - Type of thing $name is (must be 'course' or 'user'
9615: # @which - Array of names of resources desired.
9616: # Returns:
9617: # The value of the first reasource in @which that is found in the
9618: # resource hash.
9619: # Exceptional Conditions:
9620: # If the $type passed in is not valid (not the string 'course' or
9621: # 'user', an undefined reference is returned.
9622: # If none of the resources are found, an undef is returned
1.624 albertel 9623: sub resdata {
9624: my ($name,$domain,$type,@which)=@_;
9625: my $result;
9626: if ($type eq 'course') {
9627: $result=&get_courseresdata($name,$domain);
9628: } elsif ($type eq 'user') {
9629: $result=&get_userresdata($name,$domain);
9630: }
9631: if (!ref($result)) { return $result; }
1.251 albertel 9632: foreach my $item (@which) {
1.927 albertel 9633: if (defined($result->{$item->[0]})) {
9634: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 9635: }
1.250 albertel 9636: }
1.291 albertel 9637: return undef;
1.200 www 9638: }
9639:
1.1236 ! raeburn 9640: sub get_numsuppfiles {
! 9641: my ($cnum,$cdom,$ignorecache)=@_;
! 9642: my $hashid=$cnum.':'.$cdom;
! 9643: my ($suppcount,$cached);
! 9644: unless ($ignorecache) {
! 9645: ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
! 9646: }
! 9647: unless (defined($cached)) {
! 9648: my $chome=&homeserver($cnum,$cdom);
! 9649: unless ($chome eq 'no_host') {
! 9650: ($suppcount,my $errors) = (0,0);
! 9651: my $suppmap = 'supplemental.sequence';
! 9652: ($suppcount,$errors) =
! 9653: &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
! 9654: }
! 9655: &do_cache_new('suppcount',$hashid,$suppcount,600);
! 9656: }
! 9657: return $suppcount;
! 9658: }
! 9659:
1.379 matthew 9660: #
9661: # EXT resource caching routines
9662: #
9663:
9664: sub clear_EXT_cache_status {
1.383 albertel 9665: &delenv('cache.EXT.');
1.379 matthew 9666: }
9667:
9668: sub EXT_cache_status {
9669: my ($target_domain,$target_user) = @_;
1.383 albertel 9670: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 9671: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 9672: # We know already the user has no data
9673: return 1;
9674: } else {
9675: return 0;
9676: }
9677: }
9678:
9679: sub EXT_cache_set {
9680: my ($target_domain,$target_user) = @_;
1.383 albertel 9681: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 9682: #&appenv({$cachename => time});
1.379 matthew 9683: }
9684:
1.28 www 9685: # --------------------------------------------------------- Value of a Variable
1.58 www 9686: sub EXT {
1.715 albertel 9687:
1.1228 raeburn 9688: my ($varname,$symbparm,$udom,$uname,$usection,$recurse,$cid)=@_;
1.68 www 9689: unless ($varname) { return ''; }
1.218 albertel 9690: #get real user name/domain, courseid and symb
9691: my $courseid;
1.359 albertel 9692: my $publicuser;
1.427 www 9693: if ($symbparm) {
9694: $symbparm=&get_symb_from_alias($symbparm);
9695: }
1.218 albertel 9696: if (!($uname && $udom)) {
1.790 albertel 9697: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 9698: if (!$symbparm) { $symbparm=$cursymb; }
9699: } else {
1.620 albertel 9700: $courseid=$env{'request.course.id'};
1.218 albertel 9701: }
1.48 www 9702: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
9703: my $rest;
1.320 albertel 9704: if (defined($therest[0])) {
1.48 www 9705: $rest=join('.',@therest);
9706: } else {
9707: $rest='';
9708: }
1.320 albertel 9709:
1.57 www 9710: my $qualifierrest=$qualifier;
9711: if ($rest) { $qualifierrest.='.'.$rest; }
9712: my $spacequalifierrest=$space;
9713: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 9714: if ($realm eq 'user') {
1.48 www 9715: # --------------------------------------------------------------- user.resource
9716: if ($space eq 'resource') {
1.651 albertel 9717: if ( (defined($Apache::lonhomework::parsing_a_problem)
9718: || defined($Apache::lonhomework::parsing_a_task))
9719: &&
1.744 albertel 9720: ($symbparm eq &symbread()) ) {
9721: # if we are in the middle of processing the resource the
9722: # get the value we are planning on committing
9723: if (defined($Apache::lonhomework::results{$qualifierrest})) {
9724: return $Apache::lonhomework::results{$qualifierrest};
9725: } else {
9726: return $Apache::lonhomework::history{$qualifierrest};
9727: }
1.335 albertel 9728: } else {
1.359 albertel 9729: my %restored;
1.620 albertel 9730: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 9731: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
9732: } else {
9733: %restored=&restore($symbparm,$courseid,$udom,$uname);
9734: }
1.335 albertel 9735: return $restored{$qualifierrest};
9736: }
1.48 www 9737: # ----------------------------------------------------------------- user.access
9738: } elsif ($space eq 'access') {
1.218 albertel 9739: # FIXME - not supporting calls for a specific user
1.48 www 9740: return &allowed($qualifier,$rest);
9741: # ------------------------------------------ user.preferences, user.environment
9742: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 9743: if (($uname eq $env{'user.name'}) &&
9744: ($udom eq $env{'user.domain'})) {
9745: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 9746: } else {
1.359 albertel 9747: my %returnhash;
9748: if (!$publicuser) {
9749: %returnhash=&userenvironment($udom,$uname,
9750: $qualifierrest);
9751: }
1.218 albertel 9752: return $returnhash{$qualifierrest};
9753: }
1.48 www 9754: # ----------------------------------------------------------------- user.course
9755: } elsif ($space eq 'course') {
1.218 albertel 9756: # FIXME - not supporting calls for a specific user
1.620 albertel 9757: return $env{join('.',('request.course',$qualifier))};
1.48 www 9758: # ------------------------------------------------------------------- user.role
9759: } elsif ($space eq 'role') {
1.218 albertel 9760: # FIXME - not supporting calls for a specific user
1.620 albertel 9761: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 9762: if ($qualifier eq 'value') {
9763: return $role;
9764: } elsif ($qualifier eq 'extent') {
9765: return $where;
9766: }
9767: # ----------------------------------------------------------------- user.domain
9768: } elsif ($space eq 'domain') {
1.218 albertel 9769: return $udom;
1.48 www 9770: # ------------------------------------------------------------------- user.name
9771: } elsif ($space eq 'name') {
1.218 albertel 9772: return $uname;
1.48 www 9773: # ---------------------------------------------------- Any other user namespace
1.29 www 9774: } else {
1.359 albertel 9775: my %reply;
9776: if (!$publicuser) {
9777: %reply=&get($space,[$qualifierrest],$udom,$uname);
9778: }
9779: return $reply{$qualifierrest};
1.48 www 9780: }
1.236 www 9781: } elsif ($realm eq 'query') {
9782: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 9783: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
9784: [$spacequalifierrest]);
1.620 albertel 9785: return $env{'form.'.$spacequalifierrest};
1.236 www 9786: } elsif ($realm eq 'request') {
1.48 www 9787: # ------------------------------------------------------------- request.browser
9788: if ($space eq 'browser') {
1.1145 bisitz 9789: return $env{'browser.'.$qualifier};
1.57 www 9790: # ------------------------------------------------------------ request.filename
9791: } else {
1.620 albertel 9792: return $env{'request.'.$spacequalifierrest};
1.29 www 9793: }
1.28 www 9794: } elsif ($realm eq 'course') {
1.48 www 9795: # ---------------------------------------------------------- course.description
1.620 albertel 9796: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 9797: } elsif ($realm eq 'resource') {
1.165 www 9798:
1.620 albertel 9799: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 9800: if (!$symbparm) { $symbparm=&symbread(); }
9801: }
1.693 albertel 9802:
1.1232 raeburn 9803: if ($qualifier eq '') {
9804: if ($space eq 'title') {
9805: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
9806: return &gettitle($symbparm);
9807: }
1.693 albertel 9808:
1.1232 raeburn 9809: if ($space eq 'map') {
9810: my ($map) = &decode_symb($symbparm);
9811: return &symbread($map);
9812: }
9813: if ($space eq 'maptitle') {
9814: my ($map) = &decode_symb($symbparm);
9815: return &gettitle($map);
9816: }
9817: if ($space eq 'filename') {
9818: if ($symbparm) {
9819: return &clutter((&decode_symb($symbparm))[2]);
9820: }
9821: return &hreflocation('',$env{'request.filename'});
1.905 albertel 9822: }
1.1232 raeburn 9823:
1.1233 raeburn 9824: if ((defined($courseid)) && ($courseid eq $env{'request.course.id'}) && $symbparm) {
9825: if ($space eq 'visibleparts') {
9826: my $navmap = Apache::lonnavmaps::navmap->new();
9827: my $item;
9828: if (ref($navmap)) {
9829: my $res = $navmap->getBySymb($symbparm);
9830: my $parts = $res->parts();
9831: if (ref($parts) eq 'ARRAY') {
9832: $item = join(',',@{$parts});
9833: }
9834: undef($navmap);
1.1232 raeburn 9835: }
1.1233 raeburn 9836: return $item;
1.1232 raeburn 9837: }
9838: }
9839: }
1.693 albertel 9840:
9841: my ($section, $group, @groups);
1.593 albertel 9842: my ($courselevelm,$courselevel);
1.1228 raeburn 9843: if (($courseid eq '') && ($cid)) {
9844: $courseid = $cid;
9845: }
9846: if (($symbparm && $courseid) &&
9847: (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
1.165 www 9848:
1.218 albertel 9849: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 9850:
1.60 www 9851: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 9852: my $symbp=$symbparm;
1.735 albertel 9853: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 9854:
9855: my $symbparm=$symbp.'.'.$spacequalifierrest;
9856: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
9857:
1.620 albertel 9858: if (($env{'user.name'} eq $uname) &&
9859: ($env{'user.domain'} eq $udom)) {
9860: $section=$env{'request.course.sec'};
1.733 raeburn 9861: @groups = split(/:/,$env{'request.course.groups'});
9862: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 9863: } else {
1.539 albertel 9864: if (! defined($usection)) {
1.551 albertel 9865: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 9866: } else {
9867: $section = $usection;
9868: }
1.733 raeburn 9869: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 9870: }
9871:
9872: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
9873: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
9874: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
9875:
1.593 albertel 9876: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 9877: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 9878: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 9879:
1.60 www 9880: # ----------------------------------------------------------- first, check user
1.624 albertel 9881:
9882: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 9883: ([$courselevelr,'resource'],
9884: [$courselevelm,'map' ],
9885: [$courselevel, 'course' ]));
1.931 albertel 9886: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 9887:
1.594 albertel 9888: # ------------------------------------------------ second, check some of course
1.684 raeburn 9889: my $coursereply;
1.691 raeburn 9890: if (@groups > 0) {
9891: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
9892: $mapparm,$spacequalifierrest);
1.927 albertel 9893: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 9894: }
1.96 www 9895:
1.684 raeburn 9896: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 9897: $env{'course.'.$courseid.'.domain'},
9898: 'course',
9899: ([$seclevelr, 'resource'],
9900: [$seclevelm, 'map' ],
9901: [$seclevel, 'course' ],
9902: [$courselevelr,'resource']));
9903: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 9904:
1.60 www 9905: # ------------------------------------------------------ third, check map parms
1.218 albertel 9906: my %parmhash=();
9907: my $thisparm='';
9908: if (tie(%parmhash,'GDBM_File',
1.620 albertel 9909: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 9910: &GDBM_READER(),0640)) {
1.218 albertel 9911: $thisparm=$parmhash{$symbparm};
9912: untie(%parmhash);
9913: }
1.927 albertel 9914: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 9915: }
1.594 albertel 9916: # ------------------------------------------ fourth, look in resource metadata
1.71 www 9917:
1.218 albertel 9918: $spacequalifierrest=~s/\./\_/;
1.282 albertel 9919: my $filename;
9920: if (!$symbparm) { $symbparm=&symbread(); }
9921: if ($symbparm) {
1.409 www 9922: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 9923: } else {
1.620 albertel 9924: $filename=$env{'request.filename'};
1.282 albertel 9925: }
9926: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 9927: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 9928: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 9929: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 9930:
1.927 albertel 9931: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 9932: if ($symbparm && defined($courseid) &&
1.620 albertel 9933: $courseid eq $env{'request.course.id'}) {
1.624 albertel 9934: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
9935: $env{'course.'.$courseid.'.domain'},
9936: 'course',
1.927 albertel 9937: ([$courselevelm,'map' ],
9938: [$courselevel, 'course']));
9939: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 9940: }
1.145 www 9941: # ------------------------------------------------------------------ Cascade up
1.218 albertel 9942: unless ($space eq '0') {
1.336 albertel 9943: my @parts=split(/_/,$space);
9944: my $id=pop(@parts);
9945: my $part=join('_',@parts);
9946: if ($part eq '') { $part='0'; }
1.927 albertel 9947: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 9948: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 9949: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 9950: }
1.395 albertel 9951: if ($recurse) { return undef; }
9952: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 9953: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 9954: # ---------------------------------------------------- Any other user namespace
9955: } elsif ($realm eq 'environment') {
9956: # ----------------------------------------------------------------- environment
1.620 albertel 9957: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
9958: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 9959: } else {
1.770 albertel 9960: if ($uname eq 'anonymous' && $udom eq '') {
9961: return '';
9962: }
1.219 albertel 9963: my %returnhash=&userenvironment($udom,$uname,
9964: $spacequalifierrest);
9965: return $returnhash{$spacequalifierrest};
9966: }
1.28 www 9967: } elsif ($realm eq 'system') {
1.48 www 9968: # ----------------------------------------------------------------- system.time
9969: if ($space eq 'time') {
9970: return time;
9971: }
1.696 albertel 9972: } elsif ($realm eq 'server') {
9973: # ----------------------------------------------------------------- system.time
9974: if ($space eq 'name') {
9975: return $ENV{'SERVER_NAME'};
9976: }
1.28 www 9977: }
1.48 www 9978: return '';
1.61 www 9979: }
9980:
1.927 albertel 9981: sub get_reply {
9982: my ($reply_value) = @_;
1.940 raeburn 9983: if (ref($reply_value) eq 'ARRAY') {
9984: if (wantarray) {
9985: return @$reply_value;
9986: }
9987: return $reply_value->[0];
9988: } else {
9989: return $reply_value;
1.927 albertel 9990: }
9991: }
9992:
1.691 raeburn 9993: sub check_group_parms {
9994: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
9995: my @groupitems = ();
9996: my $resultitem;
1.927 albertel 9997: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 9998: foreach my $group (@{$groups}) {
9999: foreach my $level (@levels) {
1.927 albertel 10000: my $item = $courseid.'.['.$group.'].'.$level->[0];
10001: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 10002: }
10003: }
10004: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
10005: $env{'course.'.$courseid.'.domain'},
10006: 'course',@groupitems);
10007: return $coursereply;
10008: }
10009:
10010: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 10011: my ($courseid,@groups) = @_;
10012: @groups = sort(@groups);
1.691 raeburn 10013: return @groups;
10014: }
10015:
1.395 albertel 10016: sub packages_tab_default {
10017: my ($uri,$varname)=@_;
10018: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 10019:
10020: my (@extension,@specifics,$do_default);
10021: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 10022: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 10023: if ($pack_type eq 'default') {
10024: $do_default=1;
10025: } elsif ($pack_type eq 'extension') {
10026: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 10027: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 10028: # only look at packages defaults for packages that this id is
1.738 albertel 10029: push(@specifics,[$package,$pack_type,$pack_part]);
10030: }
10031: }
10032: # first look for a package that matches the requested part id
10033: foreach my $package (@specifics) {
10034: my (undef,$pack_type,$pack_part)=@{$package};
10035: next if ($pack_part ne $part);
10036: if (defined($packagetab{"$pack_type&$name&default"})) {
10037: return $packagetab{"$pack_type&$name&default"};
10038: }
10039: }
10040: # look for any possible matching non extension_ package
10041: foreach my $package (@specifics) {
10042: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 10043: if (defined($packagetab{"$pack_type&$name&default"})) {
10044: return $packagetab{"$pack_type&$name&default"};
10045: }
1.585 albertel 10046: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 10047: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
10048: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 10049: }
10050: }
1.738 albertel 10051: # look for any posible extension_ match
10052: foreach my $package (@extension) {
10053: my ($package,$pack_type)=@{$package};
10054: if (defined($packagetab{"$pack_type&$name&default"})) {
10055: return $packagetab{"$pack_type&$name&default"};
10056: }
10057: if (defined($packagetab{$package."&$name&default"})) {
10058: return $packagetab{$package."&$name&default"};
10059: }
10060: }
10061: # look for a global default setting
10062: if ($do_default && defined($packagetab{"default&$name&default"})) {
10063: return $packagetab{"default&$name&default"};
10064: }
1.395 albertel 10065: return undef;
10066: }
10067:
1.334 albertel 10068: sub add_prefix_and_part {
10069: my ($prefix,$part)=@_;
10070: my $keyroot;
10071: if (defined($prefix) && $prefix !~ /^__/) {
10072: # prefix that has a part already
10073: $keyroot=$prefix;
10074: } elsif (defined($prefix)) {
10075: # prefix that is missing a part
10076: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
10077: } else {
10078: # no prefix at all
10079: if (defined($part)) { $keyroot='_'.$part; }
10080: }
10081: return $keyroot;
10082: }
10083:
1.71 www 10084: # ---------------------------------------------------------------- Get metadata
10085:
1.599 albertel 10086: my %metaentry;
1.1070 www 10087: my %importedpartids;
1.71 www 10088: sub metadata {
1.176 www 10089: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 10090: $uri=&declutter($uri);
1.288 albertel 10091: # if it is a non metadata possible uri return quickly
1.529 albertel 10092: if (($uri eq '') ||
10093: (($uri =~ m|^/*adm/|) &&
1.1217 raeburn 10094: ($uri !~ m|^adm/includes|) && ($uri !~ m{/(smppg|bulletinboard)$})) ||
1.1108 raeburn 10095: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
1.924 albertel 10096: return undef;
10097: }
1.1140 www 10098: if (($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/)
1.924 albertel 10099: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 10100: return undef;
1.288 albertel 10101: }
1.73 www 10102: my $filename=$uri;
10103: $uri=~s/\.meta$//;
1.172 www 10104: #
10105: # Is the metadata already cached?
1.177 www 10106: # Look at timestamp of caching
1.172 www 10107: # Everything is cached by the main uri, libraries are never directly cached
10108: #
1.428 albertel 10109: if (!defined($liburi)) {
1.599 albertel 10110: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 10111: if (defined($cached)) { return $result->{':'.$what}; }
10112: }
10113: {
1.1069 www 10114: # Imported parts would go here
1.1070 www 10115: my %importedids=();
10116: my @origfileimportpartids=();
1.1069 www 10117: my $importedparts=0;
1.172 www 10118: #
10119: # Is this a recursive call for a library?
10120: #
1.599 albertel 10121: # if (! exists($metacache{$uri})) {
10122: # $metacache{$uri}={};
10123: # }
1.924 albertel 10124: my $cachetime = 60*60;
1.171 www 10125: if ($liburi) {
10126: $liburi=&declutter($liburi);
10127: $filename=$liburi;
1.401 bowersj2 10128: } else {
1.599 albertel 10129: &devalidate_cache_new('meta',$uri);
10130: undef(%metaentry);
1.401 bowersj2 10131: }
1.140 www 10132: my %metathesekeys=();
1.73 www 10133: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 10134: my $metastring;
1.1140 www 10135: if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
1.929 albertel 10136: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 10137: $metastring =
1.929 albertel 10138: &Apache::lonnet::ssi_body($which,
1.924 albertel 10139: ('grade_target' => 'meta'));
10140: $cachetime = 1; # only want this cached in the child not long term
1.1108 raeburn 10141: } elsif (($uri !~ m -^(editupload)/-) &&
10142: ($uri !~ m{^/*uploaded/$match_domain/$match_courseid/docs/})) {
1.543 albertel 10143: my $file=&filelocation('',&clutter($filename));
1.599 albertel 10144: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 10145: $metastring=&getfile($file);
1.489 albertel 10146: }
1.208 albertel 10147: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 10148: my $token;
1.140 www 10149: undef %metathesekeys;
1.71 www 10150: while ($token=$parser->get_token) {
1.339 albertel 10151: if ($token->[0] eq 'S') {
10152: if (defined($token->[2]->{'package'})) {
1.172 www 10153: #
10154: # This is a package - get package info
10155: #
1.339 albertel 10156: my $package=$token->[2]->{'package'};
10157: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10158: if (defined($token->[2]->{'id'})) {
10159: $keyroot.='_'.$token->[2]->{'id'};
10160: }
1.599 albertel 10161: if ($metaentry{':packages'}) {
10162: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 10163: } else {
1.599 albertel 10164: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 10165: }
1.736 albertel 10166: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 10167: my $part=$keyroot;
10168: $part=~s/^\_//;
1.736 albertel 10169: if ($pack_entry=~/^\Q$package\E\&/ ||
10170: $pack_entry=~/^\Q$package\E_0\&/) {
10171: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 10172: # ignore package.tab specified default values
10173: # here &package_tab_default() will fetch those
10174: if ($subp eq 'default') { next; }
1.736 albertel 10175: my $value=$packagetab{$pack_entry};
1.432 albertel 10176: my $unikey;
10177: if ($pack =~ /_0$/) {
10178: $unikey='parameter_0_'.$name;
10179: $part=0;
10180: } else {
10181: $unikey='parameter'.$keyroot.'_'.$name;
10182: }
1.339 albertel 10183: if ($subp eq 'display') {
10184: $value.=' [Part: '.$part.']';
10185: }
1.599 albertel 10186: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 10187: $metathesekeys{$unikey}=1;
1.599 albertel 10188: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10189: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 10190: }
1.599 albertel 10191: if (defined($metaentry{':'.$unikey.'.default'})) {
10192: $metaentry{':'.$unikey}=
10193: $metaentry{':'.$unikey.'.default'};
1.356 albertel 10194: }
1.339 albertel 10195: }
10196: }
10197: } else {
1.172 www 10198: #
10199: # This is not a package - some other kind of start tag
1.339 albertel 10200: #
10201: my $entry=$token->[1];
1.1068 www 10202: my $unikey='';
1.175 www 10203:
1.339 albertel 10204: if ($entry eq 'import') {
1.175 www 10205: #
10206: # Importing a library here
1.339 albertel 10207: #
1.1067 www 10208: my $location=$parser->get_text('/import');
10209: my $dir=$filename;
10210: $dir=~s|[^/]*$||;
10211: $location=&filelocation($dir,$location);
1.1069 www 10212:
1.1068 www 10213: my $importmode=$token->[2]->{'importmode'};
10214: if ($importmode eq 'problem') {
1.1069 www 10215: # Import as problem/response
1.1068 www 10216: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10217: } elsif ($importmode eq 'part') {
10218: # Import as part(s)
1.1069 www 10219: $importedparts=1;
10220: # We need to get the original file and the imported file to get the part order correct
10221: # Good news: we do not need to worry about nested libraries, since parts cannot be nested
10222: # Load and inspect original file
1.1070 www 10223: if ($#origfileimportpartids<0) {
10224: undef(%importedpartids);
10225: my $origfilelocation=$perlvar{'lonDocRoot'}.&clutter($uri);
10226: my $origfile=&getfile($origfilelocation);
10227: @origfileimportpartids=($origfile=~/<(part|import)[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10228: }
10229:
1.1069 www 10230: # Load and inspect imported file
10231: my $impfile=&getfile($location);
10232: my @impfilepartids=($impfile=~/<part[^>]*id\s*=\s*[\"\']([^\"\']+)[\"\'][^>]*>/gs);
10233: if ($#impfilepartids>=0) {
10234: # This problem had parts
1.1070 www 10235: $importedpartids{$token->[2]->{'id'}}=join(',',@impfilepartids);
1.1069 www 10236: } else {
10237: # Importing by turning a single problem into a problem part
10238: # It gets the import-tags ID as part-ID
10239: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'id'});
1.1070 www 10240: $importedpartids{$token->[2]->{'id'}}=$token->[2]->{'id'};
1.1069 www 10241: }
1.1068 www 10242: } else {
10243: # Normal import
10244: $unikey=&add_prefix_and_part($prefix,$token->[2]->{'part'});
10245: if (defined($token->[2]->{'id'})) {
10246: $unikey.='_'.$token->[2]->{'id'};
10247: }
1.1067 www 10248: }
10249:
1.339 albertel 10250: if ($depthcount<20) {
1.736 albertel 10251: my $metadata =
10252: &metadata($uri,'keys', $location,$unikey,
10253: $depthcount+1);
10254: foreach my $meta (split(',',$metadata)) {
10255: $metaentry{':'.$meta}=$metaentry{':'.$meta};
10256: $metathesekeys{$meta}=1;
1.339 albertel 10257: }
1.1068 www 10258:
10259: }
1.1067 www 10260: } else {
10261: #
10262: # Not importing, some other kind of non-package, non-library start tag
10263: #
10264: $unikey=$entry.&add_prefix_and_part($prefix,$token->[2]->{'part'});
10265: if (defined($token->[2]->{'id'})) {
10266: $unikey.='_'.$token->[2]->{'id'};
10267: }
1.339 albertel 10268: if (defined($token->[2]->{'name'})) {
10269: $unikey.='_'.$token->[2]->{'name'};
10270: }
10271: $metathesekeys{$unikey}=1;
1.736 albertel 10272: foreach my $param (@{$token->[3]}) {
10273: $metaentry{':'.$unikey.'.'.$param} =
10274: $token->[2]->{$param};
1.339 albertel 10275: }
10276: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 10277: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 10278: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
10279: # only ws inside the tag, and not in default, so use default
10280: # as value
1.599 albertel 10281: $metaentry{':'.$unikey}=$default;
1.908 albertel 10282: } elsif ( $internaltext =~ /\S/ ) {
10283: # something interesting inside the tag
10284: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 10285: } else {
1.908 albertel 10286: # no interesting values, don't set a default
1.339 albertel 10287: }
1.172 www 10288: # end of not-a-package not-a-library import
1.339 albertel 10289: }
1.172 www 10290: # end of not-a-package start tag
1.339 albertel 10291: }
1.172 www 10292: # the next is the end of "start tag"
1.339 albertel 10293: }
10294: }
1.483 albertel 10295: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 10296: $extension = lc($extension);
10297: if ($extension eq 'htm') { $extension='html'; }
10298:
1.737 albertel 10299: foreach my $key (keys(%packagetab)) {
1.483 albertel 10300: #no specific packages #how's our extension
10301: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 10302: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 10303: \%metathesekeys);
10304: }
1.883 albertel 10305:
10306: if (!exists($metaentry{':packages'})
10307: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 10308: foreach my $key (keys(%packagetab)) {
1.483 albertel 10309: #no specific packages well let's get default then
10310: if ($key!~/^default&/) { next; }
1.488 albertel 10311: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 10312: \%metathesekeys);
10313: }
10314: }
1.338 www 10315: # are there custom rights to evaluate
1.599 albertel 10316: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 10317:
1.338 www 10318: #
10319: # Importing a rights file here
1.339 albertel 10320: #
10321: unless ($depthcount) {
1.599 albertel 10322: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 10323: my $dir=$filename;
10324: $dir=~s|[^/]*$||;
10325: $location=&filelocation($dir,$location);
1.736 albertel 10326: my $rights_metadata =
10327: &metadata($uri,'keys',$location,'_rights',
10328: $depthcount+1);
10329: foreach my $rights (split(',',$rights_metadata)) {
10330: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
10331: $metathesekeys{$rights}=1;
1.339 albertel 10332: }
10333: }
10334: }
1.737 albertel 10335: # uniqifiy package listing
10336: my %seen;
10337: my @uniq_packages =
10338: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
10339: $metaentry{':packages'} = join(',',@uniq_packages);
10340:
1.1070 www 10341: if ($importedparts) {
10342: # We had imported parts and need to rebuild partorder
10343: $metaentry{':partorder'}='';
10344: $metathesekeys{'partorder'}=1;
10345: for (my $index=0;$index<$#origfileimportpartids;$index+=2) {
10346: if ($origfileimportpartids[$index] eq 'part') {
10347: # original part, part of the problem
10348: $metaentry{':partorder'}.=','.$origfileimportpartids[$index+1];
10349: } else {
10350: # we have imported parts at this position
10351: $metaentry{':partorder'}.=','.$importedpartids{$origfileimportpartids[$index+1]};
10352: }
10353: }
10354: $metaentry{':partorder'}=~s/^\,//;
10355: }
10356:
1.737 albertel 10357: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 10358: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
10359: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 10360: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 10361: # this is the end of "was not already recently cached
1.71 www 10362: }
1.599 albertel 10363: return $metaentry{':'.$what};
1.261 albertel 10364: }
10365:
1.488 albertel 10366: sub metadata_create_package_def {
1.483 albertel 10367: my ($uri,$key,$package,$metathesekeys)=@_;
10368: my ($pack,$name,$subp)=split(/\&/,$key);
10369: if ($subp eq 'default') { next; }
10370:
1.599 albertel 10371: if (defined($metaentry{':packages'})) {
10372: $metaentry{':packages'}.=','.$package;
1.483 albertel 10373: } else {
1.599 albertel 10374: $metaentry{':packages'}=$package;
1.483 albertel 10375: }
10376: my $value=$packagetab{$key};
10377: my $unikey;
10378: $unikey='parameter_0_'.$name;
1.599 albertel 10379: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 10380: $$metathesekeys{$unikey}=1;
1.599 albertel 10381: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
10382: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 10383: }
1.599 albertel 10384: if (defined($metaentry{':'.$unikey.'.default'})) {
10385: $metaentry{':'.$unikey}=
10386: $metaentry{':'.$unikey.'.default'};
1.483 albertel 10387: }
10388: }
10389:
1.261 albertel 10390: sub metadata_generate_part0 {
10391: my ($metadata,$metacache,$uri) = @_;
10392: my %allnames;
1.737 albertel 10393: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 10394: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 10395: my $part=$$metacache{':'.$metakey.'.part'};
10396: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 10397: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 10398: $allnames{$name}=$part;
10399: }
10400: }
10401: }
10402: foreach my $name (keys(%allnames)) {
10403: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 10404: my $key=":parameter_0_$name";
1.261 albertel 10405: $$metacache{"$key.part"}='0';
10406: $$metacache{"$key.name"}=$name;
1.428 albertel 10407: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 10408: $allnames{$name}.'_'.$name.
10409: '.type'};
1.428 albertel 10410: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 10411: '.display'};
1.644 www 10412: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 10413: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 10414: $$metacache{"$key.display"}=$olddis;
10415: }
1.71 www 10416: }
10417:
1.764 albertel 10418: # ------------------------------------------------------ Devalidate title cache
10419:
10420: sub devalidate_title_cache {
10421: my ($url)=@_;
10422: if (!$env{'request.course.id'}) { return; }
10423: my $symb=&symbread($url);
10424: if (!$symb) { return; }
10425: my $key=$env{'request.course.id'}."\0".$symb;
10426: &devalidate_cache_new('title',$key);
10427: }
10428:
1.1014 droeschl 10429: # ------------------------------------------------- Get the title of a course
10430:
10431: sub current_course_title {
10432: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
10433: }
1.301 www 10434: # ------------------------------------------------- Get the title of a resource
10435:
10436: sub gettitle {
10437: my $urlsymb=shift;
10438: my $symb=&symbread($urlsymb);
1.534 albertel 10439: if ($symb) {
1.620 albertel 10440: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 10441: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 10442: if (defined($cached)) {
10443: return $result;
10444: }
1.534 albertel 10445: my ($map,$resid,$url)=&decode_symb($symb);
10446: my $title='';
1.907 albertel 10447: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
10448: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
10449: } else {
10450: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
10451: &GDBM_READER(),0640)) {
10452: my $mapid=$bighash{'map_pc_'.&clutter($map)};
10453: $title=$bighash{'title_'.$mapid.'.'.$resid};
10454: untie(%bighash);
10455: }
1.534 albertel 10456: }
10457: $title=~s/\&colon\;/\:/gs;
10458: if ($title) {
1.1159 www 10459: # Remember both $symb and $title for dynamic metadata
10460: $accesshash{$symb.'___crstitle'}=$title;
1.1161 www 10461: $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
1.1159 www 10462: # Cache this title and then return it
1.599 albertel 10463: return &do_cache_new('title',$key,$title,600);
1.534 albertel 10464: }
10465: $urlsymb=$url;
10466: }
10467: my $title=&metadata($urlsymb,'title');
10468: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
10469: return $title;
1.301 www 10470: }
1.613 albertel 10471:
1.614 albertel 10472: sub get_slot {
10473: my ($which,$cnum,$cdom)=@_;
10474: if (!$cnum || !$cdom) {
1.790 albertel 10475: (undef,my $courseid)=&whichuser();
1.620 albertel 10476: $cdom=$env{'course.'.$courseid.'.domain'};
10477: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 10478: }
1.703 albertel 10479: my $key=join("\0",'slots',$cdom,$cnum,$which);
10480: my %slotinfo;
10481: if (exists($remembered{$key})) {
10482: $slotinfo{$which} = $remembered{$key};
10483: } else {
10484: %slotinfo=&get('slots',[$which],$cdom,$cnum);
10485: &Apache::lonhomework::showhash(%slotinfo);
10486: my ($tmp)=keys(%slotinfo);
10487: if ($tmp=~/^error:/) { return (); }
10488: $remembered{$key} = $slotinfo{$which};
10489: }
1.616 albertel 10490: if (ref($slotinfo{$which}) eq 'HASH') {
10491: return %{$slotinfo{$which}};
10492: }
10493: return $slotinfo{$which};
1.614 albertel 10494: }
1.1150 raeburn 10495:
10496: sub get_reservable_slots {
10497: my ($cnum,$cdom,$uname,$udom) = @_;
10498: my $now = time;
10499: my $reservable_info;
10500: my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
10501: if (exists($remembered{$key})) {
10502: $reservable_info = $remembered{$key};
10503: } else {
10504: my %resv;
10505: ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
10506: &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
10507: $reservable_info = \%resv;
10508: $remembered{$key} = $reservable_info;
10509: }
10510: return $reservable_info;
10511: }
10512:
10513: sub get_course_slots {
10514: my ($cnum,$cdom) = @_;
10515: my $hashid=$cnum.':'.$cdom;
10516: my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
10517: if (defined($cached)) {
10518: if (ref($result) eq 'HASH') {
10519: return %{$result};
10520: }
10521: } else {
10522: my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
10523: my ($tmp) = keys(%slots);
10524: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.1219 raeburn 10525: &do_cache_new('allslots',$hashid,\%slots,600);
1.1150 raeburn 10526: return %slots;
10527: }
10528: }
10529: return;
10530: }
10531:
10532: sub devalidate_slots_cache {
10533: my ($cnum,$cdom)=@_;
10534: my $hashid=$cnum.':'.$cdom;
10535: &devalidate_cache_new('allslots',$hashid);
10536: }
10537:
1.1181 raeburn 10538: sub get_coursechange {
10539: my ($cdom,$cnum) = @_;
10540: if ($cdom eq '' || $cnum eq '') {
10541: return unless ($env{'request.course.id'});
10542: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
10543: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
10544: }
10545: my $hashid=$cdom.'_'.$cnum;
10546: my ($change,$cached)=&is_cached_new('crschange',$hashid);
10547: if ((defined($cached)) && ($change ne '')) {
10548: return $change;
10549: } else {
10550: my %crshash;
10551: %crshash = &get('environment',['internal.contentchange'],$cdom,$cnum);
10552: if ($crshash{'internal.contentchange'} eq '') {
10553: $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
10554: if ($change eq '') {
10555: %crshash = &get('environment',['internal.created'],$cdom,$cnum);
10556: $change = $crshash{'internal.created'};
10557: }
10558: } else {
10559: $change = $crshash{'internal.contentchange'};
10560: }
10561: my $cachetime = 600;
10562: &do_cache_new('crschange',$hashid,$change,$cachetime);
10563: }
10564: return $change;
10565: }
10566:
10567: sub devalidate_coursechange_cache {
10568: my ($cnum,$cdom)=@_;
10569: my $hashid=$cnum.':'.$cdom;
10570: &devalidate_cache_new('crschange',$hashid);
10571: }
10572:
1.31 www 10573: # ------------------------------------------------- Update symbolic store links
10574:
10575: sub symblist {
10576: my ($mapname,%newhash)=@_;
1.438 www 10577: $mapname=&deversion(&declutter($mapname));
1.31 www 10578: my %hash;
1.620 albertel 10579: if (($env{'request.course.fn'}) && (%newhash)) {
10580: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 10581: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 10582: foreach my $url (keys(%newhash)) {
1.711 albertel 10583: next if ($url eq 'last_known'
10584: && $env{'form.no_update_last_known'});
10585: $hash{declutter($url)}=&encode_symb($mapname,
10586: $newhash{$url}->[1],
10587: $newhash{$url}->[0]);
1.191 harris41 10588: }
1.31 www 10589: if (untie(%hash)) {
10590: return 'ok';
10591: }
10592: }
10593: }
10594: return 'error';
1.212 www 10595: }
10596:
10597: # --------------------------------------------------------------- Verify a symb
10598:
10599: sub symbverify {
1.1190 raeburn 10600: my ($symb,$thisurl,$encstate)=@_;
1.510 www 10601: my $thisfn=$thisurl;
1.439 www 10602: $thisfn=&declutter($thisfn);
1.215 www 10603: # direct jump to resource in page or to a sequence - will construct own symbs
10604: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
10605: # check URL part
1.409 www 10606: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 10607:
1.431 www 10608: unless ($url eq $thisfn) { return 0; }
1.213 www 10609:
1.216 www 10610: $symb=&symbclean($symb);
1.510 www 10611: $thisurl=&deversion($thisurl);
1.439 www 10612: $thisfn=&deversion($thisfn);
1.213 www 10613:
10614: my %bighash;
10615: my $okay=0;
1.431 www 10616:
1.620 albertel 10617: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 10618: &GDBM_READER(),0640)) {
1.1204 raeburn 10619: my $noclutter;
1.1032 raeburn 10620: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
10621: $thisurl =~ s/\?.+$//;
1.1204 raeburn 10622: if ($map =~ m{^uploaded/.+\.page$}) {
10623: $thisurl =~ s{^(/adm/wrapper|)/ext/}{http://};
10624: $thisurl =~ s{^\Qhttp://https://\E}{https://};
10625: $noclutter = 1;
10626: }
10627: }
10628: my $ids;
10629: if ($noclutter) {
10630: $ids=$bighash{'ids_'.$thisurl};
10631: } else {
10632: $ids=$bighash{'ids_'.&clutter($thisurl)};
1.1032 raeburn 10633: }
1.1102 raeburn 10634: unless ($ids) {
10635: my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
10636: $ids=$bighash{$idkey};
1.216 www 10637: }
10638: if ($ids) {
10639: # ------------------------------------------------------------------- Has ID(s)
1.1202 raeburn 10640: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
1.1203 raeburn 10641: $symb =~ s/\?.+$//;
1.1202 raeburn 10642: }
1.800 albertel 10643: foreach my $id (split(/\,/,$ids)) {
10644: my ($mapid,$resid)=split(/\./,$id);
1.216 www 10645: if (
10646: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
1.1190 raeburn 10647: eq $symb) {
10648: if (ref($encstate)) {
10649: $$encstate = $bighash{'encrypted_'.$id};
10650: }
1.620 albertel 10651: if (($env{'request.role.adv'}) ||
1.1101 raeburn 10652: ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
10653: ($thisurl eq '/adm/navmaps')) {
1.1190 raeburn 10654: $okay=1;
1.1202 raeburn 10655: last;
1.582 albertel 10656: }
10657: }
1.216 www 10658: }
10659: }
1.213 www 10660: untie(%bighash);
10661: }
10662: return $okay;
1.31 www 10663: }
10664:
1.210 www 10665: # --------------------------------------------------------------- Clean-up symb
10666:
10667: sub symbclean {
10668: my $symb=shift;
1.568 albertel 10669: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 10670: # remove version from map
10671: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 10672:
1.210 www 10673: # remove version from URL
10674: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 10675:
1.507 www 10676: # remove wrapper
10677:
1.510 www 10678: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 10679: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 10680: return $symb;
1.409 www 10681: }
10682:
10683: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 10684:
10685: sub encode_symb {
10686: my ($map,$resid,$url)=@_;
10687: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
10688: }
1.409 www 10689:
10690: sub decode_symb {
1.568 albertel 10691: my $symb=shift;
10692: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
10693: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 10694: return (&fixversion($map),$resid,&fixversion($url));
10695: }
10696:
10697: sub fixversion {
10698: my $fn=shift;
1.609 banghart 10699: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 10700: my %bighash;
10701: my $uri=&clutter($fn);
1.620 albertel 10702: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 10703: # is this cached?
1.599 albertel 10704: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 10705: if (defined($cached)) { return $result; }
10706: # unfortunately not cached, or expired
1.620 albertel 10707: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 10708: &GDBM_READER(),0640)) {
10709: if ($bighash{'version_'.$uri}) {
10710: my $version=$bighash{'version_'.$uri};
1.444 www 10711: unless (($version eq 'mostrecent') ||
10712: ($version==&getversion($uri))) {
1.440 www 10713: $uri=~s/\.(\w+)$/\.$version\.$1/;
10714: }
10715: }
10716: untie %bighash;
1.413 www 10717: }
1.599 albertel 10718: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 10719: }
10720:
10721: sub deversion {
10722: my $url=shift;
10723: $url=~s/\.\d+\.(\w+)$/\.$1/;
10724: return $url;
1.210 www 10725: }
10726:
1.31 www 10727: # ------------------------------------------------------ Return symb list entry
10728:
10729: sub symbread {
1.249 www 10730: my ($thisfn,$donotrecurse)=@_;
1.1206 raeburn 10731: my $cache_str;
10732: if ($thisfn ne '') {
10733: $cache_str='request.symbread.cached.'.$thisfn;
10734: if ($env{$cache_str} ne '') {
1.1179 raeburn 10735: return $env{$cache_str};
10736: }
1.1206 raeburn 10737: } else {
1.242 www 10738: # no filename provided? try from environment
1.620 albertel 10739: if ($env{'request.symb'}) {
10740: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 10741: }
1.620 albertel 10742: $thisfn=$env{'request.filename'};
1.44 www 10743: }
1.569 albertel 10744: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 10745: # is that filename actually a symb? Verify, clean, and return
10746: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 10747: if (&symbverify($thisfn,$1)) {
1.620 albertel 10748: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 10749: }
1.242 www 10750: }
1.44 www 10751: $thisfn=declutter($thisfn);
1.31 www 10752: my %hash;
1.37 www 10753: my %bighash;
10754: my $syval='';
1.620 albertel 10755: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 10756: my $targetfn = $thisfn;
1.609 banghart 10757: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 10758: $targetfn = 'adm/wrapper/'.$thisfn;
10759: }
1.687 albertel 10760: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
10761: $targetfn=$1;
10762: }
1.620 albertel 10763: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 10764: &GDBM_READER(),0640)) {
1.481 raeburn 10765: $syval=$hash{$targetfn};
1.37 www 10766: untie(%hash);
10767: }
10768: # ---------------------------------------------------------- There was an entry
10769: if ($syval) {
1.601 albertel 10770: #unless ($syval=~/\_\d+$/) {
1.620 albertel 10771: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 10772: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 10773: #return $env{$cache_str}='';
1.601 albertel 10774: #}
10775: #$syval.=$1;
10776: #}
1.37 www 10777: } else {
10778: # ------------------------------------------------------- Was not in symb table
1.620 albertel 10779: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 10780: &GDBM_READER(),0640)) {
1.37 www 10781: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 10782: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 10783: unless ($ids) {
10784: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 10785: }
10786: unless ($ids) {
10787: # alias?
10788: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 10789: }
1.37 www 10790: if ($ids) {
10791: # ------------------------------------------------------------------- Has ID(s)
10792: my @possibilities=split(/\,/,$ids);
1.39 www 10793: if ($#possibilities==0) {
10794: # ----------------------------------------------- There is only one possibility
1.37 www 10795: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 10796: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10797: $resid,$thisfn);
1.249 www 10798: } elsif (!$donotrecurse) {
1.39 www 10799: # ------------------------------------------ There is more than one possibility
10800: my $realpossible=0;
1.800 albertel 10801: foreach my $id (@possibilities) {
10802: my $file=$bighash{'src_'.$id};
1.39 www 10803: if (&allowed('bre',$file)) {
1.800 albertel 10804: my ($mapid,$resid)=split(/\./,$id);
1.39 www 10805: if ($bighash{'map_type_'.$mapid} ne 'page') {
10806: $realpossible++;
1.626 albertel 10807: $syval=&encode_symb($bighash{'map_id_'.$mapid},
10808: $resid,$thisfn);
1.39 www 10809: }
10810: }
1.191 harris41 10811: }
1.39 www 10812: if ($realpossible!=1) { $syval=''; }
1.249 www 10813: } else {
10814: $syval='';
1.37 www 10815: }
10816: }
10817: untie(%bighash)
1.481 raeburn 10818: }
1.31 www 10819: }
1.62 www 10820: if ($syval) {
1.620 albertel 10821: return $env{$cache_str}=$syval;
1.62 www 10822: }
1.31 www 10823: }
1.949 raeburn 10824: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 10825: return $env{$cache_str}='';
1.31 www 10826: }
10827:
10828: # ---------------------------------------------------------- Return random seed
10829:
1.32 www 10830: sub numval {
10831: my $txt=shift;
10832: $txt=~tr/A-J/0-9/;
10833: $txt=~tr/a-j/0-9/;
10834: $txt=~tr/K-T/0-9/;
10835: $txt=~tr/k-t/0-9/;
10836: $txt=~tr/U-Z/0-5/;
10837: $txt=~tr/u-z/0-5/;
10838: $txt=~s/\D//g;
1.564 albertel 10839: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 10840: return int($txt);
1.368 albertel 10841: }
10842:
1.484 albertel 10843: sub numval2 {
10844: my $txt=shift;
10845: $txt=~tr/A-J/0-9/;
10846: $txt=~tr/a-j/0-9/;
10847: $txt=~tr/K-T/0-9/;
10848: $txt=~tr/k-t/0-9/;
10849: $txt=~tr/U-Z/0-5/;
10850: $txt=~tr/u-z/0-5/;
10851: $txt=~s/\D//g;
10852: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10853: my $total;
10854: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 10855: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 10856: return int($total);
10857: }
10858:
1.575 albertel 10859: sub numval3 {
10860: use integer;
10861: my $txt=shift;
10862: $txt=~tr/A-J/0-9/;
10863: $txt=~tr/a-j/0-9/;
10864: $txt=~tr/K-T/0-9/;
10865: $txt=~tr/k-t/0-9/;
10866: $txt=~tr/U-Z/0-5/;
10867: $txt=~tr/u-z/0-5/;
10868: $txt=~s/\D//g;
10869: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
10870: my $total;
10871: foreach my $val (@txts) { $total+=$val; }
10872: if ($_64bit) { $total=(($total<<32)>>32); }
10873: return $total;
10874: }
10875:
1.675 albertel 10876: sub digest {
10877: my ($data)=@_;
10878: my $digest=&Digest::MD5::md5($data);
10879: my ($a,$b,$c,$d)=unpack("iiii",$digest);
10880: my ($e,$f);
10881: {
10882: use integer;
10883: $e=($a+$b);
10884: $f=($c+$d);
10885: if ($_64bit) {
10886: $e=(($e<<32)>>32);
10887: $f=(($f<<32)>>32);
10888: }
10889: }
10890: if (wantarray) {
10891: return ($e,$f);
10892: } else {
10893: my $g;
10894: {
10895: use integer;
10896: $g=($e+$f);
10897: if ($_64bit) {
10898: $g=(($g<<32)>>32);
10899: }
10900: }
10901: return $g;
10902: }
10903: }
10904:
1.368 albertel 10905: sub latest_rnd_algorithm_id {
1.675 albertel 10906: return '64bit5';
1.366 albertel 10907: }
1.32 www 10908:
1.503 albertel 10909: sub get_rand_alg {
10910: my ($courseid)=@_;
1.790 albertel 10911: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 10912: if ($courseid) {
1.620 albertel 10913: return $env{"course.$courseid.rndseed"};
1.503 albertel 10914: }
10915: return &latest_rnd_algorithm_id();
10916: }
10917:
1.562 albertel 10918: sub validCODE {
10919: my ($CODE)=@_;
10920: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
10921: return 0;
10922: }
10923:
1.491 albertel 10924: sub getCODE {
1.620 albertel 10925: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 10926: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
10927: defined($Apache::lonhomework::parsing_a_task) ) &&
10928: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 10929: return $Apache::lonhomework::history{'resource.CODE'};
10930: }
10931: return undef;
10932: }
1.1133 foxr 10933: #
10934: # Determines the random seed for a specific context:
10935: #
10936: # parameters:
10937: # symb - in course context the symb for the seed.
10938: # course_id - The course id of the form domain_coursenum.
10939: # domain - Domain for the user.
10940: # course - Course for the user.
10941: # cenv - environment of the course.
10942: #
10943: # NOTE:
10944: # All parameters are picked out of the environment if missing
10945: # or not defined.
10946: # If a symb cannot be determined the current time is used instead.
10947: #
10948: # For a given well defined symb, courside, domain, username,
10949: # and course environment, the seed is reproducible.
10950: #
1.31 www 10951: sub rndseed {
1.1133 foxr 10952: my ($symb,$courseid,$domain,$username, $cenv)=@_;
1.790 albertel 10953: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 10954: if (!defined($symb)) {
1.366 albertel 10955: unless ($symb=$wsymb) { return time; }
10956: }
1.1146 foxr 10957: if (!defined $courseid) {
10958: $courseid=$wcourseid;
10959: }
10960: if (!defined $domain) { $domain=$wdomain; }
10961: if (!defined $username) { $username=$wusername }
1.1133 foxr 10962:
10963: my $which;
10964: if (defined($cenv->{'rndseed'})) {
10965: $which = $cenv->{'rndseed'};
10966: } else {
10967: $which =&get_rand_alg($courseid);
10968: }
1.491 albertel 10969: if (defined(&getCODE())) {
1.1133 foxr 10970:
1.675 albertel 10971: if ($which eq '64bit5') {
10972: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
10973: } elsif ($which eq '64bit4') {
1.575 albertel 10974: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
10975: } else {
10976: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
10977: }
1.675 albertel 10978: } elsif ($which eq '64bit5') {
10979: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 10980: } elsif ($which eq '64bit4') {
10981: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 10982: } elsif ($which eq '64bit3') {
10983: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 10984: } elsif ($which eq '64bit2') {
10985: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 10986: } elsif ($which eq '64bit') {
10987: return &rndseed_64bit($symb,$courseid,$domain,$username);
10988: }
10989: return &rndseed_32bit($symb,$courseid,$domain,$username);
10990: }
10991:
10992: sub rndseed_32bit {
10993: my ($symb,$courseid,$domain,$username)=@_;
10994: {
10995: use integer;
10996: my $symbchck=unpack("%32C*",$symb) << 27;
10997: my $symbseed=numval($symb) << 22;
10998: my $namechck=unpack("%32C*",$username) << 17;
10999: my $nameseed=numval($username) << 12;
11000: my $domainseed=unpack("%32C*",$domain) << 7;
11001: my $courseseed=unpack("%32C*",$courseid);
11002: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 11003: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11004: #&logthis("rndseed :$num:$symb");
1.564 albertel 11005: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 11006: return $num;
11007: }
11008: }
11009:
11010: sub rndseed_64bit {
11011: my ($symb,$courseid,$domain,$username)=@_;
11012: {
11013: use integer;
11014: my $symbchck=unpack("%32S*",$symb) << 21;
11015: my $symbseed=numval($symb) << 10;
11016: my $namechck=unpack("%32S*",$username);
11017:
11018: my $nameseed=numval($username) << 21;
11019: my $domainseed=unpack("%32S*",$domain) << 10;
11020: my $courseseed=unpack("%32S*",$courseid);
11021:
11022: my $num1=$symbchck+$symbseed+$namechck;
11023: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11024: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11025: #&logthis("rndseed :$num:$symb");
1.564 albertel 11026: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 11027: return "$num1,$num2";
1.155 albertel 11028: }
1.366 albertel 11029: }
11030:
1.443 albertel 11031: sub rndseed_64bit2 {
11032: my ($symb,$courseid,$domain,$username)=@_;
11033: {
11034: use integer;
11035: # strings need to be an even # of cahracters long, it it is odd the
11036: # last characters gets thrown away
11037: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11038: my $symbseed=numval($symb) << 10;
11039: my $namechck=unpack("%32S*",$username.' ');
11040:
11041: my $nameseed=numval($username) << 21;
1.501 albertel 11042: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11043: my $courseseed=unpack("%32S*",$courseid.' ');
11044:
11045: my $num1=$symbchck+$symbseed+$namechck;
11046: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11047: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11048: #&logthis("rndseed :$num:$symb");
1.803 albertel 11049: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 11050: return "$num1,$num2";
11051: }
11052: }
11053:
11054: sub rndseed_64bit3 {
11055: my ($symb,$courseid,$domain,$username)=@_;
11056: {
11057: use integer;
11058: # strings need to be an even # of cahracters long, it it is odd the
11059: # last characters gets thrown away
11060: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11061: my $symbseed=numval2($symb) << 10;
11062: my $namechck=unpack("%32S*",$username.' ');
11063:
11064: my $nameseed=numval2($username) << 21;
1.443 albertel 11065: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11066: my $courseseed=unpack("%32S*",$courseid.' ');
11067:
11068: my $num1=$symbchck+$symbseed+$namechck;
11069: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11070: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11071: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 11072: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 11073:
1.503 albertel 11074: return "$num1:$num2";
1.443 albertel 11075: }
11076: }
11077:
1.575 albertel 11078: sub rndseed_64bit4 {
11079: my ($symb,$courseid,$domain,$username)=@_;
11080: {
11081: use integer;
11082: # strings need to be an even # of cahracters long, it it is odd the
11083: # last characters gets thrown away
11084: my $symbchck=unpack("%32S*",$symb.' ') << 21;
11085: my $symbseed=numval3($symb) << 10;
11086: my $namechck=unpack("%32S*",$username.' ');
11087:
11088: my $nameseed=numval3($username) << 21;
11089: my $domainseed=unpack("%32S*",$domain.' ') << 10;
11090: my $courseseed=unpack("%32S*",$courseid.' ');
11091:
11092: my $num1=$symbchck+$symbseed+$namechck;
11093: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 11094: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
11095: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 11096: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.1110 www 11097:
1.575 albertel 11098: return "$num1:$num2";
11099: }
11100: }
11101:
1.675 albertel 11102: sub rndseed_64bit5 {
11103: my ($symb,$courseid,$domain,$username)=@_;
11104: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
11105: return "$num1:$num2";
11106: }
11107:
1.366 albertel 11108: sub rndseed_CODE_64bit {
11109: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 11110: {
1.366 albertel 11111: use integer;
1.443 albertel 11112: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 11113: my $symbseed=numval2($symb);
1.491 albertel 11114: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11115: my $CODEseed=numval(&getCODE());
1.443 albertel 11116: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 11117: my $num1=$symbseed+$CODEchck;
11118: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 11119: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11120: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 11121: if ($_64bit) { $num1=(($num1<<32)>>32); }
11122: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 11123: return "$num1:$num2";
1.366 albertel 11124: }
11125: }
11126:
1.575 albertel 11127: sub rndseed_CODE_64bit4 {
11128: my ($symb,$courseid,$domain,$username)=@_;
11129: {
11130: use integer;
11131: my $symbchck=unpack("%32S*",$symb.' ') << 16;
11132: my $symbseed=numval3($symb);
11133: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
11134: my $CODEseed=numval3(&getCODE());
11135: my $courseseed=unpack("%32S*",$courseid.' ');
11136: my $num1=$symbseed+$CODEchck;
11137: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 11138: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
11139: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 11140: if ($_64bit) { $num1=(($num1<<32)>>32); }
11141: if ($_64bit) { $num2=(($num2<<32)>>32); }
11142: return "$num1:$num2";
11143: }
11144: }
11145:
1.675 albertel 11146: sub rndseed_CODE_64bit5 {
11147: my ($symb,$courseid,$domain,$username)=@_;
11148: my $code = &getCODE();
11149: my ($num1,$num2)=&digest("$symb,$courseid,$code");
11150: return "$num1:$num2";
11151: }
11152:
1.366 albertel 11153: sub setup_random_from_rndseed {
11154: my ($rndseed)=@_;
1.503 albertel 11155: if ($rndseed =~/([,:])/) {
11156: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 11157: &Math::Random::random_set_seed(abs($num1),abs($num2));
11158: } else {
11159: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 11160: }
1.36 albertel 11161: }
11162:
1.474 albertel 11163: sub latest_receipt_algorithm_id {
1.835 albertel 11164: return 'receipt3';
1.474 albertel 11165: }
11166:
1.480 www 11167: sub recunique {
11168: my $fucourseid=shift;
11169: my $unique;
1.835 albertel 11170: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
11171: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 11172: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 11173: } else {
11174: $unique=$perlvar{'lonReceipt'};
11175: }
11176: return unpack("%32C*",$unique);
11177: }
11178:
11179: sub recprefix {
11180: my $fucourseid=shift;
11181: my $prefix;
1.835 albertel 11182: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
11183: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 11184: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 11185: } else {
11186: $prefix=$perlvar{'lonHostID'};
11187: }
11188: return unpack("%32C*",$prefix);
11189: }
11190:
1.76 www 11191: sub ireceipt {
1.474 albertel 11192: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 11193:
11194: my $return =&recprefix($fucourseid).'-';
11195:
11196: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
11197: $env{'request.state'} eq 'construct') {
11198: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
11199: return $return;
11200: }
11201:
1.76 www 11202: my $cuname=unpack("%32C*",$funame);
11203: my $cudom=unpack("%32C*",$fudom);
11204: my $cucourseid=unpack("%32C*",$fucourseid);
11205: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 11206: my $cunique=&recunique($fucourseid);
1.474 albertel 11207: my $cpart=unpack("%32S*",$part);
1.835 albertel 11208: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
11209:
1.790 albertel 11210: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 11211:
11212: $return.= ($cunique%$cuname+
11213: $cunique%$cudom+
11214: $cusymb%$cuname+
11215: $cusymb%$cudom+
11216: $cucourseid%$cuname+
11217: $cucourseid%$cudom+
11218: $cpart%$cuname+
11219: $cpart%$cudom);
11220: } else {
11221: $return.= ($cunique%$cuname+
11222: $cunique%$cudom+
11223: $cusymb%$cuname+
11224: $cusymb%$cudom+
11225: $cucourseid%$cuname+
11226: $cucourseid%$cudom);
11227: }
11228: return $return;
1.76 www 11229: }
11230:
11231: sub receipt {
1.474 albertel 11232: my ($part)=@_;
1.790 albertel 11233: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 11234: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 11235: }
1.260 ng 11236:
1.790 albertel 11237: sub whichuser {
11238: my ($passedsymb)=@_;
11239: my ($symb,$courseid,$domain,$name,$publicuser);
11240: if (defined($env{'form.grade_symb'})) {
11241: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
11242: my $allowed=&allowed('vgr',$tmp_courseid);
11243: if (!$allowed &&
11244: exists($env{'request.course.sec'}) &&
11245: $env{'request.course.sec'} !~ /^\s*$/) {
11246: $allowed=&allowed('vgr',$tmp_courseid.
11247: '/'.$env{'request.course.sec'});
11248: }
11249: if ($allowed) {
11250: ($symb)=&get_env_multiple('form.grade_symb');
11251: $courseid=$tmp_courseid;
11252: ($domain)=&get_env_multiple('form.grade_domain');
11253: ($name)=&get_env_multiple('form.grade_username');
11254: return ($symb,$courseid,$domain,$name,$publicuser);
11255: }
11256: }
11257: if (!$passedsymb) {
11258: $symb=&symbread();
11259: } else {
11260: $symb=$passedsymb;
11261: }
11262: $courseid=$env{'request.course.id'};
11263: $domain=$env{'user.domain'};
11264: $name=$env{'user.name'};
11265: if ($name eq 'public' && $domain eq 'public') {
11266: if (!defined($env{'form.username'})) {
11267: $env{'form.username'}.=time.rand(10000000);
11268: }
11269: $name.=$env{'form.username'};
11270: }
11271: return ($symb,$courseid,$domain,$name,$publicuser);
11272:
11273: }
11274:
1.36 albertel 11275: # ------------------------------------------------------------ Serves up a file
1.472 albertel 11276: # returns either the contents of the file or
11277: # -1 if the file doesn't exist
1.481 raeburn 11278: #
11279: # if the target is a file that was uploaded via DOCS,
11280: # a check will be made to see if a current copy exists on the local server,
11281: # if it does this will be served, otherwise a copy will be retrieved from
11282: # the home server for the course and stored in /home/httpd/html/userfiles on
11283: # the local server.
1.472 albertel 11284:
1.36 albertel 11285: sub getfile {
1.538 albertel 11286: my ($file) = @_;
1.609 banghart 11287: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 11288: &repcopy($file);
11289: return &readfile($file);
11290: }
11291:
11292: sub repcopy_userfile {
11293: my ($file)=@_;
1.1142 raeburn 11294: my $londocroot = $perlvar{'lonDocRoot'};
11295: if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
1.1164 raeburn 11296: if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
1.538 albertel 11297: my ($cdom,$cnum,$filename) =
1.811 albertel 11298: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 11299: my $uri="/uploaded/$cdom/$cnum/$filename";
11300: if (-e "$file") {
1.828 www 11301: # we already have a local copy, check it out
1.538 albertel 11302: my @fileinfo = stat($file);
1.828 www 11303: my $rtncode;
11304: my $info;
1.538 albertel 11305: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 11306: if ($lwpresp ne 'ok') {
1.828 www 11307: # there is no such file anymore, even though we had a local copy
1.482 albertel 11308: if ($rtncode eq '404') {
1.538 albertel 11309: unlink($file);
1.482 albertel 11310: }
11311: return -1;
11312: }
11313: if ($info < $fileinfo[9]) {
1.828 www 11314: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 11315: return 'ok';
1.828 www 11316: } else {
11317: # the file is outdated, get rid of it
11318: unlink($file);
1.482 albertel 11319: }
1.828 www 11320: }
11321: # one way or the other, at this point, we don't have the file
11322: # construct the correct path for the file
11323: my @parts = ($cdom,$cnum);
11324: if ($filename =~ m|^(.+)/[^/]+$|) {
11325: push @parts, split(/\//,$1);
11326: }
11327: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
11328: foreach my $part (@parts) {
11329: $path .= '/'.$part;
11330: if (!-e $path) {
11331: mkdir($path,0770);
1.482 albertel 11332: }
11333: }
1.828 www 11334: # now the path exists for sure
11335: # get a user agent
11336: my $ua=new LWP::UserAgent;
11337: my $transferfile=$file.'.in.transfer';
11338: # FIXME: this should flock
11339: if (-e $transferfile) { return 'ok'; }
11340: my $request;
11341: $uri=~s/^\///;
1.980 raeburn 11342: my $homeserver = &homeserver($cnum,$cdom);
11343: my $protocol = $protocol{$homeserver};
11344: $protocol = 'http' if ($protocol ne 'https');
11345: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 11346: my $response=$ua->request($request,$transferfile);
11347: # did it work?
11348: if ($response->is_error()) {
11349: unlink($transferfile);
11350: &logthis("Userfile repcopy failed for $uri");
11351: return -1;
11352: }
11353: # worked, rename the transfer file
11354: rename($transferfile,$file);
1.607 raeburn 11355: return 'ok';
1.481 raeburn 11356: }
11357:
1.517 albertel 11358: sub tokenwrapper {
11359: my $uri=shift;
1.980 raeburn 11360: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 11361: $uri=~s|^/||;
1.620 albertel 11362: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 11363: my $token=$1;
1.552 albertel 11364: my (undef,$udom,$uname,$file)=split('/',$uri,4);
11365: if ($udom && $uname && $file) {
11366: $file=~s|(\?\.*)*$||;
1.949 raeburn 11367: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 11368: my $homeserver = &homeserver($uname,$udom);
11369: my $protocol = $protocol{$homeserver};
11370: $protocol = 'http' if ($protocol ne 'https');
11371: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 11372: (($uri=~/\?/)?'&':'?').'token='.$token.
11373: '&tokenissued='.$perlvar{'lonHostID'};
11374: } else {
11375: return '/adm/notfound.html';
11376: }
11377: }
11378:
1.828 www 11379: # call with reqtype HEAD: get last modification time
11380: # call with reqtype GET: get the file contents
11381: # Do not call this with reqtype GET for large files! It loads everything into memory
11382: #
1.481 raeburn 11383: sub getuploaded {
11384: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
11385: $uri=~s/^\///;
1.980 raeburn 11386: my $homeserver = &homeserver($cnum,$cdom);
11387: my $protocol = $protocol{$homeserver};
11388: $protocol = 'http' if ($protocol ne 'https');
11389: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 11390: my $ua=new LWP::UserAgent;
11391: my $request=new HTTP::Request($reqtype,$uri);
11392: my $response=$ua->request($request);
11393: $$rtncode = $response->code;
1.482 albertel 11394: if (! $response->is_success()) {
11395: return 'failed';
11396: }
11397: if ($reqtype eq 'HEAD') {
1.486 www 11398: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 11399: } elsif ($reqtype eq 'GET') {
11400: $$info = $response->content;
1.472 albertel 11401: }
1.482 albertel 11402: return 'ok';
1.36 albertel 11403: }
11404:
1.481 raeburn 11405: sub readfile {
11406: my $file = shift;
11407: if ( (! -e $file ) || ($file eq '') ) { return -1; };
11408: my $fh;
11409: open($fh,"<$file");
11410: my $a='';
1.800 albertel 11411: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 11412: return $a;
11413: }
11414:
1.36 albertel 11415: sub filelocation {
1.590 banghart 11416: my ($dir,$file) = @_;
11417: my $location;
11418: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 11419:
11420: if ($file =~ m-^/adm/-) {
11421: $file=~s-^/adm/wrapper/-/-;
11422: $file=~s-^/adm/coursedocs/showdoc/-/-;
11423: }
1.882 albertel 11424:
1.1139 www 11425: if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
1.956 raeburn 11426: $location = $file;
1.609 banghart 11427: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 11428: my ($udom,$uname,$filename)=
1.811 albertel 11429: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 11430: my $home=&homeserver($uname,$udom);
11431: my $is_me=0;
11432: my @ids=¤t_machine_ids();
11433: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
11434: if ($is_me) {
1.1117 foxr 11435: $location=propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 11436: } else {
11437: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
11438: $udom.'/'.$uname.'/'.$filename;
11439: }
1.882 albertel 11440: } elsif ($file =~ m-^/adm/-) {
11441: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 11442: } else {
11443: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.1139 www 11444: $file=~s:^/(res|priv)/:/:;
11445: my $space=$1;
1.590 banghart 11446: if ( !( $file =~ m:^/:) ) {
11447: $location = $dir. '/'.$file;
11448: } else {
1.1142 raeburn 11449: $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
1.590 banghart 11450: }
1.59 albertel 11451: }
1.590 banghart 11452: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 11453: while ($location=~m{/\.\./}) {
11454: if ($location =~ m{/[^/]+/\.\./}) {
11455: $location=~ s{/[^/]+/\.\./}{/}g;
11456: } else {
11457: $location=~ s{/\.\./}{/}g;
11458: }
11459: } #remove dir/..
1.590 banghart 11460: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
11461: return $location;
1.46 www 11462: }
1.36 albertel 11463:
1.46 www 11464: sub hreflocation {
11465: my ($dir,$file)=@_;
1.980 raeburn 11466: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 11467: $file=filelocation($dir,$file);
1.700 albertel 11468: } elsif ($file=~m-^/adm/-) {
11469: $file=~s-^/adm/wrapper/-/-;
11470: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 11471: }
11472: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
11473: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
11474: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.1143 raeburn 11475: $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
11476: {/uploaded/$1/$2/}x;
1.46 www 11477: }
1.913 albertel 11478: if ($file=~ m{^/userfiles/}) {
11479: $file =~ s{^/userfiles/}{/uploaded/};
11480: }
1.462 albertel 11481: return $file;
1.465 albertel 11482: }
11483:
1.1139 www 11484:
11485:
11486:
11487:
1.465 albertel 11488: sub current_machine_domains {
1.853 albertel 11489: return &machine_domains(&hostname($perlvar{'lonHostID'}));
11490: }
11491:
11492: sub machine_domains {
11493: my ($hostname) = @_;
1.465 albertel 11494: my @domains;
1.838 albertel 11495: my %hostname = &all_hostnames();
1.465 albertel 11496: while( my($id, $name) = each(%hostname)) {
1.467 matthew 11497: # &logthis("-$id-$name-$hostname-");
1.465 albertel 11498: if ($hostname eq $name) {
1.844 albertel 11499: push(@domains,&host_domain($id));
1.465 albertel 11500: }
11501: }
11502: return @domains;
11503: }
11504:
11505: sub current_machine_ids {
1.853 albertel 11506: return &machine_ids(&hostname($perlvar{'lonHostID'}));
11507: }
11508:
11509: sub machine_ids {
11510: my ($hostname) = @_;
11511: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 11512: my @ids;
1.888 albertel 11513: my %name_to_host = &all_names();
1.889 albertel 11514: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
11515: return @{ $name_to_host{$hostname} };
11516: }
11517: return;
1.31 www 11518: }
11519:
1.824 raeburn 11520: sub additional_machine_domains {
11521: my @domains;
11522: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
11523: while( my $line = <$fh>) {
11524: $line =~ s/\s//g;
11525: push(@domains,$line);
11526: }
11527: return @domains;
11528: }
11529:
11530: sub default_login_domain {
11531: my $domain = $perlvar{'lonDefDomain'};
11532: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
11533: foreach my $posdom (¤t_machine_domains(),
11534: &additional_machine_domains()) {
11535: if (lc($posdom) eq lc($testdomain)) {
11536: $domain=$posdom;
11537: last;
11538: }
11539: }
11540: return $domain;
11541: }
11542:
1.31 www 11543: # ------------------------------------------------------------- Declutters URLs
11544:
11545: sub declutter {
11546: my $thisfn=shift;
1.569 albertel 11547: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 11548: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 11549: $thisfn=~s/^\///;
1.697 albertel 11550: $thisfn=~s|^adm/wrapper/||;
11551: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 11552: $thisfn=~s/^res\///;
1.1172 bisitz 11553: $thisfn=~s/^priv\///;
1.1032 raeburn 11554: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
11555: $thisfn=~s/\?.+$//;
11556: }
1.268 www 11557: return $thisfn;
11558: }
11559:
11560: # ------------------------------------------------------------- Clutter up URLs
11561:
11562: sub clutter {
11563: my $thisfn='/'.&declutter(shift);
1.887 albertel 11564: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 11565: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 11566: $thisfn='/res'.$thisfn;
11567: }
1.1031 raeburn 11568: if ($thisfn !~m|^/adm|) {
11569: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 11570: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 11571: } else {
11572: my ($ext) = ($thisfn =~ /\.(\w+)$/);
11573: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 11574: if ($embstyle eq 'ssi'
11575: || ($embstyle eq 'hdn')
11576: || ($embstyle eq 'rat')
11577: || ($embstyle eq 'prv')
11578: || ($embstyle eq 'ign')) {
11579: #do nothing with these
11580: } elsif (($embstyle eq 'img')
1.695 albertel 11581: || ($embstyle eq 'emb')
11582: || ($embstyle eq 'wrp')) {
11583: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 11584: } elsif ($embstyle eq 'unk'
11585: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 11586: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 11587: } else {
1.718 www 11588: # &logthis("Got a blank emb style");
1.695 albertel 11589: }
1.694 albertel 11590: }
11591: }
1.31 www 11592: return $thisfn;
1.12 www 11593: }
11594:
1.787 albertel 11595: sub clutter_with_no_wrapper {
11596: my $uri = &clutter(shift);
11597: if ($uri =~ m-^/adm/-) {
11598: $uri =~ s-^/adm/wrapper/-/-;
11599: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
11600: }
11601: return $uri;
11602: }
11603:
1.557 albertel 11604: sub freeze_escape {
11605: my ($value)=@_;
11606: if (ref($value)) {
11607: $value=&nfreeze($value);
11608: return '__FROZEN__'.&escape($value);
11609: }
11610: return &escape($value);
11611: }
11612:
1.11 www 11613:
1.557 albertel 11614: sub thaw_unescape {
11615: my ($value)=@_;
11616: if ($value =~ /^__FROZEN__/) {
11617: substr($value,0,10,undef);
11618: $value=&unescape($value);
11619: return &thaw($value);
11620: }
11621: return &unescape($value);
11622: }
11623:
1.436 albertel 11624: sub correct_line_ends {
11625: my ($result)=@_;
11626: $$result =~s/\r\n/\n/mg;
11627: $$result =~s/\r/\n/mg;
1.415 albertel 11628: }
1.1 albertel 11629: # ================================================================ Main Program
11630:
1.184 www 11631: sub goodbye {
1.204 albertel 11632: &logthis("Starting Shut down");
1.443 albertel 11633: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 11634: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 11635: #converted
1.599 albertel 11636: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 11637: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
11638: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
11639: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 11640: #1.1 only
1.870 albertel 11641: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
11642: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
11643: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
11644: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
11645: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 11646: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
11647: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 11648: &flushcourselogs();
11649: &logthis("Shutting down");
11650: }
11651:
1.852 albertel 11652: sub get_dns {
1.1210 raeburn 11653: my ($url,$func,$ignore_cache,$nocache,$hashref) = @_;
1.869 albertel 11654: if (!$ignore_cache) {
11655: my ($content,$cached)=
11656: &Apache::lonnet::is_cached_new('dns',$url);
11657: if ($cached) {
1.1210 raeburn 11658: &$func($content,$hashref);
1.869 albertel 11659: return;
11660: }
11661: }
11662:
11663: my %alldns;
1.852 albertel 11664: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
11665: foreach my $dns (<$config>) {
11666: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 11667: my $line = $1;
11668: my ($host,$protocol) = split(/:/,$line);
11669: if ($protocol ne 'https') {
11670: $protocol = 'http';
11671: }
11672: $alldns{$host} = $protocol;
1.869 albertel 11673: }
11674: while (%alldns) {
11675: my ($dns) = keys(%alldns);
1.852 albertel 11676: my $ua=new LWP::UserAgent;
1.1134 raeburn 11677: $ua->timeout(30);
1.979 raeburn 11678: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 11679: my $response=$ua->request($request);
1.979 raeburn 11680: delete($alldns{$dns});
1.852 albertel 11681: next if ($response->is_error());
11682: my @content = split("\n",$response->content);
1.1210 raeburn 11683: unless ($nocache) {
1.1219 raeburn 11684: &do_cache_new('dns',$url,\@content,30*24*60*60);
1.1210 raeburn 11685: }
11686: &$func(\@content,$hashref);
1.869 albertel 11687: return;
1.852 albertel 11688: }
11689: close($config);
1.871 albertel 11690: my $which = (split('/',$url))[3];
11691: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
11692: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 11693: my @content = <$config>;
1.1210 raeburn 11694: &$func(\@content,$hashref);
11695: return;
11696: }
11697:
11698: # ------------------------------------------------------Get DNS checksums file
1.1211 raeburn 11699: sub parse_dns_checksums_tab {
1.1210 raeburn 11700: my ($lines,$hashref) = @_;
11701: my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
11702: my $loncaparev = &get_server_loncaparev($machine_dom);
11703: my ($release,$timestamp) = split(/\-/,$loncaparev);
11704: my (%chksum,%revnum);
11705: if (ref($lines) eq 'ARRAY') {
11706: chomp(@{$lines});
11707: my $versions = shift(@{$lines});
11708: my %supported;
11709: if ($versions =~ /^VERSIONS\:([\w\.\,]+)$/) {
11710: my $releaseslist = $1;
11711: if ($releaseslist =~ /,/) {
11712: map { $supported{$_} = 1; } split(/,/,$releaseslist);
11713: } elsif ($releaseslist) {
11714: $supported{$releaseslist} = 1;
11715: }
11716: }
11717: if ($supported{$release}) {
11718: my $matchthis = 0;
11719: foreach my $line (@{$lines}) {
11720: if ($line =~ /^(\d[\w\.]+)$/) {
11721: if ($matchthis) {
11722: last;
11723: } elsif ($1 eq $release) {
11724: $matchthis = 1;
11725: }
11726: } elsif ($matchthis) {
11727: my ($file,$version,$shasum) = split(/,/,$line);
11728: $chksum{$file} = $shasum;
11729: $revnum{$file} = $version;
11730: }
11731: }
11732: if (ref($hashref) eq 'HASH') {
11733: %{$hashref} = (
11734: sums => \%chksum,
11735: versions => \%revnum,
11736: );
11737: }
11738: }
11739: }
1.869 albertel 11740: return;
1.852 albertel 11741: }
1.1210 raeburn 11742:
11743: sub fetch_dns_checksums {
11744: my %checksums;
1.1211 raeburn 11745: &get_dns('/adm/dns/checksums',\&parse_dns_checksums_tab,1,1,
11746: \%checksums);
1.1210 raeburn 11747: return \%checksums;
11748: }
11749:
1.327 albertel 11750: # ------------------------------------------------------------ Read domain file
11751: {
1.852 albertel 11752: my $loaded;
1.846 albertel 11753: my %domain;
11754:
1.852 albertel 11755: sub parse_domain_tab {
11756: my ($lines) = @_;
11757: foreach my $line (@$lines) {
11758: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 11759:
1.846 albertel 11760: chomp($line);
1.852 albertel 11761: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 11762: my %this_domain;
11763: foreach my $field ('description', 'auth_def', 'auth_arg_def',
11764: 'lang_def', 'city', 'longi', 'lati',
11765: 'primary') {
11766: $this_domain{$field} = shift(@elements);
11767: }
11768: $domain{$name} = \%this_domain;
1.852 albertel 11769: }
11770: }
1.864 albertel 11771:
11772: sub reset_domain_info {
11773: undef($loaded);
11774: undef(%domain);
11775: }
11776:
1.852 albertel 11777: sub load_domain_tab {
1.869 albertel 11778: my ($ignore_cache) = @_;
11779: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 11780: my $fh;
11781: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
11782: my @lines = <$fh>;
11783: &parse_domain_tab(\@lines);
1.448 albertel 11784: }
1.852 albertel 11785: close($fh);
11786: $loaded = 1;
1.327 albertel 11787: }
1.846 albertel 11788:
11789: sub domain {
1.852 albertel 11790: &load_domain_tab() if (!$loaded);
11791:
1.846 albertel 11792: my ($name,$what) = @_;
11793: return if ( !exists($domain{$name}) );
11794:
11795: if (!$what) {
11796: return $domain{$name}{'description'};
11797: }
11798: return $domain{$name}{$what};
11799: }
1.974 raeburn 11800:
11801: sub domain_info {
11802: &load_domain_tab() if (!$loaded);
11803: return %domain;
11804: }
11805:
1.327 albertel 11806: }
11807:
11808:
1.1 albertel 11809: # ------------------------------------------------------------- Read hosts file
11810: {
1.838 albertel 11811: my %hostname;
1.844 albertel 11812: my %hostdom;
1.845 albertel 11813: my %libserv;
1.852 albertel 11814: my $loaded;
1.888 albertel 11815: my %name_to_host;
1.1074 raeburn 11816: my %internetdom;
1.1107 raeburn 11817: my %LC_dns_serv;
1.852 albertel 11818:
11819: sub parse_hosts_tab {
11820: my ($file) = @_;
11821: foreach my $configline (@$file) {
11822: next if ($configline =~ /^(\#|\s*$ )/x);
1.1107 raeburn 11823: chomp($configline);
11824: if ($configline =~ /^\^/) {
11825: if ($configline =~ /^\^([\w.\-]+)/) {
11826: $LC_dns_serv{$1} = 1;
11827: }
11828: next;
11829: }
1.1074 raeburn 11830: my ($id,$domain,$role,$name,$protocol,$intdom)=split(/:/,$configline);
1.852 albertel 11831: $name=~s/\s//g;
11832: if ($id && $domain && $role && $name) {
11833: $hostname{$id}=$name;
1.888 albertel 11834: push(@{$name_to_host{$name}}, $id);
1.852 albertel 11835: $hostdom{$id}=$domain;
11836: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 11837: if (defined($protocol)) {
11838: if ($protocol eq 'https') {
11839: $protocol{$id} = $protocol;
11840: } else {
11841: $protocol{$id} = 'http';
11842: }
1.968 raeburn 11843: } else {
1.969 raeburn 11844: $protocol{$id} = 'http';
1.968 raeburn 11845: }
1.1074 raeburn 11846: if (defined($intdom)) {
11847: $internetdom{$id} = $intdom;
11848: }
1.852 albertel 11849: }
11850: }
11851: }
1.864 albertel 11852:
11853: sub reset_hosts_info {
1.897 albertel 11854: &purge_remembered();
1.864 albertel 11855: &reset_domain_info();
11856: &reset_hosts_ip_info();
1.892 albertel 11857: undef(%name_to_host);
1.864 albertel 11858: undef(%hostname);
11859: undef(%hostdom);
11860: undef(%libserv);
11861: undef($loaded);
11862: }
1.1 albertel 11863:
1.852 albertel 11864: sub load_hosts_tab {
1.869 albertel 11865: my ($ignore_cache) = @_;
11866: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 11867: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
11868: my @config = <$config>;
11869: &parse_hosts_tab(\@config);
11870: close($config);
11871: $loaded=1;
1.1 albertel 11872: }
1.852 albertel 11873:
1.838 albertel 11874: sub hostname {
1.852 albertel 11875: &load_hosts_tab() if (!$loaded);
11876:
1.838 albertel 11877: my ($lonid) = @_;
11878: return $hostname{$lonid};
11879: }
1.845 albertel 11880:
1.838 albertel 11881: sub all_hostnames {
1.852 albertel 11882: &load_hosts_tab() if (!$loaded);
11883:
1.838 albertel 11884: return %hostname;
11885: }
1.845 albertel 11886:
1.888 albertel 11887: sub all_names {
11888: &load_hosts_tab() if (!$loaded);
11889:
11890: return %name_to_host;
11891: }
11892:
1.974 raeburn 11893: sub all_host_domain {
11894: &load_hosts_tab() if (!$loaded);
11895: return %hostdom;
11896: }
11897:
1.845 albertel 11898: sub is_library {
1.852 albertel 11899: &load_hosts_tab() if (!$loaded);
11900:
1.845 albertel 11901: return exists($libserv{$_[0]});
11902: }
11903:
11904: sub all_library {
1.852 albertel 11905: &load_hosts_tab() if (!$loaded);
11906:
1.845 albertel 11907: return %libserv;
11908: }
11909:
1.1062 droeschl 11910: sub unique_library {
11911: #2x reverse removes all hostnames that appear more than once
11912: my %unique = reverse &all_library();
11913: return reverse %unique;
11914: }
11915:
1.841 albertel 11916: sub get_servers {
1.852 albertel 11917: &load_hosts_tab() if (!$loaded);
11918:
1.841 albertel 11919: my ($domain,$type) = @_;
11920: my %possible_hosts = ($type eq 'library') ? %libserv
11921: : %hostname;
11922: my %result;
1.842 albertel 11923: if (ref($domain) eq 'ARRAY') {
11924: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 11925: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 11926: $result{$host} = $hostname;
11927: }
11928: }
11929: } else {
11930: while ( my ($host,$hostname) = each(%possible_hosts)) {
11931: if ($hostdom{$host} eq $domain) {
11932: $result{$host} = $hostname;
11933: }
1.841 albertel 11934: }
11935: }
11936: return %result;
11937: }
1.845 albertel 11938:
1.1062 droeschl 11939: sub get_unique_servers {
11940: my %unique = reverse &get_servers(@_);
11941: return reverse %unique;
11942: }
11943:
1.844 albertel 11944: sub host_domain {
1.852 albertel 11945: &load_hosts_tab() if (!$loaded);
11946:
1.844 albertel 11947: my ($lonid) = @_;
11948: return $hostdom{$lonid};
11949: }
11950:
1.841 albertel 11951: sub all_domains {
1.852 albertel 11952: &load_hosts_tab() if (!$loaded);
11953:
1.841 albertel 11954: my %seen;
11955: my @uniq = grep(!$seen{$_}++, values(%hostdom));
11956: return @uniq;
11957: }
1.1074 raeburn 11958:
11959: sub internet_dom {
11960: &load_hosts_tab() if (!$loaded);
11961:
11962: my ($lonid) = @_;
11963: return $internetdom{$lonid};
11964: }
1.1107 raeburn 11965:
11966: sub is_LC_dns {
11967: &load_hosts_tab() if (!$loaded);
11968:
11969: my ($hostname) = @_;
11970: return exists($LC_dns_serv{$hostname});
11971: }
11972:
1.1 albertel 11973: }
11974:
1.847 albertel 11975: {
11976: my %iphost;
1.856 albertel 11977: my %name_to_ip;
11978: my %lonid_to_ip;
1.869 albertel 11979:
1.847 albertel 11980: sub get_hosts_from_ip {
11981: my ($ip) = @_;
11982: my %iphosts = &get_iphost();
11983: if (ref($iphosts{$ip})) {
11984: return @{$iphosts{$ip}};
11985: }
11986: return;
1.839 albertel 11987: }
1.864 albertel 11988:
11989: sub reset_hosts_ip_info {
11990: undef(%iphost);
11991: undef(%name_to_ip);
11992: undef(%lonid_to_ip);
11993: }
1.856 albertel 11994:
11995: sub get_host_ip {
11996: my ($lonid) = @_;
11997: if (exists($lonid_to_ip{$lonid})) {
11998: return $lonid_to_ip{$lonid};
11999: }
12000: my $name=&hostname($lonid);
12001: my $ip = gethostbyname($name);
12002: return if (!$ip || length($ip) ne 4);
12003: $ip=inet_ntoa($ip);
12004: $name_to_ip{$name} = $ip;
12005: $lonid_to_ip{$lonid} = $ip;
12006: return $ip;
12007: }
1.847 albertel 12008:
12009: sub get_iphost {
1.869 albertel 12010: my ($ignore_cache) = @_;
1.894 albertel 12011:
1.869 albertel 12012: if (!$ignore_cache) {
12013: if (%iphost) {
12014: return %iphost;
12015: }
12016: my ($ip_info,$cached)=
12017: &Apache::lonnet::is_cached_new('iphost','iphost');
12018: if ($cached) {
12019: %iphost = %{$ip_info->[0]};
12020: %name_to_ip = %{$ip_info->[1]};
12021: %lonid_to_ip = %{$ip_info->[2]};
12022: return %iphost;
12023: }
12024: }
1.894 albertel 12025:
12026: # get yesterday's info for fallback
12027: my %old_name_to_ip;
12028: my ($ip_info,$cached)=
12029: &Apache::lonnet::is_cached_new('iphost','iphost');
12030: if ($cached) {
12031: %old_name_to_ip = %{$ip_info->[1]};
12032: }
12033:
1.888 albertel 12034: my %name_to_host = &all_names();
12035: foreach my $name (keys(%name_to_host)) {
1.847 albertel 12036: my $ip;
12037: if (!exists($name_to_ip{$name})) {
12038: $ip = gethostbyname($name);
12039: if (!$ip || length($ip) ne 4) {
1.894 albertel 12040: if (defined($old_name_to_ip{$name})) {
12041: $ip = $old_name_to_ip{$name};
12042: &logthis("Can't find $name defaulting to old $ip");
12043: } else {
12044: &logthis("Name $name no IP found");
12045: next;
12046: }
12047: } else {
12048: $ip=inet_ntoa($ip);
1.847 albertel 12049: }
12050: $name_to_ip{$name} = $ip;
12051: } else {
12052: $ip = $name_to_ip{$name};
1.653 albertel 12053: }
1.888 albertel 12054: foreach my $id (@{ $name_to_host{$name} }) {
12055: $lonid_to_ip{$id} = $ip;
12056: }
12057: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 12058: }
1.1219 raeburn 12059: &do_cache_new('iphost','iphost',
12060: [\%iphost,\%name_to_ip,\%lonid_to_ip],
12061: 48*60*60);
1.869 albertel 12062:
1.847 albertel 12063: return %iphost;
1.598 albertel 12064: }
12065:
1.992 raeburn 12066: #
12067: # Given a DNS returns the loncapa host name for that DNS
12068: #
12069: sub host_from_dns {
12070: my ($dns) = @_;
12071: my @hosts;
12072: my $ip;
12073:
1.993 raeburn 12074: if (exists($name_to_ip{$dns})) {
1.992 raeburn 12075: $ip = $name_to_ip{$dns};
12076: }
12077: if (!$ip) {
12078: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
12079: if (length($ip) == 4) {
12080: $ip = &IO::Socket::inet_ntoa($ip);
12081: }
12082: }
12083: if ($ip) {
12084: @hosts = get_hosts_from_ip($ip);
12085: return $hosts[0];
12086: }
12087: return undef;
1.986 foxr 12088: }
1.992 raeburn 12089:
1.1074 raeburn 12090: sub get_internet_names {
12091: my ($lonid) = @_;
12092: return if ($lonid eq '');
12093: my ($idnref,$cached)=
12094: &Apache::lonnet::is_cached_new('internetnames',$lonid);
12095: if ($cached) {
12096: return $idnref;
12097: }
12098: my $ip = &get_host_ip($lonid);
12099: my @hosts = &get_hosts_from_ip($ip);
12100: my %iphost = &get_iphost();
12101: my (@idns,%seen);
12102: foreach my $id (@hosts) {
12103: my $dom = &host_domain($id);
12104: my $prim_id = &domain($dom,'primary');
12105: my $prim_ip = &get_host_ip($prim_id);
12106: next if ($seen{$prim_ip});
12107: if (ref($iphost{$prim_ip}) eq 'ARRAY') {
12108: foreach my $id (@{$iphost{$prim_ip}}) {
12109: my $intdom = &internet_dom($id);
12110: unless (grep(/^\Q$intdom\E$/,@idns)) {
12111: push(@idns,$intdom);
12112: }
12113: }
12114: }
12115: $seen{$prim_ip} = 1;
12116: }
1.1219 raeburn 12117: return &do_cache_new('internetnames',$lonid,\@idns,12*60*60);
1.1074 raeburn 12118: }
12119:
1.986 foxr 12120: }
12121:
1.1079 raeburn 12122: sub all_loncaparevs {
12123: 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);
12124: }
12125:
1.1227 raeburn 12126: # ---------------------------------------------------------- Read loncaparev table
12127: {
12128: sub load_loncaparevs {
12129: if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
12130: if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
12131: while (my $configline=<$config>) {
12132: chomp($configline);
12133: my ($hostid,$loncaparev)=split(/:/,$configline);
12134: $loncaparevs{$hostid}=$loncaparev;
12135: }
12136: close($config);
12137: }
12138: }
12139: }
12140: }
12141:
12142: # ---------------------------------------------------------- Read serverhostID table
12143: {
12144: sub load_serverhomeIDs {
12145: if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
12146: if (open(my $config,"<$perlvar{'lonTabDir'}/serverhomeIDs.tab")) {
12147: while (my $configline=<$config>) {
12148: chomp($configline);
12149: my ($name,$id)=split(/:/,$configline);
12150: $serverhomeIDs{$name}=$id;
12151: }
12152: close($config);
12153: }
12154: }
12155: }
12156: }
12157:
12158:
1.862 albertel 12159: BEGIN {
12160:
12161: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
12162: unless ($readit) {
12163: {
12164: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
12165: %perlvar = (%perlvar,%{$configvars});
12166: }
12167:
12168:
1.1 albertel 12169: # ------------------------------------------------------ Read spare server file
12170: {
1.448 albertel 12171: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 12172:
12173: while (my $configline=<$config>) {
12174: chomp($configline);
1.284 matthew 12175: if ($configline) {
1.784 albertel 12176: my ($host,$type) = split(':',$configline,2);
1.785 albertel 12177: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 12178: push(@{ $spareid{$type} }, $host);
1.1 albertel 12179: }
12180: }
1.448 albertel 12181: close($config);
1.1 albertel 12182: }
1.11 www 12183: # ------------------------------------------------------------ Read permissions
12184: {
1.448 albertel 12185: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 12186:
12187: while (my $configline=<$config>) {
1.448 albertel 12188: chomp($configline);
12189: if ($configline) {
12190: my ($role,$perm)=split(/ /,$configline);
12191: if ($perm ne '') { $pr{$role}=$perm; }
12192: }
1.11 www 12193: }
1.448 albertel 12194: close($config);
1.11 www 12195: }
12196:
12197: # -------------------------------------------- Read plain texts for permissions
12198: {
1.448 albertel 12199: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 12200:
12201: while (my $configline=<$config>) {
1.448 albertel 12202: chomp($configline);
12203: if ($configline) {
1.742 raeburn 12204: my ($short,@plain)=split(/:/,$configline);
12205: %{$prp{$short}} = ();
12206: if (@plain > 0) {
12207: $prp{$short}{'std'} = $plain[0];
12208: for (my $i=1; $i<@plain; $i++) {
12209: $prp{$short}{'alt'.$i} = $plain[$i];
12210: }
12211: }
1.448 albertel 12212: }
1.135 www 12213: }
1.448 albertel 12214: close($config);
1.135 www 12215: }
12216:
12217: # ---------------------------------------------------------- Read package table
12218: {
1.448 albertel 12219: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 12220:
12221: while (my $configline=<$config>) {
1.483 albertel 12222: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 12223: chomp($configline);
12224: my ($short,$plain)=split(/:/,$configline);
12225: my ($pack,$name)=split(/\&/,$short);
12226: if ($plain ne '') {
12227: $packagetab{$pack.'&'.$name.'&name'}=$name;
12228: $packagetab{$short}=$plain;
12229: }
1.11 www 12230: }
1.448 albertel 12231: close($config);
1.329 matthew 12232: }
12233:
1.1073 raeburn 12234: # ---------------------------------------------------------- Read loncaparev table
1.1227 raeburn 12235:
12236: &load_loncaparevs();
1.1073 raeburn 12237:
1.1074 raeburn 12238: # ---------------------------------------------------------- Read serverhostID table
12239:
1.1227 raeburn 12240: &load_serverhomeIDs();
12241:
12242: # ---------------------------------------------------------- Read releaseslist XML
1.1079 raeburn 12243: {
12244: my $file = $Apache::lonnet::perlvar{'lonTabDir'}.'/releaseslist.xml';
12245: if (-e $file) {
12246: my $parser = HTML::LCParser->new($file);
12247: while (my $token = $parser->get_token()) {
12248: if ($token->[0] eq 'S') {
12249: my $item = $token->[1];
12250: my $name = $token->[2]{'name'};
12251: my $value = $token->[2]{'value'};
12252: if ($item ne '' && $name ne '' && $value ne '') {
12253: my $release = $parser->get_text();
12254: $release =~ s/(^\s*|\s*$ )//gx;
12255: $needsrelease{$item.':'.$name.':'.$value} = $release;
12256: }
12257: }
12258: }
12259: }
1.1073 raeburn 12260: }
12261:
1.1138 raeburn 12262: # ---------------------------------------------------------- Read managers table
12263: {
12264: if (-e "$perlvar{'lonTabDir'}/managers.tab") {
12265: if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
12266: while (my $configline=<$config>) {
12267: chomp($configline);
12268: next if ($configline =~ /^\#/);
12269: if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
12270: $managerstab{$configline} = 1;
12271: }
12272: }
12273: close($config);
12274: }
12275: }
12276: }
12277:
1.329 matthew 12278: # ------------- set up temporary directory
12279: {
1.1117 foxr 12280: $tmpdir = LONCAPA::tempdir();
1.329 matthew 12281:
1.11 www 12282: }
12283:
1.794 albertel 12284: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
12285: 'compress_threshold'=> 20_000,
12286: });
1.185 www 12287:
1.281 www 12288: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 12289: $dumpcount=0;
1.958 www 12290: $locknum=0;
1.22 www 12291:
1.163 harris41 12292: &logtouch();
1.672 albertel 12293: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 12294: $readit=1;
1.564 albertel 12295: {
12296: use integer;
12297: my $test=(2**32)+1;
1.568 albertel 12298: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 12299: &logthis(" Detected 64bit platform ($_64bit)");
12300: }
1.1214 raeburn 12301:
12302: {
12303: eval {
12304: ($apache) =
12305: (Apache2::ServerUtil::get_server_version() =~ m{Apache/(\d+\.\d+)});
12306: };
12307: if ($@) {
12308: $apache = 1.3;
1.1213 raeburn 12309: }
12310: }
1.1214 raeburn 12311:
1.195 www 12312: }
1.1 albertel 12313: }
1.179 www 12314:
1.1 albertel 12315: 1;
1.191 harris41 12316: __END__
12317:
1.243 albertel 12318: =pod
12319:
1.191 harris41 12320: =head1 NAME
12321:
1.243 albertel 12322: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 12323:
12324: =head1 SYNOPSIS
12325:
1.243 albertel 12326: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 12327:
12328: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
12329:
1.243 albertel 12330: Common parameters:
12331:
12332: =over 4
12333:
12334: =item *
12335:
12336: $uname : an internal username (if $cname expecting a course Id specifically)
12337:
12338: =item *
12339:
12340: $udom : a domain (if $cdom expecting a course's domain specifically)
12341:
12342: =item *
12343:
12344: $symb : a resource instance identifier
12345:
12346: =item *
12347:
12348: $namespace : the name of a .db file that contains the data needed or
12349: being set.
12350:
12351: =back
12352:
1.394 bowersj2 12353: =head1 OVERVIEW
1.191 harris41 12354:
1.394 bowersj2 12355: lonnet provides subroutines which interact with the
12356: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
12357: about classes, users, and resources.
1.243 albertel 12358:
12359: For many of these objects you can also use this to store data about
12360: them or modify them in various ways.
1.191 harris41 12361:
1.394 bowersj2 12362: =head2 Symbs
1.191 harris41 12363:
1.394 bowersj2 12364: To identify a specific instance of a resource, LON-CAPA uses symbols
12365: or "symbs"X<symb>. These identifiers are built from the URL of the
12366: map, the resource number of the resource in the map, and the URL of
12367: the resource itself. The latter is somewhat redundant, but might help
12368: if maps change.
12369:
12370: An example is
12371:
12372: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
12373:
12374: The respective map entry is
12375:
12376: <resource id="19" src="/res/msu/korte/tests/part12.problem"
12377: title="Problem 2">
12378: </resource>
12379:
12380: Symbs are used by the random number generator, as well as to store and
12381: restore data specific to a certain instance of for example a problem.
12382:
12383: =head2 Storing And Retrieving Data
12384:
12385: X<store()>X<cstore()>X<restore()>Three of the most important functions
12386: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
12387: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
12388: is is the non-critical message twin of cstore. These functions are for
12389: handlers to store a perl hash to a user's permanent data space in an
12390: easy manner, and to retrieve it again on another call. It is expected
12391: that a handler would use this once at the beginning to retrieve data,
12392: and then again once at the end to send only the new data back.
12393:
12394: The data is stored in the user's data directory on the user's
12395: homeserver under the ID of the course.
12396:
12397: The hash that is returned by restore will have all of the previous
12398: value for all of the elements of the hash.
12399:
12400: Example:
12401:
12402: #creating a hash
12403: my %hash;
12404: $hash{'foo'}='bar';
12405:
12406: #storing it
12407: &Apache::lonnet::cstore(\%hash);
12408:
12409: #changing a value
12410: $hash{'foo'}='notbar';
12411:
12412: #adding a new value
12413: $hash{'bar'}='foo';
12414: &Apache::lonnet::cstore(\%hash);
12415:
12416: #retrieving the hash
12417: my %history=&Apache::lonnet::restore();
12418:
12419: #print the hash
12420: foreach my $key (sort(keys(%history))) {
12421: print("\%history{$key} = $history{$key}");
12422: }
12423:
12424: Will print out:
1.191 harris41 12425:
1.394 bowersj2 12426: %history{1:foo} = bar
12427: %history{1:keys} = foo:timestamp
12428: %history{1:timestamp} = 990455579
12429: %history{2:bar} = foo
12430: %history{2:foo} = notbar
12431: %history{2:keys} = foo:bar:timestamp
12432: %history{2:timestamp} = 990455580
12433: %history{bar} = foo
12434: %history{foo} = notbar
12435: %history{timestamp} = 990455580
12436: %history{version} = 2
12437:
12438: Note that the special hash entries C<keys>, C<version> and
12439: C<timestamp> were added to the hash. C<version> will be equal to the
12440: total number of versions of the data that have been stored. The
12441: C<timestamp> attribute will be the UNIX time the hash was
12442: stored. C<keys> is available in every historical section to list which
12443: keys were added or changed at a specific historical revision of a
12444: hash.
12445:
12446: B<Warning>: do not store the hash that restore returns directly. This
12447: will cause a mess since it will restore the historical keys as if the
12448: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 12449:
1.394 bowersj2 12450: Calling convention:
1.191 harris41 12451:
1.1225 raeburn 12452: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
12453: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname);
1.191 harris41 12454:
1.394 bowersj2 12455: For more detailed information, see lonnet specific documentation.
1.191 harris41 12456:
1.394 bowersj2 12457: =head1 RETURN MESSAGES
1.191 harris41 12458:
1.394 bowersj2 12459: =over 4
1.191 harris41 12460:
1.394 bowersj2 12461: =item * B<con_lost>: unable to contact remote host
1.191 harris41 12462:
1.394 bowersj2 12463: =item * B<con_delayed>: unable to contact remote host, message will be delivered
12464: when the connection is brought back up
1.191 harris41 12465:
1.394 bowersj2 12466: =item * B<con_failed>: unable to contact remote host and unable to save message
12467: for later delivery
1.191 harris41 12468:
1.967 bisitz 12469: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 12470:
1.394 bowersj2 12471: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 12472: that was requested
1.191 harris41 12473:
1.243 albertel 12474: =back
1.191 harris41 12475:
1.243 albertel 12476: =head1 PUBLIC SUBROUTINES
1.191 harris41 12477:
1.243 albertel 12478: =head2 Session Environment Functions
1.191 harris41 12479:
1.243 albertel 12480: =over 4
1.191 harris41 12481:
1.394 bowersj2 12482: =item *
12483: X<appenv()>
1.949 raeburn 12484: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 12485: the user envirnoment file, and will be restored for each access this
1.620 albertel 12486: user makes during this session, also modifies the %env for the current
1.949 raeburn 12487: process. Optional rolesarrayref - if defined contains a reference to an array
12488: of roles which are exempt from the restriction on modifying user.role entries
12489: in the user's environment.db and in %env.
1.191 harris41 12490:
12491: =item *
1.394 bowersj2 12492: X<delenv()>
1.987 raeburn 12493: B<delenv($delthis,$regexp)>: removes all items from the session
12494: environment file that begin with $delthis. If the
12495: optional second arg - $regexp - is true, $delthis is treated as a
12496: regular expression, otherwise \Q$delthis\E is used.
12497: The values are also deleted from the current processes %env.
1.191 harris41 12498:
1.795 albertel 12499: =item * get_env_multiple($name)
12500:
12501: gets $name from the %env hash, it seemlessly handles the cases where multiple
12502: values may be defined and end up as an array ref.
12503:
12504: returns an array of values
12505:
1.243 albertel 12506: =back
12507:
12508: =head2 User Information
1.191 harris41 12509:
1.243 albertel 12510: =over 4
1.191 harris41 12511:
12512: =item *
1.394 bowersj2 12513: X<queryauthenticate()>
12514: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 12515: authentication scheme
12516:
12517: =item *
1.394 bowersj2 12518: X<authenticate()>
1.1073 raeburn 12519: B<authenticate($uname,$upass,$udom,$checkdefauth,$clientcancheckhost)>: try to
1.394 bowersj2 12520: authenticate user from domain's lib servers (first use the current
12521: one). C<$upass> should be the users password.
1.1073 raeburn 12522: $checkdefauth is optional (value is 1 if a check should be made to
12523: authenticate user using default authentication method, and allow
12524: account creation if username does not have account in the domain).
12525: $clientcancheckhost is optional (value is 1 if checking whether the
12526: server can host will occur on the client side in lonauth.pm).
1.191 harris41 12527:
12528: =item *
1.394 bowersj2 12529: X<homeserver()>
12530: B<homeserver($uname,$udom)>: find the server which has
12531: the user's directory and files (there must be only one), this caches
12532: the answer, and also caches if there is a borken connection.
1.191 harris41 12533:
12534: =item *
1.394 bowersj2 12535: X<idget()>
12536: B<idget($udom,@ids)>: find the usernames behind a list of IDs
12537: (IDs are a unique resource in a domain, there must be only 1 ID per
12538: username, and only 1 username per ID in a specific domain) (returns
12539: hash: id=>name,id=>name)
1.191 harris41 12540:
12541: =item *
1.394 bowersj2 12542: X<idrget()>
12543: B<idrget($udom,@unames)>: find the IDs behind a list of
12544: usernames (returns hash: name=>id,name=>id)
1.191 harris41 12545:
12546: =item *
1.394 bowersj2 12547: X<idput()>
12548: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 12549:
12550: =item *
1.394 bowersj2 12551: X<rolesinit()>
1.1169 droeschl 12552: B<rolesinit($udom,$username)>: get user privileges.
12553: returns user role, first access and timer interval hashes
1.243 albertel 12554:
12555: =item *
1.1171 droeschl 12556: X<privileged()>
12557: B<privileged($username,$domain)>: returns a true if user has a
12558: privileged and active role (i.e. su or dc), false otherwise.
12559:
12560: =item *
1.551 albertel 12561: X<getsection()>
12562: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 12563: course $cname, return section name/number or '' for "not in course"
12564: and '-1' for "no section"
12565:
12566: =item *
1.394 bowersj2 12567: X<userenvironment()>
12568: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 12569: passed in @what from the requested user's environment, returns a hash
12570:
1.858 raeburn 12571: =item *
12572: X<userlog_query()>
1.859 albertel 12573: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
12574: activity.log file. %filters defines filters applied when parsing the
12575: log file. These can be start or end timestamps, or the type of action
12576: - log to look for Login or Logout events, check for Checkin or
12577: Checkout, role for role selection. The response is in the form
12578: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
12579: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 12580:
1.243 albertel 12581: =back
12582:
12583: =head2 User Roles
12584:
12585: =over 4
12586:
12587: =item *
12588:
1.810 raeburn 12589: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 12590: F: full access
12591: U,I,K: authentication modes (cxx only)
12592: '': forbidden
12593: 1: user needs to choose course
12594: 2: browse allowed
1.766 albertel 12595: A: passphrase authentication needed
1.243 albertel 12596:
12597: =item *
12598:
1.1192 raeburn 12599: constructaccess($url,$setpriv) : check for access to construction space URL
12600:
12601: See if the owner domain and name in the URL match those in the
12602: expected environment. If so, return three element list
12603: ($ownername,$ownerdomain,$ownerhome).
12604:
12605: Otherwise return the null string.
12606:
12607: If second argument 'setpriv' is true, it assigns the privileges,
12608: and returns the same three element list, unless the owner has
12609: blocked "ad hoc" Domain Coordinator access to the Author Space,
12610: in which case the null string is returned.
12611:
12612: =item *
12613:
1.243 albertel 12614: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
12615: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
12616: and course level
12617:
12618: =item *
12619:
1.988 raeburn 12620: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
12621: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 12622: $type is Course (default) or Community.
1.988 raeburn 12623: If $forcedefault evaluates to true, text returned will be default
12624: text for $type. Otherwise, if this is a course, the text returned
12625: will be a custom name for the role (if defined in the course's
12626: environment). If no custom name is defined the default is returned.
12627:
1.832 raeburn 12628: =item *
12629:
1.1219 raeburn 12630: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv) :
1.858 raeburn 12631: All arguments are optional. Returns a hash of a roles, either for
12632: co-author/assistant author roles for a user's Construction Space
1.906 albertel 12633: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 12634: In the hash, keys are set to colon-separated $uname,$udom,$role, and
12635: (optionally) if $withsec is true, a fourth colon-separated item - $section.
12636: For each key, value is set to colon-separated start and end times for
12637: the role. If no username and domain are specified, will default to
1.934 raeburn 12638: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 12639: of role statuses (active, future or previous), roles
12640: (e.g., cc,in, st etc.) and domains of the roles which can be used
12641: to restrict the list of roles reported. If no array ref is
12642: provided for types, will default to return only active roles.
1.834 albertel 12643:
1.1195 raeburn 12644: =item *
12645:
12646: in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
1.1196 raeburn 12647: user: $uname:$udom has a role in the course: $cdom_$cnum.
12648:
12649: Additional optional arguments are: $type (if role checking is to be restricted
12650: to certain user status types -- previous (expired roles), active (currently
1.1195 raeburn 12651: available roles) or future (roles available in the future), and
12652: $hideprivileged -- if true will not report course roles for users who
1.1219 raeburn 12653: have active Domain Coordinator role in course's domain or in additional
12654: domains (specified in 'Domains to check for privileged users' in course
12655: environment -- set via: Course Settings -> Classlists and staff listing).
12656:
12657: =item *
12658:
12659: privileged($username,$domain,$possdomains,$possroles) : returns 1 if user
12660: $username:$domain is a privileged user (e.g., Domain Coordinator or Super User)
12661: $possdomains and $possroles are optional array refs -- to domains to check and
12662: roles to check. If $possdomains is not specified, a dump will be done of the
12663: users' roles.db to check for a dc or su role in any domain. This can be
12664: time consuming if &privileged is called repeatedly (e.g., when displaying a
12665: classlist), so in such cases, supplying a $possdomains array is preferred, as
12666: this then allows &privileged_by_domain() to be used, which caches the identity
12667: of privileged users, eliminating the need for repeated calls to &dump().
12668:
12669: =item *
12670:
12671: privileged_by_domain($possdomains,$roles) : returns a hash of a hash of a hash,
12672: where the outer hash keys are domains specified in the $possdomains array ref,
12673: next inner hash keys are privileged roles specified in the $roles array ref,
12674: and the innermost hash contains key = value pairs for username:domain = end:start
12675: for active or future "privileged" users with that role in that domain. To avoid
12676: repeated dumps of domain roles -- via &get_domain_roles() -- contents of the
12677: innerhash are cached using priv_$role and $dom as the identifiers.
1.1195 raeburn 12678:
1.243 albertel 12679: =back
12680:
12681: =head2 User Modification
12682:
12683: =over 4
12684:
12685: =item *
12686:
1.957 raeburn 12687: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 12688: user for the level given by URL. Optional start and end dates (leave empty
12689: string or zero for "no date")
1.191 harris41 12690:
12691: =item *
12692:
1.243 albertel 12693: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
12694: change a users, password, possible return values are: ok,
12695: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
12696: refused
1.191 harris41 12697:
12698: =item *
12699:
1.243 albertel 12700: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 12701:
12702: =item *
12703:
1.1058 raeburn 12704: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
12705: $forceid,$desiredhome,$email,$inststatus,$candelete) :
12706:
12707: will update user information (firstname,middlename,lastname,generation,
12708: permanentemail), and if forceid is true, student/employee ID also.
12709: A user's institutional affiliation(s) can also be updated.
12710: User information fields will not be overwritten with empty entries
12711: unless the field is included in the $candelete array reference.
12712: This array is included when a single user is modified via "Manage Users",
12713: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 12714:
12715: =item *
12716:
1.286 matthew 12717: modifystudent
12718:
1.957 raeburn 12719: modify a student's enrollment and identification information.
1.1235 raeburn 12720: The course id is resolved based on the current user's environment.
12721: This means the invoking user must be a course coordinator or otherwise
1.286 matthew 12722: associated with a course.
12723:
1.297 matthew 12724: This call is essentially a wrapper for lonnet::modifyuser and
12725: lonnet::modify_student_enrollment
1.286 matthew 12726:
12727: Inputs:
12728:
12729: =over 4
12730:
1.957 raeburn 12731: =item B<$udom> Student's loncapa domain
1.286 matthew 12732:
1.957 raeburn 12733: =item B<$uname> Student's loncapa login name
1.286 matthew 12734:
1.964 bisitz 12735: =item B<$uid> Student/Employee ID
1.286 matthew 12736:
1.957 raeburn 12737: =item B<$umode> Student's authentication mode
1.286 matthew 12738:
1.957 raeburn 12739: =item B<$upass> Student's password
1.286 matthew 12740:
1.957 raeburn 12741: =item B<$first> Student's first name
1.286 matthew 12742:
1.957 raeburn 12743: =item B<$middle> Student's middle name
1.286 matthew 12744:
1.957 raeburn 12745: =item B<$last> Student's last name
1.286 matthew 12746:
1.957 raeburn 12747: =item B<$gene> Student's generation
1.286 matthew 12748:
1.957 raeburn 12749: =item B<$usec> Student's section in course
1.286 matthew 12750:
12751: =item B<$end> Unix time of the roles expiration
12752:
12753: =item B<$start> Unix time of the roles start date
12754:
12755: =item B<$forceid> If defined, allow $uid to be changed
12756:
12757: =item B<$desiredhome> server to use as home server for student
12758:
1.957 raeburn 12759: =item B<$email> Student's permanent e-mail address
12760:
12761: =item B<$type> Type of enrollment (auto or manual)
12762:
1.963 raeburn 12763: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
12764:
12765: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 12766:
1.963 raeburn 12767: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 12768:
1.963 raeburn 12769: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 12770:
1.1216 raeburn 12771: =item B<$inststatus> institutional status of user - : separated string of escaped status types
12772:
12773: =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 12774:
1.286 matthew 12775: =back
1.297 matthew 12776:
12777: =item *
12778:
12779: modify_student_enrollment
12780:
1.1235 raeburn 12781: Change a student's enrollment status in a class. The environment variable
1.297 matthew 12782: 'role.request.course' must be defined for this function to proceed.
12783:
12784: Inputs:
12785:
12786: =over 4
12787:
1.1235 raeburn 12788: =item $udom, student's domain
1.297 matthew 12789:
1.1235 raeburn 12790: =item $uname, student's name
1.297 matthew 12791:
1.1235 raeburn 12792: =item $uid, student's user id
1.297 matthew 12793:
1.1235 raeburn 12794: =item $first, student's first name
1.297 matthew 12795:
12796: =item $middle
12797:
12798: =item $last
12799:
12800: =item $gene
12801:
12802: =item $usec
12803:
12804: =item $end
12805:
12806: =item $start
12807:
1.957 raeburn 12808: =item $type
12809:
12810: =item $locktype
12811:
12812: =item $cid
12813:
12814: =item $selfenroll
12815:
12816: =item $context
12817:
1.1216 raeburn 12818: =item $credits, number of credits student will earn from this class
12819:
1.297 matthew 12820: =back
12821:
1.191 harris41 12822:
12823: =item *
12824:
1.243 albertel 12825: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
12826: custom role; give a custom role to a user for the level given by URL. Specify
12827: name and domain of role author, and role name
1.191 harris41 12828:
12829: =item *
12830:
1.243 albertel 12831: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 12832:
12833: =item *
12834:
1.243 albertel 12835: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
12836:
12837: =back
12838:
12839: =head2 Course Infomation
12840:
12841: =over 4
1.191 harris41 12842:
12843: =item *
12844:
1.1118 foxr 12845: coursedescription($courseid,$options) : returns a hash of information about the
1.631 albertel 12846: specified course id, including all environment settings for the
12847: course, the description of the course will be in the hash under the
12848: key 'description'
1.191 harris41 12849:
1.1118 foxr 12850: $options is an optional parameter that if supplied is a hash reference that controls
12851: what how this function works. It has the following key/values:
12852:
12853: =over 4
12854:
12855: =item freshen_cache
12856:
12857: If defined, and the environment cache for the course is valid, it is
12858: returned in the returned hash.
12859:
12860: =item one_time
12861:
12862: If defined, the last cache time is set to _now_
12863:
12864: =item user
12865:
12866: If defined, the supplied username is used instead of the current user.
12867:
12868:
12869: =back
12870:
1.191 harris41 12871: =item *
12872:
1.624 albertel 12873: resdata($name,$domain,$type,@which) : request for current parameter
12874: setting for a specific $type, where $type is either 'course' or 'user',
12875: @what should be a list of parameters to ask about. This routine caches
1.1235 raeburn 12876: answers for 10 minutes.
1.243 albertel 12877:
1.877 foxr 12878: =item *
12879:
12880: get_courseresdata($courseid, $domain) : dump the entire course resource
12881: data base, returning a hash that is keyed by the resource name and has
12882: values that are the resource value. I believe that the timestamps and
12883: versions are also returned.
12884:
1.1236 ! raeburn 12885: get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
! 12886: supplemental content area. This routine caches the number of files for
! 12887: 10 minutes.
! 12888:
1.243 albertel 12889: =back
12890:
12891: =head2 Course Modification
12892:
12893: =over 4
1.191 harris41 12894:
12895: =item *
12896:
1.243 albertel 12897: writecoursepref($courseid,%prefs) : write preferences (environment
12898: database) for a course
1.191 harris41 12899:
12900: =item *
12901:
1.1011 raeburn 12902: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
12903:
12904: =item *
12905:
1.1038 raeburn 12906: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 12907:
1.1167 droeschl 12908: =item *
12909:
12910: is_course($courseid), is_course($cdom, $cnum)
12911:
12912: Accepts either a combined $courseid (in the form of domain_courseid) or the
12913: two component version $cdom, $cnum. It checks if the specified course exists.
12914:
12915: Returns:
12916: undef if the course doesn't exist, otherwise
12917: in scalar context the combined courseid.
12918: in list context the two components of the course identifier, domain and
12919: courseid.
12920:
1.243 albertel 12921: =back
12922:
12923: =head2 Resource Subroutines
12924:
12925: =over 4
1.191 harris41 12926:
12927: =item *
12928:
1.243 albertel 12929: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 12930:
12931: =item *
12932:
1.243 albertel 12933: repcopy($filename) : subscribes to the requested file, and attempts to
12934: replicate from the owning library server, Might return
1.607 raeburn 12935: 'unavailable', 'not_found', 'forbidden', 'ok', or
12936: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 12937: resource. Expects the local filesystem pathname
12938: (/home/httpd/html/res/....)
12939:
12940: =back
12941:
12942: =head2 Resource Information
12943:
12944: =over 4
1.191 harris41 12945:
12946: =item *
12947:
1.1228 raeburn 12948: EXT($varname,$symb,$udom,$uname,$usection,$recurse,$cid) : evaluates
12949: and returns the value of a variety of different possible values,
12950: $varname should be a request string, and the other parameters can be
12951: used to specify who and what one is asking about. Ordinarily, $cid
12952: does not need to be specified, as it is retrived from
12953: $env{'request.course.id'}, but &Apache::lonnet::EXT() is called
12954: within lonuserstate::loadmap() when initializing a course, before
12955: $env{'request.course.id'} has been set, so it needs to be provided
12956: in that one case.
1.243 albertel 12957:
12958: Possible values for $varname are environment.lastname (or other item
12959: from the envirnment hash), user.name (or someother aspect about the
12960: user), resource.0.maxtries (or some other part and parameter of a
12961: resource)
1.204 albertel 12962:
12963: =item *
12964:
1.243 albertel 12965: directcondval($number) : get current value of a condition; reads from a state
12966: string
1.204 albertel 12967:
12968: =item *
12969:
1.243 albertel 12970: condval($condidx) : value of condition index based on state
1.204 albertel 12971:
12972: =item *
12973:
1.243 albertel 12974: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
12975: resource's metadata, $what should be either a specific key, or either
12976: 'keys' (to get a list of possible keys) or 'packages' to get a list of
12977: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
12978:
12979: this function automatically caches all requests
1.191 harris41 12980:
12981: =item *
12982:
1.243 albertel 12983: metadata_query($query,$custom,$customshow) : make a metadata query against the
12984: network of library servers; returns file handle of where SQL and regex results
12985: will be stored for query
1.191 harris41 12986:
12987: =item *
12988:
1.243 albertel 12989: symbread($filename) : return symbolic list entry (filename argument optional);
12990: returns the data handle
1.191 harris41 12991:
12992: =item *
12993:
1.1190 raeburn 12994: symbverify($symb,$thisfn,$encstate) : verifies that $symb actually exists
12995: and is a possible symb for the URL in $thisfn, and if is an encrypted
1.582 albertel 12996: resource that the user accessed using /enc/ returns a 1 on success, 0
1.1190 raeburn 12997: on failure, user must be in a course, as it assumes the existence of
12998: the course initial hash, and uses $env('request.course.id'}. The third
12999: arg is an optional reference to a scalar. If this arg is passed in the
13000: call to symbverify, it will be set to 1 if the symb has been set to be
13001: encrypted; otherwise it will be null.
1.191 harris41 13002:
13003: =item *
13004:
1.243 albertel 13005: symbclean($symb) : removes versions numbers from a symb, returns the
13006: cleaned symb
1.191 harris41 13007:
13008: =item *
13009:
1.243 albertel 13010: is_on_map($uri) : checks if the $uri is somewhere on the current
13011: course map, user must be in a course for it to work.
1.191 harris41 13012:
13013: =item *
13014:
1.243 albertel 13015: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 13016:
13017: =item *
13018:
1.243 albertel 13019: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
13020: a random seed, all arguments are optional, if they aren't sent it uses the
13021: environment to derive them. Note: if symb isn't sent and it can't get one
13022: from &symbread it will use the current time as its return value
1.191 harris41 13023:
13024: =item *
13025:
1.243 albertel 13026: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
13027: unfakeable, receipt
1.191 harris41 13028:
13029: =item *
13030:
1.620 albertel 13031: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 13032:
13033: =item *
13034:
1.243 albertel 13035: countacc($url) : count the number of accesses to a given URL
1.191 harris41 13036:
13037: =item *
13038:
1.243 albertel 13039: 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 13040:
13041: =item *
13042:
1.243 albertel 13043: 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 13044:
13045: =item *
13046:
1.243 albertel 13047: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 13048:
13049: =item *
13050:
1.243 albertel 13051: devalidate($symb) : devalidate temporary spreadsheet calculations,
13052: forcing spreadsheet to reevaluate the resource scores next time.
13053:
1.1195 raeburn 13054: =item *
13055:
1.1196 raeburn 13056: can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
13057: when viewing in course context.
1.1195 raeburn 13058:
1.1196 raeburn 13059: input: six args -- filename (decluttered), course number, course domain,
13060: url, symb (if registered) and group (if this is a
13061: group item -- e.g., bulletin board, group page etc.).
1.1195 raeburn 13062:
1.1196 raeburn 13063: output: array of five scalars --
1.1195 raeburn 13064: $cfile -- url for file editing if editable on current server
13065: $home -- homeserver of resource (i.e., for author if published,
13066: or course if uploaded.).
13067: $switchserver -- 1 if server switch will be needed.
1.1196 raeburn 13068: $forceedit -- 1 if icon/link should be to go to edit mode
13069: $forceview -- 1 if icon/link should be to go to view mode
1.1195 raeburn 13070:
13071: =item *
13072:
13073: is_course_upload($file,$cnum,$cdom)
13074:
13075: Used in course context to determine if current file was uploaded to
13076: the course (i.e., would be found in /userfiles/docs on the course's
13077: homeserver.
13078:
13079: input: 3 args -- filename (decluttered), course number and course domain.
13080: output: boolean -- 1 if file was uploaded.
13081:
1.243 albertel 13082: =back
13083:
13084: =head2 Storing/Retreiving Data
13085:
13086: =over 4
1.191 harris41 13087:
13088: =item *
13089:
1.243 albertel 13090: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
13091: for this url; hashref needs to be given and should be a \%hashname; the
13092: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 13093: be derived from the env
1.191 harris41 13094:
13095: =item *
13096:
1.243 albertel 13097: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
13098: uses critical subroutine
1.191 harris41 13099:
13100: =item *
13101:
1.243 albertel 13102: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
13103: all args are optional
1.191 harris41 13104:
13105: =item *
13106:
1.717 albertel 13107: dumpstore($namespace,$udom,$uname,$regexp,$range) :
13108: dumps the complete (or key matching regexp) namespace into a hash
13109: ($udom, $uname, $regexp, $range are optional) for a namespace that is
13110: normally &store()ed into
13111:
13112: $range should be either an integer '100' (give me the first 100
13113: matching records)
13114: or be two integers sperated by a - with no spaces
13115: '30-50' (give me the 30th through the 50th matching
13116: records)
13117:
13118:
13119: =item *
13120:
13121: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
13122: replaces a &store() version of data with a replacement set of data
13123: for a particular resource in a namespace passed in the $storehash hash
13124: reference
13125:
13126: =item *
13127:
1.243 albertel 13128: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
13129: works very similar to store/cstore, but all data is stored in a
13130: temporary location and can be reset using tmpreset, $storehash should
13131: be a hash reference, returns nothing on success
1.191 harris41 13132:
13133: =item *
13134:
1.243 albertel 13135: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
13136: similar to restore, but all data is stored in a temporary location and
13137: can be reset using tmpreset. Returns a hash of values on success,
13138: error string otherwise.
1.191 harris41 13139:
13140: =item *
13141:
1.243 albertel 13142: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
13143: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 13144:
13145: =item *
13146:
1.243 albertel 13147: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13148: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 13149:
13150: =item *
13151:
1.243 albertel 13152: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
13153: namesp ($udom and $uname are optional)
1.191 harris41 13154:
13155: =item *
13156:
1.702 albertel 13157: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 13158: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 13159: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 13160:
1.702 albertel 13161: $range should be either an integer '100' (give me the first 100
13162: matching records)
13163: or be two integers sperated by a - with no spaces
13164: '30-50' (give me the 30th through the 50th matching
13165: records)
1.449 matthew 13166: =item *
13167:
13168: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
13169: $store can be a scalar, an array reference, or if the amount to be
13170: incremented is > 1, a hash reference.
13171:
13172: ($udom and $uname are optional)
1.191 harris41 13173:
13174: =item *
13175:
1.243 albertel 13176: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
13177: ($udom and $uname are optional)
1.191 harris41 13178:
13179: =item *
13180:
1.243 albertel 13181: cput($namespace,$storehash,$udom,$uname) : critical put
13182: ($udom and $uname are optional)
1.191 harris41 13183:
13184: =item *
13185:
1.748 albertel 13186: newput($namespace,$storehash,$udom,$uname) :
13187:
13188: Attempts to store the items in the $storehash, but only if they don't
13189: currently exist, if this succeeds you can be certain that you have
13190: successfully created a new key value pair in the $namespace db.
13191:
13192:
13193: Args:
13194: $namespace: name of database to store values to
13195: $storehash: hashref to store to the db
13196: $udom: (optional) domain of user containing the db
13197: $uname: (optional) name of user caontaining the db
13198:
13199: Returns:
13200: 'ok' -> succeeded in storing all keys of $storehash
13201: 'key_exists: <key>' -> failed to anything out of $storehash, as at
13202: least <key> already existed in the db (other
13203: requested keys may also already exist)
1.967 bisitz 13204: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 13205: 'con_lost' -> unable to contact request server
13206: 'refused' -> action was not allowed by remote machine
13207:
13208:
13209: =item *
13210:
1.243 albertel 13211: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
13212: reference filled in from namesp (encrypts the return communication)
13213: ($udom and $uname are optional)
1.191 harris41 13214:
13215: =item *
13216:
1.243 albertel 13217: log($udom,$name,$home,$message) : write to permanent log for user; use
13218: critical subroutine
13219:
1.806 raeburn 13220: =item *
13221:
1.860 raeburn 13222: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
13223: array reference filled in from namespace found in domain level on either
13224: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 13225:
13226: =item *
13227:
1.860 raeburn 13228: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
13229: domain level either on specified domain server ($uhome) or primary domain
13230: server ($udom and $uhome are optional)
1.806 raeburn 13231:
1.943 raeburn 13232: =item *
13233:
13234: get_domain_defaults($target_domain) : returns hash with defaults for
13235: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
13236: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
13237: or localauth), initial password or a kerberos realm, language (e.g., en-us).
13238: Values are retrieved from cache (if current), or from domain's configuration.db
13239: (if available), or lastly from values in lonTabs/dns_domain,tab,
13240: or lonTabs/domain.tab.
13241:
13242: %domdefaults = &get_auth_defaults($target_domain);
13243:
1.243 albertel 13244: =back
13245:
13246: =head2 Network Status Functions
13247:
13248: =over 4
1.191 harris41 13249:
13250: =item *
13251:
1.1137 raeburn 13252: dirlist() : return directory list based on URI (first arg).
13253:
13254: Inputs: 1 required, 5 optional.
13255:
13256: =over
13257:
13258: =item
13259: $uri - path to file in filesystem (starts: /res or /userfiles/). Required.
13260:
13261: =item
13262: $userdomain - domain of user/course to be listed. Extracted from $uri if absent.
13263:
13264: =item
13265: $username - username of user/course to be listed. Extracted from $uri if absent.
13266:
13267: =item
13268: $getpropath - boolean: 1 if prepend path using &propath().
13269:
13270: =item
13271: $getuserdir - boolean: 1 if prepend path for "userfiles".
13272:
13273: =item
13274: $alternateRoot - path to prepend in place of path from $uri.
13275:
13276: =back
13277:
13278: Returns: Array of up to two items.
13279:
13280: =over
13281:
13282: a reference to an array of files/subdirectories
13283:
13284: =over
13285:
13286: Each element in the array of files/subdirectories is a & separated list of
13287: item name and the result of running stat on the item. If dirlist was requested
13288: for a file instead of a directory, the item name will be ''. For a directory
13289: listing, if the item is a metadata file, the element will end &N&M
13290: (where N amd M are either 0 or 1, corresponding to obsolete set (1), or
13291: default copyright set (1).
13292:
13293: =back
13294:
13295: a scalar containing error condition (if encountered).
13296:
13297: =over
13298:
13299: =item
13300: no_host (no homeserver identified for $username:$domain).
13301:
13302: =item
13303: no_such_host (server contacted for listing not identified as valid host).
13304:
13305: =item
13306: con_lost (connection to remote server failed).
13307:
13308: =item
13309: refused (invalid $username:$domain received on lond side).
13310:
13311: =item
13312: no_such_dir (directory at specified path on lond side does not exist).
13313:
13314: =item
13315: empty (directory at specified path on lond side is empty).
13316:
13317: =over
13318:
13319: This is currently not encountered because the &ls3, &ls2,
13320: &ls (_handler) routines on the lond side do not filter out
13321: . and .. from a directory listing.
13322:
13323: =back
13324:
13325: =back
13326:
13327: =back
1.191 harris41 13328:
13329: =item *
13330:
1.243 albertel 13331: spareserver() : find server with least workload from spare.tab
13332:
1.986 foxr 13333:
13334: =item *
13335:
13336: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
13337: if there is no corresponding loncapa host.
13338:
1.243 albertel 13339: =back
13340:
1.986 foxr 13341:
1.243 albertel 13342: =head2 Apache Request
13343:
13344: =over 4
1.191 harris41 13345:
13346: =item *
13347:
1.243 albertel 13348: ssi($url,%hash) : server side include, does a complete request cycle on url to
13349: localhost, posts hash
13350:
13351: =back
13352:
13353: =head2 Data to String to Data
13354:
13355: =over 4
1.191 harris41 13356:
13357: =item *
13358:
1.243 albertel 13359: hash2str(%hash) : convert a hash into a string complete with escaping and '='
13360: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 13361:
13362: =item *
13363:
1.243 albertel 13364: hashref2str($hashref) : convert a hashref into a string complete with
13365: escaping and '=' and '&' separators, supports elements that are
13366: arrayrefs and hashrefs
1.191 harris41 13367:
13368: =item *
13369:
1.243 albertel 13370: arrayref2str($arrayref) : convert an arrayref into a string complete
13371: with escaping and '&' separators, supports elements that are arrayrefs
13372: and hashrefs
1.191 harris41 13373:
13374: =item *
13375:
1.243 albertel 13376: str2hash($string) : convert string to hash using unescaping and
13377: splitting on '=' and '&', supports elements that are arrayrefs and
13378: hashrefs
1.191 harris41 13379:
13380: =item *
13381:
1.243 albertel 13382: str2array($string) : convert string to hash using unescaping and
13383: splitting on '&', supports elements that are arrayrefs and hashrefs
13384:
13385: =back
13386:
13387: =head2 Logging Routines
13388:
13389:
13390: These routines allow one to make log messages in the lonnet.log and
13391: lonnet.perm logfiles.
1.191 harris41 13392:
1.1119 foxr 13393: =over 4
13394:
1.191 harris41 13395: =item *
13396:
1.243 albertel 13397: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 13398:
13399: =item *
13400:
1.243 albertel 13401: logthis() : append message to the normal lonnet.log file, it gets
13402: preiodically rolled over and deleted.
1.191 harris41 13403:
13404: =item *
13405:
1.243 albertel 13406: logperm() : append a permanent message to lonnet.perm.log, this log
13407: file never gets deleted by any automated portion of the system, only
13408: messages of critical importance should go in here.
13409:
1.1119 foxr 13410:
1.243 albertel 13411: =back
13412:
13413: =head2 General File Helper Routines
13414:
13415: =over 4
1.191 harris41 13416:
13417: =item *
13418:
1.481 raeburn 13419: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
13420: (a) files in /uploaded
13421: (i) If a local copy of the file exists -
13422: compares modification date of local copy with last-modified date for
13423: definitive version stored on home server for course. If local copy is
13424: stale, requests a new version from the home server and stores it.
13425: If the original has been removed from the home server, then local copy
13426: is unlinked.
13427: (ii) If local copy does not exist -
13428: requests the file from the home server and stores it.
13429:
13430: If $caller is 'uploadrep':
13431: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
13432: for request for files originally uploaded via DOCS.
13433: - returns 'ok' if fresh local copy now available, -1 otherwise.
13434:
13435: Otherwise:
13436: This indicates a call from the content generation phase of the request.
13437: - returns the entire contents of the file or -1.
13438:
13439: (b) files in /res
13440: - returns the entire contents of a file or -1;
13441: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 13442:
1.712 albertel 13443:
13444: =item *
13445:
13446: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
13447: reference
13448:
13449: returns either a stat() list of data about the file or an empty list
13450: if the file doesn't exist or couldn't find out about it (connection
13451: problems or user unknown)
13452:
1.191 harris41 13453: =item *
13454:
1.243 albertel 13455: filelocation($dir,$file) : returns file system location of a file
13456: based on URI; meant to be "fairly clean" absolute reference, $dir is a
13457: directory that relative $file lookups are to looked in ($dir of /a/dir
13458: and a file of ../bob will become /a/bob)
1.191 harris41 13459:
13460: =item *
13461:
13462: hreflocation($dir,$file) : returns file system location or a URL; same as
13463: filelocation except for hrefs
13464:
13465: =item *
13466:
13467: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
13468:
1.243 albertel 13469: =back
13470:
1.608 albertel 13471: =head2 Usererfile file routines (/uploaded*)
13472:
13473: =over 4
13474:
13475: =item *
13476:
13477: userfileupload(): main rotine for putting a file in a user or course's
13478: filespace, arguments are,
13479:
1.620 albertel 13480: formname - required - this is the name of the element in $env where the
1.608 albertel 13481: filename, and the contents of the file to create/modifed exist
1.620 albertel 13482: the filename is in $env{'form.'.$formname.'.filename'} and the
13483: contents of the file is located in $env{'form.'.$formname}
1.1090 raeburn 13484: context - if coursedoc, store the file in the course of the active role
13485: of the current user;
13486: if 'existingfile': store in 'overwrites' in /home/httpd/perl/tmp
13487: if 'canceloverwrite': delete file in tmp/overwrites directory
1.608 albertel 13488: subdir - required - subdirectory to put the file in under ../userfiles/
13489: if undefined, it will be placed in "unknown"
13490:
13491: (This routine calls clean_filename() to remove any dangerous
13492: characters from the filename, and then calls finuserfileupload() to
13493: complete the transaction)
13494:
13495: returns either the url of the uploaded file (/uploaded/....) if successful
13496: and /adm/notfound.html if unsuccessful
13497:
13498: =item *
13499:
13500: clean_filename(): routine for cleaing a filename up for storage in
13501: userfile space, argument is:
13502:
13503: filename - proposed filename
13504:
13505: returns: the new clean filename
13506:
13507: =item *
13508:
1.1090 raeburn 13509: finishuserfileupload(): routine that creates and sends the file to
1.608 albertel 13510: userspace, probably shouldn't be called directly
13511:
13512: docuname: username or courseid of destination for the file
13513: docudom: domain of user/course of destination for the file
13514: formname: same as for userfileupload()
1.1090 raeburn 13515: fname: filename (including subdirectories) for the file
13516: parser: if 'parse', will parse (html) file to extract references to objects, links etc.
13517: allfiles: reference to hash used to store objects found by parser
13518: codebase: reference to hash used for codebases of java objects found by parser
13519: thumbwidth: width (pixels) of thumbnail to be created for uploaded image
13520: thumbheight: height (pixels) of thumbnail to be created for uploaded image
13521: resizewidth: width to be used to resize image using resizeImage from ImageMagick
13522: resizeheight: height to be used to resize image using resizeImage from ImageMagick
13523: context: if 'overwrite', will move the uploaded file from its temporary location to
13524: userfiles to facilitate overwriting a previously uploaded file with same name.
1.1095 raeburn 13525: mimetype: reference to scalar to accommodate mime type determined
13526: from File::MMagic if $parser = parse.
1.608 albertel 13527:
13528: returns either the url of the uploaded file (/uploaded/....) if successful
1.1090 raeburn 13529: and /adm/notfound.html if unsuccessful (or an error message if context
13530: was 'overwrite').
13531:
1.608 albertel 13532:
13533: =item *
13534:
13535: renameuserfile(): renames an existing userfile to a new name
13536:
13537: Args:
13538: docuname: username or courseid of destination for the file
13539: docudom: domain of user/course of destination for the file
13540: old: current file name (including any subdirs under userfiles)
13541: new: desired file name (including any subdirs under userfiles)
13542:
13543: =item *
13544:
13545: mkdiruserfile(): creates a directory is a userfiles dir
13546:
13547: Args:
13548: docuname: username or courseid of destination for the file
13549: docudom: domain of user/course of destination for the file
13550: dir: dir to create (including any subdirs under userfiles)
13551:
13552: =item *
13553:
13554: removeuserfile(): removes a file that exists in userfiles
13555:
13556: Args:
13557: docuname: username or courseid of destination for the file
13558: docudom: domain of user/course of destination for the file
13559: fname: filname to delete (including any subdirs under userfiles)
13560:
13561: =item *
13562:
13563: removeuploadedurl(): convience function for removeuserfile()
13564:
13565: Args:
13566: url: a full /uploaded/... url to delete
13567:
1.747 albertel 13568: =item *
13569:
13570: get_portfile_permissions():
13571: Args:
13572: domain: domain of user or course contain the portfolio files
13573: user: name of user or num of course contain the portfolio files
13574: Returns:
13575: hashref of a dump of the proper file_permissions.db
13576:
13577:
13578: =item *
13579:
13580: get_access_controls():
13581:
13582: Args:
13583: current_permissions: the hash ref returned from get_portfile_permissions()
13584: group: (optional) the group you want the files associated with
13585: file: (optional) the file you want access info on
13586:
13587: Returns:
1.749 raeburn 13588: a hash (keys are file names) of hashes containing
13589: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
13590: values are XML containing access control settings (see below)
1.747 albertel 13591:
13592: Internal notes:
13593:
1.749 raeburn 13594: access controls are stored in file_permissions.db as key=value pairs.
13595: key -> path to file/file_name\0uniqueID:scope_end_start
13596: where scope -> public,guest,course,group,domains or users.
13597: end -> UNIX time for end of access (0 -> no end date)
13598: start -> UNIX time for start of access
13599:
13600: value -> XML description of access control
13601: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
13602: <start></start>
13603: <end></end>
13604:
13605: <password></password> for scope type = guest
13606:
13607: <domain></domain> for scope type = course or group
13608: <number></number>
13609: <roles id="">
13610: <role></role>
13611: <access></access>
13612: <section></section>
13613: <group></group>
13614: </roles>
13615:
13616: <dom></dom> for scope type = domains
13617:
13618: <users> for scope type = users
13619: <user>
13620: <uname></uname>
13621: <udom></udom>
13622: </user>
13623: </users>
13624: </scope>
13625:
13626: Access data is also aggregated for each file in an additional key=value pair:
13627: key -> path to file/file_name\0accesscontrol
13628: value -> reference to hash
13629: hash contains key = value pairs
13630: where key = uniqueID:scope_end_start
13631: value = UNIX time record was last updated
13632:
13633: Used to improve speed of look-ups of access controls for each file.
13634:
13635: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
13636:
1.1198 raeburn 13637: =item *
13638:
1.749 raeburn 13639: modify_access_controls():
13640:
13641: Modifies access controls for a portfolio file
13642: Args
13643: 1. file name
13644: 2. reference to hash of required changes,
13645: 3. domain
13646: 4. username
13647: where domain,username are the domain of the portfolio owner
13648: (either a user or a course)
13649:
13650: Returns:
13651: 1. result of additions or updates ('ok' or 'error', with error message).
13652: 2. result of deletions ('ok' or 'error', with error message).
13653: 3. reference to hash of any new or updated access controls.
13654: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
13655: key = integer (inbound ID)
1.1198 raeburn 13656: value = uniqueID
13657:
13658: =item *
13659:
13660: get_timebased_id():
13661:
13662: Attempts to get a unique timestamp-based suffix for use with items added to a
13663: course via the Course Editor (e.g., folders, composite pages,
13664: group bulletin boards).
13665:
13666: Args: (first three required; six others optional)
13667:
13668: 1. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
13669: docssequence, or name of group
13670:
13671: 2. keyid (alphanumeric): name of temporary locking key in hash,
13672: e.g., num, boardids
13673:
13674: 3. namespace: name of gdbm file used to store suffixes already assigned;
13675: file will be named nohist_namespace.db
13676:
13677: 4. cdom: domain of course; default is current course domain from %env
13678:
13679: 5. cnum: course number; default is current course number from %env
13680:
13681: 6. idtype: set to concat if an additional digit is to be appended to the
13682: unix timestamp to form the suffix, if the plain timestamp is already
13683: in use. Default is to not do this, but simply increment the unix
13684: timestamp by 1 until a unique key is obtained.
13685:
13686: 7. who: holder of locking key; defaults to user:domain for user.
13687:
13688: 8. locktries: number of attempts to obtain a lock (sleep of 1s before
13689: retrying); default is 3.
13690:
13691: 9. maxtries: number of attempts to obtain a unique suffix; default is 20.
13692:
13693: Returns:
13694:
13695: 1. suffix obtained (numeric)
13696:
13697: 2. result of deleting locking key (ok if deleted, or lock never obtained)
13698:
13699: 3. error: contains (localized) error message if an error occurred.
13700:
1.747 albertel 13701:
1.608 albertel 13702: =back
13703:
1.243 albertel 13704: =head2 HTTP Helper Routines
13705:
13706: =over 4
13707:
1.191 harris41 13708: =item *
13709:
13710: escape() : unpack non-word characters into CGI-compatible hex codes
13711:
13712: =item *
13713:
13714: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
13715:
1.243 albertel 13716: =back
13717:
13718: =head1 PRIVATE SUBROUTINES
13719:
13720: =head2 Underlying communication routines (Shouldn't call)
13721:
13722: =over 4
13723:
13724: =item *
13725:
13726: subreply() : tries to pass a message to lonc, returns con_lost if incapable
13727:
13728: =item *
13729:
13730: reply() : uses subreply to send a message to remote machine, logs all failures
13731:
13732: =item *
13733:
13734: critical() : passes a critical message to another server; if cannot
13735: get through then place message in connection buffer directory and
13736: returns con_delayed, if incapable of saving message, returns
13737: con_failed
13738:
13739: =item *
13740:
13741: reconlonc() : tries to reconnect lonc client processes.
13742:
13743: =back
13744:
13745: =head2 Resource Access Logging
13746:
13747: =over 4
13748:
13749: =item *
13750:
13751: flushcourselogs() : flush (save) buffer logs and access logs
13752:
13753: =item *
13754:
13755: courselog($what) : save message for course in hash
13756:
13757: =item *
13758:
13759: courseacclog($what) : save message for course using &courselog(). Perform
13760: special processing for specific resource types (problems, exams, quizzes, etc).
13761:
1.191 harris41 13762: =item *
13763:
13764: goodbye() : flush course logs and log shutting down; it is called in srm.conf
13765: as a PerlChildExitHandler
1.243 albertel 13766:
13767: =back
13768:
13769: =head2 Other
13770:
13771: =over 4
13772:
13773: =item *
13774:
13775: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 13776:
13777: =back
13778:
13779: =cut
1.877 foxr 13780:
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