Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1054
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1054 ! raeburn 4: # $Id: lonnet.pm,v 1.1053 2010/03/08 14:28:50 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) = @_;
1.1054 ! raeburn 3022: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 3023: my $outcome;
3024: if ($caller eq 'timeonly') {
3025: my $cids = '';
3026: foreach my $item (keys(%$storehash)) {
3027: $cids.=&escape($item).'&';
3028: }
3029: $cids=~s/\&$//;
3030: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3031: $coursehome);
3032: } else {
3033: my $items = '';
3034: foreach my $item (keys(%$storehash)) {
3035: $items.= &escape($item).'='.
3036: &freeze_escape($$storehash{$item}).'&';
3037: }
3038: $items=~s/\&$//;
3039: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3040: $coursehome);
1.918 raeburn 3041: }
3042: if ($outcome eq 'unknown_cmd') {
3043: my $what;
3044: foreach my $cid (keys(%$storehash)) {
3045: $what .= &escape($cid).'=';
1.921 raeburn 3046: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 3047: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 3048: }
3049: $what =~ s/\:$/&/;
3050: }
3051: $what =~ s/\&$//;
3052: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3053: } else {
3054: return $outcome;
3055: }
1.353 www 3056: }
3057:
3058: sub courseiddump {
1.921 raeburn 3059: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 3060: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 3061: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3062: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
1.918 raeburn 3063: my $as_hash = 1;
3064: my %returnhash;
3065: if (!$domfilter) { $domfilter=''; }
1.845 albertel 3066: my %libserv = &all_library();
3067: foreach my $tryserver (keys(%libserv)) {
3068: if ( ( $hostidflag == 1
3069: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3070: || (!defined($hostidflag)) ) {
3071:
1.918 raeburn 3072: if (($domfilter eq '') ||
3073: (&host_domain($tryserver) eq $domfilter)) {
3074: my $rep =
3075: &reply('courseiddump:'.&host_domain($tryserver).':'.
3076: $sincefilter.':'.&escape($descfilter).':'.
3077: &escape($instcodefilter).':'.&escape($ownerfilter).
3078: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947 raeburn 3079: ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962 raeburn 3080: &escape($selfenrollonly).':'.&escape($catfilter).':'.
1.1008 raeburn 3081: $showhidden.':'.$caller.':'.&escape($cloner).':'.
1.1029 raeburn 3082: &escape($cc_clone).':'.$cloneonly.':'.
3083: &escape($createdbefore).':'.&escape($createdafter).':'.
3084: &escape($creationcontext),$tryserver);
1.918 raeburn 3085: my @pairs=split(/\&/,$rep);
3086: foreach my $item (@pairs) {
3087: my ($key,$value)=split(/\=/,$item,2);
3088: $key = &unescape($key);
3089: next if ($key =~ /^error: 2 /);
3090: my $result = &thaw_unescape($value);
3091: if (ref($result) eq 'HASH') {
3092: $returnhash{$key}=$result;
3093: } else {
1.921 raeburn 3094: my @responses = split(/:/,$value);
3095: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3096: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3097: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3098: }
1.1008 raeburn 3099: }
1.353 www 3100: }
3101: }
3102: }
3103: }
3104: return %returnhash;
3105: }
3106:
1.658 raeburn 3107: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3108:
3109: sub dcmailput {
1.685 raeburn 3110: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3111: my $status = &Apache::lonnet::critical(
1.740 www 3112: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3113: &escape($message),$server);
1.662 raeburn 3114: return $status;
3115: }
3116:
1.658 raeburn 3117: sub dcmaildump {
3118: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3119: my %returnhash=();
1.846 albertel 3120:
3121: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3122: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3123: &escape($enddate).':';
3124: my @esc_senders=map { &escape($_)} @$senders;
3125: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3126: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3127: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3128: if (($key) && ($value)) {
3129: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3130: }
3131: }
3132: }
3133: return %returnhash;
3134: }
1.662 raeburn 3135: # ---------------------------------------------------------- Domain roles
3136:
3137: sub get_domain_roles {
3138: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 3139: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 3140: $startdate = '.';
3141: }
1.1018 raeburn 3142: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 3143: $enddate = '.';
3144: }
1.922 raeburn 3145: my $rolelist;
3146: if (ref($roles) eq 'ARRAY') {
3147: $rolelist = join(':',@{$roles});
3148: }
1.662 raeburn 3149: my %personnel = ();
1.841 albertel 3150:
3151: my %servers = &get_servers($dom,'library');
3152: foreach my $tryserver (keys(%servers)) {
3153: %{$personnel{$tryserver}}=();
3154: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3155: &escape($startdate).':'.
3156: &escape($enddate).':'.
3157: &escape($rolelist), $tryserver))) {
3158: my ($key,$value) = split(/\=/,$line,2);
3159: if (($key) && ($value)) {
3160: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3161: }
3162: }
1.662 raeburn 3163: }
3164: return %personnel;
3165: }
1.658 raeburn 3166:
1.149 www 3167: # ----------------------------------------------------------- Check out an item
3168:
1.504 albertel 3169: sub get_first_access {
3170: my ($type,$argsymb)=@_;
1.790 albertel 3171: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3172: if ($argsymb) { $symb=$argsymb; }
3173: my ($map,$id,$res)=&decode_symb($symb);
1.926 albertel 3174: if ($type eq 'course') {
3175: $res='course';
3176: } elsif ($type eq 'map') {
1.588 albertel 3177: $res=&symbread($map);
3178: } else {
3179: $res=$symb;
3180: }
3181: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3182: return $times{"$courseid\0$res"};
1.504 albertel 3183: }
3184:
3185: sub set_first_access {
3186: my ($type)=@_;
1.790 albertel 3187: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3188: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 3189: if ($type eq 'course') {
3190: $res='course';
3191: } elsif ($type eq 'map') {
1.588 albertel 3192: $res=&symbread($map);
3193: } else {
3194: $res=$symb;
3195: }
3196: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 3197: if (!$firstaccess) {
1.588 albertel 3198: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 3199: }
3200: return 'already_set';
1.504 albertel 3201: }
3202:
1.149 www 3203: sub checkout {
3204: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3205: my $now=time;
3206: my $lonhost=$perlvar{'lonHostID'};
3207: my $infostr=&escape(
1.234 www 3208: 'CHECKOUTTOKEN&'.
1.149 www 3209: $tuname.'&'.
3210: $tudom.'&'.
3211: $tcrsid.'&'.
3212: $symb.'&'.
3213: $now.'&'.$ENV{'REMOTE_ADDR'});
3214: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 3215: if ($token=~/^error\:/) {
1.672 albertel 3216: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3217: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3218: "</font>");
3219: return '';
3220: }
3221:
1.149 www 3222: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3223: $token=~tr/a-z/A-Z/;
3224:
1.153 www 3225: my %infohash=('resource.0.outtoken' => $token,
3226: 'resource.0.checkouttime' => $now,
3227: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 3228:
3229: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3230: return '';
1.151 www 3231: } else {
1.672 albertel 3232: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3233: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3234: "</font>");
1.149 www 3235: }
3236:
3237: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3238: &escape('Checkout '.$infostr.' - '.
3239: $token)) ne 'ok') {
3240: return '';
1.151 www 3241: } else {
1.672 albertel 3242: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3243: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3244: "</font>");
1.149 www 3245: }
1.151 www 3246: return $token;
1.149 www 3247: }
3248:
3249: # ------------------------------------------------------------ Check in an item
3250:
3251: sub checkin {
3252: my $token=shift;
1.150 www 3253: my $now=time;
3254: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3255: $lonhost=~tr/A-Z/a-z/;
1.838 albertel 3256: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150 www 3257: $dtoken=~s/\W/\_/g;
1.234 www 3258: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 3259: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3260:
1.154 www 3261: unless (($tuname) && ($tudom)) {
3262: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3263: return '';
3264: }
3265:
3266: unless (&allowed('mgr',$tcrsid)) {
3267: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 3268: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 3269: return '';
3270: }
3271:
1.153 www 3272: my %infohash=('resource.0.intoken' => $token,
3273: 'resource.0.checkintime' => $now,
3274: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 3275:
3276: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3277: return '';
3278: }
3279:
3280: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3281: &escape('Checkin - '.$token)) ne 'ok') {
3282: return '';
3283: }
3284:
3285: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 3286: }
3287:
3288: # --------------------------------------------- Set Expire Date for Spreadsheet
3289:
3290: sub expirespread {
3291: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 3292: my $cid=$env{'request.course.id'};
1.110 www 3293: if ($cid) {
3294: my $now=time;
3295: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 3296: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3297: $env{'course.'.$cid.'.num'}.
1.110 www 3298: ':nohist_expirationdates:'.
3299: &escape($key).'='.$now,
1.620 albertel 3300: $env{'course.'.$cid.'.home'})
1.110 www 3301: }
3302: return 'ok';
1.14 www 3303: }
3304:
1.109 www 3305: # ----------------------------------------------------- Devalidate Spreadsheets
3306:
3307: sub devalidate {
1.325 www 3308: my ($symb,$uname,$udom)=@_;
1.620 albertel 3309: my $cid=$env{'request.course.id'};
1.109 www 3310: if ($cid) {
1.391 matthew 3311: # delete the stored spreadsheets for
3312: # - the student level sheet of this user in course's homespace
3313: # - the assessment level sheet for this resource
3314: # for this user in user's homespace
1.553 albertel 3315: # - current conditional state info
1.325 www 3316: my $key=$uname.':'.$udom.':';
1.109 www 3317: my $status=
1.299 matthew 3318: &del('nohist_calculatedsheets',
1.391 matthew 3319: [$key.'studentcalc:'],
1.620 albertel 3320: $env{'course.'.$cid.'.domain'},
3321: $env{'course.'.$cid.'.num'})
1.133 albertel 3322: .' '.
3323: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 3324: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 3325: unless ($status eq 'ok ok') {
3326: &logthis('Could not devalidate spreadsheet '.
1.325 www 3327: $uname.' at '.$udom.' for '.
1.109 www 3328: $symb.': '.$status);
1.133 albertel 3329: }
1.553 albertel 3330: &delenv('user.state.'.$cid);
1.109 www 3331: }
3332: }
3333:
1.265 albertel 3334: sub get_scalar {
3335: my ($string,$end) = @_;
3336: my $value;
3337: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3338: $value = $1;
3339: } elsif ($$string =~ s/^([^&]*?)&//) {
3340: $value = $1;
3341: }
3342: return &unescape($value);
3343: }
3344:
3345: sub array2str {
3346: my (@array) = @_;
3347: my $result=&arrayref2str(\@array);
3348: $result=~s/^__ARRAY_REF__//;
3349: $result=~s/__END_ARRAY_REF__$//;
3350: return $result;
3351: }
3352:
1.204 albertel 3353: sub arrayref2str {
3354: my ($arrayref) = @_;
1.265 albertel 3355: my $result='__ARRAY_REF__';
1.204 albertel 3356: foreach my $elem (@$arrayref) {
1.265 albertel 3357: if(ref($elem) eq 'ARRAY') {
3358: $result.=&arrayref2str($elem).'&';
3359: } elsif(ref($elem) eq 'HASH') {
3360: $result.=&hashref2str($elem).'&';
3361: } elsif(ref($elem)) {
3362: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 3363: } else {
3364: $result.=&escape($elem).'&';
3365: }
3366: }
3367: $result=~s/\&$//;
1.265 albertel 3368: $result .= '__END_ARRAY_REF__';
1.204 albertel 3369: return $result;
3370: }
3371:
1.168 albertel 3372: sub hash2str {
1.204 albertel 3373: my (%hash) = @_;
3374: my $result=&hashref2str(\%hash);
1.265 albertel 3375: $result=~s/^__HASH_REF__//;
3376: $result=~s/__END_HASH_REF__$//;
1.204 albertel 3377: return $result;
3378: }
3379:
3380: sub hashref2str {
3381: my ($hashref)=@_;
1.265 albertel 3382: my $result='__HASH_REF__';
1.800 albertel 3383: foreach my $key (sort(keys(%$hashref))) {
3384: if (ref($key) eq 'ARRAY') {
3385: $result.=&arrayref2str($key).'=';
3386: } elsif (ref($key) eq 'HASH') {
3387: $result.=&hashref2str($key).'=';
3388: } elsif (ref($key)) {
1.265 albertel 3389: $result.='=';
1.800 albertel 3390: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 3391: } else {
1.800 albertel 3392: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 3393: }
3394:
1.800 albertel 3395: if(ref($hashref->{$key}) eq 'ARRAY') {
3396: $result.=&arrayref2str($hashref->{$key}).'&';
3397: } elsif(ref($hashref->{$key}) eq 'HASH') {
3398: $result.=&hashref2str($hashref->{$key}).'&';
3399: } elsif(ref($hashref->{$key})) {
1.265 albertel 3400: $result.='&';
1.800 albertel 3401: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 3402: } else {
1.800 albertel 3403: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 3404: }
3405: }
1.168 albertel 3406: $result=~s/\&$//;
1.265 albertel 3407: $result .= '__END_HASH_REF__';
1.168 albertel 3408: return $result;
3409: }
3410:
3411: sub str2hash {
1.265 albertel 3412: my ($string)=@_;
3413: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3414: return %$hash;
3415: }
3416:
3417: sub str2hashref {
1.168 albertel 3418: my ($string) = @_;
1.265 albertel 3419:
3420: my %hash;
3421:
3422: if($string !~ /^__HASH_REF__/) {
3423: if (! ($string eq '' || !defined($string))) {
3424: $hash{'error'}='Not hash reference';
3425: }
3426: return (\%hash, $string);
3427: }
3428:
3429: $string =~ s/^__HASH_REF__//;
3430:
3431: while($string !~ /^__END_HASH_REF__/) {
3432: #key
3433: my $key='';
3434: if($string =~ /^__HASH_REF__/) {
3435: ($key, $string)=&str2hashref($string);
3436: if(defined($key->{'error'})) {
3437: $hash{'error'}='Bad data';
3438: return (\%hash, $string);
3439: }
3440: } elsif($string =~ /^__ARRAY_REF__/) {
3441: ($key, $string)=&str2arrayref($string);
3442: if($key->[0] eq 'Array reference error') {
3443: $hash{'error'}='Bad data';
3444: return (\%hash, $string);
3445: }
3446: } else {
3447: $string =~ s/^(.*?)=//;
1.267 albertel 3448: $key=&unescape($1);
1.265 albertel 3449: }
3450: $string =~ s/^=//;
3451:
3452: #value
3453: my $value='';
3454: if($string =~ /^__HASH_REF__/) {
3455: ($value, $string)=&str2hashref($string);
3456: if(defined($value->{'error'})) {
3457: $hash{'error'}='Bad data';
3458: return (\%hash, $string);
3459: }
3460: } elsif($string =~ /^__ARRAY_REF__/) {
3461: ($value, $string)=&str2arrayref($string);
3462: if($value->[0] eq 'Array reference error') {
3463: $hash{'error'}='Bad data';
3464: return (\%hash, $string);
3465: }
3466: } else {
3467: $value=&get_scalar(\$string,'__END_HASH_REF__');
3468: }
3469: $string =~ s/^&//;
3470:
3471: $hash{$key}=$value;
1.204 albertel 3472: }
1.265 albertel 3473:
3474: $string =~ s/^__END_HASH_REF__//;
3475:
3476: return (\%hash, $string);
1.204 albertel 3477: }
3478:
3479: sub str2array {
1.265 albertel 3480: my ($string)=@_;
3481: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3482: return @$array;
3483: }
3484:
3485: sub str2arrayref {
1.204 albertel 3486: my ($string) = @_;
1.265 albertel 3487: my @array;
3488:
3489: if($string !~ /^__ARRAY_REF__/) {
3490: if (! ($string eq '' || !defined($string))) {
3491: $array[0]='Array reference error';
3492: }
3493: return (\@array, $string);
3494: }
3495:
3496: $string =~ s/^__ARRAY_REF__//;
3497:
3498: while($string !~ /^__END_ARRAY_REF__/) {
3499: my $value='';
3500: if($string =~ /^__HASH_REF__/) {
3501: ($value, $string)=&str2hashref($string);
3502: if(defined($value->{'error'})) {
3503: $array[0] ='Array reference error';
3504: return (\@array, $string);
3505: }
3506: } elsif($string =~ /^__ARRAY_REF__/) {
3507: ($value, $string)=&str2arrayref($string);
3508: if($value->[0] eq 'Array reference error') {
3509: $array[0] ='Array reference error';
3510: return (\@array, $string);
3511: }
3512: } else {
3513: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3514: }
3515: $string =~ s/^&//;
3516:
3517: push(@array, $value);
1.191 harris41 3518: }
1.265 albertel 3519:
3520: $string =~ s/^__END_ARRAY_REF__//;
3521:
3522: return (\@array, $string);
1.168 albertel 3523: }
3524:
1.167 albertel 3525: # -------------------------------------------------------------------Temp Store
3526:
1.168 albertel 3527: sub tmpreset {
3528: my ($symb,$namespace,$domain,$stuname) = @_;
3529: if (!$symb) {
3530: $symb=&symbread();
1.620 albertel 3531: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3532: }
3533: $symb=escape($symb);
3534:
1.620 albertel 3535: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3536: $namespace=~s/\//\_/g;
3537: $namespace=~s/\W//g;
3538:
1.620 albertel 3539: if (!$domain) { $domain=$env{'user.domain'}; }
3540: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3541: if ($domain eq 'public' && $stuname eq 'public') {
3542: $stuname=$ENV{'REMOTE_ADDR'};
3543: }
1.168 albertel 3544: my $path=$perlvar{'lonDaemons'}.'/tmp';
3545: my %hash;
3546: if (tie(%hash,'GDBM_File',
3547: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3548: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 3549: foreach my $key (keys(%hash)) {
1.180 albertel 3550: if ($key=~ /:$symb/) {
1.168 albertel 3551: delete($hash{$key});
3552: }
3553: }
3554: }
3555: }
3556:
1.167 albertel 3557: sub tmpstore {
1.168 albertel 3558: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3559:
3560: if (!$symb) {
3561: $symb=&symbread();
1.620 albertel 3562: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3563: }
3564: $symb=escape($symb);
3565:
3566: if (!$namespace) {
3567: # I don't think we would ever want to store this for a course.
3568: # it seems this will only be used if we don't have a course.
1.620 albertel 3569: #$namespace=$env{'request.course.id'};
1.168 albertel 3570: #if (!$namespace) {
1.620 albertel 3571: $namespace=$env{'request.state'};
1.168 albertel 3572: #}
3573: }
3574: $namespace=~s/\//\_/g;
3575: $namespace=~s/\W//g;
1.620 albertel 3576: if (!$domain) { $domain=$env{'user.domain'}; }
3577: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3578: if ($domain eq 'public' && $stuname eq 'public') {
3579: $stuname=$ENV{'REMOTE_ADDR'};
3580: }
1.168 albertel 3581: my $now=time;
3582: my %hash;
3583: my $path=$perlvar{'lonDaemons'}.'/tmp';
3584: if (tie(%hash,'GDBM_File',
3585: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3586: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3587: $hash{"version:$symb"}++;
3588: my $version=$hash{"version:$symb"};
3589: my $allkeys='';
3590: foreach my $key (keys(%$storehash)) {
3591: $allkeys.=$key.':';
1.591 albertel 3592: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3593: }
3594: $hash{"$version:$symb:timestamp"}=$now;
3595: $allkeys.='timestamp';
3596: $hash{"$version:keys:$symb"}=$allkeys;
3597: if (untie(%hash)) {
3598: return 'ok';
3599: } else {
3600: return "error:$!";
3601: }
3602: } else {
3603: return "error:$!";
3604: }
3605: }
1.167 albertel 3606:
1.168 albertel 3607: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3608:
1.168 albertel 3609: sub tmprestore {
3610: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3611:
1.168 albertel 3612: if (!$symb) {
3613: $symb=&symbread();
1.620 albertel 3614: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3615: }
3616: $symb=escape($symb);
3617:
1.620 albertel 3618: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3619:
1.620 albertel 3620: if (!$domain) { $domain=$env{'user.domain'}; }
3621: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3622: if ($domain eq 'public' && $stuname eq 'public') {
3623: $stuname=$ENV{'REMOTE_ADDR'};
3624: }
1.168 albertel 3625: my %returnhash;
3626: $namespace=~s/\//\_/g;
3627: $namespace=~s/\W//g;
3628: my %hash;
3629: my $path=$perlvar{'lonDaemons'}.'/tmp';
3630: if (tie(%hash,'GDBM_File',
3631: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3632: &GDBM_READER(),0640)) {
1.168 albertel 3633: my $version=$hash{"version:$symb"};
3634: $returnhash{'version'}=$version;
3635: my $scope;
3636: for ($scope=1;$scope<=$version;$scope++) {
3637: my $vkeys=$hash{"$scope:keys:$symb"};
3638: my @keys=split(/:/,$vkeys);
3639: my $key;
3640: $returnhash{"$scope:keys"}=$vkeys;
3641: foreach $key (@keys) {
1.591 albertel 3642: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3643: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3644: }
3645: }
1.168 albertel 3646: if (!(untie(%hash))) {
3647: return "error:$!";
3648: }
3649: } else {
3650: return "error:$!";
3651: }
3652: return %returnhash;
1.167 albertel 3653: }
3654:
1.9 www 3655: # ----------------------------------------------------------------------- Store
3656:
3657: sub store {
1.124 www 3658: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3659: my $home='';
3660:
1.168 albertel 3661: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3662:
1.213 www 3663: $symb=&symbclean($symb);
1.122 albertel 3664: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3665:
1.620 albertel 3666: if (!$domain) { $domain=$env{'user.domain'}; }
3667: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3668:
3669: &devalidate($symb,$stuname,$domain);
1.109 www 3670:
3671: $symb=escape($symb);
1.187 www 3672: if (!$namespace) {
1.620 albertel 3673: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3674: return '';
3675: }
3676: }
1.620 albertel 3677: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3678:
3679: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3680: $$storehash{'host'}=$perlvar{'lonHostID'};
3681:
1.12 www 3682: my $namevalue='';
1.800 albertel 3683: foreach my $key (keys(%$storehash)) {
3684: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3685: }
1.12 www 3686: $namevalue=~s/\&$//;
1.187 www 3687: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3688: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3689: }
3690:
1.47 www 3691: # -------------------------------------------------------------- Critical Store
3692:
3693: sub cstore {
1.124 www 3694: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3695: my $home='';
3696:
1.168 albertel 3697: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3698:
1.213 www 3699: $symb=&symbclean($symb);
1.122 albertel 3700: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3701:
1.620 albertel 3702: if (!$domain) { $domain=$env{'user.domain'}; }
3703: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3704:
3705: &devalidate($symb,$stuname,$domain);
1.109 www 3706:
3707: $symb=escape($symb);
1.187 www 3708: if (!$namespace) {
1.620 albertel 3709: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3710: return '';
3711: }
3712: }
1.620 albertel 3713: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3714:
3715: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3716: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3717:
1.47 www 3718: my $namevalue='';
1.800 albertel 3719: foreach my $key (keys(%$storehash)) {
3720: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3721: }
1.47 www 3722: $namevalue=~s/\&$//;
1.187 www 3723: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3724: return critical
3725: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3726: }
3727:
1.9 www 3728: # --------------------------------------------------------------------- Restore
3729:
3730: sub restore {
1.124 www 3731: my ($symb,$namespace,$domain,$stuname) = @_;
3732: my $home='';
3733:
1.168 albertel 3734: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3735:
1.122 albertel 3736: if (!$symb) {
3737: unless ($symb=escape(&symbread())) { return ''; }
3738: } else {
1.213 www 3739: $symb=&escape(&symbclean($symb));
1.122 albertel 3740: }
1.188 www 3741: if (!$namespace) {
1.620 albertel 3742: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3743: return '';
3744: }
3745: }
1.620 albertel 3746: if (!$domain) { $domain=$env{'user.domain'}; }
3747: if (!$stuname) { $stuname=$env{'user.name'}; }
3748: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3749: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3750:
1.12 www 3751: my %returnhash=();
1.800 albertel 3752: foreach my $line (split(/\&/,$answer)) {
3753: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3754: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3755: }
1.75 www 3756: my $version;
3757: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3758: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3759: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3760: }
1.75 www 3761: }
1.13 www 3762: return %returnhash;
1.34 www 3763: }
3764:
3765: # ---------------------------------------------------------- Course Description
3766:
3767: sub coursedescription {
1.731 albertel 3768: my ($courseid,$args)=@_;
1.34 www 3769: $courseid=~s/^\///;
1.49 www 3770: $courseid=~s/\_/\//g;
1.34 www 3771: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3772: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3773: my $normalid=$cdomain.'_'.$cnum;
3774: # need to always cache even if we get errors otherwise we keep
3775: # trying and trying and trying to get the course description.
3776: my %envhash=();
3777: my %returnhash=();
1.731 albertel 3778:
3779: my $expiretime=600;
3780: if ($env{'request.course.id'} eq $normalid) {
3781: $expiretime=120;
3782: }
3783:
3784: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3785: if (!$args->{'freshen_cache'}
3786: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3787: foreach my $key (keys(%env)) {
3788: next if ($key !~ /^\Q$prefix\E(.*)/);
3789: my ($setting) = $1;
3790: $returnhash{$setting} = $env{$key};
3791: }
3792: return %returnhash;
3793: }
3794:
3795: # get the data agin
3796: if (!$args->{'one_time'}) {
3797: $envhash{'course.'.$normalid.'.last_cache'}=time;
3798: }
1.811 albertel 3799:
1.34 www 3800: if ($chome ne 'no_host') {
1.302 albertel 3801: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3802: if (!exists($returnhash{'con_lost'})) {
3803: $returnhash{'home'}= $chome;
3804: $returnhash{'domain'} = $cdomain;
3805: $returnhash{'num'} = $cnum;
1.741 raeburn 3806: if (!defined($returnhash{'type'})) {
3807: $returnhash{'type'} = 'Course';
3808: }
1.130 albertel 3809: while (my ($name,$value) = each %returnhash) {
1.53 www 3810: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3811: }
1.270 www 3812: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3813: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3814: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3815: $envhash{'course.'.$normalid.'.home'}=$chome;
3816: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3817: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3818: }
3819: }
1.731 albertel 3820: if (!$args->{'one_time'}) {
1.949 raeburn 3821: &appenv(\%envhash);
1.731 albertel 3822: }
1.302 albertel 3823: return %returnhash;
1.461 www 3824: }
3825:
3826: # -------------------------------------------------See if a user is privileged
3827:
3828: sub privileged {
3829: my ($username,$domain)=@_;
3830: my $rolesdump=&reply("dump:$domain:$username:roles",
3831: &homeserver($username,$domain));
1.1033 raeburn 3832: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3833: ($rolesdump =~ /^error:/)) {
3834: return 0;
3835: }
1.461 www 3836: my $now=time;
3837: if ($rolesdump ne '') {
1.800 albertel 3838: foreach my $entry (split(/&/,$rolesdump)) {
3839: if ($entry!~/^rolesdef_/) {
3840: my ($area,$role)=split(/=/,$entry);
1.461 www 3841: $area=~s/\_\w\w$//;
3842: my ($trole,$tend,$tstart)=split(/_/,$role);
3843: if (($trole eq 'dc') || ($trole eq 'su')) {
3844: my $active=1;
3845: if ($tend) {
3846: if ($tend<$now) { $active=0; }
3847: }
3848: if ($tstart) {
3849: if ($tstart>$now) { $active=0; }
3850: }
3851: if ($active) { return 1; }
3852: }
3853: }
3854: }
3855: }
3856: return 0;
1.9 www 3857: }
1.1 albertel 3858:
1.103 harris41 3859: # -------------------------------------------------------- Get user privileges
1.11 www 3860:
3861: sub rolesinit {
3862: my ($domain,$username,$authhost)=@_;
1.1034 raeburn 3863: my $now=time;
3864: my %userroles = ('user.login.time' => $now);
1.11 www 3865: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.1033 raeburn 3866: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3867: ($rolesdump =~ /^error:/)) {
3868: return \%userroles;
3869: }
1.11 www 3870: my %allroles=();
1.678 raeburn 3871: my %allgroups=();
3872: my $group_privs;
1.11 www 3873:
3874: if ($rolesdump ne '') {
1.800 albertel 3875: foreach my $entry (split(/&/,$rolesdump)) {
3876: if ($entry!~/^rolesdef_/) {
3877: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3878: $area=~s/\_\w\w$//;
1.678 raeburn 3879: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3880: if ($role=~/^cr/) {
1.807 albertel 3881: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3882: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3883: ($tend,$tstart)=split('_',$trest);
3884: } else {
3885: $trole=$role;
3886: }
1.678 raeburn 3887: } elsif ($role =~ m|^gr/|) {
3888: ($trole,$tend,$tstart) = split(/_/,$role);
3889: ($trole,$group_privs) = split(/\//,$trole);
3890: $group_privs = &unescape($group_privs);
1.587 albertel 3891: } else {
3892: ($trole,$tend,$tstart)=split(/_/,$role);
3893: }
1.743 albertel 3894: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3895: $username);
3896: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3897: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3898: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3899: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3900: my $spec=$trole.'.'.$area;
3901: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3902: if ($trole =~ /^cr\//) {
1.567 raeburn 3903: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3904: } elsif ($trole eq 'gr') {
3905: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3906: } else {
1.567 raeburn 3907: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3908: }
1.12 www 3909: }
1.662 raeburn 3910: }
1.191 harris41 3911: }
1.743 albertel 3912: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3913: $userroles{'user.adv'} = $adv;
3914: $userroles{'user.author'} = $author;
1.620 albertel 3915: $env{'user.adv'}=$adv;
1.11 www 3916: }
1.743 albertel 3917: return \%userroles;
1.11 www 3918: }
3919:
1.567 raeburn 3920: sub set_arearole {
3921: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3922: # log the associated role with the area
3923: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3924: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3925: }
3926:
3927: sub custom_roleprivs {
3928: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3929: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3930: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3931: if (&hostname($homsvr) ne '') {
1.567 raeburn 3932: my ($rdummy,$roledef)=
3933: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3934: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3935: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3936: if (defined($syspriv)) {
1.1043 raeburn 3937: if ($trest =~ /^$match_community$/) {
3938: $syspriv =~ s/bre\&S//;
3939: }
1.567 raeburn 3940: $$allroles{'cm./'}.=':'.$syspriv;
3941: $$allroles{$spec.'./'}.=':'.$syspriv;
3942: }
3943: if ($tdomain ne '') {
3944: if (defined($dompriv)) {
3945: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3946: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3947: }
3948: if (($trest ne '') && (defined($coursepriv))) {
3949: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3950: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3951: }
3952: }
3953: }
3954: }
3955: }
3956:
1.678 raeburn 3957: sub group_roleprivs {
3958: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
3959: my $access = 1;
3960: my $now = time;
3961: if (($tend!=0) && ($tend<$now)) { $access = 0; }
3962: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
3963: if ($access) {
1.811 albertel 3964: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 3965: $$allgroups{$course}{$group} .=':'.$group_privs;
3966: }
3967: }
1.567 raeburn 3968:
3969: sub standard_roleprivs {
3970: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
3971: if (defined($pr{$trole.':s'})) {
3972: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
3973: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
3974: }
3975: if ($tdomain ne '') {
3976: if (defined($pr{$trole.':d'})) {
3977: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3978: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
3979: }
3980: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
3981: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
3982: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
3983: }
3984: }
3985: }
3986:
3987: sub set_userprivs {
1.678 raeburn 3988: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 3989: my $author=0;
3990: my $adv=0;
1.678 raeburn 3991: my %grouproles = ();
3992: if (keys(%{$allgroups}) > 0) {
1.1000 raeburn 3993: foreach my $role (keys(%{$allroles})) {
1.681 raeburn 3994: my ($trole,$area,$sec,$extendedarea);
1.881 raeburn 3995: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
1.678 raeburn 3996: $trole = $1;
3997: $area = $2;
1.681 raeburn 3998: $sec = $3;
3999: $extendedarea = $area.$sec;
4000: if (exists($$allgroups{$area})) {
4001: foreach my $group (keys(%{$$allgroups{$area}})) {
4002: my $spec = $trole.'.'.$extendedarea;
4003: $grouproles{$spec.'.'.$area.'/'.$group} =
4004: $$allgroups{$area}{$group};
1.678 raeburn 4005: }
4006: }
4007: }
4008: }
4009: }
1.800 albertel 4010: foreach my $group (keys(%grouproles)) {
4011: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 4012: }
1.800 albertel 4013: foreach my $role (keys(%{$allroles})) {
4014: my %thesepriv;
1.941 raeburn 4015: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 4016: foreach my $item (split(/:/,$$allroles{$role})) {
4017: if ($item ne '') {
4018: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 4019: if ($restrictions eq '') {
4020: $thesepriv{$privilege}='F';
4021: } elsif ($thesepriv{$privilege} ne 'F') {
4022: $thesepriv{$privilege}.=$restrictions;
4023: }
4024: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4025: }
4026: }
4027: my $thesestr='';
1.800 albertel 4028: foreach my $priv (keys(%thesepriv)) {
4029: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4030: }
4031: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 4032: }
4033: return ($author,$adv);
4034: }
4035:
1.994 raeburn 4036: sub role_status {
1.1002 raeburn 4037: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 4038: my @pwhere = ();
4039: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4040: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4041: unless (!defined($$role) || $$role eq '') {
4042: $$where=join('.',@pwhere);
4043: $$trolecode=$$role.'.'.$$where;
4044: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4045: $$tstatus='is';
4046: if ($$tstart && $$tstart>$then) {
4047: $$tstatus='future';
1.1034 raeburn 4048: if ($$tstart<$now) {
4049: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 4050: if (($$where ne '') && ($$role ne '')) {
4051: my (%allroles,%allgroups,$group_privs);
4052: my %userroles = (
4053: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4054: );
4055: my $spec=$$role.'.'.$$where;
4056: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4057: if ($$role =~ /^cr\//) {
4058: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4059: } elsif ($$role eq 'gr') {
4060: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4061: $env{'user.name'});
4062: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
4063: (undef,my $group_privs) = split(/\//,$trole);
4064: $group_privs = &unescape($group_privs);
4065: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4066: } else {
4067: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4068: }
4069: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
4070: &appenv(\%userroles,[$$role,'cm']);
4071: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4072: }
4073: }
1.1034 raeburn 4074: $$tstatus = 'is';
1.1002 raeburn 4075: }
1.994 raeburn 4076: }
4077: if ($$tend) {
4078: if ($$tend<$then) {
4079: $$tstatus='expired';
4080: } elsif ($$tend<$now) {
4081: $$tstatus='will_not';
4082: }
4083: }
4084: }
4085: }
4086: }
4087:
4088: sub check_adhoc_privs {
1.1002 raeburn 4089: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994 raeburn 4090: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4091: if ($env{$cckey}) {
4092: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002 raeburn 4093: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 4094: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4095: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4096: }
4097: } else {
4098: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4099: }
4100: }
4101:
4102: sub set_adhoc_privileges {
4103: # role can be cc or ca
4104: my ($dcdom,$pickedcourse,$role) = @_;
4105: my $area = '/'.$dcdom.'/'.$pickedcourse;
4106: my $spec = $role.'.'.$area;
4107: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4108: $env{'user.name'});
4109: my %ccrole = ();
4110: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4111: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4112: &appenv(\%userroles,[$role,'cm']);
4113: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4114: &appenv( {'request.role' => $spec,
4115: 'request.role.domain' => $dcdom,
4116: 'request.course.sec' => ''
4117: }
4118: );
4119: my $tadv=0;
4120: if (&allowed('adv') eq 'F') { $tadv=1; }
4121: &appenv({'request.role.adv' => $tadv});
4122: }
4123:
1.12 www 4124: # --------------------------------------------------------------- get interface
4125:
4126: sub get {
1.131 albertel 4127: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4128: my $items='';
1.800 albertel 4129: foreach my $item (@$storearr) {
4130: $items.=&escape($item).'&';
1.191 harris41 4131: }
1.12 www 4132: $items=~s/\&$//;
1.620 albertel 4133: if (!$udomain) { $udomain=$env{'user.domain'}; }
4134: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 4135: my $uhome=&homeserver($uname,$udomain);
4136:
1.133 albertel 4137: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4138: my @pairs=split(/\&/,$rep);
1.273 albertel 4139: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4140: return @pairs;
4141: }
1.15 www 4142: my %returnhash=();
1.42 www 4143: my $i=0;
1.800 albertel 4144: foreach my $item (@$storearr) {
4145: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4146: $i++;
1.191 harris41 4147: }
1.15 www 4148: return %returnhash;
1.27 www 4149: }
4150:
4151: # --------------------------------------------------------------- del interface
4152:
4153: sub del {
1.133 albertel 4154: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 4155: my $items='';
1.800 albertel 4156: foreach my $item (@$storearr) {
4157: $items.=&escape($item).'&';
1.191 harris41 4158: }
1.984 neumanie 4159:
1.27 www 4160: $items=~s/\&$//;
1.620 albertel 4161: if (!$udomain) { $udomain=$env{'user.domain'}; }
4162: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4163: my $uhome=&homeserver($uname,$udomain);
4164: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4165: }
4166:
4167: # -------------------------------------------------------------- dump interface
4168:
4169: sub dump {
1.755 albertel 4170: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4171: if (!$udomain) { $udomain=$env{'user.domain'}; }
4172: if (!$uname) { $uname=$env{'user.name'}; }
4173: my $uhome=&homeserver($uname,$udomain);
4174: if ($regexp) {
4175: $regexp=&escape($regexp);
4176: } else {
4177: $regexp='.';
4178: }
4179: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4180: my @pairs=split(/\&/,$rep);
4181: my %returnhash=();
4182: foreach my $item (@pairs) {
4183: my ($key,$value)=split(/=/,$item,2);
4184: $key = &unescape($key);
4185: next if ($key =~ /^error: 2 /);
4186: $returnhash{$key}=&thaw_unescape($value);
4187: }
4188: return %returnhash;
1.407 www 4189: }
4190:
1.717 albertel 4191: # --------------------------------------------------------- dumpstore interface
4192:
4193: sub dumpstore {
4194: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 4195: if (!$udomain) { $udomain=$env{'user.domain'}; }
4196: if (!$uname) { $uname=$env{'user.name'}; }
4197: my $uhome=&homeserver($uname,$udomain);
4198: if ($regexp) {
4199: $regexp=&escape($regexp);
4200: } else {
4201: $regexp='.';
4202: }
4203: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4204: my @pairs=split(/\&/,$rep);
4205: my %returnhash=();
4206: foreach my $item (@pairs) {
4207: my ($key,$value)=split(/=/,$item,2);
4208: next if ($key =~ /^error: 2 /);
4209: $returnhash{$key}=&thaw_unescape($value);
4210: }
4211: return %returnhash;
1.717 albertel 4212: }
4213:
1.407 www 4214: # -------------------------------------------------------------- keys interface
4215:
4216: sub getkeys {
4217: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 4218: if (!$udomain) { $udomain=$env{'user.domain'}; }
4219: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 4220: my $uhome=&homeserver($uname,$udomain);
4221: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4222: my @keyarray=();
1.800 albertel 4223: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 4224: next if ($key =~ /^error: 2 /);
1.800 albertel 4225: push(@keyarray,&unescape($key));
1.407 www 4226: }
4227: return @keyarray;
1.318 matthew 4228: }
4229:
1.319 matthew 4230: # --------------------------------------------------------------- currentdump
4231: sub currentdump {
1.328 matthew 4232: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 4233: $courseid = $env{'request.course.id'} if (! defined($courseid));
4234: $sdom = $env{'user.domain'} if (! defined($sdom));
4235: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 4236: my $uhome = &homeserver($sname,$sdom);
4237: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 4238: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 4239: #
1.318 matthew 4240: my %returnhash=();
1.319 matthew 4241: #
4242: if ($rep eq "unknown_cmd") {
4243: # an old lond will not know currentdump
4244: # Do a dump and make it look like a currentdump
1.822 albertel 4245: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 4246: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4247: my %hash = @tmp;
4248: @tmp=();
1.424 matthew 4249: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 4250: } else {
4251: my @pairs=split(/\&/,$rep);
1.800 albertel 4252: foreach my $pair (@pairs) {
4253: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 4254: my ($symb,$param) = split(/:/,$key);
4255: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 4256: &thaw_unescape($value);
1.319 matthew 4257: }
1.191 harris41 4258: }
1.12 www 4259: return %returnhash;
1.424 matthew 4260: }
4261:
4262: sub convert_dump_to_currentdump{
4263: my %hash = %{shift()};
4264: my %returnhash;
4265: # Code ripped from lond, essentially. The only difference
4266: # here is the unescaping done by lonnet::dump(). Conceivably
4267: # we might run in to problems with parameter names =~ /^v\./
4268: while (my ($key,$value) = each(%hash)) {
4269: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 4270: $symb = &unescape($symb);
4271: $param = &unescape($param);
1.424 matthew 4272: next if ($v eq 'version' || $symb eq 'keys');
4273: next if (exists($returnhash{$symb}) &&
4274: exists($returnhash{$symb}->{$param}) &&
4275: $returnhash{$symb}->{'v.'.$param} > $v);
4276: $returnhash{$symb}->{$param}=$value;
4277: $returnhash{$symb}->{'v.'.$param}=$v;
4278: }
4279: #
4280: # Remove all of the keys in the hashes which keep track of
4281: # the version of the parameter.
4282: while (my ($symb,$param_hash) = each(%returnhash)) {
4283: # use a foreach because we are going to delete from the hash.
4284: foreach my $key (keys(%$param_hash)) {
4285: delete($param_hash->{$key}) if ($key =~ /^v\./);
4286: }
4287: }
4288: return \%returnhash;
1.12 www 4289: }
4290:
1.627 albertel 4291: # ------------------------------------------------------ critical inc interface
4292:
4293: sub cinc {
4294: return &inc(@_,'critical');
4295: }
4296:
1.449 matthew 4297: # --------------------------------------------------------------- inc interface
4298:
4299: sub inc {
1.627 albertel 4300: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 4301: if (!$udomain) { $udomain=$env{'user.domain'}; }
4302: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 4303: my $uhome=&homeserver($uname,$udomain);
4304: my $items='';
4305: if (! ref($store)) {
4306: # got a single value, so use that instead
4307: $items = &escape($store).'=&';
4308: } elsif (ref($store) eq 'SCALAR') {
4309: $items = &escape($$store).'=&';
4310: } elsif (ref($store) eq 'ARRAY') {
4311: $items = join('=&',map {&escape($_);} @{$store});
4312: } elsif (ref($store) eq 'HASH') {
4313: while (my($key,$value) = each(%{$store})) {
4314: $items.= &escape($key).'='.&escape($value).'&';
4315: }
4316: }
4317: $items=~s/\&$//;
1.627 albertel 4318: if ($critical) {
4319: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4320: } else {
4321: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4322: }
1.449 matthew 4323: }
4324:
1.12 www 4325: # --------------------------------------------------------------- put interface
4326:
4327: sub put {
1.134 albertel 4328: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4329: if (!$udomain) { $udomain=$env{'user.domain'}; }
4330: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4331: my $uhome=&homeserver($uname,$udomain);
1.12 www 4332: my $items='';
1.800 albertel 4333: foreach my $item (keys(%$storehash)) {
4334: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4335: }
1.12 www 4336: $items=~s/\&$//;
1.134 albertel 4337: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 4338: }
4339:
1.631 albertel 4340: # ------------------------------------------------------------ newput interface
4341:
4342: sub newput {
4343: my ($namespace,$storehash,$udomain,$uname)=@_;
4344: if (!$udomain) { $udomain=$env{'user.domain'}; }
4345: if (!$uname) { $uname=$env{'user.name'}; }
4346: my $uhome=&homeserver($uname,$udomain);
4347: my $items='';
4348: foreach my $key (keys(%$storehash)) {
4349: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4350: }
4351: $items=~s/\&$//;
4352: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4353: }
4354:
4355: # --------------------------------------------------------- putstore interface
4356:
1.524 raeburn 4357: sub putstore {
1.715 albertel 4358: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 4359: if (!$udomain) { $udomain=$env{'user.domain'}; }
4360: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 4361: my $uhome=&homeserver($uname,$udomain);
4362: my $items='';
1.715 albertel 4363: foreach my $key (keys(%$storehash)) {
4364: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 4365: }
1.715 albertel 4366: $items=~s/\&$//;
1.716 albertel 4367: my $esc_symb=&escape($symb);
4368: my $esc_v=&escape($version);
1.715 albertel 4369: my $reply =
1.716 albertel 4370: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 4371: $uhome);
4372: if ($reply eq 'unknown_cmd') {
1.716 albertel 4373: # gfall back to way things use to be done
1.715 albertel 4374: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4375: $uname);
1.524 raeburn 4376: }
1.715 albertel 4377: return $reply;
4378: }
4379:
4380: sub old_putstore {
1.716 albertel 4381: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4382: if (!$udomain) { $udomain=$env{'user.domain'}; }
4383: if (!$uname) { $uname=$env{'user.name'}; }
4384: my $uhome=&homeserver($uname,$udomain);
4385: my %newstorehash;
1.800 albertel 4386: foreach my $item (keys(%$storehash)) {
4387: my $key = $version.':'.&escape($symb).':'.$item;
4388: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 4389: }
4390: my $items='';
4391: my %allitems = ();
1.800 albertel 4392: foreach my $item (keys(%newstorehash)) {
4393: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 4394: my $key = $1.':keys:'.$2;
4395: $allitems{$key} .= $3.':';
4396: }
1.800 albertel 4397: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 4398: }
1.800 albertel 4399: foreach my $item (keys(%allitems)) {
4400: $allitems{$item} =~ s/\:$//;
4401: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 4402: }
4403: $items=~s/\&$//;
4404: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 4405: }
4406:
1.47 www 4407: # ------------------------------------------------------ critical put interface
4408:
4409: sub cput {
1.134 albertel 4410: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4411: if (!$udomain) { $udomain=$env{'user.domain'}; }
4412: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4413: my $uhome=&homeserver($uname,$udomain);
1.47 www 4414: my $items='';
1.800 albertel 4415: foreach my $item (keys(%$storehash)) {
4416: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4417: }
1.47 www 4418: $items=~s/\&$//;
1.134 albertel 4419: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4420: }
4421:
4422: # -------------------------------------------------------------- eget interface
4423:
4424: sub eget {
1.133 albertel 4425: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4426: my $items='';
1.800 albertel 4427: foreach my $item (@$storearr) {
4428: $items.=&escape($item).'&';
1.191 harris41 4429: }
1.12 www 4430: $items=~s/\&$//;
1.620 albertel 4431: if (!$udomain) { $udomain=$env{'user.domain'}; }
4432: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4433: my $uhome=&homeserver($uname,$udomain);
4434: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4435: my @pairs=split(/\&/,$rep);
4436: my %returnhash=();
1.42 www 4437: my $i=0;
1.800 albertel 4438: foreach my $item (@$storearr) {
4439: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4440: $i++;
1.191 harris41 4441: }
1.12 www 4442: return %returnhash;
4443: }
4444:
1.667 albertel 4445: # ------------------------------------------------------------ tmpput interface
4446: sub tmpput {
1.802 raeburn 4447: my ($storehash,$server,$context)=@_;
1.667 albertel 4448: my $items='';
1.800 albertel 4449: foreach my $item (keys(%$storehash)) {
4450: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 4451: }
4452: $items=~s/\&$//;
1.802 raeburn 4453: if (defined($context)) {
4454: $items .= ':'.&escape($context);
4455: }
1.667 albertel 4456: return &reply("tmpput:$items",$server);
4457: }
4458:
4459: # ------------------------------------------------------------ tmpget interface
4460: sub tmpget {
1.688 albertel 4461: my ($token,$server)=@_;
4462: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4463: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 4464: my %returnhash;
4465: foreach my $item (split(/\&/,$rep)) {
4466: my ($key,$value)=split(/=/,$item);
1.951 raeburn 4467: next if ($key =~ /^error: 2 /);
1.667 albertel 4468: $returnhash{&unescape($key)}=&thaw_unescape($value);
4469: }
4470: return %returnhash;
4471: }
4472:
1.688 albertel 4473: # ------------------------------------------------------------ tmpget interface
4474: sub tmpdel {
4475: my ($token,$server)=@_;
4476: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4477: return &reply("tmpdel:$token",$server);
4478: }
4479:
1.765 albertel 4480: # -------------------------------------------------- portfolio access checking
4481:
4482: sub portfolio_access {
1.766 albertel 4483: my ($requrl) = @_;
1.765 albertel 4484: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4485: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 4486: if ($result) {
4487: my %setters;
4488: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4489: my ($startblock,$endblock) =
4490: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4491: if ($startblock && $endblock) {
4492: return 'B';
4493: }
4494: } else {
4495: my ($startblock,$endblock) =
4496: &Apache::loncommon::blockcheck(\%setters,'port');
4497: if ($startblock && $endblock) {
4498: return 'B';
4499: }
4500: }
4501: }
1.765 albertel 4502: if ($result eq 'ok') {
1.766 albertel 4503: return 'F';
1.765 albertel 4504: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 4505: return 'A';
1.765 albertel 4506: }
1.766 albertel 4507: return '';
1.765 albertel 4508: }
4509:
4510: sub get_portfolio_access {
1.767 albertel 4511: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4512:
4513: if (!ref($access_hash)) {
4514: my $current_perms = &get_portfile_permissions($udom,$unum);
4515: my %access_controls = &get_access_controls($current_perms,$group,
4516: $file_name);
4517: $access_hash = $access_controls{$file_name};
4518: }
4519:
1.765 albertel 4520: my ($public,$guest,@domains,@users,@courses,@groups);
4521: my $now = time;
4522: if (ref($access_hash) eq 'HASH') {
4523: foreach my $key (keys(%{$access_hash})) {
4524: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4525: if ($start > $now) {
4526: next;
4527: }
4528: if ($end && $end<$now) {
4529: next;
4530: }
4531: if ($scope eq 'public') {
4532: $public = $key;
4533: last;
4534: } elsif ($scope eq 'guest') {
4535: $guest = $key;
4536: } elsif ($scope eq 'domains') {
4537: push(@domains,$key);
4538: } elsif ($scope eq 'users') {
4539: push(@users,$key);
4540: } elsif ($scope eq 'course') {
4541: push(@courses,$key);
4542: } elsif ($scope eq 'group') {
4543: push(@groups,$key);
4544: }
4545: }
4546: if ($public) {
4547: return 'ok';
4548: }
4549: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4550: if ($guest) {
4551: return $guest;
4552: }
4553: } else {
4554: if (@domains > 0) {
4555: foreach my $domkey (@domains) {
4556: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4557: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4558: return 'ok';
4559: }
4560: }
4561: }
4562: }
4563: if (@users > 0) {
4564: foreach my $userkey (@users) {
1.865 raeburn 4565: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4566: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4567: if (ref($item) eq 'HASH') {
4568: if (($item->{'uname'} eq $env{'user.name'}) &&
4569: ($item->{'udom'} eq $env{'user.domain'})) {
4570: return 'ok';
4571: }
4572: }
4573: }
4574: }
1.765 albertel 4575: }
4576: }
4577: my %roleshash;
4578: my @courses_and_groups = @courses;
4579: push(@courses_and_groups,@groups);
4580: if (@courses_and_groups > 0) {
4581: my (%allgroups,%allroles);
4582: my ($start,$end,$role,$sec,$group);
4583: foreach my $envkey (%env) {
1.811 albertel 4584: if ($envkey =~ m-^user\.role\.(gr|cc|in|ta|ep|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4585: my $cid = $2.'_'.$3;
4586: if ($1 eq 'gr') {
4587: $group = $4;
4588: $allgroups{$cid}{$group} = $env{$envkey};
4589: } else {
4590: if ($4 eq '') {
4591: $sec = 'none';
4592: } else {
4593: $sec = $4;
4594: }
4595: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4596: }
1.811 albertel 4597: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4598: my $cid = $2.'_'.$3;
4599: if ($4 eq '') {
4600: $sec = 'none';
4601: } else {
4602: $sec = $4;
4603: }
4604: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4605: }
4606: }
4607: if (keys(%allroles) == 0) {
4608: return;
4609: }
4610: foreach my $key (@courses_and_groups) {
4611: my %content = %{$$access_hash{$key}};
4612: my $cnum = $content{'number'};
4613: my $cdom = $content{'domain'};
4614: my $cid = $cdom.'_'.$cnum;
4615: if (!exists($allroles{$cid})) {
4616: next;
4617: }
4618: foreach my $role_id (keys(%{$content{'roles'}})) {
4619: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4620: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4621: my @status = @{$content{'roles'}{$role_id}{'access'}};
4622: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4623: foreach my $role (keys(%{$allroles{$cid}})) {
4624: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4625: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4626: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4627: if (grep/^all$/,@sections) {
4628: return 'ok';
4629: } else {
4630: if (grep/^$sec$/,@sections) {
4631: return 'ok';
4632: }
4633: }
4634: }
4635: }
4636: if (keys(%{$allgroups{$cid}}) == 0) {
4637: if (grep/^none$/,@groups) {
4638: return 'ok';
4639: }
4640: } else {
4641: if (grep/^all$/,@groups) {
4642: return 'ok';
4643: }
4644: foreach my $group (keys(%{$allgroups{$cid}})) {
4645: if (grep/^$group$/,@groups) {
4646: return 'ok';
4647: }
4648: }
4649: }
4650: }
4651: }
4652: }
4653: }
4654: }
4655: if ($guest) {
4656: return $guest;
4657: }
4658: }
4659: }
4660: return;
4661: }
4662:
4663: sub course_group_datechecker {
4664: my ($dates,$now,$status) = @_;
4665: my ($start,$end) = split(/\./,$dates);
4666: if (!$start && !$end) {
4667: return 'ok';
4668: }
4669: if (grep/^active$/,@{$status}) {
4670: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4671: return 'ok';
4672: }
4673: }
4674: if (grep/^previous$/,@{$status}) {
4675: if ($end > $now ) {
4676: return 'ok';
4677: }
4678: }
4679: if (grep/^future$/,@{$status}) {
4680: if ($start > $now) {
4681: return 'ok';
4682: }
4683: }
4684: return;
4685: }
4686:
4687: sub parse_portfolio_url {
4688: my ($url) = @_;
4689:
4690: my ($type,$udom,$unum,$group,$file_name);
4691:
1.823 albertel 4692: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4693: $type = 1;
4694: $udom = $1;
4695: $unum = $2;
4696: $file_name = $3;
1.823 albertel 4697: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4698: $type = 2;
4699: $udom = $1;
4700: $unum = $2;
4701: $group = $3;
4702: $file_name = $3.'/'.$4;
4703: }
4704: if (wantarray) {
4705: return ($type,$udom,$unum,$file_name,$group);
4706: }
4707: return $type;
4708: }
4709:
4710: sub is_portfolio_url {
4711: my ($url) = @_;
4712: return scalar(&parse_portfolio_url($url));
4713: }
4714:
1.798 raeburn 4715: sub is_portfolio_file {
4716: my ($file) = @_;
1.820 raeburn 4717: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4718: return 1;
4719: }
4720: return;
4721: }
4722:
1.976 raeburn 4723: sub usertools_access {
1.985 raeburn 4724: my ($uname,$udom,$tool,$action,$context) = @_;
4725: my ($access,%tools);
4726: if ($context eq '') {
4727: $context = 'tools';
4728: }
4729: if ($context eq 'requestcourses') {
4730: %tools = (
4731: official => 1,
4732: unofficial => 1,
1.1006 raeburn 4733: community => 1,
1.985 raeburn 4734: );
4735: } else {
4736: %tools = (
4737: aboutme => 1,
4738: blog => 1,
4739: portfolio => 1,
4740: );
4741: }
1.976 raeburn 4742: return if (!defined($tools{$tool}));
4743:
4744: if ((!defined($udom)) || (!defined($uname))) {
4745: $udom = $env{'user.domain'};
4746: $uname = $env{'user.name'};
4747: }
4748:
1.978 raeburn 4749: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4750: if ($action ne 'reload') {
1.985 raeburn 4751: if ($context eq 'requestcourses') {
4752: return $env{'environment.canrequest.'.$tool};
4753: } else {
4754: return $env{'environment.availabletools.'.$tool};
4755: }
4756: }
1.976 raeburn 4757: }
4758:
4759: my ($toolstatus,$inststatus);
4760:
1.985 raeburn 4761: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4762: ($action ne 'reload')) {
4763: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 4764: $inststatus = $env{'environment.inststatus'};
4765: } else {
1.1025 raeburn 4766: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
1.985 raeburn 4767: $toolstatus = $userenv{$context.'.'.$tool};
1.976 raeburn 4768: $inststatus = $userenv{'inststatus'};
4769: }
4770:
4771: if ($toolstatus ne '') {
4772: if ($toolstatus) {
4773: $access = 1;
4774: } else {
4775: $access = 0;
4776: }
4777: return $access;
4778: }
4779:
4780: my $is_adv = &is_advanced_user($udom,$uname);
4781: my %domdef = &get_domain_defaults($udom);
4782: if (ref($domdef{$tool}) eq 'HASH') {
4783: if ($is_adv) {
4784: if ($domdef{$tool}{'_LC_adv'} ne '') {
4785: if ($domdef{$tool}{'_LC_adv'}) {
4786: $access = 1;
4787: } else {
4788: $access = 0;
4789: }
4790: return $access;
4791: }
4792: }
4793: if ($inststatus ne '') {
4794: my ($hasaccess,$hasnoaccess);
4795: foreach my $affiliation (split(/:/,$inststatus)) {
4796: if ($domdef{$tool}{$affiliation} ne '') {
4797: if ($domdef{$tool}{$affiliation}) {
4798: $hasaccess = 1;
4799: } else {
4800: $hasnoaccess = 1;
4801: }
4802: }
4803: }
4804: if ($hasaccess || $hasnoaccess) {
4805: if ($hasaccess) {
4806: $access = 1;
4807: } elsif ($hasnoaccess) {
4808: $access = 0;
4809: }
4810: return $access;
4811: }
4812: } else {
4813: if ($domdef{$tool}{'default'} ne '') {
4814: if ($domdef{$tool}{'default'}) {
4815: $access = 1;
4816: } elsif ($domdef{$tool}{'default'} == 0) {
4817: $access = 0;
4818: }
4819: return $access;
4820: }
4821: }
4822: } else {
1.985 raeburn 4823: if ($context eq 'tools') {
4824: $access = 1;
4825: } else {
4826: $access = 0;
4827: }
1.976 raeburn 4828: return $access;
4829: }
4830: }
4831:
1.1050 raeburn 4832: sub is_course_owner {
4833: my ($cdom,$cnum,$udom,$uname) = @_;
4834: if (($udom eq '') || ($uname eq '')) {
4835: $udom = $env{'user.domain'};
4836: $uname = $env{'user.name'};
4837: }
4838: unless (($udom eq '') || ($uname eq '')) {
4839: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4840: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4841: return 1;
4842: } else {
4843: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4844: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4845: return 1;
4846: }
4847: }
4848: }
4849: }
4850: return;
4851: }
4852:
1.976 raeburn 4853: sub is_advanced_user {
4854: my ($udom,$uname) = @_;
4855: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4856: my %allroles;
4857: my $is_adv;
4858: foreach my $role (keys(%roleshash)) {
4859: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4860: my $area = '/'.$tdomain.'/'.$trest;
4861: if ($sec ne '') {
4862: $area .= '/'.$sec;
4863: }
4864: if (($area ne '') && ($trole ne '')) {
4865: my $spec=$trole.'.'.$area;
4866: if ($trole =~ /^cr\//) {
4867: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4868: } elsif ($trole ne 'gr') {
4869: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4870: }
4871: }
4872: }
4873: foreach my $role (keys(%allroles)) {
4874: last if ($is_adv);
4875: foreach my $item (split(/:/,$allroles{$role})) {
4876: if ($item ne '') {
4877: my ($privilege,$restrictions)=split(/&/,$item);
4878: if ($privilege eq 'adv') {
4879: $is_adv = 1;
4880: last;
4881: }
4882: }
4883: }
4884: }
4885: return $is_adv;
4886: }
1.798 raeburn 4887:
1.1035 raeburn 4888: sub check_can_request {
1.1036 raeburn 4889: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 4890: my $canreq = 0;
4891: my ($types,$typename) = &Apache::loncommon::course_types();
4892: my @options = ('approval','validate','autolimit');
4893: my $optregex = join('|',@options);
4894: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4895: foreach my $type (@{$types}) {
4896: if (&usertools_access($env{'user.name'},
4897: $env{'user.domain'},
4898: $type,undef,'requestcourses')) {
4899: $canreq ++;
1.1036 raeburn 4900: if (ref($request_domains) eq 'HASH') {
4901: push(@{$request_domains->{$type}},$env{'user.domain'});
4902: }
1.1035 raeburn 4903: if ($dom eq $env{'user.domain'}) {
4904: $can_request->{$type} = 1;
4905: }
4906: }
4907: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4908: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4909: if (@curr > 0) {
1.1036 raeburn 4910: foreach my $item (@curr) {
4911: if (ref($request_domains) eq 'HASH') {
4912: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4913: if ($otherdom ne '') {
4914: if (ref($request_domains->{$type}) eq 'ARRAY') {
4915: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4916: push(@{$request_domains->{$type}},$otherdom);
4917: }
4918: } else {
4919: push(@{$request_domains->{$type}},$otherdom);
4920: }
4921: }
4922: }
4923: }
4924: unless($dom eq $env{'user.domain'}) {
4925: $canreq ++;
1.1035 raeburn 4926: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4927: $can_request->{$type} = 1;
4928: }
4929: }
4930: }
4931: }
4932: }
4933: }
4934: return $canreq;
4935: }
4936:
1.341 www 4937: # ---------------------------------------------- Custom access rule evaluation
4938:
4939: sub customaccess {
4940: my ($priv,$uri)=@_;
1.807 albertel 4941: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 4942: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 4943: $udom = &LONCAPA::clean_domain($udom);
4944: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 4945: my $access=0;
1.800 albertel 4946: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 4947: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4948: if ($type eq 'user') {
4949: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 4950: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 4951: if ($tdom) {
4952: if ($tdom ne $env{'user.domain'}) { next; }
4953: }
1.896 albertel 4954: if ($tuname) {
4955: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 4956: }
4957: $access=($effect eq 'allow');
4958: last;
4959: }
4960: } else {
4961: if ($role) {
4962: if ($role ne $urole) { next; }
4963: }
4964: foreach my $scope (split(/\s*\,\s*/,$realm)) {
4965: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
4966: if ($tdom) {
4967: if ($tdom ne $udom) { next; }
4968: }
4969: if ($tcrs) {
4970: if ($tcrs ne $ucrs) { next; }
4971: }
4972: if ($tsec) {
4973: if ($tsec ne $usec) { next; }
4974: }
4975: $access=($effect eq 'allow');
4976: last;
4977: }
4978: if ($realm eq '' && $role eq '') {
4979: $access=($effect eq 'allow');
4980: }
1.402 bowersj2 4981: }
1.341 www 4982: }
4983: return $access;
4984: }
4985:
1.103 harris41 4986: # ------------------------------------------------- Check for a user privilege
1.12 www 4987:
4988: sub allowed {
1.810 raeburn 4989: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 4990: my $ver_orguri=$uri;
1.439 www 4991: $uri=&deversion($uri);
1.152 www 4992: my $orguri=$uri;
1.52 www 4993: $uri=&declutter($uri);
1.809 raeburn 4994:
1.810 raeburn 4995: if ($priv eq 'evb') {
4996: # Evade communication block restrictions for specified role in a course
4997: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
4998: return $1;
4999: } else {
5000: return;
5001: }
5002: }
5003:
1.620 albertel 5004: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 5005: # Free bre access to adm and meta resources
1.775 albertel 5006: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 5007: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5008: && ($priv eq 'bre')) {
1.14 www 5009: return 'F';
1.159 www 5010: }
5011:
1.545 banghart 5012: # Free bre access to user's own portfolio contents
1.714 raeburn 5013: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 5014: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 5015: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 5016: my %setters;
5017: my ($startblock,$endblock) =
5018: &Apache::loncommon::blockcheck(\%setters,'port');
5019: if ($startblock && $endblock) {
5020: return 'B';
5021: } else {
5022: return 'F';
5023: }
1.545 banghart 5024: }
5025:
1.762 raeburn 5026: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 5027: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5028: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5029: if (exists($env{'request.course.id'})) {
5030: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5031: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5032: if (($domain eq $cdom) && ($name eq $cnum)) {
5033: my $courseprivid=$env{'request.course.id'};
5034: $courseprivid=~s/\_/\//;
5035: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5036: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5037: return $1;
1.762 raeburn 5038: } else {
5039: if ($env{'request.course.sec'}) {
5040: $courseprivid.='/'.$env{'request.course.sec'};
5041: }
5042: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5043: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5044: return $2;
5045: }
1.714 raeburn 5046: }
5047: }
5048: }
5049: }
5050:
1.159 www 5051: # Free bre to public access
5052:
5053: if ($priv eq 'bre') {
1.238 www 5054: my $copyright=&metadata($uri,'copyright');
1.620 albertel 5055: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 5056: return 'F';
5057: }
1.238 www 5058: if ($copyright eq 'priv') {
5059: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5060: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 5061: return '';
5062: }
5063: }
5064: if ($copyright eq 'domain') {
5065: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5066: unless (($env{'user.domain'} eq $1) ||
5067: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 5068: return '';
5069: }
1.262 matthew 5070: }
1.620 albertel 5071: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 5072: # Library role, so allow browsing of resources in this domain.
5073: return 'F';
1.238 www 5074: }
1.341 www 5075: if ($copyright eq 'custom') {
5076: unless (&customaccess($priv,$uri)) { return ''; }
5077: }
1.14 www 5078: }
1.264 matthew 5079: # Domain coordinator is trying to create a course
1.620 albertel 5080: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 5081: # uri is the requested domain in this case.
5082: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 5083: # a role of dc for the domain in question.
1.620 albertel 5084: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 5085: }
1.29 www 5086:
1.52 www 5087: my $thisallowed='';
5088: my $statecond=0;
5089: my $courseprivid='';
5090:
1.1039 raeburn 5091: my $ownaccess;
1.1043 raeburn 5092: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 5093: if (($priv eq 'bro') && ($env{'user.author'})) {
5094: if ($uri eq '') {
5095: $ownaccess = 1;
5096: } else {
5097: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5098: my $udom = $env{'user.domain'};
5099: my $uname = $env{'user.name'};
5100: if ($uri =~ m{^\Q$udom\E/?$}) {
5101: $ownaccess = 1;
1.1040 raeburn 5102: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 5103: unless ($uri =~ m{\.\./}) {
5104: $ownaccess = 1;
5105: }
5106: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5107: my $now = time;
5108: if ($uri =~ m{^([^/]+)/?$}) {
5109: my $adom = $1;
5110: foreach my $key (keys(%env)) {
1.1042 raeburn 5111: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 5112: my ($start,$end) = split('.',$env{$key});
5113: if (($now >= $start) && (!$end || $end < $now)) {
5114: $ownaccess = 1;
5115: last;
5116: }
5117: }
5118: }
5119: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5120: my $adom = $1;
5121: my $aname = $2;
1.1042 raeburn 5122: foreach my $role ('ca','aa') {
5123: if ($env{"user.role.$role./$adom/$aname"}) {
5124: my ($start,$end) =
5125: split('.',$env{"user.role.$role./$adom/$aname"});
5126: if (($now >= $start) && (!$end || $end < $now)) {
5127: $ownaccess = 1;
5128: last;
5129: }
1.1039 raeburn 5130: }
5131: }
5132: }
5133: }
5134: }
5135: }
5136: }
5137:
1.52 www 5138: # Course
5139:
1.620 albertel 5140: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5141: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5142: $thisallowed.=$1;
5143: }
1.52 www 5144: }
1.29 www 5145:
1.52 www 5146: # Domain
5147:
1.620 albertel 5148: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 5149: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5150: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5151: $thisallowed.=$1;
5152: }
1.12 www 5153: }
1.52 www 5154:
5155: # Course: uri itself is a course
1.66 www 5156: my $courseuri=$uri;
5157: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 5158: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 5159:
1.620 albertel 5160: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 5161: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5162: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5163: $thisallowed.=$1;
5164: }
1.12 www 5165: }
1.29 www 5166:
1.665 albertel 5167: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 5168: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 5169: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 5170: $thisallowed='';
1.671 raeburn 5171: my ($match)=&is_on_map($uri);
5172: if ($match) {
5173: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5174: =~/\Q$priv\E\&([^\:]*)/) {
5175: $thisallowed.=$1;
5176: }
5177: } else {
1.705 albertel 5178: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 5179: if ($refuri) {
5180: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 5181: $thisallowed='F';
1.671 raeburn 5182: } else {
5183: $refuri=&declutter($refuri);
5184: my ($match) = &is_on_map($refuri);
5185: if ($match) {
5186: $thisallowed='F';
5187: }
1.669 raeburn 5188: }
1.671 raeburn 5189: }
5190: }
1.314 www 5191: }
1.492 albertel 5192:
1.766 albertel 5193: if ($priv eq 'bre'
5194: && $thisallowed ne 'F'
5195: && $thisallowed ne '2'
5196: && &is_portfolio_url($uri)) {
5197: $thisallowed = &portfolio_access($uri);
5198: }
5199:
1.52 www 5200: # Full access at system, domain or course-wide level? Exit.
1.29 www 5201: if ($thisallowed=~/F/) {
5202: return 'F';
5203: }
5204:
1.52 www 5205: # If this is generating or modifying users, exit with special codes
1.29 www 5206:
1.643 www 5207: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5208: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 5209: my ($audom,$auname)=split('/',$uri);
1.643 www 5210: # no author name given, so this just checks on the general right to make a co-author in this domain
5211: unless ($auname) { return $thisallowed; }
5212: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 5213: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5214: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5215: ($audom ne $env{'request.role.domain'}))) { return ''; }
5216: }
1.52 www 5217: return $thisallowed;
5218: }
5219: #
1.103 harris41 5220: # Gathered so far: system, domain and course wide privileges
1.52 www 5221: #
5222: # Course: See if uri or referer is an individual resource that is part of
5223: # the course
5224:
1.620 albertel 5225: if ($env{'request.course.id'}) {
1.232 www 5226:
1.620 albertel 5227: $courseprivid=$env{'request.course.id'};
5228: if ($env{'request.course.sec'}) {
5229: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 5230: }
5231: $courseprivid=~s/\_/\//;
5232: my $checkreferer=1;
1.232 www 5233: my ($match,$cond)=&is_on_map($uri);
5234: if ($match) {
5235: $statecond=$cond;
1.620 albertel 5236: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5237: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5238: $thisallowed.=$1;
5239: $checkreferer=0;
5240: }
1.29 www 5241: }
1.83 www 5242:
1.148 www 5243: if ($checkreferer) {
1.620 albertel 5244: my $refuri=$env{'httpref.'.$orguri};
1.148 www 5245: unless ($refuri) {
1.800 albertel 5246: foreach my $key (keys(%env)) {
5247: if ($key=~/^httpref\..*\*/) {
5248: my $pattern=$key;
1.156 www 5249: $pattern=~s/^httpref\.\/res\///;
1.148 www 5250: $pattern=~s/\*/\[\^\/\]\+/g;
5251: $pattern=~s/\//\\\//g;
1.152 www 5252: if ($orguri=~/$pattern/) {
1.800 albertel 5253: $refuri=$env{$key};
1.148 www 5254: }
5255: }
1.191 harris41 5256: }
1.148 www 5257: }
1.232 www 5258:
1.148 www 5259: if ($refuri) {
1.152 www 5260: $refuri=&declutter($refuri);
1.232 www 5261: my ($match,$cond)=&is_on_map($refuri);
5262: if ($match) {
5263: my $refstatecond=$cond;
1.620 albertel 5264: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5265: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5266: $thisallowed.=$1;
1.53 www 5267: $uri=$refuri;
5268: $statecond=$refstatecond;
1.52 www 5269: }
5270: }
1.148 www 5271: }
1.29 www 5272: }
1.52 www 5273: }
1.29 www 5274:
1.52 www 5275: #
1.103 harris41 5276: # Gathered now: all privileges that could apply, and condition number
1.52 www 5277: #
5278: #
5279: # Full or no access?
5280: #
1.29 www 5281:
1.52 www 5282: if ($thisallowed=~/F/) {
5283: return 'F';
5284: }
1.29 www 5285:
1.52 www 5286: unless ($thisallowed) {
5287: return '';
5288: }
1.29 www 5289:
1.52 www 5290: # Restrictions exist, deal with them
5291: #
5292: # C:according to course preferences
5293: # R:according to resource settings
5294: # L:unless locked
5295: # X:according to user session state
5296: #
5297:
5298: # Possibly locked functionality, check all courses
1.54 www 5299: # Locks might take effect only after 10 minutes cache expiration for other
5300: # courses, and 2 minutes for current course
1.52 www 5301:
5302: my $envkey;
5303: if ($thisallowed=~/L/) {
1.1000 raeburn 5304: foreach $envkey (keys(%env)) {
1.54 www 5305: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5306: my $courseid=$2;
5307: my $roleid=$1.'.'.$2;
1.92 www 5308: $courseid=~s/^\///;
1.54 www 5309: my $expiretime=600;
1.620 albertel 5310: if ($env{'request.role'} eq $roleid) {
1.54 www 5311: $expiretime=120;
5312: }
5313: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5314: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 5315: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 5316: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 5317: }
1.620 albertel 5318: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5319: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5320: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5321: &log($env{'user.domain'},$env{'user.name'},
5322: $env{'user.home'},
1.57 www 5323: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 5324: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5325: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5326: return '';
5327: }
5328: }
1.620 albertel 5329: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5330: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5331: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5332: &log($env{'user.domain'},$env{'user.name'},
5333: $env{'user.home'},
1.57 www 5334: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 5335: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5336: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5337: return '';
5338: }
5339: }
5340: }
1.29 www 5341: }
1.52 www 5342: }
5343:
5344: #
5345: # Rest of the restrictions depend on selected course
5346: #
5347:
1.620 albertel 5348: unless ($env{'request.course.id'}) {
1.766 albertel 5349: if ($thisallowed eq 'A') {
5350: return 'A';
1.814 raeburn 5351: } elsif ($thisallowed eq 'B') {
5352: return 'B';
1.766 albertel 5353: } else {
5354: return '1';
5355: }
1.52 www 5356: }
1.29 www 5357:
1.52 www 5358: #
5359: # Now user is definitely in a course
5360: #
1.53 www 5361:
5362:
5363: # Course preferences
5364:
5365: if ($thisallowed=~/C/) {
1.620 albertel 5366: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5367: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5368: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 5369: =~/\Q$rolecode\E/) {
1.689 albertel 5370: if ($priv ne 'pch') {
5371: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5372: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5373: $env{'request.course.id'});
5374: }
1.237 www 5375: return '';
5376: }
5377:
1.620 albertel 5378: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 5379: =~/\Q$unamedom\E/) {
1.689 albertel 5380: if ($priv ne 'pch') {
5381: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5382: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5383: $env{'request.course.id'});
5384: }
1.54 www 5385: return '';
5386: }
1.53 www 5387: }
5388:
5389: # Resource preferences
5390:
5391: if ($thisallowed=~/R/) {
1.620 albertel 5392: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 5393: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 5394: if ($priv ne 'pch') {
5395: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5396: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5397: }
5398: return '';
1.54 www 5399: }
1.53 www 5400: }
1.30 www 5401:
1.246 www 5402: # Restricted by state or randomout?
1.30 www 5403:
1.52 www 5404: if ($thisallowed=~/X/) {
1.620 albertel 5405: if ($env{'acc.randomout'}) {
1.579 albertel 5406: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 5407: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 5408: return '';
5409: }
1.247 www 5410: }
5411: if (&condval($statecond)) {
1.52 www 5412: return '2';
5413: } else {
5414: return '';
5415: }
5416: }
1.30 www 5417:
1.766 albertel 5418: if ($thisallowed eq 'A') {
5419: return 'A';
1.814 raeburn 5420: } elsif ($thisallowed eq 'B') {
5421: return 'B';
1.766 albertel 5422: }
1.52 www 5423: return 'F';
1.232 www 5424: }
5425:
1.710 albertel 5426: sub split_uri_for_cond {
5427: my $uri=&deversion(&declutter(shift));
5428: my @uriparts=split(/\//,$uri);
5429: my $filename=pop(@uriparts);
5430: my $pathname=join('/',@uriparts);
5431: return ($pathname,$filename);
5432: }
1.232 www 5433: # --------------------------------------------------- Is a resource on the map?
5434:
5435: sub is_on_map {
1.710 albertel 5436: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 5437: #Trying to find the conditional for the file
1.620 albertel 5438: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 5439: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 5440: if ($match) {
1.289 bowersj2 5441: return (1,$1);
5442: } else {
1.434 www 5443: return (0,0);
1.289 bowersj2 5444: }
1.12 www 5445: }
5446:
1.427 www 5447: # --------------------------------------------------------- Get symb from alias
5448:
5449: sub get_symb_from_alias {
5450: my $symb=shift;
5451: my ($map,$resid,$url)=&decode_symb($symb);
5452: # Already is a symb
5453: if ($url) { return $symb; }
5454: # Must be an alias
5455: my $aliassymb='';
5456: my %bighash;
1.620 albertel 5457: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 5458: &GDBM_READER(),0640)) {
5459: my $rid=$bighash{'mapalias_'.$symb};
5460: if ($rid) {
5461: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 5462: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5463: $resid,$bighash{'src_'.$rid});
1.427 www 5464: }
5465: untie %bighash;
5466: }
5467: return $aliassymb;
5468: }
5469:
1.12 www 5470: # ----------------------------------------------------------------- Define Role
5471:
5472: sub definerole {
5473: if (allowed('mcr','/')) {
5474: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 5475: foreach my $role (split(':',$sysrole)) {
5476: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5477: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5478: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5479: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5480: return "refused:s:$crole&$cqual";
5481: }
5482: }
1.191 harris41 5483: }
1.800 albertel 5484: foreach my $role (split(':',$domrole)) {
5485: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5486: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5487: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5488: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 5489: return "refused:d:$crole&$cqual";
5490: }
5491: }
1.191 harris41 5492: }
1.800 albertel 5493: foreach my $role (split(':',$courole)) {
5494: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5495: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5496: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5497: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5498: return "refused:c:$crole&$cqual";
5499: }
5500: }
1.191 harris41 5501: }
1.620 albertel 5502: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5503: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5504: "rolesdef_$rolename=".
5505: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 5506: return reply($command,$env{'user.home'});
1.12 www 5507: } else {
5508: return 'refused';
5509: }
1.105 harris41 5510: }
5511:
5512: # ---------------- Make a metadata query against the network of library servers
5513:
5514: sub metadata_query {
1.244 matthew 5515: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 5516: my %rhash;
1.845 albertel 5517: my %libserv = &all_library();
1.244 matthew 5518: my @server_list = (defined($server_array) ? @$server_array
5519: : keys(%libserv) );
5520: for my $server (@server_list) {
1.118 harris41 5521: unless ($custom or $customshow) {
5522: my $reply=&reply("querysend:".&escape($query),$server);
5523: $rhash{$server}=$reply;
5524: }
5525: else {
5526: my $reply=&reply("querysend:".&escape($query).':'.
5527: &escape($custom).':'.&escape($customshow),
5528: $server);
5529: $rhash{$server}=$reply;
5530: }
1.112 harris41 5531: }
1.118 harris41 5532: return \%rhash;
1.240 www 5533: }
5534:
5535: # ----------------------------------------- Send log queries and wait for reply
5536:
5537: sub log_query {
5538: my ($uname,$udom,$query,%filters)=@_;
5539: my $uhome=&homeserver($uname,$udom);
5540: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 5541: my $uhost=&hostname($uhome);
1.800 albertel 5542: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 5543: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5544: $uhome);
1.479 albertel 5545: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 5546: return get_query_reply($queryid);
5547: }
5548:
1.818 raeburn 5549: # -------------------------- Update MySQL table for portfolio file
5550:
5551: sub update_portfolio_table {
1.821 raeburn 5552: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 5553: if ($group ne '') {
5554: $file_name =~s /^\Q$group\E//;
5555: }
1.818 raeburn 5556: my $homeserver = &homeserver($uname,$udom);
5557: my $queryid=
1.821 raeburn 5558: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5559: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 5560: my $reply = &get_query_reply($queryid);
5561: return $reply;
5562: }
5563:
1.899 raeburn 5564: # -------------------------- Update MySQL allusers table
5565:
5566: sub update_allusers_table {
5567: my ($uname,$udom,$names) = @_;
5568: my $homeserver = &homeserver($uname,$udom);
5569: my $queryid=
5570: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5571: 'lastname='.&escape($names->{'lastname'}).'%%'.
5572: 'firstname='.&escape($names->{'firstname'}).'%%'.
5573: 'middlename='.&escape($names->{'middlename'}).'%%'.
5574: 'generation='.&escape($names->{'generation'}).'%%'.
5575: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5576: 'id='.&escape($names->{'id'}),$homeserver);
5577: my $reply = &get_query_reply($queryid);
5578: return $reply;
5579: }
5580:
1.508 raeburn 5581: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 5582:
5583: sub fetch_enrollment_query {
1.511 raeburn 5584: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 5585: my $homeserver;
1.547 raeburn 5586: my $maxtries = 1;
1.508 raeburn 5587: if ($context eq 'automated') {
5588: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 5589: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 5590: } else {
5591: $homeserver = &homeserver($cnum,$dom);
5592: }
1.838 albertel 5593: my $host=&hostname($homeserver);
1.506 raeburn 5594: my $cmd = '';
1.1000 raeburn 5595: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 5596: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 5597: }
5598: $cmd =~ s/%%$//;
5599: $cmd = &escape($cmd);
5600: my $query = 'fetchenrollment';
1.620 albertel 5601: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 5602: unless ($queryid=~/^\Q$host\E\_/) {
5603: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5604: return 'error: '.$queryid;
5605: }
1.506 raeburn 5606: my $reply = &get_query_reply($queryid);
1.547 raeburn 5607: my $tries = 1;
5608: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5609: $reply = &get_query_reply($queryid);
5610: $tries ++;
5611: }
1.526 raeburn 5612: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 5613: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 5614: } else {
1.901 albertel 5615: my @responses = split(/:/,$reply);
1.515 raeburn 5616: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 5617: foreach my $line (@responses) {
5618: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 5619: $$replyref{$key} = $value;
5620: }
5621: } else {
1.506 raeburn 5622: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 5623: foreach my $line (@responses) {
5624: my ($key,$value) = split(/=/,$line);
1.506 raeburn 5625: $$replyref{$key} = $value;
5626: if ($value > 0) {
1.800 albertel 5627: foreach my $item (@{$$affiliatesref{$key}}) {
5628: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 5629: my $destname = $pathname.'/'.$filename;
5630: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 5631: if ($xml_classlist =~ /^error/) {
5632: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5633: } else {
1.506 raeburn 5634: if ( open(FILE,">$destname") ) {
5635: print FILE &unescape($xml_classlist);
5636: close(FILE);
1.526 raeburn 5637: } else {
5638: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 5639: }
5640: }
5641: }
5642: }
5643: }
5644: }
5645: return 'ok';
5646: }
5647: return 'error';
5648: }
5649:
1.242 www 5650: sub get_query_reply {
5651: my $queryid=shift;
1.240 www 5652: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5653: my $reply='';
5654: for (1..100) {
5655: sleep 2;
5656: if (-e $replyfile.'.end') {
1.448 albertel 5657: if (open(my $fh,$replyfile)) {
1.904 albertel 5658: $reply = join('',<$fh>);
5659: close($fh);
1.240 www 5660: } else { return 'error: reply_file_error'; }
1.242 www 5661: return &unescape($reply);
5662: }
1.240 www 5663: }
1.242 www 5664: return 'timeout:'.$queryid;
1.240 www 5665: }
5666:
5667: sub courselog_query {
1.241 www 5668: #
5669: # possible filters:
5670: # url: url or symb
5671: # username
5672: # domain
5673: # action: view, submit, grade
5674: # start: timestamp
5675: # end: timestamp
5676: #
1.240 www 5677: my (%filters)=@_;
1.620 albertel 5678: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 5679: if ($filters{'url'}) {
5680: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5681: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5682: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5683: }
1.620 albertel 5684: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5685: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 5686: return &log_query($cname,$cdom,'courselog',%filters);
5687: }
5688:
5689: sub userlog_query {
1.858 raeburn 5690: #
5691: # possible filters:
5692: # action: log check role
5693: # start: timestamp
5694: # end: timestamp
5695: #
1.240 www 5696: my ($uname,$udom,%filters)=@_;
5697: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 5698: }
5699:
1.506 raeburn 5700: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5701:
5702: sub auto_run {
1.508 raeburn 5703: my ($cnum,$cdom) = @_;
1.876 raeburn 5704: my $response = 0;
5705: my $settings;
5706: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5707: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5708: $settings = $domconfig{'autoenroll'};
5709: if ($settings->{'run'} eq '1') {
5710: $response = 1;
5711: }
5712: } else {
1.934 raeburn 5713: my $homeserver;
5714: if (&is_course($cdom,$cnum)) {
5715: $homeserver = &homeserver($cnum,$cdom);
5716: } else {
5717: $homeserver = &domain($cdom,'primary');
5718: }
5719: if ($homeserver ne 'no_host') {
5720: $response = &reply('autorun:'.$cdom,$homeserver);
5721: }
1.876 raeburn 5722: }
1.506 raeburn 5723: return $response;
5724: }
1.776 albertel 5725:
1.506 raeburn 5726: sub auto_get_sections {
1.508 raeburn 5727: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 5728: my $homeserver;
5729: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5730: $homeserver = &homeserver($cnum,$cdom);
5731: }
5732: if (!defined($homeserver)) {
5733: if ($cdom =~ /^$match_domain$/) {
5734: $homeserver = &domain($cdom,'primary');
5735: }
5736: }
5737: my @secs;
5738: if (defined($homeserver)) {
5739: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5740: unless ($response eq 'refused') {
5741: @secs = split(/:/,$response);
5742: }
1.506 raeburn 5743: }
5744: return @secs;
5745: }
1.776 albertel 5746:
1.506 raeburn 5747: sub auto_new_course {
1.508 raeburn 5748: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5749: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 5750: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 5751: return $response;
5752: }
1.776 albertel 5753:
1.506 raeburn 5754: sub auto_validate_courseID {
1.508 raeburn 5755: my ($cnum,$cdom,$inst_course_id) = @_;
5756: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 5757: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 5758: return $response;
5759: }
1.776 albertel 5760:
1.1007 raeburn 5761: sub auto_validate_instcode {
1.1020 raeburn 5762: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 5763: my ($homeserver,$response);
5764: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5765: $homeserver = &homeserver($cnum,$cdom);
5766: }
5767: if (!defined($homeserver)) {
5768: if ($cdom =~ /^$match_domain$/) {
5769: $homeserver = &domain($cdom,'primary');
5770: }
5771: }
5772: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
1.1020 raeburn 5773: &escape($instcode).':'.&escape($owner),$homeserver));
1.1027 raeburn 5774: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5775: return ($outcome,$description);
1.1007 raeburn 5776: }
5777:
1.506 raeburn 5778: sub auto_create_password {
1.873 raeburn 5779: my ($cnum,$cdom,$authparam,$udom) = @_;
5780: my ($homeserver,$response);
1.506 raeburn 5781: my $create_passwd = 0;
5782: my $authchk = '';
1.873 raeburn 5783: if ($udom =~ /^$match_domain$/) {
5784: $homeserver = &domain($udom,'primary');
5785: }
5786: if ($homeserver eq '') {
5787: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5788: $homeserver = &homeserver($cnum,$cdom);
5789: }
5790: }
5791: if ($homeserver eq '') {
5792: $authchk = 'nodomain';
1.506 raeburn 5793: } else {
1.873 raeburn 5794: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5795: if ($response eq 'refused') {
5796: $authchk = 'refused';
5797: } else {
1.901 albertel 5798: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 5799: }
1.506 raeburn 5800: }
5801: return ($authparam,$create_passwd,$authchk);
5802: }
5803:
1.706 raeburn 5804: sub auto_photo_permission {
5805: my ($cnum,$cdom,$students) = @_;
5806: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 5807: my ($outcome,$perm_reqd,$conditions) =
5808: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 5809: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5810: return (undef,undef);
5811: }
1.706 raeburn 5812: return ($outcome,$perm_reqd,$conditions);
5813: }
5814:
5815: sub auto_checkphotos {
5816: my ($uname,$udom,$pid) = @_;
5817: my $homeserver = &homeserver($uname,$udom);
5818: my ($result,$resulttype);
5819: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 5820: &escape($uname).':'.&escape($pid),
5821: $homeserver));
1.709 albertel 5822: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5823: return (undef,undef);
5824: }
1.706 raeburn 5825: if ($outcome) {
5826: ($result,$resulttype) = split(/:/,$outcome);
5827: }
5828: return ($result,$resulttype);
5829: }
5830:
5831: sub auto_photochoice {
5832: my ($cnum,$cdom) = @_;
5833: my $homeserver = &homeserver($cnum,$cdom);
5834: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 5835: &escape($cdom),
5836: $homeserver)));
1.709 albertel 5837: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5838: return (undef,undef);
5839: }
1.706 raeburn 5840: return ($update,$comment);
5841: }
5842:
5843: sub auto_photoupdate {
5844: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5845: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 5846: my $host=&hostname($homeserver);
1.706 raeburn 5847: my $cmd = '';
5848: my $maxtries = 1;
1.800 albertel 5849: foreach my $affiliate (keys(%{$affiliatesref})) {
5850: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 5851: }
5852: $cmd =~ s/%%$//;
5853: $cmd = &escape($cmd);
5854: my $query = 'institutionalphotos';
5855: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5856: unless ($queryid=~/^\Q$host\E\_/) {
5857: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5858: return 'error: '.$queryid;
5859: }
5860: my $reply = &get_query_reply($queryid);
5861: my $tries = 1;
5862: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5863: $reply = &get_query_reply($queryid);
5864: $tries ++;
5865: }
5866: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5867: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5868: } else {
5869: my @responses = split(/:/,$reply);
5870: my $outcome = shift(@responses);
5871: foreach my $item (@responses) {
5872: my ($key,$value) = split(/=/,$item);
5873: $$photo{$key} = $value;
5874: }
5875: return $outcome;
5876: }
5877: return 'error';
5878: }
5879:
1.521 raeburn 5880: sub auto_instcode_format {
1.793 albertel 5881: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5882: $cat_order) = @_;
1.521 raeburn 5883: my $courses = '';
1.772 raeburn 5884: my @homeservers;
1.521 raeburn 5885: if ($caller eq 'global') {
1.841 albertel 5886: my %servers = &get_servers($codedom,'library');
5887: foreach my $tryserver (keys(%servers)) {
5888: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5889: push(@homeservers,$tryserver);
5890: }
1.584 raeburn 5891: }
1.1022 raeburn 5892: } elsif ($caller eq 'requests') {
5893: if ($codedom =~ /^$match_domain$/) {
5894: my $chome = &domain($codedom,'primary');
5895: unless ($chome eq 'no_host') {
5896: push(@homeservers,$chome);
5897: }
5898: }
1.521 raeburn 5899: } else {
1.772 raeburn 5900: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 5901: }
1.793 albertel 5902: foreach my $code (keys(%{$instcodes})) {
5903: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 5904: }
5905: chop($courses);
1.772 raeburn 5906: my $ok_response = 0;
5907: my $response;
5908: while (@homeservers > 0 && $ok_response == 0) {
5909: my $server = shift(@homeservers);
5910: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5911: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5912: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 5913: split(/:/,$response);
1.772 raeburn 5914: %{$codes} = (%{$codes},&str2hash($codes_str));
5915: push(@{$codetitles},&str2array($codetitles_str));
5916: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5917: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5918: $ok_response = 1;
5919: }
5920: }
5921: if ($ok_response) {
1.521 raeburn 5922: return 'ok';
1.772 raeburn 5923: } else {
5924: return $response;
1.521 raeburn 5925: }
5926: }
5927:
1.792 raeburn 5928: sub auto_instcode_defaults {
5929: my ($domain,$returnhash,$code_order) = @_;
5930: my @homeservers;
1.841 albertel 5931:
5932: my %servers = &get_servers($domain,'library');
5933: foreach my $tryserver (keys(%servers)) {
5934: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5935: push(@homeservers,$tryserver);
5936: }
1.792 raeburn 5937: }
1.841 albertel 5938:
1.792 raeburn 5939: my $response;
1.841 albertel 5940: foreach my $server (@homeservers) {
1.792 raeburn 5941: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 5942: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5943:
5944: foreach my $pair (split(/\&/,$response)) {
5945: my ($name,$value)=split(/\=/,$pair);
5946: if ($name eq 'code_order') {
5947: @{$code_order} = split(/\&/,&unescape($value));
5948: } else {
5949: $returnhash->{&unescape($name)}=&unescape($value);
5950: }
5951: }
5952: return 'ok';
1.792 raeburn 5953: }
1.841 albertel 5954:
5955: return $response;
1.1003 raeburn 5956: }
5957:
5958: sub auto_possible_instcodes {
1.1007 raeburn 5959: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
5960: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
5961: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
5962: return;
5963: }
1.1003 raeburn 5964: my (@homeservers,$uhome);
5965: if (defined(&domain($domain,'primary'))) {
5966: $uhome=&domain($domain,'primary');
5967: push(@homeservers,&domain($domain,'primary'));
5968: } else {
5969: my %servers = &get_servers($domain,'library');
5970: foreach my $tryserver (keys(%servers)) {
5971: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5972: push(@homeservers,$tryserver);
5973: }
5974: }
5975: }
5976: my $response;
5977: foreach my $server (@homeservers) {
5978: $response=&reply('autopossibleinstcodes:'.$domain,$server);
5979: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 5980: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
5981: split(':',$response);
5982: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
5983: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 5984: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 5985: my ($name,$value)=split('=',$item);
5986: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5987: }
5988: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 5989: my ($name,$value)=split('=',$item);
5990: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 5991: }
5992: return 'ok';
5993: }
5994: return $response;
5995: }
1.792 raeburn 5996:
1.1010 raeburn 5997: sub auto_courserequest_checks {
5998: my ($dom) = @_;
1.1020 raeburn 5999: my ($homeserver,%validations);
6000: if ($dom =~ /^$match_domain$/) {
6001: $homeserver = &domain($dom,'primary');
6002: }
6003: unless ($homeserver eq 'no_host') {
6004: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6005: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6006: my @items = split(/&/,$response);
6007: foreach my $item (@items) {
6008: my ($key,$value) = split('=',$item);
6009: $validations{&unescape($key)} = &thaw_unescape($value);
6010: }
6011: }
6012: }
1.1010 raeburn 6013: return %validations;
6014: }
6015:
1.1020 raeburn 6016: sub auto_courserequest_validation {
6017: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6018: my ($homeserver,$response);
6019: if ($dom =~ /^$match_domain$/) {
6020: $homeserver = &domain($dom,'primary');
6021: }
6022: unless ($homeserver eq 'no_host') {
1.1021 raeburn 6023:
1.1020 raeburn 6024: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 6025: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 6026: ':'.&escape($instcode).':'.&escape($instseclist),
6027: $homeserver));
6028: }
6029: return $response;
6030: }
6031:
1.777 albertel 6032: sub auto_validate_class_sec {
1.918 raeburn 6033: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 6034: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 6035: my $ownerlist;
6036: if (ref($owners) eq 'ARRAY') {
6037: $ownerlist = join(',',@{$owners});
6038: } else {
6039: $ownerlist = $owners;
6040: }
1.773 raeburn 6041: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 6042: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 6043: return $response;
6044: }
6045:
1.679 raeburn 6046: # ------------------------------------------------------- Course Group routines
6047:
6048: sub get_coursegroups {
1.809 raeburn 6049: my ($cdom,$cnum,$group,$namespace) = @_;
6050: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 6051: }
6052:
1.679 raeburn 6053: sub modify_coursegroup {
6054: my ($cdom,$cnum,$groupsettings) = @_;
6055: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6056: }
6057:
1.809 raeburn 6058: sub toggle_coursegroup_status {
6059: my ($cdom,$cnum,$group,$action) = @_;
6060: my ($from_namespace,$to_namespace);
6061: if ($action eq 'delete') {
6062: $from_namespace = 'coursegroups';
6063: $to_namespace = 'deleted_groups';
6064: } else {
6065: $from_namespace = 'deleted_groups';
6066: $to_namespace = 'coursegroups';
6067: }
6068: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 6069: if (my $tmp = &error(%curr_group)) {
6070: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6071: return ('read error',$tmp);
6072: } else {
6073: my %savedsettings = %curr_group;
1.809 raeburn 6074: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 6075: my $deloutcome;
6076: if ($result eq 'ok') {
1.809 raeburn 6077: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 6078: } else {
6079: return ('write error',$result);
6080: }
6081: if ($deloutcome eq 'ok') {
6082: return 'ok';
6083: } else {
6084: return ('delete error',$deloutcome);
6085: }
6086: }
6087: }
6088:
1.679 raeburn 6089: sub modify_group_roles {
1.957 raeburn 6090: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 6091: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6092: my $role = 'gr/'.&escape($userprivs);
6093: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 6094: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 6095: if ($result eq 'ok') {
6096: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6097: }
1.679 raeburn 6098: return $result;
6099: }
6100:
6101: sub modify_coursegroup_membership {
6102: my ($cdom,$cnum,$membership) = @_;
6103: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6104: return $result;
6105: }
6106:
1.682 raeburn 6107: sub get_active_groups {
6108: my ($udom,$uname,$cdom,$cnum) = @_;
6109: my $now = time;
6110: my %groups = ();
6111: foreach my $key (keys(%env)) {
1.811 albertel 6112: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 6113: my ($start,$end) = split(/\./,$env{$key});
6114: if (($end!=0) && ($end<$now)) { next; }
6115: if (($start!=0) && ($start>$now)) { next; }
6116: if ($1 eq $cdom && $2 eq $cnum) {
6117: $groups{$3} = $env{$key} ;
6118: }
6119: }
6120: }
6121: return %groups;
6122: }
6123:
1.683 raeburn 6124: sub get_group_membership {
6125: my ($cdom,$cnum,$group) = @_;
6126: return(&dump('groupmembership',$cdom,$cnum,$group));
6127: }
6128:
6129: sub get_users_groups {
6130: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 6131: my @usersgroups;
1.683 raeburn 6132: my $cachetime=1800;
6133:
6134: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 6135: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6136: if (defined($cached)) {
1.734 albertel 6137: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 6138: } else {
6139: $grouplist = '';
1.816 raeburn 6140: my $courseurl = &courseid_to_courseurl($courseid);
6141: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 6142: my $access_end = $env{'course.'.$courseid.
6143: '.default_enrollment_end_date'};
6144: my $now = time;
6145: foreach my $key (keys(%roleshash)) {
6146: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6147: my $group = $1;
6148: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6149: my $start = $2;
6150: my $end = $1;
6151: if ($start == -1) { next; } # deleted from group
6152: if (($start!=0) && ($start>$now)) { next; }
6153: if (($end!=0) && ($end<$now)) {
6154: if ($access_end && $access_end < $now) {
6155: if ($access_end - $end < 86400) {
6156: push(@usersgroups,$group);
1.733 raeburn 6157: }
6158: }
1.817 raeburn 6159: next;
1.733 raeburn 6160: }
1.817 raeburn 6161: push(@usersgroups,$group);
1.683 raeburn 6162: }
6163: }
6164: }
1.817 raeburn 6165: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6166: $grouplist = join(':',@usersgroups);
6167: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 6168: }
1.733 raeburn 6169: return @usersgroups;
1.683 raeburn 6170: }
6171:
6172: sub devalidate_getgroups_cache {
6173: my ($udom,$uname,$cdom,$cnum)=@_;
6174: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 6175:
1.683 raeburn 6176: my $hashid="$udom:$uname:$courseid";
6177: &devalidate_cache_new('getgroups',$hashid);
6178: }
6179:
1.12 www 6180: # ------------------------------------------------------------------ Plain Text
6181:
6182: sub plaintext {
1.988 raeburn 6183: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 6184: if ($short =~ m{^cr/}) {
1.758 albertel 6185: return (split('/',$short))[-1];
6186: }
1.742 raeburn 6187: if (!defined($cid)) {
6188: $cid = $env{'request.course.id'};
6189: }
6190: my %rolenames = (
1.1008 raeburn 6191: Course => 'std',
6192: Community => 'alt1',
1.742 raeburn 6193: );
1.1037 raeburn 6194: if ($cid ne '') {
6195: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6196: unless ($forcedefault) {
6197: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6198: &Apache::lonlocal::mt_escape(\$roletext);
6199: return &Apache::lonlocal::mt($roletext);
6200: }
6201: }
6202: }
6203: if ((defined($type)) && (defined($rolenames{$type})) &&
6204: (defined($rolenames{$type})) &&
6205: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 6206: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 6207: } elsif ($cid ne '') {
6208: my $crstype = $env{'course.'.$cid.'.type'};
6209: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6210: (defined($prp{$short}{$rolenames{$crstype}}))) {
6211: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6212: }
1.742 raeburn 6213: }
1.1037 raeburn 6214: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 6215: }
6216:
6217: # ----------------------------------------------------------------- Assign Role
6218:
6219: sub assignrole {
1.957 raeburn 6220: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6221: $context)=@_;
1.21 www 6222: my $mrole;
6223: if ($role =~ /^cr\//) {
1.393 www 6224: my $cwosec=$url;
1.811 albertel 6225: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 6226: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 6227: my $refused = 1;
6228: if ($context eq 'requestcourses') {
6229: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6230: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6231: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6232: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6233: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6234: if ($crsenv{'internal.courseowner'} eq
6235: $env{'user.name'}.':'.$env{'user.domain'}) {
6236: $refused = '';
6237: }
6238: }
6239: }
6240: }
6241: }
6242: if ($refused) {
6243: &logthis('Refused custom assignrole: '.
6244: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6245: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6246: return 'refused';
6247: }
1.104 www 6248: }
1.21 www 6249: $mrole='cr';
1.678 raeburn 6250: } elsif ($role =~ /^gr\//) {
6251: my $cwogrp=$url;
1.811 albertel 6252: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 6253: unless (&allowed('mdg',$cwogrp)) {
6254: &logthis('Refused group assignrole: '.
6255: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6256: $env{'user.name'}.' at '.$env{'user.domain'});
6257: return 'refused';
6258: }
6259: $mrole='gr';
1.21 www 6260: } else {
1.82 www 6261: my $cwosec=$url;
1.811 albertel 6262: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 6263: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6264: my $refused;
6265: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6266: if (!(&allowed('c'.$role,$url))) {
6267: $refused = 1;
6268: }
6269: } else {
6270: $refused = 1;
6271: }
1.947 raeburn 6272: if ($refused) {
1.1045 raeburn 6273: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6274: if (!$selfenroll && $context eq 'course') {
6275: my %crsenv;
6276: if ($role eq 'cc' || $role eq 'co') {
6277: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6278: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6279: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6280: if ($crsenv{'internal.courseowner'} eq
6281: $env{'user.name'}.':'.$env{'user.domain'}) {
6282: $refused = '';
6283: }
6284: }
6285: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6286: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6287: if ($crsenv{'internal.courseowner'} eq
6288: $env{'user.name'}.':'.$env{'user.domain'}) {
6289: $refused = '';
6290: }
6291: }
6292: }
6293: }
6294: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 6295: $refused = '';
1.1017 raeburn 6296: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 6297: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 6298: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 6299: my $wrongcc;
6300: if ($cnum =~ /^$match_community$/) {
6301: $wrongcc = 1 if ($role eq 'cc');
6302: } else {
6303: $wrongcc = 1 if ($role eq 'co');
6304: }
6305: unless ($wrongcc) {
6306: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6307: if ($crsenv{'internal.courseowner'} eq
6308: $env{'user.name'}.':'.$env{'user.domain'}) {
6309: $refused = '';
6310: }
1.1017 raeburn 6311: }
6312: }
6313: }
6314: if ($refused) {
1.947 raeburn 6315: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6316: ' '.$role.' '.$end.' '.$start.' by '.
6317: $env{'user.name'}.' at '.$env{'user.domain'});
6318: return 'refused';
6319: }
1.932 raeburn 6320: }
1.104 www 6321: }
1.21 www 6322: $mrole=$role;
6323: }
1.620 albertel 6324: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 6325: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 6326: if ($end) { $command.='_'.$end; }
1.21 www 6327: if ($start) {
6328: if ($end) {
1.81 www 6329: $command.='_'.$start;
1.21 www 6330: } else {
1.81 www 6331: $command.='_0_'.$start;
1.21 www 6332: }
6333: }
1.739 raeburn 6334: my $origstart = $start;
6335: my $origend = $end;
1.957 raeburn 6336: my $delflag;
1.357 www 6337: # actually delete
6338: if ($deleteflag) {
1.373 www 6339: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 6340: # modify command to delete the role
1.620 albertel 6341: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 6342: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 6343: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 6344: # set start and finish to negative values for userrolelog
6345: $start=-1;
6346: $end=-1;
1.957 raeburn 6347: $delflag = 1;
1.357 www 6348: }
6349: }
6350: # send command
1.349 www 6351: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 6352: # log new user role if status is ok
1.349 www 6353: if ($answer eq 'ok') {
1.663 raeburn 6354: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 6355: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 6356: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 6357: unless ($role =~ /^gr/) {
6358: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 6359: $origstart,$selfenroll,$context);
1.739 raeburn 6360: }
1.1053 raeburn 6361: if ($role eq 'cc') {
6362: &autoupdate_coowners($url,$end,$start,$uname,$udom);
6363: }
1.349 www 6364: }
6365: return $answer;
1.169 harris41 6366: }
6367:
1.1053 raeburn 6368: sub autoupdate_coowners {
6369: my ($url,$end,$start,$uname,$udom) = @_;
6370: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
6371: if (($cdom ne '') && ($cnum ne '')) {
6372: my $now = time;
6373: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
6374: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
6375: my %coursehash = &coursedescription($cdom.'_'.$cnum);
6376: my $instcode = $coursehash{'internal.coursecode'};
6377: if ($instcode ne '') {
6378: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
6379: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
6380: if ($result eq 'valid') {
6381: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
6382: if (($end == 0) || ($end > $now)) {
6383: if ($coursehash{'internal.co-owners'}) {
6384: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6385: push(@newcoowners,$coowner);
6386: }
6387: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
6388: push(@newcoowners,$uname.':'.$udom);
6389: }
6390: @newcoowners = sort(@newcoowners);
6391: } else {
6392: push(@newcoowners,$uname.':'.$udom);
6393: }
6394: } else {
6395: if ($coursehash{'internal.co-owners'}) {
6396: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6397: unless ($coowner eq $uname.':'.$udom) {
6398: push(@newcoowners,$coowner);
6399: }
6400: }
6401: unless (@newcoowners > 0) {
6402: $delcoowners = 1;
6403: $coowners = '';
6404: }
6405: }
6406: }
6407: if (@newcoowners || $delcoowners) {
6408: &store_coowners($cdom,$cnum,$coursehash{'home'},
6409: $delcoowners,@newcoowners);
6410: }
6411: }
6412: }
6413: }
6414: }
6415: }
6416: }
6417:
6418: sub store_coowners {
6419: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
6420: my $cid = $cdom.'_'.$cnum;
6421: my ($coowners,$delresult,$putresult);
6422: if (@newcoowners) {
6423: $coowners = join(',',@newcoowners);
6424: my %coownershash = (
6425: 'internal.co-owners' => $coowners,
6426: );
6427: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
6428: if ($putresult eq 'ok') {
6429: if ($env{'course.'.$cid.'.num'} eq $cnum) {
6430: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
6431: }
6432: }
6433: }
6434: if ($delcoowners) {
6435: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
6436: if ($delresult eq 'ok') {
6437: if ($env{'course.'.$cid.'.internal.co-owners'}) {
6438: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
6439: }
6440: }
6441: }
6442: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
6443: my %crsinfo =
6444: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6445: if (ref($crsinfo{$cid}) eq 'HASH') {
6446: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
6447: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
6448: }
6449: }
6450: }
6451:
1.169 harris41 6452: # -------------------------------------------------- Modify user authentication
1.197 www 6453: # Overrides without validation
6454:
1.169 harris41 6455: sub modifyuserauth {
6456: my ($udom,$uname,$umode,$upass)=@_;
6457: my $uhome=&homeserver($uname,$udom);
1.197 www 6458: unless (&allowed('mau',$udom)) { return 'refused'; }
6459: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 6460: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6461: ' in domain '.$env{'request.role.domain'});
1.169 harris41 6462: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6463: &escape($upass),$uhome);
1.620 albertel 6464: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 6465: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6466: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6467: &log($udom,,$uname,$uhome,
1.620 albertel 6468: 'Authentication changed by '.$env{'user.domain'}.', '.
6469: $env{'user.name'}.', '.$umode.
1.197 www 6470: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 6471: unless ($reply eq 'ok') {
1.197 www 6472: &logthis('Authentication mode error: '.$reply);
1.169 harris41 6473: return 'error: '.$reply;
6474: }
1.170 harris41 6475: return 'ok';
1.80 www 6476: }
6477:
1.81 www 6478: # --------------------------------------------------------------- Modify a user
1.80 www 6479:
1.81 www 6480: sub modifyuser {
1.206 matthew 6481: my ($udom, $uname, $uid,
6482: $umode, $upass, $first,
6483: $middle, $last, $gene,
1.963 raeburn 6484: $forceid, $desiredhome, $email, $inststatus)=@_;
1.807 albertel 6485: $udom= &LONCAPA::clean_domain($udom);
6486: $uname=&LONCAPA::clean_username($uname);
1.81 www 6487: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 6488: $umode.', '.$first.', '.$middle.', '.
1.206 matthew 6489: $last.', '.$gene.'(forceid: '.$forceid.')'.
6490: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6491: ' desiredhome not specified').
1.620 albertel 6492: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6493: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 6494: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 6495: # ----------------------------------------------------------------- Create User
1.406 albertel 6496: if (($uhome eq 'no_host') &&
6497: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 6498: my $unhome='';
1.844 albertel 6499: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 6500: $unhome = $desiredhome;
1.620 albertel 6501: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6502: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 6503: } else { # load balancing routine for determining $unhome
1.81 www 6504: my $loadm=10000000;
1.841 albertel 6505: my %servers = &get_servers($udom,'library');
6506: foreach my $tryserver (keys(%servers)) {
6507: my $answer=reply('load',$tryserver);
6508: if (($answer=~/\d+/) && ($answer<$loadm)) {
6509: $loadm=$answer;
6510: $unhome=$tryserver;
6511: }
1.80 www 6512: }
6513: }
6514: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 6515: return 'error: unable to find a home server for '.$uname.
6516: ' in domain '.$udom;
1.80 www 6517: }
6518: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6519: &escape($upass),$unhome);
6520: unless ($reply eq 'ok') {
6521: return 'error: '.$reply;
6522: }
1.230 stredwic 6523: $uhome=&homeserver($uname,$udom,'true');
1.80 www 6524: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 6525: return 'error: unable verify users home machine.';
1.80 www 6526: }
1.209 matthew 6527: } # End of creation of new user
1.80 www 6528: # ---------------------------------------------------------------------- Add ID
6529: if ($uid) {
6530: $uid=~tr/A-Z/a-z/;
6531: my %uidhash=&idrget($udom,$uname);
1.196 www 6532: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6533: && (!$forceid)) {
1.80 www 6534: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 6535: return 'error: user id "'.$uid.'" does not match '.
6536: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 6537: }
6538: } else {
6539: &idput($udom,($uname => $uid));
6540: }
6541: }
6542: # -------------------------------------------------------------- Add names, etc
1.313 matthew 6543: my @tmp=&get('environment',
1.899 raeburn 6544: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 6545: 'permanentemail','inststatus'],
1.134 albertel 6546: $udom,$uname);
1.313 matthew 6547: my %names;
6548: if ($tmp[0] =~ m/^error:.*/) {
6549: %names=();
6550: } else {
6551: %names = @tmp;
6552: }
1.388 www 6553: #
6554: # Make sure to not trash student environment if instructor does not bother
6555: # to supply name and email information
6556: #
6557: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 6558: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 6559: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 6560: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 6561: if ($email) {
6562: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 6563: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 6564: }
1.899 raeburn 6565: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 6566: if (defined($inststatus)) {
6567: $names{'inststatus'} = '';
6568: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6569: if (ref($usertypes) eq 'HASH') {
6570: my @okstatuses;
6571: foreach my $item (split(/:/,$inststatus)) {
6572: if (defined($usertypes->{$item})) {
6573: push(@okstatuses,$item);
6574: }
6575: }
6576: if (@okstatuses) {
6577: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6578: }
6579: }
6580: }
1.134 albertel 6581: my $reply = &put('environment', \%names, $udom,$uname);
6582: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 6583: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 6584: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.963 raeburn 6585: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6586: $umode.', '.$first.', '.$middle.', '.
6587: $last.', '.$gene.', '.$email.', '.$inststatus;
6588: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6589: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6590: } else {
6591: $logmsg .= ' during self creation';
6592: }
6593: &logthis($logmsg);
1.134 albertel 6594: return 'ok';
1.80 www 6595: }
6596:
1.81 www 6597: # -------------------------------------------------------------- Modify student
1.80 www 6598:
1.81 www 6599: sub modifystudent {
6600: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 6601: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 6602: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 6603: if (!$cid) {
1.620 albertel 6604: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6605: return 'not_in_class';
6606: }
1.80 www 6607: }
6608: # --------------------------------------------------------------- Make the user
1.81 www 6609: my $reply=&modifyuser
1.209 matthew 6610: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 6611: $desiredhome,$email,$inststatus);
1.80 www 6612: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 6613: # This will cause &modify_student_enrollment to get the uid from the
6614: # students environment
6615: $uid = undef if (!$forceid);
1.455 albertel 6616: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 6617: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 6618: return $reply;
6619: }
6620:
6621: sub modify_student_enrollment {
1.957 raeburn 6622: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 6623: my ($cdom,$cnum,$chome);
6624: if (!$cid) {
1.620 albertel 6625: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6626: return 'not_in_class';
6627: }
1.620 albertel 6628: $cdom=$env{'course.'.$cid.'.domain'};
6629: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 6630: } else {
6631: ($cdom,$cnum)=split(/_/,$cid);
6632: }
1.620 albertel 6633: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 6634: if (!$chome) {
1.457 raeburn 6635: $chome=&homeserver($cnum,$cdom);
1.297 matthew 6636: }
1.455 albertel 6637: if (!$chome) { return 'unknown_course'; }
1.297 matthew 6638: # Make sure the user exists
1.81 www 6639: my $uhome=&homeserver($uname,$udom);
6640: if (($uhome eq '') || ($uhome eq 'no_host')) {
6641: return 'error: no such user';
6642: }
1.297 matthew 6643: # Get student data if we were not given enough information
6644: if (!defined($first) || $first eq '' ||
6645: !defined($last) || $last eq '' ||
6646: !defined($uid) || $uid eq '' ||
6647: !defined($middle) || $middle eq '' ||
6648: !defined($gene) || $gene eq '') {
1.294 matthew 6649: # They did not supply us with enough data to enroll the student, so
6650: # we need to pick up more information.
1.297 matthew 6651: my %tmp = &get('environment',
1.294 matthew 6652: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 6653: ,$udom,$uname);
6654:
1.800 albertel 6655: #foreach my $key (keys(%tmp)) {
6656: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 6657: #}
1.294 matthew 6658: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6659: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6660: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 6661: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 6662: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6663: }
1.556 albertel 6664: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 6665: my $reply=cput('classlist',
6666: {"$uname:$udom" =>
1.515 raeburn 6667: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 6668: $cdom,$cnum);
1.81 www 6669: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6670: return 'error: '.$reply;
1.652 albertel 6671: } else {
6672: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 6673: }
1.297 matthew 6674: # Add student role to user
1.83 www 6675: my $uurl='/'.$cid;
1.81 www 6676: $uurl=~s/\_/\//g;
6677: if ($usec) {
6678: $uurl.='/'.$usec;
6679: }
1.957 raeburn 6680: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21 www 6681: }
6682:
1.556 albertel 6683: sub format_name {
6684: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6685: my $name;
6686: if ($first ne 'lastname') {
6687: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6688: } else {
6689: if ($lastname=~/\S/) {
6690: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6691: $name=~s/\s+,/,/;
6692: } else {
6693: $name.= $firstname.' '.$middlename.' '.$generation;
6694: }
6695: }
6696: $name=~s/^\s+//;
6697: $name=~s/\s+$//;
6698: $name=~s/\s+/ /g;
6699: return $name;
6700: }
6701:
1.84 www 6702: # ------------------------------------------------- Write to course preferences
6703:
6704: sub writecoursepref {
6705: my ($courseid,%prefs)=@_;
6706: $courseid=~s/^\///;
6707: $courseid=~s/\_/\//g;
6708: my ($cdomain,$cnum)=split(/\//,$courseid);
6709: my $chome=homeserver($cnum,$cdomain);
6710: if (($chome eq '') || ($chome eq 'no_host')) {
6711: return 'error: no such course';
6712: }
6713: my $cstring='';
1.800 albertel 6714: foreach my $pref (keys(%prefs)) {
6715: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 6716: }
1.84 www 6717: $cstring=~s/\&$//;
6718: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6719: }
6720:
6721: # ---------------------------------------------------------- Make/modify course
6722:
6723: sub createcourse {
1.741 raeburn 6724: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 6725: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 6726: $url=&declutter($url);
6727: my $cid='';
1.1028 raeburn 6728: if ($context eq 'requestcourses') {
6729: my $can_create = 0;
6730: my ($ownername,$ownerdom) = split(':',$course_owner);
6731: if ($udom eq $ownerdom) {
6732: if (&usertools_access($ownername,$ownerdom,$category,undef,
6733: $context)) {
6734: $can_create = 1;
6735: }
6736: } else {
6737: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6738: $category);
6739: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6740: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6741: if (@curr > 0) {
6742: my @options = qw(approval validate autolimit);
6743: my $optregex = join('|',@options);
6744: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6745: $can_create = 1;
6746: }
6747: }
6748: }
6749: }
6750: if ($can_create) {
6751: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6752: unless (&allowed('ccc',$udom)) {
6753: return 'refused';
6754: }
1.1017 raeburn 6755: }
6756: } else {
6757: return 'refused';
6758: }
1.1028 raeburn 6759: } elsif (!&allowed('ccc',$udom)) {
6760: return 'refused';
1.84 www 6761: }
1.1011 raeburn 6762: # --------------------------------------------------------------- Get Unique ID
6763: my $uname;
6764: if ($cnum =~ /^$match_courseid$/) {
6765: my $chome=&homeserver($cnum,$udom,'true');
6766: if (($chome eq '') || ($chome eq 'no_host')) {
6767: $uname = $cnum;
6768: } else {
1.1038 raeburn 6769: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6770: }
6771: } else {
1.1038 raeburn 6772: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6773: }
6774: return $uname if ($uname =~ /^error/);
6775: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 6776: if (!defined($course_server)) {
6777: if (defined(&domain($udom,'primary'))) {
6778: $course_server = &domain($udom,'primary');
6779: } else {
6780: $course_server = $env{'user.home'};
6781: }
6782: }
6783: my %host_servers =
6784: &Apache::lonnet::get_servers($udom,'library');
6785: unless ($host_servers{$course_server}) {
6786: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 6787: }
1.84 www 6788: # ------------------------------------------------------------- Make the course
6789: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 6790: $course_server);
1.84 www 6791: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 6792: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 6793: if (($uhome eq '') || ($uhome eq 'no_host')) {
6794: return 'error: no such course';
6795: }
1.271 www 6796: # ----------------------------------------------------------------- Course made
1.516 raeburn 6797: # log existence
1.1029 raeburn 6798: my $now = time;
1.918 raeburn 6799: my $newcourse = {
6800: $udom.'_'.$uname => {
1.921 raeburn 6801: description => $description,
6802: inst_code => $inst_code,
6803: owner => $course_owner,
6804: type => $crstype,
1.1029 raeburn 6805: creator => $env{'user.name'}.':'.
6806: $env{'user.domain'},
6807: created => $now,
6808: context => $context,
1.918 raeburn 6809: },
6810: };
1.921 raeburn 6811: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 6812: # set toplevel url
1.271 www 6813: my $topurl=$url;
6814: unless ($nonstandard) {
6815: # ------------------------------------------ For standard courses, make top url
6816: my $mapurl=&clutter($url);
1.278 www 6817: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 6818: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 6819: <map>
6820: <resource id="1" type="start"></resource>
6821: <resource id="2" src="$mapurl"></resource>
6822: <resource id="3" type="finish"></resource>
6823: <link index="1" from="1" to="2"></link>
6824: <link index="2" from="2" to="3"></link>
6825: </map>
6826: ENDINITMAP
6827: $topurl=&declutter(
1.638 albertel 6828: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 6829: );
6830: }
6831: # ----------------------------------------------------------- Write preferences
1.84 www 6832: &writecoursepref($udom.'_'.$uname,
6833: ('description' => $description,
1.271 www 6834: 'url' => $topurl));
1.84 www 6835: return '/'.$udom.'/'.$uname;
6836: }
6837:
1.1011 raeburn 6838: # ------------------------------------------------------------------- Create ID
6839: sub generate_coursenum {
1.1038 raeburn 6840: my ($udom,$crstype) = @_;
1.1011 raeburn 6841: my $domdesc = &domain($udom);
6842: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 6843: my $first;
6844: if ($crstype eq 'Community') {
6845: $first = '0';
6846: } else {
6847: $first = int(1+rand(9));
6848: }
6849: my $uname=$first.
1.1011 raeburn 6850: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6851: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6852: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6853: # ----------------------------------------------- Make sure that does not exist
6854: my $uhome=&homeserver($uname,$udom,'true');
6855: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 6856: if ($crstype eq 'Community') {
6857: $first = '0';
6858: } else {
6859: $first = int(1+rand(9));
6860: }
6861: $uname=$first.
1.1011 raeburn 6862: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6863: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6864: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6865: $uhome=&homeserver($uname,$udom,'true');
6866: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6867: return 'error: unable to generate unique course-ID';
6868: }
6869: }
6870: return $uname;
6871: }
6872:
1.813 albertel 6873: sub is_course {
6874: my ($cdom,$cnum) = @_;
6875: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946 raeburn 6876: undef,'.');
1.813 albertel 6877: if (exists($courses{$cdom.'_'.$cnum})) {
6878: return 1;
6879: }
6880: return 0;
6881: }
6882:
1.1015 raeburn 6883: sub store_userdata {
6884: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 6885: my $result;
1.1016 raeburn 6886: if ($datakey ne '') {
1.1013 raeburn 6887: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 6888: if ($udom eq '' || $uname eq '') {
6889: $udom = $env{'user.domain'};
6890: $uname = $env{'user.name'};
6891: }
6892: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 6893: if (($uhome eq '') || ($uhome eq 'no_host')) {
6894: $result = 'error: no_host';
6895: } else {
6896: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6897: $storehash->{'host'} = $perlvar{'lonHostID'};
6898:
6899: my $namevalue='';
6900: foreach my $key (keys(%{$storehash})) {
6901: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6902: }
6903: $namevalue=~s/\&$//;
6904: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
1.1015 raeburn 6905: "$namespace:$datakey:$namevalue",$uhome);
1.1013 raeburn 6906: }
6907: } else {
6908: $result = 'error: data to store was not a hash reference';
6909: }
6910: } else {
6911: $result= 'error: invalid requestkey';
6912: }
6913: return $result;
6914: }
6915:
1.21 www 6916: # ---------------------------------------------------------- Assign Custom Role
6917:
6918: sub assigncustomrole {
1.957 raeburn 6919: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6920: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 6921: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 6922: }
6923:
6924: # ----------------------------------------------------------------- Revoke Role
6925:
6926: sub revokerole {
1.957 raeburn 6927: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6928: my $now=time;
1.965 raeburn 6929: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 6930: }
6931:
6932: # ---------------------------------------------------------- Revoke Custom Role
6933:
6934: sub revokecustomrole {
1.957 raeburn 6935: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6936: my $now=time;
1.357 www 6937: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 6938: $deleteflag,$selfenroll,$context);
1.17 www 6939: }
6940:
1.533 banghart 6941: # ------------------------------------------------------------ Disk usage
1.535 albertel 6942: sub diskusage {
1.955 raeburn 6943: my ($udom,$uname,$directorypath,$getpropath)=@_;
6944: $directorypath =~ s/\/$//;
6945: my $listing=&reply('du2:'.&escape($directorypath).':'
6946: .&escape($getpropath).':'.&escape($uname).':'
6947: .&escape($udom),homeserver($uname,$udom));
6948: if ($listing eq 'unknown_cmd') {
6949: if ($getpropath) {
6950: $directorypath = &propath($udom,$uname).'/'.$directorypath;
6951: }
6952: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
6953: }
1.514 albertel 6954: return $listing;
1.512 banghart 6955: }
6956:
1.566 banghart 6957: sub is_locked {
6958: my ($file_name, $domain, $user) = @_;
6959: my @check;
6960: my $is_locked;
6961: push @check, $file_name;
1.613 albertel 6962: my %locked = &get('file_permissions',\@check,
1.620 albertel 6963: $env{'user.domain'},$env{'user.name'});
1.615 albertel 6964: my ($tmp)=keys(%locked);
6965: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 6966:
1.566 banghart 6967: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 6968: $is_locked = 'false';
6969: foreach my $entry (@{$locked{$file_name}}) {
6970: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 6971: $is_locked = 'true';
6972: last;
1.745 raeburn 6973: }
6974: }
1.566 banghart 6975: } else {
6976: $is_locked = 'false';
6977: }
6978: }
6979:
1.759 albertel 6980: sub declutter_portfile {
6981: my ($file) = @_;
1.833 albertel 6982: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 6983: return $file;
6984: }
6985:
1.559 banghart 6986: # ------------------------------------------------------------- Mark as Read Only
6987:
6988: sub mark_as_readonly {
6989: my ($domain,$user,$files,$what) = @_;
1.613 albertel 6990: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 6991: my ($tmp)=keys(%current_permissions);
6992: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 6993: foreach my $file (@{$files}) {
1.759 albertel 6994: $file = &declutter_portfile($file);
1.561 banghart 6995: push(@{$current_permissions{$file}},$what);
1.559 banghart 6996: }
1.613 albertel 6997: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 6998: return;
6999: }
7000:
1.572 banghart 7001: # ------------------------------------------------------------Save Selected Files
7002:
7003: sub save_selected_files {
7004: my ($user, $path, @files) = @_;
7005: my $filename = $user."savedfiles";
1.573 banghart 7006: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 7007: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 7008: foreach my $file (@files) {
1.620 albertel 7009: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 7010: }
7011: foreach my $file (@other_files) {
1.574 banghart 7012: print (OUT $file."\n");
1.572 banghart 7013: }
1.574 banghart 7014: close (OUT);
1.572 banghart 7015: return 'ok';
7016: }
7017:
1.574 banghart 7018: sub clear_selected_files {
7019: my ($user) = @_;
7020: my $filename = $user."savedfiles";
7021: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7022: print (OUT undef);
7023: close (OUT);
7024: return ("ok");
7025: }
7026:
1.572 banghart 7027: sub files_in_path {
7028: my ($user, $path) = @_;
7029: my $filename = $user."savedfiles";
7030: my %return_files;
1.574 banghart 7031: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 7032: while (my $line_in = <IN>) {
1.574 banghart 7033: chomp ($line_in);
7034: my @paths_and_file = split (m!/!, $line_in);
7035: my $file_part = pop (@paths_and_file);
7036: my $path_part = join ('/', @paths_and_file);
1.573 banghart 7037: $path_part.='/';
7038: my $path_and_file = $path_part.$file_part;
7039: if ($path_part eq $path) {
7040: $return_files{$file_part}= 'selected';
7041: }
7042: }
1.574 banghart 7043: close (IN);
7044: return (\%return_files);
1.572 banghart 7045: }
7046:
7047: # called in portfolio select mode, to show files selected NOT in current directory
7048: sub files_not_in_path {
7049: my ($user, $path) = @_;
7050: my $filename = $user."savedfiles";
7051: my @return_files;
7052: my $path_part;
1.800 albertel 7053: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7054: while (my $line = <IN>) {
1.572 banghart 7055: #ok, I know it's clunky, but I want it to work
1.800 albertel 7056: my @paths_and_file = split(m|/|, $line);
7057: my $file_part = pop(@paths_and_file);
7058: chomp($file_part);
7059: my $path_part = join('/', @paths_and_file);
1.572 banghart 7060: $path_part .= '/';
7061: my $path_and_file = $path_part.$file_part;
7062: if ($path_part ne $path) {
1.800 albertel 7063: push(@return_files, ($path_and_file));
1.572 banghart 7064: }
7065: }
1.800 albertel 7066: close(OUT);
1.574 banghart 7067: return (@return_files);
1.572 banghart 7068: }
7069:
1.745 raeburn 7070: #----------------------------------------------Get portfolio file permissions
1.629 banghart 7071:
1.745 raeburn 7072: sub get_portfile_permissions {
7073: my ($domain,$user) = @_;
1.613 albertel 7074: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 7075: my ($tmp)=keys(%current_permissions);
7076: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7077: return \%current_permissions;
7078: }
7079:
7080: #---------------------------------------------Get portfolio file access controls
7081:
1.749 raeburn 7082: sub get_access_controls {
1.745 raeburn 7083: my ($current_permissions,$group,$file) = @_;
1.769 albertel 7084: my %access;
7085: my $real_file = $file;
7086: $file =~ s/\.meta$//;
1.745 raeburn 7087: if (defined($file)) {
1.749 raeburn 7088: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7089: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 7090: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 7091: }
7092: }
1.745 raeburn 7093: } else {
1.749 raeburn 7094: foreach my $key (keys(%{$current_permissions})) {
7095: if ($key =~ /\0accesscontrol$/) {
7096: if (defined($group)) {
7097: if ($key !~ m-^\Q$group\E/-) {
7098: next;
7099: }
7100: }
7101: my ($fullpath) = split(/\0/,$key);
7102: if (ref($$current_permissions{$key}) eq 'HASH') {
7103: foreach my $control (keys(%{$$current_permissions{$key}})) {
7104: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7105: }
7106: }
7107: }
7108: }
7109: }
7110: return %access;
7111: }
7112:
7113: sub modify_access_controls {
7114: my ($file_name,$changes,$domain,$user)=@_;
7115: my ($outcome,$deloutcome);
7116: my %store_permissions;
7117: my %new_values;
7118: my %new_control;
7119: my %translation;
7120: my @deletions = ();
7121: my $now = time;
7122: if (exists($$changes{'activate'})) {
7123: if (ref($$changes{'activate'}) eq 'HASH') {
7124: my @newitems = sort(keys(%{$$changes{'activate'}}));
7125: my $numnew = scalar(@newitems);
7126: for (my $i=0; $i<$numnew; $i++) {
7127: my $newkey = $newitems[$i];
7128: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 7129: if ($newkey =~ /^\d+:/) {
7130: $newkey =~ s/^(\d+)/$newid/;
7131: $translation{$1} = $newid;
7132: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7133: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7134: $translation{$1} = $newid;
7135: }
1.749 raeburn 7136: $new_values{$file_name."\0".$newkey} =
7137: $$changes{'activate'}{$newitems[$i]};
7138: $new_control{$newkey} = $now;
7139: }
7140: }
7141: }
7142: my %todelete;
7143: my %changed_items;
7144: foreach my $action ('delete','update') {
7145: if (exists($$changes{$action})) {
7146: if (ref($$changes{$action}) eq 'HASH') {
7147: foreach my $key (keys(%{$$changes{$action}})) {
7148: my ($itemnum) = ($key =~ /^([^:]+):/);
7149: if ($action eq 'delete') {
7150: $todelete{$itemnum} = 1;
7151: } else {
7152: $changed_items{$itemnum} = $key;
7153: }
7154: }
1.745 raeburn 7155: }
7156: }
1.749 raeburn 7157: }
7158: # get lock on access controls for file.
7159: my $lockhash = {
7160: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7161: ':'.$env{'user.domain'},
7162: };
7163: my $tries = 0;
7164: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7165:
7166: while (($gotlock ne 'ok') && $tries <3) {
7167: $tries ++;
7168: sleep 1;
7169: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7170: }
7171: if ($gotlock eq 'ok') {
7172: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7173: my ($tmp)=keys(%curr_permissions);
7174: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7175: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7176: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7177: if (ref($curr_controls) eq 'HASH') {
7178: foreach my $control_item (keys(%{$curr_controls})) {
7179: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7180: if (defined($todelete{$itemnum})) {
7181: push(@deletions,$file_name."\0".$control_item);
7182: } else {
7183: if (defined($changed_items{$itemnum})) {
7184: $new_control{$changed_items{$itemnum}} = $now;
7185: push(@deletions,$file_name."\0".$control_item);
7186: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7187: } else {
7188: $new_control{$control_item} = $$curr_controls{$control_item};
7189: }
7190: }
1.745 raeburn 7191: }
7192: }
7193: }
1.970 raeburn 7194: my ($group);
7195: if (&is_course($domain,$user)) {
7196: ($group,my $file) = split(/\//,$file_name,2);
7197: }
1.749 raeburn 7198: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7199: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7200: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7201: # remove lock
7202: my @del_lock = ($file_name."\0".'locked_access_records');
7203: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 7204: my $sqlresult =
1.970 raeburn 7205: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 7206: $group);
1.749 raeburn 7207: } else {
7208: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 7209: }
1.749 raeburn 7210: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 7211: }
7212:
1.827 raeburn 7213: sub make_public_indefinitely {
7214: my ($requrl) = @_;
7215: my $now = time;
7216: my $action = 'activate';
7217: my $aclnum = 0;
7218: if (&is_portfolio_url($requrl)) {
7219: my (undef,$udom,$unum,$file_name,$group) =
7220: &parse_portfolio_url($requrl);
7221: my $current_perms = &get_portfile_permissions($udom,$unum);
7222: my %access_controls = &get_access_controls($current_perms,
7223: $group,$file_name);
7224: foreach my $key (keys(%{$access_controls{$file_name}})) {
7225: my ($num,$scope,$end,$start) =
7226: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7227: if ($scope eq 'public') {
7228: if ($start <= $now && $end == 0) {
7229: $action = 'none';
7230: } else {
7231: $action = 'update';
7232: $aclnum = $num;
7233: }
7234: last;
7235: }
7236: }
7237: if ($action eq 'none') {
7238: return 'ok';
7239: } else {
7240: my %changes;
7241: my $newend = 0;
7242: my $newstart = $now;
7243: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7244: $changes{$action}{$newkey} = {
7245: type => 'public',
7246: time => {
7247: start => $newstart,
7248: end => $newend,
7249: },
7250: };
7251: my ($outcome,$deloutcome,$new_values,$translation) =
7252: &modify_access_controls($file_name,\%changes,$udom,$unum);
7253: return $outcome;
7254: }
7255: } else {
7256: return 'invalid';
7257: }
7258: }
7259:
1.745 raeburn 7260: #------------------------------------------------------Get Marked as Read Only
7261:
7262: sub get_marked_as_readonly {
7263: my ($domain,$user,$what,$group) = @_;
7264: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 7265: my @readonly_files;
1.629 banghart 7266: my $cmp1=$what;
7267: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 7268: while (my ($file_name,$value) = each(%{$current_permissions})) {
7269: if (defined($group)) {
7270: if ($file_name !~ m-^\Q$group\E/-) {
7271: next;
7272: }
7273: }
1.561 banghart 7274: if (ref($value) eq "ARRAY"){
7275: foreach my $stored_what (@{$value}) {
1.629 banghart 7276: my $cmp2=$stored_what;
1.759 albertel 7277: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 7278: $cmp2=join('',@{$stored_what});
1.745 raeburn 7279: }
1.629 banghart 7280: if ($cmp1 eq $cmp2) {
1.561 banghart 7281: push(@readonly_files, $file_name);
1.745 raeburn 7282: last;
1.563 banghart 7283: } elsif (!defined($what)) {
7284: push(@readonly_files, $file_name);
1.745 raeburn 7285: last;
1.561 banghart 7286: }
7287: }
1.745 raeburn 7288: }
1.561 banghart 7289: }
7290: return @readonly_files;
7291: }
1.577 banghart 7292: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 7293:
1.577 banghart 7294: sub get_marked_as_readonly_hash {
1.745 raeburn 7295: my ($current_permissions,$group,$what) = @_;
1.577 banghart 7296: my %readonly_files;
1.745 raeburn 7297: while (my ($file_name,$value) = each(%{$current_permissions})) {
7298: if (defined($group)) {
7299: if ($file_name !~ m-^\Q$group\E/-) {
7300: next;
7301: }
7302: }
1.577 banghart 7303: if (ref($value) eq "ARRAY"){
7304: foreach my $stored_what (@{$value}) {
1.745 raeburn 7305: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 7306: foreach my $lock_descriptor(@{$stored_what}) {
7307: if ($lock_descriptor eq 'graded') {
7308: $readonly_files{$file_name} = 'graded';
7309: } elsif ($lock_descriptor eq 'handback') {
7310: $readonly_files{$file_name} = 'handback';
7311: } else {
7312: if (!exists($readonly_files{$file_name})) {
7313: $readonly_files{$file_name} = 'locked';
7314: }
7315: }
1.745 raeburn 7316: }
1.750 banghart 7317: }
1.577 banghart 7318: }
7319: }
7320: }
7321: return %readonly_files;
7322: }
1.559 banghart 7323: # ------------------------------------------------------------ Unmark as Read Only
7324:
7325: sub unmark_as_readonly {
1.629 banghart 7326: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7327: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 7328: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 7329: $file_name = &declutter_portfile($file_name);
1.634 albertel 7330: my $symb_crs = $what;
7331: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 7332: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 7333: my ($tmp)=keys(%current_permissions);
7334: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7335: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 7336: foreach my $file (@readonly_files) {
1.759 albertel 7337: my $clean_file = &declutter_portfile($file);
7338: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 7339: my $current_locks = $current_permissions{$file};
1.563 banghart 7340: my @new_locks;
7341: my @del_keys;
7342: if (ref($current_locks) eq "ARRAY"){
7343: foreach my $locker (@{$current_locks}) {
1.632 albertel 7344: my $compare=$locker;
1.749 raeburn 7345: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 7346: $compare=join('',@{$locker});
1.746 raeburn 7347: if ($compare ne $symb_crs) {
7348: push(@new_locks, $locker);
7349: }
1.563 banghart 7350: }
7351: }
1.650 albertel 7352: if (scalar(@new_locks) > 0) {
1.563 banghart 7353: $current_permissions{$file} = \@new_locks;
7354: } else {
7355: push(@del_keys, $file);
1.613 albertel 7356: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 7357: delete($current_permissions{$file});
1.563 banghart 7358: }
7359: }
1.561 banghart 7360: }
1.613 albertel 7361: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7362: return;
7363: }
1.512 banghart 7364:
1.17 www 7365: # ------------------------------------------------------------ Directory lister
7366:
7367: sub dirlist {
1.955 raeburn 7368: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 7369: $uri=~s/^\///;
7370: $uri=~s/\/$//;
1.253 stredwic 7371: my ($udom, $uname);
1.955 raeburn 7372: if ($getuserdir) {
1.253 stredwic 7373: $udom = $userdomain;
7374: $uname = $username;
1.955 raeburn 7375: } else {
7376: (undef,$udom,$uname)=split(/\//,$uri);
7377: if(defined($userdomain)) {
7378: $udom = $userdomain;
7379: }
7380: if(defined($username)) {
7381: $uname = $username;
7382: }
1.253 stredwic 7383: }
1.955 raeburn 7384: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 7385:
1.955 raeburn 7386: $dirRoot = $perlvar{'lonDocRoot'};
7387: if (defined($getpropath)) {
7388: $dirRoot = &propath($udom,$uname);
1.253 stredwic 7389: $dirRoot =~ s/\/$//;
1.955 raeburn 7390: } elsif (defined($getuserdir)) {
7391: my $subdir=$uname.'__';
7392: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7393: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7394: ."/$udom/$subdir/$uname";
7395: } elsif (defined($alternateRoot)) {
7396: $dirRoot = $alternateRoot;
1.751 banghart 7397: }
1.253 stredwic 7398:
7399: if($udom) {
7400: if($uname) {
1.955 raeburn 7401: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 7402: .$getuserdir.':'.&escape($dirRoot)
1.955 raeburn 7403: .':'.&escape($uname).':'.&escape($udom),
7404: &homeserver($uname,$udom));
7405: if ($listing eq 'unknown_cmd') {
7406: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7407: &homeserver($uname,$udom));
7408: } else {
7409: @listing_results = map { &unescape($_); } split(/:/,$listing);
7410: }
1.605 matthew 7411: if ($listing eq 'unknown_cmd') {
1.800 albertel 7412: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7413: &homeserver($uname,$udom));
1.605 matthew 7414: @listing_results = split(/:/,$listing);
7415: } else {
7416: @listing_results = map { &unescape($_); } split(/:/,$listing);
7417: }
7418: return @listing_results;
1.955 raeburn 7419: } elsif(!$alternateRoot) {
1.800 albertel 7420: my %allusers;
1.841 albertel 7421: my %servers = &get_servers($udom,'library');
1.955 raeburn 7422: foreach my $tryserver (keys(%servers)) {
7423: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7424: &escape($udom),$tryserver);
7425: if ($listing eq 'unknown_cmd') {
7426: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7427: $udom, $tryserver);
7428: } else {
7429: @listing_results = map { &unescape($_); } split(/:/,$listing);
7430: }
1.841 albertel 7431: if ($listing eq 'unknown_cmd') {
7432: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7433: $udom, $tryserver);
7434: @listing_results = split(/:/,$listing);
7435: } else {
7436: @listing_results =
7437: map { &unescape($_); } split(/:/,$listing);
7438: }
7439: if ($listing_results[0] ne 'no_such_dir' &&
7440: $listing_results[0] ne 'empty' &&
7441: $listing_results[0] ne 'con_lost') {
7442: foreach my $line (@listing_results) {
7443: my ($entry) = split(/&/,$line,2);
7444: $allusers{$entry} = 1;
7445: }
7446: }
1.253 stredwic 7447: }
7448: my $alluserstr='';
1.800 albertel 7449: foreach my $user (sort(keys(%allusers))) {
7450: $alluserstr.=$user.'&user:';
1.253 stredwic 7451: }
7452: $alluserstr=~s/:$//;
7453: return split(/:/,$alluserstr);
7454: } else {
1.800 albertel 7455: return ('missing user name');
1.253 stredwic 7456: }
1.955 raeburn 7457: } elsif(!defined($getpropath)) {
1.841 albertel 7458: my @all_domains = sort(&all_domains());
1.955 raeburn 7459: foreach my $domain (@all_domains) {
7460: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7461: }
7462: return @all_domains;
7463: } else {
1.800 albertel 7464: return ('missing domain');
1.275 stredwic 7465: }
7466: }
7467:
7468: # --------------------------------------------- GetFileTimestamp
7469: # This function utilizes dirlist and returns the date stamp for
7470: # when it was last modified. It will also return an error of -1
7471: # if an error occurs
7472:
7473: sub GetFileTimestamp {
1.955 raeburn 7474: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 7475: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7476: $studentName = &LONCAPA::clean_username($studentName);
1.955 raeburn 7477: my ($fileStat) =
7478: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7479: undef,$getuserdir);
1.275 stredwic 7480: my @stats = split('&', $fileStat);
7481: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 7482: # @stats contains first the filename, then the stat output
7483: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 7484: } else {
7485: return -1;
1.253 stredwic 7486: }
1.26 www 7487: }
7488:
1.712 albertel 7489: sub stat_file {
7490: my ($uri) = @_;
1.787 albertel 7491: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 7492:
1.955 raeburn 7493: my ($udom,$uname,$file);
1.712 albertel 7494: if ($uri =~ m-^/(uploaded|editupload)/-) {
7495: ($udom,$uname,$file) =
1.811 albertel 7496: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 7497: $file = 'userfiles/'.$file;
7498: }
7499: if ($uri =~ m-^/res/-) {
7500: ($udom,$uname) =
1.807 albertel 7501: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 7502: $file = $uri;
7503: }
7504:
7505: if (!$udom || !$uname || !$file) {
7506: # unable to handle the uri
7507: return ();
7508: }
1.956 raeburn 7509: my $getpropath;
7510: if ($file =~ /^userfiles\//) {
7511: $getpropath = 1;
7512: }
1.955 raeburn 7513: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712 albertel 7514: my @stats = split('&', $result);
1.721 banghart 7515:
1.712 albertel 7516: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7517: shift(@stats); #filename is first
7518: return @stats;
7519: }
7520: return ();
7521: }
7522:
1.26 www 7523: # -------------------------------------------------------- Value of a Condition
7524:
1.713 albertel 7525: # gets the value of a specific preevaluated condition
7526: # stored in the string $env{user.state.<cid>}
7527: # or looks up a condition reference in the bighash and if if hasn't
7528: # already been evaluated recurses into docondval to get the value of
7529: # the condition, then memoizing it to
7530: # $env{user.state.<cid>.<condition>}
1.40 www 7531: sub directcondval {
7532: my $number=shift;
1.620 albertel 7533: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 7534: &Apache::lonuserstate::evalstate();
7535: }
1.713 albertel 7536: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7537: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7538: } elsif ($number =~ /^_/) {
7539: my $sub_condition;
7540: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7541: &GDBM_READER(),0640)) {
7542: $sub_condition=$bighash{'conditions'.$number};
7543: untie(%bighash);
7544: }
7545: my $value = &docondval($sub_condition);
1.949 raeburn 7546: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 7547: return $value;
7548: }
1.620 albertel 7549: if ($env{'user.state.'.$env{'request.course.id'}}) {
7550: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 7551: } else {
7552: return 2;
7553: }
7554: }
7555:
1.713 albertel 7556: # get the collection of conditions for this resource
1.26 www 7557: sub condval {
7558: my $condidx=shift;
1.54 www 7559: my $allpathcond='';
1.713 albertel 7560: foreach my $cond (split(/\|/,$condidx)) {
7561: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7562: $allpathcond.=
7563: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7564: }
1.191 harris41 7565: }
1.54 www 7566: $allpathcond=~s/\|$//;
1.713 albertel 7567: return &docondval($allpathcond);
7568: }
7569:
7570: #evaluates an expression of conditions
7571: sub docondval {
7572: my ($allpathcond) = @_;
7573: my $result=0;
7574: if ($env{'request.course.id'}
7575: && defined($allpathcond)) {
7576: my $operand='|';
7577: my @stack;
7578: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7579: if ($chunk eq '(') {
7580: push @stack,($operand,$result);
7581: } elsif ($chunk eq ')') {
7582: my $before=pop @stack;
7583: if (pop @stack eq '&') {
7584: $result=$result>$before?$before:$result;
7585: } else {
7586: $result=$result>$before?$result:$before;
7587: }
7588: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7589: $operand=$chunk;
7590: } else {
7591: my $new=directcondval($chunk);
7592: if ($operand eq '&') {
7593: $result=$result>$new?$new:$result;
7594: } else {
7595: $result=$result>$new?$result:$new;
7596: }
7597: }
7598: }
1.26 www 7599: }
7600: return $result;
1.421 albertel 7601: }
7602:
7603: # ---------------------------------------------------- Devalidate courseresdata
7604:
7605: sub devalidatecourseresdata {
7606: my ($coursenum,$coursedomain)=@_;
7607: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7608: &devalidate_cache_new('courseres',$hashid);
1.28 www 7609: }
7610:
1.763 www 7611:
1.200 www 7612: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 7613: #
7614: # Parameters:
7615: # $coursenum - Number of the course.
7616: # $coursedomain - Domain at which the course was created.
7617: # Returns:
7618: # A hash of the course parameters along (I think) with timestamps
7619: # and version info.
1.877 foxr 7620:
1.624 albertel 7621: sub get_courseresdata {
7622: my ($coursenum,$coursedomain)=@_;
1.200 www 7623: my $coursehom=&homeserver($coursenum,$coursedomain);
7624: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7625: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 7626: my %dumpreply;
1.417 albertel 7627: unless (defined($cached)) {
1.624 albertel 7628: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 7629: $result=\%dumpreply;
1.251 albertel 7630: my ($tmp) = keys(%dumpreply);
7631: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 7632: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 7633: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7634: return $tmp;
1.416 albertel 7635: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 7636: $result=undef;
1.599 albertel 7637: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 7638: }
7639: }
1.624 albertel 7640: return $result;
7641: }
7642:
1.633 albertel 7643: sub devalidateuserresdata {
7644: my ($uname,$udom)=@_;
7645: my $hashid="$udom:$uname";
7646: &devalidate_cache_new('userres',$hashid);
7647: }
7648:
1.624 albertel 7649: sub get_userresdata {
7650: my ($uname,$udom)=@_;
7651: #most student don\'t have any data set, check if there is some data
7652: if (&EXT_cache_status($udom,$uname)) { return undef; }
7653:
7654: my $hashid="$udom:$uname";
7655: my ($result,$cached)=&is_cached_new('userres',$hashid);
7656: if (!defined($cached)) {
7657: my %resourcedata=&dump('resourcedata',$udom,$uname);
7658: $result=\%resourcedata;
7659: &do_cache_new('userres',$hashid,$result,600);
7660: }
7661: my ($tmp)=keys(%$result);
7662: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7663: return $result;
7664: }
7665: #error 2 occurs when the .db doesn't exist
7666: if ($tmp!~/error: 2 /) {
1.672 albertel 7667: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 7668: " Trying to get resource data for ".
7669: $uname." at ".$udom.": ".
7670: $tmp."</font>");
7671: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 7672: #&EXT_cache_set($udom,$uname);
7673: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 7674: undef($tmp); # not really an error so don't send it back
1.624 albertel 7675: }
7676: return $tmp;
7677: }
1.879 foxr 7678: #----------------------------------------------- resdata - return resource data
7679: # Purpose:
7680: # Return resource data for either users or for a course.
7681: # Parameters:
7682: # $name - Course/user name.
7683: # $domain - Name of the domain the user/course is registered on.
7684: # $type - Type of thing $name is (must be 'course' or 'user'
7685: # @which - Array of names of resources desired.
7686: # Returns:
7687: # The value of the first reasource in @which that is found in the
7688: # resource hash.
7689: # Exceptional Conditions:
7690: # If the $type passed in is not valid (not the string 'course' or
7691: # 'user', an undefined reference is returned.
7692: # If none of the resources are found, an undef is returned
1.624 albertel 7693: sub resdata {
7694: my ($name,$domain,$type,@which)=@_;
7695: my $result;
7696: if ($type eq 'course') {
7697: $result=&get_courseresdata($name,$domain);
7698: } elsif ($type eq 'user') {
7699: $result=&get_userresdata($name,$domain);
7700: }
7701: if (!ref($result)) { return $result; }
1.251 albertel 7702: foreach my $item (@which) {
1.927 albertel 7703: if (defined($result->{$item->[0]})) {
7704: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 7705: }
1.250 albertel 7706: }
1.291 albertel 7707: return undef;
1.200 www 7708: }
7709:
1.379 matthew 7710: #
7711: # EXT resource caching routines
7712: #
7713:
7714: sub clear_EXT_cache_status {
1.383 albertel 7715: &delenv('cache.EXT.');
1.379 matthew 7716: }
7717:
7718: sub EXT_cache_status {
7719: my ($target_domain,$target_user) = @_;
1.383 albertel 7720: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 7721: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 7722: # We know already the user has no data
7723: return 1;
7724: } else {
7725: return 0;
7726: }
7727: }
7728:
7729: sub EXT_cache_set {
7730: my ($target_domain,$target_user) = @_;
1.383 albertel 7731: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 7732: #&appenv({$cachename => time});
1.379 matthew 7733: }
7734:
1.28 www 7735: # --------------------------------------------------------- Value of a Variable
1.58 www 7736: sub EXT {
1.715 albertel 7737:
1.395 albertel 7738: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 7739: unless ($varname) { return ''; }
1.218 albertel 7740: #get real user name/domain, courseid and symb
7741: my $courseid;
1.359 albertel 7742: my $publicuser;
1.427 www 7743: if ($symbparm) {
7744: $symbparm=&get_symb_from_alias($symbparm);
7745: }
1.218 albertel 7746: if (!($uname && $udom)) {
1.790 albertel 7747: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 7748: if (!$symbparm) { $symbparm=$cursymb; }
7749: } else {
1.620 albertel 7750: $courseid=$env{'request.course.id'};
1.218 albertel 7751: }
1.48 www 7752: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7753: my $rest;
1.320 albertel 7754: if (defined($therest[0])) {
1.48 www 7755: $rest=join('.',@therest);
7756: } else {
7757: $rest='';
7758: }
1.320 albertel 7759:
1.57 www 7760: my $qualifierrest=$qualifier;
7761: if ($rest) { $qualifierrest.='.'.$rest; }
7762: my $spacequalifierrest=$space;
7763: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 7764: if ($realm eq 'user') {
1.48 www 7765: # --------------------------------------------------------------- user.resource
7766: if ($space eq 'resource') {
1.651 albertel 7767: if ( (defined($Apache::lonhomework::parsing_a_problem)
7768: || defined($Apache::lonhomework::parsing_a_task))
7769: &&
1.744 albertel 7770: ($symbparm eq &symbread()) ) {
7771: # if we are in the middle of processing the resource the
7772: # get the value we are planning on committing
7773: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7774: return $Apache::lonhomework::results{$qualifierrest};
7775: } else {
7776: return $Apache::lonhomework::history{$qualifierrest};
7777: }
1.335 albertel 7778: } else {
1.359 albertel 7779: my %restored;
1.620 albertel 7780: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 7781: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7782: } else {
7783: %restored=&restore($symbparm,$courseid,$udom,$uname);
7784: }
1.335 albertel 7785: return $restored{$qualifierrest};
7786: }
1.48 www 7787: # ----------------------------------------------------------------- user.access
7788: } elsif ($space eq 'access') {
1.218 albertel 7789: # FIXME - not supporting calls for a specific user
1.48 www 7790: return &allowed($qualifier,$rest);
7791: # ------------------------------------------ user.preferences, user.environment
7792: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 7793: if (($uname eq $env{'user.name'}) &&
7794: ($udom eq $env{'user.domain'})) {
7795: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 7796: } else {
1.359 albertel 7797: my %returnhash;
7798: if (!$publicuser) {
7799: %returnhash=&userenvironment($udom,$uname,
7800: $qualifierrest);
7801: }
1.218 albertel 7802: return $returnhash{$qualifierrest};
7803: }
1.48 www 7804: # ----------------------------------------------------------------- user.course
7805: } elsif ($space eq 'course') {
1.218 albertel 7806: # FIXME - not supporting calls for a specific user
1.620 albertel 7807: return $env{join('.',('request.course',$qualifier))};
1.48 www 7808: # ------------------------------------------------------------------- user.role
7809: } elsif ($space eq 'role') {
1.218 albertel 7810: # FIXME - not supporting calls for a specific user
1.620 albertel 7811: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 7812: if ($qualifier eq 'value') {
7813: return $role;
7814: } elsif ($qualifier eq 'extent') {
7815: return $where;
7816: }
7817: # ----------------------------------------------------------------- user.domain
7818: } elsif ($space eq 'domain') {
1.218 albertel 7819: return $udom;
1.48 www 7820: # ------------------------------------------------------------------- user.name
7821: } elsif ($space eq 'name') {
1.218 albertel 7822: return $uname;
1.48 www 7823: # ---------------------------------------------------- Any other user namespace
1.29 www 7824: } else {
1.359 albertel 7825: my %reply;
7826: if (!$publicuser) {
7827: %reply=&get($space,[$qualifierrest],$udom,$uname);
7828: }
7829: return $reply{$qualifierrest};
1.48 www 7830: }
1.236 www 7831: } elsif ($realm eq 'query') {
7832: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 7833: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7834: [$spacequalifierrest]);
1.620 albertel 7835: return $env{'form.'.$spacequalifierrest};
1.236 www 7836: } elsif ($realm eq 'request') {
1.48 www 7837: # ------------------------------------------------------------- request.browser
7838: if ($space eq 'browser') {
1.430 www 7839: if ($qualifier eq 'textremote') {
1.676 albertel 7840: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 7841: return 1;
7842: } else {
7843: return 0;
7844: }
7845: } else {
1.620 albertel 7846: return $env{'browser.'.$qualifier};
1.430 www 7847: }
1.57 www 7848: # ------------------------------------------------------------ request.filename
7849: } else {
1.620 albertel 7850: return $env{'request.'.$spacequalifierrest};
1.29 www 7851: }
1.28 www 7852: } elsif ($realm eq 'course') {
1.48 www 7853: # ---------------------------------------------------------- course.description
1.620 albertel 7854: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 7855: } elsif ($realm eq 'resource') {
1.165 www 7856:
1.620 albertel 7857: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 7858: if (!$symbparm) { $symbparm=&symbread(); }
7859: }
1.693 albertel 7860:
7861: if ($space eq 'title') {
7862: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7863: return &gettitle($symbparm);
7864: }
7865:
7866: if ($space eq 'map') {
7867: my ($map) = &decode_symb($symbparm);
7868: return &symbread($map);
7869: }
1.905 albertel 7870: if ($space eq 'filename') {
7871: if ($symbparm) {
7872: return &clutter((&decode_symb($symbparm))[2]);
7873: }
7874: return &hreflocation('',$env{'request.filename'});
7875: }
1.693 albertel 7876:
7877: my ($section, $group, @groups);
1.593 albertel 7878: my ($courselevelm,$courselevel);
1.539 albertel 7879: if ($symbparm && defined($courseid) &&
1.620 albertel 7880: $courseid eq $env{'request.course.id'}) {
1.165 www 7881:
1.218 albertel 7882: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 7883:
1.60 www 7884: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 7885: my $symbp=$symbparm;
1.735 albertel 7886: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 7887:
7888: my $symbparm=$symbp.'.'.$spacequalifierrest;
7889: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7890:
1.620 albertel 7891: if (($env{'user.name'} eq $uname) &&
7892: ($env{'user.domain'} eq $udom)) {
7893: $section=$env{'request.course.sec'};
1.733 raeburn 7894: @groups = split(/:/,$env{'request.course.groups'});
7895: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 7896: } else {
1.539 albertel 7897: if (! defined($usection)) {
1.551 albertel 7898: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 7899: } else {
7900: $section = $usection;
7901: }
1.733 raeburn 7902: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 7903: }
7904:
7905: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7906: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7907: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7908:
1.593 albertel 7909: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 7910: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 7911: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 7912:
1.60 www 7913: # ----------------------------------------------------------- first, check user
1.624 albertel 7914:
7915: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 7916: ([$courselevelr,'resource'],
7917: [$courselevelm,'map' ],
7918: [$courselevel, 'course' ]));
1.931 albertel 7919: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 7920:
1.594 albertel 7921: # ------------------------------------------------ second, check some of course
1.684 raeburn 7922: my $coursereply;
1.691 raeburn 7923: if (@groups > 0) {
7924: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
7925: $mapparm,$spacequalifierrest);
1.927 albertel 7926: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 7927: }
1.96 www 7928:
1.684 raeburn 7929: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 7930: $env{'course.'.$courseid.'.domain'},
7931: 'course',
7932: ([$seclevelr, 'resource'],
7933: [$seclevelm, 'map' ],
7934: [$seclevel, 'course' ],
7935: [$courselevelr,'resource']));
7936: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 7937:
1.60 www 7938: # ------------------------------------------------------ third, check map parms
1.218 albertel 7939: my %parmhash=();
7940: my $thisparm='';
7941: if (tie(%parmhash,'GDBM_File',
1.620 albertel 7942: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 7943: &GDBM_READER(),0640)) {
1.218 albertel 7944: $thisparm=$parmhash{$symbparm};
7945: untie(%parmhash);
7946: }
1.927 albertel 7947: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 7948: }
1.594 albertel 7949: # ------------------------------------------ fourth, look in resource metadata
1.71 www 7950:
1.218 albertel 7951: $spacequalifierrest=~s/\./\_/;
1.282 albertel 7952: my $filename;
7953: if (!$symbparm) { $symbparm=&symbread(); }
7954: if ($symbparm) {
1.409 www 7955: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 7956: } else {
1.620 albertel 7957: $filename=$env{'request.filename'};
1.282 albertel 7958: }
7959: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 7960: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 7961: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 7962: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 7963:
1.927 albertel 7964: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 7965: if ($symbparm && defined($courseid) &&
1.620 albertel 7966: $courseid eq $env{'request.course.id'}) {
1.624 albertel 7967: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
7968: $env{'course.'.$courseid.'.domain'},
7969: 'course',
1.927 albertel 7970: ([$courselevelm,'map' ],
7971: [$courselevel, 'course']));
7972: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 7973: }
1.145 www 7974: # ------------------------------------------------------------------ Cascade up
1.218 albertel 7975: unless ($space eq '0') {
1.336 albertel 7976: my @parts=split(/_/,$space);
7977: my $id=pop(@parts);
7978: my $part=join('_',@parts);
7979: if ($part eq '') { $part='0'; }
1.927 albertel 7980: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 7981: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 7982: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 7983: }
1.395 albertel 7984: if ($recurse) { return undef; }
7985: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 7986: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 7987: # ---------------------------------------------------- Any other user namespace
7988: } elsif ($realm eq 'environment') {
7989: # ----------------------------------------------------------------- environment
1.620 albertel 7990: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
7991: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 7992: } else {
1.770 albertel 7993: if ($uname eq 'anonymous' && $udom eq '') {
7994: return '';
7995: }
1.219 albertel 7996: my %returnhash=&userenvironment($udom,$uname,
7997: $spacequalifierrest);
7998: return $returnhash{$spacequalifierrest};
7999: }
1.28 www 8000: } elsif ($realm eq 'system') {
1.48 www 8001: # ----------------------------------------------------------------- system.time
8002: if ($space eq 'time') {
8003: return time;
8004: }
1.696 albertel 8005: } elsif ($realm eq 'server') {
8006: # ----------------------------------------------------------------- system.time
8007: if ($space eq 'name') {
8008: return $ENV{'SERVER_NAME'};
8009: }
1.28 www 8010: }
1.48 www 8011: return '';
1.61 www 8012: }
8013:
1.927 albertel 8014: sub get_reply {
8015: my ($reply_value) = @_;
1.940 raeburn 8016: if (ref($reply_value) eq 'ARRAY') {
8017: if (wantarray) {
8018: return @$reply_value;
8019: }
8020: return $reply_value->[0];
8021: } else {
8022: return $reply_value;
1.927 albertel 8023: }
8024: }
8025:
1.691 raeburn 8026: sub check_group_parms {
8027: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8028: my @groupitems = ();
8029: my $resultitem;
1.927 albertel 8030: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 8031: foreach my $group (@{$groups}) {
8032: foreach my $level (@levels) {
1.927 albertel 8033: my $item = $courseid.'.['.$group.'].'.$level->[0];
8034: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 8035: }
8036: }
8037: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8038: $env{'course.'.$courseid.'.domain'},
8039: 'course',@groupitems);
8040: return $coursereply;
8041: }
8042:
8043: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 8044: my ($courseid,@groups) = @_;
8045: @groups = sort(@groups);
1.691 raeburn 8046: return @groups;
8047: }
8048:
1.395 albertel 8049: sub packages_tab_default {
8050: my ($uri,$varname)=@_;
8051: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 8052:
8053: my (@extension,@specifics,$do_default);
8054: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 8055: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 8056: if ($pack_type eq 'default') {
8057: $do_default=1;
8058: } elsif ($pack_type eq 'extension') {
8059: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 8060: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 8061: # only look at packages defaults for packages that this id is
1.738 albertel 8062: push(@specifics,[$package,$pack_type,$pack_part]);
8063: }
8064: }
8065: # first look for a package that matches the requested part id
8066: foreach my $package (@specifics) {
8067: my (undef,$pack_type,$pack_part)=@{$package};
8068: next if ($pack_part ne $part);
8069: if (defined($packagetab{"$pack_type&$name&default"})) {
8070: return $packagetab{"$pack_type&$name&default"};
8071: }
8072: }
8073: # look for any possible matching non extension_ package
8074: foreach my $package (@specifics) {
8075: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 8076: if (defined($packagetab{"$pack_type&$name&default"})) {
8077: return $packagetab{"$pack_type&$name&default"};
8078: }
1.585 albertel 8079: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 8080: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8081: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 8082: }
8083: }
1.738 albertel 8084: # look for any posible extension_ match
8085: foreach my $package (@extension) {
8086: my ($package,$pack_type)=@{$package};
8087: if (defined($packagetab{"$pack_type&$name&default"})) {
8088: return $packagetab{"$pack_type&$name&default"};
8089: }
8090: if (defined($packagetab{$package."&$name&default"})) {
8091: return $packagetab{$package."&$name&default"};
8092: }
8093: }
8094: # look for a global default setting
8095: if ($do_default && defined($packagetab{"default&$name&default"})) {
8096: return $packagetab{"default&$name&default"};
8097: }
1.395 albertel 8098: return undef;
8099: }
8100:
1.334 albertel 8101: sub add_prefix_and_part {
8102: my ($prefix,$part)=@_;
8103: my $keyroot;
8104: if (defined($prefix) && $prefix !~ /^__/) {
8105: # prefix that has a part already
8106: $keyroot=$prefix;
8107: } elsif (defined($prefix)) {
8108: # prefix that is missing a part
8109: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8110: } else {
8111: # no prefix at all
8112: if (defined($part)) { $keyroot='_'.$part; }
8113: }
8114: return $keyroot;
8115: }
8116:
1.71 www 8117: # ---------------------------------------------------------------- Get metadata
8118:
1.599 albertel 8119: my %metaentry;
1.71 www 8120: sub metadata {
1.176 www 8121: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 8122: $uri=&declutter($uri);
1.288 albertel 8123: # if it is a non metadata possible uri return quickly
1.529 albertel 8124: if (($uri eq '') ||
8125: (($uri =~ m|^/*adm/|) &&
1.698 albertel 8126: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 albertel 8127: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8128: return undef;
8129: }
8130: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8131: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 8132: return undef;
1.288 albertel 8133: }
1.73 www 8134: my $filename=$uri;
8135: $uri=~s/\.meta$//;
1.172 www 8136: #
8137: # Is the metadata already cached?
1.177 www 8138: # Look at timestamp of caching
1.172 www 8139: # Everything is cached by the main uri, libraries are never directly cached
8140: #
1.428 albertel 8141: if (!defined($liburi)) {
1.599 albertel 8142: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 8143: if (defined($cached)) { return $result->{':'.$what}; }
8144: }
8145: {
1.172 www 8146: #
8147: # Is this a recursive call for a library?
8148: #
1.599 albertel 8149: # if (! exists($metacache{$uri})) {
8150: # $metacache{$uri}={};
8151: # }
1.924 albertel 8152: my $cachetime = 60*60;
1.171 www 8153: if ($liburi) {
8154: $liburi=&declutter($liburi);
8155: $filename=$liburi;
1.401 bowersj2 8156: } else {
1.599 albertel 8157: &devalidate_cache_new('meta',$uri);
8158: undef(%metaentry);
1.401 bowersj2 8159: }
1.140 www 8160: my %metathesekeys=();
1.73 www 8161: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 8162: my $metastring;
1.924 albertel 8163: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929 albertel 8164: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 8165: $metastring =
1.929 albertel 8166: &Apache::lonnet::ssi_body($which,
1.924 albertel 8167: ('grade_target' => 'meta'));
8168: $cachetime = 1; # only want this cached in the child not long term
8169: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 8170: my $file=&filelocation('',&clutter($filename));
1.599 albertel 8171: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 8172: $metastring=&getfile($file);
1.489 albertel 8173: }
1.208 albertel 8174: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 8175: my $token;
1.140 www 8176: undef %metathesekeys;
1.71 www 8177: while ($token=$parser->get_token) {
1.339 albertel 8178: if ($token->[0] eq 'S') {
8179: if (defined($token->[2]->{'package'})) {
1.172 www 8180: #
8181: # This is a package - get package info
8182: #
1.339 albertel 8183: my $package=$token->[2]->{'package'};
8184: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8185: if (defined($token->[2]->{'id'})) {
8186: $keyroot.='_'.$token->[2]->{'id'};
8187: }
1.599 albertel 8188: if ($metaentry{':packages'}) {
8189: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 8190: } else {
1.599 albertel 8191: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 8192: }
1.736 albertel 8193: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 8194: my $part=$keyroot;
8195: $part=~s/^\_//;
1.736 albertel 8196: if ($pack_entry=~/^\Q$package\E\&/ ||
8197: $pack_entry=~/^\Q$package\E_0\&/) {
8198: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 8199: # ignore package.tab specified default values
8200: # here &package_tab_default() will fetch those
8201: if ($subp eq 'default') { next; }
1.736 albertel 8202: my $value=$packagetab{$pack_entry};
1.432 albertel 8203: my $unikey;
8204: if ($pack =~ /_0$/) {
8205: $unikey='parameter_0_'.$name;
8206: $part=0;
8207: } else {
8208: $unikey='parameter'.$keyroot.'_'.$name;
8209: }
1.339 albertel 8210: if ($subp eq 'display') {
8211: $value.=' [Part: '.$part.']';
8212: }
1.599 albertel 8213: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 8214: $metathesekeys{$unikey}=1;
1.599 albertel 8215: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8216: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 8217: }
1.599 albertel 8218: if (defined($metaentry{':'.$unikey.'.default'})) {
8219: $metaentry{':'.$unikey}=
8220: $metaentry{':'.$unikey.'.default'};
1.356 albertel 8221: }
1.339 albertel 8222: }
8223: }
8224: } else {
1.172 www 8225: #
8226: # This is not a package - some other kind of start tag
1.339 albertel 8227: #
8228: my $entry=$token->[1];
8229: my $unikey;
8230: if ($entry eq 'import') {
8231: $unikey='';
8232: } else {
8233: $unikey=$entry;
8234: }
8235: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8236:
8237: if (defined($token->[2]->{'id'})) {
8238: $unikey.='_'.$token->[2]->{'id'};
8239: }
1.175 www 8240:
1.339 albertel 8241: if ($entry eq 'import') {
1.175 www 8242: #
8243: # Importing a library here
1.339 albertel 8244: #
8245: if ($depthcount<20) {
8246: my $location=$parser->get_text('/import');
8247: my $dir=$filename;
8248: $dir=~s|[^/]*$||;
8249: $location=&filelocation($dir,$location);
1.736 albertel 8250: my $metadata =
8251: &metadata($uri,'keys', $location,$unikey,
8252: $depthcount+1);
8253: foreach my $meta (split(',',$metadata)) {
8254: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8255: $metathesekeys{$meta}=1;
1.339 albertel 8256: }
8257: }
8258: } else {
8259:
8260: if (defined($token->[2]->{'name'})) {
8261: $unikey.='_'.$token->[2]->{'name'};
8262: }
8263: $metathesekeys{$unikey}=1;
1.736 albertel 8264: foreach my $param (@{$token->[3]}) {
8265: $metaentry{':'.$unikey.'.'.$param} =
8266: $token->[2]->{$param};
1.339 albertel 8267: }
8268: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 8269: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 8270: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8271: # only ws inside the tag, and not in default, so use default
8272: # as value
1.599 albertel 8273: $metaentry{':'.$unikey}=$default;
1.908 albertel 8274: } elsif ( $internaltext =~ /\S/ ) {
8275: # something interesting inside the tag
8276: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 8277: } else {
1.908 albertel 8278: # no interesting values, don't set a default
1.339 albertel 8279: }
1.172 www 8280: # end of not-a-package not-a-library import
1.339 albertel 8281: }
1.172 www 8282: # end of not-a-package start tag
1.339 albertel 8283: }
1.172 www 8284: # the next is the end of "start tag"
1.339 albertel 8285: }
8286: }
1.483 albertel 8287: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 8288: $extension = lc($extension);
8289: if ($extension eq 'htm') { $extension='html'; }
8290:
1.737 albertel 8291: foreach my $key (keys(%packagetab)) {
1.483 albertel 8292: #no specific packages #how's our extension
8293: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 8294: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 8295: \%metathesekeys);
8296: }
1.883 albertel 8297:
8298: if (!exists($metaentry{':packages'})
8299: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 8300: foreach my $key (keys(%packagetab)) {
1.483 albertel 8301: #no specific packages well let's get default then
8302: if ($key!~/^default&/) { next; }
1.488 albertel 8303: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 8304: \%metathesekeys);
8305: }
8306: }
1.338 www 8307: # are there custom rights to evaluate
1.599 albertel 8308: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 8309:
1.338 www 8310: #
8311: # Importing a rights file here
1.339 albertel 8312: #
8313: unless ($depthcount) {
1.599 albertel 8314: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 8315: my $dir=$filename;
8316: $dir=~s|[^/]*$||;
8317: $location=&filelocation($dir,$location);
1.736 albertel 8318: my $rights_metadata =
8319: &metadata($uri,'keys',$location,'_rights',
8320: $depthcount+1);
8321: foreach my $rights (split(',',$rights_metadata)) {
8322: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8323: $metathesekeys{$rights}=1;
1.339 albertel 8324: }
8325: }
8326: }
1.737 albertel 8327: # uniqifiy package listing
8328: my %seen;
8329: my @uniq_packages =
8330: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8331: $metaentry{':packages'} = join(',',@uniq_packages);
8332:
8333: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 8334: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8335: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 8336: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 8337: # this is the end of "was not already recently cached
1.71 www 8338: }
1.599 albertel 8339: return $metaentry{':'.$what};
1.261 albertel 8340: }
8341:
1.488 albertel 8342: sub metadata_create_package_def {
1.483 albertel 8343: my ($uri,$key,$package,$metathesekeys)=@_;
8344: my ($pack,$name,$subp)=split(/\&/,$key);
8345: if ($subp eq 'default') { next; }
8346:
1.599 albertel 8347: if (defined($metaentry{':packages'})) {
8348: $metaentry{':packages'}.=','.$package;
1.483 albertel 8349: } else {
1.599 albertel 8350: $metaentry{':packages'}=$package;
1.483 albertel 8351: }
8352: my $value=$packagetab{$key};
8353: my $unikey;
8354: $unikey='parameter_0_'.$name;
1.599 albertel 8355: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 8356: $$metathesekeys{$unikey}=1;
1.599 albertel 8357: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8358: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 8359: }
1.599 albertel 8360: if (defined($metaentry{':'.$unikey.'.default'})) {
8361: $metaentry{':'.$unikey}=
8362: $metaentry{':'.$unikey.'.default'};
1.483 albertel 8363: }
8364: }
8365:
1.261 albertel 8366: sub metadata_generate_part0 {
8367: my ($metadata,$metacache,$uri) = @_;
8368: my %allnames;
1.737 albertel 8369: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 8370: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 8371: my $part=$$metacache{':'.$metakey.'.part'};
8372: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 8373: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 8374: $allnames{$name}=$part;
8375: }
8376: }
8377: }
8378: foreach my $name (keys(%allnames)) {
8379: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 8380: my $key=":parameter_0_$name";
1.261 albertel 8381: $$metacache{"$key.part"}='0';
8382: $$metacache{"$key.name"}=$name;
1.428 albertel 8383: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 8384: $allnames{$name}.'_'.$name.
8385: '.type'};
1.428 albertel 8386: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 8387: '.display'};
1.644 www 8388: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 8389: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 8390: $$metacache{"$key.display"}=$olddis;
8391: }
1.71 www 8392: }
8393:
1.764 albertel 8394: # ------------------------------------------------------ Devalidate title cache
8395:
8396: sub devalidate_title_cache {
8397: my ($url)=@_;
8398: if (!$env{'request.course.id'}) { return; }
8399: my $symb=&symbread($url);
8400: if (!$symb) { return; }
8401: my $key=$env{'request.course.id'}."\0".$symb;
8402: &devalidate_cache_new('title',$key);
8403: }
8404:
1.1014 droeschl 8405: # ------------------------------------------------- Get the title of a course
8406:
8407: sub current_course_title {
8408: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8409: }
1.301 www 8410: # ------------------------------------------------- Get the title of a resource
8411:
8412: sub gettitle {
8413: my $urlsymb=shift;
8414: my $symb=&symbread($urlsymb);
1.534 albertel 8415: if ($symb) {
1.620 albertel 8416: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 8417: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 8418: if (defined($cached)) {
8419: return $result;
8420: }
1.534 albertel 8421: my ($map,$resid,$url)=&decode_symb($symb);
8422: my $title='';
1.907 albertel 8423: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8424: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8425: } else {
8426: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8427: &GDBM_READER(),0640)) {
8428: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8429: $title=$bighash{'title_'.$mapid.'.'.$resid};
8430: untie(%bighash);
8431: }
1.534 albertel 8432: }
8433: $title=~s/\&colon\;/\:/gs;
8434: if ($title) {
1.599 albertel 8435: return &do_cache_new('title',$key,$title,600);
1.534 albertel 8436: }
8437: $urlsymb=$url;
8438: }
8439: my $title=&metadata($urlsymb,'title');
8440: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8441: return $title;
1.301 www 8442: }
1.613 albertel 8443:
1.614 albertel 8444: sub get_slot {
8445: my ($which,$cnum,$cdom)=@_;
8446: if (!$cnum || !$cdom) {
1.790 albertel 8447: (undef,my $courseid)=&whichuser();
1.620 albertel 8448: $cdom=$env{'course.'.$courseid.'.domain'};
8449: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 8450: }
1.703 albertel 8451: my $key=join("\0",'slots',$cdom,$cnum,$which);
8452: my %slotinfo;
8453: if (exists($remembered{$key})) {
8454: $slotinfo{$which} = $remembered{$key};
8455: } else {
8456: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8457: &Apache::lonhomework::showhash(%slotinfo);
8458: my ($tmp)=keys(%slotinfo);
8459: if ($tmp=~/^error:/) { return (); }
8460: $remembered{$key} = $slotinfo{$which};
8461: }
1.616 albertel 8462: if (ref($slotinfo{$which}) eq 'HASH') {
8463: return %{$slotinfo{$which}};
8464: }
8465: return $slotinfo{$which};
1.614 albertel 8466: }
1.31 www 8467: # ------------------------------------------------- Update symbolic store links
8468:
8469: sub symblist {
8470: my ($mapname,%newhash)=@_;
1.438 www 8471: $mapname=&deversion(&declutter($mapname));
1.31 www 8472: my %hash;
1.620 albertel 8473: if (($env{'request.course.fn'}) && (%newhash)) {
8474: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8475: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 8476: foreach my $url (keys(%newhash)) {
1.711 albertel 8477: next if ($url eq 'last_known'
8478: && $env{'form.no_update_last_known'});
8479: $hash{declutter($url)}=&encode_symb($mapname,
8480: $newhash{$url}->[1],
8481: $newhash{$url}->[0]);
1.191 harris41 8482: }
1.31 www 8483: if (untie(%hash)) {
8484: return 'ok';
8485: }
8486: }
8487: }
8488: return 'error';
1.212 www 8489: }
8490:
8491: # --------------------------------------------------------------- Verify a symb
8492:
8493: sub symbverify {
1.510 www 8494: my ($symb,$thisurl)=@_;
8495: my $thisfn=$thisurl;
1.439 www 8496: $thisfn=&declutter($thisfn);
1.215 www 8497: # direct jump to resource in page or to a sequence - will construct own symbs
8498: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8499: # check URL part
1.409 www 8500: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 8501:
1.431 www 8502: unless ($url eq $thisfn) { return 0; }
1.213 www 8503:
1.216 www 8504: $symb=&symbclean($symb);
1.510 www 8505: $thisurl=&deversion($thisurl);
1.439 www 8506: $thisfn=&deversion($thisfn);
1.213 www 8507:
8508: my %bighash;
8509: my $okay=0;
1.431 www 8510:
1.620 albertel 8511: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8512: &GDBM_READER(),0640)) {
1.1032 raeburn 8513: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8514: $thisurl =~ s/\?.+$//;
8515: }
1.510 www 8516: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 8517: unless ($ids) {
1.510 www 8518: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 8519: }
8520: if ($ids) {
8521: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 8522: foreach my $id (split(/\,/,$ids)) {
8523: my ($mapid,$resid)=split(/\./,$id);
1.1032 raeburn 8524: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8525: $symb =~ s/\?.+$//;
8526: }
1.216 www 8527: if (
8528: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8529: eq $symb) {
1.620 albertel 8530: if (($env{'request.role.adv'}) ||
1.800 albertel 8531: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 8532: $okay=1;
8533: }
8534: }
1.216 www 8535: }
8536: }
1.213 www 8537: untie(%bighash);
8538: }
8539: return $okay;
1.31 www 8540: }
8541:
1.210 www 8542: # --------------------------------------------------------------- Clean-up symb
8543:
8544: sub symbclean {
8545: my $symb=shift;
1.568 albertel 8546: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 8547: # remove version from map
8548: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 8549:
1.210 www 8550: # remove version from URL
8551: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 8552:
1.507 www 8553: # remove wrapper
8554:
1.510 www 8555: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 8556: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 8557: return $symb;
1.409 www 8558: }
8559:
8560: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 8561:
8562: sub encode_symb {
8563: my ($map,$resid,$url)=@_;
8564: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8565: }
1.409 www 8566:
8567: sub decode_symb {
1.568 albertel 8568: my $symb=shift;
8569: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8570: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 8571: return (&fixversion($map),$resid,&fixversion($url));
8572: }
8573:
8574: sub fixversion {
8575: my $fn=shift;
1.609 banghart 8576: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 8577: my %bighash;
8578: my $uri=&clutter($fn);
1.620 albertel 8579: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 8580: # is this cached?
1.599 albertel 8581: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 8582: if (defined($cached)) { return $result; }
8583: # unfortunately not cached, or expired
1.620 albertel 8584: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 8585: &GDBM_READER(),0640)) {
8586: if ($bighash{'version_'.$uri}) {
8587: my $version=$bighash{'version_'.$uri};
1.444 www 8588: unless (($version eq 'mostrecent') ||
8589: ($version==&getversion($uri))) {
1.440 www 8590: $uri=~s/\.(\w+)$/\.$version\.$1/;
8591: }
8592: }
8593: untie %bighash;
1.413 www 8594: }
1.599 albertel 8595: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 8596: }
8597:
8598: sub deversion {
8599: my $url=shift;
8600: $url=~s/\.\d+\.(\w+)$/\.$1/;
8601: return $url;
1.210 www 8602: }
8603:
1.31 www 8604: # ------------------------------------------------------ Return symb list entry
8605:
8606: sub symbread {
1.249 www 8607: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 8608: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 8609: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 8610: # no filename provided? try from environment
1.44 www 8611: unless ($thisfn) {
1.620 albertel 8612: if ($env{'request.symb'}) {
8613: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 8614: }
1.620 albertel 8615: $thisfn=$env{'request.filename'};
1.44 www 8616: }
1.569 albertel 8617: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 8618: # is that filename actually a symb? Verify, clean, and return
8619: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 8620: if (&symbverify($thisfn,$1)) {
1.620 albertel 8621: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 8622: }
1.242 www 8623: }
1.44 www 8624: $thisfn=declutter($thisfn);
1.31 www 8625: my %hash;
1.37 www 8626: my %bighash;
8627: my $syval='';
1.620 albertel 8628: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 8629: my $targetfn = $thisfn;
1.609 banghart 8630: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 8631: $targetfn = 'adm/wrapper/'.$thisfn;
8632: }
1.687 albertel 8633: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8634: $targetfn=$1;
8635: }
1.620 albertel 8636: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8637: &GDBM_READER(),0640)) {
1.481 raeburn 8638: $syval=$hash{$targetfn};
1.37 www 8639: untie(%hash);
8640: }
8641: # ---------------------------------------------------------- There was an entry
8642: if ($syval) {
1.601 albertel 8643: #unless ($syval=~/\_\d+$/) {
1.620 albertel 8644: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 8645: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8646: #return $env{$cache_str}='';
1.601 albertel 8647: #}
8648: #$syval.=$1;
8649: #}
1.37 www 8650: } else {
8651: # ------------------------------------------------------- Was not in symb table
1.620 albertel 8652: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8653: &GDBM_READER(),0640)) {
1.37 www 8654: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 8655: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 8656: unless ($ids) {
8657: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 8658: }
8659: unless ($ids) {
8660: # alias?
8661: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 8662: }
1.37 www 8663: if ($ids) {
8664: # ------------------------------------------------------------------- Has ID(s)
8665: my @possibilities=split(/\,/,$ids);
1.39 www 8666: if ($#possibilities==0) {
8667: # ----------------------------------------------- There is only one possibility
1.37 www 8668: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 8669: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8670: $resid,$thisfn);
1.249 www 8671: } elsif (!$donotrecurse) {
1.39 www 8672: # ------------------------------------------ There is more than one possibility
8673: my $realpossible=0;
1.800 albertel 8674: foreach my $id (@possibilities) {
8675: my $file=$bighash{'src_'.$id};
1.39 www 8676: if (&allowed('bre',$file)) {
1.800 albertel 8677: my ($mapid,$resid)=split(/\./,$id);
1.39 www 8678: if ($bighash{'map_type_'.$mapid} ne 'page') {
8679: $realpossible++;
1.626 albertel 8680: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8681: $resid,$thisfn);
1.39 www 8682: }
8683: }
1.191 harris41 8684: }
1.39 www 8685: if ($realpossible!=1) { $syval=''; }
1.249 www 8686: } else {
8687: $syval='';
1.37 www 8688: }
8689: }
8690: untie(%bighash)
1.481 raeburn 8691: }
1.31 www 8692: }
1.62 www 8693: if ($syval) {
1.620 albertel 8694: return $env{$cache_str}=$syval;
1.62 www 8695: }
1.31 www 8696: }
1.949 raeburn 8697: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8698: return $env{$cache_str}='';
1.31 www 8699: }
8700:
8701: # ---------------------------------------------------------- Return random seed
8702:
1.32 www 8703: sub numval {
8704: my $txt=shift;
8705: $txt=~tr/A-J/0-9/;
8706: $txt=~tr/a-j/0-9/;
8707: $txt=~tr/K-T/0-9/;
8708: $txt=~tr/k-t/0-9/;
8709: $txt=~tr/U-Z/0-5/;
8710: $txt=~tr/u-z/0-5/;
8711: $txt=~s/\D//g;
1.564 albertel 8712: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 8713: return int($txt);
1.368 albertel 8714: }
8715:
1.484 albertel 8716: sub numval2 {
8717: my $txt=shift;
8718: $txt=~tr/A-J/0-9/;
8719: $txt=~tr/a-j/0-9/;
8720: $txt=~tr/K-T/0-9/;
8721: $txt=~tr/k-t/0-9/;
8722: $txt=~tr/U-Z/0-5/;
8723: $txt=~tr/u-z/0-5/;
8724: $txt=~s/\D//g;
8725: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8726: my $total;
8727: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 8728: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 8729: return int($total);
8730: }
8731:
1.575 albertel 8732: sub numval3 {
8733: use integer;
8734: my $txt=shift;
8735: $txt=~tr/A-J/0-9/;
8736: $txt=~tr/a-j/0-9/;
8737: $txt=~tr/K-T/0-9/;
8738: $txt=~tr/k-t/0-9/;
8739: $txt=~tr/U-Z/0-5/;
8740: $txt=~tr/u-z/0-5/;
8741: $txt=~s/\D//g;
8742: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8743: my $total;
8744: foreach my $val (@txts) { $total+=$val; }
8745: if ($_64bit) { $total=(($total<<32)>>32); }
8746: return $total;
8747: }
8748:
1.675 albertel 8749: sub digest {
8750: my ($data)=@_;
8751: my $digest=&Digest::MD5::md5($data);
8752: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8753: my ($e,$f);
8754: {
8755: use integer;
8756: $e=($a+$b);
8757: $f=($c+$d);
8758: if ($_64bit) {
8759: $e=(($e<<32)>>32);
8760: $f=(($f<<32)>>32);
8761: }
8762: }
8763: if (wantarray) {
8764: return ($e,$f);
8765: } else {
8766: my $g;
8767: {
8768: use integer;
8769: $g=($e+$f);
8770: if ($_64bit) {
8771: $g=(($g<<32)>>32);
8772: }
8773: }
8774: return $g;
8775: }
8776: }
8777:
1.368 albertel 8778: sub latest_rnd_algorithm_id {
1.675 albertel 8779: return '64bit5';
1.366 albertel 8780: }
1.32 www 8781:
1.503 albertel 8782: sub get_rand_alg {
8783: my ($courseid)=@_;
1.790 albertel 8784: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 8785: if ($courseid) {
1.620 albertel 8786: return $env{"course.$courseid.rndseed"};
1.503 albertel 8787: }
8788: return &latest_rnd_algorithm_id();
8789: }
8790:
1.562 albertel 8791: sub validCODE {
8792: my ($CODE)=@_;
8793: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8794: return 0;
8795: }
8796:
1.491 albertel 8797: sub getCODE {
1.620 albertel 8798: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 8799: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8800: defined($Apache::lonhomework::parsing_a_task) ) &&
8801: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 8802: return $Apache::lonhomework::history{'resource.CODE'};
8803: }
8804: return undef;
8805: }
8806:
1.31 www 8807: sub rndseed {
1.155 albertel 8808: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 8809: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 8810: if (!defined($symb)) {
1.366 albertel 8811: unless ($symb=$wsymb) { return time; }
8812: }
8813: if (!$courseid) { $courseid=$wcourseid; }
8814: if (!$domain) { $domain=$wdomain; }
8815: if (!$username) { $username=$wusername }
1.503 albertel 8816: my $which=&get_rand_alg();
1.803 albertel 8817:
1.491 albertel 8818: if (defined(&getCODE())) {
1.675 albertel 8819: if ($which eq '64bit5') {
8820: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8821: } elsif ($which eq '64bit4') {
1.575 albertel 8822: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8823: } else {
8824: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8825: }
1.675 albertel 8826: } elsif ($which eq '64bit5') {
8827: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 8828: } elsif ($which eq '64bit4') {
8829: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 8830: } elsif ($which eq '64bit3') {
8831: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 8832: } elsif ($which eq '64bit2') {
8833: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 8834: } elsif ($which eq '64bit') {
8835: return &rndseed_64bit($symb,$courseid,$domain,$username);
8836: }
8837: return &rndseed_32bit($symb,$courseid,$domain,$username);
8838: }
8839:
8840: sub rndseed_32bit {
8841: my ($symb,$courseid,$domain,$username)=@_;
8842: {
8843: use integer;
8844: my $symbchck=unpack("%32C*",$symb) << 27;
8845: my $symbseed=numval($symb) << 22;
8846: my $namechck=unpack("%32C*",$username) << 17;
8847: my $nameseed=numval($username) << 12;
8848: my $domainseed=unpack("%32C*",$domain) << 7;
8849: my $courseseed=unpack("%32C*",$courseid);
8850: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 8851: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8852: #&logthis("rndseed :$num:$symb");
1.564 albertel 8853: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 8854: return $num;
8855: }
8856: }
8857:
8858: sub rndseed_64bit {
8859: my ($symb,$courseid,$domain,$username)=@_;
8860: {
8861: use integer;
8862: my $symbchck=unpack("%32S*",$symb) << 21;
8863: my $symbseed=numval($symb) << 10;
8864: my $namechck=unpack("%32S*",$username);
8865:
8866: my $nameseed=numval($username) << 21;
8867: my $domainseed=unpack("%32S*",$domain) << 10;
8868: my $courseseed=unpack("%32S*",$courseid);
8869:
8870: my $num1=$symbchck+$symbseed+$namechck;
8871: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8872: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8873: #&logthis("rndseed :$num:$symb");
1.564 albertel 8874: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 8875: return "$num1,$num2";
1.155 albertel 8876: }
1.366 albertel 8877: }
8878:
1.443 albertel 8879: sub rndseed_64bit2 {
8880: my ($symb,$courseid,$domain,$username)=@_;
8881: {
8882: use integer;
8883: # strings need to be an even # of cahracters long, it it is odd the
8884: # last characters gets thrown away
8885: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8886: my $symbseed=numval($symb) << 10;
8887: my $namechck=unpack("%32S*",$username.' ');
8888:
8889: my $nameseed=numval($username) << 21;
1.501 albertel 8890: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8891: my $courseseed=unpack("%32S*",$courseid.' ');
8892:
8893: my $num1=$symbchck+$symbseed+$namechck;
8894: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8895: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8896: #&logthis("rndseed :$num:$symb");
1.803 albertel 8897: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 8898: return "$num1,$num2";
8899: }
8900: }
8901:
8902: sub rndseed_64bit3 {
8903: my ($symb,$courseid,$domain,$username)=@_;
8904: {
8905: use integer;
8906: # strings need to be an even # of cahracters long, it it is odd the
8907: # last characters gets thrown away
8908: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8909: my $symbseed=numval2($symb) << 10;
8910: my $namechck=unpack("%32S*",$username.' ');
8911:
8912: my $nameseed=numval2($username) << 21;
1.443 albertel 8913: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8914: my $courseseed=unpack("%32S*",$courseid.' ');
8915:
8916: my $num1=$symbchck+$symbseed+$namechck;
8917: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8918: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8919: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 8920: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8921:
1.503 albertel 8922: return "$num1:$num2";
1.443 albertel 8923: }
8924: }
8925:
1.575 albertel 8926: sub rndseed_64bit4 {
8927: my ($symb,$courseid,$domain,$username)=@_;
8928: {
8929: use integer;
8930: # strings need to be an even # of cahracters long, it it is odd the
8931: # last characters gets thrown away
8932: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8933: my $symbseed=numval3($symb) << 10;
8934: my $namechck=unpack("%32S*",$username.' ');
8935:
8936: my $nameseed=numval3($username) << 21;
8937: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8938: my $courseseed=unpack("%32S*",$courseid.' ');
8939:
8940: my $num1=$symbchck+$symbseed+$namechck;
8941: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8942: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8943: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 8944: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8945:
8946: return "$num1:$num2";
8947: }
8948: }
8949:
1.675 albertel 8950: sub rndseed_64bit5 {
8951: my ($symb,$courseid,$domain,$username)=@_;
8952: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
8953: return "$num1:$num2";
8954: }
8955:
1.366 albertel 8956: sub rndseed_CODE_64bit {
8957: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 8958: {
1.366 albertel 8959: use integer;
1.443 albertel 8960: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 8961: my $symbseed=numval2($symb);
1.491 albertel 8962: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8963: my $CODEseed=numval(&getCODE());
1.443 albertel 8964: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 8965: my $num1=$symbseed+$CODEchck;
8966: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8967: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8968: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 8969: if ($_64bit) { $num1=(($num1<<32)>>32); }
8970: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 8971: return "$num1:$num2";
1.366 albertel 8972: }
8973: }
8974:
1.575 albertel 8975: sub rndseed_CODE_64bit4 {
8976: my ($symb,$courseid,$domain,$username)=@_;
8977: {
8978: use integer;
8979: my $symbchck=unpack("%32S*",$symb.' ') << 16;
8980: my $symbseed=numval3($symb);
8981: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
8982: my $CODEseed=numval3(&getCODE());
8983: my $courseseed=unpack("%32S*",$courseid.' ');
8984: my $num1=$symbseed+$CODEchck;
8985: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 8986: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
8987: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 8988: if ($_64bit) { $num1=(($num1<<32)>>32); }
8989: if ($_64bit) { $num2=(($num2<<32)>>32); }
8990: return "$num1:$num2";
8991: }
8992: }
8993:
1.675 albertel 8994: sub rndseed_CODE_64bit5 {
8995: my ($symb,$courseid,$domain,$username)=@_;
8996: my $code = &getCODE();
8997: my ($num1,$num2)=&digest("$symb,$courseid,$code");
8998: return "$num1:$num2";
8999: }
9000:
1.366 albertel 9001: sub setup_random_from_rndseed {
9002: my ($rndseed)=@_;
1.503 albertel 9003: if ($rndseed =~/([,:])/) {
9004: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 9005: &Math::Random::random_set_seed(abs($num1),abs($num2));
9006: } else {
9007: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 9008: }
1.36 albertel 9009: }
9010:
1.474 albertel 9011: sub latest_receipt_algorithm_id {
1.835 albertel 9012: return 'receipt3';
1.474 albertel 9013: }
9014:
1.480 www 9015: sub recunique {
9016: my $fucourseid=shift;
9017: my $unique;
1.835 albertel 9018: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9019: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9020: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 9021: } else {
9022: $unique=$perlvar{'lonReceipt'};
9023: }
9024: return unpack("%32C*",$unique);
9025: }
9026:
9027: sub recprefix {
9028: my $fucourseid=shift;
9029: my $prefix;
1.835 albertel 9030: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9031: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9032: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 9033: } else {
9034: $prefix=$perlvar{'lonHostID'};
9035: }
9036: return unpack("%32C*",$prefix);
9037: }
9038:
1.76 www 9039: sub ireceipt {
1.474 albertel 9040: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 9041:
9042: my $return =&recprefix($fucourseid).'-';
9043:
9044: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9045: $env{'request.state'} eq 'construct') {
9046: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9047: return $return;
9048: }
9049:
1.76 www 9050: my $cuname=unpack("%32C*",$funame);
9051: my $cudom=unpack("%32C*",$fudom);
9052: my $cucourseid=unpack("%32C*",$fucourseid);
9053: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 9054: my $cunique=&recunique($fucourseid);
1.474 albertel 9055: my $cpart=unpack("%32S*",$part);
1.835 albertel 9056: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9057:
1.790 albertel 9058: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 9059:
9060: $return.= ($cunique%$cuname+
9061: $cunique%$cudom+
9062: $cusymb%$cuname+
9063: $cusymb%$cudom+
9064: $cucourseid%$cuname+
9065: $cucourseid%$cudom+
9066: $cpart%$cuname+
9067: $cpart%$cudom);
9068: } else {
9069: $return.= ($cunique%$cuname+
9070: $cunique%$cudom+
9071: $cusymb%$cuname+
9072: $cusymb%$cudom+
9073: $cucourseid%$cuname+
9074: $cucourseid%$cudom);
9075: }
9076: return $return;
1.76 www 9077: }
9078:
9079: sub receipt {
1.474 albertel 9080: my ($part)=@_;
1.790 albertel 9081: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 9082: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 9083: }
1.260 ng 9084:
1.790 albertel 9085: sub whichuser {
9086: my ($passedsymb)=@_;
9087: my ($symb,$courseid,$domain,$name,$publicuser);
9088: if (defined($env{'form.grade_symb'})) {
9089: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9090: my $allowed=&allowed('vgr',$tmp_courseid);
9091: if (!$allowed &&
9092: exists($env{'request.course.sec'}) &&
9093: $env{'request.course.sec'} !~ /^\s*$/) {
9094: $allowed=&allowed('vgr',$tmp_courseid.
9095: '/'.$env{'request.course.sec'});
9096: }
9097: if ($allowed) {
9098: ($symb)=&get_env_multiple('form.grade_symb');
9099: $courseid=$tmp_courseid;
9100: ($domain)=&get_env_multiple('form.grade_domain');
9101: ($name)=&get_env_multiple('form.grade_username');
9102: return ($symb,$courseid,$domain,$name,$publicuser);
9103: }
9104: }
9105: if (!$passedsymb) {
9106: $symb=&symbread();
9107: } else {
9108: $symb=$passedsymb;
9109: }
9110: $courseid=$env{'request.course.id'};
9111: $domain=$env{'user.domain'};
9112: $name=$env{'user.name'};
9113: if ($name eq 'public' && $domain eq 'public') {
9114: if (!defined($env{'form.username'})) {
9115: $env{'form.username'}.=time.rand(10000000);
9116: }
9117: $name.=$env{'form.username'};
9118: }
9119: return ($symb,$courseid,$domain,$name,$publicuser);
9120:
9121: }
9122:
1.36 albertel 9123: # ------------------------------------------------------------ Serves up a file
1.472 albertel 9124: # returns either the contents of the file or
9125: # -1 if the file doesn't exist
1.481 raeburn 9126: #
9127: # if the target is a file that was uploaded via DOCS,
9128: # a check will be made to see if a current copy exists on the local server,
9129: # if it does this will be served, otherwise a copy will be retrieved from
9130: # the home server for the course and stored in /home/httpd/html/userfiles on
9131: # the local server.
1.472 albertel 9132:
1.36 albertel 9133: sub getfile {
1.538 albertel 9134: my ($file) = @_;
1.609 banghart 9135: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 9136: &repcopy($file);
9137: return &readfile($file);
9138: }
9139:
9140: sub repcopy_userfile {
9141: my ($file)=@_;
1.609 banghart 9142: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 9143: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 9144: my ($cdom,$cnum,$filename) =
1.811 albertel 9145: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 9146: my $uri="/uploaded/$cdom/$cnum/$filename";
9147: if (-e "$file") {
1.828 www 9148: # we already have a local copy, check it out
1.538 albertel 9149: my @fileinfo = stat($file);
1.828 www 9150: my $rtncode;
9151: my $info;
1.538 albertel 9152: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 9153: if ($lwpresp ne 'ok') {
1.828 www 9154: # there is no such file anymore, even though we had a local copy
1.482 albertel 9155: if ($rtncode eq '404') {
1.538 albertel 9156: unlink($file);
1.482 albertel 9157: }
9158: return -1;
9159: }
9160: if ($info < $fileinfo[9]) {
1.828 www 9161: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 9162: return 'ok';
1.828 www 9163: } else {
9164: # the file is outdated, get rid of it
9165: unlink($file);
1.482 albertel 9166: }
1.828 www 9167: }
9168: # one way or the other, at this point, we don't have the file
9169: # construct the correct path for the file
9170: my @parts = ($cdom,$cnum);
9171: if ($filename =~ m|^(.+)/[^/]+$|) {
9172: push @parts, split(/\//,$1);
9173: }
9174: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9175: foreach my $part (@parts) {
9176: $path .= '/'.$part;
9177: if (!-e $path) {
9178: mkdir($path,0770);
1.482 albertel 9179: }
9180: }
1.828 www 9181: # now the path exists for sure
9182: # get a user agent
9183: my $ua=new LWP::UserAgent;
9184: my $transferfile=$file.'.in.transfer';
9185: # FIXME: this should flock
9186: if (-e $transferfile) { return 'ok'; }
9187: my $request;
9188: $uri=~s/^\///;
1.980 raeburn 9189: my $homeserver = &homeserver($cnum,$cdom);
9190: my $protocol = $protocol{$homeserver};
9191: $protocol = 'http' if ($protocol ne 'https');
9192: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 9193: my $response=$ua->request($request,$transferfile);
9194: # did it work?
9195: if ($response->is_error()) {
9196: unlink($transferfile);
9197: &logthis("Userfile repcopy failed for $uri");
9198: return -1;
9199: }
9200: # worked, rename the transfer file
9201: rename($transferfile,$file);
1.607 raeburn 9202: return 'ok';
1.481 raeburn 9203: }
9204:
1.517 albertel 9205: sub tokenwrapper {
9206: my $uri=shift;
1.980 raeburn 9207: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 9208: $uri=~s|^/||;
1.620 albertel 9209: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 9210: my $token=$1;
1.552 albertel 9211: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9212: if ($udom && $uname && $file) {
9213: $file=~s|(\?\.*)*$||;
1.949 raeburn 9214: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 9215: my $homeserver = &homeserver($uname,$udom);
9216: my $protocol = $protocol{$homeserver};
9217: $protocol = 'http' if ($protocol ne 'https');
9218: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 9219: (($uri=~/\?/)?'&':'?').'token='.$token.
9220: '&tokenissued='.$perlvar{'lonHostID'};
9221: } else {
9222: return '/adm/notfound.html';
9223: }
9224: }
9225:
1.828 www 9226: # call with reqtype HEAD: get last modification time
9227: # call with reqtype GET: get the file contents
9228: # Do not call this with reqtype GET for large files! It loads everything into memory
9229: #
1.481 raeburn 9230: sub getuploaded {
9231: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9232: $uri=~s/^\///;
1.980 raeburn 9233: my $homeserver = &homeserver($cnum,$cdom);
9234: my $protocol = $protocol{$homeserver};
9235: $protocol = 'http' if ($protocol ne 'https');
9236: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 9237: my $ua=new LWP::UserAgent;
9238: my $request=new HTTP::Request($reqtype,$uri);
9239: my $response=$ua->request($request);
9240: $$rtncode = $response->code;
1.482 albertel 9241: if (! $response->is_success()) {
9242: return 'failed';
9243: }
9244: if ($reqtype eq 'HEAD') {
1.486 www 9245: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 9246: } elsif ($reqtype eq 'GET') {
9247: $$info = $response->content;
1.472 albertel 9248: }
1.482 albertel 9249: return 'ok';
1.36 albertel 9250: }
9251:
1.481 raeburn 9252: sub readfile {
9253: my $file = shift;
9254: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9255: my $fh;
9256: open($fh,"<$file");
9257: my $a='';
1.800 albertel 9258: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 9259: return $a;
9260: }
9261:
1.36 albertel 9262: sub filelocation {
1.590 banghart 9263: my ($dir,$file) = @_;
9264: my $location;
9265: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 9266:
9267: if ($file =~ m-^/adm/-) {
9268: $file=~s-^/adm/wrapper/-/-;
9269: $file=~s-^/adm/coursedocs/showdoc/-/-;
9270: }
1.882 albertel 9271:
1.590 banghart 9272: if ($file=~m:^/~:) { # is a contruction space reference
9273: $location = $file;
9274: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 9275: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 9276: # is a correct contruction space reference
9277: $location = $file;
1.956 raeburn 9278: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9279: $location = $file;
1.609 banghart 9280: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 9281: my ($udom,$uname,$filename)=
1.811 albertel 9282: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 9283: my $home=&homeserver($uname,$udom);
9284: my $is_me=0;
9285: my @ids=¤t_machine_ids();
9286: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9287: if ($is_me) {
1.955 raeburn 9288: $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 9289: } else {
9290: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9291: $udom.'/'.$uname.'/'.$filename;
9292: }
1.882 albertel 9293: } elsif ($file =~ m-^/adm/-) {
9294: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 9295: } else {
9296: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9297: $file=~s:^/res/:/:;
9298: if ( !( $file =~ m:^/:) ) {
9299: $location = $dir. '/'.$file;
9300: } else {
9301: $location = '/home/httpd/html/res'.$file;
9302: }
1.59 albertel 9303: }
1.590 banghart 9304: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 9305: while ($location=~m{/\.\./}) {
9306: if ($location =~ m{/[^/]+/\.\./}) {
9307: $location=~ s{/[^/]+/\.\./}{/}g;
9308: } else {
9309: $location=~ s{/\.\./}{/}g;
9310: }
9311: } #remove dir/..
1.590 banghart 9312: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9313: return $location;
1.46 www 9314: }
1.36 albertel 9315:
1.46 www 9316: sub hreflocation {
9317: my ($dir,$file)=@_;
1.980 raeburn 9318: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 9319: $file=filelocation($dir,$file);
1.700 albertel 9320: } elsif ($file=~m-^/adm/-) {
9321: $file=~s-^/adm/wrapper/-/-;
9322: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 9323: }
9324: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9325: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 9326: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9327: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 9328: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 9329: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 9330: -/uploaded/$1/$2/-x;
1.46 www 9331: }
1.913 albertel 9332: if ($file=~ m{^/userfiles/}) {
9333: $file =~ s{^/userfiles/}{/uploaded/};
9334: }
1.462 albertel 9335: return $file;
1.465 albertel 9336: }
9337:
9338: sub current_machine_domains {
1.853 albertel 9339: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9340: }
9341:
9342: sub machine_domains {
9343: my ($hostname) = @_;
1.465 albertel 9344: my @domains;
1.838 albertel 9345: my %hostname = &all_hostnames();
1.465 albertel 9346: while( my($id, $name) = each(%hostname)) {
1.467 matthew 9347: # &logthis("-$id-$name-$hostname-");
1.465 albertel 9348: if ($hostname eq $name) {
1.844 albertel 9349: push(@domains,&host_domain($id));
1.465 albertel 9350: }
9351: }
9352: return @domains;
9353: }
9354:
9355: sub current_machine_ids {
1.853 albertel 9356: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9357: }
9358:
9359: sub machine_ids {
9360: my ($hostname) = @_;
9361: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 9362: my @ids;
1.888 albertel 9363: my %name_to_host = &all_names();
1.889 albertel 9364: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9365: return @{ $name_to_host{$hostname} };
9366: }
9367: return;
1.31 www 9368: }
9369:
1.824 raeburn 9370: sub additional_machine_domains {
9371: my @domains;
9372: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9373: while( my $line = <$fh>) {
9374: $line =~ s/\s//g;
9375: push(@domains,$line);
9376: }
9377: return @domains;
9378: }
9379:
9380: sub default_login_domain {
9381: my $domain = $perlvar{'lonDefDomain'};
9382: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9383: foreach my $posdom (¤t_machine_domains(),
9384: &additional_machine_domains()) {
9385: if (lc($posdom) eq lc($testdomain)) {
9386: $domain=$posdom;
9387: last;
9388: }
9389: }
9390: return $domain;
9391: }
9392:
1.31 www 9393: # ------------------------------------------------------------- Declutters URLs
9394:
9395: sub declutter {
9396: my $thisfn=shift;
1.569 albertel 9397: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 9398: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 9399: $thisfn=~s/^\///;
1.697 albertel 9400: $thisfn=~s|^adm/wrapper/||;
9401: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 9402: $thisfn=~s/^res\///;
1.1032 raeburn 9403: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9404: $thisfn=~s/\?.+$//;
9405: }
1.268 www 9406: return $thisfn;
9407: }
9408:
9409: # ------------------------------------------------------------- Clutter up URLs
9410:
9411: sub clutter {
9412: my $thisfn='/'.&declutter(shift);
1.887 albertel 9413: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 9414: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 9415: $thisfn='/res'.$thisfn;
9416: }
1.1031 raeburn 9417: if ($thisfn !~m|^/adm|) {
9418: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 9419: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 9420: } else {
9421: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9422: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 9423: if ($embstyle eq 'ssi'
9424: || ($embstyle eq 'hdn')
9425: || ($embstyle eq 'rat')
9426: || ($embstyle eq 'prv')
9427: || ($embstyle eq 'ign')) {
9428: #do nothing with these
9429: } elsif (($embstyle eq 'img')
1.695 albertel 9430: || ($embstyle eq 'emb')
9431: || ($embstyle eq 'wrp')) {
9432: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 9433: } elsif ($embstyle eq 'unk'
9434: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 9435: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 9436: } else {
1.718 www 9437: # &logthis("Got a blank emb style");
1.695 albertel 9438: }
1.694 albertel 9439: }
9440: }
1.31 www 9441: return $thisfn;
1.12 www 9442: }
9443:
1.787 albertel 9444: sub clutter_with_no_wrapper {
9445: my $uri = &clutter(shift);
9446: if ($uri =~ m-^/adm/-) {
9447: $uri =~ s-^/adm/wrapper/-/-;
9448: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9449: }
9450: return $uri;
9451: }
9452:
1.557 albertel 9453: sub freeze_escape {
9454: my ($value)=@_;
9455: if (ref($value)) {
9456: $value=&nfreeze($value);
9457: return '__FROZEN__'.&escape($value);
9458: }
9459: return &escape($value);
9460: }
9461:
1.11 www 9462:
1.557 albertel 9463: sub thaw_unescape {
9464: my ($value)=@_;
9465: if ($value =~ /^__FROZEN__/) {
9466: substr($value,0,10,undef);
9467: $value=&unescape($value);
9468: return &thaw($value);
9469: }
9470: return &unescape($value);
9471: }
9472:
1.436 albertel 9473: sub correct_line_ends {
9474: my ($result)=@_;
9475: $$result =~s/\r\n/\n/mg;
9476: $$result =~s/\r/\n/mg;
1.415 albertel 9477: }
1.1 albertel 9478: # ================================================================ Main Program
9479:
1.184 www 9480: sub goodbye {
1.204 albertel 9481: &logthis("Starting Shut down");
1.443 albertel 9482: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 9483: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 9484: #converted
1.599 albertel 9485: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 9486: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9487: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9488: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 9489: #1.1 only
1.870 albertel 9490: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9491: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9492: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9493: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9494: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 9495: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9496: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 9497: &flushcourselogs();
9498: &logthis("Shutting down");
9499: }
9500:
1.852 albertel 9501: sub get_dns {
1.869 albertel 9502: my ($url,$func,$ignore_cache) = @_;
9503: if (!$ignore_cache) {
9504: my ($content,$cached)=
9505: &Apache::lonnet::is_cached_new('dns',$url);
9506: if ($cached) {
9507: &$func($content);
9508: return;
9509: }
9510: }
9511:
9512: my %alldns;
1.852 albertel 9513: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9514: foreach my $dns (<$config>) {
9515: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 9516: my $line = $1;
9517: my ($host,$protocol) = split(/:/,$line);
9518: if ($protocol ne 'https') {
9519: $protocol = 'http';
9520: }
9521: $alldns{$host} = $protocol;
1.869 albertel 9522: }
9523: while (%alldns) {
9524: my ($dns) = keys(%alldns);
1.852 albertel 9525: my $ua=new LWP::UserAgent;
1.979 raeburn 9526: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 9527: my $response=$ua->request($request);
1.979 raeburn 9528: delete($alldns{$dns});
1.852 albertel 9529: next if ($response->is_error());
9530: my @content = split("\n",$response->content);
1.869 albertel 9531: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 9532: &$func(\@content);
1.869 albertel 9533: return;
1.852 albertel 9534: }
9535: close($config);
1.871 albertel 9536: my $which = (split('/',$url))[3];
9537: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9538: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 9539: my @content = <$config>;
9540: &$func(\@content);
9541: return;
1.852 albertel 9542: }
1.327 albertel 9543: # ------------------------------------------------------------ Read domain file
9544: {
1.852 albertel 9545: my $loaded;
1.846 albertel 9546: my %domain;
9547:
1.852 albertel 9548: sub parse_domain_tab {
9549: my ($lines) = @_;
9550: foreach my $line (@$lines) {
9551: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 9552:
1.846 albertel 9553: chomp($line);
1.852 albertel 9554: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 9555: my %this_domain;
9556: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9557: 'lang_def', 'city', 'longi', 'lati',
9558: 'primary') {
9559: $this_domain{$field} = shift(@elements);
9560: }
9561: $domain{$name} = \%this_domain;
1.852 albertel 9562: }
9563: }
1.864 albertel 9564:
9565: sub reset_domain_info {
9566: undef($loaded);
9567: undef(%domain);
9568: }
9569:
1.852 albertel 9570: sub load_domain_tab {
1.869 albertel 9571: my ($ignore_cache) = @_;
9572: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 9573: my $fh;
9574: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9575: my @lines = <$fh>;
9576: &parse_domain_tab(\@lines);
1.448 albertel 9577: }
1.852 albertel 9578: close($fh);
9579: $loaded = 1;
1.327 albertel 9580: }
1.846 albertel 9581:
9582: sub domain {
1.852 albertel 9583: &load_domain_tab() if (!$loaded);
9584:
1.846 albertel 9585: my ($name,$what) = @_;
9586: return if ( !exists($domain{$name}) );
9587:
9588: if (!$what) {
9589: return $domain{$name}{'description'};
9590: }
9591: return $domain{$name}{$what};
9592: }
1.974 raeburn 9593:
9594: sub domain_info {
9595: &load_domain_tab() if (!$loaded);
9596: return %domain;
9597: }
9598:
1.327 albertel 9599: }
9600:
9601:
1.1 albertel 9602: # ------------------------------------------------------------- Read hosts file
9603: {
1.838 albertel 9604: my %hostname;
1.844 albertel 9605: my %hostdom;
1.845 albertel 9606: my %libserv;
1.852 albertel 9607: my $loaded;
1.888 albertel 9608: my %name_to_host;
1.852 albertel 9609:
9610: sub parse_hosts_tab {
9611: my ($file) = @_;
9612: foreach my $configline (@$file) {
9613: next if ($configline =~ /^(\#|\s*$ )/x);
9614: next if ($configline =~ /^\^/);
9615: chomp($configline);
1.968 raeburn 9616: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852 albertel 9617: $name=~s/\s//g;
9618: if ($id && $domain && $role && $name) {
9619: $hostname{$id}=$name;
1.888 albertel 9620: push(@{$name_to_host{$name}}, $id);
1.852 albertel 9621: $hostdom{$id}=$domain;
9622: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 9623: if (defined($protocol)) {
9624: if ($protocol eq 'https') {
9625: $protocol{$id} = $protocol;
9626: } else {
9627: $protocol{$id} = 'http';
9628: }
1.968 raeburn 9629: } else {
1.969 raeburn 9630: $protocol{$id} = 'http';
1.968 raeburn 9631: }
1.852 albertel 9632: }
9633: }
9634: }
1.864 albertel 9635:
9636: sub reset_hosts_info {
1.897 albertel 9637: &purge_remembered();
1.864 albertel 9638: &reset_domain_info();
9639: &reset_hosts_ip_info();
1.892 albertel 9640: undef(%name_to_host);
1.864 albertel 9641: undef(%hostname);
9642: undef(%hostdom);
9643: undef(%libserv);
9644: undef($loaded);
9645: }
1.1 albertel 9646:
1.852 albertel 9647: sub load_hosts_tab {
1.869 albertel 9648: my ($ignore_cache) = @_;
9649: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 9650: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9651: my @config = <$config>;
9652: &parse_hosts_tab(\@config);
9653: close($config);
9654: $loaded=1;
1.1 albertel 9655: }
1.852 albertel 9656:
1.838 albertel 9657: sub hostname {
1.852 albertel 9658: &load_hosts_tab() if (!$loaded);
9659:
1.838 albertel 9660: my ($lonid) = @_;
9661: return $hostname{$lonid};
9662: }
1.845 albertel 9663:
1.838 albertel 9664: sub all_hostnames {
1.852 albertel 9665: &load_hosts_tab() if (!$loaded);
9666:
1.838 albertel 9667: return %hostname;
9668: }
1.845 albertel 9669:
1.888 albertel 9670: sub all_names {
9671: &load_hosts_tab() if (!$loaded);
9672:
9673: return %name_to_host;
9674: }
9675:
1.974 raeburn 9676: sub all_host_domain {
9677: &load_hosts_tab() if (!$loaded);
9678: return %hostdom;
9679: }
9680:
1.845 albertel 9681: sub is_library {
1.852 albertel 9682: &load_hosts_tab() if (!$loaded);
9683:
1.845 albertel 9684: return exists($libserv{$_[0]});
9685: }
9686:
9687: sub all_library {
1.852 albertel 9688: &load_hosts_tab() if (!$loaded);
9689:
1.845 albertel 9690: return %libserv;
9691: }
9692:
1.841 albertel 9693: sub get_servers {
1.852 albertel 9694: &load_hosts_tab() if (!$loaded);
9695:
1.841 albertel 9696: my ($domain,$type) = @_;
9697: my %possible_hosts = ($type eq 'library') ? %libserv
9698: : %hostname;
9699: my %result;
1.842 albertel 9700: if (ref($domain) eq 'ARRAY') {
9701: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 9702: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 9703: $result{$host} = $hostname;
9704: }
9705: }
9706: } else {
9707: while ( my ($host,$hostname) = each(%possible_hosts)) {
9708: if ($hostdom{$host} eq $domain) {
9709: $result{$host} = $hostname;
9710: }
1.841 albertel 9711: }
9712: }
9713: return %result;
9714: }
1.845 albertel 9715:
1.844 albertel 9716: sub host_domain {
1.852 albertel 9717: &load_hosts_tab() if (!$loaded);
9718:
1.844 albertel 9719: my ($lonid) = @_;
9720: return $hostdom{$lonid};
9721: }
9722:
1.841 albertel 9723: sub all_domains {
1.852 albertel 9724: &load_hosts_tab() if (!$loaded);
9725:
1.841 albertel 9726: my %seen;
9727: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9728: return @uniq;
9729: }
1.1 albertel 9730: }
9731:
1.847 albertel 9732: {
9733: my %iphost;
1.856 albertel 9734: my %name_to_ip;
9735: my %lonid_to_ip;
1.869 albertel 9736:
1.847 albertel 9737: sub get_hosts_from_ip {
9738: my ($ip) = @_;
9739: my %iphosts = &get_iphost();
9740: if (ref($iphosts{$ip})) {
9741: return @{$iphosts{$ip}};
9742: }
9743: return;
1.839 albertel 9744: }
1.864 albertel 9745:
9746: sub reset_hosts_ip_info {
9747: undef(%iphost);
9748: undef(%name_to_ip);
9749: undef(%lonid_to_ip);
9750: }
1.856 albertel 9751:
9752: sub get_host_ip {
9753: my ($lonid) = @_;
9754: if (exists($lonid_to_ip{$lonid})) {
9755: return $lonid_to_ip{$lonid};
9756: }
9757: my $name=&hostname($lonid);
9758: my $ip = gethostbyname($name);
9759: return if (!$ip || length($ip) ne 4);
9760: $ip=inet_ntoa($ip);
9761: $name_to_ip{$name} = $ip;
9762: $lonid_to_ip{$lonid} = $ip;
9763: return $ip;
9764: }
1.847 albertel 9765:
9766: sub get_iphost {
1.869 albertel 9767: my ($ignore_cache) = @_;
1.894 albertel 9768:
1.869 albertel 9769: if (!$ignore_cache) {
9770: if (%iphost) {
9771: return %iphost;
9772: }
9773: my ($ip_info,$cached)=
9774: &Apache::lonnet::is_cached_new('iphost','iphost');
9775: if ($cached) {
9776: %iphost = %{$ip_info->[0]};
9777: %name_to_ip = %{$ip_info->[1]};
9778: %lonid_to_ip = %{$ip_info->[2]};
9779: return %iphost;
9780: }
9781: }
1.894 albertel 9782:
9783: # get yesterday's info for fallback
9784: my %old_name_to_ip;
9785: my ($ip_info,$cached)=
9786: &Apache::lonnet::is_cached_new('iphost','iphost');
9787: if ($cached) {
9788: %old_name_to_ip = %{$ip_info->[1]};
9789: }
9790:
1.888 albertel 9791: my %name_to_host = &all_names();
9792: foreach my $name (keys(%name_to_host)) {
1.847 albertel 9793: my $ip;
9794: if (!exists($name_to_ip{$name})) {
9795: $ip = gethostbyname($name);
9796: if (!$ip || length($ip) ne 4) {
1.894 albertel 9797: if (defined($old_name_to_ip{$name})) {
9798: $ip = $old_name_to_ip{$name};
9799: &logthis("Can't find $name defaulting to old $ip");
9800: } else {
9801: &logthis("Name $name no IP found");
9802: next;
9803: }
9804: } else {
9805: $ip=inet_ntoa($ip);
1.847 albertel 9806: }
9807: $name_to_ip{$name} = $ip;
9808: } else {
9809: $ip = $name_to_ip{$name};
1.653 albertel 9810: }
1.888 albertel 9811: foreach my $id (@{ $name_to_host{$name} }) {
9812: $lonid_to_ip{$id} = $ip;
9813: }
9814: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 9815: }
1.869 albertel 9816: &Apache::lonnet::do_cache_new('iphost','iphost',
9817: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 9818: 48*60*60);
1.869 albertel 9819:
1.847 albertel 9820: return %iphost;
1.598 albertel 9821: }
9822:
1.992 raeburn 9823: #
9824: # Given a DNS returns the loncapa host name for that DNS
9825: #
9826: sub host_from_dns {
9827: my ($dns) = @_;
9828: my @hosts;
9829: my $ip;
9830:
1.993 raeburn 9831: if (exists($name_to_ip{$dns})) {
1.992 raeburn 9832: $ip = $name_to_ip{$dns};
9833: }
9834: if (!$ip) {
9835: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9836: if (length($ip) == 4) {
9837: $ip = &IO::Socket::inet_ntoa($ip);
9838: }
9839: }
9840: if ($ip) {
9841: @hosts = get_hosts_from_ip($ip);
9842: return $hosts[0];
9843: }
9844: return undef;
1.986 foxr 9845: }
1.992 raeburn 9846:
1.986 foxr 9847: }
9848:
1.862 albertel 9849: BEGIN {
9850:
9851: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9852: unless ($readit) {
9853: {
9854: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9855: %perlvar = (%perlvar,%{$configvars});
9856: }
9857:
9858:
1.1 albertel 9859: # ------------------------------------------------------ Read spare server file
9860: {
1.448 albertel 9861: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 9862:
9863: while (my $configline=<$config>) {
9864: chomp($configline);
1.284 matthew 9865: if ($configline) {
1.784 albertel 9866: my ($host,$type) = split(':',$configline,2);
1.785 albertel 9867: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 9868: push(@{ $spareid{$type} }, $host);
1.1 albertel 9869: }
9870: }
1.448 albertel 9871: close($config);
1.1 albertel 9872: }
1.11 www 9873: # ------------------------------------------------------------ Read permissions
9874: {
1.448 albertel 9875: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 9876:
9877: while (my $configline=<$config>) {
1.448 albertel 9878: chomp($configline);
9879: if ($configline) {
9880: my ($role,$perm)=split(/ /,$configline);
9881: if ($perm ne '') { $pr{$role}=$perm; }
9882: }
1.11 www 9883: }
1.448 albertel 9884: close($config);
1.11 www 9885: }
9886:
9887: # -------------------------------------------- Read plain texts for permissions
9888: {
1.448 albertel 9889: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 9890:
9891: while (my $configline=<$config>) {
1.448 albertel 9892: chomp($configline);
9893: if ($configline) {
1.742 raeburn 9894: my ($short,@plain)=split(/:/,$configline);
9895: %{$prp{$short}} = ();
9896: if (@plain > 0) {
9897: $prp{$short}{'std'} = $plain[0];
9898: for (my $i=1; $i<@plain; $i++) {
9899: $prp{$short}{'alt'.$i} = $plain[$i];
9900: }
9901: }
1.448 albertel 9902: }
1.135 www 9903: }
1.448 albertel 9904: close($config);
1.135 www 9905: }
9906:
9907: # ---------------------------------------------------------- Read package table
9908: {
1.448 albertel 9909: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 9910:
9911: while (my $configline=<$config>) {
1.483 albertel 9912: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 9913: chomp($configline);
9914: my ($short,$plain)=split(/:/,$configline);
9915: my ($pack,$name)=split(/\&/,$short);
9916: if ($plain ne '') {
9917: $packagetab{$pack.'&'.$name.'&name'}=$name;
9918: $packagetab{$short}=$plain;
9919: }
1.11 www 9920: }
1.448 albertel 9921: close($config);
1.329 matthew 9922: }
9923:
9924: # ------------- set up temporary directory
9925: {
9926: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
9927:
1.11 www 9928: }
9929:
1.794 albertel 9930: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
9931: 'compress_threshold'=> 20_000,
9932: });
1.185 www 9933:
1.281 www 9934: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 9935: $dumpcount=0;
1.958 www 9936: $locknum=0;
1.22 www 9937:
1.163 harris41 9938: &logtouch();
1.672 albertel 9939: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 9940: $readit=1;
1.564 albertel 9941: {
9942: use integer;
9943: my $test=(2**32)+1;
1.568 albertel 9944: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 9945: &logthis(" Detected 64bit platform ($_64bit)");
9946: }
1.195 www 9947: }
1.1 albertel 9948: }
1.179 www 9949:
1.1 albertel 9950: 1;
1.191 harris41 9951: __END__
9952:
1.243 albertel 9953: =pod
9954:
1.191 harris41 9955: =head1 NAME
9956:
1.243 albertel 9957: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 9958:
9959: =head1 SYNOPSIS
9960:
1.243 albertel 9961: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 9962:
9963: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
9964:
1.243 albertel 9965: Common parameters:
9966:
9967: =over 4
9968:
9969: =item *
9970:
9971: $uname : an internal username (if $cname expecting a course Id specifically)
9972:
9973: =item *
9974:
9975: $udom : a domain (if $cdom expecting a course's domain specifically)
9976:
9977: =item *
9978:
9979: $symb : a resource instance identifier
9980:
9981: =item *
9982:
9983: $namespace : the name of a .db file that contains the data needed or
9984: being set.
9985:
9986: =back
9987:
1.394 bowersj2 9988: =head1 OVERVIEW
1.191 harris41 9989:
1.394 bowersj2 9990: lonnet provides subroutines which interact with the
9991: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
9992: about classes, users, and resources.
1.243 albertel 9993:
9994: For many of these objects you can also use this to store data about
9995: them or modify them in various ways.
1.191 harris41 9996:
1.394 bowersj2 9997: =head2 Symbs
1.191 harris41 9998:
1.394 bowersj2 9999: To identify a specific instance of a resource, LON-CAPA uses symbols
10000: or "symbs"X<symb>. These identifiers are built from the URL of the
10001: map, the resource number of the resource in the map, and the URL of
10002: the resource itself. The latter is somewhat redundant, but might help
10003: if maps change.
10004:
10005: An example is
10006:
10007: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
10008:
10009: The respective map entry is
10010:
10011: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10012: title="Problem 2">
10013: </resource>
10014:
10015: Symbs are used by the random number generator, as well as to store and
10016: restore data specific to a certain instance of for example a problem.
10017:
10018: =head2 Storing And Retrieving Data
10019:
10020: X<store()>X<cstore()>X<restore()>Three of the most important functions
10021: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10022: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10023: is is the non-critical message twin of cstore. These functions are for
10024: handlers to store a perl hash to a user's permanent data space in an
10025: easy manner, and to retrieve it again on another call. It is expected
10026: that a handler would use this once at the beginning to retrieve data,
10027: and then again once at the end to send only the new data back.
10028:
10029: The data is stored in the user's data directory on the user's
10030: homeserver under the ID of the course.
10031:
10032: The hash that is returned by restore will have all of the previous
10033: value for all of the elements of the hash.
10034:
10035: Example:
10036:
10037: #creating a hash
10038: my %hash;
10039: $hash{'foo'}='bar';
10040:
10041: #storing it
10042: &Apache::lonnet::cstore(\%hash);
10043:
10044: #changing a value
10045: $hash{'foo'}='notbar';
10046:
10047: #adding a new value
10048: $hash{'bar'}='foo';
10049: &Apache::lonnet::cstore(\%hash);
10050:
10051: #retrieving the hash
10052: my %history=&Apache::lonnet::restore();
10053:
10054: #print the hash
10055: foreach my $key (sort(keys(%history))) {
10056: print("\%history{$key} = $history{$key}");
10057: }
10058:
10059: Will print out:
1.191 harris41 10060:
1.394 bowersj2 10061: %history{1:foo} = bar
10062: %history{1:keys} = foo:timestamp
10063: %history{1:timestamp} = 990455579
10064: %history{2:bar} = foo
10065: %history{2:foo} = notbar
10066: %history{2:keys} = foo:bar:timestamp
10067: %history{2:timestamp} = 990455580
10068: %history{bar} = foo
10069: %history{foo} = notbar
10070: %history{timestamp} = 990455580
10071: %history{version} = 2
10072:
10073: Note that the special hash entries C<keys>, C<version> and
10074: C<timestamp> were added to the hash. C<version> will be equal to the
10075: total number of versions of the data that have been stored. The
10076: C<timestamp> attribute will be the UNIX time the hash was
10077: stored. C<keys> is available in every historical section to list which
10078: keys were added or changed at a specific historical revision of a
10079: hash.
10080:
10081: B<Warning>: do not store the hash that restore returns directly. This
10082: will cause a mess since it will restore the historical keys as if the
10083: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 10084:
1.394 bowersj2 10085: Calling convention:
1.191 harris41 10086:
1.394 bowersj2 10087: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10088: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 10089:
1.394 bowersj2 10090: For more detailed information, see lonnet specific documentation.
1.191 harris41 10091:
1.394 bowersj2 10092: =head1 RETURN MESSAGES
1.191 harris41 10093:
1.394 bowersj2 10094: =over 4
1.191 harris41 10095:
1.394 bowersj2 10096: =item * B<con_lost>: unable to contact remote host
1.191 harris41 10097:
1.394 bowersj2 10098: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10099: when the connection is brought back up
1.191 harris41 10100:
1.394 bowersj2 10101: =item * B<con_failed>: unable to contact remote host and unable to save message
10102: for later delivery
1.191 harris41 10103:
1.967 bisitz 10104: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 10105:
1.394 bowersj2 10106: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 10107: that was requested
1.191 harris41 10108:
1.243 albertel 10109: =back
1.191 harris41 10110:
1.243 albertel 10111: =head1 PUBLIC SUBROUTINES
1.191 harris41 10112:
1.243 albertel 10113: =head2 Session Environment Functions
1.191 harris41 10114:
1.243 albertel 10115: =over 4
1.191 harris41 10116:
1.394 bowersj2 10117: =item *
10118: X<appenv()>
1.949 raeburn 10119: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 10120: the user envirnoment file, and will be restored for each access this
1.620 albertel 10121: user makes during this session, also modifies the %env for the current
1.949 raeburn 10122: process. Optional rolesarrayref - if defined contains a reference to an array
10123: of roles which are exempt from the restriction on modifying user.role entries
10124: in the user's environment.db and in %env.
1.191 harris41 10125:
10126: =item *
1.394 bowersj2 10127: X<delenv()>
1.987 raeburn 10128: B<delenv($delthis,$regexp)>: removes all items from the session
10129: environment file that begin with $delthis. If the
10130: optional second arg - $regexp - is true, $delthis is treated as a
10131: regular expression, otherwise \Q$delthis\E is used.
10132: The values are also deleted from the current processes %env.
1.191 harris41 10133:
1.795 albertel 10134: =item * get_env_multiple($name)
10135:
10136: gets $name from the %env hash, it seemlessly handles the cases where multiple
10137: values may be defined and end up as an array ref.
10138:
10139: returns an array of values
10140:
1.243 albertel 10141: =back
10142:
10143: =head2 User Information
1.191 harris41 10144:
1.243 albertel 10145: =over 4
1.191 harris41 10146:
10147: =item *
1.394 bowersj2 10148: X<queryauthenticate()>
10149: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 10150: authentication scheme
10151:
10152: =item *
1.394 bowersj2 10153: X<authenticate()>
10154: B<authenticate($uname,$upass,$udom)>: try to
10155: authenticate user from domain's lib servers (first use the current
10156: one). C<$upass> should be the users password.
1.191 harris41 10157:
10158: =item *
1.394 bowersj2 10159: X<homeserver()>
10160: B<homeserver($uname,$udom)>: find the server which has
10161: the user's directory and files (there must be only one), this caches
10162: the answer, and also caches if there is a borken connection.
1.191 harris41 10163:
10164: =item *
1.394 bowersj2 10165: X<idget()>
10166: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10167: (IDs are a unique resource in a domain, there must be only 1 ID per
10168: username, and only 1 username per ID in a specific domain) (returns
10169: hash: id=>name,id=>name)
1.191 harris41 10170:
10171: =item *
1.394 bowersj2 10172: X<idrget()>
10173: B<idrget($udom,@unames)>: find the IDs behind a list of
10174: usernames (returns hash: name=>id,name=>id)
1.191 harris41 10175:
10176: =item *
1.394 bowersj2 10177: X<idput()>
10178: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 10179:
10180: =item *
1.394 bowersj2 10181: X<rolesinit()>
10182: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 10183:
10184: =item *
1.551 albertel 10185: X<getsection()>
10186: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 10187: course $cname, return section name/number or '' for "not in course"
10188: and '-1' for "no section"
10189:
10190: =item *
1.394 bowersj2 10191: X<userenvironment()>
10192: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 10193: passed in @what from the requested user's environment, returns a hash
10194:
1.858 raeburn 10195: =item *
10196: X<userlog_query()>
1.859 albertel 10197: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10198: activity.log file. %filters defines filters applied when parsing the
10199: log file. These can be start or end timestamps, or the type of action
10200: - log to look for Login or Logout events, check for Checkin or
10201: Checkout, role for role selection. The response is in the form
10202: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10203: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 10204:
1.243 albertel 10205: =back
10206:
10207: =head2 User Roles
10208:
10209: =over 4
10210:
10211: =item *
10212:
1.810 raeburn 10213: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 10214: F: full access
10215: U,I,K: authentication modes (cxx only)
10216: '': forbidden
10217: 1: user needs to choose course
10218: 2: browse allowed
1.766 albertel 10219: A: passphrase authentication needed
1.243 albertel 10220:
10221: =item *
10222:
10223: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10224: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10225: and course level
10226:
10227: =item *
10228:
1.988 raeburn 10229: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10230: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 10231: $type is Course (default) or Community.
1.988 raeburn 10232: If $forcedefault evaluates to true, text returned will be default
10233: text for $type. Otherwise, if this is a course, the text returned
10234: will be a custom name for the role (if defined in the course's
10235: environment). If no custom name is defined the default is returned.
10236:
1.832 raeburn 10237: =item *
10238:
1.935 raeburn 10239: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 10240: All arguments are optional. Returns a hash of a roles, either for
10241: co-author/assistant author roles for a user's Construction Space
1.906 albertel 10242: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 10243: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10244: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10245: For each key, value is set to colon-separated start and end times for
10246: the role. If no username and domain are specified, will default to
1.934 raeburn 10247: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 10248: of role statuses (active, future or previous), roles
10249: (e.g., cc,in, st etc.) and domains of the roles which can be used
10250: to restrict the list of roles reported. If no array ref is
10251: provided for types, will default to return only active roles.
1.834 albertel 10252:
1.243 albertel 10253: =back
10254:
10255: =head2 User Modification
10256:
10257: =over 4
10258:
10259: =item *
10260:
1.957 raeburn 10261: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 10262: user for the level given by URL. Optional start and end dates (leave empty
10263: string or zero for "no date")
1.191 harris41 10264:
10265: =item *
10266:
1.243 albertel 10267: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10268: change a users, password, possible return values are: ok,
10269: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10270: refused
1.191 harris41 10271:
10272: =item *
10273:
1.243 albertel 10274: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 10275:
10276: =item *
10277:
1.963 raeburn 10278: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,
10279: $forceid,$desiredhome,$email,$inststatus) :
1.243 albertel 10280: modify user
1.191 harris41 10281:
10282: =item *
10283:
1.286 matthew 10284: modifystudent
10285:
1.957 raeburn 10286: modify a student's enrollment and identification information.
1.286 matthew 10287: The course id is resolved based on the current users environment.
10288: This means the envoking user must be a course coordinator or otherwise
10289: associated with a course.
10290:
1.297 matthew 10291: This call is essentially a wrapper for lonnet::modifyuser and
10292: lonnet::modify_student_enrollment
1.286 matthew 10293:
10294: Inputs:
10295:
10296: =over 4
10297:
1.957 raeburn 10298: =item B<$udom> Student's loncapa domain
1.286 matthew 10299:
1.957 raeburn 10300: =item B<$uname> Student's loncapa login name
1.286 matthew 10301:
1.964 bisitz 10302: =item B<$uid> Student/Employee ID
1.286 matthew 10303:
1.957 raeburn 10304: =item B<$umode> Student's authentication mode
1.286 matthew 10305:
1.957 raeburn 10306: =item B<$upass> Student's password
1.286 matthew 10307:
1.957 raeburn 10308: =item B<$first> Student's first name
1.286 matthew 10309:
1.957 raeburn 10310: =item B<$middle> Student's middle name
1.286 matthew 10311:
1.957 raeburn 10312: =item B<$last> Student's last name
1.286 matthew 10313:
1.957 raeburn 10314: =item B<$gene> Student's generation
1.286 matthew 10315:
1.957 raeburn 10316: =item B<$usec> Student's section in course
1.286 matthew 10317:
10318: =item B<$end> Unix time of the roles expiration
10319:
10320: =item B<$start> Unix time of the roles start date
10321:
10322: =item B<$forceid> If defined, allow $uid to be changed
10323:
10324: =item B<$desiredhome> server to use as home server for student
10325:
1.957 raeburn 10326: =item B<$email> Student's permanent e-mail address
10327:
10328: =item B<$type> Type of enrollment (auto or manual)
10329:
1.963 raeburn 10330: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10331:
10332: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 10333:
1.963 raeburn 10334: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 10335:
1.963 raeburn 10336: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 10337:
1.963 raeburn 10338: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 10339:
1.286 matthew 10340: =back
1.297 matthew 10341:
10342: =item *
10343:
10344: modify_student_enrollment
10345:
10346: Change a students enrollment status in a class. The environment variable
10347: 'role.request.course' must be defined for this function to proceed.
10348:
10349: Inputs:
10350:
10351: =over 4
10352:
10353: =item $udom, students domain
10354:
10355: =item $uname, students name
10356:
10357: =item $uid, students user id
10358:
10359: =item $first, students first name
10360:
10361: =item $middle
10362:
10363: =item $last
10364:
10365: =item $gene
10366:
10367: =item $usec
10368:
10369: =item $end
10370:
10371: =item $start
10372:
1.957 raeburn 10373: =item $type
10374:
10375: =item $locktype
10376:
10377: =item $cid
10378:
10379: =item $selfenroll
10380:
10381: =item $context
10382:
1.297 matthew 10383: =back
10384:
1.191 harris41 10385:
10386: =item *
10387:
1.243 albertel 10388: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10389: custom role; give a custom role to a user for the level given by URL. Specify
10390: name and domain of role author, and role name
1.191 harris41 10391:
10392: =item *
10393:
1.243 albertel 10394: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 10395:
10396: =item *
10397:
1.243 albertel 10398: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10399:
10400: =back
10401:
10402: =head2 Course Infomation
10403:
10404: =over 4
1.191 harris41 10405:
10406: =item *
10407:
1.631 albertel 10408: coursedescription($courseid) : returns a hash of information about the
10409: specified course id, including all environment settings for the
10410: course, the description of the course will be in the hash under the
10411: key 'description'
1.191 harris41 10412:
10413: =item *
10414:
1.624 albertel 10415: resdata($name,$domain,$type,@which) : request for current parameter
10416: setting for a specific $type, where $type is either 'course' or 'user',
10417: @what should be a list of parameters to ask about. This routine caches
10418: answers for 5 minutes.
1.243 albertel 10419:
1.877 foxr 10420: =item *
10421:
10422: get_courseresdata($courseid, $domain) : dump the entire course resource
10423: data base, returning a hash that is keyed by the resource name and has
10424: values that are the resource value. I believe that the timestamps and
10425: versions are also returned.
10426:
10427:
1.243 albertel 10428: =back
10429:
10430: =head2 Course Modification
10431:
10432: =over 4
1.191 harris41 10433:
10434: =item *
10435:
1.243 albertel 10436: writecoursepref($courseid,%prefs) : write preferences (environment
10437: database) for a course
1.191 harris41 10438:
10439: =item *
10440:
1.1011 raeburn 10441: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10442:
10443: =item *
10444:
1.1038 raeburn 10445: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 10446:
10447: =back
10448:
10449: =head2 Resource Subroutines
10450:
10451: =over 4
1.191 harris41 10452:
10453: =item *
10454:
1.243 albertel 10455: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 10456:
10457: =item *
10458:
1.243 albertel 10459: repcopy($filename) : subscribes to the requested file, and attempts to
10460: replicate from the owning library server, Might return
1.607 raeburn 10461: 'unavailable', 'not_found', 'forbidden', 'ok', or
10462: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 10463: resource. Expects the local filesystem pathname
10464: (/home/httpd/html/res/....)
10465:
10466: =back
10467:
10468: =head2 Resource Information
10469:
10470: =over 4
1.191 harris41 10471:
10472: =item *
10473:
1.243 albertel 10474: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10475: a vairety of different possible values, $varname should be a request
10476: string, and the other parameters can be used to specify who and what
10477: one is asking about.
10478:
10479: Possible values for $varname are environment.lastname (or other item
10480: from the envirnment hash), user.name (or someother aspect about the
10481: user), resource.0.maxtries (or some other part and parameter of a
10482: resource)
1.204 albertel 10483:
10484: =item *
10485:
1.243 albertel 10486: directcondval($number) : get current value of a condition; reads from a state
10487: string
1.204 albertel 10488:
10489: =item *
10490:
1.243 albertel 10491: condval($condidx) : value of condition index based on state
1.204 albertel 10492:
10493: =item *
10494:
1.243 albertel 10495: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10496: resource's metadata, $what should be either a specific key, or either
10497: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10498: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10499:
10500: this function automatically caches all requests
1.191 harris41 10501:
10502: =item *
10503:
1.243 albertel 10504: metadata_query($query,$custom,$customshow) : make a metadata query against the
10505: network of library servers; returns file handle of where SQL and regex results
10506: will be stored for query
1.191 harris41 10507:
10508: =item *
10509:
1.243 albertel 10510: symbread($filename) : return symbolic list entry (filename argument optional);
10511: returns the data handle
1.191 harris41 10512:
10513: =item *
10514:
1.243 albertel 10515: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 10516: a possible symb for the URL in $thisfn, and if is an encryypted
10517: resource that the user accessed using /enc/ returns a 1 on success, 0
10518: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 10519: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 10520:
1.191 harris41 10521:
10522: =item *
10523:
1.243 albertel 10524: symbclean($symb) : removes versions numbers from a symb, returns the
10525: cleaned symb
1.191 harris41 10526:
10527: =item *
10528:
1.243 albertel 10529: is_on_map($uri) : checks if the $uri is somewhere on the current
10530: course map, user must be in a course for it to work.
1.191 harris41 10531:
10532: =item *
10533:
1.243 albertel 10534: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 10535:
10536: =item *
10537:
1.243 albertel 10538: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10539: a random seed, all arguments are optional, if they aren't sent it uses the
10540: environment to derive them. Note: if symb isn't sent and it can't get one
10541: from &symbread it will use the current time as its return value
1.191 harris41 10542:
10543: =item *
10544:
1.243 albertel 10545: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10546: unfakeable, receipt
1.191 harris41 10547:
10548: =item *
10549:
1.620 albertel 10550: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 10551:
10552: =item *
10553:
1.243 albertel 10554: countacc($url) : count the number of accesses to a given URL
1.191 harris41 10555:
10556: =item *
10557:
1.243 albertel 10558: 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 10559:
10560: =item *
10561:
1.243 albertel 10562: 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 10563:
10564: =item *
10565:
1.243 albertel 10566: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 10567:
10568: =item *
10569:
1.243 albertel 10570: devalidate($symb) : devalidate temporary spreadsheet calculations,
10571: forcing spreadsheet to reevaluate the resource scores next time.
10572:
10573: =back
10574:
10575: =head2 Storing/Retreiving Data
10576:
10577: =over 4
1.191 harris41 10578:
10579: =item *
10580:
1.243 albertel 10581: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10582: for this url; hashref needs to be given and should be a \%hashname; the
10583: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 10584: be derived from the env
1.191 harris41 10585:
10586: =item *
10587:
1.243 albertel 10588: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10589: uses critical subroutine
1.191 harris41 10590:
10591: =item *
10592:
1.243 albertel 10593: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10594: all args are optional
1.191 harris41 10595:
10596: =item *
10597:
1.717 albertel 10598: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10599: dumps the complete (or key matching regexp) namespace into a hash
10600: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10601: normally &store()ed into
10602:
10603: $range should be either an integer '100' (give me the first 100
10604: matching records)
10605: or be two integers sperated by a - with no spaces
10606: '30-50' (give me the 30th through the 50th matching
10607: records)
10608:
10609:
10610: =item *
10611:
10612: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10613: replaces a &store() version of data with a replacement set of data
10614: for a particular resource in a namespace passed in the $storehash hash
10615: reference
10616:
10617: =item *
10618:
1.243 albertel 10619: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10620: works very similar to store/cstore, but all data is stored in a
10621: temporary location and can be reset using tmpreset, $storehash should
10622: be a hash reference, returns nothing on success
1.191 harris41 10623:
10624: =item *
10625:
1.243 albertel 10626: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10627: similar to restore, but all data is stored in a temporary location and
10628: can be reset using tmpreset. Returns a hash of values on success,
10629: error string otherwise.
1.191 harris41 10630:
10631: =item *
10632:
1.243 albertel 10633: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10634: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 10635:
10636: =item *
10637:
1.243 albertel 10638: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10639: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 10640:
10641: =item *
10642:
1.243 albertel 10643: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10644: namesp ($udom and $uname are optional)
1.191 harris41 10645:
10646: =item *
10647:
1.702 albertel 10648: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 10649: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 10650: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 10651:
1.702 albertel 10652: $range should be either an integer '100' (give me the first 100
10653: matching records)
10654: or be two integers sperated by a - with no spaces
10655: '30-50' (give me the 30th through the 50th matching
10656: records)
1.449 matthew 10657: =item *
10658:
10659: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10660: $store can be a scalar, an array reference, or if the amount to be
10661: incremented is > 1, a hash reference.
10662:
10663: ($udom and $uname are optional)
1.191 harris41 10664:
10665: =item *
10666:
1.243 albertel 10667: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10668: ($udom and $uname are optional)
1.191 harris41 10669:
10670: =item *
10671:
1.243 albertel 10672: cput($namespace,$storehash,$udom,$uname) : critical put
10673: ($udom and $uname are optional)
1.191 harris41 10674:
10675: =item *
10676:
1.748 albertel 10677: newput($namespace,$storehash,$udom,$uname) :
10678:
10679: Attempts to store the items in the $storehash, but only if they don't
10680: currently exist, if this succeeds you can be certain that you have
10681: successfully created a new key value pair in the $namespace db.
10682:
10683:
10684: Args:
10685: $namespace: name of database to store values to
10686: $storehash: hashref to store to the db
10687: $udom: (optional) domain of user containing the db
10688: $uname: (optional) name of user caontaining the db
10689:
10690: Returns:
10691: 'ok' -> succeeded in storing all keys of $storehash
10692: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10693: least <key> already existed in the db (other
10694: requested keys may also already exist)
1.967 bisitz 10695: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 10696: 'con_lost' -> unable to contact request server
10697: 'refused' -> action was not allowed by remote machine
10698:
10699:
10700: =item *
10701:
1.243 albertel 10702: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10703: reference filled in from namesp (encrypts the return communication)
10704: ($udom and $uname are optional)
1.191 harris41 10705:
10706: =item *
10707:
1.243 albertel 10708: log($udom,$name,$home,$message) : write to permanent log for user; use
10709: critical subroutine
10710:
1.806 raeburn 10711: =item *
10712:
1.860 raeburn 10713: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10714: array reference filled in from namespace found in domain level on either
10715: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 10716:
10717: =item *
10718:
1.860 raeburn 10719: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10720: domain level either on specified domain server ($uhome) or primary domain
10721: server ($udom and $uhome are optional)
1.806 raeburn 10722:
1.943 raeburn 10723: =item *
10724:
10725: get_domain_defaults($target_domain) : returns hash with defaults for
10726: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10727: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10728: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10729: Values are retrieved from cache (if current), or from domain's configuration.db
10730: (if available), or lastly from values in lonTabs/dns_domain,tab,
10731: or lonTabs/domain.tab.
10732:
10733: %domdefaults = &get_auth_defaults($target_domain);
10734:
1.243 albertel 10735: =back
10736:
10737: =head2 Network Status Functions
10738:
10739: =over 4
1.191 harris41 10740:
10741: =item *
10742:
10743: dirlist($uri) : return directory list based on URI
10744:
10745: =item *
10746:
1.243 albertel 10747: spareserver() : find server with least workload from spare.tab
10748:
1.986 foxr 10749:
10750: =item *
10751:
10752: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10753: if there is no corresponding loncapa host.
10754:
1.243 albertel 10755: =back
10756:
1.986 foxr 10757:
1.243 albertel 10758: =head2 Apache Request
10759:
10760: =over 4
1.191 harris41 10761:
10762: =item *
10763:
1.243 albertel 10764: ssi($url,%hash) : server side include, does a complete request cycle on url to
10765: localhost, posts hash
10766:
10767: =back
10768:
10769: =head2 Data to String to Data
10770:
10771: =over 4
1.191 harris41 10772:
10773: =item *
10774:
1.243 albertel 10775: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10776: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 10777:
10778: =item *
10779:
1.243 albertel 10780: hashref2str($hashref) : convert a hashref into a string complete with
10781: escaping and '=' and '&' separators, supports elements that are
10782: arrayrefs and hashrefs
1.191 harris41 10783:
10784: =item *
10785:
1.243 albertel 10786: arrayref2str($arrayref) : convert an arrayref into a string complete
10787: with escaping and '&' separators, supports elements that are arrayrefs
10788: and hashrefs
1.191 harris41 10789:
10790: =item *
10791:
1.243 albertel 10792: str2hash($string) : convert string to hash using unescaping and
10793: splitting on '=' and '&', supports elements that are arrayrefs and
10794: hashrefs
1.191 harris41 10795:
10796: =item *
10797:
1.243 albertel 10798: str2array($string) : convert string to hash using unescaping and
10799: splitting on '&', supports elements that are arrayrefs and hashrefs
10800:
10801: =back
10802:
10803: =head2 Logging Routines
10804:
10805: =over 4
10806:
10807: These routines allow one to make log messages in the lonnet.log and
10808: lonnet.perm logfiles.
1.191 harris41 10809:
10810: =item *
10811:
1.243 albertel 10812: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 10813:
10814: =item *
10815:
1.243 albertel 10816: logthis() : append message to the normal lonnet.log file, it gets
10817: preiodically rolled over and deleted.
1.191 harris41 10818:
10819: =item *
10820:
1.243 albertel 10821: logperm() : append a permanent message to lonnet.perm.log, this log
10822: file never gets deleted by any automated portion of the system, only
10823: messages of critical importance should go in here.
10824:
10825: =back
10826:
10827: =head2 General File Helper Routines
10828:
10829: =over 4
1.191 harris41 10830:
10831: =item *
10832:
1.481 raeburn 10833: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10834: (a) files in /uploaded
10835: (i) If a local copy of the file exists -
10836: compares modification date of local copy with last-modified date for
10837: definitive version stored on home server for course. If local copy is
10838: stale, requests a new version from the home server and stores it.
10839: If the original has been removed from the home server, then local copy
10840: is unlinked.
10841: (ii) If local copy does not exist -
10842: requests the file from the home server and stores it.
10843:
10844: If $caller is 'uploadrep':
10845: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10846: for request for files originally uploaded via DOCS.
10847: - returns 'ok' if fresh local copy now available, -1 otherwise.
10848:
10849: Otherwise:
10850: This indicates a call from the content generation phase of the request.
10851: - returns the entire contents of the file or -1.
10852:
10853: (b) files in /res
10854: - returns the entire contents of a file or -1;
10855: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 10856:
1.712 albertel 10857:
10858: =item *
10859:
10860: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10861: reference
10862:
10863: returns either a stat() list of data about the file or an empty list
10864: if the file doesn't exist or couldn't find out about it (connection
10865: problems or user unknown)
10866:
1.191 harris41 10867: =item *
10868:
1.243 albertel 10869: filelocation($dir,$file) : returns file system location of a file
10870: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10871: directory that relative $file lookups are to looked in ($dir of /a/dir
10872: and a file of ../bob will become /a/bob)
1.191 harris41 10873:
10874: =item *
10875:
10876: hreflocation($dir,$file) : returns file system location or a URL; same as
10877: filelocation except for hrefs
10878:
10879: =item *
10880:
10881: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10882:
1.243 albertel 10883: =back
10884:
1.608 albertel 10885: =head2 Usererfile file routines (/uploaded*)
10886:
10887: =over 4
10888:
10889: =item *
10890:
10891: userfileupload(): main rotine for putting a file in a user or course's
10892: filespace, arguments are,
10893:
1.620 albertel 10894: formname - required - this is the name of the element in $env where the
1.608 albertel 10895: filename, and the contents of the file to create/modifed exist
1.620 albertel 10896: the filename is in $env{'form.'.$formname.'.filename'} and the
10897: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 10898: coursedoc - if true, store the file in the course of the active role
10899: of the current user
10900: subdir - required - subdirectory to put the file in under ../userfiles/
10901: if undefined, it will be placed in "unknown"
10902:
10903: (This routine calls clean_filename() to remove any dangerous
10904: characters from the filename, and then calls finuserfileupload() to
10905: complete the transaction)
10906:
10907: returns either the url of the uploaded file (/uploaded/....) if successful
10908: and /adm/notfound.html if unsuccessful
10909:
10910: =item *
10911:
10912: clean_filename(): routine for cleaing a filename up for storage in
10913: userfile space, argument is:
10914:
10915: filename - proposed filename
10916:
10917: returns: the new clean filename
10918:
10919: =item *
10920:
10921: finishuserfileupload(): routine that creaes and sends the file to
10922: userspace, probably shouldn't be called directly
10923:
10924: docuname: username or courseid of destination for the file
10925: docudom: domain of user/course of destination for the file
10926: formname: same as for userfileupload()
10927: fname: filename (inculding subdirectories) for the file
10928:
10929: returns either the url of the uploaded file (/uploaded/....) if successful
10930: and /adm/notfound.html if unsuccessful
10931:
10932: =item *
10933:
10934: renameuserfile(): renames an existing userfile to a new name
10935:
10936: Args:
10937: docuname: username or courseid of destination for the file
10938: docudom: domain of user/course of destination for the file
10939: old: current file name (including any subdirs under userfiles)
10940: new: desired file name (including any subdirs under userfiles)
10941:
10942: =item *
10943:
10944: mkdiruserfile(): creates a directory is a userfiles dir
10945:
10946: Args:
10947: docuname: username or courseid of destination for the file
10948: docudom: domain of user/course of destination for the file
10949: dir: dir to create (including any subdirs under userfiles)
10950:
10951: =item *
10952:
10953: removeuserfile(): removes a file that exists in userfiles
10954:
10955: Args:
10956: docuname: username or courseid of destination for the file
10957: docudom: domain of user/course of destination for the file
10958: fname: filname to delete (including any subdirs under userfiles)
10959:
10960: =item *
10961:
10962: removeuploadedurl(): convience function for removeuserfile()
10963:
10964: Args:
10965: url: a full /uploaded/... url to delete
10966:
1.747 albertel 10967: =item *
10968:
10969: get_portfile_permissions():
10970: Args:
10971: domain: domain of user or course contain the portfolio files
10972: user: name of user or num of course contain the portfolio files
10973: Returns:
10974: hashref of a dump of the proper file_permissions.db
10975:
10976:
10977: =item *
10978:
10979: get_access_controls():
10980:
10981: Args:
10982: current_permissions: the hash ref returned from get_portfile_permissions()
10983: group: (optional) the group you want the files associated with
10984: file: (optional) the file you want access info on
10985:
10986: Returns:
1.749 raeburn 10987: a hash (keys are file names) of hashes containing
10988: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
10989: values are XML containing access control settings (see below)
1.747 albertel 10990:
10991: Internal notes:
10992:
1.749 raeburn 10993: access controls are stored in file_permissions.db as key=value pairs.
10994: key -> path to file/file_name\0uniqueID:scope_end_start
10995: where scope -> public,guest,course,group,domains or users.
10996: end -> UNIX time for end of access (0 -> no end date)
10997: start -> UNIX time for start of access
10998:
10999: value -> XML description of access control
11000: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
11001: <start></start>
11002: <end></end>
11003:
11004: <password></password> for scope type = guest
11005:
11006: <domain></domain> for scope type = course or group
11007: <number></number>
11008: <roles id="">
11009: <role></role>
11010: <access></access>
11011: <section></section>
11012: <group></group>
11013: </roles>
11014:
11015: <dom></dom> for scope type = domains
11016:
11017: <users> for scope type = users
11018: <user>
11019: <uname></uname>
11020: <udom></udom>
11021: </user>
11022: </users>
11023: </scope>
11024:
11025: Access data is also aggregated for each file in an additional key=value pair:
11026: key -> path to file/file_name\0accesscontrol
11027: value -> reference to hash
11028: hash contains key = value pairs
11029: where key = uniqueID:scope_end_start
11030: value = UNIX time record was last updated
11031:
11032: Used to improve speed of look-ups of access controls for each file.
11033:
11034: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11035:
11036: modify_access_controls():
11037:
11038: Modifies access controls for a portfolio file
11039: Args
11040: 1. file name
11041: 2. reference to hash of required changes,
11042: 3. domain
11043: 4. username
11044: where domain,username are the domain of the portfolio owner
11045: (either a user or a course)
11046:
11047: Returns:
11048: 1. result of additions or updates ('ok' or 'error', with error message).
11049: 2. result of deletions ('ok' or 'error', with error message).
11050: 3. reference to hash of any new or updated access controls.
11051: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11052: key = integer (inbound ID)
11053: value = uniqueID
1.747 albertel 11054:
1.608 albertel 11055: =back
11056:
1.243 albertel 11057: =head2 HTTP Helper Routines
11058:
11059: =over 4
11060:
1.191 harris41 11061: =item *
11062:
11063: escape() : unpack non-word characters into CGI-compatible hex codes
11064:
11065: =item *
11066:
11067: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11068:
1.243 albertel 11069: =back
11070:
11071: =head1 PRIVATE SUBROUTINES
11072:
11073: =head2 Underlying communication routines (Shouldn't call)
11074:
11075: =over 4
11076:
11077: =item *
11078:
11079: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11080:
11081: =item *
11082:
11083: reply() : uses subreply to send a message to remote machine, logs all failures
11084:
11085: =item *
11086:
11087: critical() : passes a critical message to another server; if cannot
11088: get through then place message in connection buffer directory and
11089: returns con_delayed, if incapable of saving message, returns
11090: con_failed
11091:
11092: =item *
11093:
11094: reconlonc() : tries to reconnect lonc client processes.
11095:
11096: =back
11097:
11098: =head2 Resource Access Logging
11099:
11100: =over 4
11101:
11102: =item *
11103:
11104: flushcourselogs() : flush (save) buffer logs and access logs
11105:
11106: =item *
11107:
11108: courselog($what) : save message for course in hash
11109:
11110: =item *
11111:
11112: courseacclog($what) : save message for course using &courselog(). Perform
11113: special processing for specific resource types (problems, exams, quizzes, etc).
11114:
1.191 harris41 11115: =item *
11116:
11117: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11118: as a PerlChildExitHandler
1.243 albertel 11119:
11120: =back
11121:
11122: =head2 Other
11123:
11124: =over 4
11125:
11126: =item *
11127:
11128: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 11129:
11130: =back
11131:
11132: =cut
1.877 foxr 11133:
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