Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1056.2.5
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1056.2.5! raeburn 4: # $Id: lonnet.pm,v 1.1056.2.4 2010/05/22 13:50:19 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,
1.1056.2.5! raeburn 3062: $cloneonly,$createdbefore,$createdafter,$creationcontext,$domcloner)=@_;
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).':'.
1.1056.2.5! raeburn 3084: &escape($creationcontext).':'.$domcloner,
! 3085: $tryserver);
1.918 raeburn 3086: my @pairs=split(/\&/,$rep);
3087: foreach my $item (@pairs) {
3088: my ($key,$value)=split(/\=/,$item,2);
3089: $key = &unescape($key);
3090: next if ($key =~ /^error: 2 /);
3091: my $result = &thaw_unescape($value);
3092: if (ref($result) eq 'HASH') {
3093: $returnhash{$key}=$result;
3094: } else {
1.921 raeburn 3095: my @responses = split(/:/,$value);
3096: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3097: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3098: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3099: }
1.1008 raeburn 3100: }
1.353 www 3101: }
3102: }
3103: }
3104: }
3105: return %returnhash;
3106: }
3107:
1.1055 raeburn 3108: sub courselastaccess {
3109: my ($cdom,$cnum,$hostidref) = @_;
3110: my %returnhash;
3111: if ($cdom && $cnum) {
3112: my $chome = &homeserver($cnum,$cdom);
3113: if ($chome ne 'no_host') {
3114: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3115: &extract_lastaccess(\%returnhash,$rep);
3116: }
3117: } else {
3118: if (!$cdom) { $cdom=''; }
3119: my %libserv = &all_library();
3120: foreach my $tryserver (keys(%libserv)) {
3121: if (ref($hostidref) eq 'ARRAY') {
3122: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3123: }
3124: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3125: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3126: &extract_lastaccess(\%returnhash,$rep);
3127: }
3128: }
3129: }
3130: return %returnhash;
3131: }
3132:
3133: sub extract_lastaccess {
3134: my ($returnhash,$rep) = @_;
3135: if (ref($returnhash) eq 'HASH') {
3136: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3137: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3138: $rep eq '') {
3139: my @pairs=split(/\&/,$rep);
3140: foreach my $item (@pairs) {
3141: my ($key,$value)=split(/\=/,$item,2);
3142: $key = &unescape($key);
3143: next if ($key =~ /^error: 2 /);
3144: $returnhash->{$key} = &thaw_unescape($value);
3145: }
3146: }
3147: }
3148: return;
3149: }
3150:
1.658 raeburn 3151: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3152:
3153: sub dcmailput {
1.685 raeburn 3154: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3155: my $status = &Apache::lonnet::critical(
1.740 www 3156: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3157: &escape($message),$server);
1.662 raeburn 3158: return $status;
3159: }
3160:
1.658 raeburn 3161: sub dcmaildump {
3162: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3163: my %returnhash=();
1.846 albertel 3164:
3165: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3166: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3167: &escape($enddate).':';
3168: my @esc_senders=map { &escape($_)} @$senders;
3169: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3170: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3171: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3172: if (($key) && ($value)) {
3173: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3174: }
3175: }
3176: }
3177: return %returnhash;
3178: }
1.662 raeburn 3179: # ---------------------------------------------------------- Domain roles
3180:
3181: sub get_domain_roles {
3182: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 3183: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 3184: $startdate = '.';
3185: }
1.1018 raeburn 3186: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 3187: $enddate = '.';
3188: }
1.922 raeburn 3189: my $rolelist;
3190: if (ref($roles) eq 'ARRAY') {
3191: $rolelist = join(':',@{$roles});
3192: }
1.662 raeburn 3193: my %personnel = ();
1.841 albertel 3194:
3195: my %servers = &get_servers($dom,'library');
3196: foreach my $tryserver (keys(%servers)) {
3197: %{$personnel{$tryserver}}=();
3198: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3199: &escape($startdate).':'.
3200: &escape($enddate).':'.
3201: &escape($rolelist), $tryserver))) {
3202: my ($key,$value) = split(/\=/,$line,2);
3203: if (($key) && ($value)) {
3204: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3205: }
3206: }
1.662 raeburn 3207: }
3208: return %personnel;
3209: }
1.658 raeburn 3210:
1.149 www 3211: # ----------------------------------------------------------- Check out an item
3212:
1.504 albertel 3213: sub get_first_access {
3214: my ($type,$argsymb)=@_;
1.790 albertel 3215: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3216: if ($argsymb) { $symb=$argsymb; }
3217: my ($map,$id,$res)=&decode_symb($symb);
1.926 albertel 3218: if ($type eq 'course') {
3219: $res='course';
3220: } elsif ($type eq 'map') {
1.588 albertel 3221: $res=&symbread($map);
3222: } else {
3223: $res=$symb;
3224: }
3225: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3226: return $times{"$courseid\0$res"};
1.504 albertel 3227: }
3228:
3229: sub set_first_access {
3230: my ($type)=@_;
1.790 albertel 3231: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3232: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 3233: if ($type eq 'course') {
3234: $res='course';
3235: } elsif ($type eq 'map') {
1.588 albertel 3236: $res=&symbread($map);
3237: } else {
3238: $res=$symb;
3239: }
3240: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 3241: if (!$firstaccess) {
1.588 albertel 3242: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 3243: }
3244: return 'already_set';
1.504 albertel 3245: }
3246:
1.149 www 3247: sub checkout {
3248: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3249: my $now=time;
3250: my $lonhost=$perlvar{'lonHostID'};
3251: my $infostr=&escape(
1.234 www 3252: 'CHECKOUTTOKEN&'.
1.149 www 3253: $tuname.'&'.
3254: $tudom.'&'.
3255: $tcrsid.'&'.
3256: $symb.'&'.
3257: $now.'&'.$ENV{'REMOTE_ADDR'});
3258: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 3259: if ($token=~/^error\:/) {
1.672 albertel 3260: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3261: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3262: "</font>");
3263: return '';
3264: }
3265:
1.149 www 3266: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3267: $token=~tr/a-z/A-Z/;
3268:
1.153 www 3269: my %infohash=('resource.0.outtoken' => $token,
3270: 'resource.0.checkouttime' => $now,
3271: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 3272:
3273: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3274: return '';
1.151 www 3275: } else {
1.672 albertel 3276: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3277: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3278: "</font>");
1.149 www 3279: }
3280:
3281: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3282: &escape('Checkout '.$infostr.' - '.
3283: $token)) ne 'ok') {
3284: return '';
1.151 www 3285: } else {
1.672 albertel 3286: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3287: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3288: "</font>");
1.149 www 3289: }
1.151 www 3290: return $token;
1.149 www 3291: }
3292:
3293: # ------------------------------------------------------------ Check in an item
3294:
3295: sub checkin {
3296: my $token=shift;
1.150 www 3297: my $now=time;
3298: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3299: $lonhost=~tr/A-Z/a-z/;
1.838 albertel 3300: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150 www 3301: $dtoken=~s/\W/\_/g;
1.234 www 3302: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 3303: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3304:
1.154 www 3305: unless (($tuname) && ($tudom)) {
3306: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3307: return '';
3308: }
3309:
3310: unless (&allowed('mgr',$tcrsid)) {
3311: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 3312: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 3313: return '';
3314: }
3315:
1.153 www 3316: my %infohash=('resource.0.intoken' => $token,
3317: 'resource.0.checkintime' => $now,
3318: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 3319:
3320: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3321: return '';
3322: }
3323:
3324: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3325: &escape('Checkin - '.$token)) ne 'ok') {
3326: return '';
3327: }
3328:
3329: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 3330: }
3331:
3332: # --------------------------------------------- Set Expire Date for Spreadsheet
3333:
3334: sub expirespread {
3335: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 3336: my $cid=$env{'request.course.id'};
1.110 www 3337: if ($cid) {
3338: my $now=time;
3339: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 3340: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3341: $env{'course.'.$cid.'.num'}.
1.110 www 3342: ':nohist_expirationdates:'.
3343: &escape($key).'='.$now,
1.620 albertel 3344: $env{'course.'.$cid.'.home'})
1.110 www 3345: }
3346: return 'ok';
1.14 www 3347: }
3348:
1.109 www 3349: # ----------------------------------------------------- Devalidate Spreadsheets
3350:
3351: sub devalidate {
1.325 www 3352: my ($symb,$uname,$udom)=@_;
1.620 albertel 3353: my $cid=$env{'request.course.id'};
1.109 www 3354: if ($cid) {
1.391 matthew 3355: # delete the stored spreadsheets for
3356: # - the student level sheet of this user in course's homespace
3357: # - the assessment level sheet for this resource
3358: # for this user in user's homespace
1.553 albertel 3359: # - current conditional state info
1.325 www 3360: my $key=$uname.':'.$udom.':';
1.109 www 3361: my $status=
1.299 matthew 3362: &del('nohist_calculatedsheets',
1.391 matthew 3363: [$key.'studentcalc:'],
1.620 albertel 3364: $env{'course.'.$cid.'.domain'},
3365: $env{'course.'.$cid.'.num'})
1.133 albertel 3366: .' '.
3367: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 3368: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 3369: unless ($status eq 'ok ok') {
3370: &logthis('Could not devalidate spreadsheet '.
1.325 www 3371: $uname.' at '.$udom.' for '.
1.109 www 3372: $symb.': '.$status);
1.133 albertel 3373: }
1.553 albertel 3374: &delenv('user.state.'.$cid);
1.109 www 3375: }
3376: }
3377:
1.265 albertel 3378: sub get_scalar {
3379: my ($string,$end) = @_;
3380: my $value;
3381: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3382: $value = $1;
3383: } elsif ($$string =~ s/^([^&]*?)&//) {
3384: $value = $1;
3385: }
3386: return &unescape($value);
3387: }
3388:
3389: sub array2str {
3390: my (@array) = @_;
3391: my $result=&arrayref2str(\@array);
3392: $result=~s/^__ARRAY_REF__//;
3393: $result=~s/__END_ARRAY_REF__$//;
3394: return $result;
3395: }
3396:
1.204 albertel 3397: sub arrayref2str {
3398: my ($arrayref) = @_;
1.265 albertel 3399: my $result='__ARRAY_REF__';
1.204 albertel 3400: foreach my $elem (@$arrayref) {
1.265 albertel 3401: if(ref($elem) eq 'ARRAY') {
3402: $result.=&arrayref2str($elem).'&';
3403: } elsif(ref($elem) eq 'HASH') {
3404: $result.=&hashref2str($elem).'&';
3405: } elsif(ref($elem)) {
3406: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 3407: } else {
3408: $result.=&escape($elem).'&';
3409: }
3410: }
3411: $result=~s/\&$//;
1.265 albertel 3412: $result .= '__END_ARRAY_REF__';
1.204 albertel 3413: return $result;
3414: }
3415:
1.168 albertel 3416: sub hash2str {
1.204 albertel 3417: my (%hash) = @_;
3418: my $result=&hashref2str(\%hash);
1.265 albertel 3419: $result=~s/^__HASH_REF__//;
3420: $result=~s/__END_HASH_REF__$//;
1.204 albertel 3421: return $result;
3422: }
3423:
3424: sub hashref2str {
3425: my ($hashref)=@_;
1.265 albertel 3426: my $result='__HASH_REF__';
1.800 albertel 3427: foreach my $key (sort(keys(%$hashref))) {
3428: if (ref($key) eq 'ARRAY') {
3429: $result.=&arrayref2str($key).'=';
3430: } elsif (ref($key) eq 'HASH') {
3431: $result.=&hashref2str($key).'=';
3432: } elsif (ref($key)) {
1.265 albertel 3433: $result.='=';
1.800 albertel 3434: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 3435: } else {
1.800 albertel 3436: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 3437: }
3438:
1.800 albertel 3439: if(ref($hashref->{$key}) eq 'ARRAY') {
3440: $result.=&arrayref2str($hashref->{$key}).'&';
3441: } elsif(ref($hashref->{$key}) eq 'HASH') {
3442: $result.=&hashref2str($hashref->{$key}).'&';
3443: } elsif(ref($hashref->{$key})) {
1.265 albertel 3444: $result.='&';
1.800 albertel 3445: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 3446: } else {
1.800 albertel 3447: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 3448: }
3449: }
1.168 albertel 3450: $result=~s/\&$//;
1.265 albertel 3451: $result .= '__END_HASH_REF__';
1.168 albertel 3452: return $result;
3453: }
3454:
3455: sub str2hash {
1.265 albertel 3456: my ($string)=@_;
3457: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3458: return %$hash;
3459: }
3460:
3461: sub str2hashref {
1.168 albertel 3462: my ($string) = @_;
1.265 albertel 3463:
3464: my %hash;
3465:
3466: if($string !~ /^__HASH_REF__/) {
3467: if (! ($string eq '' || !defined($string))) {
3468: $hash{'error'}='Not hash reference';
3469: }
3470: return (\%hash, $string);
3471: }
3472:
3473: $string =~ s/^__HASH_REF__//;
3474:
3475: while($string !~ /^__END_HASH_REF__/) {
3476: #key
3477: my $key='';
3478: if($string =~ /^__HASH_REF__/) {
3479: ($key, $string)=&str2hashref($string);
3480: if(defined($key->{'error'})) {
3481: $hash{'error'}='Bad data';
3482: return (\%hash, $string);
3483: }
3484: } elsif($string =~ /^__ARRAY_REF__/) {
3485: ($key, $string)=&str2arrayref($string);
3486: if($key->[0] eq 'Array reference error') {
3487: $hash{'error'}='Bad data';
3488: return (\%hash, $string);
3489: }
3490: } else {
3491: $string =~ s/^(.*?)=//;
1.267 albertel 3492: $key=&unescape($1);
1.265 albertel 3493: }
3494: $string =~ s/^=//;
3495:
3496: #value
3497: my $value='';
3498: if($string =~ /^__HASH_REF__/) {
3499: ($value, $string)=&str2hashref($string);
3500: if(defined($value->{'error'})) {
3501: $hash{'error'}='Bad data';
3502: return (\%hash, $string);
3503: }
3504: } elsif($string =~ /^__ARRAY_REF__/) {
3505: ($value, $string)=&str2arrayref($string);
3506: if($value->[0] eq 'Array reference error') {
3507: $hash{'error'}='Bad data';
3508: return (\%hash, $string);
3509: }
3510: } else {
3511: $value=&get_scalar(\$string,'__END_HASH_REF__');
3512: }
3513: $string =~ s/^&//;
3514:
3515: $hash{$key}=$value;
1.204 albertel 3516: }
1.265 albertel 3517:
3518: $string =~ s/^__END_HASH_REF__//;
3519:
3520: return (\%hash, $string);
1.204 albertel 3521: }
3522:
3523: sub str2array {
1.265 albertel 3524: my ($string)=@_;
3525: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3526: return @$array;
3527: }
3528:
3529: sub str2arrayref {
1.204 albertel 3530: my ($string) = @_;
1.265 albertel 3531: my @array;
3532:
3533: if($string !~ /^__ARRAY_REF__/) {
3534: if (! ($string eq '' || !defined($string))) {
3535: $array[0]='Array reference error';
3536: }
3537: return (\@array, $string);
3538: }
3539:
3540: $string =~ s/^__ARRAY_REF__//;
3541:
3542: while($string !~ /^__END_ARRAY_REF__/) {
3543: my $value='';
3544: if($string =~ /^__HASH_REF__/) {
3545: ($value, $string)=&str2hashref($string);
3546: if(defined($value->{'error'})) {
3547: $array[0] ='Array reference error';
3548: return (\@array, $string);
3549: }
3550: } elsif($string =~ /^__ARRAY_REF__/) {
3551: ($value, $string)=&str2arrayref($string);
3552: if($value->[0] eq 'Array reference error') {
3553: $array[0] ='Array reference error';
3554: return (\@array, $string);
3555: }
3556: } else {
3557: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3558: }
3559: $string =~ s/^&//;
3560:
3561: push(@array, $value);
1.191 harris41 3562: }
1.265 albertel 3563:
3564: $string =~ s/^__END_ARRAY_REF__//;
3565:
3566: return (\@array, $string);
1.168 albertel 3567: }
3568:
1.167 albertel 3569: # -------------------------------------------------------------------Temp Store
3570:
1.168 albertel 3571: sub tmpreset {
3572: my ($symb,$namespace,$domain,$stuname) = @_;
3573: if (!$symb) {
3574: $symb=&symbread();
1.620 albertel 3575: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3576: }
3577: $symb=escape($symb);
3578:
1.620 albertel 3579: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3580: $namespace=~s/\//\_/g;
3581: $namespace=~s/\W//g;
3582:
1.620 albertel 3583: if (!$domain) { $domain=$env{'user.domain'}; }
3584: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3585: if ($domain eq 'public' && $stuname eq 'public') {
3586: $stuname=$ENV{'REMOTE_ADDR'};
3587: }
1.168 albertel 3588: my $path=$perlvar{'lonDaemons'}.'/tmp';
3589: my %hash;
3590: if (tie(%hash,'GDBM_File',
3591: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3592: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 3593: foreach my $key (keys(%hash)) {
1.180 albertel 3594: if ($key=~ /:$symb/) {
1.168 albertel 3595: delete($hash{$key});
3596: }
3597: }
3598: }
3599: }
3600:
1.167 albertel 3601: sub tmpstore {
1.168 albertel 3602: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3603:
3604: if (!$symb) {
3605: $symb=&symbread();
1.620 albertel 3606: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3607: }
3608: $symb=escape($symb);
3609:
3610: if (!$namespace) {
3611: # I don't think we would ever want to store this for a course.
3612: # it seems this will only be used if we don't have a course.
1.620 albertel 3613: #$namespace=$env{'request.course.id'};
1.168 albertel 3614: #if (!$namespace) {
1.620 albertel 3615: $namespace=$env{'request.state'};
1.168 albertel 3616: #}
3617: }
3618: $namespace=~s/\//\_/g;
3619: $namespace=~s/\W//g;
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 $now=time;
3626: my %hash;
3627: my $path=$perlvar{'lonDaemons'}.'/tmp';
3628: if (tie(%hash,'GDBM_File',
3629: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3630: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3631: $hash{"version:$symb"}++;
3632: my $version=$hash{"version:$symb"};
3633: my $allkeys='';
3634: foreach my $key (keys(%$storehash)) {
3635: $allkeys.=$key.':';
1.591 albertel 3636: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3637: }
3638: $hash{"$version:$symb:timestamp"}=$now;
3639: $allkeys.='timestamp';
3640: $hash{"$version:keys:$symb"}=$allkeys;
3641: if (untie(%hash)) {
3642: return 'ok';
3643: } else {
3644: return "error:$!";
3645: }
3646: } else {
3647: return "error:$!";
3648: }
3649: }
1.167 albertel 3650:
1.168 albertel 3651: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3652:
1.168 albertel 3653: sub tmprestore {
3654: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3655:
1.168 albertel 3656: if (!$symb) {
3657: $symb=&symbread();
1.620 albertel 3658: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3659: }
3660: $symb=escape($symb);
3661:
1.620 albertel 3662: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3663:
1.620 albertel 3664: if (!$domain) { $domain=$env{'user.domain'}; }
3665: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3666: if ($domain eq 'public' && $stuname eq 'public') {
3667: $stuname=$ENV{'REMOTE_ADDR'};
3668: }
1.168 albertel 3669: my %returnhash;
3670: $namespace=~s/\//\_/g;
3671: $namespace=~s/\W//g;
3672: my %hash;
3673: my $path=$perlvar{'lonDaemons'}.'/tmp';
3674: if (tie(%hash,'GDBM_File',
3675: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3676: &GDBM_READER(),0640)) {
1.168 albertel 3677: my $version=$hash{"version:$symb"};
3678: $returnhash{'version'}=$version;
3679: my $scope;
3680: for ($scope=1;$scope<=$version;$scope++) {
3681: my $vkeys=$hash{"$scope:keys:$symb"};
3682: my @keys=split(/:/,$vkeys);
3683: my $key;
3684: $returnhash{"$scope:keys"}=$vkeys;
3685: foreach $key (@keys) {
1.591 albertel 3686: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3687: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3688: }
3689: }
1.168 albertel 3690: if (!(untie(%hash))) {
3691: return "error:$!";
3692: }
3693: } else {
3694: return "error:$!";
3695: }
3696: return %returnhash;
1.167 albertel 3697: }
3698:
1.9 www 3699: # ----------------------------------------------------------------------- Store
3700:
3701: sub store {
1.124 www 3702: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3703: my $home='';
3704:
1.168 albertel 3705: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3706:
1.213 www 3707: $symb=&symbclean($symb);
1.122 albertel 3708: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3709:
1.620 albertel 3710: if (!$domain) { $domain=$env{'user.domain'}; }
3711: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3712:
3713: &devalidate($symb,$stuname,$domain);
1.109 www 3714:
3715: $symb=escape($symb);
1.187 www 3716: if (!$namespace) {
1.620 albertel 3717: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3718: return '';
3719: }
3720: }
1.620 albertel 3721: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3722:
3723: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3724: $$storehash{'host'}=$perlvar{'lonHostID'};
3725:
1.12 www 3726: my $namevalue='';
1.800 albertel 3727: foreach my $key (keys(%$storehash)) {
3728: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3729: }
1.12 www 3730: $namevalue=~s/\&$//;
1.187 www 3731: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3732: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3733: }
3734:
1.47 www 3735: # -------------------------------------------------------------- Critical Store
3736:
3737: sub cstore {
1.124 www 3738: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3739: my $home='';
3740:
1.168 albertel 3741: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3742:
1.213 www 3743: $symb=&symbclean($symb);
1.122 albertel 3744: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3745:
1.620 albertel 3746: if (!$domain) { $domain=$env{'user.domain'}; }
3747: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3748:
3749: &devalidate($symb,$stuname,$domain);
1.109 www 3750:
3751: $symb=escape($symb);
1.187 www 3752: if (!$namespace) {
1.620 albertel 3753: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3754: return '';
3755: }
3756: }
1.620 albertel 3757: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3758:
3759: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3760: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3761:
1.47 www 3762: my $namevalue='';
1.800 albertel 3763: foreach my $key (keys(%$storehash)) {
3764: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3765: }
1.47 www 3766: $namevalue=~s/\&$//;
1.187 www 3767: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3768: return critical
3769: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3770: }
3771:
1.9 www 3772: # --------------------------------------------------------------------- Restore
3773:
3774: sub restore {
1.124 www 3775: my ($symb,$namespace,$domain,$stuname) = @_;
3776: my $home='';
3777:
1.168 albertel 3778: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3779:
1.122 albertel 3780: if (!$symb) {
3781: unless ($symb=escape(&symbread())) { return ''; }
3782: } else {
1.213 www 3783: $symb=&escape(&symbclean($symb));
1.122 albertel 3784: }
1.188 www 3785: if (!$namespace) {
1.620 albertel 3786: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3787: return '';
3788: }
3789: }
1.620 albertel 3790: if (!$domain) { $domain=$env{'user.domain'}; }
3791: if (!$stuname) { $stuname=$env{'user.name'}; }
3792: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3793: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3794:
1.12 www 3795: my %returnhash=();
1.800 albertel 3796: foreach my $line (split(/\&/,$answer)) {
3797: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3798: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3799: }
1.75 www 3800: my $version;
3801: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3802: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3803: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3804: }
1.75 www 3805: }
1.13 www 3806: return %returnhash;
1.34 www 3807: }
3808:
3809: # ---------------------------------------------------------- Course Description
3810:
3811: sub coursedescription {
1.731 albertel 3812: my ($courseid,$args)=@_;
1.34 www 3813: $courseid=~s/^\///;
1.49 www 3814: $courseid=~s/\_/\//g;
1.34 www 3815: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3816: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3817: my $normalid=$cdomain.'_'.$cnum;
3818: # need to always cache even if we get errors otherwise we keep
3819: # trying and trying and trying to get the course description.
3820: my %envhash=();
3821: my %returnhash=();
1.731 albertel 3822:
3823: my $expiretime=600;
3824: if ($env{'request.course.id'} eq $normalid) {
3825: $expiretime=120;
3826: }
3827:
3828: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3829: if (!$args->{'freshen_cache'}
3830: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3831: foreach my $key (keys(%env)) {
3832: next if ($key !~ /^\Q$prefix\E(.*)/);
3833: my ($setting) = $1;
3834: $returnhash{$setting} = $env{$key};
3835: }
3836: return %returnhash;
3837: }
3838:
3839: # get the data agin
3840: if (!$args->{'one_time'}) {
3841: $envhash{'course.'.$normalid.'.last_cache'}=time;
3842: }
1.811 albertel 3843:
1.34 www 3844: if ($chome ne 'no_host') {
1.302 albertel 3845: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3846: if (!exists($returnhash{'con_lost'})) {
3847: $returnhash{'home'}= $chome;
3848: $returnhash{'domain'} = $cdomain;
3849: $returnhash{'num'} = $cnum;
1.741 raeburn 3850: if (!defined($returnhash{'type'})) {
3851: $returnhash{'type'} = 'Course';
3852: }
1.130 albertel 3853: while (my ($name,$value) = each %returnhash) {
1.53 www 3854: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3855: }
1.270 www 3856: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3857: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3858: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3859: $envhash{'course.'.$normalid.'.home'}=$chome;
3860: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3861: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3862: }
3863: }
1.731 albertel 3864: if (!$args->{'one_time'}) {
1.949 raeburn 3865: &appenv(\%envhash);
1.731 albertel 3866: }
1.302 albertel 3867: return %returnhash;
1.461 www 3868: }
3869:
3870: # -------------------------------------------------See if a user is privileged
3871:
3872: sub privileged {
3873: my ($username,$domain)=@_;
3874: my $rolesdump=&reply("dump:$domain:$username:roles",
3875: &homeserver($username,$domain));
1.1033 raeburn 3876: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3877: ($rolesdump =~ /^error:/)) {
3878: return 0;
3879: }
1.461 www 3880: my $now=time;
3881: if ($rolesdump ne '') {
1.800 albertel 3882: foreach my $entry (split(/&/,$rolesdump)) {
3883: if ($entry!~/^rolesdef_/) {
3884: my ($area,$role)=split(/=/,$entry);
1.461 www 3885: $area=~s/\_\w\w$//;
3886: my ($trole,$tend,$tstart)=split(/_/,$role);
3887: if (($trole eq 'dc') || ($trole eq 'su')) {
3888: my $active=1;
3889: if ($tend) {
3890: if ($tend<$now) { $active=0; }
3891: }
3892: if ($tstart) {
3893: if ($tstart>$now) { $active=0; }
3894: }
3895: if ($active) { return 1; }
3896: }
3897: }
3898: }
3899: }
3900: return 0;
1.9 www 3901: }
1.1 albertel 3902:
1.103 harris41 3903: # -------------------------------------------------------- Get user privileges
1.11 www 3904:
3905: sub rolesinit {
3906: my ($domain,$username,$authhost)=@_;
1.1034 raeburn 3907: my $now=time;
3908: my %userroles = ('user.login.time' => $now);
1.11 www 3909: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.1033 raeburn 3910: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3911: ($rolesdump =~ /^error:/)) {
3912: return \%userroles;
3913: }
1.11 www 3914: my %allroles=();
1.678 raeburn 3915: my %allgroups=();
3916: my $group_privs;
1.11 www 3917:
3918: if ($rolesdump ne '') {
1.800 albertel 3919: foreach my $entry (split(/&/,$rolesdump)) {
3920: if ($entry!~/^rolesdef_/) {
3921: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3922: $area=~s/\_\w\w$//;
1.678 raeburn 3923: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3924: if ($role=~/^cr/) {
1.807 albertel 3925: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3926: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3927: ($tend,$tstart)=split('_',$trest);
3928: } else {
3929: $trole=$role;
3930: }
1.678 raeburn 3931: } elsif ($role =~ m|^gr/|) {
3932: ($trole,$tend,$tstart) = split(/_/,$role);
3933: ($trole,$group_privs) = split(/\//,$trole);
3934: $group_privs = &unescape($group_privs);
1.587 albertel 3935: } else {
3936: ($trole,$tend,$tstart)=split(/_/,$role);
3937: }
1.743 albertel 3938: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3939: $username);
3940: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3941: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3942: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3943: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3944: my $spec=$trole.'.'.$area;
3945: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3946: if ($trole =~ /^cr\//) {
1.567 raeburn 3947: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3948: } elsif ($trole eq 'gr') {
3949: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3950: } else {
1.567 raeburn 3951: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3952: }
1.12 www 3953: }
1.662 raeburn 3954: }
1.191 harris41 3955: }
1.743 albertel 3956: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3957: $userroles{'user.adv'} = $adv;
3958: $userroles{'user.author'} = $author;
1.620 albertel 3959: $env{'user.adv'}=$adv;
1.11 www 3960: }
1.743 albertel 3961: return \%userroles;
1.11 www 3962: }
3963:
1.567 raeburn 3964: sub set_arearole {
3965: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3966: # log the associated role with the area
3967: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3968: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3969: }
3970:
3971: sub custom_roleprivs {
3972: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3973: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3974: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3975: if (&hostname($homsvr) ne '') {
1.567 raeburn 3976: my ($rdummy,$roledef)=
3977: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3978: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3979: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3980: if (defined($syspriv)) {
1.1043 raeburn 3981: if ($trest =~ /^$match_community$/) {
3982: $syspriv =~ s/bre\&S//;
3983: }
1.567 raeburn 3984: $$allroles{'cm./'}.=':'.$syspriv;
3985: $$allroles{$spec.'./'}.=':'.$syspriv;
3986: }
3987: if ($tdomain ne '') {
3988: if (defined($dompriv)) {
3989: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3990: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3991: }
3992: if (($trest ne '') && (defined($coursepriv))) {
3993: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3994: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3995: }
3996: }
3997: }
3998: }
3999: }
4000:
1.678 raeburn 4001: sub group_roleprivs {
4002: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4003: my $access = 1;
4004: my $now = time;
4005: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4006: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4007: if ($access) {
1.811 albertel 4008: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 4009: $$allgroups{$course}{$group} .=':'.$group_privs;
4010: }
4011: }
1.567 raeburn 4012:
4013: sub standard_roleprivs {
4014: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4015: if (defined($pr{$trole.':s'})) {
4016: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4017: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4018: }
4019: if ($tdomain ne '') {
4020: if (defined($pr{$trole.':d'})) {
4021: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4022: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4023: }
4024: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4025: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4026: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4027: }
4028: }
4029: }
4030:
4031: sub set_userprivs {
1.1056.2.3 raeburn 4032: my ($userroles,$allroles,$allgroups,$groups_roles) = @_;
1.567 raeburn 4033: my $author=0;
4034: my $adv=0;
1.678 raeburn 4035: my %grouproles = ();
4036: if (keys(%{$allgroups}) > 0) {
1.1056.2.3 raeburn 4037: my @groupkeys;
1.1000 raeburn 4038: foreach my $role (keys(%{$allroles})) {
1.1056.2.3 raeburn 4039: push(@groupkeys,$role);
4040: }
4041: if (ref($groups_roles) eq 'HASH') {
4042: foreach my $key (keys(%{$groups_roles})) {
4043: unless (grep(/^\Q$key\E$/,@groupkeys)) {
4044: push(@groupkeys,$key);
4045: }
4046: }
4047: }
4048: if (@groupkeys > 0) {
4049: foreach my $role (@groupkeys) {
4050: my ($trole,$area,$sec,$extendedarea);
4051: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
4052: $trole = $1;
4053: $area = $2;
4054: $sec = $3;
4055: $extendedarea = $area.$sec;
4056: if (exists($$allgroups{$area})) {
4057: foreach my $group (keys(%{$$allgroups{$area}})) {
4058: my $spec = $trole.'.'.$extendedarea;
4059: $grouproles{$spec.'.'.$area.'/'.$group} =
4060: $$allgroups{$area}{$group};
4061: }
1.678 raeburn 4062: }
4063: }
4064: }
4065: }
4066: }
1.800 albertel 4067: foreach my $group (keys(%grouproles)) {
4068: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 4069: }
1.800 albertel 4070: foreach my $role (keys(%{$allroles})) {
4071: my %thesepriv;
1.941 raeburn 4072: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 4073: foreach my $item (split(/:/,$$allroles{$role})) {
4074: if ($item ne '') {
4075: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 4076: if ($restrictions eq '') {
4077: $thesepriv{$privilege}='F';
4078: } elsif ($thesepriv{$privilege} ne 'F') {
4079: $thesepriv{$privilege}.=$restrictions;
4080: }
4081: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4082: }
4083: }
4084: my $thesestr='';
1.800 albertel 4085: foreach my $priv (keys(%thesepriv)) {
4086: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4087: }
4088: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 4089: }
4090: return ($author,$adv);
4091: }
4092:
1.994 raeburn 4093: sub role_status {
1.1002 raeburn 4094: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 4095: my @pwhere = ();
4096: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4097: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4098: unless (!defined($$role) || $$role eq '') {
4099: $$where=join('.',@pwhere);
4100: $$trolecode=$$role.'.'.$$where;
4101: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4102: $$tstatus='is';
4103: if ($$tstart && $$tstart>$then) {
4104: $$tstatus='future';
1.1034 raeburn 4105: if ($$tstart<$now) {
4106: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 4107: if (($$where ne '') && ($$role ne '')) {
1.1056.2.3 raeburn 4108: my (%allroles,%allgroups,$group_privs,
4109: %groups_roles,@rolecodes);
1.1002 raeburn 4110: my %userroles = (
4111: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4112: );
1.1056.2.3 raeburn 4113: @rolecodes = ('cm');
1.1002 raeburn 4114: my $spec=$$role.'.'.$$where;
4115: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4116: if ($$role =~ /^cr\//) {
4117: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
1.1056.2.3 raeburn 4118: push(@rolecodes,'cr');
1.1002 raeburn 4119: } elsif ($$role eq 'gr') {
1.1056.2.3 raeburn 4120: push(@rolecodes,$$role);
1.1002 raeburn 4121: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4122: $env{'user.name'});
1.1056.2.3 raeburn 4123: my ($trole) = split('_',$rolehash{$$where.'_'.$$role},2);
1.1002 raeburn 4124: (undef,my $group_privs) = split(/\//,$trole);
4125: $group_privs = &unescape($group_privs);
4126: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
1.1056.2.3 raeburn 4127: my %course_roles = &get_my_roles($env{'user.name'},$env{'user.domain'},'userroles',['active'],['cc','co','in','ta','ep','ad','st','cr'],[$tdomain],1);
4128: if (keys(%course_roles) > 0) {
4129: my ($tnum) = ($trest =~ /^($match_courseid)/);
4130: if ($tdomain ne '' && $tnum ne '') {
4131: foreach my $key (keys(%course_roles)) {
4132: if ($key =~ /^\Q$tnum\E:\Q$tdomain\E:([^:]+):?([^:]*)/) {
4133: my $crsrole = $1;
4134: my $crssec = $2;
4135: if ($crsrole =~ /^cr/) {
4136: unless (grep(/^cr$/,@rolecodes)) {
4137: push(@rolecodes,'cr');
4138: }
4139: } else {
4140: unless(grep(/^\Q$crsrole\E$/,@rolecodes)) {
4141: push(@rolecodes,$crsrole);
4142: }
4143: }
4144: my $rolekey = $crsrole.'./'.$tdomain.'/'.$tnum;
4145: if ($crssec ne '') {
4146: $rolekey .= '/'.$crssec;
4147: }
4148: $rolekey .= './';
4149: $groups_roles{$rolekey} = \@rolecodes;
4150: }
4151: }
4152: }
4153: }
1.1002 raeburn 4154: } else {
1.1056.2.3 raeburn 4155: push(@rolecodes,$$role);
1.1002 raeburn 4156: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4157: }
1.1056.2.3 raeburn 4158: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups,\%groups_roles);
4159: &appenv(\%userroles,\@rolecodes);
1.1002 raeburn 4160: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4161: }
4162: }
1.1034 raeburn 4163: $$tstatus = 'is';
1.1002 raeburn 4164: }
1.994 raeburn 4165: }
4166: if ($$tend) {
4167: if ($$tend<$then) {
4168: $$tstatus='expired';
4169: } elsif ($$tend<$now) {
4170: $$tstatus='will_not';
4171: }
4172: }
4173: }
4174: }
4175: }
4176:
4177: sub check_adhoc_privs {
1.1002 raeburn 4178: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994 raeburn 4179: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4180: if ($env{$cckey}) {
4181: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002 raeburn 4182: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 4183: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4184: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4185: }
4186: } else {
4187: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4188: }
4189: }
4190:
4191: sub set_adhoc_privileges {
4192: # role can be cc or ca
4193: my ($dcdom,$pickedcourse,$role) = @_;
4194: my $area = '/'.$dcdom.'/'.$pickedcourse;
4195: my $spec = $role.'.'.$area;
4196: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4197: $env{'user.name'});
4198: my %ccrole = ();
4199: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4200: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4201: &appenv(\%userroles,[$role,'cm']);
4202: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4203: &appenv( {'request.role' => $spec,
4204: 'request.role.domain' => $dcdom,
4205: 'request.course.sec' => ''
4206: }
4207: );
4208: my $tadv=0;
4209: if (&allowed('adv') eq 'F') { $tadv=1; }
4210: &appenv({'request.role.adv' => $tadv});
4211: }
4212:
1.12 www 4213: # --------------------------------------------------------------- get interface
4214:
4215: sub get {
1.131 albertel 4216: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4217: my $items='';
1.800 albertel 4218: foreach my $item (@$storearr) {
4219: $items.=&escape($item).'&';
1.191 harris41 4220: }
1.12 www 4221: $items=~s/\&$//;
1.620 albertel 4222: if (!$udomain) { $udomain=$env{'user.domain'}; }
4223: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 4224: my $uhome=&homeserver($uname,$udomain);
4225:
1.133 albertel 4226: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4227: my @pairs=split(/\&/,$rep);
1.273 albertel 4228: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4229: return @pairs;
4230: }
1.15 www 4231: my %returnhash=();
1.42 www 4232: my $i=0;
1.800 albertel 4233: foreach my $item (@$storearr) {
4234: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4235: $i++;
1.191 harris41 4236: }
1.15 www 4237: return %returnhash;
1.27 www 4238: }
4239:
4240: # --------------------------------------------------------------- del interface
4241:
4242: sub del {
1.133 albertel 4243: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 4244: my $items='';
1.800 albertel 4245: foreach my $item (@$storearr) {
4246: $items.=&escape($item).'&';
1.191 harris41 4247: }
1.984 neumanie 4248:
1.27 www 4249: $items=~s/\&$//;
1.620 albertel 4250: if (!$udomain) { $udomain=$env{'user.domain'}; }
4251: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4252: my $uhome=&homeserver($uname,$udomain);
4253: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4254: }
4255:
4256: # -------------------------------------------------------------- dump interface
4257:
4258: sub dump {
1.755 albertel 4259: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4260: if (!$udomain) { $udomain=$env{'user.domain'}; }
4261: if (!$uname) { $uname=$env{'user.name'}; }
4262: my $uhome=&homeserver($uname,$udomain);
4263: if ($regexp) {
4264: $regexp=&escape($regexp);
4265: } else {
4266: $regexp='.';
4267: }
4268: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4269: my @pairs=split(/\&/,$rep);
4270: my %returnhash=();
4271: foreach my $item (@pairs) {
4272: my ($key,$value)=split(/=/,$item,2);
4273: $key = &unescape($key);
4274: next if ($key =~ /^error: 2 /);
4275: $returnhash{$key}=&thaw_unescape($value);
4276: }
4277: return %returnhash;
1.407 www 4278: }
4279:
1.717 albertel 4280: # --------------------------------------------------------- dumpstore interface
4281:
4282: sub dumpstore {
4283: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 4284: if (!$udomain) { $udomain=$env{'user.domain'}; }
4285: if (!$uname) { $uname=$env{'user.name'}; }
4286: my $uhome=&homeserver($uname,$udomain);
4287: if ($regexp) {
4288: $regexp=&escape($regexp);
4289: } else {
4290: $regexp='.';
4291: }
4292: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4293: my @pairs=split(/\&/,$rep);
4294: my %returnhash=();
4295: foreach my $item (@pairs) {
4296: my ($key,$value)=split(/=/,$item,2);
4297: next if ($key =~ /^error: 2 /);
4298: $returnhash{$key}=&thaw_unescape($value);
4299: }
4300: return %returnhash;
1.717 albertel 4301: }
4302:
1.407 www 4303: # -------------------------------------------------------------- keys interface
4304:
4305: sub getkeys {
4306: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 4307: if (!$udomain) { $udomain=$env{'user.domain'}; }
4308: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 4309: my $uhome=&homeserver($uname,$udomain);
4310: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4311: my @keyarray=();
1.800 albertel 4312: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 4313: next if ($key =~ /^error: 2 /);
1.800 albertel 4314: push(@keyarray,&unescape($key));
1.407 www 4315: }
4316: return @keyarray;
1.318 matthew 4317: }
4318:
1.319 matthew 4319: # --------------------------------------------------------------- currentdump
4320: sub currentdump {
1.328 matthew 4321: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 4322: $courseid = $env{'request.course.id'} if (! defined($courseid));
4323: $sdom = $env{'user.domain'} if (! defined($sdom));
4324: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 4325: my $uhome = &homeserver($sname,$sdom);
4326: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 4327: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 4328: #
1.318 matthew 4329: my %returnhash=();
1.319 matthew 4330: #
4331: if ($rep eq "unknown_cmd") {
4332: # an old lond will not know currentdump
4333: # Do a dump and make it look like a currentdump
1.822 albertel 4334: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 4335: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4336: my %hash = @tmp;
4337: @tmp=();
1.424 matthew 4338: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 4339: } else {
4340: my @pairs=split(/\&/,$rep);
1.800 albertel 4341: foreach my $pair (@pairs) {
4342: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 4343: my ($symb,$param) = split(/:/,$key);
4344: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 4345: &thaw_unescape($value);
1.319 matthew 4346: }
1.191 harris41 4347: }
1.12 www 4348: return %returnhash;
1.424 matthew 4349: }
4350:
4351: sub convert_dump_to_currentdump{
4352: my %hash = %{shift()};
4353: my %returnhash;
4354: # Code ripped from lond, essentially. The only difference
4355: # here is the unescaping done by lonnet::dump(). Conceivably
4356: # we might run in to problems with parameter names =~ /^v\./
4357: while (my ($key,$value) = each(%hash)) {
4358: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 4359: $symb = &unescape($symb);
4360: $param = &unescape($param);
1.424 matthew 4361: next if ($v eq 'version' || $symb eq 'keys');
4362: next if (exists($returnhash{$symb}) &&
4363: exists($returnhash{$symb}->{$param}) &&
4364: $returnhash{$symb}->{'v.'.$param} > $v);
4365: $returnhash{$symb}->{$param}=$value;
4366: $returnhash{$symb}->{'v.'.$param}=$v;
4367: }
4368: #
4369: # Remove all of the keys in the hashes which keep track of
4370: # the version of the parameter.
4371: while (my ($symb,$param_hash) = each(%returnhash)) {
4372: # use a foreach because we are going to delete from the hash.
4373: foreach my $key (keys(%$param_hash)) {
4374: delete($param_hash->{$key}) if ($key =~ /^v\./);
4375: }
4376: }
4377: return \%returnhash;
1.12 www 4378: }
4379:
1.627 albertel 4380: # ------------------------------------------------------ critical inc interface
4381:
4382: sub cinc {
4383: return &inc(@_,'critical');
4384: }
4385:
1.449 matthew 4386: # --------------------------------------------------------------- inc interface
4387:
4388: sub inc {
1.627 albertel 4389: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 4390: if (!$udomain) { $udomain=$env{'user.domain'}; }
4391: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 4392: my $uhome=&homeserver($uname,$udomain);
4393: my $items='';
4394: if (! ref($store)) {
4395: # got a single value, so use that instead
4396: $items = &escape($store).'=&';
4397: } elsif (ref($store) eq 'SCALAR') {
4398: $items = &escape($$store).'=&';
4399: } elsif (ref($store) eq 'ARRAY') {
4400: $items = join('=&',map {&escape($_);} @{$store});
4401: } elsif (ref($store) eq 'HASH') {
4402: while (my($key,$value) = each(%{$store})) {
4403: $items.= &escape($key).'='.&escape($value).'&';
4404: }
4405: }
4406: $items=~s/\&$//;
1.627 albertel 4407: if ($critical) {
4408: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4409: } else {
4410: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4411: }
1.449 matthew 4412: }
4413:
1.12 www 4414: # --------------------------------------------------------------- put interface
4415:
4416: sub put {
1.134 albertel 4417: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4418: if (!$udomain) { $udomain=$env{'user.domain'}; }
4419: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4420: my $uhome=&homeserver($uname,$udomain);
1.12 www 4421: my $items='';
1.800 albertel 4422: foreach my $item (keys(%$storehash)) {
4423: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4424: }
1.12 www 4425: $items=~s/\&$//;
1.134 albertel 4426: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 4427: }
4428:
1.631 albertel 4429: # ------------------------------------------------------------ newput interface
4430:
4431: sub newput {
4432: my ($namespace,$storehash,$udomain,$uname)=@_;
4433: if (!$udomain) { $udomain=$env{'user.domain'}; }
4434: if (!$uname) { $uname=$env{'user.name'}; }
4435: my $uhome=&homeserver($uname,$udomain);
4436: my $items='';
4437: foreach my $key (keys(%$storehash)) {
4438: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4439: }
4440: $items=~s/\&$//;
4441: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4442: }
4443:
4444: # --------------------------------------------------------- putstore interface
4445:
1.524 raeburn 4446: sub putstore {
1.715 albertel 4447: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 4448: if (!$udomain) { $udomain=$env{'user.domain'}; }
4449: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 4450: my $uhome=&homeserver($uname,$udomain);
4451: my $items='';
1.715 albertel 4452: foreach my $key (keys(%$storehash)) {
4453: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 4454: }
1.715 albertel 4455: $items=~s/\&$//;
1.716 albertel 4456: my $esc_symb=&escape($symb);
4457: my $esc_v=&escape($version);
1.715 albertel 4458: my $reply =
1.716 albertel 4459: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 4460: $uhome);
4461: if ($reply eq 'unknown_cmd') {
1.716 albertel 4462: # gfall back to way things use to be done
1.715 albertel 4463: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4464: $uname);
1.524 raeburn 4465: }
1.715 albertel 4466: return $reply;
4467: }
4468:
4469: sub old_putstore {
1.716 albertel 4470: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4471: if (!$udomain) { $udomain=$env{'user.domain'}; }
4472: if (!$uname) { $uname=$env{'user.name'}; }
4473: my $uhome=&homeserver($uname,$udomain);
4474: my %newstorehash;
1.800 albertel 4475: foreach my $item (keys(%$storehash)) {
4476: my $key = $version.':'.&escape($symb).':'.$item;
4477: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 4478: }
4479: my $items='';
4480: my %allitems = ();
1.800 albertel 4481: foreach my $item (keys(%newstorehash)) {
4482: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 4483: my $key = $1.':keys:'.$2;
4484: $allitems{$key} .= $3.':';
4485: }
1.800 albertel 4486: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 4487: }
1.800 albertel 4488: foreach my $item (keys(%allitems)) {
4489: $allitems{$item} =~ s/\:$//;
4490: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 4491: }
4492: $items=~s/\&$//;
4493: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 4494: }
4495:
1.47 www 4496: # ------------------------------------------------------ critical put interface
4497:
4498: sub cput {
1.134 albertel 4499: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4500: if (!$udomain) { $udomain=$env{'user.domain'}; }
4501: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4502: my $uhome=&homeserver($uname,$udomain);
1.47 www 4503: my $items='';
1.800 albertel 4504: foreach my $item (keys(%$storehash)) {
4505: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4506: }
1.47 www 4507: $items=~s/\&$//;
1.134 albertel 4508: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4509: }
4510:
4511: # -------------------------------------------------------------- eget interface
4512:
4513: sub eget {
1.133 albertel 4514: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4515: my $items='';
1.800 albertel 4516: foreach my $item (@$storearr) {
4517: $items.=&escape($item).'&';
1.191 harris41 4518: }
1.12 www 4519: $items=~s/\&$//;
1.620 albertel 4520: if (!$udomain) { $udomain=$env{'user.domain'}; }
4521: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4522: my $uhome=&homeserver($uname,$udomain);
4523: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4524: my @pairs=split(/\&/,$rep);
4525: my %returnhash=();
1.42 www 4526: my $i=0;
1.800 albertel 4527: foreach my $item (@$storearr) {
4528: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4529: $i++;
1.191 harris41 4530: }
1.12 www 4531: return %returnhash;
4532: }
4533:
1.667 albertel 4534: # ------------------------------------------------------------ tmpput interface
4535: sub tmpput {
1.802 raeburn 4536: my ($storehash,$server,$context)=@_;
1.667 albertel 4537: my $items='';
1.800 albertel 4538: foreach my $item (keys(%$storehash)) {
4539: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 4540: }
4541: $items=~s/\&$//;
1.802 raeburn 4542: if (defined($context)) {
4543: $items .= ':'.&escape($context);
4544: }
1.667 albertel 4545: return &reply("tmpput:$items",$server);
4546: }
4547:
4548: # ------------------------------------------------------------ tmpget interface
4549: sub tmpget {
1.688 albertel 4550: my ($token,$server)=@_;
4551: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4552: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 4553: my %returnhash;
4554: foreach my $item (split(/\&/,$rep)) {
4555: my ($key,$value)=split(/=/,$item);
1.951 raeburn 4556: next if ($key =~ /^error: 2 /);
1.667 albertel 4557: $returnhash{&unescape($key)}=&thaw_unescape($value);
4558: }
4559: return %returnhash;
4560: }
4561:
1.688 albertel 4562: # ------------------------------------------------------------ tmpget interface
4563: sub tmpdel {
4564: my ($token,$server)=@_;
4565: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4566: return &reply("tmpdel:$token",$server);
4567: }
4568:
1.765 albertel 4569: # -------------------------------------------------- portfolio access checking
4570:
4571: sub portfolio_access {
1.766 albertel 4572: my ($requrl) = @_;
1.765 albertel 4573: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4574: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 4575: if ($result) {
4576: my %setters;
4577: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4578: my ($startblock,$endblock) =
4579: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4580: if ($startblock && $endblock) {
4581: return 'B';
4582: }
4583: } else {
4584: my ($startblock,$endblock) =
4585: &Apache::loncommon::blockcheck(\%setters,'port');
4586: if ($startblock && $endblock) {
4587: return 'B';
4588: }
4589: }
4590: }
1.765 albertel 4591: if ($result eq 'ok') {
1.766 albertel 4592: return 'F';
1.765 albertel 4593: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 4594: return 'A';
1.765 albertel 4595: }
1.766 albertel 4596: return '';
1.765 albertel 4597: }
4598:
4599: sub get_portfolio_access {
1.767 albertel 4600: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4601:
4602: if (!ref($access_hash)) {
4603: my $current_perms = &get_portfile_permissions($udom,$unum);
4604: my %access_controls = &get_access_controls($current_perms,$group,
4605: $file_name);
4606: $access_hash = $access_controls{$file_name};
4607: }
4608:
1.765 albertel 4609: my ($public,$guest,@domains,@users,@courses,@groups);
4610: my $now = time;
4611: if (ref($access_hash) eq 'HASH') {
4612: foreach my $key (keys(%{$access_hash})) {
4613: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4614: if ($start > $now) {
4615: next;
4616: }
4617: if ($end && $end<$now) {
4618: next;
4619: }
4620: if ($scope eq 'public') {
4621: $public = $key;
4622: last;
4623: } elsif ($scope eq 'guest') {
4624: $guest = $key;
4625: } elsif ($scope eq 'domains') {
4626: push(@domains,$key);
4627: } elsif ($scope eq 'users') {
4628: push(@users,$key);
4629: } elsif ($scope eq 'course') {
4630: push(@courses,$key);
4631: } elsif ($scope eq 'group') {
4632: push(@groups,$key);
4633: }
4634: }
4635: if ($public) {
4636: return 'ok';
4637: }
4638: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4639: if ($guest) {
4640: return $guest;
4641: }
4642: } else {
4643: if (@domains > 0) {
4644: foreach my $domkey (@domains) {
4645: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4646: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4647: return 'ok';
4648: }
4649: }
4650: }
4651: }
4652: if (@users > 0) {
4653: foreach my $userkey (@users) {
1.865 raeburn 4654: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4655: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4656: if (ref($item) eq 'HASH') {
4657: if (($item->{'uname'} eq $env{'user.name'}) &&
4658: ($item->{'udom'} eq $env{'user.domain'})) {
4659: return 'ok';
4660: }
4661: }
4662: }
4663: }
1.765 albertel 4664: }
4665: }
4666: my %roleshash;
4667: my @courses_and_groups = @courses;
4668: push(@courses_and_groups,@groups);
4669: if (@courses_and_groups > 0) {
4670: my (%allgroups,%allroles);
4671: my ($start,$end,$role,$sec,$group);
4672: foreach my $envkey (%env) {
1.1056.2.2 raeburn 4673: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4674: my $cid = $2.'_'.$3;
4675: if ($1 eq 'gr') {
4676: $group = $4;
4677: $allgroups{$cid}{$group} = $env{$envkey};
4678: } else {
4679: if ($4 eq '') {
4680: $sec = 'none';
4681: } else {
4682: $sec = $4;
4683: }
4684: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4685: }
1.811 albertel 4686: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4687: my $cid = $2.'_'.$3;
4688: if ($4 eq '') {
4689: $sec = 'none';
4690: } else {
4691: $sec = $4;
4692: }
4693: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4694: }
4695: }
4696: if (keys(%allroles) == 0) {
4697: return;
4698: }
4699: foreach my $key (@courses_and_groups) {
4700: my %content = %{$$access_hash{$key}};
4701: my $cnum = $content{'number'};
4702: my $cdom = $content{'domain'};
4703: my $cid = $cdom.'_'.$cnum;
4704: if (!exists($allroles{$cid})) {
4705: next;
4706: }
4707: foreach my $role_id (keys(%{$content{'roles'}})) {
4708: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4709: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4710: my @status = @{$content{'roles'}{$role_id}{'access'}};
4711: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4712: foreach my $role (keys(%{$allroles{$cid}})) {
4713: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4714: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4715: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4716: if (grep/^all$/,@sections) {
4717: return 'ok';
4718: } else {
4719: if (grep/^$sec$/,@sections) {
4720: return 'ok';
4721: }
4722: }
4723: }
4724: }
4725: if (keys(%{$allgroups{$cid}}) == 0) {
4726: if (grep/^none$/,@groups) {
4727: return 'ok';
4728: }
4729: } else {
4730: if (grep/^all$/,@groups) {
4731: return 'ok';
4732: }
4733: foreach my $group (keys(%{$allgroups{$cid}})) {
4734: if (grep/^$group$/,@groups) {
4735: return 'ok';
4736: }
4737: }
4738: }
4739: }
4740: }
4741: }
4742: }
4743: }
4744: if ($guest) {
4745: return $guest;
4746: }
4747: }
4748: }
4749: return;
4750: }
4751:
4752: sub course_group_datechecker {
4753: my ($dates,$now,$status) = @_;
4754: my ($start,$end) = split(/\./,$dates);
4755: if (!$start && !$end) {
4756: return 'ok';
4757: }
4758: if (grep/^active$/,@{$status}) {
4759: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4760: return 'ok';
4761: }
4762: }
4763: if (grep/^previous$/,@{$status}) {
4764: if ($end > $now ) {
4765: return 'ok';
4766: }
4767: }
4768: if (grep/^future$/,@{$status}) {
4769: if ($start > $now) {
4770: return 'ok';
4771: }
4772: }
4773: return;
4774: }
4775:
4776: sub parse_portfolio_url {
4777: my ($url) = @_;
4778:
4779: my ($type,$udom,$unum,$group,$file_name);
4780:
1.823 albertel 4781: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4782: $type = 1;
4783: $udom = $1;
4784: $unum = $2;
4785: $file_name = $3;
1.823 albertel 4786: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4787: $type = 2;
4788: $udom = $1;
4789: $unum = $2;
4790: $group = $3;
4791: $file_name = $3.'/'.$4;
4792: }
4793: if (wantarray) {
4794: return ($type,$udom,$unum,$file_name,$group);
4795: }
4796: return $type;
4797: }
4798:
4799: sub is_portfolio_url {
4800: my ($url) = @_;
4801: return scalar(&parse_portfolio_url($url));
4802: }
4803:
1.798 raeburn 4804: sub is_portfolio_file {
4805: my ($file) = @_;
1.820 raeburn 4806: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4807: return 1;
4808: }
4809: return;
4810: }
4811:
1.976 raeburn 4812: sub usertools_access {
1.985 raeburn 4813: my ($uname,$udom,$tool,$action,$context) = @_;
4814: my ($access,%tools);
4815: if ($context eq '') {
4816: $context = 'tools';
4817: }
4818: if ($context eq 'requestcourses') {
4819: %tools = (
4820: official => 1,
4821: unofficial => 1,
1.1006 raeburn 4822: community => 1,
1.985 raeburn 4823: );
4824: } else {
4825: %tools = (
4826: aboutme => 1,
4827: blog => 1,
4828: portfolio => 1,
4829: );
4830: }
1.976 raeburn 4831: return if (!defined($tools{$tool}));
4832:
4833: if ((!defined($udom)) || (!defined($uname))) {
4834: $udom = $env{'user.domain'};
4835: $uname = $env{'user.name'};
4836: }
4837:
1.978 raeburn 4838: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4839: if ($action ne 'reload') {
1.985 raeburn 4840: if ($context eq 'requestcourses') {
4841: return $env{'environment.canrequest.'.$tool};
4842: } else {
4843: return $env{'environment.availabletools.'.$tool};
4844: }
4845: }
1.976 raeburn 4846: }
4847:
4848: my ($toolstatus,$inststatus);
4849:
1.985 raeburn 4850: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4851: ($action ne 'reload')) {
4852: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 4853: $inststatus = $env{'environment.inststatus'};
4854: } else {
1.1025 raeburn 4855: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
1.985 raeburn 4856: $toolstatus = $userenv{$context.'.'.$tool};
1.976 raeburn 4857: $inststatus = $userenv{'inststatus'};
4858: }
4859:
4860: if ($toolstatus ne '') {
4861: if ($toolstatus) {
4862: $access = 1;
4863: } else {
4864: $access = 0;
4865: }
4866: return $access;
4867: }
4868:
4869: my $is_adv = &is_advanced_user($udom,$uname);
4870: my %domdef = &get_domain_defaults($udom);
4871: if (ref($domdef{$tool}) eq 'HASH') {
4872: if ($is_adv) {
4873: if ($domdef{$tool}{'_LC_adv'} ne '') {
4874: if ($domdef{$tool}{'_LC_adv'}) {
4875: $access = 1;
4876: } else {
4877: $access = 0;
4878: }
4879: return $access;
4880: }
4881: }
4882: if ($inststatus ne '') {
4883: my ($hasaccess,$hasnoaccess);
4884: foreach my $affiliation (split(/:/,$inststatus)) {
4885: if ($domdef{$tool}{$affiliation} ne '') {
4886: if ($domdef{$tool}{$affiliation}) {
4887: $hasaccess = 1;
4888: } else {
4889: $hasnoaccess = 1;
4890: }
4891: }
4892: }
4893: if ($hasaccess || $hasnoaccess) {
4894: if ($hasaccess) {
4895: $access = 1;
4896: } elsif ($hasnoaccess) {
4897: $access = 0;
4898: }
4899: return $access;
4900: }
4901: } else {
4902: if ($domdef{$tool}{'default'} ne '') {
4903: if ($domdef{$tool}{'default'}) {
4904: $access = 1;
4905: } elsif ($domdef{$tool}{'default'} == 0) {
4906: $access = 0;
4907: }
4908: return $access;
4909: }
4910: }
4911: } else {
1.985 raeburn 4912: if ($context eq 'tools') {
4913: $access = 1;
4914: } else {
4915: $access = 0;
4916: }
1.976 raeburn 4917: return $access;
4918: }
4919: }
4920:
1.1050 raeburn 4921: sub is_course_owner {
4922: my ($cdom,$cnum,$udom,$uname) = @_;
4923: if (($udom eq '') || ($uname eq '')) {
4924: $udom = $env{'user.domain'};
4925: $uname = $env{'user.name'};
4926: }
4927: unless (($udom eq '') || ($uname eq '')) {
4928: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4929: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4930: return 1;
4931: } else {
4932: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4933: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4934: return 1;
4935: }
4936: }
4937: }
4938: }
4939: return;
4940: }
4941:
1.976 raeburn 4942: sub is_advanced_user {
4943: my ($udom,$uname) = @_;
4944: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4945: my %allroles;
4946: my $is_adv;
4947: foreach my $role (keys(%roleshash)) {
4948: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4949: my $area = '/'.$tdomain.'/'.$trest;
4950: if ($sec ne '') {
4951: $area .= '/'.$sec;
4952: }
4953: if (($area ne '') && ($trole ne '')) {
4954: my $spec=$trole.'.'.$area;
4955: if ($trole =~ /^cr\//) {
4956: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4957: } elsif ($trole ne 'gr') {
4958: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4959: }
4960: }
4961: }
4962: foreach my $role (keys(%allroles)) {
4963: last if ($is_adv);
4964: foreach my $item (split(/:/,$allroles{$role})) {
4965: if ($item ne '') {
4966: my ($privilege,$restrictions)=split(/&/,$item);
4967: if ($privilege eq 'adv') {
4968: $is_adv = 1;
4969: last;
4970: }
4971: }
4972: }
4973: }
4974: return $is_adv;
4975: }
1.798 raeburn 4976:
1.1035 raeburn 4977: sub check_can_request {
1.1036 raeburn 4978: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 4979: my $canreq = 0;
4980: my ($types,$typename) = &Apache::loncommon::course_types();
4981: my @options = ('approval','validate','autolimit');
4982: my $optregex = join('|',@options);
4983: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4984: foreach my $type (@{$types}) {
4985: if (&usertools_access($env{'user.name'},
4986: $env{'user.domain'},
4987: $type,undef,'requestcourses')) {
4988: $canreq ++;
1.1036 raeburn 4989: if (ref($request_domains) eq 'HASH') {
4990: push(@{$request_domains->{$type}},$env{'user.domain'});
4991: }
1.1035 raeburn 4992: if ($dom eq $env{'user.domain'}) {
4993: $can_request->{$type} = 1;
4994: }
4995: }
4996: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4997: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4998: if (@curr > 0) {
1.1036 raeburn 4999: foreach my $item (@curr) {
5000: if (ref($request_domains) eq 'HASH') {
5001: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
5002: if ($otherdom ne '') {
5003: if (ref($request_domains->{$type}) eq 'ARRAY') {
5004: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
5005: push(@{$request_domains->{$type}},$otherdom);
5006: }
5007: } else {
5008: push(@{$request_domains->{$type}},$otherdom);
5009: }
5010: }
5011: }
5012: }
5013: unless($dom eq $env{'user.domain'}) {
5014: $canreq ++;
1.1035 raeburn 5015: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
5016: $can_request->{$type} = 1;
5017: }
5018: }
5019: }
5020: }
5021: }
5022: }
5023: return $canreq;
5024: }
5025:
1.341 www 5026: # ---------------------------------------------- Custom access rule evaluation
5027:
5028: sub customaccess {
5029: my ($priv,$uri)=@_;
1.807 albertel 5030: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 5031: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 5032: $udom = &LONCAPA::clean_domain($udom);
5033: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 5034: my $access=0;
1.800 albertel 5035: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 5036: my ($effect,$realm,$role,$type)=split(/\:/,$right);
5037: if ($type eq 'user') {
5038: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 5039: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 5040: if ($tdom) {
5041: if ($tdom ne $env{'user.domain'}) { next; }
5042: }
1.896 albertel 5043: if ($tuname) {
5044: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 5045: }
5046: $access=($effect eq 'allow');
5047: last;
5048: }
5049: } else {
5050: if ($role) {
5051: if ($role ne $urole) { next; }
5052: }
5053: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5054: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
5055: if ($tdom) {
5056: if ($tdom ne $udom) { next; }
5057: }
5058: if ($tcrs) {
5059: if ($tcrs ne $ucrs) { next; }
5060: }
5061: if ($tsec) {
5062: if ($tsec ne $usec) { next; }
5063: }
5064: $access=($effect eq 'allow');
5065: last;
5066: }
5067: if ($realm eq '' && $role eq '') {
5068: $access=($effect eq 'allow');
5069: }
1.402 bowersj2 5070: }
1.341 www 5071: }
5072: return $access;
5073: }
5074:
1.103 harris41 5075: # ------------------------------------------------- Check for a user privilege
1.12 www 5076:
5077: sub allowed {
1.810 raeburn 5078: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 5079: my $ver_orguri=$uri;
1.439 www 5080: $uri=&deversion($uri);
1.152 www 5081: my $orguri=$uri;
1.52 www 5082: $uri=&declutter($uri);
1.809 raeburn 5083:
1.810 raeburn 5084: if ($priv eq 'evb') {
5085: # Evade communication block restrictions for specified role in a course
5086: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
5087: return $1;
5088: } else {
5089: return;
5090: }
5091: }
5092:
1.620 albertel 5093: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 5094: # Free bre access to adm and meta resources
1.775 albertel 5095: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 5096: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5097: && ($priv eq 'bre')) {
1.14 www 5098: return 'F';
1.159 www 5099: }
5100:
1.545 banghart 5101: # Free bre access to user's own portfolio contents
1.714 raeburn 5102: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 5103: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 5104: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 5105: my %setters;
5106: my ($startblock,$endblock) =
5107: &Apache::loncommon::blockcheck(\%setters,'port');
5108: if ($startblock && $endblock) {
5109: return 'B';
5110: } else {
5111: return 'F';
5112: }
1.545 banghart 5113: }
5114:
1.762 raeburn 5115: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 5116: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5117: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5118: if (exists($env{'request.course.id'})) {
5119: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5120: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5121: if (($domain eq $cdom) && ($name eq $cnum)) {
5122: my $courseprivid=$env{'request.course.id'};
5123: $courseprivid=~s/\_/\//;
5124: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5125: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5126: return $1;
1.762 raeburn 5127: } else {
5128: if ($env{'request.course.sec'}) {
5129: $courseprivid.='/'.$env{'request.course.sec'};
5130: }
5131: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5132: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5133: return $2;
5134: }
1.714 raeburn 5135: }
5136: }
5137: }
5138: }
5139:
1.159 www 5140: # Free bre to public access
5141:
5142: if ($priv eq 'bre') {
1.238 www 5143: my $copyright=&metadata($uri,'copyright');
1.620 albertel 5144: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 5145: return 'F';
5146: }
1.238 www 5147: if ($copyright eq 'priv') {
5148: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5149: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 5150: return '';
5151: }
5152: }
5153: if ($copyright eq 'domain') {
5154: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5155: unless (($env{'user.domain'} eq $1) ||
5156: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 5157: return '';
5158: }
1.262 matthew 5159: }
1.620 albertel 5160: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 5161: # Library role, so allow browsing of resources in this domain.
5162: return 'F';
1.238 www 5163: }
1.341 www 5164: if ($copyright eq 'custom') {
5165: unless (&customaccess($priv,$uri)) { return ''; }
5166: }
1.14 www 5167: }
1.264 matthew 5168: # Domain coordinator is trying to create a course
1.620 albertel 5169: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 5170: # uri is the requested domain in this case.
5171: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 5172: # a role of dc for the domain in question.
1.620 albertel 5173: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 5174: }
1.29 www 5175:
1.52 www 5176: my $thisallowed='';
5177: my $statecond=0;
5178: my $courseprivid='';
5179:
1.1039 raeburn 5180: my $ownaccess;
1.1043 raeburn 5181: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 5182: if (($priv eq 'bro') && ($env{'user.author'})) {
5183: if ($uri eq '') {
5184: $ownaccess = 1;
5185: } else {
5186: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5187: my $udom = $env{'user.domain'};
5188: my $uname = $env{'user.name'};
5189: if ($uri =~ m{^\Q$udom\E/?$}) {
5190: $ownaccess = 1;
1.1040 raeburn 5191: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 5192: unless ($uri =~ m{\.\./}) {
5193: $ownaccess = 1;
5194: }
5195: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5196: my $now = time;
5197: if ($uri =~ m{^([^/]+)/?$}) {
5198: my $adom = $1;
5199: foreach my $key (keys(%env)) {
1.1042 raeburn 5200: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 5201: my ($start,$end) = split('.',$env{$key});
5202: if (($now >= $start) && (!$end || $end < $now)) {
5203: $ownaccess = 1;
5204: last;
5205: }
5206: }
5207: }
5208: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5209: my $adom = $1;
5210: my $aname = $2;
1.1042 raeburn 5211: foreach my $role ('ca','aa') {
5212: if ($env{"user.role.$role./$adom/$aname"}) {
5213: my ($start,$end) =
5214: split('.',$env{"user.role.$role./$adom/$aname"});
5215: if (($now >= $start) && (!$end || $end < $now)) {
5216: $ownaccess = 1;
5217: last;
5218: }
1.1039 raeburn 5219: }
5220: }
5221: }
5222: }
5223: }
5224: }
5225: }
5226:
1.52 www 5227: # Course
5228:
1.620 albertel 5229: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5230: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5231: $thisallowed.=$1;
5232: }
1.52 www 5233: }
1.29 www 5234:
1.52 www 5235: # Domain
5236:
1.620 albertel 5237: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 5238: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5239: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5240: $thisallowed.=$1;
5241: }
1.12 www 5242: }
1.52 www 5243:
5244: # Course: uri itself is a course
1.66 www 5245: my $courseuri=$uri;
5246: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 5247: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 5248:
1.620 albertel 5249: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 5250: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5251: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5252: $thisallowed.=$1;
5253: }
1.12 www 5254: }
1.29 www 5255:
1.665 albertel 5256: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 5257: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 5258: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 5259: $thisallowed='';
1.671 raeburn 5260: my ($match)=&is_on_map($uri);
5261: if ($match) {
5262: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5263: =~/\Q$priv\E\&([^\:]*)/) {
5264: $thisallowed.=$1;
5265: }
5266: } else {
1.705 albertel 5267: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 5268: if ($refuri) {
5269: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 5270: $thisallowed='F';
1.671 raeburn 5271: } else {
5272: $refuri=&declutter($refuri);
5273: my ($match) = &is_on_map($refuri);
5274: if ($match) {
5275: $thisallowed='F';
5276: }
1.669 raeburn 5277: }
1.671 raeburn 5278: }
5279: }
1.314 www 5280: }
1.492 albertel 5281:
1.766 albertel 5282: if ($priv eq 'bre'
5283: && $thisallowed ne 'F'
5284: && $thisallowed ne '2'
5285: && &is_portfolio_url($uri)) {
5286: $thisallowed = &portfolio_access($uri);
5287: }
5288:
1.52 www 5289: # Full access at system, domain or course-wide level? Exit.
1.29 www 5290: if ($thisallowed=~/F/) {
5291: return 'F';
5292: }
5293:
1.52 www 5294: # If this is generating or modifying users, exit with special codes
1.29 www 5295:
1.643 www 5296: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5297: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 5298: my ($audom,$auname)=split('/',$uri);
1.643 www 5299: # no author name given, so this just checks on the general right to make a co-author in this domain
5300: unless ($auname) { return $thisallowed; }
5301: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 5302: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5303: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5304: ($audom ne $env{'request.role.domain'}))) { return ''; }
5305: }
1.52 www 5306: return $thisallowed;
5307: }
5308: #
1.103 harris41 5309: # Gathered so far: system, domain and course wide privileges
1.52 www 5310: #
5311: # Course: See if uri or referer is an individual resource that is part of
5312: # the course
5313:
1.620 albertel 5314: if ($env{'request.course.id'}) {
1.232 www 5315:
1.620 albertel 5316: $courseprivid=$env{'request.course.id'};
5317: if ($env{'request.course.sec'}) {
5318: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 5319: }
5320: $courseprivid=~s/\_/\//;
5321: my $checkreferer=1;
1.232 www 5322: my ($match,$cond)=&is_on_map($uri);
5323: if ($match) {
5324: $statecond=$cond;
1.620 albertel 5325: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5326: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5327: $thisallowed.=$1;
5328: $checkreferer=0;
5329: }
1.29 www 5330: }
1.83 www 5331:
1.148 www 5332: if ($checkreferer) {
1.620 albertel 5333: my $refuri=$env{'httpref.'.$orguri};
1.148 www 5334: unless ($refuri) {
1.800 albertel 5335: foreach my $key (keys(%env)) {
5336: if ($key=~/^httpref\..*\*/) {
5337: my $pattern=$key;
1.156 www 5338: $pattern=~s/^httpref\.\/res\///;
1.148 www 5339: $pattern=~s/\*/\[\^\/\]\+/g;
5340: $pattern=~s/\//\\\//g;
1.152 www 5341: if ($orguri=~/$pattern/) {
1.800 albertel 5342: $refuri=$env{$key};
1.148 www 5343: }
5344: }
1.191 harris41 5345: }
1.148 www 5346: }
1.232 www 5347:
1.148 www 5348: if ($refuri) {
1.152 www 5349: $refuri=&declutter($refuri);
1.232 www 5350: my ($match,$cond)=&is_on_map($refuri);
5351: if ($match) {
5352: my $refstatecond=$cond;
1.620 albertel 5353: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5354: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5355: $thisallowed.=$1;
1.53 www 5356: $uri=$refuri;
5357: $statecond=$refstatecond;
1.52 www 5358: }
5359: }
1.148 www 5360: }
1.29 www 5361: }
1.52 www 5362: }
1.29 www 5363:
1.52 www 5364: #
1.103 harris41 5365: # Gathered now: all privileges that could apply, and condition number
1.52 www 5366: #
5367: #
5368: # Full or no access?
5369: #
1.29 www 5370:
1.52 www 5371: if ($thisallowed=~/F/) {
5372: return 'F';
5373: }
1.29 www 5374:
1.52 www 5375: unless ($thisallowed) {
5376: return '';
5377: }
1.29 www 5378:
1.52 www 5379: # Restrictions exist, deal with them
5380: #
5381: # C:according to course preferences
5382: # R:according to resource settings
5383: # L:unless locked
5384: # X:according to user session state
5385: #
5386:
5387: # Possibly locked functionality, check all courses
1.54 www 5388: # Locks might take effect only after 10 minutes cache expiration for other
5389: # courses, and 2 minutes for current course
1.52 www 5390:
5391: my $envkey;
5392: if ($thisallowed=~/L/) {
1.1000 raeburn 5393: foreach $envkey (keys(%env)) {
1.54 www 5394: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5395: my $courseid=$2;
5396: my $roleid=$1.'.'.$2;
1.92 www 5397: $courseid=~s/^\///;
1.54 www 5398: my $expiretime=600;
1.620 albertel 5399: if ($env{'request.role'} eq $roleid) {
1.54 www 5400: $expiretime=120;
5401: }
5402: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5403: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 5404: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 5405: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 5406: }
1.620 albertel 5407: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5408: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5409: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5410: &log($env{'user.domain'},$env{'user.name'},
5411: $env{'user.home'},
1.57 www 5412: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 5413: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5414: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5415: return '';
5416: }
5417: }
1.620 albertel 5418: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5419: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5420: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5421: &log($env{'user.domain'},$env{'user.name'},
5422: $env{'user.home'},
1.57 www 5423: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 5424: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5425: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5426: return '';
5427: }
5428: }
5429: }
1.29 www 5430: }
1.52 www 5431: }
5432:
5433: #
5434: # Rest of the restrictions depend on selected course
5435: #
5436:
1.620 albertel 5437: unless ($env{'request.course.id'}) {
1.766 albertel 5438: if ($thisallowed eq 'A') {
5439: return 'A';
1.814 raeburn 5440: } elsif ($thisallowed eq 'B') {
5441: return 'B';
1.766 albertel 5442: } else {
5443: return '1';
5444: }
1.52 www 5445: }
1.29 www 5446:
1.52 www 5447: #
5448: # Now user is definitely in a course
5449: #
1.53 www 5450:
5451:
5452: # Course preferences
5453:
5454: if ($thisallowed=~/C/) {
1.620 albertel 5455: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5456: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5457: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 5458: =~/\Q$rolecode\E/) {
1.689 albertel 5459: if ($priv ne 'pch') {
5460: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5461: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5462: $env{'request.course.id'});
5463: }
1.237 www 5464: return '';
5465: }
5466:
1.620 albertel 5467: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 5468: =~/\Q$unamedom\E/) {
1.689 albertel 5469: if ($priv ne 'pch') {
5470: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5471: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5472: $env{'request.course.id'});
5473: }
1.54 www 5474: return '';
5475: }
1.53 www 5476: }
5477:
5478: # Resource preferences
5479:
5480: if ($thisallowed=~/R/) {
1.620 albertel 5481: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 5482: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 5483: if ($priv ne 'pch') {
5484: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5485: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5486: }
5487: return '';
1.54 www 5488: }
1.53 www 5489: }
1.30 www 5490:
1.246 www 5491: # Restricted by state or randomout?
1.30 www 5492:
1.52 www 5493: if ($thisallowed=~/X/) {
1.620 albertel 5494: if ($env{'acc.randomout'}) {
1.579 albertel 5495: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 5496: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 5497: return '';
5498: }
1.247 www 5499: }
5500: if (&condval($statecond)) {
1.52 www 5501: return '2';
5502: } else {
5503: return '';
5504: }
5505: }
1.30 www 5506:
1.766 albertel 5507: if ($thisallowed eq 'A') {
5508: return 'A';
1.814 raeburn 5509: } elsif ($thisallowed eq 'B') {
5510: return 'B';
1.766 albertel 5511: }
1.52 www 5512: return 'F';
1.232 www 5513: }
5514:
1.710 albertel 5515: sub split_uri_for_cond {
5516: my $uri=&deversion(&declutter(shift));
5517: my @uriparts=split(/\//,$uri);
5518: my $filename=pop(@uriparts);
5519: my $pathname=join('/',@uriparts);
5520: return ($pathname,$filename);
5521: }
1.232 www 5522: # --------------------------------------------------- Is a resource on the map?
5523:
5524: sub is_on_map {
1.710 albertel 5525: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 5526: #Trying to find the conditional for the file
1.620 albertel 5527: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 5528: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 5529: if ($match) {
1.289 bowersj2 5530: return (1,$1);
5531: } else {
1.434 www 5532: return (0,0);
1.289 bowersj2 5533: }
1.12 www 5534: }
5535:
1.427 www 5536: # --------------------------------------------------------- Get symb from alias
5537:
5538: sub get_symb_from_alias {
5539: my $symb=shift;
5540: my ($map,$resid,$url)=&decode_symb($symb);
5541: # Already is a symb
5542: if ($url) { return $symb; }
5543: # Must be an alias
5544: my $aliassymb='';
5545: my %bighash;
1.620 albertel 5546: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 5547: &GDBM_READER(),0640)) {
5548: my $rid=$bighash{'mapalias_'.$symb};
5549: if ($rid) {
5550: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 5551: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5552: $resid,$bighash{'src_'.$rid});
1.427 www 5553: }
5554: untie %bighash;
5555: }
5556: return $aliassymb;
5557: }
5558:
1.12 www 5559: # ----------------------------------------------------------------- Define Role
5560:
5561: sub definerole {
5562: if (allowed('mcr','/')) {
5563: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 5564: foreach my $role (split(':',$sysrole)) {
5565: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5566: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5567: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5568: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5569: return "refused:s:$crole&$cqual";
5570: }
5571: }
1.191 harris41 5572: }
1.800 albertel 5573: foreach my $role (split(':',$domrole)) {
5574: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5575: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5576: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5577: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 5578: return "refused:d:$crole&$cqual";
5579: }
5580: }
1.191 harris41 5581: }
1.800 albertel 5582: foreach my $role (split(':',$courole)) {
5583: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5584: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5585: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5586: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5587: return "refused:c:$crole&$cqual";
5588: }
5589: }
1.191 harris41 5590: }
1.620 albertel 5591: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5592: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5593: "rolesdef_$rolename=".
5594: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 5595: return reply($command,$env{'user.home'});
1.12 www 5596: } else {
5597: return 'refused';
5598: }
1.105 harris41 5599: }
5600:
5601: # ---------------- Make a metadata query against the network of library servers
5602:
5603: sub metadata_query {
1.244 matthew 5604: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 5605: my %rhash;
1.845 albertel 5606: my %libserv = &all_library();
1.244 matthew 5607: my @server_list = (defined($server_array) ? @$server_array
5608: : keys(%libserv) );
5609: for my $server (@server_list) {
1.118 harris41 5610: unless ($custom or $customshow) {
5611: my $reply=&reply("querysend:".&escape($query),$server);
5612: $rhash{$server}=$reply;
5613: }
5614: else {
5615: my $reply=&reply("querysend:".&escape($query).':'.
5616: &escape($custom).':'.&escape($customshow),
5617: $server);
5618: $rhash{$server}=$reply;
5619: }
1.112 harris41 5620: }
1.118 harris41 5621: return \%rhash;
1.240 www 5622: }
5623:
5624: # ----------------------------------------- Send log queries and wait for reply
5625:
5626: sub log_query {
5627: my ($uname,$udom,$query,%filters)=@_;
5628: my $uhome=&homeserver($uname,$udom);
5629: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 5630: my $uhost=&hostname($uhome);
1.800 albertel 5631: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 5632: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5633: $uhome);
1.479 albertel 5634: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 5635: return get_query_reply($queryid);
5636: }
5637:
1.818 raeburn 5638: # -------------------------- Update MySQL table for portfolio file
5639:
5640: sub update_portfolio_table {
1.821 raeburn 5641: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 5642: if ($group ne '') {
5643: $file_name =~s /^\Q$group\E//;
5644: }
1.818 raeburn 5645: my $homeserver = &homeserver($uname,$udom);
5646: my $queryid=
1.821 raeburn 5647: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5648: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 5649: my $reply = &get_query_reply($queryid);
5650: return $reply;
5651: }
5652:
1.899 raeburn 5653: # -------------------------- Update MySQL allusers table
5654:
5655: sub update_allusers_table {
5656: my ($uname,$udom,$names) = @_;
5657: my $homeserver = &homeserver($uname,$udom);
5658: my $queryid=
5659: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5660: 'lastname='.&escape($names->{'lastname'}).'%%'.
5661: 'firstname='.&escape($names->{'firstname'}).'%%'.
5662: 'middlename='.&escape($names->{'middlename'}).'%%'.
5663: 'generation='.&escape($names->{'generation'}).'%%'.
5664: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5665: 'id='.&escape($names->{'id'}),$homeserver);
5666: my $reply = &get_query_reply($queryid);
5667: return $reply;
5668: }
5669:
1.508 raeburn 5670: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 5671:
5672: sub fetch_enrollment_query {
1.511 raeburn 5673: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 5674: my $homeserver;
1.547 raeburn 5675: my $maxtries = 1;
1.508 raeburn 5676: if ($context eq 'automated') {
5677: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 5678: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 5679: } else {
5680: $homeserver = &homeserver($cnum,$dom);
5681: }
1.838 albertel 5682: my $host=&hostname($homeserver);
1.506 raeburn 5683: my $cmd = '';
1.1000 raeburn 5684: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 5685: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 5686: }
5687: $cmd =~ s/%%$//;
5688: $cmd = &escape($cmd);
5689: my $query = 'fetchenrollment';
1.620 albertel 5690: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 5691: unless ($queryid=~/^\Q$host\E\_/) {
5692: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5693: return 'error: '.$queryid;
5694: }
1.506 raeburn 5695: my $reply = &get_query_reply($queryid);
1.547 raeburn 5696: my $tries = 1;
5697: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5698: $reply = &get_query_reply($queryid);
5699: $tries ++;
5700: }
1.526 raeburn 5701: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 5702: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 5703: } else {
1.901 albertel 5704: my @responses = split(/:/,$reply);
1.515 raeburn 5705: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 5706: foreach my $line (@responses) {
5707: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 5708: $$replyref{$key} = $value;
5709: }
5710: } else {
1.506 raeburn 5711: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 5712: foreach my $line (@responses) {
5713: my ($key,$value) = split(/=/,$line);
1.506 raeburn 5714: $$replyref{$key} = $value;
5715: if ($value > 0) {
1.800 albertel 5716: foreach my $item (@{$$affiliatesref{$key}}) {
5717: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 5718: my $destname = $pathname.'/'.$filename;
5719: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 5720: if ($xml_classlist =~ /^error/) {
5721: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5722: } else {
1.506 raeburn 5723: if ( open(FILE,">$destname") ) {
5724: print FILE &unescape($xml_classlist);
5725: close(FILE);
1.526 raeburn 5726: } else {
5727: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 5728: }
5729: }
5730: }
5731: }
5732: }
5733: }
5734: return 'ok';
5735: }
5736: return 'error';
5737: }
5738:
1.242 www 5739: sub get_query_reply {
5740: my $queryid=shift;
1.240 www 5741: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5742: my $reply='';
5743: for (1..100) {
5744: sleep 2;
5745: if (-e $replyfile.'.end') {
1.448 albertel 5746: if (open(my $fh,$replyfile)) {
1.904 albertel 5747: $reply = join('',<$fh>);
5748: close($fh);
1.240 www 5749: } else { return 'error: reply_file_error'; }
1.242 www 5750: return &unescape($reply);
5751: }
1.240 www 5752: }
1.242 www 5753: return 'timeout:'.$queryid;
1.240 www 5754: }
5755:
5756: sub courselog_query {
1.241 www 5757: #
5758: # possible filters:
5759: # url: url or symb
5760: # username
5761: # domain
5762: # action: view, submit, grade
5763: # start: timestamp
5764: # end: timestamp
5765: #
1.240 www 5766: my (%filters)=@_;
1.620 albertel 5767: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 5768: if ($filters{'url'}) {
5769: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5770: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5771: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5772: }
1.620 albertel 5773: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5774: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 5775: return &log_query($cname,$cdom,'courselog',%filters);
5776: }
5777:
5778: sub userlog_query {
1.858 raeburn 5779: #
5780: # possible filters:
5781: # action: log check role
5782: # start: timestamp
5783: # end: timestamp
5784: #
1.240 www 5785: my ($uname,$udom,%filters)=@_;
5786: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 5787: }
5788:
1.506 raeburn 5789: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5790:
5791: sub auto_run {
1.508 raeburn 5792: my ($cnum,$cdom) = @_;
1.876 raeburn 5793: my $response = 0;
5794: my $settings;
5795: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5796: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5797: $settings = $domconfig{'autoenroll'};
5798: if ($settings->{'run'} eq '1') {
5799: $response = 1;
5800: }
5801: } else {
1.934 raeburn 5802: my $homeserver;
5803: if (&is_course($cdom,$cnum)) {
5804: $homeserver = &homeserver($cnum,$cdom);
5805: } else {
5806: $homeserver = &domain($cdom,'primary');
5807: }
5808: if ($homeserver ne 'no_host') {
5809: $response = &reply('autorun:'.$cdom,$homeserver);
5810: }
1.876 raeburn 5811: }
1.506 raeburn 5812: return $response;
5813: }
1.776 albertel 5814:
1.506 raeburn 5815: sub auto_get_sections {
1.508 raeburn 5816: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 5817: my $homeserver;
5818: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5819: $homeserver = &homeserver($cnum,$cdom);
5820: }
5821: if (!defined($homeserver)) {
5822: if ($cdom =~ /^$match_domain$/) {
5823: $homeserver = &domain($cdom,'primary');
5824: }
5825: }
5826: my @secs;
5827: if (defined($homeserver)) {
5828: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5829: unless ($response eq 'refused') {
5830: @secs = split(/:/,$response);
5831: }
1.506 raeburn 5832: }
5833: return @secs;
5834: }
1.776 albertel 5835:
1.506 raeburn 5836: sub auto_new_course {
1.508 raeburn 5837: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5838: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 5839: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 5840: return $response;
5841: }
1.776 albertel 5842:
1.506 raeburn 5843: sub auto_validate_courseID {
1.508 raeburn 5844: my ($cnum,$cdom,$inst_course_id) = @_;
5845: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 5846: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 5847: return $response;
5848: }
1.776 albertel 5849:
1.1007 raeburn 5850: sub auto_validate_instcode {
1.1020 raeburn 5851: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 5852: my ($homeserver,$response);
5853: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5854: $homeserver = &homeserver($cnum,$cdom);
5855: }
5856: if (!defined($homeserver)) {
5857: if ($cdom =~ /^$match_domain$/) {
5858: $homeserver = &domain($cdom,'primary');
5859: }
5860: }
1.1056.2.4 raeburn 5861: $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
5862: &escape($instcode).':'.&escape($owner),$homeserver));
1.1027 raeburn 5863: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5864: return ($outcome,$description);
1.1007 raeburn 5865: }
5866:
1.506 raeburn 5867: sub auto_create_password {
1.873 raeburn 5868: my ($cnum,$cdom,$authparam,$udom) = @_;
5869: my ($homeserver,$response);
1.506 raeburn 5870: my $create_passwd = 0;
5871: my $authchk = '';
1.873 raeburn 5872: if ($udom =~ /^$match_domain$/) {
5873: $homeserver = &domain($udom,'primary');
5874: }
5875: if ($homeserver eq '') {
5876: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5877: $homeserver = &homeserver($cnum,$cdom);
5878: }
5879: }
5880: if ($homeserver eq '') {
5881: $authchk = 'nodomain';
1.506 raeburn 5882: } else {
1.873 raeburn 5883: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5884: if ($response eq 'refused') {
5885: $authchk = 'refused';
5886: } else {
1.901 albertel 5887: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 5888: }
1.506 raeburn 5889: }
5890: return ($authparam,$create_passwd,$authchk);
5891: }
5892:
1.706 raeburn 5893: sub auto_photo_permission {
5894: my ($cnum,$cdom,$students) = @_;
5895: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 5896: my ($outcome,$perm_reqd,$conditions) =
5897: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 5898: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5899: return (undef,undef);
5900: }
1.706 raeburn 5901: return ($outcome,$perm_reqd,$conditions);
5902: }
5903:
5904: sub auto_checkphotos {
5905: my ($uname,$udom,$pid) = @_;
5906: my $homeserver = &homeserver($uname,$udom);
5907: my ($result,$resulttype);
5908: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 5909: &escape($uname).':'.&escape($pid),
5910: $homeserver));
1.709 albertel 5911: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5912: return (undef,undef);
5913: }
1.706 raeburn 5914: if ($outcome) {
5915: ($result,$resulttype) = split(/:/,$outcome);
5916: }
5917: return ($result,$resulttype);
5918: }
5919:
5920: sub auto_photochoice {
5921: my ($cnum,$cdom) = @_;
5922: my $homeserver = &homeserver($cnum,$cdom);
5923: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 5924: &escape($cdom),
5925: $homeserver)));
1.709 albertel 5926: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5927: return (undef,undef);
5928: }
1.706 raeburn 5929: return ($update,$comment);
5930: }
5931:
5932: sub auto_photoupdate {
5933: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5934: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 5935: my $host=&hostname($homeserver);
1.706 raeburn 5936: my $cmd = '';
5937: my $maxtries = 1;
1.800 albertel 5938: foreach my $affiliate (keys(%{$affiliatesref})) {
5939: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 5940: }
5941: $cmd =~ s/%%$//;
5942: $cmd = &escape($cmd);
5943: my $query = 'institutionalphotos';
5944: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5945: unless ($queryid=~/^\Q$host\E\_/) {
5946: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5947: return 'error: '.$queryid;
5948: }
5949: my $reply = &get_query_reply($queryid);
5950: my $tries = 1;
5951: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5952: $reply = &get_query_reply($queryid);
5953: $tries ++;
5954: }
5955: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5956: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5957: } else {
5958: my @responses = split(/:/,$reply);
5959: my $outcome = shift(@responses);
5960: foreach my $item (@responses) {
5961: my ($key,$value) = split(/=/,$item);
5962: $$photo{$key} = $value;
5963: }
5964: return $outcome;
5965: }
5966: return 'error';
5967: }
5968:
1.521 raeburn 5969: sub auto_instcode_format {
1.793 albertel 5970: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5971: $cat_order) = @_;
1.521 raeburn 5972: my $courses = '';
1.772 raeburn 5973: my @homeservers;
1.521 raeburn 5974: if ($caller eq 'global') {
1.841 albertel 5975: my %servers = &get_servers($codedom,'library');
5976: foreach my $tryserver (keys(%servers)) {
5977: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5978: push(@homeservers,$tryserver);
5979: }
1.584 raeburn 5980: }
1.1022 raeburn 5981: } elsif ($caller eq 'requests') {
5982: if ($codedom =~ /^$match_domain$/) {
5983: my $chome = &domain($codedom,'primary');
5984: unless ($chome eq 'no_host') {
5985: push(@homeservers,$chome);
5986: }
5987: }
1.521 raeburn 5988: } else {
1.772 raeburn 5989: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 5990: }
1.793 albertel 5991: foreach my $code (keys(%{$instcodes})) {
5992: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 5993: }
5994: chop($courses);
1.772 raeburn 5995: my $ok_response = 0;
5996: my $response;
5997: while (@homeservers > 0 && $ok_response == 0) {
5998: my $server = shift(@homeservers);
5999: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
6000: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
6001: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 6002: split(/:/,$response);
1.772 raeburn 6003: %{$codes} = (%{$codes},&str2hash($codes_str));
6004: push(@{$codetitles},&str2array($codetitles_str));
6005: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
6006: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
6007: $ok_response = 1;
6008: }
6009: }
6010: if ($ok_response) {
1.521 raeburn 6011: return 'ok';
1.772 raeburn 6012: } else {
6013: return $response;
1.521 raeburn 6014: }
6015: }
6016:
1.792 raeburn 6017: sub auto_instcode_defaults {
6018: my ($domain,$returnhash,$code_order) = @_;
6019: my @homeservers;
1.841 albertel 6020:
6021: my %servers = &get_servers($domain,'library');
6022: foreach my $tryserver (keys(%servers)) {
6023: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6024: push(@homeservers,$tryserver);
6025: }
1.792 raeburn 6026: }
1.841 albertel 6027:
1.792 raeburn 6028: my $response;
1.841 albertel 6029: foreach my $server (@homeservers) {
1.792 raeburn 6030: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 6031: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
6032:
6033: foreach my $pair (split(/\&/,$response)) {
6034: my ($name,$value)=split(/\=/,$pair);
6035: if ($name eq 'code_order') {
6036: @{$code_order} = split(/\&/,&unescape($value));
6037: } else {
6038: $returnhash->{&unescape($name)}=&unescape($value);
6039: }
6040: }
6041: return 'ok';
1.792 raeburn 6042: }
1.841 albertel 6043:
6044: return $response;
1.1003 raeburn 6045: }
6046:
6047: sub auto_possible_instcodes {
1.1007 raeburn 6048: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
6049: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
6050: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
6051: return;
6052: }
1.1003 raeburn 6053: my (@homeservers,$uhome);
6054: if (defined(&domain($domain,'primary'))) {
6055: $uhome=&domain($domain,'primary');
6056: push(@homeservers,&domain($domain,'primary'));
6057: } else {
6058: my %servers = &get_servers($domain,'library');
6059: foreach my $tryserver (keys(%servers)) {
6060: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6061: push(@homeservers,$tryserver);
6062: }
6063: }
6064: }
6065: my $response;
6066: foreach my $server (@homeservers) {
6067: $response=&reply('autopossibleinstcodes:'.$domain,$server);
6068: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 6069: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
6070: split(':',$response);
6071: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
6072: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 6073: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 6074: my ($name,$value)=split('=',$item);
6075: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 6076: }
6077: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 6078: my ($name,$value)=split('=',$item);
6079: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 6080: }
6081: return 'ok';
6082: }
6083: return $response;
6084: }
1.792 raeburn 6085:
1.1010 raeburn 6086: sub auto_courserequest_checks {
6087: my ($dom) = @_;
1.1020 raeburn 6088: my ($homeserver,%validations);
6089: if ($dom =~ /^$match_domain$/) {
6090: $homeserver = &domain($dom,'primary');
6091: }
6092: unless ($homeserver eq 'no_host') {
6093: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6094: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6095: my @items = split(/&/,$response);
6096: foreach my $item (@items) {
6097: my ($key,$value) = split('=',$item);
6098: $validations{&unescape($key)} = &thaw_unescape($value);
6099: }
6100: }
6101: }
1.1010 raeburn 6102: return %validations;
6103: }
6104:
1.1020 raeburn 6105: sub auto_courserequest_validation {
6106: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6107: my ($homeserver,$response);
6108: if ($dom =~ /^$match_domain$/) {
6109: $homeserver = &domain($dom,'primary');
6110: }
6111: unless ($homeserver eq 'no_host') {
1.1021 raeburn 6112:
1.1020 raeburn 6113: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 6114: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 6115: ':'.&escape($instcode).':'.&escape($instseclist),
6116: $homeserver));
6117: }
6118: return $response;
6119: }
6120:
1.777 albertel 6121: sub auto_validate_class_sec {
1.918 raeburn 6122: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 6123: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 6124: my $ownerlist;
6125: if (ref($owners) eq 'ARRAY') {
6126: $ownerlist = join(',',@{$owners});
6127: } else {
6128: $ownerlist = $owners;
6129: }
1.773 raeburn 6130: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 6131: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 6132: return $response;
6133: }
6134:
1.679 raeburn 6135: # ------------------------------------------------------- Course Group routines
6136:
6137: sub get_coursegroups {
1.809 raeburn 6138: my ($cdom,$cnum,$group,$namespace) = @_;
6139: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 6140: }
6141:
1.679 raeburn 6142: sub modify_coursegroup {
6143: my ($cdom,$cnum,$groupsettings) = @_;
6144: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6145: }
6146:
1.809 raeburn 6147: sub toggle_coursegroup_status {
6148: my ($cdom,$cnum,$group,$action) = @_;
6149: my ($from_namespace,$to_namespace);
6150: if ($action eq 'delete') {
6151: $from_namespace = 'coursegroups';
6152: $to_namespace = 'deleted_groups';
6153: } else {
6154: $from_namespace = 'deleted_groups';
6155: $to_namespace = 'coursegroups';
6156: }
6157: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 6158: if (my $tmp = &error(%curr_group)) {
6159: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6160: return ('read error',$tmp);
6161: } else {
6162: my %savedsettings = %curr_group;
1.809 raeburn 6163: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 6164: my $deloutcome;
6165: if ($result eq 'ok') {
1.809 raeburn 6166: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 6167: } else {
6168: return ('write error',$result);
6169: }
6170: if ($deloutcome eq 'ok') {
6171: return 'ok';
6172: } else {
6173: return ('delete error',$deloutcome);
6174: }
6175: }
6176: }
6177:
1.679 raeburn 6178: sub modify_group_roles {
1.957 raeburn 6179: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 6180: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6181: my $role = 'gr/'.&escape($userprivs);
6182: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 6183: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 6184: if ($result eq 'ok') {
6185: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6186: }
1.679 raeburn 6187: return $result;
6188: }
6189:
6190: sub modify_coursegroup_membership {
6191: my ($cdom,$cnum,$membership) = @_;
6192: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6193: return $result;
6194: }
6195:
1.682 raeburn 6196: sub get_active_groups {
6197: my ($udom,$uname,$cdom,$cnum) = @_;
6198: my $now = time;
6199: my %groups = ();
6200: foreach my $key (keys(%env)) {
1.811 albertel 6201: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 6202: my ($start,$end) = split(/\./,$env{$key});
6203: if (($end!=0) && ($end<$now)) { next; }
6204: if (($start!=0) && ($start>$now)) { next; }
6205: if ($1 eq $cdom && $2 eq $cnum) {
6206: $groups{$3} = $env{$key} ;
6207: }
6208: }
6209: }
6210: return %groups;
6211: }
6212:
1.683 raeburn 6213: sub get_group_membership {
6214: my ($cdom,$cnum,$group) = @_;
6215: return(&dump('groupmembership',$cdom,$cnum,$group));
6216: }
6217:
6218: sub get_users_groups {
6219: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 6220: my @usersgroups;
1.683 raeburn 6221: my $cachetime=1800;
6222:
6223: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 6224: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6225: if (defined($cached)) {
1.734 albertel 6226: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 6227: } else {
6228: $grouplist = '';
1.816 raeburn 6229: my $courseurl = &courseid_to_courseurl($courseid);
6230: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 6231: my $access_end = $env{'course.'.$courseid.
6232: '.default_enrollment_end_date'};
6233: my $now = time;
6234: foreach my $key (keys(%roleshash)) {
6235: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6236: my $group = $1;
6237: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6238: my $start = $2;
6239: my $end = $1;
6240: if ($start == -1) { next; } # deleted from group
6241: if (($start!=0) && ($start>$now)) { next; }
6242: if (($end!=0) && ($end<$now)) {
6243: if ($access_end && $access_end < $now) {
6244: if ($access_end - $end < 86400) {
6245: push(@usersgroups,$group);
1.733 raeburn 6246: }
6247: }
1.817 raeburn 6248: next;
1.733 raeburn 6249: }
1.817 raeburn 6250: push(@usersgroups,$group);
1.683 raeburn 6251: }
6252: }
6253: }
1.817 raeburn 6254: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6255: $grouplist = join(':',@usersgroups);
6256: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 6257: }
1.733 raeburn 6258: return @usersgroups;
1.683 raeburn 6259: }
6260:
6261: sub devalidate_getgroups_cache {
6262: my ($udom,$uname,$cdom,$cnum)=@_;
6263: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 6264:
1.683 raeburn 6265: my $hashid="$udom:$uname:$courseid";
6266: &devalidate_cache_new('getgroups',$hashid);
6267: }
6268:
1.12 www 6269: # ------------------------------------------------------------------ Plain Text
6270:
6271: sub plaintext {
1.988 raeburn 6272: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 6273: if ($short =~ m{^cr/}) {
1.758 albertel 6274: return (split('/',$short))[-1];
6275: }
1.742 raeburn 6276: if (!defined($cid)) {
6277: $cid = $env{'request.course.id'};
6278: }
6279: my %rolenames = (
1.1008 raeburn 6280: Course => 'std',
6281: Community => 'alt1',
1.742 raeburn 6282: );
1.1037 raeburn 6283: if ($cid ne '') {
6284: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6285: unless ($forcedefault) {
6286: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6287: &Apache::lonlocal::mt_escape(\$roletext);
6288: return &Apache::lonlocal::mt($roletext);
6289: }
6290: }
6291: }
6292: if ((defined($type)) && (defined($rolenames{$type})) &&
6293: (defined($rolenames{$type})) &&
6294: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 6295: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 6296: } elsif ($cid ne '') {
6297: my $crstype = $env{'course.'.$cid.'.type'};
6298: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6299: (defined($prp{$short}{$rolenames{$crstype}}))) {
6300: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6301: }
1.742 raeburn 6302: }
1.1037 raeburn 6303: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 6304: }
6305:
6306: # ----------------------------------------------------------------- Assign Role
6307:
6308: sub assignrole {
1.957 raeburn 6309: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6310: $context)=@_;
1.21 www 6311: my $mrole;
6312: if ($role =~ /^cr\//) {
1.393 www 6313: my $cwosec=$url;
1.811 albertel 6314: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 6315: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 6316: my $refused = 1;
6317: if ($context eq 'requestcourses') {
6318: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6319: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6320: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6321: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6322: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6323: if ($crsenv{'internal.courseowner'} eq
6324: $env{'user.name'}.':'.$env{'user.domain'}) {
6325: $refused = '';
6326: }
6327: }
6328: }
6329: }
6330: }
6331: if ($refused) {
6332: &logthis('Refused custom assignrole: '.
6333: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6334: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6335: return 'refused';
6336: }
1.104 www 6337: }
1.21 www 6338: $mrole='cr';
1.678 raeburn 6339: } elsif ($role =~ /^gr\//) {
6340: my $cwogrp=$url;
1.811 albertel 6341: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 6342: unless (&allowed('mdg',$cwogrp)) {
6343: &logthis('Refused group assignrole: '.
6344: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6345: $env{'user.name'}.' at '.$env{'user.domain'});
6346: return 'refused';
6347: }
6348: $mrole='gr';
1.21 www 6349: } else {
1.82 www 6350: my $cwosec=$url;
1.811 albertel 6351: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 6352: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6353: my $refused;
6354: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6355: if (!(&allowed('c'.$role,$url))) {
6356: $refused = 1;
6357: }
6358: } else {
6359: $refused = 1;
6360: }
1.947 raeburn 6361: if ($refused) {
1.1045 raeburn 6362: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6363: if (!$selfenroll && $context eq 'course') {
6364: my %crsenv;
6365: if ($role eq 'cc' || $role eq 'co') {
6366: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6367: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6368: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6369: if ($crsenv{'internal.courseowner'} eq
6370: $env{'user.name'}.':'.$env{'user.domain'}) {
6371: $refused = '';
6372: }
6373: }
6374: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6375: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6376: if ($crsenv{'internal.courseowner'} eq
6377: $env{'user.name'}.':'.$env{'user.domain'}) {
6378: $refused = '';
6379: }
6380: }
6381: }
6382: }
6383: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 6384: $refused = '';
1.1017 raeburn 6385: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 6386: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 6387: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 6388: my $wrongcc;
6389: if ($cnum =~ /^$match_community$/) {
6390: $wrongcc = 1 if ($role eq 'cc');
6391: } else {
6392: $wrongcc = 1 if ($role eq 'co');
6393: }
6394: unless ($wrongcc) {
6395: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6396: if ($crsenv{'internal.courseowner'} eq
6397: $env{'user.name'}.':'.$env{'user.domain'}) {
6398: $refused = '';
6399: }
1.1017 raeburn 6400: }
6401: }
6402: }
6403: if ($refused) {
1.947 raeburn 6404: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6405: ' '.$role.' '.$end.' '.$start.' by '.
6406: $env{'user.name'}.' at '.$env{'user.domain'});
6407: return 'refused';
6408: }
1.932 raeburn 6409: }
1.104 www 6410: }
1.21 www 6411: $mrole=$role;
6412: }
1.620 albertel 6413: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 6414: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 6415: if ($end) { $command.='_'.$end; }
1.21 www 6416: if ($start) {
6417: if ($end) {
1.81 www 6418: $command.='_'.$start;
1.21 www 6419: } else {
1.81 www 6420: $command.='_0_'.$start;
1.21 www 6421: }
6422: }
1.739 raeburn 6423: my $origstart = $start;
6424: my $origend = $end;
1.957 raeburn 6425: my $delflag;
1.357 www 6426: # actually delete
6427: if ($deleteflag) {
1.373 www 6428: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 6429: # modify command to delete the role
1.620 albertel 6430: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 6431: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 6432: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 6433: # set start and finish to negative values for userrolelog
6434: $start=-1;
6435: $end=-1;
1.957 raeburn 6436: $delflag = 1;
1.357 www 6437: }
6438: }
6439: # send command
1.349 www 6440: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 6441: # log new user role if status is ok
1.349 www 6442: if ($answer eq 'ok') {
1.663 raeburn 6443: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 6444: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 6445: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 6446: unless ($role =~ /^gr/) {
6447: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 6448: $origstart,$selfenroll,$context);
1.739 raeburn 6449: }
1.1053 raeburn 6450: if ($role eq 'cc') {
6451: &autoupdate_coowners($url,$end,$start,$uname,$udom);
6452: }
1.349 www 6453: }
6454: return $answer;
1.169 harris41 6455: }
6456:
1.1053 raeburn 6457: sub autoupdate_coowners {
6458: my ($url,$end,$start,$uname,$udom) = @_;
6459: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
6460: if (($cdom ne '') && ($cnum ne '')) {
6461: my $now = time;
6462: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
6463: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
6464: my %coursehash = &coursedescription($cdom.'_'.$cnum);
6465: my $instcode = $coursehash{'internal.coursecode'};
6466: if ($instcode ne '') {
1.1056 raeburn 6467: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
6468: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 6469: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 6470: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
6471: if ($result eq 'valid') {
6472: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 6473: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6474: push(@newcoowners,$coowner);
6475: }
6476: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
6477: push(@newcoowners,$uname.':'.$udom);
6478: }
6479: @newcoowners = sort(@newcoowners);
6480: } else {
6481: push(@newcoowners,$uname.':'.$udom);
6482: }
6483: } else {
6484: if ($coursehash{'internal.co-owners'}) {
6485: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6486: unless ($coowner eq $uname.':'.$udom) {
6487: push(@newcoowners,$coowner);
6488: }
6489: }
6490: unless (@newcoowners > 0) {
6491: $delcoowners = 1;
6492: $coowners = '';
6493: }
6494: }
6495: }
6496: if (@newcoowners || $delcoowners) {
6497: &store_coowners($cdom,$cnum,$coursehash{'home'},
6498: $delcoowners,@newcoowners);
6499: }
6500: }
6501: }
6502: }
6503: }
6504: }
6505: }
6506:
6507: sub store_coowners {
6508: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
6509: my $cid = $cdom.'_'.$cnum;
6510: my ($coowners,$delresult,$putresult);
6511: if (@newcoowners) {
6512: $coowners = join(',',@newcoowners);
6513: my %coownershash = (
6514: 'internal.co-owners' => $coowners,
6515: );
6516: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
6517: if ($putresult eq 'ok') {
6518: if ($env{'course.'.$cid.'.num'} eq $cnum) {
6519: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
6520: }
6521: }
6522: }
6523: if ($delcoowners) {
6524: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
6525: if ($delresult eq 'ok') {
6526: if ($env{'course.'.$cid.'.internal.co-owners'}) {
6527: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
6528: }
6529: }
6530: }
6531: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
6532: my %crsinfo =
6533: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6534: if (ref($crsinfo{$cid}) eq 'HASH') {
6535: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
6536: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
6537: }
6538: }
6539: }
6540:
1.169 harris41 6541: # -------------------------------------------------- Modify user authentication
1.197 www 6542: # Overrides without validation
6543:
1.169 harris41 6544: sub modifyuserauth {
6545: my ($udom,$uname,$umode,$upass)=@_;
6546: my $uhome=&homeserver($uname,$udom);
1.197 www 6547: unless (&allowed('mau',$udom)) { return 'refused'; }
6548: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 6549: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6550: ' in domain '.$env{'request.role.domain'});
1.169 harris41 6551: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6552: &escape($upass),$uhome);
1.620 albertel 6553: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 6554: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6555: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6556: &log($udom,,$uname,$uhome,
1.620 albertel 6557: 'Authentication changed by '.$env{'user.domain'}.', '.
6558: $env{'user.name'}.', '.$umode.
1.197 www 6559: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 6560: unless ($reply eq 'ok') {
1.197 www 6561: &logthis('Authentication mode error: '.$reply);
1.169 harris41 6562: return 'error: '.$reply;
6563: }
1.170 harris41 6564: return 'ok';
1.80 www 6565: }
6566:
1.81 www 6567: # --------------------------------------------------------------- Modify a user
1.80 www 6568:
1.81 www 6569: sub modifyuser {
1.206 matthew 6570: my ($udom, $uname, $uid,
6571: $umode, $upass, $first,
6572: $middle, $last, $gene,
1.1056.2.1 raeburn 6573: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 6574: $udom= &LONCAPA::clean_domain($udom);
6575: $uname=&LONCAPA::clean_username($uname);
1.1056.2.1 raeburn 6576: my $showcandelete = 'none';
6577: if (ref($candelete) eq 'ARRAY') {
6578: if (@{$candelete} > 0) {
6579: $showcandelete = join(', ',@{$candelete});
6580: }
6581: }
1.81 www 6582: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 6583: $umode.', '.$first.', '.$middle.', '.
1.1056.2.1 raeburn 6584: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 6585: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6586: ' desiredhome not specified').
1.620 albertel 6587: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6588: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 6589: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 6590: # ----------------------------------------------------------------- Create User
1.406 albertel 6591: if (($uhome eq 'no_host') &&
6592: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 6593: my $unhome='';
1.844 albertel 6594: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 6595: $unhome = $desiredhome;
1.620 albertel 6596: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6597: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 6598: } else { # load balancing routine for determining $unhome
1.81 www 6599: my $loadm=10000000;
1.841 albertel 6600: my %servers = &get_servers($udom,'library');
6601: foreach my $tryserver (keys(%servers)) {
6602: my $answer=reply('load',$tryserver);
6603: if (($answer=~/\d+/) && ($answer<$loadm)) {
6604: $loadm=$answer;
6605: $unhome=$tryserver;
6606: }
1.80 www 6607: }
6608: }
6609: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 6610: return 'error: unable to find a home server for '.$uname.
6611: ' in domain '.$udom;
1.80 www 6612: }
6613: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6614: &escape($upass),$unhome);
6615: unless ($reply eq 'ok') {
6616: return 'error: '.$reply;
6617: }
1.230 stredwic 6618: $uhome=&homeserver($uname,$udom,'true');
1.80 www 6619: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 6620: return 'error: unable verify users home machine.';
1.80 www 6621: }
1.209 matthew 6622: } # End of creation of new user
1.80 www 6623: # ---------------------------------------------------------------------- Add ID
6624: if ($uid) {
6625: $uid=~tr/A-Z/a-z/;
6626: my %uidhash=&idrget($udom,$uname);
1.196 www 6627: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6628: && (!$forceid)) {
1.80 www 6629: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 6630: return 'error: user id "'.$uid.'" does not match '.
6631: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 6632: }
6633: } else {
6634: &idput($udom,($uname => $uid));
6635: }
6636: }
6637: # -------------------------------------------------------------- Add names, etc
1.313 matthew 6638: my @tmp=&get('environment',
1.899 raeburn 6639: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 6640: 'permanentemail','inststatus'],
1.134 albertel 6641: $udom,$uname);
1.313 matthew 6642: my %names;
6643: if ($tmp[0] =~ m/^error:.*/) {
6644: %names=();
6645: } else {
6646: %names = @tmp;
6647: }
1.388 www 6648: #
1.1056.2.1 raeburn 6649: # If name, email and/or uid are blank (e.g., because an uploaded file
6650: # of users did not contain them), do not overwrite existing values
6651: # unless field is in $candelete array ref.
6652: #
6653: my @fields = ('firstname','middlename','lastname','generation',
6654: 'permanentemail','id');
6655: my %newvalues;
6656: if (ref($candelete) eq 'ARRAY') {
6657: foreach my $field (@fields) {
6658: if (grep(/^\Q$field\E$/,@{$candelete})) {
6659: if ($field eq 'firstname') {
6660: $names{$field} = $first;
6661: } elsif ($field eq 'middlename') {
6662: $names{$field} = $middle;
6663: } elsif ($field eq 'lastname') {
6664: $names{$field} = $last;
6665: } elsif ($field eq 'generation') {
6666: $names{$field} = $gene;
6667: } elsif ($field eq 'permanentemail') {
6668: $names{$field} = $email;
6669: } elsif ($field eq 'id') {
6670: $names{$field} = $uid;
6671: }
6672: }
6673: }
6674: }
6675:
1.388 www 6676: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 6677: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 6678: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 6679: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 6680: if ($email) {
6681: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 6682: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 6683: }
1.899 raeburn 6684: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 6685: if (defined($inststatus)) {
6686: $names{'inststatus'} = '';
6687: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6688: if (ref($usertypes) eq 'HASH') {
6689: my @okstatuses;
6690: foreach my $item (split(/:/,$inststatus)) {
6691: if (defined($usertypes->{$item})) {
6692: push(@okstatuses,$item);
6693: }
6694: }
6695: if (@okstatuses) {
6696: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6697: }
6698: }
6699: }
1.134 albertel 6700: my $reply = &put('environment', \%names, $udom,$uname);
6701: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 6702: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 6703: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.963 raeburn 6704: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6705: $umode.', '.$first.', '.$middle.', '.
6706: $last.', '.$gene.', '.$email.', '.$inststatus;
6707: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6708: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6709: } else {
6710: $logmsg .= ' during self creation';
6711: }
6712: &logthis($logmsg);
1.134 albertel 6713: return 'ok';
1.80 www 6714: }
6715:
1.81 www 6716: # -------------------------------------------------------------- Modify student
1.80 www 6717:
1.81 www 6718: sub modifystudent {
6719: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 6720: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 6721: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 6722: if (!$cid) {
1.620 albertel 6723: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6724: return 'not_in_class';
6725: }
1.80 www 6726: }
6727: # --------------------------------------------------------------- Make the user
1.81 www 6728: my $reply=&modifyuser
1.209 matthew 6729: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 6730: $desiredhome,$email,$inststatus);
1.80 www 6731: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 6732: # This will cause &modify_student_enrollment to get the uid from the
6733: # students environment
6734: $uid = undef if (!$forceid);
1.455 albertel 6735: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 6736: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 6737: return $reply;
6738: }
6739:
6740: sub modify_student_enrollment {
1.957 raeburn 6741: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 6742: my ($cdom,$cnum,$chome);
6743: if (!$cid) {
1.620 albertel 6744: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6745: return 'not_in_class';
6746: }
1.620 albertel 6747: $cdom=$env{'course.'.$cid.'.domain'};
6748: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 6749: } else {
6750: ($cdom,$cnum)=split(/_/,$cid);
6751: }
1.620 albertel 6752: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 6753: if (!$chome) {
1.457 raeburn 6754: $chome=&homeserver($cnum,$cdom);
1.297 matthew 6755: }
1.455 albertel 6756: if (!$chome) { return 'unknown_course'; }
1.297 matthew 6757: # Make sure the user exists
1.81 www 6758: my $uhome=&homeserver($uname,$udom);
6759: if (($uhome eq '') || ($uhome eq 'no_host')) {
6760: return 'error: no such user';
6761: }
1.297 matthew 6762: # Get student data if we were not given enough information
6763: if (!defined($first) || $first eq '' ||
6764: !defined($last) || $last eq '' ||
6765: !defined($uid) || $uid eq '' ||
6766: !defined($middle) || $middle eq '' ||
6767: !defined($gene) || $gene eq '') {
1.294 matthew 6768: # They did not supply us with enough data to enroll the student, so
6769: # we need to pick up more information.
1.297 matthew 6770: my %tmp = &get('environment',
1.294 matthew 6771: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 6772: ,$udom,$uname);
6773:
1.800 albertel 6774: #foreach my $key (keys(%tmp)) {
6775: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 6776: #}
1.294 matthew 6777: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6778: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6779: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 6780: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 6781: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6782: }
1.556 albertel 6783: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 6784: my $reply=cput('classlist',
6785: {"$uname:$udom" =>
1.515 raeburn 6786: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 6787: $cdom,$cnum);
1.81 www 6788: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6789: return 'error: '.$reply;
1.652 albertel 6790: } else {
6791: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 6792: }
1.297 matthew 6793: # Add student role to user
1.83 www 6794: my $uurl='/'.$cid;
1.81 www 6795: $uurl=~s/\_/\//g;
6796: if ($usec) {
6797: $uurl.='/'.$usec;
6798: }
1.957 raeburn 6799: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21 www 6800: }
6801:
1.556 albertel 6802: sub format_name {
6803: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6804: my $name;
6805: if ($first ne 'lastname') {
6806: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6807: } else {
6808: if ($lastname=~/\S/) {
6809: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6810: $name=~s/\s+,/,/;
6811: } else {
6812: $name.= $firstname.' '.$middlename.' '.$generation;
6813: }
6814: }
6815: $name=~s/^\s+//;
6816: $name=~s/\s+$//;
6817: $name=~s/\s+/ /g;
6818: return $name;
6819: }
6820:
1.84 www 6821: # ------------------------------------------------- Write to course preferences
6822:
6823: sub writecoursepref {
6824: my ($courseid,%prefs)=@_;
6825: $courseid=~s/^\///;
6826: $courseid=~s/\_/\//g;
6827: my ($cdomain,$cnum)=split(/\//,$courseid);
6828: my $chome=homeserver($cnum,$cdomain);
6829: if (($chome eq '') || ($chome eq 'no_host')) {
6830: return 'error: no such course';
6831: }
6832: my $cstring='';
1.800 albertel 6833: foreach my $pref (keys(%prefs)) {
6834: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 6835: }
1.84 www 6836: $cstring=~s/\&$//;
6837: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6838: }
6839:
6840: # ---------------------------------------------------------- Make/modify course
6841:
6842: sub createcourse {
1.741 raeburn 6843: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 6844: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 6845: $url=&declutter($url);
6846: my $cid='';
1.1028 raeburn 6847: if ($context eq 'requestcourses') {
6848: my $can_create = 0;
6849: my ($ownername,$ownerdom) = split(':',$course_owner);
6850: if ($udom eq $ownerdom) {
6851: if (&usertools_access($ownername,$ownerdom,$category,undef,
6852: $context)) {
6853: $can_create = 1;
6854: }
6855: } else {
6856: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6857: $category);
6858: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6859: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6860: if (@curr > 0) {
6861: my @options = qw(approval validate autolimit);
6862: my $optregex = join('|',@options);
6863: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6864: $can_create = 1;
6865: }
6866: }
6867: }
6868: }
6869: if ($can_create) {
6870: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6871: unless (&allowed('ccc',$udom)) {
6872: return 'refused';
6873: }
1.1017 raeburn 6874: }
6875: } else {
6876: return 'refused';
6877: }
1.1028 raeburn 6878: } elsif (!&allowed('ccc',$udom)) {
6879: return 'refused';
1.84 www 6880: }
1.1011 raeburn 6881: # --------------------------------------------------------------- Get Unique ID
6882: my $uname;
6883: if ($cnum =~ /^$match_courseid$/) {
6884: my $chome=&homeserver($cnum,$udom,'true');
6885: if (($chome eq '') || ($chome eq 'no_host')) {
6886: $uname = $cnum;
6887: } else {
1.1038 raeburn 6888: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6889: }
6890: } else {
1.1038 raeburn 6891: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6892: }
6893: return $uname if ($uname =~ /^error/);
6894: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 6895: if (!defined($course_server)) {
6896: if (defined(&domain($udom,'primary'))) {
6897: $course_server = &domain($udom,'primary');
6898: } else {
6899: $course_server = $env{'user.home'};
6900: }
6901: }
6902: my %host_servers =
6903: &Apache::lonnet::get_servers($udom,'library');
6904: unless ($host_servers{$course_server}) {
6905: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 6906: }
1.84 www 6907: # ------------------------------------------------------------- Make the course
6908: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 6909: $course_server);
1.84 www 6910: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 6911: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 6912: if (($uhome eq '') || ($uhome eq 'no_host')) {
6913: return 'error: no such course';
6914: }
1.271 www 6915: # ----------------------------------------------------------------- Course made
1.516 raeburn 6916: # log existence
1.1029 raeburn 6917: my $now = time;
1.918 raeburn 6918: my $newcourse = {
6919: $udom.'_'.$uname => {
1.921 raeburn 6920: description => $description,
6921: inst_code => $inst_code,
6922: owner => $course_owner,
6923: type => $crstype,
1.1029 raeburn 6924: creator => $env{'user.name'}.':'.
6925: $env{'user.domain'},
6926: created => $now,
6927: context => $context,
1.918 raeburn 6928: },
6929: };
1.921 raeburn 6930: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 6931: # set toplevel url
1.271 www 6932: my $topurl=$url;
6933: unless ($nonstandard) {
6934: # ------------------------------------------ For standard courses, make top url
6935: my $mapurl=&clutter($url);
1.278 www 6936: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 6937: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 6938: <map>
6939: <resource id="1" type="start"></resource>
6940: <resource id="2" src="$mapurl"></resource>
6941: <resource id="3" type="finish"></resource>
6942: <link index="1" from="1" to="2"></link>
6943: <link index="2" from="2" to="3"></link>
6944: </map>
6945: ENDINITMAP
6946: $topurl=&declutter(
1.638 albertel 6947: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 6948: );
6949: }
6950: # ----------------------------------------------------------- Write preferences
1.84 www 6951: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 6952: ('description' => $description,
6953: 'url' => $topurl,
6954: 'internal.creator' => $env{'user.name'}.':'.
6955: $env{'user.domain'},
6956: 'internal.created' => $now,
6957: 'internal.creationcontext' => $context)
6958: );
1.84 www 6959: return '/'.$udom.'/'.$uname;
6960: }
6961:
1.1011 raeburn 6962: # ------------------------------------------------------------------- Create ID
6963: sub generate_coursenum {
1.1038 raeburn 6964: my ($udom,$crstype) = @_;
1.1011 raeburn 6965: my $domdesc = &domain($udom);
6966: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 6967: my $first;
6968: if ($crstype eq 'Community') {
6969: $first = '0';
6970: } else {
6971: $first = int(1+rand(9));
6972: }
6973: my $uname=$first.
1.1011 raeburn 6974: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6975: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6976: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6977: # ----------------------------------------------- Make sure that does not exist
6978: my $uhome=&homeserver($uname,$udom,'true');
6979: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 6980: if ($crstype eq 'Community') {
6981: $first = '0';
6982: } else {
6983: $first = int(1+rand(9));
6984: }
6985: $uname=$first.
1.1011 raeburn 6986: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6987: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6988: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6989: $uhome=&homeserver($uname,$udom,'true');
6990: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6991: return 'error: unable to generate unique course-ID';
6992: }
6993: }
6994: return $uname;
6995: }
6996:
1.813 albertel 6997: sub is_course {
6998: my ($cdom,$cnum) = @_;
6999: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946 raeburn 7000: undef,'.');
1.813 albertel 7001: if (exists($courses{$cdom.'_'.$cnum})) {
7002: return 1;
7003: }
7004: return 0;
7005: }
7006:
1.1015 raeburn 7007: sub store_userdata {
7008: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 7009: my $result;
1.1016 raeburn 7010: if ($datakey ne '') {
1.1013 raeburn 7011: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 7012: if ($udom eq '' || $uname eq '') {
7013: $udom = $env{'user.domain'};
7014: $uname = $env{'user.name'};
7015: }
7016: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 7017: if (($uhome eq '') || ($uhome eq 'no_host')) {
7018: $result = 'error: no_host';
7019: } else {
7020: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
7021: $storehash->{'host'} = $perlvar{'lonHostID'};
7022:
7023: my $namevalue='';
7024: foreach my $key (keys(%{$storehash})) {
7025: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
7026: }
7027: $namevalue=~s/\&$//;
7028: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
1.1015 raeburn 7029: "$namespace:$datakey:$namevalue",$uhome);
1.1013 raeburn 7030: }
7031: } else {
7032: $result = 'error: data to store was not a hash reference';
7033: }
7034: } else {
7035: $result= 'error: invalid requestkey';
7036: }
7037: return $result;
7038: }
7039:
1.21 www 7040: # ---------------------------------------------------------- Assign Custom Role
7041:
7042: sub assigncustomrole {
1.957 raeburn 7043: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 7044: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 7045: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 7046: }
7047:
7048: # ----------------------------------------------------------------- Revoke Role
7049:
7050: sub revokerole {
1.957 raeburn 7051: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 7052: my $now=time;
1.965 raeburn 7053: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 7054: }
7055:
7056: # ---------------------------------------------------------- Revoke Custom Role
7057:
7058: sub revokecustomrole {
1.957 raeburn 7059: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 7060: my $now=time;
1.357 www 7061: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 7062: $deleteflag,$selfenroll,$context);
1.17 www 7063: }
7064:
1.533 banghart 7065: # ------------------------------------------------------------ Disk usage
1.535 albertel 7066: sub diskusage {
1.955 raeburn 7067: my ($udom,$uname,$directorypath,$getpropath)=@_;
7068: $directorypath =~ s/\/$//;
7069: my $listing=&reply('du2:'.&escape($directorypath).':'
7070: .&escape($getpropath).':'.&escape($uname).':'
7071: .&escape($udom),homeserver($uname,$udom));
7072: if ($listing eq 'unknown_cmd') {
7073: if ($getpropath) {
7074: $directorypath = &propath($udom,$uname).'/'.$directorypath;
7075: }
7076: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
7077: }
1.514 albertel 7078: return $listing;
1.512 banghart 7079: }
7080:
1.566 banghart 7081: sub is_locked {
7082: my ($file_name, $domain, $user) = @_;
7083: my @check;
7084: my $is_locked;
7085: push @check, $file_name;
1.613 albertel 7086: my %locked = &get('file_permissions',\@check,
1.620 albertel 7087: $env{'user.domain'},$env{'user.name'});
1.615 albertel 7088: my ($tmp)=keys(%locked);
7089: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 7090:
1.566 banghart 7091: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 7092: $is_locked = 'false';
7093: foreach my $entry (@{$locked{$file_name}}) {
7094: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 7095: $is_locked = 'true';
7096: last;
1.745 raeburn 7097: }
7098: }
1.566 banghart 7099: } else {
7100: $is_locked = 'false';
7101: }
7102: }
7103:
1.759 albertel 7104: sub declutter_portfile {
7105: my ($file) = @_;
1.833 albertel 7106: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 7107: return $file;
7108: }
7109:
1.559 banghart 7110: # ------------------------------------------------------------- Mark as Read Only
7111:
7112: sub mark_as_readonly {
7113: my ($domain,$user,$files,$what) = @_;
1.613 albertel 7114: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 7115: my ($tmp)=keys(%current_permissions);
7116: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 7117: foreach my $file (@{$files}) {
1.759 albertel 7118: $file = &declutter_portfile($file);
1.561 banghart 7119: push(@{$current_permissions{$file}},$what);
1.559 banghart 7120: }
1.613 albertel 7121: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7122: return;
7123: }
7124:
1.572 banghart 7125: # ------------------------------------------------------------Save Selected Files
7126:
7127: sub save_selected_files {
7128: my ($user, $path, @files) = @_;
7129: my $filename = $user."savedfiles";
1.573 banghart 7130: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 7131: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 7132: foreach my $file (@files) {
1.620 albertel 7133: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 7134: }
7135: foreach my $file (@other_files) {
1.574 banghart 7136: print (OUT $file."\n");
1.572 banghart 7137: }
1.574 banghart 7138: close (OUT);
1.572 banghart 7139: return 'ok';
7140: }
7141:
1.574 banghart 7142: sub clear_selected_files {
7143: my ($user) = @_;
7144: my $filename = $user."savedfiles";
7145: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7146: print (OUT undef);
7147: close (OUT);
7148: return ("ok");
7149: }
7150:
1.572 banghart 7151: sub files_in_path {
7152: my ($user, $path) = @_;
7153: my $filename = $user."savedfiles";
7154: my %return_files;
1.574 banghart 7155: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 7156: while (my $line_in = <IN>) {
1.574 banghart 7157: chomp ($line_in);
7158: my @paths_and_file = split (m!/!, $line_in);
7159: my $file_part = pop (@paths_and_file);
7160: my $path_part = join ('/', @paths_and_file);
1.573 banghart 7161: $path_part.='/';
7162: my $path_and_file = $path_part.$file_part;
7163: if ($path_part eq $path) {
7164: $return_files{$file_part}= 'selected';
7165: }
7166: }
1.574 banghart 7167: close (IN);
7168: return (\%return_files);
1.572 banghart 7169: }
7170:
7171: # called in portfolio select mode, to show files selected NOT in current directory
7172: sub files_not_in_path {
7173: my ($user, $path) = @_;
7174: my $filename = $user."savedfiles";
7175: my @return_files;
7176: my $path_part;
1.800 albertel 7177: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7178: while (my $line = <IN>) {
1.572 banghart 7179: #ok, I know it's clunky, but I want it to work
1.800 albertel 7180: my @paths_and_file = split(m|/|, $line);
7181: my $file_part = pop(@paths_and_file);
7182: chomp($file_part);
7183: my $path_part = join('/', @paths_and_file);
1.572 banghart 7184: $path_part .= '/';
7185: my $path_and_file = $path_part.$file_part;
7186: if ($path_part ne $path) {
1.800 albertel 7187: push(@return_files, ($path_and_file));
1.572 banghart 7188: }
7189: }
1.800 albertel 7190: close(OUT);
1.574 banghart 7191: return (@return_files);
1.572 banghart 7192: }
7193:
1.745 raeburn 7194: #----------------------------------------------Get portfolio file permissions
1.629 banghart 7195:
1.745 raeburn 7196: sub get_portfile_permissions {
7197: my ($domain,$user) = @_;
1.613 albertel 7198: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 7199: my ($tmp)=keys(%current_permissions);
7200: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7201: return \%current_permissions;
7202: }
7203:
7204: #---------------------------------------------Get portfolio file access controls
7205:
1.749 raeburn 7206: sub get_access_controls {
1.745 raeburn 7207: my ($current_permissions,$group,$file) = @_;
1.769 albertel 7208: my %access;
7209: my $real_file = $file;
7210: $file =~ s/\.meta$//;
1.745 raeburn 7211: if (defined($file)) {
1.749 raeburn 7212: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7213: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 7214: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 7215: }
7216: }
1.745 raeburn 7217: } else {
1.749 raeburn 7218: foreach my $key (keys(%{$current_permissions})) {
7219: if ($key =~ /\0accesscontrol$/) {
7220: if (defined($group)) {
7221: if ($key !~ m-^\Q$group\E/-) {
7222: next;
7223: }
7224: }
7225: my ($fullpath) = split(/\0/,$key);
7226: if (ref($$current_permissions{$key}) eq 'HASH') {
7227: foreach my $control (keys(%{$$current_permissions{$key}})) {
7228: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7229: }
7230: }
7231: }
7232: }
7233: }
7234: return %access;
7235: }
7236:
7237: sub modify_access_controls {
7238: my ($file_name,$changes,$domain,$user)=@_;
7239: my ($outcome,$deloutcome);
7240: my %store_permissions;
7241: my %new_values;
7242: my %new_control;
7243: my %translation;
7244: my @deletions = ();
7245: my $now = time;
7246: if (exists($$changes{'activate'})) {
7247: if (ref($$changes{'activate'}) eq 'HASH') {
7248: my @newitems = sort(keys(%{$$changes{'activate'}}));
7249: my $numnew = scalar(@newitems);
7250: for (my $i=0; $i<$numnew; $i++) {
7251: my $newkey = $newitems[$i];
7252: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 7253: if ($newkey =~ /^\d+:/) {
7254: $newkey =~ s/^(\d+)/$newid/;
7255: $translation{$1} = $newid;
7256: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7257: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7258: $translation{$1} = $newid;
7259: }
1.749 raeburn 7260: $new_values{$file_name."\0".$newkey} =
7261: $$changes{'activate'}{$newitems[$i]};
7262: $new_control{$newkey} = $now;
7263: }
7264: }
7265: }
7266: my %todelete;
7267: my %changed_items;
7268: foreach my $action ('delete','update') {
7269: if (exists($$changes{$action})) {
7270: if (ref($$changes{$action}) eq 'HASH') {
7271: foreach my $key (keys(%{$$changes{$action}})) {
7272: my ($itemnum) = ($key =~ /^([^:]+):/);
7273: if ($action eq 'delete') {
7274: $todelete{$itemnum} = 1;
7275: } else {
7276: $changed_items{$itemnum} = $key;
7277: }
7278: }
1.745 raeburn 7279: }
7280: }
1.749 raeburn 7281: }
7282: # get lock on access controls for file.
7283: my $lockhash = {
7284: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7285: ':'.$env{'user.domain'},
7286: };
7287: my $tries = 0;
7288: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7289:
7290: while (($gotlock ne 'ok') && $tries <3) {
7291: $tries ++;
7292: sleep 1;
7293: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7294: }
7295: if ($gotlock eq 'ok') {
7296: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7297: my ($tmp)=keys(%curr_permissions);
7298: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7299: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7300: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7301: if (ref($curr_controls) eq 'HASH') {
7302: foreach my $control_item (keys(%{$curr_controls})) {
7303: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7304: if (defined($todelete{$itemnum})) {
7305: push(@deletions,$file_name."\0".$control_item);
7306: } else {
7307: if (defined($changed_items{$itemnum})) {
7308: $new_control{$changed_items{$itemnum}} = $now;
7309: push(@deletions,$file_name."\0".$control_item);
7310: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7311: } else {
7312: $new_control{$control_item} = $$curr_controls{$control_item};
7313: }
7314: }
1.745 raeburn 7315: }
7316: }
7317: }
1.970 raeburn 7318: my ($group);
7319: if (&is_course($domain,$user)) {
7320: ($group,my $file) = split(/\//,$file_name,2);
7321: }
1.749 raeburn 7322: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7323: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7324: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7325: # remove lock
7326: my @del_lock = ($file_name."\0".'locked_access_records');
7327: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 7328: my $sqlresult =
1.970 raeburn 7329: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 7330: $group);
1.749 raeburn 7331: } else {
7332: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 7333: }
1.749 raeburn 7334: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 7335: }
7336:
1.827 raeburn 7337: sub make_public_indefinitely {
7338: my ($requrl) = @_;
7339: my $now = time;
7340: my $action = 'activate';
7341: my $aclnum = 0;
7342: if (&is_portfolio_url($requrl)) {
7343: my (undef,$udom,$unum,$file_name,$group) =
7344: &parse_portfolio_url($requrl);
7345: my $current_perms = &get_portfile_permissions($udom,$unum);
7346: my %access_controls = &get_access_controls($current_perms,
7347: $group,$file_name);
7348: foreach my $key (keys(%{$access_controls{$file_name}})) {
7349: my ($num,$scope,$end,$start) =
7350: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7351: if ($scope eq 'public') {
7352: if ($start <= $now && $end == 0) {
7353: $action = 'none';
7354: } else {
7355: $action = 'update';
7356: $aclnum = $num;
7357: }
7358: last;
7359: }
7360: }
7361: if ($action eq 'none') {
7362: return 'ok';
7363: } else {
7364: my %changes;
7365: my $newend = 0;
7366: my $newstart = $now;
7367: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7368: $changes{$action}{$newkey} = {
7369: type => 'public',
7370: time => {
7371: start => $newstart,
7372: end => $newend,
7373: },
7374: };
7375: my ($outcome,$deloutcome,$new_values,$translation) =
7376: &modify_access_controls($file_name,\%changes,$udom,$unum);
7377: return $outcome;
7378: }
7379: } else {
7380: return 'invalid';
7381: }
7382: }
7383:
1.745 raeburn 7384: #------------------------------------------------------Get Marked as Read Only
7385:
7386: sub get_marked_as_readonly {
7387: my ($domain,$user,$what,$group) = @_;
7388: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 7389: my @readonly_files;
1.629 banghart 7390: my $cmp1=$what;
7391: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 7392: while (my ($file_name,$value) = each(%{$current_permissions})) {
7393: if (defined($group)) {
7394: if ($file_name !~ m-^\Q$group\E/-) {
7395: next;
7396: }
7397: }
1.561 banghart 7398: if (ref($value) eq "ARRAY"){
7399: foreach my $stored_what (@{$value}) {
1.629 banghart 7400: my $cmp2=$stored_what;
1.759 albertel 7401: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 7402: $cmp2=join('',@{$stored_what});
1.745 raeburn 7403: }
1.629 banghart 7404: if ($cmp1 eq $cmp2) {
1.561 banghart 7405: push(@readonly_files, $file_name);
1.745 raeburn 7406: last;
1.563 banghart 7407: } elsif (!defined($what)) {
7408: push(@readonly_files, $file_name);
1.745 raeburn 7409: last;
1.561 banghart 7410: }
7411: }
1.745 raeburn 7412: }
1.561 banghart 7413: }
7414: return @readonly_files;
7415: }
1.577 banghart 7416: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 7417:
1.577 banghart 7418: sub get_marked_as_readonly_hash {
1.745 raeburn 7419: my ($current_permissions,$group,$what) = @_;
1.577 banghart 7420: my %readonly_files;
1.745 raeburn 7421: while (my ($file_name,$value) = each(%{$current_permissions})) {
7422: if (defined($group)) {
7423: if ($file_name !~ m-^\Q$group\E/-) {
7424: next;
7425: }
7426: }
1.577 banghart 7427: if (ref($value) eq "ARRAY"){
7428: foreach my $stored_what (@{$value}) {
1.745 raeburn 7429: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 7430: foreach my $lock_descriptor(@{$stored_what}) {
7431: if ($lock_descriptor eq 'graded') {
7432: $readonly_files{$file_name} = 'graded';
7433: } elsif ($lock_descriptor eq 'handback') {
7434: $readonly_files{$file_name} = 'handback';
7435: } else {
7436: if (!exists($readonly_files{$file_name})) {
7437: $readonly_files{$file_name} = 'locked';
7438: }
7439: }
1.745 raeburn 7440: }
1.750 banghart 7441: }
1.577 banghart 7442: }
7443: }
7444: }
7445: return %readonly_files;
7446: }
1.559 banghart 7447: # ------------------------------------------------------------ Unmark as Read Only
7448:
7449: sub unmark_as_readonly {
1.629 banghart 7450: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7451: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 7452: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 7453: $file_name = &declutter_portfile($file_name);
1.634 albertel 7454: my $symb_crs = $what;
7455: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 7456: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 7457: my ($tmp)=keys(%current_permissions);
7458: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7459: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 7460: foreach my $file (@readonly_files) {
1.759 albertel 7461: my $clean_file = &declutter_portfile($file);
7462: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 7463: my $current_locks = $current_permissions{$file};
1.563 banghart 7464: my @new_locks;
7465: my @del_keys;
7466: if (ref($current_locks) eq "ARRAY"){
7467: foreach my $locker (@{$current_locks}) {
1.632 albertel 7468: my $compare=$locker;
1.749 raeburn 7469: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 7470: $compare=join('',@{$locker});
1.746 raeburn 7471: if ($compare ne $symb_crs) {
7472: push(@new_locks, $locker);
7473: }
1.563 banghart 7474: }
7475: }
1.650 albertel 7476: if (scalar(@new_locks) > 0) {
1.563 banghart 7477: $current_permissions{$file} = \@new_locks;
7478: } else {
7479: push(@del_keys, $file);
1.613 albertel 7480: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 7481: delete($current_permissions{$file});
1.563 banghart 7482: }
7483: }
1.561 banghart 7484: }
1.613 albertel 7485: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7486: return;
7487: }
1.512 banghart 7488:
1.17 www 7489: # ------------------------------------------------------------ Directory lister
7490:
7491: sub dirlist {
1.955 raeburn 7492: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 7493: $uri=~s/^\///;
7494: $uri=~s/\/$//;
1.253 stredwic 7495: my ($udom, $uname);
1.955 raeburn 7496: if ($getuserdir) {
1.253 stredwic 7497: $udom = $userdomain;
7498: $uname = $username;
1.955 raeburn 7499: } else {
7500: (undef,$udom,$uname)=split(/\//,$uri);
7501: if(defined($userdomain)) {
7502: $udom = $userdomain;
7503: }
7504: if(defined($username)) {
7505: $uname = $username;
7506: }
1.253 stredwic 7507: }
1.955 raeburn 7508: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 7509:
1.955 raeburn 7510: $dirRoot = $perlvar{'lonDocRoot'};
7511: if (defined($getpropath)) {
7512: $dirRoot = &propath($udom,$uname);
1.253 stredwic 7513: $dirRoot =~ s/\/$//;
1.955 raeburn 7514: } elsif (defined($getuserdir)) {
7515: my $subdir=$uname.'__';
7516: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7517: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7518: ."/$udom/$subdir/$uname";
7519: } elsif (defined($alternateRoot)) {
7520: $dirRoot = $alternateRoot;
1.751 banghart 7521: }
1.253 stredwic 7522:
7523: if($udom) {
7524: if($uname) {
1.955 raeburn 7525: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 7526: .$getuserdir.':'.&escape($dirRoot)
1.955 raeburn 7527: .':'.&escape($uname).':'.&escape($udom),
7528: &homeserver($uname,$udom));
7529: if ($listing eq 'unknown_cmd') {
7530: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7531: &homeserver($uname,$udom));
7532: } else {
7533: @listing_results = map { &unescape($_); } split(/:/,$listing);
7534: }
1.605 matthew 7535: if ($listing eq 'unknown_cmd') {
1.800 albertel 7536: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7537: &homeserver($uname,$udom));
1.605 matthew 7538: @listing_results = split(/:/,$listing);
7539: } else {
7540: @listing_results = map { &unescape($_); } split(/:/,$listing);
7541: }
7542: return @listing_results;
1.955 raeburn 7543: } elsif(!$alternateRoot) {
1.800 albertel 7544: my %allusers;
1.841 albertel 7545: my %servers = &get_servers($udom,'library');
1.955 raeburn 7546: foreach my $tryserver (keys(%servers)) {
7547: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7548: &escape($udom),$tryserver);
7549: if ($listing eq 'unknown_cmd') {
7550: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7551: $udom, $tryserver);
7552: } else {
7553: @listing_results = map { &unescape($_); } split(/:/,$listing);
7554: }
1.841 albertel 7555: if ($listing eq 'unknown_cmd') {
7556: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7557: $udom, $tryserver);
7558: @listing_results = split(/:/,$listing);
7559: } else {
7560: @listing_results =
7561: map { &unescape($_); } split(/:/,$listing);
7562: }
7563: if ($listing_results[0] ne 'no_such_dir' &&
7564: $listing_results[0] ne 'empty' &&
7565: $listing_results[0] ne 'con_lost') {
7566: foreach my $line (@listing_results) {
7567: my ($entry) = split(/&/,$line,2);
7568: $allusers{$entry} = 1;
7569: }
7570: }
1.253 stredwic 7571: }
7572: my $alluserstr='';
1.800 albertel 7573: foreach my $user (sort(keys(%allusers))) {
7574: $alluserstr.=$user.'&user:';
1.253 stredwic 7575: }
7576: $alluserstr=~s/:$//;
7577: return split(/:/,$alluserstr);
7578: } else {
1.800 albertel 7579: return ('missing user name');
1.253 stredwic 7580: }
1.955 raeburn 7581: } elsif(!defined($getpropath)) {
1.841 albertel 7582: my @all_domains = sort(&all_domains());
1.955 raeburn 7583: foreach my $domain (@all_domains) {
7584: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7585: }
7586: return @all_domains;
7587: } else {
1.800 albertel 7588: return ('missing domain');
1.275 stredwic 7589: }
7590: }
7591:
7592: # --------------------------------------------- GetFileTimestamp
7593: # This function utilizes dirlist and returns the date stamp for
7594: # when it was last modified. It will also return an error of -1
7595: # if an error occurs
7596:
7597: sub GetFileTimestamp {
1.955 raeburn 7598: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 7599: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7600: $studentName = &LONCAPA::clean_username($studentName);
1.955 raeburn 7601: my ($fileStat) =
7602: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7603: undef,$getuserdir);
1.275 stredwic 7604: my @stats = split('&', $fileStat);
7605: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 7606: # @stats contains first the filename, then the stat output
7607: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 7608: } else {
7609: return -1;
1.253 stredwic 7610: }
1.26 www 7611: }
7612:
1.712 albertel 7613: sub stat_file {
7614: my ($uri) = @_;
1.787 albertel 7615: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 7616:
1.955 raeburn 7617: my ($udom,$uname,$file);
1.712 albertel 7618: if ($uri =~ m-^/(uploaded|editupload)/-) {
7619: ($udom,$uname,$file) =
1.811 albertel 7620: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 7621: $file = 'userfiles/'.$file;
7622: }
7623: if ($uri =~ m-^/res/-) {
7624: ($udom,$uname) =
1.807 albertel 7625: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 7626: $file = $uri;
7627: }
7628:
7629: if (!$udom || !$uname || !$file) {
7630: # unable to handle the uri
7631: return ();
7632: }
1.956 raeburn 7633: my $getpropath;
7634: if ($file =~ /^userfiles\//) {
7635: $getpropath = 1;
7636: }
1.955 raeburn 7637: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712 albertel 7638: my @stats = split('&', $result);
1.721 banghart 7639:
1.712 albertel 7640: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7641: shift(@stats); #filename is first
7642: return @stats;
7643: }
7644: return ();
7645: }
7646:
1.26 www 7647: # -------------------------------------------------------- Value of a Condition
7648:
1.713 albertel 7649: # gets the value of a specific preevaluated condition
7650: # stored in the string $env{user.state.<cid>}
7651: # or looks up a condition reference in the bighash and if if hasn't
7652: # already been evaluated recurses into docondval to get the value of
7653: # the condition, then memoizing it to
7654: # $env{user.state.<cid>.<condition>}
1.40 www 7655: sub directcondval {
7656: my $number=shift;
1.620 albertel 7657: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 7658: &Apache::lonuserstate::evalstate();
7659: }
1.713 albertel 7660: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7661: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7662: } elsif ($number =~ /^_/) {
7663: my $sub_condition;
7664: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7665: &GDBM_READER(),0640)) {
7666: $sub_condition=$bighash{'conditions'.$number};
7667: untie(%bighash);
7668: }
7669: my $value = &docondval($sub_condition);
1.949 raeburn 7670: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 7671: return $value;
7672: }
1.620 albertel 7673: if ($env{'user.state.'.$env{'request.course.id'}}) {
7674: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 7675: } else {
7676: return 2;
7677: }
7678: }
7679:
1.713 albertel 7680: # get the collection of conditions for this resource
1.26 www 7681: sub condval {
7682: my $condidx=shift;
1.54 www 7683: my $allpathcond='';
1.713 albertel 7684: foreach my $cond (split(/\|/,$condidx)) {
7685: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7686: $allpathcond.=
7687: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7688: }
1.191 harris41 7689: }
1.54 www 7690: $allpathcond=~s/\|$//;
1.713 albertel 7691: return &docondval($allpathcond);
7692: }
7693:
7694: #evaluates an expression of conditions
7695: sub docondval {
7696: my ($allpathcond) = @_;
7697: my $result=0;
7698: if ($env{'request.course.id'}
7699: && defined($allpathcond)) {
7700: my $operand='|';
7701: my @stack;
7702: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7703: if ($chunk eq '(') {
7704: push @stack,($operand,$result);
7705: } elsif ($chunk eq ')') {
7706: my $before=pop @stack;
7707: if (pop @stack eq '&') {
7708: $result=$result>$before?$before:$result;
7709: } else {
7710: $result=$result>$before?$result:$before;
7711: }
7712: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7713: $operand=$chunk;
7714: } else {
7715: my $new=directcondval($chunk);
7716: if ($operand eq '&') {
7717: $result=$result>$new?$new:$result;
7718: } else {
7719: $result=$result>$new?$result:$new;
7720: }
7721: }
7722: }
1.26 www 7723: }
7724: return $result;
1.421 albertel 7725: }
7726:
7727: # ---------------------------------------------------- Devalidate courseresdata
7728:
7729: sub devalidatecourseresdata {
7730: my ($coursenum,$coursedomain)=@_;
7731: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7732: &devalidate_cache_new('courseres',$hashid);
1.28 www 7733: }
7734:
1.763 www 7735:
1.200 www 7736: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 7737: #
7738: # Parameters:
7739: # $coursenum - Number of the course.
7740: # $coursedomain - Domain at which the course was created.
7741: # Returns:
7742: # A hash of the course parameters along (I think) with timestamps
7743: # and version info.
1.877 foxr 7744:
1.624 albertel 7745: sub get_courseresdata {
7746: my ($coursenum,$coursedomain)=@_;
1.200 www 7747: my $coursehom=&homeserver($coursenum,$coursedomain);
7748: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7749: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 7750: my %dumpreply;
1.417 albertel 7751: unless (defined($cached)) {
1.624 albertel 7752: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 7753: $result=\%dumpreply;
1.251 albertel 7754: my ($tmp) = keys(%dumpreply);
7755: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 7756: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 7757: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7758: return $tmp;
1.416 albertel 7759: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 7760: $result=undef;
1.599 albertel 7761: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 7762: }
7763: }
1.624 albertel 7764: return $result;
7765: }
7766:
1.633 albertel 7767: sub devalidateuserresdata {
7768: my ($uname,$udom)=@_;
7769: my $hashid="$udom:$uname";
7770: &devalidate_cache_new('userres',$hashid);
7771: }
7772:
1.624 albertel 7773: sub get_userresdata {
7774: my ($uname,$udom)=@_;
7775: #most student don\'t have any data set, check if there is some data
7776: if (&EXT_cache_status($udom,$uname)) { return undef; }
7777:
7778: my $hashid="$udom:$uname";
7779: my ($result,$cached)=&is_cached_new('userres',$hashid);
7780: if (!defined($cached)) {
7781: my %resourcedata=&dump('resourcedata',$udom,$uname);
7782: $result=\%resourcedata;
7783: &do_cache_new('userres',$hashid,$result,600);
7784: }
7785: my ($tmp)=keys(%$result);
7786: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7787: return $result;
7788: }
7789: #error 2 occurs when the .db doesn't exist
7790: if ($tmp!~/error: 2 /) {
1.672 albertel 7791: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 7792: " Trying to get resource data for ".
7793: $uname." at ".$udom.": ".
7794: $tmp."</font>");
7795: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 7796: #&EXT_cache_set($udom,$uname);
7797: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 7798: undef($tmp); # not really an error so don't send it back
1.624 albertel 7799: }
7800: return $tmp;
7801: }
1.879 foxr 7802: #----------------------------------------------- resdata - return resource data
7803: # Purpose:
7804: # Return resource data for either users or for a course.
7805: # Parameters:
7806: # $name - Course/user name.
7807: # $domain - Name of the domain the user/course is registered on.
7808: # $type - Type of thing $name is (must be 'course' or 'user'
7809: # @which - Array of names of resources desired.
7810: # Returns:
7811: # The value of the first reasource in @which that is found in the
7812: # resource hash.
7813: # Exceptional Conditions:
7814: # If the $type passed in is not valid (not the string 'course' or
7815: # 'user', an undefined reference is returned.
7816: # If none of the resources are found, an undef is returned
1.624 albertel 7817: sub resdata {
7818: my ($name,$domain,$type,@which)=@_;
7819: my $result;
7820: if ($type eq 'course') {
7821: $result=&get_courseresdata($name,$domain);
7822: } elsif ($type eq 'user') {
7823: $result=&get_userresdata($name,$domain);
7824: }
7825: if (!ref($result)) { return $result; }
1.251 albertel 7826: foreach my $item (@which) {
1.927 albertel 7827: if (defined($result->{$item->[0]})) {
7828: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 7829: }
1.250 albertel 7830: }
1.291 albertel 7831: return undef;
1.200 www 7832: }
7833:
1.379 matthew 7834: #
7835: # EXT resource caching routines
7836: #
7837:
7838: sub clear_EXT_cache_status {
1.383 albertel 7839: &delenv('cache.EXT.');
1.379 matthew 7840: }
7841:
7842: sub EXT_cache_status {
7843: my ($target_domain,$target_user) = @_;
1.383 albertel 7844: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 7845: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 7846: # We know already the user has no data
7847: return 1;
7848: } else {
7849: return 0;
7850: }
7851: }
7852:
7853: sub EXT_cache_set {
7854: my ($target_domain,$target_user) = @_;
1.383 albertel 7855: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 7856: #&appenv({$cachename => time});
1.379 matthew 7857: }
7858:
1.28 www 7859: # --------------------------------------------------------- Value of a Variable
1.58 www 7860: sub EXT {
1.715 albertel 7861:
1.395 albertel 7862: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 7863: unless ($varname) { return ''; }
1.218 albertel 7864: #get real user name/domain, courseid and symb
7865: my $courseid;
1.359 albertel 7866: my $publicuser;
1.427 www 7867: if ($symbparm) {
7868: $symbparm=&get_symb_from_alias($symbparm);
7869: }
1.218 albertel 7870: if (!($uname && $udom)) {
1.790 albertel 7871: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 7872: if (!$symbparm) { $symbparm=$cursymb; }
7873: } else {
1.620 albertel 7874: $courseid=$env{'request.course.id'};
1.218 albertel 7875: }
1.48 www 7876: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7877: my $rest;
1.320 albertel 7878: if (defined($therest[0])) {
1.48 www 7879: $rest=join('.',@therest);
7880: } else {
7881: $rest='';
7882: }
1.320 albertel 7883:
1.57 www 7884: my $qualifierrest=$qualifier;
7885: if ($rest) { $qualifierrest.='.'.$rest; }
7886: my $spacequalifierrest=$space;
7887: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 7888: if ($realm eq 'user') {
1.48 www 7889: # --------------------------------------------------------------- user.resource
7890: if ($space eq 'resource') {
1.651 albertel 7891: if ( (defined($Apache::lonhomework::parsing_a_problem)
7892: || defined($Apache::lonhomework::parsing_a_task))
7893: &&
1.744 albertel 7894: ($symbparm eq &symbread()) ) {
7895: # if we are in the middle of processing the resource the
7896: # get the value we are planning on committing
7897: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7898: return $Apache::lonhomework::results{$qualifierrest};
7899: } else {
7900: return $Apache::lonhomework::history{$qualifierrest};
7901: }
1.335 albertel 7902: } else {
1.359 albertel 7903: my %restored;
1.620 albertel 7904: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 7905: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7906: } else {
7907: %restored=&restore($symbparm,$courseid,$udom,$uname);
7908: }
1.335 albertel 7909: return $restored{$qualifierrest};
7910: }
1.48 www 7911: # ----------------------------------------------------------------- user.access
7912: } elsif ($space eq 'access') {
1.218 albertel 7913: # FIXME - not supporting calls for a specific user
1.48 www 7914: return &allowed($qualifier,$rest);
7915: # ------------------------------------------ user.preferences, user.environment
7916: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 7917: if (($uname eq $env{'user.name'}) &&
7918: ($udom eq $env{'user.domain'})) {
7919: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 7920: } else {
1.359 albertel 7921: my %returnhash;
7922: if (!$publicuser) {
7923: %returnhash=&userenvironment($udom,$uname,
7924: $qualifierrest);
7925: }
1.218 albertel 7926: return $returnhash{$qualifierrest};
7927: }
1.48 www 7928: # ----------------------------------------------------------------- user.course
7929: } elsif ($space eq 'course') {
1.218 albertel 7930: # FIXME - not supporting calls for a specific user
1.620 albertel 7931: return $env{join('.',('request.course',$qualifier))};
1.48 www 7932: # ------------------------------------------------------------------- user.role
7933: } elsif ($space eq 'role') {
1.218 albertel 7934: # FIXME - not supporting calls for a specific user
1.620 albertel 7935: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 7936: if ($qualifier eq 'value') {
7937: return $role;
7938: } elsif ($qualifier eq 'extent') {
7939: return $where;
7940: }
7941: # ----------------------------------------------------------------- user.domain
7942: } elsif ($space eq 'domain') {
1.218 albertel 7943: return $udom;
1.48 www 7944: # ------------------------------------------------------------------- user.name
7945: } elsif ($space eq 'name') {
1.218 albertel 7946: return $uname;
1.48 www 7947: # ---------------------------------------------------- Any other user namespace
1.29 www 7948: } else {
1.359 albertel 7949: my %reply;
7950: if (!$publicuser) {
7951: %reply=&get($space,[$qualifierrest],$udom,$uname);
7952: }
7953: return $reply{$qualifierrest};
1.48 www 7954: }
1.236 www 7955: } elsif ($realm eq 'query') {
7956: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 7957: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7958: [$spacequalifierrest]);
1.620 albertel 7959: return $env{'form.'.$spacequalifierrest};
1.236 www 7960: } elsif ($realm eq 'request') {
1.48 www 7961: # ------------------------------------------------------------- request.browser
7962: if ($space eq 'browser') {
1.430 www 7963: if ($qualifier eq 'textremote') {
1.676 albertel 7964: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 7965: return 1;
7966: } else {
7967: return 0;
7968: }
7969: } else {
1.620 albertel 7970: return $env{'browser.'.$qualifier};
1.430 www 7971: }
1.57 www 7972: # ------------------------------------------------------------ request.filename
7973: } else {
1.620 albertel 7974: return $env{'request.'.$spacequalifierrest};
1.29 www 7975: }
1.28 www 7976: } elsif ($realm eq 'course') {
1.48 www 7977: # ---------------------------------------------------------- course.description
1.620 albertel 7978: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 7979: } elsif ($realm eq 'resource') {
1.165 www 7980:
1.620 albertel 7981: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 7982: if (!$symbparm) { $symbparm=&symbread(); }
7983: }
1.693 albertel 7984:
7985: if ($space eq 'title') {
7986: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7987: return &gettitle($symbparm);
7988: }
7989:
7990: if ($space eq 'map') {
7991: my ($map) = &decode_symb($symbparm);
7992: return &symbread($map);
7993: }
1.905 albertel 7994: if ($space eq 'filename') {
7995: if ($symbparm) {
7996: return &clutter((&decode_symb($symbparm))[2]);
7997: }
7998: return &hreflocation('',$env{'request.filename'});
7999: }
1.693 albertel 8000:
8001: my ($section, $group, @groups);
1.593 albertel 8002: my ($courselevelm,$courselevel);
1.539 albertel 8003: if ($symbparm && defined($courseid) &&
1.620 albertel 8004: $courseid eq $env{'request.course.id'}) {
1.165 www 8005:
1.218 albertel 8006: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 8007:
1.60 www 8008: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 8009: my $symbp=$symbparm;
1.735 albertel 8010: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 8011:
8012: my $symbparm=$symbp.'.'.$spacequalifierrest;
8013: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
8014:
1.620 albertel 8015: if (($env{'user.name'} eq $uname) &&
8016: ($env{'user.domain'} eq $udom)) {
8017: $section=$env{'request.course.sec'};
1.733 raeburn 8018: @groups = split(/:/,$env{'request.course.groups'});
8019: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 8020: } else {
1.539 albertel 8021: if (! defined($usection)) {
1.551 albertel 8022: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 8023: } else {
8024: $section = $usection;
8025: }
1.733 raeburn 8026: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 8027: }
8028:
8029: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
8030: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
8031: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
8032:
1.593 albertel 8033: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 8034: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 8035: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 8036:
1.60 www 8037: # ----------------------------------------------------------- first, check user
1.624 albertel 8038:
8039: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 8040: ([$courselevelr,'resource'],
8041: [$courselevelm,'map' ],
8042: [$courselevel, 'course' ]));
1.931 albertel 8043: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 8044:
1.594 albertel 8045: # ------------------------------------------------ second, check some of course
1.684 raeburn 8046: my $coursereply;
1.691 raeburn 8047: if (@groups > 0) {
8048: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
8049: $mapparm,$spacequalifierrest);
1.927 albertel 8050: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 8051: }
1.96 www 8052:
1.684 raeburn 8053: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 8054: $env{'course.'.$courseid.'.domain'},
8055: 'course',
8056: ([$seclevelr, 'resource'],
8057: [$seclevelm, 'map' ],
8058: [$seclevel, 'course' ],
8059: [$courselevelr,'resource']));
8060: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 8061:
1.60 www 8062: # ------------------------------------------------------ third, check map parms
1.218 albertel 8063: my %parmhash=();
8064: my $thisparm='';
8065: if (tie(%parmhash,'GDBM_File',
1.620 albertel 8066: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 8067: &GDBM_READER(),0640)) {
1.218 albertel 8068: $thisparm=$parmhash{$symbparm};
8069: untie(%parmhash);
8070: }
1.927 albertel 8071: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 8072: }
1.594 albertel 8073: # ------------------------------------------ fourth, look in resource metadata
1.71 www 8074:
1.218 albertel 8075: $spacequalifierrest=~s/\./\_/;
1.282 albertel 8076: my $filename;
8077: if (!$symbparm) { $symbparm=&symbread(); }
8078: if ($symbparm) {
1.409 www 8079: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 8080: } else {
1.620 albertel 8081: $filename=$env{'request.filename'};
1.282 albertel 8082: }
8083: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 8084: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 8085: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 8086: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 8087:
1.927 albertel 8088: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 8089: if ($symbparm && defined($courseid) &&
1.620 albertel 8090: $courseid eq $env{'request.course.id'}) {
1.624 albertel 8091: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8092: $env{'course.'.$courseid.'.domain'},
8093: 'course',
1.927 albertel 8094: ([$courselevelm,'map' ],
8095: [$courselevel, 'course']));
8096: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 8097: }
1.145 www 8098: # ------------------------------------------------------------------ Cascade up
1.218 albertel 8099: unless ($space eq '0') {
1.336 albertel 8100: my @parts=split(/_/,$space);
8101: my $id=pop(@parts);
8102: my $part=join('_',@parts);
8103: if ($part eq '') { $part='0'; }
1.927 albertel 8104: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 8105: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 8106: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 8107: }
1.395 albertel 8108: if ($recurse) { return undef; }
8109: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 8110: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 8111: # ---------------------------------------------------- Any other user namespace
8112: } elsif ($realm eq 'environment') {
8113: # ----------------------------------------------------------------- environment
1.620 albertel 8114: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
8115: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 8116: } else {
1.770 albertel 8117: if ($uname eq 'anonymous' && $udom eq '') {
8118: return '';
8119: }
1.219 albertel 8120: my %returnhash=&userenvironment($udom,$uname,
8121: $spacequalifierrest);
8122: return $returnhash{$spacequalifierrest};
8123: }
1.28 www 8124: } elsif ($realm eq 'system') {
1.48 www 8125: # ----------------------------------------------------------------- system.time
8126: if ($space eq 'time') {
8127: return time;
8128: }
1.696 albertel 8129: } elsif ($realm eq 'server') {
8130: # ----------------------------------------------------------------- system.time
8131: if ($space eq 'name') {
8132: return $ENV{'SERVER_NAME'};
8133: }
1.28 www 8134: }
1.48 www 8135: return '';
1.61 www 8136: }
8137:
1.927 albertel 8138: sub get_reply {
8139: my ($reply_value) = @_;
1.940 raeburn 8140: if (ref($reply_value) eq 'ARRAY') {
8141: if (wantarray) {
8142: return @$reply_value;
8143: }
8144: return $reply_value->[0];
8145: } else {
8146: return $reply_value;
1.927 albertel 8147: }
8148: }
8149:
1.691 raeburn 8150: sub check_group_parms {
8151: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8152: my @groupitems = ();
8153: my $resultitem;
1.927 albertel 8154: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 8155: foreach my $group (@{$groups}) {
8156: foreach my $level (@levels) {
1.927 albertel 8157: my $item = $courseid.'.['.$group.'].'.$level->[0];
8158: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 8159: }
8160: }
8161: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8162: $env{'course.'.$courseid.'.domain'},
8163: 'course',@groupitems);
8164: return $coursereply;
8165: }
8166:
8167: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 8168: my ($courseid,@groups) = @_;
8169: @groups = sort(@groups);
1.691 raeburn 8170: return @groups;
8171: }
8172:
1.395 albertel 8173: sub packages_tab_default {
8174: my ($uri,$varname)=@_;
8175: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 8176:
8177: my (@extension,@specifics,$do_default);
8178: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 8179: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 8180: if ($pack_type eq 'default') {
8181: $do_default=1;
8182: } elsif ($pack_type eq 'extension') {
8183: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 8184: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 8185: # only look at packages defaults for packages that this id is
1.738 albertel 8186: push(@specifics,[$package,$pack_type,$pack_part]);
8187: }
8188: }
8189: # first look for a package that matches the requested part id
8190: foreach my $package (@specifics) {
8191: my (undef,$pack_type,$pack_part)=@{$package};
8192: next if ($pack_part ne $part);
8193: if (defined($packagetab{"$pack_type&$name&default"})) {
8194: return $packagetab{"$pack_type&$name&default"};
8195: }
8196: }
8197: # look for any possible matching non extension_ package
8198: foreach my $package (@specifics) {
8199: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 8200: if (defined($packagetab{"$pack_type&$name&default"})) {
8201: return $packagetab{"$pack_type&$name&default"};
8202: }
1.585 albertel 8203: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 8204: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8205: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 8206: }
8207: }
1.738 albertel 8208: # look for any posible extension_ match
8209: foreach my $package (@extension) {
8210: my ($package,$pack_type)=@{$package};
8211: if (defined($packagetab{"$pack_type&$name&default"})) {
8212: return $packagetab{"$pack_type&$name&default"};
8213: }
8214: if (defined($packagetab{$package."&$name&default"})) {
8215: return $packagetab{$package."&$name&default"};
8216: }
8217: }
8218: # look for a global default setting
8219: if ($do_default && defined($packagetab{"default&$name&default"})) {
8220: return $packagetab{"default&$name&default"};
8221: }
1.395 albertel 8222: return undef;
8223: }
8224:
1.334 albertel 8225: sub add_prefix_and_part {
8226: my ($prefix,$part)=@_;
8227: my $keyroot;
8228: if (defined($prefix) && $prefix !~ /^__/) {
8229: # prefix that has a part already
8230: $keyroot=$prefix;
8231: } elsif (defined($prefix)) {
8232: # prefix that is missing a part
8233: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8234: } else {
8235: # no prefix at all
8236: if (defined($part)) { $keyroot='_'.$part; }
8237: }
8238: return $keyroot;
8239: }
8240:
1.71 www 8241: # ---------------------------------------------------------------- Get metadata
8242:
1.599 albertel 8243: my %metaentry;
1.71 www 8244: sub metadata {
1.176 www 8245: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 8246: $uri=&declutter($uri);
1.288 albertel 8247: # if it is a non metadata possible uri return quickly
1.529 albertel 8248: if (($uri eq '') ||
8249: (($uri =~ m|^/*adm/|) &&
1.698 albertel 8250: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 albertel 8251: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8252: return undef;
8253: }
8254: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8255: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 8256: return undef;
1.288 albertel 8257: }
1.73 www 8258: my $filename=$uri;
8259: $uri=~s/\.meta$//;
1.172 www 8260: #
8261: # Is the metadata already cached?
1.177 www 8262: # Look at timestamp of caching
1.172 www 8263: # Everything is cached by the main uri, libraries are never directly cached
8264: #
1.428 albertel 8265: if (!defined($liburi)) {
1.599 albertel 8266: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 8267: if (defined($cached)) { return $result->{':'.$what}; }
8268: }
8269: {
1.172 www 8270: #
8271: # Is this a recursive call for a library?
8272: #
1.599 albertel 8273: # if (! exists($metacache{$uri})) {
8274: # $metacache{$uri}={};
8275: # }
1.924 albertel 8276: my $cachetime = 60*60;
1.171 www 8277: if ($liburi) {
8278: $liburi=&declutter($liburi);
8279: $filename=$liburi;
1.401 bowersj2 8280: } else {
1.599 albertel 8281: &devalidate_cache_new('meta',$uri);
8282: undef(%metaentry);
1.401 bowersj2 8283: }
1.140 www 8284: my %metathesekeys=();
1.73 www 8285: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 8286: my $metastring;
1.924 albertel 8287: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929 albertel 8288: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 8289: $metastring =
1.929 albertel 8290: &Apache::lonnet::ssi_body($which,
1.924 albertel 8291: ('grade_target' => 'meta'));
8292: $cachetime = 1; # only want this cached in the child not long term
8293: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 8294: my $file=&filelocation('',&clutter($filename));
1.599 albertel 8295: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 8296: $metastring=&getfile($file);
1.489 albertel 8297: }
1.208 albertel 8298: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 8299: my $token;
1.140 www 8300: undef %metathesekeys;
1.71 www 8301: while ($token=$parser->get_token) {
1.339 albertel 8302: if ($token->[0] eq 'S') {
8303: if (defined($token->[2]->{'package'})) {
1.172 www 8304: #
8305: # This is a package - get package info
8306: #
1.339 albertel 8307: my $package=$token->[2]->{'package'};
8308: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8309: if (defined($token->[2]->{'id'})) {
8310: $keyroot.='_'.$token->[2]->{'id'};
8311: }
1.599 albertel 8312: if ($metaentry{':packages'}) {
8313: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 8314: } else {
1.599 albertel 8315: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 8316: }
1.736 albertel 8317: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 8318: my $part=$keyroot;
8319: $part=~s/^\_//;
1.736 albertel 8320: if ($pack_entry=~/^\Q$package\E\&/ ||
8321: $pack_entry=~/^\Q$package\E_0\&/) {
8322: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 8323: # ignore package.tab specified default values
8324: # here &package_tab_default() will fetch those
8325: if ($subp eq 'default') { next; }
1.736 albertel 8326: my $value=$packagetab{$pack_entry};
1.432 albertel 8327: my $unikey;
8328: if ($pack =~ /_0$/) {
8329: $unikey='parameter_0_'.$name;
8330: $part=0;
8331: } else {
8332: $unikey='parameter'.$keyroot.'_'.$name;
8333: }
1.339 albertel 8334: if ($subp eq 'display') {
8335: $value.=' [Part: '.$part.']';
8336: }
1.599 albertel 8337: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 8338: $metathesekeys{$unikey}=1;
1.599 albertel 8339: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8340: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 8341: }
1.599 albertel 8342: if (defined($metaentry{':'.$unikey.'.default'})) {
8343: $metaentry{':'.$unikey}=
8344: $metaentry{':'.$unikey.'.default'};
1.356 albertel 8345: }
1.339 albertel 8346: }
8347: }
8348: } else {
1.172 www 8349: #
8350: # This is not a package - some other kind of start tag
1.339 albertel 8351: #
8352: my $entry=$token->[1];
8353: my $unikey;
8354: if ($entry eq 'import') {
8355: $unikey='';
8356: } else {
8357: $unikey=$entry;
8358: }
8359: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8360:
8361: if (defined($token->[2]->{'id'})) {
8362: $unikey.='_'.$token->[2]->{'id'};
8363: }
1.175 www 8364:
1.339 albertel 8365: if ($entry eq 'import') {
1.175 www 8366: #
8367: # Importing a library here
1.339 albertel 8368: #
8369: if ($depthcount<20) {
8370: my $location=$parser->get_text('/import');
8371: my $dir=$filename;
8372: $dir=~s|[^/]*$||;
8373: $location=&filelocation($dir,$location);
1.736 albertel 8374: my $metadata =
8375: &metadata($uri,'keys', $location,$unikey,
8376: $depthcount+1);
8377: foreach my $meta (split(',',$metadata)) {
8378: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8379: $metathesekeys{$meta}=1;
1.339 albertel 8380: }
8381: }
8382: } else {
8383:
8384: if (defined($token->[2]->{'name'})) {
8385: $unikey.='_'.$token->[2]->{'name'};
8386: }
8387: $metathesekeys{$unikey}=1;
1.736 albertel 8388: foreach my $param (@{$token->[3]}) {
8389: $metaentry{':'.$unikey.'.'.$param} =
8390: $token->[2]->{$param};
1.339 albertel 8391: }
8392: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 8393: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 8394: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8395: # only ws inside the tag, and not in default, so use default
8396: # as value
1.599 albertel 8397: $metaentry{':'.$unikey}=$default;
1.908 albertel 8398: } elsif ( $internaltext =~ /\S/ ) {
8399: # something interesting inside the tag
8400: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 8401: } else {
1.908 albertel 8402: # no interesting values, don't set a default
1.339 albertel 8403: }
1.172 www 8404: # end of not-a-package not-a-library import
1.339 albertel 8405: }
1.172 www 8406: # end of not-a-package start tag
1.339 albertel 8407: }
1.172 www 8408: # the next is the end of "start tag"
1.339 albertel 8409: }
8410: }
1.483 albertel 8411: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 8412: $extension = lc($extension);
8413: if ($extension eq 'htm') { $extension='html'; }
8414:
1.737 albertel 8415: foreach my $key (keys(%packagetab)) {
1.483 albertel 8416: #no specific packages #how's our extension
8417: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 8418: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 8419: \%metathesekeys);
8420: }
1.883 albertel 8421:
8422: if (!exists($metaentry{':packages'})
8423: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 8424: foreach my $key (keys(%packagetab)) {
1.483 albertel 8425: #no specific packages well let's get default then
8426: if ($key!~/^default&/) { next; }
1.488 albertel 8427: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 8428: \%metathesekeys);
8429: }
8430: }
1.338 www 8431: # are there custom rights to evaluate
1.599 albertel 8432: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 8433:
1.338 www 8434: #
8435: # Importing a rights file here
1.339 albertel 8436: #
8437: unless ($depthcount) {
1.599 albertel 8438: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 8439: my $dir=$filename;
8440: $dir=~s|[^/]*$||;
8441: $location=&filelocation($dir,$location);
1.736 albertel 8442: my $rights_metadata =
8443: &metadata($uri,'keys',$location,'_rights',
8444: $depthcount+1);
8445: foreach my $rights (split(',',$rights_metadata)) {
8446: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8447: $metathesekeys{$rights}=1;
1.339 albertel 8448: }
8449: }
8450: }
1.737 albertel 8451: # uniqifiy package listing
8452: my %seen;
8453: my @uniq_packages =
8454: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8455: $metaentry{':packages'} = join(',',@uniq_packages);
8456:
8457: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 8458: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8459: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 8460: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 8461: # this is the end of "was not already recently cached
1.71 www 8462: }
1.599 albertel 8463: return $metaentry{':'.$what};
1.261 albertel 8464: }
8465:
1.488 albertel 8466: sub metadata_create_package_def {
1.483 albertel 8467: my ($uri,$key,$package,$metathesekeys)=@_;
8468: my ($pack,$name,$subp)=split(/\&/,$key);
8469: if ($subp eq 'default') { next; }
8470:
1.599 albertel 8471: if (defined($metaentry{':packages'})) {
8472: $metaentry{':packages'}.=','.$package;
1.483 albertel 8473: } else {
1.599 albertel 8474: $metaentry{':packages'}=$package;
1.483 albertel 8475: }
8476: my $value=$packagetab{$key};
8477: my $unikey;
8478: $unikey='parameter_0_'.$name;
1.599 albertel 8479: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 8480: $$metathesekeys{$unikey}=1;
1.599 albertel 8481: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8482: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 8483: }
1.599 albertel 8484: if (defined($metaentry{':'.$unikey.'.default'})) {
8485: $metaentry{':'.$unikey}=
8486: $metaentry{':'.$unikey.'.default'};
1.483 albertel 8487: }
8488: }
8489:
1.261 albertel 8490: sub metadata_generate_part0 {
8491: my ($metadata,$metacache,$uri) = @_;
8492: my %allnames;
1.737 albertel 8493: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 8494: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 8495: my $part=$$metacache{':'.$metakey.'.part'};
8496: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 8497: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 8498: $allnames{$name}=$part;
8499: }
8500: }
8501: }
8502: foreach my $name (keys(%allnames)) {
8503: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 8504: my $key=":parameter_0_$name";
1.261 albertel 8505: $$metacache{"$key.part"}='0';
8506: $$metacache{"$key.name"}=$name;
1.428 albertel 8507: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 8508: $allnames{$name}.'_'.$name.
8509: '.type'};
1.428 albertel 8510: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 8511: '.display'};
1.644 www 8512: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 8513: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 8514: $$metacache{"$key.display"}=$olddis;
8515: }
1.71 www 8516: }
8517:
1.764 albertel 8518: # ------------------------------------------------------ Devalidate title cache
8519:
8520: sub devalidate_title_cache {
8521: my ($url)=@_;
8522: if (!$env{'request.course.id'}) { return; }
8523: my $symb=&symbread($url);
8524: if (!$symb) { return; }
8525: my $key=$env{'request.course.id'}."\0".$symb;
8526: &devalidate_cache_new('title',$key);
8527: }
8528:
1.1014 droeschl 8529: # ------------------------------------------------- Get the title of a course
8530:
8531: sub current_course_title {
8532: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8533: }
1.301 www 8534: # ------------------------------------------------- Get the title of a resource
8535:
8536: sub gettitle {
8537: my $urlsymb=shift;
8538: my $symb=&symbread($urlsymb);
1.534 albertel 8539: if ($symb) {
1.620 albertel 8540: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 8541: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 8542: if (defined($cached)) {
8543: return $result;
8544: }
1.534 albertel 8545: my ($map,$resid,$url)=&decode_symb($symb);
8546: my $title='';
1.907 albertel 8547: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8548: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8549: } else {
8550: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8551: &GDBM_READER(),0640)) {
8552: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8553: $title=$bighash{'title_'.$mapid.'.'.$resid};
8554: untie(%bighash);
8555: }
1.534 albertel 8556: }
8557: $title=~s/\&colon\;/\:/gs;
8558: if ($title) {
1.599 albertel 8559: return &do_cache_new('title',$key,$title,600);
1.534 albertel 8560: }
8561: $urlsymb=$url;
8562: }
8563: my $title=&metadata($urlsymb,'title');
8564: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8565: return $title;
1.301 www 8566: }
1.613 albertel 8567:
1.614 albertel 8568: sub get_slot {
8569: my ($which,$cnum,$cdom)=@_;
8570: if (!$cnum || !$cdom) {
1.790 albertel 8571: (undef,my $courseid)=&whichuser();
1.620 albertel 8572: $cdom=$env{'course.'.$courseid.'.domain'};
8573: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 8574: }
1.703 albertel 8575: my $key=join("\0",'slots',$cdom,$cnum,$which);
8576: my %slotinfo;
8577: if (exists($remembered{$key})) {
8578: $slotinfo{$which} = $remembered{$key};
8579: } else {
8580: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8581: &Apache::lonhomework::showhash(%slotinfo);
8582: my ($tmp)=keys(%slotinfo);
8583: if ($tmp=~/^error:/) { return (); }
8584: $remembered{$key} = $slotinfo{$which};
8585: }
1.616 albertel 8586: if (ref($slotinfo{$which}) eq 'HASH') {
8587: return %{$slotinfo{$which}};
8588: }
8589: return $slotinfo{$which};
1.614 albertel 8590: }
1.31 www 8591: # ------------------------------------------------- Update symbolic store links
8592:
8593: sub symblist {
8594: my ($mapname,%newhash)=@_;
1.438 www 8595: $mapname=&deversion(&declutter($mapname));
1.31 www 8596: my %hash;
1.620 albertel 8597: if (($env{'request.course.fn'}) && (%newhash)) {
8598: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8599: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 8600: foreach my $url (keys(%newhash)) {
1.711 albertel 8601: next if ($url eq 'last_known'
8602: && $env{'form.no_update_last_known'});
8603: $hash{declutter($url)}=&encode_symb($mapname,
8604: $newhash{$url}->[1],
8605: $newhash{$url}->[0]);
1.191 harris41 8606: }
1.31 www 8607: if (untie(%hash)) {
8608: return 'ok';
8609: }
8610: }
8611: }
8612: return 'error';
1.212 www 8613: }
8614:
8615: # --------------------------------------------------------------- Verify a symb
8616:
8617: sub symbverify {
1.510 www 8618: my ($symb,$thisurl)=@_;
8619: my $thisfn=$thisurl;
1.439 www 8620: $thisfn=&declutter($thisfn);
1.215 www 8621: # direct jump to resource in page or to a sequence - will construct own symbs
8622: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8623: # check URL part
1.409 www 8624: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 8625:
1.431 www 8626: unless ($url eq $thisfn) { return 0; }
1.213 www 8627:
1.216 www 8628: $symb=&symbclean($symb);
1.510 www 8629: $thisurl=&deversion($thisurl);
1.439 www 8630: $thisfn=&deversion($thisfn);
1.213 www 8631:
8632: my %bighash;
8633: my $okay=0;
1.431 www 8634:
1.620 albertel 8635: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8636: &GDBM_READER(),0640)) {
1.1032 raeburn 8637: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8638: $thisurl =~ s/\?.+$//;
8639: }
1.510 www 8640: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 8641: unless ($ids) {
1.510 www 8642: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 8643: }
8644: if ($ids) {
8645: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 8646: foreach my $id (split(/\,/,$ids)) {
8647: my ($mapid,$resid)=split(/\./,$id);
1.1032 raeburn 8648: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8649: $symb =~ s/\?.+$//;
8650: }
1.216 www 8651: if (
8652: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8653: eq $symb) {
1.620 albertel 8654: if (($env{'request.role.adv'}) ||
1.800 albertel 8655: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 8656: $okay=1;
8657: }
8658: }
1.216 www 8659: }
8660: }
1.213 www 8661: untie(%bighash);
8662: }
8663: return $okay;
1.31 www 8664: }
8665:
1.210 www 8666: # --------------------------------------------------------------- Clean-up symb
8667:
8668: sub symbclean {
8669: my $symb=shift;
1.568 albertel 8670: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 8671: # remove version from map
8672: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 8673:
1.210 www 8674: # remove version from URL
8675: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 8676:
1.507 www 8677: # remove wrapper
8678:
1.510 www 8679: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 8680: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 8681: return $symb;
1.409 www 8682: }
8683:
8684: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 8685:
8686: sub encode_symb {
8687: my ($map,$resid,$url)=@_;
8688: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8689: }
1.409 www 8690:
8691: sub decode_symb {
1.568 albertel 8692: my $symb=shift;
8693: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8694: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 8695: return (&fixversion($map),$resid,&fixversion($url));
8696: }
8697:
8698: sub fixversion {
8699: my $fn=shift;
1.609 banghart 8700: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 8701: my %bighash;
8702: my $uri=&clutter($fn);
1.620 albertel 8703: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 8704: # is this cached?
1.599 albertel 8705: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 8706: if (defined($cached)) { return $result; }
8707: # unfortunately not cached, or expired
1.620 albertel 8708: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 8709: &GDBM_READER(),0640)) {
8710: if ($bighash{'version_'.$uri}) {
8711: my $version=$bighash{'version_'.$uri};
1.444 www 8712: unless (($version eq 'mostrecent') ||
8713: ($version==&getversion($uri))) {
1.440 www 8714: $uri=~s/\.(\w+)$/\.$version\.$1/;
8715: }
8716: }
8717: untie %bighash;
1.413 www 8718: }
1.599 albertel 8719: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 8720: }
8721:
8722: sub deversion {
8723: my $url=shift;
8724: $url=~s/\.\d+\.(\w+)$/\.$1/;
8725: return $url;
1.210 www 8726: }
8727:
1.31 www 8728: # ------------------------------------------------------ Return symb list entry
8729:
8730: sub symbread {
1.249 www 8731: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 8732: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 8733: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 8734: # no filename provided? try from environment
1.44 www 8735: unless ($thisfn) {
1.620 albertel 8736: if ($env{'request.symb'}) {
8737: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 8738: }
1.620 albertel 8739: $thisfn=$env{'request.filename'};
1.44 www 8740: }
1.569 albertel 8741: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 8742: # is that filename actually a symb? Verify, clean, and return
8743: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 8744: if (&symbverify($thisfn,$1)) {
1.620 albertel 8745: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 8746: }
1.242 www 8747: }
1.44 www 8748: $thisfn=declutter($thisfn);
1.31 www 8749: my %hash;
1.37 www 8750: my %bighash;
8751: my $syval='';
1.620 albertel 8752: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 8753: my $targetfn = $thisfn;
1.609 banghart 8754: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 8755: $targetfn = 'adm/wrapper/'.$thisfn;
8756: }
1.687 albertel 8757: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8758: $targetfn=$1;
8759: }
1.620 albertel 8760: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8761: &GDBM_READER(),0640)) {
1.481 raeburn 8762: $syval=$hash{$targetfn};
1.37 www 8763: untie(%hash);
8764: }
8765: # ---------------------------------------------------------- There was an entry
8766: if ($syval) {
1.601 albertel 8767: #unless ($syval=~/\_\d+$/) {
1.620 albertel 8768: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 8769: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8770: #return $env{$cache_str}='';
1.601 albertel 8771: #}
8772: #$syval.=$1;
8773: #}
1.37 www 8774: } else {
8775: # ------------------------------------------------------- Was not in symb table
1.620 albertel 8776: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8777: &GDBM_READER(),0640)) {
1.37 www 8778: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 8779: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 8780: unless ($ids) {
8781: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 8782: }
8783: unless ($ids) {
8784: # alias?
8785: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 8786: }
1.37 www 8787: if ($ids) {
8788: # ------------------------------------------------------------------- Has ID(s)
8789: my @possibilities=split(/\,/,$ids);
1.39 www 8790: if ($#possibilities==0) {
8791: # ----------------------------------------------- There is only one possibility
1.37 www 8792: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 8793: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8794: $resid,$thisfn);
1.249 www 8795: } elsif (!$donotrecurse) {
1.39 www 8796: # ------------------------------------------ There is more than one possibility
8797: my $realpossible=0;
1.800 albertel 8798: foreach my $id (@possibilities) {
8799: my $file=$bighash{'src_'.$id};
1.39 www 8800: if (&allowed('bre',$file)) {
1.800 albertel 8801: my ($mapid,$resid)=split(/\./,$id);
1.39 www 8802: if ($bighash{'map_type_'.$mapid} ne 'page') {
8803: $realpossible++;
1.626 albertel 8804: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8805: $resid,$thisfn);
1.39 www 8806: }
8807: }
1.191 harris41 8808: }
1.39 www 8809: if ($realpossible!=1) { $syval=''; }
1.249 www 8810: } else {
8811: $syval='';
1.37 www 8812: }
8813: }
8814: untie(%bighash)
1.481 raeburn 8815: }
1.31 www 8816: }
1.62 www 8817: if ($syval) {
1.620 albertel 8818: return $env{$cache_str}=$syval;
1.62 www 8819: }
1.31 www 8820: }
1.949 raeburn 8821: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8822: return $env{$cache_str}='';
1.31 www 8823: }
8824:
8825: # ---------------------------------------------------------- Return random seed
8826:
1.32 www 8827: sub numval {
8828: my $txt=shift;
8829: $txt=~tr/A-J/0-9/;
8830: $txt=~tr/a-j/0-9/;
8831: $txt=~tr/K-T/0-9/;
8832: $txt=~tr/k-t/0-9/;
8833: $txt=~tr/U-Z/0-5/;
8834: $txt=~tr/u-z/0-5/;
8835: $txt=~s/\D//g;
1.564 albertel 8836: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 8837: return int($txt);
1.368 albertel 8838: }
8839:
1.484 albertel 8840: sub numval2 {
8841: my $txt=shift;
8842: $txt=~tr/A-J/0-9/;
8843: $txt=~tr/a-j/0-9/;
8844: $txt=~tr/K-T/0-9/;
8845: $txt=~tr/k-t/0-9/;
8846: $txt=~tr/U-Z/0-5/;
8847: $txt=~tr/u-z/0-5/;
8848: $txt=~s/\D//g;
8849: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8850: my $total;
8851: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 8852: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 8853: return int($total);
8854: }
8855:
1.575 albertel 8856: sub numval3 {
8857: use integer;
8858: my $txt=shift;
8859: $txt=~tr/A-J/0-9/;
8860: $txt=~tr/a-j/0-9/;
8861: $txt=~tr/K-T/0-9/;
8862: $txt=~tr/k-t/0-9/;
8863: $txt=~tr/U-Z/0-5/;
8864: $txt=~tr/u-z/0-5/;
8865: $txt=~s/\D//g;
8866: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8867: my $total;
8868: foreach my $val (@txts) { $total+=$val; }
8869: if ($_64bit) { $total=(($total<<32)>>32); }
8870: return $total;
8871: }
8872:
1.675 albertel 8873: sub digest {
8874: my ($data)=@_;
8875: my $digest=&Digest::MD5::md5($data);
8876: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8877: my ($e,$f);
8878: {
8879: use integer;
8880: $e=($a+$b);
8881: $f=($c+$d);
8882: if ($_64bit) {
8883: $e=(($e<<32)>>32);
8884: $f=(($f<<32)>>32);
8885: }
8886: }
8887: if (wantarray) {
8888: return ($e,$f);
8889: } else {
8890: my $g;
8891: {
8892: use integer;
8893: $g=($e+$f);
8894: if ($_64bit) {
8895: $g=(($g<<32)>>32);
8896: }
8897: }
8898: return $g;
8899: }
8900: }
8901:
1.368 albertel 8902: sub latest_rnd_algorithm_id {
1.675 albertel 8903: return '64bit5';
1.366 albertel 8904: }
1.32 www 8905:
1.503 albertel 8906: sub get_rand_alg {
8907: my ($courseid)=@_;
1.790 albertel 8908: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 8909: if ($courseid) {
1.620 albertel 8910: return $env{"course.$courseid.rndseed"};
1.503 albertel 8911: }
8912: return &latest_rnd_algorithm_id();
8913: }
8914:
1.562 albertel 8915: sub validCODE {
8916: my ($CODE)=@_;
8917: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8918: return 0;
8919: }
8920:
1.491 albertel 8921: sub getCODE {
1.620 albertel 8922: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 8923: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8924: defined($Apache::lonhomework::parsing_a_task) ) &&
8925: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 8926: return $Apache::lonhomework::history{'resource.CODE'};
8927: }
8928: return undef;
8929: }
8930:
1.31 www 8931: sub rndseed {
1.155 albertel 8932: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 8933: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 8934: if (!defined($symb)) {
1.366 albertel 8935: unless ($symb=$wsymb) { return time; }
8936: }
8937: if (!$courseid) { $courseid=$wcourseid; }
8938: if (!$domain) { $domain=$wdomain; }
8939: if (!$username) { $username=$wusername }
1.503 albertel 8940: my $which=&get_rand_alg();
1.803 albertel 8941:
1.491 albertel 8942: if (defined(&getCODE())) {
1.675 albertel 8943: if ($which eq '64bit5') {
8944: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8945: } elsif ($which eq '64bit4') {
1.575 albertel 8946: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8947: } else {
8948: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8949: }
1.675 albertel 8950: } elsif ($which eq '64bit5') {
8951: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 8952: } elsif ($which eq '64bit4') {
8953: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 8954: } elsif ($which eq '64bit3') {
8955: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 8956: } elsif ($which eq '64bit2') {
8957: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 8958: } elsif ($which eq '64bit') {
8959: return &rndseed_64bit($symb,$courseid,$domain,$username);
8960: }
8961: return &rndseed_32bit($symb,$courseid,$domain,$username);
8962: }
8963:
8964: sub rndseed_32bit {
8965: my ($symb,$courseid,$domain,$username)=@_;
8966: {
8967: use integer;
8968: my $symbchck=unpack("%32C*",$symb) << 27;
8969: my $symbseed=numval($symb) << 22;
8970: my $namechck=unpack("%32C*",$username) << 17;
8971: my $nameseed=numval($username) << 12;
8972: my $domainseed=unpack("%32C*",$domain) << 7;
8973: my $courseseed=unpack("%32C*",$courseid);
8974: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 8975: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8976: #&logthis("rndseed :$num:$symb");
1.564 albertel 8977: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 8978: return $num;
8979: }
8980: }
8981:
8982: sub rndseed_64bit {
8983: my ($symb,$courseid,$domain,$username)=@_;
8984: {
8985: use integer;
8986: my $symbchck=unpack("%32S*",$symb) << 21;
8987: my $symbseed=numval($symb) << 10;
8988: my $namechck=unpack("%32S*",$username);
8989:
8990: my $nameseed=numval($username) << 21;
8991: my $domainseed=unpack("%32S*",$domain) << 10;
8992: my $courseseed=unpack("%32S*",$courseid);
8993:
8994: my $num1=$symbchck+$symbseed+$namechck;
8995: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8996: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8997: #&logthis("rndseed :$num:$symb");
1.564 albertel 8998: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 8999: return "$num1,$num2";
1.155 albertel 9000: }
1.366 albertel 9001: }
9002:
1.443 albertel 9003: sub rndseed_64bit2 {
9004: my ($symb,$courseid,$domain,$username)=@_;
9005: {
9006: use integer;
9007: # strings need to be an even # of cahracters long, it it is odd the
9008: # last characters gets thrown away
9009: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9010: my $symbseed=numval($symb) << 10;
9011: my $namechck=unpack("%32S*",$username.' ');
9012:
9013: my $nameseed=numval($username) << 21;
1.501 albertel 9014: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9015: my $courseseed=unpack("%32S*",$courseid.' ');
9016:
9017: my $num1=$symbchck+$symbseed+$namechck;
9018: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 9019: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9020: #&logthis("rndseed :$num:$symb");
1.803 albertel 9021: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 9022: return "$num1,$num2";
9023: }
9024: }
9025:
9026: sub rndseed_64bit3 {
9027: my ($symb,$courseid,$domain,$username)=@_;
9028: {
9029: use integer;
9030: # strings need to be an even # of cahracters long, it it is odd the
9031: # last characters gets thrown away
9032: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9033: my $symbseed=numval2($symb) << 10;
9034: my $namechck=unpack("%32S*",$username.' ');
9035:
9036: my $nameseed=numval2($username) << 21;
1.443 albertel 9037: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9038: my $courseseed=unpack("%32S*",$courseid.' ');
9039:
9040: my $num1=$symbchck+$symbseed+$namechck;
9041: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 9042: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9043: #&logthis("rndseed :$num1:$num2:$_64bit");
1.564 albertel 9044: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9045:
1.503 albertel 9046: return "$num1:$num2";
1.443 albertel 9047: }
9048: }
9049:
1.575 albertel 9050: sub rndseed_64bit4 {
9051: my ($symb,$courseid,$domain,$username)=@_;
9052: {
9053: use integer;
9054: # strings need to be an even # of cahracters long, it it is odd the
9055: # last characters gets thrown away
9056: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9057: my $symbseed=numval3($symb) << 10;
9058: my $namechck=unpack("%32S*",$username.' ');
9059:
9060: my $nameseed=numval3($username) << 21;
9061: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9062: my $courseseed=unpack("%32S*",$courseid.' ');
9063:
9064: my $num1=$symbchck+$symbseed+$namechck;
9065: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 9066: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9067: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 9068: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9069:
9070: return "$num1:$num2";
9071: }
9072: }
9073:
1.675 albertel 9074: sub rndseed_64bit5 {
9075: my ($symb,$courseid,$domain,$username)=@_;
9076: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
9077: return "$num1:$num2";
9078: }
9079:
1.366 albertel 9080: sub rndseed_CODE_64bit {
9081: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 9082: {
1.366 albertel 9083: use integer;
1.443 albertel 9084: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 9085: my $symbseed=numval2($symb);
1.491 albertel 9086: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9087: my $CODEseed=numval(&getCODE());
1.443 albertel 9088: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 9089: my $num1=$symbseed+$CODEchck;
9090: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 9091: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9092: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 9093: if ($_64bit) { $num1=(($num1<<32)>>32); }
9094: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 9095: return "$num1:$num2";
1.366 albertel 9096: }
9097: }
9098:
1.575 albertel 9099: sub rndseed_CODE_64bit4 {
9100: my ($symb,$courseid,$domain,$username)=@_;
9101: {
9102: use integer;
9103: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9104: my $symbseed=numval3($symb);
9105: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9106: my $CODEseed=numval3(&getCODE());
9107: my $courseseed=unpack("%32S*",$courseid.' ');
9108: my $num1=$symbseed+$CODEchck;
9109: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 9110: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9111: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 9112: if ($_64bit) { $num1=(($num1<<32)>>32); }
9113: if ($_64bit) { $num2=(($num2<<32)>>32); }
9114: return "$num1:$num2";
9115: }
9116: }
9117:
1.675 albertel 9118: sub rndseed_CODE_64bit5 {
9119: my ($symb,$courseid,$domain,$username)=@_;
9120: my $code = &getCODE();
9121: my ($num1,$num2)=&digest("$symb,$courseid,$code");
9122: return "$num1:$num2";
9123: }
9124:
1.366 albertel 9125: sub setup_random_from_rndseed {
9126: my ($rndseed)=@_;
1.503 albertel 9127: if ($rndseed =~/([,:])/) {
9128: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 9129: &Math::Random::random_set_seed(abs($num1),abs($num2));
9130: } else {
9131: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 9132: }
1.36 albertel 9133: }
9134:
1.474 albertel 9135: sub latest_receipt_algorithm_id {
1.835 albertel 9136: return 'receipt3';
1.474 albertel 9137: }
9138:
1.480 www 9139: sub recunique {
9140: my $fucourseid=shift;
9141: my $unique;
1.835 albertel 9142: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9143: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9144: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 9145: } else {
9146: $unique=$perlvar{'lonReceipt'};
9147: }
9148: return unpack("%32C*",$unique);
9149: }
9150:
9151: sub recprefix {
9152: my $fucourseid=shift;
9153: my $prefix;
1.835 albertel 9154: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9155: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9156: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 9157: } else {
9158: $prefix=$perlvar{'lonHostID'};
9159: }
9160: return unpack("%32C*",$prefix);
9161: }
9162:
1.76 www 9163: sub ireceipt {
1.474 albertel 9164: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 9165:
9166: my $return =&recprefix($fucourseid).'-';
9167:
9168: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9169: $env{'request.state'} eq 'construct') {
9170: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9171: return $return;
9172: }
9173:
1.76 www 9174: my $cuname=unpack("%32C*",$funame);
9175: my $cudom=unpack("%32C*",$fudom);
9176: my $cucourseid=unpack("%32C*",$fucourseid);
9177: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 9178: my $cunique=&recunique($fucourseid);
1.474 albertel 9179: my $cpart=unpack("%32S*",$part);
1.835 albertel 9180: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9181:
1.790 albertel 9182: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 9183:
9184: $return.= ($cunique%$cuname+
9185: $cunique%$cudom+
9186: $cusymb%$cuname+
9187: $cusymb%$cudom+
9188: $cucourseid%$cuname+
9189: $cucourseid%$cudom+
9190: $cpart%$cuname+
9191: $cpart%$cudom);
9192: } else {
9193: $return.= ($cunique%$cuname+
9194: $cunique%$cudom+
9195: $cusymb%$cuname+
9196: $cusymb%$cudom+
9197: $cucourseid%$cuname+
9198: $cucourseid%$cudom);
9199: }
9200: return $return;
1.76 www 9201: }
9202:
9203: sub receipt {
1.474 albertel 9204: my ($part)=@_;
1.790 albertel 9205: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 9206: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 9207: }
1.260 ng 9208:
1.790 albertel 9209: sub whichuser {
9210: my ($passedsymb)=@_;
9211: my ($symb,$courseid,$domain,$name,$publicuser);
9212: if (defined($env{'form.grade_symb'})) {
9213: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9214: my $allowed=&allowed('vgr',$tmp_courseid);
9215: if (!$allowed &&
9216: exists($env{'request.course.sec'}) &&
9217: $env{'request.course.sec'} !~ /^\s*$/) {
9218: $allowed=&allowed('vgr',$tmp_courseid.
9219: '/'.$env{'request.course.sec'});
9220: }
9221: if ($allowed) {
9222: ($symb)=&get_env_multiple('form.grade_symb');
9223: $courseid=$tmp_courseid;
9224: ($domain)=&get_env_multiple('form.grade_domain');
9225: ($name)=&get_env_multiple('form.grade_username');
9226: return ($symb,$courseid,$domain,$name,$publicuser);
9227: }
9228: }
9229: if (!$passedsymb) {
9230: $symb=&symbread();
9231: } else {
9232: $symb=$passedsymb;
9233: }
9234: $courseid=$env{'request.course.id'};
9235: $domain=$env{'user.domain'};
9236: $name=$env{'user.name'};
9237: if ($name eq 'public' && $domain eq 'public') {
9238: if (!defined($env{'form.username'})) {
9239: $env{'form.username'}.=time.rand(10000000);
9240: }
9241: $name.=$env{'form.username'};
9242: }
9243: return ($symb,$courseid,$domain,$name,$publicuser);
9244:
9245: }
9246:
1.36 albertel 9247: # ------------------------------------------------------------ Serves up a file
1.472 albertel 9248: # returns either the contents of the file or
9249: # -1 if the file doesn't exist
1.481 raeburn 9250: #
9251: # if the target is a file that was uploaded via DOCS,
9252: # a check will be made to see if a current copy exists on the local server,
9253: # if it does this will be served, otherwise a copy will be retrieved from
9254: # the home server for the course and stored in /home/httpd/html/userfiles on
9255: # the local server.
1.472 albertel 9256:
1.36 albertel 9257: sub getfile {
1.538 albertel 9258: my ($file) = @_;
1.609 banghart 9259: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 9260: &repcopy($file);
9261: return &readfile($file);
9262: }
9263:
9264: sub repcopy_userfile {
9265: my ($file)=@_;
1.609 banghart 9266: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 9267: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 9268: my ($cdom,$cnum,$filename) =
1.811 albertel 9269: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 9270: my $uri="/uploaded/$cdom/$cnum/$filename";
9271: if (-e "$file") {
1.828 www 9272: # we already have a local copy, check it out
1.538 albertel 9273: my @fileinfo = stat($file);
1.828 www 9274: my $rtncode;
9275: my $info;
1.538 albertel 9276: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 9277: if ($lwpresp ne 'ok') {
1.828 www 9278: # there is no such file anymore, even though we had a local copy
1.482 albertel 9279: if ($rtncode eq '404') {
1.538 albertel 9280: unlink($file);
1.482 albertel 9281: }
9282: return -1;
9283: }
9284: if ($info < $fileinfo[9]) {
1.828 www 9285: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 9286: return 'ok';
1.828 www 9287: } else {
9288: # the file is outdated, get rid of it
9289: unlink($file);
1.482 albertel 9290: }
1.828 www 9291: }
9292: # one way or the other, at this point, we don't have the file
9293: # construct the correct path for the file
9294: my @parts = ($cdom,$cnum);
9295: if ($filename =~ m|^(.+)/[^/]+$|) {
9296: push @parts, split(/\//,$1);
9297: }
9298: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9299: foreach my $part (@parts) {
9300: $path .= '/'.$part;
9301: if (!-e $path) {
9302: mkdir($path,0770);
1.482 albertel 9303: }
9304: }
1.828 www 9305: # now the path exists for sure
9306: # get a user agent
9307: my $ua=new LWP::UserAgent;
9308: my $transferfile=$file.'.in.transfer';
9309: # FIXME: this should flock
9310: if (-e $transferfile) { return 'ok'; }
9311: my $request;
9312: $uri=~s/^\///;
1.980 raeburn 9313: my $homeserver = &homeserver($cnum,$cdom);
9314: my $protocol = $protocol{$homeserver};
9315: $protocol = 'http' if ($protocol ne 'https');
9316: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 9317: my $response=$ua->request($request,$transferfile);
9318: # did it work?
9319: if ($response->is_error()) {
9320: unlink($transferfile);
9321: &logthis("Userfile repcopy failed for $uri");
9322: return -1;
9323: }
9324: # worked, rename the transfer file
9325: rename($transferfile,$file);
1.607 raeburn 9326: return 'ok';
1.481 raeburn 9327: }
9328:
1.517 albertel 9329: sub tokenwrapper {
9330: my $uri=shift;
1.980 raeburn 9331: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 9332: $uri=~s|^/||;
1.620 albertel 9333: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 9334: my $token=$1;
1.552 albertel 9335: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9336: if ($udom && $uname && $file) {
9337: $file=~s|(\?\.*)*$||;
1.949 raeburn 9338: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 9339: my $homeserver = &homeserver($uname,$udom);
9340: my $protocol = $protocol{$homeserver};
9341: $protocol = 'http' if ($protocol ne 'https');
9342: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 9343: (($uri=~/\?/)?'&':'?').'token='.$token.
9344: '&tokenissued='.$perlvar{'lonHostID'};
9345: } else {
9346: return '/adm/notfound.html';
9347: }
9348: }
9349:
1.828 www 9350: # call with reqtype HEAD: get last modification time
9351: # call with reqtype GET: get the file contents
9352: # Do not call this with reqtype GET for large files! It loads everything into memory
9353: #
1.481 raeburn 9354: sub getuploaded {
9355: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9356: $uri=~s/^\///;
1.980 raeburn 9357: my $homeserver = &homeserver($cnum,$cdom);
9358: my $protocol = $protocol{$homeserver};
9359: $protocol = 'http' if ($protocol ne 'https');
9360: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 9361: my $ua=new LWP::UserAgent;
9362: my $request=new HTTP::Request($reqtype,$uri);
9363: my $response=$ua->request($request);
9364: $$rtncode = $response->code;
1.482 albertel 9365: if (! $response->is_success()) {
9366: return 'failed';
9367: }
9368: if ($reqtype eq 'HEAD') {
1.486 www 9369: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 9370: } elsif ($reqtype eq 'GET') {
9371: $$info = $response->content;
1.472 albertel 9372: }
1.482 albertel 9373: return 'ok';
1.36 albertel 9374: }
9375:
1.481 raeburn 9376: sub readfile {
9377: my $file = shift;
9378: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9379: my $fh;
9380: open($fh,"<$file");
9381: my $a='';
1.800 albertel 9382: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 9383: return $a;
9384: }
9385:
1.36 albertel 9386: sub filelocation {
1.590 banghart 9387: my ($dir,$file) = @_;
9388: my $location;
9389: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 9390:
9391: if ($file =~ m-^/adm/-) {
9392: $file=~s-^/adm/wrapper/-/-;
9393: $file=~s-^/adm/coursedocs/showdoc/-/-;
9394: }
1.882 albertel 9395:
1.590 banghart 9396: if ($file=~m:^/~:) { # is a contruction space reference
9397: $location = $file;
9398: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 9399: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 9400: # is a correct contruction space reference
9401: $location = $file;
1.956 raeburn 9402: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9403: $location = $file;
1.609 banghart 9404: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 9405: my ($udom,$uname,$filename)=
1.811 albertel 9406: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 9407: my $home=&homeserver($uname,$udom);
9408: my $is_me=0;
9409: my @ids=¤t_machine_ids();
9410: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9411: if ($is_me) {
1.955 raeburn 9412: $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 9413: } else {
9414: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9415: $udom.'/'.$uname.'/'.$filename;
9416: }
1.882 albertel 9417: } elsif ($file =~ m-^/adm/-) {
9418: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 9419: } else {
9420: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9421: $file=~s:^/res/:/:;
9422: if ( !( $file =~ m:^/:) ) {
9423: $location = $dir. '/'.$file;
9424: } else {
9425: $location = '/home/httpd/html/res'.$file;
9426: }
1.59 albertel 9427: }
1.590 banghart 9428: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 9429: while ($location=~m{/\.\./}) {
9430: if ($location =~ m{/[^/]+/\.\./}) {
9431: $location=~ s{/[^/]+/\.\./}{/}g;
9432: } else {
9433: $location=~ s{/\.\./}{/}g;
9434: }
9435: } #remove dir/..
1.590 banghart 9436: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9437: return $location;
1.46 www 9438: }
1.36 albertel 9439:
1.46 www 9440: sub hreflocation {
9441: my ($dir,$file)=@_;
1.980 raeburn 9442: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 9443: $file=filelocation($dir,$file);
1.700 albertel 9444: } elsif ($file=~m-^/adm/-) {
9445: $file=~s-^/adm/wrapper/-/-;
9446: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 9447: }
9448: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9449: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 9450: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9451: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 9452: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 9453: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 9454: -/uploaded/$1/$2/-x;
1.46 www 9455: }
1.913 albertel 9456: if ($file=~ m{^/userfiles/}) {
9457: $file =~ s{^/userfiles/}{/uploaded/};
9458: }
1.462 albertel 9459: return $file;
1.465 albertel 9460: }
9461:
9462: sub current_machine_domains {
1.853 albertel 9463: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9464: }
9465:
9466: sub machine_domains {
9467: my ($hostname) = @_;
1.465 albertel 9468: my @domains;
1.838 albertel 9469: my %hostname = &all_hostnames();
1.465 albertel 9470: while( my($id, $name) = each(%hostname)) {
1.467 matthew 9471: # &logthis("-$id-$name-$hostname-");
1.465 albertel 9472: if ($hostname eq $name) {
1.844 albertel 9473: push(@domains,&host_domain($id));
1.465 albertel 9474: }
9475: }
9476: return @domains;
9477: }
9478:
9479: sub current_machine_ids {
1.853 albertel 9480: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9481: }
9482:
9483: sub machine_ids {
9484: my ($hostname) = @_;
9485: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 9486: my @ids;
1.888 albertel 9487: my %name_to_host = &all_names();
1.889 albertel 9488: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9489: return @{ $name_to_host{$hostname} };
9490: }
9491: return;
1.31 www 9492: }
9493:
1.824 raeburn 9494: sub additional_machine_domains {
9495: my @domains;
9496: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9497: while( my $line = <$fh>) {
9498: $line =~ s/\s//g;
9499: push(@domains,$line);
9500: }
9501: return @domains;
9502: }
9503:
9504: sub default_login_domain {
9505: my $domain = $perlvar{'lonDefDomain'};
9506: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9507: foreach my $posdom (¤t_machine_domains(),
9508: &additional_machine_domains()) {
9509: if (lc($posdom) eq lc($testdomain)) {
9510: $domain=$posdom;
9511: last;
9512: }
9513: }
9514: return $domain;
9515: }
9516:
1.31 www 9517: # ------------------------------------------------------------- Declutters URLs
9518:
9519: sub declutter {
9520: my $thisfn=shift;
1.569 albertel 9521: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 9522: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 9523: $thisfn=~s/^\///;
1.697 albertel 9524: $thisfn=~s|^adm/wrapper/||;
9525: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 9526: $thisfn=~s/^res\///;
1.1032 raeburn 9527: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9528: $thisfn=~s/\?.+$//;
9529: }
1.268 www 9530: return $thisfn;
9531: }
9532:
9533: # ------------------------------------------------------------- Clutter up URLs
9534:
9535: sub clutter {
9536: my $thisfn='/'.&declutter(shift);
1.887 albertel 9537: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 9538: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 9539: $thisfn='/res'.$thisfn;
9540: }
1.1031 raeburn 9541: if ($thisfn !~m|^/adm|) {
9542: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 9543: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 9544: } else {
9545: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9546: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 9547: if ($embstyle eq 'ssi'
9548: || ($embstyle eq 'hdn')
9549: || ($embstyle eq 'rat')
9550: || ($embstyle eq 'prv')
9551: || ($embstyle eq 'ign')) {
9552: #do nothing with these
9553: } elsif (($embstyle eq 'img')
1.695 albertel 9554: || ($embstyle eq 'emb')
9555: || ($embstyle eq 'wrp')) {
9556: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 9557: } elsif ($embstyle eq 'unk'
9558: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 9559: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 9560: } else {
1.718 www 9561: # &logthis("Got a blank emb style");
1.695 albertel 9562: }
1.694 albertel 9563: }
9564: }
1.31 www 9565: return $thisfn;
1.12 www 9566: }
9567:
1.787 albertel 9568: sub clutter_with_no_wrapper {
9569: my $uri = &clutter(shift);
9570: if ($uri =~ m-^/adm/-) {
9571: $uri =~ s-^/adm/wrapper/-/-;
9572: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9573: }
9574: return $uri;
9575: }
9576:
1.557 albertel 9577: sub freeze_escape {
9578: my ($value)=@_;
9579: if (ref($value)) {
9580: $value=&nfreeze($value);
9581: return '__FROZEN__'.&escape($value);
9582: }
9583: return &escape($value);
9584: }
9585:
1.11 www 9586:
1.557 albertel 9587: sub thaw_unescape {
9588: my ($value)=@_;
9589: if ($value =~ /^__FROZEN__/) {
9590: substr($value,0,10,undef);
9591: $value=&unescape($value);
9592: return &thaw($value);
9593: }
9594: return &unescape($value);
9595: }
9596:
1.436 albertel 9597: sub correct_line_ends {
9598: my ($result)=@_;
9599: $$result =~s/\r\n/\n/mg;
9600: $$result =~s/\r/\n/mg;
1.415 albertel 9601: }
1.1 albertel 9602: # ================================================================ Main Program
9603:
1.184 www 9604: sub goodbye {
1.204 albertel 9605: &logthis("Starting Shut down");
1.443 albertel 9606: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 9607: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 9608: #converted
1.599 albertel 9609: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 9610: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9611: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9612: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 9613: #1.1 only
1.870 albertel 9614: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9615: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9616: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9617: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9618: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 9619: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9620: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 9621: &flushcourselogs();
9622: &logthis("Shutting down");
9623: }
9624:
1.852 albertel 9625: sub get_dns {
1.869 albertel 9626: my ($url,$func,$ignore_cache) = @_;
9627: if (!$ignore_cache) {
9628: my ($content,$cached)=
9629: &Apache::lonnet::is_cached_new('dns',$url);
9630: if ($cached) {
9631: &$func($content);
9632: return;
9633: }
9634: }
9635:
9636: my %alldns;
1.852 albertel 9637: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9638: foreach my $dns (<$config>) {
9639: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 9640: my $line = $1;
9641: my ($host,$protocol) = split(/:/,$line);
9642: if ($protocol ne 'https') {
9643: $protocol = 'http';
9644: }
9645: $alldns{$host} = $protocol;
1.869 albertel 9646: }
9647: while (%alldns) {
9648: my ($dns) = keys(%alldns);
1.852 albertel 9649: my $ua=new LWP::UserAgent;
1.979 raeburn 9650: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 9651: my $response=$ua->request($request);
1.979 raeburn 9652: delete($alldns{$dns});
1.852 albertel 9653: next if ($response->is_error());
9654: my @content = split("\n",$response->content);
1.869 albertel 9655: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 9656: &$func(\@content);
1.869 albertel 9657: return;
1.852 albertel 9658: }
9659: close($config);
1.871 albertel 9660: my $which = (split('/',$url))[3];
9661: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9662: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 9663: my @content = <$config>;
9664: &$func(\@content);
9665: return;
1.852 albertel 9666: }
1.327 albertel 9667: # ------------------------------------------------------------ Read domain file
9668: {
1.852 albertel 9669: my $loaded;
1.846 albertel 9670: my %domain;
9671:
1.852 albertel 9672: sub parse_domain_tab {
9673: my ($lines) = @_;
9674: foreach my $line (@$lines) {
9675: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 9676:
1.846 albertel 9677: chomp($line);
1.852 albertel 9678: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 9679: my %this_domain;
9680: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9681: 'lang_def', 'city', 'longi', 'lati',
9682: 'primary') {
9683: $this_domain{$field} = shift(@elements);
9684: }
9685: $domain{$name} = \%this_domain;
1.852 albertel 9686: }
9687: }
1.864 albertel 9688:
9689: sub reset_domain_info {
9690: undef($loaded);
9691: undef(%domain);
9692: }
9693:
1.852 albertel 9694: sub load_domain_tab {
1.869 albertel 9695: my ($ignore_cache) = @_;
9696: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 9697: my $fh;
9698: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9699: my @lines = <$fh>;
9700: &parse_domain_tab(\@lines);
1.448 albertel 9701: }
1.852 albertel 9702: close($fh);
9703: $loaded = 1;
1.327 albertel 9704: }
1.846 albertel 9705:
9706: sub domain {
1.852 albertel 9707: &load_domain_tab() if (!$loaded);
9708:
1.846 albertel 9709: my ($name,$what) = @_;
9710: return if ( !exists($domain{$name}) );
9711:
9712: if (!$what) {
9713: return $domain{$name}{'description'};
9714: }
9715: return $domain{$name}{$what};
9716: }
1.974 raeburn 9717:
9718: sub domain_info {
9719: &load_domain_tab() if (!$loaded);
9720: return %domain;
9721: }
9722:
1.327 albertel 9723: }
9724:
9725:
1.1 albertel 9726: # ------------------------------------------------------------- Read hosts file
9727: {
1.838 albertel 9728: my %hostname;
1.844 albertel 9729: my %hostdom;
1.845 albertel 9730: my %libserv;
1.852 albertel 9731: my $loaded;
1.888 albertel 9732: my %name_to_host;
1.852 albertel 9733:
9734: sub parse_hosts_tab {
9735: my ($file) = @_;
9736: foreach my $configline (@$file) {
9737: next if ($configline =~ /^(\#|\s*$ )/x);
9738: next if ($configline =~ /^\^/);
9739: chomp($configline);
1.968 raeburn 9740: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852 albertel 9741: $name=~s/\s//g;
9742: if ($id && $domain && $role && $name) {
9743: $hostname{$id}=$name;
1.888 albertel 9744: push(@{$name_to_host{$name}}, $id);
1.852 albertel 9745: $hostdom{$id}=$domain;
9746: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 9747: if (defined($protocol)) {
9748: if ($protocol eq 'https') {
9749: $protocol{$id} = $protocol;
9750: } else {
9751: $protocol{$id} = 'http';
9752: }
1.968 raeburn 9753: } else {
1.969 raeburn 9754: $protocol{$id} = 'http';
1.968 raeburn 9755: }
1.852 albertel 9756: }
9757: }
9758: }
1.864 albertel 9759:
9760: sub reset_hosts_info {
1.897 albertel 9761: &purge_remembered();
1.864 albertel 9762: &reset_domain_info();
9763: &reset_hosts_ip_info();
1.892 albertel 9764: undef(%name_to_host);
1.864 albertel 9765: undef(%hostname);
9766: undef(%hostdom);
9767: undef(%libserv);
9768: undef($loaded);
9769: }
1.1 albertel 9770:
1.852 albertel 9771: sub load_hosts_tab {
1.869 albertel 9772: my ($ignore_cache) = @_;
9773: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 9774: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9775: my @config = <$config>;
9776: &parse_hosts_tab(\@config);
9777: close($config);
9778: $loaded=1;
1.1 albertel 9779: }
1.852 albertel 9780:
1.838 albertel 9781: sub hostname {
1.852 albertel 9782: &load_hosts_tab() if (!$loaded);
9783:
1.838 albertel 9784: my ($lonid) = @_;
9785: return $hostname{$lonid};
9786: }
1.845 albertel 9787:
1.838 albertel 9788: sub all_hostnames {
1.852 albertel 9789: &load_hosts_tab() if (!$loaded);
9790:
1.838 albertel 9791: return %hostname;
9792: }
1.845 albertel 9793:
1.888 albertel 9794: sub all_names {
9795: &load_hosts_tab() if (!$loaded);
9796:
9797: return %name_to_host;
9798: }
9799:
1.974 raeburn 9800: sub all_host_domain {
9801: &load_hosts_tab() if (!$loaded);
9802: return %hostdom;
9803: }
9804:
1.845 albertel 9805: sub is_library {
1.852 albertel 9806: &load_hosts_tab() if (!$loaded);
9807:
1.845 albertel 9808: return exists($libserv{$_[0]});
9809: }
9810:
9811: sub all_library {
1.852 albertel 9812: &load_hosts_tab() if (!$loaded);
9813:
1.845 albertel 9814: return %libserv;
9815: }
9816:
1.841 albertel 9817: sub get_servers {
1.852 albertel 9818: &load_hosts_tab() if (!$loaded);
9819:
1.841 albertel 9820: my ($domain,$type) = @_;
9821: my %possible_hosts = ($type eq 'library') ? %libserv
9822: : %hostname;
9823: my %result;
1.842 albertel 9824: if (ref($domain) eq 'ARRAY') {
9825: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 9826: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 9827: $result{$host} = $hostname;
9828: }
9829: }
9830: } else {
9831: while ( my ($host,$hostname) = each(%possible_hosts)) {
9832: if ($hostdom{$host} eq $domain) {
9833: $result{$host} = $hostname;
9834: }
1.841 albertel 9835: }
9836: }
9837: return %result;
9838: }
1.845 albertel 9839:
1.844 albertel 9840: sub host_domain {
1.852 albertel 9841: &load_hosts_tab() if (!$loaded);
9842:
1.844 albertel 9843: my ($lonid) = @_;
9844: return $hostdom{$lonid};
9845: }
9846:
1.841 albertel 9847: sub all_domains {
1.852 albertel 9848: &load_hosts_tab() if (!$loaded);
9849:
1.841 albertel 9850: my %seen;
9851: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9852: return @uniq;
9853: }
1.1 albertel 9854: }
9855:
1.847 albertel 9856: {
9857: my %iphost;
1.856 albertel 9858: my %name_to_ip;
9859: my %lonid_to_ip;
1.869 albertel 9860:
1.847 albertel 9861: sub get_hosts_from_ip {
9862: my ($ip) = @_;
9863: my %iphosts = &get_iphost();
9864: if (ref($iphosts{$ip})) {
9865: return @{$iphosts{$ip}};
9866: }
9867: return;
1.839 albertel 9868: }
1.864 albertel 9869:
9870: sub reset_hosts_ip_info {
9871: undef(%iphost);
9872: undef(%name_to_ip);
9873: undef(%lonid_to_ip);
9874: }
1.856 albertel 9875:
9876: sub get_host_ip {
9877: my ($lonid) = @_;
9878: if (exists($lonid_to_ip{$lonid})) {
9879: return $lonid_to_ip{$lonid};
9880: }
9881: my $name=&hostname($lonid);
9882: my $ip = gethostbyname($name);
9883: return if (!$ip || length($ip) ne 4);
9884: $ip=inet_ntoa($ip);
9885: $name_to_ip{$name} = $ip;
9886: $lonid_to_ip{$lonid} = $ip;
9887: return $ip;
9888: }
1.847 albertel 9889:
9890: sub get_iphost {
1.869 albertel 9891: my ($ignore_cache) = @_;
1.894 albertel 9892:
1.869 albertel 9893: if (!$ignore_cache) {
9894: if (%iphost) {
9895: return %iphost;
9896: }
9897: my ($ip_info,$cached)=
9898: &Apache::lonnet::is_cached_new('iphost','iphost');
9899: if ($cached) {
9900: %iphost = %{$ip_info->[0]};
9901: %name_to_ip = %{$ip_info->[1]};
9902: %lonid_to_ip = %{$ip_info->[2]};
9903: return %iphost;
9904: }
9905: }
1.894 albertel 9906:
9907: # get yesterday's info for fallback
9908: my %old_name_to_ip;
9909: my ($ip_info,$cached)=
9910: &Apache::lonnet::is_cached_new('iphost','iphost');
9911: if ($cached) {
9912: %old_name_to_ip = %{$ip_info->[1]};
9913: }
9914:
1.888 albertel 9915: my %name_to_host = &all_names();
9916: foreach my $name (keys(%name_to_host)) {
1.847 albertel 9917: my $ip;
9918: if (!exists($name_to_ip{$name})) {
9919: $ip = gethostbyname($name);
9920: if (!$ip || length($ip) ne 4) {
1.894 albertel 9921: if (defined($old_name_to_ip{$name})) {
9922: $ip = $old_name_to_ip{$name};
9923: &logthis("Can't find $name defaulting to old $ip");
9924: } else {
9925: &logthis("Name $name no IP found");
9926: next;
9927: }
9928: } else {
9929: $ip=inet_ntoa($ip);
1.847 albertel 9930: }
9931: $name_to_ip{$name} = $ip;
9932: } else {
9933: $ip = $name_to_ip{$name};
1.653 albertel 9934: }
1.888 albertel 9935: foreach my $id (@{ $name_to_host{$name} }) {
9936: $lonid_to_ip{$id} = $ip;
9937: }
9938: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 9939: }
1.869 albertel 9940: &Apache::lonnet::do_cache_new('iphost','iphost',
9941: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 9942: 48*60*60);
1.869 albertel 9943:
1.847 albertel 9944: return %iphost;
1.598 albertel 9945: }
9946:
1.992 raeburn 9947: #
9948: # Given a DNS returns the loncapa host name for that DNS
9949: #
9950: sub host_from_dns {
9951: my ($dns) = @_;
9952: my @hosts;
9953: my $ip;
9954:
1.993 raeburn 9955: if (exists($name_to_ip{$dns})) {
1.992 raeburn 9956: $ip = $name_to_ip{$dns};
9957: }
9958: if (!$ip) {
9959: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9960: if (length($ip) == 4) {
9961: $ip = &IO::Socket::inet_ntoa($ip);
9962: }
9963: }
9964: if ($ip) {
9965: @hosts = get_hosts_from_ip($ip);
9966: return $hosts[0];
9967: }
9968: return undef;
1.986 foxr 9969: }
1.992 raeburn 9970:
1.986 foxr 9971: }
9972:
1.862 albertel 9973: BEGIN {
9974:
9975: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9976: unless ($readit) {
9977: {
9978: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9979: %perlvar = (%perlvar,%{$configvars});
9980: }
9981:
9982:
1.1 albertel 9983: # ------------------------------------------------------ Read spare server file
9984: {
1.448 albertel 9985: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 9986:
9987: while (my $configline=<$config>) {
9988: chomp($configline);
1.284 matthew 9989: if ($configline) {
1.784 albertel 9990: my ($host,$type) = split(':',$configline,2);
1.785 albertel 9991: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 9992: push(@{ $spareid{$type} }, $host);
1.1 albertel 9993: }
9994: }
1.448 albertel 9995: close($config);
1.1 albertel 9996: }
1.11 www 9997: # ------------------------------------------------------------ Read permissions
9998: {
1.448 albertel 9999: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 10000:
10001: while (my $configline=<$config>) {
1.448 albertel 10002: chomp($configline);
10003: if ($configline) {
10004: my ($role,$perm)=split(/ /,$configline);
10005: if ($perm ne '') { $pr{$role}=$perm; }
10006: }
1.11 www 10007: }
1.448 albertel 10008: close($config);
1.11 www 10009: }
10010:
10011: # -------------------------------------------- Read plain texts for permissions
10012: {
1.448 albertel 10013: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 10014:
10015: while (my $configline=<$config>) {
1.448 albertel 10016: chomp($configline);
10017: if ($configline) {
1.742 raeburn 10018: my ($short,@plain)=split(/:/,$configline);
10019: %{$prp{$short}} = ();
10020: if (@plain > 0) {
10021: $prp{$short}{'std'} = $plain[0];
10022: for (my $i=1; $i<@plain; $i++) {
10023: $prp{$short}{'alt'.$i} = $plain[$i];
10024: }
10025: }
1.448 albertel 10026: }
1.135 www 10027: }
1.448 albertel 10028: close($config);
1.135 www 10029: }
10030:
10031: # ---------------------------------------------------------- Read package table
10032: {
1.448 albertel 10033: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 10034:
10035: while (my $configline=<$config>) {
1.483 albertel 10036: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 10037: chomp($configline);
10038: my ($short,$plain)=split(/:/,$configline);
10039: my ($pack,$name)=split(/\&/,$short);
10040: if ($plain ne '') {
10041: $packagetab{$pack.'&'.$name.'&name'}=$name;
10042: $packagetab{$short}=$plain;
10043: }
1.11 www 10044: }
1.448 albertel 10045: close($config);
1.329 matthew 10046: }
10047:
10048: # ------------- set up temporary directory
10049: {
10050: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
10051:
1.11 www 10052: }
10053:
1.794 albertel 10054: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
10055: 'compress_threshold'=> 20_000,
10056: });
1.185 www 10057:
1.281 www 10058: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 10059: $dumpcount=0;
1.958 www 10060: $locknum=0;
1.22 www 10061:
1.163 harris41 10062: &logtouch();
1.672 albertel 10063: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 10064: $readit=1;
1.564 albertel 10065: {
10066: use integer;
10067: my $test=(2**32)+1;
1.568 albertel 10068: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 10069: &logthis(" Detected 64bit platform ($_64bit)");
10070: }
1.195 www 10071: }
1.1 albertel 10072: }
1.179 www 10073:
1.1 albertel 10074: 1;
1.191 harris41 10075: __END__
10076:
1.243 albertel 10077: =pod
10078:
1.191 harris41 10079: =head1 NAME
10080:
1.243 albertel 10081: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 10082:
10083: =head1 SYNOPSIS
10084:
1.243 albertel 10085: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 10086:
10087: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
10088:
1.243 albertel 10089: Common parameters:
10090:
10091: =over 4
10092:
10093: =item *
10094:
10095: $uname : an internal username (if $cname expecting a course Id specifically)
10096:
10097: =item *
10098:
10099: $udom : a domain (if $cdom expecting a course's domain specifically)
10100:
10101: =item *
10102:
10103: $symb : a resource instance identifier
10104:
10105: =item *
10106:
10107: $namespace : the name of a .db file that contains the data needed or
10108: being set.
10109:
10110: =back
10111:
1.394 bowersj2 10112: =head1 OVERVIEW
1.191 harris41 10113:
1.394 bowersj2 10114: lonnet provides subroutines which interact with the
10115: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
10116: about classes, users, and resources.
1.243 albertel 10117:
10118: For many of these objects you can also use this to store data about
10119: them or modify them in various ways.
1.191 harris41 10120:
1.394 bowersj2 10121: =head2 Symbs
1.191 harris41 10122:
1.394 bowersj2 10123: To identify a specific instance of a resource, LON-CAPA uses symbols
10124: or "symbs"X<symb>. These identifiers are built from the URL of the
10125: map, the resource number of the resource in the map, and the URL of
10126: the resource itself. The latter is somewhat redundant, but might help
10127: if maps change.
10128:
10129: An example is
10130:
10131: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
10132:
10133: The respective map entry is
10134:
10135: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10136: title="Problem 2">
10137: </resource>
10138:
10139: Symbs are used by the random number generator, as well as to store and
10140: restore data specific to a certain instance of for example a problem.
10141:
10142: =head2 Storing And Retrieving Data
10143:
10144: X<store()>X<cstore()>X<restore()>Three of the most important functions
10145: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10146: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10147: is is the non-critical message twin of cstore. These functions are for
10148: handlers to store a perl hash to a user's permanent data space in an
10149: easy manner, and to retrieve it again on another call. It is expected
10150: that a handler would use this once at the beginning to retrieve data,
10151: and then again once at the end to send only the new data back.
10152:
10153: The data is stored in the user's data directory on the user's
10154: homeserver under the ID of the course.
10155:
10156: The hash that is returned by restore will have all of the previous
10157: value for all of the elements of the hash.
10158:
10159: Example:
10160:
10161: #creating a hash
10162: my %hash;
10163: $hash{'foo'}='bar';
10164:
10165: #storing it
10166: &Apache::lonnet::cstore(\%hash);
10167:
10168: #changing a value
10169: $hash{'foo'}='notbar';
10170:
10171: #adding a new value
10172: $hash{'bar'}='foo';
10173: &Apache::lonnet::cstore(\%hash);
10174:
10175: #retrieving the hash
10176: my %history=&Apache::lonnet::restore();
10177:
10178: #print the hash
10179: foreach my $key (sort(keys(%history))) {
10180: print("\%history{$key} = $history{$key}");
10181: }
10182:
10183: Will print out:
1.191 harris41 10184:
1.394 bowersj2 10185: %history{1:foo} = bar
10186: %history{1:keys} = foo:timestamp
10187: %history{1:timestamp} = 990455579
10188: %history{2:bar} = foo
10189: %history{2:foo} = notbar
10190: %history{2:keys} = foo:bar:timestamp
10191: %history{2:timestamp} = 990455580
10192: %history{bar} = foo
10193: %history{foo} = notbar
10194: %history{timestamp} = 990455580
10195: %history{version} = 2
10196:
10197: Note that the special hash entries C<keys>, C<version> and
10198: C<timestamp> were added to the hash. C<version> will be equal to the
10199: total number of versions of the data that have been stored. The
10200: C<timestamp> attribute will be the UNIX time the hash was
10201: stored. C<keys> is available in every historical section to list which
10202: keys were added or changed at a specific historical revision of a
10203: hash.
10204:
10205: B<Warning>: do not store the hash that restore returns directly. This
10206: will cause a mess since it will restore the historical keys as if the
10207: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 10208:
1.394 bowersj2 10209: Calling convention:
1.191 harris41 10210:
1.394 bowersj2 10211: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10212: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 10213:
1.394 bowersj2 10214: For more detailed information, see lonnet specific documentation.
1.191 harris41 10215:
1.394 bowersj2 10216: =head1 RETURN MESSAGES
1.191 harris41 10217:
1.394 bowersj2 10218: =over 4
1.191 harris41 10219:
1.394 bowersj2 10220: =item * B<con_lost>: unable to contact remote host
1.191 harris41 10221:
1.394 bowersj2 10222: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10223: when the connection is brought back up
1.191 harris41 10224:
1.394 bowersj2 10225: =item * B<con_failed>: unable to contact remote host and unable to save message
10226: for later delivery
1.191 harris41 10227:
1.967 bisitz 10228: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 10229:
1.394 bowersj2 10230: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 10231: that was requested
1.191 harris41 10232:
1.243 albertel 10233: =back
1.191 harris41 10234:
1.243 albertel 10235: =head1 PUBLIC SUBROUTINES
1.191 harris41 10236:
1.243 albertel 10237: =head2 Session Environment Functions
1.191 harris41 10238:
1.243 albertel 10239: =over 4
1.191 harris41 10240:
1.394 bowersj2 10241: =item *
10242: X<appenv()>
1.949 raeburn 10243: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 10244: the user envirnoment file, and will be restored for each access this
1.620 albertel 10245: user makes during this session, also modifies the %env for the current
1.949 raeburn 10246: process. Optional rolesarrayref - if defined contains a reference to an array
10247: of roles which are exempt from the restriction on modifying user.role entries
10248: in the user's environment.db and in %env.
1.191 harris41 10249:
10250: =item *
1.394 bowersj2 10251: X<delenv()>
1.987 raeburn 10252: B<delenv($delthis,$regexp)>: removes all items from the session
10253: environment file that begin with $delthis. If the
10254: optional second arg - $regexp - is true, $delthis is treated as a
10255: regular expression, otherwise \Q$delthis\E is used.
10256: The values are also deleted from the current processes %env.
1.191 harris41 10257:
1.795 albertel 10258: =item * get_env_multiple($name)
10259:
10260: gets $name from the %env hash, it seemlessly handles the cases where multiple
10261: values may be defined and end up as an array ref.
10262:
10263: returns an array of values
10264:
1.243 albertel 10265: =back
10266:
10267: =head2 User Information
1.191 harris41 10268:
1.243 albertel 10269: =over 4
1.191 harris41 10270:
10271: =item *
1.394 bowersj2 10272: X<queryauthenticate()>
10273: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 10274: authentication scheme
10275:
10276: =item *
1.394 bowersj2 10277: X<authenticate()>
10278: B<authenticate($uname,$upass,$udom)>: try to
10279: authenticate user from domain's lib servers (first use the current
10280: one). C<$upass> should be the users password.
1.191 harris41 10281:
10282: =item *
1.394 bowersj2 10283: X<homeserver()>
10284: B<homeserver($uname,$udom)>: find the server which has
10285: the user's directory and files (there must be only one), this caches
10286: the answer, and also caches if there is a borken connection.
1.191 harris41 10287:
10288: =item *
1.394 bowersj2 10289: X<idget()>
10290: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10291: (IDs are a unique resource in a domain, there must be only 1 ID per
10292: username, and only 1 username per ID in a specific domain) (returns
10293: hash: id=>name,id=>name)
1.191 harris41 10294:
10295: =item *
1.394 bowersj2 10296: X<idrget()>
10297: B<idrget($udom,@unames)>: find the IDs behind a list of
10298: usernames (returns hash: name=>id,name=>id)
1.191 harris41 10299:
10300: =item *
1.394 bowersj2 10301: X<idput()>
10302: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 10303:
10304: =item *
1.394 bowersj2 10305: X<rolesinit()>
10306: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 10307:
10308: =item *
1.551 albertel 10309: X<getsection()>
10310: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 10311: course $cname, return section name/number or '' for "not in course"
10312: and '-1' for "no section"
10313:
10314: =item *
1.394 bowersj2 10315: X<userenvironment()>
10316: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 10317: passed in @what from the requested user's environment, returns a hash
10318:
1.858 raeburn 10319: =item *
10320: X<userlog_query()>
1.859 albertel 10321: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10322: activity.log file. %filters defines filters applied when parsing the
10323: log file. These can be start or end timestamps, or the type of action
10324: - log to look for Login or Logout events, check for Checkin or
10325: Checkout, role for role selection. The response is in the form
10326: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10327: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 10328:
1.243 albertel 10329: =back
10330:
10331: =head2 User Roles
10332:
10333: =over 4
10334:
10335: =item *
10336:
1.810 raeburn 10337: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 10338: F: full access
10339: U,I,K: authentication modes (cxx only)
10340: '': forbidden
10341: 1: user needs to choose course
10342: 2: browse allowed
1.766 albertel 10343: A: passphrase authentication needed
1.243 albertel 10344:
10345: =item *
10346:
10347: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10348: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10349: and course level
10350:
10351: =item *
10352:
1.988 raeburn 10353: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10354: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 10355: $type is Course (default) or Community.
1.988 raeburn 10356: If $forcedefault evaluates to true, text returned will be default
10357: text for $type. Otherwise, if this is a course, the text returned
10358: will be a custom name for the role (if defined in the course's
10359: environment). If no custom name is defined the default is returned.
10360:
1.832 raeburn 10361: =item *
10362:
1.935 raeburn 10363: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 10364: All arguments are optional. Returns a hash of a roles, either for
10365: co-author/assistant author roles for a user's Construction Space
1.906 albertel 10366: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 10367: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10368: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10369: For each key, value is set to colon-separated start and end times for
10370: the role. If no username and domain are specified, will default to
1.934 raeburn 10371: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 10372: of role statuses (active, future or previous), roles
10373: (e.g., cc,in, st etc.) and domains of the roles which can be used
10374: to restrict the list of roles reported. If no array ref is
10375: provided for types, will default to return only active roles.
1.834 albertel 10376:
1.243 albertel 10377: =back
10378:
10379: =head2 User Modification
10380:
10381: =over 4
10382:
10383: =item *
10384:
1.957 raeburn 10385: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 10386: user for the level given by URL. Optional start and end dates (leave empty
10387: string or zero for "no date")
1.191 harris41 10388:
10389: =item *
10390:
1.243 albertel 10391: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10392: change a users, password, possible return values are: ok,
10393: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10394: refused
1.191 harris41 10395:
10396: =item *
10397:
1.243 albertel 10398: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 10399:
10400: =item *
10401:
1.1056.2.1 raeburn 10402: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
10403: $forceid,$desiredhome,$email,$inststatus,$candelete) :
10404:
10405: will update user information (firstname,middlename,lastname,generation,
10406: permanentemail), and if forceid is true, student/employee ID also.
10407: A user's institutional affiliation(s) can also be updated.
10408: User information fields will not be overwritten with empty entries
10409: unless the field is included in the $candelete array reference.
10410: This array is included when a single user is modified via "Manage Users",
10411: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 10412:
10413: =item *
10414:
1.286 matthew 10415: modifystudent
10416:
1.957 raeburn 10417: modify a student's enrollment and identification information.
1.286 matthew 10418: The course id is resolved based on the current users environment.
10419: This means the envoking user must be a course coordinator or otherwise
10420: associated with a course.
10421:
1.297 matthew 10422: This call is essentially a wrapper for lonnet::modifyuser and
10423: lonnet::modify_student_enrollment
1.286 matthew 10424:
10425: Inputs:
10426:
10427: =over 4
10428:
1.957 raeburn 10429: =item B<$udom> Student's loncapa domain
1.286 matthew 10430:
1.957 raeburn 10431: =item B<$uname> Student's loncapa login name
1.286 matthew 10432:
1.964 bisitz 10433: =item B<$uid> Student/Employee ID
1.286 matthew 10434:
1.957 raeburn 10435: =item B<$umode> Student's authentication mode
1.286 matthew 10436:
1.957 raeburn 10437: =item B<$upass> Student's password
1.286 matthew 10438:
1.957 raeburn 10439: =item B<$first> Student's first name
1.286 matthew 10440:
1.957 raeburn 10441: =item B<$middle> Student's middle name
1.286 matthew 10442:
1.957 raeburn 10443: =item B<$last> Student's last name
1.286 matthew 10444:
1.957 raeburn 10445: =item B<$gene> Student's generation
1.286 matthew 10446:
1.957 raeburn 10447: =item B<$usec> Student's section in course
1.286 matthew 10448:
10449: =item B<$end> Unix time of the roles expiration
10450:
10451: =item B<$start> Unix time of the roles start date
10452:
10453: =item B<$forceid> If defined, allow $uid to be changed
10454:
10455: =item B<$desiredhome> server to use as home server for student
10456:
1.957 raeburn 10457: =item B<$email> Student's permanent e-mail address
10458:
10459: =item B<$type> Type of enrollment (auto or manual)
10460:
1.963 raeburn 10461: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10462:
10463: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 10464:
1.963 raeburn 10465: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 10466:
1.963 raeburn 10467: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 10468:
1.963 raeburn 10469: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 10470:
1.286 matthew 10471: =back
1.297 matthew 10472:
10473: =item *
10474:
10475: modify_student_enrollment
10476:
10477: Change a students enrollment status in a class. The environment variable
10478: 'role.request.course' must be defined for this function to proceed.
10479:
10480: Inputs:
10481:
10482: =over 4
10483:
10484: =item $udom, students domain
10485:
10486: =item $uname, students name
10487:
10488: =item $uid, students user id
10489:
10490: =item $first, students first name
10491:
10492: =item $middle
10493:
10494: =item $last
10495:
10496: =item $gene
10497:
10498: =item $usec
10499:
10500: =item $end
10501:
10502: =item $start
10503:
1.957 raeburn 10504: =item $type
10505:
10506: =item $locktype
10507:
10508: =item $cid
10509:
10510: =item $selfenroll
10511:
10512: =item $context
10513:
1.297 matthew 10514: =back
10515:
1.191 harris41 10516:
10517: =item *
10518:
1.243 albertel 10519: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10520: custom role; give a custom role to a user for the level given by URL. Specify
10521: name and domain of role author, and role name
1.191 harris41 10522:
10523: =item *
10524:
1.243 albertel 10525: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 10526:
10527: =item *
10528:
1.243 albertel 10529: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10530:
10531: =back
10532:
10533: =head2 Course Infomation
10534:
10535: =over 4
1.191 harris41 10536:
10537: =item *
10538:
1.631 albertel 10539: coursedescription($courseid) : returns a hash of information about the
10540: specified course id, including all environment settings for the
10541: course, the description of the course will be in the hash under the
10542: key 'description'
1.191 harris41 10543:
10544: =item *
10545:
1.624 albertel 10546: resdata($name,$domain,$type,@which) : request for current parameter
10547: setting for a specific $type, where $type is either 'course' or 'user',
10548: @what should be a list of parameters to ask about. This routine caches
10549: answers for 5 minutes.
1.243 albertel 10550:
1.877 foxr 10551: =item *
10552:
10553: get_courseresdata($courseid, $domain) : dump the entire course resource
10554: data base, returning a hash that is keyed by the resource name and has
10555: values that are the resource value. I believe that the timestamps and
10556: versions are also returned.
10557:
10558:
1.243 albertel 10559: =back
10560:
10561: =head2 Course Modification
10562:
10563: =over 4
1.191 harris41 10564:
10565: =item *
10566:
1.243 albertel 10567: writecoursepref($courseid,%prefs) : write preferences (environment
10568: database) for a course
1.191 harris41 10569:
10570: =item *
10571:
1.1011 raeburn 10572: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10573:
10574: =item *
10575:
1.1038 raeburn 10576: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 10577:
10578: =back
10579:
10580: =head2 Resource Subroutines
10581:
10582: =over 4
1.191 harris41 10583:
10584: =item *
10585:
1.243 albertel 10586: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 10587:
10588: =item *
10589:
1.243 albertel 10590: repcopy($filename) : subscribes to the requested file, and attempts to
10591: replicate from the owning library server, Might return
1.607 raeburn 10592: 'unavailable', 'not_found', 'forbidden', 'ok', or
10593: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 10594: resource. Expects the local filesystem pathname
10595: (/home/httpd/html/res/....)
10596:
10597: =back
10598:
10599: =head2 Resource Information
10600:
10601: =over 4
1.191 harris41 10602:
10603: =item *
10604:
1.243 albertel 10605: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10606: a vairety of different possible values, $varname should be a request
10607: string, and the other parameters can be used to specify who and what
10608: one is asking about.
10609:
10610: Possible values for $varname are environment.lastname (or other item
10611: from the envirnment hash), user.name (or someother aspect about the
10612: user), resource.0.maxtries (or some other part and parameter of a
10613: resource)
1.204 albertel 10614:
10615: =item *
10616:
1.243 albertel 10617: directcondval($number) : get current value of a condition; reads from a state
10618: string
1.204 albertel 10619:
10620: =item *
10621:
1.243 albertel 10622: condval($condidx) : value of condition index based on state
1.204 albertel 10623:
10624: =item *
10625:
1.243 albertel 10626: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10627: resource's metadata, $what should be either a specific key, or either
10628: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10629: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10630:
10631: this function automatically caches all requests
1.191 harris41 10632:
10633: =item *
10634:
1.243 albertel 10635: metadata_query($query,$custom,$customshow) : make a metadata query against the
10636: network of library servers; returns file handle of where SQL and regex results
10637: will be stored for query
1.191 harris41 10638:
10639: =item *
10640:
1.243 albertel 10641: symbread($filename) : return symbolic list entry (filename argument optional);
10642: returns the data handle
1.191 harris41 10643:
10644: =item *
10645:
1.243 albertel 10646: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 10647: a possible symb for the URL in $thisfn, and if is an encryypted
10648: resource that the user accessed using /enc/ returns a 1 on success, 0
10649: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 10650: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 10651:
1.191 harris41 10652:
10653: =item *
10654:
1.243 albertel 10655: symbclean($symb) : removes versions numbers from a symb, returns the
10656: cleaned symb
1.191 harris41 10657:
10658: =item *
10659:
1.243 albertel 10660: is_on_map($uri) : checks if the $uri is somewhere on the current
10661: course map, user must be in a course for it to work.
1.191 harris41 10662:
10663: =item *
10664:
1.243 albertel 10665: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 10666:
10667: =item *
10668:
1.243 albertel 10669: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10670: a random seed, all arguments are optional, if they aren't sent it uses the
10671: environment to derive them. Note: if symb isn't sent and it can't get one
10672: from &symbread it will use the current time as its return value
1.191 harris41 10673:
10674: =item *
10675:
1.243 albertel 10676: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10677: unfakeable, receipt
1.191 harris41 10678:
10679: =item *
10680:
1.620 albertel 10681: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 10682:
10683: =item *
10684:
1.243 albertel 10685: countacc($url) : count the number of accesses to a given URL
1.191 harris41 10686:
10687: =item *
10688:
1.243 albertel 10689: 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 10690:
10691: =item *
10692:
1.243 albertel 10693: 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 10694:
10695: =item *
10696:
1.243 albertel 10697: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 10698:
10699: =item *
10700:
1.243 albertel 10701: devalidate($symb) : devalidate temporary spreadsheet calculations,
10702: forcing spreadsheet to reevaluate the resource scores next time.
10703:
10704: =back
10705:
10706: =head2 Storing/Retreiving Data
10707:
10708: =over 4
1.191 harris41 10709:
10710: =item *
10711:
1.243 albertel 10712: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10713: for this url; hashref needs to be given and should be a \%hashname; the
10714: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 10715: be derived from the env
1.191 harris41 10716:
10717: =item *
10718:
1.243 albertel 10719: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10720: uses critical subroutine
1.191 harris41 10721:
10722: =item *
10723:
1.243 albertel 10724: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10725: all args are optional
1.191 harris41 10726:
10727: =item *
10728:
1.717 albertel 10729: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10730: dumps the complete (or key matching regexp) namespace into a hash
10731: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10732: normally &store()ed into
10733:
10734: $range should be either an integer '100' (give me the first 100
10735: matching records)
10736: or be two integers sperated by a - with no spaces
10737: '30-50' (give me the 30th through the 50th matching
10738: records)
10739:
10740:
10741: =item *
10742:
10743: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10744: replaces a &store() version of data with a replacement set of data
10745: for a particular resource in a namespace passed in the $storehash hash
10746: reference
10747:
10748: =item *
10749:
1.243 albertel 10750: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10751: works very similar to store/cstore, but all data is stored in a
10752: temporary location and can be reset using tmpreset, $storehash should
10753: be a hash reference, returns nothing on success
1.191 harris41 10754:
10755: =item *
10756:
1.243 albertel 10757: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10758: similar to restore, but all data is stored in a temporary location and
10759: can be reset using tmpreset. Returns a hash of values on success,
10760: error string otherwise.
1.191 harris41 10761:
10762: =item *
10763:
1.243 albertel 10764: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10765: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 10766:
10767: =item *
10768:
1.243 albertel 10769: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10770: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 10771:
10772: =item *
10773:
1.243 albertel 10774: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10775: namesp ($udom and $uname are optional)
1.191 harris41 10776:
10777: =item *
10778:
1.702 albertel 10779: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 10780: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 10781: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 10782:
1.702 albertel 10783: $range should be either an integer '100' (give me the first 100
10784: matching records)
10785: or be two integers sperated by a - with no spaces
10786: '30-50' (give me the 30th through the 50th matching
10787: records)
1.449 matthew 10788: =item *
10789:
10790: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10791: $store can be a scalar, an array reference, or if the amount to be
10792: incremented is > 1, a hash reference.
10793:
10794: ($udom and $uname are optional)
1.191 harris41 10795:
10796: =item *
10797:
1.243 albertel 10798: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10799: ($udom and $uname are optional)
1.191 harris41 10800:
10801: =item *
10802:
1.243 albertel 10803: cput($namespace,$storehash,$udom,$uname) : critical put
10804: ($udom and $uname are optional)
1.191 harris41 10805:
10806: =item *
10807:
1.748 albertel 10808: newput($namespace,$storehash,$udom,$uname) :
10809:
10810: Attempts to store the items in the $storehash, but only if they don't
10811: currently exist, if this succeeds you can be certain that you have
10812: successfully created a new key value pair in the $namespace db.
10813:
10814:
10815: Args:
10816: $namespace: name of database to store values to
10817: $storehash: hashref to store to the db
10818: $udom: (optional) domain of user containing the db
10819: $uname: (optional) name of user caontaining the db
10820:
10821: Returns:
10822: 'ok' -> succeeded in storing all keys of $storehash
10823: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10824: least <key> already existed in the db (other
10825: requested keys may also already exist)
1.967 bisitz 10826: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 10827: 'con_lost' -> unable to contact request server
10828: 'refused' -> action was not allowed by remote machine
10829:
10830:
10831: =item *
10832:
1.243 albertel 10833: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10834: reference filled in from namesp (encrypts the return communication)
10835: ($udom and $uname are optional)
1.191 harris41 10836:
10837: =item *
10838:
1.243 albertel 10839: log($udom,$name,$home,$message) : write to permanent log for user; use
10840: critical subroutine
10841:
1.806 raeburn 10842: =item *
10843:
1.860 raeburn 10844: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10845: array reference filled in from namespace found in domain level on either
10846: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 10847:
10848: =item *
10849:
1.860 raeburn 10850: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10851: domain level either on specified domain server ($uhome) or primary domain
10852: server ($udom and $uhome are optional)
1.806 raeburn 10853:
1.943 raeburn 10854: =item *
10855:
10856: get_domain_defaults($target_domain) : returns hash with defaults for
10857: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10858: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10859: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10860: Values are retrieved from cache (if current), or from domain's configuration.db
10861: (if available), or lastly from values in lonTabs/dns_domain,tab,
10862: or lonTabs/domain.tab.
10863:
10864: %domdefaults = &get_auth_defaults($target_domain);
10865:
1.243 albertel 10866: =back
10867:
10868: =head2 Network Status Functions
10869:
10870: =over 4
1.191 harris41 10871:
10872: =item *
10873:
10874: dirlist($uri) : return directory list based on URI
10875:
10876: =item *
10877:
1.243 albertel 10878: spareserver() : find server with least workload from spare.tab
10879:
1.986 foxr 10880:
10881: =item *
10882:
10883: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10884: if there is no corresponding loncapa host.
10885:
1.243 albertel 10886: =back
10887:
1.986 foxr 10888:
1.243 albertel 10889: =head2 Apache Request
10890:
10891: =over 4
1.191 harris41 10892:
10893: =item *
10894:
1.243 albertel 10895: ssi($url,%hash) : server side include, does a complete request cycle on url to
10896: localhost, posts hash
10897:
10898: =back
10899:
10900: =head2 Data to String to Data
10901:
10902: =over 4
1.191 harris41 10903:
10904: =item *
10905:
1.243 albertel 10906: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10907: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 10908:
10909: =item *
10910:
1.243 albertel 10911: hashref2str($hashref) : convert a hashref into a string complete with
10912: escaping and '=' and '&' separators, supports elements that are
10913: arrayrefs and hashrefs
1.191 harris41 10914:
10915: =item *
10916:
1.243 albertel 10917: arrayref2str($arrayref) : convert an arrayref into a string complete
10918: with escaping and '&' separators, supports elements that are arrayrefs
10919: and hashrefs
1.191 harris41 10920:
10921: =item *
10922:
1.243 albertel 10923: str2hash($string) : convert string to hash using unescaping and
10924: splitting on '=' and '&', supports elements that are arrayrefs and
10925: hashrefs
1.191 harris41 10926:
10927: =item *
10928:
1.243 albertel 10929: str2array($string) : convert string to hash using unescaping and
10930: splitting on '&', supports elements that are arrayrefs and hashrefs
10931:
10932: =back
10933:
10934: =head2 Logging Routines
10935:
10936: =over 4
10937:
10938: These routines allow one to make log messages in the lonnet.log and
10939: lonnet.perm logfiles.
1.191 harris41 10940:
10941: =item *
10942:
1.243 albertel 10943: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 10944:
10945: =item *
10946:
1.243 albertel 10947: logthis() : append message to the normal lonnet.log file, it gets
10948: preiodically rolled over and deleted.
1.191 harris41 10949:
10950: =item *
10951:
1.243 albertel 10952: logperm() : append a permanent message to lonnet.perm.log, this log
10953: file never gets deleted by any automated portion of the system, only
10954: messages of critical importance should go in here.
10955:
10956: =back
10957:
10958: =head2 General File Helper Routines
10959:
10960: =over 4
1.191 harris41 10961:
10962: =item *
10963:
1.481 raeburn 10964: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10965: (a) files in /uploaded
10966: (i) If a local copy of the file exists -
10967: compares modification date of local copy with last-modified date for
10968: definitive version stored on home server for course. If local copy is
10969: stale, requests a new version from the home server and stores it.
10970: If the original has been removed from the home server, then local copy
10971: is unlinked.
10972: (ii) If local copy does not exist -
10973: requests the file from the home server and stores it.
10974:
10975: If $caller is 'uploadrep':
10976: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10977: for request for files originally uploaded via DOCS.
10978: - returns 'ok' if fresh local copy now available, -1 otherwise.
10979:
10980: Otherwise:
10981: This indicates a call from the content generation phase of the request.
10982: - returns the entire contents of the file or -1.
10983:
10984: (b) files in /res
10985: - returns the entire contents of a file or -1;
10986: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 10987:
1.712 albertel 10988:
10989: =item *
10990:
10991: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10992: reference
10993:
10994: returns either a stat() list of data about the file or an empty list
10995: if the file doesn't exist or couldn't find out about it (connection
10996: problems or user unknown)
10997:
1.191 harris41 10998: =item *
10999:
1.243 albertel 11000: filelocation($dir,$file) : returns file system location of a file
11001: based on URI; meant to be "fairly clean" absolute reference, $dir is a
11002: directory that relative $file lookups are to looked in ($dir of /a/dir
11003: and a file of ../bob will become /a/bob)
1.191 harris41 11004:
11005: =item *
11006:
11007: hreflocation($dir,$file) : returns file system location or a URL; same as
11008: filelocation except for hrefs
11009:
11010: =item *
11011:
11012: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
11013:
1.243 albertel 11014: =back
11015:
1.608 albertel 11016: =head2 Usererfile file routines (/uploaded*)
11017:
11018: =over 4
11019:
11020: =item *
11021:
11022: userfileupload(): main rotine for putting a file in a user or course's
11023: filespace, arguments are,
11024:
1.620 albertel 11025: formname - required - this is the name of the element in $env where the
1.608 albertel 11026: filename, and the contents of the file to create/modifed exist
1.620 albertel 11027: the filename is in $env{'form.'.$formname.'.filename'} and the
11028: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 11029: coursedoc - if true, store the file in the course of the active role
11030: of the current user
11031: subdir - required - subdirectory to put the file in under ../userfiles/
11032: if undefined, it will be placed in "unknown"
11033:
11034: (This routine calls clean_filename() to remove any dangerous
11035: characters from the filename, and then calls finuserfileupload() to
11036: complete the transaction)
11037:
11038: returns either the url of the uploaded file (/uploaded/....) if successful
11039: and /adm/notfound.html if unsuccessful
11040:
11041: =item *
11042:
11043: clean_filename(): routine for cleaing a filename up for storage in
11044: userfile space, argument is:
11045:
11046: filename - proposed filename
11047:
11048: returns: the new clean filename
11049:
11050: =item *
11051:
11052: finishuserfileupload(): routine that creaes and sends the file to
11053: userspace, probably shouldn't be called directly
11054:
11055: docuname: username or courseid of destination for the file
11056: docudom: domain of user/course of destination for the file
11057: formname: same as for userfileupload()
11058: fname: filename (inculding subdirectories) for the file
11059:
11060: returns either the url of the uploaded file (/uploaded/....) if successful
11061: and /adm/notfound.html if unsuccessful
11062:
11063: =item *
11064:
11065: renameuserfile(): renames an existing userfile to a new name
11066:
11067: Args:
11068: docuname: username or courseid of destination for the file
11069: docudom: domain of user/course of destination for the file
11070: old: current file name (including any subdirs under userfiles)
11071: new: desired file name (including any subdirs under userfiles)
11072:
11073: =item *
11074:
11075: mkdiruserfile(): creates a directory is a userfiles dir
11076:
11077: Args:
11078: docuname: username or courseid of destination for the file
11079: docudom: domain of user/course of destination for the file
11080: dir: dir to create (including any subdirs under userfiles)
11081:
11082: =item *
11083:
11084: removeuserfile(): removes a file that exists in userfiles
11085:
11086: Args:
11087: docuname: username or courseid of destination for the file
11088: docudom: domain of user/course of destination for the file
11089: fname: filname to delete (including any subdirs under userfiles)
11090:
11091: =item *
11092:
11093: removeuploadedurl(): convience function for removeuserfile()
11094:
11095: Args:
11096: url: a full /uploaded/... url to delete
11097:
1.747 albertel 11098: =item *
11099:
11100: get_portfile_permissions():
11101: Args:
11102: domain: domain of user or course contain the portfolio files
11103: user: name of user or num of course contain the portfolio files
11104: Returns:
11105: hashref of a dump of the proper file_permissions.db
11106:
11107:
11108: =item *
11109:
11110: get_access_controls():
11111:
11112: Args:
11113: current_permissions: the hash ref returned from get_portfile_permissions()
11114: group: (optional) the group you want the files associated with
11115: file: (optional) the file you want access info on
11116:
11117: Returns:
1.749 raeburn 11118: a hash (keys are file names) of hashes containing
11119: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
11120: values are XML containing access control settings (see below)
1.747 albertel 11121:
11122: Internal notes:
11123:
1.749 raeburn 11124: access controls are stored in file_permissions.db as key=value pairs.
11125: key -> path to file/file_name\0uniqueID:scope_end_start
11126: where scope -> public,guest,course,group,domains or users.
11127: end -> UNIX time for end of access (0 -> no end date)
11128: start -> UNIX time for start of access
11129:
11130: value -> XML description of access control
11131: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
11132: <start></start>
11133: <end></end>
11134:
11135: <password></password> for scope type = guest
11136:
11137: <domain></domain> for scope type = course or group
11138: <number></number>
11139: <roles id="">
11140: <role></role>
11141: <access></access>
11142: <section></section>
11143: <group></group>
11144: </roles>
11145:
11146: <dom></dom> for scope type = domains
11147:
11148: <users> for scope type = users
11149: <user>
11150: <uname></uname>
11151: <udom></udom>
11152: </user>
11153: </users>
11154: </scope>
11155:
11156: Access data is also aggregated for each file in an additional key=value pair:
11157: key -> path to file/file_name\0accesscontrol
11158: value -> reference to hash
11159: hash contains key = value pairs
11160: where key = uniqueID:scope_end_start
11161: value = UNIX time record was last updated
11162:
11163: Used to improve speed of look-ups of access controls for each file.
11164:
11165: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11166:
11167: modify_access_controls():
11168:
11169: Modifies access controls for a portfolio file
11170: Args
11171: 1. file name
11172: 2. reference to hash of required changes,
11173: 3. domain
11174: 4. username
11175: where domain,username are the domain of the portfolio owner
11176: (either a user or a course)
11177:
11178: Returns:
11179: 1. result of additions or updates ('ok' or 'error', with error message).
11180: 2. result of deletions ('ok' or 'error', with error message).
11181: 3. reference to hash of any new or updated access controls.
11182: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11183: key = integer (inbound ID)
11184: value = uniqueID
1.747 albertel 11185:
1.608 albertel 11186: =back
11187:
1.243 albertel 11188: =head2 HTTP Helper Routines
11189:
11190: =over 4
11191:
1.191 harris41 11192: =item *
11193:
11194: escape() : unpack non-word characters into CGI-compatible hex codes
11195:
11196: =item *
11197:
11198: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11199:
1.243 albertel 11200: =back
11201:
11202: =head1 PRIVATE SUBROUTINES
11203:
11204: =head2 Underlying communication routines (Shouldn't call)
11205:
11206: =over 4
11207:
11208: =item *
11209:
11210: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11211:
11212: =item *
11213:
11214: reply() : uses subreply to send a message to remote machine, logs all failures
11215:
11216: =item *
11217:
11218: critical() : passes a critical message to another server; if cannot
11219: get through then place message in connection buffer directory and
11220: returns con_delayed, if incapable of saving message, returns
11221: con_failed
11222:
11223: =item *
11224:
11225: reconlonc() : tries to reconnect lonc client processes.
11226:
11227: =back
11228:
11229: =head2 Resource Access Logging
11230:
11231: =over 4
11232:
11233: =item *
11234:
11235: flushcourselogs() : flush (save) buffer logs and access logs
11236:
11237: =item *
11238:
11239: courselog($what) : save message for course in hash
11240:
11241: =item *
11242:
11243: courseacclog($what) : save message for course using &courselog(). Perform
11244: special processing for specific resource types (problems, exams, quizzes, etc).
11245:
1.191 harris41 11246: =item *
11247:
11248: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11249: as a PerlChildExitHandler
1.243 albertel 11250:
11251: =back
11252:
11253: =head2 Other
11254:
11255: =over 4
11256:
11257: =item *
11258:
11259: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 11260:
11261: =back
11262:
11263: =cut
1.877 foxr 11264:
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