Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1058
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1058 ! raeburn 4: # $Id: lonnet.pm,v 1.1057 2010/03/21 18:31:53 www 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.871 albertel 78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.968 raeburn 79: $_64bit %env %protocol);
1.871 albertel 80:
81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
82: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 84: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 85:
1.1 albertel 86: use IO::Socket;
1.31 www 87: use GDBM_File;
1.208 albertel 88: use HTML::LCParser;
1.88 www 89: use Fcntl qw(:flock);
1.870 albertel 90: use Storable qw(thaw nfreeze);
1.539 albertel 91: use Time::HiRes qw( gettimeofday tv_interval );
1.599 albertel 92: use Cache::Memcached;
1.676 albertel 93: use Digest::MD5;
1.790 albertel 94: use Math::Random;
1.1024 raeburn 95: use File::MMagic;
1.807 albertel 96: use LONCAPA qw(:DEFAULT :match);
1.740 www 97: use LONCAPA::Configuration;
1.676 albertel 98:
1.195 www 99: my $readit;
1.550 foxr 100: my $max_connection_retries = 10; # Or some such value.
1.1 albertel 101:
1.619 albertel 102: require Exporter;
103:
104: our @ISA = qw (Exporter);
105: our @EXPORT = qw(%env);
106:
1.449 matthew 107:
1.1 albertel 108: # --------------------------------------------------------------------- Logging
1.729 www 109: {
110: my $logid;
111: sub instructor_log {
1.957 raeburn 112: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
113: if (($cnum eq '') || ($cdom eq '')) {
114: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
115: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
116: }
1.729 www 117: $logid++;
1.957 raeburn 118: my $now = time();
119: my $id=$now.'00000'.$$.'00000'.$logid;
1.729 www 120: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 121: { $id => {
122: 'exe_uname' => $env{'user.name'},
123: 'exe_udom' => $env{'user.domain'},
1.957 raeburn 124: 'exe_time' => $now,
1.730 www 125: 'exe_ip' => $ENV{'REMOTE_ADDR'},
126: 'delflag' => $delflag,
127: 'logentry' => $storehash,
128: 'uname' => $uname,
129: 'udom' => $udom,
130: }
1.957 raeburn 131: },$cdom,$cnum);
1.729 www 132: }
133: }
1.1 albertel 134:
1.163 harris41 135: sub logtouch {
136: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 137: unless (-e "$execdir/logs/lonnet.log") {
138: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 139: close $fh;
140: }
141: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
142: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
143: }
144:
1.1 albertel 145: sub logthis {
146: my $message=shift;
147: my $execdir=$perlvar{'lonDaemons'};
148: my $now=time;
149: my $local=localtime($now);
1.448 albertel 150: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986 foxr 151: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
152: print $fh $logstring;
1.448 albertel 153: close($fh);
154: }
1.1 albertel 155: return 1;
156: }
157:
158: sub logperm {
159: my $message=shift;
160: my $execdir=$perlvar{'lonDaemons'};
161: my $now=time;
162: my $local=localtime($now);
1.448 albertel 163: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
164: print $fh "$now:$message:$local\n";
165: close($fh);
166: }
1.1 albertel 167: return 1;
168: }
169:
1.850 albertel 170: sub create_connection {
1.853 albertel 171: my ($hostname,$lonid) = @_;
1.851 albertel 172: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 173: Type => SOCK_STREAM,
174: Timeout => 10);
175: return 0 if (!$client);
1.890 albertel 176: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 177: my $result = <$client>;
178: chomp($result);
179: return 1 if ($result eq 'done');
180: return 0;
181: }
182:
1.983 raeburn 183: sub get_server_timezone {
184: my ($cnum,$cdom) = @_;
185: my $home=&homeserver($cnum,$cdom);
186: if ($home ne 'no_host') {
187: my $cachetime = 24*3600;
188: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
189: if (defined($cached)) {
190: return $timezone;
191: } else {
192: my $timezone = &reply('servertimezone',$home);
193: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
194: }
195: }
196: }
1.850 albertel 197:
1.993 raeburn 198: sub get_server_loncaparev {
199: my ($dom,$lonhost) = @_;
200: if (defined($lonhost)) {
201: if (!defined(&hostname($lonhost))) {
202: undef($lonhost);
203: }
204: }
205: if (!defined($lonhost)) {
206: if (defined(&domain($dom,'primary'))) {
207: $lonhost=&domain($dom,'primary');
208: if ($lonhost eq 'no_host') {
209: undef($lonhost);
210: }
211: }
212: }
213: if (defined($lonhost)) {
214: my $cachetime = 24*3600;
215: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
216: if (defined($cached)) {
217: return $loncaparev;
218: } else {
219: my $loncaparev = &reply('serverloncaparev',$lonhost);
220: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
221: }
222: }
223: }
224:
1.1 albertel 225: # -------------------------------------------------- Non-critical communication
226: sub subreply {
227: my ($cmd,$server)=@_;
1.838 albertel 228: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 229: #
230: # With loncnew process trimming, there's a timing hole between lonc server
231: # process exit and the master server picking up the listen on the AF_UNIX
232: # socket. In that time interval, a lock file will exist:
233:
234: my $lockfile=$peerfile.".lock";
235: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
236: sleep(1);
237: }
238: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 239: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 240: #
1.550 foxr 241: # We'll give the connection a few tries before abandoning it. If
242: # connection is not possible, we'll con_lost back to the client.
243: #
244: my $client;
245: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
246: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
247: Type => SOCK_STREAM,
248: Timeout => 10);
1.869 albertel 249: if ($client) {
1.550 foxr 250: last; # Connected!
1.850 albertel 251: } else {
1.853 albertel 252: &create_connection(&hostname($server),$server);
1.550 foxr 253: }
1.850 albertel 254: sleep(1); # Try again later if failed connection.
1.550 foxr 255: }
256: my $answer;
257: if ($client) {
1.704 albertel 258: print $client "sethost:$server:$cmd\n";
1.550 foxr 259: $answer=<$client>;
260: if (!$answer) { $answer="con_lost"; }
261: chomp($answer);
262: } else {
263: $answer = 'con_lost'; # Failed connection.
264: }
1.1 albertel 265: return $answer;
266: }
267:
268: sub reply {
269: my ($cmd,$server)=@_;
1.838 albertel 270: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 271: my $answer=subreply($cmd,$server);
1.65 www 272: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 273: &logthis("<font color=\"blue\">WARNING:".
1.12 www 274: " $cmd to $server returned $answer</font>");
275: }
1.1 albertel 276: return $answer;
277: }
278:
279: # ----------------------------------------------------------- Send USR1 to lonc
280:
281: sub reconlonc {
1.891 albertel 282: my ($lonid) = @_;
283: my $hostname = &hostname($lonid);
284: if ($lonid) {
285: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
286: if ($hostname && -e $peerfile) {
287: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
288: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
289: Type => SOCK_STREAM,
290: Timeout => 10);
291: if ($client) {
292: print $client ("reset_retries\n");
293: my $answer=<$client>;
294: #reset just this one.
295: }
296: }
297: return;
298: }
299:
1.836 www 300: &logthis("Trying to reconnect lonc");
1.1 albertel 301: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 302: if (open(my $fh,"<$loncfile")) {
1.1 albertel 303: my $loncpid=<$fh>;
304: chomp($loncpid);
305: if (kill 0 => $loncpid) {
306: &logthis("lonc at pid $loncpid responding, sending USR1");
307: kill USR1 => $loncpid;
308: sleep 1;
1.836 www 309: } else {
1.12 www 310: &logthis(
1.672 albertel 311: "<font color=\"blue\">WARNING:".
1.12 www 312: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 313: }
314: } else {
1.836 www 315: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 316: }
317: }
318:
319: # ------------------------------------------------------ Critical communication
1.12 www 320:
1.1 albertel 321: sub critical {
322: my ($cmd,$server)=@_;
1.838 albertel 323: unless (&hostname($server)) {
1.672 albertel 324: &logthis("<font color=\"blue\">WARNING:".
1.89 www 325: " Critical message to unknown server ($server)</font>");
326: return 'no_such_host';
327: }
1.1 albertel 328: my $answer=reply($cmd,$server);
329: if ($answer eq 'con_lost') {
330: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 331: my $answer=reply($cmd,$server);
1.1 albertel 332: if ($answer eq 'con_lost') {
333: my $now=time;
334: my $middlename=$cmd;
1.5 www 335: $middlename=substr($middlename,0,16);
1.1 albertel 336: $middlename=~s/\W//g;
337: my $dfilename=
1.305 www 338: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
339: $dumpcount++;
1.1 albertel 340: {
1.448 albertel 341: my $dfh;
342: if (open($dfh,">$dfilename")) {
343: print $dfh "$cmd\n";
344: close($dfh);
345: }
1.1 albertel 346: }
347: sleep 2;
348: my $wcmd='';
349: {
1.448 albertel 350: my $dfh;
351: if (open($dfh,"<$dfilename")) {
352: $wcmd=<$dfh>;
353: close($dfh);
354: }
1.1 albertel 355: }
356: chomp($wcmd);
1.7 www 357: if ($wcmd eq $cmd) {
1.672 albertel 358: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 359: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 360: &logperm("D:$server:$cmd");
361: return 'con_delayed';
362: } else {
1.672 albertel 363: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 364: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 365: &logperm("F:$server:$cmd");
366: return 'con_failed';
367: }
368: }
369: }
370: return $answer;
1.405 albertel 371: }
372:
1.755 albertel 373: # ------------------------------------------- check if return value is an error
374:
375: sub error {
376: my ($result) = @_;
1.756 albertel 377: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 378: if ($2 == 2) { return undef; }
379: return $1;
380: }
381: return undef;
382: }
383:
1.783 albertel 384: sub convert_and_load_session_env {
385: my ($lonidsdir,$handle)=@_;
386: my @profile;
387: {
1.917 albertel 388: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
389: if (!$opened) {
1.915 albertel 390: return 0;
391: }
1.783 albertel 392: flock($idf,LOCK_SH);
393: @profile=<$idf>;
394: close($idf);
395: }
396: my %temp_env;
397: foreach my $line (@profile) {
1.786 albertel 398: if ($line !~ m/=/) {
399: return 0;
400: }
1.783 albertel 401: chomp($line);
402: my ($envname,$envvalue)=split(/=/,$line,2);
403: $temp_env{&unescape($envname)} = &unescape($envvalue);
404: }
405: unlink("$lonidsdir/$handle.id");
406: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
407: 0640)) {
408: %disk_env = %temp_env;
409: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
410: untie(%disk_env);
411: }
1.786 albertel 412: return 1;
1.783 albertel 413: }
414:
1.374 www 415: # ------------------------------------------- Transfer profile into environment
1.780 albertel 416: my $env_loaded;
417: sub transfer_profile_to_env {
1.788 albertel 418: my ($lonidsdir,$handle,$force_transfer) = @_;
419: if (!$force_transfer && $env_loaded) { return; }
1.374 www 420:
1.720 albertel 421: if (!defined($lonidsdir)) {
422: $lonidsdir = $perlvar{'lonIDsDir'};
423: }
424: if (!defined($handle)) {
425: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
426: }
427:
1.786 albertel 428: my $convert;
429: {
1.917 albertel 430: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
431: if (!$opened) {
1.915 albertel 432: return;
433: }
1.786 albertel 434: flock($idf,LOCK_SH);
435: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
436: &GDBM_READER(),0640)) {
437: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
438: untie(%disk_env);
439: } else {
440: $convert = 1;
441: }
442: }
443: if ($convert) {
444: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
445: &logthis("Failed to load session, or convert session.");
446: }
1.374 www 447: }
1.783 albertel 448:
1.786 albertel 449: my %remove;
1.783 albertel 450: while ( my $envname = each(%env) ) {
1.433 matthew 451: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
452: if ($time < time-300) {
1.783 albertel 453: $remove{$key}++;
1.433 matthew 454: }
455: }
456: }
1.783 albertel 457:
1.619 albertel 458: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 459: $env_loaded=1;
1.783 albertel 460: foreach my $expired_key (keys(%remove)) {
1.433 matthew 461: &delenv($expired_key);
1.374 www 462: }
1.1 albertel 463: }
464:
1.916 albertel 465: # ---------------------------------------------------- Check for valid session
466: sub check_for_valid_session {
467: my ($r) = @_;
468: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
469: my $lonid=$cookies{'lonID'};
470: return undef if (!$lonid);
471:
472: my $handle=&LONCAPA::clean_handle($lonid->value);
473: my $lonidsdir=$r->dir_config('lonIDsDir');
474: return undef if (!-e "$lonidsdir/$handle.id");
475:
1.917 albertel 476: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
477: return undef if (!$opened);
1.916 albertel 478:
479: flock($idf,LOCK_SH);
480: my %disk_env;
481: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
482: &GDBM_READER(),0640)) {
483: return undef;
484: }
485:
486: if (!defined($disk_env{'user.name'})
487: || !defined($disk_env{'user.domain'})) {
488: return undef;
489: }
490: return $handle;
491: }
492:
1.830 albertel 493: sub timed_flock {
494: my ($file,$lock_type) = @_;
495: my $failed=0;
496: eval {
497: local $SIG{__DIE__}='DEFAULT';
498: local $SIG{ALRM}=sub {
499: $failed=1;
500: die("failed lock");
501: };
502: alarm(13);
503: flock($file,$lock_type);
504: alarm(0);
505: };
506: if ($failed) {
507: return undef;
508: } else {
509: return 1;
510: }
511: }
512:
1.5 www 513: # ---------------------------------------------------------- Append Environment
514:
515: sub appenv {
1.949 raeburn 516: my ($newenv,$roles) = @_;
517: if (ref($newenv) eq 'HASH') {
518: foreach my $key (keys(%{$newenv})) {
519: my $refused = 0;
520: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
521: $refused = 1;
522: if (ref($roles) eq 'ARRAY') {
523: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
524: if (grep(/^\Q$role\E$/,@{$roles})) {
525: $refused = 0;
526: }
527: }
528: }
529: if ($refused) {
530: &logthis("<font color=\"blue\">WARNING: ".
531: "Attempt to modify environment ".$key." to ".$newenv->{$key}
532: .'</font>');
533: delete($newenv->{$key});
534: } else {
535: $env{$key}=$newenv->{$key};
536: }
537: }
538: my $opened = open(my $env_file,'+<',$env{'user.environment'});
539: if ($opened
540: && &timed_flock($env_file,LOCK_EX)
541: &&
542: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
543: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
544: while (my ($key,$value) = each(%{$newenv})) {
545: $disk_env{$key} = $value;
546: }
547: untie(%disk_env);
1.35 www 548: }
1.191 harris41 549: }
1.56 www 550: return 'ok';
551: }
552: # ----------------------------------------------------- Delete from Environment
553:
554: sub delenv {
1.987 raeburn 555: my ($delthis,$regexp) = @_;
1.56 www 556: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 557: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 558: "Attempt to delete from environment ".$delthis);
559: return 'error';
560: }
1.917 albertel 561: my $opened = open(my $env_file,'+<',$env{'user.environment'});
562: if ($opened
1.915 albertel 563: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 564: &&
565: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
566: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 567: foreach my $key (keys(%disk_env)) {
1.987 raeburn 568: if ($regexp) {
569: if ($key=~/^$delthis/) {
570: delete($env{$key});
571: delete($disk_env{$key});
572: }
573: } else {
574: if ($key=~/^\Q$delthis\E/) {
575: delete($env{$key});
576: delete($disk_env{$key});
577: }
578: }
1.448 albertel 579: }
1.783 albertel 580: untie(%disk_env);
1.5 www 581: }
582: return 'ok';
1.369 albertel 583: }
584:
1.790 albertel 585: sub get_env_multiple {
586: my ($name) = @_;
587: my @values;
588: if (defined($env{$name})) {
589: # exists is it an array
590: if (ref($env{$name})) {
591: @values=@{ $env{$name} };
592: } else {
593: $values[0]=$env{$name};
594: }
595: }
596: return(@values);
597: }
598:
1.958 www 599: # ------------------------------------------------------------------- Locking
600:
601: sub set_lock {
602: my ($text)=@_;
603: $locknum++;
604: my $id=$$.'-'.$locknum;
605: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
606: 'session.lock.'.$id => $text});
607: return $id;
608: }
609:
610: sub get_locks {
611: my $num=0;
612: my %texts=();
613: foreach my $lock (split(/\,/,$env{'session.locks'})) {
614: if ($lock=~/\w/) {
615: $num++;
616: $texts{$lock}=$env{'session.lock.'.$lock};
617: }
618: }
619: return ($num,%texts);
620: }
621:
622: sub remove_lock {
623: my ($id)=@_;
624: my $newlocks='';
625: foreach my $lock (split(/\,/,$env{'session.locks'})) {
626: if (($lock=~/\w/) && ($lock ne $id)) {
627: $newlocks.=','.$lock;
628: }
629: }
630: &appenv({'session.locks' => $newlocks});
631: &delenv('session.lock.'.$id);
632: }
633:
634: sub remove_all_locks {
635: my $activelocks=$env{'session.locks'};
636: foreach my $lock (split(/\,/,$env{'session.locks'})) {
637: if ($lock=~/\w/) {
638: &remove_lock($lock);
639: }
640: }
641: }
642:
643:
1.369 albertel 644: # ------------------------------------------ Find out current server userload
645: sub userload {
646: my $numusers=0;
647: {
648: opendir(LONIDS,$perlvar{'lonIDsDir'});
649: my $filename;
650: my $curtime=time;
651: while ($filename=readdir(LONIDS)) {
1.925 albertel 652: next if ($filename eq '.' || $filename eq '..');
653: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 654: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 655: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 656: }
657: closedir(LONIDS);
658: }
659: my $userloadpercent=0;
660: my $maxuserload=$perlvar{'lonUserLoadLim'};
661: if ($maxuserload) {
1.371 albertel 662: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 663: }
1.372 albertel 664: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 665: return $userloadpercent;
1.283 www 666: }
667:
668: # ------------------------------------------ Fight off request when overloaded
669:
670: sub overloaderror {
671: my ($r,$checkserver)=@_;
672: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
673: my $loadavg;
674: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 675: open(my $loadfile,'/proc/loadavg');
1.283 www 676: $loadavg=<$loadfile>;
677: $loadavg =~ s/\s.*//g;
1.285 matthew 678: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 679: close($loadfile);
1.283 www 680: } else {
681: $loadavg=&reply('load',$checkserver);
682: }
1.285 matthew 683: my $overload=$loadavg-100;
1.283 www 684: if ($overload>0) {
1.285 matthew 685: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 686: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 687: return 413;
1.283 www 688: }
689: return '';
1.5 www 690: }
1.1 albertel 691:
692: # ------------------------------ Find server with least workload from spare.tab
1.11 www 693:
1.1 albertel 694: sub spareserver {
1.670 albertel 695: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.784 albertel 696: my $spare_server;
1.370 albertel 697: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 698: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
699: : $userloadpercent;
700:
701: foreach my $try_server (@{ $spareid{'primary'} }) {
702: ($spare_server, $lowest_load) =
703: &compare_server_load($try_server, $spare_server, $lowest_load);
704: }
705:
706: my $found_server = ($spare_server ne '' && $lowest_load < 100);
707:
708: if (!$found_server) {
709: foreach my $try_server (@{ $spareid{'default'} }) {
710: ($spare_server, $lowest_load) =
711: &compare_server_load($try_server, $spare_server, $lowest_load);
712: }
713: }
714:
715: if (!$want_server_name) {
1.968 raeburn 716: my $protocol = 'http';
717: if ($protocol{$spare_server} eq 'https') {
718: $protocol = $protocol{$spare_server};
719: }
1.1001 raeburn 720: if (defined($spare_server)) {
721: my $hostname = &hostname($spare_server);
722: if (defined($hostname)) {
723: $spare_server = $protocol.'://'.$hostname;
724: }
725: }
1.784 albertel 726: }
727: return $spare_server;
728: }
729:
730: sub compare_server_load {
731: my ($try_server, $spare_server, $lowest_load) = @_;
732:
733: my $loadans = &reply('load', $try_server);
734: my $userloadans = &reply('userload',$try_server);
735:
736: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
737: next; #didn't get a number from the server
738: }
739:
740: my $load;
741: if ($loadans =~ /\d/) {
742: if ($userloadans =~ /\d/) {
743: #both are numbers, pick the bigger one
744: $load = ($loadans > $userloadans) ? $loadans
745: : $userloadans;
1.411 albertel 746: } else {
1.784 albertel 747: $load = $loadans;
1.411 albertel 748: }
1.784 albertel 749: } else {
750: $load = $userloadans;
751: }
752:
753: if (($load =~ /\d/) && ($load < $lowest_load)) {
754: $spare_server = $try_server;
755: $lowest_load = $load;
1.370 albertel 756: }
1.784 albertel 757: return ($spare_server,$lowest_load);
1.202 matthew 758: }
1.914 albertel 759:
760: # --------------------------- ask offload servers if user already has a session
761: sub find_existing_session {
762: my ($udom,$uname) = @_;
763: foreach my $try_server (@{ $spareid{'primary'} },
764: @{ $spareid{'default'} }) {
765: return $try_server if (&has_user_session($try_server, $udom, $uname));
766: }
767: return;
768: }
769:
770: # -------------------------------- ask if server already has a session for user
771: sub has_user_session {
772: my ($lonid,$udom,$uname) = @_;
773: my $result = &reply(join(':','userhassession',
774: map {&escape($_)} ($udom,$uname)),$lonid);
775: return 1 if ($result eq 'ok');
776:
777: return 0;
778: }
779:
1.202 matthew 780: # --------------------------------------------- Try to change a user's password
781:
782: sub changepass {
1.799 raeburn 783: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 784: $currentpass = &escape($currentpass);
785: $newpass = &escape($newpass);
1.1030 raeburn 786: my $lonhost = $perlvar{'lonHostID'};
787: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 788: $server);
789: if (! $answer) {
790: &logthis("No reply on password change request to $server ".
791: "by $uname in domain $udom.");
792: } elsif ($answer =~ "^ok") {
793: &logthis("$uname in $udom successfully changed their password ".
794: "on $server.");
795: } elsif ($answer =~ "^pwchange_failure") {
796: &logthis("$uname in $udom was unable to change their password ".
797: "on $server. The action was blocked by either lcpasswd ".
798: "or pwchange");
799: } elsif ($answer =~ "^non_authorized") {
800: &logthis("$uname in $udom did not get their password correct when ".
801: "attempting to change it on $server.");
802: } elsif ($answer =~ "^auth_mode_error") {
803: &logthis("$uname in $udom attempted to change their password despite ".
804: "not being locally or internally authenticated on $server.");
805: } elsif ($answer =~ "^unknown_user") {
806: &logthis("$uname in $udom attempted to change their password ".
807: "on $server but were unable to because $server is not ".
808: "their home server.");
809: } elsif ($answer =~ "^refused") {
810: &logthis("$server refused to change $uname in $udom password because ".
811: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 812: } elsif ($answer =~ "invalid_client") {
813: &logthis("$server refused to change $uname in $udom password because ".
814: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 815: }
816: return $answer;
1.1 albertel 817: }
818:
1.169 harris41 819: # ----------------------- Try to determine user's current authentication scheme
820:
821: sub queryauthenticate {
822: my ($uname,$udom)=@_;
1.456 albertel 823: my $uhome=&homeserver($uname,$udom);
824: if (!$uhome) {
825: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
826: return 'no_host';
827: }
828: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
829: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
830: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 831: }
1.456 albertel 832: return $answer;
1.169 harris41 833: }
834:
1.1 albertel 835: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 836:
1.1 albertel 837: sub authenticate {
1.952 raeburn 838: my ($uname,$upass,$udom,$checkdefauth)=@_;
1.807 albertel 839: $upass=&escape($upass);
840: $uname= &LONCAPA::clean_username($uname);
1.836 www 841: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 842: my $newhome;
1.836 www 843: if ((!$uhome) || ($uhome eq 'no_host')) {
844: # Maybe the machine was offline and only re-appeared again recently?
845: &reconlonc();
846: # One more
1.952 raeburn 847: $uhome=&homeserver($uname,$udom,1);
848: if (($uhome eq 'no_host') && $checkdefauth) {
849: if (defined(&domain($udom,'primary'))) {
850: $newhome=&domain($udom,'primary');
851: }
852: if ($newhome ne '') {
853: $uhome = $newhome;
854: }
855: }
1.836 www 856: if ((!$uhome) || ($uhome eq 'no_host')) {
857: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 858: return 'no_host';
859: }
1.1 albertel 860: }
1.952 raeburn 861: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
1.471 albertel 862: if ($answer eq 'authorized') {
1.952 raeburn 863: if ($newhome) {
864: &logthis("User $uname at $udom authorized by $uhome, but needs account");
865: return 'no_account_on_host';
866: } else {
867: &logthis("User $uname at $udom authorized by $uhome");
868: return $uhome;
869: }
1.471 albertel 870: }
871: if ($answer eq 'non_authorized') {
872: &logthis("User $uname at $udom rejected by $uhome");
873: return 'no_host';
1.9 www 874: }
1.471 albertel 875: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 876: return 'no_host';
877: }
878:
879: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 880:
1.599 albertel 881: my %homecache;
1.1 albertel 882: sub homeserver {
1.230 stredwic 883: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 884: my $index="$uname:$udom";
1.426 albertel 885:
1.599 albertel 886: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 887:
888: my %servers = &get_servers($udom,'library');
889: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 890: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 891: exists($badServerCache{$tryserver}));
1.841 albertel 892:
893: my $answer=reply("home:$udom:$uname",$tryserver);
894: if ($answer eq 'found') {
895: delete($badServerCache{$tryserver});
896: return $homecache{$index}=$tryserver;
897: } elsif ($answer eq 'no_host') {
898: $badServerCache{$tryserver}=1;
899: }
1.1 albertel 900: }
901: return 'no_host';
1.70 www 902: }
903:
904: # ------------------------------------- Find the usernames behind a list of IDs
905:
906: sub idget {
907: my ($udom,@ids)=@_;
908: my %returnhash=();
909:
1.841 albertel 910: my %servers = &get_servers($udom,'library');
911: foreach my $tryserver (keys(%servers)) {
912: my $idlist=join('&',@ids);
913: $idlist=~tr/A-Z/a-z/;
914: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
915: my @answer=();
916: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
917: @answer=split(/\&/,$reply);
918: } ;
919: my $i;
920: for ($i=0;$i<=$#ids;$i++) {
921: if ($answer[$i]) {
922: $returnhash{$ids[$i]}=$answer[$i];
923: }
924: }
925: }
1.70 www 926: return %returnhash;
927: }
928:
929: # ------------------------------------- Find the IDs behind a list of usernames
930:
931: sub idrget {
932: my ($udom,@unames)=@_;
933: my %returnhash=();
1.800 albertel 934: foreach my $uname (@unames) {
935: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 936: }
1.70 www 937: return %returnhash;
938: }
939:
940: # ------------------------------- Store away a list of names and associated IDs
941:
942: sub idput {
943: my ($udom,%ids)=@_;
944: my %servers=();
1.800 albertel 945: foreach my $uname (keys(%ids)) {
946: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
947: my $uhom=&homeserver($uname,$udom);
1.70 www 948: if ($uhom ne 'no_host') {
1.800 albertel 949: my $id=&escape($ids{$uname});
1.70 www 950: $id=~tr/A-Z/a-z/;
1.800 albertel 951: my $esc_unam=&escape($uname);
1.70 www 952: if ($servers{$uhom}) {
1.800 albertel 953: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 954: } else {
1.800 albertel 955: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 956: }
957: }
1.191 harris41 958: }
1.800 albertel 959: foreach my $server (keys(%servers)) {
960: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 961: }
1.344 www 962: }
963:
1.1023 raeburn 964: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 965: sub dump_dom {
1.1023 raeburn 966: my ($namespace,$udom,$regexp,$range)=@_;
1.1012 raeburn 967: if (!$udom) {
968: $udom=$env{'user.domain'};
969: }
970: my %returnhash;
1.1023 raeburn 971: if ($udom) {
972: my $uname = &get_domainconfiguser($udom);
973: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
1.1012 raeburn 974: }
975: return %returnhash;
976: }
977:
1.1023 raeburn 978: # ------------------------------------------ get items from domain db files
1.806 raeburn 979:
980: sub get_dom {
1.860 raeburn 981: my ($namespace,$storearr,$udom,$uhome)=@_;
1.806 raeburn 982: my $items='';
983: foreach my $item (@$storearr) {
984: $items.=&escape($item).'&';
985: }
986: $items=~s/\&$//;
1.860 raeburn 987: if (!$udom) {
988: $udom=$env{'user.domain'};
989: if (defined(&domain($udom,'primary'))) {
990: $uhome=&domain($udom,'primary');
991: } else {
1.874 albertel 992: undef($uhome);
1.860 raeburn 993: }
994: } else {
995: if (!$uhome) {
996: if (defined(&domain($udom,'primary'))) {
997: $uhome=&domain($udom,'primary');
998: }
999: }
1000: }
1001: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1002: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 1003: my %returnhash;
1.875 albertel 1004: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1005: return %returnhash;
1006: }
1.806 raeburn 1007: my @pairs=split(/\&/,$rep);
1008: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1009: return @pairs;
1010: }
1011: my $i=0;
1012: foreach my $item (@$storearr) {
1013: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1014: $i++;
1015: }
1016: return %returnhash;
1017: } else {
1.880 banghart 1018: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1019: }
1020: }
1021:
1022: # -------------------------------------------- put items in domain db files
1023:
1024: sub put_dom {
1.860 raeburn 1025: my ($namespace,$storehash,$udom,$uhome)=@_;
1026: if (!$udom) {
1027: $udom=$env{'user.domain'};
1028: if (defined(&domain($udom,'primary'))) {
1029: $uhome=&domain($udom,'primary');
1030: } else {
1.874 albertel 1031: undef($uhome);
1.860 raeburn 1032: }
1033: } else {
1034: if (!$uhome) {
1035: if (defined(&domain($udom,'primary'))) {
1036: $uhome=&domain($udom,'primary');
1037: }
1038: }
1039: }
1040: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1041: my $items='';
1042: foreach my $item (keys(%$storehash)) {
1043: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1044: }
1045: $items=~s/\&$//;
1046: return &reply("putdom:$udom:$namespace:$items",$uhome);
1047: } else {
1.860 raeburn 1048: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1049: }
1050: }
1051:
1.1023 raeburn 1052: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 1053: sub newput_dom {
1.1023 raeburn 1054: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 1055: my $result;
1056: if (!$udom) {
1057: $udom=$env{'user.domain'};
1058: }
1.1023 raeburn 1059: if ($udom) {
1060: my $uname = &get_domainconfiguser($udom);
1061: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 1062: }
1063: return $result;
1064: }
1065:
1.1023 raeburn 1066: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 1067: sub del_dom {
1.1023 raeburn 1068: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 1069: if (ref($storearr) eq 'ARRAY') {
1070: if (!$udom) {
1071: $udom=$env{'user.domain'};
1072: }
1.1023 raeburn 1073: if ($udom) {
1074: my $uname = &get_domainconfiguser($udom);
1075: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 1076: }
1077: }
1078: }
1079:
1.1023 raeburn 1080: # ----------------------------------construct domainconfig user for a domain
1081: sub get_domainconfiguser {
1082: my ($udom) = @_;
1083: return $udom.'-domainconfig';
1084: }
1085:
1.837 raeburn 1086: sub retrieve_inst_usertypes {
1087: my ($udom) = @_;
1088: my (%returnhash,@order);
1.989 raeburn 1089: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1090: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1091: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1092: %returnhash = %{$domdefs{'inststatustypes'}};
1093: @order = @{$domdefs{'inststatusorder'}};
1094: } else {
1095: if (defined(&domain($udom,'primary'))) {
1096: my $uhome=&domain($udom,'primary');
1097: my $rep=&reply("inst_usertypes:$udom",$uhome);
1098: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1099: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1100: return (\%returnhash,\@order);
1101: }
1102: my ($hashitems,$orderitems) = split(/:/,$rep);
1103: my @pairs=split(/\&/,$hashitems);
1104: foreach my $item (@pairs) {
1105: my ($key,$value)=split(/=/,$item,2);
1106: $key = &unescape($key);
1107: next if ($key =~ /^error: 2 /);
1108: $returnhash{$key}=&thaw_unescape($value);
1109: }
1110: my @esc_order = split(/\&/,$orderitems);
1111: foreach my $item (@esc_order) {
1112: push(@order,&unescape($item));
1113: }
1114: } else {
1115: &logthis("get_dom failed - no primary domain server for $udom");
1.837 raeburn 1116: }
1117: }
1118: return (\%returnhash,\@order);
1119: }
1120:
1.868 raeburn 1121: sub is_domainimage {
1122: my ($url) = @_;
1123: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1124: if (&domain($1) ne '') {
1125: return '1';
1126: }
1127: }
1128: return;
1129: }
1130:
1.899 raeburn 1131: sub inst_directory_query {
1132: my ($srch) = @_;
1133: my $udom = $srch->{'srchdomain'};
1134: my %results;
1135: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1136: my $outcome;
1.899 raeburn 1137: if ($homeserver ne '') {
1.904 albertel 1138: my $queryid=&reply("querysend:instdirsearch:".
1139: &escape($srch->{'srchby'}).':'.
1140: &escape($srch->{'srchterm'}).':'.
1141: &escape($srch->{'srchtype'}),$homeserver);
1142: my $host=&hostname($homeserver);
1143: if ($queryid !~/^\Q$host\E\_/) {
1144: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1145: return;
1146: }
1147: my $response = &get_query_reply($queryid);
1148: my $maxtries = 5;
1149: my $tries = 1;
1150: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1151: $response = &get_query_reply($queryid);
1152: $tries ++;
1153: }
1154:
1155: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1156: if ($response eq 'unavailable') {
1157: $outcome = $response;
1158: } else {
1159: $outcome = 'ok';
1160: my @matches = split(/\n/,$response);
1161: foreach my $match (@matches) {
1162: my ($key,$value) = split(/=/,$match);
1163: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1164: }
1.899 raeburn 1165: }
1166: }
1167: }
1.909 raeburn 1168: return ($outcome,%results);
1.899 raeburn 1169: }
1170:
1171: sub usersearch {
1172: my ($srch) = @_;
1173: my $dom = $srch->{'srchdomain'};
1174: my %results;
1175: my %libserv = &all_library();
1176: my $query = 'usersearch';
1177: foreach my $tryserver (keys(%libserv)) {
1178: if (&host_domain($tryserver) eq $dom) {
1179: my $host=&hostname($tryserver);
1180: my $queryid=
1.911 raeburn 1181: &reply("querysend:".&escape($query).':'.
1182: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1183: &escape($srch->{'srchtype'}).':'.
1184: &escape($srch->{'srchterm'}),$tryserver);
1185: if ($queryid !~/^\Q$host\E\_/) {
1186: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1187: next;
1.899 raeburn 1188: }
1189: my $reply = &get_query_reply($queryid);
1190: my $maxtries = 1;
1191: my $tries = 1;
1192: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1193: $reply = &get_query_reply($queryid);
1194: $tries ++;
1195: }
1196: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1197: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1198: } else {
1.911 raeburn 1199: my @matches;
1200: if ($reply =~ /\n/) {
1201: @matches = split(/\n/,$reply);
1202: } else {
1203: @matches = split(/\&/,$reply);
1204: }
1.899 raeburn 1205: foreach my $match (@matches) {
1206: my ($uname,$udom,%userhash);
1.911 raeburn 1207: foreach my $entry (split(/:/,$match)) {
1208: my ($key,$value) =
1209: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1210: $userhash{$key} = $value;
1211: if ($key eq 'username') {
1212: $uname = $value;
1213: } elsif ($key eq 'domain') {
1214: $udom = $value;
1.911 raeburn 1215: }
1.899 raeburn 1216: }
1217: $results{$uname.':'.$udom} = \%userhash;
1218: }
1219: }
1220: }
1221: }
1222: return %results;
1223: }
1224:
1.912 raeburn 1225: sub get_instuser {
1226: my ($udom,$uname,$id) = @_;
1227: my $homeserver = &domain($udom,'primary');
1228: my ($outcome,%results);
1229: if ($homeserver ne '') {
1230: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1231: &escape($id).':'.&escape($udom),$homeserver);
1232: my $host=&hostname($homeserver);
1233: if ($queryid !~/^\Q$host\E\_/) {
1234: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1235: return;
1236: }
1237: my $response = &get_query_reply($queryid);
1238: my $maxtries = 5;
1239: my $tries = 1;
1240: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1241: $response = &get_query_reply($queryid);
1242: $tries ++;
1243: }
1244: if (!&error($response) && $response ne 'refused') {
1245: if ($response eq 'unavailable') {
1246: $outcome = $response;
1247: } else {
1248: $outcome = 'ok';
1249: my @matches = split(/\n/,$response);
1250: foreach my $match (@matches) {
1251: my ($key,$value) = split(/=/,$match);
1252: $results{&unescape($key)} = &thaw_unescape($value);
1253: }
1254: }
1255: }
1256: }
1257: my %userinfo;
1258: if (ref($results{$uname}) eq 'HASH') {
1259: %userinfo = %{$results{$uname}};
1260: }
1261: return ($outcome,%userinfo);
1262: }
1263:
1264: sub inst_rulecheck {
1.923 raeburn 1265: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 1266: my %returnhash;
1267: if ($udom ne '') {
1268: if (ref($rules) eq 'ARRAY') {
1269: @{$rules} = map {&escape($_);} (@{$rules});
1270: my $rulestr = join(':',@{$rules});
1271: my $homeserver=&domain($udom,'primary');
1272: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1273: my $response;
1274: if ($item eq 'username') {
1275: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1276: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 1277: $homeserver));
1.923 raeburn 1278: } elsif ($item eq 'id') {
1279: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1280: ':'.&escape($id).':'.$rulestr,
1281: $homeserver));
1.945 raeburn 1282: } elsif ($item eq 'selfcreate') {
1283: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 1284: &escape($udom).':'.&escape($uname).
1285: ':'.$rulestr,$homeserver));
1.923 raeburn 1286: }
1.912 raeburn 1287: if ($response ne 'refused') {
1288: my @pairs=split(/\&/,$response);
1289: foreach my $item (@pairs) {
1290: my ($key,$value)=split(/=/,$item,2);
1291: $key = &unescape($key);
1292: next if ($key =~ /^error: 2 /);
1293: $returnhash{$key}=&thaw_unescape($value);
1294: }
1295: }
1296: }
1297: }
1298: }
1299: return %returnhash;
1300: }
1301:
1302: sub inst_userrules {
1.923 raeburn 1303: my ($udom,$check) = @_;
1.912 raeburn 1304: my (%ruleshash,@ruleorder);
1305: if ($udom ne '') {
1306: my $homeserver=&domain($udom,'primary');
1307: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1308: my $response;
1309: if ($check eq 'id') {
1310: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 1311: $homeserver);
1.943 raeburn 1312: } elsif ($check eq 'email') {
1313: $response=&reply('instemailrules:'.&escape($udom),
1314: $homeserver);
1.923 raeburn 1315: } else {
1316: $response=&reply('instuserrules:'.&escape($udom),
1317: $homeserver);
1318: }
1.912 raeburn 1319: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 1320: ($response ne 'unknown_cmd') &&
1.912 raeburn 1321: ($response ne 'no_such_host')) {
1322: my ($hashitems,$orderitems) = split(/:/,$response);
1323: my @pairs=split(/\&/,$hashitems);
1324: foreach my $item (@pairs) {
1325: my ($key,$value)=split(/=/,$item,2);
1326: $key = &unescape($key);
1327: next if ($key =~ /^error: 2 /);
1328: $ruleshash{$key}=&thaw_unescape($value);
1329: }
1330: my @esc_order = split(/\&/,$orderitems);
1331: foreach my $item (@esc_order) {
1332: push(@ruleorder,&unescape($item));
1333: }
1334: }
1335: }
1336: }
1337: return (\%ruleshash,\@ruleorder);
1338: }
1339:
1.976 raeburn 1340: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 1341:
1342: sub get_domain_defaults {
1343: my ($domain) = @_;
1344: my $cachetime = 60*60*24;
1345: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1346: if (defined($cached)) {
1347: if (ref($result) eq 'HASH') {
1348: return %{$result};
1349: }
1350: }
1351: my %domdefaults;
1352: my %domconfig =
1.989 raeburn 1353: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 1354: 'requestcourses','inststatus',
1355: 'coursedefaults'],$domain);
1.943 raeburn 1356: if (ref($domconfig{'defaults'}) eq 'HASH') {
1357: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1358: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1359: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 1360: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 1361: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.943 raeburn 1362: } else {
1363: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1364: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1365: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1366: }
1.976 raeburn 1367: if (ref($domconfig{'quotas'}) eq 'HASH') {
1368: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1369: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1370: } else {
1371: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1372: }
1373: my @usertools = ('aboutme','blog','portfolio');
1374: foreach my $item (@usertools) {
1375: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1376: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1377: }
1378: }
1379: }
1.985 raeburn 1380: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1006 raeburn 1381: foreach my $item ('official','unofficial','community') {
1.985 raeburn 1382: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1383: }
1384: }
1.989 raeburn 1385: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1386: foreach my $item ('inststatustypes','inststatusorder') {
1387: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1388: }
1389: }
1.1047 raeburn 1390: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1391: foreach my $item ('canuse_pdfforms') {
1392: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1393: }
1394: }
1.943 raeburn 1395: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1396: $cachetime);
1397: return %domdefaults;
1398: }
1399:
1.344 www 1400: # --------------------------------------------------- Assign a key to a student
1401:
1402: sub assign_access_key {
1.364 www 1403: #
1404: # a valid key looks like uname:udom#comments
1405: # comments are being appended
1406: #
1.498 www 1407: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1408: $kdom=
1.620 albertel 1409: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 1410: $knum=
1.620 albertel 1411: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 1412: $cdom=
1.620 albertel 1413: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1414: $cnum=
1.620 albertel 1415: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1416: $udom=$env{'user.name'} unless (defined($udom));
1417: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 1418: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 1419: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 1420: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 1421: # assigned to this person
1422: # - this should not happen,
1.345 www 1423: # unless something went wrong
1424: # the first time around
1425: # ready to assign
1.364 www 1426: $logentry=$1.'; '.$logentry;
1.496 www 1427: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 1428: $kdom,$knum) eq 'ok') {
1.345 www 1429: # key now belongs to user
1.346 www 1430: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 1431: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 1432: &appenv({'environment.'.$envkey => $ckey});
1.345 www 1433: return 'ok';
1434: } else {
1435: return
1436: 'error: Count not permanently assign key, will need to be re-entered later.';
1437: }
1438: } else {
1439: return 'error: Could not assign key, try again later.';
1440: }
1.364 www 1441: } elsif (!$existing{$ckey}) {
1.345 www 1442: # the key does not exist
1443: return 'error: The key does not exist';
1444: } else {
1445: # the key is somebody else's
1446: return 'error: The key is already in use';
1447: }
1.344 www 1448: }
1449:
1.364 www 1450: # ------------------------------------------ put an additional comment on a key
1451:
1452: sub comment_access_key {
1453: #
1454: # a valid key looks like uname:udom#comments
1455: # comments are being appended
1456: #
1457: my ($ckey,$cdom,$cnum,$logentry)=@_;
1458: $cdom=
1.620 albertel 1459: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 1460: $cnum=
1.620 albertel 1461: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 1462: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1463: if ($existing{$ckey}) {
1464: $existing{$ckey}.='; '.$logentry;
1465: # ready to assign
1.367 www 1466: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 1467: $cdom,$cnum) eq 'ok') {
1468: return 'ok';
1469: } else {
1470: return 'error: Count not store comment.';
1471: }
1472: } else {
1473: # the key does not exist
1474: return 'error: The key does not exist';
1475: }
1476: }
1477:
1.344 www 1478: # ------------------------------------------------------ Generate a set of keys
1479:
1480: sub generate_access_keys {
1.364 www 1481: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 1482: $cdom=
1.620 albertel 1483: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1484: $cnum=
1.620 albertel 1485: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 1486: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 1487: unless (($cdom) && ($cnum)) { return 0; }
1488: if ($number>10000) { return 0; }
1489: sleep(2); # make sure don't get same seed twice
1490: srand(time()^($$+($$<<15))); # from "Programming Perl"
1491: my $total=0;
1492: for (my $i=1;$i<=$number;$i++) {
1493: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1494: sprintf("%lx",int(100000*rand)).'-'.
1495: sprintf("%lx",int(100000*rand));
1496: $newkey=~s/1/g/g; # folks mix up 1 and l
1497: $newkey=~s/0/h/g; # and also 0 and O
1498: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1499: if ($existing{$newkey}) {
1500: $i--;
1501: } else {
1.364 www 1502: if (&put('accesskeys',
1503: { $newkey => '# generated '.localtime().
1.620 albertel 1504: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 1505: '; '.$logentry },
1506: $cdom,$cnum) eq 'ok') {
1.344 www 1507: $total++;
1508: }
1509: }
1510: }
1.620 albertel 1511: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 1512: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1513: return $total;
1514: }
1515:
1516: # ------------------------------------------------------- Validate an accesskey
1517:
1518: sub validate_access_key {
1519: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1520: $cdom=
1.620 albertel 1521: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1522: $cnum=
1.620 albertel 1523: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1524: $udom=$env{'user.domain'} unless (defined($udom));
1525: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 1526: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 1527: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 1528: }
1529:
1530: # ------------------------------------- Find the section of student in a course
1.652 albertel 1531: sub devalidate_getsection_cache {
1532: my ($udom,$unam,$courseid)=@_;
1533: my $hashid="$udom:$unam:$courseid";
1534: &devalidate_cache_new('getsection',$hashid);
1535: }
1.298 matthew 1536:
1.815 albertel 1537: sub courseid_to_courseurl {
1538: my ($courseid) = @_;
1539: #already url style courseid
1540: return $courseid if ($courseid =~ m{^/});
1541:
1542: if (exists($env{'course.'.$courseid.'.num'})) {
1543: my $cnum = $env{'course.'.$courseid.'.num'};
1544: my $cdom = $env{'course.'.$courseid.'.domain'};
1545: return "/$cdom/$cnum";
1546: }
1547:
1548: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1549: if (exists($courseinfo{'num'})) {
1550: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1551: }
1552:
1553: return undef;
1554: }
1555:
1.298 matthew 1556: sub getsection {
1557: my ($udom,$unam,$courseid)=@_;
1.599 albertel 1558: my $cachetime=1800;
1.551 albertel 1559:
1560: my $hashid="$udom:$unam:$courseid";
1.599 albertel 1561: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 1562: if (defined($cached)) { return $result; }
1563:
1.298 matthew 1564: my %Pending;
1565: my %Expired;
1566: #
1567: # Each role can either have not started yet (pending), be active,
1568: # or have expired.
1569: #
1570: # If there is an active role, we are done.
1571: #
1572: # If there is more than one role which has not started yet,
1573: # choose the one which will start sooner
1574: # If there is one role which has not started yet, return it.
1575: #
1576: # If there is more than one expired role, choose the one which ended last.
1577: # If there is a role which has expired, return it.
1578: #
1.815 albertel 1579: $courseid = &courseid_to_courseurl($courseid);
1.817 raeburn 1580: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1581: foreach my $key (keys(%roleshash)) {
1.479 albertel 1582: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 1583: my $section=$1;
1584: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 1585: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 1586: my $now=time;
1.548 albertel 1587: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 1588: $Expired{$end}=$section;
1589: next;
1590: }
1.548 albertel 1591: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 1592: $Pending{$start}=$section;
1593: next;
1594: }
1.599 albertel 1595: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 1596: }
1597: #
1598: # Presumedly there will be few matching roles from the above
1599: # loop and the sorting time will be negligible.
1600: if (scalar(keys(%Pending))) {
1601: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 1602: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 1603: }
1604: if (scalar(keys(%Expired))) {
1605: my @sorted = sort {$a <=> $b} keys(%Expired);
1606: my $time = pop(@sorted);
1.599 albertel 1607: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 1608: }
1.599 albertel 1609: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 1610: }
1.70 www 1611:
1.599 albertel 1612: sub save_cache {
1613: &purge_remembered();
1.722 albertel 1614: #&Apache::loncommon::validate_page();
1.620 albertel 1615: undef(%env);
1.780 albertel 1616: undef($env_loaded);
1.599 albertel 1617: }
1.452 albertel 1618:
1.599 albertel 1619: my $to_remember=-1;
1620: my %remembered;
1621: my %accessed;
1622: my $kicks=0;
1623: my $hits=0;
1.849 albertel 1624: sub make_key {
1625: my ($name,$id) = @_;
1.872 albertel 1626: if (length($id) > 65
1627: && length(&escape($id)) > 200) {
1628: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1629: }
1.849 albertel 1630: return &escape($name.':'.$id);
1631: }
1632:
1.599 albertel 1633: sub devalidate_cache_new {
1634: my ($name,$id,$debug) = @_;
1635: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 1636: $id=&make_key($name,$id);
1.599 albertel 1637: $memcache->delete($id);
1638: delete($remembered{$id});
1639: delete($accessed{$id});
1640: }
1641:
1642: sub is_cached_new {
1643: my ($name,$id,$debug) = @_;
1.849 albertel 1644: $id=&make_key($name,$id);
1.599 albertel 1645: if (exists($remembered{$id})) {
1646: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1647: $accessed{$id}=[&gettimeofday()];
1648: $hits++;
1649: return ($remembered{$id},1);
1650: }
1651: my $value = $memcache->get($id);
1652: if (!(defined($value))) {
1653: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 1654: return (undef,undef);
1.416 albertel 1655: }
1.599 albertel 1656: if ($value eq '__undef__') {
1657: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1658: $value=undef;
1659: }
1660: &make_room($id,$value,$debug);
1661: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1662: return ($value,1);
1663: }
1664:
1665: sub do_cache_new {
1666: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 1667: $id=&make_key($name,$id);
1.599 albertel 1668: my $setvalue=$value;
1669: if (!defined($setvalue)) {
1670: $setvalue='__undef__';
1671: }
1.623 albertel 1672: if (!defined($time) ) {
1673: $time=600;
1674: }
1.599 albertel 1675: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 1676: my $result = $memcache->set($id,$setvalue,$time);
1677: if (! $result) {
1.872 albertel 1678: &logthis("caching of id -> $id failed");
1.910 albertel 1679: $memcache->disconnect_all();
1.872 albertel 1680: }
1.600 albertel 1681: # need to make a copy of $value
1.919 albertel 1682: &make_room($id,$value,$debug);
1.599 albertel 1683: return $value;
1684: }
1685:
1686: sub make_room {
1687: my ($id,$value,$debug)=@_;
1.919 albertel 1688:
1689: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1690: : $value;
1.599 albertel 1691: if ($to_remember<0) { return; }
1692: $accessed{$id}=[&gettimeofday()];
1693: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1694: my $to_kick;
1695: my $max_time=0;
1696: foreach my $other (keys(%accessed)) {
1697: if (&tv_interval($accessed{$other}) > $max_time) {
1698: $to_kick=$other;
1699: $max_time=&tv_interval($accessed{$other});
1700: }
1701: }
1702: delete($remembered{$to_kick});
1703: delete($accessed{$to_kick});
1704: $kicks++;
1705: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 1706: return;
1707: }
1708:
1.599 albertel 1709: sub purge_remembered {
1.604 albertel 1710: #&logthis("Tossing ".scalar(keys(%remembered)));
1711: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 1712: undef(%remembered);
1713: undef(%accessed);
1.428 albertel 1714: }
1.70 www 1715: # ------------------------------------- Read an entry from a user's environment
1716:
1717: sub userenvironment {
1718: my ($udom,$unam,@what)=@_;
1.976 raeburn 1719: my $items;
1720: foreach my $item (@what) {
1721: $items.=&escape($item).'&';
1722: }
1723: $items=~s/\&$//;
1.70 www 1724: my %returnhash=();
1.1009 raeburn 1725: my $uhome = &homeserver($unam,$udom);
1726: unless ($uhome eq 'no_host') {
1727: my @answer=split(/\&/,
1728: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 1729: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
1730: return %returnhash;
1731: }
1.1009 raeburn 1732: my $i;
1733: for ($i=0;$i<=$#what;$i++) {
1734: $returnhash{$what[$i]}=&unescape($answer[$i]);
1735: }
1.70 www 1736: }
1737: return %returnhash;
1.1 albertel 1738: }
1739:
1.617 albertel 1740: # ---------------------------------------------------------- Get a studentphoto
1741: sub studentphoto {
1742: my ($udom,$unam,$ext) = @_;
1743: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 1744: if (defined($env{'request.course.id'})) {
1.708 raeburn 1745: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 1746: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1747: return(&retrievestudentphoto($udom,$unam,$ext));
1748: } else {
1749: my ($result,$perm_reqd)=
1.707 albertel 1750: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1751: if ($result eq 'ok') {
1752: if (!($perm_reqd eq 'yes')) {
1753: return(&retrievestudentphoto($udom,$unam,$ext));
1754: }
1755: }
1756: }
1757: }
1758: } else {
1759: my ($result,$perm_reqd) =
1.707 albertel 1760: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1761: if ($result eq 'ok') {
1762: if (!($perm_reqd eq 'yes')) {
1763: return(&retrievestudentphoto($udom,$unam,$ext));
1764: }
1765: }
1766: }
1767: return '/adm/lonKaputt/lonlogo_broken.gif';
1768: }
1769:
1770: sub retrievestudentphoto {
1771: my ($udom,$unam,$ext,$type) = @_;
1772: my $home=&Apache::lonnet::homeserver($unam,$udom);
1773: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1774: if ($ret eq 'ok') {
1775: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1776: if ($type eq 'thumbnail') {
1777: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1778: }
1779: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1780: return $tokenurl;
1781: } else {
1782: if ($type eq 'thumbnail') {
1783: return '/adm/lonKaputt/genericstudent_tn.gif';
1784: } else {
1785: return '/adm/lonKaputt/lonlogo_broken.gif';
1786: }
1.617 albertel 1787: }
1788: }
1789:
1.263 www 1790: # -------------------------------------------------------------------- New chat
1791:
1792: sub chatsend {
1.724 raeburn 1793: my ($newentry,$anon,$group)=@_;
1.620 albertel 1794: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1795: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1796: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1797: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1798: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1799: &escape($newentry)).':'.$group,$chome);
1.292 www 1800: }
1801:
1802: # ------------------------------------------ Find current version of a resource
1803:
1804: sub getversion {
1805: my $fname=&clutter(shift);
1806: unless ($fname=~/^\/res\//) { return -1; }
1807: return ¤tversion(&filelocation('',$fname));
1808: }
1809:
1810: sub currentversion {
1811: my $fname=shift;
1.599 albertel 1812: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1813: if (defined($cached)) { return $result; }
1.292 www 1814: my $author=$fname;
1815: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1816: my ($udom,$uname)=split(/\//,$author);
1817: my $home=homeserver($uname,$udom);
1818: if ($home eq 'no_host') {
1819: return -1;
1820: }
1821: my $answer=reply("currentversion:$fname",$home);
1822: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1823: return -1;
1824: }
1.599 albertel 1825: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1826: }
1827:
1.1 albertel 1828: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1829:
1.1 albertel 1830: sub subscribe {
1831: my $fname=shift;
1.761 raeburn 1832: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1833: $fname=~s/[\n\r]//g;
1.1 albertel 1834: my $author=$fname;
1835: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1836: my ($udom,$uname)=split(/\//,$author);
1837: my $home=homeserver($uname,$udom);
1.335 albertel 1838: if ($home eq 'no_host') {
1839: return 'not_found';
1.1 albertel 1840: }
1841: my $answer=reply("sub:$fname",$home);
1.64 www 1842: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1843: $answer.=' by '.$home;
1844: }
1.1 albertel 1845: return $answer;
1846: }
1847:
1.8 www 1848: # -------------------------------------------------------------- Replicate file
1849:
1850: sub repcopy {
1851: my $filename=shift;
1.23 www 1852: $filename=~s/\/+/\//g;
1.607 raeburn 1853: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1854: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1855: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1856: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1857: return &repcopy_userfile($filename);
1858: }
1.532 albertel 1859: $filename=~s/[\n\r]//g;
1.8 www 1860: my $transname="$filename.in.transfer";
1.828 www 1861: # FIXME: this should flock
1.607 raeburn 1862: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1863: my $remoteurl=subscribe($filename);
1.64 www 1864: if ($remoteurl =~ /^con_lost by/) {
1865: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1866: return 'unavailable';
1.8 www 1867: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1868: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1869: return 'not_found';
1.64 www 1870: } elsif ($remoteurl =~ /^rejected by/) {
1871: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1872: return 'forbidden';
1.20 www 1873: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1874: return 'ok';
1.8 www 1875: } else {
1.290 www 1876: my $author=$filename;
1877: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1878: my ($udom,$uname)=split(/\//,$author);
1879: my $home=homeserver($uname,$udom);
1880: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1881: my @parts=split(/\//,$filename);
1882: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1883: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1884: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1885: return 'bad_request';
1.8 www 1886: }
1887: my $count;
1888: for ($count=5;$count<$#parts;$count++) {
1889: $path.="/$parts[$count]";
1890: if ((-e $path)!=1) {
1891: mkdir($path,0777);
1892: }
1893: }
1894: my $ua=new LWP::UserAgent;
1895: my $request=new HTTP::Request('GET',"$remoteurl");
1896: my $response=$ua->request($request,$transname);
1897: if ($response->is_error()) {
1898: unlink($transname);
1899: my $message=$response->status_line;
1.672 albertel 1900: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1901: ." LWP get: $message: $filename</font>");
1.607 raeburn 1902: return 'unavailable';
1.8 www 1903: } else {
1.16 www 1904: if ($remoteurl!~/\.meta$/) {
1905: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1906: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1907: if ($mresponse->is_error()) {
1908: unlink($filename.'.meta');
1909: &logthis(
1.672 albertel 1910: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1911: }
1912: }
1.8 www 1913: rename($transname,$filename);
1.607 raeburn 1914: return 'ok';
1.8 www 1915: }
1.290 www 1916: }
1.8 www 1917: }
1.330 www 1918: }
1919:
1920: # ------------------------------------------------ Get server side include body
1921: sub ssi_body {
1.381 albertel 1922: my ($filelink,%form)=@_;
1.606 matthew 1923: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1924: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1925: }
1.953 www 1926: my $output='';
1927: my $response;
1.980 raeburn 1928: if ($filelink=~/^https?\:/) {
1.954 raeburn 1929: ($output,$response)=&externalssi($filelink);
1.953 www 1930: } else {
1.1004 droeschl 1931: $filelink .= $filelink=~/\?/ ? '&' : '?';
1932: $filelink .= 'inhibitmenu=yes';
1.953 www 1933: ($output,$response)=&ssi($filelink,%form);
1934: }
1.778 albertel 1935: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1936: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 1937: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 1938: if (wantarray) {
1939: return ($output, $response);
1940: } else {
1941: return $output;
1942: }
1.8 www 1943: }
1944:
1.15 www 1945: # --------------------------------------------------------- Server Side Include
1946:
1.782 albertel 1947: sub absolute_url {
1948: my ($host_name) = @_;
1949: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1950: if ($host_name eq '') {
1951: $host_name = $ENV{'SERVER_NAME'};
1952: }
1953: return $protocol.$host_name;
1954: }
1955:
1.942 foxr 1956: #
1957: # Server side include.
1958: # Parameters:
1959: # fn Possibly encrypted resource name/id.
1960: # form Hash that describes how the rendering should be done
1961: # and other things.
1.944 foxr 1962: # Returns:
1.950 raeburn 1963: # Scalar context: The content of the response.
1964: # Array context: 2 element list of the content and the full response object.
1.942 foxr 1965: #
1.15 www 1966: sub ssi {
1967:
1.944 foxr 1968: my ($fn,%form)=@_;
1.15 www 1969: my $ua=new LWP::UserAgent;
1.23 www 1970: my $request;
1.711 albertel 1971:
1972: $form{'no_update_last_known'}=1;
1.895 albertel 1973: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 1974: if (%form) {
1.782 albertel 1975: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000 raeburn 1976: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23 www 1977: } else {
1.782 albertel 1978: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 1979: }
1980:
1.15 www 1981: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1982: my $response=$ua->request($request);
1983:
1.944 foxr 1984: if (wantarray) {
1985: return ($response->content, $response);
1986: } else {
1987: return $response->content;
1.942 foxr 1988: }
1.324 www 1989: }
1990:
1991: sub externalssi {
1992: my ($url)=@_;
1993: my $ua=new LWP::UserAgent;
1994: my $request=new HTTP::Request('GET',$url);
1995: my $response=$ua->request($request);
1.954 raeburn 1996: if (wantarray) {
1997: return ($response->content, $response);
1998: } else {
1999: return $response->content;
2000: }
1.15 www 2001: }
1.254 www 2002:
1.492 albertel 2003: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2004:
2005: sub allowuploaded {
2006: my ($srcurl,$url)=@_;
2007: $url=&clutter(&declutter($url));
2008: my $dir=$url;
2009: $dir=~s/\/[^\/]+$//;
2010: my %httpref=();
2011: my $httpurl=&hreflocation('',$url);
2012: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2013: &Apache::lonnet::appenv(\%httpref);
1.254 www 2014: }
1.477 raeburn 2015:
1.478 albertel 2016: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 2017: # input: action, courseID, current domain, intended
1.637 raeburn 2018: # path to file, source of file, instruction to parse file for objects,
2019: # ref to hash for embedded objects,
2020: # ref to hash for codebase of java objects.
2021: #
1.485 raeburn 2022: # output: url to file (if action was uploaddoc),
2023: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 2024: #
1.478 albertel 2025: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2026: # course.
1.477 raeburn 2027: #
1.478 albertel 2028: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2029: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2030: # course's home server.
1.477 raeburn 2031: #
1.478 albertel 2032: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2033: # be copied from $source (current location) to
2034: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2035: # and will then be copied to
2036: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2037: # course's home server.
1.485 raeburn 2038: #
1.481 raeburn 2039: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 2040: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 2041: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2042: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2043: # in course's home server.
1.637 raeburn 2044: #
1.477 raeburn 2045:
2046: sub process_coursefile {
1.638 albertel 2047: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 2048: my $fetchresult;
1.638 albertel 2049: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 2050: if ($action eq 'propagate') {
1.638 albertel 2051: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2052: $home);
1.481 raeburn 2053: } else {
1.477 raeburn 2054: my $fpath = '';
2055: my $fname = $file;
1.478 albertel 2056: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 2057: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 2058: my $filepath = &build_filepath($fpath);
1.481 raeburn 2059: if ($action eq 'copy') {
2060: if ($source eq '') {
2061: $fetchresult = 'no source file';
2062: return $fetchresult;
2063: } else {
2064: my $destination = $filepath.'/'.$fname;
2065: rename($source,$destination);
2066: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2067: $home);
1.481 raeburn 2068: }
2069: } elsif ($action eq 'uploaddoc') {
2070: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 2071: print $fh $env{'form.'.$source};
1.481 raeburn 2072: close($fh);
1.637 raeburn 2073: if ($parser eq 'parse') {
1.1024 raeburn 2074: my $mm = new File::MMagic;
2075: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2076: if ($mime_type eq 'text/html') {
2077: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2078: unless ($parse_result eq 'ok') {
2079: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2080: }
1.637 raeburn 2081: }
2082: }
1.477 raeburn 2083: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2084: $home);
1.481 raeburn 2085: if ($fetchresult eq 'ok') {
2086: return '/uploaded/'.$fpath.'/'.$fname;
2087: } else {
2088: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2089: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 2090: return '/adm/notfound.html';
2091: }
1.477 raeburn 2092: }
2093: }
1.485 raeburn 2094: unless ( $fetchresult eq 'ok') {
1.477 raeburn 2095: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2096: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 2097: }
2098: return $fetchresult;
2099: }
2100:
1.637 raeburn 2101: sub build_filepath {
2102: my ($fpath) = @_;
2103: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2104: unless ($fpath eq '') {
2105: my @parts=split('/',$fpath);
2106: foreach my $part (@parts) {
2107: $filepath.= '/'.$part;
2108: if ((-e $filepath)!=1) {
2109: mkdir($filepath,0777);
2110: }
2111: }
2112: }
2113: return $filepath;
2114: }
2115:
2116: sub store_edited_file {
1.638 albertel 2117: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 2118: my $file = $primary_url;
2119: $file =~ s#^/uploaded/$docudom/$docuname/##;
2120: my $fpath = '';
2121: my $fname = $file;
2122: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2123: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2124: my $filepath = &build_filepath($fpath);
2125: open(my $fh,'>'.$filepath.'/'.$fname);
2126: print $fh $content;
2127: close($fh);
1.638 albertel 2128: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 2129: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2130: $home);
1.637 raeburn 2131: if ($$fetchresult eq 'ok') {
2132: return '/uploaded/'.$fpath.'/'.$fname;
2133: } else {
1.638 albertel 2134: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2135: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 2136: return '/adm/notfound.html';
2137: }
2138: }
2139:
1.531 albertel 2140: sub clean_filename {
1.831 albertel 2141: my ($fname,$args)=@_;
1.315 www 2142: # Replace Windows backslashes by forward slashes
1.257 www 2143: $fname=~s/\\/\//g;
1.831 albertel 2144: if (!$args->{'keep_path'}) {
2145: # Get rid of everything but the actual filename
2146: $fname=~s/^.*\/([^\/]+)$/$1/;
2147: }
1.315 www 2148: # Replace spaces by underscores
2149: $fname=~s/\s+/\_/g;
2150: # Replace all other weird characters by nothing
1.831 albertel 2151: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 2152: # Replace all .\d. sequences with _\d. so they no longer look like version
2153: # numbers
2154: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 2155: return $fname;
2156: }
1.1051 raeburn 2157: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2158: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2159: # image with the same aspect ratio as the original, but with dimensions which do
2160: # not exceed $resizewidth and $resizeheight.
2161:
1.984 neumanie 2162: sub resizeImage {
1.1051 raeburn 2163: my ($img_path,$resizewidth,$resizeheight) = @_;
2164: my $ima = Image::Magick->new;
2165: my $resized;
2166: if (-e $img_path) {
2167: $ima->Read($img_path);
2168: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2169: my $width = $ima->Get('width');
2170: my $height = $ima->Get('height');
2171: if ($width > $resizewidth) {
2172: my $factor = $width/$resizewidth;
2173: my $newheight = $height/$factor;
2174: $ima->Scale(width=>$resizewidth,height=>$newheight);
2175: $resized = 1;
2176: }
2177: }
2178: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2179: my $width = $ima->Get('width');
2180: my $height = $ima->Get('height');
2181: if ($height > $resizeheight) {
2182: my $factor = $height/$resizeheight;
2183: my $newwidth = $width/$factor;
2184: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2185: $resized = 1;
2186: }
2187: }
2188: if ($resized) {
2189: $ima->Write($img_path);
2190: }
2191: }
2192: return;
1.977 amueller 2193: }
2194:
1.608 albertel 2195: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 2196: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 2197: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 2198: # $coursedoc - if true up to the current course
2199: # if false
2200: # $subdir - directory in userfile to store the file into
1.858 raeburn 2201: # $parser - instruction to parse file for objects ($parser = parse)
2202: # $allfiles - reference to hash for embedded objects
2203: # $codebase - reference to hash for codebase of java objects
2204: # $desuname - username for permanent storage of uploaded file
2205: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 2206: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2207: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 2208: # $resizewidth - width (pixels) to which to resize uploaded image
2209: # $resizeheight - height (pixels) to which to resize uploaded image
1.858 raeburn 2210: #
1.686 albertel 2211: # output: url of file in userspace, or error: <message>
2212: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 2213:
1.531 albertel 2214: sub userfileupload {
1.860 raeburn 2215: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1051 raeburn 2216: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight)=@_;
1.531 albertel 2217: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 2218: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 2219: $fname=&clean_filename($fname);
1.315 www 2220: # See if there is anything left
1.257 www 2221: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 2222: chop($env{'form.'.$formname});
1.523 raeburn 2223: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2224: my $now = time;
2225: my $filepath = 'tmp/helprequests/'.$now;
2226: my @parts=split(/\//,$filepath);
2227: my $fullpath = $perlvar{'lonDaemons'};
2228: for (my $i=0;$i<@parts;$i++) {
2229: $fullpath .= '/'.$parts[$i];
2230: if ((-e $fullpath)!=1) {
2231: mkdir($fullpath,0777);
2232: }
2233: }
2234: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 2235: print $fh $env{'form.'.$formname};
1.523 raeburn 2236: close($fh);
1.741 raeburn 2237: return $fullpath.'/'.$fname;
2238: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2239: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2240: '_'.$env{'user.domain'}.'/pending';
2241: my @parts=split(/\//,$filepath);
2242: my $fullpath = $perlvar{'lonDaemons'};
2243: for (my $i=0;$i<@parts;$i++) {
2244: $fullpath .= '/'.$parts[$i];
2245: if ((-e $fullpath)!=1) {
2246: mkdir($fullpath,0777);
2247: }
2248: }
2249: open(my $fh,'>'.$fullpath.'/'.$fname);
2250: print $fh $env{'form.'.$formname};
2251: close($fh);
2252: return $fullpath.'/'.$fname;
1.523 raeburn 2253: }
1.995 raeburn 2254: if ($subdir eq 'scantron') {
2255: $fname = 'scantron_orig_'.$fname;
2256: } else {
1.258 www 2257: # Create the directory if not present
1.995 raeburn 2258: $fname="$subdir/$fname";
2259: }
1.259 www 2260: if ($coursedoc) {
1.638 albertel 2261: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2262: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 2263: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 2264: return &finishuserfileupload($docuname,$docudom,
2265: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 2266: $codebase,$thumbwidth,$thumbheight,
2267: $resizewidth,$resizeheight);
1.481 raeburn 2268: } else {
1.620 albertel 2269: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 2270: return &process_coursefile('uploaddoc',$docuname,$docudom,
2271: $fname,$formname,$parser,
2272: $allfiles,$codebase);
1.481 raeburn 2273: }
1.719 banghart 2274: } elsif (defined($destuname)) {
2275: my $docuname=$destuname;
2276: my $docudom=$destudom;
1.860 raeburn 2277: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2278: $parser,$allfiles,$codebase,
1.1051 raeburn 2279: $thumbwidth,$thumbheight,
2280: $resizewidth,$resizeheight);
1.719 banghart 2281:
1.259 www 2282: } else {
1.638 albertel 2283: my $docuname=$env{'user.name'};
2284: my $docudom=$env{'user.domain'};
1.714 raeburn 2285: if (exists($env{'form.group'})) {
2286: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2287: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2288: }
1.860 raeburn 2289: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2290: $parser,$allfiles,$codebase,
1.1051 raeburn 2291: $thumbwidth,$thumbheight,
2292: $resizewidth,$resizeheight);
1.259 www 2293: }
1.271 www 2294: }
2295:
2296: sub finishuserfileupload {
1.860 raeburn 2297: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1051 raeburn 2298: $thumbwidth,$thumbheight,$resizewidth,$resizeheight) = @_;
1.477 raeburn 2299: my $path=$docudom.'/'.$docuname.'/';
1.258 www 2300: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 2301:
1.860 raeburn 2302: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 2303: $file=$fname;
2304: if ($fname=~m|/|) {
2305: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2306: $path.=$fnamepath.'/';
2307: }
1.259 www 2308: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 2309: my $count;
2310: for ($count=4;$count<=$#parts;$count++) {
2311: $filepath.="/$parts[$count]";
2312: if ((-e $filepath)!=1) {
2313: mkdir($filepath,0777);
2314: }
2315: }
1.984 neumanie 2316:
1.258 www 2317: # Save the file
2318: {
1.701 albertel 2319: if (!open(FH,'>'.$filepath.'/'.$file)) {
2320: &logthis('Failed to create '.$filepath.'/'.$file);
2321: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2322: return '/adm/notfound.html';
2323: }
2324: if (!print FH ($env{'form.'.$formname})) {
2325: &logthis('Failed to write to '.$filepath.'/'.$file);
2326: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2327: return '/adm/notfound.html';
2328: }
1.570 albertel 2329: close(FH);
1.1051 raeburn 2330: if ($resizewidth && $resizeheight) {
2331: my $mm = new File::MMagic;
2332: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2333: if ($mime_type =~ m{^image/}) {
2334: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2335: }
1.977 amueller 2336: }
1.258 www 2337: }
1.637 raeburn 2338: if ($parser eq 'parse') {
1.1024 raeburn 2339: my $mm = new File::MMagic;
2340: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2341: if ($mime_type eq 'text/html') {
2342: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2343: $allfiles,$codebase);
2344: unless ($parse_result eq 'ok') {
2345: &logthis('Failed to parse '.$filepath.$file.
2346: ' for embedded media: '.$parse_result);
2347: }
1.637 raeburn 2348: }
2349: }
1.860 raeburn 2350: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2351: my $input = $filepath.'/'.$file;
2352: my $output = $filepath.'/'.'tn-'.$file;
2353: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2354: system("convert -sample $thumbsize $input $output");
2355: if (-e $filepath.'/'.'tn-'.$file) {
2356: $fetchthumb = 1;
2357: }
2358: }
1.858 raeburn 2359:
1.259 www 2360: # Notify homeserver to grep it
2361: #
1.984 neumanie 2362: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 2363: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 2364: if ($fetchresult eq 'ok') {
1.860 raeburn 2365: if ($fetchthumb) {
2366: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2367: if ($thumbresult ne 'ok') {
2368: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2369: $docuhome.': '.$thumbresult);
2370: }
2371: }
1.259 www 2372: #
1.258 www 2373: # Return the URL to it
1.494 albertel 2374: return '/uploaded/'.$path.$file;
1.263 www 2375: } else {
1.494 albertel 2376: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2377: ': '.$fetchresult);
1.263 www 2378: return '/adm/notfound.html';
1.858 raeburn 2379: }
1.493 albertel 2380: }
2381:
1.637 raeburn 2382: sub extract_embedded_items {
1.961 raeburn 2383: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 2384: my @state = ();
2385: my %javafiles = (
2386: codebase => '',
2387: code => '',
2388: archive => ''
2389: );
2390: my %mediafiles = (
2391: src => '',
2392: movie => '',
2393: );
1.648 raeburn 2394: my $p;
2395: if ($content) {
2396: $p = HTML::LCParser->new($content);
2397: } else {
1.961 raeburn 2398: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 2399: }
1.641 albertel 2400: while (my $t=$p->get_token()) {
1.640 albertel 2401: if ($t->[0] eq 'S') {
2402: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 2403: push(@state, $tagname);
1.648 raeburn 2404: if (lc($tagname) eq 'allow') {
2405: &add_filetype($allfiles,$attr->{'src'},'src');
2406: }
1.640 albertel 2407: if (lc($tagname) eq 'img') {
2408: &add_filetype($allfiles,$attr->{'src'},'src');
2409: }
1.886 albertel 2410: if (lc($tagname) eq 'a') {
2411: &add_filetype($allfiles,$attr->{'href'},'href');
2412: }
1.645 raeburn 2413: if (lc($tagname) eq 'script') {
2414: if ($attr->{'archive'} =~ /\.jar$/i) {
2415: &add_filetype($allfiles,$attr->{'archive'},'archive');
2416: } else {
2417: &add_filetype($allfiles,$attr->{'src'},'src');
2418: }
2419: }
2420: if (lc($tagname) eq 'link') {
2421: if (lc($attr->{'rel'}) eq 'stylesheet') {
2422: &add_filetype($allfiles,$attr->{'href'},'href');
2423: }
2424: }
1.640 albertel 2425: if (lc($tagname) eq 'object' ||
2426: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2427: foreach my $item (keys(%javafiles)) {
2428: $javafiles{$item} = '';
2429: }
2430: }
2431: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2432: my $name = lc($attr->{'name'});
2433: foreach my $item (keys(%javafiles)) {
2434: if ($name eq $item) {
2435: $javafiles{$item} = $attr->{'value'};
2436: last;
2437: }
2438: }
2439: foreach my $item (keys(%mediafiles)) {
2440: if ($name eq $item) {
2441: &add_filetype($allfiles, $attr->{'value'}, 'value');
2442: last;
2443: }
2444: }
2445: }
2446: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2447: foreach my $item (keys(%javafiles)) {
2448: if ($attr->{$item}) {
2449: $javafiles{$item} = $attr->{$item};
2450: last;
2451: }
2452: }
2453: foreach my $item (keys(%mediafiles)) {
2454: if ($attr->{$item}) {
2455: &add_filetype($allfiles,$attr->{$item},$item);
2456: last;
2457: }
2458: }
2459: }
2460: } elsif ($t->[0] eq 'E') {
2461: my ($tagname) = ($t->[1]);
2462: if ($javafiles{'codebase'} ne '') {
2463: $javafiles{'codebase'} .= '/';
2464: }
2465: if (lc($tagname) eq 'applet' ||
2466: lc($tagname) eq 'object' ||
2467: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2468: ) {
2469: foreach my $item (keys(%javafiles)) {
2470: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2471: my $file=$javafiles{'codebase'}.$javafiles{$item};
2472: &add_filetype($allfiles,$file,$item);
2473: }
2474: }
2475: }
2476: pop @state;
2477: }
2478: }
1.637 raeburn 2479: return 'ok';
2480: }
2481:
1.639 albertel 2482: sub add_filetype {
2483: my ($allfiles,$file,$type)=@_;
2484: if (exists($allfiles->{$file})) {
2485: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2486: push(@{$allfiles->{$file}}, &escape($type));
2487: }
2488: } else {
2489: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 2490: }
2491: }
2492:
1.493 albertel 2493: sub removeuploadedurl {
1.984 neumanie 2494: my ($url)=@_;
2495: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 2496: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 2497: }
2498:
2499: sub removeuserfile {
2500: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 2501: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2502: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 2503: if ($result eq 'ok') {
1.798 raeburn 2504: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2505: my $metafile = $fname.'.meta';
2506: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 2507: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 2508: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2509: my $sqlresult =
1.823 albertel 2510: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2511: 'portfolio_metadata',$group,
2512: 'delete');
1.798 raeburn 2513: }
2514: }
2515: return $result;
1.257 www 2516: }
1.15 www 2517:
1.530 albertel 2518: sub mkdiruserfile {
2519: my ($docuname,$docudom,$dir)=@_;
2520: my $home=&homeserver($docuname,$docudom);
2521: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2522: }
2523:
1.531 albertel 2524: sub renameuserfile {
2525: my ($docuname,$docudom,$old,$new)=@_;
2526: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2527: my $result = &reply("renameuserfile:$docudom:$docuname:".
2528: &escape("$old").':'.&escape("$new"),$home);
2529: if ($result eq 'ok') {
2530: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2531: my $oldmeta = $old.'.meta';
2532: my $newmeta = $new.'.meta';
2533: my $metaresult =
2534: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 2535: my $url = "/uploaded/$docudom/$docuname/$old";
2536: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2537: my $sqlresult =
1.823 albertel 2538: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2539: 'portfolio_metadata',$group,
2540: 'delete');
1.798 raeburn 2541: }
2542: }
2543: return $result;
1.531 albertel 2544: }
2545:
1.14 www 2546: # ------------------------------------------------------------------------- Log
2547:
2548: sub log {
2549: my ($dom,$nam,$hom,$what)=@_;
1.47 www 2550: return critical("log:$dom:$nam:$what",$hom);
1.157 www 2551: }
2552:
2553: # ------------------------------------------------------------------ Course Log
1.352 www 2554: #
2555: # This routine flushes several buffers of non-mission-critical nature
2556: #
1.157 www 2557:
2558: sub flushcourselogs {
1.352 www 2559: &logthis('Flushing log buffers');
2560: #
2561: # course logs
2562: # This is a log of all transactions in a course, which can be used
2563: # for data mining purposes
2564: #
2565: # It also collects the courseid database, which lists last transaction
2566: # times and course titles for all courseids
2567: #
2568: my %courseidbuffer=();
1.921 raeburn 2569: foreach my $crsid (keys(%courselogs)) {
1.352 www 2570: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 2571: &escape($courselogs{$crsid}),
2572: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 2573: delete $courselogs{$crsid};
2574: } else {
2575: &logthis('Failed to flush log buffer for '.$crsid);
2576: if (length($courselogs{$crsid})>40000) {
1.672 albertel 2577: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 2578: " exceeded maximum size, deleting.</font>");
2579: delete $courselogs{$crsid};
2580: }
1.352 www 2581: }
1.920 raeburn 2582: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 2583: 'description' => $coursedescrbuf{$crsid},
2584: 'inst_code' => $courseinstcodebuf{$crsid},
2585: 'type' => $coursetypebuf{$crsid},
2586: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 2587: };
1.191 harris41 2588: }
1.352 www 2589: #
2590: # Write course id database (reverse lookup) to homeserver of courses
2591: # Is used in pickcourse
2592: #
1.840 albertel 2593: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 2594: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 2595: $courseidbuffer{$crs_home},
2596: $crs_home,'timeonly');
1.352 www 2597: }
2598: #
2599: # File accesses
2600: # Writes to the dynamic metadata of resources to get hit counts, etc.
2601: #
1.449 matthew 2602: foreach my $entry (keys(%accesshash)) {
1.458 matthew 2603: if ($entry =~ /___count$/) {
2604: my ($dom,$name);
1.807 albertel 2605: ($dom,$name,undef)=
1.811 albertel 2606: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 2607: if (! defined($dom) || $dom eq '' ||
2608: ! defined($name) || $name eq '') {
1.620 albertel 2609: my $cid = $env{'request.course.id'};
2610: $dom = $env{'request.'.$cid.'.domain'};
2611: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 2612: }
1.450 matthew 2613: my $value = $accesshash{$entry};
2614: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2615: my %temphash=($url => $value);
1.449 matthew 2616: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2617: if ($result eq 'ok') {
2618: delete $accesshash{$entry};
2619: } elsif ($result eq 'unknown_cmd') {
2620: # Target server has old code running on it.
1.450 matthew 2621: my %temphash=($entry => $value);
1.449 matthew 2622: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2623: delete $accesshash{$entry};
2624: }
2625: }
2626: } else {
1.811 albertel 2627: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.450 matthew 2628: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 2629: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2630: delete $accesshash{$entry};
2631: }
1.185 www 2632: }
1.191 harris41 2633: }
1.352 www 2634: #
2635: # Roles
2636: # Reverse lookup of user roles for course faculty/staff and co-authorship
2637: #
1.800 albertel 2638: foreach my $entry (keys(%userrolehash)) {
1.351 www 2639: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 2640: split(/\:/,$entry);
2641: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 2642: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 2643: $rudom,$runame) eq 'ok') {
2644: delete $userrolehash{$entry};
2645: }
2646: }
1.662 raeburn 2647: #
2648: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2649: #
2650: my %domrolebuffer = ();
1.1000 raeburn 2651: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 2652: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 2653: if ($domrolebuffer{$rudom}) {
2654: $domrolebuffer{$rudom}.='&'.&escape($entry).
2655: '='.&escape($domainrolehash{$entry});
2656: } else {
2657: $domrolebuffer{$rudom}.=&escape($entry).
2658: '='.&escape($domainrolehash{$entry});
2659: }
2660: delete $domainrolehash{$entry};
2661: }
2662: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 2663: my %servers = &get_servers($dom,'library');
2664: foreach my $tryserver (keys(%servers)) {
2665: unless (&reply('domroleput:'.$dom.':'.
2666: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2667: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2668: }
1.662 raeburn 2669: }
2670: }
1.186 www 2671: $dumpcount++;
1.157 www 2672: }
2673:
2674: sub courselog {
2675: my $what=shift;
1.158 www 2676: $what=time.':'.$what;
1.620 albertel 2677: unless ($env{'request.course.id'}) { return ''; }
2678: $coursedombuf{$env{'request.course.id'}}=
2679: $env{'course.'.$env{'request.course.id'}.'.domain'};
2680: $coursenumbuf{$env{'request.course.id'}}=
2681: $env{'course.'.$env{'request.course.id'}.'.num'};
2682: $coursehombuf{$env{'request.course.id'}}=
2683: $env{'course.'.$env{'request.course.id'}.'.home'};
2684: $coursedescrbuf{$env{'request.course.id'}}=
2685: $env{'course.'.$env{'request.course.id'}.'.description'};
2686: $courseinstcodebuf{$env{'request.course.id'}}=
2687: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2688: $courseownerbuf{$env{'request.course.id'}}=
2689: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 2690: $coursetypebuf{$env{'request.course.id'}}=
2691: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 2692: if (defined $courselogs{$env{'request.course.id'}}) {
2693: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 2694: } else {
1.620 albertel 2695: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 2696: }
1.620 albertel 2697: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 2698: &flushcourselogs();
2699: }
1.158 www 2700: }
2701:
2702: sub courseacclog {
2703: my $fnsymb=shift;
1.620 albertel 2704: unless ($env{'request.course.id'}) { return ''; }
2705: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 2706: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 2707: $what.=':POST';
1.583 matthew 2708: # FIXME: Probably ought to escape things....
1.800 albertel 2709: foreach my $key (keys(%env)) {
2710: if ($key=~/^form\.(.*)/) {
1.975 raeburn 2711: my $formitem = $1;
2712: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2713: $what.=':'.$formitem.'='.$env{$key};
2714: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2715: $what.=':'.$formitem.'='.$env{$key};
2716: }
1.158 www 2717: }
1.191 harris41 2718: }
1.583 matthew 2719: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2720: # FIXME: We should not be depending on a form parameter that someone
2721: # editing lonsearchcat.pm might change in the future.
1.620 albertel 2722: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 2723: $what.= ':POST';
2724: # FIXME: Probably ought to escape things....
2725: foreach my $element ('courseexp','crsfulltext','crsrelated',
2726: 'crsdiscuss') {
1.620 albertel 2727: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 2728: }
2729: }
1.158 www 2730: }
2731: &courselog($what);
1.149 www 2732: }
2733:
1.185 www 2734: sub countacc {
2735: my $url=&declutter(shift);
1.458 matthew 2736: return if (! defined($url) || $url eq '');
1.620 albertel 2737: unless ($env{'request.course.id'}) { return ''; }
2738: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 2739: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 2740: $accesshash{$key}++;
1.185 www 2741: }
1.349 www 2742:
1.361 www 2743: sub linklog {
2744: my ($from,$to)=@_;
2745: $from=&declutter($from);
2746: $to=&declutter($to);
2747: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2748: $accesshash{$to.'___'.$from.'___goto'}=1;
2749: }
2750:
1.349 www 2751: sub userrolelog {
2752: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 2753: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 2754: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 2755: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1.1041 raeburn 2756: ($trole=~/^ta/) || ($trole=~/^co/)) {
1.350 www 2757: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2758: $userrolehash
2759: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 2760: =$tend.':'.$tstart;
1.662 raeburn 2761: }
1.898 albertel 2762: if (($env{'request.role'} =~ /dc\./) &&
2763: (($trole=~/^au/) || ($trole=~/^in/) ||
2764: ($trole=~/^cc/) || ($trole=~/^ep/) ||
1.1041 raeburn 2765: ($trole=~/^cr/) || ($trole=~/^ta/) ||
2766: ($trole=~/^co/))) {
1.898 albertel 2767: $userrolehash
2768: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2769: =$tend.':'.$tstart;
2770: }
1.662 raeburn 2771: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2772: ($trole=~/^li/) || ($trole=~/^li/) ||
2773: ($trole=~/^au/) || ($trole=~/^dg/) ||
2774: ($trole=~/^sc/)) {
2775: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2776: $domainrolehash
2777: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2778: = $tend.':'.$tstart;
2779: }
1.351 www 2780: }
2781:
1.957 raeburn 2782: sub courserolelog {
2783: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2784: if (($trole eq 'cc') || ($trole eq 'in') ||
2785: ($trole eq 'ep') || ($trole eq 'ad') ||
2786: ($trole eq 'ta') || ($trole eq 'st') ||
1.1044 raeburn 2787: ($trole=~/^cr/) || ($trole eq 'gr') ||
2788: ($trole eq 'co')) {
1.957 raeburn 2789: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2790: my $cdom = $1;
2791: my $cnum = $2;
2792: my $sec = $3;
2793: my $namespace = 'rolelog';
2794: my %storehash = (
2795: role => $trole,
2796: start => $tstart,
2797: end => $tend,
2798: selfenroll => $selfenroll,
2799: context => $context,
2800: );
2801: if ($trole eq 'gr') {
2802: $namespace = 'groupslog';
2803: $storehash{'group'} = $sec;
2804: } else {
2805: $storehash{'section'} = $sec;
2806: }
2807: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
1.996 raeburn 2808: if (($trole ne 'st') || ($sec ne '')) {
2809: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2810: }
1.957 raeburn 2811: }
2812: }
2813: return;
2814: }
2815:
1.351 www 2816: sub get_course_adv_roles {
1.948 raeburn 2817: my ($cid,$codes) = @_;
1.620 albertel 2818: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 2819: my %coursehash=&coursedescription($cid);
1.988 raeburn 2820: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 2821: my %nothide=();
1.800 albertel 2822: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 2823: if ($user !~ /:/) {
2824: $nothide{join(':',split(/[\@]/,$user))}=1;
2825: } else {
2826: $nothide{$user}=1;
2827: }
1.470 www 2828: }
1.351 www 2829: my %returnhash=();
2830: my %dumphash=
2831: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2832: my $now=time;
1.997 raeburn 2833: my %privileged;
1.1000 raeburn 2834: foreach my $entry (keys(%dumphash)) {
1.800 albertel 2835: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 2836: if (($tstart) && ($tstart<0)) { next; }
2837: if (($tend) && ($tend<$now)) { next; }
2838: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 2839: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 2840: if ($username eq '' || $domain eq '') { next; }
1.997 raeburn 2841: unless (ref($privileged{$domain}) eq 'HASH') {
2842: my %dompersonnel =
1.998 raeburn 2843: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
1.997 raeburn 2844: $privileged{$domain} = {};
2845: foreach my $server (keys(%dompersonnel)) {
1.999 raeburn 2846: if (ref($dompersonnel{$server}) eq 'HASH') {
1.997 raeburn 2847: foreach my $user (keys(%{$dompersonnel{$server}})) {
2848: my ($trole,$uname,$udom) = split(/:/,$user);
2849: $privileged{$udom}{$uname} = 1;
2850: }
2851: }
2852: }
2853: }
2854: if ((exists($privileged{$domain}{$username})) &&
2855: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 2856: if ($role eq 'cr') { next; }
1.948 raeburn 2857: if ($codes) {
2858: if ($section) { $role .= ':'.$section; }
2859: if ($returnhash{$role}) {
2860: $returnhash{$role}.=','.$username.':'.$domain;
2861: } else {
2862: $returnhash{$role}=$username.':'.$domain;
2863: }
1.351 www 2864: } else {
1.988 raeburn 2865: my $key=&plaintext($role,$crstype);
1.973 bisitz 2866: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 2867: if ($returnhash{$key}) {
2868: $returnhash{$key}.=','.$username.':'.$domain;
2869: } else {
2870: $returnhash{$key}=$username.':'.$domain;
2871: }
1.351 www 2872: }
1.948 raeburn 2873: }
1.400 www 2874: return %returnhash;
2875: }
2876:
2877: sub get_my_roles {
1.937 raeburn 2878: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 2879: unless (defined($uname)) { $uname=$env{'user.name'}; }
2880: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 2881: my (%dumphash,%nothide);
1.858 raeburn 2882: if ($context eq 'userroles') {
2883: %dumphash = &dump('roles',$udom,$uname);
2884: } else {
2885: %dumphash=
1.400 www 2886: &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 2887: if ($hidepriv) {
2888: my %coursehash=&coursedescription($udom.'_'.$uname);
2889: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2890: if ($user !~ /:/) {
2891: $nothide{join(':',split(/[\@]/,$user))} = 1;
2892: } else {
2893: $nothide{$user} = 1;
2894: }
2895: }
2896: }
1.858 raeburn 2897: }
1.400 www 2898: my %returnhash=();
2899: my $now=time;
1.999 raeburn 2900: my %privileged;
1.800 albertel 2901: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 2902: my ($role,$tend,$tstart);
2903: if ($context eq 'userroles') {
2904: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2905: } else {
2906: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2907: }
1.400 www 2908: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 2909: my $status = 'active';
1.939 raeburn 2910: if (($tend) && ($tend<=$now)) {
1.832 raeburn 2911: $status = 'previous';
2912: }
2913: if (($tstart) && ($now<$tstart)) {
2914: $status = 'future';
2915: }
2916: if (ref($types) eq 'ARRAY') {
2917: if (!grep(/^\Q$status\E$/,@{$types})) {
2918: next;
2919: }
2920: } else {
2921: if ($status ne 'active') {
2922: next;
2923: }
2924: }
1.867 raeburn 2925: my ($rolecode,$username,$domain,$section,$area);
2926: if ($context eq 'userroles') {
2927: ($area,$rolecode) = split(/_/,$entry);
2928: (undef,$domain,$username,$section) = split(/\//,$area);
2929: } else {
2930: ($role,$username,$domain,$section) = split(/\:/,$entry);
2931: }
1.832 raeburn 2932: if (ref($roledoms) eq 'ARRAY') {
2933: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2934: next;
2935: }
2936: }
2937: if (ref($roles) eq 'ARRAY') {
2938: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 2939: if ($role =~ /^cr\//) {
2940: if (!grep(/^cr$/,@{$roles})) {
2941: next;
2942: }
2943: } else {
2944: next;
2945: }
1.832 raeburn 2946: }
1.867 raeburn 2947: }
1.937 raeburn 2948: if ($hidepriv) {
1.999 raeburn 2949: if ($context eq 'userroles') {
2950: if ((&privileged($username,$domain)) &&
2951: (!$nothide{$username.':'.$domain})) {
2952: next;
2953: }
2954: } else {
2955: unless (ref($privileged{$domain}) eq 'HASH') {
2956: my %dompersonnel =
2957: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2958: $privileged{$domain} = {};
2959: if (keys(%dompersonnel)) {
2960: foreach my $server (keys(%dompersonnel)) {
2961: if (ref($dompersonnel{$server}) eq 'HASH') {
2962: foreach my $user (keys(%{$dompersonnel{$server}})) {
2963: my ($trole,$uname,$udom) = split(/:/,$user);
2964: $privileged{$udom}{$uname} = $trole;
2965: }
2966: }
2967: }
2968: }
2969: }
2970: if (exists($privileged{$domain}{$username})) {
2971: if (!$nothide{$username.':'.$domain}) {
2972: next;
2973: }
2974: }
1.937 raeburn 2975: }
2976: }
1.933 raeburn 2977: if ($withsec) {
2978: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2979: $tstart.':'.$tend;
2980: } else {
2981: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2982: }
1.832 raeburn 2983: }
1.373 www 2984: return %returnhash;
1.399 www 2985: }
2986:
2987: # ----------------------------------------------------- Frontpage Announcements
2988: #
2989: #
2990:
2991: sub postannounce {
2992: my ($server,$text)=@_;
1.844 albertel 2993: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 2994: unless ($text=~/\w/) { $text=''; }
2995: return &reply('setannounce:'.&escape($text),$server);
2996: }
2997:
2998: sub getannounce {
1.448 albertel 2999:
3000: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 3001: my $announcement='';
1.800 albertel 3002: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 3003: close($fh);
1.399 www 3004: if ($announcement=~/\w/) {
3005: return
3006: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 3007: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 3008: } else {
3009: return '';
3010: }
3011: } else {
3012: return '';
3013: }
1.351 www 3014: }
1.353 www 3015:
3016: # ---------------------------------------------------------- Course ID routines
3017: # Deal with domain's nohist_courseid.db files
3018: #
3019:
3020: sub courseidput {
1.921 raeburn 3021: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 3022: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 3023: my $outcome;
3024: if ($caller eq 'timeonly') {
3025: my $cids = '';
3026: foreach my $item (keys(%$storehash)) {
3027: $cids.=&escape($item).'&';
3028: }
3029: $cids=~s/\&$//;
3030: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3031: $coursehome);
3032: } else {
3033: my $items = '';
3034: foreach my $item (keys(%$storehash)) {
3035: $items.= &escape($item).'='.
3036: &freeze_escape($$storehash{$item}).'&';
3037: }
3038: $items=~s/\&$//;
3039: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3040: $coursehome);
1.918 raeburn 3041: }
3042: if ($outcome eq 'unknown_cmd') {
3043: my $what;
3044: foreach my $cid (keys(%$storehash)) {
3045: $what .= &escape($cid).'=';
1.921 raeburn 3046: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 3047: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 3048: }
3049: $what =~ s/\:$/&/;
3050: }
3051: $what =~ s/\&$//;
3052: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3053: } else {
3054: return $outcome;
3055: }
1.353 www 3056: }
3057:
3058: sub courseiddump {
1.921 raeburn 3059: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 3060: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 3061: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3062: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
1.918 raeburn 3063: my $as_hash = 1;
3064: my %returnhash;
3065: if (!$domfilter) { $domfilter=''; }
1.845 albertel 3066: my %libserv = &all_library();
3067: foreach my $tryserver (keys(%libserv)) {
3068: if ( ( $hostidflag == 1
3069: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3070: || (!defined($hostidflag)) ) {
3071:
1.918 raeburn 3072: if (($domfilter eq '') ||
3073: (&host_domain($tryserver) eq $domfilter)) {
3074: my $rep =
3075: &reply('courseiddump:'.&host_domain($tryserver).':'.
3076: $sincefilter.':'.&escape($descfilter).':'.
3077: &escape($instcodefilter).':'.&escape($ownerfilter).
3078: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947 raeburn 3079: ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962 raeburn 3080: &escape($selfenrollonly).':'.&escape($catfilter).':'.
1.1008 raeburn 3081: $showhidden.':'.$caller.':'.&escape($cloner).':'.
1.1029 raeburn 3082: &escape($cc_clone).':'.$cloneonly.':'.
3083: &escape($createdbefore).':'.&escape($createdafter).':'.
3084: &escape($creationcontext),$tryserver);
1.918 raeburn 3085: my @pairs=split(/\&/,$rep);
3086: foreach my $item (@pairs) {
3087: my ($key,$value)=split(/\=/,$item,2);
3088: $key = &unescape($key);
3089: next if ($key =~ /^error: 2 /);
3090: my $result = &thaw_unescape($value);
3091: if (ref($result) eq 'HASH') {
3092: $returnhash{$key}=$result;
3093: } else {
1.921 raeburn 3094: my @responses = split(/:/,$value);
3095: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3096: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3097: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3098: }
1.1008 raeburn 3099: }
1.353 www 3100: }
3101: }
3102: }
3103: }
3104: return %returnhash;
3105: }
3106:
1.1055 raeburn 3107: sub courselastaccess {
3108: my ($cdom,$cnum,$hostidref) = @_;
3109: my %returnhash;
3110: if ($cdom && $cnum) {
3111: my $chome = &homeserver($cnum,$cdom);
3112: if ($chome ne 'no_host') {
3113: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3114: &extract_lastaccess(\%returnhash,$rep);
3115: }
3116: } else {
3117: if (!$cdom) { $cdom=''; }
3118: my %libserv = &all_library();
3119: foreach my $tryserver (keys(%libserv)) {
3120: if (ref($hostidref) eq 'ARRAY') {
3121: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3122: }
3123: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3124: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3125: &extract_lastaccess(\%returnhash,$rep);
3126: }
3127: }
3128: }
3129: return %returnhash;
3130: }
3131:
3132: sub extract_lastaccess {
3133: my ($returnhash,$rep) = @_;
3134: if (ref($returnhash) eq 'HASH') {
3135: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3136: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3137: $rep eq '') {
3138: my @pairs=split(/\&/,$rep);
3139: foreach my $item (@pairs) {
3140: my ($key,$value)=split(/\=/,$item,2);
3141: $key = &unescape($key);
3142: next if ($key =~ /^error: 2 /);
3143: $returnhash->{$key} = &thaw_unescape($value);
3144: }
3145: }
3146: }
3147: return;
3148: }
3149:
1.658 raeburn 3150: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3151:
3152: sub dcmailput {
1.685 raeburn 3153: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3154: my $status = &Apache::lonnet::critical(
1.740 www 3155: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3156: &escape($message),$server);
1.662 raeburn 3157: return $status;
3158: }
3159:
1.658 raeburn 3160: sub dcmaildump {
3161: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3162: my %returnhash=();
1.846 albertel 3163:
3164: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3165: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3166: &escape($enddate).':';
3167: my @esc_senders=map { &escape($_)} @$senders;
3168: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3169: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3170: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3171: if (($key) && ($value)) {
3172: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3173: }
3174: }
3175: }
3176: return %returnhash;
3177: }
1.662 raeburn 3178: # ---------------------------------------------------------- Domain roles
3179:
3180: sub get_domain_roles {
3181: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 3182: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 3183: $startdate = '.';
3184: }
1.1018 raeburn 3185: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 3186: $enddate = '.';
3187: }
1.922 raeburn 3188: my $rolelist;
3189: if (ref($roles) eq 'ARRAY') {
3190: $rolelist = join(':',@{$roles});
3191: }
1.662 raeburn 3192: my %personnel = ();
1.841 albertel 3193:
3194: my %servers = &get_servers($dom,'library');
3195: foreach my $tryserver (keys(%servers)) {
3196: %{$personnel{$tryserver}}=();
3197: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3198: &escape($startdate).':'.
3199: &escape($enddate).':'.
3200: &escape($rolelist), $tryserver))) {
3201: my ($key,$value) = split(/\=/,$line,2);
3202: if (($key) && ($value)) {
3203: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3204: }
3205: }
1.662 raeburn 3206: }
3207: return %personnel;
3208: }
1.658 raeburn 3209:
1.1057 www 3210: # ----------------------------------------------------------- Interval timing
1.149 www 3211:
1.504 albertel 3212: sub get_first_access {
3213: my ($type,$argsymb)=@_;
1.790 albertel 3214: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3215: if ($argsymb) { $symb=$argsymb; }
3216: my ($map,$id,$res)=&decode_symb($symb);
1.926 albertel 3217: if ($type eq 'course') {
3218: $res='course';
3219: } elsif ($type eq 'map') {
1.588 albertel 3220: $res=&symbread($map);
3221: } else {
3222: $res=$symb;
3223: }
3224: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3225: return $times{"$courseid\0$res"};
1.504 albertel 3226: }
3227:
3228: sub set_first_access {
3229: my ($type)=@_;
1.790 albertel 3230: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3231: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 3232: if ($type eq 'course') {
3233: $res='course';
3234: } elsif ($type eq 'map') {
1.588 albertel 3235: $res=&symbread($map);
3236: } else {
3237: $res=$symb;
3238: }
3239: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 3240: if (!$firstaccess) {
1.588 albertel 3241: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 3242: }
3243: return 'already_set';
1.504 albertel 3244: }
3245:
1.110 www 3246: # --------------------------------------------- Set Expire Date for Spreadsheet
3247:
3248: sub expirespread {
3249: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 3250: my $cid=$env{'request.course.id'};
1.110 www 3251: if ($cid) {
3252: my $now=time;
3253: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 3254: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3255: $env{'course.'.$cid.'.num'}.
1.110 www 3256: ':nohist_expirationdates:'.
3257: &escape($key).'='.$now,
1.620 albertel 3258: $env{'course.'.$cid.'.home'})
1.110 www 3259: }
3260: return 'ok';
1.14 www 3261: }
3262:
1.109 www 3263: # ----------------------------------------------------- Devalidate Spreadsheets
3264:
3265: sub devalidate {
1.325 www 3266: my ($symb,$uname,$udom)=@_;
1.620 albertel 3267: my $cid=$env{'request.course.id'};
1.109 www 3268: if ($cid) {
1.391 matthew 3269: # delete the stored spreadsheets for
3270: # - the student level sheet of this user in course's homespace
3271: # - the assessment level sheet for this resource
3272: # for this user in user's homespace
1.553 albertel 3273: # - current conditional state info
1.325 www 3274: my $key=$uname.':'.$udom.':';
1.109 www 3275: my $status=
1.299 matthew 3276: &del('nohist_calculatedsheets',
1.391 matthew 3277: [$key.'studentcalc:'],
1.620 albertel 3278: $env{'course.'.$cid.'.domain'},
3279: $env{'course.'.$cid.'.num'})
1.133 albertel 3280: .' '.
3281: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 3282: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 3283: unless ($status eq 'ok ok') {
3284: &logthis('Could not devalidate spreadsheet '.
1.325 www 3285: $uname.' at '.$udom.' for '.
1.109 www 3286: $symb.': '.$status);
1.133 albertel 3287: }
1.553 albertel 3288: &delenv('user.state.'.$cid);
1.109 www 3289: }
3290: }
3291:
1.265 albertel 3292: sub get_scalar {
3293: my ($string,$end) = @_;
3294: my $value;
3295: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3296: $value = $1;
3297: } elsif ($$string =~ s/^([^&]*?)&//) {
3298: $value = $1;
3299: }
3300: return &unescape($value);
3301: }
3302:
3303: sub array2str {
3304: my (@array) = @_;
3305: my $result=&arrayref2str(\@array);
3306: $result=~s/^__ARRAY_REF__//;
3307: $result=~s/__END_ARRAY_REF__$//;
3308: return $result;
3309: }
3310:
1.204 albertel 3311: sub arrayref2str {
3312: my ($arrayref) = @_;
1.265 albertel 3313: my $result='__ARRAY_REF__';
1.204 albertel 3314: foreach my $elem (@$arrayref) {
1.265 albertel 3315: if(ref($elem) eq 'ARRAY') {
3316: $result.=&arrayref2str($elem).'&';
3317: } elsif(ref($elem) eq 'HASH') {
3318: $result.=&hashref2str($elem).'&';
3319: } elsif(ref($elem)) {
3320: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 3321: } else {
3322: $result.=&escape($elem).'&';
3323: }
3324: }
3325: $result=~s/\&$//;
1.265 albertel 3326: $result .= '__END_ARRAY_REF__';
1.204 albertel 3327: return $result;
3328: }
3329:
1.168 albertel 3330: sub hash2str {
1.204 albertel 3331: my (%hash) = @_;
3332: my $result=&hashref2str(\%hash);
1.265 albertel 3333: $result=~s/^__HASH_REF__//;
3334: $result=~s/__END_HASH_REF__$//;
1.204 albertel 3335: return $result;
3336: }
3337:
3338: sub hashref2str {
3339: my ($hashref)=@_;
1.265 albertel 3340: my $result='__HASH_REF__';
1.800 albertel 3341: foreach my $key (sort(keys(%$hashref))) {
3342: if (ref($key) eq 'ARRAY') {
3343: $result.=&arrayref2str($key).'=';
3344: } elsif (ref($key) eq 'HASH') {
3345: $result.=&hashref2str($key).'=';
3346: } elsif (ref($key)) {
1.265 albertel 3347: $result.='=';
1.800 albertel 3348: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 3349: } else {
1.800 albertel 3350: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 3351: }
3352:
1.800 albertel 3353: if(ref($hashref->{$key}) eq 'ARRAY') {
3354: $result.=&arrayref2str($hashref->{$key}).'&';
3355: } elsif(ref($hashref->{$key}) eq 'HASH') {
3356: $result.=&hashref2str($hashref->{$key}).'&';
3357: } elsif(ref($hashref->{$key})) {
1.265 albertel 3358: $result.='&';
1.800 albertel 3359: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 3360: } else {
1.800 albertel 3361: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 3362: }
3363: }
1.168 albertel 3364: $result=~s/\&$//;
1.265 albertel 3365: $result .= '__END_HASH_REF__';
1.168 albertel 3366: return $result;
3367: }
3368:
3369: sub str2hash {
1.265 albertel 3370: my ($string)=@_;
3371: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3372: return %$hash;
3373: }
3374:
3375: sub str2hashref {
1.168 albertel 3376: my ($string) = @_;
1.265 albertel 3377:
3378: my %hash;
3379:
3380: if($string !~ /^__HASH_REF__/) {
3381: if (! ($string eq '' || !defined($string))) {
3382: $hash{'error'}='Not hash reference';
3383: }
3384: return (\%hash, $string);
3385: }
3386:
3387: $string =~ s/^__HASH_REF__//;
3388:
3389: while($string !~ /^__END_HASH_REF__/) {
3390: #key
3391: my $key='';
3392: if($string =~ /^__HASH_REF__/) {
3393: ($key, $string)=&str2hashref($string);
3394: if(defined($key->{'error'})) {
3395: $hash{'error'}='Bad data';
3396: return (\%hash, $string);
3397: }
3398: } elsif($string =~ /^__ARRAY_REF__/) {
3399: ($key, $string)=&str2arrayref($string);
3400: if($key->[0] eq 'Array reference error') {
3401: $hash{'error'}='Bad data';
3402: return (\%hash, $string);
3403: }
3404: } else {
3405: $string =~ s/^(.*?)=//;
1.267 albertel 3406: $key=&unescape($1);
1.265 albertel 3407: }
3408: $string =~ s/^=//;
3409:
3410: #value
3411: my $value='';
3412: if($string =~ /^__HASH_REF__/) {
3413: ($value, $string)=&str2hashref($string);
3414: if(defined($value->{'error'})) {
3415: $hash{'error'}='Bad data';
3416: return (\%hash, $string);
3417: }
3418: } elsif($string =~ /^__ARRAY_REF__/) {
3419: ($value, $string)=&str2arrayref($string);
3420: if($value->[0] eq 'Array reference error') {
3421: $hash{'error'}='Bad data';
3422: return (\%hash, $string);
3423: }
3424: } else {
3425: $value=&get_scalar(\$string,'__END_HASH_REF__');
3426: }
3427: $string =~ s/^&//;
3428:
3429: $hash{$key}=$value;
1.204 albertel 3430: }
1.265 albertel 3431:
3432: $string =~ s/^__END_HASH_REF__//;
3433:
3434: return (\%hash, $string);
1.204 albertel 3435: }
3436:
3437: sub str2array {
1.265 albertel 3438: my ($string)=@_;
3439: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3440: return @$array;
3441: }
3442:
3443: sub str2arrayref {
1.204 albertel 3444: my ($string) = @_;
1.265 albertel 3445: my @array;
3446:
3447: if($string !~ /^__ARRAY_REF__/) {
3448: if (! ($string eq '' || !defined($string))) {
3449: $array[0]='Array reference error';
3450: }
3451: return (\@array, $string);
3452: }
3453:
3454: $string =~ s/^__ARRAY_REF__//;
3455:
3456: while($string !~ /^__END_ARRAY_REF__/) {
3457: my $value='';
3458: if($string =~ /^__HASH_REF__/) {
3459: ($value, $string)=&str2hashref($string);
3460: if(defined($value->{'error'})) {
3461: $array[0] ='Array reference error';
3462: return (\@array, $string);
3463: }
3464: } elsif($string =~ /^__ARRAY_REF__/) {
3465: ($value, $string)=&str2arrayref($string);
3466: if($value->[0] eq 'Array reference error') {
3467: $array[0] ='Array reference error';
3468: return (\@array, $string);
3469: }
3470: } else {
3471: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3472: }
3473: $string =~ s/^&//;
3474:
3475: push(@array, $value);
1.191 harris41 3476: }
1.265 albertel 3477:
3478: $string =~ s/^__END_ARRAY_REF__//;
3479:
3480: return (\@array, $string);
1.168 albertel 3481: }
3482:
1.167 albertel 3483: # -------------------------------------------------------------------Temp Store
3484:
1.168 albertel 3485: sub tmpreset {
3486: my ($symb,$namespace,$domain,$stuname) = @_;
3487: if (!$symb) {
3488: $symb=&symbread();
1.620 albertel 3489: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3490: }
3491: $symb=escape($symb);
3492:
1.620 albertel 3493: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3494: $namespace=~s/\//\_/g;
3495: $namespace=~s/\W//g;
3496:
1.620 albertel 3497: if (!$domain) { $domain=$env{'user.domain'}; }
3498: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3499: if ($domain eq 'public' && $stuname eq 'public') {
3500: $stuname=$ENV{'REMOTE_ADDR'};
3501: }
1.168 albertel 3502: my $path=$perlvar{'lonDaemons'}.'/tmp';
3503: my %hash;
3504: if (tie(%hash,'GDBM_File',
3505: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3506: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 3507: foreach my $key (keys(%hash)) {
1.180 albertel 3508: if ($key=~ /:$symb/) {
1.168 albertel 3509: delete($hash{$key});
3510: }
3511: }
3512: }
3513: }
3514:
1.167 albertel 3515: sub tmpstore {
1.168 albertel 3516: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3517:
3518: if (!$symb) {
3519: $symb=&symbread();
1.620 albertel 3520: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3521: }
3522: $symb=escape($symb);
3523:
3524: if (!$namespace) {
3525: # I don't think we would ever want to store this for a course.
3526: # it seems this will only be used if we don't have a course.
1.620 albertel 3527: #$namespace=$env{'request.course.id'};
1.168 albertel 3528: #if (!$namespace) {
1.620 albertel 3529: $namespace=$env{'request.state'};
1.168 albertel 3530: #}
3531: }
3532: $namespace=~s/\//\_/g;
3533: $namespace=~s/\W//g;
1.620 albertel 3534: if (!$domain) { $domain=$env{'user.domain'}; }
3535: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3536: if ($domain eq 'public' && $stuname eq 'public') {
3537: $stuname=$ENV{'REMOTE_ADDR'};
3538: }
1.168 albertel 3539: my $now=time;
3540: my %hash;
3541: my $path=$perlvar{'lonDaemons'}.'/tmp';
3542: if (tie(%hash,'GDBM_File',
3543: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3544: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3545: $hash{"version:$symb"}++;
3546: my $version=$hash{"version:$symb"};
3547: my $allkeys='';
3548: foreach my $key (keys(%$storehash)) {
3549: $allkeys.=$key.':';
1.591 albertel 3550: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3551: }
3552: $hash{"$version:$symb:timestamp"}=$now;
3553: $allkeys.='timestamp';
3554: $hash{"$version:keys:$symb"}=$allkeys;
3555: if (untie(%hash)) {
3556: return 'ok';
3557: } else {
3558: return "error:$!";
3559: }
3560: } else {
3561: return "error:$!";
3562: }
3563: }
1.167 albertel 3564:
1.168 albertel 3565: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3566:
1.168 albertel 3567: sub tmprestore {
3568: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3569:
1.168 albertel 3570: if (!$symb) {
3571: $symb=&symbread();
1.620 albertel 3572: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3573: }
3574: $symb=escape($symb);
3575:
1.620 albertel 3576: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3577:
1.620 albertel 3578: if (!$domain) { $domain=$env{'user.domain'}; }
3579: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3580: if ($domain eq 'public' && $stuname eq 'public') {
3581: $stuname=$ENV{'REMOTE_ADDR'};
3582: }
1.168 albertel 3583: my %returnhash;
3584: $namespace=~s/\//\_/g;
3585: $namespace=~s/\W//g;
3586: my %hash;
3587: my $path=$perlvar{'lonDaemons'}.'/tmp';
3588: if (tie(%hash,'GDBM_File',
3589: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3590: &GDBM_READER(),0640)) {
1.168 albertel 3591: my $version=$hash{"version:$symb"};
3592: $returnhash{'version'}=$version;
3593: my $scope;
3594: for ($scope=1;$scope<=$version;$scope++) {
3595: my $vkeys=$hash{"$scope:keys:$symb"};
3596: my @keys=split(/:/,$vkeys);
3597: my $key;
3598: $returnhash{"$scope:keys"}=$vkeys;
3599: foreach $key (@keys) {
1.591 albertel 3600: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3601: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3602: }
3603: }
1.168 albertel 3604: if (!(untie(%hash))) {
3605: return "error:$!";
3606: }
3607: } else {
3608: return "error:$!";
3609: }
3610: return %returnhash;
1.167 albertel 3611: }
3612:
1.9 www 3613: # ----------------------------------------------------------------------- Store
3614:
3615: sub store {
1.124 www 3616: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3617: my $home='';
3618:
1.168 albertel 3619: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3620:
1.213 www 3621: $symb=&symbclean($symb);
1.122 albertel 3622: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3623:
1.620 albertel 3624: if (!$domain) { $domain=$env{'user.domain'}; }
3625: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3626:
3627: &devalidate($symb,$stuname,$domain);
1.109 www 3628:
3629: $symb=escape($symb);
1.187 www 3630: if (!$namespace) {
1.620 albertel 3631: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3632: return '';
3633: }
3634: }
1.620 albertel 3635: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3636:
3637: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3638: $$storehash{'host'}=$perlvar{'lonHostID'};
3639:
1.12 www 3640: my $namevalue='';
1.800 albertel 3641: foreach my $key (keys(%$storehash)) {
3642: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3643: }
1.12 www 3644: $namevalue=~s/\&$//;
1.187 www 3645: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3646: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3647: }
3648:
1.47 www 3649: # -------------------------------------------------------------- Critical Store
3650:
3651: sub cstore {
1.124 www 3652: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3653: my $home='';
3654:
1.168 albertel 3655: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3656:
1.213 www 3657: $symb=&symbclean($symb);
1.122 albertel 3658: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3659:
1.620 albertel 3660: if (!$domain) { $domain=$env{'user.domain'}; }
3661: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3662:
3663: &devalidate($symb,$stuname,$domain);
1.109 www 3664:
3665: $symb=escape($symb);
1.187 www 3666: if (!$namespace) {
1.620 albertel 3667: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3668: return '';
3669: }
3670: }
1.620 albertel 3671: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3672:
3673: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3674: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3675:
1.47 www 3676: my $namevalue='';
1.800 albertel 3677: foreach my $key (keys(%$storehash)) {
3678: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3679: }
1.47 www 3680: $namevalue=~s/\&$//;
1.187 www 3681: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3682: return critical
3683: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3684: }
3685:
1.9 www 3686: # --------------------------------------------------------------------- Restore
3687:
3688: sub restore {
1.124 www 3689: my ($symb,$namespace,$domain,$stuname) = @_;
3690: my $home='';
3691:
1.168 albertel 3692: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3693:
1.122 albertel 3694: if (!$symb) {
3695: unless ($symb=escape(&symbread())) { return ''; }
3696: } else {
1.213 www 3697: $symb=&escape(&symbclean($symb));
1.122 albertel 3698: }
1.188 www 3699: if (!$namespace) {
1.620 albertel 3700: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3701: return '';
3702: }
3703: }
1.620 albertel 3704: if (!$domain) { $domain=$env{'user.domain'}; }
3705: if (!$stuname) { $stuname=$env{'user.name'}; }
3706: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3707: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3708:
1.12 www 3709: my %returnhash=();
1.800 albertel 3710: foreach my $line (split(/\&/,$answer)) {
3711: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3712: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3713: }
1.75 www 3714: my $version;
3715: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3716: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3717: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3718: }
1.75 www 3719: }
1.13 www 3720: return %returnhash;
1.34 www 3721: }
3722:
3723: # ---------------------------------------------------------- Course Description
3724:
3725: sub coursedescription {
1.731 albertel 3726: my ($courseid,$args)=@_;
1.34 www 3727: $courseid=~s/^\///;
1.49 www 3728: $courseid=~s/\_/\//g;
1.34 www 3729: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3730: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3731: my $normalid=$cdomain.'_'.$cnum;
3732: # need to always cache even if we get errors otherwise we keep
3733: # trying and trying and trying to get the course description.
3734: my %envhash=();
3735: my %returnhash=();
1.731 albertel 3736:
3737: my $expiretime=600;
3738: if ($env{'request.course.id'} eq $normalid) {
3739: $expiretime=120;
3740: }
3741:
3742: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3743: if (!$args->{'freshen_cache'}
3744: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3745: foreach my $key (keys(%env)) {
3746: next if ($key !~ /^\Q$prefix\E(.*)/);
3747: my ($setting) = $1;
3748: $returnhash{$setting} = $env{$key};
3749: }
3750: return %returnhash;
3751: }
3752:
3753: # get the data agin
3754: if (!$args->{'one_time'}) {
3755: $envhash{'course.'.$normalid.'.last_cache'}=time;
3756: }
1.811 albertel 3757:
1.34 www 3758: if ($chome ne 'no_host') {
1.302 albertel 3759: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3760: if (!exists($returnhash{'con_lost'})) {
3761: $returnhash{'home'}= $chome;
3762: $returnhash{'domain'} = $cdomain;
3763: $returnhash{'num'} = $cnum;
1.741 raeburn 3764: if (!defined($returnhash{'type'})) {
3765: $returnhash{'type'} = 'Course';
3766: }
1.130 albertel 3767: while (my ($name,$value) = each %returnhash) {
1.53 www 3768: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3769: }
1.270 www 3770: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3771: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3772: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3773: $envhash{'course.'.$normalid.'.home'}=$chome;
3774: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3775: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3776: }
3777: }
1.731 albertel 3778: if (!$args->{'one_time'}) {
1.949 raeburn 3779: &appenv(\%envhash);
1.731 albertel 3780: }
1.302 albertel 3781: return %returnhash;
1.461 www 3782: }
3783:
3784: # -------------------------------------------------See if a user is privileged
3785:
3786: sub privileged {
3787: my ($username,$domain)=@_;
3788: my $rolesdump=&reply("dump:$domain:$username:roles",
3789: &homeserver($username,$domain));
1.1033 raeburn 3790: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3791: ($rolesdump =~ /^error:/)) {
3792: return 0;
3793: }
1.461 www 3794: my $now=time;
3795: if ($rolesdump ne '') {
1.800 albertel 3796: foreach my $entry (split(/&/,$rolesdump)) {
3797: if ($entry!~/^rolesdef_/) {
3798: my ($area,$role)=split(/=/,$entry);
1.461 www 3799: $area=~s/\_\w\w$//;
3800: my ($trole,$tend,$tstart)=split(/_/,$role);
3801: if (($trole eq 'dc') || ($trole eq 'su')) {
3802: my $active=1;
3803: if ($tend) {
3804: if ($tend<$now) { $active=0; }
3805: }
3806: if ($tstart) {
3807: if ($tstart>$now) { $active=0; }
3808: }
3809: if ($active) { return 1; }
3810: }
3811: }
3812: }
3813: }
3814: return 0;
1.9 www 3815: }
1.1 albertel 3816:
1.103 harris41 3817: # -------------------------------------------------------- Get user privileges
1.11 www 3818:
3819: sub rolesinit {
3820: my ($domain,$username,$authhost)=@_;
1.1034 raeburn 3821: my $now=time;
3822: my %userroles = ('user.login.time' => $now);
1.11 www 3823: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.1033 raeburn 3824: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3825: ($rolesdump =~ /^error:/)) {
3826: return \%userroles;
3827: }
1.11 www 3828: my %allroles=();
1.678 raeburn 3829: my %allgroups=();
3830: my $group_privs;
1.11 www 3831:
3832: if ($rolesdump ne '') {
1.800 albertel 3833: foreach my $entry (split(/&/,$rolesdump)) {
3834: if ($entry!~/^rolesdef_/) {
3835: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3836: $area=~s/\_\w\w$//;
1.678 raeburn 3837: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3838: if ($role=~/^cr/) {
1.807 albertel 3839: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3840: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3841: ($tend,$tstart)=split('_',$trest);
3842: } else {
3843: $trole=$role;
3844: }
1.678 raeburn 3845: } elsif ($role =~ m|^gr/|) {
3846: ($trole,$tend,$tstart) = split(/_/,$role);
3847: ($trole,$group_privs) = split(/\//,$trole);
3848: $group_privs = &unescape($group_privs);
1.587 albertel 3849: } else {
3850: ($trole,$tend,$tstart)=split(/_/,$role);
3851: }
1.743 albertel 3852: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3853: $username);
3854: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3855: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3856: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3857: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3858: my $spec=$trole.'.'.$area;
3859: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3860: if ($trole =~ /^cr\//) {
1.567 raeburn 3861: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3862: } elsif ($trole eq 'gr') {
3863: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3864: } else {
1.567 raeburn 3865: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3866: }
1.12 www 3867: }
1.662 raeburn 3868: }
1.191 harris41 3869: }
1.743 albertel 3870: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3871: $userroles{'user.adv'} = $adv;
3872: $userroles{'user.author'} = $author;
1.620 albertel 3873: $env{'user.adv'}=$adv;
1.11 www 3874: }
1.743 albertel 3875: return \%userroles;
1.11 www 3876: }
3877:
1.567 raeburn 3878: sub set_arearole {
3879: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3880: # log the associated role with the area
3881: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3882: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3883: }
3884:
3885: sub custom_roleprivs {
3886: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3887: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3888: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3889: if (&hostname($homsvr) ne '') {
1.567 raeburn 3890: my ($rdummy,$roledef)=
3891: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3892: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3893: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3894: if (defined($syspriv)) {
1.1043 raeburn 3895: if ($trest =~ /^$match_community$/) {
3896: $syspriv =~ s/bre\&S//;
3897: }
1.567 raeburn 3898: $$allroles{'cm./'}.=':'.$syspriv;
3899: $$allroles{$spec.'./'}.=':'.$syspriv;
3900: }
3901: if ($tdomain ne '') {
3902: if (defined($dompriv)) {
3903: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3904: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3905: }
3906: if (($trest ne '') && (defined($coursepriv))) {
3907: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3908: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3909: }
3910: }
3911: }
3912: }
3913: }
3914:
1.678 raeburn 3915: sub group_roleprivs {
3916: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3917: my $access = 1;
3918: my $now = time;
3919: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3920: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3921: if ($access) {
1.811 albertel 3922: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 3923: $$allgroups{$course}{$group} .=':'.$group_privs;
3924: }
3925: }
1.567 raeburn 3926:
3927: sub standard_roleprivs {
3928: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3929: if (defined($pr{$trole.':s'})) {
3930: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3931: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3932: }
3933: if ($tdomain ne '') {
3934: if (defined($pr{$trole.':d'})) {
3935: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3936: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3937: }
3938: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3939: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3940: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3941: }
3942: }
3943: }
3944:
3945: sub set_userprivs {
1.678 raeburn 3946: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 3947: my $author=0;
3948: my $adv=0;
1.678 raeburn 3949: my %grouproles = ();
3950: if (keys(%{$allgroups}) > 0) {
1.1000 raeburn 3951: foreach my $role (keys(%{$allroles})) {
1.681 raeburn 3952: my ($trole,$area,$sec,$extendedarea);
1.881 raeburn 3953: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
1.678 raeburn 3954: $trole = $1;
3955: $area = $2;
1.681 raeburn 3956: $sec = $3;
3957: $extendedarea = $area.$sec;
3958: if (exists($$allgroups{$area})) {
3959: foreach my $group (keys(%{$$allgroups{$area}})) {
3960: my $spec = $trole.'.'.$extendedarea;
3961: $grouproles{$spec.'.'.$area.'/'.$group} =
3962: $$allgroups{$area}{$group};
1.678 raeburn 3963: }
3964: }
3965: }
3966: }
3967: }
1.800 albertel 3968: foreach my $group (keys(%grouproles)) {
3969: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 3970: }
1.800 albertel 3971: foreach my $role (keys(%{$allroles})) {
3972: my %thesepriv;
1.941 raeburn 3973: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 3974: foreach my $item (split(/:/,$$allroles{$role})) {
3975: if ($item ne '') {
3976: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 3977: if ($restrictions eq '') {
3978: $thesepriv{$privilege}='F';
3979: } elsif ($thesepriv{$privilege} ne 'F') {
3980: $thesepriv{$privilege}.=$restrictions;
3981: }
3982: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
3983: }
3984: }
3985: my $thesestr='';
1.800 albertel 3986: foreach my $priv (keys(%thesepriv)) {
3987: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
3988: }
3989: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 3990: }
3991: return ($author,$adv);
3992: }
3993:
1.994 raeburn 3994: sub role_status {
1.1002 raeburn 3995: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 3996: my @pwhere = ();
3997: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
3998: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
3999: unless (!defined($$role) || $$role eq '') {
4000: $$where=join('.',@pwhere);
4001: $$trolecode=$$role.'.'.$$where;
4002: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4003: $$tstatus='is';
4004: if ($$tstart && $$tstart>$then) {
4005: $$tstatus='future';
1.1034 raeburn 4006: if ($$tstart<$now) {
4007: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 4008: if (($$where ne '') && ($$role ne '')) {
4009: my (%allroles,%allgroups,$group_privs);
4010: my %userroles = (
4011: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4012: );
4013: my $spec=$$role.'.'.$$where;
4014: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4015: if ($$role =~ /^cr\//) {
4016: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4017: } elsif ($$role eq 'gr') {
4018: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4019: $env{'user.name'});
4020: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
4021: (undef,my $group_privs) = split(/\//,$trole);
4022: $group_privs = &unescape($group_privs);
4023: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4024: } else {
4025: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4026: }
4027: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
4028: &appenv(\%userroles,[$$role,'cm']);
4029: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4030: }
4031: }
1.1034 raeburn 4032: $$tstatus = 'is';
1.1002 raeburn 4033: }
1.994 raeburn 4034: }
4035: if ($$tend) {
4036: if ($$tend<$then) {
4037: $$tstatus='expired';
4038: } elsif ($$tend<$now) {
4039: $$tstatus='will_not';
4040: }
4041: }
4042: }
4043: }
4044: }
4045:
4046: sub check_adhoc_privs {
1.1002 raeburn 4047: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994 raeburn 4048: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4049: if ($env{$cckey}) {
4050: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002 raeburn 4051: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 4052: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4053: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4054: }
4055: } else {
4056: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4057: }
4058: }
4059:
4060: sub set_adhoc_privileges {
4061: # role can be cc or ca
4062: my ($dcdom,$pickedcourse,$role) = @_;
4063: my $area = '/'.$dcdom.'/'.$pickedcourse;
4064: my $spec = $role.'.'.$area;
4065: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4066: $env{'user.name'});
4067: my %ccrole = ();
4068: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4069: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4070: &appenv(\%userroles,[$role,'cm']);
4071: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4072: &appenv( {'request.role' => $spec,
4073: 'request.role.domain' => $dcdom,
4074: 'request.course.sec' => ''
4075: }
4076: );
4077: my $tadv=0;
4078: if (&allowed('adv') eq 'F') { $tadv=1; }
4079: &appenv({'request.role.adv' => $tadv});
4080: }
4081:
1.12 www 4082: # --------------------------------------------------------------- get interface
4083:
4084: sub get {
1.131 albertel 4085: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4086: my $items='';
1.800 albertel 4087: foreach my $item (@$storearr) {
4088: $items.=&escape($item).'&';
1.191 harris41 4089: }
1.12 www 4090: $items=~s/\&$//;
1.620 albertel 4091: if (!$udomain) { $udomain=$env{'user.domain'}; }
4092: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 4093: my $uhome=&homeserver($uname,$udomain);
4094:
1.133 albertel 4095: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4096: my @pairs=split(/\&/,$rep);
1.273 albertel 4097: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4098: return @pairs;
4099: }
1.15 www 4100: my %returnhash=();
1.42 www 4101: my $i=0;
1.800 albertel 4102: foreach my $item (@$storearr) {
4103: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4104: $i++;
1.191 harris41 4105: }
1.15 www 4106: return %returnhash;
1.27 www 4107: }
4108:
4109: # --------------------------------------------------------------- del interface
4110:
4111: sub del {
1.133 albertel 4112: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 4113: my $items='';
1.800 albertel 4114: foreach my $item (@$storearr) {
4115: $items.=&escape($item).'&';
1.191 harris41 4116: }
1.984 neumanie 4117:
1.27 www 4118: $items=~s/\&$//;
1.620 albertel 4119: if (!$udomain) { $udomain=$env{'user.domain'}; }
4120: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4121: my $uhome=&homeserver($uname,$udomain);
4122: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4123: }
4124:
4125: # -------------------------------------------------------------- dump interface
4126:
4127: sub dump {
1.755 albertel 4128: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4129: if (!$udomain) { $udomain=$env{'user.domain'}; }
4130: if (!$uname) { $uname=$env{'user.name'}; }
4131: my $uhome=&homeserver($uname,$udomain);
4132: if ($regexp) {
4133: $regexp=&escape($regexp);
4134: } else {
4135: $regexp='.';
4136: }
4137: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4138: my @pairs=split(/\&/,$rep);
4139: my %returnhash=();
4140: foreach my $item (@pairs) {
4141: my ($key,$value)=split(/=/,$item,2);
4142: $key = &unescape($key);
4143: next if ($key =~ /^error: 2 /);
4144: $returnhash{$key}=&thaw_unescape($value);
4145: }
4146: return %returnhash;
1.407 www 4147: }
4148:
1.717 albertel 4149: # --------------------------------------------------------- dumpstore interface
4150:
4151: sub dumpstore {
4152: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 4153: if (!$udomain) { $udomain=$env{'user.domain'}; }
4154: if (!$uname) { $uname=$env{'user.name'}; }
4155: my $uhome=&homeserver($uname,$udomain);
4156: if ($regexp) {
4157: $regexp=&escape($regexp);
4158: } else {
4159: $regexp='.';
4160: }
4161: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4162: my @pairs=split(/\&/,$rep);
4163: my %returnhash=();
4164: foreach my $item (@pairs) {
4165: my ($key,$value)=split(/=/,$item,2);
4166: next if ($key =~ /^error: 2 /);
4167: $returnhash{$key}=&thaw_unescape($value);
4168: }
4169: return %returnhash;
1.717 albertel 4170: }
4171:
1.407 www 4172: # -------------------------------------------------------------- keys interface
4173:
4174: sub getkeys {
4175: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 4176: if (!$udomain) { $udomain=$env{'user.domain'}; }
4177: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 4178: my $uhome=&homeserver($uname,$udomain);
4179: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4180: my @keyarray=();
1.800 albertel 4181: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 4182: next if ($key =~ /^error: 2 /);
1.800 albertel 4183: push(@keyarray,&unescape($key));
1.407 www 4184: }
4185: return @keyarray;
1.318 matthew 4186: }
4187:
1.319 matthew 4188: # --------------------------------------------------------------- currentdump
4189: sub currentdump {
1.328 matthew 4190: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 4191: $courseid = $env{'request.course.id'} if (! defined($courseid));
4192: $sdom = $env{'user.domain'} if (! defined($sdom));
4193: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 4194: my $uhome = &homeserver($sname,$sdom);
4195: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 4196: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 4197: #
1.318 matthew 4198: my %returnhash=();
1.319 matthew 4199: #
4200: if ($rep eq "unknown_cmd") {
4201: # an old lond will not know currentdump
4202: # Do a dump and make it look like a currentdump
1.822 albertel 4203: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 4204: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4205: my %hash = @tmp;
4206: @tmp=();
1.424 matthew 4207: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 4208: } else {
4209: my @pairs=split(/\&/,$rep);
1.800 albertel 4210: foreach my $pair (@pairs) {
4211: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 4212: my ($symb,$param) = split(/:/,$key);
4213: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 4214: &thaw_unescape($value);
1.319 matthew 4215: }
1.191 harris41 4216: }
1.12 www 4217: return %returnhash;
1.424 matthew 4218: }
4219:
4220: sub convert_dump_to_currentdump{
4221: my %hash = %{shift()};
4222: my %returnhash;
4223: # Code ripped from lond, essentially. The only difference
4224: # here is the unescaping done by lonnet::dump(). Conceivably
4225: # we might run in to problems with parameter names =~ /^v\./
4226: while (my ($key,$value) = each(%hash)) {
4227: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 4228: $symb = &unescape($symb);
4229: $param = &unescape($param);
1.424 matthew 4230: next if ($v eq 'version' || $symb eq 'keys');
4231: next if (exists($returnhash{$symb}) &&
4232: exists($returnhash{$symb}->{$param}) &&
4233: $returnhash{$symb}->{'v.'.$param} > $v);
4234: $returnhash{$symb}->{$param}=$value;
4235: $returnhash{$symb}->{'v.'.$param}=$v;
4236: }
4237: #
4238: # Remove all of the keys in the hashes which keep track of
4239: # the version of the parameter.
4240: while (my ($symb,$param_hash) = each(%returnhash)) {
4241: # use a foreach because we are going to delete from the hash.
4242: foreach my $key (keys(%$param_hash)) {
4243: delete($param_hash->{$key}) if ($key =~ /^v\./);
4244: }
4245: }
4246: return \%returnhash;
1.12 www 4247: }
4248:
1.627 albertel 4249: # ------------------------------------------------------ critical inc interface
4250:
4251: sub cinc {
4252: return &inc(@_,'critical');
4253: }
4254:
1.449 matthew 4255: # --------------------------------------------------------------- inc interface
4256:
4257: sub inc {
1.627 albertel 4258: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 4259: if (!$udomain) { $udomain=$env{'user.domain'}; }
4260: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 4261: my $uhome=&homeserver($uname,$udomain);
4262: my $items='';
4263: if (! ref($store)) {
4264: # got a single value, so use that instead
4265: $items = &escape($store).'=&';
4266: } elsif (ref($store) eq 'SCALAR') {
4267: $items = &escape($$store).'=&';
4268: } elsif (ref($store) eq 'ARRAY') {
4269: $items = join('=&',map {&escape($_);} @{$store});
4270: } elsif (ref($store) eq 'HASH') {
4271: while (my($key,$value) = each(%{$store})) {
4272: $items.= &escape($key).'='.&escape($value).'&';
4273: }
4274: }
4275: $items=~s/\&$//;
1.627 albertel 4276: if ($critical) {
4277: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4278: } else {
4279: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4280: }
1.449 matthew 4281: }
4282:
1.12 www 4283: # --------------------------------------------------------------- put interface
4284:
4285: sub put {
1.134 albertel 4286: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4287: if (!$udomain) { $udomain=$env{'user.domain'}; }
4288: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4289: my $uhome=&homeserver($uname,$udomain);
1.12 www 4290: my $items='';
1.800 albertel 4291: foreach my $item (keys(%$storehash)) {
4292: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4293: }
1.12 www 4294: $items=~s/\&$//;
1.134 albertel 4295: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 4296: }
4297:
1.631 albertel 4298: # ------------------------------------------------------------ newput interface
4299:
4300: sub newput {
4301: my ($namespace,$storehash,$udomain,$uname)=@_;
4302: if (!$udomain) { $udomain=$env{'user.domain'}; }
4303: if (!$uname) { $uname=$env{'user.name'}; }
4304: my $uhome=&homeserver($uname,$udomain);
4305: my $items='';
4306: foreach my $key (keys(%$storehash)) {
4307: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4308: }
4309: $items=~s/\&$//;
4310: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4311: }
4312:
4313: # --------------------------------------------------------- putstore interface
4314:
1.524 raeburn 4315: sub putstore {
1.715 albertel 4316: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 4317: if (!$udomain) { $udomain=$env{'user.domain'}; }
4318: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 4319: my $uhome=&homeserver($uname,$udomain);
4320: my $items='';
1.715 albertel 4321: foreach my $key (keys(%$storehash)) {
4322: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 4323: }
1.715 albertel 4324: $items=~s/\&$//;
1.716 albertel 4325: my $esc_symb=&escape($symb);
4326: my $esc_v=&escape($version);
1.715 albertel 4327: my $reply =
1.716 albertel 4328: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 4329: $uhome);
4330: if ($reply eq 'unknown_cmd') {
1.716 albertel 4331: # gfall back to way things use to be done
1.715 albertel 4332: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4333: $uname);
1.524 raeburn 4334: }
1.715 albertel 4335: return $reply;
4336: }
4337:
4338: sub old_putstore {
1.716 albertel 4339: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4340: if (!$udomain) { $udomain=$env{'user.domain'}; }
4341: if (!$uname) { $uname=$env{'user.name'}; }
4342: my $uhome=&homeserver($uname,$udomain);
4343: my %newstorehash;
1.800 albertel 4344: foreach my $item (keys(%$storehash)) {
4345: my $key = $version.':'.&escape($symb).':'.$item;
4346: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 4347: }
4348: my $items='';
4349: my %allitems = ();
1.800 albertel 4350: foreach my $item (keys(%newstorehash)) {
4351: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 4352: my $key = $1.':keys:'.$2;
4353: $allitems{$key} .= $3.':';
4354: }
1.800 albertel 4355: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 4356: }
1.800 albertel 4357: foreach my $item (keys(%allitems)) {
4358: $allitems{$item} =~ s/\:$//;
4359: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 4360: }
4361: $items=~s/\&$//;
4362: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 4363: }
4364:
1.47 www 4365: # ------------------------------------------------------ critical put interface
4366:
4367: sub cput {
1.134 albertel 4368: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4369: if (!$udomain) { $udomain=$env{'user.domain'}; }
4370: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4371: my $uhome=&homeserver($uname,$udomain);
1.47 www 4372: my $items='';
1.800 albertel 4373: foreach my $item (keys(%$storehash)) {
4374: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4375: }
1.47 www 4376: $items=~s/\&$//;
1.134 albertel 4377: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4378: }
4379:
4380: # -------------------------------------------------------------- eget interface
4381:
4382: sub eget {
1.133 albertel 4383: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4384: my $items='';
1.800 albertel 4385: foreach my $item (@$storearr) {
4386: $items.=&escape($item).'&';
1.191 harris41 4387: }
1.12 www 4388: $items=~s/\&$//;
1.620 albertel 4389: if (!$udomain) { $udomain=$env{'user.domain'}; }
4390: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4391: my $uhome=&homeserver($uname,$udomain);
4392: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4393: my @pairs=split(/\&/,$rep);
4394: my %returnhash=();
1.42 www 4395: my $i=0;
1.800 albertel 4396: foreach my $item (@$storearr) {
4397: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4398: $i++;
1.191 harris41 4399: }
1.12 www 4400: return %returnhash;
4401: }
4402:
1.667 albertel 4403: # ------------------------------------------------------------ tmpput interface
4404: sub tmpput {
1.802 raeburn 4405: my ($storehash,$server,$context)=@_;
1.667 albertel 4406: my $items='';
1.800 albertel 4407: foreach my $item (keys(%$storehash)) {
4408: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 4409: }
4410: $items=~s/\&$//;
1.802 raeburn 4411: if (defined($context)) {
4412: $items .= ':'.&escape($context);
4413: }
1.667 albertel 4414: return &reply("tmpput:$items",$server);
4415: }
4416:
4417: # ------------------------------------------------------------ tmpget interface
4418: sub tmpget {
1.688 albertel 4419: my ($token,$server)=@_;
4420: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4421: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 4422: my %returnhash;
4423: foreach my $item (split(/\&/,$rep)) {
4424: my ($key,$value)=split(/=/,$item);
1.951 raeburn 4425: next if ($key =~ /^error: 2 /);
1.667 albertel 4426: $returnhash{&unescape($key)}=&thaw_unescape($value);
4427: }
4428: return %returnhash;
4429: }
4430:
1.688 albertel 4431: # ------------------------------------------------------------ tmpget interface
4432: sub tmpdel {
4433: my ($token,$server)=@_;
4434: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4435: return &reply("tmpdel:$token",$server);
4436: }
4437:
1.765 albertel 4438: # -------------------------------------------------- portfolio access checking
4439:
4440: sub portfolio_access {
1.766 albertel 4441: my ($requrl) = @_;
1.765 albertel 4442: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4443: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 4444: if ($result) {
4445: my %setters;
4446: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4447: my ($startblock,$endblock) =
4448: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4449: if ($startblock && $endblock) {
4450: return 'B';
4451: }
4452: } else {
4453: my ($startblock,$endblock) =
4454: &Apache::loncommon::blockcheck(\%setters,'port');
4455: if ($startblock && $endblock) {
4456: return 'B';
4457: }
4458: }
4459: }
1.765 albertel 4460: if ($result eq 'ok') {
1.766 albertel 4461: return 'F';
1.765 albertel 4462: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 4463: return 'A';
1.765 albertel 4464: }
1.766 albertel 4465: return '';
1.765 albertel 4466: }
4467:
4468: sub get_portfolio_access {
1.767 albertel 4469: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4470:
4471: if (!ref($access_hash)) {
4472: my $current_perms = &get_portfile_permissions($udom,$unum);
4473: my %access_controls = &get_access_controls($current_perms,$group,
4474: $file_name);
4475: $access_hash = $access_controls{$file_name};
4476: }
4477:
1.765 albertel 4478: my ($public,$guest,@domains,@users,@courses,@groups);
4479: my $now = time;
4480: if (ref($access_hash) eq 'HASH') {
4481: foreach my $key (keys(%{$access_hash})) {
4482: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4483: if ($start > $now) {
4484: next;
4485: }
4486: if ($end && $end<$now) {
4487: next;
4488: }
4489: if ($scope eq 'public') {
4490: $public = $key;
4491: last;
4492: } elsif ($scope eq 'guest') {
4493: $guest = $key;
4494: } elsif ($scope eq 'domains') {
4495: push(@domains,$key);
4496: } elsif ($scope eq 'users') {
4497: push(@users,$key);
4498: } elsif ($scope eq 'course') {
4499: push(@courses,$key);
4500: } elsif ($scope eq 'group') {
4501: push(@groups,$key);
4502: }
4503: }
4504: if ($public) {
4505: return 'ok';
4506: }
4507: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4508: if ($guest) {
4509: return $guest;
4510: }
4511: } else {
4512: if (@domains > 0) {
4513: foreach my $domkey (@domains) {
4514: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4515: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4516: return 'ok';
4517: }
4518: }
4519: }
4520: }
4521: if (@users > 0) {
4522: foreach my $userkey (@users) {
1.865 raeburn 4523: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4524: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4525: if (ref($item) eq 'HASH') {
4526: if (($item->{'uname'} eq $env{'user.name'}) &&
4527: ($item->{'udom'} eq $env{'user.domain'})) {
4528: return 'ok';
4529: }
4530: }
4531: }
4532: }
1.765 albertel 4533: }
4534: }
4535: my %roleshash;
4536: my @courses_and_groups = @courses;
4537: push(@courses_and_groups,@groups);
4538: if (@courses_and_groups > 0) {
4539: my (%allgroups,%allroles);
4540: my ($start,$end,$role,$sec,$group);
4541: foreach my $envkey (%env) {
1.811 albertel 4542: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4543: my $cid = $2.'_'.$3;
4544: if ($1 eq 'gr') {
4545: $group = $4;
4546: $allgroups{$cid}{$group} = $env{$envkey};
4547: } else {
4548: if ($4 eq '') {
4549: $sec = 'none';
4550: } else {
4551: $sec = $4;
4552: }
4553: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4554: }
1.811 albertel 4555: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4556: my $cid = $2.'_'.$3;
4557: if ($4 eq '') {
4558: $sec = 'none';
4559: } else {
4560: $sec = $4;
4561: }
4562: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4563: }
4564: }
4565: if (keys(%allroles) == 0) {
4566: return;
4567: }
4568: foreach my $key (@courses_and_groups) {
4569: my %content = %{$$access_hash{$key}};
4570: my $cnum = $content{'number'};
4571: my $cdom = $content{'domain'};
4572: my $cid = $cdom.'_'.$cnum;
4573: if (!exists($allroles{$cid})) {
4574: next;
4575: }
4576: foreach my $role_id (keys(%{$content{'roles'}})) {
4577: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4578: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4579: my @status = @{$content{'roles'}{$role_id}{'access'}};
4580: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4581: foreach my $role (keys(%{$allroles{$cid}})) {
4582: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4583: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4584: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4585: if (grep/^all$/,@sections) {
4586: return 'ok';
4587: } else {
4588: if (grep/^$sec$/,@sections) {
4589: return 'ok';
4590: }
4591: }
4592: }
4593: }
4594: if (keys(%{$allgroups{$cid}}) == 0) {
4595: if (grep/^none$/,@groups) {
4596: return 'ok';
4597: }
4598: } else {
4599: if (grep/^all$/,@groups) {
4600: return 'ok';
4601: }
4602: foreach my $group (keys(%{$allgroups{$cid}})) {
4603: if (grep/^$group$/,@groups) {
4604: return 'ok';
4605: }
4606: }
4607: }
4608: }
4609: }
4610: }
4611: }
4612: }
4613: if ($guest) {
4614: return $guest;
4615: }
4616: }
4617: }
4618: return;
4619: }
4620:
4621: sub course_group_datechecker {
4622: my ($dates,$now,$status) = @_;
4623: my ($start,$end) = split(/\./,$dates);
4624: if (!$start && !$end) {
4625: return 'ok';
4626: }
4627: if (grep/^active$/,@{$status}) {
4628: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4629: return 'ok';
4630: }
4631: }
4632: if (grep/^previous$/,@{$status}) {
4633: if ($end > $now ) {
4634: return 'ok';
4635: }
4636: }
4637: if (grep/^future$/,@{$status}) {
4638: if ($start > $now) {
4639: return 'ok';
4640: }
4641: }
4642: return;
4643: }
4644:
4645: sub parse_portfolio_url {
4646: my ($url) = @_;
4647:
4648: my ($type,$udom,$unum,$group,$file_name);
4649:
1.823 albertel 4650: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4651: $type = 1;
4652: $udom = $1;
4653: $unum = $2;
4654: $file_name = $3;
1.823 albertel 4655: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4656: $type = 2;
4657: $udom = $1;
4658: $unum = $2;
4659: $group = $3;
4660: $file_name = $3.'/'.$4;
4661: }
4662: if (wantarray) {
4663: return ($type,$udom,$unum,$file_name,$group);
4664: }
4665: return $type;
4666: }
4667:
4668: sub is_portfolio_url {
4669: my ($url) = @_;
4670: return scalar(&parse_portfolio_url($url));
4671: }
4672:
1.798 raeburn 4673: sub is_portfolio_file {
4674: my ($file) = @_;
1.820 raeburn 4675: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4676: return 1;
4677: }
4678: return;
4679: }
4680:
1.976 raeburn 4681: sub usertools_access {
1.985 raeburn 4682: my ($uname,$udom,$tool,$action,$context) = @_;
4683: my ($access,%tools);
4684: if ($context eq '') {
4685: $context = 'tools';
4686: }
4687: if ($context eq 'requestcourses') {
4688: %tools = (
4689: official => 1,
4690: unofficial => 1,
1.1006 raeburn 4691: community => 1,
1.985 raeburn 4692: );
4693: } else {
4694: %tools = (
4695: aboutme => 1,
4696: blog => 1,
4697: portfolio => 1,
4698: );
4699: }
1.976 raeburn 4700: return if (!defined($tools{$tool}));
4701:
4702: if ((!defined($udom)) || (!defined($uname))) {
4703: $udom = $env{'user.domain'};
4704: $uname = $env{'user.name'};
4705: }
4706:
1.978 raeburn 4707: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4708: if ($action ne 'reload') {
1.985 raeburn 4709: if ($context eq 'requestcourses') {
4710: return $env{'environment.canrequest.'.$tool};
4711: } else {
4712: return $env{'environment.availabletools.'.$tool};
4713: }
4714: }
1.976 raeburn 4715: }
4716:
4717: my ($toolstatus,$inststatus);
4718:
1.985 raeburn 4719: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4720: ($action ne 'reload')) {
4721: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 4722: $inststatus = $env{'environment.inststatus'};
4723: } else {
1.1025 raeburn 4724: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
1.985 raeburn 4725: $toolstatus = $userenv{$context.'.'.$tool};
1.976 raeburn 4726: $inststatus = $userenv{'inststatus'};
4727: }
4728:
4729: if ($toolstatus ne '') {
4730: if ($toolstatus) {
4731: $access = 1;
4732: } else {
4733: $access = 0;
4734: }
4735: return $access;
4736: }
4737:
4738: my $is_adv = &is_advanced_user($udom,$uname);
4739: my %domdef = &get_domain_defaults($udom);
4740: if (ref($domdef{$tool}) eq 'HASH') {
4741: if ($is_adv) {
4742: if ($domdef{$tool}{'_LC_adv'} ne '') {
4743: if ($domdef{$tool}{'_LC_adv'}) {
4744: $access = 1;
4745: } else {
4746: $access = 0;
4747: }
4748: return $access;
4749: }
4750: }
4751: if ($inststatus ne '') {
4752: my ($hasaccess,$hasnoaccess);
4753: foreach my $affiliation (split(/:/,$inststatus)) {
4754: if ($domdef{$tool}{$affiliation} ne '') {
4755: if ($domdef{$tool}{$affiliation}) {
4756: $hasaccess = 1;
4757: } else {
4758: $hasnoaccess = 1;
4759: }
4760: }
4761: }
4762: if ($hasaccess || $hasnoaccess) {
4763: if ($hasaccess) {
4764: $access = 1;
4765: } elsif ($hasnoaccess) {
4766: $access = 0;
4767: }
4768: return $access;
4769: }
4770: } else {
4771: if ($domdef{$tool}{'default'} ne '') {
4772: if ($domdef{$tool}{'default'}) {
4773: $access = 1;
4774: } elsif ($domdef{$tool}{'default'} == 0) {
4775: $access = 0;
4776: }
4777: return $access;
4778: }
4779: }
4780: } else {
1.985 raeburn 4781: if ($context eq 'tools') {
4782: $access = 1;
4783: } else {
4784: $access = 0;
4785: }
1.976 raeburn 4786: return $access;
4787: }
4788: }
4789:
1.1050 raeburn 4790: sub is_course_owner {
4791: my ($cdom,$cnum,$udom,$uname) = @_;
4792: if (($udom eq '') || ($uname eq '')) {
4793: $udom = $env{'user.domain'};
4794: $uname = $env{'user.name'};
4795: }
4796: unless (($udom eq '') || ($uname eq '')) {
4797: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4798: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4799: return 1;
4800: } else {
4801: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4802: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4803: return 1;
4804: }
4805: }
4806: }
4807: }
4808: return;
4809: }
4810:
1.976 raeburn 4811: sub is_advanced_user {
4812: my ($udom,$uname) = @_;
4813: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4814: my %allroles;
4815: my $is_adv;
4816: foreach my $role (keys(%roleshash)) {
4817: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4818: my $area = '/'.$tdomain.'/'.$trest;
4819: if ($sec ne '') {
4820: $area .= '/'.$sec;
4821: }
4822: if (($area ne '') && ($trole ne '')) {
4823: my $spec=$trole.'.'.$area;
4824: if ($trole =~ /^cr\//) {
4825: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4826: } elsif ($trole ne 'gr') {
4827: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4828: }
4829: }
4830: }
4831: foreach my $role (keys(%allroles)) {
4832: last if ($is_adv);
4833: foreach my $item (split(/:/,$allroles{$role})) {
4834: if ($item ne '') {
4835: my ($privilege,$restrictions)=split(/&/,$item);
4836: if ($privilege eq 'adv') {
4837: $is_adv = 1;
4838: last;
4839: }
4840: }
4841: }
4842: }
4843: return $is_adv;
4844: }
1.798 raeburn 4845:
1.1035 raeburn 4846: sub check_can_request {
1.1036 raeburn 4847: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 4848: my $canreq = 0;
4849: my ($types,$typename) = &Apache::loncommon::course_types();
4850: my @options = ('approval','validate','autolimit');
4851: my $optregex = join('|',@options);
4852: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4853: foreach my $type (@{$types}) {
4854: if (&usertools_access($env{'user.name'},
4855: $env{'user.domain'},
4856: $type,undef,'requestcourses')) {
4857: $canreq ++;
1.1036 raeburn 4858: if (ref($request_domains) eq 'HASH') {
4859: push(@{$request_domains->{$type}},$env{'user.domain'});
4860: }
1.1035 raeburn 4861: if ($dom eq $env{'user.domain'}) {
4862: $can_request->{$type} = 1;
4863: }
4864: }
4865: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4866: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4867: if (@curr > 0) {
1.1036 raeburn 4868: foreach my $item (@curr) {
4869: if (ref($request_domains) eq 'HASH') {
4870: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4871: if ($otherdom ne '') {
4872: if (ref($request_domains->{$type}) eq 'ARRAY') {
4873: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4874: push(@{$request_domains->{$type}},$otherdom);
4875: }
4876: } else {
4877: push(@{$request_domains->{$type}},$otherdom);
4878: }
4879: }
4880: }
4881: }
4882: unless($dom eq $env{'user.domain'}) {
4883: $canreq ++;
1.1035 raeburn 4884: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4885: $can_request->{$type} = 1;
4886: }
4887: }
4888: }
4889: }
4890: }
4891: }
4892: return $canreq;
4893: }
4894:
1.341 www 4895: # ---------------------------------------------- Custom access rule evaluation
4896:
4897: sub customaccess {
4898: my ($priv,$uri)=@_;
1.807 albertel 4899: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 4900: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 4901: $udom = &LONCAPA::clean_domain($udom);
4902: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 4903: my $access=0;
1.800 albertel 4904: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 4905: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4906: if ($type eq 'user') {
4907: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 4908: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 4909: if ($tdom) {
4910: if ($tdom ne $env{'user.domain'}) { next; }
4911: }
1.896 albertel 4912: if ($tuname) {
4913: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 4914: }
4915: $access=($effect eq 'allow');
4916: last;
4917: }
4918: } else {
4919: if ($role) {
4920: if ($role ne $urole) { next; }
4921: }
4922: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4923: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4924: if ($tdom) {
4925: if ($tdom ne $udom) { next; }
4926: }
4927: if ($tcrs) {
4928: if ($tcrs ne $ucrs) { next; }
4929: }
4930: if ($tsec) {
4931: if ($tsec ne $usec) { next; }
4932: }
4933: $access=($effect eq 'allow');
4934: last;
4935: }
4936: if ($realm eq '' && $role eq '') {
4937: $access=($effect eq 'allow');
4938: }
1.402 bowersj2 4939: }
1.341 www 4940: }
4941: return $access;
4942: }
4943:
1.103 harris41 4944: # ------------------------------------------------- Check for a user privilege
1.12 www 4945:
4946: sub allowed {
1.810 raeburn 4947: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 4948: my $ver_orguri=$uri;
1.439 www 4949: $uri=&deversion($uri);
1.152 www 4950: my $orguri=$uri;
1.52 www 4951: $uri=&declutter($uri);
1.809 raeburn 4952:
1.810 raeburn 4953: if ($priv eq 'evb') {
4954: # Evade communication block restrictions for specified role in a course
4955: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4956: return $1;
4957: } else {
4958: return;
4959: }
4960: }
4961:
1.620 albertel 4962: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 4963: # Free bre access to adm and meta resources
1.775 albertel 4964: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 4965: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
4966: && ($priv eq 'bre')) {
1.14 www 4967: return 'F';
1.159 www 4968: }
4969:
1.545 banghart 4970: # Free bre access to user's own portfolio contents
1.714 raeburn 4971: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 4972: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 4973: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 4974: my %setters;
4975: my ($startblock,$endblock) =
4976: &Apache::loncommon::blockcheck(\%setters,'port');
4977: if ($startblock && $endblock) {
4978: return 'B';
4979: } else {
4980: return 'F';
4981: }
1.545 banghart 4982: }
4983:
1.762 raeburn 4984: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 4985: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
4986: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
4987: if (exists($env{'request.course.id'})) {
4988: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
4989: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
4990: if (($domain eq $cdom) && ($name eq $cnum)) {
4991: my $courseprivid=$env{'request.course.id'};
4992: $courseprivid=~s/\_/\//;
4993: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
4994: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
4995: return $1;
1.762 raeburn 4996: } else {
4997: if ($env{'request.course.sec'}) {
4998: $courseprivid.='/'.$env{'request.course.sec'};
4999: }
5000: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5001: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5002: return $2;
5003: }
1.714 raeburn 5004: }
5005: }
5006: }
5007: }
5008:
1.159 www 5009: # Free bre to public access
5010:
5011: if ($priv eq 'bre') {
1.238 www 5012: my $copyright=&metadata($uri,'copyright');
1.620 albertel 5013: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 5014: return 'F';
5015: }
1.238 www 5016: if ($copyright eq 'priv') {
5017: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5018: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 5019: return '';
5020: }
5021: }
5022: if ($copyright eq 'domain') {
5023: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5024: unless (($env{'user.domain'} eq $1) ||
5025: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 5026: return '';
5027: }
1.262 matthew 5028: }
1.620 albertel 5029: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 5030: # Library role, so allow browsing of resources in this domain.
5031: return 'F';
1.238 www 5032: }
1.341 www 5033: if ($copyright eq 'custom') {
5034: unless (&customaccess($priv,$uri)) { return ''; }
5035: }
1.14 www 5036: }
1.264 matthew 5037: # Domain coordinator is trying to create a course
1.620 albertel 5038: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 5039: # uri is the requested domain in this case.
5040: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 5041: # a role of dc for the domain in question.
1.620 albertel 5042: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 5043: }
1.29 www 5044:
1.52 www 5045: my $thisallowed='';
5046: my $statecond=0;
5047: my $courseprivid='';
5048:
1.1039 raeburn 5049: my $ownaccess;
1.1043 raeburn 5050: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 5051: if (($priv eq 'bro') && ($env{'user.author'})) {
5052: if ($uri eq '') {
5053: $ownaccess = 1;
5054: } else {
5055: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5056: my $udom = $env{'user.domain'};
5057: my $uname = $env{'user.name'};
5058: if ($uri =~ m{^\Q$udom\E/?$}) {
5059: $ownaccess = 1;
1.1040 raeburn 5060: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 5061: unless ($uri =~ m{\.\./}) {
5062: $ownaccess = 1;
5063: }
5064: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5065: my $now = time;
5066: if ($uri =~ m{^([^/]+)/?$}) {
5067: my $adom = $1;
5068: foreach my $key (keys(%env)) {
1.1042 raeburn 5069: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 5070: my ($start,$end) = split('.',$env{$key});
5071: if (($now >= $start) && (!$end || $end < $now)) {
5072: $ownaccess = 1;
5073: last;
5074: }
5075: }
5076: }
5077: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5078: my $adom = $1;
5079: my $aname = $2;
1.1042 raeburn 5080: foreach my $role ('ca','aa') {
5081: if ($env{"user.role.$role./$adom/$aname"}) {
5082: my ($start,$end) =
5083: split('.',$env{"user.role.$role./$adom/$aname"});
5084: if (($now >= $start) && (!$end || $end < $now)) {
5085: $ownaccess = 1;
5086: last;
5087: }
1.1039 raeburn 5088: }
5089: }
5090: }
5091: }
5092: }
5093: }
5094: }
5095:
1.52 www 5096: # Course
5097:
1.620 albertel 5098: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5099: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5100: $thisallowed.=$1;
5101: }
1.52 www 5102: }
1.29 www 5103:
1.52 www 5104: # Domain
5105:
1.620 albertel 5106: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 5107: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5108: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5109: $thisallowed.=$1;
5110: }
1.12 www 5111: }
1.52 www 5112:
5113: # Course: uri itself is a course
1.66 www 5114: my $courseuri=$uri;
5115: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 5116: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 5117:
1.620 albertel 5118: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 5119: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5120: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5121: $thisallowed.=$1;
5122: }
1.12 www 5123: }
1.29 www 5124:
1.665 albertel 5125: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 5126: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 5127: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 5128: $thisallowed='';
1.671 raeburn 5129: my ($match)=&is_on_map($uri);
5130: if ($match) {
5131: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5132: =~/\Q$priv\E\&([^\:]*)/) {
5133: $thisallowed.=$1;
5134: }
5135: } else {
1.705 albertel 5136: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 5137: if ($refuri) {
5138: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 5139: $thisallowed='F';
1.671 raeburn 5140: } else {
5141: $refuri=&declutter($refuri);
5142: my ($match) = &is_on_map($refuri);
5143: if ($match) {
5144: $thisallowed='F';
5145: }
1.669 raeburn 5146: }
1.671 raeburn 5147: }
5148: }
1.314 www 5149: }
1.492 albertel 5150:
1.766 albertel 5151: if ($priv eq 'bre'
5152: && $thisallowed ne 'F'
5153: && $thisallowed ne '2'
5154: && &is_portfolio_url($uri)) {
5155: $thisallowed = &portfolio_access($uri);
5156: }
5157:
1.52 www 5158: # Full access at system, domain or course-wide level? Exit.
1.29 www 5159: if ($thisallowed=~/F/) {
5160: return 'F';
5161: }
5162:
1.52 www 5163: # If this is generating or modifying users, exit with special codes
1.29 www 5164:
1.643 www 5165: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5166: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 5167: my ($audom,$auname)=split('/',$uri);
1.643 www 5168: # no author name given, so this just checks on the general right to make a co-author in this domain
5169: unless ($auname) { return $thisallowed; }
5170: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 5171: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5172: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5173: ($audom ne $env{'request.role.domain'}))) { return ''; }
5174: }
1.52 www 5175: return $thisallowed;
5176: }
5177: #
1.103 harris41 5178: # Gathered so far: system, domain and course wide privileges
1.52 www 5179: #
5180: # Course: See if uri or referer is an individual resource that is part of
5181: # the course
5182:
1.620 albertel 5183: if ($env{'request.course.id'}) {
1.232 www 5184:
1.620 albertel 5185: $courseprivid=$env{'request.course.id'};
5186: if ($env{'request.course.sec'}) {
5187: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 5188: }
5189: $courseprivid=~s/\_/\//;
5190: my $checkreferer=1;
1.232 www 5191: my ($match,$cond)=&is_on_map($uri);
5192: if ($match) {
5193: $statecond=$cond;
1.620 albertel 5194: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5195: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5196: $thisallowed.=$1;
5197: $checkreferer=0;
5198: }
1.29 www 5199: }
1.83 www 5200:
1.148 www 5201: if ($checkreferer) {
1.620 albertel 5202: my $refuri=$env{'httpref.'.$orguri};
1.148 www 5203: unless ($refuri) {
1.800 albertel 5204: foreach my $key (keys(%env)) {
5205: if ($key=~/^httpref\..*\*/) {
5206: my $pattern=$key;
1.156 www 5207: $pattern=~s/^httpref\.\/res\///;
1.148 www 5208: $pattern=~s/\*/\[\^\/\]\+/g;
5209: $pattern=~s/\//\\\//g;
1.152 www 5210: if ($orguri=~/$pattern/) {
1.800 albertel 5211: $refuri=$env{$key};
1.148 www 5212: }
5213: }
1.191 harris41 5214: }
1.148 www 5215: }
1.232 www 5216:
1.148 www 5217: if ($refuri) {
1.152 www 5218: $refuri=&declutter($refuri);
1.232 www 5219: my ($match,$cond)=&is_on_map($refuri);
5220: if ($match) {
5221: my $refstatecond=$cond;
1.620 albertel 5222: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5223: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5224: $thisallowed.=$1;
1.53 www 5225: $uri=$refuri;
5226: $statecond=$refstatecond;
1.52 www 5227: }
5228: }
1.148 www 5229: }
1.29 www 5230: }
1.52 www 5231: }
1.29 www 5232:
1.52 www 5233: #
1.103 harris41 5234: # Gathered now: all privileges that could apply, and condition number
1.52 www 5235: #
5236: #
5237: # Full or no access?
5238: #
1.29 www 5239:
1.52 www 5240: if ($thisallowed=~/F/) {
5241: return 'F';
5242: }
1.29 www 5243:
1.52 www 5244: unless ($thisallowed) {
5245: return '';
5246: }
1.29 www 5247:
1.52 www 5248: # Restrictions exist, deal with them
5249: #
5250: # C:according to course preferences
5251: # R:according to resource settings
5252: # L:unless locked
5253: # X:according to user session state
5254: #
5255:
5256: # Possibly locked functionality, check all courses
1.54 www 5257: # Locks might take effect only after 10 minutes cache expiration for other
5258: # courses, and 2 minutes for current course
1.52 www 5259:
5260: my $envkey;
5261: if ($thisallowed=~/L/) {
1.1000 raeburn 5262: foreach $envkey (keys(%env)) {
1.54 www 5263: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5264: my $courseid=$2;
5265: my $roleid=$1.'.'.$2;
1.92 www 5266: $courseid=~s/^\///;
1.54 www 5267: my $expiretime=600;
1.620 albertel 5268: if ($env{'request.role'} eq $roleid) {
1.54 www 5269: $expiretime=120;
5270: }
5271: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5272: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 5273: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 5274: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 5275: }
1.620 albertel 5276: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5277: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5278: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5279: &log($env{'user.domain'},$env{'user.name'},
5280: $env{'user.home'},
1.57 www 5281: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 5282: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5283: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5284: return '';
5285: }
5286: }
1.620 albertel 5287: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5288: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5289: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5290: &log($env{'user.domain'},$env{'user.name'},
5291: $env{'user.home'},
1.57 www 5292: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 5293: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5294: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5295: return '';
5296: }
5297: }
5298: }
1.29 www 5299: }
1.52 www 5300: }
5301:
5302: #
5303: # Rest of the restrictions depend on selected course
5304: #
5305:
1.620 albertel 5306: unless ($env{'request.course.id'}) {
1.766 albertel 5307: if ($thisallowed eq 'A') {
5308: return 'A';
1.814 raeburn 5309: } elsif ($thisallowed eq 'B') {
5310: return 'B';
1.766 albertel 5311: } else {
5312: return '1';
5313: }
1.52 www 5314: }
1.29 www 5315:
1.52 www 5316: #
5317: # Now user is definitely in a course
5318: #
1.53 www 5319:
5320:
5321: # Course preferences
5322:
5323: if ($thisallowed=~/C/) {
1.620 albertel 5324: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5325: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5326: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 5327: =~/\Q$rolecode\E/) {
1.689 albertel 5328: if ($priv ne 'pch') {
5329: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5330: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5331: $env{'request.course.id'});
5332: }
1.237 www 5333: return '';
5334: }
5335:
1.620 albertel 5336: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 5337: =~/\Q$unamedom\E/) {
1.689 albertel 5338: if ($priv ne 'pch') {
5339: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5340: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5341: $env{'request.course.id'});
5342: }
1.54 www 5343: return '';
5344: }
1.53 www 5345: }
5346:
5347: # Resource preferences
5348:
5349: if ($thisallowed=~/R/) {
1.620 albertel 5350: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 5351: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 5352: if ($priv ne 'pch') {
5353: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5354: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5355: }
5356: return '';
1.54 www 5357: }
1.53 www 5358: }
1.30 www 5359:
1.246 www 5360: # Restricted by state or randomout?
1.30 www 5361:
1.52 www 5362: if ($thisallowed=~/X/) {
1.620 albertel 5363: if ($env{'acc.randomout'}) {
1.579 albertel 5364: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 5365: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 5366: return '';
5367: }
1.247 www 5368: }
5369: if (&condval($statecond)) {
1.52 www 5370: return '2';
5371: } else {
5372: return '';
5373: }
5374: }
1.30 www 5375:
1.766 albertel 5376: if ($thisallowed eq 'A') {
5377: return 'A';
1.814 raeburn 5378: } elsif ($thisallowed eq 'B') {
5379: return 'B';
1.766 albertel 5380: }
1.52 www 5381: return 'F';
1.232 www 5382: }
5383:
1.710 albertel 5384: sub split_uri_for_cond {
5385: my $uri=&deversion(&declutter(shift));
5386: my @uriparts=split(/\//,$uri);
5387: my $filename=pop(@uriparts);
5388: my $pathname=join('/',@uriparts);
5389: return ($pathname,$filename);
5390: }
1.232 www 5391: # --------------------------------------------------- Is a resource on the map?
5392:
5393: sub is_on_map {
1.710 albertel 5394: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 5395: #Trying to find the conditional for the file
1.620 albertel 5396: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 5397: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 5398: if ($match) {
1.289 bowersj2 5399: return (1,$1);
5400: } else {
1.434 www 5401: return (0,0);
1.289 bowersj2 5402: }
1.12 www 5403: }
5404:
1.427 www 5405: # --------------------------------------------------------- Get symb from alias
5406:
5407: sub get_symb_from_alias {
5408: my $symb=shift;
5409: my ($map,$resid,$url)=&decode_symb($symb);
5410: # Already is a symb
5411: if ($url) { return $symb; }
5412: # Must be an alias
5413: my $aliassymb='';
5414: my %bighash;
1.620 albertel 5415: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 5416: &GDBM_READER(),0640)) {
5417: my $rid=$bighash{'mapalias_'.$symb};
5418: if ($rid) {
5419: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 5420: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5421: $resid,$bighash{'src_'.$rid});
1.427 www 5422: }
5423: untie %bighash;
5424: }
5425: return $aliassymb;
5426: }
5427:
1.12 www 5428: # ----------------------------------------------------------------- Define Role
5429:
5430: sub definerole {
5431: if (allowed('mcr','/')) {
5432: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 5433: foreach my $role (split(':',$sysrole)) {
5434: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5435: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5436: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5437: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5438: return "refused:s:$crole&$cqual";
5439: }
5440: }
1.191 harris41 5441: }
1.800 albertel 5442: foreach my $role (split(':',$domrole)) {
5443: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5444: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5445: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5446: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 5447: return "refused:d:$crole&$cqual";
5448: }
5449: }
1.191 harris41 5450: }
1.800 albertel 5451: foreach my $role (split(':',$courole)) {
5452: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5453: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5454: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5455: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5456: return "refused:c:$crole&$cqual";
5457: }
5458: }
1.191 harris41 5459: }
1.620 albertel 5460: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5461: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5462: "rolesdef_$rolename=".
5463: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 5464: return reply($command,$env{'user.home'});
1.12 www 5465: } else {
5466: return 'refused';
5467: }
1.105 harris41 5468: }
5469:
5470: # ---------------- Make a metadata query against the network of library servers
5471:
5472: sub metadata_query {
1.244 matthew 5473: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 5474: my %rhash;
1.845 albertel 5475: my %libserv = &all_library();
1.244 matthew 5476: my @server_list = (defined($server_array) ? @$server_array
5477: : keys(%libserv) );
5478: for my $server (@server_list) {
1.118 harris41 5479: unless ($custom or $customshow) {
5480: my $reply=&reply("querysend:".&escape($query),$server);
5481: $rhash{$server}=$reply;
5482: }
5483: else {
5484: my $reply=&reply("querysend:".&escape($query).':'.
5485: &escape($custom).':'.&escape($customshow),
5486: $server);
5487: $rhash{$server}=$reply;
5488: }
1.112 harris41 5489: }
1.118 harris41 5490: return \%rhash;
1.240 www 5491: }
5492:
5493: # ----------------------------------------- Send log queries and wait for reply
5494:
5495: sub log_query {
5496: my ($uname,$udom,$query,%filters)=@_;
5497: my $uhome=&homeserver($uname,$udom);
5498: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 5499: my $uhost=&hostname($uhome);
1.800 albertel 5500: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 5501: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5502: $uhome);
1.479 albertel 5503: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 5504: return get_query_reply($queryid);
5505: }
5506:
1.818 raeburn 5507: # -------------------------- Update MySQL table for portfolio file
5508:
5509: sub update_portfolio_table {
1.821 raeburn 5510: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 5511: if ($group ne '') {
5512: $file_name =~s /^\Q$group\E//;
5513: }
1.818 raeburn 5514: my $homeserver = &homeserver($uname,$udom);
5515: my $queryid=
1.821 raeburn 5516: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5517: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 5518: my $reply = &get_query_reply($queryid);
5519: return $reply;
5520: }
5521:
1.899 raeburn 5522: # -------------------------- Update MySQL allusers table
5523:
5524: sub update_allusers_table {
5525: my ($uname,$udom,$names) = @_;
5526: my $homeserver = &homeserver($uname,$udom);
5527: my $queryid=
5528: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5529: 'lastname='.&escape($names->{'lastname'}).'%%'.
5530: 'firstname='.&escape($names->{'firstname'}).'%%'.
5531: 'middlename='.&escape($names->{'middlename'}).'%%'.
5532: 'generation='.&escape($names->{'generation'}).'%%'.
5533: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5534: 'id='.&escape($names->{'id'}),$homeserver);
5535: my $reply = &get_query_reply($queryid);
5536: return $reply;
5537: }
5538:
1.508 raeburn 5539: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 5540:
5541: sub fetch_enrollment_query {
1.511 raeburn 5542: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 5543: my $homeserver;
1.547 raeburn 5544: my $maxtries = 1;
1.508 raeburn 5545: if ($context eq 'automated') {
5546: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 5547: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 5548: } else {
5549: $homeserver = &homeserver($cnum,$dom);
5550: }
1.838 albertel 5551: my $host=&hostname($homeserver);
1.506 raeburn 5552: my $cmd = '';
1.1000 raeburn 5553: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 5554: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 5555: }
5556: $cmd =~ s/%%$//;
5557: $cmd = &escape($cmd);
5558: my $query = 'fetchenrollment';
1.620 albertel 5559: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 5560: unless ($queryid=~/^\Q$host\E\_/) {
5561: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5562: return 'error: '.$queryid;
5563: }
1.506 raeburn 5564: my $reply = &get_query_reply($queryid);
1.547 raeburn 5565: my $tries = 1;
5566: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5567: $reply = &get_query_reply($queryid);
5568: $tries ++;
5569: }
1.526 raeburn 5570: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 5571: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 5572: } else {
1.901 albertel 5573: my @responses = split(/:/,$reply);
1.515 raeburn 5574: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 5575: foreach my $line (@responses) {
5576: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 5577: $$replyref{$key} = $value;
5578: }
5579: } else {
1.506 raeburn 5580: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 5581: foreach my $line (@responses) {
5582: my ($key,$value) = split(/=/,$line);
1.506 raeburn 5583: $$replyref{$key} = $value;
5584: if ($value > 0) {
1.800 albertel 5585: foreach my $item (@{$$affiliatesref{$key}}) {
5586: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 5587: my $destname = $pathname.'/'.$filename;
5588: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 5589: if ($xml_classlist =~ /^error/) {
5590: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5591: } else {
1.506 raeburn 5592: if ( open(FILE,">$destname") ) {
5593: print FILE &unescape($xml_classlist);
5594: close(FILE);
1.526 raeburn 5595: } else {
5596: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 5597: }
5598: }
5599: }
5600: }
5601: }
5602: }
5603: return 'ok';
5604: }
5605: return 'error';
5606: }
5607:
1.242 www 5608: sub get_query_reply {
5609: my $queryid=shift;
1.240 www 5610: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5611: my $reply='';
5612: for (1..100) {
5613: sleep 2;
5614: if (-e $replyfile.'.end') {
1.448 albertel 5615: if (open(my $fh,$replyfile)) {
1.904 albertel 5616: $reply = join('',<$fh>);
5617: close($fh);
1.240 www 5618: } else { return 'error: reply_file_error'; }
1.242 www 5619: return &unescape($reply);
5620: }
1.240 www 5621: }
1.242 www 5622: return 'timeout:'.$queryid;
1.240 www 5623: }
5624:
5625: sub courselog_query {
1.241 www 5626: #
5627: # possible filters:
5628: # url: url or symb
5629: # username
5630: # domain
5631: # action: view, submit, grade
5632: # start: timestamp
5633: # end: timestamp
5634: #
1.240 www 5635: my (%filters)=@_;
1.620 albertel 5636: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 5637: if ($filters{'url'}) {
5638: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5639: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5640: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5641: }
1.620 albertel 5642: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5643: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 5644: return &log_query($cname,$cdom,'courselog',%filters);
5645: }
5646:
5647: sub userlog_query {
1.858 raeburn 5648: #
5649: # possible filters:
5650: # action: log check role
5651: # start: timestamp
5652: # end: timestamp
5653: #
1.240 www 5654: my ($uname,$udom,%filters)=@_;
5655: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 5656: }
5657:
1.506 raeburn 5658: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5659:
5660: sub auto_run {
1.508 raeburn 5661: my ($cnum,$cdom) = @_;
1.876 raeburn 5662: my $response = 0;
5663: my $settings;
5664: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5665: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5666: $settings = $domconfig{'autoenroll'};
5667: if ($settings->{'run'} eq '1') {
5668: $response = 1;
5669: }
5670: } else {
1.934 raeburn 5671: my $homeserver;
5672: if (&is_course($cdom,$cnum)) {
5673: $homeserver = &homeserver($cnum,$cdom);
5674: } else {
5675: $homeserver = &domain($cdom,'primary');
5676: }
5677: if ($homeserver ne 'no_host') {
5678: $response = &reply('autorun:'.$cdom,$homeserver);
5679: }
1.876 raeburn 5680: }
1.506 raeburn 5681: return $response;
5682: }
1.776 albertel 5683:
1.506 raeburn 5684: sub auto_get_sections {
1.508 raeburn 5685: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 5686: my $homeserver;
5687: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5688: $homeserver = &homeserver($cnum,$cdom);
5689: }
5690: if (!defined($homeserver)) {
5691: if ($cdom =~ /^$match_domain$/) {
5692: $homeserver = &domain($cdom,'primary');
5693: }
5694: }
5695: my @secs;
5696: if (defined($homeserver)) {
5697: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5698: unless ($response eq 'refused') {
5699: @secs = split(/:/,$response);
5700: }
1.506 raeburn 5701: }
5702: return @secs;
5703: }
1.776 albertel 5704:
1.506 raeburn 5705: sub auto_new_course {
1.508 raeburn 5706: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5707: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 5708: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 5709: return $response;
5710: }
1.776 albertel 5711:
1.506 raeburn 5712: sub auto_validate_courseID {
1.508 raeburn 5713: my ($cnum,$cdom,$inst_course_id) = @_;
5714: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 5715: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 5716: return $response;
5717: }
1.776 albertel 5718:
1.1007 raeburn 5719: sub auto_validate_instcode {
1.1020 raeburn 5720: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 5721: my ($homeserver,$response);
5722: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5723: $homeserver = &homeserver($cnum,$cdom);
5724: }
5725: if (!defined($homeserver)) {
5726: if ($cdom =~ /^$match_domain$/) {
5727: $homeserver = &domain($cdom,'primary');
5728: }
5729: }
5730: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
1.1020 raeburn 5731: &escape($instcode).':'.&escape($owner),$homeserver));
1.1027 raeburn 5732: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5733: return ($outcome,$description);
1.1007 raeburn 5734: }
5735:
1.506 raeburn 5736: sub auto_create_password {
1.873 raeburn 5737: my ($cnum,$cdom,$authparam,$udom) = @_;
5738: my ($homeserver,$response);
1.506 raeburn 5739: my $create_passwd = 0;
5740: my $authchk = '';
1.873 raeburn 5741: if ($udom =~ /^$match_domain$/) {
5742: $homeserver = &domain($udom,'primary');
5743: }
5744: if ($homeserver eq '') {
5745: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5746: $homeserver = &homeserver($cnum,$cdom);
5747: }
5748: }
5749: if ($homeserver eq '') {
5750: $authchk = 'nodomain';
1.506 raeburn 5751: } else {
1.873 raeburn 5752: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5753: if ($response eq 'refused') {
5754: $authchk = 'refused';
5755: } else {
1.901 albertel 5756: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 5757: }
1.506 raeburn 5758: }
5759: return ($authparam,$create_passwd,$authchk);
5760: }
5761:
1.706 raeburn 5762: sub auto_photo_permission {
5763: my ($cnum,$cdom,$students) = @_;
5764: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 5765: my ($outcome,$perm_reqd,$conditions) =
5766: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 5767: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5768: return (undef,undef);
5769: }
1.706 raeburn 5770: return ($outcome,$perm_reqd,$conditions);
5771: }
5772:
5773: sub auto_checkphotos {
5774: my ($uname,$udom,$pid) = @_;
5775: my $homeserver = &homeserver($uname,$udom);
5776: my ($result,$resulttype);
5777: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 5778: &escape($uname).':'.&escape($pid),
5779: $homeserver));
1.709 albertel 5780: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5781: return (undef,undef);
5782: }
1.706 raeburn 5783: if ($outcome) {
5784: ($result,$resulttype) = split(/:/,$outcome);
5785: }
5786: return ($result,$resulttype);
5787: }
5788:
5789: sub auto_photochoice {
5790: my ($cnum,$cdom) = @_;
5791: my $homeserver = &homeserver($cnum,$cdom);
5792: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 5793: &escape($cdom),
5794: $homeserver)));
1.709 albertel 5795: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5796: return (undef,undef);
5797: }
1.706 raeburn 5798: return ($update,$comment);
5799: }
5800:
5801: sub auto_photoupdate {
5802: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5803: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 5804: my $host=&hostname($homeserver);
1.706 raeburn 5805: my $cmd = '';
5806: my $maxtries = 1;
1.800 albertel 5807: foreach my $affiliate (keys(%{$affiliatesref})) {
5808: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 5809: }
5810: $cmd =~ s/%%$//;
5811: $cmd = &escape($cmd);
5812: my $query = 'institutionalphotos';
5813: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5814: unless ($queryid=~/^\Q$host\E\_/) {
5815: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5816: return 'error: '.$queryid;
5817: }
5818: my $reply = &get_query_reply($queryid);
5819: my $tries = 1;
5820: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5821: $reply = &get_query_reply($queryid);
5822: $tries ++;
5823: }
5824: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5825: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5826: } else {
5827: my @responses = split(/:/,$reply);
5828: my $outcome = shift(@responses);
5829: foreach my $item (@responses) {
5830: my ($key,$value) = split(/=/,$item);
5831: $$photo{$key} = $value;
5832: }
5833: return $outcome;
5834: }
5835: return 'error';
5836: }
5837:
1.521 raeburn 5838: sub auto_instcode_format {
1.793 albertel 5839: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5840: $cat_order) = @_;
1.521 raeburn 5841: my $courses = '';
1.772 raeburn 5842: my @homeservers;
1.521 raeburn 5843: if ($caller eq 'global') {
1.841 albertel 5844: my %servers = &get_servers($codedom,'library');
5845: foreach my $tryserver (keys(%servers)) {
5846: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5847: push(@homeservers,$tryserver);
5848: }
1.584 raeburn 5849: }
1.1022 raeburn 5850: } elsif ($caller eq 'requests') {
5851: if ($codedom =~ /^$match_domain$/) {
5852: my $chome = &domain($codedom,'primary');
5853: unless ($chome eq 'no_host') {
5854: push(@homeservers,$chome);
5855: }
5856: }
1.521 raeburn 5857: } else {
1.772 raeburn 5858: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 5859: }
1.793 albertel 5860: foreach my $code (keys(%{$instcodes})) {
5861: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 5862: }
5863: chop($courses);
1.772 raeburn 5864: my $ok_response = 0;
5865: my $response;
5866: while (@homeservers > 0 && $ok_response == 0) {
5867: my $server = shift(@homeservers);
5868: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5869: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5870: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 5871: split(/:/,$response);
1.772 raeburn 5872: %{$codes} = (%{$codes},&str2hash($codes_str));
5873: push(@{$codetitles},&str2array($codetitles_str));
5874: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5875: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5876: $ok_response = 1;
5877: }
5878: }
5879: if ($ok_response) {
1.521 raeburn 5880: return 'ok';
1.772 raeburn 5881: } else {
5882: return $response;
1.521 raeburn 5883: }
5884: }
5885:
1.792 raeburn 5886: sub auto_instcode_defaults {
5887: my ($domain,$returnhash,$code_order) = @_;
5888: my @homeservers;
1.841 albertel 5889:
5890: my %servers = &get_servers($domain,'library');
5891: foreach my $tryserver (keys(%servers)) {
5892: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5893: push(@homeservers,$tryserver);
5894: }
1.792 raeburn 5895: }
1.841 albertel 5896:
1.792 raeburn 5897: my $response;
1.841 albertel 5898: foreach my $server (@homeservers) {
1.792 raeburn 5899: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 5900: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5901:
5902: foreach my $pair (split(/\&/,$response)) {
5903: my ($name,$value)=split(/\=/,$pair);
5904: if ($name eq 'code_order') {
5905: @{$code_order} = split(/\&/,&unescape($value));
5906: } else {
5907: $returnhash->{&unescape($name)}=&unescape($value);
5908: }
5909: }
5910: return 'ok';
1.792 raeburn 5911: }
1.841 albertel 5912:
5913: return $response;
1.1003 raeburn 5914: }
5915:
5916: sub auto_possible_instcodes {
1.1007 raeburn 5917: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
5918: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
5919: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
5920: return;
5921: }
1.1003 raeburn 5922: my (@homeservers,$uhome);
5923: if (defined(&domain($domain,'primary'))) {
5924: $uhome=&domain($domain,'primary');
5925: push(@homeservers,&domain($domain,'primary'));
5926: } else {
5927: my %servers = &get_servers($domain,'library');
5928: foreach my $tryserver (keys(%servers)) {
5929: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5930: push(@homeservers,$tryserver);
5931: }
5932: }
5933: }
5934: my $response;
5935: foreach my $server (@homeservers) {
5936: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5937: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 5938: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
5939: split(':',$response);
5940: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5941: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 5942: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 5943: my ($name,$value)=split('=',$item);
5944: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5945: }
5946: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 5947: my ($name,$value)=split('=',$item);
5948: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5949: }
5950: return 'ok';
5951: }
5952: return $response;
5953: }
1.792 raeburn 5954:
1.1010 raeburn 5955: sub auto_courserequest_checks {
5956: my ($dom) = @_;
1.1020 raeburn 5957: my ($homeserver,%validations);
5958: if ($dom =~ /^$match_domain$/) {
5959: $homeserver = &domain($dom,'primary');
5960: }
5961: unless ($homeserver eq 'no_host') {
5962: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
5963: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
5964: my @items = split(/&/,$response);
5965: foreach my $item (@items) {
5966: my ($key,$value) = split('=',$item);
5967: $validations{&unescape($key)} = &thaw_unescape($value);
5968: }
5969: }
5970: }
1.1010 raeburn 5971: return %validations;
5972: }
5973:
1.1020 raeburn 5974: sub auto_courserequest_validation {
5975: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
5976: my ($homeserver,$response);
5977: if ($dom =~ /^$match_domain$/) {
5978: $homeserver = &domain($dom,'primary');
5979: }
5980: unless ($homeserver eq 'no_host') {
1.1021 raeburn 5981:
1.1020 raeburn 5982: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 5983: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 5984: ':'.&escape($instcode).':'.&escape($instseclist),
5985: $homeserver));
5986: }
5987: return $response;
5988: }
5989:
1.777 albertel 5990: sub auto_validate_class_sec {
1.918 raeburn 5991: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 5992: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 5993: my $ownerlist;
5994: if (ref($owners) eq 'ARRAY') {
5995: $ownerlist = join(',',@{$owners});
5996: } else {
5997: $ownerlist = $owners;
5998: }
1.773 raeburn 5999: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 6000: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 6001: return $response;
6002: }
6003:
1.679 raeburn 6004: # ------------------------------------------------------- Course Group routines
6005:
6006: sub get_coursegroups {
1.809 raeburn 6007: my ($cdom,$cnum,$group,$namespace) = @_;
6008: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 6009: }
6010:
1.679 raeburn 6011: sub modify_coursegroup {
6012: my ($cdom,$cnum,$groupsettings) = @_;
6013: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6014: }
6015:
1.809 raeburn 6016: sub toggle_coursegroup_status {
6017: my ($cdom,$cnum,$group,$action) = @_;
6018: my ($from_namespace,$to_namespace);
6019: if ($action eq 'delete') {
6020: $from_namespace = 'coursegroups';
6021: $to_namespace = 'deleted_groups';
6022: } else {
6023: $from_namespace = 'deleted_groups';
6024: $to_namespace = 'coursegroups';
6025: }
6026: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 6027: if (my $tmp = &error(%curr_group)) {
6028: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6029: return ('read error',$tmp);
6030: } else {
6031: my %savedsettings = %curr_group;
1.809 raeburn 6032: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 6033: my $deloutcome;
6034: if ($result eq 'ok') {
1.809 raeburn 6035: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 6036: } else {
6037: return ('write error',$result);
6038: }
6039: if ($deloutcome eq 'ok') {
6040: return 'ok';
6041: } else {
6042: return ('delete error',$deloutcome);
6043: }
6044: }
6045: }
6046:
1.679 raeburn 6047: sub modify_group_roles {
1.957 raeburn 6048: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 6049: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6050: my $role = 'gr/'.&escape($userprivs);
6051: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 6052: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 6053: if ($result eq 'ok') {
6054: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6055: }
1.679 raeburn 6056: return $result;
6057: }
6058:
6059: sub modify_coursegroup_membership {
6060: my ($cdom,$cnum,$membership) = @_;
6061: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6062: return $result;
6063: }
6064:
1.682 raeburn 6065: sub get_active_groups {
6066: my ($udom,$uname,$cdom,$cnum) = @_;
6067: my $now = time;
6068: my %groups = ();
6069: foreach my $key (keys(%env)) {
1.811 albertel 6070: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 6071: my ($start,$end) = split(/\./,$env{$key});
6072: if (($end!=0) && ($end<$now)) { next; }
6073: if (($start!=0) && ($start>$now)) { next; }
6074: if ($1 eq $cdom && $2 eq $cnum) {
6075: $groups{$3} = $env{$key} ;
6076: }
6077: }
6078: }
6079: return %groups;
6080: }
6081:
1.683 raeburn 6082: sub get_group_membership {
6083: my ($cdom,$cnum,$group) = @_;
6084: return(&dump('groupmembership',$cdom,$cnum,$group));
6085: }
6086:
6087: sub get_users_groups {
6088: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 6089: my @usersgroups;
1.683 raeburn 6090: my $cachetime=1800;
6091:
6092: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 6093: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6094: if (defined($cached)) {
1.734 albertel 6095: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 6096: } else {
6097: $grouplist = '';
1.816 raeburn 6098: my $courseurl = &courseid_to_courseurl($courseid);
6099: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 6100: my $access_end = $env{'course.'.$courseid.
6101: '.default_enrollment_end_date'};
6102: my $now = time;
6103: foreach my $key (keys(%roleshash)) {
6104: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6105: my $group = $1;
6106: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6107: my $start = $2;
6108: my $end = $1;
6109: if ($start == -1) { next; } # deleted from group
6110: if (($start!=0) && ($start>$now)) { next; }
6111: if (($end!=0) && ($end<$now)) {
6112: if ($access_end && $access_end < $now) {
6113: if ($access_end - $end < 86400) {
6114: push(@usersgroups,$group);
1.733 raeburn 6115: }
6116: }
1.817 raeburn 6117: next;
1.733 raeburn 6118: }
1.817 raeburn 6119: push(@usersgroups,$group);
1.683 raeburn 6120: }
6121: }
6122: }
1.817 raeburn 6123: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6124: $grouplist = join(':',@usersgroups);
6125: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 6126: }
1.733 raeburn 6127: return @usersgroups;
1.683 raeburn 6128: }
6129:
6130: sub devalidate_getgroups_cache {
6131: my ($udom,$uname,$cdom,$cnum)=@_;
6132: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 6133:
1.683 raeburn 6134: my $hashid="$udom:$uname:$courseid";
6135: &devalidate_cache_new('getgroups',$hashid);
6136: }
6137:
1.12 www 6138: # ------------------------------------------------------------------ Plain Text
6139:
6140: sub plaintext {
1.988 raeburn 6141: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 6142: if ($short =~ m{^cr/}) {
1.758 albertel 6143: return (split('/',$short))[-1];
6144: }
1.742 raeburn 6145: if (!defined($cid)) {
6146: $cid = $env{'request.course.id'};
6147: }
6148: my %rolenames = (
1.1008 raeburn 6149: Course => 'std',
6150: Community => 'alt1',
1.742 raeburn 6151: );
1.1037 raeburn 6152: if ($cid ne '') {
6153: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6154: unless ($forcedefault) {
6155: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6156: &Apache::lonlocal::mt_escape(\$roletext);
6157: return &Apache::lonlocal::mt($roletext);
6158: }
6159: }
6160: }
6161: if ((defined($type)) && (defined($rolenames{$type})) &&
6162: (defined($rolenames{$type})) &&
6163: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 6164: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 6165: } elsif ($cid ne '') {
6166: my $crstype = $env{'course.'.$cid.'.type'};
6167: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6168: (defined($prp{$short}{$rolenames{$crstype}}))) {
6169: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6170: }
1.742 raeburn 6171: }
1.1037 raeburn 6172: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 6173: }
6174:
6175: # ----------------------------------------------------------------- Assign Role
6176:
6177: sub assignrole {
1.957 raeburn 6178: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6179: $context)=@_;
1.21 www 6180: my $mrole;
6181: if ($role =~ /^cr\//) {
1.393 www 6182: my $cwosec=$url;
1.811 albertel 6183: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 6184: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 6185: my $refused = 1;
6186: if ($context eq 'requestcourses') {
6187: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6188: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6189: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6190: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6191: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6192: if ($crsenv{'internal.courseowner'} eq
6193: $env{'user.name'}.':'.$env{'user.domain'}) {
6194: $refused = '';
6195: }
6196: }
6197: }
6198: }
6199: }
6200: if ($refused) {
6201: &logthis('Refused custom assignrole: '.
6202: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6203: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6204: return 'refused';
6205: }
1.104 www 6206: }
1.21 www 6207: $mrole='cr';
1.678 raeburn 6208: } elsif ($role =~ /^gr\//) {
6209: my $cwogrp=$url;
1.811 albertel 6210: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 6211: unless (&allowed('mdg',$cwogrp)) {
6212: &logthis('Refused group assignrole: '.
6213: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6214: $env{'user.name'}.' at '.$env{'user.domain'});
6215: return 'refused';
6216: }
6217: $mrole='gr';
1.21 www 6218: } else {
1.82 www 6219: my $cwosec=$url;
1.811 albertel 6220: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 6221: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6222: my $refused;
6223: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6224: if (!(&allowed('c'.$role,$url))) {
6225: $refused = 1;
6226: }
6227: } else {
6228: $refused = 1;
6229: }
1.947 raeburn 6230: if ($refused) {
1.1045 raeburn 6231: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6232: if (!$selfenroll && $context eq 'course') {
6233: my %crsenv;
6234: if ($role eq 'cc' || $role eq 'co') {
6235: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6236: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
1.1058 ! raeburn 6237:
1.1045 raeburn 6238: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6239: if ($crsenv{'internal.courseowner'} eq
6240: $env{'user.name'}.':'.$env{'user.domain'}) {
6241: $refused = '';
6242: }
6243: }
6244: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6245: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6246: if ($crsenv{'internal.courseowner'} eq
6247: $env{'user.name'}.':'.$env{'user.domain'}) {
6248: $refused = '';
6249: }
6250: }
6251: }
6252: }
6253: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 6254: $refused = '';
1.1017 raeburn 6255: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 6256: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 6257: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 6258: my $wrongcc;
6259: if ($cnum =~ /^$match_community$/) {
6260: $wrongcc = 1 if ($role eq 'cc');
6261: } else {
6262: $wrongcc = 1 if ($role eq 'co');
6263: }
6264: unless ($wrongcc) {
6265: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6266: if ($crsenv{'internal.courseowner'} eq
6267: $env{'user.name'}.':'.$env{'user.domain'}) {
6268: $refused = '';
6269: }
1.1017 raeburn 6270: }
6271: }
6272: }
6273: if ($refused) {
1.947 raeburn 6274: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6275: ' '.$role.' '.$end.' '.$start.' by '.
6276: $env{'user.name'}.' at '.$env{'user.domain'});
6277: return 'refused';
6278: }
1.932 raeburn 6279: }
1.104 www 6280: }
1.21 www 6281: $mrole=$role;
6282: }
1.620 albertel 6283: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 6284: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 6285: if ($end) { $command.='_'.$end; }
1.21 www 6286: if ($start) {
6287: if ($end) {
1.81 www 6288: $command.='_'.$start;
1.21 www 6289: } else {
1.81 www 6290: $command.='_0_'.$start;
1.21 www 6291: }
6292: }
1.739 raeburn 6293: my $origstart = $start;
6294: my $origend = $end;
1.957 raeburn 6295: my $delflag;
1.357 www 6296: # actually delete
6297: if ($deleteflag) {
1.373 www 6298: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 6299: # modify command to delete the role
1.620 albertel 6300: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 6301: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 6302: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 6303: # set start and finish to negative values for userrolelog
6304: $start=-1;
6305: $end=-1;
1.957 raeburn 6306: $delflag = 1;
1.357 www 6307: }
6308: }
6309: # send command
1.349 www 6310: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 6311: # log new user role if status is ok
1.349 www 6312: if ($answer eq 'ok') {
1.663 raeburn 6313: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 6314: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 6315: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 6316: unless ($role =~ /^gr/) {
6317: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 6318: $origstart,$selfenroll,$context);
1.739 raeburn 6319: }
1.1053 raeburn 6320: if ($role eq 'cc') {
6321: &autoupdate_coowners($url,$end,$start,$uname,$udom);
6322: }
1.349 www 6323: }
6324: return $answer;
1.169 harris41 6325: }
6326:
1.1053 raeburn 6327: sub autoupdate_coowners {
6328: my ($url,$end,$start,$uname,$udom) = @_;
6329: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
6330: if (($cdom ne '') && ($cnum ne '')) {
6331: my $now = time;
6332: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
6333: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
6334: my %coursehash = &coursedescription($cdom.'_'.$cnum);
6335: my $instcode = $coursehash{'internal.coursecode'};
6336: if ($instcode ne '') {
1.1056 raeburn 6337: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
6338: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 6339: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 6340: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
6341: if ($result eq 'valid') {
6342: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 6343: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6344: push(@newcoowners,$coowner);
6345: }
6346: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
6347: push(@newcoowners,$uname.':'.$udom);
6348: }
6349: @newcoowners = sort(@newcoowners);
6350: } else {
6351: push(@newcoowners,$uname.':'.$udom);
6352: }
6353: } else {
6354: if ($coursehash{'internal.co-owners'}) {
6355: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6356: unless ($coowner eq $uname.':'.$udom) {
6357: push(@newcoowners,$coowner);
6358: }
6359: }
6360: unless (@newcoowners > 0) {
6361: $delcoowners = 1;
6362: $coowners = '';
6363: }
6364: }
6365: }
6366: if (@newcoowners || $delcoowners) {
6367: &store_coowners($cdom,$cnum,$coursehash{'home'},
6368: $delcoowners,@newcoowners);
6369: }
6370: }
6371: }
6372: }
6373: }
6374: }
6375: }
6376:
6377: sub store_coowners {
6378: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
6379: my $cid = $cdom.'_'.$cnum;
6380: my ($coowners,$delresult,$putresult);
6381: if (@newcoowners) {
6382: $coowners = join(',',@newcoowners);
6383: my %coownershash = (
6384: 'internal.co-owners' => $coowners,
6385: );
6386: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
6387: if ($putresult eq 'ok') {
6388: if ($env{'course.'.$cid.'.num'} eq $cnum) {
6389: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
6390: }
6391: }
6392: }
6393: if ($delcoowners) {
6394: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
6395: if ($delresult eq 'ok') {
6396: if ($env{'course.'.$cid.'.internal.co-owners'}) {
6397: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
6398: }
6399: }
6400: }
6401: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
6402: my %crsinfo =
6403: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6404: if (ref($crsinfo{$cid}) eq 'HASH') {
6405: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
6406: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
6407: }
6408: }
6409: }
6410:
1.169 harris41 6411: # -------------------------------------------------- Modify user authentication
1.197 www 6412: # Overrides without validation
6413:
1.169 harris41 6414: sub modifyuserauth {
6415: my ($udom,$uname,$umode,$upass)=@_;
6416: my $uhome=&homeserver($uname,$udom);
1.197 www 6417: unless (&allowed('mau',$udom)) { return 'refused'; }
6418: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 6419: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6420: ' in domain '.$env{'request.role.domain'});
1.169 harris41 6421: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6422: &escape($upass),$uhome);
1.620 albertel 6423: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 6424: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6425: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6426: &log($udom,,$uname,$uhome,
1.620 albertel 6427: 'Authentication changed by '.$env{'user.domain'}.', '.
6428: $env{'user.name'}.', '.$umode.
1.197 www 6429: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 6430: unless ($reply eq 'ok') {
1.197 www 6431: &logthis('Authentication mode error: '.$reply);
1.169 harris41 6432: return 'error: '.$reply;
6433: }
1.170 harris41 6434: return 'ok';
1.80 www 6435: }
6436:
1.81 www 6437: # --------------------------------------------------------------- Modify a user
1.80 www 6438:
1.81 www 6439: sub modifyuser {
1.206 matthew 6440: my ($udom, $uname, $uid,
6441: $umode, $upass, $first,
6442: $middle, $last, $gene,
1.1058 ! raeburn 6443: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 6444: $udom= &LONCAPA::clean_domain($udom);
6445: $uname=&LONCAPA::clean_username($uname);
1.81 www 6446: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 6447: $umode.', '.$first.', '.$middle.', '.
1.1058 ! raeburn 6448: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$candelete.')'.
1.206 matthew 6449: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6450: ' desiredhome not specified').
1.620 albertel 6451: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6452: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 6453: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 6454: # ----------------------------------------------------------------- Create User
1.406 albertel 6455: if (($uhome eq 'no_host') &&
6456: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 6457: my $unhome='';
1.844 albertel 6458: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 6459: $unhome = $desiredhome;
1.620 albertel 6460: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6461: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 6462: } else { # load balancing routine for determining $unhome
1.81 www 6463: my $loadm=10000000;
1.841 albertel 6464: my %servers = &get_servers($udom,'library');
6465: foreach my $tryserver (keys(%servers)) {
6466: my $answer=reply('load',$tryserver);
6467: if (($answer=~/\d+/) && ($answer<$loadm)) {
6468: $loadm=$answer;
6469: $unhome=$tryserver;
6470: }
1.80 www 6471: }
6472: }
6473: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 6474: return 'error: unable to find a home server for '.$uname.
6475: ' in domain '.$udom;
1.80 www 6476: }
6477: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6478: &escape($upass),$unhome);
6479: unless ($reply eq 'ok') {
6480: return 'error: '.$reply;
6481: }
1.230 stredwic 6482: $uhome=&homeserver($uname,$udom,'true');
1.80 www 6483: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 6484: return 'error: unable verify users home machine.';
1.80 www 6485: }
1.209 matthew 6486: } # End of creation of new user
1.80 www 6487: # ---------------------------------------------------------------------- Add ID
6488: if ($uid) {
6489: $uid=~tr/A-Z/a-z/;
6490: my %uidhash=&idrget($udom,$uname);
1.196 www 6491: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6492: && (!$forceid)) {
1.80 www 6493: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 6494: return 'error: user id "'.$uid.'" does not match '.
6495: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 6496: }
6497: } else {
6498: &idput($udom,($uname => $uid));
6499: }
6500: }
6501: # -------------------------------------------------------------- Add names, etc
1.313 matthew 6502: my @tmp=&get('environment',
1.899 raeburn 6503: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 6504: 'permanentemail','inststatus'],
1.134 albertel 6505: $udom,$uname);
1.313 matthew 6506: my %names;
6507: if ($tmp[0] =~ m/^error:.*/) {
6508: %names=();
6509: } else {
6510: %names = @tmp;
6511: }
1.388 www 6512: #
1.1058 ! raeburn 6513: # If name, email and/or uid are blank (e.g., because an uploaded file
! 6514: # of users did not contain them), do not overwrite existing values
! 6515: # unless field is in $candelete array ref.
! 6516: #
! 6517:
! 6518: my @fields = ('firstname','middlename','lastname','generation',
! 6519: 'permanentemail','id');
! 6520: my %newvalues;
! 6521: if (ref($candelete) eq 'ARRAY') {
! 6522: foreach my $field (@fields) {
! 6523: if (grep(/^\Q$field\E$/,@{$candelete})) {
! 6524: if ($field eq 'firstname') {
! 6525: $names{$field} = $first;
! 6526: } elsif ($field eq 'middlename') {
! 6527: $names{$field} = $middle;
! 6528: } elsif ($field eq 'lastname') {
! 6529: $names{$field} = $last;
! 6530: } elsif ($field eq 'generation') {
! 6531: $names{$field} = $gene;
! 6532: } elsif ($field eq 'permanentemail') {
! 6533: $names{$field} = $email;
! 6534: } elsif ($field eq 'id') {
! 6535: $names{$field} = $uid;
! 6536: }
! 6537: }
! 6538: }
! 6539: }
1.388 www 6540: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 6541: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 6542: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 6543: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 6544: if ($email) {
6545: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 6546: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 6547: }
1.899 raeburn 6548: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 6549: if (defined($inststatus)) {
6550: $names{'inststatus'} = '';
6551: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6552: if (ref($usertypes) eq 'HASH') {
6553: my @okstatuses;
6554: foreach my $item (split(/:/,$inststatus)) {
6555: if (defined($usertypes->{$item})) {
6556: push(@okstatuses,$item);
6557: }
6558: }
6559: if (@okstatuses) {
6560: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6561: }
6562: }
6563: }
1.134 albertel 6564: my $reply = &put('environment', \%names, $udom,$uname);
6565: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 6566: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 6567: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.963 raeburn 6568: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6569: $umode.', '.$first.', '.$middle.', '.
6570: $last.', '.$gene.', '.$email.', '.$inststatus;
6571: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6572: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6573: } else {
6574: $logmsg .= ' during self creation';
6575: }
6576: &logthis($logmsg);
1.134 albertel 6577: return 'ok';
1.80 www 6578: }
6579:
1.81 www 6580: # -------------------------------------------------------------- Modify student
1.80 www 6581:
1.81 www 6582: sub modifystudent {
6583: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 6584: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 6585: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 6586: if (!$cid) {
1.620 albertel 6587: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6588: return 'not_in_class';
6589: }
1.80 www 6590: }
6591: # --------------------------------------------------------------- Make the user
1.81 www 6592: my $reply=&modifyuser
1.209 matthew 6593: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 6594: $desiredhome,$email,$inststatus);
1.80 www 6595: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 6596: # This will cause &modify_student_enrollment to get the uid from the
6597: # students environment
6598: $uid = undef if (!$forceid);
1.455 albertel 6599: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 6600: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 6601: return $reply;
6602: }
6603:
6604: sub modify_student_enrollment {
1.957 raeburn 6605: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 6606: my ($cdom,$cnum,$chome);
6607: if (!$cid) {
1.620 albertel 6608: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6609: return 'not_in_class';
6610: }
1.620 albertel 6611: $cdom=$env{'course.'.$cid.'.domain'};
6612: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 6613: } else {
6614: ($cdom,$cnum)=split(/_/,$cid);
6615: }
1.620 albertel 6616: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 6617: if (!$chome) {
1.457 raeburn 6618: $chome=&homeserver($cnum,$cdom);
1.297 matthew 6619: }
1.455 albertel 6620: if (!$chome) { return 'unknown_course'; }
1.297 matthew 6621: # Make sure the user exists
1.81 www 6622: my $uhome=&homeserver($uname,$udom);
6623: if (($uhome eq '') || ($uhome eq 'no_host')) {
6624: return 'error: no such user';
6625: }
1.297 matthew 6626: # Get student data if we were not given enough information
6627: if (!defined($first) || $first eq '' ||
6628: !defined($last) || $last eq '' ||
6629: !defined($uid) || $uid eq '' ||
6630: !defined($middle) || $middle eq '' ||
6631: !defined($gene) || $gene eq '') {
1.294 matthew 6632: # They did not supply us with enough data to enroll the student, so
6633: # we need to pick up more information.
1.297 matthew 6634: my %tmp = &get('environment',
1.294 matthew 6635: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 6636: ,$udom,$uname);
6637:
1.800 albertel 6638: #foreach my $key (keys(%tmp)) {
6639: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 6640: #}
1.294 matthew 6641: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6642: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6643: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 6644: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 6645: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6646: }
1.556 albertel 6647: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 6648: my $reply=cput('classlist',
6649: {"$uname:$udom" =>
1.515 raeburn 6650: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 6651: $cdom,$cnum);
1.81 www 6652: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6653: return 'error: '.$reply;
1.652 albertel 6654: } else {
6655: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 6656: }
1.297 matthew 6657: # Add student role to user
1.83 www 6658: my $uurl='/'.$cid;
1.81 www 6659: $uurl=~s/\_/\//g;
6660: if ($usec) {
6661: $uurl.='/'.$usec;
6662: }
1.957 raeburn 6663: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21 www 6664: }
6665:
1.556 albertel 6666: sub format_name {
6667: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6668: my $name;
6669: if ($first ne 'lastname') {
6670: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6671: } else {
6672: if ($lastname=~/\S/) {
6673: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6674: $name=~s/\s+,/,/;
6675: } else {
6676: $name.= $firstname.' '.$middlename.' '.$generation;
6677: }
6678: }
6679: $name=~s/^\s+//;
6680: $name=~s/\s+$//;
6681: $name=~s/\s+/ /g;
6682: return $name;
6683: }
6684:
1.84 www 6685: # ------------------------------------------------- Write to course preferences
6686:
6687: sub writecoursepref {
6688: my ($courseid,%prefs)=@_;
6689: $courseid=~s/^\///;
6690: $courseid=~s/\_/\//g;
6691: my ($cdomain,$cnum)=split(/\//,$courseid);
6692: my $chome=homeserver($cnum,$cdomain);
6693: if (($chome eq '') || ($chome eq 'no_host')) {
6694: return 'error: no such course';
6695: }
6696: my $cstring='';
1.800 albertel 6697: foreach my $pref (keys(%prefs)) {
6698: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 6699: }
1.84 www 6700: $cstring=~s/\&$//;
6701: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6702: }
6703:
6704: # ---------------------------------------------------------- Make/modify course
6705:
6706: sub createcourse {
1.741 raeburn 6707: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 6708: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 6709: $url=&declutter($url);
6710: my $cid='';
1.1028 raeburn 6711: if ($context eq 'requestcourses') {
6712: my $can_create = 0;
6713: my ($ownername,$ownerdom) = split(':',$course_owner);
6714: if ($udom eq $ownerdom) {
6715: if (&usertools_access($ownername,$ownerdom,$category,undef,
6716: $context)) {
6717: $can_create = 1;
6718: }
6719: } else {
6720: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6721: $category);
6722: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6723: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6724: if (@curr > 0) {
6725: my @options = qw(approval validate autolimit);
6726: my $optregex = join('|',@options);
6727: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6728: $can_create = 1;
6729: }
6730: }
6731: }
6732: }
6733: if ($can_create) {
6734: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6735: unless (&allowed('ccc',$udom)) {
6736: return 'refused';
6737: }
1.1017 raeburn 6738: }
6739: } else {
6740: return 'refused';
6741: }
1.1028 raeburn 6742: } elsif (!&allowed('ccc',$udom)) {
6743: return 'refused';
1.84 www 6744: }
1.1011 raeburn 6745: # --------------------------------------------------------------- Get Unique ID
6746: my $uname;
6747: if ($cnum =~ /^$match_courseid$/) {
6748: my $chome=&homeserver($cnum,$udom,'true');
6749: if (($chome eq '') || ($chome eq 'no_host')) {
6750: $uname = $cnum;
6751: } else {
1.1038 raeburn 6752: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6753: }
6754: } else {
1.1038 raeburn 6755: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6756: }
6757: return $uname if ($uname =~ /^error/);
6758: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 6759: if (!defined($course_server)) {
6760: if (defined(&domain($udom,'primary'))) {
6761: $course_server = &domain($udom,'primary');
6762: } else {
6763: $course_server = $env{'user.home'};
6764: }
6765: }
6766: my %host_servers =
6767: &Apache::lonnet::get_servers($udom,'library');
6768: unless ($host_servers{$course_server}) {
6769: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 6770: }
1.84 www 6771: # ------------------------------------------------------------- Make the course
6772: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 6773: $course_server);
1.84 www 6774: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 6775: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 6776: if (($uhome eq '') || ($uhome eq 'no_host')) {
6777: return 'error: no such course';
6778: }
1.271 www 6779: # ----------------------------------------------------------------- Course made
1.516 raeburn 6780: # log existence
1.1029 raeburn 6781: my $now = time;
1.918 raeburn 6782: my $newcourse = {
6783: $udom.'_'.$uname => {
1.921 raeburn 6784: description => $description,
6785: inst_code => $inst_code,
6786: owner => $course_owner,
6787: type => $crstype,
1.1029 raeburn 6788: creator => $env{'user.name'}.':'.
6789: $env{'user.domain'},
6790: created => $now,
6791: context => $context,
1.918 raeburn 6792: },
6793: };
1.921 raeburn 6794: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 6795: # set toplevel url
1.271 www 6796: my $topurl=$url;
6797: unless ($nonstandard) {
6798: # ------------------------------------------ For standard courses, make top url
6799: my $mapurl=&clutter($url);
1.278 www 6800: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 6801: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 6802: <map>
6803: <resource id="1" type="start"></resource>
6804: <resource id="2" src="$mapurl"></resource>
6805: <resource id="3" type="finish"></resource>
6806: <link index="1" from="1" to="2"></link>
6807: <link index="2" from="2" to="3"></link>
6808: </map>
6809: ENDINITMAP
6810: $topurl=&declutter(
1.638 albertel 6811: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 6812: );
6813: }
6814: # ----------------------------------------------------------- Write preferences
1.84 www 6815: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 6816: ('description' => $description,
6817: 'url' => $topurl,
6818: 'internal.creator' => $env{'user.name'}.':'.
6819: $env{'user.domain'},
6820: 'internal.created' => $now,
6821: 'internal.creationcontext' => $context)
6822: );
1.84 www 6823: return '/'.$udom.'/'.$uname;
6824: }
6825:
1.1011 raeburn 6826: # ------------------------------------------------------------------- Create ID
6827: sub generate_coursenum {
1.1038 raeburn 6828: my ($udom,$crstype) = @_;
1.1011 raeburn 6829: my $domdesc = &domain($udom);
6830: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 6831: my $first;
6832: if ($crstype eq 'Community') {
6833: $first = '0';
6834: } else {
6835: $first = int(1+rand(9));
6836: }
6837: my $uname=$first.
1.1011 raeburn 6838: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6839: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6840: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6841: # ----------------------------------------------- Make sure that does not exist
6842: my $uhome=&homeserver($uname,$udom,'true');
6843: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 6844: if ($crstype eq 'Community') {
6845: $first = '0';
6846: } else {
6847: $first = int(1+rand(9));
6848: }
6849: $uname=$first.
1.1011 raeburn 6850: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6851: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6852: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6853: $uhome=&homeserver($uname,$udom,'true');
6854: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6855: return 'error: unable to generate unique course-ID';
6856: }
6857: }
6858: return $uname;
6859: }
6860:
1.813 albertel 6861: sub is_course {
6862: my ($cdom,$cnum) = @_;
6863: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946 raeburn 6864: undef,'.');
1.813 albertel 6865: if (exists($courses{$cdom.'_'.$cnum})) {
6866: return 1;
6867: }
6868: return 0;
6869: }
6870:
1.1015 raeburn 6871: sub store_userdata {
6872: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 6873: my $result;
1.1016 raeburn 6874: if ($datakey ne '') {
1.1013 raeburn 6875: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 6876: if ($udom eq '' || $uname eq '') {
6877: $udom = $env{'user.domain'};
6878: $uname = $env{'user.name'};
6879: }
6880: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 6881: if (($uhome eq '') || ($uhome eq 'no_host')) {
6882: $result = 'error: no_host';
6883: } else {
6884: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6885: $storehash->{'host'} = $perlvar{'lonHostID'};
6886:
6887: my $namevalue='';
6888: foreach my $key (keys(%{$storehash})) {
6889: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6890: }
6891: $namevalue=~s/\&$//;
6892: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
1.1015 raeburn 6893: "$namespace:$datakey:$namevalue",$uhome);
1.1013 raeburn 6894: }
6895: } else {
6896: $result = 'error: data to store was not a hash reference';
6897: }
6898: } else {
6899: $result= 'error: invalid requestkey';
6900: }
6901: return $result;
6902: }
6903:
1.21 www 6904: # ---------------------------------------------------------- Assign Custom Role
6905:
6906: sub assigncustomrole {
1.957 raeburn 6907: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6908: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 6909: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 6910: }
6911:
6912: # ----------------------------------------------------------------- Revoke Role
6913:
6914: sub revokerole {
1.957 raeburn 6915: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6916: my $now=time;
1.965 raeburn 6917: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 6918: }
6919:
6920: # ---------------------------------------------------------- Revoke Custom Role
6921:
6922: sub revokecustomrole {
1.957 raeburn 6923: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6924: my $now=time;
1.357 www 6925: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 6926: $deleteflag,$selfenroll,$context);
1.17 www 6927: }
6928:
1.533 banghart 6929: # ------------------------------------------------------------ Disk usage
1.535 albertel 6930: sub diskusage {
1.955 raeburn 6931: my ($udom,$uname,$directorypath,$getpropath)=@_;
6932: $directorypath =~ s/\/$//;
6933: my $listing=&reply('du2:'.&escape($directorypath).':'
6934: .&escape($getpropath).':'.&escape($uname).':'
6935: .&escape($udom),homeserver($uname,$udom));
6936: if ($listing eq 'unknown_cmd') {
6937: if ($getpropath) {
6938: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6939: }
6940: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6941: }
1.514 albertel 6942: return $listing;
1.512 banghart 6943: }
6944:
1.566 banghart 6945: sub is_locked {
6946: my ($file_name, $domain, $user) = @_;
6947: my @check;
6948: my $is_locked;
6949: push @check, $file_name;
1.613 albertel 6950: my %locked = &get('file_permissions',\@check,
1.620 albertel 6951: $env{'user.domain'},$env{'user.name'});
1.615 albertel 6952: my ($tmp)=keys(%locked);
6953: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 6954:
1.566 banghart 6955: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 6956: $is_locked = 'false';
6957: foreach my $entry (@{$locked{$file_name}}) {
6958: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 6959: $is_locked = 'true';
6960: last;
1.745 raeburn 6961: }
6962: }
1.566 banghart 6963: } else {
6964: $is_locked = 'false';
6965: }
6966: }
6967:
1.759 albertel 6968: sub declutter_portfile {
6969: my ($file) = @_;
1.833 albertel 6970: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 6971: return $file;
6972: }
6973:
1.559 banghart 6974: # ------------------------------------------------------------- Mark as Read Only
6975:
6976: sub mark_as_readonly {
6977: my ($domain,$user,$files,$what) = @_;
1.613 albertel 6978: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 6979: my ($tmp)=keys(%current_permissions);
6980: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 6981: foreach my $file (@{$files}) {
1.759 albertel 6982: $file = &declutter_portfile($file);
1.561 banghart 6983: push(@{$current_permissions{$file}},$what);
1.559 banghart 6984: }
1.613 albertel 6985: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 6986: return;
6987: }
6988:
1.572 banghart 6989: # ------------------------------------------------------------Save Selected Files
6990:
6991: sub save_selected_files {
6992: my ($user, $path, @files) = @_;
6993: my $filename = $user."savedfiles";
1.573 banghart 6994: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 6995: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 6996: foreach my $file (@files) {
1.620 albertel 6997: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 6998: }
6999: foreach my $file (@other_files) {
1.574 banghart 7000: print (OUT $file."\n");
1.572 banghart 7001: }
1.574 banghart 7002: close (OUT);
1.572 banghart 7003: return 'ok';
7004: }
7005:
1.574 banghart 7006: sub clear_selected_files {
7007: my ($user) = @_;
7008: my $filename = $user."savedfiles";
7009: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7010: print (OUT undef);
7011: close (OUT);
7012: return ("ok");
7013: }
7014:
1.572 banghart 7015: sub files_in_path {
7016: my ($user, $path) = @_;
7017: my $filename = $user."savedfiles";
7018: my %return_files;
1.574 banghart 7019: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 7020: while (my $line_in = <IN>) {
1.574 banghart 7021: chomp ($line_in);
7022: my @paths_and_file = split (m!/!, $line_in);
7023: my $file_part = pop (@paths_and_file);
7024: my $path_part = join ('/', @paths_and_file);
1.573 banghart 7025: $path_part.='/';
7026: my $path_and_file = $path_part.$file_part;
7027: if ($path_part eq $path) {
7028: $return_files{$file_part}= 'selected';
7029: }
7030: }
1.574 banghart 7031: close (IN);
7032: return (\%return_files);
1.572 banghart 7033: }
7034:
7035: # called in portfolio select mode, to show files selected NOT in current directory
7036: sub files_not_in_path {
7037: my ($user, $path) = @_;
7038: my $filename = $user."savedfiles";
7039: my @return_files;
7040: my $path_part;
1.800 albertel 7041: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7042: while (my $line = <IN>) {
1.572 banghart 7043: #ok, I know it's clunky, but I want it to work
1.800 albertel 7044: my @paths_and_file = split(m|/|, $line);
7045: my $file_part = pop(@paths_and_file);
7046: chomp($file_part);
7047: my $path_part = join('/', @paths_and_file);
1.572 banghart 7048: $path_part .= '/';
7049: my $path_and_file = $path_part.$file_part;
7050: if ($path_part ne $path) {
1.800 albertel 7051: push(@return_files, ($path_and_file));
1.572 banghart 7052: }
7053: }
1.800 albertel 7054: close(OUT);
1.574 banghart 7055: return (@return_files);
1.572 banghart 7056: }
7057:
1.745 raeburn 7058: #----------------------------------------------Get portfolio file permissions
1.629 banghart 7059:
1.745 raeburn 7060: sub get_portfile_permissions {
7061: my ($domain,$user) = @_;
1.613 albertel 7062: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 7063: my ($tmp)=keys(%current_permissions);
7064: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7065: return \%current_permissions;
7066: }
7067:
7068: #---------------------------------------------Get portfolio file access controls
7069:
1.749 raeburn 7070: sub get_access_controls {
1.745 raeburn 7071: my ($current_permissions,$group,$file) = @_;
1.769 albertel 7072: my %access;
7073: my $real_file = $file;
7074: $file =~ s/\.meta$//;
1.745 raeburn 7075: if (defined($file)) {
1.749 raeburn 7076: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7077: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 7078: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 7079: }
7080: }
1.745 raeburn 7081: } else {
1.749 raeburn 7082: foreach my $key (keys(%{$current_permissions})) {
7083: if ($key =~ /\0accesscontrol$/) {
7084: if (defined($group)) {
7085: if ($key !~ m-^\Q$group\E/-) {
7086: next;
7087: }
7088: }
7089: my ($fullpath) = split(/\0/,$key);
7090: if (ref($$current_permissions{$key}) eq 'HASH') {
7091: foreach my $control (keys(%{$$current_permissions{$key}})) {
7092: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7093: }
7094: }
7095: }
7096: }
7097: }
7098: return %access;
7099: }
7100:
7101: sub modify_access_controls {
7102: my ($file_name,$changes,$domain,$user)=@_;
7103: my ($outcome,$deloutcome);
7104: my %store_permissions;
7105: my %new_values;
7106: my %new_control;
7107: my %translation;
7108: my @deletions = ();
7109: my $now = time;
7110: if (exists($$changes{'activate'})) {
7111: if (ref($$changes{'activate'}) eq 'HASH') {
7112: my @newitems = sort(keys(%{$$changes{'activate'}}));
7113: my $numnew = scalar(@newitems);
7114: for (my $i=0; $i<$numnew; $i++) {
7115: my $newkey = $newitems[$i];
7116: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 7117: if ($newkey =~ /^\d+:/) {
7118: $newkey =~ s/^(\d+)/$newid/;
7119: $translation{$1} = $newid;
7120: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7121: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7122: $translation{$1} = $newid;
7123: }
1.749 raeburn 7124: $new_values{$file_name."\0".$newkey} =
7125: $$changes{'activate'}{$newitems[$i]};
7126: $new_control{$newkey} = $now;
7127: }
7128: }
7129: }
7130: my %todelete;
7131: my %changed_items;
7132: foreach my $action ('delete','update') {
7133: if (exists($$changes{$action})) {
7134: if (ref($$changes{$action}) eq 'HASH') {
7135: foreach my $key (keys(%{$$changes{$action}})) {
7136: my ($itemnum) = ($key =~ /^([^:]+):/);
7137: if ($action eq 'delete') {
7138: $todelete{$itemnum} = 1;
7139: } else {
7140: $changed_items{$itemnum} = $key;
7141: }
7142: }
1.745 raeburn 7143: }
7144: }
1.749 raeburn 7145: }
7146: # get lock on access controls for file.
7147: my $lockhash = {
7148: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7149: ':'.$env{'user.domain'},
7150: };
7151: my $tries = 0;
7152: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7153:
7154: while (($gotlock ne 'ok') && $tries <3) {
7155: $tries ++;
7156: sleep 1;
7157: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7158: }
7159: if ($gotlock eq 'ok') {
7160: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7161: my ($tmp)=keys(%curr_permissions);
7162: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7163: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7164: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7165: if (ref($curr_controls) eq 'HASH') {
7166: foreach my $control_item (keys(%{$curr_controls})) {
7167: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7168: if (defined($todelete{$itemnum})) {
7169: push(@deletions,$file_name."\0".$control_item);
7170: } else {
7171: if (defined($changed_items{$itemnum})) {
7172: $new_control{$changed_items{$itemnum}} = $now;
7173: push(@deletions,$file_name."\0".$control_item);
7174: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7175: } else {
7176: $new_control{$control_item} = $$curr_controls{$control_item};
7177: }
7178: }
1.745 raeburn 7179: }
7180: }
7181: }
1.970 raeburn 7182: my ($group);
7183: if (&is_course($domain,$user)) {
7184: ($group,my $file) = split(/\//,$file_name,2);
7185: }
1.749 raeburn 7186: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7187: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7188: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7189: # remove lock
7190: my @del_lock = ($file_name."\0".'locked_access_records');
7191: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 7192: my $sqlresult =
1.970 raeburn 7193: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 7194: $group);
1.749 raeburn 7195: } else {
7196: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 7197: }
1.749 raeburn 7198: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 7199: }
7200:
1.827 raeburn 7201: sub make_public_indefinitely {
7202: my ($requrl) = @_;
7203: my $now = time;
7204: my $action = 'activate';
7205: my $aclnum = 0;
7206: if (&is_portfolio_url($requrl)) {
7207: my (undef,$udom,$unum,$file_name,$group) =
7208: &parse_portfolio_url($requrl);
7209: my $current_perms = &get_portfile_permissions($udom,$unum);
7210: my %access_controls = &get_access_controls($current_perms,
7211: $group,$file_name);
7212: foreach my $key (keys(%{$access_controls{$file_name}})) {
7213: my ($num,$scope,$end,$start) =
7214: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7215: if ($scope eq 'public') {
7216: if ($start <= $now && $end == 0) {
7217: $action = 'none';
7218: } else {
7219: $action = 'update';
7220: $aclnum = $num;
7221: }
7222: last;
7223: }
7224: }
7225: if ($action eq 'none') {
7226: return 'ok';
7227: } else {
7228: my %changes;
7229: my $newend = 0;
7230: my $newstart = $now;
7231: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7232: $changes{$action}{$newkey} = {
7233: type => 'public',
7234: time => {
7235: start => $newstart,
7236: end => $newend,
7237: },
7238: };
7239: my ($outcome,$deloutcome,$new_values,$translation) =
7240: &modify_access_controls($file_name,\%changes,$udom,$unum);
7241: return $outcome;
7242: }
7243: } else {
7244: return 'invalid';
7245: }
7246: }
7247:
1.745 raeburn 7248: #------------------------------------------------------Get Marked as Read Only
7249:
7250: sub get_marked_as_readonly {
7251: my ($domain,$user,$what,$group) = @_;
7252: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 7253: my @readonly_files;
1.629 banghart 7254: my $cmp1=$what;
7255: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 7256: while (my ($file_name,$value) = each(%{$current_permissions})) {
7257: if (defined($group)) {
7258: if ($file_name !~ m-^\Q$group\E/-) {
7259: next;
7260: }
7261: }
1.561 banghart 7262: if (ref($value) eq "ARRAY"){
7263: foreach my $stored_what (@{$value}) {
1.629 banghart 7264: my $cmp2=$stored_what;
1.759 albertel 7265: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 7266: $cmp2=join('',@{$stored_what});
1.745 raeburn 7267: }
1.629 banghart 7268: if ($cmp1 eq $cmp2) {
1.561 banghart 7269: push(@readonly_files, $file_name);
1.745 raeburn 7270: last;
1.563 banghart 7271: } elsif (!defined($what)) {
7272: push(@readonly_files, $file_name);
1.745 raeburn 7273: last;
1.561 banghart 7274: }
7275: }
1.745 raeburn 7276: }
1.561 banghart 7277: }
7278: return @readonly_files;
7279: }
1.577 banghart 7280: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 7281:
1.577 banghart 7282: sub get_marked_as_readonly_hash {
1.745 raeburn 7283: my ($current_permissions,$group,$what) = @_;
1.577 banghart 7284: my %readonly_files;
1.745 raeburn 7285: while (my ($file_name,$value) = each(%{$current_permissions})) {
7286: if (defined($group)) {
7287: if ($file_name !~ m-^\Q$group\E/-) {
7288: next;
7289: }
7290: }
1.577 banghart 7291: if (ref($value) eq "ARRAY"){
7292: foreach my $stored_what (@{$value}) {
1.745 raeburn 7293: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 7294: foreach my $lock_descriptor(@{$stored_what}) {
7295: if ($lock_descriptor eq 'graded') {
7296: $readonly_files{$file_name} = 'graded';
7297: } elsif ($lock_descriptor eq 'handback') {
7298: $readonly_files{$file_name} = 'handback';
7299: } else {
7300: if (!exists($readonly_files{$file_name})) {
7301: $readonly_files{$file_name} = 'locked';
7302: }
7303: }
1.745 raeburn 7304: }
1.750 banghart 7305: }
1.577 banghart 7306: }
7307: }
7308: }
7309: return %readonly_files;
7310: }
1.559 banghart 7311: # ------------------------------------------------------------ Unmark as Read Only
7312:
7313: sub unmark_as_readonly {
1.629 banghart 7314: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7315: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 7316: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 7317: $file_name = &declutter_portfile($file_name);
1.634 albertel 7318: my $symb_crs = $what;
7319: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 7320: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 7321: my ($tmp)=keys(%current_permissions);
7322: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7323: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 7324: foreach my $file (@readonly_files) {
1.759 albertel 7325: my $clean_file = &declutter_portfile($file);
7326: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 7327: my $current_locks = $current_permissions{$file};
1.563 banghart 7328: my @new_locks;
7329: my @del_keys;
7330: if (ref($current_locks) eq "ARRAY"){
7331: foreach my $locker (@{$current_locks}) {
1.632 albertel 7332: my $compare=$locker;
1.749 raeburn 7333: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 7334: $compare=join('',@{$locker});
1.746 raeburn 7335: if ($compare ne $symb_crs) {
7336: push(@new_locks, $locker);
7337: }
1.563 banghart 7338: }
7339: }
1.650 albertel 7340: if (scalar(@new_locks) > 0) {
1.563 banghart 7341: $current_permissions{$file} = \@new_locks;
7342: } else {
7343: push(@del_keys, $file);
1.613 albertel 7344: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 7345: delete($current_permissions{$file});
1.563 banghart 7346: }
7347: }
1.561 banghart 7348: }
1.613 albertel 7349: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7350: return;
7351: }
1.512 banghart 7352:
1.17 www 7353: # ------------------------------------------------------------ Directory lister
7354:
7355: sub dirlist {
1.955 raeburn 7356: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 7357: $uri=~s/^\///;
7358: $uri=~s/\/$//;
1.253 stredwic 7359: my ($udom, $uname);
1.955 raeburn 7360: if ($getuserdir) {
1.253 stredwic 7361: $udom = $userdomain;
7362: $uname = $username;
1.955 raeburn 7363: } else {
7364: (undef,$udom,$uname)=split(/\//,$uri);
7365: if(defined($userdomain)) {
7366: $udom = $userdomain;
7367: }
7368: if(defined($username)) {
7369: $uname = $username;
7370: }
1.253 stredwic 7371: }
1.955 raeburn 7372: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 7373:
1.955 raeburn 7374: $dirRoot = $perlvar{'lonDocRoot'};
7375: if (defined($getpropath)) {
7376: $dirRoot = &propath($udom,$uname);
1.253 stredwic 7377: $dirRoot =~ s/\/$//;
1.955 raeburn 7378: } elsif (defined($getuserdir)) {
7379: my $subdir=$uname.'__';
7380: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7381: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7382: ."/$udom/$subdir/$uname";
7383: } elsif (defined($alternateRoot)) {
7384: $dirRoot = $alternateRoot;
1.751 banghart 7385: }
1.253 stredwic 7386:
7387: if($udom) {
7388: if($uname) {
1.955 raeburn 7389: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 7390: .$getuserdir.':'.&escape($dirRoot)
1.955 raeburn 7391: .':'.&escape($uname).':'.&escape($udom),
7392: &homeserver($uname,$udom));
7393: if ($listing eq 'unknown_cmd') {
7394: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7395: &homeserver($uname,$udom));
7396: } else {
7397: @listing_results = map { &unescape($_); } split(/:/,$listing);
7398: }
1.605 matthew 7399: if ($listing eq 'unknown_cmd') {
1.800 albertel 7400: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7401: &homeserver($uname,$udom));
1.605 matthew 7402: @listing_results = split(/:/,$listing);
7403: } else {
7404: @listing_results = map { &unescape($_); } split(/:/,$listing);
7405: }
7406: return @listing_results;
1.955 raeburn 7407: } elsif(!$alternateRoot) {
1.800 albertel 7408: my %allusers;
1.841 albertel 7409: my %servers = &get_servers($udom,'library');
1.955 raeburn 7410: foreach my $tryserver (keys(%servers)) {
7411: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7412: &escape($udom),$tryserver);
7413: if ($listing eq 'unknown_cmd') {
7414: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7415: $udom, $tryserver);
7416: } else {
7417: @listing_results = map { &unescape($_); } split(/:/,$listing);
7418: }
1.841 albertel 7419: if ($listing eq 'unknown_cmd') {
7420: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7421: $udom, $tryserver);
7422: @listing_results = split(/:/,$listing);
7423: } else {
7424: @listing_results =
7425: map { &unescape($_); } split(/:/,$listing);
7426: }
7427: if ($listing_results[0] ne 'no_such_dir' &&
7428: $listing_results[0] ne 'empty' &&
7429: $listing_results[0] ne 'con_lost') {
7430: foreach my $line (@listing_results) {
7431: my ($entry) = split(/&/,$line,2);
7432: $allusers{$entry} = 1;
7433: }
7434: }
1.253 stredwic 7435: }
7436: my $alluserstr='';
1.800 albertel 7437: foreach my $user (sort(keys(%allusers))) {
7438: $alluserstr.=$user.'&user:';
1.253 stredwic 7439: }
7440: $alluserstr=~s/:$//;
7441: return split(/:/,$alluserstr);
7442: } else {
1.800 albertel 7443: return ('missing user name');
1.253 stredwic 7444: }
1.955 raeburn 7445: } elsif(!defined($getpropath)) {
1.841 albertel 7446: my @all_domains = sort(&all_domains());
1.955 raeburn 7447: foreach my $domain (@all_domains) {
7448: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7449: }
7450: return @all_domains;
7451: } else {
1.800 albertel 7452: return ('missing domain');
1.275 stredwic 7453: }
7454: }
7455:
7456: # --------------------------------------------- GetFileTimestamp
7457: # This function utilizes dirlist and returns the date stamp for
7458: # when it was last modified. It will also return an error of -1
7459: # if an error occurs
7460:
7461: sub GetFileTimestamp {
1.955 raeburn 7462: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 7463: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7464: $studentName = &LONCAPA::clean_username($studentName);
1.955 raeburn 7465: my ($fileStat) =
7466: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7467: undef,$getuserdir);
1.275 stredwic 7468: my @stats = split('&', $fileStat);
7469: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 7470: # @stats contains first the filename, then the stat output
7471: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 7472: } else {
7473: return -1;
1.253 stredwic 7474: }
1.26 www 7475: }
7476:
1.712 albertel 7477: sub stat_file {
7478: my ($uri) = @_;
1.787 albertel 7479: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 7480:
1.955 raeburn 7481: my ($udom,$uname,$file);
1.712 albertel 7482: if ($uri =~ m-^/(uploaded|editupload)/-) {
7483: ($udom,$uname,$file) =
1.811 albertel 7484: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 7485: $file = 'userfiles/'.$file;
7486: }
7487: if ($uri =~ m-^/res/-) {
7488: ($udom,$uname) =
1.807 albertel 7489: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 7490: $file = $uri;
7491: }
7492:
7493: if (!$udom || !$uname || !$file) {
7494: # unable to handle the uri
7495: return ();
7496: }
1.956 raeburn 7497: my $getpropath;
7498: if ($file =~ /^userfiles\//) {
7499: $getpropath = 1;
7500: }
1.955 raeburn 7501: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712 albertel 7502: my @stats = split('&', $result);
1.721 banghart 7503:
1.712 albertel 7504: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7505: shift(@stats); #filename is first
7506: return @stats;
7507: }
7508: return ();
7509: }
7510:
1.26 www 7511: # -------------------------------------------------------- Value of a Condition
7512:
1.713 albertel 7513: # gets the value of a specific preevaluated condition
7514: # stored in the string $env{user.state.<cid>}
7515: # or looks up a condition reference in the bighash and if if hasn't
7516: # already been evaluated recurses into docondval to get the value of
7517: # the condition, then memoizing it to
7518: # $env{user.state.<cid>.<condition>}
1.40 www 7519: sub directcondval {
7520: my $number=shift;
1.620 albertel 7521: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 7522: &Apache::lonuserstate::evalstate();
7523: }
1.713 albertel 7524: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7525: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7526: } elsif ($number =~ /^_/) {
7527: my $sub_condition;
7528: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7529: &GDBM_READER(),0640)) {
7530: $sub_condition=$bighash{'conditions'.$number};
7531: untie(%bighash);
7532: }
7533: my $value = &docondval($sub_condition);
1.949 raeburn 7534: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 7535: return $value;
7536: }
1.620 albertel 7537: if ($env{'user.state.'.$env{'request.course.id'}}) {
7538: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 7539: } else {
7540: return 2;
7541: }
7542: }
7543:
1.713 albertel 7544: # get the collection of conditions for this resource
1.26 www 7545: sub condval {
7546: my $condidx=shift;
1.54 www 7547: my $allpathcond='';
1.713 albertel 7548: foreach my $cond (split(/\|/,$condidx)) {
7549: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7550: $allpathcond.=
7551: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7552: }
1.191 harris41 7553: }
1.54 www 7554: $allpathcond=~s/\|$//;
1.713 albertel 7555: return &docondval($allpathcond);
7556: }
7557:
7558: #evaluates an expression of conditions
7559: sub docondval {
7560: my ($allpathcond) = @_;
7561: my $result=0;
7562: if ($env{'request.course.id'}
7563: && defined($allpathcond)) {
7564: my $operand='|';
7565: my @stack;
7566: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7567: if ($chunk eq '(') {
7568: push @stack,($operand,$result);
7569: } elsif ($chunk eq ')') {
7570: my $before=pop @stack;
7571: if (pop @stack eq '&') {
7572: $result=$result>$before?$before:$result;
7573: } else {
7574: $result=$result>$before?$result:$before;
7575: }
7576: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7577: $operand=$chunk;
7578: } else {
7579: my $new=directcondval($chunk);
7580: if ($operand eq '&') {
7581: $result=$result>$new?$new:$result;
7582: } else {
7583: $result=$result>$new?$result:$new;
7584: }
7585: }
7586: }
1.26 www 7587: }
7588: return $result;
1.421 albertel 7589: }
7590:
7591: # ---------------------------------------------------- Devalidate courseresdata
7592:
7593: sub devalidatecourseresdata {
7594: my ($coursenum,$coursedomain)=@_;
7595: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7596: &devalidate_cache_new('courseres',$hashid);
1.28 www 7597: }
7598:
1.763 www 7599:
1.200 www 7600: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 7601: #
7602: # Parameters:
7603: # $coursenum - Number of the course.
7604: # $coursedomain - Domain at which the course was created.
7605: # Returns:
7606: # A hash of the course parameters along (I think) with timestamps
7607: # and version info.
1.877 foxr 7608:
1.624 albertel 7609: sub get_courseresdata {
7610: my ($coursenum,$coursedomain)=@_;
1.200 www 7611: my $coursehom=&homeserver($coursenum,$coursedomain);
7612: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7613: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 7614: my %dumpreply;
1.417 albertel 7615: unless (defined($cached)) {
1.624 albertel 7616: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 7617: $result=\%dumpreply;
1.251 albertel 7618: my ($tmp) = keys(%dumpreply);
7619: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 7620: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 7621: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7622: return $tmp;
1.416 albertel 7623: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 7624: $result=undef;
1.599 albertel 7625: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 7626: }
7627: }
1.624 albertel 7628: return $result;
7629: }
7630:
1.633 albertel 7631: sub devalidateuserresdata {
7632: my ($uname,$udom)=@_;
7633: my $hashid="$udom:$uname";
7634: &devalidate_cache_new('userres',$hashid);
7635: }
7636:
1.624 albertel 7637: sub get_userresdata {
7638: my ($uname,$udom)=@_;
7639: #most student don\'t have any data set, check if there is some data
7640: if (&EXT_cache_status($udom,$uname)) { return undef; }
7641:
7642: my $hashid="$udom:$uname";
7643: my ($result,$cached)=&is_cached_new('userres',$hashid);
7644: if (!defined($cached)) {
7645: my %resourcedata=&dump('resourcedata',$udom,$uname);
7646: $result=\%resourcedata;
7647: &do_cache_new('userres',$hashid,$result,600);
7648: }
7649: my ($tmp)=keys(%$result);
7650: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7651: return $result;
7652: }
7653: #error 2 occurs when the .db doesn't exist
7654: if ($tmp!~/error: 2 /) {
1.672 albertel 7655: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 7656: " Trying to get resource data for ".
7657: $uname." at ".$udom.": ".
7658: $tmp."</font>");
7659: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 7660: #&EXT_cache_set($udom,$uname);
7661: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 7662: undef($tmp); # not really an error so don't send it back
1.624 albertel 7663: }
7664: return $tmp;
7665: }
1.879 foxr 7666: #----------------------------------------------- resdata - return resource data
7667: # Purpose:
7668: # Return resource data for either users or for a course.
7669: # Parameters:
7670: # $name - Course/user name.
7671: # $domain - Name of the domain the user/course is registered on.
7672: # $type - Type of thing $name is (must be 'course' or 'user'
7673: # @which - Array of names of resources desired.
7674: # Returns:
7675: # The value of the first reasource in @which that is found in the
7676: # resource hash.
7677: # Exceptional Conditions:
7678: # If the $type passed in is not valid (not the string 'course' or
7679: # 'user', an undefined reference is returned.
7680: # If none of the resources are found, an undef is returned
1.624 albertel 7681: sub resdata {
7682: my ($name,$domain,$type,@which)=@_;
7683: my $result;
7684: if ($type eq 'course') {
7685: $result=&get_courseresdata($name,$domain);
7686: } elsif ($type eq 'user') {
7687: $result=&get_userresdata($name,$domain);
7688: }
7689: if (!ref($result)) { return $result; }
1.251 albertel 7690: foreach my $item (@which) {
1.927 albertel 7691: if (defined($result->{$item->[0]})) {
7692: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 7693: }
1.250 albertel 7694: }
1.291 albertel 7695: return undef;
1.200 www 7696: }
7697:
1.379 matthew 7698: #
7699: # EXT resource caching routines
7700: #
7701:
7702: sub clear_EXT_cache_status {
1.383 albertel 7703: &delenv('cache.EXT.');
1.379 matthew 7704: }
7705:
7706: sub EXT_cache_status {
7707: my ($target_domain,$target_user) = @_;
1.383 albertel 7708: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 7709: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 7710: # We know already the user has no data
7711: return 1;
7712: } else {
7713: return 0;
7714: }
7715: }
7716:
7717: sub EXT_cache_set {
7718: my ($target_domain,$target_user) = @_;
1.383 albertel 7719: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 7720: #&appenv({$cachename => time});
1.379 matthew 7721: }
7722:
1.28 www 7723: # --------------------------------------------------------- Value of a Variable
1.58 www 7724: sub EXT {
1.715 albertel 7725:
1.395 albertel 7726: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 7727: unless ($varname) { return ''; }
1.218 albertel 7728: #get real user name/domain, courseid and symb
7729: my $courseid;
1.359 albertel 7730: my $publicuser;
1.427 www 7731: if ($symbparm) {
7732: $symbparm=&get_symb_from_alias($symbparm);
7733: }
1.218 albertel 7734: if (!($uname && $udom)) {
1.790 albertel 7735: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 7736: if (!$symbparm) { $symbparm=$cursymb; }
7737: } else {
1.620 albertel 7738: $courseid=$env{'request.course.id'};
1.218 albertel 7739: }
1.48 www 7740: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7741: my $rest;
1.320 albertel 7742: if (defined($therest[0])) {
1.48 www 7743: $rest=join('.',@therest);
7744: } else {
7745: $rest='';
7746: }
1.320 albertel 7747:
1.57 www 7748: my $qualifierrest=$qualifier;
7749: if ($rest) { $qualifierrest.='.'.$rest; }
7750: my $spacequalifierrest=$space;
7751: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 7752: if ($realm eq 'user') {
1.48 www 7753: # --------------------------------------------------------------- user.resource
7754: if ($space eq 'resource') {
1.651 albertel 7755: if ( (defined($Apache::lonhomework::parsing_a_problem)
7756: || defined($Apache::lonhomework::parsing_a_task))
7757: &&
1.744 albertel 7758: ($symbparm eq &symbread()) ) {
7759: # if we are in the middle of processing the resource the
7760: # get the value we are planning on committing
7761: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7762: return $Apache::lonhomework::results{$qualifierrest};
7763: } else {
7764: return $Apache::lonhomework::history{$qualifierrest};
7765: }
1.335 albertel 7766: } else {
1.359 albertel 7767: my %restored;
1.620 albertel 7768: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 7769: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7770: } else {
7771: %restored=&restore($symbparm,$courseid,$udom,$uname);
7772: }
1.335 albertel 7773: return $restored{$qualifierrest};
7774: }
1.48 www 7775: # ----------------------------------------------------------------- user.access
7776: } elsif ($space eq 'access') {
1.218 albertel 7777: # FIXME - not supporting calls for a specific user
1.48 www 7778: return &allowed($qualifier,$rest);
7779: # ------------------------------------------ user.preferences, user.environment
7780: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 7781: if (($uname eq $env{'user.name'}) &&
7782: ($udom eq $env{'user.domain'})) {
7783: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 7784: } else {
1.359 albertel 7785: my %returnhash;
7786: if (!$publicuser) {
7787: %returnhash=&userenvironment($udom,$uname,
7788: $qualifierrest);
7789: }
1.218 albertel 7790: return $returnhash{$qualifierrest};
7791: }
1.48 www 7792: # ----------------------------------------------------------------- user.course
7793: } elsif ($space eq 'course') {
1.218 albertel 7794: # FIXME - not supporting calls for a specific user
1.620 albertel 7795: return $env{join('.',('request.course',$qualifier))};
1.48 www 7796: # ------------------------------------------------------------------- user.role
7797: } elsif ($space eq 'role') {
1.218 albertel 7798: # FIXME - not supporting calls for a specific user
1.620 albertel 7799: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 7800: if ($qualifier eq 'value') {
7801: return $role;
7802: } elsif ($qualifier eq 'extent') {
7803: return $where;
7804: }
7805: # ----------------------------------------------------------------- user.domain
7806: } elsif ($space eq 'domain') {
1.218 albertel 7807: return $udom;
1.48 www 7808: # ------------------------------------------------------------------- user.name
7809: } elsif ($space eq 'name') {
1.218 albertel 7810: return $uname;
1.48 www 7811: # ---------------------------------------------------- Any other user namespace
1.29 www 7812: } else {
1.359 albertel 7813: my %reply;
7814: if (!$publicuser) {
7815: %reply=&get($space,[$qualifierrest],$udom,$uname);
7816: }
7817: return $reply{$qualifierrest};
1.48 www 7818: }
1.236 www 7819: } elsif ($realm eq 'query') {
7820: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 7821: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7822: [$spacequalifierrest]);
1.620 albertel 7823: return $env{'form.'.$spacequalifierrest};
1.236 www 7824: } elsif ($realm eq 'request') {
1.48 www 7825: # ------------------------------------------------------------- request.browser
7826: if ($space eq 'browser') {
1.430 www 7827: if ($qualifier eq 'textremote') {
1.676 albertel 7828: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 7829: return 1;
7830: } else {
7831: return 0;
7832: }
7833: } else {
1.620 albertel 7834: return $env{'browser.'.$qualifier};
1.430 www 7835: }
1.57 www 7836: # ------------------------------------------------------------ request.filename
7837: } else {
1.620 albertel 7838: return $env{'request.'.$spacequalifierrest};
1.29 www 7839: }
1.28 www 7840: } elsif ($realm eq 'course') {
1.48 www 7841: # ---------------------------------------------------------- course.description
1.620 albertel 7842: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 7843: } elsif ($realm eq 'resource') {
1.165 www 7844:
1.620 albertel 7845: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 7846: if (!$symbparm) { $symbparm=&symbread(); }
7847: }
1.693 albertel 7848:
7849: if ($space eq 'title') {
7850: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7851: return &gettitle($symbparm);
7852: }
7853:
7854: if ($space eq 'map') {
7855: my ($map) = &decode_symb($symbparm);
7856: return &symbread($map);
7857: }
1.905 albertel 7858: if ($space eq 'filename') {
7859: if ($symbparm) {
7860: return &clutter((&decode_symb($symbparm))[2]);
7861: }
7862: return &hreflocation('',$env{'request.filename'});
7863: }
1.693 albertel 7864:
7865: my ($section, $group, @groups);
1.593 albertel 7866: my ($courselevelm,$courselevel);
1.539 albertel 7867: if ($symbparm && defined($courseid) &&
1.620 albertel 7868: $courseid eq $env{'request.course.id'}) {
1.165 www 7869:
1.218 albertel 7870: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 7871:
1.60 www 7872: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 7873: my $symbp=$symbparm;
1.735 albertel 7874: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 7875:
7876: my $symbparm=$symbp.'.'.$spacequalifierrest;
7877: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7878:
1.620 albertel 7879: if (($env{'user.name'} eq $uname) &&
7880: ($env{'user.domain'} eq $udom)) {
7881: $section=$env{'request.course.sec'};
1.733 raeburn 7882: @groups = split(/:/,$env{'request.course.groups'});
7883: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 7884: } else {
1.539 albertel 7885: if (! defined($usection)) {
1.551 albertel 7886: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 7887: } else {
7888: $section = $usection;
7889: }
1.733 raeburn 7890: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 7891: }
7892:
7893: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7894: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7895: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7896:
1.593 albertel 7897: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 7898: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 7899: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 7900:
1.60 www 7901: # ----------------------------------------------------------- first, check user
1.624 albertel 7902:
7903: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 7904: ([$courselevelr,'resource'],
7905: [$courselevelm,'map' ],
7906: [$courselevel, 'course' ]));
1.931 albertel 7907: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 7908:
1.594 albertel 7909: # ------------------------------------------------ second, check some of course
1.684 raeburn 7910: my $coursereply;
1.691 raeburn 7911: if (@groups > 0) {
7912: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7913: $mapparm,$spacequalifierrest);
1.927 albertel 7914: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 7915: }
1.96 www 7916:
1.684 raeburn 7917: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 7918: $env{'course.'.$courseid.'.domain'},
7919: 'course',
7920: ([$seclevelr, 'resource'],
7921: [$seclevelm, 'map' ],
7922: [$seclevel, 'course' ],
7923: [$courselevelr,'resource']));
7924: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 7925:
1.60 www 7926: # ------------------------------------------------------ third, check map parms
1.218 albertel 7927: my %parmhash=();
7928: my $thisparm='';
7929: if (tie(%parmhash,'GDBM_File',
1.620 albertel 7930: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 7931: &GDBM_READER(),0640)) {
1.218 albertel 7932: $thisparm=$parmhash{$symbparm};
7933: untie(%parmhash);
7934: }
1.927 albertel 7935: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 7936: }
1.594 albertel 7937: # ------------------------------------------ fourth, look in resource metadata
1.71 www 7938:
1.218 albertel 7939: $spacequalifierrest=~s/\./\_/;
1.282 albertel 7940: my $filename;
7941: if (!$symbparm) { $symbparm=&symbread(); }
7942: if ($symbparm) {
1.409 www 7943: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 7944: } else {
1.620 albertel 7945: $filename=$env{'request.filename'};
1.282 albertel 7946: }
7947: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 7948: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 7949: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 7950: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 7951:
1.927 albertel 7952: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 7953: if ($symbparm && defined($courseid) &&
1.620 albertel 7954: $courseid eq $env{'request.course.id'}) {
1.624 albertel 7955: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7956: $env{'course.'.$courseid.'.domain'},
7957: 'course',
1.927 albertel 7958: ([$courselevelm,'map' ],
7959: [$courselevel, 'course']));
7960: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 7961: }
1.145 www 7962: # ------------------------------------------------------------------ Cascade up
1.218 albertel 7963: unless ($space eq '0') {
1.336 albertel 7964: my @parts=split(/_/,$space);
7965: my $id=pop(@parts);
7966: my $part=join('_',@parts);
7967: if ($part eq '') { $part='0'; }
1.927 albertel 7968: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 7969: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 7970: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 7971: }
1.395 albertel 7972: if ($recurse) { return undef; }
7973: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 7974: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 7975: # ---------------------------------------------------- Any other user namespace
7976: } elsif ($realm eq 'environment') {
7977: # ----------------------------------------------------------------- environment
1.620 albertel 7978: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7979: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 7980: } else {
1.770 albertel 7981: if ($uname eq 'anonymous' && $udom eq '') {
7982: return '';
7983: }
1.219 albertel 7984: my %returnhash=&userenvironment($udom,$uname,
7985: $spacequalifierrest);
7986: return $returnhash{$spacequalifierrest};
7987: }
1.28 www 7988: } elsif ($realm eq 'system') {
1.48 www 7989: # ----------------------------------------------------------------- system.time
7990: if ($space eq 'time') {
7991: return time;
7992: }
1.696 albertel 7993: } elsif ($realm eq 'server') {
7994: # ----------------------------------------------------------------- system.time
7995: if ($space eq 'name') {
7996: return $ENV{'SERVER_NAME'};
7997: }
1.28 www 7998: }
1.48 www 7999: return '';
1.61 www 8000: }
8001:
1.927 albertel 8002: sub get_reply {
8003: my ($reply_value) = @_;
1.940 raeburn 8004: if (ref($reply_value) eq 'ARRAY') {
8005: if (wantarray) {
8006: return @$reply_value;
8007: }
8008: return $reply_value->[0];
8009: } else {
8010: return $reply_value;
1.927 albertel 8011: }
8012: }
8013:
1.691 raeburn 8014: sub check_group_parms {
8015: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8016: my @groupitems = ();
8017: my $resultitem;
1.927 albertel 8018: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 8019: foreach my $group (@{$groups}) {
8020: foreach my $level (@levels) {
1.927 albertel 8021: my $item = $courseid.'.['.$group.'].'.$level->[0];
8022: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 8023: }
8024: }
8025: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8026: $env{'course.'.$courseid.'.domain'},
8027: 'course',@groupitems);
8028: return $coursereply;
8029: }
8030:
8031: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 8032: my ($courseid,@groups) = @_;
8033: @groups = sort(@groups);
1.691 raeburn 8034: return @groups;
8035: }
8036:
1.395 albertel 8037: sub packages_tab_default {
8038: my ($uri,$varname)=@_;
8039: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 8040:
8041: my (@extension,@specifics,$do_default);
8042: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 8043: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 8044: if ($pack_type eq 'default') {
8045: $do_default=1;
8046: } elsif ($pack_type eq 'extension') {
8047: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 8048: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 8049: # only look at packages defaults for packages that this id is
1.738 albertel 8050: push(@specifics,[$package,$pack_type,$pack_part]);
8051: }
8052: }
8053: # first look for a package that matches the requested part id
8054: foreach my $package (@specifics) {
8055: my (undef,$pack_type,$pack_part)=@{$package};
8056: next if ($pack_part ne $part);
8057: if (defined($packagetab{"$pack_type&$name&default"})) {
8058: return $packagetab{"$pack_type&$name&default"};
8059: }
8060: }
8061: # look for any possible matching non extension_ package
8062: foreach my $package (@specifics) {
8063: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 8064: if (defined($packagetab{"$pack_type&$name&default"})) {
8065: return $packagetab{"$pack_type&$name&default"};
8066: }
1.585 albertel 8067: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 8068: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8069: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 8070: }
8071: }
1.738 albertel 8072: # look for any posible extension_ match
8073: foreach my $package (@extension) {
8074: my ($package,$pack_type)=@{$package};
8075: if (defined($packagetab{"$pack_type&$name&default"})) {
8076: return $packagetab{"$pack_type&$name&default"};
8077: }
8078: if (defined($packagetab{$package."&$name&default"})) {
8079: return $packagetab{$package."&$name&default"};
8080: }
8081: }
8082: # look for a global default setting
8083: if ($do_default && defined($packagetab{"default&$name&default"})) {
8084: return $packagetab{"default&$name&default"};
8085: }
1.395 albertel 8086: return undef;
8087: }
8088:
1.334 albertel 8089: sub add_prefix_and_part {
8090: my ($prefix,$part)=@_;
8091: my $keyroot;
8092: if (defined($prefix) && $prefix !~ /^__/) {
8093: # prefix that has a part already
8094: $keyroot=$prefix;
8095: } elsif (defined($prefix)) {
8096: # prefix that is missing a part
8097: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8098: } else {
8099: # no prefix at all
8100: if (defined($part)) { $keyroot='_'.$part; }
8101: }
8102: return $keyroot;
8103: }
8104:
1.71 www 8105: # ---------------------------------------------------------------- Get metadata
8106:
1.599 albertel 8107: my %metaentry;
1.71 www 8108: sub metadata {
1.176 www 8109: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 8110: $uri=&declutter($uri);
1.288 albertel 8111: # if it is a non metadata possible uri return quickly
1.529 albertel 8112: if (($uri eq '') ||
8113: (($uri =~ m|^/*adm/|) &&
1.698 albertel 8114: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 albertel 8115: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8116: return undef;
8117: }
8118: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8119: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 8120: return undef;
1.288 albertel 8121: }
1.73 www 8122: my $filename=$uri;
8123: $uri=~s/\.meta$//;
1.172 www 8124: #
8125: # Is the metadata already cached?
1.177 www 8126: # Look at timestamp of caching
1.172 www 8127: # Everything is cached by the main uri, libraries are never directly cached
8128: #
1.428 albertel 8129: if (!defined($liburi)) {
1.599 albertel 8130: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 8131: if (defined($cached)) { return $result->{':'.$what}; }
8132: }
8133: {
1.172 www 8134: #
8135: # Is this a recursive call for a library?
8136: #
1.599 albertel 8137: # if (! exists($metacache{$uri})) {
8138: # $metacache{$uri}={};
8139: # }
1.924 albertel 8140: my $cachetime = 60*60;
1.171 www 8141: if ($liburi) {
8142: $liburi=&declutter($liburi);
8143: $filename=$liburi;
1.401 bowersj2 8144: } else {
1.599 albertel 8145: &devalidate_cache_new('meta',$uri);
8146: undef(%metaentry);
1.401 bowersj2 8147: }
1.140 www 8148: my %metathesekeys=();
1.73 www 8149: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 8150: my $metastring;
1.924 albertel 8151: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929 albertel 8152: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 8153: $metastring =
1.929 albertel 8154: &Apache::lonnet::ssi_body($which,
1.924 albertel 8155: ('grade_target' => 'meta'));
8156: $cachetime = 1; # only want this cached in the child not long term
8157: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 8158: my $file=&filelocation('',&clutter($filename));
1.599 albertel 8159: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 8160: $metastring=&getfile($file);
1.489 albertel 8161: }
1.208 albertel 8162: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 8163: my $token;
1.140 www 8164: undef %metathesekeys;
1.71 www 8165: while ($token=$parser->get_token) {
1.339 albertel 8166: if ($token->[0] eq 'S') {
8167: if (defined($token->[2]->{'package'})) {
1.172 www 8168: #
8169: # This is a package - get package info
8170: #
1.339 albertel 8171: my $package=$token->[2]->{'package'};
8172: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8173: if (defined($token->[2]->{'id'})) {
8174: $keyroot.='_'.$token->[2]->{'id'};
8175: }
1.599 albertel 8176: if ($metaentry{':packages'}) {
8177: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 8178: } else {
1.599 albertel 8179: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 8180: }
1.736 albertel 8181: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 8182: my $part=$keyroot;
8183: $part=~s/^\_//;
1.736 albertel 8184: if ($pack_entry=~/^\Q$package\E\&/ ||
8185: $pack_entry=~/^\Q$package\E_0\&/) {
8186: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 8187: # ignore package.tab specified default values
8188: # here &package_tab_default() will fetch those
8189: if ($subp eq 'default') { next; }
1.736 albertel 8190: my $value=$packagetab{$pack_entry};
1.432 albertel 8191: my $unikey;
8192: if ($pack =~ /_0$/) {
8193: $unikey='parameter_0_'.$name;
8194: $part=0;
8195: } else {
8196: $unikey='parameter'.$keyroot.'_'.$name;
8197: }
1.339 albertel 8198: if ($subp eq 'display') {
8199: $value.=' [Part: '.$part.']';
8200: }
1.599 albertel 8201: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 8202: $metathesekeys{$unikey}=1;
1.599 albertel 8203: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8204: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 8205: }
1.599 albertel 8206: if (defined($metaentry{':'.$unikey.'.default'})) {
8207: $metaentry{':'.$unikey}=
8208: $metaentry{':'.$unikey.'.default'};
1.356 albertel 8209: }
1.339 albertel 8210: }
8211: }
8212: } else {
1.172 www 8213: #
8214: # This is not a package - some other kind of start tag
1.339 albertel 8215: #
8216: my $entry=$token->[1];
8217: my $unikey;
8218: if ($entry eq 'import') {
8219: $unikey='';
8220: } else {
8221: $unikey=$entry;
8222: }
8223: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8224:
8225: if (defined($token->[2]->{'id'})) {
8226: $unikey.='_'.$token->[2]->{'id'};
8227: }
1.175 www 8228:
1.339 albertel 8229: if ($entry eq 'import') {
1.175 www 8230: #
8231: # Importing a library here
1.339 albertel 8232: #
8233: if ($depthcount<20) {
8234: my $location=$parser->get_text('/import');
8235: my $dir=$filename;
8236: $dir=~s|[^/]*$||;
8237: $location=&filelocation($dir,$location);
1.736 albertel 8238: my $metadata =
8239: &metadata($uri,'keys', $location,$unikey,
8240: $depthcount+1);
8241: foreach my $meta (split(',',$metadata)) {
8242: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8243: $metathesekeys{$meta}=1;
1.339 albertel 8244: }
8245: }
8246: } else {
8247:
8248: if (defined($token->[2]->{'name'})) {
8249: $unikey.='_'.$token->[2]->{'name'};
8250: }
8251: $metathesekeys{$unikey}=1;
1.736 albertel 8252: foreach my $param (@{$token->[3]}) {
8253: $metaentry{':'.$unikey.'.'.$param} =
8254: $token->[2]->{$param};
1.339 albertel 8255: }
8256: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 8257: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 8258: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8259: # only ws inside the tag, and not in default, so use default
8260: # as value
1.599 albertel 8261: $metaentry{':'.$unikey}=$default;
1.908 albertel 8262: } elsif ( $internaltext =~ /\S/ ) {
8263: # something interesting inside the tag
8264: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 8265: } else {
1.908 albertel 8266: # no interesting values, don't set a default
1.339 albertel 8267: }
1.172 www 8268: # end of not-a-package not-a-library import
1.339 albertel 8269: }
1.172 www 8270: # end of not-a-package start tag
1.339 albertel 8271: }
1.172 www 8272: # the next is the end of "start tag"
1.339 albertel 8273: }
8274: }
1.483 albertel 8275: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 8276: $extension = lc($extension);
8277: if ($extension eq 'htm') { $extension='html'; }
8278:
1.737 albertel 8279: foreach my $key (keys(%packagetab)) {
1.483 albertel 8280: #no specific packages #how's our extension
8281: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 8282: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 8283: \%metathesekeys);
8284: }
1.883 albertel 8285:
8286: if (!exists($metaentry{':packages'})
8287: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 8288: foreach my $key (keys(%packagetab)) {
1.483 albertel 8289: #no specific packages well let's get default then
8290: if ($key!~/^default&/) { next; }
1.488 albertel 8291: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 8292: \%metathesekeys);
8293: }
8294: }
1.338 www 8295: # are there custom rights to evaluate
1.599 albertel 8296: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 8297:
1.338 www 8298: #
8299: # Importing a rights file here
1.339 albertel 8300: #
8301: unless ($depthcount) {
1.599 albertel 8302: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 8303: my $dir=$filename;
8304: $dir=~s|[^/]*$||;
8305: $location=&filelocation($dir,$location);
1.736 albertel 8306: my $rights_metadata =
8307: &metadata($uri,'keys',$location,'_rights',
8308: $depthcount+1);
8309: foreach my $rights (split(',',$rights_metadata)) {
8310: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8311: $metathesekeys{$rights}=1;
1.339 albertel 8312: }
8313: }
8314: }
1.737 albertel 8315: # uniqifiy package listing
8316: my %seen;
8317: my @uniq_packages =
8318: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8319: $metaentry{':packages'} = join(',',@uniq_packages);
8320:
8321: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 8322: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8323: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 8324: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 8325: # this is the end of "was not already recently cached
1.71 www 8326: }
1.599 albertel 8327: return $metaentry{':'.$what};
1.261 albertel 8328: }
8329:
1.488 albertel 8330: sub metadata_create_package_def {
1.483 albertel 8331: my ($uri,$key,$package,$metathesekeys)=@_;
8332: my ($pack,$name,$subp)=split(/\&/,$key);
8333: if ($subp eq 'default') { next; }
8334:
1.599 albertel 8335: if (defined($metaentry{':packages'})) {
8336: $metaentry{':packages'}.=','.$package;
1.483 albertel 8337: } else {
1.599 albertel 8338: $metaentry{':packages'}=$package;
1.483 albertel 8339: }
8340: my $value=$packagetab{$key};
8341: my $unikey;
8342: $unikey='parameter_0_'.$name;
1.599 albertel 8343: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 8344: $$metathesekeys{$unikey}=1;
1.599 albertel 8345: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8346: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 8347: }
1.599 albertel 8348: if (defined($metaentry{':'.$unikey.'.default'})) {
8349: $metaentry{':'.$unikey}=
8350: $metaentry{':'.$unikey.'.default'};
1.483 albertel 8351: }
8352: }
8353:
1.261 albertel 8354: sub metadata_generate_part0 {
8355: my ($metadata,$metacache,$uri) = @_;
8356: my %allnames;
1.737 albertel 8357: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 8358: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 8359: my $part=$$metacache{':'.$metakey.'.part'};
8360: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 8361: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 8362: $allnames{$name}=$part;
8363: }
8364: }
8365: }
8366: foreach my $name (keys(%allnames)) {
8367: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 8368: my $key=":parameter_0_$name";
1.261 albertel 8369: $$metacache{"$key.part"}='0';
8370: $$metacache{"$key.name"}=$name;
1.428 albertel 8371: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 8372: $allnames{$name}.'_'.$name.
8373: '.type'};
1.428 albertel 8374: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 8375: '.display'};
1.644 www 8376: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 8377: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 8378: $$metacache{"$key.display"}=$olddis;
8379: }
1.71 www 8380: }
8381:
1.764 albertel 8382: # ------------------------------------------------------ Devalidate title cache
8383:
8384: sub devalidate_title_cache {
8385: my ($url)=@_;
8386: if (!$env{'request.course.id'}) { return; }
8387: my $symb=&symbread($url);
8388: if (!$symb) { return; }
8389: my $key=$env{'request.course.id'}."\0".$symb;
8390: &devalidate_cache_new('title',$key);
8391: }
8392:
1.1014 droeschl 8393: # ------------------------------------------------- Get the title of a course
8394:
8395: sub current_course_title {
8396: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8397: }
1.301 www 8398: # ------------------------------------------------- Get the title of a resource
8399:
8400: sub gettitle {
8401: my $urlsymb=shift;
8402: my $symb=&symbread($urlsymb);
1.534 albertel 8403: if ($symb) {
1.620 albertel 8404: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 8405: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 8406: if (defined($cached)) {
8407: return $result;
8408: }
1.534 albertel 8409: my ($map,$resid,$url)=&decode_symb($symb);
8410: my $title='';
1.907 albertel 8411: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8412: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8413: } else {
8414: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8415: &GDBM_READER(),0640)) {
8416: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8417: $title=$bighash{'title_'.$mapid.'.'.$resid};
8418: untie(%bighash);
8419: }
1.534 albertel 8420: }
8421: $title=~s/\&colon\;/\:/gs;
8422: if ($title) {
1.599 albertel 8423: return &do_cache_new('title',$key,$title,600);
1.534 albertel 8424: }
8425: $urlsymb=$url;
8426: }
8427: my $title=&metadata($urlsymb,'title');
8428: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8429: return $title;
1.301 www 8430: }
1.613 albertel 8431:
1.614 albertel 8432: sub get_slot {
8433: my ($which,$cnum,$cdom)=@_;
8434: if (!$cnum || !$cdom) {
1.790 albertel 8435: (undef,my $courseid)=&whichuser();
1.620 albertel 8436: $cdom=$env{'course.'.$courseid.'.domain'};
8437: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 8438: }
1.703 albertel 8439: my $key=join("\0",'slots',$cdom,$cnum,$which);
8440: my %slotinfo;
8441: if (exists($remembered{$key})) {
8442: $slotinfo{$which} = $remembered{$key};
8443: } else {
8444: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8445: &Apache::lonhomework::showhash(%slotinfo);
8446: my ($tmp)=keys(%slotinfo);
8447: if ($tmp=~/^error:/) { return (); }
8448: $remembered{$key} = $slotinfo{$which};
8449: }
1.616 albertel 8450: if (ref($slotinfo{$which}) eq 'HASH') {
8451: return %{$slotinfo{$which}};
8452: }
8453: return $slotinfo{$which};
1.614 albertel 8454: }
1.31 www 8455: # ------------------------------------------------- Update symbolic store links
8456:
8457: sub symblist {
8458: my ($mapname,%newhash)=@_;
1.438 www 8459: $mapname=&deversion(&declutter($mapname));
1.31 www 8460: my %hash;
1.620 albertel 8461: if (($env{'request.course.fn'}) && (%newhash)) {
8462: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8463: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 8464: foreach my $url (keys(%newhash)) {
1.711 albertel 8465: next if ($url eq 'last_known'
8466: && $env{'form.no_update_last_known'});
8467: $hash{declutter($url)}=&encode_symb($mapname,
8468: $newhash{$url}->[1],
8469: $newhash{$url}->[0]);
1.191 harris41 8470: }
1.31 www 8471: if (untie(%hash)) {
8472: return 'ok';
8473: }
8474: }
8475: }
8476: return 'error';
1.212 www 8477: }
8478:
8479: # --------------------------------------------------------------- Verify a symb
8480:
8481: sub symbverify {
1.510 www 8482: my ($symb,$thisurl)=@_;
8483: my $thisfn=$thisurl;
1.439 www 8484: $thisfn=&declutter($thisfn);
1.215 www 8485: # direct jump to resource in page or to a sequence - will construct own symbs
8486: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8487: # check URL part
1.409 www 8488: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 8489:
1.431 www 8490: unless ($url eq $thisfn) { return 0; }
1.213 www 8491:
1.216 www 8492: $symb=&symbclean($symb);
1.510 www 8493: $thisurl=&deversion($thisurl);
1.439 www 8494: $thisfn=&deversion($thisfn);
1.213 www 8495:
8496: my %bighash;
8497: my $okay=0;
1.431 www 8498:
1.620 albertel 8499: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8500: &GDBM_READER(),0640)) {
1.1032 raeburn 8501: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8502: $thisurl =~ s/\?.+$//;
8503: }
1.510 www 8504: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 8505: unless ($ids) {
1.510 www 8506: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 8507: }
8508: if ($ids) {
8509: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 8510: foreach my $id (split(/\,/,$ids)) {
8511: my ($mapid,$resid)=split(/\./,$id);
1.1032 raeburn 8512: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8513: $symb =~ s/\?.+$//;
8514: }
1.216 www 8515: if (
8516: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8517: eq $symb) {
1.620 albertel 8518: if (($env{'request.role.adv'}) ||
1.800 albertel 8519: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 8520: $okay=1;
8521: }
8522: }
1.216 www 8523: }
8524: }
1.213 www 8525: untie(%bighash);
8526: }
8527: return $okay;
1.31 www 8528: }
8529:
1.210 www 8530: # --------------------------------------------------------------- Clean-up symb
8531:
8532: sub symbclean {
8533: my $symb=shift;
1.568 albertel 8534: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 8535: # remove version from map
8536: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 8537:
1.210 www 8538: # remove version from URL
8539: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 8540:
1.507 www 8541: # remove wrapper
8542:
1.510 www 8543: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 8544: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 8545: return $symb;
1.409 www 8546: }
8547:
8548: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 8549:
8550: sub encode_symb {
8551: my ($map,$resid,$url)=@_;
8552: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8553: }
1.409 www 8554:
8555: sub decode_symb {
1.568 albertel 8556: my $symb=shift;
8557: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8558: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 8559: return (&fixversion($map),$resid,&fixversion($url));
8560: }
8561:
8562: sub fixversion {
8563: my $fn=shift;
1.609 banghart 8564: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 8565: my %bighash;
8566: my $uri=&clutter($fn);
1.620 albertel 8567: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 8568: # is this cached?
1.599 albertel 8569: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 8570: if (defined($cached)) { return $result; }
8571: # unfortunately not cached, or expired
1.620 albertel 8572: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 8573: &GDBM_READER(),0640)) {
8574: if ($bighash{'version_'.$uri}) {
8575: my $version=$bighash{'version_'.$uri};
1.444 www 8576: unless (($version eq 'mostrecent') ||
8577: ($version==&getversion($uri))) {
1.440 www 8578: $uri=~s/\.(\w+)$/\.$version\.$1/;
8579: }
8580: }
8581: untie %bighash;
1.413 www 8582: }
1.599 albertel 8583: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 8584: }
8585:
8586: sub deversion {
8587: my $url=shift;
8588: $url=~s/\.\d+\.(\w+)$/\.$1/;
8589: return $url;
1.210 www 8590: }
8591:
1.31 www 8592: # ------------------------------------------------------ Return symb list entry
8593:
8594: sub symbread {
1.249 www 8595: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 8596: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 8597: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 8598: # no filename provided? try from environment
1.44 www 8599: unless ($thisfn) {
1.620 albertel 8600: if ($env{'request.symb'}) {
8601: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 8602: }
1.620 albertel 8603: $thisfn=$env{'request.filename'};
1.44 www 8604: }
1.569 albertel 8605: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 8606: # is that filename actually a symb? Verify, clean, and return
8607: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 8608: if (&symbverify($thisfn,$1)) {
1.620 albertel 8609: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 8610: }
1.242 www 8611: }
1.44 www 8612: $thisfn=declutter($thisfn);
1.31 www 8613: my %hash;
1.37 www 8614: my %bighash;
8615: my $syval='';
1.620 albertel 8616: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 8617: my $targetfn = $thisfn;
1.609 banghart 8618: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 8619: $targetfn = 'adm/wrapper/'.$thisfn;
8620: }
1.687 albertel 8621: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8622: $targetfn=$1;
8623: }
1.620 albertel 8624: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8625: &GDBM_READER(),0640)) {
1.481 raeburn 8626: $syval=$hash{$targetfn};
1.37 www 8627: untie(%hash);
8628: }
8629: # ---------------------------------------------------------- There was an entry
8630: if ($syval) {
1.601 albertel 8631: #unless ($syval=~/\_\d+$/) {
1.620 albertel 8632: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 8633: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8634: #return $env{$cache_str}='';
1.601 albertel 8635: #}
8636: #$syval.=$1;
8637: #}
1.37 www 8638: } else {
8639: # ------------------------------------------------------- Was not in symb table
1.620 albertel 8640: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8641: &GDBM_READER(),0640)) {
1.37 www 8642: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 8643: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 8644: unless ($ids) {
8645: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 8646: }
8647: unless ($ids) {
8648: # alias?
8649: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 8650: }
1.37 www 8651: if ($ids) {
8652: # ------------------------------------------------------------------- Has ID(s)
8653: my @possibilities=split(/\,/,$ids);
1.39 www 8654: if ($#possibilities==0) {
8655: # ----------------------------------------------- There is only one possibility
1.37 www 8656: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 8657: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8658: $resid,$thisfn);
1.249 www 8659: } elsif (!$donotrecurse) {
1.39 www 8660: # ------------------------------------------ There is more than one possibility
8661: my $realpossible=0;
1.800 albertel 8662: foreach my $id (@possibilities) {
8663: my $file=$bighash{'src_'.$id};
1.39 www 8664: if (&allowed('bre',$file)) {
1.800 albertel 8665: my ($mapid,$resid)=split(/\./,$id);
1.39 www 8666: if ($bighash{'map_type_'.$mapid} ne 'page') {
8667: $realpossible++;
1.626 albertel 8668: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8669: $resid,$thisfn);
1.39 www 8670: }
8671: }
1.191 harris41 8672: }
1.39 www 8673: if ($realpossible!=1) { $syval=''; }
1.249 www 8674: } else {
8675: $syval='';
1.37 www 8676: }
8677: }
8678: untie(%bighash)
1.481 raeburn 8679: }
1.31 www 8680: }
1.62 www 8681: if ($syval) {
1.620 albertel 8682: return $env{$cache_str}=$syval;
1.62 www 8683: }
1.31 www 8684: }
1.949 raeburn 8685: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8686: return $env{$cache_str}='';
1.31 www 8687: }
8688:
8689: # ---------------------------------------------------------- Return random seed
8690:
1.32 www 8691: sub numval {
8692: my $txt=shift;
8693: $txt=~tr/A-J/0-9/;
8694: $txt=~tr/a-j/0-9/;
8695: $txt=~tr/K-T/0-9/;
8696: $txt=~tr/k-t/0-9/;
8697: $txt=~tr/U-Z/0-5/;
8698: $txt=~tr/u-z/0-5/;
8699: $txt=~s/\D//g;
1.564 albertel 8700: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 8701: return int($txt);
1.368 albertel 8702: }
8703:
1.484 albertel 8704: sub numval2 {
8705: my $txt=shift;
8706: $txt=~tr/A-J/0-9/;
8707: $txt=~tr/a-j/0-9/;
8708: $txt=~tr/K-T/0-9/;
8709: $txt=~tr/k-t/0-9/;
8710: $txt=~tr/U-Z/0-5/;
8711: $txt=~tr/u-z/0-5/;
8712: $txt=~s/\D//g;
8713: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8714: my $total;
8715: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 8716: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 8717: return int($total);
8718: }
8719:
1.575 albertel 8720: sub numval3 {
8721: use integer;
8722: my $txt=shift;
8723: $txt=~tr/A-J/0-9/;
8724: $txt=~tr/a-j/0-9/;
8725: $txt=~tr/K-T/0-9/;
8726: $txt=~tr/k-t/0-9/;
8727: $txt=~tr/U-Z/0-5/;
8728: $txt=~tr/u-z/0-5/;
8729: $txt=~s/\D//g;
8730: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8731: my $total;
8732: foreach my $val (@txts) { $total+=$val; }
8733: if ($_64bit) { $total=(($total<<32)>>32); }
8734: return $total;
8735: }
8736:
1.675 albertel 8737: sub digest {
8738: my ($data)=@_;
8739: my $digest=&Digest::MD5::md5($data);
8740: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8741: my ($e,$f);
8742: {
8743: use integer;
8744: $e=($a+$b);
8745: $f=($c+$d);
8746: if ($_64bit) {
8747: $e=(($e<<32)>>32);
8748: $f=(($f<<32)>>32);
8749: }
8750: }
8751: if (wantarray) {
8752: return ($e,$f);
8753: } else {
8754: my $g;
8755: {
8756: use integer;
8757: $g=($e+$f);
8758: if ($_64bit) {
8759: $g=(($g<<32)>>32);
8760: }
8761: }
8762: return $g;
8763: }
8764: }
8765:
1.368 albertel 8766: sub latest_rnd_algorithm_id {
1.675 albertel 8767: return '64bit5';
1.366 albertel 8768: }
1.32 www 8769:
1.503 albertel 8770: sub get_rand_alg {
8771: my ($courseid)=@_;
1.790 albertel 8772: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 8773: if ($courseid) {
1.620 albertel 8774: return $env{"course.$courseid.rndseed"};
1.503 albertel 8775: }
8776: return &latest_rnd_algorithm_id();
8777: }
8778:
1.562 albertel 8779: sub validCODE {
8780: my ($CODE)=@_;
8781: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8782: return 0;
8783: }
8784:
1.491 albertel 8785: sub getCODE {
1.620 albertel 8786: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 8787: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8788: defined($Apache::lonhomework::parsing_a_task) ) &&
8789: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 8790: return $Apache::lonhomework::history{'resource.CODE'};
8791: }
8792: return undef;
8793: }
8794:
1.31 www 8795: sub rndseed {
1.155 albertel 8796: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 8797: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 8798: if (!defined($symb)) {
1.366 albertel 8799: unless ($symb=$wsymb) { return time; }
8800: }
8801: if (!$courseid) { $courseid=$wcourseid; }
8802: if (!$domain) { $domain=$wdomain; }
8803: if (!$username) { $username=$wusername }
1.503 albertel 8804: my $which=&get_rand_alg();
1.803 albertel 8805:
1.491 albertel 8806: if (defined(&getCODE())) {
1.675 albertel 8807: if ($which eq '64bit5') {
8808: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8809: } elsif ($which eq '64bit4') {
1.575 albertel 8810: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8811: } else {
8812: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8813: }
1.675 albertel 8814: } elsif ($which eq '64bit5') {
8815: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 8816: } elsif ($which eq '64bit4') {
8817: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 8818: } elsif ($which eq '64bit3') {
8819: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 8820: } elsif ($which eq '64bit2') {
8821: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 8822: } elsif ($which eq '64bit') {
8823: return &rndseed_64bit($symb,$courseid,$domain,$username);
8824: }
8825: return &rndseed_32bit($symb,$courseid,$domain,$username);
8826: }
8827:
8828: sub rndseed_32bit {
8829: my ($symb,$courseid,$domain,$username)=@_;
8830: {
8831: use integer;
8832: my $symbchck=unpack("%32C*",$symb) << 27;
8833: my $symbseed=numval($symb) << 22;
8834: my $namechck=unpack("%32C*",$username) << 17;
8835: my $nameseed=numval($username) << 12;
8836: my $domainseed=unpack("%32C*",$domain) << 7;
8837: my $courseseed=unpack("%32C*",$courseid);
8838: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 8839: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8840: #&logthis("rndseed :$num:$symb");
1.564 albertel 8841: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 8842: return $num;
8843: }
8844: }
8845:
8846: sub rndseed_64bit {
8847: my ($symb,$courseid,$domain,$username)=@_;
8848: {
8849: use integer;
8850: my $symbchck=unpack("%32S*",$symb) << 21;
8851: my $symbseed=numval($symb) << 10;
8852: my $namechck=unpack("%32S*",$username);
8853:
8854: my $nameseed=numval($username) << 21;
8855: my $domainseed=unpack("%32S*",$domain) << 10;
8856: my $courseseed=unpack("%32S*",$courseid);
8857:
8858: my $num1=$symbchck+$symbseed+$namechck;
8859: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8860: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8861: #&logthis("rndseed :$num:$symb");
1.564 albertel 8862: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 8863: return "$num1,$num2";
1.155 albertel 8864: }
1.366 albertel 8865: }
8866:
1.443 albertel 8867: sub rndseed_64bit2 {
8868: my ($symb,$courseid,$domain,$username)=@_;
8869: {
8870: use integer;
8871: # strings need to be an even # of cahracters long, it it is odd the
8872: # last characters gets thrown away
8873: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8874: my $symbseed=numval($symb) << 10;
8875: my $namechck=unpack("%32S*",$username.' ');
8876:
8877: my $nameseed=numval($username) << 21;
1.501 albertel 8878: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8879: my $courseseed=unpack("%32S*",$courseid.' ');
8880:
8881: my $num1=$symbchck+$symbseed+$namechck;
8882: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8883: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8884: #&logthis("rndseed :$num:$symb");
1.803 albertel 8885: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 8886: return "$num1,$num2";
8887: }
8888: }
8889:
8890: sub rndseed_64bit3 {
8891: my ($symb,$courseid,$domain,$username)=@_;
8892: {
8893: use integer;
8894: # strings need to be an even # of cahracters long, it it is odd the
8895: # last characters gets thrown away
8896: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8897: my $symbseed=numval2($symb) << 10;
8898: my $namechck=unpack("%32S*",$username.' ');
8899:
8900: my $nameseed=numval2($username) << 21;
1.443 albertel 8901: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8902: my $courseseed=unpack("%32S*",$courseid.' ');
8903:
8904: my $num1=$symbchck+$symbseed+$namechck;
8905: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8906: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8907: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 8908: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8909:
1.503 albertel 8910: return "$num1:$num2";
1.443 albertel 8911: }
8912: }
8913:
1.575 albertel 8914: sub rndseed_64bit4 {
8915: my ($symb,$courseid,$domain,$username)=@_;
8916: {
8917: use integer;
8918: # strings need to be an even # of cahracters long, it it is odd the
8919: # last characters gets thrown away
8920: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8921: my $symbseed=numval3($symb) << 10;
8922: my $namechck=unpack("%32S*",$username.' ');
8923:
8924: my $nameseed=numval3($username) << 21;
8925: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8926: my $courseseed=unpack("%32S*",$courseid.' ');
8927:
8928: my $num1=$symbchck+$symbseed+$namechck;
8929: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8930: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8931: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 8932: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8933:
8934: return "$num1:$num2";
8935: }
8936: }
8937:
1.675 albertel 8938: sub rndseed_64bit5 {
8939: my ($symb,$courseid,$domain,$username)=@_;
8940: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8941: return "$num1:$num2";
8942: }
8943:
1.366 albertel 8944: sub rndseed_CODE_64bit {
8945: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 8946: {
1.366 albertel 8947: use integer;
1.443 albertel 8948: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 8949: my $symbseed=numval2($symb);
1.491 albertel 8950: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8951: my $CODEseed=numval(&getCODE());
1.443 albertel 8952: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 8953: my $num1=$symbseed+$CODEchck;
8954: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8955: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8956: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 8957: if ($_64bit) { $num1=(($num1<<32)>>32); }
8958: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 8959: return "$num1:$num2";
1.366 albertel 8960: }
8961: }
8962:
1.575 albertel 8963: sub rndseed_CODE_64bit4 {
8964: my ($symb,$courseid,$domain,$username)=@_;
8965: {
8966: use integer;
8967: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8968: my $symbseed=numval3($symb);
8969: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8970: my $CODEseed=numval3(&getCODE());
8971: my $courseseed=unpack("%32S*",$courseid.' ');
8972: my $num1=$symbseed+$CODEchck;
8973: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8974: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8975: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 8976: if ($_64bit) { $num1=(($num1<<32)>>32); }
8977: if ($_64bit) { $num2=(($num2<<32)>>32); }
8978: return "$num1:$num2";
8979: }
8980: }
8981:
1.675 albertel 8982: sub rndseed_CODE_64bit5 {
8983: my ($symb,$courseid,$domain,$username)=@_;
8984: my $code = &getCODE();
8985: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8986: return "$num1:$num2";
8987: }
8988:
1.366 albertel 8989: sub setup_random_from_rndseed {
8990: my ($rndseed)=@_;
1.503 albertel 8991: if ($rndseed =~/([,:])/) {
8992: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 8993: &Math::Random::random_set_seed(abs($num1),abs($num2));
8994: } else {
8995: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 8996: }
1.36 albertel 8997: }
8998:
1.474 albertel 8999: sub latest_receipt_algorithm_id {
1.835 albertel 9000: return 'receipt3';
1.474 albertel 9001: }
9002:
1.480 www 9003: sub recunique {
9004: my $fucourseid=shift;
9005: my $unique;
1.835 albertel 9006: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9007: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9008: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 9009: } else {
9010: $unique=$perlvar{'lonReceipt'};
9011: }
9012: return unpack("%32C*",$unique);
9013: }
9014:
9015: sub recprefix {
9016: my $fucourseid=shift;
9017: my $prefix;
1.835 albertel 9018: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9019: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9020: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 9021: } else {
9022: $prefix=$perlvar{'lonHostID'};
9023: }
9024: return unpack("%32C*",$prefix);
9025: }
9026:
1.76 www 9027: sub ireceipt {
1.474 albertel 9028: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 9029:
9030: my $return =&recprefix($fucourseid).'-';
9031:
9032: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9033: $env{'request.state'} eq 'construct') {
9034: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9035: return $return;
9036: }
9037:
1.76 www 9038: my $cuname=unpack("%32C*",$funame);
9039: my $cudom=unpack("%32C*",$fudom);
9040: my $cucourseid=unpack("%32C*",$fucourseid);
9041: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 9042: my $cunique=&recunique($fucourseid);
1.474 albertel 9043: my $cpart=unpack("%32S*",$part);
1.835 albertel 9044: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9045:
1.790 albertel 9046: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 9047:
9048: $return.= ($cunique%$cuname+
9049: $cunique%$cudom+
9050: $cusymb%$cuname+
9051: $cusymb%$cudom+
9052: $cucourseid%$cuname+
9053: $cucourseid%$cudom+
9054: $cpart%$cuname+
9055: $cpart%$cudom);
9056: } else {
9057: $return.= ($cunique%$cuname+
9058: $cunique%$cudom+
9059: $cusymb%$cuname+
9060: $cusymb%$cudom+
9061: $cucourseid%$cuname+
9062: $cucourseid%$cudom);
9063: }
9064: return $return;
1.76 www 9065: }
9066:
9067: sub receipt {
1.474 albertel 9068: my ($part)=@_;
1.790 albertel 9069: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 9070: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 9071: }
1.260 ng 9072:
1.790 albertel 9073: sub whichuser {
9074: my ($passedsymb)=@_;
9075: my ($symb,$courseid,$domain,$name,$publicuser);
9076: if (defined($env{'form.grade_symb'})) {
9077: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9078: my $allowed=&allowed('vgr',$tmp_courseid);
9079: if (!$allowed &&
9080: exists($env{'request.course.sec'}) &&
9081: $env{'request.course.sec'} !~ /^\s*$/) {
9082: $allowed=&allowed('vgr',$tmp_courseid.
9083: '/'.$env{'request.course.sec'});
9084: }
9085: if ($allowed) {
9086: ($symb)=&get_env_multiple('form.grade_symb');
9087: $courseid=$tmp_courseid;
9088: ($domain)=&get_env_multiple('form.grade_domain');
9089: ($name)=&get_env_multiple('form.grade_username');
9090: return ($symb,$courseid,$domain,$name,$publicuser);
9091: }
9092: }
9093: if (!$passedsymb) {
9094: $symb=&symbread();
9095: } else {
9096: $symb=$passedsymb;
9097: }
9098: $courseid=$env{'request.course.id'};
9099: $domain=$env{'user.domain'};
9100: $name=$env{'user.name'};
9101: if ($name eq 'public' && $domain eq 'public') {
9102: if (!defined($env{'form.username'})) {
9103: $env{'form.username'}.=time.rand(10000000);
9104: }
9105: $name.=$env{'form.username'};
9106: }
9107: return ($symb,$courseid,$domain,$name,$publicuser);
9108:
9109: }
9110:
1.36 albertel 9111: # ------------------------------------------------------------ Serves up a file
1.472 albertel 9112: # returns either the contents of the file or
9113: # -1 if the file doesn't exist
1.481 raeburn 9114: #
9115: # if the target is a file that was uploaded via DOCS,
9116: # a check will be made to see if a current copy exists on the local server,
9117: # if it does this will be served, otherwise a copy will be retrieved from
9118: # the home server for the course and stored in /home/httpd/html/userfiles on
9119: # the local server.
1.472 albertel 9120:
1.36 albertel 9121: sub getfile {
1.538 albertel 9122: my ($file) = @_;
1.609 banghart 9123: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 9124: &repcopy($file);
9125: return &readfile($file);
9126: }
9127:
9128: sub repcopy_userfile {
9129: my ($file)=@_;
1.609 banghart 9130: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 9131: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 9132: my ($cdom,$cnum,$filename) =
1.811 albertel 9133: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 9134: my $uri="/uploaded/$cdom/$cnum/$filename";
9135: if (-e "$file") {
1.828 www 9136: # we already have a local copy, check it out
1.538 albertel 9137: my @fileinfo = stat($file);
1.828 www 9138: my $rtncode;
9139: my $info;
1.538 albertel 9140: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 9141: if ($lwpresp ne 'ok') {
1.828 www 9142: # there is no such file anymore, even though we had a local copy
1.482 albertel 9143: if ($rtncode eq '404') {
1.538 albertel 9144: unlink($file);
1.482 albertel 9145: }
9146: return -1;
9147: }
9148: if ($info < $fileinfo[9]) {
1.828 www 9149: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 9150: return 'ok';
1.828 www 9151: } else {
9152: # the file is outdated, get rid of it
9153: unlink($file);
1.482 albertel 9154: }
1.828 www 9155: }
9156: # one way or the other, at this point, we don't have the file
9157: # construct the correct path for the file
9158: my @parts = ($cdom,$cnum);
9159: if ($filename =~ m|^(.+)/[^/]+$|) {
9160: push @parts, split(/\//,$1);
9161: }
9162: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9163: foreach my $part (@parts) {
9164: $path .= '/'.$part;
9165: if (!-e $path) {
9166: mkdir($path,0770);
1.482 albertel 9167: }
9168: }
1.828 www 9169: # now the path exists for sure
9170: # get a user agent
9171: my $ua=new LWP::UserAgent;
9172: my $transferfile=$file.'.in.transfer';
9173: # FIXME: this should flock
9174: if (-e $transferfile) { return 'ok'; }
9175: my $request;
9176: $uri=~s/^\///;
1.980 raeburn 9177: my $homeserver = &homeserver($cnum,$cdom);
9178: my $protocol = $protocol{$homeserver};
9179: $protocol = 'http' if ($protocol ne 'https');
9180: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 9181: my $response=$ua->request($request,$transferfile);
9182: # did it work?
9183: if ($response->is_error()) {
9184: unlink($transferfile);
9185: &logthis("Userfile repcopy failed for $uri");
9186: return -1;
9187: }
9188: # worked, rename the transfer file
9189: rename($transferfile,$file);
1.607 raeburn 9190: return 'ok';
1.481 raeburn 9191: }
9192:
1.517 albertel 9193: sub tokenwrapper {
9194: my $uri=shift;
1.980 raeburn 9195: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 9196: $uri=~s|^/||;
1.620 albertel 9197: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 9198: my $token=$1;
1.552 albertel 9199: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9200: if ($udom && $uname && $file) {
9201: $file=~s|(\?\.*)*$||;
1.949 raeburn 9202: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 9203: my $homeserver = &homeserver($uname,$udom);
9204: my $protocol = $protocol{$homeserver};
9205: $protocol = 'http' if ($protocol ne 'https');
9206: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 9207: (($uri=~/\?/)?'&':'?').'token='.$token.
9208: '&tokenissued='.$perlvar{'lonHostID'};
9209: } else {
9210: return '/adm/notfound.html';
9211: }
9212: }
9213:
1.828 www 9214: # call with reqtype HEAD: get last modification time
9215: # call with reqtype GET: get the file contents
9216: # Do not call this with reqtype GET for large files! It loads everything into memory
9217: #
1.481 raeburn 9218: sub getuploaded {
9219: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9220: $uri=~s/^\///;
1.980 raeburn 9221: my $homeserver = &homeserver($cnum,$cdom);
9222: my $protocol = $protocol{$homeserver};
9223: $protocol = 'http' if ($protocol ne 'https');
9224: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 9225: my $ua=new LWP::UserAgent;
9226: my $request=new HTTP::Request($reqtype,$uri);
9227: my $response=$ua->request($request);
9228: $$rtncode = $response->code;
1.482 albertel 9229: if (! $response->is_success()) {
9230: return 'failed';
9231: }
9232: if ($reqtype eq 'HEAD') {
1.486 www 9233: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 9234: } elsif ($reqtype eq 'GET') {
9235: $$info = $response->content;
1.472 albertel 9236: }
1.482 albertel 9237: return 'ok';
1.36 albertel 9238: }
9239:
1.481 raeburn 9240: sub readfile {
9241: my $file = shift;
9242: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9243: my $fh;
9244: open($fh,"<$file");
9245: my $a='';
1.800 albertel 9246: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 9247: return $a;
9248: }
9249:
1.36 albertel 9250: sub filelocation {
1.590 banghart 9251: my ($dir,$file) = @_;
9252: my $location;
9253: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 9254:
9255: if ($file =~ m-^/adm/-) {
9256: $file=~s-^/adm/wrapper/-/-;
9257: $file=~s-^/adm/coursedocs/showdoc/-/-;
9258: }
1.882 albertel 9259:
1.590 banghart 9260: if ($file=~m:^/~:) { # is a contruction space reference
9261: $location = $file;
9262: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 9263: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 9264: # is a correct contruction space reference
9265: $location = $file;
1.956 raeburn 9266: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9267: $location = $file;
1.609 banghart 9268: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 9269: my ($udom,$uname,$filename)=
1.811 albertel 9270: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 9271: my $home=&homeserver($uname,$udom);
9272: my $is_me=0;
9273: my @ids=¤t_machine_ids();
9274: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9275: if ($is_me) {
1.955 raeburn 9276: $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 9277: } else {
9278: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9279: $udom.'/'.$uname.'/'.$filename;
9280: }
1.882 albertel 9281: } elsif ($file =~ m-^/adm/-) {
9282: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 9283: } else {
9284: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9285: $file=~s:^/res/:/:;
9286: if ( !( $file =~ m:^/:) ) {
9287: $location = $dir. '/'.$file;
9288: } else {
9289: $location = '/home/httpd/html/res'.$file;
9290: }
1.59 albertel 9291: }
1.590 banghart 9292: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 9293: while ($location=~m{/\.\./}) {
9294: if ($location =~ m{/[^/]+/\.\./}) {
9295: $location=~ s{/[^/]+/\.\./}{/}g;
9296: } else {
9297: $location=~ s{/\.\./}{/}g;
9298: }
9299: } #remove dir/..
1.590 banghart 9300: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9301: return $location;
1.46 www 9302: }
1.36 albertel 9303:
1.46 www 9304: sub hreflocation {
9305: my ($dir,$file)=@_;
1.980 raeburn 9306: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 9307: $file=filelocation($dir,$file);
1.700 albertel 9308: } elsif ($file=~m-^/adm/-) {
9309: $file=~s-^/adm/wrapper/-/-;
9310: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 9311: }
9312: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9313: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 9314: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9315: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 9316: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 9317: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 9318: -/uploaded/$1/$2/-x;
1.46 www 9319: }
1.913 albertel 9320: if ($file=~ m{^/userfiles/}) {
9321: $file =~ s{^/userfiles/}{/uploaded/};
9322: }
1.462 albertel 9323: return $file;
1.465 albertel 9324: }
9325:
9326: sub current_machine_domains {
1.853 albertel 9327: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9328: }
9329:
9330: sub machine_domains {
9331: my ($hostname) = @_;
1.465 albertel 9332: my @domains;
1.838 albertel 9333: my %hostname = &all_hostnames();
1.465 albertel 9334: while( my($id, $name) = each(%hostname)) {
1.467 matthew 9335: # &logthis("-$id-$name-$hostname-");
1.465 albertel 9336: if ($hostname eq $name) {
1.844 albertel 9337: push(@domains,&host_domain($id));
1.465 albertel 9338: }
9339: }
9340: return @domains;
9341: }
9342:
9343: sub current_machine_ids {
1.853 albertel 9344: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9345: }
9346:
9347: sub machine_ids {
9348: my ($hostname) = @_;
9349: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 9350: my @ids;
1.888 albertel 9351: my %name_to_host = &all_names();
1.889 albertel 9352: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9353: return @{ $name_to_host{$hostname} };
9354: }
9355: return;
1.31 www 9356: }
9357:
1.824 raeburn 9358: sub additional_machine_domains {
9359: my @domains;
9360: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9361: while( my $line = <$fh>) {
9362: $line =~ s/\s//g;
9363: push(@domains,$line);
9364: }
9365: return @domains;
9366: }
9367:
9368: sub default_login_domain {
9369: my $domain = $perlvar{'lonDefDomain'};
9370: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9371: foreach my $posdom (¤t_machine_domains(),
9372: &additional_machine_domains()) {
9373: if (lc($posdom) eq lc($testdomain)) {
9374: $domain=$posdom;
9375: last;
9376: }
9377: }
9378: return $domain;
9379: }
9380:
1.31 www 9381: # ------------------------------------------------------------- Declutters URLs
9382:
9383: sub declutter {
9384: my $thisfn=shift;
1.569 albertel 9385: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 9386: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 9387: $thisfn=~s/^\///;
1.697 albertel 9388: $thisfn=~s|^adm/wrapper/||;
9389: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 9390: $thisfn=~s/^res\///;
1.1032 raeburn 9391: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9392: $thisfn=~s/\?.+$//;
9393: }
1.268 www 9394: return $thisfn;
9395: }
9396:
9397: # ------------------------------------------------------------- Clutter up URLs
9398:
9399: sub clutter {
9400: my $thisfn='/'.&declutter(shift);
1.887 albertel 9401: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 9402: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 9403: $thisfn='/res'.$thisfn;
9404: }
1.1031 raeburn 9405: if ($thisfn !~m|^/adm|) {
9406: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 9407: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 9408: } else {
9409: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9410: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 9411: if ($embstyle eq 'ssi'
9412: || ($embstyle eq 'hdn')
9413: || ($embstyle eq 'rat')
9414: || ($embstyle eq 'prv')
9415: || ($embstyle eq 'ign')) {
9416: #do nothing with these
9417: } elsif (($embstyle eq 'img')
1.695 albertel 9418: || ($embstyle eq 'emb')
9419: || ($embstyle eq 'wrp')) {
9420: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 9421: } elsif ($embstyle eq 'unk'
9422: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 9423: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 9424: } else {
1.718 www 9425: # &logthis("Got a blank emb style");
1.695 albertel 9426: }
1.694 albertel 9427: }
9428: }
1.31 www 9429: return $thisfn;
1.12 www 9430: }
9431:
1.787 albertel 9432: sub clutter_with_no_wrapper {
9433: my $uri = &clutter(shift);
9434: if ($uri =~ m-^/adm/-) {
9435: $uri =~ s-^/adm/wrapper/-/-;
9436: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9437: }
9438: return $uri;
9439: }
9440:
1.557 albertel 9441: sub freeze_escape {
9442: my ($value)=@_;
9443: if (ref($value)) {
9444: $value=&nfreeze($value);
9445: return '__FROZEN__'.&escape($value);
9446: }
9447: return &escape($value);
9448: }
9449:
1.11 www 9450:
1.557 albertel 9451: sub thaw_unescape {
9452: my ($value)=@_;
9453: if ($value =~ /^__FROZEN__/) {
9454: substr($value,0,10,undef);
9455: $value=&unescape($value);
9456: return &thaw($value);
9457: }
9458: return &unescape($value);
9459: }
9460:
1.436 albertel 9461: sub correct_line_ends {
9462: my ($result)=@_;
9463: $$result =~s/\r\n/\n/mg;
9464: $$result =~s/\r/\n/mg;
1.415 albertel 9465: }
1.1 albertel 9466: # ================================================================ Main Program
9467:
1.184 www 9468: sub goodbye {
1.204 albertel 9469: &logthis("Starting Shut down");
1.443 albertel 9470: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 9471: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 9472: #converted
1.599 albertel 9473: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 9474: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9475: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9476: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 9477: #1.1 only
1.870 albertel 9478: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9479: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9480: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9481: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9482: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 9483: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9484: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 9485: &flushcourselogs();
9486: &logthis("Shutting down");
9487: }
9488:
1.852 albertel 9489: sub get_dns {
1.869 albertel 9490: my ($url,$func,$ignore_cache) = @_;
9491: if (!$ignore_cache) {
9492: my ($content,$cached)=
9493: &Apache::lonnet::is_cached_new('dns',$url);
9494: if ($cached) {
9495: &$func($content);
9496: return;
9497: }
9498: }
9499:
9500: my %alldns;
1.852 albertel 9501: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9502: foreach my $dns (<$config>) {
9503: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 9504: my $line = $1;
9505: my ($host,$protocol) = split(/:/,$line);
9506: if ($protocol ne 'https') {
9507: $protocol = 'http';
9508: }
9509: $alldns{$host} = $protocol;
1.869 albertel 9510: }
9511: while (%alldns) {
9512: my ($dns) = keys(%alldns);
1.852 albertel 9513: my $ua=new LWP::UserAgent;
1.979 raeburn 9514: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 9515: my $response=$ua->request($request);
1.979 raeburn 9516: delete($alldns{$dns});
1.852 albertel 9517: next if ($response->is_error());
9518: my @content = split("\n",$response->content);
1.869 albertel 9519: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 9520: &$func(\@content);
1.869 albertel 9521: return;
1.852 albertel 9522: }
9523: close($config);
1.871 albertel 9524: my $which = (split('/',$url))[3];
9525: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9526: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 9527: my @content = <$config>;
9528: &$func(\@content);
9529: return;
1.852 albertel 9530: }
1.327 albertel 9531: # ------------------------------------------------------------ Read domain file
9532: {
1.852 albertel 9533: my $loaded;
1.846 albertel 9534: my %domain;
9535:
1.852 albertel 9536: sub parse_domain_tab {
9537: my ($lines) = @_;
9538: foreach my $line (@$lines) {
9539: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 9540:
1.846 albertel 9541: chomp($line);
1.852 albertel 9542: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 9543: my %this_domain;
9544: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9545: 'lang_def', 'city', 'longi', 'lati',
9546: 'primary') {
9547: $this_domain{$field} = shift(@elements);
9548: }
9549: $domain{$name} = \%this_domain;
1.852 albertel 9550: }
9551: }
1.864 albertel 9552:
9553: sub reset_domain_info {
9554: undef($loaded);
9555: undef(%domain);
9556: }
9557:
1.852 albertel 9558: sub load_domain_tab {
1.869 albertel 9559: my ($ignore_cache) = @_;
9560: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 9561: my $fh;
9562: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9563: my @lines = <$fh>;
9564: &parse_domain_tab(\@lines);
1.448 albertel 9565: }
1.852 albertel 9566: close($fh);
9567: $loaded = 1;
1.327 albertel 9568: }
1.846 albertel 9569:
9570: sub domain {
1.852 albertel 9571: &load_domain_tab() if (!$loaded);
9572:
1.846 albertel 9573: my ($name,$what) = @_;
9574: return if ( !exists($domain{$name}) );
9575:
9576: if (!$what) {
9577: return $domain{$name}{'description'};
9578: }
9579: return $domain{$name}{$what};
9580: }
1.974 raeburn 9581:
9582: sub domain_info {
9583: &load_domain_tab() if (!$loaded);
9584: return %domain;
9585: }
9586:
1.327 albertel 9587: }
9588:
9589:
1.1 albertel 9590: # ------------------------------------------------------------- Read hosts file
9591: {
1.838 albertel 9592: my %hostname;
1.844 albertel 9593: my %hostdom;
1.845 albertel 9594: my %libserv;
1.852 albertel 9595: my $loaded;
1.888 albertel 9596: my %name_to_host;
1.852 albertel 9597:
9598: sub parse_hosts_tab {
9599: my ($file) = @_;
9600: foreach my $configline (@$file) {
9601: next if ($configline =~ /^(\#|\s*$ )/x);
9602: next if ($configline =~ /^\^/);
9603: chomp($configline);
1.968 raeburn 9604: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852 albertel 9605: $name=~s/\s//g;
9606: if ($id && $domain && $role && $name) {
9607: $hostname{$id}=$name;
1.888 albertel 9608: push(@{$name_to_host{$name}}, $id);
1.852 albertel 9609: $hostdom{$id}=$domain;
9610: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 9611: if (defined($protocol)) {
9612: if ($protocol eq 'https') {
9613: $protocol{$id} = $protocol;
9614: } else {
9615: $protocol{$id} = 'http';
9616: }
1.968 raeburn 9617: } else {
1.969 raeburn 9618: $protocol{$id} = 'http';
1.968 raeburn 9619: }
1.852 albertel 9620: }
9621: }
9622: }
1.864 albertel 9623:
9624: sub reset_hosts_info {
1.897 albertel 9625: &purge_remembered();
1.864 albertel 9626: &reset_domain_info();
9627: &reset_hosts_ip_info();
1.892 albertel 9628: undef(%name_to_host);
1.864 albertel 9629: undef(%hostname);
9630: undef(%hostdom);
9631: undef(%libserv);
9632: undef($loaded);
9633: }
1.1 albertel 9634:
1.852 albertel 9635: sub load_hosts_tab {
1.869 albertel 9636: my ($ignore_cache) = @_;
9637: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 9638: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9639: my @config = <$config>;
9640: &parse_hosts_tab(\@config);
9641: close($config);
9642: $loaded=1;
1.1 albertel 9643: }
1.852 albertel 9644:
1.838 albertel 9645: sub hostname {
1.852 albertel 9646: &load_hosts_tab() if (!$loaded);
9647:
1.838 albertel 9648: my ($lonid) = @_;
9649: return $hostname{$lonid};
9650: }
1.845 albertel 9651:
1.838 albertel 9652: sub all_hostnames {
1.852 albertel 9653: &load_hosts_tab() if (!$loaded);
9654:
1.838 albertel 9655: return %hostname;
9656: }
1.845 albertel 9657:
1.888 albertel 9658: sub all_names {
9659: &load_hosts_tab() if (!$loaded);
9660:
9661: return %name_to_host;
9662: }
9663:
1.974 raeburn 9664: sub all_host_domain {
9665: &load_hosts_tab() if (!$loaded);
9666: return %hostdom;
9667: }
9668:
1.845 albertel 9669: sub is_library {
1.852 albertel 9670: &load_hosts_tab() if (!$loaded);
9671:
1.845 albertel 9672: return exists($libserv{$_[0]});
9673: }
9674:
9675: sub all_library {
1.852 albertel 9676: &load_hosts_tab() if (!$loaded);
9677:
1.845 albertel 9678: return %libserv;
9679: }
9680:
1.841 albertel 9681: sub get_servers {
1.852 albertel 9682: &load_hosts_tab() if (!$loaded);
9683:
1.841 albertel 9684: my ($domain,$type) = @_;
9685: my %possible_hosts = ($type eq 'library') ? %libserv
9686: : %hostname;
9687: my %result;
1.842 albertel 9688: if (ref($domain) eq 'ARRAY') {
9689: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 9690: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 9691: $result{$host} = $hostname;
9692: }
9693: }
9694: } else {
9695: while ( my ($host,$hostname) = each(%possible_hosts)) {
9696: if ($hostdom{$host} eq $domain) {
9697: $result{$host} = $hostname;
9698: }
1.841 albertel 9699: }
9700: }
9701: return %result;
9702: }
1.845 albertel 9703:
1.844 albertel 9704: sub host_domain {
1.852 albertel 9705: &load_hosts_tab() if (!$loaded);
9706:
1.844 albertel 9707: my ($lonid) = @_;
9708: return $hostdom{$lonid};
9709: }
9710:
1.841 albertel 9711: sub all_domains {
1.852 albertel 9712: &load_hosts_tab() if (!$loaded);
9713:
1.841 albertel 9714: my %seen;
9715: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9716: return @uniq;
9717: }
1.1 albertel 9718: }
9719:
1.847 albertel 9720: {
9721: my %iphost;
1.856 albertel 9722: my %name_to_ip;
9723: my %lonid_to_ip;
1.869 albertel 9724:
1.847 albertel 9725: sub get_hosts_from_ip {
9726: my ($ip) = @_;
9727: my %iphosts = &get_iphost();
9728: if (ref($iphosts{$ip})) {
9729: return @{$iphosts{$ip}};
9730: }
9731: return;
1.839 albertel 9732: }
1.864 albertel 9733:
9734: sub reset_hosts_ip_info {
9735: undef(%iphost);
9736: undef(%name_to_ip);
9737: undef(%lonid_to_ip);
9738: }
1.856 albertel 9739:
9740: sub get_host_ip {
9741: my ($lonid) = @_;
9742: if (exists($lonid_to_ip{$lonid})) {
9743: return $lonid_to_ip{$lonid};
9744: }
9745: my $name=&hostname($lonid);
9746: my $ip = gethostbyname($name);
9747: return if (!$ip || length($ip) ne 4);
9748: $ip=inet_ntoa($ip);
9749: $name_to_ip{$name} = $ip;
9750: $lonid_to_ip{$lonid} = $ip;
9751: return $ip;
9752: }
1.847 albertel 9753:
9754: sub get_iphost {
1.869 albertel 9755: my ($ignore_cache) = @_;
1.894 albertel 9756:
1.869 albertel 9757: if (!$ignore_cache) {
9758: if (%iphost) {
9759: return %iphost;
9760: }
9761: my ($ip_info,$cached)=
9762: &Apache::lonnet::is_cached_new('iphost','iphost');
9763: if ($cached) {
9764: %iphost = %{$ip_info->[0]};
9765: %name_to_ip = %{$ip_info->[1]};
9766: %lonid_to_ip = %{$ip_info->[2]};
9767: return %iphost;
9768: }
9769: }
1.894 albertel 9770:
9771: # get yesterday's info for fallback
9772: my %old_name_to_ip;
9773: my ($ip_info,$cached)=
9774: &Apache::lonnet::is_cached_new('iphost','iphost');
9775: if ($cached) {
9776: %old_name_to_ip = %{$ip_info->[1]};
9777: }
9778:
1.888 albertel 9779: my %name_to_host = &all_names();
9780: foreach my $name (keys(%name_to_host)) {
1.847 albertel 9781: my $ip;
9782: if (!exists($name_to_ip{$name})) {
9783: $ip = gethostbyname($name);
9784: if (!$ip || length($ip) ne 4) {
1.894 albertel 9785: if (defined($old_name_to_ip{$name})) {
9786: $ip = $old_name_to_ip{$name};
9787: &logthis("Can't find $name defaulting to old $ip");
9788: } else {
9789: &logthis("Name $name no IP found");
9790: next;
9791: }
9792: } else {
9793: $ip=inet_ntoa($ip);
1.847 albertel 9794: }
9795: $name_to_ip{$name} = $ip;
9796: } else {
9797: $ip = $name_to_ip{$name};
1.653 albertel 9798: }
1.888 albertel 9799: foreach my $id (@{ $name_to_host{$name} }) {
9800: $lonid_to_ip{$id} = $ip;
9801: }
9802: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 9803: }
1.869 albertel 9804: &Apache::lonnet::do_cache_new('iphost','iphost',
9805: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 9806: 48*60*60);
1.869 albertel 9807:
1.847 albertel 9808: return %iphost;
1.598 albertel 9809: }
9810:
1.992 raeburn 9811: #
9812: # Given a DNS returns the loncapa host name for that DNS
9813: #
9814: sub host_from_dns {
9815: my ($dns) = @_;
9816: my @hosts;
9817: my $ip;
9818:
1.993 raeburn 9819: if (exists($name_to_ip{$dns})) {
1.992 raeburn 9820: $ip = $name_to_ip{$dns};
9821: }
9822: if (!$ip) {
9823: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9824: if (length($ip) == 4) {
9825: $ip = &IO::Socket::inet_ntoa($ip);
9826: }
9827: }
9828: if ($ip) {
9829: @hosts = get_hosts_from_ip($ip);
9830: return $hosts[0];
9831: }
9832: return undef;
1.986 foxr 9833: }
1.992 raeburn 9834:
1.986 foxr 9835: }
9836:
1.862 albertel 9837: BEGIN {
9838:
9839: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9840: unless ($readit) {
9841: {
9842: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9843: %perlvar = (%perlvar,%{$configvars});
9844: }
9845:
9846:
1.1 albertel 9847: # ------------------------------------------------------ Read spare server file
9848: {
1.448 albertel 9849: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 9850:
9851: while (my $configline=<$config>) {
9852: chomp($configline);
1.284 matthew 9853: if ($configline) {
1.784 albertel 9854: my ($host,$type) = split(':',$configline,2);
1.785 albertel 9855: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 9856: push(@{ $spareid{$type} }, $host);
1.1 albertel 9857: }
9858: }
1.448 albertel 9859: close($config);
1.1 albertel 9860: }
1.11 www 9861: # ------------------------------------------------------------ Read permissions
9862: {
1.448 albertel 9863: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 9864:
9865: while (my $configline=<$config>) {
1.448 albertel 9866: chomp($configline);
9867: if ($configline) {
9868: my ($role,$perm)=split(/ /,$configline);
9869: if ($perm ne '') { $pr{$role}=$perm; }
9870: }
1.11 www 9871: }
1.448 albertel 9872: close($config);
1.11 www 9873: }
9874:
9875: # -------------------------------------------- Read plain texts for permissions
9876: {
1.448 albertel 9877: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 9878:
9879: while (my $configline=<$config>) {
1.448 albertel 9880: chomp($configline);
9881: if ($configline) {
1.742 raeburn 9882: my ($short,@plain)=split(/:/,$configline);
9883: %{$prp{$short}} = ();
9884: if (@plain > 0) {
9885: $prp{$short}{'std'} = $plain[0];
9886: for (my $i=1; $i<@plain; $i++) {
9887: $prp{$short}{'alt'.$i} = $plain[$i];
9888: }
9889: }
1.448 albertel 9890: }
1.135 www 9891: }
1.448 albertel 9892: close($config);
1.135 www 9893: }
9894:
9895: # ---------------------------------------------------------- Read package table
9896: {
1.448 albertel 9897: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 9898:
9899: while (my $configline=<$config>) {
1.483 albertel 9900: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 9901: chomp($configline);
9902: my ($short,$plain)=split(/:/,$configline);
9903: my ($pack,$name)=split(/\&/,$short);
9904: if ($plain ne '') {
9905: $packagetab{$pack.'&'.$name.'&name'}=$name;
9906: $packagetab{$short}=$plain;
9907: }
1.11 www 9908: }
1.448 albertel 9909: close($config);
1.329 matthew 9910: }
9911:
9912: # ------------- set up temporary directory
9913: {
9914: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9915:
1.11 www 9916: }
9917:
1.794 albertel 9918: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9919: 'compress_threshold'=> 20_000,
9920: });
1.185 www 9921:
1.281 www 9922: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 9923: $dumpcount=0;
1.958 www 9924: $locknum=0;
1.22 www 9925:
1.163 harris41 9926: &logtouch();
1.672 albertel 9927: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 9928: $readit=1;
1.564 albertel 9929: {
9930: use integer;
9931: my $test=(2**32)+1;
1.568 albertel 9932: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 9933: &logthis(" Detected 64bit platform ($_64bit)");
9934: }
1.195 www 9935: }
1.1 albertel 9936: }
1.179 www 9937:
1.1 albertel 9938: 1;
1.191 harris41 9939: __END__
9940:
1.243 albertel 9941: =pod
9942:
1.191 harris41 9943: =head1 NAME
9944:
1.243 albertel 9945: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 9946:
9947: =head1 SYNOPSIS
9948:
1.243 albertel 9949: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 9950:
9951: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9952:
1.243 albertel 9953: Common parameters:
9954:
9955: =over 4
9956:
9957: =item *
9958:
9959: $uname : an internal username (if $cname expecting a course Id specifically)
9960:
9961: =item *
9962:
9963: $udom : a domain (if $cdom expecting a course's domain specifically)
9964:
9965: =item *
9966:
9967: $symb : a resource instance identifier
9968:
9969: =item *
9970:
9971: $namespace : the name of a .db file that contains the data needed or
9972: being set.
9973:
9974: =back
9975:
1.394 bowersj2 9976: =head1 OVERVIEW
1.191 harris41 9977:
1.394 bowersj2 9978: lonnet provides subroutines which interact with the
9979: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9980: about classes, users, and resources.
1.243 albertel 9981:
9982: For many of these objects you can also use this to store data about
9983: them or modify them in various ways.
1.191 harris41 9984:
1.394 bowersj2 9985: =head2 Symbs
1.191 harris41 9986:
1.394 bowersj2 9987: To identify a specific instance of a resource, LON-CAPA uses symbols
9988: or "symbs"X<symb>. These identifiers are built from the URL of the
9989: map, the resource number of the resource in the map, and the URL of
9990: the resource itself. The latter is somewhat redundant, but might help
9991: if maps change.
9992:
9993: An example is
9994:
9995: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
9996:
9997: The respective map entry is
9998:
9999: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10000: title="Problem 2">
10001: </resource>
10002:
10003: Symbs are used by the random number generator, as well as to store and
10004: restore data specific to a certain instance of for example a problem.
10005:
10006: =head2 Storing And Retrieving Data
10007:
10008: X<store()>X<cstore()>X<restore()>Three of the most important functions
10009: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10010: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10011: is is the non-critical message twin of cstore. These functions are for
10012: handlers to store a perl hash to a user's permanent data space in an
10013: easy manner, and to retrieve it again on another call. It is expected
10014: that a handler would use this once at the beginning to retrieve data,
10015: and then again once at the end to send only the new data back.
10016:
10017: The data is stored in the user's data directory on the user's
10018: homeserver under the ID of the course.
10019:
10020: The hash that is returned by restore will have all of the previous
10021: value for all of the elements of the hash.
10022:
10023: Example:
10024:
10025: #creating a hash
10026: my %hash;
10027: $hash{'foo'}='bar';
10028:
10029: #storing it
10030: &Apache::lonnet::cstore(\%hash);
10031:
10032: #changing a value
10033: $hash{'foo'}='notbar';
10034:
10035: #adding a new value
10036: $hash{'bar'}='foo';
10037: &Apache::lonnet::cstore(\%hash);
10038:
10039: #retrieving the hash
10040: my %history=&Apache::lonnet::restore();
10041:
10042: #print the hash
10043: foreach my $key (sort(keys(%history))) {
10044: print("\%history{$key} = $history{$key}");
10045: }
10046:
10047: Will print out:
1.191 harris41 10048:
1.394 bowersj2 10049: %history{1:foo} = bar
10050: %history{1:keys} = foo:timestamp
10051: %history{1:timestamp} = 990455579
10052: %history{2:bar} = foo
10053: %history{2:foo} = notbar
10054: %history{2:keys} = foo:bar:timestamp
10055: %history{2:timestamp} = 990455580
10056: %history{bar} = foo
10057: %history{foo} = notbar
10058: %history{timestamp} = 990455580
10059: %history{version} = 2
10060:
10061: Note that the special hash entries C<keys>, C<version> and
10062: C<timestamp> were added to the hash. C<version> will be equal to the
10063: total number of versions of the data that have been stored. The
10064: C<timestamp> attribute will be the UNIX time the hash was
10065: stored. C<keys> is available in every historical section to list which
10066: keys were added or changed at a specific historical revision of a
10067: hash.
10068:
10069: B<Warning>: do not store the hash that restore returns directly. This
10070: will cause a mess since it will restore the historical keys as if the
10071: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 10072:
1.394 bowersj2 10073: Calling convention:
1.191 harris41 10074:
1.394 bowersj2 10075: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10076: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 10077:
1.394 bowersj2 10078: For more detailed information, see lonnet specific documentation.
1.191 harris41 10079:
1.394 bowersj2 10080: =head1 RETURN MESSAGES
1.191 harris41 10081:
1.394 bowersj2 10082: =over 4
1.191 harris41 10083:
1.394 bowersj2 10084: =item * B<con_lost>: unable to contact remote host
1.191 harris41 10085:
1.394 bowersj2 10086: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10087: when the connection is brought back up
1.191 harris41 10088:
1.394 bowersj2 10089: =item * B<con_failed>: unable to contact remote host and unable to save message
10090: for later delivery
1.191 harris41 10091:
1.967 bisitz 10092: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 10093:
1.394 bowersj2 10094: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 10095: that was requested
1.191 harris41 10096:
1.243 albertel 10097: =back
1.191 harris41 10098:
1.243 albertel 10099: =head1 PUBLIC SUBROUTINES
1.191 harris41 10100:
1.243 albertel 10101: =head2 Session Environment Functions
1.191 harris41 10102:
1.243 albertel 10103: =over 4
1.191 harris41 10104:
1.394 bowersj2 10105: =item *
10106: X<appenv()>
1.949 raeburn 10107: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 10108: the user envirnoment file, and will be restored for each access this
1.620 albertel 10109: user makes during this session, also modifies the %env for the current
1.949 raeburn 10110: process. Optional rolesarrayref - if defined contains a reference to an array
10111: of roles which are exempt from the restriction on modifying user.role entries
10112: in the user's environment.db and in %env.
1.191 harris41 10113:
10114: =item *
1.394 bowersj2 10115: X<delenv()>
1.987 raeburn 10116: B<delenv($delthis,$regexp)>: removes all items from the session
10117: environment file that begin with $delthis. If the
10118: optional second arg - $regexp - is true, $delthis is treated as a
10119: regular expression, otherwise \Q$delthis\E is used.
10120: The values are also deleted from the current processes %env.
1.191 harris41 10121:
1.795 albertel 10122: =item * get_env_multiple($name)
10123:
10124: gets $name from the %env hash, it seemlessly handles the cases where multiple
10125: values may be defined and end up as an array ref.
10126:
10127: returns an array of values
10128:
1.243 albertel 10129: =back
10130:
10131: =head2 User Information
1.191 harris41 10132:
1.243 albertel 10133: =over 4
1.191 harris41 10134:
10135: =item *
1.394 bowersj2 10136: X<queryauthenticate()>
10137: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 10138: authentication scheme
10139:
10140: =item *
1.394 bowersj2 10141: X<authenticate()>
10142: B<authenticate($uname,$upass,$udom)>: try to
10143: authenticate user from domain's lib servers (first use the current
10144: one). C<$upass> should be the users password.
1.191 harris41 10145:
10146: =item *
1.394 bowersj2 10147: X<homeserver()>
10148: B<homeserver($uname,$udom)>: find the server which has
10149: the user's directory and files (there must be only one), this caches
10150: the answer, and also caches if there is a borken connection.
1.191 harris41 10151:
10152: =item *
1.394 bowersj2 10153: X<idget()>
10154: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10155: (IDs are a unique resource in a domain, there must be only 1 ID per
10156: username, and only 1 username per ID in a specific domain) (returns
10157: hash: id=>name,id=>name)
1.191 harris41 10158:
10159: =item *
1.394 bowersj2 10160: X<idrget()>
10161: B<idrget($udom,@unames)>: find the IDs behind a list of
10162: usernames (returns hash: name=>id,name=>id)
1.191 harris41 10163:
10164: =item *
1.394 bowersj2 10165: X<idput()>
10166: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 10167:
10168: =item *
1.394 bowersj2 10169: X<rolesinit()>
10170: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 10171:
10172: =item *
1.551 albertel 10173: X<getsection()>
10174: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 10175: course $cname, return section name/number or '' for "not in course"
10176: and '-1' for "no section"
10177:
10178: =item *
1.394 bowersj2 10179: X<userenvironment()>
10180: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 10181: passed in @what from the requested user's environment, returns a hash
10182:
1.858 raeburn 10183: =item *
10184: X<userlog_query()>
1.859 albertel 10185: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10186: activity.log file. %filters defines filters applied when parsing the
10187: log file. These can be start or end timestamps, or the type of action
10188: - log to look for Login or Logout events, check for Checkin or
10189: Checkout, role for role selection. The response is in the form
10190: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10191: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 10192:
1.243 albertel 10193: =back
10194:
10195: =head2 User Roles
10196:
10197: =over 4
10198:
10199: =item *
10200:
1.810 raeburn 10201: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 10202: F: full access
10203: U,I,K: authentication modes (cxx only)
10204: '': forbidden
10205: 1: user needs to choose course
10206: 2: browse allowed
1.766 albertel 10207: A: passphrase authentication needed
1.243 albertel 10208:
10209: =item *
10210:
10211: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10212: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10213: and course level
10214:
10215: =item *
10216:
1.988 raeburn 10217: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10218: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 10219: $type is Course (default) or Community.
1.988 raeburn 10220: If $forcedefault evaluates to true, text returned will be default
10221: text for $type. Otherwise, if this is a course, the text returned
10222: will be a custom name for the role (if defined in the course's
10223: environment). If no custom name is defined the default is returned.
10224:
1.832 raeburn 10225: =item *
10226:
1.935 raeburn 10227: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 10228: All arguments are optional. Returns a hash of a roles, either for
10229: co-author/assistant author roles for a user's Construction Space
1.906 albertel 10230: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 10231: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10232: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10233: For each key, value is set to colon-separated start and end times for
10234: the role. If no username and domain are specified, will default to
1.934 raeburn 10235: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 10236: of role statuses (active, future or previous), roles
10237: (e.g., cc,in, st etc.) and domains of the roles which can be used
10238: to restrict the list of roles reported. If no array ref is
10239: provided for types, will default to return only active roles.
1.834 albertel 10240:
1.243 albertel 10241: =back
10242:
10243: =head2 User Modification
10244:
10245: =over 4
10246:
10247: =item *
10248:
1.957 raeburn 10249: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 10250: user for the level given by URL. Optional start and end dates (leave empty
10251: string or zero for "no date")
1.191 harris41 10252:
10253: =item *
10254:
1.243 albertel 10255: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10256: change a users, password, possible return values are: ok,
10257: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10258: refused
1.191 harris41 10259:
10260: =item *
10261:
1.243 albertel 10262: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 10263:
10264: =item *
10265:
1.1058 ! raeburn 10266: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
! 10267: $forceid,$desiredhome,$email,$inststatus,$candelete) :
! 10268:
! 10269: will update user information (firstname,middlename,lastname,generation,
! 10270: permanentemail), and if forceid is true, student/employee ID also.
! 10271: A user's institutional affiliation(s) can also be updated.
! 10272: User information fields will not be overwritten with empty entries
! 10273: unless the field is included in the $candelete array reference.
! 10274: This array is included when a single user is modified via "Manage Users",
! 10275: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 10276:
10277: =item *
10278:
1.286 matthew 10279: modifystudent
10280:
1.957 raeburn 10281: modify a student's enrollment and identification information.
1.286 matthew 10282: The course id is resolved based on the current users environment.
10283: This means the envoking user must be a course coordinator or otherwise
10284: associated with a course.
10285:
1.297 matthew 10286: This call is essentially a wrapper for lonnet::modifyuser and
10287: lonnet::modify_student_enrollment
1.286 matthew 10288:
10289: Inputs:
10290:
10291: =over 4
10292:
1.957 raeburn 10293: =item B<$udom> Student's loncapa domain
1.286 matthew 10294:
1.957 raeburn 10295: =item B<$uname> Student's loncapa login name
1.286 matthew 10296:
1.964 bisitz 10297: =item B<$uid> Student/Employee ID
1.286 matthew 10298:
1.957 raeburn 10299: =item B<$umode> Student's authentication mode
1.286 matthew 10300:
1.957 raeburn 10301: =item B<$upass> Student's password
1.286 matthew 10302:
1.957 raeburn 10303: =item B<$first> Student's first name
1.286 matthew 10304:
1.957 raeburn 10305: =item B<$middle> Student's middle name
1.286 matthew 10306:
1.957 raeburn 10307: =item B<$last> Student's last name
1.286 matthew 10308:
1.957 raeburn 10309: =item B<$gene> Student's generation
1.286 matthew 10310:
1.957 raeburn 10311: =item B<$usec> Student's section in course
1.286 matthew 10312:
10313: =item B<$end> Unix time of the roles expiration
10314:
10315: =item B<$start> Unix time of the roles start date
10316:
10317: =item B<$forceid> If defined, allow $uid to be changed
10318:
10319: =item B<$desiredhome> server to use as home server for student
10320:
1.957 raeburn 10321: =item B<$email> Student's permanent e-mail address
10322:
10323: =item B<$type> Type of enrollment (auto or manual)
10324:
1.963 raeburn 10325: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10326:
10327: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 10328:
1.963 raeburn 10329: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 10330:
1.963 raeburn 10331: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 10332:
1.963 raeburn 10333: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 10334:
1.286 matthew 10335: =back
1.297 matthew 10336:
10337: =item *
10338:
10339: modify_student_enrollment
10340:
10341: Change a students enrollment status in a class. The environment variable
10342: 'role.request.course' must be defined for this function to proceed.
10343:
10344: Inputs:
10345:
10346: =over 4
10347:
10348: =item $udom, students domain
10349:
10350: =item $uname, students name
10351:
10352: =item $uid, students user id
10353:
10354: =item $first, students first name
10355:
10356: =item $middle
10357:
10358: =item $last
10359:
10360: =item $gene
10361:
10362: =item $usec
10363:
10364: =item $end
10365:
10366: =item $start
10367:
1.957 raeburn 10368: =item $type
10369:
10370: =item $locktype
10371:
10372: =item $cid
10373:
10374: =item $selfenroll
10375:
10376: =item $context
10377:
1.297 matthew 10378: =back
10379:
1.191 harris41 10380:
10381: =item *
10382:
1.243 albertel 10383: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10384: custom role; give a custom role to a user for the level given by URL. Specify
10385: name and domain of role author, and role name
1.191 harris41 10386:
10387: =item *
10388:
1.243 albertel 10389: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 10390:
10391: =item *
10392:
1.243 albertel 10393: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10394:
10395: =back
10396:
10397: =head2 Course Infomation
10398:
10399: =over 4
1.191 harris41 10400:
10401: =item *
10402:
1.631 albertel 10403: coursedescription($courseid) : returns a hash of information about the
10404: specified course id, including all environment settings for the
10405: course, the description of the course will be in the hash under the
10406: key 'description'
1.191 harris41 10407:
10408: =item *
10409:
1.624 albertel 10410: resdata($name,$domain,$type,@which) : request for current parameter
10411: setting for a specific $type, where $type is either 'course' or 'user',
10412: @what should be a list of parameters to ask about. This routine caches
10413: answers for 5 minutes.
1.243 albertel 10414:
1.877 foxr 10415: =item *
10416:
10417: get_courseresdata($courseid, $domain) : dump the entire course resource
10418: data base, returning a hash that is keyed by the resource name and has
10419: values that are the resource value. I believe that the timestamps and
10420: versions are also returned.
10421:
10422:
1.243 albertel 10423: =back
10424:
10425: =head2 Course Modification
10426:
10427: =over 4
1.191 harris41 10428:
10429: =item *
10430:
1.243 albertel 10431: writecoursepref($courseid,%prefs) : write preferences (environment
10432: database) for a course
1.191 harris41 10433:
10434: =item *
10435:
1.1011 raeburn 10436: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10437:
10438: =item *
10439:
1.1038 raeburn 10440: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 10441:
10442: =back
10443:
10444: =head2 Resource Subroutines
10445:
10446: =over 4
1.191 harris41 10447:
10448: =item *
10449:
1.243 albertel 10450: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 10451:
10452: =item *
10453:
1.243 albertel 10454: repcopy($filename) : subscribes to the requested file, and attempts to
10455: replicate from the owning library server, Might return
1.607 raeburn 10456: 'unavailable', 'not_found', 'forbidden', 'ok', or
10457: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 10458: resource. Expects the local filesystem pathname
10459: (/home/httpd/html/res/....)
10460:
10461: =back
10462:
10463: =head2 Resource Information
10464:
10465: =over 4
1.191 harris41 10466:
10467: =item *
10468:
1.243 albertel 10469: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10470: a vairety of different possible values, $varname should be a request
10471: string, and the other parameters can be used to specify who and what
10472: one is asking about.
10473:
10474: Possible values for $varname are environment.lastname (or other item
10475: from the envirnment hash), user.name (or someother aspect about the
10476: user), resource.0.maxtries (or some other part and parameter of a
10477: resource)
1.204 albertel 10478:
10479: =item *
10480:
1.243 albertel 10481: directcondval($number) : get current value of a condition; reads from a state
10482: string
1.204 albertel 10483:
10484: =item *
10485:
1.243 albertel 10486: condval($condidx) : value of condition index based on state
1.204 albertel 10487:
10488: =item *
10489:
1.243 albertel 10490: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10491: resource's metadata, $what should be either a specific key, or either
10492: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10493: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10494:
10495: this function automatically caches all requests
1.191 harris41 10496:
10497: =item *
10498:
1.243 albertel 10499: metadata_query($query,$custom,$customshow) : make a metadata query against the
10500: network of library servers; returns file handle of where SQL and regex results
10501: will be stored for query
1.191 harris41 10502:
10503: =item *
10504:
1.243 albertel 10505: symbread($filename) : return symbolic list entry (filename argument optional);
10506: returns the data handle
1.191 harris41 10507:
10508: =item *
10509:
1.243 albertel 10510: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 10511: a possible symb for the URL in $thisfn, and if is an encryypted
10512: resource that the user accessed using /enc/ returns a 1 on success, 0
10513: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 10514: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 10515:
1.191 harris41 10516:
10517: =item *
10518:
1.243 albertel 10519: symbclean($symb) : removes versions numbers from a symb, returns the
10520: cleaned symb
1.191 harris41 10521:
10522: =item *
10523:
1.243 albertel 10524: is_on_map($uri) : checks if the $uri is somewhere on the current
10525: course map, user must be in a course for it to work.
1.191 harris41 10526:
10527: =item *
10528:
1.243 albertel 10529: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 10530:
10531: =item *
10532:
1.243 albertel 10533: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10534: a random seed, all arguments are optional, if they aren't sent it uses the
10535: environment to derive them. Note: if symb isn't sent and it can't get one
10536: from &symbread it will use the current time as its return value
1.191 harris41 10537:
10538: =item *
10539:
1.243 albertel 10540: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10541: unfakeable, receipt
1.191 harris41 10542:
10543: =item *
10544:
1.620 albertel 10545: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 10546:
10547: =item *
10548:
1.243 albertel 10549: countacc($url) : count the number of accesses to a given URL
1.191 harris41 10550:
10551: =item *
10552:
1.243 albertel 10553: 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 10554:
10555: =item *
10556:
1.243 albertel 10557: 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 10558:
10559: =item *
10560:
1.243 albertel 10561: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 10562:
10563: =item *
10564:
1.243 albertel 10565: devalidate($symb) : devalidate temporary spreadsheet calculations,
10566: forcing spreadsheet to reevaluate the resource scores next time.
10567:
10568: =back
10569:
10570: =head2 Storing/Retreiving Data
10571:
10572: =over 4
1.191 harris41 10573:
10574: =item *
10575:
1.243 albertel 10576: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10577: for this url; hashref needs to be given and should be a \%hashname; the
10578: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 10579: be derived from the env
1.191 harris41 10580:
10581: =item *
10582:
1.243 albertel 10583: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10584: uses critical subroutine
1.191 harris41 10585:
10586: =item *
10587:
1.243 albertel 10588: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10589: all args are optional
1.191 harris41 10590:
10591: =item *
10592:
1.717 albertel 10593: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10594: dumps the complete (or key matching regexp) namespace into a hash
10595: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10596: normally &store()ed into
10597:
10598: $range should be either an integer '100' (give me the first 100
10599: matching records)
10600: or be two integers sperated by a - with no spaces
10601: '30-50' (give me the 30th through the 50th matching
10602: records)
10603:
10604:
10605: =item *
10606:
10607: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10608: replaces a &store() version of data with a replacement set of data
10609: for a particular resource in a namespace passed in the $storehash hash
10610: reference
10611:
10612: =item *
10613:
1.243 albertel 10614: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10615: works very similar to store/cstore, but all data is stored in a
10616: temporary location and can be reset using tmpreset, $storehash should
10617: be a hash reference, returns nothing on success
1.191 harris41 10618:
10619: =item *
10620:
1.243 albertel 10621: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10622: similar to restore, but all data is stored in a temporary location and
10623: can be reset using tmpreset. Returns a hash of values on success,
10624: error string otherwise.
1.191 harris41 10625:
10626: =item *
10627:
1.243 albertel 10628: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10629: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 10630:
10631: =item *
10632:
1.243 albertel 10633: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10634: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 10635:
10636: =item *
10637:
1.243 albertel 10638: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10639: namesp ($udom and $uname are optional)
1.191 harris41 10640:
10641: =item *
10642:
1.702 albertel 10643: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 10644: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 10645: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 10646:
1.702 albertel 10647: $range should be either an integer '100' (give me the first 100
10648: matching records)
10649: or be two integers sperated by a - with no spaces
10650: '30-50' (give me the 30th through the 50th matching
10651: records)
1.449 matthew 10652: =item *
10653:
10654: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10655: $store can be a scalar, an array reference, or if the amount to be
10656: incremented is > 1, a hash reference.
10657:
10658: ($udom and $uname are optional)
1.191 harris41 10659:
10660: =item *
10661:
1.243 albertel 10662: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10663: ($udom and $uname are optional)
1.191 harris41 10664:
10665: =item *
10666:
1.243 albertel 10667: cput($namespace,$storehash,$udom,$uname) : critical put
10668: ($udom and $uname are optional)
1.191 harris41 10669:
10670: =item *
10671:
1.748 albertel 10672: newput($namespace,$storehash,$udom,$uname) :
10673:
10674: Attempts to store the items in the $storehash, but only if they don't
10675: currently exist, if this succeeds you can be certain that you have
10676: successfully created a new key value pair in the $namespace db.
10677:
10678:
10679: Args:
10680: $namespace: name of database to store values to
10681: $storehash: hashref to store to the db
10682: $udom: (optional) domain of user containing the db
10683: $uname: (optional) name of user caontaining the db
10684:
10685: Returns:
10686: 'ok' -> succeeded in storing all keys of $storehash
10687: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10688: least <key> already existed in the db (other
10689: requested keys may also already exist)
1.967 bisitz 10690: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 10691: 'con_lost' -> unable to contact request server
10692: 'refused' -> action was not allowed by remote machine
10693:
10694:
10695: =item *
10696:
1.243 albertel 10697: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10698: reference filled in from namesp (encrypts the return communication)
10699: ($udom and $uname are optional)
1.191 harris41 10700:
10701: =item *
10702:
1.243 albertel 10703: log($udom,$name,$home,$message) : write to permanent log for user; use
10704: critical subroutine
10705:
1.806 raeburn 10706: =item *
10707:
1.860 raeburn 10708: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10709: array reference filled in from namespace found in domain level on either
10710: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 10711:
10712: =item *
10713:
1.860 raeburn 10714: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10715: domain level either on specified domain server ($uhome) or primary domain
10716: server ($udom and $uhome are optional)
1.806 raeburn 10717:
1.943 raeburn 10718: =item *
10719:
10720: get_domain_defaults($target_domain) : returns hash with defaults for
10721: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10722: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10723: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10724: Values are retrieved from cache (if current), or from domain's configuration.db
10725: (if available), or lastly from values in lonTabs/dns_domain,tab,
10726: or lonTabs/domain.tab.
10727:
10728: %domdefaults = &get_auth_defaults($target_domain);
10729:
1.243 albertel 10730: =back
10731:
10732: =head2 Network Status Functions
10733:
10734: =over 4
1.191 harris41 10735:
10736: =item *
10737:
10738: dirlist($uri) : return directory list based on URI
10739:
10740: =item *
10741:
1.243 albertel 10742: spareserver() : find server with least workload from spare.tab
10743:
1.986 foxr 10744:
10745: =item *
10746:
10747: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10748: if there is no corresponding loncapa host.
10749:
1.243 albertel 10750: =back
10751:
1.986 foxr 10752:
1.243 albertel 10753: =head2 Apache Request
10754:
10755: =over 4
1.191 harris41 10756:
10757: =item *
10758:
1.243 albertel 10759: ssi($url,%hash) : server side include, does a complete request cycle on url to
10760: localhost, posts hash
10761:
10762: =back
10763:
10764: =head2 Data to String to Data
10765:
10766: =over 4
1.191 harris41 10767:
10768: =item *
10769:
1.243 albertel 10770: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10771: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 10772:
10773: =item *
10774:
1.243 albertel 10775: hashref2str($hashref) : convert a hashref into a string complete with
10776: escaping and '=' and '&' separators, supports elements that are
10777: arrayrefs and hashrefs
1.191 harris41 10778:
10779: =item *
10780:
1.243 albertel 10781: arrayref2str($arrayref) : convert an arrayref into a string complete
10782: with escaping and '&' separators, supports elements that are arrayrefs
10783: and hashrefs
1.191 harris41 10784:
10785: =item *
10786:
1.243 albertel 10787: str2hash($string) : convert string to hash using unescaping and
10788: splitting on '=' and '&', supports elements that are arrayrefs and
10789: hashrefs
1.191 harris41 10790:
10791: =item *
10792:
1.243 albertel 10793: str2array($string) : convert string to hash using unescaping and
10794: splitting on '&', supports elements that are arrayrefs and hashrefs
10795:
10796: =back
10797:
10798: =head2 Logging Routines
10799:
10800: =over 4
10801:
10802: These routines allow one to make log messages in the lonnet.log and
10803: lonnet.perm logfiles.
1.191 harris41 10804:
10805: =item *
10806:
1.243 albertel 10807: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 10808:
10809: =item *
10810:
1.243 albertel 10811: logthis() : append message to the normal lonnet.log file, it gets
10812: preiodically rolled over and deleted.
1.191 harris41 10813:
10814: =item *
10815:
1.243 albertel 10816: logperm() : append a permanent message to lonnet.perm.log, this log
10817: file never gets deleted by any automated portion of the system, only
10818: messages of critical importance should go in here.
10819:
10820: =back
10821:
10822: =head2 General File Helper Routines
10823:
10824: =over 4
1.191 harris41 10825:
10826: =item *
10827:
1.481 raeburn 10828: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10829: (a) files in /uploaded
10830: (i) If a local copy of the file exists -
10831: compares modification date of local copy with last-modified date for
10832: definitive version stored on home server for course. If local copy is
10833: stale, requests a new version from the home server and stores it.
10834: If the original has been removed from the home server, then local copy
10835: is unlinked.
10836: (ii) If local copy does not exist -
10837: requests the file from the home server and stores it.
10838:
10839: If $caller is 'uploadrep':
10840: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10841: for request for files originally uploaded via DOCS.
10842: - returns 'ok' if fresh local copy now available, -1 otherwise.
10843:
10844: Otherwise:
10845: This indicates a call from the content generation phase of the request.
10846: - returns the entire contents of the file or -1.
10847:
10848: (b) files in /res
10849: - returns the entire contents of a file or -1;
10850: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 10851:
1.712 albertel 10852:
10853: =item *
10854:
10855: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10856: reference
10857:
10858: returns either a stat() list of data about the file or an empty list
10859: if the file doesn't exist or couldn't find out about it (connection
10860: problems or user unknown)
10861:
1.191 harris41 10862: =item *
10863:
1.243 albertel 10864: filelocation($dir,$file) : returns file system location of a file
10865: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10866: directory that relative $file lookups are to looked in ($dir of /a/dir
10867: and a file of ../bob will become /a/bob)
1.191 harris41 10868:
10869: =item *
10870:
10871: hreflocation($dir,$file) : returns file system location or a URL; same as
10872: filelocation except for hrefs
10873:
10874: =item *
10875:
10876: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10877:
1.243 albertel 10878: =back
10879:
1.608 albertel 10880: =head2 Usererfile file routines (/uploaded*)
10881:
10882: =over 4
10883:
10884: =item *
10885:
10886: userfileupload(): main rotine for putting a file in a user or course's
10887: filespace, arguments are,
10888:
1.620 albertel 10889: formname - required - this is the name of the element in $env where the
1.608 albertel 10890: filename, and the contents of the file to create/modifed exist
1.620 albertel 10891: the filename is in $env{'form.'.$formname.'.filename'} and the
10892: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 10893: coursedoc - if true, store the file in the course of the active role
10894: of the current user
10895: subdir - required - subdirectory to put the file in under ../userfiles/
10896: if undefined, it will be placed in "unknown"
10897:
10898: (This routine calls clean_filename() to remove any dangerous
10899: characters from the filename, and then calls finuserfileupload() to
10900: complete the transaction)
10901:
10902: returns either the url of the uploaded file (/uploaded/....) if successful
10903: and /adm/notfound.html if unsuccessful
10904:
10905: =item *
10906:
10907: clean_filename(): routine for cleaing a filename up for storage in
10908: userfile space, argument is:
10909:
10910: filename - proposed filename
10911:
10912: returns: the new clean filename
10913:
10914: =item *
10915:
10916: finishuserfileupload(): routine that creaes and sends the file to
10917: userspace, probably shouldn't be called directly
10918:
10919: docuname: username or courseid of destination for the file
10920: docudom: domain of user/course of destination for the file
10921: formname: same as for userfileupload()
10922: fname: filename (inculding subdirectories) for the file
10923:
10924: returns either the url of the uploaded file (/uploaded/....) if successful
10925: and /adm/notfound.html if unsuccessful
10926:
10927: =item *
10928:
10929: renameuserfile(): renames an existing userfile to a new name
10930:
10931: Args:
10932: docuname: username or courseid of destination for the file
10933: docudom: domain of user/course of destination for the file
10934: old: current file name (including any subdirs under userfiles)
10935: new: desired file name (including any subdirs under userfiles)
10936:
10937: =item *
10938:
10939: mkdiruserfile(): creates a directory is a userfiles dir
10940:
10941: Args:
10942: docuname: username or courseid of destination for the file
10943: docudom: domain of user/course of destination for the file
10944: dir: dir to create (including any subdirs under userfiles)
10945:
10946: =item *
10947:
10948: removeuserfile(): removes a file that exists in userfiles
10949:
10950: Args:
10951: docuname: username or courseid of destination for the file
10952: docudom: domain of user/course of destination for the file
10953: fname: filname to delete (including any subdirs under userfiles)
10954:
10955: =item *
10956:
10957: removeuploadedurl(): convience function for removeuserfile()
10958:
10959: Args:
10960: url: a full /uploaded/... url to delete
10961:
1.747 albertel 10962: =item *
10963:
10964: get_portfile_permissions():
10965: Args:
10966: domain: domain of user or course contain the portfolio files
10967: user: name of user or num of course contain the portfolio files
10968: Returns:
10969: hashref of a dump of the proper file_permissions.db
10970:
10971:
10972: =item *
10973:
10974: get_access_controls():
10975:
10976: Args:
10977: current_permissions: the hash ref returned from get_portfile_permissions()
10978: group: (optional) the group you want the files associated with
10979: file: (optional) the file you want access info on
10980:
10981: Returns:
1.749 raeburn 10982: a hash (keys are file names) of hashes containing
10983: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10984: values are XML containing access control settings (see below)
1.747 albertel 10985:
10986: Internal notes:
10987:
1.749 raeburn 10988: access controls are stored in file_permissions.db as key=value pairs.
10989: key -> path to file/file_name\0uniqueID:scope_end_start
10990: where scope -> public,guest,course,group,domains or users.
10991: end -> UNIX time for end of access (0 -> no end date)
10992: start -> UNIX time for start of access
10993:
10994: value -> XML description of access control
10995: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
10996: <start></start>
10997: <end></end>
10998:
10999: <password></password> for scope type = guest
11000:
11001: <domain></domain> for scope type = course or group
11002: <number></number>
11003: <roles id="">
11004: <role></role>
11005: <access></access>
11006: <section></section>
11007: <group></group>
11008: </roles>
11009:
11010: <dom></dom> for scope type = domains
11011:
11012: <users> for scope type = users
11013: <user>
11014: <uname></uname>
11015: <udom></udom>
11016: </user>
11017: </users>
11018: </scope>
11019:
11020: Access data is also aggregated for each file in an additional key=value pair:
11021: key -> path to file/file_name\0accesscontrol
11022: value -> reference to hash
11023: hash contains key = value pairs
11024: where key = uniqueID:scope_end_start
11025: value = UNIX time record was last updated
11026:
11027: Used to improve speed of look-ups of access controls for each file.
11028:
11029: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11030:
11031: modify_access_controls():
11032:
11033: Modifies access controls for a portfolio file
11034: Args
11035: 1. file name
11036: 2. reference to hash of required changes,
11037: 3. domain
11038: 4. username
11039: where domain,username are the domain of the portfolio owner
11040: (either a user or a course)
11041:
11042: Returns:
11043: 1. result of additions or updates ('ok' or 'error', with error message).
11044: 2. result of deletions ('ok' or 'error', with error message).
11045: 3. reference to hash of any new or updated access controls.
11046: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11047: key = integer (inbound ID)
11048: value = uniqueID
1.747 albertel 11049:
1.608 albertel 11050: =back
11051:
1.243 albertel 11052: =head2 HTTP Helper Routines
11053:
11054: =over 4
11055:
1.191 harris41 11056: =item *
11057:
11058: escape() : unpack non-word characters into CGI-compatible hex codes
11059:
11060: =item *
11061:
11062: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11063:
1.243 albertel 11064: =back
11065:
11066: =head1 PRIVATE SUBROUTINES
11067:
11068: =head2 Underlying communication routines (Shouldn't call)
11069:
11070: =over 4
11071:
11072: =item *
11073:
11074: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11075:
11076: =item *
11077:
11078: reply() : uses subreply to send a message to remote machine, logs all failures
11079:
11080: =item *
11081:
11082: critical() : passes a critical message to another server; if cannot
11083: get through then place message in connection buffer directory and
11084: returns con_delayed, if incapable of saving message, returns
11085: con_failed
11086:
11087: =item *
11088:
11089: reconlonc() : tries to reconnect lonc client processes.
11090:
11091: =back
11092:
11093: =head2 Resource Access Logging
11094:
11095: =over 4
11096:
11097: =item *
11098:
11099: flushcourselogs() : flush (save) buffer logs and access logs
11100:
11101: =item *
11102:
11103: courselog($what) : save message for course in hash
11104:
11105: =item *
11106:
11107: courseacclog($what) : save message for course using &courselog(). Perform
11108: special processing for specific resource types (problems, exams, quizzes, etc).
11109:
1.191 harris41 11110: =item *
11111:
11112: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11113: as a PerlChildExitHandler
1.243 albertel 11114:
11115: =back
11116:
11117: =head2 Other
11118:
11119: =over 4
11120:
11121: =item *
11122:
11123: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 11124:
11125: =back
11126:
11127: =cut
1.877 foxr 11128:
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