Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1053
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1053 ! raeburn 4: # $Id: lonnet.pm,v 1.1052 2010/02/25 03:43:27 raeburn Exp $
1.178 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.169 harris41 28: ###
29:
1.971 jms 30: =pod
31:
1.972 jms 32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
1.971 jms 51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
1.1 albertel 71: package Apache::lonnet;
72:
73: use strict;
1.8 www 74: use LWP::UserAgent();
1.486 www 75: use HTTP::Date;
1.977 amueller 76: use Image::Magick;
77:
1.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) = @_;
3022: my $outcome;
3023: if ($caller eq 'timeonly') {
3024: my $cids = '';
3025: foreach my $item (keys(%$storehash)) {
3026: $cids.=&escape($item).'&';
3027: }
3028: $cids=~s/\&$//;
3029: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3030: $coursehome);
3031: } else {
3032: my $items = '';
3033: foreach my $item (keys(%$storehash)) {
3034: $items.= &escape($item).'='.
3035: &freeze_escape($$storehash{$item}).'&';
3036: }
3037: $items=~s/\&$//;
3038: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3039: $coursehome);
1.918 raeburn 3040: }
3041: if ($outcome eq 'unknown_cmd') {
3042: my $what;
3043: foreach my $cid (keys(%$storehash)) {
3044: $what .= &escape($cid).'=';
1.921 raeburn 3045: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 3046: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 3047: }
3048: $what =~ s/\:$/&/;
3049: }
3050: $what =~ s/\&$//;
3051: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3052: } else {
3053: return $outcome;
3054: }
1.353 www 3055: }
3056:
3057: sub courseiddump {
1.921 raeburn 3058: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 3059: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 3060: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3061: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
1.918 raeburn 3062: my $as_hash = 1;
3063: my %returnhash;
3064: if (!$domfilter) { $domfilter=''; }
1.845 albertel 3065: my %libserv = &all_library();
3066: foreach my $tryserver (keys(%libserv)) {
3067: if ( ( $hostidflag == 1
3068: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3069: || (!defined($hostidflag)) ) {
3070:
1.918 raeburn 3071: if (($domfilter eq '') ||
3072: (&host_domain($tryserver) eq $domfilter)) {
3073: my $rep =
3074: &reply('courseiddump:'.&host_domain($tryserver).':'.
3075: $sincefilter.':'.&escape($descfilter).':'.
3076: &escape($instcodefilter).':'.&escape($ownerfilter).
3077: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947 raeburn 3078: ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962 raeburn 3079: &escape($selfenrollonly).':'.&escape($catfilter).':'.
1.1008 raeburn 3080: $showhidden.':'.$caller.':'.&escape($cloner).':'.
1.1029 raeburn 3081: &escape($cc_clone).':'.$cloneonly.':'.
3082: &escape($createdbefore).':'.&escape($createdafter).':'.
3083: &escape($creationcontext),$tryserver);
1.918 raeburn 3084: my @pairs=split(/\&/,$rep);
3085: foreach my $item (@pairs) {
3086: my ($key,$value)=split(/\=/,$item,2);
3087: $key = &unescape($key);
3088: next if ($key =~ /^error: 2 /);
3089: my $result = &thaw_unescape($value);
3090: if (ref($result) eq 'HASH') {
3091: $returnhash{$key}=$result;
3092: } else {
1.921 raeburn 3093: my @responses = split(/:/,$value);
3094: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3095: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3096: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3097: }
1.1008 raeburn 3098: }
1.353 www 3099: }
3100: }
3101: }
3102: }
3103: return %returnhash;
3104: }
3105:
1.658 raeburn 3106: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3107:
3108: sub dcmailput {
1.685 raeburn 3109: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3110: my $status = &Apache::lonnet::critical(
1.740 www 3111: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3112: &escape($message),$server);
1.662 raeburn 3113: return $status;
3114: }
3115:
1.658 raeburn 3116: sub dcmaildump {
3117: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3118: my %returnhash=();
1.846 albertel 3119:
3120: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3121: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3122: &escape($enddate).':';
3123: my @esc_senders=map { &escape($_)} @$senders;
3124: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3125: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3126: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3127: if (($key) && ($value)) {
3128: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3129: }
3130: }
3131: }
3132: return %returnhash;
3133: }
1.662 raeburn 3134: # ---------------------------------------------------------- Domain roles
3135:
3136: sub get_domain_roles {
3137: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 3138: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 3139: $startdate = '.';
3140: }
1.1018 raeburn 3141: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 3142: $enddate = '.';
3143: }
1.922 raeburn 3144: my $rolelist;
3145: if (ref($roles) eq 'ARRAY') {
3146: $rolelist = join(':',@{$roles});
3147: }
1.662 raeburn 3148: my %personnel = ();
1.841 albertel 3149:
3150: my %servers = &get_servers($dom,'library');
3151: foreach my $tryserver (keys(%servers)) {
3152: %{$personnel{$tryserver}}=();
3153: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3154: &escape($startdate).':'.
3155: &escape($enddate).':'.
3156: &escape($rolelist), $tryserver))) {
3157: my ($key,$value) = split(/\=/,$line,2);
3158: if (($key) && ($value)) {
3159: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3160: }
3161: }
1.662 raeburn 3162: }
3163: return %personnel;
3164: }
1.658 raeburn 3165:
1.149 www 3166: # ----------------------------------------------------------- Check out an item
3167:
1.504 albertel 3168: sub get_first_access {
3169: my ($type,$argsymb)=@_;
1.790 albertel 3170: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3171: if ($argsymb) { $symb=$argsymb; }
3172: my ($map,$id,$res)=&decode_symb($symb);
1.926 albertel 3173: if ($type eq 'course') {
3174: $res='course';
3175: } elsif ($type eq 'map') {
1.588 albertel 3176: $res=&symbread($map);
3177: } else {
3178: $res=$symb;
3179: }
3180: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3181: return $times{"$courseid\0$res"};
1.504 albertel 3182: }
3183:
3184: sub set_first_access {
3185: my ($type)=@_;
1.790 albertel 3186: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3187: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 3188: if ($type eq 'course') {
3189: $res='course';
3190: } elsif ($type eq 'map') {
1.588 albertel 3191: $res=&symbread($map);
3192: } else {
3193: $res=$symb;
3194: }
3195: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 3196: if (!$firstaccess) {
1.588 albertel 3197: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 3198: }
3199: return 'already_set';
1.504 albertel 3200: }
3201:
1.149 www 3202: sub checkout {
3203: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3204: my $now=time;
3205: my $lonhost=$perlvar{'lonHostID'};
3206: my $infostr=&escape(
1.234 www 3207: 'CHECKOUTTOKEN&'.
1.149 www 3208: $tuname.'&'.
3209: $tudom.'&'.
3210: $tcrsid.'&'.
3211: $symb.'&'.
3212: $now.'&'.$ENV{'REMOTE_ADDR'});
3213: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 3214: if ($token=~/^error\:/) {
1.672 albertel 3215: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3216: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3217: "</font>");
3218: return '';
3219: }
3220:
1.149 www 3221: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3222: $token=~tr/a-z/A-Z/;
3223:
1.153 www 3224: my %infohash=('resource.0.outtoken' => $token,
3225: 'resource.0.checkouttime' => $now,
3226: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 3227:
3228: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3229: return '';
1.151 www 3230: } else {
1.672 albertel 3231: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3232: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3233: "</font>");
1.149 www 3234: }
3235:
3236: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3237: &escape('Checkout '.$infostr.' - '.
3238: $token)) ne 'ok') {
3239: return '';
1.151 www 3240: } else {
1.672 albertel 3241: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3242: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3243: "</font>");
1.149 www 3244: }
1.151 www 3245: return $token;
1.149 www 3246: }
3247:
3248: # ------------------------------------------------------------ Check in an item
3249:
3250: sub checkin {
3251: my $token=shift;
1.150 www 3252: my $now=time;
3253: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3254: $lonhost=~tr/A-Z/a-z/;
1.838 albertel 3255: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150 www 3256: $dtoken=~s/\W/\_/g;
1.234 www 3257: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 3258: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3259:
1.154 www 3260: unless (($tuname) && ($tudom)) {
3261: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3262: return '';
3263: }
3264:
3265: unless (&allowed('mgr',$tcrsid)) {
3266: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 3267: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 3268: return '';
3269: }
3270:
1.153 www 3271: my %infohash=('resource.0.intoken' => $token,
3272: 'resource.0.checkintime' => $now,
3273: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 3274:
3275: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3276: return '';
3277: }
3278:
3279: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3280: &escape('Checkin - '.$token)) ne 'ok') {
3281: return '';
3282: }
3283:
3284: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 3285: }
3286:
3287: # --------------------------------------------- Set Expire Date for Spreadsheet
3288:
3289: sub expirespread {
3290: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 3291: my $cid=$env{'request.course.id'};
1.110 www 3292: if ($cid) {
3293: my $now=time;
3294: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 3295: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3296: $env{'course.'.$cid.'.num'}.
1.110 www 3297: ':nohist_expirationdates:'.
3298: &escape($key).'='.$now,
1.620 albertel 3299: $env{'course.'.$cid.'.home'})
1.110 www 3300: }
3301: return 'ok';
1.14 www 3302: }
3303:
1.109 www 3304: # ----------------------------------------------------- Devalidate Spreadsheets
3305:
3306: sub devalidate {
1.325 www 3307: my ($symb,$uname,$udom)=@_;
1.620 albertel 3308: my $cid=$env{'request.course.id'};
1.109 www 3309: if ($cid) {
1.391 matthew 3310: # delete the stored spreadsheets for
3311: # - the student level sheet of this user in course's homespace
3312: # - the assessment level sheet for this resource
3313: # for this user in user's homespace
1.553 albertel 3314: # - current conditional state info
1.325 www 3315: my $key=$uname.':'.$udom.':';
1.109 www 3316: my $status=
1.299 matthew 3317: &del('nohist_calculatedsheets',
1.391 matthew 3318: [$key.'studentcalc:'],
1.620 albertel 3319: $env{'course.'.$cid.'.domain'},
3320: $env{'course.'.$cid.'.num'})
1.133 albertel 3321: .' '.
3322: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 3323: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 3324: unless ($status eq 'ok ok') {
3325: &logthis('Could not devalidate spreadsheet '.
1.325 www 3326: $uname.' at '.$udom.' for '.
1.109 www 3327: $symb.': '.$status);
1.133 albertel 3328: }
1.553 albertel 3329: &delenv('user.state.'.$cid);
1.109 www 3330: }
3331: }
3332:
1.265 albertel 3333: sub get_scalar {
3334: my ($string,$end) = @_;
3335: my $value;
3336: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3337: $value = $1;
3338: } elsif ($$string =~ s/^([^&]*?)&//) {
3339: $value = $1;
3340: }
3341: return &unescape($value);
3342: }
3343:
3344: sub array2str {
3345: my (@array) = @_;
3346: my $result=&arrayref2str(\@array);
3347: $result=~s/^__ARRAY_REF__//;
3348: $result=~s/__END_ARRAY_REF__$//;
3349: return $result;
3350: }
3351:
1.204 albertel 3352: sub arrayref2str {
3353: my ($arrayref) = @_;
1.265 albertel 3354: my $result='__ARRAY_REF__';
1.204 albertel 3355: foreach my $elem (@$arrayref) {
1.265 albertel 3356: if(ref($elem) eq 'ARRAY') {
3357: $result.=&arrayref2str($elem).'&';
3358: } elsif(ref($elem) eq 'HASH') {
3359: $result.=&hashref2str($elem).'&';
3360: } elsif(ref($elem)) {
3361: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 3362: } else {
3363: $result.=&escape($elem).'&';
3364: }
3365: }
3366: $result=~s/\&$//;
1.265 albertel 3367: $result .= '__END_ARRAY_REF__';
1.204 albertel 3368: return $result;
3369: }
3370:
1.168 albertel 3371: sub hash2str {
1.204 albertel 3372: my (%hash) = @_;
3373: my $result=&hashref2str(\%hash);
1.265 albertel 3374: $result=~s/^__HASH_REF__//;
3375: $result=~s/__END_HASH_REF__$//;
1.204 albertel 3376: return $result;
3377: }
3378:
3379: sub hashref2str {
3380: my ($hashref)=@_;
1.265 albertel 3381: my $result='__HASH_REF__';
1.800 albertel 3382: foreach my $key (sort(keys(%$hashref))) {
3383: if (ref($key) eq 'ARRAY') {
3384: $result.=&arrayref2str($key).'=';
3385: } elsif (ref($key) eq 'HASH') {
3386: $result.=&hashref2str($key).'=';
3387: } elsif (ref($key)) {
1.265 albertel 3388: $result.='=';
1.800 albertel 3389: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 3390: } else {
1.800 albertel 3391: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 3392: }
3393:
1.800 albertel 3394: if(ref($hashref->{$key}) eq 'ARRAY') {
3395: $result.=&arrayref2str($hashref->{$key}).'&';
3396: } elsif(ref($hashref->{$key}) eq 'HASH') {
3397: $result.=&hashref2str($hashref->{$key}).'&';
3398: } elsif(ref($hashref->{$key})) {
1.265 albertel 3399: $result.='&';
1.800 albertel 3400: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 3401: } else {
1.800 albertel 3402: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 3403: }
3404: }
1.168 albertel 3405: $result=~s/\&$//;
1.265 albertel 3406: $result .= '__END_HASH_REF__';
1.168 albertel 3407: return $result;
3408: }
3409:
3410: sub str2hash {
1.265 albertel 3411: my ($string)=@_;
3412: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3413: return %$hash;
3414: }
3415:
3416: sub str2hashref {
1.168 albertel 3417: my ($string) = @_;
1.265 albertel 3418:
3419: my %hash;
3420:
3421: if($string !~ /^__HASH_REF__/) {
3422: if (! ($string eq '' || !defined($string))) {
3423: $hash{'error'}='Not hash reference';
3424: }
3425: return (\%hash, $string);
3426: }
3427:
3428: $string =~ s/^__HASH_REF__//;
3429:
3430: while($string !~ /^__END_HASH_REF__/) {
3431: #key
3432: my $key='';
3433: if($string =~ /^__HASH_REF__/) {
3434: ($key, $string)=&str2hashref($string);
3435: if(defined($key->{'error'})) {
3436: $hash{'error'}='Bad data';
3437: return (\%hash, $string);
3438: }
3439: } elsif($string =~ /^__ARRAY_REF__/) {
3440: ($key, $string)=&str2arrayref($string);
3441: if($key->[0] eq 'Array reference error') {
3442: $hash{'error'}='Bad data';
3443: return (\%hash, $string);
3444: }
3445: } else {
3446: $string =~ s/^(.*?)=//;
1.267 albertel 3447: $key=&unescape($1);
1.265 albertel 3448: }
3449: $string =~ s/^=//;
3450:
3451: #value
3452: my $value='';
3453: if($string =~ /^__HASH_REF__/) {
3454: ($value, $string)=&str2hashref($string);
3455: if(defined($value->{'error'})) {
3456: $hash{'error'}='Bad data';
3457: return (\%hash, $string);
3458: }
3459: } elsif($string =~ /^__ARRAY_REF__/) {
3460: ($value, $string)=&str2arrayref($string);
3461: if($value->[0] eq 'Array reference error') {
3462: $hash{'error'}='Bad data';
3463: return (\%hash, $string);
3464: }
3465: } else {
3466: $value=&get_scalar(\$string,'__END_HASH_REF__');
3467: }
3468: $string =~ s/^&//;
3469:
3470: $hash{$key}=$value;
1.204 albertel 3471: }
1.265 albertel 3472:
3473: $string =~ s/^__END_HASH_REF__//;
3474:
3475: return (\%hash, $string);
1.204 albertel 3476: }
3477:
3478: sub str2array {
1.265 albertel 3479: my ($string)=@_;
3480: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3481: return @$array;
3482: }
3483:
3484: sub str2arrayref {
1.204 albertel 3485: my ($string) = @_;
1.265 albertel 3486: my @array;
3487:
3488: if($string !~ /^__ARRAY_REF__/) {
3489: if (! ($string eq '' || !defined($string))) {
3490: $array[0]='Array reference error';
3491: }
3492: return (\@array, $string);
3493: }
3494:
3495: $string =~ s/^__ARRAY_REF__//;
3496:
3497: while($string !~ /^__END_ARRAY_REF__/) {
3498: my $value='';
3499: if($string =~ /^__HASH_REF__/) {
3500: ($value, $string)=&str2hashref($string);
3501: if(defined($value->{'error'})) {
3502: $array[0] ='Array reference error';
3503: return (\@array, $string);
3504: }
3505: } elsif($string =~ /^__ARRAY_REF__/) {
3506: ($value, $string)=&str2arrayref($string);
3507: if($value->[0] eq 'Array reference error') {
3508: $array[0] ='Array reference error';
3509: return (\@array, $string);
3510: }
3511: } else {
3512: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3513: }
3514: $string =~ s/^&//;
3515:
3516: push(@array, $value);
1.191 harris41 3517: }
1.265 albertel 3518:
3519: $string =~ s/^__END_ARRAY_REF__//;
3520:
3521: return (\@array, $string);
1.168 albertel 3522: }
3523:
1.167 albertel 3524: # -------------------------------------------------------------------Temp Store
3525:
1.168 albertel 3526: sub tmpreset {
3527: my ($symb,$namespace,$domain,$stuname) = @_;
3528: if (!$symb) {
3529: $symb=&symbread();
1.620 albertel 3530: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3531: }
3532: $symb=escape($symb);
3533:
1.620 albertel 3534: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3535: $namespace=~s/\//\_/g;
3536: $namespace=~s/\W//g;
3537:
1.620 albertel 3538: if (!$domain) { $domain=$env{'user.domain'}; }
3539: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3540: if ($domain eq 'public' && $stuname eq 'public') {
3541: $stuname=$ENV{'REMOTE_ADDR'};
3542: }
1.168 albertel 3543: my $path=$perlvar{'lonDaemons'}.'/tmp';
3544: my %hash;
3545: if (tie(%hash,'GDBM_File',
3546: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3547: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 3548: foreach my $key (keys(%hash)) {
1.180 albertel 3549: if ($key=~ /:$symb/) {
1.168 albertel 3550: delete($hash{$key});
3551: }
3552: }
3553: }
3554: }
3555:
1.167 albertel 3556: sub tmpstore {
1.168 albertel 3557: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3558:
3559: if (!$symb) {
3560: $symb=&symbread();
1.620 albertel 3561: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3562: }
3563: $symb=escape($symb);
3564:
3565: if (!$namespace) {
3566: # I don't think we would ever want to store this for a course.
3567: # it seems this will only be used if we don't have a course.
1.620 albertel 3568: #$namespace=$env{'request.course.id'};
1.168 albertel 3569: #if (!$namespace) {
1.620 albertel 3570: $namespace=$env{'request.state'};
1.168 albertel 3571: #}
3572: }
3573: $namespace=~s/\//\_/g;
3574: $namespace=~s/\W//g;
1.620 albertel 3575: if (!$domain) { $domain=$env{'user.domain'}; }
3576: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3577: if ($domain eq 'public' && $stuname eq 'public') {
3578: $stuname=$ENV{'REMOTE_ADDR'};
3579: }
1.168 albertel 3580: my $now=time;
3581: my %hash;
3582: my $path=$perlvar{'lonDaemons'}.'/tmp';
3583: if (tie(%hash,'GDBM_File',
3584: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3585: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3586: $hash{"version:$symb"}++;
3587: my $version=$hash{"version:$symb"};
3588: my $allkeys='';
3589: foreach my $key (keys(%$storehash)) {
3590: $allkeys.=$key.':';
1.591 albertel 3591: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3592: }
3593: $hash{"$version:$symb:timestamp"}=$now;
3594: $allkeys.='timestamp';
3595: $hash{"$version:keys:$symb"}=$allkeys;
3596: if (untie(%hash)) {
3597: return 'ok';
3598: } else {
3599: return "error:$!";
3600: }
3601: } else {
3602: return "error:$!";
3603: }
3604: }
1.167 albertel 3605:
1.168 albertel 3606: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3607:
1.168 albertel 3608: sub tmprestore {
3609: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3610:
1.168 albertel 3611: if (!$symb) {
3612: $symb=&symbread();
1.620 albertel 3613: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3614: }
3615: $symb=escape($symb);
3616:
1.620 albertel 3617: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3618:
1.620 albertel 3619: if (!$domain) { $domain=$env{'user.domain'}; }
3620: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3621: if ($domain eq 'public' && $stuname eq 'public') {
3622: $stuname=$ENV{'REMOTE_ADDR'};
3623: }
1.168 albertel 3624: my %returnhash;
3625: $namespace=~s/\//\_/g;
3626: $namespace=~s/\W//g;
3627: my %hash;
3628: my $path=$perlvar{'lonDaemons'}.'/tmp';
3629: if (tie(%hash,'GDBM_File',
3630: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3631: &GDBM_READER(),0640)) {
1.168 albertel 3632: my $version=$hash{"version:$symb"};
3633: $returnhash{'version'}=$version;
3634: my $scope;
3635: for ($scope=1;$scope<=$version;$scope++) {
3636: my $vkeys=$hash{"$scope:keys:$symb"};
3637: my @keys=split(/:/,$vkeys);
3638: my $key;
3639: $returnhash{"$scope:keys"}=$vkeys;
3640: foreach $key (@keys) {
1.591 albertel 3641: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3642: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3643: }
3644: }
1.168 albertel 3645: if (!(untie(%hash))) {
3646: return "error:$!";
3647: }
3648: } else {
3649: return "error:$!";
3650: }
3651: return %returnhash;
1.167 albertel 3652: }
3653:
1.9 www 3654: # ----------------------------------------------------------------------- Store
3655:
3656: sub store {
1.124 www 3657: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3658: my $home='';
3659:
1.168 albertel 3660: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3661:
1.213 www 3662: $symb=&symbclean($symb);
1.122 albertel 3663: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3664:
1.620 albertel 3665: if (!$domain) { $domain=$env{'user.domain'}; }
3666: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3667:
3668: &devalidate($symb,$stuname,$domain);
1.109 www 3669:
3670: $symb=escape($symb);
1.187 www 3671: if (!$namespace) {
1.620 albertel 3672: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3673: return '';
3674: }
3675: }
1.620 albertel 3676: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3677:
3678: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3679: $$storehash{'host'}=$perlvar{'lonHostID'};
3680:
1.12 www 3681: my $namevalue='';
1.800 albertel 3682: foreach my $key (keys(%$storehash)) {
3683: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3684: }
1.12 www 3685: $namevalue=~s/\&$//;
1.187 www 3686: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3687: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3688: }
3689:
1.47 www 3690: # -------------------------------------------------------------- Critical Store
3691:
3692: sub cstore {
1.124 www 3693: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3694: my $home='';
3695:
1.168 albertel 3696: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3697:
1.213 www 3698: $symb=&symbclean($symb);
1.122 albertel 3699: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3700:
1.620 albertel 3701: if (!$domain) { $domain=$env{'user.domain'}; }
3702: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3703:
3704: &devalidate($symb,$stuname,$domain);
1.109 www 3705:
3706: $symb=escape($symb);
1.187 www 3707: if (!$namespace) {
1.620 albertel 3708: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3709: return '';
3710: }
3711: }
1.620 albertel 3712: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3713:
3714: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3715: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3716:
1.47 www 3717: my $namevalue='';
1.800 albertel 3718: foreach my $key (keys(%$storehash)) {
3719: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3720: }
1.47 www 3721: $namevalue=~s/\&$//;
1.187 www 3722: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3723: return critical
3724: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3725: }
3726:
1.9 www 3727: # --------------------------------------------------------------------- Restore
3728:
3729: sub restore {
1.124 www 3730: my ($symb,$namespace,$domain,$stuname) = @_;
3731: my $home='';
3732:
1.168 albertel 3733: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3734:
1.122 albertel 3735: if (!$symb) {
3736: unless ($symb=escape(&symbread())) { return ''; }
3737: } else {
1.213 www 3738: $symb=&escape(&symbclean($symb));
1.122 albertel 3739: }
1.188 www 3740: if (!$namespace) {
1.620 albertel 3741: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3742: return '';
3743: }
3744: }
1.620 albertel 3745: if (!$domain) { $domain=$env{'user.domain'}; }
3746: if (!$stuname) { $stuname=$env{'user.name'}; }
3747: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3748: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3749:
1.12 www 3750: my %returnhash=();
1.800 albertel 3751: foreach my $line (split(/\&/,$answer)) {
3752: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3753: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3754: }
1.75 www 3755: my $version;
3756: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3757: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3758: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3759: }
1.75 www 3760: }
1.13 www 3761: return %returnhash;
1.34 www 3762: }
3763:
3764: # ---------------------------------------------------------- Course Description
3765:
3766: sub coursedescription {
1.731 albertel 3767: my ($courseid,$args)=@_;
1.34 www 3768: $courseid=~s/^\///;
1.49 www 3769: $courseid=~s/\_/\//g;
1.34 www 3770: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3771: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3772: my $normalid=$cdomain.'_'.$cnum;
3773: # need to always cache even if we get errors otherwise we keep
3774: # trying and trying and trying to get the course description.
3775: my %envhash=();
3776: my %returnhash=();
1.731 albertel 3777:
3778: my $expiretime=600;
3779: if ($env{'request.course.id'} eq $normalid) {
3780: $expiretime=120;
3781: }
3782:
3783: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3784: if (!$args->{'freshen_cache'}
3785: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3786: foreach my $key (keys(%env)) {
3787: next if ($key !~ /^\Q$prefix\E(.*)/);
3788: my ($setting) = $1;
3789: $returnhash{$setting} = $env{$key};
3790: }
3791: return %returnhash;
3792: }
3793:
3794: # get the data agin
3795: if (!$args->{'one_time'}) {
3796: $envhash{'course.'.$normalid.'.last_cache'}=time;
3797: }
1.811 albertel 3798:
1.34 www 3799: if ($chome ne 'no_host') {
1.302 albertel 3800: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3801: if (!exists($returnhash{'con_lost'})) {
3802: $returnhash{'home'}= $chome;
3803: $returnhash{'domain'} = $cdomain;
3804: $returnhash{'num'} = $cnum;
1.741 raeburn 3805: if (!defined($returnhash{'type'})) {
3806: $returnhash{'type'} = 'Course';
3807: }
1.130 albertel 3808: while (my ($name,$value) = each %returnhash) {
1.53 www 3809: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3810: }
1.270 www 3811: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3812: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3813: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3814: $envhash{'course.'.$normalid.'.home'}=$chome;
3815: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3816: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3817: }
3818: }
1.731 albertel 3819: if (!$args->{'one_time'}) {
1.949 raeburn 3820: &appenv(\%envhash);
1.731 albertel 3821: }
1.302 albertel 3822: return %returnhash;
1.461 www 3823: }
3824:
3825: # -------------------------------------------------See if a user is privileged
3826:
3827: sub privileged {
3828: my ($username,$domain)=@_;
3829: my $rolesdump=&reply("dump:$domain:$username:roles",
3830: &homeserver($username,$domain));
1.1033 raeburn 3831: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3832: ($rolesdump =~ /^error:/)) {
3833: return 0;
3834: }
1.461 www 3835: my $now=time;
3836: if ($rolesdump ne '') {
1.800 albertel 3837: foreach my $entry (split(/&/,$rolesdump)) {
3838: if ($entry!~/^rolesdef_/) {
3839: my ($area,$role)=split(/=/,$entry);
1.461 www 3840: $area=~s/\_\w\w$//;
3841: my ($trole,$tend,$tstart)=split(/_/,$role);
3842: if (($trole eq 'dc') || ($trole eq 'su')) {
3843: my $active=1;
3844: if ($tend) {
3845: if ($tend<$now) { $active=0; }
3846: }
3847: if ($tstart) {
3848: if ($tstart>$now) { $active=0; }
3849: }
3850: if ($active) { return 1; }
3851: }
3852: }
3853: }
3854: }
3855: return 0;
1.9 www 3856: }
1.1 albertel 3857:
1.103 harris41 3858: # -------------------------------------------------------- Get user privileges
1.11 www 3859:
3860: sub rolesinit {
3861: my ($domain,$username,$authhost)=@_;
1.1034 raeburn 3862: my $now=time;
3863: my %userroles = ('user.login.time' => $now);
1.11 www 3864: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.1033 raeburn 3865: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3866: ($rolesdump =~ /^error:/)) {
3867: return \%userroles;
3868: }
1.11 www 3869: my %allroles=();
1.678 raeburn 3870: my %allgroups=();
3871: my $group_privs;
1.11 www 3872:
3873: if ($rolesdump ne '') {
1.800 albertel 3874: foreach my $entry (split(/&/,$rolesdump)) {
3875: if ($entry!~/^rolesdef_/) {
3876: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3877: $area=~s/\_\w\w$//;
1.678 raeburn 3878: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3879: if ($role=~/^cr/) {
1.807 albertel 3880: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3881: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3882: ($tend,$tstart)=split('_',$trest);
3883: } else {
3884: $trole=$role;
3885: }
1.678 raeburn 3886: } elsif ($role =~ m|^gr/|) {
3887: ($trole,$tend,$tstart) = split(/_/,$role);
3888: ($trole,$group_privs) = split(/\//,$trole);
3889: $group_privs = &unescape($group_privs);
1.587 albertel 3890: } else {
3891: ($trole,$tend,$tstart)=split(/_/,$role);
3892: }
1.743 albertel 3893: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3894: $username);
3895: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3896: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3897: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3898: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3899: my $spec=$trole.'.'.$area;
3900: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3901: if ($trole =~ /^cr\//) {
1.567 raeburn 3902: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3903: } elsif ($trole eq 'gr') {
3904: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3905: } else {
1.567 raeburn 3906: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3907: }
1.12 www 3908: }
1.662 raeburn 3909: }
1.191 harris41 3910: }
1.743 albertel 3911: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3912: $userroles{'user.adv'} = $adv;
3913: $userroles{'user.author'} = $author;
1.620 albertel 3914: $env{'user.adv'}=$adv;
1.11 www 3915: }
1.743 albertel 3916: return \%userroles;
1.11 www 3917: }
3918:
1.567 raeburn 3919: sub set_arearole {
3920: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3921: # log the associated role with the area
3922: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3923: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3924: }
3925:
3926: sub custom_roleprivs {
3927: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3928: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3929: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3930: if (&hostname($homsvr) ne '') {
1.567 raeburn 3931: my ($rdummy,$roledef)=
3932: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3933: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3934: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3935: if (defined($syspriv)) {
1.1043 raeburn 3936: if ($trest =~ /^$match_community$/) {
3937: $syspriv =~ s/bre\&S//;
3938: }
1.567 raeburn 3939: $$allroles{'cm./'}.=':'.$syspriv;
3940: $$allroles{$spec.'./'}.=':'.$syspriv;
3941: }
3942: if ($tdomain ne '') {
3943: if (defined($dompriv)) {
3944: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3945: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3946: }
3947: if (($trest ne '') && (defined($coursepriv))) {
3948: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3949: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3950: }
3951: }
3952: }
3953: }
3954: }
3955:
1.678 raeburn 3956: sub group_roleprivs {
3957: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3958: my $access = 1;
3959: my $now = time;
3960: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3961: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3962: if ($access) {
1.811 albertel 3963: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 3964: $$allgroups{$course}{$group} .=':'.$group_privs;
3965: }
3966: }
1.567 raeburn 3967:
3968: sub standard_roleprivs {
3969: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3970: if (defined($pr{$trole.':s'})) {
3971: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3972: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3973: }
3974: if ($tdomain ne '') {
3975: if (defined($pr{$trole.':d'})) {
3976: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3977: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3978: }
3979: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3980: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3981: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3982: }
3983: }
3984: }
3985:
3986: sub set_userprivs {
1.678 raeburn 3987: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 3988: my $author=0;
3989: my $adv=0;
1.678 raeburn 3990: my %grouproles = ();
3991: if (keys(%{$allgroups}) > 0) {
1.1000 raeburn 3992: foreach my $role (keys(%{$allroles})) {
1.681 raeburn 3993: my ($trole,$area,$sec,$extendedarea);
1.881 raeburn 3994: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
1.678 raeburn 3995: $trole = $1;
3996: $area = $2;
1.681 raeburn 3997: $sec = $3;
3998: $extendedarea = $area.$sec;
3999: if (exists($$allgroups{$area})) {
4000: foreach my $group (keys(%{$$allgroups{$area}})) {
4001: my $spec = $trole.'.'.$extendedarea;
4002: $grouproles{$spec.'.'.$area.'/'.$group} =
4003: $$allgroups{$area}{$group};
1.678 raeburn 4004: }
4005: }
4006: }
4007: }
4008: }
1.800 albertel 4009: foreach my $group (keys(%grouproles)) {
4010: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 4011: }
1.800 albertel 4012: foreach my $role (keys(%{$allroles})) {
4013: my %thesepriv;
1.941 raeburn 4014: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 4015: foreach my $item (split(/:/,$$allroles{$role})) {
4016: if ($item ne '') {
4017: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 4018: if ($restrictions eq '') {
4019: $thesepriv{$privilege}='F';
4020: } elsif ($thesepriv{$privilege} ne 'F') {
4021: $thesepriv{$privilege}.=$restrictions;
4022: }
4023: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4024: }
4025: }
4026: my $thesestr='';
1.800 albertel 4027: foreach my $priv (keys(%thesepriv)) {
4028: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4029: }
4030: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 4031: }
4032: return ($author,$adv);
4033: }
4034:
1.994 raeburn 4035: sub role_status {
1.1002 raeburn 4036: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 4037: my @pwhere = ();
4038: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4039: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4040: unless (!defined($$role) || $$role eq '') {
4041: $$where=join('.',@pwhere);
4042: $$trolecode=$$role.'.'.$$where;
4043: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4044: $$tstatus='is';
4045: if ($$tstart && $$tstart>$then) {
4046: $$tstatus='future';
1.1034 raeburn 4047: if ($$tstart<$now) {
4048: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 4049: if (($$where ne '') && ($$role ne '')) {
4050: my (%allroles,%allgroups,$group_privs);
4051: my %userroles = (
4052: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4053: );
4054: my $spec=$$role.'.'.$$where;
4055: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4056: if ($$role =~ /^cr\//) {
4057: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4058: } elsif ($$role eq 'gr') {
4059: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4060: $env{'user.name'});
4061: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
4062: (undef,my $group_privs) = split(/\//,$trole);
4063: $group_privs = &unescape($group_privs);
4064: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4065: } else {
4066: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4067: }
4068: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
4069: &appenv(\%userroles,[$$role,'cm']);
4070: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4071: }
4072: }
1.1034 raeburn 4073: $$tstatus = 'is';
1.1002 raeburn 4074: }
1.994 raeburn 4075: }
4076: if ($$tend) {
4077: if ($$tend<$then) {
4078: $$tstatus='expired';
4079: } elsif ($$tend<$now) {
4080: $$tstatus='will_not';
4081: }
4082: }
4083: }
4084: }
4085: }
4086:
4087: sub check_adhoc_privs {
1.1002 raeburn 4088: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994 raeburn 4089: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4090: if ($env{$cckey}) {
4091: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002 raeburn 4092: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 4093: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4094: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4095: }
4096: } else {
4097: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4098: }
4099: }
4100:
4101: sub set_adhoc_privileges {
4102: # role can be cc or ca
4103: my ($dcdom,$pickedcourse,$role) = @_;
4104: my $area = '/'.$dcdom.'/'.$pickedcourse;
4105: my $spec = $role.'.'.$area;
4106: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4107: $env{'user.name'});
4108: my %ccrole = ();
4109: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4110: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4111: &appenv(\%userroles,[$role,'cm']);
4112: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4113: &appenv( {'request.role' => $spec,
4114: 'request.role.domain' => $dcdom,
4115: 'request.course.sec' => ''
4116: }
4117: );
4118: my $tadv=0;
4119: if (&allowed('adv') eq 'F') { $tadv=1; }
4120: &appenv({'request.role.adv' => $tadv});
4121: }
4122:
1.12 www 4123: # --------------------------------------------------------------- get interface
4124:
4125: sub get {
1.131 albertel 4126: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4127: my $items='';
1.800 albertel 4128: foreach my $item (@$storearr) {
4129: $items.=&escape($item).'&';
1.191 harris41 4130: }
1.12 www 4131: $items=~s/\&$//;
1.620 albertel 4132: if (!$udomain) { $udomain=$env{'user.domain'}; }
4133: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 4134: my $uhome=&homeserver($uname,$udomain);
4135:
1.133 albertel 4136: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4137: my @pairs=split(/\&/,$rep);
1.273 albertel 4138: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4139: return @pairs;
4140: }
1.15 www 4141: my %returnhash=();
1.42 www 4142: my $i=0;
1.800 albertel 4143: foreach my $item (@$storearr) {
4144: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4145: $i++;
1.191 harris41 4146: }
1.15 www 4147: return %returnhash;
1.27 www 4148: }
4149:
4150: # --------------------------------------------------------------- del interface
4151:
4152: sub del {
1.133 albertel 4153: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 4154: my $items='';
1.800 albertel 4155: foreach my $item (@$storearr) {
4156: $items.=&escape($item).'&';
1.191 harris41 4157: }
1.984 neumanie 4158:
1.27 www 4159: $items=~s/\&$//;
1.620 albertel 4160: if (!$udomain) { $udomain=$env{'user.domain'}; }
4161: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4162: my $uhome=&homeserver($uname,$udomain);
4163: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4164: }
4165:
4166: # -------------------------------------------------------------- dump interface
4167:
4168: sub dump {
1.755 albertel 4169: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4170: if (!$udomain) { $udomain=$env{'user.domain'}; }
4171: if (!$uname) { $uname=$env{'user.name'}; }
4172: my $uhome=&homeserver($uname,$udomain);
4173: if ($regexp) {
4174: $regexp=&escape($regexp);
4175: } else {
4176: $regexp='.';
4177: }
4178: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4179: my @pairs=split(/\&/,$rep);
4180: my %returnhash=();
4181: foreach my $item (@pairs) {
4182: my ($key,$value)=split(/=/,$item,2);
4183: $key = &unescape($key);
4184: next if ($key =~ /^error: 2 /);
4185: $returnhash{$key}=&thaw_unescape($value);
4186: }
4187: return %returnhash;
1.407 www 4188: }
4189:
1.717 albertel 4190: # --------------------------------------------------------- dumpstore interface
4191:
4192: sub dumpstore {
4193: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 4194: if (!$udomain) { $udomain=$env{'user.domain'}; }
4195: if (!$uname) { $uname=$env{'user.name'}; }
4196: my $uhome=&homeserver($uname,$udomain);
4197: if ($regexp) {
4198: $regexp=&escape($regexp);
4199: } else {
4200: $regexp='.';
4201: }
4202: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4203: my @pairs=split(/\&/,$rep);
4204: my %returnhash=();
4205: foreach my $item (@pairs) {
4206: my ($key,$value)=split(/=/,$item,2);
4207: next if ($key =~ /^error: 2 /);
4208: $returnhash{$key}=&thaw_unescape($value);
4209: }
4210: return %returnhash;
1.717 albertel 4211: }
4212:
1.407 www 4213: # -------------------------------------------------------------- keys interface
4214:
4215: sub getkeys {
4216: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 4217: if (!$udomain) { $udomain=$env{'user.domain'}; }
4218: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 4219: my $uhome=&homeserver($uname,$udomain);
4220: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4221: my @keyarray=();
1.800 albertel 4222: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 4223: next if ($key =~ /^error: 2 /);
1.800 albertel 4224: push(@keyarray,&unescape($key));
1.407 www 4225: }
4226: return @keyarray;
1.318 matthew 4227: }
4228:
1.319 matthew 4229: # --------------------------------------------------------------- currentdump
4230: sub currentdump {
1.328 matthew 4231: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 4232: $courseid = $env{'request.course.id'} if (! defined($courseid));
4233: $sdom = $env{'user.domain'} if (! defined($sdom));
4234: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 4235: my $uhome = &homeserver($sname,$sdom);
4236: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 4237: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 4238: #
1.318 matthew 4239: my %returnhash=();
1.319 matthew 4240: #
4241: if ($rep eq "unknown_cmd") {
4242: # an old lond will not know currentdump
4243: # Do a dump and make it look like a currentdump
1.822 albertel 4244: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 4245: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4246: my %hash = @tmp;
4247: @tmp=();
1.424 matthew 4248: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 4249: } else {
4250: my @pairs=split(/\&/,$rep);
1.800 albertel 4251: foreach my $pair (@pairs) {
4252: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 4253: my ($symb,$param) = split(/:/,$key);
4254: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 4255: &thaw_unescape($value);
1.319 matthew 4256: }
1.191 harris41 4257: }
1.12 www 4258: return %returnhash;
1.424 matthew 4259: }
4260:
4261: sub convert_dump_to_currentdump{
4262: my %hash = %{shift()};
4263: my %returnhash;
4264: # Code ripped from lond, essentially. The only difference
4265: # here is the unescaping done by lonnet::dump(). Conceivably
4266: # we might run in to problems with parameter names =~ /^v\./
4267: while (my ($key,$value) = each(%hash)) {
4268: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 4269: $symb = &unescape($symb);
4270: $param = &unescape($param);
1.424 matthew 4271: next if ($v eq 'version' || $symb eq 'keys');
4272: next if (exists($returnhash{$symb}) &&
4273: exists($returnhash{$symb}->{$param}) &&
4274: $returnhash{$symb}->{'v.'.$param} > $v);
4275: $returnhash{$symb}->{$param}=$value;
4276: $returnhash{$symb}->{'v.'.$param}=$v;
4277: }
4278: #
4279: # Remove all of the keys in the hashes which keep track of
4280: # the version of the parameter.
4281: while (my ($symb,$param_hash) = each(%returnhash)) {
4282: # use a foreach because we are going to delete from the hash.
4283: foreach my $key (keys(%$param_hash)) {
4284: delete($param_hash->{$key}) if ($key =~ /^v\./);
4285: }
4286: }
4287: return \%returnhash;
1.12 www 4288: }
4289:
1.627 albertel 4290: # ------------------------------------------------------ critical inc interface
4291:
4292: sub cinc {
4293: return &inc(@_,'critical');
4294: }
4295:
1.449 matthew 4296: # --------------------------------------------------------------- inc interface
4297:
4298: sub inc {
1.627 albertel 4299: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 4300: if (!$udomain) { $udomain=$env{'user.domain'}; }
4301: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 4302: my $uhome=&homeserver($uname,$udomain);
4303: my $items='';
4304: if (! ref($store)) {
4305: # got a single value, so use that instead
4306: $items = &escape($store).'=&';
4307: } elsif (ref($store) eq 'SCALAR') {
4308: $items = &escape($$store).'=&';
4309: } elsif (ref($store) eq 'ARRAY') {
4310: $items = join('=&',map {&escape($_);} @{$store});
4311: } elsif (ref($store) eq 'HASH') {
4312: while (my($key,$value) = each(%{$store})) {
4313: $items.= &escape($key).'='.&escape($value).'&';
4314: }
4315: }
4316: $items=~s/\&$//;
1.627 albertel 4317: if ($critical) {
4318: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4319: } else {
4320: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4321: }
1.449 matthew 4322: }
4323:
1.12 www 4324: # --------------------------------------------------------------- put interface
4325:
4326: sub put {
1.134 albertel 4327: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4328: if (!$udomain) { $udomain=$env{'user.domain'}; }
4329: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4330: my $uhome=&homeserver($uname,$udomain);
1.12 www 4331: my $items='';
1.800 albertel 4332: foreach my $item (keys(%$storehash)) {
4333: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4334: }
1.12 www 4335: $items=~s/\&$//;
1.134 albertel 4336: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 4337: }
4338:
1.631 albertel 4339: # ------------------------------------------------------------ newput interface
4340:
4341: sub newput {
4342: my ($namespace,$storehash,$udomain,$uname)=@_;
4343: if (!$udomain) { $udomain=$env{'user.domain'}; }
4344: if (!$uname) { $uname=$env{'user.name'}; }
4345: my $uhome=&homeserver($uname,$udomain);
4346: my $items='';
4347: foreach my $key (keys(%$storehash)) {
4348: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4349: }
4350: $items=~s/\&$//;
4351: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4352: }
4353:
4354: # --------------------------------------------------------- putstore interface
4355:
1.524 raeburn 4356: sub putstore {
1.715 albertel 4357: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 4358: if (!$udomain) { $udomain=$env{'user.domain'}; }
4359: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 4360: my $uhome=&homeserver($uname,$udomain);
4361: my $items='';
1.715 albertel 4362: foreach my $key (keys(%$storehash)) {
4363: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 4364: }
1.715 albertel 4365: $items=~s/\&$//;
1.716 albertel 4366: my $esc_symb=&escape($symb);
4367: my $esc_v=&escape($version);
1.715 albertel 4368: my $reply =
1.716 albertel 4369: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 4370: $uhome);
4371: if ($reply eq 'unknown_cmd') {
1.716 albertel 4372: # gfall back to way things use to be done
1.715 albertel 4373: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4374: $uname);
1.524 raeburn 4375: }
1.715 albertel 4376: return $reply;
4377: }
4378:
4379: sub old_putstore {
1.716 albertel 4380: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4381: if (!$udomain) { $udomain=$env{'user.domain'}; }
4382: if (!$uname) { $uname=$env{'user.name'}; }
4383: my $uhome=&homeserver($uname,$udomain);
4384: my %newstorehash;
1.800 albertel 4385: foreach my $item (keys(%$storehash)) {
4386: my $key = $version.':'.&escape($symb).':'.$item;
4387: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 4388: }
4389: my $items='';
4390: my %allitems = ();
1.800 albertel 4391: foreach my $item (keys(%newstorehash)) {
4392: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 4393: my $key = $1.':keys:'.$2;
4394: $allitems{$key} .= $3.':';
4395: }
1.800 albertel 4396: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 4397: }
1.800 albertel 4398: foreach my $item (keys(%allitems)) {
4399: $allitems{$item} =~ s/\:$//;
4400: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 4401: }
4402: $items=~s/\&$//;
4403: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 4404: }
4405:
1.47 www 4406: # ------------------------------------------------------ critical put interface
4407:
4408: sub cput {
1.134 albertel 4409: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4410: if (!$udomain) { $udomain=$env{'user.domain'}; }
4411: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4412: my $uhome=&homeserver($uname,$udomain);
1.47 www 4413: my $items='';
1.800 albertel 4414: foreach my $item (keys(%$storehash)) {
4415: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4416: }
1.47 www 4417: $items=~s/\&$//;
1.134 albertel 4418: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4419: }
4420:
4421: # -------------------------------------------------------------- eget interface
4422:
4423: sub eget {
1.133 albertel 4424: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4425: my $items='';
1.800 albertel 4426: foreach my $item (@$storearr) {
4427: $items.=&escape($item).'&';
1.191 harris41 4428: }
1.12 www 4429: $items=~s/\&$//;
1.620 albertel 4430: if (!$udomain) { $udomain=$env{'user.domain'}; }
4431: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4432: my $uhome=&homeserver($uname,$udomain);
4433: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4434: my @pairs=split(/\&/,$rep);
4435: my %returnhash=();
1.42 www 4436: my $i=0;
1.800 albertel 4437: foreach my $item (@$storearr) {
4438: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4439: $i++;
1.191 harris41 4440: }
1.12 www 4441: return %returnhash;
4442: }
4443:
1.667 albertel 4444: # ------------------------------------------------------------ tmpput interface
4445: sub tmpput {
1.802 raeburn 4446: my ($storehash,$server,$context)=@_;
1.667 albertel 4447: my $items='';
1.800 albertel 4448: foreach my $item (keys(%$storehash)) {
4449: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 4450: }
4451: $items=~s/\&$//;
1.802 raeburn 4452: if (defined($context)) {
4453: $items .= ':'.&escape($context);
4454: }
1.667 albertel 4455: return &reply("tmpput:$items",$server);
4456: }
4457:
4458: # ------------------------------------------------------------ tmpget interface
4459: sub tmpget {
1.688 albertel 4460: my ($token,$server)=@_;
4461: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4462: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 4463: my %returnhash;
4464: foreach my $item (split(/\&/,$rep)) {
4465: my ($key,$value)=split(/=/,$item);
1.951 raeburn 4466: next if ($key =~ /^error: 2 /);
1.667 albertel 4467: $returnhash{&unescape($key)}=&thaw_unescape($value);
4468: }
4469: return %returnhash;
4470: }
4471:
1.688 albertel 4472: # ------------------------------------------------------------ tmpget interface
4473: sub tmpdel {
4474: my ($token,$server)=@_;
4475: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4476: return &reply("tmpdel:$token",$server);
4477: }
4478:
1.765 albertel 4479: # -------------------------------------------------- portfolio access checking
4480:
4481: sub portfolio_access {
1.766 albertel 4482: my ($requrl) = @_;
1.765 albertel 4483: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4484: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 4485: if ($result) {
4486: my %setters;
4487: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4488: my ($startblock,$endblock) =
4489: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4490: if ($startblock && $endblock) {
4491: return 'B';
4492: }
4493: } else {
4494: my ($startblock,$endblock) =
4495: &Apache::loncommon::blockcheck(\%setters,'port');
4496: if ($startblock && $endblock) {
4497: return 'B';
4498: }
4499: }
4500: }
1.765 albertel 4501: if ($result eq 'ok') {
1.766 albertel 4502: return 'F';
1.765 albertel 4503: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 4504: return 'A';
1.765 albertel 4505: }
1.766 albertel 4506: return '';
1.765 albertel 4507: }
4508:
4509: sub get_portfolio_access {
1.767 albertel 4510: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4511:
4512: if (!ref($access_hash)) {
4513: my $current_perms = &get_portfile_permissions($udom,$unum);
4514: my %access_controls = &get_access_controls($current_perms,$group,
4515: $file_name);
4516: $access_hash = $access_controls{$file_name};
4517: }
4518:
1.765 albertel 4519: my ($public,$guest,@domains,@users,@courses,@groups);
4520: my $now = time;
4521: if (ref($access_hash) eq 'HASH') {
4522: foreach my $key (keys(%{$access_hash})) {
4523: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4524: if ($start > $now) {
4525: next;
4526: }
4527: if ($end && $end<$now) {
4528: next;
4529: }
4530: if ($scope eq 'public') {
4531: $public = $key;
4532: last;
4533: } elsif ($scope eq 'guest') {
4534: $guest = $key;
4535: } elsif ($scope eq 'domains') {
4536: push(@domains,$key);
4537: } elsif ($scope eq 'users') {
4538: push(@users,$key);
4539: } elsif ($scope eq 'course') {
4540: push(@courses,$key);
4541: } elsif ($scope eq 'group') {
4542: push(@groups,$key);
4543: }
4544: }
4545: if ($public) {
4546: return 'ok';
4547: }
4548: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4549: if ($guest) {
4550: return $guest;
4551: }
4552: } else {
4553: if (@domains > 0) {
4554: foreach my $domkey (@domains) {
4555: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4556: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4557: return 'ok';
4558: }
4559: }
4560: }
4561: }
4562: if (@users > 0) {
4563: foreach my $userkey (@users) {
1.865 raeburn 4564: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4565: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4566: if (ref($item) eq 'HASH') {
4567: if (($item->{'uname'} eq $env{'user.name'}) &&
4568: ($item->{'udom'} eq $env{'user.domain'})) {
4569: return 'ok';
4570: }
4571: }
4572: }
4573: }
1.765 albertel 4574: }
4575: }
4576: my %roleshash;
4577: my @courses_and_groups = @courses;
4578: push(@courses_and_groups,@groups);
4579: if (@courses_and_groups > 0) {
4580: my (%allgroups,%allroles);
4581: my ($start,$end,$role,$sec,$group);
4582: foreach my $envkey (%env) {
1.811 albertel 4583: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4584: my $cid = $2.'_'.$3;
4585: if ($1 eq 'gr') {
4586: $group = $4;
4587: $allgroups{$cid}{$group} = $env{$envkey};
4588: } else {
4589: if ($4 eq '') {
4590: $sec = 'none';
4591: } else {
4592: $sec = $4;
4593: }
4594: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4595: }
1.811 albertel 4596: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4597: my $cid = $2.'_'.$3;
4598: if ($4 eq '') {
4599: $sec = 'none';
4600: } else {
4601: $sec = $4;
4602: }
4603: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4604: }
4605: }
4606: if (keys(%allroles) == 0) {
4607: return;
4608: }
4609: foreach my $key (@courses_and_groups) {
4610: my %content = %{$$access_hash{$key}};
4611: my $cnum = $content{'number'};
4612: my $cdom = $content{'domain'};
4613: my $cid = $cdom.'_'.$cnum;
4614: if (!exists($allroles{$cid})) {
4615: next;
4616: }
4617: foreach my $role_id (keys(%{$content{'roles'}})) {
4618: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4619: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4620: my @status = @{$content{'roles'}{$role_id}{'access'}};
4621: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4622: foreach my $role (keys(%{$allroles{$cid}})) {
4623: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4624: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4625: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4626: if (grep/^all$/,@sections) {
4627: return 'ok';
4628: } else {
4629: if (grep/^$sec$/,@sections) {
4630: return 'ok';
4631: }
4632: }
4633: }
4634: }
4635: if (keys(%{$allgroups{$cid}}) == 0) {
4636: if (grep/^none$/,@groups) {
4637: return 'ok';
4638: }
4639: } else {
4640: if (grep/^all$/,@groups) {
4641: return 'ok';
4642: }
4643: foreach my $group (keys(%{$allgroups{$cid}})) {
4644: if (grep/^$group$/,@groups) {
4645: return 'ok';
4646: }
4647: }
4648: }
4649: }
4650: }
4651: }
4652: }
4653: }
4654: if ($guest) {
4655: return $guest;
4656: }
4657: }
4658: }
4659: return;
4660: }
4661:
4662: sub course_group_datechecker {
4663: my ($dates,$now,$status) = @_;
4664: my ($start,$end) = split(/\./,$dates);
4665: if (!$start && !$end) {
4666: return 'ok';
4667: }
4668: if (grep/^active$/,@{$status}) {
4669: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4670: return 'ok';
4671: }
4672: }
4673: if (grep/^previous$/,@{$status}) {
4674: if ($end > $now ) {
4675: return 'ok';
4676: }
4677: }
4678: if (grep/^future$/,@{$status}) {
4679: if ($start > $now) {
4680: return 'ok';
4681: }
4682: }
4683: return;
4684: }
4685:
4686: sub parse_portfolio_url {
4687: my ($url) = @_;
4688:
4689: my ($type,$udom,$unum,$group,$file_name);
4690:
1.823 albertel 4691: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4692: $type = 1;
4693: $udom = $1;
4694: $unum = $2;
4695: $file_name = $3;
1.823 albertel 4696: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4697: $type = 2;
4698: $udom = $1;
4699: $unum = $2;
4700: $group = $3;
4701: $file_name = $3.'/'.$4;
4702: }
4703: if (wantarray) {
4704: return ($type,$udom,$unum,$file_name,$group);
4705: }
4706: return $type;
4707: }
4708:
4709: sub is_portfolio_url {
4710: my ($url) = @_;
4711: return scalar(&parse_portfolio_url($url));
4712: }
4713:
1.798 raeburn 4714: sub is_portfolio_file {
4715: my ($file) = @_;
1.820 raeburn 4716: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4717: return 1;
4718: }
4719: return;
4720: }
4721:
1.976 raeburn 4722: sub usertools_access {
1.985 raeburn 4723: my ($uname,$udom,$tool,$action,$context) = @_;
4724: my ($access,%tools);
4725: if ($context eq '') {
4726: $context = 'tools';
4727: }
4728: if ($context eq 'requestcourses') {
4729: %tools = (
4730: official => 1,
4731: unofficial => 1,
1.1006 raeburn 4732: community => 1,
1.985 raeburn 4733: );
4734: } else {
4735: %tools = (
4736: aboutme => 1,
4737: blog => 1,
4738: portfolio => 1,
4739: );
4740: }
1.976 raeburn 4741: return if (!defined($tools{$tool}));
4742:
4743: if ((!defined($udom)) || (!defined($uname))) {
4744: $udom = $env{'user.domain'};
4745: $uname = $env{'user.name'};
4746: }
4747:
1.978 raeburn 4748: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4749: if ($action ne 'reload') {
1.985 raeburn 4750: if ($context eq 'requestcourses') {
4751: return $env{'environment.canrequest.'.$tool};
4752: } else {
4753: return $env{'environment.availabletools.'.$tool};
4754: }
4755: }
1.976 raeburn 4756: }
4757:
4758: my ($toolstatus,$inststatus);
4759:
1.985 raeburn 4760: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4761: ($action ne 'reload')) {
4762: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 4763: $inststatus = $env{'environment.inststatus'};
4764: } else {
1.1025 raeburn 4765: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
1.985 raeburn 4766: $toolstatus = $userenv{$context.'.'.$tool};
1.976 raeburn 4767: $inststatus = $userenv{'inststatus'};
4768: }
4769:
4770: if ($toolstatus ne '') {
4771: if ($toolstatus) {
4772: $access = 1;
4773: } else {
4774: $access = 0;
4775: }
4776: return $access;
4777: }
4778:
4779: my $is_adv = &is_advanced_user($udom,$uname);
4780: my %domdef = &get_domain_defaults($udom);
4781: if (ref($domdef{$tool}) eq 'HASH') {
4782: if ($is_adv) {
4783: if ($domdef{$tool}{'_LC_adv'} ne '') {
4784: if ($domdef{$tool}{'_LC_adv'}) {
4785: $access = 1;
4786: } else {
4787: $access = 0;
4788: }
4789: return $access;
4790: }
4791: }
4792: if ($inststatus ne '') {
4793: my ($hasaccess,$hasnoaccess);
4794: foreach my $affiliation (split(/:/,$inststatus)) {
4795: if ($domdef{$tool}{$affiliation} ne '') {
4796: if ($domdef{$tool}{$affiliation}) {
4797: $hasaccess = 1;
4798: } else {
4799: $hasnoaccess = 1;
4800: }
4801: }
4802: }
4803: if ($hasaccess || $hasnoaccess) {
4804: if ($hasaccess) {
4805: $access = 1;
4806: } elsif ($hasnoaccess) {
4807: $access = 0;
4808: }
4809: return $access;
4810: }
4811: } else {
4812: if ($domdef{$tool}{'default'} ne '') {
4813: if ($domdef{$tool}{'default'}) {
4814: $access = 1;
4815: } elsif ($domdef{$tool}{'default'} == 0) {
4816: $access = 0;
4817: }
4818: return $access;
4819: }
4820: }
4821: } else {
1.985 raeburn 4822: if ($context eq 'tools') {
4823: $access = 1;
4824: } else {
4825: $access = 0;
4826: }
1.976 raeburn 4827: return $access;
4828: }
4829: }
4830:
1.1050 raeburn 4831: sub is_course_owner {
4832: my ($cdom,$cnum,$udom,$uname) = @_;
4833: if (($udom eq '') || ($uname eq '')) {
4834: $udom = $env{'user.domain'};
4835: $uname = $env{'user.name'};
4836: }
4837: unless (($udom eq '') || ($uname eq '')) {
4838: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4839: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4840: return 1;
4841: } else {
4842: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4843: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4844: return 1;
4845: }
4846: }
4847: }
4848: }
4849: return;
4850: }
4851:
1.976 raeburn 4852: sub is_advanced_user {
4853: my ($udom,$uname) = @_;
4854: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4855: my %allroles;
4856: my $is_adv;
4857: foreach my $role (keys(%roleshash)) {
4858: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4859: my $area = '/'.$tdomain.'/'.$trest;
4860: if ($sec ne '') {
4861: $area .= '/'.$sec;
4862: }
4863: if (($area ne '') && ($trole ne '')) {
4864: my $spec=$trole.'.'.$area;
4865: if ($trole =~ /^cr\//) {
4866: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4867: } elsif ($trole ne 'gr') {
4868: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4869: }
4870: }
4871: }
4872: foreach my $role (keys(%allroles)) {
4873: last if ($is_adv);
4874: foreach my $item (split(/:/,$allroles{$role})) {
4875: if ($item ne '') {
4876: my ($privilege,$restrictions)=split(/&/,$item);
4877: if ($privilege eq 'adv') {
4878: $is_adv = 1;
4879: last;
4880: }
4881: }
4882: }
4883: }
4884: return $is_adv;
4885: }
1.798 raeburn 4886:
1.1035 raeburn 4887: sub check_can_request {
1.1036 raeburn 4888: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 4889: my $canreq = 0;
4890: my ($types,$typename) = &Apache::loncommon::course_types();
4891: my @options = ('approval','validate','autolimit');
4892: my $optregex = join('|',@options);
4893: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4894: foreach my $type (@{$types}) {
4895: if (&usertools_access($env{'user.name'},
4896: $env{'user.domain'},
4897: $type,undef,'requestcourses')) {
4898: $canreq ++;
1.1036 raeburn 4899: if (ref($request_domains) eq 'HASH') {
4900: push(@{$request_domains->{$type}},$env{'user.domain'});
4901: }
1.1035 raeburn 4902: if ($dom eq $env{'user.domain'}) {
4903: $can_request->{$type} = 1;
4904: }
4905: }
4906: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4907: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4908: if (@curr > 0) {
1.1036 raeburn 4909: foreach my $item (@curr) {
4910: if (ref($request_domains) eq 'HASH') {
4911: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4912: if ($otherdom ne '') {
4913: if (ref($request_domains->{$type}) eq 'ARRAY') {
4914: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4915: push(@{$request_domains->{$type}},$otherdom);
4916: }
4917: } else {
4918: push(@{$request_domains->{$type}},$otherdom);
4919: }
4920: }
4921: }
4922: }
4923: unless($dom eq $env{'user.domain'}) {
4924: $canreq ++;
1.1035 raeburn 4925: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4926: $can_request->{$type} = 1;
4927: }
4928: }
4929: }
4930: }
4931: }
4932: }
4933: return $canreq;
4934: }
4935:
1.341 www 4936: # ---------------------------------------------- Custom access rule evaluation
4937:
4938: sub customaccess {
4939: my ($priv,$uri)=@_;
1.807 albertel 4940: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 4941: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 4942: $udom = &LONCAPA::clean_domain($udom);
4943: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 4944: my $access=0;
1.800 albertel 4945: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 4946: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4947: if ($type eq 'user') {
4948: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 4949: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 4950: if ($tdom) {
4951: if ($tdom ne $env{'user.domain'}) { next; }
4952: }
1.896 albertel 4953: if ($tuname) {
4954: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 4955: }
4956: $access=($effect eq 'allow');
4957: last;
4958: }
4959: } else {
4960: if ($role) {
4961: if ($role ne $urole) { next; }
4962: }
4963: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4964: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4965: if ($tdom) {
4966: if ($tdom ne $udom) { next; }
4967: }
4968: if ($tcrs) {
4969: if ($tcrs ne $ucrs) { next; }
4970: }
4971: if ($tsec) {
4972: if ($tsec ne $usec) { next; }
4973: }
4974: $access=($effect eq 'allow');
4975: last;
4976: }
4977: if ($realm eq '' && $role eq '') {
4978: $access=($effect eq 'allow');
4979: }
1.402 bowersj2 4980: }
1.341 www 4981: }
4982: return $access;
4983: }
4984:
1.103 harris41 4985: # ------------------------------------------------- Check for a user privilege
1.12 www 4986:
4987: sub allowed {
1.810 raeburn 4988: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 4989: my $ver_orguri=$uri;
1.439 www 4990: $uri=&deversion($uri);
1.152 www 4991: my $orguri=$uri;
1.52 www 4992: $uri=&declutter($uri);
1.809 raeburn 4993:
1.810 raeburn 4994: if ($priv eq 'evb') {
4995: # Evade communication block restrictions for specified role in a course
4996: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4997: return $1;
4998: } else {
4999: return;
5000: }
5001: }
5002:
1.620 albertel 5003: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 5004: # Free bre access to adm and meta resources
1.775 albertel 5005: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 5006: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5007: && ($priv eq 'bre')) {
1.14 www 5008: return 'F';
1.159 www 5009: }
5010:
1.545 banghart 5011: # Free bre access to user's own portfolio contents
1.714 raeburn 5012: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 5013: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 5014: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 5015: my %setters;
5016: my ($startblock,$endblock) =
5017: &Apache::loncommon::blockcheck(\%setters,'port');
5018: if ($startblock && $endblock) {
5019: return 'B';
5020: } else {
5021: return 'F';
5022: }
1.545 banghart 5023: }
5024:
1.762 raeburn 5025: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 5026: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5027: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5028: if (exists($env{'request.course.id'})) {
5029: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5030: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5031: if (($domain eq $cdom) && ($name eq $cnum)) {
5032: my $courseprivid=$env{'request.course.id'};
5033: $courseprivid=~s/\_/\//;
5034: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5035: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5036: return $1;
1.762 raeburn 5037: } else {
5038: if ($env{'request.course.sec'}) {
5039: $courseprivid.='/'.$env{'request.course.sec'};
5040: }
5041: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5042: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5043: return $2;
5044: }
1.714 raeburn 5045: }
5046: }
5047: }
5048: }
5049:
1.159 www 5050: # Free bre to public access
5051:
5052: if ($priv eq 'bre') {
1.238 www 5053: my $copyright=&metadata($uri,'copyright');
1.620 albertel 5054: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 5055: return 'F';
5056: }
1.238 www 5057: if ($copyright eq 'priv') {
5058: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5059: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 5060: return '';
5061: }
5062: }
5063: if ($copyright eq 'domain') {
5064: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5065: unless (($env{'user.domain'} eq $1) ||
5066: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 5067: return '';
5068: }
1.262 matthew 5069: }
1.620 albertel 5070: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 5071: # Library role, so allow browsing of resources in this domain.
5072: return 'F';
1.238 www 5073: }
1.341 www 5074: if ($copyright eq 'custom') {
5075: unless (&customaccess($priv,$uri)) { return ''; }
5076: }
1.14 www 5077: }
1.264 matthew 5078: # Domain coordinator is trying to create a course
1.620 albertel 5079: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 5080: # uri is the requested domain in this case.
5081: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 5082: # a role of dc for the domain in question.
1.620 albertel 5083: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 5084: }
1.29 www 5085:
1.52 www 5086: my $thisallowed='';
5087: my $statecond=0;
5088: my $courseprivid='';
5089:
1.1039 raeburn 5090: my $ownaccess;
1.1043 raeburn 5091: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 5092: if (($priv eq 'bro') && ($env{'user.author'})) {
5093: if ($uri eq '') {
5094: $ownaccess = 1;
5095: } else {
5096: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5097: my $udom = $env{'user.domain'};
5098: my $uname = $env{'user.name'};
5099: if ($uri =~ m{^\Q$udom\E/?$}) {
5100: $ownaccess = 1;
1.1040 raeburn 5101: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 5102: unless ($uri =~ m{\.\./}) {
5103: $ownaccess = 1;
5104: }
5105: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5106: my $now = time;
5107: if ($uri =~ m{^([^/]+)/?$}) {
5108: my $adom = $1;
5109: foreach my $key (keys(%env)) {
1.1042 raeburn 5110: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 5111: my ($start,$end) = split('.',$env{$key});
5112: if (($now >= $start) && (!$end || $end < $now)) {
5113: $ownaccess = 1;
5114: last;
5115: }
5116: }
5117: }
5118: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5119: my $adom = $1;
5120: my $aname = $2;
1.1042 raeburn 5121: foreach my $role ('ca','aa') {
5122: if ($env{"user.role.$role./$adom/$aname"}) {
5123: my ($start,$end) =
5124: split('.',$env{"user.role.$role./$adom/$aname"});
5125: if (($now >= $start) && (!$end || $end < $now)) {
5126: $ownaccess = 1;
5127: last;
5128: }
1.1039 raeburn 5129: }
5130: }
5131: }
5132: }
5133: }
5134: }
5135: }
5136:
1.52 www 5137: # Course
5138:
1.620 albertel 5139: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5140: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5141: $thisallowed.=$1;
5142: }
1.52 www 5143: }
1.29 www 5144:
1.52 www 5145: # Domain
5146:
1.620 albertel 5147: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 5148: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5149: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5150: $thisallowed.=$1;
5151: }
1.12 www 5152: }
1.52 www 5153:
5154: # Course: uri itself is a course
1.66 www 5155: my $courseuri=$uri;
5156: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 5157: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 5158:
1.620 albertel 5159: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 5160: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5161: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5162: $thisallowed.=$1;
5163: }
1.12 www 5164: }
1.29 www 5165:
1.665 albertel 5166: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 5167: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 5168: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 5169: $thisallowed='';
1.671 raeburn 5170: my ($match)=&is_on_map($uri);
5171: if ($match) {
5172: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5173: =~/\Q$priv\E\&([^\:]*)/) {
5174: $thisallowed.=$1;
5175: }
5176: } else {
1.705 albertel 5177: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 5178: if ($refuri) {
5179: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 5180: $thisallowed='F';
1.671 raeburn 5181: } else {
5182: $refuri=&declutter($refuri);
5183: my ($match) = &is_on_map($refuri);
5184: if ($match) {
5185: $thisallowed='F';
5186: }
1.669 raeburn 5187: }
1.671 raeburn 5188: }
5189: }
1.314 www 5190: }
1.492 albertel 5191:
1.766 albertel 5192: if ($priv eq 'bre'
5193: && $thisallowed ne 'F'
5194: && $thisallowed ne '2'
5195: && &is_portfolio_url($uri)) {
5196: $thisallowed = &portfolio_access($uri);
5197: }
5198:
1.52 www 5199: # Full access at system, domain or course-wide level? Exit.
1.29 www 5200: if ($thisallowed=~/F/) {
5201: return 'F';
5202: }
5203:
1.52 www 5204: # If this is generating or modifying users, exit with special codes
1.29 www 5205:
1.643 www 5206: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5207: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 5208: my ($audom,$auname)=split('/',$uri);
1.643 www 5209: # no author name given, so this just checks on the general right to make a co-author in this domain
5210: unless ($auname) { return $thisallowed; }
5211: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 5212: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5213: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5214: ($audom ne $env{'request.role.domain'}))) { return ''; }
5215: }
1.52 www 5216: return $thisallowed;
5217: }
5218: #
1.103 harris41 5219: # Gathered so far: system, domain and course wide privileges
1.52 www 5220: #
5221: # Course: See if uri or referer is an individual resource that is part of
5222: # the course
5223:
1.620 albertel 5224: if ($env{'request.course.id'}) {
1.232 www 5225:
1.620 albertel 5226: $courseprivid=$env{'request.course.id'};
5227: if ($env{'request.course.sec'}) {
5228: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 5229: }
5230: $courseprivid=~s/\_/\//;
5231: my $checkreferer=1;
1.232 www 5232: my ($match,$cond)=&is_on_map($uri);
5233: if ($match) {
5234: $statecond=$cond;
1.620 albertel 5235: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5236: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5237: $thisallowed.=$1;
5238: $checkreferer=0;
5239: }
1.29 www 5240: }
1.83 www 5241:
1.148 www 5242: if ($checkreferer) {
1.620 albertel 5243: my $refuri=$env{'httpref.'.$orguri};
1.148 www 5244: unless ($refuri) {
1.800 albertel 5245: foreach my $key (keys(%env)) {
5246: if ($key=~/^httpref\..*\*/) {
5247: my $pattern=$key;
1.156 www 5248: $pattern=~s/^httpref\.\/res\///;
1.148 www 5249: $pattern=~s/\*/\[\^\/\]\+/g;
5250: $pattern=~s/\//\\\//g;
1.152 www 5251: if ($orguri=~/$pattern/) {
1.800 albertel 5252: $refuri=$env{$key};
1.148 www 5253: }
5254: }
1.191 harris41 5255: }
1.148 www 5256: }
1.232 www 5257:
1.148 www 5258: if ($refuri) {
1.152 www 5259: $refuri=&declutter($refuri);
1.232 www 5260: my ($match,$cond)=&is_on_map($refuri);
5261: if ($match) {
5262: my $refstatecond=$cond;
1.620 albertel 5263: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5264: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5265: $thisallowed.=$1;
1.53 www 5266: $uri=$refuri;
5267: $statecond=$refstatecond;
1.52 www 5268: }
5269: }
1.148 www 5270: }
1.29 www 5271: }
1.52 www 5272: }
1.29 www 5273:
1.52 www 5274: #
1.103 harris41 5275: # Gathered now: all privileges that could apply, and condition number
1.52 www 5276: #
5277: #
5278: # Full or no access?
5279: #
1.29 www 5280:
1.52 www 5281: if ($thisallowed=~/F/) {
5282: return 'F';
5283: }
1.29 www 5284:
1.52 www 5285: unless ($thisallowed) {
5286: return '';
5287: }
1.29 www 5288:
1.52 www 5289: # Restrictions exist, deal with them
5290: #
5291: # C:according to course preferences
5292: # R:according to resource settings
5293: # L:unless locked
5294: # X:according to user session state
5295: #
5296:
5297: # Possibly locked functionality, check all courses
1.54 www 5298: # Locks might take effect only after 10 minutes cache expiration for other
5299: # courses, and 2 minutes for current course
1.52 www 5300:
5301: my $envkey;
5302: if ($thisallowed=~/L/) {
1.1000 raeburn 5303: foreach $envkey (keys(%env)) {
1.54 www 5304: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5305: my $courseid=$2;
5306: my $roleid=$1.'.'.$2;
1.92 www 5307: $courseid=~s/^\///;
1.54 www 5308: my $expiretime=600;
1.620 albertel 5309: if ($env{'request.role'} eq $roleid) {
1.54 www 5310: $expiretime=120;
5311: }
5312: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5313: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 5314: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 5315: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 5316: }
1.620 albertel 5317: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5318: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5319: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5320: &log($env{'user.domain'},$env{'user.name'},
5321: $env{'user.home'},
1.57 www 5322: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 5323: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5324: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5325: return '';
5326: }
5327: }
1.620 albertel 5328: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5329: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5330: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5331: &log($env{'user.domain'},$env{'user.name'},
5332: $env{'user.home'},
1.57 www 5333: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 5334: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5335: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5336: return '';
5337: }
5338: }
5339: }
1.29 www 5340: }
1.52 www 5341: }
5342:
5343: #
5344: # Rest of the restrictions depend on selected course
5345: #
5346:
1.620 albertel 5347: unless ($env{'request.course.id'}) {
1.766 albertel 5348: if ($thisallowed eq 'A') {
5349: return 'A';
1.814 raeburn 5350: } elsif ($thisallowed eq 'B') {
5351: return 'B';
1.766 albertel 5352: } else {
5353: return '1';
5354: }
1.52 www 5355: }
1.29 www 5356:
1.52 www 5357: #
5358: # Now user is definitely in a course
5359: #
1.53 www 5360:
5361:
5362: # Course preferences
5363:
5364: if ($thisallowed=~/C/) {
1.620 albertel 5365: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5366: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5367: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 5368: =~/\Q$rolecode\E/) {
1.689 albertel 5369: if ($priv ne 'pch') {
5370: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5371: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5372: $env{'request.course.id'});
5373: }
1.237 www 5374: return '';
5375: }
5376:
1.620 albertel 5377: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 5378: =~/\Q$unamedom\E/) {
1.689 albertel 5379: if ($priv ne 'pch') {
5380: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5381: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5382: $env{'request.course.id'});
5383: }
1.54 www 5384: return '';
5385: }
1.53 www 5386: }
5387:
5388: # Resource preferences
5389:
5390: if ($thisallowed=~/R/) {
1.620 albertel 5391: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 5392: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 5393: if ($priv ne 'pch') {
5394: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5395: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5396: }
5397: return '';
1.54 www 5398: }
1.53 www 5399: }
1.30 www 5400:
1.246 www 5401: # Restricted by state or randomout?
1.30 www 5402:
1.52 www 5403: if ($thisallowed=~/X/) {
1.620 albertel 5404: if ($env{'acc.randomout'}) {
1.579 albertel 5405: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 5406: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 5407: return '';
5408: }
1.247 www 5409: }
5410: if (&condval($statecond)) {
1.52 www 5411: return '2';
5412: } else {
5413: return '';
5414: }
5415: }
1.30 www 5416:
1.766 albertel 5417: if ($thisallowed eq 'A') {
5418: return 'A';
1.814 raeburn 5419: } elsif ($thisallowed eq 'B') {
5420: return 'B';
1.766 albertel 5421: }
1.52 www 5422: return 'F';
1.232 www 5423: }
5424:
1.710 albertel 5425: sub split_uri_for_cond {
5426: my $uri=&deversion(&declutter(shift));
5427: my @uriparts=split(/\//,$uri);
5428: my $filename=pop(@uriparts);
5429: my $pathname=join('/',@uriparts);
5430: return ($pathname,$filename);
5431: }
1.232 www 5432: # --------------------------------------------------- Is a resource on the map?
5433:
5434: sub is_on_map {
1.710 albertel 5435: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 5436: #Trying to find the conditional for the file
1.620 albertel 5437: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 5438: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 5439: if ($match) {
1.289 bowersj2 5440: return (1,$1);
5441: } else {
1.434 www 5442: return (0,0);
1.289 bowersj2 5443: }
1.12 www 5444: }
5445:
1.427 www 5446: # --------------------------------------------------------- Get symb from alias
5447:
5448: sub get_symb_from_alias {
5449: my $symb=shift;
5450: my ($map,$resid,$url)=&decode_symb($symb);
5451: # Already is a symb
5452: if ($url) { return $symb; }
5453: # Must be an alias
5454: my $aliassymb='';
5455: my %bighash;
1.620 albertel 5456: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 5457: &GDBM_READER(),0640)) {
5458: my $rid=$bighash{'mapalias_'.$symb};
5459: if ($rid) {
5460: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 5461: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5462: $resid,$bighash{'src_'.$rid});
1.427 www 5463: }
5464: untie %bighash;
5465: }
5466: return $aliassymb;
5467: }
5468:
1.12 www 5469: # ----------------------------------------------------------------- Define Role
5470:
5471: sub definerole {
5472: if (allowed('mcr','/')) {
5473: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 5474: foreach my $role (split(':',$sysrole)) {
5475: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5476: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5477: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5478: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5479: return "refused:s:$crole&$cqual";
5480: }
5481: }
1.191 harris41 5482: }
1.800 albertel 5483: foreach my $role (split(':',$domrole)) {
5484: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5485: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5486: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5487: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 5488: return "refused:d:$crole&$cqual";
5489: }
5490: }
1.191 harris41 5491: }
1.800 albertel 5492: foreach my $role (split(':',$courole)) {
5493: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5494: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5495: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5496: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5497: return "refused:c:$crole&$cqual";
5498: }
5499: }
1.191 harris41 5500: }
1.620 albertel 5501: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5502: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5503: "rolesdef_$rolename=".
5504: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 5505: return reply($command,$env{'user.home'});
1.12 www 5506: } else {
5507: return 'refused';
5508: }
1.105 harris41 5509: }
5510:
5511: # ---------------- Make a metadata query against the network of library servers
5512:
5513: sub metadata_query {
1.244 matthew 5514: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 5515: my %rhash;
1.845 albertel 5516: my %libserv = &all_library();
1.244 matthew 5517: my @server_list = (defined($server_array) ? @$server_array
5518: : keys(%libserv) );
5519: for my $server (@server_list) {
1.118 harris41 5520: unless ($custom or $customshow) {
5521: my $reply=&reply("querysend:".&escape($query),$server);
5522: $rhash{$server}=$reply;
5523: }
5524: else {
5525: my $reply=&reply("querysend:".&escape($query).':'.
5526: &escape($custom).':'.&escape($customshow),
5527: $server);
5528: $rhash{$server}=$reply;
5529: }
1.112 harris41 5530: }
1.118 harris41 5531: return \%rhash;
1.240 www 5532: }
5533:
5534: # ----------------------------------------- Send log queries and wait for reply
5535:
5536: sub log_query {
5537: my ($uname,$udom,$query,%filters)=@_;
5538: my $uhome=&homeserver($uname,$udom);
5539: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 5540: my $uhost=&hostname($uhome);
1.800 albertel 5541: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 5542: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5543: $uhome);
1.479 albertel 5544: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 5545: return get_query_reply($queryid);
5546: }
5547:
1.818 raeburn 5548: # -------------------------- Update MySQL table for portfolio file
5549:
5550: sub update_portfolio_table {
1.821 raeburn 5551: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 5552: if ($group ne '') {
5553: $file_name =~s /^\Q$group\E//;
5554: }
1.818 raeburn 5555: my $homeserver = &homeserver($uname,$udom);
5556: my $queryid=
1.821 raeburn 5557: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5558: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 5559: my $reply = &get_query_reply($queryid);
5560: return $reply;
5561: }
5562:
1.899 raeburn 5563: # -------------------------- Update MySQL allusers table
5564:
5565: sub update_allusers_table {
5566: my ($uname,$udom,$names) = @_;
5567: my $homeserver = &homeserver($uname,$udom);
5568: my $queryid=
5569: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5570: 'lastname='.&escape($names->{'lastname'}).'%%'.
5571: 'firstname='.&escape($names->{'firstname'}).'%%'.
5572: 'middlename='.&escape($names->{'middlename'}).'%%'.
5573: 'generation='.&escape($names->{'generation'}).'%%'.
5574: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5575: 'id='.&escape($names->{'id'}),$homeserver);
5576: my $reply = &get_query_reply($queryid);
5577: return $reply;
5578: }
5579:
1.508 raeburn 5580: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 5581:
5582: sub fetch_enrollment_query {
1.511 raeburn 5583: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 5584: my $homeserver;
1.547 raeburn 5585: my $maxtries = 1;
1.508 raeburn 5586: if ($context eq 'automated') {
5587: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 5588: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 5589: } else {
5590: $homeserver = &homeserver($cnum,$dom);
5591: }
1.838 albertel 5592: my $host=&hostname($homeserver);
1.506 raeburn 5593: my $cmd = '';
1.1000 raeburn 5594: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 5595: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 5596: }
5597: $cmd =~ s/%%$//;
5598: $cmd = &escape($cmd);
5599: my $query = 'fetchenrollment';
1.620 albertel 5600: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 5601: unless ($queryid=~/^\Q$host\E\_/) {
5602: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5603: return 'error: '.$queryid;
5604: }
1.506 raeburn 5605: my $reply = &get_query_reply($queryid);
1.547 raeburn 5606: my $tries = 1;
5607: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5608: $reply = &get_query_reply($queryid);
5609: $tries ++;
5610: }
1.526 raeburn 5611: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 5612: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 5613: } else {
1.901 albertel 5614: my @responses = split(/:/,$reply);
1.515 raeburn 5615: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 5616: foreach my $line (@responses) {
5617: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 5618: $$replyref{$key} = $value;
5619: }
5620: } else {
1.506 raeburn 5621: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 5622: foreach my $line (@responses) {
5623: my ($key,$value) = split(/=/,$line);
1.506 raeburn 5624: $$replyref{$key} = $value;
5625: if ($value > 0) {
1.800 albertel 5626: foreach my $item (@{$$affiliatesref{$key}}) {
5627: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 5628: my $destname = $pathname.'/'.$filename;
5629: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 5630: if ($xml_classlist =~ /^error/) {
5631: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5632: } else {
1.506 raeburn 5633: if ( open(FILE,">$destname") ) {
5634: print FILE &unescape($xml_classlist);
5635: close(FILE);
1.526 raeburn 5636: } else {
5637: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 5638: }
5639: }
5640: }
5641: }
5642: }
5643: }
5644: return 'ok';
5645: }
5646: return 'error';
5647: }
5648:
1.242 www 5649: sub get_query_reply {
5650: my $queryid=shift;
1.240 www 5651: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5652: my $reply='';
5653: for (1..100) {
5654: sleep 2;
5655: if (-e $replyfile.'.end') {
1.448 albertel 5656: if (open(my $fh,$replyfile)) {
1.904 albertel 5657: $reply = join('',<$fh>);
5658: close($fh);
1.240 www 5659: } else { return 'error: reply_file_error'; }
1.242 www 5660: return &unescape($reply);
5661: }
1.240 www 5662: }
1.242 www 5663: return 'timeout:'.$queryid;
1.240 www 5664: }
5665:
5666: sub courselog_query {
1.241 www 5667: #
5668: # possible filters:
5669: # url: url or symb
5670: # username
5671: # domain
5672: # action: view, submit, grade
5673: # start: timestamp
5674: # end: timestamp
5675: #
1.240 www 5676: my (%filters)=@_;
1.620 albertel 5677: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 5678: if ($filters{'url'}) {
5679: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5680: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5681: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5682: }
1.620 albertel 5683: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5684: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 5685: return &log_query($cname,$cdom,'courselog',%filters);
5686: }
5687:
5688: sub userlog_query {
1.858 raeburn 5689: #
5690: # possible filters:
5691: # action: log check role
5692: # start: timestamp
5693: # end: timestamp
5694: #
1.240 www 5695: my ($uname,$udom,%filters)=@_;
5696: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 5697: }
5698:
1.506 raeburn 5699: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5700:
5701: sub auto_run {
1.508 raeburn 5702: my ($cnum,$cdom) = @_;
1.876 raeburn 5703: my $response = 0;
5704: my $settings;
5705: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5706: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5707: $settings = $domconfig{'autoenroll'};
5708: if ($settings->{'run'} eq '1') {
5709: $response = 1;
5710: }
5711: } else {
1.934 raeburn 5712: my $homeserver;
5713: if (&is_course($cdom,$cnum)) {
5714: $homeserver = &homeserver($cnum,$cdom);
5715: } else {
5716: $homeserver = &domain($cdom,'primary');
5717: }
5718: if ($homeserver ne 'no_host') {
5719: $response = &reply('autorun:'.$cdom,$homeserver);
5720: }
1.876 raeburn 5721: }
1.506 raeburn 5722: return $response;
5723: }
1.776 albertel 5724:
1.506 raeburn 5725: sub auto_get_sections {
1.508 raeburn 5726: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 5727: my $homeserver;
5728: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5729: $homeserver = &homeserver($cnum,$cdom);
5730: }
5731: if (!defined($homeserver)) {
5732: if ($cdom =~ /^$match_domain$/) {
5733: $homeserver = &domain($cdom,'primary');
5734: }
5735: }
5736: my @secs;
5737: if (defined($homeserver)) {
5738: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5739: unless ($response eq 'refused') {
5740: @secs = split(/:/,$response);
5741: }
1.506 raeburn 5742: }
5743: return @secs;
5744: }
1.776 albertel 5745:
1.506 raeburn 5746: sub auto_new_course {
1.508 raeburn 5747: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5748: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 5749: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 5750: return $response;
5751: }
1.776 albertel 5752:
1.506 raeburn 5753: sub auto_validate_courseID {
1.508 raeburn 5754: my ($cnum,$cdom,$inst_course_id) = @_;
5755: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 5756: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 5757: return $response;
5758: }
1.776 albertel 5759:
1.1007 raeburn 5760: sub auto_validate_instcode {
1.1020 raeburn 5761: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 5762: my ($homeserver,$response);
5763: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5764: $homeserver = &homeserver($cnum,$cdom);
5765: }
5766: if (!defined($homeserver)) {
5767: if ($cdom =~ /^$match_domain$/) {
5768: $homeserver = &domain($cdom,'primary');
5769: }
5770: }
5771: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
1.1020 raeburn 5772: &escape($instcode).':'.&escape($owner),$homeserver));
1.1027 raeburn 5773: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5774: return ($outcome,$description);
1.1007 raeburn 5775: }
5776:
1.506 raeburn 5777: sub auto_create_password {
1.873 raeburn 5778: my ($cnum,$cdom,$authparam,$udom) = @_;
5779: my ($homeserver,$response);
1.506 raeburn 5780: my $create_passwd = 0;
5781: my $authchk = '';
1.873 raeburn 5782: if ($udom =~ /^$match_domain$/) {
5783: $homeserver = &domain($udom,'primary');
5784: }
5785: if ($homeserver eq '') {
5786: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5787: $homeserver = &homeserver($cnum,$cdom);
5788: }
5789: }
5790: if ($homeserver eq '') {
5791: $authchk = 'nodomain';
1.506 raeburn 5792: } else {
1.873 raeburn 5793: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5794: if ($response eq 'refused') {
5795: $authchk = 'refused';
5796: } else {
1.901 albertel 5797: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 5798: }
1.506 raeburn 5799: }
5800: return ($authparam,$create_passwd,$authchk);
5801: }
5802:
1.706 raeburn 5803: sub auto_photo_permission {
5804: my ($cnum,$cdom,$students) = @_;
5805: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 5806: my ($outcome,$perm_reqd,$conditions) =
5807: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 5808: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5809: return (undef,undef);
5810: }
1.706 raeburn 5811: return ($outcome,$perm_reqd,$conditions);
5812: }
5813:
5814: sub auto_checkphotos {
5815: my ($uname,$udom,$pid) = @_;
5816: my $homeserver = &homeserver($uname,$udom);
5817: my ($result,$resulttype);
5818: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 5819: &escape($uname).':'.&escape($pid),
5820: $homeserver));
1.709 albertel 5821: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5822: return (undef,undef);
5823: }
1.706 raeburn 5824: if ($outcome) {
5825: ($result,$resulttype) = split(/:/,$outcome);
5826: }
5827: return ($result,$resulttype);
5828: }
5829:
5830: sub auto_photochoice {
5831: my ($cnum,$cdom) = @_;
5832: my $homeserver = &homeserver($cnum,$cdom);
5833: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 5834: &escape($cdom),
5835: $homeserver)));
1.709 albertel 5836: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5837: return (undef,undef);
5838: }
1.706 raeburn 5839: return ($update,$comment);
5840: }
5841:
5842: sub auto_photoupdate {
5843: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5844: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 5845: my $host=&hostname($homeserver);
1.706 raeburn 5846: my $cmd = '';
5847: my $maxtries = 1;
1.800 albertel 5848: foreach my $affiliate (keys(%{$affiliatesref})) {
5849: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 5850: }
5851: $cmd =~ s/%%$//;
5852: $cmd = &escape($cmd);
5853: my $query = 'institutionalphotos';
5854: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5855: unless ($queryid=~/^\Q$host\E\_/) {
5856: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5857: return 'error: '.$queryid;
5858: }
5859: my $reply = &get_query_reply($queryid);
5860: my $tries = 1;
5861: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5862: $reply = &get_query_reply($queryid);
5863: $tries ++;
5864: }
5865: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5866: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5867: } else {
5868: my @responses = split(/:/,$reply);
5869: my $outcome = shift(@responses);
5870: foreach my $item (@responses) {
5871: my ($key,$value) = split(/=/,$item);
5872: $$photo{$key} = $value;
5873: }
5874: return $outcome;
5875: }
5876: return 'error';
5877: }
5878:
1.521 raeburn 5879: sub auto_instcode_format {
1.793 albertel 5880: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5881: $cat_order) = @_;
1.521 raeburn 5882: my $courses = '';
1.772 raeburn 5883: my @homeservers;
1.521 raeburn 5884: if ($caller eq 'global') {
1.841 albertel 5885: my %servers = &get_servers($codedom,'library');
5886: foreach my $tryserver (keys(%servers)) {
5887: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5888: push(@homeservers,$tryserver);
5889: }
1.584 raeburn 5890: }
1.1022 raeburn 5891: } elsif ($caller eq 'requests') {
5892: if ($codedom =~ /^$match_domain$/) {
5893: my $chome = &domain($codedom,'primary');
5894: unless ($chome eq 'no_host') {
5895: push(@homeservers,$chome);
5896: }
5897: }
1.521 raeburn 5898: } else {
1.772 raeburn 5899: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 5900: }
1.793 albertel 5901: foreach my $code (keys(%{$instcodes})) {
5902: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 5903: }
5904: chop($courses);
1.772 raeburn 5905: my $ok_response = 0;
5906: my $response;
5907: while (@homeservers > 0 && $ok_response == 0) {
5908: my $server = shift(@homeservers);
5909: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5910: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5911: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 5912: split(/:/,$response);
1.772 raeburn 5913: %{$codes} = (%{$codes},&str2hash($codes_str));
5914: push(@{$codetitles},&str2array($codetitles_str));
5915: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5916: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5917: $ok_response = 1;
5918: }
5919: }
5920: if ($ok_response) {
1.521 raeburn 5921: return 'ok';
1.772 raeburn 5922: } else {
5923: return $response;
1.521 raeburn 5924: }
5925: }
5926:
1.792 raeburn 5927: sub auto_instcode_defaults {
5928: my ($domain,$returnhash,$code_order) = @_;
5929: my @homeservers;
1.841 albertel 5930:
5931: my %servers = &get_servers($domain,'library');
5932: foreach my $tryserver (keys(%servers)) {
5933: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5934: push(@homeservers,$tryserver);
5935: }
1.792 raeburn 5936: }
1.841 albertel 5937:
1.792 raeburn 5938: my $response;
1.841 albertel 5939: foreach my $server (@homeservers) {
1.792 raeburn 5940: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 5941: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5942:
5943: foreach my $pair (split(/\&/,$response)) {
5944: my ($name,$value)=split(/\=/,$pair);
5945: if ($name eq 'code_order') {
5946: @{$code_order} = split(/\&/,&unescape($value));
5947: } else {
5948: $returnhash->{&unescape($name)}=&unescape($value);
5949: }
5950: }
5951: return 'ok';
1.792 raeburn 5952: }
1.841 albertel 5953:
5954: return $response;
1.1003 raeburn 5955: }
5956:
5957: sub auto_possible_instcodes {
1.1007 raeburn 5958: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
5959: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
5960: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
5961: return;
5962: }
1.1003 raeburn 5963: my (@homeservers,$uhome);
5964: if (defined(&domain($domain,'primary'))) {
5965: $uhome=&domain($domain,'primary');
5966: push(@homeservers,&domain($domain,'primary'));
5967: } else {
5968: my %servers = &get_servers($domain,'library');
5969: foreach my $tryserver (keys(%servers)) {
5970: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5971: push(@homeservers,$tryserver);
5972: }
5973: }
5974: }
5975: my $response;
5976: foreach my $server (@homeservers) {
5977: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5978: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 5979: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
5980: split(':',$response);
5981: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5982: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 5983: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 5984: my ($name,$value)=split('=',$item);
5985: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5986: }
5987: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 5988: my ($name,$value)=split('=',$item);
5989: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5990: }
5991: return 'ok';
5992: }
5993: return $response;
5994: }
1.792 raeburn 5995:
1.1010 raeburn 5996: sub auto_courserequest_checks {
5997: my ($dom) = @_;
1.1020 raeburn 5998: my ($homeserver,%validations);
5999: if ($dom =~ /^$match_domain$/) {
6000: $homeserver = &domain($dom,'primary');
6001: }
6002: unless ($homeserver eq 'no_host') {
6003: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6004: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6005: my @items = split(/&/,$response);
6006: foreach my $item (@items) {
6007: my ($key,$value) = split('=',$item);
6008: $validations{&unescape($key)} = &thaw_unescape($value);
6009: }
6010: }
6011: }
1.1010 raeburn 6012: return %validations;
6013: }
6014:
1.1020 raeburn 6015: sub auto_courserequest_validation {
6016: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6017: my ($homeserver,$response);
6018: if ($dom =~ /^$match_domain$/) {
6019: $homeserver = &domain($dom,'primary');
6020: }
6021: unless ($homeserver eq 'no_host') {
1.1021 raeburn 6022:
1.1020 raeburn 6023: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 6024: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 6025: ':'.&escape($instcode).':'.&escape($instseclist),
6026: $homeserver));
6027: }
6028: return $response;
6029: }
6030:
1.777 albertel 6031: sub auto_validate_class_sec {
1.918 raeburn 6032: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 6033: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 6034: my $ownerlist;
6035: if (ref($owners) eq 'ARRAY') {
6036: $ownerlist = join(',',@{$owners});
6037: } else {
6038: $ownerlist = $owners;
6039: }
1.773 raeburn 6040: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 6041: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 6042: return $response;
6043: }
6044:
1.679 raeburn 6045: # ------------------------------------------------------- Course Group routines
6046:
6047: sub get_coursegroups {
1.809 raeburn 6048: my ($cdom,$cnum,$group,$namespace) = @_;
6049: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 6050: }
6051:
1.679 raeburn 6052: sub modify_coursegroup {
6053: my ($cdom,$cnum,$groupsettings) = @_;
6054: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6055: }
6056:
1.809 raeburn 6057: sub toggle_coursegroup_status {
6058: my ($cdom,$cnum,$group,$action) = @_;
6059: my ($from_namespace,$to_namespace);
6060: if ($action eq 'delete') {
6061: $from_namespace = 'coursegroups';
6062: $to_namespace = 'deleted_groups';
6063: } else {
6064: $from_namespace = 'deleted_groups';
6065: $to_namespace = 'coursegroups';
6066: }
6067: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 6068: if (my $tmp = &error(%curr_group)) {
6069: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6070: return ('read error',$tmp);
6071: } else {
6072: my %savedsettings = %curr_group;
1.809 raeburn 6073: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 6074: my $deloutcome;
6075: if ($result eq 'ok') {
1.809 raeburn 6076: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 6077: } else {
6078: return ('write error',$result);
6079: }
6080: if ($deloutcome eq 'ok') {
6081: return 'ok';
6082: } else {
6083: return ('delete error',$deloutcome);
6084: }
6085: }
6086: }
6087:
1.679 raeburn 6088: sub modify_group_roles {
1.957 raeburn 6089: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 6090: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6091: my $role = 'gr/'.&escape($userprivs);
6092: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 6093: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 6094: if ($result eq 'ok') {
6095: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6096: }
1.679 raeburn 6097: return $result;
6098: }
6099:
6100: sub modify_coursegroup_membership {
6101: my ($cdom,$cnum,$membership) = @_;
6102: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6103: return $result;
6104: }
6105:
1.682 raeburn 6106: sub get_active_groups {
6107: my ($udom,$uname,$cdom,$cnum) = @_;
6108: my $now = time;
6109: my %groups = ();
6110: foreach my $key (keys(%env)) {
1.811 albertel 6111: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 6112: my ($start,$end) = split(/\./,$env{$key});
6113: if (($end!=0) && ($end<$now)) { next; }
6114: if (($start!=0) && ($start>$now)) { next; }
6115: if ($1 eq $cdom && $2 eq $cnum) {
6116: $groups{$3} = $env{$key} ;
6117: }
6118: }
6119: }
6120: return %groups;
6121: }
6122:
1.683 raeburn 6123: sub get_group_membership {
6124: my ($cdom,$cnum,$group) = @_;
6125: return(&dump('groupmembership',$cdom,$cnum,$group));
6126: }
6127:
6128: sub get_users_groups {
6129: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 6130: my @usersgroups;
1.683 raeburn 6131: my $cachetime=1800;
6132:
6133: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 6134: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6135: if (defined($cached)) {
1.734 albertel 6136: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 6137: } else {
6138: $grouplist = '';
1.816 raeburn 6139: my $courseurl = &courseid_to_courseurl($courseid);
6140: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 6141: my $access_end = $env{'course.'.$courseid.
6142: '.default_enrollment_end_date'};
6143: my $now = time;
6144: foreach my $key (keys(%roleshash)) {
6145: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6146: my $group = $1;
6147: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6148: my $start = $2;
6149: my $end = $1;
6150: if ($start == -1) { next; } # deleted from group
6151: if (($start!=0) && ($start>$now)) { next; }
6152: if (($end!=0) && ($end<$now)) {
6153: if ($access_end && $access_end < $now) {
6154: if ($access_end - $end < 86400) {
6155: push(@usersgroups,$group);
1.733 raeburn 6156: }
6157: }
1.817 raeburn 6158: next;
1.733 raeburn 6159: }
1.817 raeburn 6160: push(@usersgroups,$group);
1.683 raeburn 6161: }
6162: }
6163: }
1.817 raeburn 6164: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6165: $grouplist = join(':',@usersgroups);
6166: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 6167: }
1.733 raeburn 6168: return @usersgroups;
1.683 raeburn 6169: }
6170:
6171: sub devalidate_getgroups_cache {
6172: my ($udom,$uname,$cdom,$cnum)=@_;
6173: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 6174:
1.683 raeburn 6175: my $hashid="$udom:$uname:$courseid";
6176: &devalidate_cache_new('getgroups',$hashid);
6177: }
6178:
1.12 www 6179: # ------------------------------------------------------------------ Plain Text
6180:
6181: sub plaintext {
1.988 raeburn 6182: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 6183: if ($short =~ m{^cr/}) {
1.758 albertel 6184: return (split('/',$short))[-1];
6185: }
1.742 raeburn 6186: if (!defined($cid)) {
6187: $cid = $env{'request.course.id'};
6188: }
6189: my %rolenames = (
1.1008 raeburn 6190: Course => 'std',
6191: Community => 'alt1',
1.742 raeburn 6192: );
1.1037 raeburn 6193: if ($cid ne '') {
6194: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6195: unless ($forcedefault) {
6196: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6197: &Apache::lonlocal::mt_escape(\$roletext);
6198: return &Apache::lonlocal::mt($roletext);
6199: }
6200: }
6201: }
6202: if ((defined($type)) && (defined($rolenames{$type})) &&
6203: (defined($rolenames{$type})) &&
6204: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 6205: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 6206: } elsif ($cid ne '') {
6207: my $crstype = $env{'course.'.$cid.'.type'};
6208: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6209: (defined($prp{$short}{$rolenames{$crstype}}))) {
6210: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6211: }
1.742 raeburn 6212: }
1.1037 raeburn 6213: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 6214: }
6215:
6216: # ----------------------------------------------------------------- Assign Role
6217:
6218: sub assignrole {
1.957 raeburn 6219: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6220: $context)=@_;
1.21 www 6221: my $mrole;
6222: if ($role =~ /^cr\//) {
1.393 www 6223: my $cwosec=$url;
1.811 albertel 6224: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 6225: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 6226: my $refused = 1;
6227: if ($context eq 'requestcourses') {
6228: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6229: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6230: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6231: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6232: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6233: if ($crsenv{'internal.courseowner'} eq
6234: $env{'user.name'}.':'.$env{'user.domain'}) {
6235: $refused = '';
6236: }
6237: }
6238: }
6239: }
6240: }
6241: if ($refused) {
6242: &logthis('Refused custom assignrole: '.
6243: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6244: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6245: return 'refused';
6246: }
1.104 www 6247: }
1.21 www 6248: $mrole='cr';
1.678 raeburn 6249: } elsif ($role =~ /^gr\//) {
6250: my $cwogrp=$url;
1.811 albertel 6251: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 6252: unless (&allowed('mdg',$cwogrp)) {
6253: &logthis('Refused group assignrole: '.
6254: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6255: $env{'user.name'}.' at '.$env{'user.domain'});
6256: return 'refused';
6257: }
6258: $mrole='gr';
1.21 www 6259: } else {
1.82 www 6260: my $cwosec=$url;
1.811 albertel 6261: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 6262: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6263: my $refused;
6264: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6265: if (!(&allowed('c'.$role,$url))) {
6266: $refused = 1;
6267: }
6268: } else {
6269: $refused = 1;
6270: }
1.947 raeburn 6271: if ($refused) {
1.1045 raeburn 6272: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6273: if (!$selfenroll && $context eq 'course') {
6274: my %crsenv;
6275: if ($role eq 'cc' || $role eq 'co') {
6276: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6277: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6278: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6279: if ($crsenv{'internal.courseowner'} eq
6280: $env{'user.name'}.':'.$env{'user.domain'}) {
6281: $refused = '';
6282: }
6283: }
6284: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6285: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6286: if ($crsenv{'internal.courseowner'} eq
6287: $env{'user.name'}.':'.$env{'user.domain'}) {
6288: $refused = '';
6289: }
6290: }
6291: }
6292: }
6293: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 6294: $refused = '';
1.1017 raeburn 6295: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 6296: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 6297: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 6298: my $wrongcc;
6299: if ($cnum =~ /^$match_community$/) {
6300: $wrongcc = 1 if ($role eq 'cc');
6301: } else {
6302: $wrongcc = 1 if ($role eq 'co');
6303: }
6304: unless ($wrongcc) {
6305: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6306: if ($crsenv{'internal.courseowner'} eq
6307: $env{'user.name'}.':'.$env{'user.domain'}) {
6308: $refused = '';
6309: }
1.1017 raeburn 6310: }
6311: }
6312: }
6313: if ($refused) {
1.947 raeburn 6314: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6315: ' '.$role.' '.$end.' '.$start.' by '.
6316: $env{'user.name'}.' at '.$env{'user.domain'});
6317: return 'refused';
6318: }
1.932 raeburn 6319: }
1.104 www 6320: }
1.21 www 6321: $mrole=$role;
6322: }
1.620 albertel 6323: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 6324: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 6325: if ($end) { $command.='_'.$end; }
1.21 www 6326: if ($start) {
6327: if ($end) {
1.81 www 6328: $command.='_'.$start;
1.21 www 6329: } else {
1.81 www 6330: $command.='_0_'.$start;
1.21 www 6331: }
6332: }
1.739 raeburn 6333: my $origstart = $start;
6334: my $origend = $end;
1.957 raeburn 6335: my $delflag;
1.357 www 6336: # actually delete
6337: if ($deleteflag) {
1.373 www 6338: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 6339: # modify command to delete the role
1.620 albertel 6340: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 6341: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 6342: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 6343: # set start and finish to negative values for userrolelog
6344: $start=-1;
6345: $end=-1;
1.957 raeburn 6346: $delflag = 1;
1.357 www 6347: }
6348: }
6349: # send command
1.349 www 6350: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 6351: # log new user role if status is ok
1.349 www 6352: if ($answer eq 'ok') {
1.663 raeburn 6353: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 6354: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 6355: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 6356: unless ($role =~ /^gr/) {
6357: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 6358: $origstart,$selfenroll,$context);
1.739 raeburn 6359: }
1.1053 ! raeburn 6360: if ($role eq 'cc') {
! 6361: &autoupdate_coowners($url,$end,$start,$uname,$udom);
! 6362: }
1.349 www 6363: }
6364: return $answer;
1.169 harris41 6365: }
6366:
1.1053 ! raeburn 6367: sub autoupdate_coowners {
! 6368: my ($url,$end,$start,$uname,$udom) = @_;
! 6369: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
! 6370: if (($cdom ne '') && ($cnum ne '')) {
! 6371: my $now = time;
! 6372: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
! 6373: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
! 6374: my %coursehash = &coursedescription($cdom.'_'.$cnum);
! 6375: my $instcode = $coursehash{'internal.coursecode'};
! 6376: if ($instcode ne '') {
! 6377: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
! 6378: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
! 6379: if ($result eq 'valid') {
! 6380: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
! 6381: if (($end == 0) || ($end > $now)) {
! 6382: if ($coursehash{'internal.co-owners'}) {
! 6383: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
! 6384: push(@newcoowners,$coowner);
! 6385: }
! 6386: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
! 6387: push(@newcoowners,$uname.':'.$udom);
! 6388: }
! 6389: @newcoowners = sort(@newcoowners);
! 6390: } else {
! 6391: push(@newcoowners,$uname.':'.$udom);
! 6392: }
! 6393: } else {
! 6394: if ($coursehash{'internal.co-owners'}) {
! 6395: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
! 6396: unless ($coowner eq $uname.':'.$udom) {
! 6397: push(@newcoowners,$coowner);
! 6398: }
! 6399: }
! 6400: unless (@newcoowners > 0) {
! 6401: $delcoowners = 1;
! 6402: $coowners = '';
! 6403: }
! 6404: }
! 6405: }
! 6406: if (@newcoowners || $delcoowners) {
! 6407: &store_coowners($cdom,$cnum,$coursehash{'home'},
! 6408: $delcoowners,@newcoowners);
! 6409: }
! 6410: }
! 6411: }
! 6412: }
! 6413: }
! 6414: }
! 6415: }
! 6416:
! 6417: sub store_coowners {
! 6418: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
! 6419: my $cid = $cdom.'_'.$cnum;
! 6420: my ($coowners,$delresult,$putresult);
! 6421: if (@newcoowners) {
! 6422: $coowners = join(',',@newcoowners);
! 6423: my %coownershash = (
! 6424: 'internal.co-owners' => $coowners,
! 6425: );
! 6426: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
! 6427: if ($putresult eq 'ok') {
! 6428: if ($env{'course.'.$cid.'.num'} eq $cnum) {
! 6429: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
! 6430: }
! 6431: }
! 6432: }
! 6433: if ($delcoowners) {
! 6434: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
! 6435: if ($delresult eq 'ok') {
! 6436: if ($env{'course.'.$cid.'.internal.co-owners'}) {
! 6437: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
! 6438: }
! 6439: }
! 6440: }
! 6441: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
! 6442: my %crsinfo =
! 6443: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
! 6444: if (ref($crsinfo{$cid}) eq 'HASH') {
! 6445: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
! 6446: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
! 6447: }
! 6448: }
! 6449: }
! 6450:
1.169 harris41 6451: # -------------------------------------------------- Modify user authentication
1.197 www 6452: # Overrides without validation
6453:
1.169 harris41 6454: sub modifyuserauth {
6455: my ($udom,$uname,$umode,$upass)=@_;
6456: my $uhome=&homeserver($uname,$udom);
1.197 www 6457: unless (&allowed('mau',$udom)) { return 'refused'; }
6458: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 6459: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6460: ' in domain '.$env{'request.role.domain'});
1.169 harris41 6461: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6462: &escape($upass),$uhome);
1.620 albertel 6463: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 6464: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6465: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6466: &log($udom,,$uname,$uhome,
1.620 albertel 6467: 'Authentication changed by '.$env{'user.domain'}.', '.
6468: $env{'user.name'}.', '.$umode.
1.197 www 6469: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 6470: unless ($reply eq 'ok') {
1.197 www 6471: &logthis('Authentication mode error: '.$reply);
1.169 harris41 6472: return 'error: '.$reply;
6473: }
1.170 harris41 6474: return 'ok';
1.80 www 6475: }
6476:
1.81 www 6477: # --------------------------------------------------------------- Modify a user
1.80 www 6478:
1.81 www 6479: sub modifyuser {
1.206 matthew 6480: my ($udom, $uname, $uid,
6481: $umode, $upass, $first,
6482: $middle, $last, $gene,
1.963 raeburn 6483: $forceid, $desiredhome, $email, $inststatus)=@_;
1.807 albertel 6484: $udom= &LONCAPA::clean_domain($udom);
6485: $uname=&LONCAPA::clean_username($uname);
1.81 www 6486: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 6487: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 6488: $last.', '.$gene.'(forceid: '.$forceid.')'.
6489: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6490: ' desiredhome not specified').
1.620 albertel 6491: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6492: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 6493: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 6494: # ----------------------------------------------------------------- Create User
1.406 albertel 6495: if (($uhome eq 'no_host') &&
6496: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 6497: my $unhome='';
1.844 albertel 6498: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 6499: $unhome = $desiredhome;
1.620 albertel 6500: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6501: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 6502: } else { # load balancing routine for determining $unhome
1.81 www 6503: my $loadm=10000000;
1.841 albertel 6504: my %servers = &get_servers($udom,'library');
6505: foreach my $tryserver (keys(%servers)) {
6506: my $answer=reply('load',$tryserver);
6507: if (($answer=~/\d+/) && ($answer<$loadm)) {
6508: $loadm=$answer;
6509: $unhome=$tryserver;
6510: }
1.80 www 6511: }
6512: }
6513: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 6514: return 'error: unable to find a home server for '.$uname.
6515: ' in domain '.$udom;
1.80 www 6516: }
6517: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6518: &escape($upass),$unhome);
6519: unless ($reply eq 'ok') {
6520: return 'error: '.$reply;
6521: }
1.230 stredwic 6522: $uhome=&homeserver($uname,$udom,'true');
1.80 www 6523: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 6524: return 'error: unable verify users home machine.';
1.80 www 6525: }
1.209 matthew 6526: } # End of creation of new user
1.80 www 6527: # ---------------------------------------------------------------------- Add ID
6528: if ($uid) {
6529: $uid=~tr/A-Z/a-z/;
6530: my %uidhash=&idrget($udom,$uname);
1.196 www 6531: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6532: && (!$forceid)) {
1.80 www 6533: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 6534: return 'error: user id "'.$uid.'" does not match '.
6535: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 6536: }
6537: } else {
6538: &idput($udom,($uname => $uid));
6539: }
6540: }
6541: # -------------------------------------------------------------- Add names, etc
1.313 matthew 6542: my @tmp=&get('environment',
1.899 raeburn 6543: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 6544: 'permanentemail','inststatus'],
1.134 albertel 6545: $udom,$uname);
1.313 matthew 6546: my %names;
6547: if ($tmp[0] =~ m/^error:.*/) {
6548: %names=();
6549: } else {
6550: %names = @tmp;
6551: }
1.388 www 6552: #
6553: # Make sure to not trash student environment if instructor does not bother
6554: # to supply name and email information
6555: #
6556: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 6557: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 6558: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 6559: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 6560: if ($email) {
6561: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 6562: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 6563: }
1.899 raeburn 6564: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 6565: if (defined($inststatus)) {
6566: $names{'inststatus'} = '';
6567: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6568: if (ref($usertypes) eq 'HASH') {
6569: my @okstatuses;
6570: foreach my $item (split(/:/,$inststatus)) {
6571: if (defined($usertypes->{$item})) {
6572: push(@okstatuses,$item);
6573: }
6574: }
6575: if (@okstatuses) {
6576: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6577: }
6578: }
6579: }
1.134 albertel 6580: my $reply = &put('environment', \%names, $udom,$uname);
6581: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 6582: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 6583: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.963 raeburn 6584: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6585: $umode.', '.$first.', '.$middle.', '.
6586: $last.', '.$gene.', '.$email.', '.$inststatus;
6587: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6588: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6589: } else {
6590: $logmsg .= ' during self creation';
6591: }
6592: &logthis($logmsg);
1.134 albertel 6593: return 'ok';
1.80 www 6594: }
6595:
1.81 www 6596: # -------------------------------------------------------------- Modify student
1.80 www 6597:
1.81 www 6598: sub modifystudent {
6599: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 6600: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 6601: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 6602: if (!$cid) {
1.620 albertel 6603: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6604: return 'not_in_class';
6605: }
1.80 www 6606: }
6607: # --------------------------------------------------------------- Make the user
1.81 www 6608: my $reply=&modifyuser
1.209 matthew 6609: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 6610: $desiredhome,$email,$inststatus);
1.80 www 6611: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 6612: # This will cause &modify_student_enrollment to get the uid from the
6613: # students environment
6614: $uid = undef if (!$forceid);
1.455 albertel 6615: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 6616: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 6617: return $reply;
6618: }
6619:
6620: sub modify_student_enrollment {
1.957 raeburn 6621: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 6622: my ($cdom,$cnum,$chome);
6623: if (!$cid) {
1.620 albertel 6624: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6625: return 'not_in_class';
6626: }
1.620 albertel 6627: $cdom=$env{'course.'.$cid.'.domain'};
6628: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 6629: } else {
6630: ($cdom,$cnum)=split(/_/,$cid);
6631: }
1.620 albertel 6632: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 6633: if (!$chome) {
1.457 raeburn 6634: $chome=&homeserver($cnum,$cdom);
1.297 matthew 6635: }
1.455 albertel 6636: if (!$chome) { return 'unknown_course'; }
1.297 matthew 6637: # Make sure the user exists
1.81 www 6638: my $uhome=&homeserver($uname,$udom);
6639: if (($uhome eq '') || ($uhome eq 'no_host')) {
6640: return 'error: no such user';
6641: }
1.297 matthew 6642: # Get student data if we were not given enough information
6643: if (!defined($first) || $first eq '' ||
6644: !defined($last) || $last eq '' ||
6645: !defined($uid) || $uid eq '' ||
6646: !defined($middle) || $middle eq '' ||
6647: !defined($gene) || $gene eq '') {
1.294 matthew 6648: # They did not supply us with enough data to enroll the student, so
6649: # we need to pick up more information.
1.297 matthew 6650: my %tmp = &get('environment',
1.294 matthew 6651: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 6652: ,$udom,$uname);
6653:
1.800 albertel 6654: #foreach my $key (keys(%tmp)) {
6655: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 6656: #}
1.294 matthew 6657: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6658: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6659: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 6660: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 6661: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6662: }
1.556 albertel 6663: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 6664: my $reply=cput('classlist',
6665: {"$uname:$udom" =>
1.515 raeburn 6666: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 6667: $cdom,$cnum);
1.81 www 6668: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6669: return 'error: '.$reply;
1.652 albertel 6670: } else {
6671: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 6672: }
1.297 matthew 6673: # Add student role to user
1.83 www 6674: my $uurl='/'.$cid;
1.81 www 6675: $uurl=~s/\_/\//g;
6676: if ($usec) {
6677: $uurl.='/'.$usec;
6678: }
1.957 raeburn 6679: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21 www 6680: }
6681:
1.556 albertel 6682: sub format_name {
6683: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6684: my $name;
6685: if ($first ne 'lastname') {
6686: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6687: } else {
6688: if ($lastname=~/\S/) {
6689: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6690: $name=~s/\s+,/,/;
6691: } else {
6692: $name.= $firstname.' '.$middlename.' '.$generation;
6693: }
6694: }
6695: $name=~s/^\s+//;
6696: $name=~s/\s+$//;
6697: $name=~s/\s+/ /g;
6698: return $name;
6699: }
6700:
1.84 www 6701: # ------------------------------------------------- Write to course preferences
6702:
6703: sub writecoursepref {
6704: my ($courseid,%prefs)=@_;
6705: $courseid=~s/^\///;
6706: $courseid=~s/\_/\//g;
6707: my ($cdomain,$cnum)=split(/\//,$courseid);
6708: my $chome=homeserver($cnum,$cdomain);
6709: if (($chome eq '') || ($chome eq 'no_host')) {
6710: return 'error: no such course';
6711: }
6712: my $cstring='';
1.800 albertel 6713: foreach my $pref (keys(%prefs)) {
6714: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 6715: }
1.84 www 6716: $cstring=~s/\&$//;
6717: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6718: }
6719:
6720: # ---------------------------------------------------------- Make/modify course
6721:
6722: sub createcourse {
1.741 raeburn 6723: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 6724: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 6725: $url=&declutter($url);
6726: my $cid='';
1.1028 raeburn 6727: if ($context eq 'requestcourses') {
6728: my $can_create = 0;
6729: my ($ownername,$ownerdom) = split(':',$course_owner);
6730: if ($udom eq $ownerdom) {
6731: if (&usertools_access($ownername,$ownerdom,$category,undef,
6732: $context)) {
6733: $can_create = 1;
6734: }
6735: } else {
6736: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6737: $category);
6738: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6739: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6740: if (@curr > 0) {
6741: my @options = qw(approval validate autolimit);
6742: my $optregex = join('|',@options);
6743: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6744: $can_create = 1;
6745: }
6746: }
6747: }
6748: }
6749: if ($can_create) {
6750: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6751: unless (&allowed('ccc',$udom)) {
6752: return 'refused';
6753: }
1.1017 raeburn 6754: }
6755: } else {
6756: return 'refused';
6757: }
1.1028 raeburn 6758: } elsif (!&allowed('ccc',$udom)) {
6759: return 'refused';
1.84 www 6760: }
1.1011 raeburn 6761: # --------------------------------------------------------------- Get Unique ID
6762: my $uname;
6763: if ($cnum =~ /^$match_courseid$/) {
6764: my $chome=&homeserver($cnum,$udom,'true');
6765: if (($chome eq '') || ($chome eq 'no_host')) {
6766: $uname = $cnum;
6767: } else {
1.1038 raeburn 6768: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6769: }
6770: } else {
1.1038 raeburn 6771: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6772: }
6773: return $uname if ($uname =~ /^error/);
6774: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 6775: if (!defined($course_server)) {
6776: if (defined(&domain($udom,'primary'))) {
6777: $course_server = &domain($udom,'primary');
6778: } else {
6779: $course_server = $env{'user.home'};
6780: }
6781: }
6782: my %host_servers =
6783: &Apache::lonnet::get_servers($udom,'library');
6784: unless ($host_servers{$course_server}) {
6785: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 6786: }
1.84 www 6787: # ------------------------------------------------------------- Make the course
6788: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 6789: $course_server);
1.84 www 6790: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 6791: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 6792: if (($uhome eq '') || ($uhome eq 'no_host')) {
6793: return 'error: no such course';
6794: }
1.271 www 6795: # ----------------------------------------------------------------- Course made
1.516 raeburn 6796: # log existence
1.1029 raeburn 6797: my $now = time;
1.918 raeburn 6798: my $newcourse = {
6799: $udom.'_'.$uname => {
1.921 raeburn 6800: description => $description,
6801: inst_code => $inst_code,
6802: owner => $course_owner,
6803: type => $crstype,
1.1029 raeburn 6804: creator => $env{'user.name'}.':'.
6805: $env{'user.domain'},
6806: created => $now,
6807: context => $context,
1.918 raeburn 6808: },
6809: };
1.921 raeburn 6810: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 6811: # set toplevel url
1.271 www 6812: my $topurl=$url;
6813: unless ($nonstandard) {
6814: # ------------------------------------------ For standard courses, make top url
6815: my $mapurl=&clutter($url);
1.278 www 6816: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 6817: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 6818: <map>
6819: <resource id="1" type="start"></resource>
6820: <resource id="2" src="$mapurl"></resource>
6821: <resource id="3" type="finish"></resource>
6822: <link index="1" from="1" to="2"></link>
6823: <link index="2" from="2" to="3"></link>
6824: </map>
6825: ENDINITMAP
6826: $topurl=&declutter(
1.638 albertel 6827: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 6828: );
6829: }
6830: # ----------------------------------------------------------- Write preferences
1.84 www 6831: &writecoursepref($udom.'_'.$uname,
6832: ('description' => $description,
1.271 www 6833: 'url' => $topurl));
1.84 www 6834: return '/'.$udom.'/'.$uname;
6835: }
6836:
1.1011 raeburn 6837: # ------------------------------------------------------------------- Create ID
6838: sub generate_coursenum {
1.1038 raeburn 6839: my ($udom,$crstype) = @_;
1.1011 raeburn 6840: my $domdesc = &domain($udom);
6841: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 6842: my $first;
6843: if ($crstype eq 'Community') {
6844: $first = '0';
6845: } else {
6846: $first = int(1+rand(9));
6847: }
6848: my $uname=$first.
1.1011 raeburn 6849: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6850: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6851: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6852: # ----------------------------------------------- Make sure that does not exist
6853: my $uhome=&homeserver($uname,$udom,'true');
6854: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 6855: if ($crstype eq 'Community') {
6856: $first = '0';
6857: } else {
6858: $first = int(1+rand(9));
6859: }
6860: $uname=$first.
1.1011 raeburn 6861: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6862: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6863: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6864: $uhome=&homeserver($uname,$udom,'true');
6865: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6866: return 'error: unable to generate unique course-ID';
6867: }
6868: }
6869: return $uname;
6870: }
6871:
1.813 albertel 6872: sub is_course {
6873: my ($cdom,$cnum) = @_;
6874: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946 raeburn 6875: undef,'.');
1.813 albertel 6876: if (exists($courses{$cdom.'_'.$cnum})) {
6877: return 1;
6878: }
6879: return 0;
6880: }
6881:
1.1015 raeburn 6882: sub store_userdata {
6883: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 6884: my $result;
1.1016 raeburn 6885: if ($datakey ne '') {
1.1013 raeburn 6886: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 6887: if ($udom eq '' || $uname eq '') {
6888: $udom = $env{'user.domain'};
6889: $uname = $env{'user.name'};
6890: }
6891: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 6892: if (($uhome eq '') || ($uhome eq 'no_host')) {
6893: $result = 'error: no_host';
6894: } else {
6895: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6896: $storehash->{'host'} = $perlvar{'lonHostID'};
6897:
6898: my $namevalue='';
6899: foreach my $key (keys(%{$storehash})) {
6900: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6901: }
6902: $namevalue=~s/\&$//;
6903: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
1.1015 raeburn 6904: "$namespace:$datakey:$namevalue",$uhome);
1.1013 raeburn 6905: }
6906: } else {
6907: $result = 'error: data to store was not a hash reference';
6908: }
6909: } else {
6910: $result= 'error: invalid requestkey';
6911: }
6912: return $result;
6913: }
6914:
1.21 www 6915: # ---------------------------------------------------------- Assign Custom Role
6916:
6917: sub assigncustomrole {
1.957 raeburn 6918: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6919: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 6920: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 6921: }
6922:
6923: # ----------------------------------------------------------------- Revoke Role
6924:
6925: sub revokerole {
1.957 raeburn 6926: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6927: my $now=time;
1.965 raeburn 6928: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 6929: }
6930:
6931: # ---------------------------------------------------------- Revoke Custom Role
6932:
6933: sub revokecustomrole {
1.957 raeburn 6934: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6935: my $now=time;
1.357 www 6936: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 6937: $deleteflag,$selfenroll,$context);
1.17 www 6938: }
6939:
1.533 banghart 6940: # ------------------------------------------------------------ Disk usage
1.535 albertel 6941: sub diskusage {
1.955 raeburn 6942: my ($udom,$uname,$directorypath,$getpropath)=@_;
6943: $directorypath =~ s/\/$//;
6944: my $listing=&reply('du2:'.&escape($directorypath).':'
6945: .&escape($getpropath).':'.&escape($uname).':'
6946: .&escape($udom),homeserver($uname,$udom));
6947: if ($listing eq 'unknown_cmd') {
6948: if ($getpropath) {
6949: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6950: }
6951: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6952: }
1.514 albertel 6953: return $listing;
1.512 banghart 6954: }
6955:
1.566 banghart 6956: sub is_locked {
6957: my ($file_name, $domain, $user) = @_;
6958: my @check;
6959: my $is_locked;
6960: push @check, $file_name;
1.613 albertel 6961: my %locked = &get('file_permissions',\@check,
1.620 albertel 6962: $env{'user.domain'},$env{'user.name'});
1.615 albertel 6963: my ($tmp)=keys(%locked);
6964: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 6965:
1.566 banghart 6966: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 6967: $is_locked = 'false';
6968: foreach my $entry (@{$locked{$file_name}}) {
6969: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 6970: $is_locked = 'true';
6971: last;
1.745 raeburn 6972: }
6973: }
1.566 banghart 6974: } else {
6975: $is_locked = 'false';
6976: }
6977: }
6978:
1.759 albertel 6979: sub declutter_portfile {
6980: my ($file) = @_;
1.833 albertel 6981: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 6982: return $file;
6983: }
6984:
1.559 banghart 6985: # ------------------------------------------------------------- Mark as Read Only
6986:
6987: sub mark_as_readonly {
6988: my ($domain,$user,$files,$what) = @_;
1.613 albertel 6989: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 6990: my ($tmp)=keys(%current_permissions);
6991: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 6992: foreach my $file (@{$files}) {
1.759 albertel 6993: $file = &declutter_portfile($file);
1.561 banghart 6994: push(@{$current_permissions{$file}},$what);
1.559 banghart 6995: }
1.613 albertel 6996: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 6997: return;
6998: }
6999:
1.572 banghart 7000: # ------------------------------------------------------------Save Selected Files
7001:
7002: sub save_selected_files {
7003: my ($user, $path, @files) = @_;
7004: my $filename = $user."savedfiles";
1.573 banghart 7005: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 7006: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 7007: foreach my $file (@files) {
1.620 albertel 7008: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 7009: }
7010: foreach my $file (@other_files) {
1.574 banghart 7011: print (OUT $file."\n");
1.572 banghart 7012: }
1.574 banghart 7013: close (OUT);
1.572 banghart 7014: return 'ok';
7015: }
7016:
1.574 banghart 7017: sub clear_selected_files {
7018: my ($user) = @_;
7019: my $filename = $user."savedfiles";
7020: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7021: print (OUT undef);
7022: close (OUT);
7023: return ("ok");
7024: }
7025:
1.572 banghart 7026: sub files_in_path {
7027: my ($user, $path) = @_;
7028: my $filename = $user."savedfiles";
7029: my %return_files;
1.574 banghart 7030: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 7031: while (my $line_in = <IN>) {
1.574 banghart 7032: chomp ($line_in);
7033: my @paths_and_file = split (m!/!, $line_in);
7034: my $file_part = pop (@paths_and_file);
7035: my $path_part = join ('/', @paths_and_file);
1.573 banghart 7036: $path_part.='/';
7037: my $path_and_file = $path_part.$file_part;
7038: if ($path_part eq $path) {
7039: $return_files{$file_part}= 'selected';
7040: }
7041: }
1.574 banghart 7042: close (IN);
7043: return (\%return_files);
1.572 banghart 7044: }
7045:
7046: # called in portfolio select mode, to show files selected NOT in current directory
7047: sub files_not_in_path {
7048: my ($user, $path) = @_;
7049: my $filename = $user."savedfiles";
7050: my @return_files;
7051: my $path_part;
1.800 albertel 7052: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7053: while (my $line = <IN>) {
1.572 banghart 7054: #ok, I know it's clunky, but I want it to work
1.800 albertel 7055: my @paths_and_file = split(m|/|, $line);
7056: my $file_part = pop(@paths_and_file);
7057: chomp($file_part);
7058: my $path_part = join('/', @paths_and_file);
1.572 banghart 7059: $path_part .= '/';
7060: my $path_and_file = $path_part.$file_part;
7061: if ($path_part ne $path) {
1.800 albertel 7062: push(@return_files, ($path_and_file));
1.572 banghart 7063: }
7064: }
1.800 albertel 7065: close(OUT);
1.574 banghart 7066: return (@return_files);
1.572 banghart 7067: }
7068:
1.745 raeburn 7069: #----------------------------------------------Get portfolio file permissions
1.629 banghart 7070:
1.745 raeburn 7071: sub get_portfile_permissions {
7072: my ($domain,$user) = @_;
1.613 albertel 7073: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 7074: my ($tmp)=keys(%current_permissions);
7075: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7076: return \%current_permissions;
7077: }
7078:
7079: #---------------------------------------------Get portfolio file access controls
7080:
1.749 raeburn 7081: sub get_access_controls {
1.745 raeburn 7082: my ($current_permissions,$group,$file) = @_;
1.769 albertel 7083: my %access;
7084: my $real_file = $file;
7085: $file =~ s/\.meta$//;
1.745 raeburn 7086: if (defined($file)) {
1.749 raeburn 7087: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7088: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 7089: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 7090: }
7091: }
1.745 raeburn 7092: } else {
1.749 raeburn 7093: foreach my $key (keys(%{$current_permissions})) {
7094: if ($key =~ /\0accesscontrol$/) {
7095: if (defined($group)) {
7096: if ($key !~ m-^\Q$group\E/-) {
7097: next;
7098: }
7099: }
7100: my ($fullpath) = split(/\0/,$key);
7101: if (ref($$current_permissions{$key}) eq 'HASH') {
7102: foreach my $control (keys(%{$$current_permissions{$key}})) {
7103: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7104: }
7105: }
7106: }
7107: }
7108: }
7109: return %access;
7110: }
7111:
7112: sub modify_access_controls {
7113: my ($file_name,$changes,$domain,$user)=@_;
7114: my ($outcome,$deloutcome);
7115: my %store_permissions;
7116: my %new_values;
7117: my %new_control;
7118: my %translation;
7119: my @deletions = ();
7120: my $now = time;
7121: if (exists($$changes{'activate'})) {
7122: if (ref($$changes{'activate'}) eq 'HASH') {
7123: my @newitems = sort(keys(%{$$changes{'activate'}}));
7124: my $numnew = scalar(@newitems);
7125: for (my $i=0; $i<$numnew; $i++) {
7126: my $newkey = $newitems[$i];
7127: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 7128: if ($newkey =~ /^\d+:/) {
7129: $newkey =~ s/^(\d+)/$newid/;
7130: $translation{$1} = $newid;
7131: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7132: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7133: $translation{$1} = $newid;
7134: }
1.749 raeburn 7135: $new_values{$file_name."\0".$newkey} =
7136: $$changes{'activate'}{$newitems[$i]};
7137: $new_control{$newkey} = $now;
7138: }
7139: }
7140: }
7141: my %todelete;
7142: my %changed_items;
7143: foreach my $action ('delete','update') {
7144: if (exists($$changes{$action})) {
7145: if (ref($$changes{$action}) eq 'HASH') {
7146: foreach my $key (keys(%{$$changes{$action}})) {
7147: my ($itemnum) = ($key =~ /^([^:]+):/);
7148: if ($action eq 'delete') {
7149: $todelete{$itemnum} = 1;
7150: } else {
7151: $changed_items{$itemnum} = $key;
7152: }
7153: }
1.745 raeburn 7154: }
7155: }
1.749 raeburn 7156: }
7157: # get lock on access controls for file.
7158: my $lockhash = {
7159: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7160: ':'.$env{'user.domain'},
7161: };
7162: my $tries = 0;
7163: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7164:
7165: while (($gotlock ne 'ok') && $tries <3) {
7166: $tries ++;
7167: sleep 1;
7168: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7169: }
7170: if ($gotlock eq 'ok') {
7171: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7172: my ($tmp)=keys(%curr_permissions);
7173: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7174: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7175: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7176: if (ref($curr_controls) eq 'HASH') {
7177: foreach my $control_item (keys(%{$curr_controls})) {
7178: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7179: if (defined($todelete{$itemnum})) {
7180: push(@deletions,$file_name."\0".$control_item);
7181: } else {
7182: if (defined($changed_items{$itemnum})) {
7183: $new_control{$changed_items{$itemnum}} = $now;
7184: push(@deletions,$file_name."\0".$control_item);
7185: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7186: } else {
7187: $new_control{$control_item} = $$curr_controls{$control_item};
7188: }
7189: }
1.745 raeburn 7190: }
7191: }
7192: }
1.970 raeburn 7193: my ($group);
7194: if (&is_course($domain,$user)) {
7195: ($group,my $file) = split(/\//,$file_name,2);
7196: }
1.749 raeburn 7197: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7198: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7199: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7200: # remove lock
7201: my @del_lock = ($file_name."\0".'locked_access_records');
7202: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 7203: my $sqlresult =
1.970 raeburn 7204: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 7205: $group);
1.749 raeburn 7206: } else {
7207: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 7208: }
1.749 raeburn 7209: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 7210: }
7211:
1.827 raeburn 7212: sub make_public_indefinitely {
7213: my ($requrl) = @_;
7214: my $now = time;
7215: my $action = 'activate';
7216: my $aclnum = 0;
7217: if (&is_portfolio_url($requrl)) {
7218: my (undef,$udom,$unum,$file_name,$group) =
7219: &parse_portfolio_url($requrl);
7220: my $current_perms = &get_portfile_permissions($udom,$unum);
7221: my %access_controls = &get_access_controls($current_perms,
7222: $group,$file_name);
7223: foreach my $key (keys(%{$access_controls{$file_name}})) {
7224: my ($num,$scope,$end,$start) =
7225: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7226: if ($scope eq 'public') {
7227: if ($start <= $now && $end == 0) {
7228: $action = 'none';
7229: } else {
7230: $action = 'update';
7231: $aclnum = $num;
7232: }
7233: last;
7234: }
7235: }
7236: if ($action eq 'none') {
7237: return 'ok';
7238: } else {
7239: my %changes;
7240: my $newend = 0;
7241: my $newstart = $now;
7242: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7243: $changes{$action}{$newkey} = {
7244: type => 'public',
7245: time => {
7246: start => $newstart,
7247: end => $newend,
7248: },
7249: };
7250: my ($outcome,$deloutcome,$new_values,$translation) =
7251: &modify_access_controls($file_name,\%changes,$udom,$unum);
7252: return $outcome;
7253: }
7254: } else {
7255: return 'invalid';
7256: }
7257: }
7258:
1.745 raeburn 7259: #------------------------------------------------------Get Marked as Read Only
7260:
7261: sub get_marked_as_readonly {
7262: my ($domain,$user,$what,$group) = @_;
7263: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 7264: my @readonly_files;
1.629 banghart 7265: my $cmp1=$what;
7266: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 7267: while (my ($file_name,$value) = each(%{$current_permissions})) {
7268: if (defined($group)) {
7269: if ($file_name !~ m-^\Q$group\E/-) {
7270: next;
7271: }
7272: }
1.561 banghart 7273: if (ref($value) eq "ARRAY"){
7274: foreach my $stored_what (@{$value}) {
1.629 banghart 7275: my $cmp2=$stored_what;
1.759 albertel 7276: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 7277: $cmp2=join('',@{$stored_what});
1.745 raeburn 7278: }
1.629 banghart 7279: if ($cmp1 eq $cmp2) {
1.561 banghart 7280: push(@readonly_files, $file_name);
1.745 raeburn 7281: last;
1.563 banghart 7282: } elsif (!defined($what)) {
7283: push(@readonly_files, $file_name);
1.745 raeburn 7284: last;
1.561 banghart 7285: }
7286: }
1.745 raeburn 7287: }
1.561 banghart 7288: }
7289: return @readonly_files;
7290: }
1.577 banghart 7291: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 7292:
1.577 banghart 7293: sub get_marked_as_readonly_hash {
1.745 raeburn 7294: my ($current_permissions,$group,$what) = @_;
1.577 banghart 7295: my %readonly_files;
1.745 raeburn 7296: while (my ($file_name,$value) = each(%{$current_permissions})) {
7297: if (defined($group)) {
7298: if ($file_name !~ m-^\Q$group\E/-) {
7299: next;
7300: }
7301: }
1.577 banghart 7302: if (ref($value) eq "ARRAY"){
7303: foreach my $stored_what (@{$value}) {
1.745 raeburn 7304: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 7305: foreach my $lock_descriptor(@{$stored_what}) {
7306: if ($lock_descriptor eq 'graded') {
7307: $readonly_files{$file_name} = 'graded';
7308: } elsif ($lock_descriptor eq 'handback') {
7309: $readonly_files{$file_name} = 'handback';
7310: } else {
7311: if (!exists($readonly_files{$file_name})) {
7312: $readonly_files{$file_name} = 'locked';
7313: }
7314: }
1.745 raeburn 7315: }
1.750 banghart 7316: }
1.577 banghart 7317: }
7318: }
7319: }
7320: return %readonly_files;
7321: }
1.559 banghart 7322: # ------------------------------------------------------------ Unmark as Read Only
7323:
7324: sub unmark_as_readonly {
1.629 banghart 7325: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7326: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 7327: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 7328: $file_name = &declutter_portfile($file_name);
1.634 albertel 7329: my $symb_crs = $what;
7330: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 7331: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 7332: my ($tmp)=keys(%current_permissions);
7333: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7334: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 7335: foreach my $file (@readonly_files) {
1.759 albertel 7336: my $clean_file = &declutter_portfile($file);
7337: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 7338: my $current_locks = $current_permissions{$file};
1.563 banghart 7339: my @new_locks;
7340: my @del_keys;
7341: if (ref($current_locks) eq "ARRAY"){
7342: foreach my $locker (@{$current_locks}) {
1.632 albertel 7343: my $compare=$locker;
1.749 raeburn 7344: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 7345: $compare=join('',@{$locker});
1.746 raeburn 7346: if ($compare ne $symb_crs) {
7347: push(@new_locks, $locker);
7348: }
1.563 banghart 7349: }
7350: }
1.650 albertel 7351: if (scalar(@new_locks) > 0) {
1.563 banghart 7352: $current_permissions{$file} = \@new_locks;
7353: } else {
7354: push(@del_keys, $file);
1.613 albertel 7355: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 7356: delete($current_permissions{$file});
1.563 banghart 7357: }
7358: }
1.561 banghart 7359: }
1.613 albertel 7360: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7361: return;
7362: }
1.512 banghart 7363:
1.17 www 7364: # ------------------------------------------------------------ Directory lister
7365:
7366: sub dirlist {
1.955 raeburn 7367: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 7368: $uri=~s/^\///;
7369: $uri=~s/\/$//;
1.253 stredwic 7370: my ($udom, $uname);
1.955 raeburn 7371: if ($getuserdir) {
1.253 stredwic 7372: $udom = $userdomain;
7373: $uname = $username;
1.955 raeburn 7374: } else {
7375: (undef,$udom,$uname)=split(/\//,$uri);
7376: if(defined($userdomain)) {
7377: $udom = $userdomain;
7378: }
7379: if(defined($username)) {
7380: $uname = $username;
7381: }
1.253 stredwic 7382: }
1.955 raeburn 7383: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 7384:
1.955 raeburn 7385: $dirRoot = $perlvar{'lonDocRoot'};
7386: if (defined($getpropath)) {
7387: $dirRoot = &propath($udom,$uname);
1.253 stredwic 7388: $dirRoot =~ s/\/$//;
1.955 raeburn 7389: } elsif (defined($getuserdir)) {
7390: my $subdir=$uname.'__';
7391: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7392: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7393: ."/$udom/$subdir/$uname";
7394: } elsif (defined($alternateRoot)) {
7395: $dirRoot = $alternateRoot;
1.751 banghart 7396: }
1.253 stredwic 7397:
7398: if($udom) {
7399: if($uname) {
1.955 raeburn 7400: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 7401: .$getuserdir.':'.&escape($dirRoot)
1.955 raeburn 7402: .':'.&escape($uname).':'.&escape($udom),
7403: &homeserver($uname,$udom));
7404: if ($listing eq 'unknown_cmd') {
7405: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7406: &homeserver($uname,$udom));
7407: } else {
7408: @listing_results = map { &unescape($_); } split(/:/,$listing);
7409: }
1.605 matthew 7410: if ($listing eq 'unknown_cmd') {
1.800 albertel 7411: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7412: &homeserver($uname,$udom));
1.605 matthew 7413: @listing_results = split(/:/,$listing);
7414: } else {
7415: @listing_results = map { &unescape($_); } split(/:/,$listing);
7416: }
7417: return @listing_results;
1.955 raeburn 7418: } elsif(!$alternateRoot) {
1.800 albertel 7419: my %allusers;
1.841 albertel 7420: my %servers = &get_servers($udom,'library');
1.955 raeburn 7421: foreach my $tryserver (keys(%servers)) {
7422: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7423: &escape($udom),$tryserver);
7424: if ($listing eq 'unknown_cmd') {
7425: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7426: $udom, $tryserver);
7427: } else {
7428: @listing_results = map { &unescape($_); } split(/:/,$listing);
7429: }
1.841 albertel 7430: if ($listing eq 'unknown_cmd') {
7431: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7432: $udom, $tryserver);
7433: @listing_results = split(/:/,$listing);
7434: } else {
7435: @listing_results =
7436: map { &unescape($_); } split(/:/,$listing);
7437: }
7438: if ($listing_results[0] ne 'no_such_dir' &&
7439: $listing_results[0] ne 'empty' &&
7440: $listing_results[0] ne 'con_lost') {
7441: foreach my $line (@listing_results) {
7442: my ($entry) = split(/&/,$line,2);
7443: $allusers{$entry} = 1;
7444: }
7445: }
1.253 stredwic 7446: }
7447: my $alluserstr='';
1.800 albertel 7448: foreach my $user (sort(keys(%allusers))) {
7449: $alluserstr.=$user.'&user:';
1.253 stredwic 7450: }
7451: $alluserstr=~s/:$//;
7452: return split(/:/,$alluserstr);
7453: } else {
1.800 albertel 7454: return ('missing user name');
1.253 stredwic 7455: }
1.955 raeburn 7456: } elsif(!defined($getpropath)) {
1.841 albertel 7457: my @all_domains = sort(&all_domains());
1.955 raeburn 7458: foreach my $domain (@all_domains) {
7459: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7460: }
7461: return @all_domains;
7462: } else {
1.800 albertel 7463: return ('missing domain');
1.275 stredwic 7464: }
7465: }
7466:
7467: # --------------------------------------------- GetFileTimestamp
7468: # This function utilizes dirlist and returns the date stamp for
7469: # when it was last modified. It will also return an error of -1
7470: # if an error occurs
7471:
7472: sub GetFileTimestamp {
1.955 raeburn 7473: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 7474: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7475: $studentName = &LONCAPA::clean_username($studentName);
1.955 raeburn 7476: my ($fileStat) =
7477: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7478: undef,$getuserdir);
1.275 stredwic 7479: my @stats = split('&', $fileStat);
7480: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 7481: # @stats contains first the filename, then the stat output
7482: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 7483: } else {
7484: return -1;
1.253 stredwic 7485: }
1.26 www 7486: }
7487:
1.712 albertel 7488: sub stat_file {
7489: my ($uri) = @_;
1.787 albertel 7490: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 7491:
1.955 raeburn 7492: my ($udom,$uname,$file);
1.712 albertel 7493: if ($uri =~ m-^/(uploaded|editupload)/-) {
7494: ($udom,$uname,$file) =
1.811 albertel 7495: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 7496: $file = 'userfiles/'.$file;
7497: }
7498: if ($uri =~ m-^/res/-) {
7499: ($udom,$uname) =
1.807 albertel 7500: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 7501: $file = $uri;
7502: }
7503:
7504: if (!$udom || !$uname || !$file) {
7505: # unable to handle the uri
7506: return ();
7507: }
1.956 raeburn 7508: my $getpropath;
7509: if ($file =~ /^userfiles\//) {
7510: $getpropath = 1;
7511: }
1.955 raeburn 7512: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712 albertel 7513: my @stats = split('&', $result);
1.721 banghart 7514:
1.712 albertel 7515: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7516: shift(@stats); #filename is first
7517: return @stats;
7518: }
7519: return ();
7520: }
7521:
1.26 www 7522: # -------------------------------------------------------- Value of a Condition
7523:
1.713 albertel 7524: # gets the value of a specific preevaluated condition
7525: # stored in the string $env{user.state.<cid>}
7526: # or looks up a condition reference in the bighash and if if hasn't
7527: # already been evaluated recurses into docondval to get the value of
7528: # the condition, then memoizing it to
7529: # $env{user.state.<cid>.<condition>}
1.40 www 7530: sub directcondval {
7531: my $number=shift;
1.620 albertel 7532: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 7533: &Apache::lonuserstate::evalstate();
7534: }
1.713 albertel 7535: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7536: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7537: } elsif ($number =~ /^_/) {
7538: my $sub_condition;
7539: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7540: &GDBM_READER(),0640)) {
7541: $sub_condition=$bighash{'conditions'.$number};
7542: untie(%bighash);
7543: }
7544: my $value = &docondval($sub_condition);
1.949 raeburn 7545: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 7546: return $value;
7547: }
1.620 albertel 7548: if ($env{'user.state.'.$env{'request.course.id'}}) {
7549: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 7550: } else {
7551: return 2;
7552: }
7553: }
7554:
1.713 albertel 7555: # get the collection of conditions for this resource
1.26 www 7556: sub condval {
7557: my $condidx=shift;
1.54 www 7558: my $allpathcond='';
1.713 albertel 7559: foreach my $cond (split(/\|/,$condidx)) {
7560: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7561: $allpathcond.=
7562: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7563: }
1.191 harris41 7564: }
1.54 www 7565: $allpathcond=~s/\|$//;
1.713 albertel 7566: return &docondval($allpathcond);
7567: }
7568:
7569: #evaluates an expression of conditions
7570: sub docondval {
7571: my ($allpathcond) = @_;
7572: my $result=0;
7573: if ($env{'request.course.id'}
7574: && defined($allpathcond)) {
7575: my $operand='|';
7576: my @stack;
7577: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7578: if ($chunk eq '(') {
7579: push @stack,($operand,$result);
7580: } elsif ($chunk eq ')') {
7581: my $before=pop @stack;
7582: if (pop @stack eq '&') {
7583: $result=$result>$before?$before:$result;
7584: } else {
7585: $result=$result>$before?$result:$before;
7586: }
7587: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7588: $operand=$chunk;
7589: } else {
7590: my $new=directcondval($chunk);
7591: if ($operand eq '&') {
7592: $result=$result>$new?$new:$result;
7593: } else {
7594: $result=$result>$new?$result:$new;
7595: }
7596: }
7597: }
1.26 www 7598: }
7599: return $result;
1.421 albertel 7600: }
7601:
7602: # ---------------------------------------------------- Devalidate courseresdata
7603:
7604: sub devalidatecourseresdata {
7605: my ($coursenum,$coursedomain)=@_;
7606: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7607: &devalidate_cache_new('courseres',$hashid);
1.28 www 7608: }
7609:
1.763 www 7610:
1.200 www 7611: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 7612: #
7613: # Parameters:
7614: # $coursenum - Number of the course.
7615: # $coursedomain - Domain at which the course was created.
7616: # Returns:
7617: # A hash of the course parameters along (I think) with timestamps
7618: # and version info.
1.877 foxr 7619:
1.624 albertel 7620: sub get_courseresdata {
7621: my ($coursenum,$coursedomain)=@_;
1.200 www 7622: my $coursehom=&homeserver($coursenum,$coursedomain);
7623: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7624: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 7625: my %dumpreply;
1.417 albertel 7626: unless (defined($cached)) {
1.624 albertel 7627: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 7628: $result=\%dumpreply;
1.251 albertel 7629: my ($tmp) = keys(%dumpreply);
7630: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 7631: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 7632: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7633: return $tmp;
1.416 albertel 7634: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 7635: $result=undef;
1.599 albertel 7636: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 7637: }
7638: }
1.624 albertel 7639: return $result;
7640: }
7641:
1.633 albertel 7642: sub devalidateuserresdata {
7643: my ($uname,$udom)=@_;
7644: my $hashid="$udom:$uname";
7645: &devalidate_cache_new('userres',$hashid);
7646: }
7647:
1.624 albertel 7648: sub get_userresdata {
7649: my ($uname,$udom)=@_;
7650: #most student don\'t have any data set, check if there is some data
7651: if (&EXT_cache_status($udom,$uname)) { return undef; }
7652:
7653: my $hashid="$udom:$uname";
7654: my ($result,$cached)=&is_cached_new('userres',$hashid);
7655: if (!defined($cached)) {
7656: my %resourcedata=&dump('resourcedata',$udom,$uname);
7657: $result=\%resourcedata;
7658: &do_cache_new('userres',$hashid,$result,600);
7659: }
7660: my ($tmp)=keys(%$result);
7661: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7662: return $result;
7663: }
7664: #error 2 occurs when the .db doesn't exist
7665: if ($tmp!~/error: 2 /) {
1.672 albertel 7666: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 7667: " Trying to get resource data for ".
7668: $uname." at ".$udom.": ".
7669: $tmp."</font>");
7670: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 7671: #&EXT_cache_set($udom,$uname);
7672: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 7673: undef($tmp); # not really an error so don't send it back
1.624 albertel 7674: }
7675: return $tmp;
7676: }
1.879 foxr 7677: #----------------------------------------------- resdata - return resource data
7678: # Purpose:
7679: # Return resource data for either users or for a course.
7680: # Parameters:
7681: # $name - Course/user name.
7682: # $domain - Name of the domain the user/course is registered on.
7683: # $type - Type of thing $name is (must be 'course' or 'user'
7684: # @which - Array of names of resources desired.
7685: # Returns:
7686: # The value of the first reasource in @which that is found in the
7687: # resource hash.
7688: # Exceptional Conditions:
7689: # If the $type passed in is not valid (not the string 'course' or
7690: # 'user', an undefined reference is returned.
7691: # If none of the resources are found, an undef is returned
1.624 albertel 7692: sub resdata {
7693: my ($name,$domain,$type,@which)=@_;
7694: my $result;
7695: if ($type eq 'course') {
7696: $result=&get_courseresdata($name,$domain);
7697: } elsif ($type eq 'user') {
7698: $result=&get_userresdata($name,$domain);
7699: }
7700: if (!ref($result)) { return $result; }
1.251 albertel 7701: foreach my $item (@which) {
1.927 albertel 7702: if (defined($result->{$item->[0]})) {
7703: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 7704: }
1.250 albertel 7705: }
1.291 albertel 7706: return undef;
1.200 www 7707: }
7708:
1.379 matthew 7709: #
7710: # EXT resource caching routines
7711: #
7712:
7713: sub clear_EXT_cache_status {
1.383 albertel 7714: &delenv('cache.EXT.');
1.379 matthew 7715: }
7716:
7717: sub EXT_cache_status {
7718: my ($target_domain,$target_user) = @_;
1.383 albertel 7719: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 7720: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 7721: # We know already the user has no data
7722: return 1;
7723: } else {
7724: return 0;
7725: }
7726: }
7727:
7728: sub EXT_cache_set {
7729: my ($target_domain,$target_user) = @_;
1.383 albertel 7730: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 7731: #&appenv({$cachename => time});
1.379 matthew 7732: }
7733:
1.28 www 7734: # --------------------------------------------------------- Value of a Variable
1.58 www 7735: sub EXT {
1.715 albertel 7736:
1.395 albertel 7737: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 7738: unless ($varname) { return ''; }
1.218 albertel 7739: #get real user name/domain, courseid and symb
7740: my $courseid;
1.359 albertel 7741: my $publicuser;
1.427 www 7742: if ($symbparm) {
7743: $symbparm=&get_symb_from_alias($symbparm);
7744: }
1.218 albertel 7745: if (!($uname && $udom)) {
1.790 albertel 7746: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 7747: if (!$symbparm) { $symbparm=$cursymb; }
7748: } else {
1.620 albertel 7749: $courseid=$env{'request.course.id'};
1.218 albertel 7750: }
1.48 www 7751: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7752: my $rest;
1.320 albertel 7753: if (defined($therest[0])) {
1.48 www 7754: $rest=join('.',@therest);
7755: } else {
7756: $rest='';
7757: }
1.320 albertel 7758:
1.57 www 7759: my $qualifierrest=$qualifier;
7760: if ($rest) { $qualifierrest.='.'.$rest; }
7761: my $spacequalifierrest=$space;
7762: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 7763: if ($realm eq 'user') {
1.48 www 7764: # --------------------------------------------------------------- user.resource
7765: if ($space eq 'resource') {
1.651 albertel 7766: if ( (defined($Apache::lonhomework::parsing_a_problem)
7767: || defined($Apache::lonhomework::parsing_a_task))
7768: &&
1.744 albertel 7769: ($symbparm eq &symbread()) ) {
7770: # if we are in the middle of processing the resource the
7771: # get the value we are planning on committing
7772: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7773: return $Apache::lonhomework::results{$qualifierrest};
7774: } else {
7775: return $Apache::lonhomework::history{$qualifierrest};
7776: }
1.335 albertel 7777: } else {
1.359 albertel 7778: my %restored;
1.620 albertel 7779: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 7780: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7781: } else {
7782: %restored=&restore($symbparm,$courseid,$udom,$uname);
7783: }
1.335 albertel 7784: return $restored{$qualifierrest};
7785: }
1.48 www 7786: # ----------------------------------------------------------------- user.access
7787: } elsif ($space eq 'access') {
1.218 albertel 7788: # FIXME - not supporting calls for a specific user
1.48 www 7789: return &allowed($qualifier,$rest);
7790: # ------------------------------------------ user.preferences, user.environment
7791: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 7792: if (($uname eq $env{'user.name'}) &&
7793: ($udom eq $env{'user.domain'})) {
7794: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 7795: } else {
1.359 albertel 7796: my %returnhash;
7797: if (!$publicuser) {
7798: %returnhash=&userenvironment($udom,$uname,
7799: $qualifierrest);
7800: }
1.218 albertel 7801: return $returnhash{$qualifierrest};
7802: }
1.48 www 7803: # ----------------------------------------------------------------- user.course
7804: } elsif ($space eq 'course') {
1.218 albertel 7805: # FIXME - not supporting calls for a specific user
1.620 albertel 7806: return $env{join('.',('request.course',$qualifier))};
1.48 www 7807: # ------------------------------------------------------------------- user.role
7808: } elsif ($space eq 'role') {
1.218 albertel 7809: # FIXME - not supporting calls for a specific user
1.620 albertel 7810: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 7811: if ($qualifier eq 'value') {
7812: return $role;
7813: } elsif ($qualifier eq 'extent') {
7814: return $where;
7815: }
7816: # ----------------------------------------------------------------- user.domain
7817: } elsif ($space eq 'domain') {
1.218 albertel 7818: return $udom;
1.48 www 7819: # ------------------------------------------------------------------- user.name
7820: } elsif ($space eq 'name') {
1.218 albertel 7821: return $uname;
1.48 www 7822: # ---------------------------------------------------- Any other user namespace
1.29 www 7823: } else {
1.359 albertel 7824: my %reply;
7825: if (!$publicuser) {
7826: %reply=&get($space,[$qualifierrest],$udom,$uname);
7827: }
7828: return $reply{$qualifierrest};
1.48 www 7829: }
1.236 www 7830: } elsif ($realm eq 'query') {
7831: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 7832: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7833: [$spacequalifierrest]);
1.620 albertel 7834: return $env{'form.'.$spacequalifierrest};
1.236 www 7835: } elsif ($realm eq 'request') {
1.48 www 7836: # ------------------------------------------------------------- request.browser
7837: if ($space eq 'browser') {
1.430 www 7838: if ($qualifier eq 'textremote') {
1.676 albertel 7839: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 7840: return 1;
7841: } else {
7842: return 0;
7843: }
7844: } else {
1.620 albertel 7845: return $env{'browser.'.$qualifier};
1.430 www 7846: }
1.57 www 7847: # ------------------------------------------------------------ request.filename
7848: } else {
1.620 albertel 7849: return $env{'request.'.$spacequalifierrest};
1.29 www 7850: }
1.28 www 7851: } elsif ($realm eq 'course') {
1.48 www 7852: # ---------------------------------------------------------- course.description
1.620 albertel 7853: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 7854: } elsif ($realm eq 'resource') {
1.165 www 7855:
1.620 albertel 7856: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 7857: if (!$symbparm) { $symbparm=&symbread(); }
7858: }
1.693 albertel 7859:
7860: if ($space eq 'title') {
7861: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7862: return &gettitle($symbparm);
7863: }
7864:
7865: if ($space eq 'map') {
7866: my ($map) = &decode_symb($symbparm);
7867: return &symbread($map);
7868: }
1.905 albertel 7869: if ($space eq 'filename') {
7870: if ($symbparm) {
7871: return &clutter((&decode_symb($symbparm))[2]);
7872: }
7873: return &hreflocation('',$env{'request.filename'});
7874: }
1.693 albertel 7875:
7876: my ($section, $group, @groups);
1.593 albertel 7877: my ($courselevelm,$courselevel);
1.539 albertel 7878: if ($symbparm && defined($courseid) &&
1.620 albertel 7879: $courseid eq $env{'request.course.id'}) {
1.165 www 7880:
1.218 albertel 7881: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 7882:
1.60 www 7883: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 7884: my $symbp=$symbparm;
1.735 albertel 7885: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 7886:
7887: my $symbparm=$symbp.'.'.$spacequalifierrest;
7888: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7889:
1.620 albertel 7890: if (($env{'user.name'} eq $uname) &&
7891: ($env{'user.domain'} eq $udom)) {
7892: $section=$env{'request.course.sec'};
1.733 raeburn 7893: @groups = split(/:/,$env{'request.course.groups'});
7894: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 7895: } else {
1.539 albertel 7896: if (! defined($usection)) {
1.551 albertel 7897: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 7898: } else {
7899: $section = $usection;
7900: }
1.733 raeburn 7901: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 7902: }
7903:
7904: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7905: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7906: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7907:
1.593 albertel 7908: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 7909: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 7910: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 7911:
1.60 www 7912: # ----------------------------------------------------------- first, check user
1.624 albertel 7913:
7914: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 7915: ([$courselevelr,'resource'],
7916: [$courselevelm,'map' ],
7917: [$courselevel, 'course' ]));
1.931 albertel 7918: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 7919:
1.594 albertel 7920: # ------------------------------------------------ second, check some of course
1.684 raeburn 7921: my $coursereply;
1.691 raeburn 7922: if (@groups > 0) {
7923: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7924: $mapparm,$spacequalifierrest);
1.927 albertel 7925: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 7926: }
1.96 www 7927:
1.684 raeburn 7928: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 7929: $env{'course.'.$courseid.'.domain'},
7930: 'course',
7931: ([$seclevelr, 'resource'],
7932: [$seclevelm, 'map' ],
7933: [$seclevel, 'course' ],
7934: [$courselevelr,'resource']));
7935: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 7936:
1.60 www 7937: # ------------------------------------------------------ third, check map parms
1.218 albertel 7938: my %parmhash=();
7939: my $thisparm='';
7940: if (tie(%parmhash,'GDBM_File',
1.620 albertel 7941: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 7942: &GDBM_READER(),0640)) {
1.218 albertel 7943: $thisparm=$parmhash{$symbparm};
7944: untie(%parmhash);
7945: }
1.927 albertel 7946: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 7947: }
1.594 albertel 7948: # ------------------------------------------ fourth, look in resource metadata
1.71 www 7949:
1.218 albertel 7950: $spacequalifierrest=~s/\./\_/;
1.282 albertel 7951: my $filename;
7952: if (!$symbparm) { $symbparm=&symbread(); }
7953: if ($symbparm) {
1.409 www 7954: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 7955: } else {
1.620 albertel 7956: $filename=$env{'request.filename'};
1.282 albertel 7957: }
7958: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 7959: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 7960: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 7961: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 7962:
1.927 albertel 7963: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 7964: if ($symbparm && defined($courseid) &&
1.620 albertel 7965: $courseid eq $env{'request.course.id'}) {
1.624 albertel 7966: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7967: $env{'course.'.$courseid.'.domain'},
7968: 'course',
1.927 albertel 7969: ([$courselevelm,'map' ],
7970: [$courselevel, 'course']));
7971: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 7972: }
1.145 www 7973: # ------------------------------------------------------------------ Cascade up
1.218 albertel 7974: unless ($space eq '0') {
1.336 albertel 7975: my @parts=split(/_/,$space);
7976: my $id=pop(@parts);
7977: my $part=join('_',@parts);
7978: if ($part eq '') { $part='0'; }
1.927 albertel 7979: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 7980: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 7981: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 7982: }
1.395 albertel 7983: if ($recurse) { return undef; }
7984: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 7985: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 7986: # ---------------------------------------------------- Any other user namespace
7987: } elsif ($realm eq 'environment') {
7988: # ----------------------------------------------------------------- environment
1.620 albertel 7989: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7990: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 7991: } else {
1.770 albertel 7992: if ($uname eq 'anonymous' && $udom eq '') {
7993: return '';
7994: }
1.219 albertel 7995: my %returnhash=&userenvironment($udom,$uname,
7996: $spacequalifierrest);
7997: return $returnhash{$spacequalifierrest};
7998: }
1.28 www 7999: } elsif ($realm eq 'system') {
1.48 www 8000: # ----------------------------------------------------------------- system.time
8001: if ($space eq 'time') {
8002: return time;
8003: }
1.696 albertel 8004: } elsif ($realm eq 'server') {
8005: # ----------------------------------------------------------------- system.time
8006: if ($space eq 'name') {
8007: return $ENV{'SERVER_NAME'};
8008: }
1.28 www 8009: }
1.48 www 8010: return '';
1.61 www 8011: }
8012:
1.927 albertel 8013: sub get_reply {
8014: my ($reply_value) = @_;
1.940 raeburn 8015: if (ref($reply_value) eq 'ARRAY') {
8016: if (wantarray) {
8017: return @$reply_value;
8018: }
8019: return $reply_value->[0];
8020: } else {
8021: return $reply_value;
1.927 albertel 8022: }
8023: }
8024:
1.691 raeburn 8025: sub check_group_parms {
8026: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8027: my @groupitems = ();
8028: my $resultitem;
1.927 albertel 8029: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 8030: foreach my $group (@{$groups}) {
8031: foreach my $level (@levels) {
1.927 albertel 8032: my $item = $courseid.'.['.$group.'].'.$level->[0];
8033: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 8034: }
8035: }
8036: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8037: $env{'course.'.$courseid.'.domain'},
8038: 'course',@groupitems);
8039: return $coursereply;
8040: }
8041:
8042: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 8043: my ($courseid,@groups) = @_;
8044: @groups = sort(@groups);
1.691 raeburn 8045: return @groups;
8046: }
8047:
1.395 albertel 8048: sub packages_tab_default {
8049: my ($uri,$varname)=@_;
8050: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 8051:
8052: my (@extension,@specifics,$do_default);
8053: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 8054: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 8055: if ($pack_type eq 'default') {
8056: $do_default=1;
8057: } elsif ($pack_type eq 'extension') {
8058: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 8059: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 8060: # only look at packages defaults for packages that this id is
1.738 albertel 8061: push(@specifics,[$package,$pack_type,$pack_part]);
8062: }
8063: }
8064: # first look for a package that matches the requested part id
8065: foreach my $package (@specifics) {
8066: my (undef,$pack_type,$pack_part)=@{$package};
8067: next if ($pack_part ne $part);
8068: if (defined($packagetab{"$pack_type&$name&default"})) {
8069: return $packagetab{"$pack_type&$name&default"};
8070: }
8071: }
8072: # look for any possible matching non extension_ package
8073: foreach my $package (@specifics) {
8074: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 8075: if (defined($packagetab{"$pack_type&$name&default"})) {
8076: return $packagetab{"$pack_type&$name&default"};
8077: }
1.585 albertel 8078: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 8079: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8080: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 8081: }
8082: }
1.738 albertel 8083: # look for any posible extension_ match
8084: foreach my $package (@extension) {
8085: my ($package,$pack_type)=@{$package};
8086: if (defined($packagetab{"$pack_type&$name&default"})) {
8087: return $packagetab{"$pack_type&$name&default"};
8088: }
8089: if (defined($packagetab{$package."&$name&default"})) {
8090: return $packagetab{$package."&$name&default"};
8091: }
8092: }
8093: # look for a global default setting
8094: if ($do_default && defined($packagetab{"default&$name&default"})) {
8095: return $packagetab{"default&$name&default"};
8096: }
1.395 albertel 8097: return undef;
8098: }
8099:
1.334 albertel 8100: sub add_prefix_and_part {
8101: my ($prefix,$part)=@_;
8102: my $keyroot;
8103: if (defined($prefix) && $prefix !~ /^__/) {
8104: # prefix that has a part already
8105: $keyroot=$prefix;
8106: } elsif (defined($prefix)) {
8107: # prefix that is missing a part
8108: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8109: } else {
8110: # no prefix at all
8111: if (defined($part)) { $keyroot='_'.$part; }
8112: }
8113: return $keyroot;
8114: }
8115:
1.71 www 8116: # ---------------------------------------------------------------- Get metadata
8117:
1.599 albertel 8118: my %metaentry;
1.71 www 8119: sub metadata {
1.176 www 8120: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 8121: $uri=&declutter($uri);
1.288 albertel 8122: # if it is a non metadata possible uri return quickly
1.529 albertel 8123: if (($uri eq '') ||
8124: (($uri =~ m|^/*adm/|) &&
1.698 albertel 8125: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 albertel 8126: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8127: return undef;
8128: }
8129: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8130: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 8131: return undef;
1.288 albertel 8132: }
1.73 www 8133: my $filename=$uri;
8134: $uri=~s/\.meta$//;
1.172 www 8135: #
8136: # Is the metadata already cached?
1.177 www 8137: # Look at timestamp of caching
1.172 www 8138: # Everything is cached by the main uri, libraries are never directly cached
8139: #
1.428 albertel 8140: if (!defined($liburi)) {
1.599 albertel 8141: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 8142: if (defined($cached)) { return $result->{':'.$what}; }
8143: }
8144: {
1.172 www 8145: #
8146: # Is this a recursive call for a library?
8147: #
1.599 albertel 8148: # if (! exists($metacache{$uri})) {
8149: # $metacache{$uri}={};
8150: # }
1.924 albertel 8151: my $cachetime = 60*60;
1.171 www 8152: if ($liburi) {
8153: $liburi=&declutter($liburi);
8154: $filename=$liburi;
1.401 bowersj2 8155: } else {
1.599 albertel 8156: &devalidate_cache_new('meta',$uri);
8157: undef(%metaentry);
1.401 bowersj2 8158: }
1.140 www 8159: my %metathesekeys=();
1.73 www 8160: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 8161: my $metastring;
1.924 albertel 8162: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929 albertel 8163: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 8164: $metastring =
1.929 albertel 8165: &Apache::lonnet::ssi_body($which,
1.924 albertel 8166: ('grade_target' => 'meta'));
8167: $cachetime = 1; # only want this cached in the child not long term
8168: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 8169: my $file=&filelocation('',&clutter($filename));
1.599 albertel 8170: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 8171: $metastring=&getfile($file);
1.489 albertel 8172: }
1.208 albertel 8173: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 8174: my $token;
1.140 www 8175: undef %metathesekeys;
1.71 www 8176: while ($token=$parser->get_token) {
1.339 albertel 8177: if ($token->[0] eq 'S') {
8178: if (defined($token->[2]->{'package'})) {
1.172 www 8179: #
8180: # This is a package - get package info
8181: #
1.339 albertel 8182: my $package=$token->[2]->{'package'};
8183: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8184: if (defined($token->[2]->{'id'})) {
8185: $keyroot.='_'.$token->[2]->{'id'};
8186: }
1.599 albertel 8187: if ($metaentry{':packages'}) {
8188: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 8189: } else {
1.599 albertel 8190: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 8191: }
1.736 albertel 8192: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 8193: my $part=$keyroot;
8194: $part=~s/^\_//;
1.736 albertel 8195: if ($pack_entry=~/^\Q$package\E\&/ ||
8196: $pack_entry=~/^\Q$package\E_0\&/) {
8197: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 8198: # ignore package.tab specified default values
8199: # here &package_tab_default() will fetch those
8200: if ($subp eq 'default') { next; }
1.736 albertel 8201: my $value=$packagetab{$pack_entry};
1.432 albertel 8202: my $unikey;
8203: if ($pack =~ /_0$/) {
8204: $unikey='parameter_0_'.$name;
8205: $part=0;
8206: } else {
8207: $unikey='parameter'.$keyroot.'_'.$name;
8208: }
1.339 albertel 8209: if ($subp eq 'display') {
8210: $value.=' [Part: '.$part.']';
8211: }
1.599 albertel 8212: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 8213: $metathesekeys{$unikey}=1;
1.599 albertel 8214: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8215: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 8216: }
1.599 albertel 8217: if (defined($metaentry{':'.$unikey.'.default'})) {
8218: $metaentry{':'.$unikey}=
8219: $metaentry{':'.$unikey.'.default'};
1.356 albertel 8220: }
1.339 albertel 8221: }
8222: }
8223: } else {
1.172 www 8224: #
8225: # This is not a package - some other kind of start tag
1.339 albertel 8226: #
8227: my $entry=$token->[1];
8228: my $unikey;
8229: if ($entry eq 'import') {
8230: $unikey='';
8231: } else {
8232: $unikey=$entry;
8233: }
8234: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8235:
8236: if (defined($token->[2]->{'id'})) {
8237: $unikey.='_'.$token->[2]->{'id'};
8238: }
1.175 www 8239:
1.339 albertel 8240: if ($entry eq 'import') {
1.175 www 8241: #
8242: # Importing a library here
1.339 albertel 8243: #
8244: if ($depthcount<20) {
8245: my $location=$parser->get_text('/import');
8246: my $dir=$filename;
8247: $dir=~s|[^/]*$||;
8248: $location=&filelocation($dir,$location);
1.736 albertel 8249: my $metadata =
8250: &metadata($uri,'keys', $location,$unikey,
8251: $depthcount+1);
8252: foreach my $meta (split(',',$metadata)) {
8253: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8254: $metathesekeys{$meta}=1;
1.339 albertel 8255: }
8256: }
8257: } else {
8258:
8259: if (defined($token->[2]->{'name'})) {
8260: $unikey.='_'.$token->[2]->{'name'};
8261: }
8262: $metathesekeys{$unikey}=1;
1.736 albertel 8263: foreach my $param (@{$token->[3]}) {
8264: $metaentry{':'.$unikey.'.'.$param} =
8265: $token->[2]->{$param};
1.339 albertel 8266: }
8267: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 8268: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 8269: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8270: # only ws inside the tag, and not in default, so use default
8271: # as value
1.599 albertel 8272: $metaentry{':'.$unikey}=$default;
1.908 albertel 8273: } elsif ( $internaltext =~ /\S/ ) {
8274: # something interesting inside the tag
8275: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 8276: } else {
1.908 albertel 8277: # no interesting values, don't set a default
1.339 albertel 8278: }
1.172 www 8279: # end of not-a-package not-a-library import
1.339 albertel 8280: }
1.172 www 8281: # end of not-a-package start tag
1.339 albertel 8282: }
1.172 www 8283: # the next is the end of "start tag"
1.339 albertel 8284: }
8285: }
1.483 albertel 8286: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 8287: $extension = lc($extension);
8288: if ($extension eq 'htm') { $extension='html'; }
8289:
1.737 albertel 8290: foreach my $key (keys(%packagetab)) {
1.483 albertel 8291: #no specific packages #how's our extension
8292: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 8293: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 8294: \%metathesekeys);
8295: }
1.883 albertel 8296:
8297: if (!exists($metaentry{':packages'})
8298: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 8299: foreach my $key (keys(%packagetab)) {
1.483 albertel 8300: #no specific packages well let's get default then
8301: if ($key!~/^default&/) { next; }
1.488 albertel 8302: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 8303: \%metathesekeys);
8304: }
8305: }
1.338 www 8306: # are there custom rights to evaluate
1.599 albertel 8307: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 8308:
1.338 www 8309: #
8310: # Importing a rights file here
1.339 albertel 8311: #
8312: unless ($depthcount) {
1.599 albertel 8313: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 8314: my $dir=$filename;
8315: $dir=~s|[^/]*$||;
8316: $location=&filelocation($dir,$location);
1.736 albertel 8317: my $rights_metadata =
8318: &metadata($uri,'keys',$location,'_rights',
8319: $depthcount+1);
8320: foreach my $rights (split(',',$rights_metadata)) {
8321: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8322: $metathesekeys{$rights}=1;
1.339 albertel 8323: }
8324: }
8325: }
1.737 albertel 8326: # uniqifiy package listing
8327: my %seen;
8328: my @uniq_packages =
8329: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8330: $metaentry{':packages'} = join(',',@uniq_packages);
8331:
8332: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 8333: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8334: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 8335: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 8336: # this is the end of "was not already recently cached
1.71 www 8337: }
1.599 albertel 8338: return $metaentry{':'.$what};
1.261 albertel 8339: }
8340:
1.488 albertel 8341: sub metadata_create_package_def {
1.483 albertel 8342: my ($uri,$key,$package,$metathesekeys)=@_;
8343: my ($pack,$name,$subp)=split(/\&/,$key);
8344: if ($subp eq 'default') { next; }
8345:
1.599 albertel 8346: if (defined($metaentry{':packages'})) {
8347: $metaentry{':packages'}.=','.$package;
1.483 albertel 8348: } else {
1.599 albertel 8349: $metaentry{':packages'}=$package;
1.483 albertel 8350: }
8351: my $value=$packagetab{$key};
8352: my $unikey;
8353: $unikey='parameter_0_'.$name;
1.599 albertel 8354: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 8355: $$metathesekeys{$unikey}=1;
1.599 albertel 8356: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8357: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 8358: }
1.599 albertel 8359: if (defined($metaentry{':'.$unikey.'.default'})) {
8360: $metaentry{':'.$unikey}=
8361: $metaentry{':'.$unikey.'.default'};
1.483 albertel 8362: }
8363: }
8364:
1.261 albertel 8365: sub metadata_generate_part0 {
8366: my ($metadata,$metacache,$uri) = @_;
8367: my %allnames;
1.737 albertel 8368: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 8369: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 8370: my $part=$$metacache{':'.$metakey.'.part'};
8371: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 8372: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 8373: $allnames{$name}=$part;
8374: }
8375: }
8376: }
8377: foreach my $name (keys(%allnames)) {
8378: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 8379: my $key=":parameter_0_$name";
1.261 albertel 8380: $$metacache{"$key.part"}='0';
8381: $$metacache{"$key.name"}=$name;
1.428 albertel 8382: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 8383: $allnames{$name}.'_'.$name.
8384: '.type'};
1.428 albertel 8385: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 8386: '.display'};
1.644 www 8387: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 8388: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 8389: $$metacache{"$key.display"}=$olddis;
8390: }
1.71 www 8391: }
8392:
1.764 albertel 8393: # ------------------------------------------------------ Devalidate title cache
8394:
8395: sub devalidate_title_cache {
8396: my ($url)=@_;
8397: if (!$env{'request.course.id'}) { return; }
8398: my $symb=&symbread($url);
8399: if (!$symb) { return; }
8400: my $key=$env{'request.course.id'}."\0".$symb;
8401: &devalidate_cache_new('title',$key);
8402: }
8403:
1.1014 droeschl 8404: # ------------------------------------------------- Get the title of a course
8405:
8406: sub current_course_title {
8407: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8408: }
1.301 www 8409: # ------------------------------------------------- Get the title of a resource
8410:
8411: sub gettitle {
8412: my $urlsymb=shift;
8413: my $symb=&symbread($urlsymb);
1.534 albertel 8414: if ($symb) {
1.620 albertel 8415: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 8416: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 8417: if (defined($cached)) {
8418: return $result;
8419: }
1.534 albertel 8420: my ($map,$resid,$url)=&decode_symb($symb);
8421: my $title='';
1.907 albertel 8422: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8423: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8424: } else {
8425: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8426: &GDBM_READER(),0640)) {
8427: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8428: $title=$bighash{'title_'.$mapid.'.'.$resid};
8429: untie(%bighash);
8430: }
1.534 albertel 8431: }
8432: $title=~s/\&colon\;/\:/gs;
8433: if ($title) {
1.599 albertel 8434: return &do_cache_new('title',$key,$title,600);
1.534 albertel 8435: }
8436: $urlsymb=$url;
8437: }
8438: my $title=&metadata($urlsymb,'title');
8439: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8440: return $title;
1.301 www 8441: }
1.613 albertel 8442:
1.614 albertel 8443: sub get_slot {
8444: my ($which,$cnum,$cdom)=@_;
8445: if (!$cnum || !$cdom) {
1.790 albertel 8446: (undef,my $courseid)=&whichuser();
1.620 albertel 8447: $cdom=$env{'course.'.$courseid.'.domain'};
8448: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 8449: }
1.703 albertel 8450: my $key=join("\0",'slots',$cdom,$cnum,$which);
8451: my %slotinfo;
8452: if (exists($remembered{$key})) {
8453: $slotinfo{$which} = $remembered{$key};
8454: } else {
8455: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8456: &Apache::lonhomework::showhash(%slotinfo);
8457: my ($tmp)=keys(%slotinfo);
8458: if ($tmp=~/^error:/) { return (); }
8459: $remembered{$key} = $slotinfo{$which};
8460: }
1.616 albertel 8461: if (ref($slotinfo{$which}) eq 'HASH') {
8462: return %{$slotinfo{$which}};
8463: }
8464: return $slotinfo{$which};
1.614 albertel 8465: }
1.31 www 8466: # ------------------------------------------------- Update symbolic store links
8467:
8468: sub symblist {
8469: my ($mapname,%newhash)=@_;
1.438 www 8470: $mapname=&deversion(&declutter($mapname));
1.31 www 8471: my %hash;
1.620 albertel 8472: if (($env{'request.course.fn'}) && (%newhash)) {
8473: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8474: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 8475: foreach my $url (keys(%newhash)) {
1.711 albertel 8476: next if ($url eq 'last_known'
8477: && $env{'form.no_update_last_known'});
8478: $hash{declutter($url)}=&encode_symb($mapname,
8479: $newhash{$url}->[1],
8480: $newhash{$url}->[0]);
1.191 harris41 8481: }
1.31 www 8482: if (untie(%hash)) {
8483: return 'ok';
8484: }
8485: }
8486: }
8487: return 'error';
1.212 www 8488: }
8489:
8490: # --------------------------------------------------------------- Verify a symb
8491:
8492: sub symbverify {
1.510 www 8493: my ($symb,$thisurl)=@_;
8494: my $thisfn=$thisurl;
1.439 www 8495: $thisfn=&declutter($thisfn);
1.215 www 8496: # direct jump to resource in page or to a sequence - will construct own symbs
8497: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8498: # check URL part
1.409 www 8499: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 8500:
1.431 www 8501: unless ($url eq $thisfn) { return 0; }
1.213 www 8502:
1.216 www 8503: $symb=&symbclean($symb);
1.510 www 8504: $thisurl=&deversion($thisurl);
1.439 www 8505: $thisfn=&deversion($thisfn);
1.213 www 8506:
8507: my %bighash;
8508: my $okay=0;
1.431 www 8509:
1.620 albertel 8510: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8511: &GDBM_READER(),0640)) {
1.1032 raeburn 8512: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8513: $thisurl =~ s/\?.+$//;
8514: }
1.510 www 8515: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 8516: unless ($ids) {
1.510 www 8517: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 8518: }
8519: if ($ids) {
8520: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 8521: foreach my $id (split(/\,/,$ids)) {
8522: my ($mapid,$resid)=split(/\./,$id);
1.1032 raeburn 8523: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8524: $symb =~ s/\?.+$//;
8525: }
1.216 www 8526: if (
8527: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8528: eq $symb) {
1.620 albertel 8529: if (($env{'request.role.adv'}) ||
1.800 albertel 8530: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 8531: $okay=1;
8532: }
8533: }
1.216 www 8534: }
8535: }
1.213 www 8536: untie(%bighash);
8537: }
8538: return $okay;
1.31 www 8539: }
8540:
1.210 www 8541: # --------------------------------------------------------------- Clean-up symb
8542:
8543: sub symbclean {
8544: my $symb=shift;
1.568 albertel 8545: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 8546: # remove version from map
8547: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 8548:
1.210 www 8549: # remove version from URL
8550: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 8551:
1.507 www 8552: # remove wrapper
8553:
1.510 www 8554: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 8555: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 8556: return $symb;
1.409 www 8557: }
8558:
8559: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 8560:
8561: sub encode_symb {
8562: my ($map,$resid,$url)=@_;
8563: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8564: }
1.409 www 8565:
8566: sub decode_symb {
1.568 albertel 8567: my $symb=shift;
8568: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8569: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 8570: return (&fixversion($map),$resid,&fixversion($url));
8571: }
8572:
8573: sub fixversion {
8574: my $fn=shift;
1.609 banghart 8575: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 8576: my %bighash;
8577: my $uri=&clutter($fn);
1.620 albertel 8578: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 8579: # is this cached?
1.599 albertel 8580: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 8581: if (defined($cached)) { return $result; }
8582: # unfortunately not cached, or expired
1.620 albertel 8583: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 8584: &GDBM_READER(),0640)) {
8585: if ($bighash{'version_'.$uri}) {
8586: my $version=$bighash{'version_'.$uri};
1.444 www 8587: unless (($version eq 'mostrecent') ||
8588: ($version==&getversion($uri))) {
1.440 www 8589: $uri=~s/\.(\w+)$/\.$version\.$1/;
8590: }
8591: }
8592: untie %bighash;
1.413 www 8593: }
1.599 albertel 8594: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 8595: }
8596:
8597: sub deversion {
8598: my $url=shift;
8599: $url=~s/\.\d+\.(\w+)$/\.$1/;
8600: return $url;
1.210 www 8601: }
8602:
1.31 www 8603: # ------------------------------------------------------ Return symb list entry
8604:
8605: sub symbread {
1.249 www 8606: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 8607: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 8608: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 8609: # no filename provided? try from environment
1.44 www 8610: unless ($thisfn) {
1.620 albertel 8611: if ($env{'request.symb'}) {
8612: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 8613: }
1.620 albertel 8614: $thisfn=$env{'request.filename'};
1.44 www 8615: }
1.569 albertel 8616: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 8617: # is that filename actually a symb? Verify, clean, and return
8618: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 8619: if (&symbverify($thisfn,$1)) {
1.620 albertel 8620: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 8621: }
1.242 www 8622: }
1.44 www 8623: $thisfn=declutter($thisfn);
1.31 www 8624: my %hash;
1.37 www 8625: my %bighash;
8626: my $syval='';
1.620 albertel 8627: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 8628: my $targetfn = $thisfn;
1.609 banghart 8629: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 8630: $targetfn = 'adm/wrapper/'.$thisfn;
8631: }
1.687 albertel 8632: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8633: $targetfn=$1;
8634: }
1.620 albertel 8635: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8636: &GDBM_READER(),0640)) {
1.481 raeburn 8637: $syval=$hash{$targetfn};
1.37 www 8638: untie(%hash);
8639: }
8640: # ---------------------------------------------------------- There was an entry
8641: if ($syval) {
1.601 albertel 8642: #unless ($syval=~/\_\d+$/) {
1.620 albertel 8643: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 8644: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8645: #return $env{$cache_str}='';
1.601 albertel 8646: #}
8647: #$syval.=$1;
8648: #}
1.37 www 8649: } else {
8650: # ------------------------------------------------------- Was not in symb table
1.620 albertel 8651: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8652: &GDBM_READER(),0640)) {
1.37 www 8653: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 8654: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 8655: unless ($ids) {
8656: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 8657: }
8658: unless ($ids) {
8659: # alias?
8660: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 8661: }
1.37 www 8662: if ($ids) {
8663: # ------------------------------------------------------------------- Has ID(s)
8664: my @possibilities=split(/\,/,$ids);
1.39 www 8665: if ($#possibilities==0) {
8666: # ----------------------------------------------- There is only one possibility
1.37 www 8667: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 8668: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8669: $resid,$thisfn);
1.249 www 8670: } elsif (!$donotrecurse) {
1.39 www 8671: # ------------------------------------------ There is more than one possibility
8672: my $realpossible=0;
1.800 albertel 8673: foreach my $id (@possibilities) {
8674: my $file=$bighash{'src_'.$id};
1.39 www 8675: if (&allowed('bre',$file)) {
1.800 albertel 8676: my ($mapid,$resid)=split(/\./,$id);
1.39 www 8677: if ($bighash{'map_type_'.$mapid} ne 'page') {
8678: $realpossible++;
1.626 albertel 8679: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8680: $resid,$thisfn);
1.39 www 8681: }
8682: }
1.191 harris41 8683: }
1.39 www 8684: if ($realpossible!=1) { $syval=''; }
1.249 www 8685: } else {
8686: $syval='';
1.37 www 8687: }
8688: }
8689: untie(%bighash)
1.481 raeburn 8690: }
1.31 www 8691: }
1.62 www 8692: if ($syval) {
1.620 albertel 8693: return $env{$cache_str}=$syval;
1.62 www 8694: }
1.31 www 8695: }
1.949 raeburn 8696: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8697: return $env{$cache_str}='';
1.31 www 8698: }
8699:
8700: # ---------------------------------------------------------- Return random seed
8701:
1.32 www 8702: sub numval {
8703: my $txt=shift;
8704: $txt=~tr/A-J/0-9/;
8705: $txt=~tr/a-j/0-9/;
8706: $txt=~tr/K-T/0-9/;
8707: $txt=~tr/k-t/0-9/;
8708: $txt=~tr/U-Z/0-5/;
8709: $txt=~tr/u-z/0-5/;
8710: $txt=~s/\D//g;
1.564 albertel 8711: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 8712: return int($txt);
1.368 albertel 8713: }
8714:
1.484 albertel 8715: sub numval2 {
8716: my $txt=shift;
8717: $txt=~tr/A-J/0-9/;
8718: $txt=~tr/a-j/0-9/;
8719: $txt=~tr/K-T/0-9/;
8720: $txt=~tr/k-t/0-9/;
8721: $txt=~tr/U-Z/0-5/;
8722: $txt=~tr/u-z/0-5/;
8723: $txt=~s/\D//g;
8724: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8725: my $total;
8726: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 8727: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 8728: return int($total);
8729: }
8730:
1.575 albertel 8731: sub numval3 {
8732: use integer;
8733: my $txt=shift;
8734: $txt=~tr/A-J/0-9/;
8735: $txt=~tr/a-j/0-9/;
8736: $txt=~tr/K-T/0-9/;
8737: $txt=~tr/k-t/0-9/;
8738: $txt=~tr/U-Z/0-5/;
8739: $txt=~tr/u-z/0-5/;
8740: $txt=~s/\D//g;
8741: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8742: my $total;
8743: foreach my $val (@txts) { $total+=$val; }
8744: if ($_64bit) { $total=(($total<<32)>>32); }
8745: return $total;
8746: }
8747:
1.675 albertel 8748: sub digest {
8749: my ($data)=@_;
8750: my $digest=&Digest::MD5::md5($data);
8751: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8752: my ($e,$f);
8753: {
8754: use integer;
8755: $e=($a+$b);
8756: $f=($c+$d);
8757: if ($_64bit) {
8758: $e=(($e<<32)>>32);
8759: $f=(($f<<32)>>32);
8760: }
8761: }
8762: if (wantarray) {
8763: return ($e,$f);
8764: } else {
8765: my $g;
8766: {
8767: use integer;
8768: $g=($e+$f);
8769: if ($_64bit) {
8770: $g=(($g<<32)>>32);
8771: }
8772: }
8773: return $g;
8774: }
8775: }
8776:
1.368 albertel 8777: sub latest_rnd_algorithm_id {
1.675 albertel 8778: return '64bit5';
1.366 albertel 8779: }
1.32 www 8780:
1.503 albertel 8781: sub get_rand_alg {
8782: my ($courseid)=@_;
1.790 albertel 8783: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 8784: if ($courseid) {
1.620 albertel 8785: return $env{"course.$courseid.rndseed"};
1.503 albertel 8786: }
8787: return &latest_rnd_algorithm_id();
8788: }
8789:
1.562 albertel 8790: sub validCODE {
8791: my ($CODE)=@_;
8792: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8793: return 0;
8794: }
8795:
1.491 albertel 8796: sub getCODE {
1.620 albertel 8797: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 8798: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8799: defined($Apache::lonhomework::parsing_a_task) ) &&
8800: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 8801: return $Apache::lonhomework::history{'resource.CODE'};
8802: }
8803: return undef;
8804: }
8805:
1.31 www 8806: sub rndseed {
1.155 albertel 8807: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 8808: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 8809: if (!defined($symb)) {
1.366 albertel 8810: unless ($symb=$wsymb) { return time; }
8811: }
8812: if (!$courseid) { $courseid=$wcourseid; }
8813: if (!$domain) { $domain=$wdomain; }
8814: if (!$username) { $username=$wusername }
1.503 albertel 8815: my $which=&get_rand_alg();
1.803 albertel 8816:
1.491 albertel 8817: if (defined(&getCODE())) {
1.675 albertel 8818: if ($which eq '64bit5') {
8819: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8820: } elsif ($which eq '64bit4') {
1.575 albertel 8821: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8822: } else {
8823: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8824: }
1.675 albertel 8825: } elsif ($which eq '64bit5') {
8826: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 8827: } elsif ($which eq '64bit4') {
8828: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 8829: } elsif ($which eq '64bit3') {
8830: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 8831: } elsif ($which eq '64bit2') {
8832: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 8833: } elsif ($which eq '64bit') {
8834: return &rndseed_64bit($symb,$courseid,$domain,$username);
8835: }
8836: return &rndseed_32bit($symb,$courseid,$domain,$username);
8837: }
8838:
8839: sub rndseed_32bit {
8840: my ($symb,$courseid,$domain,$username)=@_;
8841: {
8842: use integer;
8843: my $symbchck=unpack("%32C*",$symb) << 27;
8844: my $symbseed=numval($symb) << 22;
8845: my $namechck=unpack("%32C*",$username) << 17;
8846: my $nameseed=numval($username) << 12;
8847: my $domainseed=unpack("%32C*",$domain) << 7;
8848: my $courseseed=unpack("%32C*",$courseid);
8849: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 8850: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8851: #&logthis("rndseed :$num:$symb");
1.564 albertel 8852: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 8853: return $num;
8854: }
8855: }
8856:
8857: sub rndseed_64bit {
8858: my ($symb,$courseid,$domain,$username)=@_;
8859: {
8860: use integer;
8861: my $symbchck=unpack("%32S*",$symb) << 21;
8862: my $symbseed=numval($symb) << 10;
8863: my $namechck=unpack("%32S*",$username);
8864:
8865: my $nameseed=numval($username) << 21;
8866: my $domainseed=unpack("%32S*",$domain) << 10;
8867: my $courseseed=unpack("%32S*",$courseid);
8868:
8869: my $num1=$symbchck+$symbseed+$namechck;
8870: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8871: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8872: #&logthis("rndseed :$num:$symb");
1.564 albertel 8873: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 8874: return "$num1,$num2";
1.155 albertel 8875: }
1.366 albertel 8876: }
8877:
1.443 albertel 8878: sub rndseed_64bit2 {
8879: my ($symb,$courseid,$domain,$username)=@_;
8880: {
8881: use integer;
8882: # strings need to be an even # of cahracters long, it it is odd the
8883: # last characters gets thrown away
8884: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8885: my $symbseed=numval($symb) << 10;
8886: my $namechck=unpack("%32S*",$username.' ');
8887:
8888: my $nameseed=numval($username) << 21;
1.501 albertel 8889: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8890: my $courseseed=unpack("%32S*",$courseid.' ');
8891:
8892: my $num1=$symbchck+$symbseed+$namechck;
8893: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8894: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8895: #&logthis("rndseed :$num:$symb");
1.803 albertel 8896: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 8897: return "$num1,$num2";
8898: }
8899: }
8900:
8901: sub rndseed_64bit3 {
8902: my ($symb,$courseid,$domain,$username)=@_;
8903: {
8904: use integer;
8905: # strings need to be an even # of cahracters long, it it is odd the
8906: # last characters gets thrown away
8907: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8908: my $symbseed=numval2($symb) << 10;
8909: my $namechck=unpack("%32S*",$username.' ');
8910:
8911: my $nameseed=numval2($username) << 21;
1.443 albertel 8912: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8913: my $courseseed=unpack("%32S*",$courseid.' ');
8914:
8915: my $num1=$symbchck+$symbseed+$namechck;
8916: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8917: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8918: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 8919: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8920:
1.503 albertel 8921: return "$num1:$num2";
1.443 albertel 8922: }
8923: }
8924:
1.575 albertel 8925: sub rndseed_64bit4 {
8926: my ($symb,$courseid,$domain,$username)=@_;
8927: {
8928: use integer;
8929: # strings need to be an even # of cahracters long, it it is odd the
8930: # last characters gets thrown away
8931: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8932: my $symbseed=numval3($symb) << 10;
8933: my $namechck=unpack("%32S*",$username.' ');
8934:
8935: my $nameseed=numval3($username) << 21;
8936: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8937: my $courseseed=unpack("%32S*",$courseid.' ');
8938:
8939: my $num1=$symbchck+$symbseed+$namechck;
8940: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8941: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8942: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 8943: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8944:
8945: return "$num1:$num2";
8946: }
8947: }
8948:
1.675 albertel 8949: sub rndseed_64bit5 {
8950: my ($symb,$courseid,$domain,$username)=@_;
8951: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8952: return "$num1:$num2";
8953: }
8954:
1.366 albertel 8955: sub rndseed_CODE_64bit {
8956: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 8957: {
1.366 albertel 8958: use integer;
1.443 albertel 8959: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 8960: my $symbseed=numval2($symb);
1.491 albertel 8961: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8962: my $CODEseed=numval(&getCODE());
1.443 albertel 8963: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 8964: my $num1=$symbseed+$CODEchck;
8965: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8966: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8967: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 8968: if ($_64bit) { $num1=(($num1<<32)>>32); }
8969: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 8970: return "$num1:$num2";
1.366 albertel 8971: }
8972: }
8973:
1.575 albertel 8974: sub rndseed_CODE_64bit4 {
8975: my ($symb,$courseid,$domain,$username)=@_;
8976: {
8977: use integer;
8978: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8979: my $symbseed=numval3($symb);
8980: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8981: my $CODEseed=numval3(&getCODE());
8982: my $courseseed=unpack("%32S*",$courseid.' ');
8983: my $num1=$symbseed+$CODEchck;
8984: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8985: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8986: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 8987: if ($_64bit) { $num1=(($num1<<32)>>32); }
8988: if ($_64bit) { $num2=(($num2<<32)>>32); }
8989: return "$num1:$num2";
8990: }
8991: }
8992:
1.675 albertel 8993: sub rndseed_CODE_64bit5 {
8994: my ($symb,$courseid,$domain,$username)=@_;
8995: my $code = &getCODE();
8996: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8997: return "$num1:$num2";
8998: }
8999:
1.366 albertel 9000: sub setup_random_from_rndseed {
9001: my ($rndseed)=@_;
1.503 albertel 9002: if ($rndseed =~/([,:])/) {
9003: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 9004: &Math::Random::random_set_seed(abs($num1),abs($num2));
9005: } else {
9006: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 9007: }
1.36 albertel 9008: }
9009:
1.474 albertel 9010: sub latest_receipt_algorithm_id {
1.835 albertel 9011: return 'receipt3';
1.474 albertel 9012: }
9013:
1.480 www 9014: sub recunique {
9015: my $fucourseid=shift;
9016: my $unique;
1.835 albertel 9017: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9018: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9019: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 9020: } else {
9021: $unique=$perlvar{'lonReceipt'};
9022: }
9023: return unpack("%32C*",$unique);
9024: }
9025:
9026: sub recprefix {
9027: my $fucourseid=shift;
9028: my $prefix;
1.835 albertel 9029: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9030: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9031: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 9032: } else {
9033: $prefix=$perlvar{'lonHostID'};
9034: }
9035: return unpack("%32C*",$prefix);
9036: }
9037:
1.76 www 9038: sub ireceipt {
1.474 albertel 9039: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 9040:
9041: my $return =&recprefix($fucourseid).'-';
9042:
9043: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9044: $env{'request.state'} eq 'construct') {
9045: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9046: return $return;
9047: }
9048:
1.76 www 9049: my $cuname=unpack("%32C*",$funame);
9050: my $cudom=unpack("%32C*",$fudom);
9051: my $cucourseid=unpack("%32C*",$fucourseid);
9052: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 9053: my $cunique=&recunique($fucourseid);
1.474 albertel 9054: my $cpart=unpack("%32S*",$part);
1.835 albertel 9055: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9056:
1.790 albertel 9057: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 9058:
9059: $return.= ($cunique%$cuname+
9060: $cunique%$cudom+
9061: $cusymb%$cuname+
9062: $cusymb%$cudom+
9063: $cucourseid%$cuname+
9064: $cucourseid%$cudom+
9065: $cpart%$cuname+
9066: $cpart%$cudom);
9067: } else {
9068: $return.= ($cunique%$cuname+
9069: $cunique%$cudom+
9070: $cusymb%$cuname+
9071: $cusymb%$cudom+
9072: $cucourseid%$cuname+
9073: $cucourseid%$cudom);
9074: }
9075: return $return;
1.76 www 9076: }
9077:
9078: sub receipt {
1.474 albertel 9079: my ($part)=@_;
1.790 albertel 9080: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 9081: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 9082: }
1.260 ng 9083:
1.790 albertel 9084: sub whichuser {
9085: my ($passedsymb)=@_;
9086: my ($symb,$courseid,$domain,$name,$publicuser);
9087: if (defined($env{'form.grade_symb'})) {
9088: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9089: my $allowed=&allowed('vgr',$tmp_courseid);
9090: if (!$allowed &&
9091: exists($env{'request.course.sec'}) &&
9092: $env{'request.course.sec'} !~ /^\s*$/) {
9093: $allowed=&allowed('vgr',$tmp_courseid.
9094: '/'.$env{'request.course.sec'});
9095: }
9096: if ($allowed) {
9097: ($symb)=&get_env_multiple('form.grade_symb');
9098: $courseid=$tmp_courseid;
9099: ($domain)=&get_env_multiple('form.grade_domain');
9100: ($name)=&get_env_multiple('form.grade_username');
9101: return ($symb,$courseid,$domain,$name,$publicuser);
9102: }
9103: }
9104: if (!$passedsymb) {
9105: $symb=&symbread();
9106: } else {
9107: $symb=$passedsymb;
9108: }
9109: $courseid=$env{'request.course.id'};
9110: $domain=$env{'user.domain'};
9111: $name=$env{'user.name'};
9112: if ($name eq 'public' && $domain eq 'public') {
9113: if (!defined($env{'form.username'})) {
9114: $env{'form.username'}.=time.rand(10000000);
9115: }
9116: $name.=$env{'form.username'};
9117: }
9118: return ($symb,$courseid,$domain,$name,$publicuser);
9119:
9120: }
9121:
1.36 albertel 9122: # ------------------------------------------------------------ Serves up a file
1.472 albertel 9123: # returns either the contents of the file or
9124: # -1 if the file doesn't exist
1.481 raeburn 9125: #
9126: # if the target is a file that was uploaded via DOCS,
9127: # a check will be made to see if a current copy exists on the local server,
9128: # if it does this will be served, otherwise a copy will be retrieved from
9129: # the home server for the course and stored in /home/httpd/html/userfiles on
9130: # the local server.
1.472 albertel 9131:
1.36 albertel 9132: sub getfile {
1.538 albertel 9133: my ($file) = @_;
1.609 banghart 9134: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 9135: &repcopy($file);
9136: return &readfile($file);
9137: }
9138:
9139: sub repcopy_userfile {
9140: my ($file)=@_;
1.609 banghart 9141: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 9142: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 9143: my ($cdom,$cnum,$filename) =
1.811 albertel 9144: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 9145: my $uri="/uploaded/$cdom/$cnum/$filename";
9146: if (-e "$file") {
1.828 www 9147: # we already have a local copy, check it out
1.538 albertel 9148: my @fileinfo = stat($file);
1.828 www 9149: my $rtncode;
9150: my $info;
1.538 albertel 9151: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 9152: if ($lwpresp ne 'ok') {
1.828 www 9153: # there is no such file anymore, even though we had a local copy
1.482 albertel 9154: if ($rtncode eq '404') {
1.538 albertel 9155: unlink($file);
1.482 albertel 9156: }
9157: return -1;
9158: }
9159: if ($info < $fileinfo[9]) {
1.828 www 9160: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 9161: return 'ok';
1.828 www 9162: } else {
9163: # the file is outdated, get rid of it
9164: unlink($file);
1.482 albertel 9165: }
1.828 www 9166: }
9167: # one way or the other, at this point, we don't have the file
9168: # construct the correct path for the file
9169: my @parts = ($cdom,$cnum);
9170: if ($filename =~ m|^(.+)/[^/]+$|) {
9171: push @parts, split(/\//,$1);
9172: }
9173: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9174: foreach my $part (@parts) {
9175: $path .= '/'.$part;
9176: if (!-e $path) {
9177: mkdir($path,0770);
1.482 albertel 9178: }
9179: }
1.828 www 9180: # now the path exists for sure
9181: # get a user agent
9182: my $ua=new LWP::UserAgent;
9183: my $transferfile=$file.'.in.transfer';
9184: # FIXME: this should flock
9185: if (-e $transferfile) { return 'ok'; }
9186: my $request;
9187: $uri=~s/^\///;
1.980 raeburn 9188: my $homeserver = &homeserver($cnum,$cdom);
9189: my $protocol = $protocol{$homeserver};
9190: $protocol = 'http' if ($protocol ne 'https');
9191: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 9192: my $response=$ua->request($request,$transferfile);
9193: # did it work?
9194: if ($response->is_error()) {
9195: unlink($transferfile);
9196: &logthis("Userfile repcopy failed for $uri");
9197: return -1;
9198: }
9199: # worked, rename the transfer file
9200: rename($transferfile,$file);
1.607 raeburn 9201: return 'ok';
1.481 raeburn 9202: }
9203:
1.517 albertel 9204: sub tokenwrapper {
9205: my $uri=shift;
1.980 raeburn 9206: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 9207: $uri=~s|^/||;
1.620 albertel 9208: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 9209: my $token=$1;
1.552 albertel 9210: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9211: if ($udom && $uname && $file) {
9212: $file=~s|(\?\.*)*$||;
1.949 raeburn 9213: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 9214: my $homeserver = &homeserver($uname,$udom);
9215: my $protocol = $protocol{$homeserver};
9216: $protocol = 'http' if ($protocol ne 'https');
9217: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 9218: (($uri=~/\?/)?'&':'?').'token='.$token.
9219: '&tokenissued='.$perlvar{'lonHostID'};
9220: } else {
9221: return '/adm/notfound.html';
9222: }
9223: }
9224:
1.828 www 9225: # call with reqtype HEAD: get last modification time
9226: # call with reqtype GET: get the file contents
9227: # Do not call this with reqtype GET for large files! It loads everything into memory
9228: #
1.481 raeburn 9229: sub getuploaded {
9230: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9231: $uri=~s/^\///;
1.980 raeburn 9232: my $homeserver = &homeserver($cnum,$cdom);
9233: my $protocol = $protocol{$homeserver};
9234: $protocol = 'http' if ($protocol ne 'https');
9235: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 9236: my $ua=new LWP::UserAgent;
9237: my $request=new HTTP::Request($reqtype,$uri);
9238: my $response=$ua->request($request);
9239: $$rtncode = $response->code;
1.482 albertel 9240: if (! $response->is_success()) {
9241: return 'failed';
9242: }
9243: if ($reqtype eq 'HEAD') {
1.486 www 9244: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 9245: } elsif ($reqtype eq 'GET') {
9246: $$info = $response->content;
1.472 albertel 9247: }
1.482 albertel 9248: return 'ok';
1.36 albertel 9249: }
9250:
1.481 raeburn 9251: sub readfile {
9252: my $file = shift;
9253: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9254: my $fh;
9255: open($fh,"<$file");
9256: my $a='';
1.800 albertel 9257: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 9258: return $a;
9259: }
9260:
1.36 albertel 9261: sub filelocation {
1.590 banghart 9262: my ($dir,$file) = @_;
9263: my $location;
9264: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 9265:
9266: if ($file =~ m-^/adm/-) {
9267: $file=~s-^/adm/wrapper/-/-;
9268: $file=~s-^/adm/coursedocs/showdoc/-/-;
9269: }
1.882 albertel 9270:
1.590 banghart 9271: if ($file=~m:^/~:) { # is a contruction space reference
9272: $location = $file;
9273: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 9274: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 9275: # is a correct contruction space reference
9276: $location = $file;
1.956 raeburn 9277: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9278: $location = $file;
1.609 banghart 9279: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 9280: my ($udom,$uname,$filename)=
1.811 albertel 9281: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 9282: my $home=&homeserver($uname,$udom);
9283: my $is_me=0;
9284: my @ids=¤t_machine_ids();
9285: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9286: if ($is_me) {
1.955 raeburn 9287: $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 9288: } else {
9289: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9290: $udom.'/'.$uname.'/'.$filename;
9291: }
1.882 albertel 9292: } elsif ($file =~ m-^/adm/-) {
9293: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 9294: } else {
9295: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9296: $file=~s:^/res/:/:;
9297: if ( !( $file =~ m:^/:) ) {
9298: $location = $dir. '/'.$file;
9299: } else {
9300: $location = '/home/httpd/html/res'.$file;
9301: }
1.59 albertel 9302: }
1.590 banghart 9303: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 9304: while ($location=~m{/\.\./}) {
9305: if ($location =~ m{/[^/]+/\.\./}) {
9306: $location=~ s{/[^/]+/\.\./}{/}g;
9307: } else {
9308: $location=~ s{/\.\./}{/}g;
9309: }
9310: } #remove dir/..
1.590 banghart 9311: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9312: return $location;
1.46 www 9313: }
1.36 albertel 9314:
1.46 www 9315: sub hreflocation {
9316: my ($dir,$file)=@_;
1.980 raeburn 9317: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 9318: $file=filelocation($dir,$file);
1.700 albertel 9319: } elsif ($file=~m-^/adm/-) {
9320: $file=~s-^/adm/wrapper/-/-;
9321: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 9322: }
9323: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9324: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 9325: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9326: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 9327: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 9328: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 9329: -/uploaded/$1/$2/-x;
1.46 www 9330: }
1.913 albertel 9331: if ($file=~ m{^/userfiles/}) {
9332: $file =~ s{^/userfiles/}{/uploaded/};
9333: }
1.462 albertel 9334: return $file;
1.465 albertel 9335: }
9336:
9337: sub current_machine_domains {
1.853 albertel 9338: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9339: }
9340:
9341: sub machine_domains {
9342: my ($hostname) = @_;
1.465 albertel 9343: my @domains;
1.838 albertel 9344: my %hostname = &all_hostnames();
1.465 albertel 9345: while( my($id, $name) = each(%hostname)) {
1.467 matthew 9346: # &logthis("-$id-$name-$hostname-");
1.465 albertel 9347: if ($hostname eq $name) {
1.844 albertel 9348: push(@domains,&host_domain($id));
1.465 albertel 9349: }
9350: }
9351: return @domains;
9352: }
9353:
9354: sub current_machine_ids {
1.853 albertel 9355: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9356: }
9357:
9358: sub machine_ids {
9359: my ($hostname) = @_;
9360: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 9361: my @ids;
1.888 albertel 9362: my %name_to_host = &all_names();
1.889 albertel 9363: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9364: return @{ $name_to_host{$hostname} };
9365: }
9366: return;
1.31 www 9367: }
9368:
1.824 raeburn 9369: sub additional_machine_domains {
9370: my @domains;
9371: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9372: while( my $line = <$fh>) {
9373: $line =~ s/\s//g;
9374: push(@domains,$line);
9375: }
9376: return @domains;
9377: }
9378:
9379: sub default_login_domain {
9380: my $domain = $perlvar{'lonDefDomain'};
9381: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9382: foreach my $posdom (¤t_machine_domains(),
9383: &additional_machine_domains()) {
9384: if (lc($posdom) eq lc($testdomain)) {
9385: $domain=$posdom;
9386: last;
9387: }
9388: }
9389: return $domain;
9390: }
9391:
1.31 www 9392: # ------------------------------------------------------------- Declutters URLs
9393:
9394: sub declutter {
9395: my $thisfn=shift;
1.569 albertel 9396: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 9397: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 9398: $thisfn=~s/^\///;
1.697 albertel 9399: $thisfn=~s|^adm/wrapper/||;
9400: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 9401: $thisfn=~s/^res\///;
1.1032 raeburn 9402: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9403: $thisfn=~s/\?.+$//;
9404: }
1.268 www 9405: return $thisfn;
9406: }
9407:
9408: # ------------------------------------------------------------- Clutter up URLs
9409:
9410: sub clutter {
9411: my $thisfn='/'.&declutter(shift);
1.887 albertel 9412: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 9413: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 9414: $thisfn='/res'.$thisfn;
9415: }
1.1031 raeburn 9416: if ($thisfn !~m|^/adm|) {
9417: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 9418: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 9419: } else {
9420: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9421: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 9422: if ($embstyle eq 'ssi'
9423: || ($embstyle eq 'hdn')
9424: || ($embstyle eq 'rat')
9425: || ($embstyle eq 'prv')
9426: || ($embstyle eq 'ign')) {
9427: #do nothing with these
9428: } elsif (($embstyle eq 'img')
1.695 albertel 9429: || ($embstyle eq 'emb')
9430: || ($embstyle eq 'wrp')) {
9431: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 9432: } elsif ($embstyle eq 'unk'
9433: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 9434: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 9435: } else {
1.718 www 9436: # &logthis("Got a blank emb style");
1.695 albertel 9437: }
1.694 albertel 9438: }
9439: }
1.31 www 9440: return $thisfn;
1.12 www 9441: }
9442:
1.787 albertel 9443: sub clutter_with_no_wrapper {
9444: my $uri = &clutter(shift);
9445: if ($uri =~ m-^/adm/-) {
9446: $uri =~ s-^/adm/wrapper/-/-;
9447: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9448: }
9449: return $uri;
9450: }
9451:
1.557 albertel 9452: sub freeze_escape {
9453: my ($value)=@_;
9454: if (ref($value)) {
9455: $value=&nfreeze($value);
9456: return '__FROZEN__'.&escape($value);
9457: }
9458: return &escape($value);
9459: }
9460:
1.11 www 9461:
1.557 albertel 9462: sub thaw_unescape {
9463: my ($value)=@_;
9464: if ($value =~ /^__FROZEN__/) {
9465: substr($value,0,10,undef);
9466: $value=&unescape($value);
9467: return &thaw($value);
9468: }
9469: return &unescape($value);
9470: }
9471:
1.436 albertel 9472: sub correct_line_ends {
9473: my ($result)=@_;
9474: $$result =~s/\r\n/\n/mg;
9475: $$result =~s/\r/\n/mg;
1.415 albertel 9476: }
1.1 albertel 9477: # ================================================================ Main Program
9478:
1.184 www 9479: sub goodbye {
1.204 albertel 9480: &logthis("Starting Shut down");
1.443 albertel 9481: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 9482: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 9483: #converted
1.599 albertel 9484: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 9485: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9486: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9487: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 9488: #1.1 only
1.870 albertel 9489: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9490: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9491: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9492: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9493: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 9494: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9495: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 9496: &flushcourselogs();
9497: &logthis("Shutting down");
9498: }
9499:
1.852 albertel 9500: sub get_dns {
1.869 albertel 9501: my ($url,$func,$ignore_cache) = @_;
9502: if (!$ignore_cache) {
9503: my ($content,$cached)=
9504: &Apache::lonnet::is_cached_new('dns',$url);
9505: if ($cached) {
9506: &$func($content);
9507: return;
9508: }
9509: }
9510:
9511: my %alldns;
1.852 albertel 9512: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9513: foreach my $dns (<$config>) {
9514: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 9515: my $line = $1;
9516: my ($host,$protocol) = split(/:/,$line);
9517: if ($protocol ne 'https') {
9518: $protocol = 'http';
9519: }
9520: $alldns{$host} = $protocol;
1.869 albertel 9521: }
9522: while (%alldns) {
9523: my ($dns) = keys(%alldns);
1.852 albertel 9524: my $ua=new LWP::UserAgent;
1.979 raeburn 9525: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 9526: my $response=$ua->request($request);
1.979 raeburn 9527: delete($alldns{$dns});
1.852 albertel 9528: next if ($response->is_error());
9529: my @content = split("\n",$response->content);
1.869 albertel 9530: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 9531: &$func(\@content);
1.869 albertel 9532: return;
1.852 albertel 9533: }
9534: close($config);
1.871 albertel 9535: my $which = (split('/',$url))[3];
9536: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9537: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 9538: my @content = <$config>;
9539: &$func(\@content);
9540: return;
1.852 albertel 9541: }
1.327 albertel 9542: # ------------------------------------------------------------ Read domain file
9543: {
1.852 albertel 9544: my $loaded;
1.846 albertel 9545: my %domain;
9546:
1.852 albertel 9547: sub parse_domain_tab {
9548: my ($lines) = @_;
9549: foreach my $line (@$lines) {
9550: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 9551:
1.846 albertel 9552: chomp($line);
1.852 albertel 9553: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 9554: my %this_domain;
9555: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9556: 'lang_def', 'city', 'longi', 'lati',
9557: 'primary') {
9558: $this_domain{$field} = shift(@elements);
9559: }
9560: $domain{$name} = \%this_domain;
1.852 albertel 9561: }
9562: }
1.864 albertel 9563:
9564: sub reset_domain_info {
9565: undef($loaded);
9566: undef(%domain);
9567: }
9568:
1.852 albertel 9569: sub load_domain_tab {
1.869 albertel 9570: my ($ignore_cache) = @_;
9571: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 9572: my $fh;
9573: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9574: my @lines = <$fh>;
9575: &parse_domain_tab(\@lines);
1.448 albertel 9576: }
1.852 albertel 9577: close($fh);
9578: $loaded = 1;
1.327 albertel 9579: }
1.846 albertel 9580:
9581: sub domain {
1.852 albertel 9582: &load_domain_tab() if (!$loaded);
9583:
1.846 albertel 9584: my ($name,$what) = @_;
9585: return if ( !exists($domain{$name}) );
9586:
9587: if (!$what) {
9588: return $domain{$name}{'description'};
9589: }
9590: return $domain{$name}{$what};
9591: }
1.974 raeburn 9592:
9593: sub domain_info {
9594: &load_domain_tab() if (!$loaded);
9595: return %domain;
9596: }
9597:
1.327 albertel 9598: }
9599:
9600:
1.1 albertel 9601: # ------------------------------------------------------------- Read hosts file
9602: {
1.838 albertel 9603: my %hostname;
1.844 albertel 9604: my %hostdom;
1.845 albertel 9605: my %libserv;
1.852 albertel 9606: my $loaded;
1.888 albertel 9607: my %name_to_host;
1.852 albertel 9608:
9609: sub parse_hosts_tab {
9610: my ($file) = @_;
9611: foreach my $configline (@$file) {
9612: next if ($configline =~ /^(\#|\s*$ )/x);
9613: next if ($configline =~ /^\^/);
9614: chomp($configline);
1.968 raeburn 9615: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852 albertel 9616: $name=~s/\s//g;
9617: if ($id && $domain && $role && $name) {
9618: $hostname{$id}=$name;
1.888 albertel 9619: push(@{$name_to_host{$name}}, $id);
1.852 albertel 9620: $hostdom{$id}=$domain;
9621: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 9622: if (defined($protocol)) {
9623: if ($protocol eq 'https') {
9624: $protocol{$id} = $protocol;
9625: } else {
9626: $protocol{$id} = 'http';
9627: }
1.968 raeburn 9628: } else {
1.969 raeburn 9629: $protocol{$id} = 'http';
1.968 raeburn 9630: }
1.852 albertel 9631: }
9632: }
9633: }
1.864 albertel 9634:
9635: sub reset_hosts_info {
1.897 albertel 9636: &purge_remembered();
1.864 albertel 9637: &reset_domain_info();
9638: &reset_hosts_ip_info();
1.892 albertel 9639: undef(%name_to_host);
1.864 albertel 9640: undef(%hostname);
9641: undef(%hostdom);
9642: undef(%libserv);
9643: undef($loaded);
9644: }
1.1 albertel 9645:
1.852 albertel 9646: sub load_hosts_tab {
1.869 albertel 9647: my ($ignore_cache) = @_;
9648: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 9649: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9650: my @config = <$config>;
9651: &parse_hosts_tab(\@config);
9652: close($config);
9653: $loaded=1;
1.1 albertel 9654: }
1.852 albertel 9655:
1.838 albertel 9656: sub hostname {
1.852 albertel 9657: &load_hosts_tab() if (!$loaded);
9658:
1.838 albertel 9659: my ($lonid) = @_;
9660: return $hostname{$lonid};
9661: }
1.845 albertel 9662:
1.838 albertel 9663: sub all_hostnames {
1.852 albertel 9664: &load_hosts_tab() if (!$loaded);
9665:
1.838 albertel 9666: return %hostname;
9667: }
1.845 albertel 9668:
1.888 albertel 9669: sub all_names {
9670: &load_hosts_tab() if (!$loaded);
9671:
9672: return %name_to_host;
9673: }
9674:
1.974 raeburn 9675: sub all_host_domain {
9676: &load_hosts_tab() if (!$loaded);
9677: return %hostdom;
9678: }
9679:
1.845 albertel 9680: sub is_library {
1.852 albertel 9681: &load_hosts_tab() if (!$loaded);
9682:
1.845 albertel 9683: return exists($libserv{$_[0]});
9684: }
9685:
9686: sub all_library {
1.852 albertel 9687: &load_hosts_tab() if (!$loaded);
9688:
1.845 albertel 9689: return %libserv;
9690: }
9691:
1.841 albertel 9692: sub get_servers {
1.852 albertel 9693: &load_hosts_tab() if (!$loaded);
9694:
1.841 albertel 9695: my ($domain,$type) = @_;
9696: my %possible_hosts = ($type eq 'library') ? %libserv
9697: : %hostname;
9698: my %result;
1.842 albertel 9699: if (ref($domain) eq 'ARRAY') {
9700: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 9701: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 9702: $result{$host} = $hostname;
9703: }
9704: }
9705: } else {
9706: while ( my ($host,$hostname) = each(%possible_hosts)) {
9707: if ($hostdom{$host} eq $domain) {
9708: $result{$host} = $hostname;
9709: }
1.841 albertel 9710: }
9711: }
9712: return %result;
9713: }
1.845 albertel 9714:
1.844 albertel 9715: sub host_domain {
1.852 albertel 9716: &load_hosts_tab() if (!$loaded);
9717:
1.844 albertel 9718: my ($lonid) = @_;
9719: return $hostdom{$lonid};
9720: }
9721:
1.841 albertel 9722: sub all_domains {
1.852 albertel 9723: &load_hosts_tab() if (!$loaded);
9724:
1.841 albertel 9725: my %seen;
9726: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9727: return @uniq;
9728: }
1.1 albertel 9729: }
9730:
1.847 albertel 9731: {
9732: my %iphost;
1.856 albertel 9733: my %name_to_ip;
9734: my %lonid_to_ip;
1.869 albertel 9735:
1.847 albertel 9736: sub get_hosts_from_ip {
9737: my ($ip) = @_;
9738: my %iphosts = &get_iphost();
9739: if (ref($iphosts{$ip})) {
9740: return @{$iphosts{$ip}};
9741: }
9742: return;
1.839 albertel 9743: }
1.864 albertel 9744:
9745: sub reset_hosts_ip_info {
9746: undef(%iphost);
9747: undef(%name_to_ip);
9748: undef(%lonid_to_ip);
9749: }
1.856 albertel 9750:
9751: sub get_host_ip {
9752: my ($lonid) = @_;
9753: if (exists($lonid_to_ip{$lonid})) {
9754: return $lonid_to_ip{$lonid};
9755: }
9756: my $name=&hostname($lonid);
9757: my $ip = gethostbyname($name);
9758: return if (!$ip || length($ip) ne 4);
9759: $ip=inet_ntoa($ip);
9760: $name_to_ip{$name} = $ip;
9761: $lonid_to_ip{$lonid} = $ip;
9762: return $ip;
9763: }
1.847 albertel 9764:
9765: sub get_iphost {
1.869 albertel 9766: my ($ignore_cache) = @_;
1.894 albertel 9767:
1.869 albertel 9768: if (!$ignore_cache) {
9769: if (%iphost) {
9770: return %iphost;
9771: }
9772: my ($ip_info,$cached)=
9773: &Apache::lonnet::is_cached_new('iphost','iphost');
9774: if ($cached) {
9775: %iphost = %{$ip_info->[0]};
9776: %name_to_ip = %{$ip_info->[1]};
9777: %lonid_to_ip = %{$ip_info->[2]};
9778: return %iphost;
9779: }
9780: }
1.894 albertel 9781:
9782: # get yesterday's info for fallback
9783: my %old_name_to_ip;
9784: my ($ip_info,$cached)=
9785: &Apache::lonnet::is_cached_new('iphost','iphost');
9786: if ($cached) {
9787: %old_name_to_ip = %{$ip_info->[1]};
9788: }
9789:
1.888 albertel 9790: my %name_to_host = &all_names();
9791: foreach my $name (keys(%name_to_host)) {
1.847 albertel 9792: my $ip;
9793: if (!exists($name_to_ip{$name})) {
9794: $ip = gethostbyname($name);
9795: if (!$ip || length($ip) ne 4) {
1.894 albertel 9796: if (defined($old_name_to_ip{$name})) {
9797: $ip = $old_name_to_ip{$name};
9798: &logthis("Can't find $name defaulting to old $ip");
9799: } else {
9800: &logthis("Name $name no IP found");
9801: next;
9802: }
9803: } else {
9804: $ip=inet_ntoa($ip);
1.847 albertel 9805: }
9806: $name_to_ip{$name} = $ip;
9807: } else {
9808: $ip = $name_to_ip{$name};
1.653 albertel 9809: }
1.888 albertel 9810: foreach my $id (@{ $name_to_host{$name} }) {
9811: $lonid_to_ip{$id} = $ip;
9812: }
9813: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 9814: }
1.869 albertel 9815: &Apache::lonnet::do_cache_new('iphost','iphost',
9816: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 9817: 48*60*60);
1.869 albertel 9818:
1.847 albertel 9819: return %iphost;
1.598 albertel 9820: }
9821:
1.992 raeburn 9822: #
9823: # Given a DNS returns the loncapa host name for that DNS
9824: #
9825: sub host_from_dns {
9826: my ($dns) = @_;
9827: my @hosts;
9828: my $ip;
9829:
1.993 raeburn 9830: if (exists($name_to_ip{$dns})) {
1.992 raeburn 9831: $ip = $name_to_ip{$dns};
9832: }
9833: if (!$ip) {
9834: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9835: if (length($ip) == 4) {
9836: $ip = &IO::Socket::inet_ntoa($ip);
9837: }
9838: }
9839: if ($ip) {
9840: @hosts = get_hosts_from_ip($ip);
9841: return $hosts[0];
9842: }
9843: return undef;
1.986 foxr 9844: }
1.992 raeburn 9845:
1.986 foxr 9846: }
9847:
1.862 albertel 9848: BEGIN {
9849:
9850: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9851: unless ($readit) {
9852: {
9853: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9854: %perlvar = (%perlvar,%{$configvars});
9855: }
9856:
9857:
1.1 albertel 9858: # ------------------------------------------------------ Read spare server file
9859: {
1.448 albertel 9860: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 9861:
9862: while (my $configline=<$config>) {
9863: chomp($configline);
1.284 matthew 9864: if ($configline) {
1.784 albertel 9865: my ($host,$type) = split(':',$configline,2);
1.785 albertel 9866: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 9867: push(@{ $spareid{$type} }, $host);
1.1 albertel 9868: }
9869: }
1.448 albertel 9870: close($config);
1.1 albertel 9871: }
1.11 www 9872: # ------------------------------------------------------------ Read permissions
9873: {
1.448 albertel 9874: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 9875:
9876: while (my $configline=<$config>) {
1.448 albertel 9877: chomp($configline);
9878: if ($configline) {
9879: my ($role,$perm)=split(/ /,$configline);
9880: if ($perm ne '') { $pr{$role}=$perm; }
9881: }
1.11 www 9882: }
1.448 albertel 9883: close($config);
1.11 www 9884: }
9885:
9886: # -------------------------------------------- Read plain texts for permissions
9887: {
1.448 albertel 9888: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 9889:
9890: while (my $configline=<$config>) {
1.448 albertel 9891: chomp($configline);
9892: if ($configline) {
1.742 raeburn 9893: my ($short,@plain)=split(/:/,$configline);
9894: %{$prp{$short}} = ();
9895: if (@plain > 0) {
9896: $prp{$short}{'std'} = $plain[0];
9897: for (my $i=1; $i<@plain; $i++) {
9898: $prp{$short}{'alt'.$i} = $plain[$i];
9899: }
9900: }
1.448 albertel 9901: }
1.135 www 9902: }
1.448 albertel 9903: close($config);
1.135 www 9904: }
9905:
9906: # ---------------------------------------------------------- Read package table
9907: {
1.448 albertel 9908: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 9909:
9910: while (my $configline=<$config>) {
1.483 albertel 9911: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 9912: chomp($configline);
9913: my ($short,$plain)=split(/:/,$configline);
9914: my ($pack,$name)=split(/\&/,$short);
9915: if ($plain ne '') {
9916: $packagetab{$pack.'&'.$name.'&name'}=$name;
9917: $packagetab{$short}=$plain;
9918: }
1.11 www 9919: }
1.448 albertel 9920: close($config);
1.329 matthew 9921: }
9922:
9923: # ------------- set up temporary directory
9924: {
9925: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9926:
1.11 www 9927: }
9928:
1.794 albertel 9929: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9930: 'compress_threshold'=> 20_000,
9931: });
1.185 www 9932:
1.281 www 9933: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 9934: $dumpcount=0;
1.958 www 9935: $locknum=0;
1.22 www 9936:
1.163 harris41 9937: &logtouch();
1.672 albertel 9938: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 9939: $readit=1;
1.564 albertel 9940: {
9941: use integer;
9942: my $test=(2**32)+1;
1.568 albertel 9943: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 9944: &logthis(" Detected 64bit platform ($_64bit)");
9945: }
1.195 www 9946: }
1.1 albertel 9947: }
1.179 www 9948:
1.1 albertel 9949: 1;
1.191 harris41 9950: __END__
9951:
1.243 albertel 9952: =pod
9953:
1.191 harris41 9954: =head1 NAME
9955:
1.243 albertel 9956: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 9957:
9958: =head1 SYNOPSIS
9959:
1.243 albertel 9960: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 9961:
9962: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9963:
1.243 albertel 9964: Common parameters:
9965:
9966: =over 4
9967:
9968: =item *
9969:
9970: $uname : an internal username (if $cname expecting a course Id specifically)
9971:
9972: =item *
9973:
9974: $udom : a domain (if $cdom expecting a course's domain specifically)
9975:
9976: =item *
9977:
9978: $symb : a resource instance identifier
9979:
9980: =item *
9981:
9982: $namespace : the name of a .db file that contains the data needed or
9983: being set.
9984:
9985: =back
9986:
1.394 bowersj2 9987: =head1 OVERVIEW
1.191 harris41 9988:
1.394 bowersj2 9989: lonnet provides subroutines which interact with the
9990: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9991: about classes, users, and resources.
1.243 albertel 9992:
9993: For many of these objects you can also use this to store data about
9994: them or modify them in various ways.
1.191 harris41 9995:
1.394 bowersj2 9996: =head2 Symbs
1.191 harris41 9997:
1.394 bowersj2 9998: To identify a specific instance of a resource, LON-CAPA uses symbols
9999: or "symbs"X<symb>. These identifiers are built from the URL of the
10000: map, the resource number of the resource in the map, and the URL of
10001: the resource itself. The latter is somewhat redundant, but might help
10002: if maps change.
10003:
10004: An example is
10005:
10006: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
10007:
10008: The respective map entry is
10009:
10010: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10011: title="Problem 2">
10012: </resource>
10013:
10014: Symbs are used by the random number generator, as well as to store and
10015: restore data specific to a certain instance of for example a problem.
10016:
10017: =head2 Storing And Retrieving Data
10018:
10019: X<store()>X<cstore()>X<restore()>Three of the most important functions
10020: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10021: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10022: is is the non-critical message twin of cstore. These functions are for
10023: handlers to store a perl hash to a user's permanent data space in an
10024: easy manner, and to retrieve it again on another call. It is expected
10025: that a handler would use this once at the beginning to retrieve data,
10026: and then again once at the end to send only the new data back.
10027:
10028: The data is stored in the user's data directory on the user's
10029: homeserver under the ID of the course.
10030:
10031: The hash that is returned by restore will have all of the previous
10032: value for all of the elements of the hash.
10033:
10034: Example:
10035:
10036: #creating a hash
10037: my %hash;
10038: $hash{'foo'}='bar';
10039:
10040: #storing it
10041: &Apache::lonnet::cstore(\%hash);
10042:
10043: #changing a value
10044: $hash{'foo'}='notbar';
10045:
10046: #adding a new value
10047: $hash{'bar'}='foo';
10048: &Apache::lonnet::cstore(\%hash);
10049:
10050: #retrieving the hash
10051: my %history=&Apache::lonnet::restore();
10052:
10053: #print the hash
10054: foreach my $key (sort(keys(%history))) {
10055: print("\%history{$key} = $history{$key}");
10056: }
10057:
10058: Will print out:
1.191 harris41 10059:
1.394 bowersj2 10060: %history{1:foo} = bar
10061: %history{1:keys} = foo:timestamp
10062: %history{1:timestamp} = 990455579
10063: %history{2:bar} = foo
10064: %history{2:foo} = notbar
10065: %history{2:keys} = foo:bar:timestamp
10066: %history{2:timestamp} = 990455580
10067: %history{bar} = foo
10068: %history{foo} = notbar
10069: %history{timestamp} = 990455580
10070: %history{version} = 2
10071:
10072: Note that the special hash entries C<keys>, C<version> and
10073: C<timestamp> were added to the hash. C<version> will be equal to the
10074: total number of versions of the data that have been stored. The
10075: C<timestamp> attribute will be the UNIX time the hash was
10076: stored. C<keys> is available in every historical section to list which
10077: keys were added or changed at a specific historical revision of a
10078: hash.
10079:
10080: B<Warning>: do not store the hash that restore returns directly. This
10081: will cause a mess since it will restore the historical keys as if the
10082: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 10083:
1.394 bowersj2 10084: Calling convention:
1.191 harris41 10085:
1.394 bowersj2 10086: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10087: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 10088:
1.394 bowersj2 10089: For more detailed information, see lonnet specific documentation.
1.191 harris41 10090:
1.394 bowersj2 10091: =head1 RETURN MESSAGES
1.191 harris41 10092:
1.394 bowersj2 10093: =over 4
1.191 harris41 10094:
1.394 bowersj2 10095: =item * B<con_lost>: unable to contact remote host
1.191 harris41 10096:
1.394 bowersj2 10097: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10098: when the connection is brought back up
1.191 harris41 10099:
1.394 bowersj2 10100: =item * B<con_failed>: unable to contact remote host and unable to save message
10101: for later delivery
1.191 harris41 10102:
1.967 bisitz 10103: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 10104:
1.394 bowersj2 10105: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 10106: that was requested
1.191 harris41 10107:
1.243 albertel 10108: =back
1.191 harris41 10109:
1.243 albertel 10110: =head1 PUBLIC SUBROUTINES
1.191 harris41 10111:
1.243 albertel 10112: =head2 Session Environment Functions
1.191 harris41 10113:
1.243 albertel 10114: =over 4
1.191 harris41 10115:
1.394 bowersj2 10116: =item *
10117: X<appenv()>
1.949 raeburn 10118: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 10119: the user envirnoment file, and will be restored for each access this
1.620 albertel 10120: user makes during this session, also modifies the %env for the current
1.949 raeburn 10121: process. Optional rolesarrayref - if defined contains a reference to an array
10122: of roles which are exempt from the restriction on modifying user.role entries
10123: in the user's environment.db and in %env.
1.191 harris41 10124:
10125: =item *
1.394 bowersj2 10126: X<delenv()>
1.987 raeburn 10127: B<delenv($delthis,$regexp)>: removes all items from the session
10128: environment file that begin with $delthis. If the
10129: optional second arg - $regexp - is true, $delthis is treated as a
10130: regular expression, otherwise \Q$delthis\E is used.
10131: The values are also deleted from the current processes %env.
1.191 harris41 10132:
1.795 albertel 10133: =item * get_env_multiple($name)
10134:
10135: gets $name from the %env hash, it seemlessly handles the cases where multiple
10136: values may be defined and end up as an array ref.
10137:
10138: returns an array of values
10139:
1.243 albertel 10140: =back
10141:
10142: =head2 User Information
1.191 harris41 10143:
1.243 albertel 10144: =over 4
1.191 harris41 10145:
10146: =item *
1.394 bowersj2 10147: X<queryauthenticate()>
10148: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 10149: authentication scheme
10150:
10151: =item *
1.394 bowersj2 10152: X<authenticate()>
10153: B<authenticate($uname,$upass,$udom)>: try to
10154: authenticate user from domain's lib servers (first use the current
10155: one). C<$upass> should be the users password.
1.191 harris41 10156:
10157: =item *
1.394 bowersj2 10158: X<homeserver()>
10159: B<homeserver($uname,$udom)>: find the server which has
10160: the user's directory and files (there must be only one), this caches
10161: the answer, and also caches if there is a borken connection.
1.191 harris41 10162:
10163: =item *
1.394 bowersj2 10164: X<idget()>
10165: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10166: (IDs are a unique resource in a domain, there must be only 1 ID per
10167: username, and only 1 username per ID in a specific domain) (returns
10168: hash: id=>name,id=>name)
1.191 harris41 10169:
10170: =item *
1.394 bowersj2 10171: X<idrget()>
10172: B<idrget($udom,@unames)>: find the IDs behind a list of
10173: usernames (returns hash: name=>id,name=>id)
1.191 harris41 10174:
10175: =item *
1.394 bowersj2 10176: X<idput()>
10177: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 10178:
10179: =item *
1.394 bowersj2 10180: X<rolesinit()>
10181: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 10182:
10183: =item *
1.551 albertel 10184: X<getsection()>
10185: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 10186: course $cname, return section name/number or '' for "not in course"
10187: and '-1' for "no section"
10188:
10189: =item *
1.394 bowersj2 10190: X<userenvironment()>
10191: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 10192: passed in @what from the requested user's environment, returns a hash
10193:
1.858 raeburn 10194: =item *
10195: X<userlog_query()>
1.859 albertel 10196: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10197: activity.log file. %filters defines filters applied when parsing the
10198: log file. These can be start or end timestamps, or the type of action
10199: - log to look for Login or Logout events, check for Checkin or
10200: Checkout, role for role selection. The response is in the form
10201: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10202: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 10203:
1.243 albertel 10204: =back
10205:
10206: =head2 User Roles
10207:
10208: =over 4
10209:
10210: =item *
10211:
1.810 raeburn 10212: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 10213: F: full access
10214: U,I,K: authentication modes (cxx only)
10215: '': forbidden
10216: 1: user needs to choose course
10217: 2: browse allowed
1.766 albertel 10218: A: passphrase authentication needed
1.243 albertel 10219:
10220: =item *
10221:
10222: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10223: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10224: and course level
10225:
10226: =item *
10227:
1.988 raeburn 10228: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10229: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 10230: $type is Course (default) or Community.
1.988 raeburn 10231: If $forcedefault evaluates to true, text returned will be default
10232: text for $type. Otherwise, if this is a course, the text returned
10233: will be a custom name for the role (if defined in the course's
10234: environment). If no custom name is defined the default is returned.
10235:
1.832 raeburn 10236: =item *
10237:
1.935 raeburn 10238: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 10239: All arguments are optional. Returns a hash of a roles, either for
10240: co-author/assistant author roles for a user's Construction Space
1.906 albertel 10241: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 10242: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10243: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10244: For each key, value is set to colon-separated start and end times for
10245: the role. If no username and domain are specified, will default to
1.934 raeburn 10246: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 10247: of role statuses (active, future or previous), roles
10248: (e.g., cc,in, st etc.) and domains of the roles which can be used
10249: to restrict the list of roles reported. If no array ref is
10250: provided for types, will default to return only active roles.
1.834 albertel 10251:
1.243 albertel 10252: =back
10253:
10254: =head2 User Modification
10255:
10256: =over 4
10257:
10258: =item *
10259:
1.957 raeburn 10260: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 10261: user for the level given by URL. Optional start and end dates (leave empty
10262: string or zero for "no date")
1.191 harris41 10263:
10264: =item *
10265:
1.243 albertel 10266: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10267: change a users, password, possible return values are: ok,
10268: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10269: refused
1.191 harris41 10270:
10271: =item *
10272:
1.243 albertel 10273: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 10274:
10275: =item *
10276:
1.963 raeburn 10277: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
10278: $forceid,$desiredhome,$email,$inststatus) :
1.243 albertel 10279: modify user
1.191 harris41 10280:
10281: =item *
10282:
1.286 matthew 10283: modifystudent
10284:
1.957 raeburn 10285: modify a student's enrollment and identification information.
1.286 matthew 10286: The course id is resolved based on the current users environment.
10287: This means the envoking user must be a course coordinator or otherwise
10288: associated with a course.
10289:
1.297 matthew 10290: This call is essentially a wrapper for lonnet::modifyuser and
10291: lonnet::modify_student_enrollment
1.286 matthew 10292:
10293: Inputs:
10294:
10295: =over 4
10296:
1.957 raeburn 10297: =item B<$udom> Student's loncapa domain
1.286 matthew 10298:
1.957 raeburn 10299: =item B<$uname> Student's loncapa login name
1.286 matthew 10300:
1.964 bisitz 10301: =item B<$uid> Student/Employee ID
1.286 matthew 10302:
1.957 raeburn 10303: =item B<$umode> Student's authentication mode
1.286 matthew 10304:
1.957 raeburn 10305: =item B<$upass> Student's password
1.286 matthew 10306:
1.957 raeburn 10307: =item B<$first> Student's first name
1.286 matthew 10308:
1.957 raeburn 10309: =item B<$middle> Student's middle name
1.286 matthew 10310:
1.957 raeburn 10311: =item B<$last> Student's last name
1.286 matthew 10312:
1.957 raeburn 10313: =item B<$gene> Student's generation
1.286 matthew 10314:
1.957 raeburn 10315: =item B<$usec> Student's section in course
1.286 matthew 10316:
10317: =item B<$end> Unix time of the roles expiration
10318:
10319: =item B<$start> Unix time of the roles start date
10320:
10321: =item B<$forceid> If defined, allow $uid to be changed
10322:
10323: =item B<$desiredhome> server to use as home server for student
10324:
1.957 raeburn 10325: =item B<$email> Student's permanent e-mail address
10326:
10327: =item B<$type> Type of enrollment (auto or manual)
10328:
1.963 raeburn 10329: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10330:
10331: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 10332:
1.963 raeburn 10333: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 10334:
1.963 raeburn 10335: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 10336:
1.963 raeburn 10337: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 10338:
1.286 matthew 10339: =back
1.297 matthew 10340:
10341: =item *
10342:
10343: modify_student_enrollment
10344:
10345: Change a students enrollment status in a class. The environment variable
10346: 'role.request.course' must be defined for this function to proceed.
10347:
10348: Inputs:
10349:
10350: =over 4
10351:
10352: =item $udom, students domain
10353:
10354: =item $uname, students name
10355:
10356: =item $uid, students user id
10357:
10358: =item $first, students first name
10359:
10360: =item $middle
10361:
10362: =item $last
10363:
10364: =item $gene
10365:
10366: =item $usec
10367:
10368: =item $end
10369:
10370: =item $start
10371:
1.957 raeburn 10372: =item $type
10373:
10374: =item $locktype
10375:
10376: =item $cid
10377:
10378: =item $selfenroll
10379:
10380: =item $context
10381:
1.297 matthew 10382: =back
10383:
1.191 harris41 10384:
10385: =item *
10386:
1.243 albertel 10387: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10388: custom role; give a custom role to a user for the level given by URL. Specify
10389: name and domain of role author, and role name
1.191 harris41 10390:
10391: =item *
10392:
1.243 albertel 10393: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 10394:
10395: =item *
10396:
1.243 albertel 10397: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10398:
10399: =back
10400:
10401: =head2 Course Infomation
10402:
10403: =over 4
1.191 harris41 10404:
10405: =item *
10406:
1.631 albertel 10407: coursedescription($courseid) : returns a hash of information about the
10408: specified course id, including all environment settings for the
10409: course, the description of the course will be in the hash under the
10410: key 'description'
1.191 harris41 10411:
10412: =item *
10413:
1.624 albertel 10414: resdata($name,$domain,$type,@which) : request for current parameter
10415: setting for a specific $type, where $type is either 'course' or 'user',
10416: @what should be a list of parameters to ask about. This routine caches
10417: answers for 5 minutes.
1.243 albertel 10418:
1.877 foxr 10419: =item *
10420:
10421: get_courseresdata($courseid, $domain) : dump the entire course resource
10422: data base, returning a hash that is keyed by the resource name and has
10423: values that are the resource value. I believe that the timestamps and
10424: versions are also returned.
10425:
10426:
1.243 albertel 10427: =back
10428:
10429: =head2 Course Modification
10430:
10431: =over 4
1.191 harris41 10432:
10433: =item *
10434:
1.243 albertel 10435: writecoursepref($courseid,%prefs) : write preferences (environment
10436: database) for a course
1.191 harris41 10437:
10438: =item *
10439:
1.1011 raeburn 10440: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10441:
10442: =item *
10443:
1.1038 raeburn 10444: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 10445:
10446: =back
10447:
10448: =head2 Resource Subroutines
10449:
10450: =over 4
1.191 harris41 10451:
10452: =item *
10453:
1.243 albertel 10454: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 10455:
10456: =item *
10457:
1.243 albertel 10458: repcopy($filename) : subscribes to the requested file, and attempts to
10459: replicate from the owning library server, Might return
1.607 raeburn 10460: 'unavailable', 'not_found', 'forbidden', 'ok', or
10461: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 10462: resource. Expects the local filesystem pathname
10463: (/home/httpd/html/res/....)
10464:
10465: =back
10466:
10467: =head2 Resource Information
10468:
10469: =over 4
1.191 harris41 10470:
10471: =item *
10472:
1.243 albertel 10473: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10474: a vairety of different possible values, $varname should be a request
10475: string, and the other parameters can be used to specify who and what
10476: one is asking about.
10477:
10478: Possible values for $varname are environment.lastname (or other item
10479: from the envirnment hash), user.name (or someother aspect about the
10480: user), resource.0.maxtries (or some other part and parameter of a
10481: resource)
1.204 albertel 10482:
10483: =item *
10484:
1.243 albertel 10485: directcondval($number) : get current value of a condition; reads from a state
10486: string
1.204 albertel 10487:
10488: =item *
10489:
1.243 albertel 10490: condval($condidx) : value of condition index based on state
1.204 albertel 10491:
10492: =item *
10493:
1.243 albertel 10494: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10495: resource's metadata, $what should be either a specific key, or either
10496: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10497: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10498:
10499: this function automatically caches all requests
1.191 harris41 10500:
10501: =item *
10502:
1.243 albertel 10503: metadata_query($query,$custom,$customshow) : make a metadata query against the
10504: network of library servers; returns file handle of where SQL and regex results
10505: will be stored for query
1.191 harris41 10506:
10507: =item *
10508:
1.243 albertel 10509: symbread($filename) : return symbolic list entry (filename argument optional);
10510: returns the data handle
1.191 harris41 10511:
10512: =item *
10513:
1.243 albertel 10514: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 10515: a possible symb for the URL in $thisfn, and if is an encryypted
10516: resource that the user accessed using /enc/ returns a 1 on success, 0
10517: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 10518: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 10519:
1.191 harris41 10520:
10521: =item *
10522:
1.243 albertel 10523: symbclean($symb) : removes versions numbers from a symb, returns the
10524: cleaned symb
1.191 harris41 10525:
10526: =item *
10527:
1.243 albertel 10528: is_on_map($uri) : checks if the $uri is somewhere on the current
10529: course map, user must be in a course for it to work.
1.191 harris41 10530:
10531: =item *
10532:
1.243 albertel 10533: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 10534:
10535: =item *
10536:
1.243 albertel 10537: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10538: a random seed, all arguments are optional, if they aren't sent it uses the
10539: environment to derive them. Note: if symb isn't sent and it can't get one
10540: from &symbread it will use the current time as its return value
1.191 harris41 10541:
10542: =item *
10543:
1.243 albertel 10544: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10545: unfakeable, receipt
1.191 harris41 10546:
10547: =item *
10548:
1.620 albertel 10549: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 10550:
10551: =item *
10552:
1.243 albertel 10553: countacc($url) : count the number of accesses to a given URL
1.191 harris41 10554:
10555: =item *
10556:
1.243 albertel 10557: 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 10558:
10559: =item *
10560:
1.243 albertel 10561: 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 10562:
10563: =item *
10564:
1.243 albertel 10565: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 10566:
10567: =item *
10568:
1.243 albertel 10569: devalidate($symb) : devalidate temporary spreadsheet calculations,
10570: forcing spreadsheet to reevaluate the resource scores next time.
10571:
10572: =back
10573:
10574: =head2 Storing/Retreiving Data
10575:
10576: =over 4
1.191 harris41 10577:
10578: =item *
10579:
1.243 albertel 10580: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10581: for this url; hashref needs to be given and should be a \%hashname; the
10582: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 10583: be derived from the env
1.191 harris41 10584:
10585: =item *
10586:
1.243 albertel 10587: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10588: uses critical subroutine
1.191 harris41 10589:
10590: =item *
10591:
1.243 albertel 10592: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10593: all args are optional
1.191 harris41 10594:
10595: =item *
10596:
1.717 albertel 10597: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10598: dumps the complete (or key matching regexp) namespace into a hash
10599: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10600: normally &store()ed into
10601:
10602: $range should be either an integer '100' (give me the first 100
10603: matching records)
10604: or be two integers sperated by a - with no spaces
10605: '30-50' (give me the 30th through the 50th matching
10606: records)
10607:
10608:
10609: =item *
10610:
10611: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10612: replaces a &store() version of data with a replacement set of data
10613: for a particular resource in a namespace passed in the $storehash hash
10614: reference
10615:
10616: =item *
10617:
1.243 albertel 10618: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10619: works very similar to store/cstore, but all data is stored in a
10620: temporary location and can be reset using tmpreset, $storehash should
10621: be a hash reference, returns nothing on success
1.191 harris41 10622:
10623: =item *
10624:
1.243 albertel 10625: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10626: similar to restore, but all data is stored in a temporary location and
10627: can be reset using tmpreset. Returns a hash of values on success,
10628: error string otherwise.
1.191 harris41 10629:
10630: =item *
10631:
1.243 albertel 10632: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10633: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 10634:
10635: =item *
10636:
1.243 albertel 10637: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10638: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 10639:
10640: =item *
10641:
1.243 albertel 10642: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10643: namesp ($udom and $uname are optional)
1.191 harris41 10644:
10645: =item *
10646:
1.702 albertel 10647: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 10648: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 10649: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 10650:
1.702 albertel 10651: $range should be either an integer '100' (give me the first 100
10652: matching records)
10653: or be two integers sperated by a - with no spaces
10654: '30-50' (give me the 30th through the 50th matching
10655: records)
1.449 matthew 10656: =item *
10657:
10658: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10659: $store can be a scalar, an array reference, or if the amount to be
10660: incremented is > 1, a hash reference.
10661:
10662: ($udom and $uname are optional)
1.191 harris41 10663:
10664: =item *
10665:
1.243 albertel 10666: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10667: ($udom and $uname are optional)
1.191 harris41 10668:
10669: =item *
10670:
1.243 albertel 10671: cput($namespace,$storehash,$udom,$uname) : critical put
10672: ($udom and $uname are optional)
1.191 harris41 10673:
10674: =item *
10675:
1.748 albertel 10676: newput($namespace,$storehash,$udom,$uname) :
10677:
10678: Attempts to store the items in the $storehash, but only if they don't
10679: currently exist, if this succeeds you can be certain that you have
10680: successfully created a new key value pair in the $namespace db.
10681:
10682:
10683: Args:
10684: $namespace: name of database to store values to
10685: $storehash: hashref to store to the db
10686: $udom: (optional) domain of user containing the db
10687: $uname: (optional) name of user caontaining the db
10688:
10689: Returns:
10690: 'ok' -> succeeded in storing all keys of $storehash
10691: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10692: least <key> already existed in the db (other
10693: requested keys may also already exist)
1.967 bisitz 10694: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 10695: 'con_lost' -> unable to contact request server
10696: 'refused' -> action was not allowed by remote machine
10697:
10698:
10699: =item *
10700:
1.243 albertel 10701: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10702: reference filled in from namesp (encrypts the return communication)
10703: ($udom and $uname are optional)
1.191 harris41 10704:
10705: =item *
10706:
1.243 albertel 10707: log($udom,$name,$home,$message) : write to permanent log for user; use
10708: critical subroutine
10709:
1.806 raeburn 10710: =item *
10711:
1.860 raeburn 10712: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10713: array reference filled in from namespace found in domain level on either
10714: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 10715:
10716: =item *
10717:
1.860 raeburn 10718: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10719: domain level either on specified domain server ($uhome) or primary domain
10720: server ($udom and $uhome are optional)
1.806 raeburn 10721:
1.943 raeburn 10722: =item *
10723:
10724: get_domain_defaults($target_domain) : returns hash with defaults for
10725: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10726: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10727: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10728: Values are retrieved from cache (if current), or from domain's configuration.db
10729: (if available), or lastly from values in lonTabs/dns_domain,tab,
10730: or lonTabs/domain.tab.
10731:
10732: %domdefaults = &get_auth_defaults($target_domain);
10733:
1.243 albertel 10734: =back
10735:
10736: =head2 Network Status Functions
10737:
10738: =over 4
1.191 harris41 10739:
10740: =item *
10741:
10742: dirlist($uri) : return directory list based on URI
10743:
10744: =item *
10745:
1.243 albertel 10746: spareserver() : find server with least workload from spare.tab
10747:
1.986 foxr 10748:
10749: =item *
10750:
10751: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10752: if there is no corresponding loncapa host.
10753:
1.243 albertel 10754: =back
10755:
1.986 foxr 10756:
1.243 albertel 10757: =head2 Apache Request
10758:
10759: =over 4
1.191 harris41 10760:
10761: =item *
10762:
1.243 albertel 10763: ssi($url,%hash) : server side include, does a complete request cycle on url to
10764: localhost, posts hash
10765:
10766: =back
10767:
10768: =head2 Data to String to Data
10769:
10770: =over 4
1.191 harris41 10771:
10772: =item *
10773:
1.243 albertel 10774: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10775: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 10776:
10777: =item *
10778:
1.243 albertel 10779: hashref2str($hashref) : convert a hashref into a string complete with
10780: escaping and '=' and '&' separators, supports elements that are
10781: arrayrefs and hashrefs
1.191 harris41 10782:
10783: =item *
10784:
1.243 albertel 10785: arrayref2str($arrayref) : convert an arrayref into a string complete
10786: with escaping and '&' separators, supports elements that are arrayrefs
10787: and hashrefs
1.191 harris41 10788:
10789: =item *
10790:
1.243 albertel 10791: str2hash($string) : convert string to hash using unescaping and
10792: splitting on '=' and '&', supports elements that are arrayrefs and
10793: hashrefs
1.191 harris41 10794:
10795: =item *
10796:
1.243 albertel 10797: str2array($string) : convert string to hash using unescaping and
10798: splitting on '&', supports elements that are arrayrefs and hashrefs
10799:
10800: =back
10801:
10802: =head2 Logging Routines
10803:
10804: =over 4
10805:
10806: These routines allow one to make log messages in the lonnet.log and
10807: lonnet.perm logfiles.
1.191 harris41 10808:
10809: =item *
10810:
1.243 albertel 10811: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 10812:
10813: =item *
10814:
1.243 albertel 10815: logthis() : append message to the normal lonnet.log file, it gets
10816: preiodically rolled over and deleted.
1.191 harris41 10817:
10818: =item *
10819:
1.243 albertel 10820: logperm() : append a permanent message to lonnet.perm.log, this log
10821: file never gets deleted by any automated portion of the system, only
10822: messages of critical importance should go in here.
10823:
10824: =back
10825:
10826: =head2 General File Helper Routines
10827:
10828: =over 4
1.191 harris41 10829:
10830: =item *
10831:
1.481 raeburn 10832: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10833: (a) files in /uploaded
10834: (i) If a local copy of the file exists -
10835: compares modification date of local copy with last-modified date for
10836: definitive version stored on home server for course. If local copy is
10837: stale, requests a new version from the home server and stores it.
10838: If the original has been removed from the home server, then local copy
10839: is unlinked.
10840: (ii) If local copy does not exist -
10841: requests the file from the home server and stores it.
10842:
10843: If $caller is 'uploadrep':
10844: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10845: for request for files originally uploaded via DOCS.
10846: - returns 'ok' if fresh local copy now available, -1 otherwise.
10847:
10848: Otherwise:
10849: This indicates a call from the content generation phase of the request.
10850: - returns the entire contents of the file or -1.
10851:
10852: (b) files in /res
10853: - returns the entire contents of a file or -1;
10854: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 10855:
1.712 albertel 10856:
10857: =item *
10858:
10859: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10860: reference
10861:
10862: returns either a stat() list of data about the file or an empty list
10863: if the file doesn't exist or couldn't find out about it (connection
10864: problems or user unknown)
10865:
1.191 harris41 10866: =item *
10867:
1.243 albertel 10868: filelocation($dir,$file) : returns file system location of a file
10869: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10870: directory that relative $file lookups are to looked in ($dir of /a/dir
10871: and a file of ../bob will become /a/bob)
1.191 harris41 10872:
10873: =item *
10874:
10875: hreflocation($dir,$file) : returns file system location or a URL; same as
10876: filelocation except for hrefs
10877:
10878: =item *
10879:
10880: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10881:
1.243 albertel 10882: =back
10883:
1.608 albertel 10884: =head2 Usererfile file routines (/uploaded*)
10885:
10886: =over 4
10887:
10888: =item *
10889:
10890: userfileupload(): main rotine for putting a file in a user or course's
10891: filespace, arguments are,
10892:
1.620 albertel 10893: formname - required - this is the name of the element in $env where the
1.608 albertel 10894: filename, and the contents of the file to create/modifed exist
1.620 albertel 10895: the filename is in $env{'form.'.$formname.'.filename'} and the
10896: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 10897: coursedoc - if true, store the file in the course of the active role
10898: of the current user
10899: subdir - required - subdirectory to put the file in under ../userfiles/
10900: if undefined, it will be placed in "unknown"
10901:
10902: (This routine calls clean_filename() to remove any dangerous
10903: characters from the filename, and then calls finuserfileupload() to
10904: complete the transaction)
10905:
10906: returns either the url of the uploaded file (/uploaded/....) if successful
10907: and /adm/notfound.html if unsuccessful
10908:
10909: =item *
10910:
10911: clean_filename(): routine for cleaing a filename up for storage in
10912: userfile space, argument is:
10913:
10914: filename - proposed filename
10915:
10916: returns: the new clean filename
10917:
10918: =item *
10919:
10920: finishuserfileupload(): routine that creaes and sends the file to
10921: userspace, probably shouldn't be called directly
10922:
10923: docuname: username or courseid of destination for the file
10924: docudom: domain of user/course of destination for the file
10925: formname: same as for userfileupload()
10926: fname: filename (inculding subdirectories) for the file
10927:
10928: returns either the url of the uploaded file (/uploaded/....) if successful
10929: and /adm/notfound.html if unsuccessful
10930:
10931: =item *
10932:
10933: renameuserfile(): renames an existing userfile to a new name
10934:
10935: Args:
10936: docuname: username or courseid of destination for the file
10937: docudom: domain of user/course of destination for the file
10938: old: current file name (including any subdirs under userfiles)
10939: new: desired file name (including any subdirs under userfiles)
10940:
10941: =item *
10942:
10943: mkdiruserfile(): creates a directory is a userfiles dir
10944:
10945: Args:
10946: docuname: username or courseid of destination for the file
10947: docudom: domain of user/course of destination for the file
10948: dir: dir to create (including any subdirs under userfiles)
10949:
10950: =item *
10951:
10952: removeuserfile(): removes a file that exists in userfiles
10953:
10954: Args:
10955: docuname: username or courseid of destination for the file
10956: docudom: domain of user/course of destination for the file
10957: fname: filname to delete (including any subdirs under userfiles)
10958:
10959: =item *
10960:
10961: removeuploadedurl(): convience function for removeuserfile()
10962:
10963: Args:
10964: url: a full /uploaded/... url to delete
10965:
1.747 albertel 10966: =item *
10967:
10968: get_portfile_permissions():
10969: Args:
10970: domain: domain of user or course contain the portfolio files
10971: user: name of user or num of course contain the portfolio files
10972: Returns:
10973: hashref of a dump of the proper file_permissions.db
10974:
10975:
10976: =item *
10977:
10978: get_access_controls():
10979:
10980: Args:
10981: current_permissions: the hash ref returned from get_portfile_permissions()
10982: group: (optional) the group you want the files associated with
10983: file: (optional) the file you want access info on
10984:
10985: Returns:
1.749 raeburn 10986: a hash (keys are file names) of hashes containing
10987: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10988: values are XML containing access control settings (see below)
1.747 albertel 10989:
10990: Internal notes:
10991:
1.749 raeburn 10992: access controls are stored in file_permissions.db as key=value pairs.
10993: key -> path to file/file_name\0uniqueID:scope_end_start
10994: where scope -> public,guest,course,group,domains or users.
10995: end -> UNIX time for end of access (0 -> no end date)
10996: start -> UNIX time for start of access
10997:
10998: value -> XML description of access control
10999: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
11000: <start></start>
11001: <end></end>
11002:
11003: <password></password> for scope type = guest
11004:
11005: <domain></domain> for scope type = course or group
11006: <number></number>
11007: <roles id="">
11008: <role></role>
11009: <access></access>
11010: <section></section>
11011: <group></group>
11012: </roles>
11013:
11014: <dom></dom> for scope type = domains
11015:
11016: <users> for scope type = users
11017: <user>
11018: <uname></uname>
11019: <udom></udom>
11020: </user>
11021: </users>
11022: </scope>
11023:
11024: Access data is also aggregated for each file in an additional key=value pair:
11025: key -> path to file/file_name\0accesscontrol
11026: value -> reference to hash
11027: hash contains key = value pairs
11028: where key = uniqueID:scope_end_start
11029: value = UNIX time record was last updated
11030:
11031: Used to improve speed of look-ups of access controls for each file.
11032:
11033: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11034:
11035: modify_access_controls():
11036:
11037: Modifies access controls for a portfolio file
11038: Args
11039: 1. file name
11040: 2. reference to hash of required changes,
11041: 3. domain
11042: 4. username
11043: where domain,username are the domain of the portfolio owner
11044: (either a user or a course)
11045:
11046: Returns:
11047: 1. result of additions or updates ('ok' or 'error', with error message).
11048: 2. result of deletions ('ok' or 'error', with error message).
11049: 3. reference to hash of any new or updated access controls.
11050: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11051: key = integer (inbound ID)
11052: value = uniqueID
1.747 albertel 11053:
1.608 albertel 11054: =back
11055:
1.243 albertel 11056: =head2 HTTP Helper Routines
11057:
11058: =over 4
11059:
1.191 harris41 11060: =item *
11061:
11062: escape() : unpack non-word characters into CGI-compatible hex codes
11063:
11064: =item *
11065:
11066: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11067:
1.243 albertel 11068: =back
11069:
11070: =head1 PRIVATE SUBROUTINES
11071:
11072: =head2 Underlying communication routines (Shouldn't call)
11073:
11074: =over 4
11075:
11076: =item *
11077:
11078: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11079:
11080: =item *
11081:
11082: reply() : uses subreply to send a message to remote machine, logs all failures
11083:
11084: =item *
11085:
11086: critical() : passes a critical message to another server; if cannot
11087: get through then place message in connection buffer directory and
11088: returns con_delayed, if incapable of saving message, returns
11089: con_failed
11090:
11091: =item *
11092:
11093: reconlonc() : tries to reconnect lonc client processes.
11094:
11095: =back
11096:
11097: =head2 Resource Access Logging
11098:
11099: =over 4
11100:
11101: =item *
11102:
11103: flushcourselogs() : flush (save) buffer logs and access logs
11104:
11105: =item *
11106:
11107: courselog($what) : save message for course in hash
11108:
11109: =item *
11110:
11111: courseacclog($what) : save message for course using &courselog(). Perform
11112: special processing for specific resource types (problems, exams, quizzes, etc).
11113:
1.191 harris41 11114: =item *
11115:
11116: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11117: as a PerlChildExitHandler
1.243 albertel 11118:
11119: =back
11120:
11121: =head2 Other
11122:
11123: =over 4
11124:
11125: =item *
11126:
11127: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 11128:
11129: =back
11130:
11131: =cut
1.877 foxr 11132:
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