Annotation of loncom/lonnet/perl/lonnet.pm, revision 1.1056.2.2
1.1 albertel 1: # The LearningOnline Network
2: # TCP networking package
1.12 www 3: #
1.1056.2.2! raeburn 4: # $Id: lonnet.pm,v 1.1056.2.1 2010/03/24 03:29:56 raeburn Exp $
1.178 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.169 harris41 28: ###
29:
1.971 jms 30: =pod
31:
1.972 jms 32: =head1 NAME
33:
34: Apache::lonnet.pm
35:
36: =head1 SYNOPSIS
37:
38: This file is an interface to the lonc processes of
39: the LON-CAPA network as well as set of elaborated functions for handling information
40: necessary for navigating through a given cluster of LON-CAPA machines within a
41: domain. There are over 40 specialized functions in this module which handle the
42: reading and transmission of metadata, user information (ids, names, environments, roles,
43: logs), file information (storage, reading, directories, extensions, replication, embedded
44: styles and descriptors), educational resources (course descriptions, section names and
45: numbers), url hashing (to assign roles on a url basis), and translating abbreviated symbols to
46: and from more descriptive phrases or explanations.
47:
48: This is part of the LearningOnline Network with CAPA project
49: described at http://www.lon-capa.org.
50:
1.971 jms 51: =head1 Package Variables
52:
53: These are largely undocumented, so if you decipher one please note it here.
54:
55: =over 4
56:
57: =item $processmarker
58:
59: Contains the time this process was started and this servers host id.
60:
61: =item $dumpcount
62:
63: Counts the number of times a message log flush has been attempted (regardless
64: of success) by this process. Used as part of the filename when messages are
65: delayed.
66:
67: =back
68:
69: =cut
70:
1.1 albertel 71: package Apache::lonnet;
72:
73: use strict;
1.8 www 74: use LWP::UserAgent();
1.486 www 75: use HTTP::Date;
1.977 amueller 76: use Image::Magick;
77:
1.871 albertel 78: use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
1.968 raeburn 79: $_64bit %env %protocol);
1.871 albertel 80:
81: my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
82: %userrolehash, $processmarker, $dumpcount, %coursedombuf,
83: %coursenumbuf, %coursehombuf, %coursedescrbuf, %courseinstcodebuf,
1.958 www 84: %courseownerbuf, %coursetypebuf,$locknum);
1.403 www 85:
1.1 albertel 86: use IO::Socket;
1.31 www 87: use GDBM_File;
1.208 albertel 88: use HTML::LCParser;
1.88 www 89: use Fcntl qw(:flock);
1.870 albertel 90: use Storable qw(thaw nfreeze);
1.539 albertel 91: use Time::HiRes qw( gettimeofday tv_interval );
1.599 albertel 92: use Cache::Memcached;
1.676 albertel 93: use Digest::MD5;
1.790 albertel 94: use Math::Random;
1.1024 raeburn 95: use File::MMagic;
1.807 albertel 96: use LONCAPA qw(:DEFAULT :match);
1.740 www 97: use LONCAPA::Configuration;
1.676 albertel 98:
1.195 www 99: my $readit;
1.550 foxr 100: my $max_connection_retries = 10; # Or some such value.
1.1 albertel 101:
1.619 albertel 102: require Exporter;
103:
104: our @ISA = qw (Exporter);
105: our @EXPORT = qw(%env);
106:
1.449 matthew 107:
1.1 albertel 108: # --------------------------------------------------------------------- Logging
1.729 www 109: {
110: my $logid;
111: sub instructor_log {
1.957 raeburn 112: my ($hash_name,$storehash,$delflag,$uname,$udom,$cnum,$cdom)=@_;
113: if (($cnum eq '') || ($cdom eq '')) {
114: $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
115: $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
116: }
1.729 www 117: $logid++;
1.957 raeburn 118: my $now = time();
119: my $id=$now.'00000'.$$.'00000'.$logid;
1.729 www 120: return &Apache::lonnet::put('nohist_'.$hash_name,
1.730 www 121: { $id => {
122: 'exe_uname' => $env{'user.name'},
123: 'exe_udom' => $env{'user.domain'},
1.957 raeburn 124: 'exe_time' => $now,
1.730 www 125: 'exe_ip' => $ENV{'REMOTE_ADDR'},
126: 'delflag' => $delflag,
127: 'logentry' => $storehash,
128: 'uname' => $uname,
129: 'udom' => $udom,
130: }
1.957 raeburn 131: },$cdom,$cnum);
1.729 www 132: }
133: }
1.1 albertel 134:
1.163 harris41 135: sub logtouch {
136: my $execdir=$perlvar{'lonDaemons'};
1.448 albertel 137: unless (-e "$execdir/logs/lonnet.log") {
138: open(my $fh,">>$execdir/logs/lonnet.log");
1.163 harris41 139: close $fh;
140: }
141: my ($wwwuid,$wwwgid)=(getpwnam('www'))[2,3];
142: chown($wwwuid,$wwwgid,$execdir.'/logs/lonnet.log');
143: }
144:
1.1 albertel 145: sub logthis {
146: my $message=shift;
147: my $execdir=$perlvar{'lonDaemons'};
148: my $now=time;
149: my $local=localtime($now);
1.448 albertel 150: if (open(my $fh,">>$execdir/logs/lonnet.log")) {
1.986 foxr 151: my $logstring = $local. " ($$): ".$message."\n"; # Keep any \'s in string.
152: print $fh $logstring;
1.448 albertel 153: close($fh);
154: }
1.1 albertel 155: return 1;
156: }
157:
158: sub logperm {
159: my $message=shift;
160: my $execdir=$perlvar{'lonDaemons'};
161: my $now=time;
162: my $local=localtime($now);
1.448 albertel 163: if (open(my $fh,">>$execdir/logs/lonnet.perm.log")) {
164: print $fh "$now:$message:$local\n";
165: close($fh);
166: }
1.1 albertel 167: return 1;
168: }
169:
1.850 albertel 170: sub create_connection {
1.853 albertel 171: my ($hostname,$lonid) = @_;
1.851 albertel 172: my $client=IO::Socket::UNIX->new(Peer => $perlvar{'lonSockCreate'},
1.850 albertel 173: Type => SOCK_STREAM,
174: Timeout => 10);
175: return 0 if (!$client);
1.890 albertel 176: print $client (join(':',$hostname,$lonid,&machine_ids($hostname))."\n");
1.850 albertel 177: my $result = <$client>;
178: chomp($result);
179: return 1 if ($result eq 'done');
180: return 0;
181: }
182:
1.983 raeburn 183: sub get_server_timezone {
184: my ($cnum,$cdom) = @_;
185: my $home=&homeserver($cnum,$cdom);
186: if ($home ne 'no_host') {
187: my $cachetime = 24*3600;
188: my ($timezone,$cached)=&is_cached_new('servertimezone',$home);
189: if (defined($cached)) {
190: return $timezone;
191: } else {
192: my $timezone = &reply('servertimezone',$home);
193: return &do_cache_new('servertimezone',$home,$timezone,$cachetime);
194: }
195: }
196: }
1.850 albertel 197:
1.993 raeburn 198: sub get_server_loncaparev {
199: my ($dom,$lonhost) = @_;
200: if (defined($lonhost)) {
201: if (!defined(&hostname($lonhost))) {
202: undef($lonhost);
203: }
204: }
205: if (!defined($lonhost)) {
206: if (defined(&domain($dom,'primary'))) {
207: $lonhost=&domain($dom,'primary');
208: if ($lonhost eq 'no_host') {
209: undef($lonhost);
210: }
211: }
212: }
213: if (defined($lonhost)) {
214: my $cachetime = 24*3600;
215: my ($loncaparev,$cached)=&is_cached_new('serverloncaparev',$lonhost);
216: if (defined($cached)) {
217: return $loncaparev;
218: } else {
219: my $loncaparev = &reply('serverloncaparev',$lonhost);
220: return &do_cache_new('serverloncaparev',$lonhost,$loncaparev,$cachetime);
221: }
222: }
223: }
224:
1.1 albertel 225: # -------------------------------------------------- Non-critical communication
226: sub subreply {
227: my ($cmd,$server)=@_;
1.838 albertel 228: my $peerfile="$perlvar{'lonSockDir'}/".&hostname($server);
1.549 foxr 229: #
230: # With loncnew process trimming, there's a timing hole between lonc server
231: # process exit and the master server picking up the listen on the AF_UNIX
232: # socket. In that time interval, a lock file will exist:
233:
234: my $lockfile=$peerfile.".lock";
235: while (-e $lockfile) { # Need to wait for the lockfile to disappear.
236: sleep(1);
237: }
238: # At this point, either a loncnew parent is listening or an old lonc
1.550 foxr 239: # or loncnew child is listening so we can connect or everything's dead.
1.549 foxr 240: #
1.550 foxr 241: # We'll give the connection a few tries before abandoning it. If
242: # connection is not possible, we'll con_lost back to the client.
243: #
244: my $client;
245: for (my $retries = 0; $retries < $max_connection_retries; $retries++) {
246: $client=IO::Socket::UNIX->new(Peer =>"$peerfile",
247: Type => SOCK_STREAM,
248: Timeout => 10);
1.869 albertel 249: if ($client) {
1.550 foxr 250: last; # Connected!
1.850 albertel 251: } else {
1.853 albertel 252: &create_connection(&hostname($server),$server);
1.550 foxr 253: }
1.850 albertel 254: sleep(1); # Try again later if failed connection.
1.550 foxr 255: }
256: my $answer;
257: if ($client) {
1.704 albertel 258: print $client "sethost:$server:$cmd\n";
1.550 foxr 259: $answer=<$client>;
260: if (!$answer) { $answer="con_lost"; }
261: chomp($answer);
262: } else {
263: $answer = 'con_lost'; # Failed connection.
264: }
1.1 albertel 265: return $answer;
266: }
267:
268: sub reply {
269: my ($cmd,$server)=@_;
1.838 albertel 270: unless (defined(&hostname($server))) { return 'no_such_host'; }
1.1 albertel 271: my $answer=subreply($cmd,$server);
1.65 www 272: if (($answer=~/^refused/) || ($answer=~/^rejected/)) {
1.672 albertel 273: &logthis("<font color=\"blue\">WARNING:".
1.12 www 274: " $cmd to $server returned $answer</font>");
275: }
1.1 albertel 276: return $answer;
277: }
278:
279: # ----------------------------------------------------------- Send USR1 to lonc
280:
281: sub reconlonc {
1.891 albertel 282: my ($lonid) = @_;
283: my $hostname = &hostname($lonid);
284: if ($lonid) {
285: my $peerfile="$perlvar{'lonSockDir'}/$hostname";
286: if ($hostname && -e $peerfile) {
287: &logthis("Trying to reconnect lonc for $lonid ($hostname)");
288: my $client=IO::Socket::UNIX->new(Peer => $peerfile,
289: Type => SOCK_STREAM,
290: Timeout => 10);
291: if ($client) {
292: print $client ("reset_retries\n");
293: my $answer=<$client>;
294: #reset just this one.
295: }
296: }
297: return;
298: }
299:
1.836 www 300: &logthis("Trying to reconnect lonc");
1.1 albertel 301: my $loncfile="$perlvar{'lonDaemons'}/logs/lonc.pid";
1.448 albertel 302: if (open(my $fh,"<$loncfile")) {
1.1 albertel 303: my $loncpid=<$fh>;
304: chomp($loncpid);
305: if (kill 0 => $loncpid) {
306: &logthis("lonc at pid $loncpid responding, sending USR1");
307: kill USR1 => $loncpid;
308: sleep 1;
1.836 www 309: } else {
1.12 www 310: &logthis(
1.672 albertel 311: "<font color=\"blue\">WARNING:".
1.12 www 312: " lonc at pid $loncpid not responding, giving up</font>");
1.1 albertel 313: }
314: } else {
1.836 www 315: &logthis('<font color="blue">WARNING: lonc not running, giving up</font>');
1.1 albertel 316: }
317: }
318:
319: # ------------------------------------------------------ Critical communication
1.12 www 320:
1.1 albertel 321: sub critical {
322: my ($cmd,$server)=@_;
1.838 albertel 323: unless (&hostname($server)) {
1.672 albertel 324: &logthis("<font color=\"blue\">WARNING:".
1.89 www 325: " Critical message to unknown server ($server)</font>");
326: return 'no_such_host';
327: }
1.1 albertel 328: my $answer=reply($cmd,$server);
329: if ($answer eq 'con_lost') {
330: &reconlonc("$perlvar{'lonSockDir'}/$server");
1.589 albertel 331: my $answer=reply($cmd,$server);
1.1 albertel 332: if ($answer eq 'con_lost') {
333: my $now=time;
334: my $middlename=$cmd;
1.5 www 335: $middlename=substr($middlename,0,16);
1.1 albertel 336: $middlename=~s/\W//g;
337: my $dfilename=
1.305 www 338: "$perlvar{'lonSockDir'}/delayed/$now.$dumpcount.$$.$middlename.$server";
339: $dumpcount++;
1.1 albertel 340: {
1.448 albertel 341: my $dfh;
342: if (open($dfh,">$dfilename")) {
343: print $dfh "$cmd\n";
344: close($dfh);
345: }
1.1 albertel 346: }
347: sleep 2;
348: my $wcmd='';
349: {
1.448 albertel 350: my $dfh;
351: if (open($dfh,"<$dfilename")) {
352: $wcmd=<$dfh>;
353: close($dfh);
354: }
1.1 albertel 355: }
356: chomp($wcmd);
1.7 www 357: if ($wcmd eq $cmd) {
1.672 albertel 358: &logthis("<font color=\"blue\">WARNING: ".
1.12 www 359: "Connection buffer $dfilename: $cmd</font>");
1.1 albertel 360: &logperm("D:$server:$cmd");
361: return 'con_delayed';
362: } else {
1.672 albertel 363: &logthis("<font color=\"red\">CRITICAL:"
1.12 www 364: ." Critical connection failed: $server $cmd</font>");
1.1 albertel 365: &logperm("F:$server:$cmd");
366: return 'con_failed';
367: }
368: }
369: }
370: return $answer;
1.405 albertel 371: }
372:
1.755 albertel 373: # ------------------------------------------- check if return value is an error
374:
375: sub error {
376: my ($result) = @_;
1.756 albertel 377: if ($result =~ /^(con_lost|no_such_host|error: (\d+) (.*))/) {
1.755 albertel 378: if ($2 == 2) { return undef; }
379: return $1;
380: }
381: return undef;
382: }
383:
1.783 albertel 384: sub convert_and_load_session_env {
385: my ($lonidsdir,$handle)=@_;
386: my @profile;
387: {
1.917 albertel 388: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
389: if (!$opened) {
1.915 albertel 390: return 0;
391: }
1.783 albertel 392: flock($idf,LOCK_SH);
393: @profile=<$idf>;
394: close($idf);
395: }
396: my %temp_env;
397: foreach my $line (@profile) {
1.786 albertel 398: if ($line !~ m/=/) {
399: return 0;
400: }
1.783 albertel 401: chomp($line);
402: my ($envname,$envvalue)=split(/=/,$line,2);
403: $temp_env{&unescape($envname)} = &unescape($envvalue);
404: }
405: unlink("$lonidsdir/$handle.id");
406: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",&GDBM_WRCREAT(),
407: 0640)) {
408: %disk_env = %temp_env;
409: @env{keys(%temp_env)} = @disk_env{keys(%temp_env)};
410: untie(%disk_env);
411: }
1.786 albertel 412: return 1;
1.783 albertel 413: }
414:
1.374 www 415: # ------------------------------------------- Transfer profile into environment
1.780 albertel 416: my $env_loaded;
417: sub transfer_profile_to_env {
1.788 albertel 418: my ($lonidsdir,$handle,$force_transfer) = @_;
419: if (!$force_transfer && $env_loaded) { return; }
1.374 www 420:
1.720 albertel 421: if (!defined($lonidsdir)) {
422: $lonidsdir = $perlvar{'lonIDsDir'};
423: }
424: if (!defined($handle)) {
425: ($handle) = ($env{'user.environment'} =~m|/([^/]+)\.id$| );
426: }
427:
1.786 albertel 428: my $convert;
429: {
1.917 albertel 430: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
431: if (!$opened) {
1.915 albertel 432: return;
433: }
1.786 albertel 434: flock($idf,LOCK_SH);
435: if (tie(my %disk_env,'GDBM_File',"$lonidsdir/$handle.id",
436: &GDBM_READER(),0640)) {
437: @env{keys(%disk_env)} = @disk_env{keys(%disk_env)};
438: untie(%disk_env);
439: } else {
440: $convert = 1;
441: }
442: }
443: if ($convert) {
444: if (!&convert_and_load_session_env($lonidsdir,$handle)) {
445: &logthis("Failed to load session, or convert session.");
446: }
1.374 www 447: }
1.783 albertel 448:
1.786 albertel 449: my %remove;
1.783 albertel 450: while ( my $envname = each(%env) ) {
1.433 matthew 451: if (my ($key,$time) = ($envname =~ /^(cgi\.(\d+)_\d+\.)/)) {
452: if ($time < time-300) {
1.783 albertel 453: $remove{$key}++;
1.433 matthew 454: }
455: }
456: }
1.783 albertel 457:
1.619 albertel 458: $env{'user.environment'} = "$lonidsdir/$handle.id";
1.780 albertel 459: $env_loaded=1;
1.783 albertel 460: foreach my $expired_key (keys(%remove)) {
1.433 matthew 461: &delenv($expired_key);
1.374 www 462: }
1.1 albertel 463: }
464:
1.916 albertel 465: # ---------------------------------------------------- Check for valid session
466: sub check_for_valid_session {
467: my ($r) = @_;
468: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
469: my $lonid=$cookies{'lonID'};
470: return undef if (!$lonid);
471:
472: my $handle=&LONCAPA::clean_handle($lonid->value);
473: my $lonidsdir=$r->dir_config('lonIDsDir');
474: return undef if (!-e "$lonidsdir/$handle.id");
475:
1.917 albertel 476: my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
477: return undef if (!$opened);
1.916 albertel 478:
479: flock($idf,LOCK_SH);
480: my %disk_env;
481: if (!tie(%disk_env,'GDBM_File',"$lonidsdir/$handle.id",
482: &GDBM_READER(),0640)) {
483: return undef;
484: }
485:
486: if (!defined($disk_env{'user.name'})
487: || !defined($disk_env{'user.domain'})) {
488: return undef;
489: }
490: return $handle;
491: }
492:
1.830 albertel 493: sub timed_flock {
494: my ($file,$lock_type) = @_;
495: my $failed=0;
496: eval {
497: local $SIG{__DIE__}='DEFAULT';
498: local $SIG{ALRM}=sub {
499: $failed=1;
500: die("failed lock");
501: };
502: alarm(13);
503: flock($file,$lock_type);
504: alarm(0);
505: };
506: if ($failed) {
507: return undef;
508: } else {
509: return 1;
510: }
511: }
512:
1.5 www 513: # ---------------------------------------------------------- Append Environment
514:
515: sub appenv {
1.949 raeburn 516: my ($newenv,$roles) = @_;
517: if (ref($newenv) eq 'HASH') {
518: foreach my $key (keys(%{$newenv})) {
519: my $refused = 0;
520: if (($key =~ /^user\.role/) || ($key =~ /^user\.priv/)) {
521: $refused = 1;
522: if (ref($roles) eq 'ARRAY') {
523: my ($type,$role) = ($key =~ /^user\.(role|priv)\.([^.]+)\./);
524: if (grep(/^\Q$role\E$/,@{$roles})) {
525: $refused = 0;
526: }
527: }
528: }
529: if ($refused) {
530: &logthis("<font color=\"blue\">WARNING: ".
531: "Attempt to modify environment ".$key." to ".$newenv->{$key}
532: .'</font>');
533: delete($newenv->{$key});
534: } else {
535: $env{$key}=$newenv->{$key};
536: }
537: }
538: my $opened = open(my $env_file,'+<',$env{'user.environment'});
539: if ($opened
540: && &timed_flock($env_file,LOCK_EX)
541: &&
542: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
543: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
544: while (my ($key,$value) = each(%{$newenv})) {
545: $disk_env{$key} = $value;
546: }
547: untie(%disk_env);
1.35 www 548: }
1.191 harris41 549: }
1.56 www 550: return 'ok';
551: }
552: # ----------------------------------------------------- Delete from Environment
553:
554: sub delenv {
1.987 raeburn 555: my ($delthis,$regexp) = @_;
1.56 www 556: if (($delthis=~/user\.role/) || ($delthis=~/user\.priv/)) {
1.672 albertel 557: &logthis("<font color=\"blue\">WARNING: ".
1.56 www 558: "Attempt to delete from environment ".$delthis);
559: return 'error';
560: }
1.917 albertel 561: my $opened = open(my $env_file,'+<',$env{'user.environment'});
562: if ($opened
1.915 albertel 563: && &timed_flock($env_file,LOCK_EX)
1.830 albertel 564: &&
565: tie(my %disk_env,'GDBM_File',$env{'user.environment'},
566: (&GDBM_WRITER()|&GDBM_NOLOCK()),0640)) {
1.783 albertel 567: foreach my $key (keys(%disk_env)) {
1.987 raeburn 568: if ($regexp) {
569: if ($key=~/^$delthis/) {
570: delete($env{$key});
571: delete($disk_env{$key});
572: }
573: } else {
574: if ($key=~/^\Q$delthis\E/) {
575: delete($env{$key});
576: delete($disk_env{$key});
577: }
578: }
1.448 albertel 579: }
1.783 albertel 580: untie(%disk_env);
1.5 www 581: }
582: return 'ok';
1.369 albertel 583: }
584:
1.790 albertel 585: sub get_env_multiple {
586: my ($name) = @_;
587: my @values;
588: if (defined($env{$name})) {
589: # exists is it an array
590: if (ref($env{$name})) {
591: @values=@{ $env{$name} };
592: } else {
593: $values[0]=$env{$name};
594: }
595: }
596: return(@values);
597: }
598:
1.958 www 599: # ------------------------------------------------------------------- Locking
600:
601: sub set_lock {
602: my ($text)=@_;
603: $locknum++;
604: my $id=$$.'-'.$locknum;
605: &appenv({'session.locks' => $env{'session.locks'}.','.$id,
606: 'session.lock.'.$id => $text});
607: return $id;
608: }
609:
610: sub get_locks {
611: my $num=0;
612: my %texts=();
613: foreach my $lock (split(/\,/,$env{'session.locks'})) {
614: if ($lock=~/\w/) {
615: $num++;
616: $texts{$lock}=$env{'session.lock.'.$lock};
617: }
618: }
619: return ($num,%texts);
620: }
621:
622: sub remove_lock {
623: my ($id)=@_;
624: my $newlocks='';
625: foreach my $lock (split(/\,/,$env{'session.locks'})) {
626: if (($lock=~/\w/) && ($lock ne $id)) {
627: $newlocks.=','.$lock;
628: }
629: }
630: &appenv({'session.locks' => $newlocks});
631: &delenv('session.lock.'.$id);
632: }
633:
634: sub remove_all_locks {
635: my $activelocks=$env{'session.locks'};
636: foreach my $lock (split(/\,/,$env{'session.locks'})) {
637: if ($lock=~/\w/) {
638: &remove_lock($lock);
639: }
640: }
641: }
642:
643:
1.369 albertel 644: # ------------------------------------------ Find out current server userload
645: sub userload {
646: my $numusers=0;
647: {
648: opendir(LONIDS,$perlvar{'lonIDsDir'});
649: my $filename;
650: my $curtime=time;
651: while ($filename=readdir(LONIDS)) {
1.925 albertel 652: next if ($filename eq '.' || $filename eq '..');
653: next if ($filename =~ /publicuser_\d+\.id/);
1.404 albertel 654: my ($mtime)=(stat($perlvar{'lonIDsDir'}.'/'.$filename))[9];
1.437 albertel 655: if ($curtime-$mtime < 1800) { $numusers++; }
1.369 albertel 656: }
657: closedir(LONIDS);
658: }
659: my $userloadpercent=0;
660: my $maxuserload=$perlvar{'lonUserLoadLim'};
661: if ($maxuserload) {
1.371 albertel 662: $userloadpercent=100*$numusers/$maxuserload;
1.369 albertel 663: }
1.372 albertel 664: $userloadpercent=sprintf("%.2f",$userloadpercent);
1.369 albertel 665: return $userloadpercent;
1.283 www 666: }
667:
668: # ------------------------------------------ Fight off request when overloaded
669:
670: sub overloaderror {
671: my ($r,$checkserver)=@_;
672: unless ($checkserver) { $checkserver=$perlvar{'lonHostID'}; }
673: my $loadavg;
674: if ($checkserver eq $perlvar{'lonHostID'}) {
1.448 albertel 675: open(my $loadfile,'/proc/loadavg');
1.283 www 676: $loadavg=<$loadfile>;
677: $loadavg =~ s/\s.*//g;
1.285 matthew 678: $loadavg = 100*$loadavg/$perlvar{'lonLoadLim'};
1.448 albertel 679: close($loadfile);
1.283 www 680: } else {
681: $loadavg=&reply('load',$checkserver);
682: }
1.285 matthew 683: my $overload=$loadavg-100;
1.283 www 684: if ($overload>0) {
1.285 matthew 685: $r->err_headers_out->{'Retry-After'}=$overload;
1.283 www 686: $r->log_error('Overload of '.$overload.' on '.$checkserver);
1.554 www 687: return 413;
1.283 www 688: }
689: return '';
1.5 www 690: }
1.1 albertel 691:
692: # ------------------------------ Find server with least workload from spare.tab
1.11 www 693:
1.1 albertel 694: sub spareserver {
1.670 albertel 695: my ($loadpercent,$userloadpercent,$want_server_name) = @_;
1.784 albertel 696: my $spare_server;
1.370 albertel 697: if ($userloadpercent !~ /\d/) { $userloadpercent=0; }
1.784 albertel 698: my $lowest_load=($loadpercent > $userloadpercent) ? $loadpercent
699: : $userloadpercent;
700:
701: foreach my $try_server (@{ $spareid{'primary'} }) {
702: ($spare_server, $lowest_load) =
703: &compare_server_load($try_server, $spare_server, $lowest_load);
704: }
705:
706: my $found_server = ($spare_server ne '' && $lowest_load < 100);
707:
708: if (!$found_server) {
709: foreach my $try_server (@{ $spareid{'default'} }) {
710: ($spare_server, $lowest_load) =
711: &compare_server_load($try_server, $spare_server, $lowest_load);
712: }
713: }
714:
715: if (!$want_server_name) {
1.968 raeburn 716: my $protocol = 'http';
717: if ($protocol{$spare_server} eq 'https') {
718: $protocol = $protocol{$spare_server};
719: }
1.1001 raeburn 720: if (defined($spare_server)) {
721: my $hostname = &hostname($spare_server);
722: if (defined($hostname)) {
723: $spare_server = $protocol.'://'.$hostname;
724: }
725: }
1.784 albertel 726: }
727: return $spare_server;
728: }
729:
730: sub compare_server_load {
731: my ($try_server, $spare_server, $lowest_load) = @_;
732:
733: my $loadans = &reply('load', $try_server);
734: my $userloadans = &reply('userload',$try_server);
735:
736: if ($loadans !~ /\d/ && $userloadans !~ /\d/) {
737: next; #didn't get a number from the server
738: }
739:
740: my $load;
741: if ($loadans =~ /\d/) {
742: if ($userloadans =~ /\d/) {
743: #both are numbers, pick the bigger one
744: $load = ($loadans > $userloadans) ? $loadans
745: : $userloadans;
1.411 albertel 746: } else {
1.784 albertel 747: $load = $loadans;
1.411 albertel 748: }
1.784 albertel 749: } else {
750: $load = $userloadans;
751: }
752:
753: if (($load =~ /\d/) && ($load < $lowest_load)) {
754: $spare_server = $try_server;
755: $lowest_load = $load;
1.370 albertel 756: }
1.784 albertel 757: return ($spare_server,$lowest_load);
1.202 matthew 758: }
1.914 albertel 759:
760: # --------------------------- ask offload servers if user already has a session
761: sub find_existing_session {
762: my ($udom,$uname) = @_;
763: foreach my $try_server (@{ $spareid{'primary'} },
764: @{ $spareid{'default'} }) {
765: return $try_server if (&has_user_session($try_server, $udom, $uname));
766: }
767: return;
768: }
769:
770: # -------------------------------- ask if server already has a session for user
771: sub has_user_session {
772: my ($lonid,$udom,$uname) = @_;
773: my $result = &reply(join(':','userhassession',
774: map {&escape($_)} ($udom,$uname)),$lonid);
775: return 1 if ($result eq 'ok');
776:
777: return 0;
778: }
779:
1.202 matthew 780: # --------------------------------------------- Try to change a user's password
781:
782: sub changepass {
1.799 raeburn 783: my ($uname,$udom,$currentpass,$newpass,$server,$context)=@_;
1.202 matthew 784: $currentpass = &escape($currentpass);
785: $newpass = &escape($newpass);
1.1030 raeburn 786: my $lonhost = $perlvar{'lonHostID'};
787: my $answer = reply("encrypt:passwd:$udom:$uname:$currentpass:$newpass:$context:$lonhost",
1.202 matthew 788: $server);
789: if (! $answer) {
790: &logthis("No reply on password change request to $server ".
791: "by $uname in domain $udom.");
792: } elsif ($answer =~ "^ok") {
793: &logthis("$uname in $udom successfully changed their password ".
794: "on $server.");
795: } elsif ($answer =~ "^pwchange_failure") {
796: &logthis("$uname in $udom was unable to change their password ".
797: "on $server. The action was blocked by either lcpasswd ".
798: "or pwchange");
799: } elsif ($answer =~ "^non_authorized") {
800: &logthis("$uname in $udom did not get their password correct when ".
801: "attempting to change it on $server.");
802: } elsif ($answer =~ "^auth_mode_error") {
803: &logthis("$uname in $udom attempted to change their password despite ".
804: "not being locally or internally authenticated on $server.");
805: } elsif ($answer =~ "^unknown_user") {
806: &logthis("$uname in $udom attempted to change their password ".
807: "on $server but were unable to because $server is not ".
808: "their home server.");
809: } elsif ($answer =~ "^refused") {
810: &logthis("$server refused to change $uname in $udom password because ".
811: "it was sent an unencrypted request to change the password.");
1.1030 raeburn 812: } elsif ($answer =~ "invalid_client") {
813: &logthis("$server refused to change $uname in $udom password because ".
814: "it was a reset by e-mail originating from an invalid server.");
1.202 matthew 815: }
816: return $answer;
1.1 albertel 817: }
818:
1.169 harris41 819: # ----------------------- Try to determine user's current authentication scheme
820:
821: sub queryauthenticate {
822: my ($uname,$udom)=@_;
1.456 albertel 823: my $uhome=&homeserver($uname,$udom);
824: if (!$uhome) {
825: &logthis("User $uname at $udom is unknown when looking for authentication mechanism");
826: return 'no_host';
827: }
828: my $answer=reply("encrypt:currentauth:$udom:$uname",$uhome);
829: if ($answer =~ /^(unknown_user|refused|con_lost)/) {
830: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.169 harris41 831: }
1.456 albertel 832: return $answer;
1.169 harris41 833: }
834:
1.1 albertel 835: # --------- Try to authenticate user from domain's lib servers (first this one)
1.11 www 836:
1.1 albertel 837: sub authenticate {
1.952 raeburn 838: my ($uname,$upass,$udom,$checkdefauth)=@_;
1.807 albertel 839: $upass=&escape($upass);
840: $uname= &LONCAPA::clean_username($uname);
1.836 www 841: my $uhome=&homeserver($uname,$udom,1);
1.952 raeburn 842: my $newhome;
1.836 www 843: if ((!$uhome) || ($uhome eq 'no_host')) {
844: # Maybe the machine was offline and only re-appeared again recently?
845: &reconlonc();
846: # One more
1.952 raeburn 847: $uhome=&homeserver($uname,$udom,1);
848: if (($uhome eq 'no_host') && $checkdefauth) {
849: if (defined(&domain($udom,'primary'))) {
850: $newhome=&domain($udom,'primary');
851: }
852: if ($newhome ne '') {
853: $uhome = $newhome;
854: }
855: }
1.836 www 856: if ((!$uhome) || ($uhome eq 'no_host')) {
857: &logthis("User $uname at $udom is unknown in authenticate");
1.952 raeburn 858: return 'no_host';
859: }
1.1 albertel 860: }
1.952 raeburn 861: my $answer=reply("encrypt:auth:$udom:$uname:$upass:$checkdefauth",$uhome);
1.471 albertel 862: if ($answer eq 'authorized') {
1.952 raeburn 863: if ($newhome) {
864: &logthis("User $uname at $udom authorized by $uhome, but needs account");
865: return 'no_account_on_host';
866: } else {
867: &logthis("User $uname at $udom authorized by $uhome");
868: return $uhome;
869: }
1.471 albertel 870: }
871: if ($answer eq 'non_authorized') {
872: &logthis("User $uname at $udom rejected by $uhome");
873: return 'no_host';
1.9 www 874: }
1.471 albertel 875: &logthis("User $uname at $udom threw error $answer when checking authentication mechanism");
1.1 albertel 876: return 'no_host';
877: }
878:
879: # ---------------------- Find the homebase for a user from domain's lib servers
1.11 www 880:
1.599 albertel 881: my %homecache;
1.1 albertel 882: sub homeserver {
1.230 stredwic 883: my ($uname,$udom,$ignoreBadCache)=@_;
1.1 albertel 884: my $index="$uname:$udom";
1.426 albertel 885:
1.599 albertel 886: if (exists($homecache{$index})) { return $homecache{$index}; }
1.841 albertel 887:
888: my %servers = &get_servers($udom,'library');
889: foreach my $tryserver (keys(%servers)) {
1.230 stredwic 890: next if ($ignoreBadCache ne 'true' &&
1.231 stredwic 891: exists($badServerCache{$tryserver}));
1.841 albertel 892:
893: my $answer=reply("home:$udom:$uname",$tryserver);
894: if ($answer eq 'found') {
895: delete($badServerCache{$tryserver});
896: return $homecache{$index}=$tryserver;
897: } elsif ($answer eq 'no_host') {
898: $badServerCache{$tryserver}=1;
899: }
1.1 albertel 900: }
901: return 'no_host';
1.70 www 902: }
903:
904: # ------------------------------------- Find the usernames behind a list of IDs
905:
906: sub idget {
907: my ($udom,@ids)=@_;
908: my %returnhash=();
909:
1.841 albertel 910: my %servers = &get_servers($udom,'library');
911: foreach my $tryserver (keys(%servers)) {
912: my $idlist=join('&',@ids);
913: $idlist=~tr/A-Z/a-z/;
914: my $reply=&reply("idget:$udom:".$idlist,$tryserver);
915: my @answer=();
916: if (($reply ne 'con_lost') && ($reply!~/^error\:/)) {
917: @answer=split(/\&/,$reply);
918: } ;
919: my $i;
920: for ($i=0;$i<=$#ids;$i++) {
921: if ($answer[$i]) {
922: $returnhash{$ids[$i]}=$answer[$i];
923: }
924: }
925: }
1.70 www 926: return %returnhash;
927: }
928:
929: # ------------------------------------- Find the IDs behind a list of usernames
930:
931: sub idrget {
932: my ($udom,@unames)=@_;
933: my %returnhash=();
1.800 albertel 934: foreach my $uname (@unames) {
935: $returnhash{$uname}=(&userenvironment($udom,$uname,'id'))[1];
1.191 harris41 936: }
1.70 www 937: return %returnhash;
938: }
939:
940: # ------------------------------- Store away a list of names and associated IDs
941:
942: sub idput {
943: my ($udom,%ids)=@_;
944: my %servers=();
1.800 albertel 945: foreach my $uname (keys(%ids)) {
946: &cput('environment',{'id'=>$ids{$uname}},$udom,$uname);
947: my $uhom=&homeserver($uname,$udom);
1.70 www 948: if ($uhom ne 'no_host') {
1.800 albertel 949: my $id=&escape($ids{$uname});
1.70 www 950: $id=~tr/A-Z/a-z/;
1.800 albertel 951: my $esc_unam=&escape($uname);
1.70 www 952: if ($servers{$uhom}) {
1.800 albertel 953: $servers{$uhom}.='&'.$id.'='.$esc_unam;
1.70 www 954: } else {
1.800 albertel 955: $servers{$uhom}=$id.'='.$esc_unam;
1.70 www 956: }
957: }
1.191 harris41 958: }
1.800 albertel 959: foreach my $server (keys(%servers)) {
960: &critical('idput:'.$udom.':'.$servers{$server},$server);
1.191 harris41 961: }
1.344 www 962: }
963:
1.1023 raeburn 964: # ------------------------------dump from db file owned by domainconfig user
1.1012 raeburn 965: sub dump_dom {
1.1023 raeburn 966: my ($namespace,$udom,$regexp,$range)=@_;
1.1012 raeburn 967: if (!$udom) {
968: $udom=$env{'user.domain'};
969: }
970: my %returnhash;
1.1023 raeburn 971: if ($udom) {
972: my $uname = &get_domainconfiguser($udom);
973: %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
1.1012 raeburn 974: }
975: return %returnhash;
976: }
977:
1.1023 raeburn 978: # ------------------------------------------ get items from domain db files
1.806 raeburn 979:
980: sub get_dom {
1.860 raeburn 981: my ($namespace,$storearr,$udom,$uhome)=@_;
1.806 raeburn 982: my $items='';
983: foreach my $item (@$storearr) {
984: $items.=&escape($item).'&';
985: }
986: $items=~s/\&$//;
1.860 raeburn 987: if (!$udom) {
988: $udom=$env{'user.domain'};
989: if (defined(&domain($udom,'primary'))) {
990: $uhome=&domain($udom,'primary');
991: } else {
1.874 albertel 992: undef($uhome);
1.860 raeburn 993: }
994: } else {
995: if (!$uhome) {
996: if (defined(&domain($udom,'primary'))) {
997: $uhome=&domain($udom,'primary');
998: }
999: }
1000: }
1001: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1002: my $rep=&reply("getdom:$udom:$namespace:$items",$uhome);
1.866 raeburn 1003: my %returnhash;
1.875 albertel 1004: if ($rep eq '' || $rep =~ /^error: 2 /) {
1.866 raeburn 1005: return %returnhash;
1006: }
1.806 raeburn 1007: my @pairs=split(/\&/,$rep);
1008: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
1009: return @pairs;
1010: }
1011: my $i=0;
1012: foreach my $item (@$storearr) {
1013: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1014: $i++;
1015: }
1016: return %returnhash;
1017: } else {
1.880 banghart 1018: &logthis("get_dom failed - no homeserver and/or domain ($udom) ($uhome)");
1.806 raeburn 1019: }
1020: }
1021:
1022: # -------------------------------------------- put items in domain db files
1023:
1024: sub put_dom {
1.860 raeburn 1025: my ($namespace,$storehash,$udom,$uhome)=@_;
1026: if (!$udom) {
1027: $udom=$env{'user.domain'};
1028: if (defined(&domain($udom,'primary'))) {
1029: $uhome=&domain($udom,'primary');
1030: } else {
1.874 albertel 1031: undef($uhome);
1.860 raeburn 1032: }
1033: } else {
1034: if (!$uhome) {
1035: if (defined(&domain($udom,'primary'))) {
1036: $uhome=&domain($udom,'primary');
1037: }
1038: }
1039: }
1040: if ($udom && $uhome && ($uhome ne 'no_host')) {
1.806 raeburn 1041: my $items='';
1042: foreach my $item (keys(%$storehash)) {
1043: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1044: }
1045: $items=~s/\&$//;
1046: return &reply("putdom:$udom:$namespace:$items",$uhome);
1047: } else {
1.860 raeburn 1048: &logthis("put_dom failed - no homeserver and/or domain");
1.806 raeburn 1049: }
1050: }
1051:
1.1023 raeburn 1052: # --------------------- newput for items in db file owned by domainconfig user
1.1012 raeburn 1053: sub newput_dom {
1.1023 raeburn 1054: my ($namespace,$storehash,$udom) = @_;
1.1012 raeburn 1055: my $result;
1056: if (!$udom) {
1057: $udom=$env{'user.domain'};
1058: }
1.1023 raeburn 1059: if ($udom) {
1060: my $uname = &get_domainconfiguser($udom);
1061: $result = &newput($namespace,$storehash,$udom,$uname);
1.1012 raeburn 1062: }
1063: return $result;
1064: }
1065:
1.1023 raeburn 1066: # --------------------- delete for items in db file owned by domainconfig user
1.1012 raeburn 1067: sub del_dom {
1.1023 raeburn 1068: my ($namespace,$storearr,$udom)=@_;
1.1012 raeburn 1069: if (ref($storearr) eq 'ARRAY') {
1070: if (!$udom) {
1071: $udom=$env{'user.domain'};
1072: }
1.1023 raeburn 1073: if ($udom) {
1074: my $uname = &get_domainconfiguser($udom);
1075: return &del($namespace,$storearr,$udom,$uname);
1.1012 raeburn 1076: }
1077: }
1078: }
1079:
1.1023 raeburn 1080: # ----------------------------------construct domainconfig user for a domain
1081: sub get_domainconfiguser {
1082: my ($udom) = @_;
1083: return $udom.'-domainconfig';
1084: }
1085:
1.837 raeburn 1086: sub retrieve_inst_usertypes {
1087: my ($udom) = @_;
1088: my (%returnhash,@order);
1.989 raeburn 1089: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1090: if ((ref($domdefs{'inststatustypes'}) eq 'HASH') &&
1091: (ref($domdefs{'inststatusorder'}) eq 'ARRAY')) {
1092: %returnhash = %{$domdefs{'inststatustypes'}};
1093: @order = @{$domdefs{'inststatusorder'}};
1094: } else {
1095: if (defined(&domain($udom,'primary'))) {
1096: my $uhome=&domain($udom,'primary');
1097: my $rep=&reply("inst_usertypes:$udom",$uhome);
1098: if ($rep =~ /^(con_lost|error|no_such_host|refused)/) {
1099: &logthis("get_dom failed - $rep returned from $uhome in domain: $udom");
1100: return (\%returnhash,\@order);
1101: }
1102: my ($hashitems,$orderitems) = split(/:/,$rep);
1103: my @pairs=split(/\&/,$hashitems);
1104: foreach my $item (@pairs) {
1105: my ($key,$value)=split(/=/,$item,2);
1106: $key = &unescape($key);
1107: next if ($key =~ /^error: 2 /);
1108: $returnhash{$key}=&thaw_unescape($value);
1109: }
1110: my @esc_order = split(/\&/,$orderitems);
1111: foreach my $item (@esc_order) {
1112: push(@order,&unescape($item));
1113: }
1114: } else {
1115: &logthis("get_dom failed - no primary domain server for $udom");
1.837 raeburn 1116: }
1117: }
1118: return (\%returnhash,\@order);
1119: }
1120:
1.868 raeburn 1121: sub is_domainimage {
1122: my ($url) = @_;
1123: if ($url=~m-^/+res/+($match_domain)/+\1\-domainconfig/+(img|logo|domlogo)/+-) {
1124: if (&domain($1) ne '') {
1125: return '1';
1126: }
1127: }
1128: return;
1129: }
1130:
1.899 raeburn 1131: sub inst_directory_query {
1132: my ($srch) = @_;
1133: my $udom = $srch->{'srchdomain'};
1134: my %results;
1135: my $homeserver = &domain($udom,'primary');
1.909 raeburn 1136: my $outcome;
1.899 raeburn 1137: if ($homeserver ne '') {
1.904 albertel 1138: my $queryid=&reply("querysend:instdirsearch:".
1139: &escape($srch->{'srchby'}).':'.
1140: &escape($srch->{'srchterm'}).':'.
1141: &escape($srch->{'srchtype'}),$homeserver);
1142: my $host=&hostname($homeserver);
1143: if ($queryid !~/^\Q$host\E\_/) {
1144: &logthis('instituional directory search invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1145: return;
1146: }
1147: my $response = &get_query_reply($queryid);
1148: my $maxtries = 5;
1149: my $tries = 1;
1150: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1151: $response = &get_query_reply($queryid);
1152: $tries ++;
1153: }
1154:
1155: if (!&error($response) && $response ne 'refused') {
1.909 raeburn 1156: if ($response eq 'unavailable') {
1157: $outcome = $response;
1158: } else {
1159: $outcome = 'ok';
1160: my @matches = split(/\n/,$response);
1161: foreach my $match (@matches) {
1162: my ($key,$value) = split(/=/,$match);
1163: $results{&unescape($key).':'.$udom} = &thaw_unescape($value);
1164: }
1.899 raeburn 1165: }
1166: }
1167: }
1.909 raeburn 1168: return ($outcome,%results);
1.899 raeburn 1169: }
1170:
1171: sub usersearch {
1172: my ($srch) = @_;
1173: my $dom = $srch->{'srchdomain'};
1174: my %results;
1175: my %libserv = &all_library();
1176: my $query = 'usersearch';
1177: foreach my $tryserver (keys(%libserv)) {
1178: if (&host_domain($tryserver) eq $dom) {
1179: my $host=&hostname($tryserver);
1180: my $queryid=
1.911 raeburn 1181: &reply("querysend:".&escape($query).':'.
1182: &escape($srch->{'srchby'}).':'.
1.899 raeburn 1183: &escape($srch->{'srchtype'}).':'.
1184: &escape($srch->{'srchterm'}),$tryserver);
1185: if ($queryid !~/^\Q$host\E\_/) {
1186: &logthis('usersearch: invalid queryid: '.$queryid.' for host: '.$host.'in domain '.$dom.' and server: '.$tryserver);
1.902 raeburn 1187: next;
1.899 raeburn 1188: }
1189: my $reply = &get_query_reply($queryid);
1190: my $maxtries = 1;
1191: my $tries = 1;
1192: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
1193: $reply = &get_query_reply($queryid);
1194: $tries ++;
1195: }
1196: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1197: &logthis('usersrch error: '.$reply.' for '.$dom.' - searching for : '.$srch->{'srchterm'}.' by '.$srch->{'srchby'}.' ('.$srch->{'srchtype'}.') - maxtries: '.$maxtries.' tries: '.$tries);
1198: } else {
1.911 raeburn 1199: my @matches;
1200: if ($reply =~ /\n/) {
1201: @matches = split(/\n/,$reply);
1202: } else {
1203: @matches = split(/\&/,$reply);
1204: }
1.899 raeburn 1205: foreach my $match (@matches) {
1206: my ($uname,$udom,%userhash);
1.911 raeburn 1207: foreach my $entry (split(/:/,$match)) {
1208: my ($key,$value) =
1209: map {&unescape($_);} split(/=/,$entry);
1.899 raeburn 1210: $userhash{$key} = $value;
1211: if ($key eq 'username') {
1212: $uname = $value;
1213: } elsif ($key eq 'domain') {
1214: $udom = $value;
1.911 raeburn 1215: }
1.899 raeburn 1216: }
1217: $results{$uname.':'.$udom} = \%userhash;
1218: }
1219: }
1220: }
1221: }
1222: return %results;
1223: }
1224:
1.912 raeburn 1225: sub get_instuser {
1226: my ($udom,$uname,$id) = @_;
1227: my $homeserver = &domain($udom,'primary');
1228: my ($outcome,%results);
1229: if ($homeserver ne '') {
1230: my $queryid=&reply("querysend:getinstuser:".&escape($uname).':'.
1231: &escape($id).':'.&escape($udom),$homeserver);
1232: my $host=&hostname($homeserver);
1233: if ($queryid !~/^\Q$host\E\_/) {
1234: &logthis('get_instuser invalid queryid: '.$queryid.' for host: '.$homeserver.'in domain '.$udom);
1235: return;
1236: }
1237: my $response = &get_query_reply($queryid);
1238: my $maxtries = 5;
1239: my $tries = 1;
1240: while (($response=~/^timeout/) && ($tries < $maxtries)) {
1241: $response = &get_query_reply($queryid);
1242: $tries ++;
1243: }
1244: if (!&error($response) && $response ne 'refused') {
1245: if ($response eq 'unavailable') {
1246: $outcome = $response;
1247: } else {
1248: $outcome = 'ok';
1249: my @matches = split(/\n/,$response);
1250: foreach my $match (@matches) {
1251: my ($key,$value) = split(/=/,$match);
1252: $results{&unescape($key)} = &thaw_unescape($value);
1253: }
1254: }
1255: }
1256: }
1257: my %userinfo;
1258: if (ref($results{$uname}) eq 'HASH') {
1259: %userinfo = %{$results{$uname}};
1260: }
1261: return ($outcome,%userinfo);
1262: }
1263:
1264: sub inst_rulecheck {
1.923 raeburn 1265: my ($udom,$uname,$id,$item,$rules) = @_;
1.912 raeburn 1266: my %returnhash;
1267: if ($udom ne '') {
1268: if (ref($rules) eq 'ARRAY') {
1269: @{$rules} = map {&escape($_);} (@{$rules});
1270: my $rulestr = join(':',@{$rules});
1271: my $homeserver=&domain($udom,'primary');
1272: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1273: my $response;
1274: if ($item eq 'username') {
1275: $response=&unescape(&reply('instrulecheck:'.&escape($udom).
1276: ':'.&escape($uname).':'.$rulestr,
1.912 raeburn 1277: $homeserver));
1.923 raeburn 1278: } elsif ($item eq 'id') {
1279: $response=&unescape(&reply('instidrulecheck:'.&escape($udom).
1280: ':'.&escape($id).':'.$rulestr,
1281: $homeserver));
1.945 raeburn 1282: } elsif ($item eq 'selfcreate') {
1283: $response=&unescape(&reply('instselfcreatecheck:'.
1.943 raeburn 1284: &escape($udom).':'.&escape($uname).
1285: ':'.$rulestr,$homeserver));
1.923 raeburn 1286: }
1.912 raeburn 1287: if ($response ne 'refused') {
1288: my @pairs=split(/\&/,$response);
1289: foreach my $item (@pairs) {
1290: my ($key,$value)=split(/=/,$item,2);
1291: $key = &unescape($key);
1292: next if ($key =~ /^error: 2 /);
1293: $returnhash{$key}=&thaw_unescape($value);
1294: }
1295: }
1296: }
1297: }
1298: }
1299: return %returnhash;
1300: }
1301:
1302: sub inst_userrules {
1.923 raeburn 1303: my ($udom,$check) = @_;
1.912 raeburn 1304: my (%ruleshash,@ruleorder);
1305: if ($udom ne '') {
1306: my $homeserver=&domain($udom,'primary');
1307: if (($homeserver ne '') && ($homeserver ne 'no_host')) {
1.923 raeburn 1308: my $response;
1309: if ($check eq 'id') {
1310: $response=&reply('instidrules:'.&escape($udom),
1.912 raeburn 1311: $homeserver);
1.943 raeburn 1312: } elsif ($check eq 'email') {
1313: $response=&reply('instemailrules:'.&escape($udom),
1314: $homeserver);
1.923 raeburn 1315: } else {
1316: $response=&reply('instuserrules:'.&escape($udom),
1317: $homeserver);
1318: }
1.912 raeburn 1319: if (($response ne 'refused') && ($response ne 'error') &&
1.923 raeburn 1320: ($response ne 'unknown_cmd') &&
1.912 raeburn 1321: ($response ne 'no_such_host')) {
1322: my ($hashitems,$orderitems) = split(/:/,$response);
1323: my @pairs=split(/\&/,$hashitems);
1324: foreach my $item (@pairs) {
1325: my ($key,$value)=split(/=/,$item,2);
1326: $key = &unescape($key);
1327: next if ($key =~ /^error: 2 /);
1328: $ruleshash{$key}=&thaw_unescape($value);
1329: }
1330: my @esc_order = split(/\&/,$orderitems);
1331: foreach my $item (@esc_order) {
1332: push(@ruleorder,&unescape($item));
1333: }
1334: }
1335: }
1336: }
1337: return (\%ruleshash,\@ruleorder);
1338: }
1339:
1.976 raeburn 1340: # ------------- Get Authentication, Language and User Tools Defaults for Domain
1.943 raeburn 1341:
1342: sub get_domain_defaults {
1343: my ($domain) = @_;
1344: my $cachetime = 60*60*24;
1345: my ($result,$cached)=&is_cached_new('domdefaults',$domain);
1346: if (defined($cached)) {
1347: if (ref($result) eq 'HASH') {
1348: return %{$result};
1349: }
1350: }
1351: my %domdefaults;
1352: my %domconfig =
1.989 raeburn 1353: &Apache::lonnet::get_dom('configuration',['defaults','quotas',
1.1047 raeburn 1354: 'requestcourses','inststatus',
1355: 'coursedefaults'],$domain);
1.943 raeburn 1356: if (ref($domconfig{'defaults'}) eq 'HASH') {
1357: $domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
1358: $domdefaults{'auth_def'} = $domconfig{'defaults'}{'auth_def'};
1359: $domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
1.982 raeburn 1360: $domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
1.985 raeburn 1361: $domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
1.943 raeburn 1362: } else {
1363: $domdefaults{'lang_def'} = &domain($domain,'lang_def');
1364: $domdefaults{'auth_def'} = &domain($domain,'auth_def');
1365: $domdefaults{'auth_arg_def'} = &domain($domain,'auth_arg_def');
1366: }
1.976 raeburn 1367: if (ref($domconfig{'quotas'}) eq 'HASH') {
1368: if (ref($domconfig{'quotas'}{'defaultquota'}) eq 'HASH') {
1369: $domdefaults{'defaultquota'} = $domconfig{'quotas'}{'defaultquota'};
1370: } else {
1371: $domdefaults{'defaultquota'} = $domconfig{'quotas'};
1372: }
1373: my @usertools = ('aboutme','blog','portfolio');
1374: foreach my $item (@usertools) {
1375: if (ref($domconfig{'quotas'}{$item}) eq 'HASH') {
1376: $domdefaults{$item} = $domconfig{'quotas'}{$item};
1377: }
1378: }
1379: }
1.985 raeburn 1380: if (ref($domconfig{'requestcourses'}) eq 'HASH') {
1.1006 raeburn 1381: foreach my $item ('official','unofficial','community') {
1.985 raeburn 1382: $domdefaults{$item} = $domconfig{'requestcourses'}{$item};
1383: }
1384: }
1.989 raeburn 1385: if (ref($domconfig{'inststatus'}) eq 'HASH') {
1386: foreach my $item ('inststatustypes','inststatusorder') {
1387: $domdefaults{$item} = $domconfig{'inststatus'}{$item};
1388: }
1389: }
1.1047 raeburn 1390: if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
1391: foreach my $item ('canuse_pdfforms') {
1392: $domdefaults{$item} = $domconfig{'coursedefaults'}{$item};
1393: }
1394: }
1.943 raeburn 1395: &Apache::lonnet::do_cache_new('domdefaults',$domain,\%domdefaults,
1396: $cachetime);
1397: return %domdefaults;
1398: }
1399:
1.344 www 1400: # --------------------------------------------------- Assign a key to a student
1401:
1402: sub assign_access_key {
1.364 www 1403: #
1404: # a valid key looks like uname:udom#comments
1405: # comments are being appended
1406: #
1.498 www 1407: my ($ckey,$kdom,$knum,$cdom,$cnum,$udom,$uname,$logentry)=@_;
1408: $kdom=
1.620 albertel 1409: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($kdom));
1.498 www 1410: $knum=
1.620 albertel 1411: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($knum));
1.344 www 1412: $cdom=
1.620 albertel 1413: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1414: $cnum=
1.620 albertel 1415: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1416: $udom=$env{'user.name'} unless (defined($udom));
1417: $uname=$env{'user.domain'} unless (defined($uname));
1.498 www 1418: my %existing=&get('accesskeys',[$ckey],$kdom,$knum);
1.364 www 1419: if (($existing{$ckey}=~/^\#(.*)$/) || # - new key
1.479 albertel 1420: ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#(.*)$/)) {
1.364 www 1421: # assigned to this person
1422: # - this should not happen,
1.345 www 1423: # unless something went wrong
1424: # the first time around
1425: # ready to assign
1.364 www 1426: $logentry=$1.'; '.$logentry;
1.496 www 1427: if (&put('accesskeys',{$ckey=>$uname.':'.$udom.'#'.$logentry},
1.498 www 1428: $kdom,$knum) eq 'ok') {
1.345 www 1429: # key now belongs to user
1.346 www 1430: my $envkey='key.'.$cdom.'_'.$cnum;
1.345 www 1431: if (&put('environment',{$envkey => $ckey}) eq 'ok') {
1.949 raeburn 1432: &appenv({'environment.'.$envkey => $ckey});
1.345 www 1433: return 'ok';
1434: } else {
1435: return
1436: 'error: Count not permanently assign key, will need to be re-entered later.';
1437: }
1438: } else {
1439: return 'error: Could not assign key, try again later.';
1440: }
1.364 www 1441: } elsif (!$existing{$ckey}) {
1.345 www 1442: # the key does not exist
1443: return 'error: The key does not exist';
1444: } else {
1445: # the key is somebody else's
1446: return 'error: The key is already in use';
1447: }
1.344 www 1448: }
1449:
1.364 www 1450: # ------------------------------------------ put an additional comment on a key
1451:
1452: sub comment_access_key {
1453: #
1454: # a valid key looks like uname:udom#comments
1455: # comments are being appended
1456: #
1457: my ($ckey,$cdom,$cnum,$logentry)=@_;
1458: $cdom=
1.620 albertel 1459: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.364 www 1460: $cnum=
1.620 albertel 1461: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.364 www 1462: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1463: if ($existing{$ckey}) {
1464: $existing{$ckey}.='; '.$logentry;
1465: # ready to assign
1.367 www 1466: if (&put('accesskeys',{$ckey=>$existing{$ckey}},
1.364 www 1467: $cdom,$cnum) eq 'ok') {
1468: return 'ok';
1469: } else {
1470: return 'error: Count not store comment.';
1471: }
1472: } else {
1473: # the key does not exist
1474: return 'error: The key does not exist';
1475: }
1476: }
1477:
1.344 www 1478: # ------------------------------------------------------ Generate a set of keys
1479:
1480: sub generate_access_keys {
1.364 www 1481: my ($number,$cdom,$cnum,$logentry)=@_;
1.344 www 1482: $cdom=
1.620 albertel 1483: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1484: $cnum=
1.620 albertel 1485: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1.361 www 1486: unless (&allowed('mky',$cdom)) { return 0; }
1.344 www 1487: unless (($cdom) && ($cnum)) { return 0; }
1488: if ($number>10000) { return 0; }
1489: sleep(2); # make sure don't get same seed twice
1490: srand(time()^($$+($$<<15))); # from "Programming Perl"
1491: my $total=0;
1492: for (my $i=1;$i<=$number;$i++) {
1493: my $newkey=sprintf("%lx",int(100000*rand)).'-'.
1494: sprintf("%lx",int(100000*rand)).'-'.
1495: sprintf("%lx",int(100000*rand));
1496: $newkey=~s/1/g/g; # folks mix up 1 and l
1497: $newkey=~s/0/h/g; # and also 0 and O
1498: my %existing=&get('accesskeys',[$newkey],$cdom,$cnum);
1499: if ($existing{$newkey}) {
1500: $i--;
1501: } else {
1.364 www 1502: if (&put('accesskeys',
1503: { $newkey => '# generated '.localtime().
1.620 albertel 1504: ' by '.$env{'user.name'}.'@'.$env{'user.domain'}.
1.364 www 1505: '; '.$logentry },
1506: $cdom,$cnum) eq 'ok') {
1.344 www 1507: $total++;
1508: }
1509: }
1510: }
1.620 albertel 1511: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.344 www 1512: 'Generated '.$total.' keys for '.$cnum.' at '.$cdom);
1513: return $total;
1514: }
1515:
1516: # ------------------------------------------------------- Validate an accesskey
1517:
1518: sub validate_access_key {
1519: my ($ckey,$cdom,$cnum,$udom,$uname)=@_;
1520: $cdom=
1.620 albertel 1521: $env{'course.'.$env{'request.course.id'}.'.domain'} unless (defined($cdom));
1.344 www 1522: $cnum=
1.620 albertel 1523: $env{'course.'.$env{'request.course.id'}.'.num'} unless (defined($cnum));
1524: $udom=$env{'user.domain'} unless (defined($udom));
1525: $uname=$env{'user.name'} unless (defined($uname));
1.345 www 1526: my %existing=&get('accesskeys',[$ckey],$cdom,$cnum);
1.479 albertel 1527: return ($existing{$ckey}=~/^\Q$uname\E\:\Q$udom\E\#/);
1.70 www 1528: }
1529:
1530: # ------------------------------------- Find the section of student in a course
1.652 albertel 1531: sub devalidate_getsection_cache {
1532: my ($udom,$unam,$courseid)=@_;
1533: my $hashid="$udom:$unam:$courseid";
1534: &devalidate_cache_new('getsection',$hashid);
1535: }
1.298 matthew 1536:
1.815 albertel 1537: sub courseid_to_courseurl {
1538: my ($courseid) = @_;
1539: #already url style courseid
1540: return $courseid if ($courseid =~ m{^/});
1541:
1542: if (exists($env{'course.'.$courseid.'.num'})) {
1543: my $cnum = $env{'course.'.$courseid.'.num'};
1544: my $cdom = $env{'course.'.$courseid.'.domain'};
1545: return "/$cdom/$cnum";
1546: }
1547:
1548: my %courseinfo=&Apache::lonnet::coursedescription($courseid);
1549: if (exists($courseinfo{'num'})) {
1550: return "/$courseinfo{'domain'}/$courseinfo{'num'}";
1551: }
1552:
1553: return undef;
1554: }
1555:
1.298 matthew 1556: sub getsection {
1557: my ($udom,$unam,$courseid)=@_;
1.599 albertel 1558: my $cachetime=1800;
1.551 albertel 1559:
1560: my $hashid="$udom:$unam:$courseid";
1.599 albertel 1561: my ($result,$cached)=&is_cached_new('getsection',$hashid);
1.551 albertel 1562: if (defined($cached)) { return $result; }
1563:
1.298 matthew 1564: my %Pending;
1565: my %Expired;
1566: #
1567: # Each role can either have not started yet (pending), be active,
1568: # or have expired.
1569: #
1570: # If there is an active role, we are done.
1571: #
1572: # If there is more than one role which has not started yet,
1573: # choose the one which will start sooner
1574: # If there is one role which has not started yet, return it.
1575: #
1576: # If there is more than one expired role, choose the one which ended last.
1577: # If there is a role which has expired, return it.
1578: #
1.815 albertel 1579: $courseid = &courseid_to_courseurl($courseid);
1.817 raeburn 1580: my %roleshash = &dump('roles',$udom,$unam,$courseid);
1581: foreach my $key (keys(%roleshash)) {
1.479 albertel 1582: next if ($key !~/^\Q$courseid\E(?:\/)*(\w+)*\_st$/);
1.298 matthew 1583: my $section=$1;
1584: if ($key eq $courseid.'_st') { $section=''; }
1.817 raeburn 1585: my ($dummy,$end,$start)=split(/\_/,&unescape($roleshash{$key}));
1.298 matthew 1586: my $now=time;
1.548 albertel 1587: if (defined($end) && $end && ($now > $end)) {
1.298 matthew 1588: $Expired{$end}=$section;
1589: next;
1590: }
1.548 albertel 1591: if (defined($start) && $start && ($now < $start)) {
1.298 matthew 1592: $Pending{$start}=$section;
1593: next;
1594: }
1.599 albertel 1595: return &do_cache_new('getsection',$hashid,$section,$cachetime);
1.298 matthew 1596: }
1597: #
1598: # Presumedly there will be few matching roles from the above
1599: # loop and the sorting time will be negligible.
1600: if (scalar(keys(%Pending))) {
1601: my ($time) = sort {$a <=> $b} keys(%Pending);
1.599 albertel 1602: return &do_cache_new('getsection',$hashid,$Pending{$time},$cachetime);
1.298 matthew 1603: }
1604: if (scalar(keys(%Expired))) {
1605: my @sorted = sort {$a <=> $b} keys(%Expired);
1606: my $time = pop(@sorted);
1.599 albertel 1607: return &do_cache_new('getsection',$hashid,$Expired{$time},$cachetime);
1.298 matthew 1608: }
1.599 albertel 1609: return &do_cache_new('getsection',$hashid,'-1',$cachetime);
1.298 matthew 1610: }
1.70 www 1611:
1.599 albertel 1612: sub save_cache {
1613: &purge_remembered();
1.722 albertel 1614: #&Apache::loncommon::validate_page();
1.620 albertel 1615: undef(%env);
1.780 albertel 1616: undef($env_loaded);
1.599 albertel 1617: }
1.452 albertel 1618:
1.599 albertel 1619: my $to_remember=-1;
1620: my %remembered;
1621: my %accessed;
1622: my $kicks=0;
1623: my $hits=0;
1.849 albertel 1624: sub make_key {
1625: my ($name,$id) = @_;
1.872 albertel 1626: if (length($id) > 65
1627: && length(&escape($id)) > 200) {
1628: $id=length($id).':'.&Digest::MD5::md5_hex($id);
1629: }
1.849 albertel 1630: return &escape($name.':'.$id);
1631: }
1632:
1.599 albertel 1633: sub devalidate_cache_new {
1634: my ($name,$id,$debug) = @_;
1635: if ($debug) { &Apache::lonnet::logthis("deleting $name:$id"); }
1.849 albertel 1636: $id=&make_key($name,$id);
1.599 albertel 1637: $memcache->delete($id);
1638: delete($remembered{$id});
1639: delete($accessed{$id});
1640: }
1641:
1642: sub is_cached_new {
1643: my ($name,$id,$debug) = @_;
1.849 albertel 1644: $id=&make_key($name,$id);
1.599 albertel 1645: if (exists($remembered{$id})) {
1646: if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
1647: $accessed{$id}=[&gettimeofday()];
1648: $hits++;
1649: return ($remembered{$id},1);
1650: }
1651: my $value = $memcache->get($id);
1652: if (!(defined($value))) {
1653: if ($debug) { &Apache::lonnet::logthis("getting $id is not defined"); }
1.417 albertel 1654: return (undef,undef);
1.416 albertel 1655: }
1.599 albertel 1656: if ($value eq '__undef__') {
1657: if ($debug) { &Apache::lonnet::logthis("getting $id is __undef__"); }
1658: $value=undef;
1659: }
1660: &make_room($id,$value,$debug);
1661: if ($debug) { &Apache::lonnet::logthis("getting $id is $value"); }
1662: return ($value,1);
1663: }
1664:
1665: sub do_cache_new {
1666: my ($name,$id,$value,$time,$debug) = @_;
1.849 albertel 1667: $id=&make_key($name,$id);
1.599 albertel 1668: my $setvalue=$value;
1669: if (!defined($setvalue)) {
1670: $setvalue='__undef__';
1671: }
1.623 albertel 1672: if (!defined($time) ) {
1673: $time=600;
1674: }
1.599 albertel 1675: if ($debug) { &Apache::lonnet::logthis("Setting $id to $value"); }
1.910 albertel 1676: my $result = $memcache->set($id,$setvalue,$time);
1677: if (! $result) {
1.872 albertel 1678: &logthis("caching of id -> $id failed");
1.910 albertel 1679: $memcache->disconnect_all();
1.872 albertel 1680: }
1.600 albertel 1681: # need to make a copy of $value
1.919 albertel 1682: &make_room($id,$value,$debug);
1.599 albertel 1683: return $value;
1684: }
1685:
1686: sub make_room {
1687: my ($id,$value,$debug)=@_;
1.919 albertel 1688:
1689: $remembered{$id}= (ref($value)) ? &Storable::dclone($value)
1690: : $value;
1.599 albertel 1691: if ($to_remember<0) { return; }
1692: $accessed{$id}=[&gettimeofday()];
1693: if (scalar(keys(%remembered)) <= $to_remember) { return; }
1694: my $to_kick;
1695: my $max_time=0;
1696: foreach my $other (keys(%accessed)) {
1697: if (&tv_interval($accessed{$other}) > $max_time) {
1698: $to_kick=$other;
1699: $max_time=&tv_interval($accessed{$other});
1700: }
1701: }
1702: delete($remembered{$to_kick});
1703: delete($accessed{$to_kick});
1704: $kicks++;
1705: if ($debug) { &logthis("kicking $to_kick $max_time $kicks\n"); }
1.541 albertel 1706: return;
1707: }
1708:
1.599 albertel 1709: sub purge_remembered {
1.604 albertel 1710: #&logthis("Tossing ".scalar(keys(%remembered)));
1711: #&logthis(sprintf("%-20s is %s",'%remembered',length(&freeze(\%remembered))));
1.599 albertel 1712: undef(%remembered);
1713: undef(%accessed);
1.428 albertel 1714: }
1.70 www 1715: # ------------------------------------- Read an entry from a user's environment
1716:
1717: sub userenvironment {
1718: my ($udom,$unam,@what)=@_;
1.976 raeburn 1719: my $items;
1720: foreach my $item (@what) {
1721: $items.=&escape($item).'&';
1722: }
1723: $items=~s/\&$//;
1.70 www 1724: my %returnhash=();
1.1009 raeburn 1725: my $uhome = &homeserver($unam,$udom);
1726: unless ($uhome eq 'no_host') {
1727: my @answer=split(/\&/,
1728: &reply('get:'.$udom.':'.$unam.':environment:'.$items,$uhome));
1.1048 raeburn 1729: if ($#answer==0 && $answer[0] =~ /^(con_lost|error:|no_such_host)/i) {
1730: return %returnhash;
1731: }
1.1009 raeburn 1732: my $i;
1733: for ($i=0;$i<=$#what;$i++) {
1734: $returnhash{$what[$i]}=&unescape($answer[$i]);
1735: }
1.70 www 1736: }
1737: return %returnhash;
1.1 albertel 1738: }
1739:
1.617 albertel 1740: # ---------------------------------------------------------- Get a studentphoto
1741: sub studentphoto {
1742: my ($udom,$unam,$ext) = @_;
1743: my $home=&Apache::lonnet::homeserver($unam,$udom);
1.706 raeburn 1744: if (defined($env{'request.course.id'})) {
1.708 raeburn 1745: if ($env{'course.'.$env{'request.course.id'}.'.internal.showphoto'}) {
1.706 raeburn 1746: if ($udom eq $env{'course.'.$env{'request.course.id'}.'.domain'}) {
1747: return(&retrievestudentphoto($udom,$unam,$ext));
1748: } else {
1749: my ($result,$perm_reqd)=
1.707 albertel 1750: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1751: if ($result eq 'ok') {
1752: if (!($perm_reqd eq 'yes')) {
1753: return(&retrievestudentphoto($udom,$unam,$ext));
1754: }
1755: }
1756: }
1757: }
1758: } else {
1759: my ($result,$perm_reqd) =
1.707 albertel 1760: &Apache::lonnet::auto_photo_permission($unam,$udom);
1.706 raeburn 1761: if ($result eq 'ok') {
1762: if (!($perm_reqd eq 'yes')) {
1763: return(&retrievestudentphoto($udom,$unam,$ext));
1764: }
1765: }
1766: }
1767: return '/adm/lonKaputt/lonlogo_broken.gif';
1768: }
1769:
1770: sub retrievestudentphoto {
1771: my ($udom,$unam,$ext,$type) = @_;
1772: my $home=&Apache::lonnet::homeserver($unam,$udom);
1773: my $ret=&Apache::lonnet::reply("studentphoto:$udom:$unam:$ext:$type",$home);
1774: if ($ret eq 'ok') {
1775: my $url="/uploaded/$udom/$unam/internal/studentphoto.$ext";
1776: if ($type eq 'thumbnail') {
1777: $url="/uploaded/$udom/$unam/internal/studentphoto_tn.$ext";
1778: }
1779: my $tokenurl=&Apache::lonnet::tokenwrapper($url);
1780: return $tokenurl;
1781: } else {
1782: if ($type eq 'thumbnail') {
1783: return '/adm/lonKaputt/genericstudent_tn.gif';
1784: } else {
1785: return '/adm/lonKaputt/lonlogo_broken.gif';
1786: }
1.617 albertel 1787: }
1788: }
1789:
1.263 www 1790: # -------------------------------------------------------------------- New chat
1791:
1792: sub chatsend {
1.724 raeburn 1793: my ($newentry,$anon,$group)=@_;
1.620 albertel 1794: my $cnum=$env{'course.'.$env{'request.course.id'}.'.num'};
1795: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1796: my $chome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.263 www 1797: &reply('chatsend:'.$cdom.':'.$cnum.':'.
1.620 albertel 1798: &escape($env{'user.domain'}.':'.$env{'user.name'}.':'.$anon.':'.
1.724 raeburn 1799: &escape($newentry)).':'.$group,$chome);
1.292 www 1800: }
1801:
1802: # ------------------------------------------ Find current version of a resource
1803:
1804: sub getversion {
1805: my $fname=&clutter(shift);
1806: unless ($fname=~/^\/res\//) { return -1; }
1807: return ¤tversion(&filelocation('',$fname));
1808: }
1809:
1810: sub currentversion {
1811: my $fname=shift;
1.599 albertel 1812: my ($result,$cached)=&is_cached_new('resversion',$fname);
1.440 www 1813: if (defined($cached)) { return $result; }
1.292 www 1814: my $author=$fname;
1815: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1816: my ($udom,$uname)=split(/\//,$author);
1817: my $home=homeserver($uname,$udom);
1818: if ($home eq 'no_host') {
1819: return -1;
1820: }
1821: my $answer=reply("currentversion:$fname",$home);
1822: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1823: return -1;
1824: }
1.599 albertel 1825: return &do_cache_new('resversion',$fname,$answer,600);
1.263 www 1826: }
1827:
1.1 albertel 1828: # ----------------------------- Subscribe to a resource, return URL if possible
1.11 www 1829:
1.1 albertel 1830: sub subscribe {
1831: my $fname=shift;
1.761 raeburn 1832: if ($fname=~/\/(aboutme|syllabus|bulletinboard|smppg)$/) { return ''; }
1.532 albertel 1833: $fname=~s/[\n\r]//g;
1.1 albertel 1834: my $author=$fname;
1835: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1836: my ($udom,$uname)=split(/\//,$author);
1837: my $home=homeserver($uname,$udom);
1.335 albertel 1838: if ($home eq 'no_host') {
1839: return 'not_found';
1.1 albertel 1840: }
1841: my $answer=reply("sub:$fname",$home);
1.64 www 1842: if (($answer eq 'con_lost') || ($answer eq 'rejected')) {
1843: $answer.=' by '.$home;
1844: }
1.1 albertel 1845: return $answer;
1846: }
1847:
1.8 www 1848: # -------------------------------------------------------------- Replicate file
1849:
1850: sub repcopy {
1851: my $filename=shift;
1.23 www 1852: $filename=~s/\/+/\//g;
1.607 raeburn 1853: if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
1854: if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 1855: if ($filename=~m|^/home/httpd/html/userfiles/| or
1.609 banghart 1856: $filename=~m -^/*(uploaded|editupload)/-) {
1.538 albertel 1857: return &repcopy_userfile($filename);
1858: }
1.532 albertel 1859: $filename=~s/[\n\r]//g;
1.8 www 1860: my $transname="$filename.in.transfer";
1.828 www 1861: # FIXME: this should flock
1.607 raeburn 1862: if ((-e $filename) || (-e $transname)) { return 'ok'; }
1.8 www 1863: my $remoteurl=subscribe($filename);
1.64 www 1864: if ($remoteurl =~ /^con_lost by/) {
1865: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1866: return 'unavailable';
1.8 www 1867: } elsif ($remoteurl eq 'not_found') {
1.441 albertel 1868: #&logthis("Subscribe returned not_found: $filename");
1.607 raeburn 1869: return 'not_found';
1.64 www 1870: } elsif ($remoteurl =~ /^rejected by/) {
1871: &logthis("Subscribe returned $remoteurl: $filename");
1.607 raeburn 1872: return 'forbidden';
1.20 www 1873: } elsif ($remoteurl eq 'directory') {
1.607 raeburn 1874: return 'ok';
1.8 www 1875: } else {
1.290 www 1876: my $author=$filename;
1877: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1878: my ($udom,$uname)=split(/\//,$author);
1879: my $home=homeserver($uname,$udom);
1880: unless ($home eq $perlvar{'lonHostID'}) {
1.8 www 1881: my @parts=split(/\//,$filename);
1882: my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
1883: if ($path ne "$perlvar{'lonDocRoot'}/res") {
1884: &logthis("Malconfiguration for replication: $filename");
1.607 raeburn 1885: return 'bad_request';
1.8 www 1886: }
1887: my $count;
1888: for ($count=5;$count<$#parts;$count++) {
1889: $path.="/$parts[$count]";
1890: if ((-e $path)!=1) {
1891: mkdir($path,0777);
1892: }
1893: }
1894: my $ua=new LWP::UserAgent;
1895: my $request=new HTTP::Request('GET',"$remoteurl");
1896: my $response=$ua->request($request,$transname);
1897: if ($response->is_error()) {
1898: unlink($transname);
1899: my $message=$response->status_line;
1.672 albertel 1900: &logthis("<font color=\"blue\">WARNING:"
1.12 www 1901: ." LWP get: $message: $filename</font>");
1.607 raeburn 1902: return 'unavailable';
1.8 www 1903: } else {
1.16 www 1904: if ($remoteurl!~/\.meta$/) {
1905: my $mrequest=new HTTP::Request('GET',$remoteurl.'.meta');
1906: my $mresponse=$ua->request($mrequest,$filename.'.meta');
1907: if ($mresponse->is_error()) {
1908: unlink($filename.'.meta');
1909: &logthis(
1.672 albertel 1910: "<font color=\"yellow\">INFO: No metadata: $filename</font>");
1.16 www 1911: }
1912: }
1.8 www 1913: rename($transname,$filename);
1.607 raeburn 1914: return 'ok';
1.8 www 1915: }
1.290 www 1916: }
1.8 www 1917: }
1.330 www 1918: }
1919:
1920: # ------------------------------------------------ Get server side include body
1921: sub ssi_body {
1.381 albertel 1922: my ($filelink,%form)=@_;
1.606 matthew 1923: if (! exists($form{'LONCAPA_INTERNAL_no_discussion'})) {
1924: $form{'LONCAPA_INTERNAL_no_discussion'}='true';
1925: }
1.953 www 1926: my $output='';
1927: my $response;
1.980 raeburn 1928: if ($filelink=~/^https?\:/) {
1.954 raeburn 1929: ($output,$response)=&externalssi($filelink);
1.953 www 1930: } else {
1.1004 droeschl 1931: $filelink .= $filelink=~/\?/ ? '&' : '?';
1932: $filelink .= 'inhibitmenu=yes';
1.953 www 1933: ($output,$response)=&ssi($filelink,%form);
1934: }
1.778 albertel 1935: $output=~s|//(\s*<!--)? BEGIN LON-CAPA Internal.+?// END LON-CAPA Internal\s*(-->)?\s||gs;
1.451 albertel 1936: $output=~s/^.*?\<body[^\>]*\>//si;
1.930 albertel 1937: $output=~s/\<\/body\s*\>.*?$//si;
1.953 www 1938: if (wantarray) {
1939: return ($output, $response);
1940: } else {
1941: return $output;
1942: }
1.8 www 1943: }
1944:
1.15 www 1945: # --------------------------------------------------------- Server Side Include
1946:
1.782 albertel 1947: sub absolute_url {
1948: my ($host_name) = @_;
1949: my $protocol = ($ENV{'SERVER_PORT'} == 443?'https://':'http://');
1950: if ($host_name eq '') {
1951: $host_name = $ENV{'SERVER_NAME'};
1952: }
1953: return $protocol.$host_name;
1954: }
1955:
1.942 foxr 1956: #
1957: # Server side include.
1958: # Parameters:
1959: # fn Possibly encrypted resource name/id.
1960: # form Hash that describes how the rendering should be done
1961: # and other things.
1.944 foxr 1962: # Returns:
1.950 raeburn 1963: # Scalar context: The content of the response.
1964: # Array context: 2 element list of the content and the full response object.
1.942 foxr 1965: #
1.15 www 1966: sub ssi {
1967:
1.944 foxr 1968: my ($fn,%form)=@_;
1.15 www 1969: my $ua=new LWP::UserAgent;
1.23 www 1970: my $request;
1.711 albertel 1971:
1972: $form{'no_update_last_known'}=1;
1.895 albertel 1973: &Apache::lonenc::check_encrypt(\$fn);
1.23 www 1974: if (%form) {
1.782 albertel 1975: $request=new HTTP::Request('POST',&absolute_url().$fn);
1.1000 raeburn 1976: $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
1.23 www 1977: } else {
1.782 albertel 1978: $request=new HTTP::Request('GET',&absolute_url().$fn);
1.23 www 1979: }
1980:
1.15 www 1981: $request->header(Cookie => $ENV{'HTTP_COOKIE'});
1982: my $response=$ua->request($request);
1983:
1.944 foxr 1984: if (wantarray) {
1985: return ($response->content, $response);
1986: } else {
1987: return $response->content;
1.942 foxr 1988: }
1.324 www 1989: }
1990:
1991: sub externalssi {
1992: my ($url)=@_;
1993: my $ua=new LWP::UserAgent;
1994: my $request=new HTTP::Request('GET',$url);
1995: my $response=$ua->request($request);
1.954 raeburn 1996: if (wantarray) {
1997: return ($response->content, $response);
1998: } else {
1999: return $response->content;
2000: }
1.15 www 2001: }
1.254 www 2002:
1.492 albertel 2003: # -------------------------------- Allow a /uploaded/ URI to be vouched for
2004:
2005: sub allowuploaded {
2006: my ($srcurl,$url)=@_;
2007: $url=&clutter(&declutter($url));
2008: my $dir=$url;
2009: $dir=~s/\/[^\/]+$//;
2010: my %httpref=();
2011: my $httpurl=&hreflocation('',$url);
2012: $httpref{'httpref.'.$httpurl}=$srcurl;
1.949 raeburn 2013: &Apache::lonnet::appenv(\%httpref);
1.254 www 2014: }
1.477 raeburn 2015:
1.478 albertel 2016: # --------- File operations in /home/httpd/html/userfiles/$domain/1/2/3/$course
1.638 albertel 2017: # input: action, courseID, current domain, intended
1.637 raeburn 2018: # path to file, source of file, instruction to parse file for objects,
2019: # ref to hash for embedded objects,
2020: # ref to hash for codebase of java objects.
2021: #
1.485 raeburn 2022: # output: url to file (if action was uploaddoc),
2023: # ok if successful, or diagnostic message otherwise (if action was propagate or copy)
1.477 raeburn 2024: #
1.478 albertel 2025: # Allows directory structure to be used within lonUsers/../userfiles/ for a
2026: # course.
1.477 raeburn 2027: #
1.478 albertel 2028: # action = propagate - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2029: # will be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles in
2030: # course's home server.
1.477 raeburn 2031: #
1.478 albertel 2032: # action = copy - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file will
2033: # be copied from $source (current location) to
2034: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2035: # and will then be copied to
2036: # /home/httpd/lonUsers/$domain/1/2/3/$course/userfiles/$file in
2037: # course's home server.
1.485 raeburn 2038: #
1.481 raeburn 2039: # action = uploaddoc - /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
1.620 albertel 2040: # will be retrived from $env{form.uploaddoc} (from DOCS interface) to
1.481 raeburn 2041: # /home/httpd/html/userfiles/$domain/1/2/3/$course/$file
2042: # and will then be copied to /home/httpd/lonUsers/1/2/3/$course/userfiles/$file
2043: # in course's home server.
1.637 raeburn 2044: #
1.477 raeburn 2045:
2046: sub process_coursefile {
1.638 albertel 2047: my ($action,$docuname,$docudom,$file,$source,$parser,$allfiles,$codebase)=@_;
1.477 raeburn 2048: my $fetchresult;
1.638 albertel 2049: my $home=&homeserver($docuname,$docudom);
1.477 raeburn 2050: if ($action eq 'propagate') {
1.638 albertel 2051: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
2052: $home);
1.481 raeburn 2053: } else {
1.477 raeburn 2054: my $fpath = '';
2055: my $fname = $file;
1.478 albertel 2056: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
1.477 raeburn 2057: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
1.637 raeburn 2058: my $filepath = &build_filepath($fpath);
1.481 raeburn 2059: if ($action eq 'copy') {
2060: if ($source eq '') {
2061: $fetchresult = 'no source file';
2062: return $fetchresult;
2063: } else {
2064: my $destination = $filepath.'/'.$fname;
2065: rename($source,$destination);
2066: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2067: $home);
1.481 raeburn 2068: }
2069: } elsif ($action eq 'uploaddoc') {
2070: open(my $fh,'>'.$filepath.'/'.$fname);
1.620 albertel 2071: print $fh $env{'form.'.$source};
1.481 raeburn 2072: close($fh);
1.637 raeburn 2073: if ($parser eq 'parse') {
1.1024 raeburn 2074: my $mm = new File::MMagic;
2075: my $mime_type = $mm->checktype_filename($filepath.'/'.$fname);
2076: if ($mime_type eq 'text/html') {
2077: my $parse_result = &extract_embedded_items($filepath.'/'.$fname,$allfiles,$codebase);
2078: unless ($parse_result eq 'ok') {
2079: &logthis('Failed to parse '.$filepath.'/'.$fname.' for embedded media: '.$parse_result);
2080: }
1.637 raeburn 2081: }
2082: }
1.477 raeburn 2083: $fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2084: $home);
1.481 raeburn 2085: if ($fetchresult eq 'ok') {
2086: return '/uploaded/'.$fpath.'/'.$fname;
2087: } else {
2088: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2089: ' to host '.$home.': '.$fetchresult);
1.481 raeburn 2090: return '/adm/notfound.html';
2091: }
1.477 raeburn 2092: }
2093: }
1.485 raeburn 2094: unless ( $fetchresult eq 'ok') {
1.477 raeburn 2095: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
1.638 albertel 2096: ' to host '.$home.': '.$fetchresult);
1.477 raeburn 2097: }
2098: return $fetchresult;
2099: }
2100:
1.637 raeburn 2101: sub build_filepath {
2102: my ($fpath) = @_;
2103: my $filepath=$perlvar{'lonDocRoot'}.'/userfiles';
2104: unless ($fpath eq '') {
2105: my @parts=split('/',$fpath);
2106: foreach my $part (@parts) {
2107: $filepath.= '/'.$part;
2108: if ((-e $filepath)!=1) {
2109: mkdir($filepath,0777);
2110: }
2111: }
2112: }
2113: return $filepath;
2114: }
2115:
2116: sub store_edited_file {
1.638 albertel 2117: my ($primary_url,$content,$docudom,$docuname,$fetchresult) = @_;
1.637 raeburn 2118: my $file = $primary_url;
2119: $file =~ s#^/uploaded/$docudom/$docuname/##;
2120: my $fpath = '';
2121: my $fname = $file;
2122: ($fpath,$fname) = ($file =~ m|^(.*)/([^/]+)$|);
2123: $fpath=$docudom.'/'.$docuname.'/'.$fpath;
2124: my $filepath = &build_filepath($fpath);
2125: open(my $fh,'>'.$filepath.'/'.$fname);
2126: print $fh $content;
2127: close($fh);
1.638 albertel 2128: my $home=&homeserver($docuname,$docudom);
1.637 raeburn 2129: $$fetchresult= &reply('fetchuserfile:'.$docudom.'/'.$docuname.'/'.$file,
1.638 albertel 2130: $home);
1.637 raeburn 2131: if ($$fetchresult eq 'ok') {
2132: return '/uploaded/'.$fpath.'/'.$fname;
2133: } else {
1.638 albertel 2134: &logthis('Failed to transfer '.$docudom.'/'.$docuname.'/'.$file.
2135: ' to host '.$home.': '.$$fetchresult);
1.637 raeburn 2136: return '/adm/notfound.html';
2137: }
2138: }
2139:
1.531 albertel 2140: sub clean_filename {
1.831 albertel 2141: my ($fname,$args)=@_;
1.315 www 2142: # Replace Windows backslashes by forward slashes
1.257 www 2143: $fname=~s/\\/\//g;
1.831 albertel 2144: if (!$args->{'keep_path'}) {
2145: # Get rid of everything but the actual filename
2146: $fname=~s/^.*\/([^\/]+)$/$1/;
2147: }
1.315 www 2148: # Replace spaces by underscores
2149: $fname=~s/\s+/\_/g;
2150: # Replace all other weird characters by nothing
1.831 albertel 2151: $fname=~s{[^/\w\.\-]}{}g;
1.540 albertel 2152: # Replace all .\d. sequences with _\d. so they no longer look like version
2153: # numbers
2154: $fname=~s/\.(\d+)(?=\.)/_$1/g;
1.531 albertel 2155: return $fname;
2156: }
1.1051 raeburn 2157: # This Function checks if an Image's dimensions exceed either $resizewidth (width)
2158: # or $resizeheight (height) - both pixels. If so, the image is scaled to produce an
2159: # image with the same aspect ratio as the original, but with dimensions which do
2160: # not exceed $resizewidth and $resizeheight.
2161:
1.984 neumanie 2162: sub resizeImage {
1.1051 raeburn 2163: my ($img_path,$resizewidth,$resizeheight) = @_;
2164: my $ima = Image::Magick->new;
2165: my $resized;
2166: if (-e $img_path) {
2167: $ima->Read($img_path);
2168: if (($resizewidth =~ /^\d+$/) && ($resizeheight > 0)) {
2169: my $width = $ima->Get('width');
2170: my $height = $ima->Get('height');
2171: if ($width > $resizewidth) {
2172: my $factor = $width/$resizewidth;
2173: my $newheight = $height/$factor;
2174: $ima->Scale(width=>$resizewidth,height=>$newheight);
2175: $resized = 1;
2176: }
2177: }
2178: if (($resizeheight =~ /^\d+$/) && ($resizeheight > 0)) {
2179: my $width = $ima->Get('width');
2180: my $height = $ima->Get('height');
2181: if ($height > $resizeheight) {
2182: my $factor = $height/$resizeheight;
2183: my $newwidth = $width/$factor;
2184: $ima->Scale(width=>$newwidth,height=>$resizeheight);
2185: $resized = 1;
2186: }
2187: }
2188: if ($resized) {
2189: $ima->Write($img_path);
2190: }
2191: }
2192: return;
1.977 amueller 2193: }
2194:
1.608 albertel 2195: # --------------- Take an uploaded file and put it into the userfiles directory
1.686 albertel 2196: # input: $formname - the contents of the file are in $env{"form.$formname"}
1.719 banghart 2197: # the desired filenam is in $env{"form.$formname.filename"}
1.686 albertel 2198: # $coursedoc - if true up to the current course
2199: # if false
2200: # $subdir - directory in userfile to store the file into
1.858 raeburn 2201: # $parser - instruction to parse file for objects ($parser = parse)
2202: # $allfiles - reference to hash for embedded objects
2203: # $codebase - reference to hash for codebase of java objects
2204: # $desuname - username for permanent storage of uploaded file
2205: # $dsetudom - domain for permanaent storage of uploaded file
1.860 raeburn 2206: # $thumbwidth - width (pixels) of thumbnail to make for uploaded image
2207: # $thumbheight - height (pixels) of thumbnail to make for uploaded image
1.1051 raeburn 2208: # $resizewidth - width (pixels) to which to resize uploaded image
2209: # $resizeheight - height (pixels) to which to resize uploaded image
1.858 raeburn 2210: #
1.686 albertel 2211: # output: url of file in userspace, or error: <message>
2212: # or /adm/notfound.html if failure to upload occurse
1.608 albertel 2213:
1.531 albertel 2214: sub userfileupload {
1.860 raeburn 2215: my ($formname,$coursedoc,$subdir,$parser,$allfiles,$codebase,$destuname,
1.1051 raeburn 2216: $destudom,$thumbwidth,$thumbheight,$resizewidth,$resizeheight)=@_;
1.531 albertel 2217: if (!defined($subdir)) { $subdir='unknown'; }
1.620 albertel 2218: my $fname=$env{'form.'.$formname.'.filename'};
1.531 albertel 2219: $fname=&clean_filename($fname);
1.315 www 2220: # See if there is anything left
1.257 www 2221: unless ($fname) { return 'error: no uploaded file'; }
1.620 albertel 2222: chop($env{'form.'.$formname});
1.523 raeburn 2223: if (($formname eq 'screenshot') && ($subdir eq 'helprequests')) { #files uploaded to help request form are handled differently
2224: my $now = time;
2225: my $filepath = 'tmp/helprequests/'.$now;
2226: my @parts=split(/\//,$filepath);
2227: my $fullpath = $perlvar{'lonDaemons'};
2228: for (my $i=0;$i<@parts;$i++) {
2229: $fullpath .= '/'.$parts[$i];
2230: if ((-e $fullpath)!=1) {
2231: mkdir($fullpath,0777);
2232: }
2233: }
2234: open(my $fh,'>'.$fullpath.'/'.$fname);
1.620 albertel 2235: print $fh $env{'form.'.$formname};
1.523 raeburn 2236: close($fh);
1.741 raeburn 2237: return $fullpath.'/'.$fname;
2238: } elsif (($formname eq 'coursecreatorxml') && ($subdir eq 'batchupload')) { #files uploaded to create course page are handled differently
2239: my $filepath = 'tmp/addcourse/'.$destudom.'/web/'.$env{'user.name'}.
2240: '_'.$env{'user.domain'}.'/pending';
2241: my @parts=split(/\//,$filepath);
2242: my $fullpath = $perlvar{'lonDaemons'};
2243: for (my $i=0;$i<@parts;$i++) {
2244: $fullpath .= '/'.$parts[$i];
2245: if ((-e $fullpath)!=1) {
2246: mkdir($fullpath,0777);
2247: }
2248: }
2249: open(my $fh,'>'.$fullpath.'/'.$fname);
2250: print $fh $env{'form.'.$formname};
2251: close($fh);
2252: return $fullpath.'/'.$fname;
1.523 raeburn 2253: }
1.995 raeburn 2254: if ($subdir eq 'scantron') {
2255: $fname = 'scantron_orig_'.$fname;
2256: } else {
1.258 www 2257: # Create the directory if not present
1.995 raeburn 2258: $fname="$subdir/$fname";
2259: }
1.259 www 2260: if ($coursedoc) {
1.638 albertel 2261: my $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2262: my $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.646 raeburn 2263: if ($env{'form.folder'} =~ m/^(default|supplemental)/) {
1.638 albertel 2264: return &finishuserfileupload($docuname,$docudom,
2265: $formname,$fname,$parser,$allfiles,
1.1051 raeburn 2266: $codebase,$thumbwidth,$thumbheight,
2267: $resizewidth,$resizeheight);
1.481 raeburn 2268: } else {
1.620 albertel 2269: $fname=$env{'form.folder'}.'/'.$fname;
1.638 albertel 2270: return &process_coursefile('uploaddoc',$docuname,$docudom,
2271: $fname,$formname,$parser,
2272: $allfiles,$codebase);
1.481 raeburn 2273: }
1.719 banghart 2274: } elsif (defined($destuname)) {
2275: my $docuname=$destuname;
2276: my $docudom=$destudom;
1.860 raeburn 2277: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2278: $parser,$allfiles,$codebase,
1.1051 raeburn 2279: $thumbwidth,$thumbheight,
2280: $resizewidth,$resizeheight);
1.719 banghart 2281:
1.259 www 2282: } else {
1.638 albertel 2283: my $docuname=$env{'user.name'};
2284: my $docudom=$env{'user.domain'};
1.714 raeburn 2285: if (exists($env{'form.group'})) {
2286: $docuname=$env{'course.'.$env{'request.course.id'}.'.num'};
2287: $docudom=$env{'course.'.$env{'request.course.id'}.'.domain'};
2288: }
1.860 raeburn 2289: return &finishuserfileupload($docuname,$docudom,$formname,$fname,
2290: $parser,$allfiles,$codebase,
1.1051 raeburn 2291: $thumbwidth,$thumbheight,
2292: $resizewidth,$resizeheight);
1.259 www 2293: }
1.271 www 2294: }
2295:
2296: sub finishuserfileupload {
1.860 raeburn 2297: my ($docuname,$docudom,$formname,$fname,$parser,$allfiles,$codebase,
1.1051 raeburn 2298: $thumbwidth,$thumbheight,$resizewidth,$resizeheight) = @_;
1.477 raeburn 2299: my $path=$docudom.'/'.$docuname.'/';
1.258 www 2300: my $filepath=$perlvar{'lonDocRoot'};
1.984 neumanie 2301:
1.860 raeburn 2302: my ($fnamepath,$file,$fetchthumb);
1.494 albertel 2303: $file=$fname;
2304: if ($fname=~m|/|) {
2305: ($fnamepath,$file) = ($fname =~ m|^(.*)/([^/]+)$|);
2306: $path.=$fnamepath.'/';
2307: }
1.259 www 2308: my @parts=split(/\//,$filepath.'/userfiles/'.$path);
1.258 www 2309: my $count;
2310: for ($count=4;$count<=$#parts;$count++) {
2311: $filepath.="/$parts[$count]";
2312: if ((-e $filepath)!=1) {
2313: mkdir($filepath,0777);
2314: }
2315: }
1.984 neumanie 2316:
1.258 www 2317: # Save the file
2318: {
1.701 albertel 2319: if (!open(FH,'>'.$filepath.'/'.$file)) {
2320: &logthis('Failed to create '.$filepath.'/'.$file);
2321: print STDERR ('Failed to create '.$filepath.'/'.$file."\n");
2322: return '/adm/notfound.html';
2323: }
2324: if (!print FH ($env{'form.'.$formname})) {
2325: &logthis('Failed to write to '.$filepath.'/'.$file);
2326: print STDERR ('Failed to write to '.$filepath.'/'.$file."\n");
2327: return '/adm/notfound.html';
2328: }
1.570 albertel 2329: close(FH);
1.1051 raeburn 2330: if ($resizewidth && $resizeheight) {
2331: my $mm = new File::MMagic;
2332: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2333: if ($mime_type =~ m{^image/}) {
2334: &resizeImage($filepath.'/'.$file,$resizewidth,$resizeheight);
2335: }
1.977 amueller 2336: }
1.258 www 2337: }
1.637 raeburn 2338: if ($parser eq 'parse') {
1.1024 raeburn 2339: my $mm = new File::MMagic;
2340: my $mime_type = $mm->checktype_filename($filepath.'/'.$file);
2341: if ($mime_type eq 'text/html') {
2342: my $parse_result = &extract_embedded_items($filepath.'/'.$file,
2343: $allfiles,$codebase);
2344: unless ($parse_result eq 'ok') {
2345: &logthis('Failed to parse '.$filepath.$file.
2346: ' for embedded media: '.$parse_result);
2347: }
1.637 raeburn 2348: }
2349: }
1.860 raeburn 2350: if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
2351: my $input = $filepath.'/'.$file;
2352: my $output = $filepath.'/'.'tn-'.$file;
2353: my $thumbsize = $thumbwidth.'x'.$thumbheight;
2354: system("convert -sample $thumbsize $input $output");
2355: if (-e $filepath.'/'.'tn-'.$file) {
2356: $fetchthumb = 1;
2357: }
2358: }
1.858 raeburn 2359:
1.259 www 2360: # Notify homeserver to grep it
2361: #
1.984 neumanie 2362: my $docuhome=&homeserver($docuname,$docudom);
1.494 albertel 2363: my $fetchresult= &reply('fetchuserfile:'.$path.$file,$docuhome);
1.295 www 2364: if ($fetchresult eq 'ok') {
1.860 raeburn 2365: if ($fetchthumb) {
2366: my $thumbresult= &reply('fetchuserfile:'.$path.'tn-'.$file,$docuhome);
2367: if ($thumbresult ne 'ok') {
2368: &logthis('Failed to transfer '.$path.'tn-'.$file.' to host '.
2369: $docuhome.': '.$thumbresult);
2370: }
2371: }
1.259 www 2372: #
1.258 www 2373: # Return the URL to it
1.494 albertel 2374: return '/uploaded/'.$path.$file;
1.263 www 2375: } else {
1.494 albertel 2376: &logthis('Failed to transfer '.$path.$file.' to host '.$docuhome.
2377: ': '.$fetchresult);
1.263 www 2378: return '/adm/notfound.html';
1.858 raeburn 2379: }
1.493 albertel 2380: }
2381:
1.637 raeburn 2382: sub extract_embedded_items {
1.961 raeburn 2383: my ($fullpath,$allfiles,$codebase,$content) = @_;
1.637 raeburn 2384: my @state = ();
2385: my %javafiles = (
2386: codebase => '',
2387: code => '',
2388: archive => ''
2389: );
2390: my %mediafiles = (
2391: src => '',
2392: movie => '',
2393: );
1.648 raeburn 2394: my $p;
2395: if ($content) {
2396: $p = HTML::LCParser->new($content);
2397: } else {
1.961 raeburn 2398: $p = HTML::LCParser->new($fullpath);
1.648 raeburn 2399: }
1.641 albertel 2400: while (my $t=$p->get_token()) {
1.640 albertel 2401: if ($t->[0] eq 'S') {
2402: my ($tagname, $attr) = ($t->[1],$t->[2]);
1.886 albertel 2403: push(@state, $tagname);
1.648 raeburn 2404: if (lc($tagname) eq 'allow') {
2405: &add_filetype($allfiles,$attr->{'src'},'src');
2406: }
1.640 albertel 2407: if (lc($tagname) eq 'img') {
2408: &add_filetype($allfiles,$attr->{'src'},'src');
2409: }
1.886 albertel 2410: if (lc($tagname) eq 'a') {
2411: &add_filetype($allfiles,$attr->{'href'},'href');
2412: }
1.645 raeburn 2413: if (lc($tagname) eq 'script') {
2414: if ($attr->{'archive'} =~ /\.jar$/i) {
2415: &add_filetype($allfiles,$attr->{'archive'},'archive');
2416: } else {
2417: &add_filetype($allfiles,$attr->{'src'},'src');
2418: }
2419: }
2420: if (lc($tagname) eq 'link') {
2421: if (lc($attr->{'rel'}) eq 'stylesheet') {
2422: &add_filetype($allfiles,$attr->{'href'},'href');
2423: }
2424: }
1.640 albertel 2425: if (lc($tagname) eq 'object' ||
2426: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')) {
2427: foreach my $item (keys(%javafiles)) {
2428: $javafiles{$item} = '';
2429: }
2430: }
2431: if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
2432: my $name = lc($attr->{'name'});
2433: foreach my $item (keys(%javafiles)) {
2434: if ($name eq $item) {
2435: $javafiles{$item} = $attr->{'value'};
2436: last;
2437: }
2438: }
2439: foreach my $item (keys(%mediafiles)) {
2440: if ($name eq $item) {
2441: &add_filetype($allfiles, $attr->{'value'}, 'value');
2442: last;
2443: }
2444: }
2445: }
2446: if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
2447: foreach my $item (keys(%javafiles)) {
2448: if ($attr->{$item}) {
2449: $javafiles{$item} = $attr->{$item};
2450: last;
2451: }
2452: }
2453: foreach my $item (keys(%mediafiles)) {
2454: if ($attr->{$item}) {
2455: &add_filetype($allfiles,$attr->{$item},$item);
2456: last;
2457: }
2458: }
2459: }
2460: } elsif ($t->[0] eq 'E') {
2461: my ($tagname) = ($t->[1]);
2462: if ($javafiles{'codebase'} ne '') {
2463: $javafiles{'codebase'} .= '/';
2464: }
2465: if (lc($tagname) eq 'applet' ||
2466: lc($tagname) eq 'object' ||
2467: (lc($tagname) eq 'embed' && lc($state[-2]) ne 'object')
2468: ) {
2469: foreach my $item (keys(%javafiles)) {
2470: if ($item ne 'codebase' && $javafiles{$item} ne '') {
2471: my $file=$javafiles{'codebase'}.$javafiles{$item};
2472: &add_filetype($allfiles,$file,$item);
2473: }
2474: }
2475: }
2476: pop @state;
2477: }
2478: }
1.637 raeburn 2479: return 'ok';
2480: }
2481:
1.639 albertel 2482: sub add_filetype {
2483: my ($allfiles,$file,$type)=@_;
2484: if (exists($allfiles->{$file})) {
2485: unless (grep/^\Q$type\E$/, @{$allfiles->{$file}}) {
2486: push(@{$allfiles->{$file}}, &escape($type));
2487: }
2488: } else {
2489: @{$allfiles->{$file}} = (&escape($type));
1.637 raeburn 2490: }
2491: }
2492:
1.493 albertel 2493: sub removeuploadedurl {
1.984 neumanie 2494: my ($url)=@_;
2495: my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
1.613 albertel 2496: return &removeuserfile($uname,$udom,$fname);
1.490 albertel 2497: }
2498:
2499: sub removeuserfile {
2500: my ($docuname,$docudom,$fname)=@_;
1.984 neumanie 2501: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2502: my $result = &reply("removeuserfile:$docudom/$docuname/$fname",$home);
1.984 neumanie 2503: if ($result eq 'ok') {
1.798 raeburn 2504: if (($fname !~ /\.meta$/) && (&is_portfolio_file($fname))) {
2505: my $metafile = $fname.'.meta';
2506: my $metaresult = &removeuserfile($docuname,$docudom,$metafile);
1.823 albertel 2507: my $url = "/uploaded/$docudom/$docuname/$fname";
1.984 neumanie 2508: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2509: my $sqlresult =
1.823 albertel 2510: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2511: 'portfolio_metadata',$group,
2512: 'delete');
1.798 raeburn 2513: }
2514: }
2515: return $result;
1.257 www 2516: }
1.15 www 2517:
1.530 albertel 2518: sub mkdiruserfile {
2519: my ($docuname,$docudom,$dir)=@_;
2520: my $home=&homeserver($docuname,$docudom);
2521: return &reply("mkdiruserfile:".&escape("$docudom/$docuname/$dir"),$home);
2522: }
2523:
1.531 albertel 2524: sub renameuserfile {
2525: my ($docuname,$docudom,$old,$new)=@_;
2526: my $home=&homeserver($docuname,$docudom);
1.798 raeburn 2527: my $result = &reply("renameuserfile:$docudom:$docuname:".
2528: &escape("$old").':'.&escape("$new"),$home);
2529: if ($result eq 'ok') {
2530: if (($old !~ /\.meta$/) && (&is_portfolio_file($old))) {
2531: my $oldmeta = $old.'.meta';
2532: my $newmeta = $new.'.meta';
2533: my $metaresult =
2534: &renameuserfile($docuname,$docudom,$oldmeta,$newmeta);
1.823 albertel 2535: my $url = "/uploaded/$docudom/$docuname/$old";
2536: my ($file,$group) = (&parse_portfolio_url($url))[3,4];
1.821 raeburn 2537: my $sqlresult =
1.823 albertel 2538: &update_portfolio_table($docuname,$docudom,$file,
1.821 raeburn 2539: 'portfolio_metadata',$group,
2540: 'delete');
1.798 raeburn 2541: }
2542: }
2543: return $result;
1.531 albertel 2544: }
2545:
1.14 www 2546: # ------------------------------------------------------------------------- Log
2547:
2548: sub log {
2549: my ($dom,$nam,$hom,$what)=@_;
1.47 www 2550: return critical("log:$dom:$nam:$what",$hom);
1.157 www 2551: }
2552:
2553: # ------------------------------------------------------------------ Course Log
1.352 www 2554: #
2555: # This routine flushes several buffers of non-mission-critical nature
2556: #
1.157 www 2557:
2558: sub flushcourselogs {
1.352 www 2559: &logthis('Flushing log buffers');
2560: #
2561: # course logs
2562: # This is a log of all transactions in a course, which can be used
2563: # for data mining purposes
2564: #
2565: # It also collects the courseid database, which lists last transaction
2566: # times and course titles for all courseids
2567: #
2568: my %courseidbuffer=();
1.921 raeburn 2569: foreach my $crsid (keys(%courselogs)) {
1.352 www 2570: if (&reply('log:'.$coursedombuf{$crsid}.':'.$coursenumbuf{$crsid}.':'.
1.188 www 2571: &escape($courselogs{$crsid}),
2572: $coursehombuf{$crsid}) eq 'ok') {
1.157 www 2573: delete $courselogs{$crsid};
2574: } else {
2575: &logthis('Failed to flush log buffer for '.$crsid);
2576: if (length($courselogs{$crsid})>40000) {
1.672 albertel 2577: &logthis("<font color=\"blue\">WARNING: Buffer for ".$crsid.
1.157 www 2578: " exceeded maximum size, deleting.</font>");
2579: delete $courselogs{$crsid};
2580: }
1.352 www 2581: }
1.920 raeburn 2582: $courseidbuffer{$coursehombuf{$crsid}}{$crsid} = {
1.936 raeburn 2583: 'description' => $coursedescrbuf{$crsid},
2584: 'inst_code' => $courseinstcodebuf{$crsid},
2585: 'type' => $coursetypebuf{$crsid},
2586: 'owner' => $courseownerbuf{$crsid},
1.920 raeburn 2587: };
1.191 harris41 2588: }
1.352 www 2589: #
2590: # Write course id database (reverse lookup) to homeserver of courses
2591: # Is used in pickcourse
2592: #
1.840 albertel 2593: foreach my $crs_home (keys(%courseidbuffer)) {
1.918 raeburn 2594: my $response = &courseidput(&host_domain($crs_home),
1.921 raeburn 2595: $courseidbuffer{$crs_home},
2596: $crs_home,'timeonly');
1.352 www 2597: }
2598: #
2599: # File accesses
2600: # Writes to the dynamic metadata of resources to get hit counts, etc.
2601: #
1.449 matthew 2602: foreach my $entry (keys(%accesshash)) {
1.458 matthew 2603: if ($entry =~ /___count$/) {
2604: my ($dom,$name);
1.807 albertel 2605: ($dom,$name,undef)=
1.811 albertel 2606: ($entry=~m{___($match_domain)/($match_name)/(.*)___count$});
1.458 matthew 2607: if (! defined($dom) || $dom eq '' ||
2608: ! defined($name) || $name eq '') {
1.620 albertel 2609: my $cid = $env{'request.course.id'};
2610: $dom = $env{'request.'.$cid.'.domain'};
2611: $name = $env{'request.'.$cid.'.num'};
1.458 matthew 2612: }
1.450 matthew 2613: my $value = $accesshash{$entry};
2614: my (undef,$url,undef) = ($entry =~ /^(.*)___(.*)___count$/);
2615: my %temphash=($url => $value);
1.449 matthew 2616: my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
2617: if ($result eq 'ok') {
2618: delete $accesshash{$entry};
2619: } elsif ($result eq 'unknown_cmd') {
2620: # Target server has old code running on it.
1.450 matthew 2621: my %temphash=($entry => $value);
1.449 matthew 2622: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2623: delete $accesshash{$entry};
2624: }
2625: }
2626: } else {
1.811 albertel 2627: my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
1.450 matthew 2628: my %temphash=($entry => $accesshash{$entry});
1.449 matthew 2629: if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
2630: delete $accesshash{$entry};
2631: }
1.185 www 2632: }
1.191 harris41 2633: }
1.352 www 2634: #
2635: # Roles
2636: # Reverse lookup of user roles for course faculty/staff and co-authorship
2637: #
1.800 albertel 2638: foreach my $entry (keys(%userrolehash)) {
1.351 www 2639: my ($role,$uname,$udom,$runame,$rudom,$rsec)=
1.349 www 2640: split(/\:/,$entry);
2641: if (&Apache::lonnet::put('nohist_userroles',
1.351 www 2642: { $role.':'.$uname.':'.$udom.':'.$rsec => $userrolehash{$entry} },
1.349 www 2643: $rudom,$runame) eq 'ok') {
2644: delete $userrolehash{$entry};
2645: }
2646: }
1.662 raeburn 2647: #
2648: # Reverse lookup of domain roles (dc, ad, li, sc, au)
2649: #
2650: my %domrolebuffer = ();
1.1000 raeburn 2651: foreach my $entry (keys(%domainrolehash)) {
1.901 albertel 2652: my ($role,$uname,$udom,$runame,$rudom,$rsec)=split(/:/,$entry);
1.662 raeburn 2653: if ($domrolebuffer{$rudom}) {
2654: $domrolebuffer{$rudom}.='&'.&escape($entry).
2655: '='.&escape($domainrolehash{$entry});
2656: } else {
2657: $domrolebuffer{$rudom}.=&escape($entry).
2658: '='.&escape($domainrolehash{$entry});
2659: }
2660: delete $domainrolehash{$entry};
2661: }
2662: foreach my $dom (keys(%domrolebuffer)) {
1.841 albertel 2663: my %servers = &get_servers($dom,'library');
2664: foreach my $tryserver (keys(%servers)) {
2665: unless (&reply('domroleput:'.$dom.':'.
2666: $domrolebuffer{$dom},$tryserver) eq 'ok') {
2667: &logthis('Put of domain roles failed for '.$dom.' and '.$tryserver);
2668: }
1.662 raeburn 2669: }
2670: }
1.186 www 2671: $dumpcount++;
1.157 www 2672: }
2673:
2674: sub courselog {
2675: my $what=shift;
1.158 www 2676: $what=time.':'.$what;
1.620 albertel 2677: unless ($env{'request.course.id'}) { return ''; }
2678: $coursedombuf{$env{'request.course.id'}}=
2679: $env{'course.'.$env{'request.course.id'}.'.domain'};
2680: $coursenumbuf{$env{'request.course.id'}}=
2681: $env{'course.'.$env{'request.course.id'}.'.num'};
2682: $coursehombuf{$env{'request.course.id'}}=
2683: $env{'course.'.$env{'request.course.id'}.'.home'};
2684: $coursedescrbuf{$env{'request.course.id'}}=
2685: $env{'course.'.$env{'request.course.id'}.'.description'};
2686: $courseinstcodebuf{$env{'request.course.id'}}=
2687: $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
2688: $courseownerbuf{$env{'request.course.id'}}=
2689: $env{'course.'.$env{'request.course.id'}.'.internal.courseowner'};
1.741 raeburn 2690: $coursetypebuf{$env{'request.course.id'}}=
2691: $env{'course.'.$env{'request.course.id'}.'.type'};
1.620 albertel 2692: if (defined $courselogs{$env{'request.course.id'}}) {
2693: $courselogs{$env{'request.course.id'}}.='&'.$what;
1.157 www 2694: } else {
1.620 albertel 2695: $courselogs{$env{'request.course.id'}}.=$what;
1.157 www 2696: }
1.620 albertel 2697: if (length($courselogs{$env{'request.course.id'}})>4048) {
1.157 www 2698: &flushcourselogs();
2699: }
1.158 www 2700: }
2701:
2702: sub courseacclog {
2703: my $fnsymb=shift;
1.620 albertel 2704: unless ($env{'request.course.id'}) { return ''; }
2705: my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
1.657 albertel 2706: if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
1.187 www 2707: $what.=':POST';
1.583 matthew 2708: # FIXME: Probably ought to escape things....
1.800 albertel 2709: foreach my $key (keys(%env)) {
2710: if ($key=~/^form\.(.*)/) {
1.975 raeburn 2711: my $formitem = $1;
2712: if ($formitem =~ /^HWFILE(?:SIZE|TOOBIG)/) {
2713: $what.=':'.$formitem.'='.$env{$key};
2714: } elsif ($formitem !~ /^HWFILE(?:[^.]+)$/) {
2715: $what.=':'.$formitem.'='.$env{$key};
2716: }
1.158 www 2717: }
1.191 harris41 2718: }
1.583 matthew 2719: } elsif ($fnsymb =~ m:^/adm/searchcat:) {
2720: # FIXME: We should not be depending on a form parameter that someone
2721: # editing lonsearchcat.pm might change in the future.
1.620 albertel 2722: if ($env{'form.phase'} eq 'course_search') {
1.583 matthew 2723: $what.= ':POST';
2724: # FIXME: Probably ought to escape things....
2725: foreach my $element ('courseexp','crsfulltext','crsrelated',
2726: 'crsdiscuss') {
1.620 albertel 2727: $what.=':'.$element.'='.$env{'form.'.$element};
1.583 matthew 2728: }
2729: }
1.158 www 2730: }
2731: &courselog($what);
1.149 www 2732: }
2733:
1.185 www 2734: sub countacc {
2735: my $url=&declutter(shift);
1.458 matthew 2736: return if (! defined($url) || $url eq '');
1.620 albertel 2737: unless ($env{'request.course.id'}) { return ''; }
2738: $accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
1.281 www 2739: my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
1.450 matthew 2740: $accesshash{$key}++;
1.185 www 2741: }
1.349 www 2742:
1.361 www 2743: sub linklog {
2744: my ($from,$to)=@_;
2745: $from=&declutter($from);
2746: $to=&declutter($to);
2747: $accesshash{$from.'___'.$to.'___comefrom'}=1;
2748: $accesshash{$to.'___'.$from.'___goto'}=1;
2749: }
2750:
1.349 www 2751: sub userrolelog {
2752: my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
1.661 raeburn 2753: if (($trole=~/^ca/) || ($trole=~/^aa/) ||
1.662 raeburn 2754: ($trole=~/^in/) || ($trole=~/^cc/) ||
1.661 raeburn 2755: ($trole=~/^ep/) || ($trole=~/^cr/) ||
1.1041 raeburn 2756: ($trole=~/^ta/) || ($trole=~/^co/)) {
1.350 www 2757: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2758: $userrolehash
2759: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
1.349 www 2760: =$tend.':'.$tstart;
1.662 raeburn 2761: }
1.898 albertel 2762: if (($env{'request.role'} =~ /dc\./) &&
2763: (($trole=~/^au/) || ($trole=~/^in/) ||
2764: ($trole=~/^cc/) || ($trole=~/^ep/) ||
1.1041 raeburn 2765: ($trole=~/^cr/) || ($trole=~/^ta/) ||
2766: ($trole=~/^co/))) {
1.898 albertel 2767: $userrolehash
2768: {$trole.':'.$username.':'.$domain.':'.$env{'user.name'}.':'.$env{'user.domain'}.':'}
2769: =$tend.':'.$tstart;
2770: }
1.662 raeburn 2771: if (($trole=~/^dc/) || ($trole=~/^ad/) ||
2772: ($trole=~/^li/) || ($trole=~/^li/) ||
2773: ($trole=~/^au/) || ($trole=~/^dg/) ||
2774: ($trole=~/^sc/)) {
2775: my (undef,$rudom,$runame,$rsec)=split(/\//,$area);
2776: $domainrolehash
2777: {$trole.':'.$username.':'.$domain.':'.$runame.':'.$rudom.':'.$rsec}
2778: = $tend.':'.$tstart;
2779: }
1.351 www 2780: }
2781:
1.957 raeburn 2782: sub courserolelog {
2783: my ($trole,$username,$domain,$area,$tstart,$tend,$delflag,$selfenroll,$context)=@_;
2784: if (($trole eq 'cc') || ($trole eq 'in') ||
2785: ($trole eq 'ep') || ($trole eq 'ad') ||
2786: ($trole eq 'ta') || ($trole eq 'st') ||
1.1044 raeburn 2787: ($trole=~/^cr/) || ($trole eq 'gr') ||
2788: ($trole eq 'co')) {
1.957 raeburn 2789: if ($area =~ m-^/($match_domain)/($match_courseid)/?([^/]*)-) {
2790: my $cdom = $1;
2791: my $cnum = $2;
2792: my $sec = $3;
2793: my $namespace = 'rolelog';
2794: my %storehash = (
2795: role => $trole,
2796: start => $tstart,
2797: end => $tend,
2798: selfenroll => $selfenroll,
2799: context => $context,
2800: );
2801: if ($trole eq 'gr') {
2802: $namespace = 'groupslog';
2803: $storehash{'group'} = $sec;
2804: } else {
2805: $storehash{'section'} = $sec;
2806: }
2807: &instructor_log($namespace,\%storehash,$delflag,$username,$domain,$cnum,$cdom);
1.996 raeburn 2808: if (($trole ne 'st') || ($sec ne '')) {
2809: &devalidate_cache_new('getcourseroles',$cdom.'_'.$cnum);
2810: }
1.957 raeburn 2811: }
2812: }
2813: return;
2814: }
2815:
1.351 www 2816: sub get_course_adv_roles {
1.948 raeburn 2817: my ($cid,$codes) = @_;
1.620 albertel 2818: $cid=$env{'request.course.id'} unless (defined($cid));
1.351 www 2819: my %coursehash=&coursedescription($cid);
1.988 raeburn 2820: my $crstype = &Apache::loncommon::course_type($cid);
1.470 www 2821: my %nothide=();
1.800 albertel 2822: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
1.937 raeburn 2823: if ($user !~ /:/) {
2824: $nothide{join(':',split(/[\@]/,$user))}=1;
2825: } else {
2826: $nothide{$user}=1;
2827: }
1.470 www 2828: }
1.351 www 2829: my %returnhash=();
2830: my %dumphash=
2831: &dump('nohist_userroles',$coursehash{'domain'},$coursehash{'num'});
2832: my $now=time;
1.997 raeburn 2833: my %privileged;
1.1000 raeburn 2834: foreach my $entry (keys(%dumphash)) {
1.800 albertel 2835: my ($tend,$tstart)=split(/\:/,$dumphash{$entry});
1.351 www 2836: if (($tstart) && ($tstart<0)) { next; }
2837: if (($tend) && ($tend<$now)) { next; }
2838: if (($tstart) && ($now<$tstart)) { next; }
1.800 albertel 2839: my ($role,$username,$domain,$section)=split(/\:/,$entry);
1.576 albertel 2840: if ($username eq '' || $domain eq '') { next; }
1.997 raeburn 2841: unless (ref($privileged{$domain}) eq 'HASH') {
2842: my %dompersonnel =
1.998 raeburn 2843: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
1.997 raeburn 2844: $privileged{$domain} = {};
2845: foreach my $server (keys(%dompersonnel)) {
1.999 raeburn 2846: if (ref($dompersonnel{$server}) eq 'HASH') {
1.997 raeburn 2847: foreach my $user (keys(%{$dompersonnel{$server}})) {
2848: my ($trole,$uname,$udom) = split(/:/,$user);
2849: $privileged{$udom}{$uname} = 1;
2850: }
2851: }
2852: }
2853: }
2854: if ((exists($privileged{$domain}{$username})) &&
2855: (!$nothide{$username.':'.$domain})) { next; }
1.656 albertel 2856: if ($role eq 'cr') { next; }
1.948 raeburn 2857: if ($codes) {
2858: if ($section) { $role .= ':'.$section; }
2859: if ($returnhash{$role}) {
2860: $returnhash{$role}.=','.$username.':'.$domain;
2861: } else {
2862: $returnhash{$role}=$username.':'.$domain;
2863: }
1.351 www 2864: } else {
1.988 raeburn 2865: my $key=&plaintext($role,$crstype);
1.973 bisitz 2866: if ($section) { $key.=' ('.&Apache::lonlocal::mt('Section [_1]',$section).')'; }
1.948 raeburn 2867: if ($returnhash{$key}) {
2868: $returnhash{$key}.=','.$username.':'.$domain;
2869: } else {
2870: $returnhash{$key}=$username.':'.$domain;
2871: }
1.351 www 2872: }
1.948 raeburn 2873: }
1.400 www 2874: return %returnhash;
2875: }
2876:
2877: sub get_my_roles {
1.937 raeburn 2878: my ($uname,$udom,$context,$types,$roles,$roledoms,$withsec,$hidepriv)=@_;
1.620 albertel 2879: unless (defined($uname)) { $uname=$env{'user.name'}; }
2880: unless (defined($udom)) { $udom=$env{'user.domain'}; }
1.937 raeburn 2881: my (%dumphash,%nothide);
1.858 raeburn 2882: if ($context eq 'userroles') {
2883: %dumphash = &dump('roles',$udom,$uname);
2884: } else {
2885: %dumphash=
1.400 www 2886: &dump('nohist_userroles',$udom,$uname);
1.937 raeburn 2887: if ($hidepriv) {
2888: my %coursehash=&coursedescription($udom.'_'.$uname);
2889: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
2890: if ($user !~ /:/) {
2891: $nothide{join(':',split(/[\@]/,$user))} = 1;
2892: } else {
2893: $nothide{$user} = 1;
2894: }
2895: }
2896: }
1.858 raeburn 2897: }
1.400 www 2898: my %returnhash=();
2899: my $now=time;
1.999 raeburn 2900: my %privileged;
1.800 albertel 2901: foreach my $entry (keys(%dumphash)) {
1.867 raeburn 2902: my ($role,$tend,$tstart);
2903: if ($context eq 'userroles') {
2904: ($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
2905: } else {
2906: ($tend,$tstart)=split(/\:/,$dumphash{$entry});
2907: }
1.400 www 2908: if (($tstart) && ($tstart<0)) { next; }
1.832 raeburn 2909: my $status = 'active';
1.939 raeburn 2910: if (($tend) && ($tend<=$now)) {
1.832 raeburn 2911: $status = 'previous';
2912: }
2913: if (($tstart) && ($now<$tstart)) {
2914: $status = 'future';
2915: }
2916: if (ref($types) eq 'ARRAY') {
2917: if (!grep(/^\Q$status\E$/,@{$types})) {
2918: next;
2919: }
2920: } else {
2921: if ($status ne 'active') {
2922: next;
2923: }
2924: }
1.867 raeburn 2925: my ($rolecode,$username,$domain,$section,$area);
2926: if ($context eq 'userroles') {
2927: ($area,$rolecode) = split(/_/,$entry);
2928: (undef,$domain,$username,$section) = split(/\//,$area);
2929: } else {
2930: ($role,$username,$domain,$section) = split(/\:/,$entry);
2931: }
1.832 raeburn 2932: if (ref($roledoms) eq 'ARRAY') {
2933: if (!grep(/^\Q$domain\E$/,@{$roledoms})) {
2934: next;
2935: }
2936: }
2937: if (ref($roles) eq 'ARRAY') {
2938: if (!grep(/^\Q$role\E$/,@{$roles})) {
1.922 raeburn 2939: if ($role =~ /^cr\//) {
2940: if (!grep(/^cr$/,@{$roles})) {
2941: next;
2942: }
2943: } else {
2944: next;
2945: }
1.832 raeburn 2946: }
1.867 raeburn 2947: }
1.937 raeburn 2948: if ($hidepriv) {
1.999 raeburn 2949: if ($context eq 'userroles') {
2950: if ((&privileged($username,$domain)) &&
2951: (!$nothide{$username.':'.$domain})) {
2952: next;
2953: }
2954: } else {
2955: unless (ref($privileged{$domain}) eq 'HASH') {
2956: my %dompersonnel =
2957: &Apache::lonnet::get_domain_roles($domain,['dc'],$now,$now);
2958: $privileged{$domain} = {};
2959: if (keys(%dompersonnel)) {
2960: foreach my $server (keys(%dompersonnel)) {
2961: if (ref($dompersonnel{$server}) eq 'HASH') {
2962: foreach my $user (keys(%{$dompersonnel{$server}})) {
2963: my ($trole,$uname,$udom) = split(/:/,$user);
2964: $privileged{$udom}{$uname} = $trole;
2965: }
2966: }
2967: }
2968: }
2969: }
2970: if (exists($privileged{$domain}{$username})) {
2971: if (!$nothide{$username.':'.$domain}) {
2972: next;
2973: }
2974: }
1.937 raeburn 2975: }
2976: }
1.933 raeburn 2977: if ($withsec) {
2978: $returnhash{$username.':'.$domain.':'.$role.':'.$section} =
2979: $tstart.':'.$tend;
2980: } else {
2981: $returnhash{$username.':'.$domain.':'.$role}=$tstart.':'.$tend;
2982: }
1.832 raeburn 2983: }
1.373 www 2984: return %returnhash;
1.399 www 2985: }
2986:
2987: # ----------------------------------------------------- Frontpage Announcements
2988: #
2989: #
2990:
2991: sub postannounce {
2992: my ($server,$text)=@_;
1.844 albertel 2993: unless (&allowed('psa',&host_domain($server))) { return 'refused'; }
1.399 www 2994: unless ($text=~/\w/) { $text=''; }
2995: return &reply('setannounce:'.&escape($text),$server);
2996: }
2997:
2998: sub getannounce {
1.448 albertel 2999:
3000: if (open(my $fh,$perlvar{'lonDocRoot'}.'/announcement.txt')) {
1.399 www 3001: my $announcement='';
1.800 albertel 3002: while (my $line = <$fh>) { $announcement .= $line; }
1.448 albertel 3003: close($fh);
1.399 www 3004: if ($announcement=~/\w/) {
3005: return
3006: '<table bgcolor="#FF5555" cellpadding="5" cellspacing="3">'.
1.518 albertel 3007: '<tr><td bgcolor="#FFFFFF"><tt>'.$announcement.'</tt></td></tr></table>';
1.399 www 3008: } else {
3009: return '';
3010: }
3011: } else {
3012: return '';
3013: }
1.351 www 3014: }
1.353 www 3015:
3016: # ---------------------------------------------------------- Course ID routines
3017: # Deal with domain's nohist_courseid.db files
3018: #
3019:
3020: sub courseidput {
1.921 raeburn 3021: my ($domain,$storehash,$coursehome,$caller) = @_;
1.1054 raeburn 3022: return unless (ref($storehash) eq 'HASH');
1.921 raeburn 3023: my $outcome;
3024: if ($caller eq 'timeonly') {
3025: my $cids = '';
3026: foreach my $item (keys(%$storehash)) {
3027: $cids.=&escape($item).'&';
3028: }
3029: $cids=~s/\&$//;
3030: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$cids,
3031: $coursehome);
3032: } else {
3033: my $items = '';
3034: foreach my $item (keys(%$storehash)) {
3035: $items.= &escape($item).'='.
3036: &freeze_escape($$storehash{$item}).'&';
3037: }
3038: $items=~s/\&$//;
3039: $outcome = &reply('courseidputhash:'.$domain.':'.$caller.':'.$items,
3040: $coursehome);
1.918 raeburn 3041: }
3042: if ($outcome eq 'unknown_cmd') {
3043: my $what;
3044: foreach my $cid (keys(%$storehash)) {
3045: $what .= &escape($cid).'=';
1.921 raeburn 3046: foreach my $item ('description','inst_code','owner','type') {
1.936 raeburn 3047: $what .= &escape($storehash->{$cid}{$item}).':';
1.918 raeburn 3048: }
3049: $what =~ s/\:$/&/;
3050: }
3051: $what =~ s/\&$//;
3052: return &reply('courseidput:'.$domain.':'.$what,$coursehome);
3053: } else {
3054: return $outcome;
3055: }
1.353 www 3056: }
3057:
3058: sub courseiddump {
1.921 raeburn 3059: my ($domfilter,$descfilter,$sincefilter,$instcodefilter,$ownerfilter,
1.947 raeburn 3060: $coursefilter,$hostidflag,$hostidref,$typefilter,$regexp_ok,
1.1029 raeburn 3061: $selfenrollonly,$catfilter,$showhidden,$caller,$cloner,$cc_clone,
3062: $cloneonly,$createdbefore,$createdafter,$creationcontext)=@_;
1.918 raeburn 3063: my $as_hash = 1;
3064: my %returnhash;
3065: if (!$domfilter) { $domfilter=''; }
1.845 albertel 3066: my %libserv = &all_library();
3067: foreach my $tryserver (keys(%libserv)) {
3068: if ( ( $hostidflag == 1
3069: && grep(/^\Q$tryserver\E$/,@{$hostidref}) )
3070: || (!defined($hostidflag)) ) {
3071:
1.918 raeburn 3072: if (($domfilter eq '') ||
3073: (&host_domain($tryserver) eq $domfilter)) {
3074: my $rep =
3075: &reply('courseiddump:'.&host_domain($tryserver).':'.
3076: $sincefilter.':'.&escape($descfilter).':'.
3077: &escape($instcodefilter).':'.&escape($ownerfilter).
3078: ':'.&escape($coursefilter).':'.&escape($typefilter).
1.947 raeburn 3079: ':'.&escape($regexp_ok).':'.$as_hash.':'.
1.962 raeburn 3080: &escape($selfenrollonly).':'.&escape($catfilter).':'.
1.1008 raeburn 3081: $showhidden.':'.$caller.':'.&escape($cloner).':'.
1.1029 raeburn 3082: &escape($cc_clone).':'.$cloneonly.':'.
3083: &escape($createdbefore).':'.&escape($createdafter).':'.
3084: &escape($creationcontext),$tryserver);
1.918 raeburn 3085: my @pairs=split(/\&/,$rep);
3086: foreach my $item (@pairs) {
3087: my ($key,$value)=split(/\=/,$item,2);
3088: $key = &unescape($key);
3089: next if ($key =~ /^error: 2 /);
3090: my $result = &thaw_unescape($value);
3091: if (ref($result) eq 'HASH') {
3092: $returnhash{$key}=$result;
3093: } else {
1.921 raeburn 3094: my @responses = split(/:/,$value);
3095: my @items = ('description','inst_code','owner','type');
1.918 raeburn 3096: for (my $i=0; $i<@responses; $i++) {
1.921 raeburn 3097: $returnhash{$key}{$items[$i]} = &unescape($responses[$i]);
1.918 raeburn 3098: }
1.1008 raeburn 3099: }
1.353 www 3100: }
3101: }
3102: }
3103: }
3104: return %returnhash;
3105: }
3106:
1.1055 raeburn 3107: sub courselastaccess {
3108: my ($cdom,$cnum,$hostidref) = @_;
3109: my %returnhash;
3110: if ($cdom && $cnum) {
3111: my $chome = &homeserver($cnum,$cdom);
3112: if ($chome ne 'no_host') {
3113: my $rep = &reply('courselastaccess:'.$cdom.':'.$cnum,$chome);
3114: &extract_lastaccess(\%returnhash,$rep);
3115: }
3116: } else {
3117: if (!$cdom) { $cdom=''; }
3118: my %libserv = &all_library();
3119: foreach my $tryserver (keys(%libserv)) {
3120: if (ref($hostidref) eq 'ARRAY') {
3121: next unless (grep(/^\Q$tryserver\E$/,@{$hostidref}));
3122: }
3123: if (($cdom eq '') || (&host_domain($tryserver) eq $cdom)) {
3124: my $rep = &reply('courselastaccess:'.&host_domain($tryserver).':',$tryserver);
3125: &extract_lastaccess(\%returnhash,$rep);
3126: }
3127: }
3128: }
3129: return %returnhash;
3130: }
3131:
3132: sub extract_lastaccess {
3133: my ($returnhash,$rep) = @_;
3134: if (ref($returnhash) eq 'HASH') {
3135: unless ($rep eq 'unknown_command' || $rep eq 'no_such_host' ||
3136: $rep eq 'con_lost' || $rep eq 'rejected' || $rep eq 'refused' ||
3137: $rep eq '') {
3138: my @pairs=split(/\&/,$rep);
3139: foreach my $item (@pairs) {
3140: my ($key,$value)=split(/\=/,$item,2);
3141: $key = &unescape($key);
3142: next if ($key =~ /^error: 2 /);
3143: $returnhash->{$key} = &thaw_unescape($value);
3144: }
3145: }
3146: }
3147: return;
3148: }
3149:
1.658 raeburn 3150: # ---------------------------------------------------------- DC e-mail
1.662 raeburn 3151:
3152: sub dcmailput {
1.685 raeburn 3153: my ($domain,$msgid,$message,$server)=@_;
1.662 raeburn 3154: my $status = &Apache::lonnet::critical(
1.740 www 3155: 'dcmailput:'.$domain.':'.&escape($msgid).'='.
3156: &escape($message),$server);
1.662 raeburn 3157: return $status;
3158: }
3159:
1.658 raeburn 3160: sub dcmaildump {
3161: my ($dom,$startdate,$enddate,$senders) = @_;
1.685 raeburn 3162: my %returnhash=();
1.846 albertel 3163:
3164: if (defined(&domain($dom,'primary'))) {
1.685 raeburn 3165: my $cmd='dcmaildump:'.$dom.':'.&escape($startdate).':'.
3166: &escape($enddate).':';
3167: my @esc_senders=map { &escape($_)} @$senders;
3168: $cmd.=&escape(join('&',@esc_senders));
1.846 albertel 3169: foreach my $line (split(/\&/,&reply($cmd,&domain($dom,'primary')))) {
1.800 albertel 3170: my ($key,$value) = split(/\=/,$line,2);
1.685 raeburn 3171: if (($key) && ($value)) {
3172: $returnhash{&unescape($key)} = &unescape($value);
1.658 raeburn 3173: }
3174: }
3175: }
3176: return %returnhash;
3177: }
1.662 raeburn 3178: # ---------------------------------------------------------- Domain roles
3179:
3180: sub get_domain_roles {
3181: my ($dom,$roles,$startdate,$enddate)=@_;
1.1018 raeburn 3182: if ((!defined($startdate)) || ($startdate eq '')) {
1.662 raeburn 3183: $startdate = '.';
3184: }
1.1018 raeburn 3185: if ((!defined($enddate)) || ($enddate eq '')) {
1.662 raeburn 3186: $enddate = '.';
3187: }
1.922 raeburn 3188: my $rolelist;
3189: if (ref($roles) eq 'ARRAY') {
3190: $rolelist = join(':',@{$roles});
3191: }
1.662 raeburn 3192: my %personnel = ();
1.841 albertel 3193:
3194: my %servers = &get_servers($dom,'library');
3195: foreach my $tryserver (keys(%servers)) {
3196: %{$personnel{$tryserver}}=();
3197: foreach my $line (split(/\&/,&reply('domrolesdump:'.$dom.':'.
3198: &escape($startdate).':'.
3199: &escape($enddate).':'.
3200: &escape($rolelist), $tryserver))) {
3201: my ($key,$value) = split(/\=/,$line,2);
3202: if (($key) && ($value)) {
3203: $personnel{$tryserver}{&unescape($key)} = &unescape($value);
3204: }
3205: }
1.662 raeburn 3206: }
3207: return %personnel;
3208: }
1.658 raeburn 3209:
1.149 www 3210: # ----------------------------------------------------------- Check out an item
3211:
1.504 albertel 3212: sub get_first_access {
3213: my ($type,$argsymb)=@_;
1.790 albertel 3214: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3215: if ($argsymb) { $symb=$argsymb; }
3216: my ($map,$id,$res)=&decode_symb($symb);
1.926 albertel 3217: if ($type eq 'course') {
3218: $res='course';
3219: } elsif ($type eq 'map') {
1.588 albertel 3220: $res=&symbread($map);
3221: } else {
3222: $res=$symb;
3223: }
3224: my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
3225: return $times{"$courseid\0$res"};
1.504 albertel 3226: }
3227:
3228: sub set_first_access {
3229: my ($type)=@_;
1.790 albertel 3230: my ($symb,$courseid,$udom,$uname)=&whichuser();
1.504 albertel 3231: my ($map,$id,$res)=&decode_symb($symb);
1.928 albertel 3232: if ($type eq 'course') {
3233: $res='course';
3234: } elsif ($type eq 'map') {
1.588 albertel 3235: $res=&symbread($map);
3236: } else {
3237: $res=$symb;
3238: }
3239: my $firstaccess=&get_first_access($type,$symb);
1.505 albertel 3240: if (!$firstaccess) {
1.588 albertel 3241: return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
1.505 albertel 3242: }
3243: return 'already_set';
1.504 albertel 3244: }
3245:
1.149 www 3246: sub checkout {
3247: my ($symb,$tuname,$tudom,$tcrsid)=@_;
3248: my $now=time;
3249: my $lonhost=$perlvar{'lonHostID'};
3250: my $infostr=&escape(
1.234 www 3251: 'CHECKOUTTOKEN&'.
1.149 www 3252: $tuname.'&'.
3253: $tudom.'&'.
3254: $tcrsid.'&'.
3255: $symb.'&'.
3256: $now.'&'.$ENV{'REMOTE_ADDR'});
3257: my $token=&reply('tmpput:'.$infostr,$lonhost);
1.151 www 3258: if ($token=~/^error\:/) {
1.672 albertel 3259: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3260: "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
3261: "</font>");
3262: return '';
3263: }
3264:
1.149 www 3265: $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
3266: $token=~tr/a-z/A-Z/;
3267:
1.153 www 3268: my %infohash=('resource.0.outtoken' => $token,
3269: 'resource.0.checkouttime' => $now,
3270: 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
1.149 www 3271:
3272: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3273: return '';
1.151 www 3274: } else {
1.672 albertel 3275: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3276: "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
3277: "</font>");
1.149 www 3278: }
3279:
3280: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3281: &escape('Checkout '.$infostr.' - '.
3282: $token)) ne 'ok') {
3283: return '';
1.151 www 3284: } else {
1.672 albertel 3285: &logthis("<font color=\"blue\">WARNING: ".
1.151 www 3286: "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
3287: "</font>");
1.149 www 3288: }
1.151 www 3289: return $token;
1.149 www 3290: }
3291:
3292: # ------------------------------------------------------------ Check in an item
3293:
3294: sub checkin {
3295: my $token=shift;
1.150 www 3296: my $now=time;
3297: my ($ta,$tb,$lonhost)=split(/\*/,$token);
3298: $lonhost=~tr/A-Z/a-z/;
1.838 albertel 3299: my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
1.150 www 3300: $dtoken=~s/\W/\_/g;
1.234 www 3301: my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
1.150 www 3302: split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
3303:
1.154 www 3304: unless (($tuname) && ($tudom)) {
3305: &logthis('Check in '.$token.' ('.$dtoken.') failed');
3306: return '';
3307: }
3308:
3309: unless (&allowed('mgr',$tcrsid)) {
3310: &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
1.620 albertel 3311: $env{'user.name'}.' - '.$env{'user.domain'});
1.154 www 3312: return '';
3313: }
3314:
1.153 www 3315: my %infohash=('resource.0.intoken' => $token,
3316: 'resource.0.checkintime' => $now,
3317: 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
1.150 www 3318:
3319: unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
3320: return '';
3321: }
3322:
3323: if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
3324: &escape('Checkin - '.$token)) ne 'ok') {
3325: return '';
3326: }
3327:
3328: return ($symb,$tuname,$tudom,$tcrsid);
1.110 www 3329: }
3330:
3331: # --------------------------------------------- Set Expire Date for Spreadsheet
3332:
3333: sub expirespread {
3334: my ($uname,$udom,$stype,$usymb)=@_;
1.620 albertel 3335: my $cid=$env{'request.course.id'};
1.110 www 3336: if ($cid) {
3337: my $now=time;
3338: my $key=$uname.':'.$udom.':'.$stype.':'.$usymb;
1.620 albertel 3339: return &reply('put:'.$env{'course.'.$cid.'.domain'}.':'.
3340: $env{'course.'.$cid.'.num'}.
1.110 www 3341: ':nohist_expirationdates:'.
3342: &escape($key).'='.$now,
1.620 albertel 3343: $env{'course.'.$cid.'.home'})
1.110 www 3344: }
3345: return 'ok';
1.14 www 3346: }
3347:
1.109 www 3348: # ----------------------------------------------------- Devalidate Spreadsheets
3349:
3350: sub devalidate {
1.325 www 3351: my ($symb,$uname,$udom)=@_;
1.620 albertel 3352: my $cid=$env{'request.course.id'};
1.109 www 3353: if ($cid) {
1.391 matthew 3354: # delete the stored spreadsheets for
3355: # - the student level sheet of this user in course's homespace
3356: # - the assessment level sheet for this resource
3357: # for this user in user's homespace
1.553 albertel 3358: # - current conditional state info
1.325 www 3359: my $key=$uname.':'.$udom.':';
1.109 www 3360: my $status=
1.299 matthew 3361: &del('nohist_calculatedsheets',
1.391 matthew 3362: [$key.'studentcalc:'],
1.620 albertel 3363: $env{'course.'.$cid.'.domain'},
3364: $env{'course.'.$cid.'.num'})
1.133 albertel 3365: .' '.
3366: &del('nohist_calculatedsheets_'.$cid,
1.391 matthew 3367: [$key.'assesscalc:'.$symb],$udom,$uname);
1.109 www 3368: unless ($status eq 'ok ok') {
3369: &logthis('Could not devalidate spreadsheet '.
1.325 www 3370: $uname.' at '.$udom.' for '.
1.109 www 3371: $symb.': '.$status);
1.133 albertel 3372: }
1.553 albertel 3373: &delenv('user.state.'.$cid);
1.109 www 3374: }
3375: }
3376:
1.265 albertel 3377: sub get_scalar {
3378: my ($string,$end) = @_;
3379: my $value;
3380: if ($$string =~ s/^([^&]*?)($end)/$2/) {
3381: $value = $1;
3382: } elsif ($$string =~ s/^([^&]*?)&//) {
3383: $value = $1;
3384: }
3385: return &unescape($value);
3386: }
3387:
3388: sub array2str {
3389: my (@array) = @_;
3390: my $result=&arrayref2str(\@array);
3391: $result=~s/^__ARRAY_REF__//;
3392: $result=~s/__END_ARRAY_REF__$//;
3393: return $result;
3394: }
3395:
1.204 albertel 3396: sub arrayref2str {
3397: my ($arrayref) = @_;
1.265 albertel 3398: my $result='__ARRAY_REF__';
1.204 albertel 3399: foreach my $elem (@$arrayref) {
1.265 albertel 3400: if(ref($elem) eq 'ARRAY') {
3401: $result.=&arrayref2str($elem).'&';
3402: } elsif(ref($elem) eq 'HASH') {
3403: $result.=&hashref2str($elem).'&';
3404: } elsif(ref($elem)) {
3405: #print("Got a ref of ".(ref($elem))." skipping.");
1.204 albertel 3406: } else {
3407: $result.=&escape($elem).'&';
3408: }
3409: }
3410: $result=~s/\&$//;
1.265 albertel 3411: $result .= '__END_ARRAY_REF__';
1.204 albertel 3412: return $result;
3413: }
3414:
1.168 albertel 3415: sub hash2str {
1.204 albertel 3416: my (%hash) = @_;
3417: my $result=&hashref2str(\%hash);
1.265 albertel 3418: $result=~s/^__HASH_REF__//;
3419: $result=~s/__END_HASH_REF__$//;
1.204 albertel 3420: return $result;
3421: }
3422:
3423: sub hashref2str {
3424: my ($hashref)=@_;
1.265 albertel 3425: my $result='__HASH_REF__';
1.800 albertel 3426: foreach my $key (sort(keys(%$hashref))) {
3427: if (ref($key) eq 'ARRAY') {
3428: $result.=&arrayref2str($key).'=';
3429: } elsif (ref($key) eq 'HASH') {
3430: $result.=&hashref2str($key).'=';
3431: } elsif (ref($key)) {
1.265 albertel 3432: $result.='=';
1.800 albertel 3433: #print("Got a ref of ".(ref($key))." skipping.");
1.204 albertel 3434: } else {
1.800 albertel 3435: if ($key) {$result.=&escape($key).'=';} else { last; }
1.204 albertel 3436: }
3437:
1.800 albertel 3438: if(ref($hashref->{$key}) eq 'ARRAY') {
3439: $result.=&arrayref2str($hashref->{$key}).'&';
3440: } elsif(ref($hashref->{$key}) eq 'HASH') {
3441: $result.=&hashref2str($hashref->{$key}).'&';
3442: } elsif(ref($hashref->{$key})) {
1.265 albertel 3443: $result.='&';
1.800 albertel 3444: #print("Got a ref of ".(ref($hashref->{$key}))." skipping.");
1.204 albertel 3445: } else {
1.800 albertel 3446: $result.=&escape($hashref->{$key}).'&';
1.204 albertel 3447: }
3448: }
1.168 albertel 3449: $result=~s/\&$//;
1.265 albertel 3450: $result .= '__END_HASH_REF__';
1.168 albertel 3451: return $result;
3452: }
3453:
3454: sub str2hash {
1.265 albertel 3455: my ($string)=@_;
3456: my ($hash)=&str2hashref('__HASH_REF__'.$string.'__END_HASH_REF__');
3457: return %$hash;
3458: }
3459:
3460: sub str2hashref {
1.168 albertel 3461: my ($string) = @_;
1.265 albertel 3462:
3463: my %hash;
3464:
3465: if($string !~ /^__HASH_REF__/) {
3466: if (! ($string eq '' || !defined($string))) {
3467: $hash{'error'}='Not hash reference';
3468: }
3469: return (\%hash, $string);
3470: }
3471:
3472: $string =~ s/^__HASH_REF__//;
3473:
3474: while($string !~ /^__END_HASH_REF__/) {
3475: #key
3476: my $key='';
3477: if($string =~ /^__HASH_REF__/) {
3478: ($key, $string)=&str2hashref($string);
3479: if(defined($key->{'error'})) {
3480: $hash{'error'}='Bad data';
3481: return (\%hash, $string);
3482: }
3483: } elsif($string =~ /^__ARRAY_REF__/) {
3484: ($key, $string)=&str2arrayref($string);
3485: if($key->[0] eq 'Array reference error') {
3486: $hash{'error'}='Bad data';
3487: return (\%hash, $string);
3488: }
3489: } else {
3490: $string =~ s/^(.*?)=//;
1.267 albertel 3491: $key=&unescape($1);
1.265 albertel 3492: }
3493: $string =~ s/^=//;
3494:
3495: #value
3496: my $value='';
3497: if($string =~ /^__HASH_REF__/) {
3498: ($value, $string)=&str2hashref($string);
3499: if(defined($value->{'error'})) {
3500: $hash{'error'}='Bad data';
3501: return (\%hash, $string);
3502: }
3503: } elsif($string =~ /^__ARRAY_REF__/) {
3504: ($value, $string)=&str2arrayref($string);
3505: if($value->[0] eq 'Array reference error') {
3506: $hash{'error'}='Bad data';
3507: return (\%hash, $string);
3508: }
3509: } else {
3510: $value=&get_scalar(\$string,'__END_HASH_REF__');
3511: }
3512: $string =~ s/^&//;
3513:
3514: $hash{$key}=$value;
1.204 albertel 3515: }
1.265 albertel 3516:
3517: $string =~ s/^__END_HASH_REF__//;
3518:
3519: return (\%hash, $string);
1.204 albertel 3520: }
3521:
3522: sub str2array {
1.265 albertel 3523: my ($string)=@_;
3524: my ($array)=&str2arrayref('__ARRAY_REF__'.$string.'__END_ARRAY_REF__');
3525: return @$array;
3526: }
3527:
3528: sub str2arrayref {
1.204 albertel 3529: my ($string) = @_;
1.265 albertel 3530: my @array;
3531:
3532: if($string !~ /^__ARRAY_REF__/) {
3533: if (! ($string eq '' || !defined($string))) {
3534: $array[0]='Array reference error';
3535: }
3536: return (\@array, $string);
3537: }
3538:
3539: $string =~ s/^__ARRAY_REF__//;
3540:
3541: while($string !~ /^__END_ARRAY_REF__/) {
3542: my $value='';
3543: if($string =~ /^__HASH_REF__/) {
3544: ($value, $string)=&str2hashref($string);
3545: if(defined($value->{'error'})) {
3546: $array[0] ='Array reference error';
3547: return (\@array, $string);
3548: }
3549: } elsif($string =~ /^__ARRAY_REF__/) {
3550: ($value, $string)=&str2arrayref($string);
3551: if($value->[0] eq 'Array reference error') {
3552: $array[0] ='Array reference error';
3553: return (\@array, $string);
3554: }
3555: } else {
3556: $value=&get_scalar(\$string,'__END_ARRAY_REF__');
3557: }
3558: $string =~ s/^&//;
3559:
3560: push(@array, $value);
1.191 harris41 3561: }
1.265 albertel 3562:
3563: $string =~ s/^__END_ARRAY_REF__//;
3564:
3565: return (\@array, $string);
1.168 albertel 3566: }
3567:
1.167 albertel 3568: # -------------------------------------------------------------------Temp Store
3569:
1.168 albertel 3570: sub tmpreset {
3571: my ($symb,$namespace,$domain,$stuname) = @_;
3572: if (!$symb) {
3573: $symb=&symbread();
1.620 albertel 3574: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3575: }
3576: $symb=escape($symb);
3577:
1.620 albertel 3578: if (!$namespace) { $namespace=$env{'request.state'}; }
1.168 albertel 3579: $namespace=~s/\//\_/g;
3580: $namespace=~s/\W//g;
3581:
1.620 albertel 3582: if (!$domain) { $domain=$env{'user.domain'}; }
3583: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3584: if ($domain eq 'public' && $stuname eq 'public') {
3585: $stuname=$ENV{'REMOTE_ADDR'};
3586: }
1.168 albertel 3587: my $path=$perlvar{'lonDaemons'}.'/tmp';
3588: my %hash;
3589: if (tie(%hash,'GDBM_File',
3590: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3591: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 3592: foreach my $key (keys(%hash)) {
1.180 albertel 3593: if ($key=~ /:$symb/) {
1.168 albertel 3594: delete($hash{$key});
3595: }
3596: }
3597: }
3598: }
3599:
1.167 albertel 3600: sub tmpstore {
1.168 albertel 3601: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3602:
3603: if (!$symb) {
3604: $symb=&symbread();
1.620 albertel 3605: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3606: }
3607: $symb=escape($symb);
3608:
3609: if (!$namespace) {
3610: # I don't think we would ever want to store this for a course.
3611: # it seems this will only be used if we don't have a course.
1.620 albertel 3612: #$namespace=$env{'request.course.id'};
1.168 albertel 3613: #if (!$namespace) {
1.620 albertel 3614: $namespace=$env{'request.state'};
1.168 albertel 3615: #}
3616: }
3617: $namespace=~s/\//\_/g;
3618: $namespace=~s/\W//g;
1.620 albertel 3619: if (!$domain) { $domain=$env{'user.domain'}; }
3620: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3621: if ($domain eq 'public' && $stuname eq 'public') {
3622: $stuname=$ENV{'REMOTE_ADDR'};
3623: }
1.168 albertel 3624: my $now=time;
3625: my %hash;
3626: my $path=$perlvar{'lonDaemons'}.'/tmp';
3627: if (tie(%hash,'GDBM_File',
3628: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3629: &GDBM_WRCREAT(),0640)) {
1.168 albertel 3630: $hash{"version:$symb"}++;
3631: my $version=$hash{"version:$symb"};
3632: my $allkeys='';
3633: foreach my $key (keys(%$storehash)) {
3634: $allkeys.=$key.':';
1.591 albertel 3635: $hash{"$version:$symb:$key"}=&freeze_escape($$storehash{$key});
1.168 albertel 3636: }
3637: $hash{"$version:$symb:timestamp"}=$now;
3638: $allkeys.='timestamp';
3639: $hash{"$version:keys:$symb"}=$allkeys;
3640: if (untie(%hash)) {
3641: return 'ok';
3642: } else {
3643: return "error:$!";
3644: }
3645: } else {
3646: return "error:$!";
3647: }
3648: }
1.167 albertel 3649:
1.168 albertel 3650: # -----------------------------------------------------------------Temp Restore
1.167 albertel 3651:
1.168 albertel 3652: sub tmprestore {
3653: my ($symb,$namespace,$domain,$stuname) = @_;
1.167 albertel 3654:
1.168 albertel 3655: if (!$symb) {
3656: $symb=&symbread();
1.620 albertel 3657: if (!$symb) { $symb= $env{'request.url'}; }
1.168 albertel 3658: }
3659: $symb=escape($symb);
3660:
1.620 albertel 3661: if (!$namespace) { $namespace=$env{'request.state'}; }
1.591 albertel 3662:
1.620 albertel 3663: if (!$domain) { $domain=$env{'user.domain'}; }
3664: if (!$stuname) { $stuname=$env{'user.name'}; }
1.591 albertel 3665: if ($domain eq 'public' && $stuname eq 'public') {
3666: $stuname=$ENV{'REMOTE_ADDR'};
3667: }
1.168 albertel 3668: my %returnhash;
3669: $namespace=~s/\//\_/g;
3670: $namespace=~s/\W//g;
3671: my %hash;
3672: my $path=$perlvar{'lonDaemons'}.'/tmp';
3673: if (tie(%hash,'GDBM_File',
3674: $path.'/tmpstore_'.$stuname.'_'.$domain.'_'.$namespace.'.db',
1.256 albertel 3675: &GDBM_READER(),0640)) {
1.168 albertel 3676: my $version=$hash{"version:$symb"};
3677: $returnhash{'version'}=$version;
3678: my $scope;
3679: for ($scope=1;$scope<=$version;$scope++) {
3680: my $vkeys=$hash{"$scope:keys:$symb"};
3681: my @keys=split(/:/,$vkeys);
3682: my $key;
3683: $returnhash{"$scope:keys"}=$vkeys;
3684: foreach $key (@keys) {
1.591 albertel 3685: $returnhash{"$scope:$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
3686: $returnhash{"$key"}=&thaw_unescape($hash{"$scope:$symb:$key"});
1.167 albertel 3687: }
3688: }
1.168 albertel 3689: if (!(untie(%hash))) {
3690: return "error:$!";
3691: }
3692: } else {
3693: return "error:$!";
3694: }
3695: return %returnhash;
1.167 albertel 3696: }
3697:
1.9 www 3698: # ----------------------------------------------------------------------- Store
3699:
3700: sub store {
1.124 www 3701: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3702: my $home='';
3703:
1.168 albertel 3704: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3705:
1.213 www 3706: $symb=&symbclean($symb);
1.122 albertel 3707: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3708:
1.620 albertel 3709: if (!$domain) { $domain=$env{'user.domain'}; }
3710: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3711:
3712: &devalidate($symb,$stuname,$domain);
1.109 www 3713:
3714: $symb=escape($symb);
1.187 www 3715: if (!$namespace) {
1.620 albertel 3716: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3717: return '';
3718: }
3719: }
1.620 albertel 3720: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3721:
3722: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3723: $$storehash{'host'}=$perlvar{'lonHostID'};
3724:
1.12 www 3725: my $namevalue='';
1.800 albertel 3726: foreach my $key (keys(%$storehash)) {
3727: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3728: }
1.12 www 3729: $namevalue=~s/\&$//;
1.187 www 3730: &courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
1.124 www 3731: return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.9 www 3732: }
3733:
1.47 www 3734: # -------------------------------------------------------------- Critical Store
3735:
3736: sub cstore {
1.124 www 3737: my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
3738: my $home='';
3739:
1.168 albertel 3740: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3741:
1.213 www 3742: $symb=&symbclean($symb);
1.122 albertel 3743: if (!$symb) { unless ($symb=&symbread()) { return ''; } }
1.109 www 3744:
1.620 albertel 3745: if (!$domain) { $domain=$env{'user.domain'}; }
3746: if (!$stuname) { $stuname=$env{'user.name'}; }
1.325 www 3747:
3748: &devalidate($symb,$stuname,$domain);
1.109 www 3749:
3750: $symb=escape($symb);
1.187 www 3751: if (!$namespace) {
1.620 albertel 3752: unless ($namespace=$env{'request.course.id'}) {
1.187 www 3753: return '';
3754: }
3755: }
1.620 albertel 3756: if (!$home) { $home=$env{'user.home'}; }
1.447 www 3757:
3758: $$storehash{'ip'}=$ENV{'REMOTE_ADDR'};
3759: $$storehash{'host'}=$perlvar{'lonHostID'};
1.122 albertel 3760:
1.47 www 3761: my $namevalue='';
1.800 albertel 3762: foreach my $key (keys(%$storehash)) {
3763: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
1.191 harris41 3764: }
1.47 www 3765: $namevalue=~s/\&$//;
1.187 www 3766: &courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
1.188 www 3767: return critical
3768: ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
1.47 www 3769: }
3770:
1.9 www 3771: # --------------------------------------------------------------------- Restore
3772:
3773: sub restore {
1.124 www 3774: my ($symb,$namespace,$domain,$stuname) = @_;
3775: my $home='';
3776:
1.168 albertel 3777: if ($stuname) { $home=&homeserver($stuname,$domain); }
1.124 www 3778:
1.122 albertel 3779: if (!$symb) {
3780: unless ($symb=escape(&symbread())) { return ''; }
3781: } else {
1.213 www 3782: $symb=&escape(&symbclean($symb));
1.122 albertel 3783: }
1.188 www 3784: if (!$namespace) {
1.620 albertel 3785: unless ($namespace=$env{'request.course.id'}) {
1.188 www 3786: return '';
3787: }
3788: }
1.620 albertel 3789: if (!$domain) { $domain=$env{'user.domain'}; }
3790: if (!$stuname) { $stuname=$env{'user.name'}; }
3791: if (!$home) { $home=$env{'user.home'}; }
1.122 albertel 3792: my $answer=&reply("restore:$domain:$stuname:$namespace:$symb","$home");
3793:
1.12 www 3794: my %returnhash=();
1.800 albertel 3795: foreach my $line (split(/\&/,$answer)) {
3796: my ($name,$value)=split(/\=/,$line);
1.591 albertel 3797: $returnhash{&unescape($name)}=&thaw_unescape($value);
1.191 harris41 3798: }
1.75 www 3799: my $version;
3800: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.800 albertel 3801: foreach my $item (split(/\:/,$returnhash{$version.':keys'})) {
3802: $returnhash{$item}=$returnhash{$version.':'.$item};
1.191 harris41 3803: }
1.75 www 3804: }
1.13 www 3805: return %returnhash;
1.34 www 3806: }
3807:
3808: # ---------------------------------------------------------- Course Description
3809:
3810: sub coursedescription {
1.731 albertel 3811: my ($courseid,$args)=@_;
1.34 www 3812: $courseid=~s/^\///;
1.49 www 3813: $courseid=~s/\_/\//g;
1.34 www 3814: my ($cdomain,$cnum)=split(/\//,$courseid);
1.129 albertel 3815: my $chome=&homeserver($cnum,$cdomain);
1.302 albertel 3816: my $normalid=$cdomain.'_'.$cnum;
3817: # need to always cache even if we get errors otherwise we keep
3818: # trying and trying and trying to get the course description.
3819: my %envhash=();
3820: my %returnhash=();
1.731 albertel 3821:
3822: my $expiretime=600;
3823: if ($env{'request.course.id'} eq $normalid) {
3824: $expiretime=120;
3825: }
3826:
3827: my $prefix='course.'.$cdomain.'_'.$cnum.'.';
3828: if (!$args->{'freshen_cache'}
3829: && ((time-$env{$prefix.'last_cache'}) < $expiretime) ) {
3830: foreach my $key (keys(%env)) {
3831: next if ($key !~ /^\Q$prefix\E(.*)/);
3832: my ($setting) = $1;
3833: $returnhash{$setting} = $env{$key};
3834: }
3835: return %returnhash;
3836: }
3837:
3838: # get the data agin
3839: if (!$args->{'one_time'}) {
3840: $envhash{'course.'.$normalid.'.last_cache'}=time;
3841: }
1.811 albertel 3842:
1.34 www 3843: if ($chome ne 'no_host') {
1.302 albertel 3844: %returnhash=&dump('environment',$cdomain,$cnum);
1.129 albertel 3845: if (!exists($returnhash{'con_lost'})) {
3846: $returnhash{'home'}= $chome;
3847: $returnhash{'domain'} = $cdomain;
3848: $returnhash{'num'} = $cnum;
1.741 raeburn 3849: if (!defined($returnhash{'type'})) {
3850: $returnhash{'type'} = 'Course';
3851: }
1.130 albertel 3852: while (my ($name,$value) = each %returnhash) {
1.53 www 3853: $envhash{'course.'.$normalid.'.'.$name}=$value;
1.129 albertel 3854: }
1.270 www 3855: $returnhash{'url'}=&clutter($returnhash{'url'});
1.34 www 3856: $returnhash{'fn'}=$perlvar{'lonDaemons'}.'/tmp/'.
1.620 albertel 3857: $env{'user.name'}.'_'.$cdomain.'_'.$cnum;
1.60 www 3858: $envhash{'course.'.$normalid.'.home'}=$chome;
3859: $envhash{'course.'.$normalid.'.domain'}=$cdomain;
3860: $envhash{'course.'.$normalid.'.num'}=$cnum;
1.34 www 3861: }
3862: }
1.731 albertel 3863: if (!$args->{'one_time'}) {
1.949 raeburn 3864: &appenv(\%envhash);
1.731 albertel 3865: }
1.302 albertel 3866: return %returnhash;
1.461 www 3867: }
3868:
3869: # -------------------------------------------------See if a user is privileged
3870:
3871: sub privileged {
3872: my ($username,$domain)=@_;
3873: my $rolesdump=&reply("dump:$domain:$username:roles",
3874: &homeserver($username,$domain));
1.1033 raeburn 3875: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3876: ($rolesdump =~ /^error:/)) {
3877: return 0;
3878: }
1.461 www 3879: my $now=time;
3880: if ($rolesdump ne '') {
1.800 albertel 3881: foreach my $entry (split(/&/,$rolesdump)) {
3882: if ($entry!~/^rolesdef_/) {
3883: my ($area,$role)=split(/=/,$entry);
1.461 www 3884: $area=~s/\_\w\w$//;
3885: my ($trole,$tend,$tstart)=split(/_/,$role);
3886: if (($trole eq 'dc') || ($trole eq 'su')) {
3887: my $active=1;
3888: if ($tend) {
3889: if ($tend<$now) { $active=0; }
3890: }
3891: if ($tstart) {
3892: if ($tstart>$now) { $active=0; }
3893: }
3894: if ($active) { return 1; }
3895: }
3896: }
3897: }
3898: }
3899: return 0;
1.9 www 3900: }
1.1 albertel 3901:
1.103 harris41 3902: # -------------------------------------------------------- Get user privileges
1.11 www 3903:
3904: sub rolesinit {
3905: my ($domain,$username,$authhost)=@_;
1.1034 raeburn 3906: my $now=time;
3907: my %userroles = ('user.login.time' => $now);
1.11 www 3908: my $rolesdump=reply("dump:$domain:$username:roles",$authhost);
1.1033 raeburn 3909: if (($rolesdump eq 'con_lost') || ($rolesdump eq '') ||
3910: ($rolesdump =~ /^error:/)) {
3911: return \%userroles;
3912: }
1.11 www 3913: my %allroles=();
1.678 raeburn 3914: my %allgroups=();
3915: my $group_privs;
1.11 www 3916:
3917: if ($rolesdump ne '') {
1.800 albertel 3918: foreach my $entry (split(/&/,$rolesdump)) {
3919: if ($entry!~/^rolesdef_/) {
3920: my ($area,$role)=split(/=/,$entry);
1.587 albertel 3921: $area=~s/\_\w\w$//;
1.678 raeburn 3922: my ($trole,$tend,$tstart,$group_privs);
1.587 albertel 3923: if ($role=~/^cr/) {
1.807 albertel 3924: if ($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|) {
3925: ($trole,my $trest)=($role=~m|^(cr/$match_domain/$match_username/[a-zA-Z0-9]+)_(.*)$|);
1.655 albertel 3926: ($tend,$tstart)=split('_',$trest);
3927: } else {
3928: $trole=$role;
3929: }
1.678 raeburn 3930: } elsif ($role =~ m|^gr/|) {
3931: ($trole,$tend,$tstart) = split(/_/,$role);
3932: ($trole,$group_privs) = split(/\//,$trole);
3933: $group_privs = &unescape($group_privs);
1.587 albertel 3934: } else {
3935: ($trole,$tend,$tstart)=split(/_/,$role);
3936: }
1.743 albertel 3937: my %new_role = &set_arearole($trole,$area,$tstart,$tend,$domain,
3938: $username);
3939: @userroles{keys(%new_role)} = @new_role{keys(%new_role)};
1.567 raeburn 3940: if (($tend!=0) && ($tend<$now)) { $trole=''; }
3941: if (($tstart!=0) && ($tstart>$now)) { $trole=''; }
1.11 www 3942: if (($area ne '') && ($trole ne '')) {
1.347 albertel 3943: my $spec=$trole.'.'.$area;
3944: my ($tdummy,$tdomain,$trest)=split(/\//,$area);
3945: if ($trole =~ /^cr\//) {
1.567 raeburn 3946: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
1.678 raeburn 3947: } elsif ($trole eq 'gr') {
3948: &group_roleprivs(\%allgroups,$area,$group_privs,$tend,$tstart);
1.347 albertel 3949: } else {
1.567 raeburn 3950: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
1.347 albertel 3951: }
1.12 www 3952: }
1.662 raeburn 3953: }
1.191 harris41 3954: }
1.743 albertel 3955: my ($author,$adv) = &set_userprivs(\%userroles,\%allroles,\%allgroups);
3956: $userroles{'user.adv'} = $adv;
3957: $userroles{'user.author'} = $author;
1.620 albertel 3958: $env{'user.adv'}=$adv;
1.11 www 3959: }
1.743 albertel 3960: return \%userroles;
1.11 www 3961: }
3962:
1.567 raeburn 3963: sub set_arearole {
3964: my ($trole,$area,$tstart,$tend,$domain,$username) = @_;
3965: # log the associated role with the area
3966: &userrolelog($trole,$username,$domain,$area,$tstart,$tend);
1.743 albertel 3967: return ('user.role.'.$trole.'.'.$area => $tstart.'.'.$tend);
1.567 raeburn 3968: }
3969:
3970: sub custom_roleprivs {
3971: my ($allroles,$trole,$tdomain,$trest,$spec,$area) = @_;
3972: my ($rdummy,$rdomain,$rauthor,$rrole)=split(/\//,$trole);
3973: my $homsvr=homeserver($rauthor,$rdomain);
1.838 albertel 3974: if (&hostname($homsvr) ne '') {
1.567 raeburn 3975: my ($rdummy,$roledef)=
3976: &get('roles',["rolesdef_$rrole"],$rdomain,$rauthor);
3977: if (($rdummy ne 'con_lost') && ($roledef ne '')) {
3978: my ($syspriv,$dompriv,$coursepriv)=split(/\_/,$roledef);
3979: if (defined($syspriv)) {
1.1043 raeburn 3980: if ($trest =~ /^$match_community$/) {
3981: $syspriv =~ s/bre\&S//;
3982: }
1.567 raeburn 3983: $$allroles{'cm./'}.=':'.$syspriv;
3984: $$allroles{$spec.'./'}.=':'.$syspriv;
3985: }
3986: if ($tdomain ne '') {
3987: if (defined($dompriv)) {
3988: $$allroles{'cm./'.$tdomain.'/'}.=':'.$dompriv;
3989: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$dompriv;
3990: }
3991: if (($trest ne '') && (defined($coursepriv))) {
3992: $$allroles{'cm.'.$area}.=':'.$coursepriv;
3993: $$allroles{$spec.'.'.$area}.=':'.$coursepriv;
3994: }
3995: }
3996: }
3997: }
3998: }
3999:
1.678 raeburn 4000: sub group_roleprivs {
4001: my ($allgroups,$area,$group_privs,$tend,$tstart) = @_;
4002: my $access = 1;
4003: my $now = time;
4004: if (($tend!=0) && ($tend<$now)) { $access = 0; }
4005: if (($tstart!=0) && ($tstart>$now)) { $access=0; }
4006: if ($access) {
1.811 albertel 4007: my ($course,$group) = ($area =~ m|(/$match_domain/$match_courseid)/([^/]+)$|);
1.678 raeburn 4008: $$allgroups{$course}{$group} .=':'.$group_privs;
4009: }
4010: }
1.567 raeburn 4011:
4012: sub standard_roleprivs {
4013: my ($allroles,$trole,$tdomain,$spec,$trest,$area) = @_;
4014: if (defined($pr{$trole.':s'})) {
4015: $$allroles{'cm./'}.=':'.$pr{$trole.':s'};
4016: $$allroles{$spec.'./'}.=':'.$pr{$trole.':s'};
4017: }
4018: if ($tdomain ne '') {
4019: if (defined($pr{$trole.':d'})) {
4020: $$allroles{'cm./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4021: $$allroles{$spec.'./'.$tdomain.'/'}.=':'.$pr{$trole.':d'};
4022: }
4023: if (($trest ne '') && (defined($pr{$trole.':c'}))) {
4024: $$allroles{'cm.'.$area}.=':'.$pr{$trole.':c'};
4025: $$allroles{$spec.'.'.$area}.=':'.$pr{$trole.':c'};
4026: }
4027: }
4028: }
4029:
4030: sub set_userprivs {
1.678 raeburn 4031: my ($userroles,$allroles,$allgroups) = @_;
1.567 raeburn 4032: my $author=0;
4033: my $adv=0;
1.678 raeburn 4034: my %grouproles = ();
4035: if (keys(%{$allgroups}) > 0) {
1.1000 raeburn 4036: foreach my $role (keys(%{$allroles})) {
1.681 raeburn 4037: my ($trole,$area,$sec,$extendedarea);
1.881 raeburn 4038: if ($role =~ m-^(\w+|cr/$match_domain/$match_username/\w+)\.(/$match_domain/$match_courseid)(/?\w*)\.-) {
1.678 raeburn 4039: $trole = $1;
4040: $area = $2;
1.681 raeburn 4041: $sec = $3;
4042: $extendedarea = $area.$sec;
4043: if (exists($$allgroups{$area})) {
4044: foreach my $group (keys(%{$$allgroups{$area}})) {
4045: my $spec = $trole.'.'.$extendedarea;
4046: $grouproles{$spec.'.'.$area.'/'.$group} =
4047: $$allgroups{$area}{$group};
1.678 raeburn 4048: }
4049: }
4050: }
4051: }
4052: }
1.800 albertel 4053: foreach my $group (keys(%grouproles)) {
4054: $$allroles{$group} = $grouproles{$group};
1.678 raeburn 4055: }
1.800 albertel 4056: foreach my $role (keys(%{$allroles})) {
4057: my %thesepriv;
1.941 raeburn 4058: if (($role=~/^au/) || ($role=~/^ca/) || ($role=~/^aa/)) { $author=1; }
1.800 albertel 4059: foreach my $item (split(/:/,$$allroles{$role})) {
4060: if ($item ne '') {
4061: my ($privilege,$restrictions)=split(/&/,$item);
1.567 raeburn 4062: if ($restrictions eq '') {
4063: $thesepriv{$privilege}='F';
4064: } elsif ($thesepriv{$privilege} ne 'F') {
4065: $thesepriv{$privilege}.=$restrictions;
4066: }
4067: if ($thesepriv{'adv'} eq 'F') { $adv=1; }
4068: }
4069: }
4070: my $thesestr='';
1.800 albertel 4071: foreach my $priv (keys(%thesepriv)) {
4072: $thesestr.=':'.$priv.'&'.$thesepriv{$priv};
4073: }
4074: $userroles->{'user.priv.'.$role} = $thesestr;
1.567 raeburn 4075: }
4076: return ($author,$adv);
4077: }
4078:
1.994 raeburn 4079: sub role_status {
1.1002 raeburn 4080: my ($rolekey,$then,$refresh,$now,$role,$where,$trolecode,$tstatus,$tstart,$tend) = @_;
1.994 raeburn 4081: my @pwhere = ();
4082: if (exists($env{$rolekey}) && $env{$rolekey} ne '') {
4083: (undef,undef,$$role,@pwhere)=split(/\./,$rolekey);
4084: unless (!defined($$role) || $$role eq '') {
4085: $$where=join('.',@pwhere);
4086: $$trolecode=$$role.'.'.$$where;
4087: ($$tstart,$$tend)=split(/\./,$env{$rolekey});
4088: $$tstatus='is';
4089: if ($$tstart && $$tstart>$then) {
4090: $$tstatus='future';
1.1034 raeburn 4091: if ($$tstart<$now) {
4092: if ($$tstart && $$tstart>$refresh) {
1.1002 raeburn 4093: if (($$where ne '') && ($$role ne '')) {
4094: my (%allroles,%allgroups,$group_privs);
4095: my %userroles = (
4096: 'user.role.'.$$role.'.'.$$where => $$tstart.'.'.$$tend
4097: );
4098: my $spec=$$role.'.'.$$where;
4099: my ($tdummy,$tdomain,$trest)=split(/\//,$$where);
4100: if ($$role =~ /^cr\//) {
4101: &custom_roleprivs(\%allroles,$$role,$tdomain,$trest,$spec,$$where);
4102: } elsif ($$role eq 'gr') {
4103: my %rolehash = &get('roles',[$$where.'_'.$$role],$env{'user.domain'},
4104: $env{'user.name'});
4105: my $trole = split('_',$rolehash{$$where.'_'.$$role},1);
4106: (undef,my $group_privs) = split(/\//,$trole);
4107: $group_privs = &unescape($group_privs);
4108: &group_roleprivs(\%allgroups,$$where,$group_privs,$$tend,$$tstart);
4109: } else {
4110: &standard_roleprivs(\%allroles,$$role,$tdomain,$spec,$trest,$$where);
4111: }
4112: my ($author,$adv)= &set_userprivs(\%userroles,\%allroles,\%allgroups);
4113: &appenv(\%userroles,[$$role,'cm']);
4114: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4115: }
4116: }
1.1034 raeburn 4117: $$tstatus = 'is';
1.1002 raeburn 4118: }
1.994 raeburn 4119: }
4120: if ($$tend) {
4121: if ($$tend<$then) {
4122: $$tstatus='expired';
4123: } elsif ($$tend<$now) {
4124: $$tstatus='will_not';
4125: }
4126: }
4127: }
4128: }
4129: }
4130:
4131: sub check_adhoc_privs {
1.1002 raeburn 4132: my ($cdom,$cnum,$then,$refresh,$now,$checkrole) = @_;
1.994 raeburn 4133: my $cckey = 'user.role.'.$checkrole.'./'.$cdom.'/'.$cnum;
4134: if ($env{$cckey}) {
4135: my ($role,$where,$trolecode,$tstart,$tend,$tremark,$tstatus,$tpstart,$tpend);
1.1002 raeburn 4136: &role_status($cckey,$then,$refresh,$now,\$role,\$where,\$trolecode,\$tstatus,\$tstart,\$tend);
1.994 raeburn 4137: unless (($tstatus eq 'is') || ($tstatus eq 'will_not')) {
4138: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4139: }
4140: } else {
4141: &set_adhoc_privileges($cdom,$cnum,$checkrole);
4142: }
4143: }
4144:
4145: sub set_adhoc_privileges {
4146: # role can be cc or ca
4147: my ($dcdom,$pickedcourse,$role) = @_;
4148: my $area = '/'.$dcdom.'/'.$pickedcourse;
4149: my $spec = $role.'.'.$area;
4150: my %userroles = &set_arearole($role,$area,'','',$env{'user.domain'},
4151: $env{'user.name'});
4152: my %ccrole = ();
4153: &standard_roleprivs(\%ccrole,$role,$dcdom,$spec,$pickedcourse,$area);
4154: my ($author,$adv)= &set_userprivs(\%userroles,\%ccrole);
4155: &appenv(\%userroles,[$role,'cm']);
4156: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},"Role ".$role);
4157: &appenv( {'request.role' => $spec,
4158: 'request.role.domain' => $dcdom,
4159: 'request.course.sec' => ''
4160: }
4161: );
4162: my $tadv=0;
4163: if (&allowed('adv') eq 'F') { $tadv=1; }
4164: &appenv({'request.role.adv' => $tadv});
4165: }
4166:
1.12 www 4167: # --------------------------------------------------------------- get interface
4168:
4169: sub get {
1.131 albertel 4170: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4171: my $items='';
1.800 albertel 4172: foreach my $item (@$storearr) {
4173: $items.=&escape($item).'&';
1.191 harris41 4174: }
1.12 www 4175: $items=~s/\&$//;
1.620 albertel 4176: if (!$udomain) { $udomain=$env{'user.domain'}; }
4177: if (!$uname) { $uname=$env{'user.name'}; }
1.131 albertel 4178: my $uhome=&homeserver($uname,$udomain);
4179:
1.133 albertel 4180: my $rep=&reply("get:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4181: my @pairs=split(/\&/,$rep);
1.273 albertel 4182: if ( $#pairs==0 && $pairs[0] =~ /^(con_lost|error|no_such_host)/i) {
4183: return @pairs;
4184: }
1.15 www 4185: my %returnhash=();
1.42 www 4186: my $i=0;
1.800 albertel 4187: foreach my $item (@$storearr) {
4188: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4189: $i++;
1.191 harris41 4190: }
1.15 www 4191: return %returnhash;
1.27 www 4192: }
4193:
4194: # --------------------------------------------------------------- del interface
4195:
4196: sub del {
1.133 albertel 4197: my ($namespace,$storearr,$udomain,$uname)=@_;
1.27 www 4198: my $items='';
1.800 albertel 4199: foreach my $item (@$storearr) {
4200: $items.=&escape($item).'&';
1.191 harris41 4201: }
1.984 neumanie 4202:
1.27 www 4203: $items=~s/\&$//;
1.620 albertel 4204: if (!$udomain) { $udomain=$env{'user.domain'}; }
4205: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4206: my $uhome=&homeserver($uname,$udomain);
4207: return &reply("del:$udomain:$uname:$namespace:$items",$uhome);
1.15 www 4208: }
4209:
4210: # -------------------------------------------------------------- dump interface
4211:
4212: sub dump {
1.755 albertel 4213: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
4214: if (!$udomain) { $udomain=$env{'user.domain'}; }
4215: if (!$uname) { $uname=$env{'user.name'}; }
4216: my $uhome=&homeserver($uname,$udomain);
4217: if ($regexp) {
4218: $regexp=&escape($regexp);
4219: } else {
4220: $regexp='.';
4221: }
4222: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4223: my @pairs=split(/\&/,$rep);
4224: my %returnhash=();
4225: foreach my $item (@pairs) {
4226: my ($key,$value)=split(/=/,$item,2);
4227: $key = &unescape($key);
4228: next if ($key =~ /^error: 2 /);
4229: $returnhash{$key}=&thaw_unescape($value);
4230: }
4231: return %returnhash;
1.407 www 4232: }
4233:
1.717 albertel 4234: # --------------------------------------------------------- dumpstore interface
4235:
4236: sub dumpstore {
4237: my ($namespace,$udomain,$uname,$regexp,$range)=@_;
1.822 albertel 4238: if (!$udomain) { $udomain=$env{'user.domain'}; }
4239: if (!$uname) { $uname=$env{'user.name'}; }
4240: my $uhome=&homeserver($uname,$udomain);
4241: if ($regexp) {
4242: $regexp=&escape($regexp);
4243: } else {
4244: $regexp='.';
4245: }
4246: my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
4247: my @pairs=split(/\&/,$rep);
4248: my %returnhash=();
4249: foreach my $item (@pairs) {
4250: my ($key,$value)=split(/=/,$item,2);
4251: next if ($key =~ /^error: 2 /);
4252: $returnhash{$key}=&thaw_unescape($value);
4253: }
4254: return %returnhash;
1.717 albertel 4255: }
4256:
1.407 www 4257: # -------------------------------------------------------------- keys interface
4258:
4259: sub getkeys {
4260: my ($namespace,$udomain,$uname)=@_;
1.620 albertel 4261: if (!$udomain) { $udomain=$env{'user.domain'}; }
4262: if (!$uname) { $uname=$env{'user.name'}; }
1.407 www 4263: my $uhome=&homeserver($uname,$udomain);
4264: my $rep=reply("keys:$udomain:$uname:$namespace",$uhome);
4265: my @keyarray=();
1.800 albertel 4266: foreach my $key (split(/\&/,$rep)) {
1.812 raeburn 4267: next if ($key =~ /^error: 2 /);
1.800 albertel 4268: push(@keyarray,&unescape($key));
1.407 www 4269: }
4270: return @keyarray;
1.318 matthew 4271: }
4272:
1.319 matthew 4273: # --------------------------------------------------------------- currentdump
4274: sub currentdump {
1.328 matthew 4275: my ($courseid,$sdom,$sname)=@_;
1.620 albertel 4276: $courseid = $env{'request.course.id'} if (! defined($courseid));
4277: $sdom = $env{'user.domain'} if (! defined($sdom));
4278: $sname = $env{'user.name'} if (! defined($sname));
1.326 matthew 4279: my $uhome = &homeserver($sname,$sdom);
4280: my $rep=reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
1.318 matthew 4281: return if ($rep =~ /^(error:|no_such_host)/);
1.319 matthew 4282: #
1.318 matthew 4283: my %returnhash=();
1.319 matthew 4284: #
4285: if ($rep eq "unknown_cmd") {
4286: # an old lond will not know currentdump
4287: # Do a dump and make it look like a currentdump
1.822 albertel 4288: my @tmp = &dumpstore($courseid,$sdom,$sname,'.');
1.319 matthew 4289: return if ($tmp[0] =~ /^(error:|no_such_host)/);
4290: my %hash = @tmp;
4291: @tmp=();
1.424 matthew 4292: %returnhash = %{&convert_dump_to_currentdump(\%hash)};
1.319 matthew 4293: } else {
4294: my @pairs=split(/\&/,$rep);
1.800 albertel 4295: foreach my $pair (@pairs) {
4296: my ($key,$value)=split(/=/,$pair,2);
1.319 matthew 4297: my ($symb,$param) = split(/:/,$key);
4298: $returnhash{&unescape($symb)}->{&unescape($param)} =
1.557 albertel 4299: &thaw_unescape($value);
1.319 matthew 4300: }
1.191 harris41 4301: }
1.12 www 4302: return %returnhash;
1.424 matthew 4303: }
4304:
4305: sub convert_dump_to_currentdump{
4306: my %hash = %{shift()};
4307: my %returnhash;
4308: # Code ripped from lond, essentially. The only difference
4309: # here is the unescaping done by lonnet::dump(). Conceivably
4310: # we might run in to problems with parameter names =~ /^v\./
4311: while (my ($key,$value) = each(%hash)) {
4312: my ($v,$symb,$param) = split(/:/,$key);
1.822 albertel 4313: $symb = &unescape($symb);
4314: $param = &unescape($param);
1.424 matthew 4315: next if ($v eq 'version' || $symb eq 'keys');
4316: next if (exists($returnhash{$symb}) &&
4317: exists($returnhash{$symb}->{$param}) &&
4318: $returnhash{$symb}->{'v.'.$param} > $v);
4319: $returnhash{$symb}->{$param}=$value;
4320: $returnhash{$symb}->{'v.'.$param}=$v;
4321: }
4322: #
4323: # Remove all of the keys in the hashes which keep track of
4324: # the version of the parameter.
4325: while (my ($symb,$param_hash) = each(%returnhash)) {
4326: # use a foreach because we are going to delete from the hash.
4327: foreach my $key (keys(%$param_hash)) {
4328: delete($param_hash->{$key}) if ($key =~ /^v\./);
4329: }
4330: }
4331: return \%returnhash;
1.12 www 4332: }
4333:
1.627 albertel 4334: # ------------------------------------------------------ critical inc interface
4335:
4336: sub cinc {
4337: return &inc(@_,'critical');
4338: }
4339:
1.449 matthew 4340: # --------------------------------------------------------------- inc interface
4341:
4342: sub inc {
1.627 albertel 4343: my ($namespace,$store,$udomain,$uname,$critical) = @_;
1.620 albertel 4344: if (!$udomain) { $udomain=$env{'user.domain'}; }
4345: if (!$uname) { $uname=$env{'user.name'}; }
1.449 matthew 4346: my $uhome=&homeserver($uname,$udomain);
4347: my $items='';
4348: if (! ref($store)) {
4349: # got a single value, so use that instead
4350: $items = &escape($store).'=&';
4351: } elsif (ref($store) eq 'SCALAR') {
4352: $items = &escape($$store).'=&';
4353: } elsif (ref($store) eq 'ARRAY') {
4354: $items = join('=&',map {&escape($_);} @{$store});
4355: } elsif (ref($store) eq 'HASH') {
4356: while (my($key,$value) = each(%{$store})) {
4357: $items.= &escape($key).'='.&escape($value).'&';
4358: }
4359: }
4360: $items=~s/\&$//;
1.627 albertel 4361: if ($critical) {
4362: return &critical("inc:$udomain:$uname:$namespace:$items",$uhome);
4363: } else {
4364: return &reply("inc:$udomain:$uname:$namespace:$items",$uhome);
4365: }
1.449 matthew 4366: }
4367:
1.12 www 4368: # --------------------------------------------------------------- put interface
4369:
4370: sub put {
1.134 albertel 4371: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4372: if (!$udomain) { $udomain=$env{'user.domain'}; }
4373: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4374: my $uhome=&homeserver($uname,$udomain);
1.12 www 4375: my $items='';
1.800 albertel 4376: foreach my $item (keys(%$storehash)) {
4377: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4378: }
1.12 www 4379: $items=~s/\&$//;
1.134 albertel 4380: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.47 www 4381: }
4382:
1.631 albertel 4383: # ------------------------------------------------------------ newput interface
4384:
4385: sub newput {
4386: my ($namespace,$storehash,$udomain,$uname)=@_;
4387: if (!$udomain) { $udomain=$env{'user.domain'}; }
4388: if (!$uname) { $uname=$env{'user.name'}; }
4389: my $uhome=&homeserver($uname,$udomain);
4390: my $items='';
4391: foreach my $key (keys(%$storehash)) {
4392: $items.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
4393: }
4394: $items=~s/\&$//;
4395: return &reply("newput:$udomain:$uname:$namespace:$items",$uhome);
4396: }
4397:
4398: # --------------------------------------------------------- putstore interface
4399:
1.524 raeburn 4400: sub putstore {
1.715 albertel 4401: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
1.620 albertel 4402: if (!$udomain) { $udomain=$env{'user.domain'}; }
4403: if (!$uname) { $uname=$env{'user.name'}; }
1.524 raeburn 4404: my $uhome=&homeserver($uname,$udomain);
4405: my $items='';
1.715 albertel 4406: foreach my $key (keys(%$storehash)) {
4407: $items.= &escape($key).'='.&freeze_escape($storehash->{$key}).'&';
1.524 raeburn 4408: }
1.715 albertel 4409: $items=~s/\&$//;
1.716 albertel 4410: my $esc_symb=&escape($symb);
4411: my $esc_v=&escape($version);
1.715 albertel 4412: my $reply =
1.716 albertel 4413: &reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
1.715 albertel 4414: $uhome);
4415: if ($reply eq 'unknown_cmd') {
1.716 albertel 4416: # gfall back to way things use to be done
1.715 albertel 4417: return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
4418: $uname);
1.524 raeburn 4419: }
1.715 albertel 4420: return $reply;
4421: }
4422:
4423: sub old_putstore {
1.716 albertel 4424: my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
4425: if (!$udomain) { $udomain=$env{'user.domain'}; }
4426: if (!$uname) { $uname=$env{'user.name'}; }
4427: my $uhome=&homeserver($uname,$udomain);
4428: my %newstorehash;
1.800 albertel 4429: foreach my $item (keys(%$storehash)) {
4430: my $key = $version.':'.&escape($symb).':'.$item;
4431: $newstorehash{$key} = $storehash->{$item};
1.716 albertel 4432: }
4433: my $items='';
4434: my %allitems = ();
1.800 albertel 4435: foreach my $item (keys(%newstorehash)) {
4436: if ($item =~ m/^([^\:]+):([^\:]+):([^\:]+)$/) {
1.716 albertel 4437: my $key = $1.':keys:'.$2;
4438: $allitems{$key} .= $3.':';
4439: }
1.800 albertel 4440: $items.=$item.'='.&freeze_escape($newstorehash{$item}).'&';
1.716 albertel 4441: }
1.800 albertel 4442: foreach my $item (keys(%allitems)) {
4443: $allitems{$item} =~ s/\:$//;
4444: $items.= $item.'='.$allitems{$item}.'&';
1.716 albertel 4445: }
4446: $items=~s/\&$//;
4447: return &reply("put:$udomain:$uname:$namespace:$items",$uhome);
1.524 raeburn 4448: }
4449:
1.47 www 4450: # ------------------------------------------------------ critical put interface
4451:
4452: sub cput {
1.134 albertel 4453: my ($namespace,$storehash,$udomain,$uname)=@_;
1.620 albertel 4454: if (!$udomain) { $udomain=$env{'user.domain'}; }
4455: if (!$uname) { $uname=$env{'user.name'}; }
1.134 albertel 4456: my $uhome=&homeserver($uname,$udomain);
1.47 www 4457: my $items='';
1.800 albertel 4458: foreach my $item (keys(%$storehash)) {
4459: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.191 harris41 4460: }
1.47 www 4461: $items=~s/\&$//;
1.134 albertel 4462: return &critical("put:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4463: }
4464:
4465: # -------------------------------------------------------------- eget interface
4466:
4467: sub eget {
1.133 albertel 4468: my ($namespace,$storearr,$udomain,$uname)=@_;
1.12 www 4469: my $items='';
1.800 albertel 4470: foreach my $item (@$storearr) {
4471: $items.=&escape($item).'&';
1.191 harris41 4472: }
1.12 www 4473: $items=~s/\&$//;
1.620 albertel 4474: if (!$udomain) { $udomain=$env{'user.domain'}; }
4475: if (!$uname) { $uname=$env{'user.name'}; }
1.133 albertel 4476: my $uhome=&homeserver($uname,$udomain);
4477: my $rep=&reply("eget:$udomain:$uname:$namespace:$items",$uhome);
1.12 www 4478: my @pairs=split(/\&/,$rep);
4479: my %returnhash=();
1.42 www 4480: my $i=0;
1.800 albertel 4481: foreach my $item (@$storearr) {
4482: $returnhash{$item}=&thaw_unescape($pairs[$i]);
1.42 www 4483: $i++;
1.191 harris41 4484: }
1.12 www 4485: return %returnhash;
4486: }
4487:
1.667 albertel 4488: # ------------------------------------------------------------ tmpput interface
4489: sub tmpput {
1.802 raeburn 4490: my ($storehash,$server,$context)=@_;
1.667 albertel 4491: my $items='';
1.800 albertel 4492: foreach my $item (keys(%$storehash)) {
4493: $items.=&escape($item).'='.&freeze_escape($$storehash{$item}).'&';
1.667 albertel 4494: }
4495: $items=~s/\&$//;
1.802 raeburn 4496: if (defined($context)) {
4497: $items .= ':'.&escape($context);
4498: }
1.667 albertel 4499: return &reply("tmpput:$items",$server);
4500: }
4501:
4502: # ------------------------------------------------------------ tmpget interface
4503: sub tmpget {
1.688 albertel 4504: my ($token,$server)=@_;
4505: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4506: my $rep=&reply("tmpget:$token",$server);
1.667 albertel 4507: my %returnhash;
4508: foreach my $item (split(/\&/,$rep)) {
4509: my ($key,$value)=split(/=/,$item);
1.951 raeburn 4510: next if ($key =~ /^error: 2 /);
1.667 albertel 4511: $returnhash{&unescape($key)}=&thaw_unescape($value);
4512: }
4513: return %returnhash;
4514: }
4515:
1.688 albertel 4516: # ------------------------------------------------------------ tmpget interface
4517: sub tmpdel {
4518: my ($token,$server)=@_;
4519: if (!defined($server)) { $server = $perlvar{'lonHostID'}; }
4520: return &reply("tmpdel:$token",$server);
4521: }
4522:
1.765 albertel 4523: # -------------------------------------------------- portfolio access checking
4524:
4525: sub portfolio_access {
1.766 albertel 4526: my ($requrl) = @_;
1.765 albertel 4527: my (undef,$udom,$unum,$file_name,$group) = &parse_portfolio_url($requrl);
4528: my $result = &get_portfolio_access($udom,$unum,$file_name,$group);
1.814 raeburn 4529: if ($result) {
4530: my %setters;
4531: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4532: my ($startblock,$endblock) =
4533: &Apache::loncommon::blockcheck(\%setters,'port',$unum,$udom);
4534: if ($startblock && $endblock) {
4535: return 'B';
4536: }
4537: } else {
4538: my ($startblock,$endblock) =
4539: &Apache::loncommon::blockcheck(\%setters,'port');
4540: if ($startblock && $endblock) {
4541: return 'B';
4542: }
4543: }
4544: }
1.765 albertel 4545: if ($result eq 'ok') {
1.766 albertel 4546: return 'F';
1.765 albertel 4547: } elsif ($result =~ /^[^:]+:guest_/) {
1.766 albertel 4548: return 'A';
1.765 albertel 4549: }
1.766 albertel 4550: return '';
1.765 albertel 4551: }
4552:
4553: sub get_portfolio_access {
1.767 albertel 4554: my ($udom,$unum,$file_name,$group,$access_hash) = @_;
4555:
4556: if (!ref($access_hash)) {
4557: my $current_perms = &get_portfile_permissions($udom,$unum);
4558: my %access_controls = &get_access_controls($current_perms,$group,
4559: $file_name);
4560: $access_hash = $access_controls{$file_name};
4561: }
4562:
1.765 albertel 4563: my ($public,$guest,@domains,@users,@courses,@groups);
4564: my $now = time;
4565: if (ref($access_hash) eq 'HASH') {
4566: foreach my $key (keys(%{$access_hash})) {
4567: my ($num,$scope,$end,$start) = ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
4568: if ($start > $now) {
4569: next;
4570: }
4571: if ($end && $end<$now) {
4572: next;
4573: }
4574: if ($scope eq 'public') {
4575: $public = $key;
4576: last;
4577: } elsif ($scope eq 'guest') {
4578: $guest = $key;
4579: } elsif ($scope eq 'domains') {
4580: push(@domains,$key);
4581: } elsif ($scope eq 'users') {
4582: push(@users,$key);
4583: } elsif ($scope eq 'course') {
4584: push(@courses,$key);
4585: } elsif ($scope eq 'group') {
4586: push(@groups,$key);
4587: }
4588: }
4589: if ($public) {
4590: return 'ok';
4591: }
4592: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4593: if ($guest) {
4594: return $guest;
4595: }
4596: } else {
4597: if (@domains > 0) {
4598: foreach my $domkey (@domains) {
4599: if (ref($access_hash->{$domkey}{'dom'}) eq 'ARRAY') {
4600: if (grep(/^\Q$env{'user.domain'}\E$/,@{$access_hash->{$domkey}{'dom'}})) {
4601: return 'ok';
4602: }
4603: }
4604: }
4605: }
4606: if (@users > 0) {
4607: foreach my $userkey (@users) {
1.865 raeburn 4608: if (ref($access_hash->{$userkey}{'users'}) eq 'ARRAY') {
4609: foreach my $item (@{$access_hash->{$userkey}{'users'}}) {
4610: if (ref($item) eq 'HASH') {
4611: if (($item->{'uname'} eq $env{'user.name'}) &&
4612: ($item->{'udom'} eq $env{'user.domain'})) {
4613: return 'ok';
4614: }
4615: }
4616: }
4617: }
1.765 albertel 4618: }
4619: }
4620: my %roleshash;
4621: my @courses_and_groups = @courses;
4622: push(@courses_and_groups,@groups);
4623: if (@courses_and_groups > 0) {
4624: my (%allgroups,%allroles);
4625: my ($start,$end,$role,$sec,$group);
4626: foreach my $envkey (%env) {
1.1056.2.2! raeburn 4627: if ($envkey =~ m-^user\.role\.(gr|cc|co|in|ta|ep|ad|st)\./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4628: my $cid = $2.'_'.$3;
4629: if ($1 eq 'gr') {
4630: $group = $4;
4631: $allgroups{$cid}{$group} = $env{$envkey};
4632: } else {
4633: if ($4 eq '') {
4634: $sec = 'none';
4635: } else {
4636: $sec = $4;
4637: }
4638: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4639: }
1.811 albertel 4640: } elsif ($envkey =~ m-^user\.role\./cr/($match_domain/$match_username/\w*)./($match_domain)/($match_courseid)/?([^/]*)$-) {
1.765 albertel 4641: my $cid = $2.'_'.$3;
4642: if ($4 eq '') {
4643: $sec = 'none';
4644: } else {
4645: $sec = $4;
4646: }
4647: $allroles{$cid}{$1}{$sec} = $env{$envkey};
4648: }
4649: }
4650: if (keys(%allroles) == 0) {
4651: return;
4652: }
4653: foreach my $key (@courses_and_groups) {
4654: my %content = %{$$access_hash{$key}};
4655: my $cnum = $content{'number'};
4656: my $cdom = $content{'domain'};
4657: my $cid = $cdom.'_'.$cnum;
4658: if (!exists($allroles{$cid})) {
4659: next;
4660: }
4661: foreach my $role_id (keys(%{$content{'roles'}})) {
4662: my @sections = @{$content{'roles'}{$role_id}{'section'}};
4663: my @groups = @{$content{'roles'}{$role_id}{'group'}};
4664: my @status = @{$content{'roles'}{$role_id}{'access'}};
4665: my @roles = @{$content{'roles'}{$role_id}{'role'}};
4666: foreach my $role (keys(%{$allroles{$cid}})) {
4667: if ((grep/^all$/,@roles) || (grep/^\Q$role\E$/,@roles)) {
4668: foreach my $sec (keys(%{$allroles{$cid}{$role}})) {
4669: if (&course_group_datechecker($allroles{$cid}{$role}{$sec},$now,\@status) eq 'ok') {
4670: if (grep/^all$/,@sections) {
4671: return 'ok';
4672: } else {
4673: if (grep/^$sec$/,@sections) {
4674: return 'ok';
4675: }
4676: }
4677: }
4678: }
4679: if (keys(%{$allgroups{$cid}}) == 0) {
4680: if (grep/^none$/,@groups) {
4681: return 'ok';
4682: }
4683: } else {
4684: if (grep/^all$/,@groups) {
4685: return 'ok';
4686: }
4687: foreach my $group (keys(%{$allgroups{$cid}})) {
4688: if (grep/^$group$/,@groups) {
4689: return 'ok';
4690: }
4691: }
4692: }
4693: }
4694: }
4695: }
4696: }
4697: }
4698: if ($guest) {
4699: return $guest;
4700: }
4701: }
4702: }
4703: return;
4704: }
4705:
4706: sub course_group_datechecker {
4707: my ($dates,$now,$status) = @_;
4708: my ($start,$end) = split(/\./,$dates);
4709: if (!$start && !$end) {
4710: return 'ok';
4711: }
4712: if (grep/^active$/,@{$status}) {
4713: if (((!$start) || ($start && $start <= $now)) && ((!$end) || ($end && $end >= $now))) {
4714: return 'ok';
4715: }
4716: }
4717: if (grep/^previous$/,@{$status}) {
4718: if ($end > $now ) {
4719: return 'ok';
4720: }
4721: }
4722: if (grep/^future$/,@{$status}) {
4723: if ($start > $now) {
4724: return 'ok';
4725: }
4726: }
4727: return;
4728: }
4729:
4730: sub parse_portfolio_url {
4731: my ($url) = @_;
4732:
4733: my ($type,$udom,$unum,$group,$file_name);
4734:
1.823 albertel 4735: if ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_username)/portfolio(/.+)$-) {
1.765 albertel 4736: $type = 1;
4737: $udom = $1;
4738: $unum = $2;
4739: $file_name = $3;
1.823 albertel 4740: } elsif ($url =~ m-^/*(?:uploaded|editupload)/($match_domain)/($match_courseid)/groups/([^/]+)/portfolio/(.+)$-) {
1.765 albertel 4741: $type = 2;
4742: $udom = $1;
4743: $unum = $2;
4744: $group = $3;
4745: $file_name = $3.'/'.$4;
4746: }
4747: if (wantarray) {
4748: return ($type,$udom,$unum,$file_name,$group);
4749: }
4750: return $type;
4751: }
4752:
4753: sub is_portfolio_url {
4754: my ($url) = @_;
4755: return scalar(&parse_portfolio_url($url));
4756: }
4757:
1.798 raeburn 4758: sub is_portfolio_file {
4759: my ($file) = @_;
1.820 raeburn 4760: if (($file =~ /^portfolio/) || ($file =~ /^groups\/\w+\/portfolio/)) {
1.798 raeburn 4761: return 1;
4762: }
4763: return;
4764: }
4765:
1.976 raeburn 4766: sub usertools_access {
1.985 raeburn 4767: my ($uname,$udom,$tool,$action,$context) = @_;
4768: my ($access,%tools);
4769: if ($context eq '') {
4770: $context = 'tools';
4771: }
4772: if ($context eq 'requestcourses') {
4773: %tools = (
4774: official => 1,
4775: unofficial => 1,
1.1006 raeburn 4776: community => 1,
1.985 raeburn 4777: );
4778: } else {
4779: %tools = (
4780: aboutme => 1,
4781: blog => 1,
4782: portfolio => 1,
4783: );
4784: }
1.976 raeburn 4785: return if (!defined($tools{$tool}));
4786:
4787: if ((!defined($udom)) || (!defined($uname))) {
4788: $udom = $env{'user.domain'};
4789: $uname = $env{'user.name'};
4790: }
4791:
1.978 raeburn 4792: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
4793: if ($action ne 'reload') {
1.985 raeburn 4794: if ($context eq 'requestcourses') {
4795: return $env{'environment.canrequest.'.$tool};
4796: } else {
4797: return $env{'environment.availabletools.'.$tool};
4798: }
4799: }
1.976 raeburn 4800: }
4801:
4802: my ($toolstatus,$inststatus);
4803:
1.985 raeburn 4804: if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
4805: ($action ne 'reload')) {
4806: $toolstatus = $env{'environment.'.$context.'.'.$tool};
1.976 raeburn 4807: $inststatus = $env{'environment.inststatus'};
4808: } else {
1.1025 raeburn 4809: my %userenv = &userenvironment($udom,$uname,$context.'.'.$tool,'inststatus');
1.985 raeburn 4810: $toolstatus = $userenv{$context.'.'.$tool};
1.976 raeburn 4811: $inststatus = $userenv{'inststatus'};
4812: }
4813:
4814: if ($toolstatus ne '') {
4815: if ($toolstatus) {
4816: $access = 1;
4817: } else {
4818: $access = 0;
4819: }
4820: return $access;
4821: }
4822:
4823: my $is_adv = &is_advanced_user($udom,$uname);
4824: my %domdef = &get_domain_defaults($udom);
4825: if (ref($domdef{$tool}) eq 'HASH') {
4826: if ($is_adv) {
4827: if ($domdef{$tool}{'_LC_adv'} ne '') {
4828: if ($domdef{$tool}{'_LC_adv'}) {
4829: $access = 1;
4830: } else {
4831: $access = 0;
4832: }
4833: return $access;
4834: }
4835: }
4836: if ($inststatus ne '') {
4837: my ($hasaccess,$hasnoaccess);
4838: foreach my $affiliation (split(/:/,$inststatus)) {
4839: if ($domdef{$tool}{$affiliation} ne '') {
4840: if ($domdef{$tool}{$affiliation}) {
4841: $hasaccess = 1;
4842: } else {
4843: $hasnoaccess = 1;
4844: }
4845: }
4846: }
4847: if ($hasaccess || $hasnoaccess) {
4848: if ($hasaccess) {
4849: $access = 1;
4850: } elsif ($hasnoaccess) {
4851: $access = 0;
4852: }
4853: return $access;
4854: }
4855: } else {
4856: if ($domdef{$tool}{'default'} ne '') {
4857: if ($domdef{$tool}{'default'}) {
4858: $access = 1;
4859: } elsif ($domdef{$tool}{'default'} == 0) {
4860: $access = 0;
4861: }
4862: return $access;
4863: }
4864: }
4865: } else {
1.985 raeburn 4866: if ($context eq 'tools') {
4867: $access = 1;
4868: } else {
4869: $access = 0;
4870: }
1.976 raeburn 4871: return $access;
4872: }
4873: }
4874:
1.1050 raeburn 4875: sub is_course_owner {
4876: my ($cdom,$cnum,$udom,$uname) = @_;
4877: if (($udom eq '') || ($uname eq '')) {
4878: $udom = $env{'user.domain'};
4879: $uname = $env{'user.name'};
4880: }
4881: unless (($udom eq '') || ($uname eq '')) {
4882: if (exists($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'})) {
4883: if ($env{'course.'.$cdom.'_'.$cnum.'.internal.courseowner'} eq $uname.':'.$udom) {
4884: return 1;
4885: } else {
4886: my %courseinfo = &Apache::lonnet::coursedescription($cdom.'/'.$cnum);
4887: if ($courseinfo{'internal.courseowner'} eq $uname.':'.$udom) {
4888: return 1;
4889: }
4890: }
4891: }
4892: }
4893: return;
4894: }
4895:
1.976 raeburn 4896: sub is_advanced_user {
4897: my ($udom,$uname) = @_;
4898: my %roleshash = &get_my_roles($uname,$udom,'userroles',undef,undef,undef,1);
4899: my %allroles;
4900: my $is_adv;
4901: foreach my $role (keys(%roleshash)) {
4902: my ($trest,$tdomain,$trole,$sec) = split(/:/,$role);
4903: my $area = '/'.$tdomain.'/'.$trest;
4904: if ($sec ne '') {
4905: $area .= '/'.$sec;
4906: }
4907: if (($area ne '') && ($trole ne '')) {
4908: my $spec=$trole.'.'.$area;
4909: if ($trole =~ /^cr\//) {
4910: &custom_roleprivs(\%allroles,$trole,$tdomain,$trest,$spec,$area);
4911: } elsif ($trole ne 'gr') {
4912: &standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
4913: }
4914: }
4915: }
4916: foreach my $role (keys(%allroles)) {
4917: last if ($is_adv);
4918: foreach my $item (split(/:/,$allroles{$role})) {
4919: if ($item ne '') {
4920: my ($privilege,$restrictions)=split(/&/,$item);
4921: if ($privilege eq 'adv') {
4922: $is_adv = 1;
4923: last;
4924: }
4925: }
4926: }
4927: }
4928: return $is_adv;
4929: }
1.798 raeburn 4930:
1.1035 raeburn 4931: sub check_can_request {
1.1036 raeburn 4932: my ($dom,$can_request,$request_domains) = @_;
1.1035 raeburn 4933: my $canreq = 0;
4934: my ($types,$typename) = &Apache::loncommon::course_types();
4935: my @options = ('approval','validate','autolimit');
4936: my $optregex = join('|',@options);
4937: if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
4938: foreach my $type (@{$types}) {
4939: if (&usertools_access($env{'user.name'},
4940: $env{'user.domain'},
4941: $type,undef,'requestcourses')) {
4942: $canreq ++;
1.1036 raeburn 4943: if (ref($request_domains) eq 'HASH') {
4944: push(@{$request_domains->{$type}},$env{'user.domain'});
4945: }
1.1035 raeburn 4946: if ($dom eq $env{'user.domain'}) {
4947: $can_request->{$type} = 1;
4948: }
4949: }
4950: if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
4951: my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
4952: if (@curr > 0) {
1.1036 raeburn 4953: foreach my $item (@curr) {
4954: if (ref($request_domains) eq 'HASH') {
4955: my ($otherdom) = ($item =~ /^($match_domain):($optregex)(=?\d*)$/);
4956: if ($otherdom ne '') {
4957: if (ref($request_domains->{$type}) eq 'ARRAY') {
4958: unless (grep(/^\Q$otherdom\E$/,@{$request_domains->{$type}})) {
4959: push(@{$request_domains->{$type}},$otherdom);
4960: }
4961: } else {
4962: push(@{$request_domains->{$type}},$otherdom);
4963: }
4964: }
4965: }
4966: }
4967: unless($dom eq $env{'user.domain'}) {
4968: $canreq ++;
1.1035 raeburn 4969: if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
4970: $can_request->{$type} = 1;
4971: }
4972: }
4973: }
4974: }
4975: }
4976: }
4977: return $canreq;
4978: }
4979:
1.341 www 4980: # ---------------------------------------------- Custom access rule evaluation
4981:
4982: sub customaccess {
4983: my ($priv,$uri)=@_;
1.807 albertel 4984: my ($urole,$urealm)=split(/\./,$env{'request.role'},2);
1.819 www 4985: my (undef,$udom,$ucrs,$usec)=split(/\//,$urealm);
1.807 albertel 4986: $udom = &LONCAPA::clean_domain($udom);
4987: $ucrs = &LONCAPA::clean_username($ucrs);
1.341 www 4988: my $access=0;
1.800 albertel 4989: foreach my $right (split(/\s*\,\s*/,&metadata($uri,'rule_rights'))) {
1.893 albertel 4990: my ($effect,$realm,$role,$type)=split(/\:/,$right);
4991: if ($type eq 'user') {
4992: foreach my $scope (split(/\s*\,\s*/,$realm)) {
1.896 albertel 4993: my ($tdom,$tuname)=split(m{/},$scope);
1.893 albertel 4994: if ($tdom) {
4995: if ($tdom ne $env{'user.domain'}) { next; }
4996: }
1.896 albertel 4997: if ($tuname) {
4998: if ($tuname ne $env{'user.name'}) { next; }
1.893 albertel 4999: }
5000: $access=($effect eq 'allow');
5001: last;
5002: }
5003: } else {
5004: if ($role) {
5005: if ($role ne $urole) { next; }
5006: }
5007: foreach my $scope (split(/\s*\,\s*/,$realm)) {
5008: my ($tdom,$tcrs,$tsec)=split(/\_/,$scope);
5009: if ($tdom) {
5010: if ($tdom ne $udom) { next; }
5011: }
5012: if ($tcrs) {
5013: if ($tcrs ne $ucrs) { next; }
5014: }
5015: if ($tsec) {
5016: if ($tsec ne $usec) { next; }
5017: }
5018: $access=($effect eq 'allow');
5019: last;
5020: }
5021: if ($realm eq '' && $role eq '') {
5022: $access=($effect eq 'allow');
5023: }
1.402 bowersj2 5024: }
1.341 www 5025: }
5026: return $access;
5027: }
5028:
1.103 harris41 5029: # ------------------------------------------------- Check for a user privilege
1.12 www 5030:
5031: sub allowed {
1.810 raeburn 5032: my ($priv,$uri,$symb,$role)=@_;
1.705 albertel 5033: my $ver_orguri=$uri;
1.439 www 5034: $uri=&deversion($uri);
1.152 www 5035: my $orguri=$uri;
1.52 www 5036: $uri=&declutter($uri);
1.809 raeburn 5037:
1.810 raeburn 5038: if ($priv eq 'evb') {
5039: # Evade communication block restrictions for specified role in a course
5040: if ($env{'user.priv.'.$role} =~/evb\&([^\:]*)/) {
5041: return $1;
5042: } else {
5043: return;
5044: }
5045: }
5046:
1.620 albertel 5047: if (defined($env{'allowed.'.$priv})) { return $env{'allowed.'.$priv}; }
1.54 www 5048: # Free bre access to adm and meta resources
1.775 albertel 5049: if (((($uri=~/^adm\//) && ($uri !~ m{/(?:smppg|bulletinboard)$}))
1.769 albertel 5050: || (($uri=~/\.meta$/) && ($uri!~m|^uploaded/|) ))
5051: && ($priv eq 'bre')) {
1.14 www 5052: return 'F';
1.159 www 5053: }
5054:
1.545 banghart 5055: # Free bre access to user's own portfolio contents
1.714 raeburn 5056: my ($space,$domain,$name,@dir)=split('/',$uri);
1.647 raeburn 5057: if (($space=~/^(uploaded|editupload)$/) && ($env{'user.name'} eq $name) &&
1.714 raeburn 5058: ($env{'user.domain'} eq $domain) && ('portfolio' eq $dir[0])) {
1.814 raeburn 5059: my %setters;
5060: my ($startblock,$endblock) =
5061: &Apache::loncommon::blockcheck(\%setters,'port');
5062: if ($startblock && $endblock) {
5063: return 'B';
5064: } else {
5065: return 'F';
5066: }
1.545 banghart 5067: }
5068:
1.762 raeburn 5069: # bre access to group portfolio for rgf priv in group, or mdg or vcg in course.
1.714 raeburn 5070: if (($space=~/^(uploaded|editupload)$/) && ($dir[0] eq 'groups')
5071: && ($dir[2] eq 'portfolio') && ($priv eq 'bre')) {
5072: if (exists($env{'request.course.id'})) {
5073: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
5074: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
5075: if (($domain eq $cdom) && ($name eq $cnum)) {
5076: my $courseprivid=$env{'request.course.id'};
5077: $courseprivid=~s/\_/\//;
5078: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid
5079: .'/'.$dir[1]} =~/rgf\&([^\:]*)/) {
5080: return $1;
1.762 raeburn 5081: } else {
5082: if ($env{'request.course.sec'}) {
5083: $courseprivid.='/'.$env{'request.course.sec'};
5084: }
5085: if ($env{'user.priv.'.$env{'request.role'}.'./'.
5086: $courseprivid} =~/(mdg|vcg)\&([^\:]*)/) {
5087: return $2;
5088: }
1.714 raeburn 5089: }
5090: }
5091: }
5092: }
5093:
1.159 www 5094: # Free bre to public access
5095:
5096: if ($priv eq 'bre') {
1.238 www 5097: my $copyright=&metadata($uri,'copyright');
1.620 albertel 5098: if (($copyright eq 'public') && (!$env{'request.course.id'})) {
1.301 www 5099: return 'F';
5100: }
1.238 www 5101: if ($copyright eq 'priv') {
5102: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5103: unless (($env{'user.name'} eq $2) && ($env{'user.domain'} eq $1)) {
1.238 www 5104: return '';
5105: }
5106: }
5107: if ($copyright eq 'domain') {
5108: $uri=~/([^\/]+)\/([^\/]+)\//;
1.620 albertel 5109: unless (($env{'user.domain'} eq $1) ||
5110: ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $1)) {
1.238 www 5111: return '';
5112: }
1.262 matthew 5113: }
1.620 albertel 5114: if ($env{'request.role'}=~ /li\.\//) {
1.262 matthew 5115: # Library role, so allow browsing of resources in this domain.
5116: return 'F';
1.238 www 5117: }
1.341 www 5118: if ($copyright eq 'custom') {
5119: unless (&customaccess($priv,$uri)) { return ''; }
5120: }
1.14 www 5121: }
1.264 matthew 5122: # Domain coordinator is trying to create a course
1.620 albertel 5123: if (($priv eq 'ccc') && ($env{'request.role'} =~ /^dc\./)) {
1.264 matthew 5124: # uri is the requested domain in this case.
5125: # comparison to 'request.role.domain' shows if the user has selected
1.678 raeburn 5126: # a role of dc for the domain in question.
1.620 albertel 5127: return 'F' if ($uri eq $env{'request.role.domain'});
1.264 matthew 5128: }
1.29 www 5129:
1.52 www 5130: my $thisallowed='';
5131: my $statecond=0;
5132: my $courseprivid='';
5133:
1.1039 raeburn 5134: my $ownaccess;
1.1043 raeburn 5135: # Community Coordinator or Assistant Co-author browsing resource space.
1.1039 raeburn 5136: if (($priv eq 'bro') && ($env{'user.author'})) {
5137: if ($uri eq '') {
5138: $ownaccess = 1;
5139: } else {
5140: if (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
5141: my $udom = $env{'user.domain'};
5142: my $uname = $env{'user.name'};
5143: if ($uri =~ m{^\Q$udom\E/?$}) {
5144: $ownaccess = 1;
1.1040 raeburn 5145: } elsif ($uri =~ m{^\Q$udom\E/\Q$uname\E/?}) {
1.1039 raeburn 5146: unless ($uri =~ m{\.\./}) {
5147: $ownaccess = 1;
5148: }
5149: } elsif (($udom ne 'public') && ($uname ne 'public')) {
5150: my $now = time;
5151: if ($uri =~ m{^([^/]+)/?$}) {
5152: my $adom = $1;
5153: foreach my $key (keys(%env)) {
1.1042 raeburn 5154: if ($key =~ m{^user\.role\.(ca|aa)/\Q$adom\E}) {
1.1039 raeburn 5155: my ($start,$end) = split('.',$env{$key});
5156: if (($now >= $start) && (!$end || $end < $now)) {
5157: $ownaccess = 1;
5158: last;
5159: }
5160: }
5161: }
5162: } elsif ($uri =~ m{^([^/]+)/([^/]+)/?}) {
5163: my $adom = $1;
5164: my $aname = $2;
1.1042 raeburn 5165: foreach my $role ('ca','aa') {
5166: if ($env{"user.role.$role./$adom/$aname"}) {
5167: my ($start,$end) =
5168: split('.',$env{"user.role.$role./$adom/$aname"});
5169: if (($now >= $start) && (!$end || $end < $now)) {
5170: $ownaccess = 1;
5171: last;
5172: }
1.1039 raeburn 5173: }
5174: }
5175: }
5176: }
5177: }
5178: }
5179: }
5180:
1.52 www 5181: # Course
5182:
1.620 albertel 5183: if ($env{'user.priv.'.$env{'request.role'}.'./'}=~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5184: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5185: $thisallowed.=$1;
5186: }
1.52 www 5187: }
1.29 www 5188:
1.52 www 5189: # Domain
5190:
1.620 albertel 5191: if ($env{'user.priv.'.$env{'request.role'}.'./'.(split(/\//,$uri))[0].'/'}
1.479 albertel 5192: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5193: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5194: $thisallowed.=$1;
5195: }
1.12 www 5196: }
1.52 www 5197:
5198: # Course: uri itself is a course
1.66 www 5199: my $courseuri=$uri;
5200: $courseuri=~s/\_(\d)/\/$1/;
1.83 www 5201: $courseuri=~s/^([^\/])/\/$1/;
1.81 www 5202:
1.620 albertel 5203: if ($env{'user.priv.'.$env{'request.role'}.'.'.$courseuri}
1.479 albertel 5204: =~/\Q$priv\E\&([^\:]*)/) {
1.1043 raeburn 5205: unless (($priv eq 'bro') && (!$ownaccess)) {
1.1039 raeburn 5206: $thisallowed.=$1;
5207: }
1.12 www 5208: }
1.29 www 5209:
1.665 albertel 5210: # URI is an uploaded document for this course, default permissions don't matter
1.611 albertel 5211: # not allowing 'edit' access (editupload) to uploaded course docs
1.492 albertel 5212: if (($priv eq 'bre') && ($uri=~m|^uploaded/|)) {
1.665 albertel 5213: $thisallowed='';
1.671 raeburn 5214: my ($match)=&is_on_map($uri);
5215: if ($match) {
5216: if ($env{'user.priv.'.$env{'request.role'}.'./'}
5217: =~/\Q$priv\E\&([^\:]*)/) {
5218: $thisallowed.=$1;
5219: }
5220: } else {
1.705 albertel 5221: my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
1.671 raeburn 5222: if ($refuri) {
5223: if ($refuri =~ m|^/adm/|) {
1.669 raeburn 5224: $thisallowed='F';
1.671 raeburn 5225: } else {
5226: $refuri=&declutter($refuri);
5227: my ($match) = &is_on_map($refuri);
5228: if ($match) {
5229: $thisallowed='F';
5230: }
1.669 raeburn 5231: }
1.671 raeburn 5232: }
5233: }
1.314 www 5234: }
1.492 albertel 5235:
1.766 albertel 5236: if ($priv eq 'bre'
5237: && $thisallowed ne 'F'
5238: && $thisallowed ne '2'
5239: && &is_portfolio_url($uri)) {
5240: $thisallowed = &portfolio_access($uri);
5241: }
5242:
1.52 www 5243: # Full access at system, domain or course-wide level? Exit.
1.29 www 5244: if ($thisallowed=~/F/) {
5245: return 'F';
5246: }
5247:
1.52 www 5248: # If this is generating or modifying users, exit with special codes
1.29 www 5249:
1.643 www 5250: if (':csu:cdc:ccc:cin:cta:cep:ccr:cst:cad:cli:cau:cdg:cca:caa:'=~/\:\Q$priv\E\:/) {
5251: if (($priv eq 'cca') || ($priv eq 'caa')) {
1.642 albertel 5252: my ($audom,$auname)=split('/',$uri);
1.643 www 5253: # no author name given, so this just checks on the general right to make a co-author in this domain
5254: unless ($auname) { return $thisallowed; }
5255: # an author name is given, so we are about to actually make a co-author for a certain account
1.642 albertel 5256: if (($auname ne $env{'user.name'} && $env{'request.role'} !~ /^dc\./) ||
5257: (($audom ne $env{'user.domain'} && $env{'request.role'} !~ /^dc\./) &&
5258: ($audom ne $env{'request.role.domain'}))) { return ''; }
5259: }
1.52 www 5260: return $thisallowed;
5261: }
5262: #
1.103 harris41 5263: # Gathered so far: system, domain and course wide privileges
1.52 www 5264: #
5265: # Course: See if uri or referer is an individual resource that is part of
5266: # the course
5267:
1.620 albertel 5268: if ($env{'request.course.id'}) {
1.232 www 5269:
1.620 albertel 5270: $courseprivid=$env{'request.course.id'};
5271: if ($env{'request.course.sec'}) {
5272: $courseprivid.='/'.$env{'request.course.sec'};
1.52 www 5273: }
5274: $courseprivid=~s/\_/\//;
5275: my $checkreferer=1;
1.232 www 5276: my ($match,$cond)=&is_on_map($uri);
5277: if ($match) {
5278: $statecond=$cond;
1.620 albertel 5279: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5280: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5281: $thisallowed.=$1;
5282: $checkreferer=0;
5283: }
1.29 www 5284: }
1.83 www 5285:
1.148 www 5286: if ($checkreferer) {
1.620 albertel 5287: my $refuri=$env{'httpref.'.$orguri};
1.148 www 5288: unless ($refuri) {
1.800 albertel 5289: foreach my $key (keys(%env)) {
5290: if ($key=~/^httpref\..*\*/) {
5291: my $pattern=$key;
1.156 www 5292: $pattern=~s/^httpref\.\/res\///;
1.148 www 5293: $pattern=~s/\*/\[\^\/\]\+/g;
5294: $pattern=~s/\//\\\//g;
1.152 www 5295: if ($orguri=~/$pattern/) {
1.800 albertel 5296: $refuri=$env{$key};
1.148 www 5297: }
5298: }
1.191 harris41 5299: }
1.148 www 5300: }
1.232 www 5301:
1.148 www 5302: if ($refuri) {
1.152 www 5303: $refuri=&declutter($refuri);
1.232 www 5304: my ($match,$cond)=&is_on_map($refuri);
5305: if ($match) {
5306: my $refstatecond=$cond;
1.620 albertel 5307: if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
1.479 albertel 5308: =~/\Q$priv\E\&([^\:]*)/) {
1.52 www 5309: $thisallowed.=$1;
1.53 www 5310: $uri=$refuri;
5311: $statecond=$refstatecond;
1.52 www 5312: }
5313: }
1.148 www 5314: }
1.29 www 5315: }
1.52 www 5316: }
1.29 www 5317:
1.52 www 5318: #
1.103 harris41 5319: # Gathered now: all privileges that could apply, and condition number
1.52 www 5320: #
5321: #
5322: # Full or no access?
5323: #
1.29 www 5324:
1.52 www 5325: if ($thisallowed=~/F/) {
5326: return 'F';
5327: }
1.29 www 5328:
1.52 www 5329: unless ($thisallowed) {
5330: return '';
5331: }
1.29 www 5332:
1.52 www 5333: # Restrictions exist, deal with them
5334: #
5335: # C:according to course preferences
5336: # R:according to resource settings
5337: # L:unless locked
5338: # X:according to user session state
5339: #
5340:
5341: # Possibly locked functionality, check all courses
1.54 www 5342: # Locks might take effect only after 10 minutes cache expiration for other
5343: # courses, and 2 minutes for current course
1.52 www 5344:
5345: my $envkey;
5346: if ($thisallowed=~/L/) {
1.1000 raeburn 5347: foreach $envkey (keys(%env)) {
1.54 www 5348: if ($envkey=~/^user\.role\.(st|ta)\.([^\.]*)/) {
5349: my $courseid=$2;
5350: my $roleid=$1.'.'.$2;
1.92 www 5351: $courseid=~s/^\///;
1.54 www 5352: my $expiretime=600;
1.620 albertel 5353: if ($env{'request.role'} eq $roleid) {
1.54 www 5354: $expiretime=120;
5355: }
5356: my ($cdom,$cnum,$csec)=split(/\//,$courseid);
5357: my $prefix='course.'.$cdom.'_'.$cnum.'.';
1.620 albertel 5358: if ((time-$env{$prefix.'last_cache'})>$expiretime) {
1.731 albertel 5359: &coursedescription($courseid,{'freshen_cache' => 1});
1.54 www 5360: }
1.620 albertel 5361: if (($env{$prefix.'res.'.$uri.'.lock.sections'}=~/\,\Q$csec\E\,/)
5362: || ($env{$prefix.'res.'.$uri.'.lock.sections'} eq 'all')) {
5363: if ($env{$prefix.'res.'.$uri.'.lock.expire'}>time) {
5364: &log($env{'user.domain'},$env{'user.name'},
5365: $env{'user.home'},
1.57 www 5366: 'Locked by res: '.$priv.' for '.$uri.' due to '.
1.52 www 5367: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5368: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5369: return '';
5370: }
5371: }
1.620 albertel 5372: if (($env{$prefix.'priv.'.$priv.'.lock.sections'}=~/\,\Q$csec\E\,/)
5373: || ($env{$prefix.'priv.'.$priv.'.lock.sections'} eq 'all')) {
5374: if ($env{'priv.'.$priv.'.lock.expire'}>time) {
5375: &log($env{'user.domain'},$env{'user.name'},
5376: $env{'user.home'},
1.57 www 5377: 'Locked by priv: '.$priv.' for '.$uri.' due to '.
1.52 www 5378: $cdom.'/'.$cnum.'/'.$csec.' expire '.
1.620 albertel 5379: $env{$prefix.'priv.'.$priv.'.lock.expire'});
1.52 www 5380: return '';
5381: }
5382: }
5383: }
1.29 www 5384: }
1.52 www 5385: }
5386:
5387: #
5388: # Rest of the restrictions depend on selected course
5389: #
5390:
1.620 albertel 5391: unless ($env{'request.course.id'}) {
1.766 albertel 5392: if ($thisallowed eq 'A') {
5393: return 'A';
1.814 raeburn 5394: } elsif ($thisallowed eq 'B') {
5395: return 'B';
1.766 albertel 5396: } else {
5397: return '1';
5398: }
1.52 www 5399: }
1.29 www 5400:
1.52 www 5401: #
5402: # Now user is definitely in a course
5403: #
1.53 www 5404:
5405:
5406: # Course preferences
5407:
5408: if ($thisallowed=~/C/) {
1.620 albertel 5409: my $rolecode=(split(/\./,$env{'request.role'}))[0];
5410: my $unamedom=$env{'user.name'}.':'.$env{'user.domain'};
5411: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.roles.denied'}
1.479 albertel 5412: =~/\Q$rolecode\E/) {
1.689 albertel 5413: if ($priv ne 'pch') {
5414: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5415: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode.' in '.
5416: $env{'request.course.id'});
5417: }
1.237 www 5418: return '';
5419: }
5420:
1.620 albertel 5421: if ($env{'course.'.$env{'request.course.id'}.'.'.$priv.'.users.denied'}
1.479 albertel 5422: =~/\Q$unamedom\E/) {
1.689 albertel 5423: if ($priv ne 'pch') {
5424: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.
5425: 'Denied by user: '.$priv.' for '.$uri.' as '.$unamedom.' in '.
5426: $env{'request.course.id'});
5427: }
1.54 www 5428: return '';
5429: }
1.53 www 5430: }
5431:
5432: # Resource preferences
5433:
5434: if ($thisallowed=~/R/) {
1.620 albertel 5435: my $rolecode=(split(/\./,$env{'request.role'}))[0];
1.479 albertel 5436: if (&metadata($uri,'roledeny')=~/\Q$rolecode\E/) {
1.689 albertel 5437: if ($priv ne 'pch') {
5438: &logthis($env{'user.domain'}.':'.$env{'user.name'}.':'.$env{'user.home'}.':'.
5439: 'Denied by role: '.$priv.' for '.$uri.' as '.$rolecode);
5440: }
5441: return '';
1.54 www 5442: }
1.53 www 5443: }
1.30 www 5444:
1.246 www 5445: # Restricted by state or randomout?
1.30 www 5446:
1.52 www 5447: if ($thisallowed=~/X/) {
1.620 albertel 5448: if ($env{'acc.randomout'}) {
1.579 albertel 5449: if (!$symb) { $symb=&symbread($uri,1); }
1.620 albertel 5450: if (($symb) && ($env{'acc.randomout'}=~/\&\Q$symb\E\&/)) {
1.248 www 5451: return '';
5452: }
1.247 www 5453: }
5454: if (&condval($statecond)) {
1.52 www 5455: return '2';
5456: } else {
5457: return '';
5458: }
5459: }
1.30 www 5460:
1.766 albertel 5461: if ($thisallowed eq 'A') {
5462: return 'A';
1.814 raeburn 5463: } elsif ($thisallowed eq 'B') {
5464: return 'B';
1.766 albertel 5465: }
1.52 www 5466: return 'F';
1.232 www 5467: }
5468:
1.710 albertel 5469: sub split_uri_for_cond {
5470: my $uri=&deversion(&declutter(shift));
5471: my @uriparts=split(/\//,$uri);
5472: my $filename=pop(@uriparts);
5473: my $pathname=join('/',@uriparts);
5474: return ($pathname,$filename);
5475: }
1.232 www 5476: # --------------------------------------------------- Is a resource on the map?
5477:
5478: sub is_on_map {
1.710 albertel 5479: my ($pathname,$filename) = &split_uri_for_cond(shift);
1.289 bowersj2 5480: #Trying to find the conditional for the file
1.620 albertel 5481: my $match=($env{'acc.res.'.$env{'request.course.id'}.'.'.$pathname}=~
1.289 bowersj2 5482: /\&\Q$filename\E\:([\d\|]+)\&/);
1.232 www 5483: if ($match) {
1.289 bowersj2 5484: return (1,$1);
5485: } else {
1.434 www 5486: return (0,0);
1.289 bowersj2 5487: }
1.12 www 5488: }
5489:
1.427 www 5490: # --------------------------------------------------------- Get symb from alias
5491:
5492: sub get_symb_from_alias {
5493: my $symb=shift;
5494: my ($map,$resid,$url)=&decode_symb($symb);
5495: # Already is a symb
5496: if ($url) { return $symb; }
5497: # Must be an alias
5498: my $aliassymb='';
5499: my %bighash;
1.620 albertel 5500: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.427 www 5501: &GDBM_READER(),0640)) {
5502: my $rid=$bighash{'mapalias_'.$symb};
5503: if ($rid) {
5504: my ($mapid,$resid)=split(/\./,$rid);
1.429 albertel 5505: $aliassymb=&encode_symb($bighash{'map_id_'.$mapid},
5506: $resid,$bighash{'src_'.$rid});
1.427 www 5507: }
5508: untie %bighash;
5509: }
5510: return $aliassymb;
5511: }
5512:
1.12 www 5513: # ----------------------------------------------------------------- Define Role
5514:
5515: sub definerole {
5516: if (allowed('mcr','/')) {
5517: my ($rolename,$sysrole,$domrole,$courole)=@_;
1.800 albertel 5518: foreach my $role (split(':',$sysrole)) {
5519: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5520: if ($pr{'cr:s'}!~/\Q$crole\E/) { return "refused:s:$crole"; }
5521: if ($pr{'cr:s'}=~/\Q$crole\E\&/) {
5522: if ($pr{'cr:s'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5523: return "refused:s:$crole&$cqual";
5524: }
5525: }
1.191 harris41 5526: }
1.800 albertel 5527: foreach my $role (split(':',$domrole)) {
5528: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5529: if ($pr{'cr:d'}!~/\Q$crole\E/) { return "refused:d:$crole"; }
5530: if ($pr{'cr:d'}=~/\Q$crole\E\&/) {
5531: if ($pr{'cr:d'}!~/\Q$crole\W\&\w*\Q$cqual\E/) {
1.21 www 5532: return "refused:d:$crole&$cqual";
5533: }
5534: }
1.191 harris41 5535: }
1.800 albertel 5536: foreach my $role (split(':',$courole)) {
5537: my ($crole,$cqual)=split(/\&/,$role);
1.479 albertel 5538: if ($pr{'cr:c'}!~/\Q$crole\E/) { return "refused:c:$crole"; }
5539: if ($pr{'cr:c'}=~/\Q$crole\E\&/) {
5540: if ($pr{'cr:c'}!~/\Q$crole\E\&\w*\Q$cqual\E/) {
1.21 www 5541: return "refused:c:$crole&$cqual";
5542: }
5543: }
1.191 harris41 5544: }
1.620 albertel 5545: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
5546: "$env{'user.domain'}:$env{'user.name'}:".
1.21 www 5547: "rolesdef_$rolename=".
5548: escape($sysrole.'_'.$domrole.'_'.$courole);
1.620 albertel 5549: return reply($command,$env{'user.home'});
1.12 www 5550: } else {
5551: return 'refused';
5552: }
1.105 harris41 5553: }
5554:
5555: # ---------------- Make a metadata query against the network of library servers
5556:
5557: sub metadata_query {
1.244 matthew 5558: my ($query,$custom,$customshow,$server_array)=@_;
1.120 harris41 5559: my %rhash;
1.845 albertel 5560: my %libserv = &all_library();
1.244 matthew 5561: my @server_list = (defined($server_array) ? @$server_array
5562: : keys(%libserv) );
5563: for my $server (@server_list) {
1.118 harris41 5564: unless ($custom or $customshow) {
5565: my $reply=&reply("querysend:".&escape($query),$server);
5566: $rhash{$server}=$reply;
5567: }
5568: else {
5569: my $reply=&reply("querysend:".&escape($query).':'.
5570: &escape($custom).':'.&escape($customshow),
5571: $server);
5572: $rhash{$server}=$reply;
5573: }
1.112 harris41 5574: }
1.118 harris41 5575: return \%rhash;
1.240 www 5576: }
5577:
5578: # ----------------------------------------- Send log queries and wait for reply
5579:
5580: sub log_query {
5581: my ($uname,$udom,$query,%filters)=@_;
5582: my $uhome=&homeserver($uname,$udom);
5583: if ($uhome eq 'no_host') { return 'error: no_host'; }
1.838 albertel 5584: my $uhost=&hostname($uhome);
1.800 albertel 5585: my $command=&escape(join(':',map{$_.'='.$filters{$_}} keys(%filters)));
1.240 www 5586: my $queryid=&reply("querysend:".$query.':'.$udom.':'.$uname.':'.$command,
5587: $uhome);
1.479 albertel 5588: unless ($queryid=~/^\Q$uhost\E\_/) { return 'error: '.$queryid; }
1.242 www 5589: return get_query_reply($queryid);
5590: }
5591:
1.818 raeburn 5592: # -------------------------- Update MySQL table for portfolio file
5593:
5594: sub update_portfolio_table {
1.821 raeburn 5595: my ($uname,$udom,$file_name,$query,$group,$action) = @_;
1.970 raeburn 5596: if ($group ne '') {
5597: $file_name =~s /^\Q$group\E//;
5598: }
1.818 raeburn 5599: my $homeserver = &homeserver($uname,$udom);
5600: my $queryid=
1.821 raeburn 5601: &reply("querysend:".$query.':'.&escape($uname.':'.$udom.':'.$group).
5602: ':'.&escape($file_name).':'.$action,$homeserver);
1.818 raeburn 5603: my $reply = &get_query_reply($queryid);
5604: return $reply;
5605: }
5606:
1.899 raeburn 5607: # -------------------------- Update MySQL allusers table
5608:
5609: sub update_allusers_table {
5610: my ($uname,$udom,$names) = @_;
5611: my $homeserver = &homeserver($uname,$udom);
5612: my $queryid=
5613: &reply('querysend:allusers:'.&escape($uname).':'.&escape($udom).':'.
5614: 'lastname='.&escape($names->{'lastname'}).'%%'.
5615: 'firstname='.&escape($names->{'firstname'}).'%%'.
5616: 'middlename='.&escape($names->{'middlename'}).'%%'.
5617: 'generation='.&escape($names->{'generation'}).'%%'.
5618: 'permanentemail='.&escape($names->{'permanentemail'}).'%%'.
5619: 'id='.&escape($names->{'id'}),$homeserver);
5620: my $reply = &get_query_reply($queryid);
5621: return $reply;
5622: }
5623:
1.508 raeburn 5624: # ------- Request retrieval of institutional classlists for course(s)
1.506 raeburn 5625:
5626: sub fetch_enrollment_query {
1.511 raeburn 5627: my ($context,$affiliatesref,$replyref,$dom,$cnum) = @_;
1.508 raeburn 5628: my $homeserver;
1.547 raeburn 5629: my $maxtries = 1;
1.508 raeburn 5630: if ($context eq 'automated') {
5631: $homeserver = $perlvar{'lonHostID'};
1.547 raeburn 5632: $maxtries = 10; # will wait for up to 2000s for retrieval of classlist data before timeout
1.508 raeburn 5633: } else {
5634: $homeserver = &homeserver($cnum,$dom);
5635: }
1.838 albertel 5636: my $host=&hostname($homeserver);
1.506 raeburn 5637: my $cmd = '';
1.1000 raeburn 5638: foreach my $affiliate (keys(%{$affiliatesref})) {
1.800 albertel 5639: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.506 raeburn 5640: }
5641: $cmd =~ s/%%$//;
5642: $cmd = &escape($cmd);
5643: my $query = 'fetchenrollment';
1.620 albertel 5644: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$env{'user.name'}.':'.$cmd,$homeserver);
1.526 raeburn 5645: unless ($queryid=~/^\Q$host\E\_/) {
5646: &logthis('fetch_enrollment_query: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' context: '.$context.' '.$cnum);
5647: return 'error: '.$queryid;
5648: }
1.506 raeburn 5649: my $reply = &get_query_reply($queryid);
1.547 raeburn 5650: my $tries = 1;
5651: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5652: $reply = &get_query_reply($queryid);
5653: $tries ++;
5654: }
1.526 raeburn 5655: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
1.620 albertel 5656: &logthis('fetch_enrollment_query error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' context: '.$context.' '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
1.526 raeburn 5657: } else {
1.901 albertel 5658: my @responses = split(/:/,$reply);
1.515 raeburn 5659: if ($homeserver eq $perlvar{'lonHostID'}) {
1.800 albertel 5660: foreach my $line (@responses) {
5661: my ($key,$value) = split(/=/,$line,2);
1.515 raeburn 5662: $$replyref{$key} = $value;
5663: }
5664: } else {
1.506 raeburn 5665: my $pathname = $perlvar{'lonDaemons'}.'/tmp';
1.800 albertel 5666: foreach my $line (@responses) {
5667: my ($key,$value) = split(/=/,$line);
1.506 raeburn 5668: $$replyref{$key} = $value;
5669: if ($value > 0) {
1.800 albertel 5670: foreach my $item (@{$$affiliatesref{$key}}) {
5671: my $filename = $dom.'_'.$key.'_'.$item.'_classlist.xml';
1.506 raeburn 5672: my $destname = $pathname.'/'.$filename;
5673: my $xml_classlist = &reply("autoretrieve:".$filename,$homeserver);
1.526 raeburn 5674: if ($xml_classlist =~ /^error/) {
5675: &logthis('fetch_enrollment_query - autoretrieve error: '.$xml_classlist.' for '.$filename.' from server: '.$homeserver.' '.$context.' '.$cnum);
5676: } else {
1.506 raeburn 5677: if ( open(FILE,">$destname") ) {
5678: print FILE &unescape($xml_classlist);
5679: close(FILE);
1.526 raeburn 5680: } else {
5681: &logthis('fetch_enrollment_query - error opening classlist file '.$destname.' '.$context.' '.$cnum);
1.506 raeburn 5682: }
5683: }
5684: }
5685: }
5686: }
5687: }
5688: return 'ok';
5689: }
5690: return 'error';
5691: }
5692:
1.242 www 5693: sub get_query_reply {
5694: my $queryid=shift;
1.240 www 5695: my $replyfile=$perlvar{'lonDaemons'}.'/tmp/'.$queryid;
5696: my $reply='';
5697: for (1..100) {
5698: sleep 2;
5699: if (-e $replyfile.'.end') {
1.448 albertel 5700: if (open(my $fh,$replyfile)) {
1.904 albertel 5701: $reply = join('',<$fh>);
5702: close($fh);
1.240 www 5703: } else { return 'error: reply_file_error'; }
1.242 www 5704: return &unescape($reply);
5705: }
1.240 www 5706: }
1.242 www 5707: return 'timeout:'.$queryid;
1.240 www 5708: }
5709:
5710: sub courselog_query {
1.241 www 5711: #
5712: # possible filters:
5713: # url: url or symb
5714: # username
5715: # domain
5716: # action: view, submit, grade
5717: # start: timestamp
5718: # end: timestamp
5719: #
1.240 www 5720: my (%filters)=@_;
1.620 albertel 5721: unless ($env{'request.course.id'}) { return 'no_course'; }
1.241 www 5722: if ($filters{'url'}) {
5723: $filters{'url'}=&symbclean(&declutter($filters{'url'}));
5724: $filters{'url'}=~s/\.(\w+)$/(\\.\\d+)*\\.$1/;
5725: $filters{'url'}=~s/\.(\w+)\_\_\_/(\\.\\d+)*\\.$1/;
5726: }
1.620 albertel 5727: my $cname=$env{'course.'.$env{'request.course.id'}.'.num'};
5728: my $cdom=$env{'course.'.$env{'request.course.id'}.'.domain'};
1.240 www 5729: return &log_query($cname,$cdom,'courselog',%filters);
5730: }
5731:
5732: sub userlog_query {
1.858 raeburn 5733: #
5734: # possible filters:
5735: # action: log check role
5736: # start: timestamp
5737: # end: timestamp
5738: #
1.240 www 5739: my ($uname,$udom,%filters)=@_;
5740: return &log_query($uname,$udom,'userlog',%filters);
1.12 www 5741: }
5742:
1.506 raeburn 5743: #--------- Call auto-enrollment subs in localenroll.pm for homeserver for course
5744:
5745: sub auto_run {
1.508 raeburn 5746: my ($cnum,$cdom) = @_;
1.876 raeburn 5747: my $response = 0;
5748: my $settings;
5749: my %domconfig = &get_dom('configuration',['autoenroll'],$cdom);
5750: if (ref($domconfig{'autoenroll'}) eq 'HASH') {
5751: $settings = $domconfig{'autoenroll'};
5752: if ($settings->{'run'} eq '1') {
5753: $response = 1;
5754: }
5755: } else {
1.934 raeburn 5756: my $homeserver;
5757: if (&is_course($cdom,$cnum)) {
5758: $homeserver = &homeserver($cnum,$cdom);
5759: } else {
5760: $homeserver = &domain($cdom,'primary');
5761: }
5762: if ($homeserver ne 'no_host') {
5763: $response = &reply('autorun:'.$cdom,$homeserver);
5764: }
1.876 raeburn 5765: }
1.506 raeburn 5766: return $response;
5767: }
1.776 albertel 5768:
1.506 raeburn 5769: sub auto_get_sections {
1.508 raeburn 5770: my ($cnum,$cdom,$inst_coursecode) = @_;
1.1007 raeburn 5771: my $homeserver;
5772: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5773: $homeserver = &homeserver($cnum,$cdom);
5774: }
5775: if (!defined($homeserver)) {
5776: if ($cdom =~ /^$match_domain$/) {
5777: $homeserver = &domain($cdom,'primary');
5778: }
5779: }
5780: my @secs;
5781: if (defined($homeserver)) {
5782: my $response=&unescape(&reply('autogetsections:'.$inst_coursecode.':'.$cdom,$homeserver));
5783: unless ($response eq 'refused') {
5784: @secs = split(/:/,$response);
5785: }
1.506 raeburn 5786: }
5787: return @secs;
5788: }
1.776 albertel 5789:
1.506 raeburn 5790: sub auto_new_course {
1.508 raeburn 5791: my ($cnum,$cdom,$inst_course_id,$owner) = @_;
5792: my $homeserver = &homeserver($cnum,$cdom);
1.515 raeburn 5793: my $response=&unescape(&reply('autonewcourse:'.$inst_course_id.':'.$owner.':'.$cdom,$homeserver));
1.506 raeburn 5794: return $response;
5795: }
1.776 albertel 5796:
1.506 raeburn 5797: sub auto_validate_courseID {
1.508 raeburn 5798: my ($cnum,$cdom,$inst_course_id) = @_;
5799: my $homeserver = &homeserver($cnum,$cdom);
1.511 raeburn 5800: my $response=&unescape(&reply('autovalidatecourse:'.$inst_course_id.':'.$cdom,$homeserver));
1.506 raeburn 5801: return $response;
5802: }
1.776 albertel 5803:
1.1007 raeburn 5804: sub auto_validate_instcode {
1.1020 raeburn 5805: my ($cnum,$cdom,$instcode,$owner) = @_;
1.1007 raeburn 5806: my ($homeserver,$response);
5807: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5808: $homeserver = &homeserver($cnum,$cdom);
5809: }
5810: if (!defined($homeserver)) {
5811: if ($cdom =~ /^$match_domain$/) {
5812: $homeserver = &domain($cdom,'primary');
5813: }
5814: }
5815: my $response=&unescape(&reply('autovalidateinstcode:'.$cdom.':'.
1.1020 raeburn 5816: &escape($instcode).':'.&escape($owner),$homeserver));
1.1027 raeburn 5817: my ($outcome,$description) = map { &unescape($_); } split('&',$response,2);
5818: return ($outcome,$description);
1.1007 raeburn 5819: }
5820:
1.506 raeburn 5821: sub auto_create_password {
1.873 raeburn 5822: my ($cnum,$cdom,$authparam,$udom) = @_;
5823: my ($homeserver,$response);
1.506 raeburn 5824: my $create_passwd = 0;
5825: my $authchk = '';
1.873 raeburn 5826: if ($udom =~ /^$match_domain$/) {
5827: $homeserver = &domain($udom,'primary');
5828: }
5829: if ($homeserver eq '') {
5830: if (($cdom =~ /^$match_domain$/) && ($cnum =~ /^$match_courseid$/)) {
5831: $homeserver = &homeserver($cnum,$cdom);
5832: }
5833: }
5834: if ($homeserver eq '') {
5835: $authchk = 'nodomain';
1.506 raeburn 5836: } else {
1.873 raeburn 5837: $response=&unescape(&reply('autocreatepassword:'.$authparam.':'.$cdom,$homeserver));
5838: if ($response eq 'refused') {
5839: $authchk = 'refused';
5840: } else {
1.901 albertel 5841: ($authparam,$create_passwd,$authchk) = split(/:/,$response);
1.873 raeburn 5842: }
1.506 raeburn 5843: }
5844: return ($authparam,$create_passwd,$authchk);
5845: }
5846:
1.706 raeburn 5847: sub auto_photo_permission {
5848: my ($cnum,$cdom,$students) = @_;
5849: my $homeserver = &homeserver($cnum,$cdom);
1.707 albertel 5850: my ($outcome,$perm_reqd,$conditions) =
5851: split(/:/,&unescape(&reply('autophotopermission:'.$cdom,$homeserver)),3);
1.709 albertel 5852: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5853: return (undef,undef);
5854: }
1.706 raeburn 5855: return ($outcome,$perm_reqd,$conditions);
5856: }
5857:
5858: sub auto_checkphotos {
5859: my ($uname,$udom,$pid) = @_;
5860: my $homeserver = &homeserver($uname,$udom);
5861: my ($result,$resulttype);
5862: my $outcome = &unescape(&reply('autophotocheck:'.&escape($udom).':'.
1.707 albertel 5863: &escape($uname).':'.&escape($pid),
5864: $homeserver));
1.709 albertel 5865: if ($outcome =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5866: return (undef,undef);
5867: }
1.706 raeburn 5868: if ($outcome) {
5869: ($result,$resulttype) = split(/:/,$outcome);
5870: }
5871: return ($result,$resulttype);
5872: }
5873:
5874: sub auto_photochoice {
5875: my ($cnum,$cdom) = @_;
5876: my $homeserver = &homeserver($cnum,$cdom);
5877: my ($update,$comment) = split(/:/,&unescape(&reply('autophotochoice:'.
1.707 albertel 5878: &escape($cdom),
5879: $homeserver)));
1.709 albertel 5880: if ($update =~ /^(con_lost|unknown_cmd|no_such_host)$/) {
5881: return (undef,undef);
5882: }
1.706 raeburn 5883: return ($update,$comment);
5884: }
5885:
5886: sub auto_photoupdate {
5887: my ($affiliatesref,$dom,$cnum,$photo) = @_;
5888: my $homeserver = &homeserver($cnum,$dom);
1.838 albertel 5889: my $host=&hostname($homeserver);
1.706 raeburn 5890: my $cmd = '';
5891: my $maxtries = 1;
1.800 albertel 5892: foreach my $affiliate (keys(%{$affiliatesref})) {
5893: $cmd .= $affiliate.'='.join(",",@{$$affiliatesref{$affiliate}}).'%%';
1.706 raeburn 5894: }
5895: $cmd =~ s/%%$//;
5896: $cmd = &escape($cmd);
5897: my $query = 'institutionalphotos';
5898: my $queryid=&reply("querysend:".$query.':'.$dom.':'.$cnum.':'.$cmd,$homeserver);
5899: unless ($queryid=~/^\Q$host\E\_/) {
5900: &logthis('institutionalphotos: invalid queryid: '.$queryid.' for host: '.$host.' and homeserver: '.$homeserver.' and course: '.$cnum);
5901: return 'error: '.$queryid;
5902: }
5903: my $reply = &get_query_reply($queryid);
5904: my $tries = 1;
5905: while (($reply=~/^timeout/) && ($tries < $maxtries)) {
5906: $reply = &get_query_reply($queryid);
5907: $tries ++;
5908: }
5909: if ( ($reply =~/^timeout/) || ($reply =~/^error/) ) {
5910: &logthis('institutionalphotos error: '.$reply.' for '.$dom.' '.$env{'user.name'}.' for '.$queryid.' course: '.$cnum.' maxtries: '.$maxtries.' tries: '.$tries);
5911: } else {
5912: my @responses = split(/:/,$reply);
5913: my $outcome = shift(@responses);
5914: foreach my $item (@responses) {
5915: my ($key,$value) = split(/=/,$item);
5916: $$photo{$key} = $value;
5917: }
5918: return $outcome;
5919: }
5920: return 'error';
5921: }
5922:
1.521 raeburn 5923: sub auto_instcode_format {
1.793 albertel 5924: my ($caller,$codedom,$instcodes,$codes,$codetitles,$cat_titles,
5925: $cat_order) = @_;
1.521 raeburn 5926: my $courses = '';
1.772 raeburn 5927: my @homeservers;
1.521 raeburn 5928: if ($caller eq 'global') {
1.841 albertel 5929: my %servers = &get_servers($codedom,'library');
5930: foreach my $tryserver (keys(%servers)) {
5931: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5932: push(@homeservers,$tryserver);
5933: }
1.584 raeburn 5934: }
1.1022 raeburn 5935: } elsif ($caller eq 'requests') {
5936: if ($codedom =~ /^$match_domain$/) {
5937: my $chome = &domain($codedom,'primary');
5938: unless ($chome eq 'no_host') {
5939: push(@homeservers,$chome);
5940: }
5941: }
1.521 raeburn 5942: } else {
1.772 raeburn 5943: push(@homeservers,&homeserver($caller,$codedom));
1.521 raeburn 5944: }
1.793 albertel 5945: foreach my $code (keys(%{$instcodes})) {
5946: $courses .= &escape($code).'='.&escape($$instcodes{$code}).'&';
1.521 raeburn 5947: }
5948: chop($courses);
1.772 raeburn 5949: my $ok_response = 0;
5950: my $response;
5951: while (@homeservers > 0 && $ok_response == 0) {
5952: my $server = shift(@homeservers);
5953: $response=&reply('autoinstcodeformat:'.$codedom.':'.$courses,$server);
5954: if ($response !~ /(con_lost|error|no_such_host|refused)/) {
5955: my ($codes_str,$codetitles_str,$cat_titles_str,$cat_order_str) =
1.901 albertel 5956: split(/:/,$response);
1.772 raeburn 5957: %{$codes} = (%{$codes},&str2hash($codes_str));
5958: push(@{$codetitles},&str2array($codetitles_str));
5959: %{$cat_titles} = (%{$cat_titles},&str2hash($cat_titles_str));
5960: %{$cat_order} = (%{$cat_order},&str2hash($cat_order_str));
5961: $ok_response = 1;
5962: }
5963: }
5964: if ($ok_response) {
1.521 raeburn 5965: return 'ok';
1.772 raeburn 5966: } else {
5967: return $response;
1.521 raeburn 5968: }
5969: }
5970:
1.792 raeburn 5971: sub auto_instcode_defaults {
5972: my ($domain,$returnhash,$code_order) = @_;
5973: my @homeservers;
1.841 albertel 5974:
5975: my %servers = &get_servers($domain,'library');
5976: foreach my $tryserver (keys(%servers)) {
5977: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
5978: push(@homeservers,$tryserver);
5979: }
1.792 raeburn 5980: }
1.841 albertel 5981:
1.792 raeburn 5982: my $response;
1.841 albertel 5983: foreach my $server (@homeservers) {
1.792 raeburn 5984: $response=&reply('autoinstcodedefaults:'.$domain,$server);
1.841 albertel 5985: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
5986:
5987: foreach my $pair (split(/\&/,$response)) {
5988: my ($name,$value)=split(/\=/,$pair);
5989: if ($name eq 'code_order') {
5990: @{$code_order} = split(/\&/,&unescape($value));
5991: } else {
5992: $returnhash->{&unescape($name)}=&unescape($value);
5993: }
5994: }
5995: return 'ok';
1.792 raeburn 5996: }
1.841 albertel 5997:
5998: return $response;
1.1003 raeburn 5999: }
6000:
6001: sub auto_possible_instcodes {
1.1007 raeburn 6002: my ($domain,$codetitles,$cat_titles,$cat_orders,$code_order) = @_;
6003: unless ((ref($codetitles) eq 'ARRAY') && (ref($cat_titles) eq 'HASH') &&
6004: (ref($cat_orders) eq 'HASH') && (ref($code_order) eq 'ARRAY')) {
6005: return;
6006: }
1.1003 raeburn 6007: my (@homeservers,$uhome);
6008: if (defined(&domain($domain,'primary'))) {
6009: $uhome=&domain($domain,'primary');
6010: push(@homeservers,&domain($domain,'primary'));
6011: } else {
6012: my %servers = &get_servers($domain,'library');
6013: foreach my $tryserver (keys(%servers)) {
6014: if (!grep(/^\Q$tryserver\E$/,@homeservers)) {
6015: push(@homeservers,$tryserver);
6016: }
6017: }
6018: }
6019: my $response;
6020: foreach my $server (@homeservers) {
6021: $response=&reply('autopossibleinstcodes:'.$domain,$server);
6022: next if ($response =~ /(con_lost|error|no_such_host|refused)/);
1.1007 raeburn 6023: my ($codetitlestr,$codeorderstr,$cat_title,$cat_order) =
6024: split(':',$response);
6025: @{$codetitles} = map { &unescape($_); } (split('&',$codetitlestr));
6026: @{$code_order} = map { &unescape($_); } (split('&',$codeorderstr));
1.1003 raeburn 6027: foreach my $item (split('&',$cat_title)) {
1.1005 raeburn 6028: my ($name,$value)=split('=',$item);
6029: $cat_titles->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 6030: }
6031: foreach my $item (split('&',$cat_order)) {
1.1005 raeburn 6032: my ($name,$value)=split('=',$item);
6033: $cat_orders->{&unescape($name)}=&thaw_unescape($value);
1.1003 raeburn 6034: }
6035: return 'ok';
6036: }
6037: return $response;
6038: }
1.792 raeburn 6039:
1.1010 raeburn 6040: sub auto_courserequest_checks {
6041: my ($dom) = @_;
1.1020 raeburn 6042: my ($homeserver,%validations);
6043: if ($dom =~ /^$match_domain$/) {
6044: $homeserver = &domain($dom,'primary');
6045: }
6046: unless ($homeserver eq 'no_host') {
6047: my $response=&reply('autocrsreqchecks:'.$dom,$homeserver);
6048: unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
6049: my @items = split(/&/,$response);
6050: foreach my $item (@items) {
6051: my ($key,$value) = split('=',$item);
6052: $validations{&unescape($key)} = &thaw_unescape($value);
6053: }
6054: }
6055: }
1.1010 raeburn 6056: return %validations;
6057: }
6058:
1.1020 raeburn 6059: sub auto_courserequest_validation {
6060: my ($dom,$owner,$crstype,$inststatuslist,$instcode,$instseclist) = @_;
6061: my ($homeserver,$response);
6062: if ($dom =~ /^$match_domain$/) {
6063: $homeserver = &domain($dom,'primary');
6064: }
6065: unless ($homeserver eq 'no_host') {
1.1021 raeburn 6066:
1.1020 raeburn 6067: $response=&unescape(&reply('autocrsreqvalidation:'.$dom.':'.&escape($owner).
1.1021 raeburn 6068: ':'.&escape($crstype).':'.&escape($inststatuslist).
1.1020 raeburn 6069: ':'.&escape($instcode).':'.&escape($instseclist),
6070: $homeserver));
6071: }
6072: return $response;
6073: }
6074:
1.777 albertel 6075: sub auto_validate_class_sec {
1.918 raeburn 6076: my ($cdom,$cnum,$owners,$inst_class) = @_;
1.773 raeburn 6077: my $homeserver = &homeserver($cnum,$cdom);
1.918 raeburn 6078: my $ownerlist;
6079: if (ref($owners) eq 'ARRAY') {
6080: $ownerlist = join(',',@{$owners});
6081: } else {
6082: $ownerlist = $owners;
6083: }
1.773 raeburn 6084: my $response=&reply('autovalidateclass_sec:'.$inst_class.':'.
1.918 raeburn 6085: &escape($ownerlist).':'.$cdom,$homeserver);
1.773 raeburn 6086: return $response;
6087: }
6088:
1.679 raeburn 6089: # ------------------------------------------------------- Course Group routines
6090:
6091: sub get_coursegroups {
1.809 raeburn 6092: my ($cdom,$cnum,$group,$namespace) = @_;
6093: return(&dump($namespace,$cdom,$cnum,$group));
1.805 raeburn 6094: }
6095:
1.679 raeburn 6096: sub modify_coursegroup {
6097: my ($cdom,$cnum,$groupsettings) = @_;
6098: return(&put('coursegroups',$groupsettings,$cdom,$cnum));
6099: }
6100:
1.809 raeburn 6101: sub toggle_coursegroup_status {
6102: my ($cdom,$cnum,$group,$action) = @_;
6103: my ($from_namespace,$to_namespace);
6104: if ($action eq 'delete') {
6105: $from_namespace = 'coursegroups';
6106: $to_namespace = 'deleted_groups';
6107: } else {
6108: $from_namespace = 'deleted_groups';
6109: $to_namespace = 'coursegroups';
6110: }
6111: my %curr_group = &get_coursegroups($cdom,$cnum,$group,$from_namespace);
1.805 raeburn 6112: if (my $tmp = &error(%curr_group)) {
6113: &Apache::lonnet::logthis('Error retrieving group: '.$tmp.' in '.$cnum.':'.$cdom);
6114: return ('read error',$tmp);
6115: } else {
6116: my %savedsettings = %curr_group;
1.809 raeburn 6117: my $result = &put($to_namespace,\%savedsettings,$cdom,$cnum);
1.805 raeburn 6118: my $deloutcome;
6119: if ($result eq 'ok') {
1.809 raeburn 6120: $deloutcome = &del($from_namespace,[$group],$cdom,$cnum);
1.805 raeburn 6121: } else {
6122: return ('write error',$result);
6123: }
6124: if ($deloutcome eq 'ok') {
6125: return 'ok';
6126: } else {
6127: return ('delete error',$deloutcome);
6128: }
6129: }
6130: }
6131:
1.679 raeburn 6132: sub modify_group_roles {
1.957 raeburn 6133: my ($cdom,$cnum,$group_id,$user,$end,$start,$userprivs,$selfenroll,$context) = @_;
1.679 raeburn 6134: my $url = '/'.$cdom.'/'.$cnum.'/'.$group_id;
6135: my $role = 'gr/'.&escape($userprivs);
6136: my ($uname,$udom) = split(/:/,$user);
1.957 raeburn 6137: my $result = &assignrole($udom,$uname,$url,$role,$end,$start,'',$selfenroll,$context);
1.684 raeburn 6138: if ($result eq 'ok') {
6139: &devalidate_getgroups_cache($udom,$uname,$cdom,$cnum);
6140: }
1.679 raeburn 6141: return $result;
6142: }
6143:
6144: sub modify_coursegroup_membership {
6145: my ($cdom,$cnum,$membership) = @_;
6146: my $result = &put('groupmembership',$membership,$cdom,$cnum);
6147: return $result;
6148: }
6149:
1.682 raeburn 6150: sub get_active_groups {
6151: my ($udom,$uname,$cdom,$cnum) = @_;
6152: my $now = time;
6153: my %groups = ();
6154: foreach my $key (keys(%env)) {
1.811 albertel 6155: if ($key =~ m-user\.role\.gr\./($match_domain)/($match_courseid)/(\w+)$-) {
1.682 raeburn 6156: my ($start,$end) = split(/\./,$env{$key});
6157: if (($end!=0) && ($end<$now)) { next; }
6158: if (($start!=0) && ($start>$now)) { next; }
6159: if ($1 eq $cdom && $2 eq $cnum) {
6160: $groups{$3} = $env{$key} ;
6161: }
6162: }
6163: }
6164: return %groups;
6165: }
6166:
1.683 raeburn 6167: sub get_group_membership {
6168: my ($cdom,$cnum,$group) = @_;
6169: return(&dump('groupmembership',$cdom,$cnum,$group));
6170: }
6171:
6172: sub get_users_groups {
6173: my ($udom,$uname,$courseid) = @_;
1.733 raeburn 6174: my @usersgroups;
1.683 raeburn 6175: my $cachetime=1800;
6176:
6177: my $hashid="$udom:$uname:$courseid";
1.733 raeburn 6178: my ($grouplist,$cached)=&is_cached_new('getgroups',$hashid);
6179: if (defined($cached)) {
1.734 albertel 6180: @usersgroups = split(/:/,$grouplist);
1.733 raeburn 6181: } else {
6182: $grouplist = '';
1.816 raeburn 6183: my $courseurl = &courseid_to_courseurl($courseid);
6184: my %roleshash = &dump('roles',$udom,$uname,$courseurl);
1.817 raeburn 6185: my $access_end = $env{'course.'.$courseid.
6186: '.default_enrollment_end_date'};
6187: my $now = time;
6188: foreach my $key (keys(%roleshash)) {
6189: if ($key =~ /^\Q$courseurl\E\/(\w+)\_gr$/) {
6190: my $group = $1;
6191: if ($roleshash{$key} =~ /_(\d+)_(\d+)$/) {
6192: my $start = $2;
6193: my $end = $1;
6194: if ($start == -1) { next; } # deleted from group
6195: if (($start!=0) && ($start>$now)) { next; }
6196: if (($end!=0) && ($end<$now)) {
6197: if ($access_end && $access_end < $now) {
6198: if ($access_end - $end < 86400) {
6199: push(@usersgroups,$group);
1.733 raeburn 6200: }
6201: }
1.817 raeburn 6202: next;
1.733 raeburn 6203: }
1.817 raeburn 6204: push(@usersgroups,$group);
1.683 raeburn 6205: }
6206: }
6207: }
1.817 raeburn 6208: @usersgroups = &sort_course_groups($courseid,@usersgroups);
6209: $grouplist = join(':',@usersgroups);
6210: &do_cache_new('getgroups',$hashid,$grouplist,$cachetime);
1.683 raeburn 6211: }
1.733 raeburn 6212: return @usersgroups;
1.683 raeburn 6213: }
6214:
6215: sub devalidate_getgroups_cache {
6216: my ($udom,$uname,$cdom,$cnum)=@_;
6217: my $courseid = $cdom.'_'.$cnum;
1.807 albertel 6218:
1.683 raeburn 6219: my $hashid="$udom:$uname:$courseid";
6220: &devalidate_cache_new('getgroups',$hashid);
6221: }
6222:
1.12 www 6223: # ------------------------------------------------------------------ Plain Text
6224:
6225: sub plaintext {
1.988 raeburn 6226: my ($short,$type,$cid,$forcedefault) = @_;
1.1046 raeburn 6227: if ($short =~ m{^cr/}) {
1.758 albertel 6228: return (split('/',$short))[-1];
6229: }
1.742 raeburn 6230: if (!defined($cid)) {
6231: $cid = $env{'request.course.id'};
6232: }
6233: my %rolenames = (
1.1008 raeburn 6234: Course => 'std',
6235: Community => 'alt1',
1.742 raeburn 6236: );
1.1037 raeburn 6237: if ($cid ne '') {
6238: if ($env{'course.'.$cid.'.'.$short.'.plaintext'} ne '') {
6239: unless ($forcedefault) {
6240: my $roletext = $env{'course.'.$cid.'.'.$short.'.plaintext'};
6241: &Apache::lonlocal::mt_escape(\$roletext);
6242: return &Apache::lonlocal::mt($roletext);
6243: }
6244: }
6245: }
6246: if ((defined($type)) && (defined($rolenames{$type})) &&
6247: (defined($rolenames{$type})) &&
6248: (defined($prp{$short}{$rolenames{$type}}))) {
1.742 raeburn 6249: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$type}});
1.1037 raeburn 6250: } elsif ($cid ne '') {
6251: my $crstype = $env{'course.'.$cid.'.type'};
6252: if (($crstype ne '') && (defined($rolenames{$crstype})) &&
6253: (defined($prp{$short}{$rolenames{$crstype}}))) {
6254: return &Apache::lonlocal::mt($prp{$short}{$rolenames{$crstype}});
6255: }
1.742 raeburn 6256: }
1.1037 raeburn 6257: return &Apache::lonlocal::mt($prp{$short}{'std'});
1.12 www 6258: }
6259:
6260: # ----------------------------------------------------------------- Assign Role
6261:
6262: sub assignrole {
1.957 raeburn 6263: my ($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,
6264: $context)=@_;
1.21 www 6265: my $mrole;
6266: if ($role =~ /^cr\//) {
1.393 www 6267: my $cwosec=$url;
1.811 albertel 6268: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.393 www 6269: unless (&allowed('ccr',$cwosec)) {
1.1026 raeburn 6270: my $refused = 1;
6271: if ($context eq 'requestcourses') {
6272: if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
6273: if ($role =~ m{^cr/($match_domain)/($match_username)/([^/]+)$}) {
6274: if (($1 eq $env{'user.domain'}) && ($2 eq $env{'user.name'})) {
6275: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6276: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6277: if ($crsenv{'internal.courseowner'} eq
6278: $env{'user.name'}.':'.$env{'user.domain'}) {
6279: $refused = '';
6280: }
6281: }
6282: }
6283: }
6284: }
6285: if ($refused) {
6286: &logthis('Refused custom assignrole: '.
6287: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.
6288: ' by '.$env{'user.name'}.' at '.$env{'user.domain'});
6289: return 'refused';
6290: }
1.104 www 6291: }
1.21 www 6292: $mrole='cr';
1.678 raeburn 6293: } elsif ($role =~ /^gr\//) {
6294: my $cwogrp=$url;
1.811 albertel 6295: $cwogrp=~s{^/($match_domain)/($match_courseid)/.*}{$1/$2};
1.678 raeburn 6296: unless (&allowed('mdg',$cwogrp)) {
6297: &logthis('Refused group assignrole: '.
6298: $udom.' '.$uname.' '.$url.' '.$role.' '.$end.' '.$start.' by '.
6299: $env{'user.name'}.' at '.$env{'user.domain'});
6300: return 'refused';
6301: }
6302: $mrole='gr';
1.21 www 6303: } else {
1.82 www 6304: my $cwosec=$url;
1.811 albertel 6305: $cwosec=~s/^\/($match_domain)\/($match_courseid)\/.*/$1\/$2/;
1.932 raeburn 6306: if (!(&allowed('c'.$role,$cwosec)) && !(&allowed('c'.$role,$udom))) {
6307: my $refused;
6308: if (($env{'request.course.sec'} ne '') && ($role eq 'st')) {
6309: if (!(&allowed('c'.$role,$url))) {
6310: $refused = 1;
6311: }
6312: } else {
6313: $refused = 1;
6314: }
1.947 raeburn 6315: if ($refused) {
1.1045 raeburn 6316: my ($cdom,$cnum) = ($cwosec =~ m{^/?($match_domain)/($match_courseid)$});
6317: if (!$selfenroll && $context eq 'course') {
6318: my %crsenv;
6319: if ($role eq 'cc' || $role eq 'co') {
6320: %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6321: if (($role eq 'cc') && ($cnum !~ /^$match_community$/)) {
6322: if ($env{'request.role'} eq 'cc./'.$cdom.'/'.$cnum) {
6323: if ($crsenv{'internal.courseowner'} eq
6324: $env{'user.name'}.':'.$env{'user.domain'}) {
6325: $refused = '';
6326: }
6327: }
6328: } elsif (($role eq 'co') && ($cnum =~ /^$match_community$/)) {
6329: if ($env{'request.role'} eq 'co./'.$cdom.'/'.$cnum) {
6330: if ($crsenv{'internal.courseowner'} eq
6331: $env{'user.name'}.':'.$env{'user.domain'}) {
6332: $refused = '';
6333: }
6334: }
6335: }
6336: }
6337: } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
1.947 raeburn 6338: $refused = '';
1.1017 raeburn 6339: } elsif ($context eq 'requestcourses') {
1.1041 raeburn 6340: my @possroles = ('st','ta','ep','in','cc','co');
1.1026 raeburn 6341: if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
1.1041 raeburn 6342: my $wrongcc;
6343: if ($cnum =~ /^$match_community$/) {
6344: $wrongcc = 1 if ($role eq 'cc');
6345: } else {
6346: $wrongcc = 1 if ($role eq 'co');
6347: }
6348: unless ($wrongcc) {
6349: my %crsenv = &userenvironment($cdom,$cnum,('internal.courseowner'));
6350: if ($crsenv{'internal.courseowner'} eq
6351: $env{'user.name'}.':'.$env{'user.domain'}) {
6352: $refused = '';
6353: }
1.1017 raeburn 6354: }
6355: }
6356: }
6357: if ($refused) {
1.947 raeburn 6358: &logthis('Refused assignrole: '.$udom.' '.$uname.' '.$url.
6359: ' '.$role.' '.$end.' '.$start.' by '.
6360: $env{'user.name'}.' at '.$env{'user.domain'});
6361: return 'refused';
6362: }
1.932 raeburn 6363: }
1.104 www 6364: }
1.21 www 6365: $mrole=$role;
6366: }
1.620 albertel 6367: my $command="encrypt:rolesput:$env{'user.domain'}:$env{'user.name'}:".
1.21 www 6368: "$udom:$uname:$url".'_'."$mrole=$role";
1.81 www 6369: if ($end) { $command.='_'.$end; }
1.21 www 6370: if ($start) {
6371: if ($end) {
1.81 www 6372: $command.='_'.$start;
1.21 www 6373: } else {
1.81 www 6374: $command.='_0_'.$start;
1.21 www 6375: }
6376: }
1.739 raeburn 6377: my $origstart = $start;
6378: my $origend = $end;
1.957 raeburn 6379: my $delflag;
1.357 www 6380: # actually delete
6381: if ($deleteflag) {
1.373 www 6382: if ((&allowed('dro',$udom)) || (&allowed('dro',$url))) {
1.357 www 6383: # modify command to delete the role
1.620 albertel 6384: $command="encrypt:rolesdel:$env{'user.domain'}:$env{'user.name'}:".
1.357 www 6385: "$udom:$uname:$url".'_'."$mrole";
1.620 albertel 6386: &logthis("$env{'user.name'} at $env{'user.domain'} deletes $mrole in $url for $uname at $udom");
1.357 www 6387: # set start and finish to negative values for userrolelog
6388: $start=-1;
6389: $end=-1;
1.957 raeburn 6390: $delflag = 1;
1.357 www 6391: }
6392: }
6393: # send command
1.349 www 6394: my $answer=&reply($command,&homeserver($uname,$udom));
1.357 www 6395: # log new user role if status is ok
1.349 www 6396: if ($answer eq 'ok') {
1.663 raeburn 6397: &userrolelog($role,$uname,$udom,$url,$start,$end);
1.739 raeburn 6398: # for course roles, perform group memberships changes triggered by role change.
1.957 raeburn 6399: &courserolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,$selfenroll,$context);
1.739 raeburn 6400: unless ($role =~ /^gr/) {
6401: &Apache::longroup::group_changes($udom,$uname,$url,$role,$origend,
1.957 raeburn 6402: $origstart,$selfenroll,$context);
1.739 raeburn 6403: }
1.1053 raeburn 6404: if ($role eq 'cc') {
6405: &autoupdate_coowners($url,$end,$start,$uname,$udom);
6406: }
1.349 www 6407: }
6408: return $answer;
1.169 harris41 6409: }
6410:
1.1053 raeburn 6411: sub autoupdate_coowners {
6412: my ($url,$end,$start,$uname,$udom) = @_;
6413: my ($cdom,$cnum) = ($url =~ m{^/($match_domain)/($match_courseid)});
6414: if (($cdom ne '') && ($cnum ne '')) {
6415: my $now = time;
6416: my %domdesign = &Apache::loncommon::get_domainconf($cdom);
6417: if ($domdesign{$cdom.'.autoassign.co-owners'}) {
6418: my %coursehash = &coursedescription($cdom.'_'.$cnum);
6419: my $instcode = $coursehash{'internal.coursecode'};
6420: if ($instcode ne '') {
1.1056 raeburn 6421: if (($start && $start <= $now) && ($end == 0) || ($end > $now)) {
6422: unless ($coursehash{'internal.courseowner'} eq $uname.':'.$udom) {
1.1053 raeburn 6423: my ($delcoowners,@newcoowners,$putresult,$delresult,$coowners);
1.1056 raeburn 6424: my ($result,$desc) = &auto_validate_instcode($cnum,$cdom,$instcode,$uname.':'.$udom);
6425: if ($result eq 'valid') {
6426: if ($coursehash{'internal.co-owners'}) {
1.1053 raeburn 6427: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6428: push(@newcoowners,$coowner);
6429: }
6430: unless (grep(/^\Q$uname\E:\Q$udom\E$/,@newcoowners)) {
6431: push(@newcoowners,$uname.':'.$udom);
6432: }
6433: @newcoowners = sort(@newcoowners);
6434: } else {
6435: push(@newcoowners,$uname.':'.$udom);
6436: }
6437: } else {
6438: if ($coursehash{'internal.co-owners'}) {
6439: foreach my $coowner (split(',',$coursehash{'internal.co-owners'})) {
6440: unless ($coowner eq $uname.':'.$udom) {
6441: push(@newcoowners,$coowner);
6442: }
6443: }
6444: unless (@newcoowners > 0) {
6445: $delcoowners = 1;
6446: $coowners = '';
6447: }
6448: }
6449: }
6450: if (@newcoowners || $delcoowners) {
6451: &store_coowners($cdom,$cnum,$coursehash{'home'},
6452: $delcoowners,@newcoowners);
6453: }
6454: }
6455: }
6456: }
6457: }
6458: }
6459: }
6460:
6461: sub store_coowners {
6462: my ($cdom,$cnum,$chome,$delcoowners,@newcoowners) = @_;
6463: my $cid = $cdom.'_'.$cnum;
6464: my ($coowners,$delresult,$putresult);
6465: if (@newcoowners) {
6466: $coowners = join(',',@newcoowners);
6467: my %coownershash = (
6468: 'internal.co-owners' => $coowners,
6469: );
6470: $putresult = &put('environment',\%coownershash,$cdom,$cnum);
6471: if ($putresult eq 'ok') {
6472: if ($env{'course.'.$cid.'.num'} eq $cnum) {
6473: &appenv({'course.'.$cid.'.internal.co-owners' => $coowners});
6474: }
6475: }
6476: }
6477: if ($delcoowners) {
6478: $delresult = &Apache::lonnet::del('environment',['internal.co-owners'],$cdom,$cnum);
6479: if ($delresult eq 'ok') {
6480: if ($env{'course.'.$cid.'.internal.co-owners'}) {
6481: &Apache::lonnet::delenv('course.'.$cid.'.internal.co-owners');
6482: }
6483: }
6484: }
6485: if (($putresult eq 'ok') || ($delresult eq 'ok')) {
6486: my %crsinfo =
6487: &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,undef,undef,'.');
6488: if (ref($crsinfo{$cid}) eq 'HASH') {
6489: $crsinfo{$cid}{'co-owners'} = \@newcoowners;
6490: my $cidput = &Apache::lonnet::courseidput($cdom,\%crsinfo,$chome,'notime');
6491: }
6492: }
6493: }
6494:
1.169 harris41 6495: # -------------------------------------------------- Modify user authentication
1.197 www 6496: # Overrides without validation
6497:
1.169 harris41 6498: sub modifyuserauth {
6499: my ($udom,$uname,$umode,$upass)=@_;
6500: my $uhome=&homeserver($uname,$udom);
1.197 www 6501: unless (&allowed('mau',$udom)) { return 'refused'; }
6502: &logthis('Call to modify user authentication '.$udom.', '.$uname.', '.
1.620 albertel 6503: $umode.' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6504: ' in domain '.$env{'request.role.domain'});
1.169 harris41 6505: my $reply=&reply('encrypt:changeuserauth:'.$udom.':'.$uname.':'.$umode.':'.
6506: &escape($upass),$uhome);
1.620 albertel 6507: &log($env{'user.domain'},$env{'user.name'},$env{'user.home'},
1.197 www 6508: 'Authentication changed for '.$udom.', '.$uname.', '.$umode.
6509: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
6510: &log($udom,,$uname,$uhome,
1.620 albertel 6511: 'Authentication changed by '.$env{'user.domain'}.', '.
6512: $env{'user.name'}.', '.$umode.
1.197 www 6513: '(Remote '.$ENV{'REMOTE_ADDR'}.'): '.$reply);
1.169 harris41 6514: unless ($reply eq 'ok') {
1.197 www 6515: &logthis('Authentication mode error: '.$reply);
1.169 harris41 6516: return 'error: '.$reply;
6517: }
1.170 harris41 6518: return 'ok';
1.80 www 6519: }
6520:
1.81 www 6521: # --------------------------------------------------------------- Modify a user
1.80 www 6522:
1.81 www 6523: sub modifyuser {
1.206 matthew 6524: my ($udom, $uname, $uid,
6525: $umode, $upass, $first,
6526: $middle, $last, $gene,
1.1056.2.1 raeburn 6527: $forceid, $desiredhome, $email, $inststatus, $candelete)=@_;
1.807 albertel 6528: $udom= &LONCAPA::clean_domain($udom);
6529: $uname=&LONCAPA::clean_username($uname);
1.1056.2.1 raeburn 6530: my $showcandelete = 'none';
6531: if (ref($candelete) eq 'ARRAY') {
6532: if (@{$candelete} > 0) {
6533: $showcandelete = join(', ',@{$candelete});
6534: }
6535: }
1.81 www 6536: &logthis('Call to modify user '.$udom.', '.$uname.', '.$uid.', '.
1.80 www 6537: $umode.', '.$first.', '.$middle.', '.
1.1056.2.1 raeburn 6538: $last.', '.$gene.'(forceid: '.$forceid.'; candelete: '.$showcandelete.')'.
1.206 matthew 6539: (defined($desiredhome) ? ' desiredhome = '.$desiredhome :
6540: ' desiredhome not specified').
1.620 albertel 6541: ' by '.$env{'user.name'}.' at '.$env{'user.domain'}.
6542: ' in domain '.$env{'request.role.domain'});
1.230 stredwic 6543: my $uhome=&homeserver($uname,$udom,'true');
1.80 www 6544: # ----------------------------------------------------------------- Create User
1.406 albertel 6545: if (($uhome eq 'no_host') &&
6546: (($umode && $upass) || ($umode eq 'localauth'))) {
1.80 www 6547: my $unhome='';
1.844 albertel 6548: if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
1.209 matthew 6549: $unhome = $desiredhome;
1.620 albertel 6550: } elsif($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom) {
6551: $unhome=$env{'course.'.$env{'request.course.id'}.'.home'};
1.209 matthew 6552: } else { # load balancing routine for determining $unhome
1.81 www 6553: my $loadm=10000000;
1.841 albertel 6554: my %servers = &get_servers($udom,'library');
6555: foreach my $tryserver (keys(%servers)) {
6556: my $answer=reply('load',$tryserver);
6557: if (($answer=~/\d+/) && ($answer<$loadm)) {
6558: $loadm=$answer;
6559: $unhome=$tryserver;
6560: }
1.80 www 6561: }
6562: }
6563: if (($unhome eq '') || ($unhome eq 'no_host')) {
1.206 matthew 6564: return 'error: unable to find a home server for '.$uname.
6565: ' in domain '.$udom;
1.80 www 6566: }
6567: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':'.$umode.':'.
6568: &escape($upass),$unhome);
6569: unless ($reply eq 'ok') {
6570: return 'error: '.$reply;
6571: }
1.230 stredwic 6572: $uhome=&homeserver($uname,$udom,'true');
1.80 www 6573: if (($uhome eq '') || ($uhome eq 'no_host') || ($uhome ne $unhome)) {
1.386 matthew 6574: return 'error: unable verify users home machine.';
1.80 www 6575: }
1.209 matthew 6576: } # End of creation of new user
1.80 www 6577: # ---------------------------------------------------------------------- Add ID
6578: if ($uid) {
6579: $uid=~tr/A-Z/a-z/;
6580: my %uidhash=&idrget($udom,$uname);
1.196 www 6581: if (($uidhash{$uname}) && ($uidhash{$uname}!~/error\:/)
6582: && (!$forceid)) {
1.80 www 6583: unless ($uid eq $uidhash{$uname}) {
1.386 matthew 6584: return 'error: user id "'.$uid.'" does not match '.
6585: 'current user id "'.$uidhash{$uname}.'".';
1.80 www 6586: }
6587: } else {
6588: &idput($udom,($uname => $uid));
6589: }
6590: }
6591: # -------------------------------------------------------------- Add names, etc
1.313 matthew 6592: my @tmp=&get('environment',
1.899 raeburn 6593: ['firstname','middlename','lastname','generation','id',
1.963 raeburn 6594: 'permanentemail','inststatus'],
1.134 albertel 6595: $udom,$uname);
1.313 matthew 6596: my %names;
6597: if ($tmp[0] =~ m/^error:.*/) {
6598: %names=();
6599: } else {
6600: %names = @tmp;
6601: }
1.388 www 6602: #
1.1056.2.1 raeburn 6603: # If name, email and/or uid are blank (e.g., because an uploaded file
6604: # of users did not contain them), do not overwrite existing values
6605: # unless field is in $candelete array ref.
6606: #
6607: my @fields = ('firstname','middlename','lastname','generation',
6608: 'permanentemail','id');
6609: my %newvalues;
6610: if (ref($candelete) eq 'ARRAY') {
6611: foreach my $field (@fields) {
6612: if (grep(/^\Q$field\E$/,@{$candelete})) {
6613: if ($field eq 'firstname') {
6614: $names{$field} = $first;
6615: } elsif ($field eq 'middlename') {
6616: $names{$field} = $middle;
6617: } elsif ($field eq 'lastname') {
6618: $names{$field} = $last;
6619: } elsif ($field eq 'generation') {
6620: $names{$field} = $gene;
6621: } elsif ($field eq 'permanentemail') {
6622: $names{$field} = $email;
6623: } elsif ($field eq 'id') {
6624: $names{$field} = $uid;
6625: }
6626: }
6627: }
6628: }
6629:
1.388 www 6630: if ($first) { $names{'firstname'} = $first; }
1.385 matthew 6631: if (defined($middle)) { $names{'middlename'} = $middle; }
1.388 www 6632: if ($last) { $names{'lastname'} = $last; }
1.385 matthew 6633: if (defined($gene)) { $names{'generation'} = $gene; }
1.592 www 6634: if ($email) {
6635: $email=~s/[^\w\@\.\-\,]//gs;
1.963 raeburn 6636: if ($email=~/\@/) { $names{'permanentemail'} = $email; }
1.592 www 6637: }
1.899 raeburn 6638: if ($uid) { $names{'id'} = $uid; }
1.989 raeburn 6639: if (defined($inststatus)) {
6640: $names{'inststatus'} = '';
6641: my ($usertypes,$typesorder) = &retrieve_inst_usertypes($udom);
6642: if (ref($usertypes) eq 'HASH') {
6643: my @okstatuses;
6644: foreach my $item (split(/:/,$inststatus)) {
6645: if (defined($usertypes->{$item})) {
6646: push(@okstatuses,$item);
6647: }
6648: }
6649: if (@okstatuses) {
6650: $names{'inststatus'} = join(':', map { &escape($_); } @okstatuses);
6651: }
6652: }
6653: }
1.134 albertel 6654: my $reply = &put('environment', \%names, $udom,$uname);
6655: if ($reply ne 'ok') { return 'error: '.$reply; }
1.899 raeburn 6656: my $sqlresult = &update_allusers_table($uname,$udom,\%names);
1.680 www 6657: &devalidate_cache_new('namescache',$uname.':'.$udom);
1.963 raeburn 6658: my $logmsg = 'Success modifying user '.$udom.', '.$uname.', '.$uid.', '.
6659: $umode.', '.$first.', '.$middle.', '.
6660: $last.', '.$gene.', '.$email.', '.$inststatus;
6661: if ($env{'user.name'} ne '' && $env{'user.domain'}) {
6662: $logmsg .= ' by '.$env{'user.name'}.' at '.$env{'user.domain'};
6663: } else {
6664: $logmsg .= ' during self creation';
6665: }
6666: &logthis($logmsg);
1.134 albertel 6667: return 'ok';
1.80 www 6668: }
6669:
1.81 www 6670: # -------------------------------------------------------------- Modify student
1.80 www 6671:
1.81 www 6672: sub modifystudent {
6673: my ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$usec,
1.957 raeburn 6674: $end,$start,$forceid,$desiredhome,$email,$type,$locktype,$cid,
1.990 raeburn 6675: $selfenroll,$context,$inststatus)=@_;
1.455 albertel 6676: if (!$cid) {
1.620 albertel 6677: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6678: return 'not_in_class';
6679: }
1.80 www 6680: }
6681: # --------------------------------------------------------------- Make the user
1.81 www 6682: my $reply=&modifyuser
1.209 matthew 6683: ($udom,$uname,$uid,$umode,$upass,$first,$middle,$last,$gene,$forceid,
1.990 raeburn 6684: $desiredhome,$email,$inststatus);
1.80 www 6685: unless ($reply eq 'ok') { return $reply; }
1.297 matthew 6686: # This will cause &modify_student_enrollment to get the uid from the
6687: # students environment
6688: $uid = undef if (!$forceid);
1.455 albertel 6689: $reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
1.957 raeburn 6690: $gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context);
1.297 matthew 6691: return $reply;
6692: }
6693:
6694: sub modify_student_enrollment {
1.957 raeburn 6695: my ($udom,$uname,$uid,$first,$middle,$last,$gene,$usec,$end,$start,$type,$locktype,$cid,$selfenroll,$context) = @_;
1.455 albertel 6696: my ($cdom,$cnum,$chome);
6697: if (!$cid) {
1.620 albertel 6698: unless ($cid=$env{'request.course.id'}) {
1.455 albertel 6699: return 'not_in_class';
6700: }
1.620 albertel 6701: $cdom=$env{'course.'.$cid.'.domain'};
6702: $cnum=$env{'course.'.$cid.'.num'};
1.455 albertel 6703: } else {
6704: ($cdom,$cnum)=split(/_/,$cid);
6705: }
1.620 albertel 6706: $chome=$env{'course.'.$cid.'.home'};
1.455 albertel 6707: if (!$chome) {
1.457 raeburn 6708: $chome=&homeserver($cnum,$cdom);
1.297 matthew 6709: }
1.455 albertel 6710: if (!$chome) { return 'unknown_course'; }
1.297 matthew 6711: # Make sure the user exists
1.81 www 6712: my $uhome=&homeserver($uname,$udom);
6713: if (($uhome eq '') || ($uhome eq 'no_host')) {
6714: return 'error: no such user';
6715: }
1.297 matthew 6716: # Get student data if we were not given enough information
6717: if (!defined($first) || $first eq '' ||
6718: !defined($last) || $last eq '' ||
6719: !defined($uid) || $uid eq '' ||
6720: !defined($middle) || $middle eq '' ||
6721: !defined($gene) || $gene eq '') {
1.294 matthew 6722: # They did not supply us with enough data to enroll the student, so
6723: # we need to pick up more information.
1.297 matthew 6724: my %tmp = &get('environment',
1.294 matthew 6725: ['firstname','middlename','lastname', 'generation','id']
1.297 matthew 6726: ,$udom,$uname);
6727:
1.800 albertel 6728: #foreach my $key (keys(%tmp)) {
6729: # &logthis("key $key = ".$tmp{$key});
1.455 albertel 6730: #}
1.294 matthew 6731: $first = $tmp{'firstname'} if (!defined($first) || $first eq '');
6732: $middle = $tmp{'middlename'} if (!defined($middle) || $middle eq '');
6733: $last = $tmp{'lastname'} if (!defined($last) || $last eq '');
1.297 matthew 6734: $gene = $tmp{'generation'} if (!defined($gene) || $gene eq '');
1.294 matthew 6735: $uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
6736: }
1.556 albertel 6737: my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
1.487 albertel 6738: my $reply=cput('classlist',
6739: {"$uname:$udom" =>
1.515 raeburn 6740: join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
1.487 albertel 6741: $cdom,$cnum);
1.81 www 6742: unless (($reply eq 'ok') || ($reply eq 'delayed')) {
6743: return 'error: '.$reply;
1.652 albertel 6744: } else {
6745: &devalidate_getsection_cache($udom,$uname,$cid);
1.81 www 6746: }
1.297 matthew 6747: # Add student role to user
1.83 www 6748: my $uurl='/'.$cid;
1.81 www 6749: $uurl=~s/\_/\//g;
6750: if ($usec) {
6751: $uurl.='/'.$usec;
6752: }
1.957 raeburn 6753: return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
1.21 www 6754: }
6755:
1.556 albertel 6756: sub format_name {
6757: my ($firstname,$middlename,$lastname,$generation,$first)=@_;
6758: my $name;
6759: if ($first ne 'lastname') {
6760: $name=$firstname.' '.$middlename.' '.$lastname.' '.$generation;
6761: } else {
6762: if ($lastname=~/\S/) {
6763: $name.= $lastname.' '.$generation.', '.$firstname.' '.$middlename;
6764: $name=~s/\s+,/,/;
6765: } else {
6766: $name.= $firstname.' '.$middlename.' '.$generation;
6767: }
6768: }
6769: $name=~s/^\s+//;
6770: $name=~s/\s+$//;
6771: $name=~s/\s+/ /g;
6772: return $name;
6773: }
6774:
1.84 www 6775: # ------------------------------------------------- Write to course preferences
6776:
6777: sub writecoursepref {
6778: my ($courseid,%prefs)=@_;
6779: $courseid=~s/^\///;
6780: $courseid=~s/\_/\//g;
6781: my ($cdomain,$cnum)=split(/\//,$courseid);
6782: my $chome=homeserver($cnum,$cdomain);
6783: if (($chome eq '') || ($chome eq 'no_host')) {
6784: return 'error: no such course';
6785: }
6786: my $cstring='';
1.800 albertel 6787: foreach my $pref (keys(%prefs)) {
6788: $cstring.=&escape($pref).'='.&escape($prefs{$pref}).'&';
1.191 harris41 6789: }
1.84 www 6790: $cstring=~s/\&$//;
6791: return reply('put:'.$cdomain.':'.$cnum.':environment:'.$cstring,$chome);
6792: }
6793:
6794: # ---------------------------------------------------------- Make/modify course
6795:
6796: sub createcourse {
1.741 raeburn 6797: my ($udom,$description,$url,$course_server,$nonstandard,$inst_code,
1.1017 raeburn 6798: $course_owner,$crstype,$cnum,$context,$category)=@_;
1.84 www 6799: $url=&declutter($url);
6800: my $cid='';
1.1028 raeburn 6801: if ($context eq 'requestcourses') {
6802: my $can_create = 0;
6803: my ($ownername,$ownerdom) = split(':',$course_owner);
6804: if ($udom eq $ownerdom) {
6805: if (&usertools_access($ownername,$ownerdom,$category,undef,
6806: $context)) {
6807: $can_create = 1;
6808: }
6809: } else {
6810: my %userenv = &userenvironment($ownerdom,$ownername,'reqcrsotherdom.'.
6811: $category);
6812: if ($userenv{'reqcrsotherdom.'.$category} ne '') {
6813: my @curr = split(',',$userenv{'reqcrsotherdom.'.$category});
6814: if (@curr > 0) {
6815: my @options = qw(approval validate autolimit);
6816: my $optregex = join('|',@options);
6817: if (grep(/^\Q$udom\E:($optregex)(=?\d*)$/,@curr)) {
6818: $can_create = 1;
6819: }
6820: }
6821: }
6822: }
6823: if ($can_create) {
6824: unless ($ownername eq $env{'user.name'} && $ownerdom eq $env{'user.domain'}) {
6825: unless (&allowed('ccc',$udom)) {
6826: return 'refused';
6827: }
1.1017 raeburn 6828: }
6829: } else {
6830: return 'refused';
6831: }
1.1028 raeburn 6832: } elsif (!&allowed('ccc',$udom)) {
6833: return 'refused';
1.84 www 6834: }
1.1011 raeburn 6835: # --------------------------------------------------------------- Get Unique ID
6836: my $uname;
6837: if ($cnum =~ /^$match_courseid$/) {
6838: my $chome=&homeserver($cnum,$udom,'true');
6839: if (($chome eq '') || ($chome eq 'no_host')) {
6840: $uname = $cnum;
6841: } else {
1.1038 raeburn 6842: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6843: }
6844: } else {
1.1038 raeburn 6845: $uname = &generate_coursenum($udom,$crstype);
1.1011 raeburn 6846: }
6847: return $uname if ($uname =~ /^error/);
6848: # -------------------------------------------------- Check supplied server name
1.1052 raeburn 6849: if (!defined($course_server)) {
6850: if (defined(&domain($udom,'primary'))) {
6851: $course_server = &domain($udom,'primary');
6852: } else {
6853: $course_server = $env{'user.home'};
6854: }
6855: }
6856: my %host_servers =
6857: &Apache::lonnet::get_servers($udom,'library');
6858: unless ($host_servers{$course_server}) {
6859: return 'error: invalid home server for course: '.$course_server;
1.264 matthew 6860: }
1.84 www 6861: # ------------------------------------------------------------- Make the course
6862: my $reply=&reply('encrypt:makeuser:'.$udom.':'.$uname.':none::',
1.264 matthew 6863: $course_server);
1.84 www 6864: unless ($reply eq 'ok') { return 'error: '.$reply; }
1.1011 raeburn 6865: my $uhome=&homeserver($uname,$udom,'true');
1.84 www 6866: if (($uhome eq '') || ($uhome eq 'no_host')) {
6867: return 'error: no such course';
6868: }
1.271 www 6869: # ----------------------------------------------------------------- Course made
1.516 raeburn 6870: # log existence
1.1029 raeburn 6871: my $now = time;
1.918 raeburn 6872: my $newcourse = {
6873: $udom.'_'.$uname => {
1.921 raeburn 6874: description => $description,
6875: inst_code => $inst_code,
6876: owner => $course_owner,
6877: type => $crstype,
1.1029 raeburn 6878: creator => $env{'user.name'}.':'.
6879: $env{'user.domain'},
6880: created => $now,
6881: context => $context,
1.918 raeburn 6882: },
6883: };
1.921 raeburn 6884: &courseidput($udom,$newcourse,$uhome,'notime');
1.358 www 6885: # set toplevel url
1.271 www 6886: my $topurl=$url;
6887: unless ($nonstandard) {
6888: # ------------------------------------------ For standard courses, make top url
6889: my $mapurl=&clutter($url);
1.278 www 6890: if ($mapurl eq '/res/') { $mapurl=''; }
1.620 albertel 6891: $env{'form.initmap'}=(<<ENDINITMAP);
1.271 www 6892: <map>
6893: <resource id="1" type="start"></resource>
6894: <resource id="2" src="$mapurl"></resource>
6895: <resource id="3" type="finish"></resource>
6896: <link index="1" from="1" to="2"></link>
6897: <link index="2" from="2" to="3"></link>
6898: </map>
6899: ENDINITMAP
6900: $topurl=&declutter(
1.638 albertel 6901: &finishuserfileupload($uname,$udom,'initmap','default.sequence')
1.271 www 6902: );
6903: }
6904: # ----------------------------------------------------------- Write preferences
1.84 www 6905: &writecoursepref($udom.'_'.$uname,
1.1056 raeburn 6906: ('description' => $description,
6907: 'url' => $topurl,
6908: 'internal.creator' => $env{'user.name'}.':'.
6909: $env{'user.domain'},
6910: 'internal.created' => $now,
6911: 'internal.creationcontext' => $context)
6912: );
1.84 www 6913: return '/'.$udom.'/'.$uname;
6914: }
6915:
1.1011 raeburn 6916: # ------------------------------------------------------------------- Create ID
6917: sub generate_coursenum {
1.1038 raeburn 6918: my ($udom,$crstype) = @_;
1.1011 raeburn 6919: my $domdesc = &domain($udom);
6920: return 'error: invalid domain' if ($domdesc eq '');
1.1038 raeburn 6921: my $first;
6922: if ($crstype eq 'Community') {
6923: $first = '0';
6924: } else {
6925: $first = int(1+rand(9));
6926: }
6927: my $uname=$first.
1.1011 raeburn 6928: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6929: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6930: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6931: # ----------------------------------------------- Make sure that does not exist
6932: my $uhome=&homeserver($uname,$udom,'true');
6933: unless (($uhome eq '') || ($uhome eq 'no_host')) {
1.1038 raeburn 6934: if ($crstype eq 'Community') {
6935: $first = '0';
6936: } else {
6937: $first = int(1+rand(9));
6938: }
6939: $uname=$first.
1.1011 raeburn 6940: ('a'..'z','A'..'Z','0'..'9')[int(rand(62))].
6941: substr($$.time,0,5).unpack("H8",pack("I32",time)).
6942: unpack("H2",pack("I32",int(rand(255)))).$perlvar{'lonHostID'};
6943: $uhome=&homeserver($uname,$udom,'true');
6944: unless (($uhome eq '') || ($uhome eq 'no_host')) {
6945: return 'error: unable to generate unique course-ID';
6946: }
6947: }
6948: return $uname;
6949: }
6950:
1.813 albertel 6951: sub is_course {
6952: my ($cdom,$cnum) = @_;
6953: my %courses = &courseiddump($cdom,'.',1,'.','.',$cnum,undef,
1.946 raeburn 6954: undef,'.');
1.813 albertel 6955: if (exists($courses{$cdom.'_'.$cnum})) {
6956: return 1;
6957: }
6958: return 0;
6959: }
6960:
1.1015 raeburn 6961: sub store_userdata {
6962: my ($storehash,$datakey,$namespace,$udom,$uname) = @_;
1.1013 raeburn 6963: my $result;
1.1016 raeburn 6964: if ($datakey ne '') {
1.1013 raeburn 6965: if (ref($storehash) eq 'HASH') {
1.1017 raeburn 6966: if ($udom eq '' || $uname eq '') {
6967: $udom = $env{'user.domain'};
6968: $uname = $env{'user.name'};
6969: }
6970: my $uhome=&homeserver($uname,$udom);
1.1013 raeburn 6971: if (($uhome eq '') || ($uhome eq 'no_host')) {
6972: $result = 'error: no_host';
6973: } else {
6974: $storehash->{'ip'} = $ENV{'REMOTE_ADDR'};
6975: $storehash->{'host'} = $perlvar{'lonHostID'};
6976:
6977: my $namevalue='';
6978: foreach my $key (keys(%{$storehash})) {
6979: $namevalue.=&escape($key).'='.&freeze_escape($$storehash{$key}).'&';
6980: }
6981: $namevalue=~s/\&$//;
6982: $result = &reply("store:$env{'user.domain'}:$env{'user.name'}:".
1.1015 raeburn 6983: "$namespace:$datakey:$namevalue",$uhome);
1.1013 raeburn 6984: }
6985: } else {
6986: $result = 'error: data to store was not a hash reference';
6987: }
6988: } else {
6989: $result= 'error: invalid requestkey';
6990: }
6991: return $result;
6992: }
6993:
1.21 www 6994: # ---------------------------------------------------------- Assign Custom Role
6995:
6996: sub assigncustomrole {
1.957 raeburn 6997: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start,$deleteflag,$selfenroll,$context)=@_;
1.21 www 6998: return &assignrole($udom,$uname,$url,'cr/'.$rdom.'/'.$rnam.'/'.$rolename,
1.957 raeburn 6999: $end,$start,$deleteflag,$selfenroll,$context);
1.21 www 7000: }
7001:
7002: # ----------------------------------------------------------------- Revoke Role
7003:
7004: sub revokerole {
1.957 raeburn 7005: my ($udom,$uname,$url,$role,$deleteflag,$selfenroll,$context)=@_;
1.21 www 7006: my $now=time;
1.965 raeburn 7007: return &assignrole($udom,$uname,$url,$role,$now,undef,$deleteflag,$selfenroll,$context);
1.21 www 7008: }
7009:
7010: # ---------------------------------------------------------- Revoke Custom Role
7011:
7012: sub revokecustomrole {
1.957 raeburn 7013: my ($udom,$uname,$url,$rdom,$rnam,$rolename,$deleteflag,$selfenroll,$context)=@_;
1.21 www 7014: my $now=time;
1.357 www 7015: return &assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$now,
1.957 raeburn 7016: $deleteflag,$selfenroll,$context);
1.17 www 7017: }
7018:
1.533 banghart 7019: # ------------------------------------------------------------ Disk usage
1.535 albertel 7020: sub diskusage {
1.955 raeburn 7021: my ($udom,$uname,$directorypath,$getpropath)=@_;
7022: $directorypath =~ s/\/$//;
7023: my $listing=&reply('du2:'.&escape($directorypath).':'
7024: .&escape($getpropath).':'.&escape($uname).':'
7025: .&escape($udom),homeserver($uname,$udom));
7026: if ($listing eq 'unknown_cmd') {
7027: if ($getpropath) {
7028: $directorypath = &propath($udom,$uname).'/'.$directorypath;
7029: }
7030: $listing = &reply('du:'.$directorypath,homeserver($uname,$udom));
7031: }
1.514 albertel 7032: return $listing;
1.512 banghart 7033: }
7034:
1.566 banghart 7035: sub is_locked {
7036: my ($file_name, $domain, $user) = @_;
7037: my @check;
7038: my $is_locked;
7039: push @check, $file_name;
1.613 albertel 7040: my %locked = &get('file_permissions',\@check,
1.620 albertel 7041: $env{'user.domain'},$env{'user.name'});
1.615 albertel 7042: my ($tmp)=keys(%locked);
7043: if ($tmp=~/^error:/) { undef(%locked); }
1.745 raeburn 7044:
1.566 banghart 7045: if (ref($locked{$file_name}) eq 'ARRAY') {
1.745 raeburn 7046: $is_locked = 'false';
7047: foreach my $entry (@{$locked{$file_name}}) {
7048: if (ref($entry) eq 'ARRAY') {
1.746 raeburn 7049: $is_locked = 'true';
7050: last;
1.745 raeburn 7051: }
7052: }
1.566 banghart 7053: } else {
7054: $is_locked = 'false';
7055: }
7056: }
7057:
1.759 albertel 7058: sub declutter_portfile {
7059: my ($file) = @_;
1.833 albertel 7060: $file =~ s{^(/portfolio/|portfolio/)}{/};
1.759 albertel 7061: return $file;
7062: }
7063:
1.559 banghart 7064: # ------------------------------------------------------------- Mark as Read Only
7065:
7066: sub mark_as_readonly {
7067: my ($domain,$user,$files,$what) = @_;
1.613 albertel 7068: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 7069: my ($tmp)=keys(%current_permissions);
7070: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.560 banghart 7071: foreach my $file (@{$files}) {
1.759 albertel 7072: $file = &declutter_portfile($file);
1.561 banghart 7073: push(@{$current_permissions{$file}},$what);
1.559 banghart 7074: }
1.613 albertel 7075: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7076: return;
7077: }
7078:
1.572 banghart 7079: # ------------------------------------------------------------Save Selected Files
7080:
7081: sub save_selected_files {
7082: my ($user, $path, @files) = @_;
7083: my $filename = $user."savedfiles";
1.573 banghart 7084: my @other_files = &files_not_in_path($user, $path);
1.871 albertel 7085: open (OUT, '>'.$tmpdir.$filename);
1.573 banghart 7086: foreach my $file (@files) {
1.620 albertel 7087: print (OUT $env{'form.currentpath'}.$file."\n");
1.573 banghart 7088: }
7089: foreach my $file (@other_files) {
1.574 banghart 7090: print (OUT $file."\n");
1.572 banghart 7091: }
1.574 banghart 7092: close (OUT);
1.572 banghart 7093: return 'ok';
7094: }
7095:
1.574 banghart 7096: sub clear_selected_files {
7097: my ($user) = @_;
7098: my $filename = $user."savedfiles";
7099: open (OUT, '>'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7100: print (OUT undef);
7101: close (OUT);
7102: return ("ok");
7103: }
7104:
1.572 banghart 7105: sub files_in_path {
7106: my ($user, $path) = @_;
7107: my $filename = $user."savedfiles";
7108: my %return_files;
1.574 banghart 7109: open (IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
1.573 banghart 7110: while (my $line_in = <IN>) {
1.574 banghart 7111: chomp ($line_in);
7112: my @paths_and_file = split (m!/!, $line_in);
7113: my $file_part = pop (@paths_and_file);
7114: my $path_part = join ('/', @paths_and_file);
1.573 banghart 7115: $path_part.='/';
7116: my $path_and_file = $path_part.$file_part;
7117: if ($path_part eq $path) {
7118: $return_files{$file_part}= 'selected';
7119: }
7120: }
1.574 banghart 7121: close (IN);
7122: return (\%return_files);
1.572 banghart 7123: }
7124:
7125: # called in portfolio select mode, to show files selected NOT in current directory
7126: sub files_not_in_path {
7127: my ($user, $path) = @_;
7128: my $filename = $user."savedfiles";
7129: my @return_files;
7130: my $path_part;
1.800 albertel 7131: open(IN, '<'.$Apache::lonnet::perlvar{'lonDaemons'}.'/tmp/'.$filename);
7132: while (my $line = <IN>) {
1.572 banghart 7133: #ok, I know it's clunky, but I want it to work
1.800 albertel 7134: my @paths_and_file = split(m|/|, $line);
7135: my $file_part = pop(@paths_and_file);
7136: chomp($file_part);
7137: my $path_part = join('/', @paths_and_file);
1.572 banghart 7138: $path_part .= '/';
7139: my $path_and_file = $path_part.$file_part;
7140: if ($path_part ne $path) {
1.800 albertel 7141: push(@return_files, ($path_and_file));
1.572 banghart 7142: }
7143: }
1.800 albertel 7144: close(OUT);
1.574 banghart 7145: return (@return_files);
1.572 banghart 7146: }
7147:
1.745 raeburn 7148: #----------------------------------------------Get portfolio file permissions
1.629 banghart 7149:
1.745 raeburn 7150: sub get_portfile_permissions {
7151: my ($domain,$user) = @_;
1.613 albertel 7152: my %current_permissions = &dump('file_permissions',$domain,$user);
1.615 albertel 7153: my ($tmp)=keys(%current_permissions);
7154: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7155: return \%current_permissions;
7156: }
7157:
7158: #---------------------------------------------Get portfolio file access controls
7159:
1.749 raeburn 7160: sub get_access_controls {
1.745 raeburn 7161: my ($current_permissions,$group,$file) = @_;
1.769 albertel 7162: my %access;
7163: my $real_file = $file;
7164: $file =~ s/\.meta$//;
1.745 raeburn 7165: if (defined($file)) {
1.749 raeburn 7166: if (ref($$current_permissions{$file."\0".'accesscontrol'}) eq 'HASH') {
7167: foreach my $control (keys(%{$$current_permissions{$file."\0".'accesscontrol'}})) {
1.769 albertel 7168: $access{$real_file}{$control} = $$current_permissions{$file."\0".$control};
1.749 raeburn 7169: }
7170: }
1.745 raeburn 7171: } else {
1.749 raeburn 7172: foreach my $key (keys(%{$current_permissions})) {
7173: if ($key =~ /\0accesscontrol$/) {
7174: if (defined($group)) {
7175: if ($key !~ m-^\Q$group\E/-) {
7176: next;
7177: }
7178: }
7179: my ($fullpath) = split(/\0/,$key);
7180: if (ref($$current_permissions{$key}) eq 'HASH') {
7181: foreach my $control (keys(%{$$current_permissions{$key}})) {
7182: $access{$fullpath}{$control}=$$current_permissions{$fullpath."\0".$control};
7183: }
7184: }
7185: }
7186: }
7187: }
7188: return %access;
7189: }
7190:
7191: sub modify_access_controls {
7192: my ($file_name,$changes,$domain,$user)=@_;
7193: my ($outcome,$deloutcome);
7194: my %store_permissions;
7195: my %new_values;
7196: my %new_control;
7197: my %translation;
7198: my @deletions = ();
7199: my $now = time;
7200: if (exists($$changes{'activate'})) {
7201: if (ref($$changes{'activate'}) eq 'HASH') {
7202: my @newitems = sort(keys(%{$$changes{'activate'}}));
7203: my $numnew = scalar(@newitems);
7204: for (my $i=0; $i<$numnew; $i++) {
7205: my $newkey = $newitems[$i];
7206: my $newid = &Apache::loncommon::get_cgi_id();
1.797 raeburn 7207: if ($newkey =~ /^\d+:/) {
7208: $newkey =~ s/^(\d+)/$newid/;
7209: $translation{$1} = $newid;
7210: } elsif ($newkey =~ /^\d+_\d+_\d+:/) {
7211: $newkey =~ s/^(\d+_\d+_\d+)/$newid/;
7212: $translation{$1} = $newid;
7213: }
1.749 raeburn 7214: $new_values{$file_name."\0".$newkey} =
7215: $$changes{'activate'}{$newitems[$i]};
7216: $new_control{$newkey} = $now;
7217: }
7218: }
7219: }
7220: my %todelete;
7221: my %changed_items;
7222: foreach my $action ('delete','update') {
7223: if (exists($$changes{$action})) {
7224: if (ref($$changes{$action}) eq 'HASH') {
7225: foreach my $key (keys(%{$$changes{$action}})) {
7226: my ($itemnum) = ($key =~ /^([^:]+):/);
7227: if ($action eq 'delete') {
7228: $todelete{$itemnum} = 1;
7229: } else {
7230: $changed_items{$itemnum} = $key;
7231: }
7232: }
1.745 raeburn 7233: }
7234: }
1.749 raeburn 7235: }
7236: # get lock on access controls for file.
7237: my $lockhash = {
7238: $file_name."\0".'locked_access_records' => $env{'user.name'}.
7239: ':'.$env{'user.domain'},
7240: };
7241: my $tries = 0;
7242: my $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7243:
7244: while (($gotlock ne 'ok') && $tries <3) {
7245: $tries ++;
7246: sleep 1;
7247: $gotlock = &newput('file_permissions',$lockhash,$domain,$user);
7248: }
7249: if ($gotlock eq 'ok') {
7250: my %curr_permissions = &dump('file_permissions',$domain,$user,$file_name);
7251: my ($tmp)=keys(%curr_permissions);
7252: if ($tmp=~/^error:/) { undef(%curr_permissions); }
7253: if (exists($curr_permissions{$file_name."\0".'accesscontrol'})) {
7254: my $curr_controls = $curr_permissions{$file_name."\0".'accesscontrol'};
7255: if (ref($curr_controls) eq 'HASH') {
7256: foreach my $control_item (keys(%{$curr_controls})) {
7257: my ($itemnum) = ($control_item =~ /^([^:]+):/);
7258: if (defined($todelete{$itemnum})) {
7259: push(@deletions,$file_name."\0".$control_item);
7260: } else {
7261: if (defined($changed_items{$itemnum})) {
7262: $new_control{$changed_items{$itemnum}} = $now;
7263: push(@deletions,$file_name."\0".$control_item);
7264: $new_values{$file_name."\0".$changed_items{$itemnum}} = $$changes{'update'}{$changed_items{$itemnum}};
7265: } else {
7266: $new_control{$control_item} = $$curr_controls{$control_item};
7267: }
7268: }
1.745 raeburn 7269: }
7270: }
7271: }
1.970 raeburn 7272: my ($group);
7273: if (&is_course($domain,$user)) {
7274: ($group,my $file) = split(/\//,$file_name,2);
7275: }
1.749 raeburn 7276: $deloutcome = &del('file_permissions',\@deletions,$domain,$user);
7277: $new_values{$file_name."\0".'accesscontrol'} = \%new_control;
7278: $outcome = &put('file_permissions',\%new_values,$domain,$user);
7279: # remove lock
7280: my @del_lock = ($file_name."\0".'locked_access_records');
7281: my $dellockoutcome = &del('file_permissions',\@del_lock,$domain,$user);
1.818 raeburn 7282: my $sqlresult =
1.970 raeburn 7283: &update_portfolio_table($user,$domain,$file_name,'portfolio_access',
1.818 raeburn 7284: $group);
1.749 raeburn 7285: } else {
7286: $outcome = "error: could not obtain lockfile\n";
1.745 raeburn 7287: }
1.749 raeburn 7288: return ($outcome,$deloutcome,\%new_values,\%translation);
1.745 raeburn 7289: }
7290:
1.827 raeburn 7291: sub make_public_indefinitely {
7292: my ($requrl) = @_;
7293: my $now = time;
7294: my $action = 'activate';
7295: my $aclnum = 0;
7296: if (&is_portfolio_url($requrl)) {
7297: my (undef,$udom,$unum,$file_name,$group) =
7298: &parse_portfolio_url($requrl);
7299: my $current_perms = &get_portfile_permissions($udom,$unum);
7300: my %access_controls = &get_access_controls($current_perms,
7301: $group,$file_name);
7302: foreach my $key (keys(%{$access_controls{$file_name}})) {
7303: my ($num,$scope,$end,$start) =
7304: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
7305: if ($scope eq 'public') {
7306: if ($start <= $now && $end == 0) {
7307: $action = 'none';
7308: } else {
7309: $action = 'update';
7310: $aclnum = $num;
7311: }
7312: last;
7313: }
7314: }
7315: if ($action eq 'none') {
7316: return 'ok';
7317: } else {
7318: my %changes;
7319: my $newend = 0;
7320: my $newstart = $now;
7321: my $newkey = $aclnum.':public_'.$newend.'_'.$newstart;
7322: $changes{$action}{$newkey} = {
7323: type => 'public',
7324: time => {
7325: start => $newstart,
7326: end => $newend,
7327: },
7328: };
7329: my ($outcome,$deloutcome,$new_values,$translation) =
7330: &modify_access_controls($file_name,\%changes,$udom,$unum);
7331: return $outcome;
7332: }
7333: } else {
7334: return 'invalid';
7335: }
7336: }
7337:
1.745 raeburn 7338: #------------------------------------------------------Get Marked as Read Only
7339:
7340: sub get_marked_as_readonly {
7341: my ($domain,$user,$what,$group) = @_;
7342: my $current_permissions = &get_portfile_permissions($domain,$user);
1.563 banghart 7343: my @readonly_files;
1.629 banghart 7344: my $cmp1=$what;
7345: if (ref($what)) { $cmp1=join('',@{$what}) };
1.745 raeburn 7346: while (my ($file_name,$value) = each(%{$current_permissions})) {
7347: if (defined($group)) {
7348: if ($file_name !~ m-^\Q$group\E/-) {
7349: next;
7350: }
7351: }
1.561 banghart 7352: if (ref($value) eq "ARRAY"){
7353: foreach my $stored_what (@{$value}) {
1.629 banghart 7354: my $cmp2=$stored_what;
1.759 albertel 7355: if (ref($stored_what) eq 'ARRAY') {
1.746 raeburn 7356: $cmp2=join('',@{$stored_what});
1.745 raeburn 7357: }
1.629 banghart 7358: if ($cmp1 eq $cmp2) {
1.561 banghart 7359: push(@readonly_files, $file_name);
1.745 raeburn 7360: last;
1.563 banghart 7361: } elsif (!defined($what)) {
7362: push(@readonly_files, $file_name);
1.745 raeburn 7363: last;
1.561 banghart 7364: }
7365: }
1.745 raeburn 7366: }
1.561 banghart 7367: }
7368: return @readonly_files;
7369: }
1.577 banghart 7370: #-----------------------------------------------------------Get Marked as Read Only Hash
1.561 banghart 7371:
1.577 banghart 7372: sub get_marked_as_readonly_hash {
1.745 raeburn 7373: my ($current_permissions,$group,$what) = @_;
1.577 banghart 7374: my %readonly_files;
1.745 raeburn 7375: while (my ($file_name,$value) = each(%{$current_permissions})) {
7376: if (defined($group)) {
7377: if ($file_name !~ m-^\Q$group\E/-) {
7378: next;
7379: }
7380: }
1.577 banghart 7381: if (ref($value) eq "ARRAY"){
7382: foreach my $stored_what (@{$value}) {
1.745 raeburn 7383: if (ref($stored_what) eq 'ARRAY') {
1.750 banghart 7384: foreach my $lock_descriptor(@{$stored_what}) {
7385: if ($lock_descriptor eq 'graded') {
7386: $readonly_files{$file_name} = 'graded';
7387: } elsif ($lock_descriptor eq 'handback') {
7388: $readonly_files{$file_name} = 'handback';
7389: } else {
7390: if (!exists($readonly_files{$file_name})) {
7391: $readonly_files{$file_name} = 'locked';
7392: }
7393: }
1.745 raeburn 7394: }
1.750 banghart 7395: }
1.577 banghart 7396: }
7397: }
7398: }
7399: return %readonly_files;
7400: }
1.559 banghart 7401: # ------------------------------------------------------------ Unmark as Read Only
7402:
7403: sub unmark_as_readonly {
1.629 banghart 7404: # unmarks $file_name (if $file_name is defined), or all files locked by $what
7405: # for portfolio submissions, $what contains [$symb,$crsid]
1.745 raeburn 7406: my ($domain,$user,$what,$file_name,$group) = @_;
1.759 albertel 7407: $file_name = &declutter_portfile($file_name);
1.634 albertel 7408: my $symb_crs = $what;
7409: if (ref($what)) { $symb_crs=join('',@$what); }
1.745 raeburn 7410: my %current_permissions = &dump('file_permissions',$domain,$user,$group);
1.615 albertel 7411: my ($tmp)=keys(%current_permissions);
7412: if ($tmp=~/^error:/) { undef(%current_permissions); }
1.745 raeburn 7413: my @readonly_files = &get_marked_as_readonly($domain,$user,$what,$group);
1.650 albertel 7414: foreach my $file (@readonly_files) {
1.759 albertel 7415: my $clean_file = &declutter_portfile($file);
7416: if (defined($file_name) && ($file_name ne $clean_file)) { next; }
1.650 albertel 7417: my $current_locks = $current_permissions{$file};
1.563 banghart 7418: my @new_locks;
7419: my @del_keys;
7420: if (ref($current_locks) eq "ARRAY"){
7421: foreach my $locker (@{$current_locks}) {
1.632 albertel 7422: my $compare=$locker;
1.749 raeburn 7423: if (ref($locker) eq 'ARRAY') {
1.745 raeburn 7424: $compare=join('',@{$locker});
1.746 raeburn 7425: if ($compare ne $symb_crs) {
7426: push(@new_locks, $locker);
7427: }
1.563 banghart 7428: }
7429: }
1.650 albertel 7430: if (scalar(@new_locks) > 0) {
1.563 banghart 7431: $current_permissions{$file} = \@new_locks;
7432: } else {
7433: push(@del_keys, $file);
1.613 albertel 7434: &del('file_permissions',\@del_keys, $domain, $user);
1.650 albertel 7435: delete($current_permissions{$file});
1.563 banghart 7436: }
7437: }
1.561 banghart 7438: }
1.613 albertel 7439: &put('file_permissions',\%current_permissions,$domain,$user);
1.559 banghart 7440: return;
7441: }
1.512 banghart 7442:
1.17 www 7443: # ------------------------------------------------------------ Directory lister
7444:
7445: sub dirlist {
1.955 raeburn 7446: my ($uri,$userdomain,$username,$getpropath,$getuserdir,$alternateRoot)=@_;
1.18 www 7447: $uri=~s/^\///;
7448: $uri=~s/\/$//;
1.253 stredwic 7449: my ($udom, $uname);
1.955 raeburn 7450: if ($getuserdir) {
1.253 stredwic 7451: $udom = $userdomain;
7452: $uname = $username;
1.955 raeburn 7453: } else {
7454: (undef,$udom,$uname)=split(/\//,$uri);
7455: if(defined($userdomain)) {
7456: $udom = $userdomain;
7457: }
7458: if(defined($username)) {
7459: $uname = $username;
7460: }
1.253 stredwic 7461: }
1.955 raeburn 7462: my ($dirRoot,$listing,@listing_results);
1.253 stredwic 7463:
1.955 raeburn 7464: $dirRoot = $perlvar{'lonDocRoot'};
7465: if (defined($getpropath)) {
7466: $dirRoot = &propath($udom,$uname);
1.253 stredwic 7467: $dirRoot =~ s/\/$//;
1.955 raeburn 7468: } elsif (defined($getuserdir)) {
7469: my $subdir=$uname.'__';
7470: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
7471: $dirRoot = $Apache::lonnet::perlvar{'lonUsersDir'}
7472: ."/$udom/$subdir/$uname";
7473: } elsif (defined($alternateRoot)) {
7474: $dirRoot = $alternateRoot;
1.751 banghart 7475: }
1.253 stredwic 7476:
7477: if($udom) {
7478: if($uname) {
1.955 raeburn 7479: $listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
1.956 raeburn 7480: .$getuserdir.':'.&escape($dirRoot)
1.955 raeburn 7481: .':'.&escape($uname).':'.&escape($udom),
7482: &homeserver($uname,$udom));
7483: if ($listing eq 'unknown_cmd') {
7484: $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
7485: &homeserver($uname,$udom));
7486: } else {
7487: @listing_results = map { &unescape($_); } split(/:/,$listing);
7488: }
1.605 matthew 7489: if ($listing eq 'unknown_cmd') {
1.800 albertel 7490: $listing = &reply('ls:'.$dirRoot.'/'.$uri,
7491: &homeserver($uname,$udom));
1.605 matthew 7492: @listing_results = split(/:/,$listing);
7493: } else {
7494: @listing_results = map { &unescape($_); } split(/:/,$listing);
7495: }
7496: return @listing_results;
1.955 raeburn 7497: } elsif(!$alternateRoot) {
1.800 albertel 7498: my %allusers;
1.841 albertel 7499: my %servers = &get_servers($udom,'library');
1.955 raeburn 7500: foreach my $tryserver (keys(%servers)) {
7501: $listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
7502: &escape($udom),$tryserver);
7503: if ($listing eq 'unknown_cmd') {
7504: $listing = &reply('ls2:'.$perlvar{'lonDocRoot'}.'/res/'.
7505: $udom, $tryserver);
7506: } else {
7507: @listing_results = map { &unescape($_); } split(/:/,$listing);
7508: }
1.841 albertel 7509: if ($listing eq 'unknown_cmd') {
7510: $listing = &reply('ls:'.$perlvar{'lonDocRoot'}.'/res/'.
7511: $udom, $tryserver);
7512: @listing_results = split(/:/,$listing);
7513: } else {
7514: @listing_results =
7515: map { &unescape($_); } split(/:/,$listing);
7516: }
7517: if ($listing_results[0] ne 'no_such_dir' &&
7518: $listing_results[0] ne 'empty' &&
7519: $listing_results[0] ne 'con_lost') {
7520: foreach my $line (@listing_results) {
7521: my ($entry) = split(/&/,$line,2);
7522: $allusers{$entry} = 1;
7523: }
7524: }
1.253 stredwic 7525: }
7526: my $alluserstr='';
1.800 albertel 7527: foreach my $user (sort(keys(%allusers))) {
7528: $alluserstr.=$user.'&user:';
1.253 stredwic 7529: }
7530: $alluserstr=~s/:$//;
7531: return split(/:/,$alluserstr);
7532: } else {
1.800 albertel 7533: return ('missing user name');
1.253 stredwic 7534: }
1.955 raeburn 7535: } elsif(!defined($getpropath)) {
1.841 albertel 7536: my @all_domains = sort(&all_domains());
1.955 raeburn 7537: foreach my $domain (@all_domains) {
7538: $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
7539: }
7540: return @all_domains;
7541: } else {
1.800 albertel 7542: return ('missing domain');
1.275 stredwic 7543: }
7544: }
7545:
7546: # --------------------------------------------- GetFileTimestamp
7547: # This function utilizes dirlist and returns the date stamp for
7548: # when it was last modified. It will also return an error of -1
7549: # if an error occurs
7550:
7551: sub GetFileTimestamp {
1.955 raeburn 7552: my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
1.807 albertel 7553: $studentDomain = &LONCAPA::clean_domain($studentDomain);
7554: $studentName = &LONCAPA::clean_username($studentName);
1.955 raeburn 7555: my ($fileStat) =
7556: &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
7557: undef,$getuserdir);
1.275 stredwic 7558: my @stats = split('&', $fileStat);
7559: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
1.375 matthew 7560: # @stats contains first the filename, then the stat output
7561: return $stats[10]; # so this is 10 instead of 9.
1.275 stredwic 7562: } else {
7563: return -1;
1.253 stredwic 7564: }
1.26 www 7565: }
7566:
1.712 albertel 7567: sub stat_file {
7568: my ($uri) = @_;
1.787 albertel 7569: $uri = &clutter_with_no_wrapper($uri);
1.722 albertel 7570:
1.955 raeburn 7571: my ($udom,$uname,$file);
1.712 albertel 7572: if ($uri =~ m-^/(uploaded|editupload)/-) {
7573: ($udom,$uname,$file) =
1.811 albertel 7574: ($uri =~ m-/(?:uploaded|editupload)/?($match_domain)/?($match_name)/?(.*)-);
1.712 albertel 7575: $file = 'userfiles/'.$file;
7576: }
7577: if ($uri =~ m-^/res/-) {
7578: ($udom,$uname) =
1.807 albertel 7579: ($uri =~ m-/(?:res)/?($match_domain)/?($match_username)/-);
1.712 albertel 7580: $file = $uri;
7581: }
7582:
7583: if (!$udom || !$uname || !$file) {
7584: # unable to handle the uri
7585: return ();
7586: }
1.956 raeburn 7587: my $getpropath;
7588: if ($file =~ /^userfiles\//) {
7589: $getpropath = 1;
7590: }
1.955 raeburn 7591: my ($result) = &dirlist($file,$udom,$uname,$getpropath);
1.712 albertel 7592: my @stats = split('&', $result);
1.721 banghart 7593:
1.712 albertel 7594: if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
7595: shift(@stats); #filename is first
7596: return @stats;
7597: }
7598: return ();
7599: }
7600:
1.26 www 7601: # -------------------------------------------------------- Value of a Condition
7602:
1.713 albertel 7603: # gets the value of a specific preevaluated condition
7604: # stored in the string $env{user.state.<cid>}
7605: # or looks up a condition reference in the bighash and if if hasn't
7606: # already been evaluated recurses into docondval to get the value of
7607: # the condition, then memoizing it to
7608: # $env{user.state.<cid>.<condition>}
1.40 www 7609: sub directcondval {
7610: my $number=shift;
1.620 albertel 7611: if (!defined($env{'user.state.'.$env{'request.course.id'}})) {
1.555 albertel 7612: &Apache::lonuserstate::evalstate();
7613: }
1.713 albertel 7614: if (exists($env{'user.state.'.$env{'request.course.id'}.".$number"})) {
7615: return $env{'user.state.'.$env{'request.course.id'}.".$number"};
7616: } elsif ($number =~ /^_/) {
7617: my $sub_condition;
7618: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
7619: &GDBM_READER(),0640)) {
7620: $sub_condition=$bighash{'conditions'.$number};
7621: untie(%bighash);
7622: }
7623: my $value = &docondval($sub_condition);
1.949 raeburn 7624: &appenv({'user.state.'.$env{'request.course.id'}.".$number" => $value});
1.713 albertel 7625: return $value;
7626: }
1.620 albertel 7627: if ($env{'user.state.'.$env{'request.course.id'}}) {
7628: return substr($env{'user.state.'.$env{'request.course.id'}},$number,1);
1.40 www 7629: } else {
7630: return 2;
7631: }
7632: }
7633:
1.713 albertel 7634: # get the collection of conditions for this resource
1.26 www 7635: sub condval {
7636: my $condidx=shift;
1.54 www 7637: my $allpathcond='';
1.713 albertel 7638: foreach my $cond (split(/\|/,$condidx)) {
7639: if (defined($env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond})) {
7640: $allpathcond.=
7641: '('.$env{'acc.cond.'.$env{'request.course.id'}.'.'.$cond}.')|';
7642: }
1.191 harris41 7643: }
1.54 www 7644: $allpathcond=~s/\|$//;
1.713 albertel 7645: return &docondval($allpathcond);
7646: }
7647:
7648: #evaluates an expression of conditions
7649: sub docondval {
7650: my ($allpathcond) = @_;
7651: my $result=0;
7652: if ($env{'request.course.id'}
7653: && defined($allpathcond)) {
7654: my $operand='|';
7655: my @stack;
7656: foreach my $chunk ($allpathcond=~/(\d+|_\d+\.\d+|\(|\)|\&|\|)/g) {
7657: if ($chunk eq '(') {
7658: push @stack,($operand,$result);
7659: } elsif ($chunk eq ')') {
7660: my $before=pop @stack;
7661: if (pop @stack eq '&') {
7662: $result=$result>$before?$before:$result;
7663: } else {
7664: $result=$result>$before?$result:$before;
7665: }
7666: } elsif (($chunk eq '&') || ($chunk eq '|')) {
7667: $operand=$chunk;
7668: } else {
7669: my $new=directcondval($chunk);
7670: if ($operand eq '&') {
7671: $result=$result>$new?$new:$result;
7672: } else {
7673: $result=$result>$new?$result:$new;
7674: }
7675: }
7676: }
1.26 www 7677: }
7678: return $result;
1.421 albertel 7679: }
7680:
7681: # ---------------------------------------------------- Devalidate courseresdata
7682:
7683: sub devalidatecourseresdata {
7684: my ($coursenum,$coursedomain)=@_;
7685: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7686: &devalidate_cache_new('courseres',$hashid);
1.28 www 7687: }
7688:
1.763 www 7689:
1.200 www 7690: # --------------------------------------------------- Course Resourcedata Query
1.878 foxr 7691: #
7692: # Parameters:
7693: # $coursenum - Number of the course.
7694: # $coursedomain - Domain at which the course was created.
7695: # Returns:
7696: # A hash of the course parameters along (I think) with timestamps
7697: # and version info.
1.877 foxr 7698:
1.624 albertel 7699: sub get_courseresdata {
7700: my ($coursenum,$coursedomain)=@_;
1.200 www 7701: my $coursehom=&homeserver($coursenum,$coursedomain);
7702: my $hashid=$coursenum.':'.$coursedomain;
1.599 albertel 7703: my ($result,$cached)=&is_cached_new('courseres',$hashid);
1.624 albertel 7704: my %dumpreply;
1.417 albertel 7705: unless (defined($cached)) {
1.624 albertel 7706: %dumpreply=&dump('resourcedata',$coursedomain,$coursenum);
1.417 albertel 7707: $result=\%dumpreply;
1.251 albertel 7708: my ($tmp) = keys(%dumpreply);
7709: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
1.599 albertel 7710: &do_cache_new('courseres',$hashid,$result,600);
1.306 albertel 7711: } elsif ($tmp =~ /^(con_lost|no_such_host)/) {
7712: return $tmp;
1.416 albertel 7713: } elsif ($tmp =~ /^(error)/) {
1.417 albertel 7714: $result=undef;
1.599 albertel 7715: &do_cache_new('courseres',$hashid,$result,600);
1.250 albertel 7716: }
7717: }
1.624 albertel 7718: return $result;
7719: }
7720:
1.633 albertel 7721: sub devalidateuserresdata {
7722: my ($uname,$udom)=@_;
7723: my $hashid="$udom:$uname";
7724: &devalidate_cache_new('userres',$hashid);
7725: }
7726:
1.624 albertel 7727: sub get_userresdata {
7728: my ($uname,$udom)=@_;
7729: #most student don\'t have any data set, check if there is some data
7730: if (&EXT_cache_status($udom,$uname)) { return undef; }
7731:
7732: my $hashid="$udom:$uname";
7733: my ($result,$cached)=&is_cached_new('userres',$hashid);
7734: if (!defined($cached)) {
7735: my %resourcedata=&dump('resourcedata',$udom,$uname);
7736: $result=\%resourcedata;
7737: &do_cache_new('userres',$hashid,$result,600);
7738: }
7739: my ($tmp)=keys(%$result);
7740: if (($tmp!~/^error\:/) && ($tmp!~/^con_lost/)) {
7741: return $result;
7742: }
7743: #error 2 occurs when the .db doesn't exist
7744: if ($tmp!~/error: 2 /) {
1.672 albertel 7745: &logthis("<font color=\"blue\">WARNING:".
1.624 albertel 7746: " Trying to get resource data for ".
7747: $uname." at ".$udom.": ".
7748: $tmp."</font>");
7749: } elsif ($tmp=~/error: 2 /) {
1.633 albertel 7750: #&EXT_cache_set($udom,$uname);
7751: &do_cache_new('userres',$hashid,undef,600);
1.636 albertel 7752: undef($tmp); # not really an error so don't send it back
1.624 albertel 7753: }
7754: return $tmp;
7755: }
1.879 foxr 7756: #----------------------------------------------- resdata - return resource data
7757: # Purpose:
7758: # Return resource data for either users or for a course.
7759: # Parameters:
7760: # $name - Course/user name.
7761: # $domain - Name of the domain the user/course is registered on.
7762: # $type - Type of thing $name is (must be 'course' or 'user'
7763: # @which - Array of names of resources desired.
7764: # Returns:
7765: # The value of the first reasource in @which that is found in the
7766: # resource hash.
7767: # Exceptional Conditions:
7768: # If the $type passed in is not valid (not the string 'course' or
7769: # 'user', an undefined reference is returned.
7770: # If none of the resources are found, an undef is returned
1.624 albertel 7771: sub resdata {
7772: my ($name,$domain,$type,@which)=@_;
7773: my $result;
7774: if ($type eq 'course') {
7775: $result=&get_courseresdata($name,$domain);
7776: } elsif ($type eq 'user') {
7777: $result=&get_userresdata($name,$domain);
7778: }
7779: if (!ref($result)) { return $result; }
1.251 albertel 7780: foreach my $item (@which) {
1.927 albertel 7781: if (defined($result->{$item->[0]})) {
7782: return [$result->{$item->[0]},$item->[1]];
1.251 albertel 7783: }
1.250 albertel 7784: }
1.291 albertel 7785: return undef;
1.200 www 7786: }
7787:
1.379 matthew 7788: #
7789: # EXT resource caching routines
7790: #
7791:
7792: sub clear_EXT_cache_status {
1.383 albertel 7793: &delenv('cache.EXT.');
1.379 matthew 7794: }
7795:
7796: sub EXT_cache_status {
7797: my ($target_domain,$target_user) = @_;
1.383 albertel 7798: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.620 albertel 7799: if (exists($env{$cachename}) && ($env{$cachename}+600) > time) {
1.379 matthew 7800: # We know already the user has no data
7801: return 1;
7802: } else {
7803: return 0;
7804: }
7805: }
7806:
7807: sub EXT_cache_set {
7808: my ($target_domain,$target_user) = @_;
1.383 albertel 7809: my $cachename = 'cache.EXT.'.$target_user.'.'.$target_domain;
1.949 raeburn 7810: #&appenv({$cachename => time});
1.379 matthew 7811: }
7812:
1.28 www 7813: # --------------------------------------------------------- Value of a Variable
1.58 www 7814: sub EXT {
1.715 albertel 7815:
1.395 albertel 7816: my ($varname,$symbparm,$udom,$uname,$usection,$recurse)=@_;
1.68 www 7817: unless ($varname) { return ''; }
1.218 albertel 7818: #get real user name/domain, courseid and symb
7819: my $courseid;
1.359 albertel 7820: my $publicuser;
1.427 www 7821: if ($symbparm) {
7822: $symbparm=&get_symb_from_alias($symbparm);
7823: }
1.218 albertel 7824: if (!($uname && $udom)) {
1.790 albertel 7825: (my $cursymb,$courseid,$udom,$uname,$publicuser)= &whichuser($symbparm);
1.218 albertel 7826: if (!$symbparm) { $symbparm=$cursymb; }
7827: } else {
1.620 albertel 7828: $courseid=$env{'request.course.id'};
1.218 albertel 7829: }
1.48 www 7830: my ($realm,$space,$qualifier,@therest)=split(/\./,$varname);
7831: my $rest;
1.320 albertel 7832: if (defined($therest[0])) {
1.48 www 7833: $rest=join('.',@therest);
7834: } else {
7835: $rest='';
7836: }
1.320 albertel 7837:
1.57 www 7838: my $qualifierrest=$qualifier;
7839: if ($rest) { $qualifierrest.='.'.$rest; }
7840: my $spacequalifierrest=$space;
7841: if ($qualifierrest) { $spacequalifierrest.='.'.$qualifierrest; }
1.28 www 7842: if ($realm eq 'user') {
1.48 www 7843: # --------------------------------------------------------------- user.resource
7844: if ($space eq 'resource') {
1.651 albertel 7845: if ( (defined($Apache::lonhomework::parsing_a_problem)
7846: || defined($Apache::lonhomework::parsing_a_task))
7847: &&
1.744 albertel 7848: ($symbparm eq &symbread()) ) {
7849: # if we are in the middle of processing the resource the
7850: # get the value we are planning on committing
7851: if (defined($Apache::lonhomework::results{$qualifierrest})) {
7852: return $Apache::lonhomework::results{$qualifierrest};
7853: } else {
7854: return $Apache::lonhomework::history{$qualifierrest};
7855: }
1.335 albertel 7856: } else {
1.359 albertel 7857: my %restored;
1.620 albertel 7858: if ($publicuser || $env{'request.state'} eq 'construct') {
1.359 albertel 7859: %restored=&tmprestore($symbparm,$courseid,$udom,$uname);
7860: } else {
7861: %restored=&restore($symbparm,$courseid,$udom,$uname);
7862: }
1.335 albertel 7863: return $restored{$qualifierrest};
7864: }
1.48 www 7865: # ----------------------------------------------------------------- user.access
7866: } elsif ($space eq 'access') {
1.218 albertel 7867: # FIXME - not supporting calls for a specific user
1.48 www 7868: return &allowed($qualifier,$rest);
7869: # ------------------------------------------ user.preferences, user.environment
7870: } elsif (($space eq 'preferences') || ($space eq 'environment')) {
1.620 albertel 7871: if (($uname eq $env{'user.name'}) &&
7872: ($udom eq $env{'user.domain'})) {
7873: return $env{join('.',('environment',$qualifierrest))};
1.218 albertel 7874: } else {
1.359 albertel 7875: my %returnhash;
7876: if (!$publicuser) {
7877: %returnhash=&userenvironment($udom,$uname,
7878: $qualifierrest);
7879: }
1.218 albertel 7880: return $returnhash{$qualifierrest};
7881: }
1.48 www 7882: # ----------------------------------------------------------------- user.course
7883: } elsif ($space eq 'course') {
1.218 albertel 7884: # FIXME - not supporting calls for a specific user
1.620 albertel 7885: return $env{join('.',('request.course',$qualifier))};
1.48 www 7886: # ------------------------------------------------------------------- user.role
7887: } elsif ($space eq 'role') {
1.218 albertel 7888: # FIXME - not supporting calls for a specific user
1.620 albertel 7889: my ($role,$where)=split(/\./,$env{'request.role'});
1.48 www 7890: if ($qualifier eq 'value') {
7891: return $role;
7892: } elsif ($qualifier eq 'extent') {
7893: return $where;
7894: }
7895: # ----------------------------------------------------------------- user.domain
7896: } elsif ($space eq 'domain') {
1.218 albertel 7897: return $udom;
1.48 www 7898: # ------------------------------------------------------------------- user.name
7899: } elsif ($space eq 'name') {
1.218 albertel 7900: return $uname;
1.48 www 7901: # ---------------------------------------------------- Any other user namespace
1.29 www 7902: } else {
1.359 albertel 7903: my %reply;
7904: if (!$publicuser) {
7905: %reply=&get($space,[$qualifierrest],$udom,$uname);
7906: }
7907: return $reply{$qualifierrest};
1.48 www 7908: }
1.236 www 7909: } elsif ($realm eq 'query') {
7910: # ---------------------------------------------- pull stuff out of query string
1.384 albertel 7911: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},
7912: [$spacequalifierrest]);
1.620 albertel 7913: return $env{'form.'.$spacequalifierrest};
1.236 www 7914: } elsif ($realm eq 'request') {
1.48 www 7915: # ------------------------------------------------------------- request.browser
7916: if ($space eq 'browser') {
1.430 www 7917: if ($qualifier eq 'textremote') {
1.676 albertel 7918: if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
1.430 www 7919: return 1;
7920: } else {
7921: return 0;
7922: }
7923: } else {
1.620 albertel 7924: return $env{'browser.'.$qualifier};
1.430 www 7925: }
1.57 www 7926: # ------------------------------------------------------------ request.filename
7927: } else {
1.620 albertel 7928: return $env{'request.'.$spacequalifierrest};
1.29 www 7929: }
1.28 www 7930: } elsif ($realm eq 'course') {
1.48 www 7931: # ---------------------------------------------------------- course.description
1.620 albertel 7932: return $env{'course.'.$courseid.'.'.$spacequalifierrest};
1.57 www 7933: } elsif ($realm eq 'resource') {
1.165 www 7934:
1.620 albertel 7935: if (defined($courseid) && $courseid eq $env{'request.course.id'}) {
1.539 albertel 7936: if (!$symbparm) { $symbparm=&symbread(); }
7937: }
1.693 albertel 7938:
7939: if ($space eq 'title') {
7940: if (!$symbparm) { $symbparm = $env{'request.filename'}; }
7941: return &gettitle($symbparm);
7942: }
7943:
7944: if ($space eq 'map') {
7945: my ($map) = &decode_symb($symbparm);
7946: return &symbread($map);
7947: }
1.905 albertel 7948: if ($space eq 'filename') {
7949: if ($symbparm) {
7950: return &clutter((&decode_symb($symbparm))[2]);
7951: }
7952: return &hreflocation('',$env{'request.filename'});
7953: }
1.693 albertel 7954:
7955: my ($section, $group, @groups);
1.593 albertel 7956: my ($courselevelm,$courselevel);
1.539 albertel 7957: if ($symbparm && defined($courseid) &&
1.620 albertel 7958: $courseid eq $env{'request.course.id'}) {
1.165 www 7959:
1.218 albertel 7960: #print '<br>'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
1.165 www 7961:
1.60 www 7962: # ----------------------------------------------------- Cascading lookup scheme
1.218 albertel 7963: my $symbp=$symbparm;
1.735 albertel 7964: my $mapp=&deversion((&decode_symb($symbp))[0]);
1.218 albertel 7965:
7966: my $symbparm=$symbp.'.'.$spacequalifierrest;
7967: my $mapparm=$mapp.'___(all).'.$spacequalifierrest;
7968:
1.620 albertel 7969: if (($env{'user.name'} eq $uname) &&
7970: ($env{'user.domain'} eq $udom)) {
7971: $section=$env{'request.course.sec'};
1.733 raeburn 7972: @groups = split(/:/,$env{'request.course.groups'});
7973: @groups=&sort_course_groups($courseid,@groups);
1.218 albertel 7974: } else {
1.539 albertel 7975: if (! defined($usection)) {
1.551 albertel 7976: $section=&getsection($udom,$uname,$courseid);
1.539 albertel 7977: } else {
7978: $section = $usection;
7979: }
1.733 raeburn 7980: @groups = &get_users_groups($udom,$uname,$courseid);
1.218 albertel 7981: }
7982:
7983: my $seclevel=$courseid.'.['.$section.'].'.$spacequalifierrest;
7984: my $seclevelr=$courseid.'.['.$section.'].'.$symbparm;
7985: my $seclevelm=$courseid.'.['.$section.'].'.$mapparm;
7986:
1.593 albertel 7987: $courselevel=$courseid.'.'.$spacequalifierrest;
1.218 albertel 7988: my $courselevelr=$courseid.'.'.$symbparm;
1.593 albertel 7989: $courselevelm=$courseid.'.'.$mapparm;
1.69 www 7990:
1.60 www 7991: # ----------------------------------------------------------- first, check user
1.624 albertel 7992:
7993: my $userreply=&resdata($uname,$udom,'user',
1.927 albertel 7994: ([$courselevelr,'resource'],
7995: [$courselevelm,'map' ],
7996: [$courselevel, 'course' ]));
1.931 albertel 7997: if (defined($userreply)) { return &get_reply($userreply); }
1.95 www 7998:
1.594 albertel 7999: # ------------------------------------------------ second, check some of course
1.684 raeburn 8000: my $coursereply;
1.691 raeburn 8001: if (@groups > 0) {
8002: $coursereply = &check_group_parms($courseid,\@groups,$symbparm,
8003: $mapparm,$spacequalifierrest);
1.927 albertel 8004: if (defined($coursereply)) { return &get_reply($coursereply); }
1.684 raeburn 8005: }
1.96 www 8006:
1.684 raeburn 8007: $coursereply=&resdata($env{'course.'.$courseid.'.num'},
1.927 albertel 8008: $env{'course.'.$courseid.'.domain'},
8009: 'course',
8010: ([$seclevelr, 'resource'],
8011: [$seclevelm, 'map' ],
8012: [$seclevel, 'course' ],
8013: [$courselevelr,'resource']));
8014: if (defined($coursereply)) { return &get_reply($coursereply); }
1.200 www 8015:
1.60 www 8016: # ------------------------------------------------------ third, check map parms
1.218 albertel 8017: my %parmhash=();
8018: my $thisparm='';
8019: if (tie(%parmhash,'GDBM_File',
1.620 albertel 8020: $env{'request.course.fn'}.'_parms.db',
1.256 albertel 8021: &GDBM_READER(),0640)) {
1.218 albertel 8022: $thisparm=$parmhash{$symbparm};
8023: untie(%parmhash);
8024: }
1.927 albertel 8025: if ($thisparm) { return &get_reply([$thisparm,'resource']); }
1.218 albertel 8026: }
1.594 albertel 8027: # ------------------------------------------ fourth, look in resource metadata
1.71 www 8028:
1.218 albertel 8029: $spacequalifierrest=~s/\./\_/;
1.282 albertel 8030: my $filename;
8031: if (!$symbparm) { $symbparm=&symbread(); }
8032: if ($symbparm) {
1.409 www 8033: $filename=(&decode_symb($symbparm))[2];
1.282 albertel 8034: } else {
1.620 albertel 8035: $filename=$env{'request.filename'};
1.282 albertel 8036: }
8037: my $metadata=&metadata($filename,$spacequalifierrest);
1.927 albertel 8038: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.282 albertel 8039: $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
1.927 albertel 8040: if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
1.142 www 8041:
1.927 albertel 8042: # ---------------------------------------------- fourth, look in rest of course
1.593 albertel 8043: if ($symbparm && defined($courseid) &&
1.620 albertel 8044: $courseid eq $env{'request.course.id'}) {
1.624 albertel 8045: my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
8046: $env{'course.'.$courseid.'.domain'},
8047: 'course',
1.927 albertel 8048: ([$courselevelm,'map' ],
8049: [$courselevel, 'course']));
8050: if (defined($coursereply)) { return &get_reply($coursereply); }
1.593 albertel 8051: }
1.145 www 8052: # ------------------------------------------------------------------ Cascade up
1.218 albertel 8053: unless ($space eq '0') {
1.336 albertel 8054: my @parts=split(/_/,$space);
8055: my $id=pop(@parts);
8056: my $part=join('_',@parts);
8057: if ($part eq '') { $part='0'; }
1.927 albertel 8058: my @partgeneral=&EXT('resource.'.$part.'.'.$qualifierrest,
1.395 albertel 8059: $symbparm,$udom,$uname,$section,1);
1.938 raeburn 8060: if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
1.218 albertel 8061: }
1.395 albertel 8062: if ($recurse) { return undef; }
8063: my $pack_def=&packages_tab_default($filename,$varname);
1.927 albertel 8064: if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
1.48 www 8065: # ---------------------------------------------------- Any other user namespace
8066: } elsif ($realm eq 'environment') {
8067: # ----------------------------------------------------------------- environment
1.620 albertel 8068: if (($uname eq $env{'user.name'})&&($udom eq $env{'user.domain'})) {
8069: return $env{'environment.'.$spacequalifierrest};
1.219 albertel 8070: } else {
1.770 albertel 8071: if ($uname eq 'anonymous' && $udom eq '') {
8072: return '';
8073: }
1.219 albertel 8074: my %returnhash=&userenvironment($udom,$uname,
8075: $spacequalifierrest);
8076: return $returnhash{$spacequalifierrest};
8077: }
1.28 www 8078: } elsif ($realm eq 'system') {
1.48 www 8079: # ----------------------------------------------------------------- system.time
8080: if ($space eq 'time') {
8081: return time;
8082: }
1.696 albertel 8083: } elsif ($realm eq 'server') {
8084: # ----------------------------------------------------------------- system.time
8085: if ($space eq 'name') {
8086: return $ENV{'SERVER_NAME'};
8087: }
1.28 www 8088: }
1.48 www 8089: return '';
1.61 www 8090: }
8091:
1.927 albertel 8092: sub get_reply {
8093: my ($reply_value) = @_;
1.940 raeburn 8094: if (ref($reply_value) eq 'ARRAY') {
8095: if (wantarray) {
8096: return @$reply_value;
8097: }
8098: return $reply_value->[0];
8099: } else {
8100: return $reply_value;
1.927 albertel 8101: }
8102: }
8103:
1.691 raeburn 8104: sub check_group_parms {
8105: my ($courseid,$groups,$symbparm,$mapparm,$what) = @_;
8106: my @groupitems = ();
8107: my $resultitem;
1.927 albertel 8108: my @levels = ([$symbparm,'resource'],[$mapparm,'map'],[$what,'course']);
1.691 raeburn 8109: foreach my $group (@{$groups}) {
8110: foreach my $level (@levels) {
1.927 albertel 8111: my $item = $courseid.'.['.$group.'].'.$level->[0];
8112: push(@groupitems,[$item,$level->[1]]);
1.691 raeburn 8113: }
8114: }
8115: my $coursereply = &resdata($env{'course.'.$courseid.'.num'},
8116: $env{'course.'.$courseid.'.domain'},
8117: 'course',@groupitems);
8118: return $coursereply;
8119: }
8120:
8121: sub sort_course_groups { # Sort groups based on defined rankings. Default is sort().
1.733 raeburn 8122: my ($courseid,@groups) = @_;
8123: @groups = sort(@groups);
1.691 raeburn 8124: return @groups;
8125: }
8126:
1.395 albertel 8127: sub packages_tab_default {
8128: my ($uri,$varname)=@_;
8129: my (undef,$part,$name)=split(/\./,$varname);
1.738 albertel 8130:
8131: my (@extension,@specifics,$do_default);
8132: foreach my $package (split(/,/,&metadata($uri,'packages'))) {
1.395 albertel 8133: my ($pack_type,$pack_part)=split(/_/,$package,2);
1.738 albertel 8134: if ($pack_type eq 'default') {
8135: $do_default=1;
8136: } elsif ($pack_type eq 'extension') {
8137: push(@extension,[$package,$pack_type,$pack_part]);
1.885 albertel 8138: } elsif ($pack_part eq $part || $pack_type eq 'part') {
1.848 albertel 8139: # only look at packages defaults for packages that this id is
1.738 albertel 8140: push(@specifics,[$package,$pack_type,$pack_part]);
8141: }
8142: }
8143: # first look for a package that matches the requested part id
8144: foreach my $package (@specifics) {
8145: my (undef,$pack_type,$pack_part)=@{$package};
8146: next if ($pack_part ne $part);
8147: if (defined($packagetab{"$pack_type&$name&default"})) {
8148: return $packagetab{"$pack_type&$name&default"};
8149: }
8150: }
8151: # look for any possible matching non extension_ package
8152: foreach my $package (@specifics) {
8153: my (undef,$pack_type,$pack_part)=@{$package};
1.468 albertel 8154: if (defined($packagetab{"$pack_type&$name&default"})) {
8155: return $packagetab{"$pack_type&$name&default"};
8156: }
1.585 albertel 8157: if ($pack_type eq 'part') { $pack_part='0'; }
1.468 albertel 8158: if (defined($packagetab{$pack_type."_".$pack_part."&$name&default"})) {
8159: return $packagetab{$pack_type."_".$pack_part."&$name&default"};
1.395 albertel 8160: }
8161: }
1.738 albertel 8162: # look for any posible extension_ match
8163: foreach my $package (@extension) {
8164: my ($package,$pack_type)=@{$package};
8165: if (defined($packagetab{"$pack_type&$name&default"})) {
8166: return $packagetab{"$pack_type&$name&default"};
8167: }
8168: if (defined($packagetab{$package."&$name&default"})) {
8169: return $packagetab{$package."&$name&default"};
8170: }
8171: }
8172: # look for a global default setting
8173: if ($do_default && defined($packagetab{"default&$name&default"})) {
8174: return $packagetab{"default&$name&default"};
8175: }
1.395 albertel 8176: return undef;
8177: }
8178:
1.334 albertel 8179: sub add_prefix_and_part {
8180: my ($prefix,$part)=@_;
8181: my $keyroot;
8182: if (defined($prefix) && $prefix !~ /^__/) {
8183: # prefix that has a part already
8184: $keyroot=$prefix;
8185: } elsif (defined($prefix)) {
8186: # prefix that is missing a part
8187: if (defined($part)) { $keyroot='_'.$part.substr($prefix,1); }
8188: } else {
8189: # no prefix at all
8190: if (defined($part)) { $keyroot='_'.$part; }
8191: }
8192: return $keyroot;
8193: }
8194:
1.71 www 8195: # ---------------------------------------------------------------- Get metadata
8196:
1.599 albertel 8197: my %metaentry;
1.71 www 8198: sub metadata {
1.176 www 8199: my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
1.71 www 8200: $uri=&declutter($uri);
1.288 albertel 8201: # if it is a non metadata possible uri return quickly
1.529 albertel 8202: if (($uri eq '') ||
8203: (($uri =~ m|^/*adm/|) &&
1.698 albertel 8204: ($uri !~ m|^adm/includes|) && ($uri !~ m|/bulletinboard$|)) ||
1.924 albertel 8205: ($uri =~ m|/$|) || ($uri =~ m|/.meta$|) ) {
8206: return undef;
8207: }
8208: if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
8209: && &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
1.468 albertel 8210: return undef;
1.288 albertel 8211: }
1.73 www 8212: my $filename=$uri;
8213: $uri=~s/\.meta$//;
1.172 www 8214: #
8215: # Is the metadata already cached?
1.177 www 8216: # Look at timestamp of caching
1.172 www 8217: # Everything is cached by the main uri, libraries are never directly cached
8218: #
1.428 albertel 8219: if (!defined($liburi)) {
1.599 albertel 8220: my ($result,$cached)=&is_cached_new('meta',$uri);
1.428 albertel 8221: if (defined($cached)) { return $result->{':'.$what}; }
8222: }
8223: {
1.172 www 8224: #
8225: # Is this a recursive call for a library?
8226: #
1.599 albertel 8227: # if (! exists($metacache{$uri})) {
8228: # $metacache{$uri}={};
8229: # }
1.924 albertel 8230: my $cachetime = 60*60;
1.171 www 8231: if ($liburi) {
8232: $liburi=&declutter($liburi);
8233: $filename=$liburi;
1.401 bowersj2 8234: } else {
1.599 albertel 8235: &devalidate_cache_new('meta',$uri);
8236: undef(%metaentry);
1.401 bowersj2 8237: }
1.140 www 8238: my %metathesekeys=();
1.73 www 8239: unless ($filename=~/\.meta$/) { $filename.='.meta'; }
1.489 albertel 8240: my $metastring;
1.924 albertel 8241: if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
1.929 albertel 8242: my $which = &hreflocation('','/'.($liburi || $uri));
1.924 albertel 8243: $metastring =
1.929 albertel 8244: &Apache::lonnet::ssi_body($which,
1.924 albertel 8245: ('grade_target' => 'meta'));
8246: $cachetime = 1; # only want this cached in the child not long term
8247: } elsif ($uri !~ m -^(editupload)/-) {
1.543 albertel 8248: my $file=&filelocation('',&clutter($filename));
1.599 albertel 8249: #push(@{$metaentry{$uri.'.file'}},$file);
1.543 albertel 8250: $metastring=&getfile($file);
1.489 albertel 8251: }
1.208 albertel 8252: my $parser=HTML::LCParser->new(\$metastring);
1.71 www 8253: my $token;
1.140 www 8254: undef %metathesekeys;
1.71 www 8255: while ($token=$parser->get_token) {
1.339 albertel 8256: if ($token->[0] eq 'S') {
8257: if (defined($token->[2]->{'package'})) {
1.172 www 8258: #
8259: # This is a package - get package info
8260: #
1.339 albertel 8261: my $package=$token->[2]->{'package'};
8262: my $keyroot=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8263: if (defined($token->[2]->{'id'})) {
8264: $keyroot.='_'.$token->[2]->{'id'};
8265: }
1.599 albertel 8266: if ($metaentry{':packages'}) {
8267: $metaentry{':packages'}.=','.$package.$keyroot;
1.339 albertel 8268: } else {
1.599 albertel 8269: $metaentry{':packages'}=$package.$keyroot;
1.339 albertel 8270: }
1.736 albertel 8271: foreach my $pack_entry (keys(%packagetab)) {
1.432 albertel 8272: my $part=$keyroot;
8273: $part=~s/^\_//;
1.736 albertel 8274: if ($pack_entry=~/^\Q$package\E\&/ ||
8275: $pack_entry=~/^\Q$package\E_0\&/) {
8276: my ($pack,$name,$subp)=split(/\&/,$pack_entry);
1.395 albertel 8277: # ignore package.tab specified default values
8278: # here &package_tab_default() will fetch those
8279: if ($subp eq 'default') { next; }
1.736 albertel 8280: my $value=$packagetab{$pack_entry};
1.432 albertel 8281: my $unikey;
8282: if ($pack =~ /_0$/) {
8283: $unikey='parameter_0_'.$name;
8284: $part=0;
8285: } else {
8286: $unikey='parameter'.$keyroot.'_'.$name;
8287: }
1.339 albertel 8288: if ($subp eq 'display') {
8289: $value.=' [Part: '.$part.']';
8290: }
1.599 albertel 8291: $metaentry{':'.$unikey.'.part'}=$part;
1.395 albertel 8292: $metathesekeys{$unikey}=1;
1.599 albertel 8293: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8294: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.339 albertel 8295: }
1.599 albertel 8296: if (defined($metaentry{':'.$unikey.'.default'})) {
8297: $metaentry{':'.$unikey}=
8298: $metaentry{':'.$unikey.'.default'};
1.356 albertel 8299: }
1.339 albertel 8300: }
8301: }
8302: } else {
1.172 www 8303: #
8304: # This is not a package - some other kind of start tag
1.339 albertel 8305: #
8306: my $entry=$token->[1];
8307: my $unikey;
8308: if ($entry eq 'import') {
8309: $unikey='';
8310: } else {
8311: $unikey=$entry;
8312: }
8313: $unikey.=&add_prefix_and_part($prefix,$token->[2]->{'part'});
8314:
8315: if (defined($token->[2]->{'id'})) {
8316: $unikey.='_'.$token->[2]->{'id'};
8317: }
1.175 www 8318:
1.339 albertel 8319: if ($entry eq 'import') {
1.175 www 8320: #
8321: # Importing a library here
1.339 albertel 8322: #
8323: if ($depthcount<20) {
8324: my $location=$parser->get_text('/import');
8325: my $dir=$filename;
8326: $dir=~s|[^/]*$||;
8327: $location=&filelocation($dir,$location);
1.736 albertel 8328: my $metadata =
8329: &metadata($uri,'keys', $location,$unikey,
8330: $depthcount+1);
8331: foreach my $meta (split(',',$metadata)) {
8332: $metaentry{':'.$meta}=$metaentry{':'.$meta};
8333: $metathesekeys{$meta}=1;
1.339 albertel 8334: }
8335: }
8336: } else {
8337:
8338: if (defined($token->[2]->{'name'})) {
8339: $unikey.='_'.$token->[2]->{'name'};
8340: }
8341: $metathesekeys{$unikey}=1;
1.736 albertel 8342: foreach my $param (@{$token->[3]}) {
8343: $metaentry{':'.$unikey.'.'.$param} =
8344: $token->[2]->{$param};
1.339 albertel 8345: }
8346: my $internaltext=&HTML::Entities::decode($parser->get_text('/'.$entry));
1.599 albertel 8347: my $default=$metaentry{':'.$unikey.'.default'};
1.339 albertel 8348: if ( $internaltext =~ /^\s*$/ && $default !~ /^\s*$/) {
8349: # only ws inside the tag, and not in default, so use default
8350: # as value
1.599 albertel 8351: $metaentry{':'.$unikey}=$default;
1.908 albertel 8352: } elsif ( $internaltext =~ /\S/ ) {
8353: # something interesting inside the tag
8354: $metaentry{':'.$unikey}=$internaltext;
1.339 albertel 8355: } else {
1.908 albertel 8356: # no interesting values, don't set a default
1.339 albertel 8357: }
1.172 www 8358: # end of not-a-package not-a-library import
1.339 albertel 8359: }
1.172 www 8360: # end of not-a-package start tag
1.339 albertel 8361: }
1.172 www 8362: # the next is the end of "start tag"
1.339 albertel 8363: }
8364: }
1.483 albertel 8365: my ($extension) = ($uri =~ /\.(\w+)$/);
1.883 albertel 8366: $extension = lc($extension);
8367: if ($extension eq 'htm') { $extension='html'; }
8368:
1.737 albertel 8369: foreach my $key (keys(%packagetab)) {
1.483 albertel 8370: #no specific packages #how's our extension
8371: if ($key!~/^extension_\Q$extension\E&/) { next; }
1.488 albertel 8372: &metadata_create_package_def($uri,$key,'extension_'.$extension,
1.483 albertel 8373: \%metathesekeys);
8374: }
1.883 albertel 8375:
8376: if (!exists($metaentry{':packages'})
8377: || $packagetab{"import_defaults&extension_$extension"}) {
1.737 albertel 8378: foreach my $key (keys(%packagetab)) {
1.483 albertel 8379: #no specific packages well let's get default then
8380: if ($key!~/^default&/) { next; }
1.488 albertel 8381: &metadata_create_package_def($uri,$key,'default',
1.483 albertel 8382: \%metathesekeys);
8383: }
8384: }
1.338 www 8385: # are there custom rights to evaluate
1.599 albertel 8386: if ($metaentry{':copyright'} eq 'custom') {
1.339 albertel 8387:
1.338 www 8388: #
8389: # Importing a rights file here
1.339 albertel 8390: #
8391: unless ($depthcount) {
1.599 albertel 8392: my $location=$metaentry{':customdistributionfile'};
1.339 albertel 8393: my $dir=$filename;
8394: $dir=~s|[^/]*$||;
8395: $location=&filelocation($dir,$location);
1.736 albertel 8396: my $rights_metadata =
8397: &metadata($uri,'keys',$location,'_rights',
8398: $depthcount+1);
8399: foreach my $rights (split(',',$rights_metadata)) {
8400: #$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
8401: $metathesekeys{$rights}=1;
1.339 albertel 8402: }
8403: }
8404: }
1.737 albertel 8405: # uniqifiy package listing
8406: my %seen;
8407: my @uniq_packages =
8408: grep { ! $seen{$_} ++ } (split(',',$metaentry{':packages'}));
8409: $metaentry{':packages'} = join(',',@uniq_packages);
8410:
8411: $metaentry{':keys'} = join(',',keys(%metathesekeys));
1.599 albertel 8412: &metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
8413: $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
1.924 albertel 8414: &do_cache_new('meta',$uri,\%metaentry,$cachetime);
1.177 www 8415: # this is the end of "was not already recently cached
1.71 www 8416: }
1.599 albertel 8417: return $metaentry{':'.$what};
1.261 albertel 8418: }
8419:
1.488 albertel 8420: sub metadata_create_package_def {
1.483 albertel 8421: my ($uri,$key,$package,$metathesekeys)=@_;
8422: my ($pack,$name,$subp)=split(/\&/,$key);
8423: if ($subp eq 'default') { next; }
8424:
1.599 albertel 8425: if (defined($metaentry{':packages'})) {
8426: $metaentry{':packages'}.=','.$package;
1.483 albertel 8427: } else {
1.599 albertel 8428: $metaentry{':packages'}=$package;
1.483 albertel 8429: }
8430: my $value=$packagetab{$key};
8431: my $unikey;
8432: $unikey='parameter_0_'.$name;
1.599 albertel 8433: $metaentry{':'.$unikey.'.part'}=0;
1.483 albertel 8434: $$metathesekeys{$unikey}=1;
1.599 albertel 8435: unless (defined($metaentry{':'.$unikey.'.'.$subp})) {
8436: $metaentry{':'.$unikey.'.'.$subp}=$value;
1.483 albertel 8437: }
1.599 albertel 8438: if (defined($metaentry{':'.$unikey.'.default'})) {
8439: $metaentry{':'.$unikey}=
8440: $metaentry{':'.$unikey.'.default'};
1.483 albertel 8441: }
8442: }
8443:
1.261 albertel 8444: sub metadata_generate_part0 {
8445: my ($metadata,$metacache,$uri) = @_;
8446: my %allnames;
1.737 albertel 8447: foreach my $metakey (keys(%$metadata)) {
1.261 albertel 8448: if ($metakey=~/^parameter\_(.*)/) {
1.428 albertel 8449: my $part=$$metacache{':'.$metakey.'.part'};
8450: my $name=$$metacache{':'.$metakey.'.name'};
1.356 albertel 8451: if (! exists($$metadata{'parameter_0_'.$name.'.name'})) {
1.261 albertel 8452: $allnames{$name}=$part;
8453: }
8454: }
8455: }
8456: foreach my $name (keys(%allnames)) {
8457: $$metadata{"parameter_0_$name"}=1;
1.428 albertel 8458: my $key=":parameter_0_$name";
1.261 albertel 8459: $$metacache{"$key.part"}='0';
8460: $$metacache{"$key.name"}=$name;
1.428 albertel 8461: $$metacache{"$key.type"}=$$metacache{':parameter_'.
1.261 albertel 8462: $allnames{$name}.'_'.$name.
8463: '.type'};
1.428 albertel 8464: my $olddis=$$metacache{':parameter_'.$allnames{$name}.'_'.$name.
1.261 albertel 8465: '.display'};
1.644 www 8466: my $expr='[Part: '.$allnames{$name}.']';
1.479 albertel 8467: $olddis=~s/\Q$expr\E/\[Part: 0\]/;
1.261 albertel 8468: $$metacache{"$key.display"}=$olddis;
8469: }
1.71 www 8470: }
8471:
1.764 albertel 8472: # ------------------------------------------------------ Devalidate title cache
8473:
8474: sub devalidate_title_cache {
8475: my ($url)=@_;
8476: if (!$env{'request.course.id'}) { return; }
8477: my $symb=&symbread($url);
8478: if (!$symb) { return; }
8479: my $key=$env{'request.course.id'}."\0".$symb;
8480: &devalidate_cache_new('title',$key);
8481: }
8482:
1.1014 droeschl 8483: # ------------------------------------------------- Get the title of a course
8484:
8485: sub current_course_title {
8486: return $env{ 'course.' . $env{'request.course.id'} . '.description' };
8487: }
1.301 www 8488: # ------------------------------------------------- Get the title of a resource
8489:
8490: sub gettitle {
8491: my $urlsymb=shift;
8492: my $symb=&symbread($urlsymb);
1.534 albertel 8493: if ($symb) {
1.620 albertel 8494: my $key=$env{'request.course.id'}."\0".$symb;
1.599 albertel 8495: my ($result,$cached)=&is_cached_new('title',$key);
1.575 albertel 8496: if (defined($cached)) {
8497: return $result;
8498: }
1.534 albertel 8499: my ($map,$resid,$url)=&decode_symb($symb);
8500: my $title='';
1.907 albertel 8501: if (!$map && $resid == 0 && $url =~/default\.sequence$/) {
8502: $title = $env{'course.'.$env{'request.course.id'}.'.description'};
8503: } else {
8504: if (tie(my %bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
8505: &GDBM_READER(),0640)) {
8506: my $mapid=$bighash{'map_pc_'.&clutter($map)};
8507: $title=$bighash{'title_'.$mapid.'.'.$resid};
8508: untie(%bighash);
8509: }
1.534 albertel 8510: }
8511: $title=~s/\&colon\;/\:/gs;
8512: if ($title) {
1.599 albertel 8513: return &do_cache_new('title',$key,$title,600);
1.534 albertel 8514: }
8515: $urlsymb=$url;
8516: }
8517: my $title=&metadata($urlsymb,'title');
8518: if (!$title) { $title=(split('/',$urlsymb))[-1]; }
8519: return $title;
1.301 www 8520: }
1.613 albertel 8521:
1.614 albertel 8522: sub get_slot {
8523: my ($which,$cnum,$cdom)=@_;
8524: if (!$cnum || !$cdom) {
1.790 albertel 8525: (undef,my $courseid)=&whichuser();
1.620 albertel 8526: $cdom=$env{'course.'.$courseid.'.domain'};
8527: $cnum=$env{'course.'.$courseid.'.num'};
1.614 albertel 8528: }
1.703 albertel 8529: my $key=join("\0",'slots',$cdom,$cnum,$which);
8530: my %slotinfo;
8531: if (exists($remembered{$key})) {
8532: $slotinfo{$which} = $remembered{$key};
8533: } else {
8534: %slotinfo=&get('slots',[$which],$cdom,$cnum);
8535: &Apache::lonhomework::showhash(%slotinfo);
8536: my ($tmp)=keys(%slotinfo);
8537: if ($tmp=~/^error:/) { return (); }
8538: $remembered{$key} = $slotinfo{$which};
8539: }
1.616 albertel 8540: if (ref($slotinfo{$which}) eq 'HASH') {
8541: return %{$slotinfo{$which}};
8542: }
8543: return $slotinfo{$which};
1.614 albertel 8544: }
1.31 www 8545: # ------------------------------------------------- Update symbolic store links
8546:
8547: sub symblist {
8548: my ($mapname,%newhash)=@_;
1.438 www 8549: $mapname=&deversion(&declutter($mapname));
1.31 www 8550: my %hash;
1.620 albertel 8551: if (($env{'request.course.fn'}) && (%newhash)) {
8552: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8553: &GDBM_WRCREAT(),0640)) {
1.1000 raeburn 8554: foreach my $url (keys(%newhash)) {
1.711 albertel 8555: next if ($url eq 'last_known'
8556: && $env{'form.no_update_last_known'});
8557: $hash{declutter($url)}=&encode_symb($mapname,
8558: $newhash{$url}->[1],
8559: $newhash{$url}->[0]);
1.191 harris41 8560: }
1.31 www 8561: if (untie(%hash)) {
8562: return 'ok';
8563: }
8564: }
8565: }
8566: return 'error';
1.212 www 8567: }
8568:
8569: # --------------------------------------------------------------- Verify a symb
8570:
8571: sub symbverify {
1.510 www 8572: my ($symb,$thisurl)=@_;
8573: my $thisfn=$thisurl;
1.439 www 8574: $thisfn=&declutter($thisfn);
1.215 www 8575: # direct jump to resource in page or to a sequence - will construct own symbs
8576: if ($thisfn=~/\.(page|sequence)$/) { return 1; }
8577: # check URL part
1.409 www 8578: my ($map,$resid,$url)=&decode_symb($symb);
1.439 www 8579:
1.431 www 8580: unless ($url eq $thisfn) { return 0; }
1.213 www 8581:
1.216 www 8582: $symb=&symbclean($symb);
1.510 www 8583: $thisurl=&deversion($thisurl);
1.439 www 8584: $thisfn=&deversion($thisfn);
1.213 www 8585:
8586: my %bighash;
8587: my $okay=0;
1.431 www 8588:
1.620 albertel 8589: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8590: &GDBM_READER(),0640)) {
1.1032 raeburn 8591: if (($thisurl =~ m{^/adm/wrapper/ext/}) || ($thisurl =~ m{^ext/})) {
8592: $thisurl =~ s/\?.+$//;
8593: }
1.510 www 8594: my $ids=$bighash{'ids_'.&clutter($thisurl)};
1.216 www 8595: unless ($ids) {
1.510 www 8596: $ids=$bighash{'ids_/'.$thisurl};
1.216 www 8597: }
8598: if ($ids) {
8599: # ------------------------------------------------------------------- Has ID(s)
1.800 albertel 8600: foreach my $id (split(/\,/,$ids)) {
8601: my ($mapid,$resid)=split(/\./,$id);
1.1032 raeburn 8602: if ($thisfn =~ m{^/adm/wrapper/ext/}) {
8603: $symb =~ s/\?.+$//;
8604: }
1.216 www 8605: if (
8606: &symbclean(&declutter($bighash{'map_id_'.$mapid}).'___'.$resid.'___'.$thisfn)
8607: eq $symb) {
1.620 albertel 8608: if (($env{'request.role.adv'}) ||
1.800 albertel 8609: $bighash{'encrypted_'.$id} eq $env{'request.enc'}) {
1.582 albertel 8610: $okay=1;
8611: }
8612: }
1.216 www 8613: }
8614: }
1.213 www 8615: untie(%bighash);
8616: }
8617: return $okay;
1.31 www 8618: }
8619:
1.210 www 8620: # --------------------------------------------------------------- Clean-up symb
8621:
8622: sub symbclean {
8623: my $symb=shift;
1.568 albertel 8624: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
1.210 www 8625: # remove version from map
8626: $symb=~s/\.(\d+)\.(\w+)\_\_\_/\.$2\_\_\_/;
1.215 www 8627:
1.210 www 8628: # remove version from URL
8629: $symb=~s/\.(\d+)\.(\w+)$/\.$2/;
1.213 www 8630:
1.507 www 8631: # remove wrapper
8632:
1.510 www 8633: $symb=~s/(\_\_\_\d+\_\_\_)adm\/wrapper\/(res\/)*/$1/;
1.694 albertel 8634: $symb=~s/(\_\_\_\d+\_\_\_)adm\/coursedocs\/showdoc\/(res\/)*/$1/;
1.210 www 8635: return $symb;
1.409 www 8636: }
8637:
8638: # ---------------------------------------------- Split symb to find map and url
1.429 albertel 8639:
8640: sub encode_symb {
8641: my ($map,$resid,$url)=@_;
8642: return &symbclean(&declutter($map).'___'.$resid.'___'.&declutter($url));
8643: }
1.409 www 8644:
8645: sub decode_symb {
1.568 albertel 8646: my $symb=shift;
8647: if ($symb=~m|^/enc/|) { $symb=&Apache::lonenc::unencrypted($symb); }
8648: my ($map,$resid,$url)=split(/___/,$symb);
1.413 www 8649: return (&fixversion($map),$resid,&fixversion($url));
8650: }
8651:
8652: sub fixversion {
8653: my $fn=shift;
1.609 banghart 8654: if ($fn=~/^(adm|uploaded|editupload|public)/) { return $fn; }
1.435 www 8655: my %bighash;
8656: my $uri=&clutter($fn);
1.620 albertel 8657: my $key=$env{'request.course.id'}.'_'.$uri;
1.440 www 8658: # is this cached?
1.599 albertel 8659: my ($result,$cached)=&is_cached_new('courseresversion',$key);
1.440 www 8660: if (defined($cached)) { return $result; }
8661: # unfortunately not cached, or expired
1.620 albertel 8662: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.440 www 8663: &GDBM_READER(),0640)) {
8664: if ($bighash{'version_'.$uri}) {
8665: my $version=$bighash{'version_'.$uri};
1.444 www 8666: unless (($version eq 'mostrecent') ||
8667: ($version==&getversion($uri))) {
1.440 www 8668: $uri=~s/\.(\w+)$/\.$version\.$1/;
8669: }
8670: }
8671: untie %bighash;
1.413 www 8672: }
1.599 albertel 8673: return &do_cache_new('courseresversion',$key,&declutter($uri),600);
1.438 www 8674: }
8675:
8676: sub deversion {
8677: my $url=shift;
8678: $url=~s/\.\d+\.(\w+)$/\.$1/;
8679: return $url;
1.210 www 8680: }
8681:
1.31 www 8682: # ------------------------------------------------------ Return symb list entry
8683:
8684: sub symbread {
1.249 www 8685: my ($thisfn,$donotrecurse)=@_;
1.542 albertel 8686: my $cache_str='request.symbread.cached.'.$thisfn;
1.620 albertel 8687: if (defined($env{$cache_str})) { return $env{$cache_str}; }
1.242 www 8688: # no filename provided? try from environment
1.44 www 8689: unless ($thisfn) {
1.620 albertel 8690: if ($env{'request.symb'}) {
8691: return $env{$cache_str}=&symbclean($env{'request.symb'});
1.539 albertel 8692: }
1.620 albertel 8693: $thisfn=$env{'request.filename'};
1.44 www 8694: }
1.569 albertel 8695: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.242 www 8696: # is that filename actually a symb? Verify, clean, and return
8697: if ($thisfn=~/\_\_\_\d+\_\_\_(.*)$/) {
1.539 albertel 8698: if (&symbverify($thisfn,$1)) {
1.620 albertel 8699: return $env{$cache_str}=&symbclean($thisfn);
1.539 albertel 8700: }
1.242 www 8701: }
1.44 www 8702: $thisfn=declutter($thisfn);
1.31 www 8703: my %hash;
1.37 www 8704: my %bighash;
8705: my $syval='';
1.620 albertel 8706: if (($env{'request.course.fn'}) && ($thisfn)) {
1.481 raeburn 8707: my $targetfn = $thisfn;
1.609 banghart 8708: if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
1.481 raeburn 8709: $targetfn = 'adm/wrapper/'.$thisfn;
8710: }
1.687 albertel 8711: if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
8712: $targetfn=$1;
8713: }
1.620 albertel 8714: if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.256 albertel 8715: &GDBM_READER(),0640)) {
1.481 raeburn 8716: $syval=$hash{$targetfn};
1.37 www 8717: untie(%hash);
8718: }
8719: # ---------------------------------------------------------- There was an entry
8720: if ($syval) {
1.601 albertel 8721: #unless ($syval=~/\_\d+$/) {
1.620 albertel 8722: #unless ($env{'form.request.prefix'}=~/\.(\d+)\_$/) {
1.949 raeburn 8723: #&appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8724: #return $env{$cache_str}='';
1.601 albertel 8725: #}
8726: #$syval.=$1;
8727: #}
1.37 www 8728: } else {
8729: # ------------------------------------------------------- Was not in symb table
1.620 albertel 8730: if (tie(%bighash,'GDBM_File',$env{'request.course.fn'}.'.db',
1.256 albertel 8731: &GDBM_READER(),0640)) {
1.37 www 8732: # ---------------------------------------------- Get ID(s) for current resource
1.280 www 8733: my $ids=$bighash{'ids_'.&clutter($thisfn)};
1.65 www 8734: unless ($ids) {
8735: $ids=$bighash{'ids_/'.$thisfn};
1.242 www 8736: }
8737: unless ($ids) {
8738: # alias?
8739: $ids=$bighash{'mapalias_'.$thisfn};
1.65 www 8740: }
1.37 www 8741: if ($ids) {
8742: # ------------------------------------------------------------------- Has ID(s)
8743: my @possibilities=split(/\,/,$ids);
1.39 www 8744: if ($#possibilities==0) {
8745: # ----------------------------------------------- There is only one possibility
1.37 www 8746: my ($mapid,$resid)=split(/\./,$ids);
1.626 albertel 8747: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8748: $resid,$thisfn);
1.249 www 8749: } elsif (!$donotrecurse) {
1.39 www 8750: # ------------------------------------------ There is more than one possibility
8751: my $realpossible=0;
1.800 albertel 8752: foreach my $id (@possibilities) {
8753: my $file=$bighash{'src_'.$id};
1.39 www 8754: if (&allowed('bre',$file)) {
1.800 albertel 8755: my ($mapid,$resid)=split(/\./,$id);
1.39 www 8756: if ($bighash{'map_type_'.$mapid} ne 'page') {
8757: $realpossible++;
1.626 albertel 8758: $syval=&encode_symb($bighash{'map_id_'.$mapid},
8759: $resid,$thisfn);
1.39 www 8760: }
8761: }
1.191 harris41 8762: }
1.39 www 8763: if ($realpossible!=1) { $syval=''; }
1.249 www 8764: } else {
8765: $syval='';
1.37 www 8766: }
8767: }
8768: untie(%bighash)
1.481 raeburn 8769: }
1.31 www 8770: }
1.62 www 8771: if ($syval) {
1.620 albertel 8772: return $env{$cache_str}=$syval;
1.62 www 8773: }
1.31 www 8774: }
1.949 raeburn 8775: &appenv({'request.ambiguous' => $thisfn});
1.620 albertel 8776: return $env{$cache_str}='';
1.31 www 8777: }
8778:
8779: # ---------------------------------------------------------- Return random seed
8780:
1.32 www 8781: sub numval {
8782: my $txt=shift;
8783: $txt=~tr/A-J/0-9/;
8784: $txt=~tr/a-j/0-9/;
8785: $txt=~tr/K-T/0-9/;
8786: $txt=~tr/k-t/0-9/;
8787: $txt=~tr/U-Z/0-5/;
8788: $txt=~tr/u-z/0-5/;
8789: $txt=~s/\D//g;
1.564 albertel 8790: if ($_64bit) { if ($txt > 2**32) { return -1; } }
1.32 www 8791: return int($txt);
1.368 albertel 8792: }
8793:
1.484 albertel 8794: sub numval2 {
8795: my $txt=shift;
8796: $txt=~tr/A-J/0-9/;
8797: $txt=~tr/a-j/0-9/;
8798: $txt=~tr/K-T/0-9/;
8799: $txt=~tr/k-t/0-9/;
8800: $txt=~tr/U-Z/0-5/;
8801: $txt=~tr/u-z/0-5/;
8802: $txt=~s/\D//g;
8803: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8804: my $total;
8805: foreach my $val (@txts) { $total+=$val; }
1.564 albertel 8806: if ($_64bit) { if ($total > 2**32) { return -1; } }
1.484 albertel 8807: return int($total);
8808: }
8809:
1.575 albertel 8810: sub numval3 {
8811: use integer;
8812: my $txt=shift;
8813: $txt=~tr/A-J/0-9/;
8814: $txt=~tr/a-j/0-9/;
8815: $txt=~tr/K-T/0-9/;
8816: $txt=~tr/k-t/0-9/;
8817: $txt=~tr/U-Z/0-5/;
8818: $txt=~tr/u-z/0-5/;
8819: $txt=~s/\D//g;
8820: my @txts=split(/(\d\d\d\d\d\d\d\d\d)/,$txt);
8821: my $total;
8822: foreach my $val (@txts) { $total+=$val; }
8823: if ($_64bit) { $total=(($total<<32)>>32); }
8824: return $total;
8825: }
8826:
1.675 albertel 8827: sub digest {
8828: my ($data)=@_;
8829: my $digest=&Digest::MD5::md5($data);
8830: my ($a,$b,$c,$d)=unpack("iiii",$digest);
8831: my ($e,$f);
8832: {
8833: use integer;
8834: $e=($a+$b);
8835: $f=($c+$d);
8836: if ($_64bit) {
8837: $e=(($e<<32)>>32);
8838: $f=(($f<<32)>>32);
8839: }
8840: }
8841: if (wantarray) {
8842: return ($e,$f);
8843: } else {
8844: my $g;
8845: {
8846: use integer;
8847: $g=($e+$f);
8848: if ($_64bit) {
8849: $g=(($g<<32)>>32);
8850: }
8851: }
8852: return $g;
8853: }
8854: }
8855:
1.368 albertel 8856: sub latest_rnd_algorithm_id {
1.675 albertel 8857: return '64bit5';
1.366 albertel 8858: }
1.32 www 8859:
1.503 albertel 8860: sub get_rand_alg {
8861: my ($courseid)=@_;
1.790 albertel 8862: if (!$courseid) { $courseid=(&whichuser())[1]; }
1.503 albertel 8863: if ($courseid) {
1.620 albertel 8864: return $env{"course.$courseid.rndseed"};
1.503 albertel 8865: }
8866: return &latest_rnd_algorithm_id();
8867: }
8868:
1.562 albertel 8869: sub validCODE {
8870: my ($CODE)=@_;
8871: if (defined($CODE) && $CODE ne '' && $CODE =~ /^\w+$/) { return 1; }
8872: return 0;
8873: }
8874:
1.491 albertel 8875: sub getCODE {
1.620 albertel 8876: if (&validCODE($env{'form.CODE'})) { return $env{'form.CODE'}; }
1.618 albertel 8877: if ( (defined($Apache::lonhomework::parsing_a_problem) ||
8878: defined($Apache::lonhomework::parsing_a_task) ) &&
8879: &validCODE($Apache::lonhomework::history{'resource.CODE'})) {
1.491 albertel 8880: return $Apache::lonhomework::history{'resource.CODE'};
8881: }
8882: return undef;
8883: }
8884:
1.31 www 8885: sub rndseed {
1.155 albertel 8886: my ($symb,$courseid,$domain,$username)=@_;
1.790 albertel 8887: my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
1.896 albertel 8888: if (!defined($symb)) {
1.366 albertel 8889: unless ($symb=$wsymb) { return time; }
8890: }
8891: if (!$courseid) { $courseid=$wcourseid; }
8892: if (!$domain) { $domain=$wdomain; }
8893: if (!$username) { $username=$wusername }
1.503 albertel 8894: my $which=&get_rand_alg();
1.803 albertel 8895:
1.491 albertel 8896: if (defined(&getCODE())) {
1.675 albertel 8897: if ($which eq '64bit5') {
8898: return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
8899: } elsif ($which eq '64bit4') {
1.575 albertel 8900: return &rndseed_CODE_64bit4($symb,$courseid,$domain,$username);
8901: } else {
8902: return &rndseed_CODE_64bit($symb,$courseid,$domain,$username);
8903: }
1.675 albertel 8904: } elsif ($which eq '64bit5') {
8905: return &rndseed_64bit5($symb,$courseid,$domain,$username);
1.575 albertel 8906: } elsif ($which eq '64bit4') {
8907: return &rndseed_64bit4($symb,$courseid,$domain,$username);
1.501 albertel 8908: } elsif ($which eq '64bit3') {
8909: return &rndseed_64bit3($symb,$courseid,$domain,$username);
1.443 albertel 8910: } elsif ($which eq '64bit2') {
8911: return &rndseed_64bit2($symb,$courseid,$domain,$username);
1.366 albertel 8912: } elsif ($which eq '64bit') {
8913: return &rndseed_64bit($symb,$courseid,$domain,$username);
8914: }
8915: return &rndseed_32bit($symb,$courseid,$domain,$username);
8916: }
8917:
8918: sub rndseed_32bit {
8919: my ($symb,$courseid,$domain,$username)=@_;
8920: {
8921: use integer;
8922: my $symbchck=unpack("%32C*",$symb) << 27;
8923: my $symbseed=numval($symb) << 22;
8924: my $namechck=unpack("%32C*",$username) << 17;
8925: my $nameseed=numval($username) << 12;
8926: my $domainseed=unpack("%32C*",$domain) << 7;
8927: my $courseseed=unpack("%32C*",$courseid);
8928: my $num=$symbseed+$nameseed+$domainseed+$courseseed+$namechck+$symbchck;
1.790 albertel 8929: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8930: #&logthis("rndseed :$num:$symb");
1.564 albertel 8931: if ($_64bit) { $num=(($num<<32)>>32); }
1.366 albertel 8932: return $num;
8933: }
8934: }
8935:
8936: sub rndseed_64bit {
8937: my ($symb,$courseid,$domain,$username)=@_;
8938: {
8939: use integer;
8940: my $symbchck=unpack("%32S*",$symb) << 21;
8941: my $symbseed=numval($symb) << 10;
8942: my $namechck=unpack("%32S*",$username);
8943:
8944: my $nameseed=numval($username) << 21;
8945: my $domainseed=unpack("%32S*",$domain) << 10;
8946: my $courseseed=unpack("%32S*",$courseid);
8947:
8948: my $num1=$symbchck+$symbseed+$namechck;
8949: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8950: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8951: #&logthis("rndseed :$num:$symb");
1.564 albertel 8952: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.366 albertel 8953: return "$num1,$num2";
1.155 albertel 8954: }
1.366 albertel 8955: }
8956:
1.443 albertel 8957: sub rndseed_64bit2 {
8958: my ($symb,$courseid,$domain,$username)=@_;
8959: {
8960: use integer;
8961: # strings need to be an even # of cahracters long, it it is odd the
8962: # last characters gets thrown away
8963: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8964: my $symbseed=numval($symb) << 10;
8965: my $namechck=unpack("%32S*",$username.' ');
8966:
8967: my $nameseed=numval($username) << 21;
1.501 albertel 8968: my $domainseed=unpack("%32S*",$domain.' ') << 10;
8969: my $courseseed=unpack("%32S*",$courseid.' ');
8970:
8971: my $num1=$symbchck+$symbseed+$namechck;
8972: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 8973: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
8974: #&logthis("rndseed :$num:$symb");
1.803 albertel 8975: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
1.501 albertel 8976: return "$num1,$num2";
8977: }
8978: }
8979:
8980: sub rndseed_64bit3 {
8981: my ($symb,$courseid,$domain,$username)=@_;
8982: {
8983: use integer;
8984: # strings need to be an even # of cahracters long, it it is odd the
8985: # last characters gets thrown away
8986: my $symbchck=unpack("%32S*",$symb.' ') << 21;
8987: my $symbseed=numval2($symb) << 10;
8988: my $namechck=unpack("%32S*",$username.' ');
8989:
8990: my $nameseed=numval2($username) << 21;
1.443 albertel 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 :$num1:$num2:$_64bit");
1.564 albertel 8998: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
8999:
1.503 albertel 9000: return "$num1:$num2";
1.443 albertel 9001: }
9002: }
9003:
1.575 albertel 9004: sub rndseed_64bit4 {
9005: my ($symb,$courseid,$domain,$username)=@_;
9006: {
9007: use integer;
9008: # strings need to be an even # of cahracters long, it it is odd the
9009: # last characters gets thrown away
9010: my $symbchck=unpack("%32S*",$symb.' ') << 21;
9011: my $symbseed=numval3($symb) << 10;
9012: my $namechck=unpack("%32S*",$username.' ');
9013:
9014: my $nameseed=numval3($username) << 21;
9015: my $domainseed=unpack("%32S*",$domain.' ') << 10;
9016: my $courseseed=unpack("%32S*",$courseid.' ');
9017:
9018: my $num1=$symbchck+$symbseed+$namechck;
9019: my $num2=$nameseed+$domainseed+$courseseed;
1.790 albertel 9020: #&logthis("$symbseed:$nameseed;$domainseed|$courseseed;$namechck:$symbchck");
9021: #&logthis("rndseed :$num1:$num2:$_64bit");
1.575 albertel 9022: if ($_64bit) { $num1=(($num1<<32)>>32); $num2=(($num2<<32)>>32); }
9023:
9024: return "$num1:$num2";
9025: }
9026: }
9027:
1.675 albertel 9028: sub rndseed_64bit5 {
9029: my ($symb,$courseid,$domain,$username)=@_;
9030: my ($num1,$num2)=&digest("$symb,$courseid,$domain,$username");
9031: return "$num1:$num2";
9032: }
9033:
1.366 albertel 9034: sub rndseed_CODE_64bit {
9035: my ($symb,$courseid,$domain,$username)=@_;
1.155 albertel 9036: {
1.366 albertel 9037: use integer;
1.443 albertel 9038: my $symbchck=unpack("%32S*",$symb.' ') << 16;
1.484 albertel 9039: my $symbseed=numval2($symb);
1.491 albertel 9040: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9041: my $CODEseed=numval(&getCODE());
1.443 albertel 9042: my $courseseed=unpack("%32S*",$courseid.' ');
1.484 albertel 9043: my $num1=$symbseed+$CODEchck;
9044: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 9045: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9046: #&logthis("rndseed :$num1:$num2:$symb");
1.564 albertel 9047: if ($_64bit) { $num1=(($num1<<32)>>32); }
9048: if ($_64bit) { $num2=(($num2<<32)>>32); }
1.503 albertel 9049: return "$num1:$num2";
1.366 albertel 9050: }
9051: }
9052:
1.575 albertel 9053: sub rndseed_CODE_64bit4 {
9054: my ($symb,$courseid,$domain,$username)=@_;
9055: {
9056: use integer;
9057: my $symbchck=unpack("%32S*",$symb.' ') << 16;
9058: my $symbseed=numval3($symb);
9059: my $CODEchck=unpack("%32S*",&getCODE().' ') << 16;
9060: my $CODEseed=numval3(&getCODE());
9061: my $courseseed=unpack("%32S*",$courseid.' ');
9062: my $num1=$symbseed+$CODEchck;
9063: my $num2=$CODEseed+$courseseed+$symbchck;
1.790 albertel 9064: #&logthis("$symbseed:$CODEchck|$CODEseed:$courseseed:$symbchck");
9065: #&logthis("rndseed :$num1:$num2:$symb");
1.575 albertel 9066: if ($_64bit) { $num1=(($num1<<32)>>32); }
9067: if ($_64bit) { $num2=(($num2<<32)>>32); }
9068: return "$num1:$num2";
9069: }
9070: }
9071:
1.675 albertel 9072: sub rndseed_CODE_64bit5 {
9073: my ($symb,$courseid,$domain,$username)=@_;
9074: my $code = &getCODE();
9075: my ($num1,$num2)=&digest("$symb,$courseid,$code");
9076: return "$num1:$num2";
9077: }
9078:
1.366 albertel 9079: sub setup_random_from_rndseed {
9080: my ($rndseed)=@_;
1.503 albertel 9081: if ($rndseed =~/([,:])/) {
9082: my ($num1,$num2)=split(/[,:]/,$rndseed);
1.366 albertel 9083: &Math::Random::random_set_seed(abs($num1),abs($num2));
9084: } else {
9085: &Math::Random::random_set_seed_from_phrase($rndseed);
1.98 albertel 9086: }
1.36 albertel 9087: }
9088:
1.474 albertel 9089: sub latest_receipt_algorithm_id {
1.835 albertel 9090: return 'receipt3';
1.474 albertel 9091: }
9092:
1.480 www 9093: sub recunique {
9094: my $fucourseid=shift;
9095: my $unique;
1.835 albertel 9096: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2' ||
9097: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9098: $unique=$env{"course.$fucourseid.internal.encseed"};
1.480 www 9099: } else {
9100: $unique=$perlvar{'lonReceipt'};
9101: }
9102: return unpack("%32C*",$unique);
9103: }
9104:
9105: sub recprefix {
9106: my $fucourseid=shift;
9107: my $prefix;
1.835 albertel 9108: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2'||
9109: $env{"course.$fucourseid.receiptalg"} eq 'receipt3' ) {
1.620 albertel 9110: $prefix=$env{"course.$fucourseid.internal.encpref"};
1.480 www 9111: } else {
9112: $prefix=$perlvar{'lonHostID'};
9113: }
9114: return unpack("%32C*",$prefix);
9115: }
9116:
1.76 www 9117: sub ireceipt {
1.474 albertel 9118: my ($funame,$fudom,$fucourseid,$fusymb,$part)=@_;
1.835 albertel 9119:
9120: my $return =&recprefix($fucourseid).'-';
9121:
9122: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt3' ||
9123: $env{'request.state'} eq 'construct') {
9124: $return .= (&digest("$funame,$fudom,$fucourseid,$fusymb,$part")%10000);
9125: return $return;
9126: }
9127:
1.76 www 9128: my $cuname=unpack("%32C*",$funame);
9129: my $cudom=unpack("%32C*",$fudom);
9130: my $cucourseid=unpack("%32C*",$fucourseid);
9131: my $cusymb=unpack("%32C*",$fusymb);
1.480 www 9132: my $cunique=&recunique($fucourseid);
1.474 albertel 9133: my $cpart=unpack("%32S*",$part);
1.835 albertel 9134: if ($env{"course.$fucourseid.receiptalg"} eq 'receipt2') {
9135:
1.790 albertel 9136: #&logthis("doing receipt2 using parts $cpart, uname $cuname and udom $cudom gets ".($cpart%$cuname)." and ".($cpart%$cudom));
1.474 albertel 9137:
9138: $return.= ($cunique%$cuname+
9139: $cunique%$cudom+
9140: $cusymb%$cuname+
9141: $cusymb%$cudom+
9142: $cucourseid%$cuname+
9143: $cucourseid%$cudom+
9144: $cpart%$cuname+
9145: $cpart%$cudom);
9146: } else {
9147: $return.= ($cunique%$cuname+
9148: $cunique%$cudom+
9149: $cusymb%$cuname+
9150: $cusymb%$cudom+
9151: $cucourseid%$cuname+
9152: $cucourseid%$cudom);
9153: }
9154: return $return;
1.76 www 9155: }
9156:
9157: sub receipt {
1.474 albertel 9158: my ($part)=@_;
1.790 albertel 9159: my ($symb,$courseid,$domain,$name) = &whichuser();
1.474 albertel 9160: return &ireceipt($name,$domain,$courseid,$symb,$part);
1.76 www 9161: }
1.260 ng 9162:
1.790 albertel 9163: sub whichuser {
9164: my ($passedsymb)=@_;
9165: my ($symb,$courseid,$domain,$name,$publicuser);
9166: if (defined($env{'form.grade_symb'})) {
9167: my ($tmp_courseid)=&get_env_multiple('form.grade_courseid');
9168: my $allowed=&allowed('vgr',$tmp_courseid);
9169: if (!$allowed &&
9170: exists($env{'request.course.sec'}) &&
9171: $env{'request.course.sec'} !~ /^\s*$/) {
9172: $allowed=&allowed('vgr',$tmp_courseid.
9173: '/'.$env{'request.course.sec'});
9174: }
9175: if ($allowed) {
9176: ($symb)=&get_env_multiple('form.grade_symb');
9177: $courseid=$tmp_courseid;
9178: ($domain)=&get_env_multiple('form.grade_domain');
9179: ($name)=&get_env_multiple('form.grade_username');
9180: return ($symb,$courseid,$domain,$name,$publicuser);
9181: }
9182: }
9183: if (!$passedsymb) {
9184: $symb=&symbread();
9185: } else {
9186: $symb=$passedsymb;
9187: }
9188: $courseid=$env{'request.course.id'};
9189: $domain=$env{'user.domain'};
9190: $name=$env{'user.name'};
9191: if ($name eq 'public' && $domain eq 'public') {
9192: if (!defined($env{'form.username'})) {
9193: $env{'form.username'}.=time.rand(10000000);
9194: }
9195: $name.=$env{'form.username'};
9196: }
9197: return ($symb,$courseid,$domain,$name,$publicuser);
9198:
9199: }
9200:
1.36 albertel 9201: # ------------------------------------------------------------ Serves up a file
1.472 albertel 9202: # returns either the contents of the file or
9203: # -1 if the file doesn't exist
1.481 raeburn 9204: #
9205: # if the target is a file that was uploaded via DOCS,
9206: # a check will be made to see if a current copy exists on the local server,
9207: # if it does this will be served, otherwise a copy will be retrieved from
9208: # the home server for the course and stored in /home/httpd/html/userfiles on
9209: # the local server.
1.472 albertel 9210:
1.36 albertel 9211: sub getfile {
1.538 albertel 9212: my ($file) = @_;
1.609 banghart 9213: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.538 albertel 9214: &repcopy($file);
9215: return &readfile($file);
9216: }
9217:
9218: sub repcopy_userfile {
9219: my ($file)=@_;
1.609 banghart 9220: if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
1.610 albertel 9221: if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
1.538 albertel 9222: my ($cdom,$cnum,$filename) =
1.811 albertel 9223: ($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
1.538 albertel 9224: my $uri="/uploaded/$cdom/$cnum/$filename";
9225: if (-e "$file") {
1.828 www 9226: # we already have a local copy, check it out
1.538 albertel 9227: my @fileinfo = stat($file);
1.828 www 9228: my $rtncode;
9229: my $info;
1.538 albertel 9230: my $lwpresp = &getuploaded('HEAD',$uri,$cdom,$cnum,\$info,\$rtncode);
1.482 albertel 9231: if ($lwpresp ne 'ok') {
1.828 www 9232: # there is no such file anymore, even though we had a local copy
1.482 albertel 9233: if ($rtncode eq '404') {
1.538 albertel 9234: unlink($file);
1.482 albertel 9235: }
9236: return -1;
9237: }
9238: if ($info < $fileinfo[9]) {
1.828 www 9239: # nice, the file we have is up-to-date, just say okay
1.607 raeburn 9240: return 'ok';
1.828 www 9241: } else {
9242: # the file is outdated, get rid of it
9243: unlink($file);
1.482 albertel 9244: }
1.828 www 9245: }
9246: # one way or the other, at this point, we don't have the file
9247: # construct the correct path for the file
9248: my @parts = ($cdom,$cnum);
9249: if ($filename =~ m|^(.+)/[^/]+$|) {
9250: push @parts, split(/\//,$1);
9251: }
9252: my $path = $perlvar{'lonDocRoot'}.'/userfiles';
9253: foreach my $part (@parts) {
9254: $path .= '/'.$part;
9255: if (!-e $path) {
9256: mkdir($path,0770);
1.482 albertel 9257: }
9258: }
1.828 www 9259: # now the path exists for sure
9260: # get a user agent
9261: my $ua=new LWP::UserAgent;
9262: my $transferfile=$file.'.in.transfer';
9263: # FIXME: this should flock
9264: if (-e $transferfile) { return 'ok'; }
9265: my $request;
9266: $uri=~s/^\///;
1.980 raeburn 9267: my $homeserver = &homeserver($cnum,$cdom);
9268: my $protocol = $protocol{$homeserver};
9269: $protocol = 'http' if ($protocol ne 'https');
9270: $request=new HTTP::Request('GET',$protocol.'://'.&hostname($homeserver).'/raw/'.$uri);
1.828 www 9271: my $response=$ua->request($request,$transferfile);
9272: # did it work?
9273: if ($response->is_error()) {
9274: unlink($transferfile);
9275: &logthis("Userfile repcopy failed for $uri");
9276: return -1;
9277: }
9278: # worked, rename the transfer file
9279: rename($transferfile,$file);
1.607 raeburn 9280: return 'ok';
1.481 raeburn 9281: }
9282:
1.517 albertel 9283: sub tokenwrapper {
9284: my $uri=shift;
1.980 raeburn 9285: $uri=~s|^https?\://([^/]+)||;
1.552 albertel 9286: $uri=~s|^/||;
1.620 albertel 9287: $env{'user.environment'}=~/\/([^\/]+)\.id/;
1.517 albertel 9288: my $token=$1;
1.552 albertel 9289: my (undef,$udom,$uname,$file)=split('/',$uri,4);
9290: if ($udom && $uname && $file) {
9291: $file=~s|(\?\.*)*$||;
1.949 raeburn 9292: &appenv({"userfile.$udom/$uname/$file" => $env{'request.course.id'}});
1.980 raeburn 9293: my $homeserver = &homeserver($uname,$udom);
9294: my $protocol = $protocol{$homeserver};
9295: $protocol = 'http' if ($protocol ne 'https');
9296: return $protocol.'://'.&hostname($homeserver).'/'.$uri.
1.517 albertel 9297: (($uri=~/\?/)?'&':'?').'token='.$token.
9298: '&tokenissued='.$perlvar{'lonHostID'};
9299: } else {
9300: return '/adm/notfound.html';
9301: }
9302: }
9303:
1.828 www 9304: # call with reqtype HEAD: get last modification time
9305: # call with reqtype GET: get the file contents
9306: # Do not call this with reqtype GET for large files! It loads everything into memory
9307: #
1.481 raeburn 9308: sub getuploaded {
9309: my ($reqtype,$uri,$cdom,$cnum,$info,$rtncode) = @_;
9310: $uri=~s/^\///;
1.980 raeburn 9311: my $homeserver = &homeserver($cnum,$cdom);
9312: my $protocol = $protocol{$homeserver};
9313: $protocol = 'http' if ($protocol ne 'https');
9314: $uri = $protocol.'://'.&hostname($homeserver).'/raw/'.$uri;
1.481 raeburn 9315: my $ua=new LWP::UserAgent;
9316: my $request=new HTTP::Request($reqtype,$uri);
9317: my $response=$ua->request($request);
9318: $$rtncode = $response->code;
1.482 albertel 9319: if (! $response->is_success()) {
9320: return 'failed';
9321: }
9322: if ($reqtype eq 'HEAD') {
1.486 www 9323: $$info = &HTTP::Date::str2time( $response->header('Last-modified') );
1.482 albertel 9324: } elsif ($reqtype eq 'GET') {
9325: $$info = $response->content;
1.472 albertel 9326: }
1.482 albertel 9327: return 'ok';
1.36 albertel 9328: }
9329:
1.481 raeburn 9330: sub readfile {
9331: my $file = shift;
9332: if ( (! -e $file ) || ($file eq '') ) { return -1; };
9333: my $fh;
9334: open($fh,"<$file");
9335: my $a='';
1.800 albertel 9336: while (my $line = <$fh>) { $a .= $line; }
1.481 raeburn 9337: return $a;
9338: }
9339:
1.36 albertel 9340: sub filelocation {
1.590 banghart 9341: my ($dir,$file) = @_;
9342: my $location;
9343: $file=~ s/^\s*(\S+)\s*$/$1/; ## strip off leading and trailing spaces
1.700 albertel 9344:
9345: if ($file =~ m-^/adm/-) {
9346: $file=~s-^/adm/wrapper/-/-;
9347: $file=~s-^/adm/coursedocs/showdoc/-/-;
9348: }
1.882 albertel 9349:
1.590 banghart 9350: if ($file=~m:^/~:) { # is a contruction space reference
9351: $location = $file;
9352: $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
1.807 albertel 9353: } elsif ($file=~m{^/home/$match_username/public_html/}) {
1.649 albertel 9354: # is a correct contruction space reference
9355: $location = $file;
1.956 raeburn 9356: } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
9357: $location = $file;
1.609 banghart 9358: } elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
1.590 banghart 9359: my ($udom,$uname,$filename)=
1.811 albertel 9360: ($file=~m -^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$-);
1.590 banghart 9361: my $home=&homeserver($uname,$udom);
9362: my $is_me=0;
9363: my @ids=¤t_machine_ids();
9364: foreach my $id (@ids) { if ($id eq $home) { $is_me=1; } }
9365: if ($is_me) {
1.955 raeburn 9366: $location=&propath($udom,$uname).'/userfiles/'.$filename;
1.590 banghart 9367: } else {
9368: $location=$Apache::lonnet::perlvar{'lonDocRoot'}.'/userfiles/'.
9369: $udom.'/'.$uname.'/'.$filename;
9370: }
1.882 albertel 9371: } elsif ($file =~ m-^/adm/-) {
9372: $location = $perlvar{'lonDocRoot'}.'/'.$file;
1.590 banghart 9373: } else {
9374: $file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
9375: $file=~s:^/res/:/:;
9376: if ( !( $file =~ m:^/:) ) {
9377: $location = $dir. '/'.$file;
9378: } else {
9379: $location = '/home/httpd/html/res'.$file;
9380: }
1.59 albertel 9381: }
1.590 banghart 9382: $location=~s://+:/:g; # remove duplicate /
1.930 albertel 9383: while ($location=~m{/\.\./}) {
9384: if ($location =~ m{/[^/]+/\.\./}) {
9385: $location=~ s{/[^/]+/\.\./}{/}g;
9386: } else {
9387: $location=~ s{/\.\./}{/}g;
9388: }
9389: } #remove dir/..
1.590 banghart 9390: while ($location=~m:/\./:) {$location=~ s:/\./:/:g;} #remove /./
9391: return $location;
1.46 www 9392: }
1.36 albertel 9393:
1.46 www 9394: sub hreflocation {
9395: my ($dir,$file)=@_;
1.980 raeburn 9396: unless (($file=~m-^https?\://-i) || ($file=~m-^/-)) {
1.666 albertel 9397: $file=filelocation($dir,$file);
1.700 albertel 9398: } elsif ($file=~m-^/adm/-) {
9399: $file=~s-^/adm/wrapper/-/-;
9400: $file=~s-^/adm/coursedocs/showdoc/-/-;
1.666 albertel 9401: }
9402: if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
9403: $file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
1.807 albertel 9404: } elsif ($file=~m-/home/($match_username)/public_html/-) {
9405: $file=~s-^/home/($match_username)/public_html/-/~$1/-;
1.666 albertel 9406: } elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
1.811 albertel 9407: $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
1.666 albertel 9408: -/uploaded/$1/$2/-x;
1.46 www 9409: }
1.913 albertel 9410: if ($file=~ m{^/userfiles/}) {
9411: $file =~ s{^/userfiles/}{/uploaded/};
9412: }
1.462 albertel 9413: return $file;
1.465 albertel 9414: }
9415:
9416: sub current_machine_domains {
1.853 albertel 9417: return &machine_domains(&hostname($perlvar{'lonHostID'}));
9418: }
9419:
9420: sub machine_domains {
9421: my ($hostname) = @_;
1.465 albertel 9422: my @domains;
1.838 albertel 9423: my %hostname = &all_hostnames();
1.465 albertel 9424: while( my($id, $name) = each(%hostname)) {
1.467 matthew 9425: # &logthis("-$id-$name-$hostname-");
1.465 albertel 9426: if ($hostname eq $name) {
1.844 albertel 9427: push(@domains,&host_domain($id));
1.465 albertel 9428: }
9429: }
9430: return @domains;
9431: }
9432:
9433: sub current_machine_ids {
1.853 albertel 9434: return &machine_ids(&hostname($perlvar{'lonHostID'}));
9435: }
9436:
9437: sub machine_ids {
9438: my ($hostname) = @_;
9439: $hostname ||= &hostname($perlvar{'lonHostID'});
1.465 albertel 9440: my @ids;
1.888 albertel 9441: my %name_to_host = &all_names();
1.889 albertel 9442: if (ref($name_to_host{$hostname}) eq 'ARRAY') {
9443: return @{ $name_to_host{$hostname} };
9444: }
9445: return;
1.31 www 9446: }
9447:
1.824 raeburn 9448: sub additional_machine_domains {
9449: my @domains;
9450: open(my $fh,"<$perlvar{'lonTabDir'}/expected_domains.tab");
9451: while( my $line = <$fh>) {
9452: $line =~ s/\s//g;
9453: push(@domains,$line);
9454: }
9455: return @domains;
9456: }
9457:
9458: sub default_login_domain {
9459: my $domain = $perlvar{'lonDefDomain'};
9460: my $testdomain=(split(/\./,$ENV{'HTTP_HOST'}))[0];
9461: foreach my $posdom (¤t_machine_domains(),
9462: &additional_machine_domains()) {
9463: if (lc($posdom) eq lc($testdomain)) {
9464: $domain=$posdom;
9465: last;
9466: }
9467: }
9468: return $domain;
9469: }
9470:
1.31 www 9471: # ------------------------------------------------------------- Declutters URLs
9472:
9473: sub declutter {
9474: my $thisfn=shift;
1.569 albertel 9475: if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
1.479 albertel 9476: $thisfn=~s/^\Q$perlvar{'lonDocRoot'}\E//;
1.31 www 9477: $thisfn=~s/^\///;
1.697 albertel 9478: $thisfn=~s|^adm/wrapper/||;
9479: $thisfn=~s|^adm/coursedocs/showdoc/||;
1.31 www 9480: $thisfn=~s/^res\///;
1.1032 raeburn 9481: unless (($thisfn =~ /^ext/) || ($thisfn =~ /\.(page|sequence)___\d+___ext/)) {
9482: $thisfn=~s/\?.+$//;
9483: }
1.268 www 9484: return $thisfn;
9485: }
9486:
9487: # ------------------------------------------------------------- Clutter up URLs
9488:
9489: sub clutter {
9490: my $thisfn='/'.&declutter(shift);
1.887 albertel 9491: if ($thisfn !~ m{^/(uploaded|editupload|adm|userfiles|ext|raw|priv|public)/}
1.884 albertel 9492: || $thisfn =~ m{^/adm/(includes|pages)} ) {
1.270 www 9493: $thisfn='/res'.$thisfn;
9494: }
1.1031 raeburn 9495: if ($thisfn !~m|^/adm|) {
9496: if ($thisfn =~ m|^/ext/|) {
1.694 albertel 9497: $thisfn='/adm/wrapper'.$thisfn;
1.695 albertel 9498: } else {
9499: my ($ext) = ($thisfn =~ /\.(\w+)$/);
9500: my $embstyle=&Apache::loncommon::fileembstyle($ext);
1.698 albertel 9501: if ($embstyle eq 'ssi'
9502: || ($embstyle eq 'hdn')
9503: || ($embstyle eq 'rat')
9504: || ($embstyle eq 'prv')
9505: || ($embstyle eq 'ign')) {
9506: #do nothing with these
9507: } elsif (($embstyle eq 'img')
1.695 albertel 9508: || ($embstyle eq 'emb')
9509: || ($embstyle eq 'wrp')) {
9510: $thisfn='/adm/wrapper'.$thisfn;
1.698 albertel 9511: } elsif ($embstyle eq 'unk'
9512: && $thisfn!~/\.(sequence|page)$/) {
1.695 albertel 9513: $thisfn='/adm/coursedocs/showdoc'.$thisfn;
1.698 albertel 9514: } else {
1.718 www 9515: # &logthis("Got a blank emb style");
1.695 albertel 9516: }
1.694 albertel 9517: }
9518: }
1.31 www 9519: return $thisfn;
1.12 www 9520: }
9521:
1.787 albertel 9522: sub clutter_with_no_wrapper {
9523: my $uri = &clutter(shift);
9524: if ($uri =~ m-^/adm/-) {
9525: $uri =~ s-^/adm/wrapper/-/-;
9526: $uri =~ s-^/adm/coursedocs/showdoc/-/-;
9527: }
9528: return $uri;
9529: }
9530:
1.557 albertel 9531: sub freeze_escape {
9532: my ($value)=@_;
9533: if (ref($value)) {
9534: $value=&nfreeze($value);
9535: return '__FROZEN__'.&escape($value);
9536: }
9537: return &escape($value);
9538: }
9539:
1.11 www 9540:
1.557 albertel 9541: sub thaw_unescape {
9542: my ($value)=@_;
9543: if ($value =~ /^__FROZEN__/) {
9544: substr($value,0,10,undef);
9545: $value=&unescape($value);
9546: return &thaw($value);
9547: }
9548: return &unescape($value);
9549: }
9550:
1.436 albertel 9551: sub correct_line_ends {
9552: my ($result)=@_;
9553: $$result =~s/\r\n/\n/mg;
9554: $$result =~s/\r/\n/mg;
1.415 albertel 9555: }
1.1 albertel 9556: # ================================================================ Main Program
9557:
1.184 www 9558: sub goodbye {
1.204 albertel 9559: &logthis("Starting Shut down");
1.443 albertel 9560: #not converted to using infrastruture and probably shouldn't be
1.870 albertel 9561: &logthis(sprintf("%-20s is %s",'%badServerCache',length(&nfreeze(\%badServerCache))));
1.443 albertel 9562: #converted
1.599 albertel 9563: # &logthis(sprintf("%-20s is %s",'%metacache',scalar(%metacache)));
1.870 albertel 9564: &logthis(sprintf("%-20s is %s",'%homecache',length(&nfreeze(\%homecache))));
9565: # &logthis(sprintf("%-20s is %s",'%titlecache',length(&nfreeze(\%titlecache))));
9566: # &logthis(sprintf("%-20s is %s",'%courseresdatacache',length(&nfreeze(\%courseresdatacache))));
1.425 albertel 9567: #1.1 only
1.870 albertel 9568: # &logthis(sprintf("%-20s is %s",'%userresdatacache',length(&nfreeze(\%userresdatacache))));
9569: # &logthis(sprintf("%-20s is %s",'%getsectioncache',length(&nfreeze(\%getsectioncache))));
9570: # &logthis(sprintf("%-20s is %s",'%courseresversioncache',length(&nfreeze(\%courseresversioncache))));
9571: # &logthis(sprintf("%-20s is %s",'%resversioncache',length(&nfreeze(\%resversioncache))));
9572: &logthis(sprintf("%-20s is %s",'%remembered',length(&nfreeze(\%remembered))));
1.599 albertel 9573: &logthis(sprintf("%-20s is %s",'kicks',$kicks));
9574: &logthis(sprintf("%-20s is %s",'hits',$hits));
1.184 www 9575: &flushcourselogs();
9576: &logthis("Shutting down");
9577: }
9578:
1.852 albertel 9579: sub get_dns {
1.869 albertel 9580: my ($url,$func,$ignore_cache) = @_;
9581: if (!$ignore_cache) {
9582: my ($content,$cached)=
9583: &Apache::lonnet::is_cached_new('dns',$url);
9584: if ($cached) {
9585: &$func($content);
9586: return;
9587: }
9588: }
9589:
9590: my %alldns;
1.852 albertel 9591: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9592: foreach my $dns (<$config>) {
9593: next if ($dns !~ /^\^(\S*)/x);
1.979 raeburn 9594: my $line = $1;
9595: my ($host,$protocol) = split(/:/,$line);
9596: if ($protocol ne 'https') {
9597: $protocol = 'http';
9598: }
9599: $alldns{$host} = $protocol;
1.869 albertel 9600: }
9601: while (%alldns) {
9602: my ($dns) = keys(%alldns);
1.852 albertel 9603: my $ua=new LWP::UserAgent;
1.979 raeburn 9604: my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
1.852 albertel 9605: my $response=$ua->request($request);
1.979 raeburn 9606: delete($alldns{$dns});
1.852 albertel 9607: next if ($response->is_error());
9608: my @content = split("\n",$response->content);
1.869 albertel 9609: &Apache::lonnet::do_cache_new('dns',$url,\@content,30*24*60*60);
1.852 albertel 9610: &$func(\@content);
1.869 albertel 9611: return;
1.852 albertel 9612: }
9613: close($config);
1.871 albertel 9614: my $which = (split('/',$url))[3];
9615: &logthis("unable to contact DNS defaulting to on disk file dns_$which.tab\n");
9616: open($config,"<$perlvar{'lonTabDir'}/dns_$which.tab");
1.869 albertel 9617: my @content = <$config>;
9618: &$func(\@content);
9619: return;
1.852 albertel 9620: }
1.327 albertel 9621: # ------------------------------------------------------------ Read domain file
9622: {
1.852 albertel 9623: my $loaded;
1.846 albertel 9624: my %domain;
9625:
1.852 albertel 9626: sub parse_domain_tab {
9627: my ($lines) = @_;
9628: foreach my $line (@$lines) {
9629: next if ($line =~ /^(\#|\s*$ )/x);
1.403 www 9630:
1.846 albertel 9631: chomp($line);
1.852 albertel 9632: my ($name,@elements) = split(/:/,$line,9);
1.846 albertel 9633: my %this_domain;
9634: foreach my $field ('description', 'auth_def', 'auth_arg_def',
9635: 'lang_def', 'city', 'longi', 'lati',
9636: 'primary') {
9637: $this_domain{$field} = shift(@elements);
9638: }
9639: $domain{$name} = \%this_domain;
1.852 albertel 9640: }
9641: }
1.864 albertel 9642:
9643: sub reset_domain_info {
9644: undef($loaded);
9645: undef(%domain);
9646: }
9647:
1.852 albertel 9648: sub load_domain_tab {
1.869 albertel 9649: my ($ignore_cache) = @_;
9650: &get_dns('/adm/dns/domain',\&parse_domain_tab,$ignore_cache);
1.852 albertel 9651: my $fh;
9652: if (open($fh,"<".$perlvar{'lonTabDir'}.'/domain.tab')) {
9653: my @lines = <$fh>;
9654: &parse_domain_tab(\@lines);
1.448 albertel 9655: }
1.852 albertel 9656: close($fh);
9657: $loaded = 1;
1.327 albertel 9658: }
1.846 albertel 9659:
9660: sub domain {
1.852 albertel 9661: &load_domain_tab() if (!$loaded);
9662:
1.846 albertel 9663: my ($name,$what) = @_;
9664: return if ( !exists($domain{$name}) );
9665:
9666: if (!$what) {
9667: return $domain{$name}{'description'};
9668: }
9669: return $domain{$name}{$what};
9670: }
1.974 raeburn 9671:
9672: sub domain_info {
9673: &load_domain_tab() if (!$loaded);
9674: return %domain;
9675: }
9676:
1.327 albertel 9677: }
9678:
9679:
1.1 albertel 9680: # ------------------------------------------------------------- Read hosts file
9681: {
1.838 albertel 9682: my %hostname;
1.844 albertel 9683: my %hostdom;
1.845 albertel 9684: my %libserv;
1.852 albertel 9685: my $loaded;
1.888 albertel 9686: my %name_to_host;
1.852 albertel 9687:
9688: sub parse_hosts_tab {
9689: my ($file) = @_;
9690: foreach my $configline (@$file) {
9691: next if ($configline =~ /^(\#|\s*$ )/x);
9692: next if ($configline =~ /^\^/);
9693: chomp($configline);
1.968 raeburn 9694: my ($id,$domain,$role,$name,$protocol)=split(/:/,$configline);
1.852 albertel 9695: $name=~s/\s//g;
9696: if ($id && $domain && $role && $name) {
9697: $hostname{$id}=$name;
1.888 albertel 9698: push(@{$name_to_host{$name}}, $id);
1.852 albertel 9699: $hostdom{$id}=$domain;
9700: if ($role eq 'library') { $libserv{$id}=$name; }
1.969 raeburn 9701: if (defined($protocol)) {
9702: if ($protocol eq 'https') {
9703: $protocol{$id} = $protocol;
9704: } else {
9705: $protocol{$id} = 'http';
9706: }
1.968 raeburn 9707: } else {
1.969 raeburn 9708: $protocol{$id} = 'http';
1.968 raeburn 9709: }
1.852 albertel 9710: }
9711: }
9712: }
1.864 albertel 9713:
9714: sub reset_hosts_info {
1.897 albertel 9715: &purge_remembered();
1.864 albertel 9716: &reset_domain_info();
9717: &reset_hosts_ip_info();
1.892 albertel 9718: undef(%name_to_host);
1.864 albertel 9719: undef(%hostname);
9720: undef(%hostdom);
9721: undef(%libserv);
9722: undef($loaded);
9723: }
1.1 albertel 9724:
1.852 albertel 9725: sub load_hosts_tab {
1.869 albertel 9726: my ($ignore_cache) = @_;
9727: &get_dns('/adm/dns/hosts',\&parse_hosts_tab,$ignore_cache);
1.852 albertel 9728: open(my $config,"<$perlvar{'lonTabDir'}/hosts.tab");
9729: my @config = <$config>;
9730: &parse_hosts_tab(\@config);
9731: close($config);
9732: $loaded=1;
1.1 albertel 9733: }
1.852 albertel 9734:
1.838 albertel 9735: sub hostname {
1.852 albertel 9736: &load_hosts_tab() if (!$loaded);
9737:
1.838 albertel 9738: my ($lonid) = @_;
9739: return $hostname{$lonid};
9740: }
1.845 albertel 9741:
1.838 albertel 9742: sub all_hostnames {
1.852 albertel 9743: &load_hosts_tab() if (!$loaded);
9744:
1.838 albertel 9745: return %hostname;
9746: }
1.845 albertel 9747:
1.888 albertel 9748: sub all_names {
9749: &load_hosts_tab() if (!$loaded);
9750:
9751: return %name_to_host;
9752: }
9753:
1.974 raeburn 9754: sub all_host_domain {
9755: &load_hosts_tab() if (!$loaded);
9756: return %hostdom;
9757: }
9758:
1.845 albertel 9759: sub is_library {
1.852 albertel 9760: &load_hosts_tab() if (!$loaded);
9761:
1.845 albertel 9762: return exists($libserv{$_[0]});
9763: }
9764:
9765: sub all_library {
1.852 albertel 9766: &load_hosts_tab() if (!$loaded);
9767:
1.845 albertel 9768: return %libserv;
9769: }
9770:
1.841 albertel 9771: sub get_servers {
1.852 albertel 9772: &load_hosts_tab() if (!$loaded);
9773:
1.841 albertel 9774: my ($domain,$type) = @_;
9775: my %possible_hosts = ($type eq 'library') ? %libserv
9776: : %hostname;
9777: my %result;
1.842 albertel 9778: if (ref($domain) eq 'ARRAY') {
9779: while ( my ($host,$hostname) = each(%possible_hosts)) {
1.843 albertel 9780: if (grep(/^\Q$hostdom{$host}\E$/,@$domain)) {
1.842 albertel 9781: $result{$host} = $hostname;
9782: }
9783: }
9784: } else {
9785: while ( my ($host,$hostname) = each(%possible_hosts)) {
9786: if ($hostdom{$host} eq $domain) {
9787: $result{$host} = $hostname;
9788: }
1.841 albertel 9789: }
9790: }
9791: return %result;
9792: }
1.845 albertel 9793:
1.844 albertel 9794: sub host_domain {
1.852 albertel 9795: &load_hosts_tab() if (!$loaded);
9796:
1.844 albertel 9797: my ($lonid) = @_;
9798: return $hostdom{$lonid};
9799: }
9800:
1.841 albertel 9801: sub all_domains {
1.852 albertel 9802: &load_hosts_tab() if (!$loaded);
9803:
1.841 albertel 9804: my %seen;
9805: my @uniq = grep(!$seen{$_}++, values(%hostdom));
9806: return @uniq;
9807: }
1.1 albertel 9808: }
9809:
1.847 albertel 9810: {
9811: my %iphost;
1.856 albertel 9812: my %name_to_ip;
9813: my %lonid_to_ip;
1.869 albertel 9814:
1.847 albertel 9815: sub get_hosts_from_ip {
9816: my ($ip) = @_;
9817: my %iphosts = &get_iphost();
9818: if (ref($iphosts{$ip})) {
9819: return @{$iphosts{$ip}};
9820: }
9821: return;
1.839 albertel 9822: }
1.864 albertel 9823:
9824: sub reset_hosts_ip_info {
9825: undef(%iphost);
9826: undef(%name_to_ip);
9827: undef(%lonid_to_ip);
9828: }
1.856 albertel 9829:
9830: sub get_host_ip {
9831: my ($lonid) = @_;
9832: if (exists($lonid_to_ip{$lonid})) {
9833: return $lonid_to_ip{$lonid};
9834: }
9835: my $name=&hostname($lonid);
9836: my $ip = gethostbyname($name);
9837: return if (!$ip || length($ip) ne 4);
9838: $ip=inet_ntoa($ip);
9839: $name_to_ip{$name} = $ip;
9840: $lonid_to_ip{$lonid} = $ip;
9841: return $ip;
9842: }
1.847 albertel 9843:
9844: sub get_iphost {
1.869 albertel 9845: my ($ignore_cache) = @_;
1.894 albertel 9846:
1.869 albertel 9847: if (!$ignore_cache) {
9848: if (%iphost) {
9849: return %iphost;
9850: }
9851: my ($ip_info,$cached)=
9852: &Apache::lonnet::is_cached_new('iphost','iphost');
9853: if ($cached) {
9854: %iphost = %{$ip_info->[0]};
9855: %name_to_ip = %{$ip_info->[1]};
9856: %lonid_to_ip = %{$ip_info->[2]};
9857: return %iphost;
9858: }
9859: }
1.894 albertel 9860:
9861: # get yesterday's info for fallback
9862: my %old_name_to_ip;
9863: my ($ip_info,$cached)=
9864: &Apache::lonnet::is_cached_new('iphost','iphost');
9865: if ($cached) {
9866: %old_name_to_ip = %{$ip_info->[1]};
9867: }
9868:
1.888 albertel 9869: my %name_to_host = &all_names();
9870: foreach my $name (keys(%name_to_host)) {
1.847 albertel 9871: my $ip;
9872: if (!exists($name_to_ip{$name})) {
9873: $ip = gethostbyname($name);
9874: if (!$ip || length($ip) ne 4) {
1.894 albertel 9875: if (defined($old_name_to_ip{$name})) {
9876: $ip = $old_name_to_ip{$name};
9877: &logthis("Can't find $name defaulting to old $ip");
9878: } else {
9879: &logthis("Name $name no IP found");
9880: next;
9881: }
9882: } else {
9883: $ip=inet_ntoa($ip);
1.847 albertel 9884: }
9885: $name_to_ip{$name} = $ip;
9886: } else {
9887: $ip = $name_to_ip{$name};
1.653 albertel 9888: }
1.888 albertel 9889: foreach my $id (@{ $name_to_host{$name} }) {
9890: $lonid_to_ip{$id} = $ip;
9891: }
9892: push(@{$iphost{$ip}},@{$name_to_host{$name}});
1.598 albertel 9893: }
1.869 albertel 9894: &Apache::lonnet::do_cache_new('iphost','iphost',
9895: [\%iphost,\%name_to_ip,\%lonid_to_ip],
1.894 albertel 9896: 48*60*60);
1.869 albertel 9897:
1.847 albertel 9898: return %iphost;
1.598 albertel 9899: }
9900:
1.992 raeburn 9901: #
9902: # Given a DNS returns the loncapa host name for that DNS
9903: #
9904: sub host_from_dns {
9905: my ($dns) = @_;
9906: my @hosts;
9907: my $ip;
9908:
1.993 raeburn 9909: if (exists($name_to_ip{$dns})) {
1.992 raeburn 9910: $ip = $name_to_ip{$dns};
9911: }
9912: if (!$ip) {
9913: $ip = gethostbyname($dns); # Initial translation to IP is in net order.
9914: if (length($ip) == 4) {
9915: $ip = &IO::Socket::inet_ntoa($ip);
9916: }
9917: }
9918: if ($ip) {
9919: @hosts = get_hosts_from_ip($ip);
9920: return $hosts[0];
9921: }
9922: return undef;
1.986 foxr 9923: }
1.992 raeburn 9924:
1.986 foxr 9925: }
9926:
1.862 albertel 9927: BEGIN {
9928:
9929: # ----------------------------------- Read loncapa.conf and loncapa_apache.conf
9930: unless ($readit) {
9931: {
9932: my $configvars = LONCAPA::Configuration::read_conf('loncapa.conf');
9933: %perlvar = (%perlvar,%{$configvars});
9934: }
9935:
9936:
1.1 albertel 9937: # ------------------------------------------------------ Read spare server file
9938: {
1.448 albertel 9939: open(my $config,"<$perlvar{'lonTabDir'}/spare.tab");
1.1 albertel 9940:
9941: while (my $configline=<$config>) {
9942: chomp($configline);
1.284 matthew 9943: if ($configline) {
1.784 albertel 9944: my ($host,$type) = split(':',$configline,2);
1.785 albertel 9945: if (!defined($type) || $type eq '') { $type = 'default' };
1.784 albertel 9946: push(@{ $spareid{$type} }, $host);
1.1 albertel 9947: }
9948: }
1.448 albertel 9949: close($config);
1.1 albertel 9950: }
1.11 www 9951: # ------------------------------------------------------------ Read permissions
9952: {
1.448 albertel 9953: open(my $config,"<$perlvar{'lonTabDir'}/roles.tab");
1.11 www 9954:
9955: while (my $configline=<$config>) {
1.448 albertel 9956: chomp($configline);
9957: if ($configline) {
9958: my ($role,$perm)=split(/ /,$configline);
9959: if ($perm ne '') { $pr{$role}=$perm; }
9960: }
1.11 www 9961: }
1.448 albertel 9962: close($config);
1.11 www 9963: }
9964:
9965: # -------------------------------------------- Read plain texts for permissions
9966: {
1.448 albertel 9967: open(my $config,"<$perlvar{'lonTabDir'}/rolesplain.tab");
1.11 www 9968:
9969: while (my $configline=<$config>) {
1.448 albertel 9970: chomp($configline);
9971: if ($configline) {
1.742 raeburn 9972: my ($short,@plain)=split(/:/,$configline);
9973: %{$prp{$short}} = ();
9974: if (@plain > 0) {
9975: $prp{$short}{'std'} = $plain[0];
9976: for (my $i=1; $i<@plain; $i++) {
9977: $prp{$short}{'alt'.$i} = $plain[$i];
9978: }
9979: }
1.448 albertel 9980: }
1.135 www 9981: }
1.448 albertel 9982: close($config);
1.135 www 9983: }
9984:
9985: # ---------------------------------------------------------- Read package table
9986: {
1.448 albertel 9987: open(my $config,"<$perlvar{'lonTabDir'}/packages.tab");
1.135 www 9988:
9989: while (my $configline=<$config>) {
1.483 albertel 9990: if ($configline !~ /\S/ || $configline=~/^#/) { next; }
1.448 albertel 9991: chomp($configline);
9992: my ($short,$plain)=split(/:/,$configline);
9993: my ($pack,$name)=split(/\&/,$short);
9994: if ($plain ne '') {
9995: $packagetab{$pack.'&'.$name.'&name'}=$name;
9996: $packagetab{$short}=$plain;
9997: }
1.11 www 9998: }
1.448 albertel 9999: close($config);
1.329 matthew 10000: }
10001:
10002: # ------------- set up temporary directory
10003: {
10004: $tmpdir = $perlvar{'lonDaemons'}.'/tmp/';
10005:
1.11 www 10006: }
10007:
1.794 albertel 10008: $memcache=new Cache::Memcached({'servers' => ['127.0.0.1:11211'],
10009: 'compress_threshold'=> 20_000,
10010: });
1.185 www 10011:
1.281 www 10012: $processmarker='_'.time.'_'.$perlvar{'lonHostID'};
1.186 www 10013: $dumpcount=0;
1.958 www 10014: $locknum=0;
1.22 www 10015:
1.163 harris41 10016: &logtouch();
1.672 albertel 10017: &logthis('<font color="yellow">INFO: Read configuration</font>');
1.195 www 10018: $readit=1;
1.564 albertel 10019: {
10020: use integer;
10021: my $test=(2**32)+1;
1.568 albertel 10022: if ($test != 0) { $_64bit=1; } else { $_64bit=0; }
1.564 albertel 10023: &logthis(" Detected 64bit platform ($_64bit)");
10024: }
1.195 www 10025: }
1.1 albertel 10026: }
1.179 www 10027:
1.1 albertel 10028: 1;
1.191 harris41 10029: __END__
10030:
1.243 albertel 10031: =pod
10032:
1.191 harris41 10033: =head1 NAME
10034:
1.243 albertel 10035: Apache::lonnet - Subroutines to ask questions about things in the network.
1.191 harris41 10036:
10037: =head1 SYNOPSIS
10038:
1.243 albertel 10039: Invoked by other LON-CAPA modules, when they need to talk to or about objects in the network.
1.191 harris41 10040:
10041: &Apache::lonnet::SUBROUTINENAME(ARGUMENTS);
10042:
1.243 albertel 10043: Common parameters:
10044:
10045: =over 4
10046:
10047: =item *
10048:
10049: $uname : an internal username (if $cname expecting a course Id specifically)
10050:
10051: =item *
10052:
10053: $udom : a domain (if $cdom expecting a course's domain specifically)
10054:
10055: =item *
10056:
10057: $symb : a resource instance identifier
10058:
10059: =item *
10060:
10061: $namespace : the name of a .db file that contains the data needed or
10062: being set.
10063:
10064: =back
10065:
1.394 bowersj2 10066: =head1 OVERVIEW
1.191 harris41 10067:
1.394 bowersj2 10068: lonnet provides subroutines which interact with the
10069: lonc/lond (TCP) network layer of LON-CAPA. They can be used to ask
10070: about classes, users, and resources.
1.243 albertel 10071:
10072: For many of these objects you can also use this to store data about
10073: them or modify them in various ways.
1.191 harris41 10074:
1.394 bowersj2 10075: =head2 Symbs
1.191 harris41 10076:
1.394 bowersj2 10077: To identify a specific instance of a resource, LON-CAPA uses symbols
10078: or "symbs"X<symb>. These identifiers are built from the URL of the
10079: map, the resource number of the resource in the map, and the URL of
10080: the resource itself. The latter is somewhat redundant, but might help
10081: if maps change.
10082:
10083: An example is
10084:
10085: msu/korte/parts/part1.sequence___19___msu/korte/tests/part12.problem
10086:
10087: The respective map entry is
10088:
10089: <resource id="19" src="/res/msu/korte/tests/part12.problem"
10090: title="Problem 2">
10091: </resource>
10092:
10093: Symbs are used by the random number generator, as well as to store and
10094: restore data specific to a certain instance of for example a problem.
10095:
10096: =head2 Storing And Retrieving Data
10097:
10098: X<store()>X<cstore()>X<restore()>Three of the most important functions
10099: in C<lonnet.pm> are C<&Apache::lonnet::cstore()>,
10100: C<&Apache::lonnet:restore()>, and C<&Apache::lonnet::store()>, which
10101: is is the non-critical message twin of cstore. These functions are for
10102: handlers to store a perl hash to a user's permanent data space in an
10103: easy manner, and to retrieve it again on another call. It is expected
10104: that a handler would use this once at the beginning to retrieve data,
10105: and then again once at the end to send only the new data back.
10106:
10107: The data is stored in the user's data directory on the user's
10108: homeserver under the ID of the course.
10109:
10110: The hash that is returned by restore will have all of the previous
10111: value for all of the elements of the hash.
10112:
10113: Example:
10114:
10115: #creating a hash
10116: my %hash;
10117: $hash{'foo'}='bar';
10118:
10119: #storing it
10120: &Apache::lonnet::cstore(\%hash);
10121:
10122: #changing a value
10123: $hash{'foo'}='notbar';
10124:
10125: #adding a new value
10126: $hash{'bar'}='foo';
10127: &Apache::lonnet::cstore(\%hash);
10128:
10129: #retrieving the hash
10130: my %history=&Apache::lonnet::restore();
10131:
10132: #print the hash
10133: foreach my $key (sort(keys(%history))) {
10134: print("\%history{$key} = $history{$key}");
10135: }
10136:
10137: Will print out:
1.191 harris41 10138:
1.394 bowersj2 10139: %history{1:foo} = bar
10140: %history{1:keys} = foo:timestamp
10141: %history{1:timestamp} = 990455579
10142: %history{2:bar} = foo
10143: %history{2:foo} = notbar
10144: %history{2:keys} = foo:bar:timestamp
10145: %history{2:timestamp} = 990455580
10146: %history{bar} = foo
10147: %history{foo} = notbar
10148: %history{timestamp} = 990455580
10149: %history{version} = 2
10150:
10151: Note that the special hash entries C<keys>, C<version> and
10152: C<timestamp> were added to the hash. C<version> will be equal to the
10153: total number of versions of the data that have been stored. The
10154: C<timestamp> attribute will be the UNIX time the hash was
10155: stored. C<keys> is available in every historical section to list which
10156: keys were added or changed at a specific historical revision of a
10157: hash.
10158:
10159: B<Warning>: do not store the hash that restore returns directly. This
10160: will cause a mess since it will restore the historical keys as if the
10161: were new keys. I.E. 1:foo will become 1:1:foo etc.
1.191 harris41 10162:
1.394 bowersj2 10163: Calling convention:
1.191 harris41 10164:
1.394 bowersj2 10165: my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname,$home);
10166: &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$home);
1.191 harris41 10167:
1.394 bowersj2 10168: For more detailed information, see lonnet specific documentation.
1.191 harris41 10169:
1.394 bowersj2 10170: =head1 RETURN MESSAGES
1.191 harris41 10171:
1.394 bowersj2 10172: =over 4
1.191 harris41 10173:
1.394 bowersj2 10174: =item * B<con_lost>: unable to contact remote host
1.191 harris41 10175:
1.394 bowersj2 10176: =item * B<con_delayed>: unable to contact remote host, message will be delivered
10177: when the connection is brought back up
1.191 harris41 10178:
1.394 bowersj2 10179: =item * B<con_failed>: unable to contact remote host and unable to save message
10180: for later delivery
1.191 harris41 10181:
1.967 bisitz 10182: =item * B<error:>: an error a occurred, a description of the error follows the :
1.191 harris41 10183:
1.394 bowersj2 10184: =item * B<no_such_host>: unable to fund a host associated with the user/domain
1.243 albertel 10185: that was requested
1.191 harris41 10186:
1.243 albertel 10187: =back
1.191 harris41 10188:
1.243 albertel 10189: =head1 PUBLIC SUBROUTINES
1.191 harris41 10190:
1.243 albertel 10191: =head2 Session Environment Functions
1.191 harris41 10192:
1.243 albertel 10193: =over 4
1.191 harris41 10194:
1.394 bowersj2 10195: =item *
10196: X<appenv()>
1.949 raeburn 10197: B<appenv($hashref,$rolesarrayref)>: the value of %{$hashref} is written to
1.394 bowersj2 10198: the user envirnoment file, and will be restored for each access this
1.620 albertel 10199: user makes during this session, also modifies the %env for the current
1.949 raeburn 10200: process. Optional rolesarrayref - if defined contains a reference to an array
10201: of roles which are exempt from the restriction on modifying user.role entries
10202: in the user's environment.db and in %env.
1.191 harris41 10203:
10204: =item *
1.394 bowersj2 10205: X<delenv()>
1.987 raeburn 10206: B<delenv($delthis,$regexp)>: removes all items from the session
10207: environment file that begin with $delthis. If the
10208: optional second arg - $regexp - is true, $delthis is treated as a
10209: regular expression, otherwise \Q$delthis\E is used.
10210: The values are also deleted from the current processes %env.
1.191 harris41 10211:
1.795 albertel 10212: =item * get_env_multiple($name)
10213:
10214: gets $name from the %env hash, it seemlessly handles the cases where multiple
10215: values may be defined and end up as an array ref.
10216:
10217: returns an array of values
10218:
1.243 albertel 10219: =back
10220:
10221: =head2 User Information
1.191 harris41 10222:
1.243 albertel 10223: =over 4
1.191 harris41 10224:
10225: =item *
1.394 bowersj2 10226: X<queryauthenticate()>
10227: B<queryauthenticate($uname,$udom)>: try to determine user's current
1.191 harris41 10228: authentication scheme
10229:
10230: =item *
1.394 bowersj2 10231: X<authenticate()>
10232: B<authenticate($uname,$upass,$udom)>: try to
10233: authenticate user from domain's lib servers (first use the current
10234: one). C<$upass> should be the users password.
1.191 harris41 10235:
10236: =item *
1.394 bowersj2 10237: X<homeserver()>
10238: B<homeserver($uname,$udom)>: find the server which has
10239: the user's directory and files (there must be only one), this caches
10240: the answer, and also caches if there is a borken connection.
1.191 harris41 10241:
10242: =item *
1.394 bowersj2 10243: X<idget()>
10244: B<idget($udom,@ids)>: find the usernames behind a list of IDs
10245: (IDs are a unique resource in a domain, there must be only 1 ID per
10246: username, and only 1 username per ID in a specific domain) (returns
10247: hash: id=>name,id=>name)
1.191 harris41 10248:
10249: =item *
1.394 bowersj2 10250: X<idrget()>
10251: B<idrget($udom,@unames)>: find the IDs behind a list of
10252: usernames (returns hash: name=>id,name=>id)
1.191 harris41 10253:
10254: =item *
1.394 bowersj2 10255: X<idput()>
10256: B<idput($udom,%ids)>: store away a list of names and associated IDs
1.191 harris41 10257:
10258: =item *
1.394 bowersj2 10259: X<rolesinit()>
10260: B<rolesinit($udom,$username,$authhost)>: get user privileges
1.243 albertel 10261:
10262: =item *
1.551 albertel 10263: X<getsection()>
10264: B<getsection($udom,$uname,$cname)>: finds the section of student in the
1.243 albertel 10265: course $cname, return section name/number or '' for "not in course"
10266: and '-1' for "no section"
10267:
10268: =item *
1.394 bowersj2 10269: X<userenvironment()>
10270: B<userenvironment($udom,$uname,@what)>: gets the values of the keys
1.243 albertel 10271: passed in @what from the requested user's environment, returns a hash
10272:
1.858 raeburn 10273: =item *
10274: X<userlog_query()>
1.859 albertel 10275: B<userlog_query($uname,$udom,%filters)>: retrieves data from a user's
10276: activity.log file. %filters defines filters applied when parsing the
10277: log file. These can be start or end timestamps, or the type of action
10278: - log to look for Login or Logout events, check for Checkin or
10279: Checkout, role for role selection. The response is in the form
10280: timestamp1:hostid1:event1×tamp2:hostid2:event2 where events are
10281: escaped strings of the action recorded in the activity.log file.
1.858 raeburn 10282:
1.243 albertel 10283: =back
10284:
10285: =head2 User Roles
10286:
10287: =over 4
10288:
10289: =item *
10290:
1.810 raeburn 10291: allowed($priv,$uri,$symb,$role) : check for a user privilege; returns codes for allowed actions
1.243 albertel 10292: F: full access
10293: U,I,K: authentication modes (cxx only)
10294: '': forbidden
10295: 1: user needs to choose course
10296: 2: browse allowed
1.766 albertel 10297: A: passphrase authentication needed
1.243 albertel 10298:
10299: =item *
10300:
10301: definerole($rolename,$sysrole,$domrole,$courole) : define role; define a custom
10302: role rolename set privileges in format of lonTabs/roles.tab for system, domain,
10303: and course level
10304:
10305: =item *
10306:
1.988 raeburn 10307: plaintext($short,$type,$cid,$forcedefault) : return value in %prp hash
10308: (rolesplain.tab); plain text explanation of a user role term.
1.1008 raeburn 10309: $type is Course (default) or Community.
1.988 raeburn 10310: If $forcedefault evaluates to true, text returned will be default
10311: text for $type. Otherwise, if this is a course, the text returned
10312: will be a custom name for the role (if defined in the course's
10313: environment). If no custom name is defined the default is returned.
10314:
1.832 raeburn 10315: =item *
10316:
1.935 raeburn 10317: get_my_roles($uname,$udom,$context,$types,$roles,$roledoms,$withsec) :
1.858 raeburn 10318: All arguments are optional. Returns a hash of a roles, either for
10319: co-author/assistant author roles for a user's Construction Space
1.906 albertel 10320: (default), or if $context is 'userroles', roles for the user himself,
1.933 raeburn 10321: In the hash, keys are set to colon-separated $uname,$udom,$role, and
10322: (optionally) if $withsec is true, a fourth colon-separated item - $section.
10323: For each key, value is set to colon-separated start and end times for
10324: the role. If no username and domain are specified, will default to
1.934 raeburn 10325: current user/domain. Types, roles, and roledoms are references to arrays
1.858 raeburn 10326: of role statuses (active, future or previous), roles
10327: (e.g., cc,in, st etc.) and domains of the roles which can be used
10328: to restrict the list of roles reported. If no array ref is
10329: provided for types, will default to return only active roles.
1.834 albertel 10330:
1.243 albertel 10331: =back
10332:
10333: =head2 User Modification
10334:
10335: =over 4
10336:
10337: =item *
10338:
1.957 raeburn 10339: assignrole($udom,$uname,$url,$role,$end,$start,$deleteflag,$selfenroll,$context) : assign role; give a role to a
1.243 albertel 10340: user for the level given by URL. Optional start and end dates (leave empty
10341: string or zero for "no date")
1.191 harris41 10342:
10343: =item *
10344:
1.243 albertel 10345: changepass($uname,$udom,$currentpass,$newpass,$server) : attempts to
10346: change a users, password, possible return values are: ok,
10347: pwchange_failure, non_authorized, auth_mode_error, unknown_user,
10348: refused
1.191 harris41 10349:
10350: =item *
10351:
1.243 albertel 10352: modifyuserauth($udom,$uname,$umode,$upass) : modify user authentication
1.191 harris41 10353:
10354: =item *
10355:
1.1056.2.1 raeburn 10356: modifyuser($udom,$uname,$uid,$umode,$upass,$first,$middle,$last, $gene,
10357: $forceid,$desiredhome,$email,$inststatus,$candelete) :
10358:
10359: will update user information (firstname,middlename,lastname,generation,
10360: permanentemail), and if forceid is true, student/employee ID also.
10361: A user's institutional affiliation(s) can also be updated.
10362: User information fields will not be overwritten with empty entries
10363: unless the field is included in the $candelete array reference.
10364: This array is included when a single user is modified via "Manage Users",
10365: or when Autoupdate.pl is run by cron in a domain.
1.191 harris41 10366:
10367: =item *
10368:
1.286 matthew 10369: modifystudent
10370:
1.957 raeburn 10371: modify a student's enrollment and identification information.
1.286 matthew 10372: The course id is resolved based on the current users environment.
10373: This means the envoking user must be a course coordinator or otherwise
10374: associated with a course.
10375:
1.297 matthew 10376: This call is essentially a wrapper for lonnet::modifyuser and
10377: lonnet::modify_student_enrollment
1.286 matthew 10378:
10379: Inputs:
10380:
10381: =over 4
10382:
1.957 raeburn 10383: =item B<$udom> Student's loncapa domain
1.286 matthew 10384:
1.957 raeburn 10385: =item B<$uname> Student's loncapa login name
1.286 matthew 10386:
1.964 bisitz 10387: =item B<$uid> Student/Employee ID
1.286 matthew 10388:
1.957 raeburn 10389: =item B<$umode> Student's authentication mode
1.286 matthew 10390:
1.957 raeburn 10391: =item B<$upass> Student's password
1.286 matthew 10392:
1.957 raeburn 10393: =item B<$first> Student's first name
1.286 matthew 10394:
1.957 raeburn 10395: =item B<$middle> Student's middle name
1.286 matthew 10396:
1.957 raeburn 10397: =item B<$last> Student's last name
1.286 matthew 10398:
1.957 raeburn 10399: =item B<$gene> Student's generation
1.286 matthew 10400:
1.957 raeburn 10401: =item B<$usec> Student's section in course
1.286 matthew 10402:
10403: =item B<$end> Unix time of the roles expiration
10404:
10405: =item B<$start> Unix time of the roles start date
10406:
10407: =item B<$forceid> If defined, allow $uid to be changed
10408:
10409: =item B<$desiredhome> server to use as home server for student
10410:
1.957 raeburn 10411: =item B<$email> Student's permanent e-mail address
10412:
10413: =item B<$type> Type of enrollment (auto or manual)
10414:
1.963 raeburn 10415: =item B<$locktype> boolean - enrollment type locked to prevent Autoenroll.pl changing manual to auto
10416:
10417: =item B<$cid> courseID - needed if a course role is assigned by a user whose current role is DC
1.957 raeburn 10418:
1.963 raeburn 10419: =item B<$selfenroll> boolean - 1 if user role change occurred via self-enrollment
1.957 raeburn 10420:
1.963 raeburn 10421: =item B<$context> role change context (shown in User Management Logs display in a course)
1.957 raeburn 10422:
1.963 raeburn 10423: =item B<$inststatus> institutional status of user - : separated string of escaped status types
1.957 raeburn 10424:
1.286 matthew 10425: =back
1.297 matthew 10426:
10427: =item *
10428:
10429: modify_student_enrollment
10430:
10431: Change a students enrollment status in a class. The environment variable
10432: 'role.request.course' must be defined for this function to proceed.
10433:
10434: Inputs:
10435:
10436: =over 4
10437:
10438: =item $udom, students domain
10439:
10440: =item $uname, students name
10441:
10442: =item $uid, students user id
10443:
10444: =item $first, students first name
10445:
10446: =item $middle
10447:
10448: =item $last
10449:
10450: =item $gene
10451:
10452: =item $usec
10453:
10454: =item $end
10455:
10456: =item $start
10457:
1.957 raeburn 10458: =item $type
10459:
10460: =item $locktype
10461:
10462: =item $cid
10463:
10464: =item $selfenroll
10465:
10466: =item $context
10467:
1.297 matthew 10468: =back
10469:
1.191 harris41 10470:
10471: =item *
10472:
1.243 albertel 10473: assigncustomrole($udom,$uname,$url,$rdom,$rnam,$rolename,$end,$start) : assign
10474: custom role; give a custom role to a user for the level given by URL. Specify
10475: name and domain of role author, and role name
1.191 harris41 10476:
10477: =item *
10478:
1.243 albertel 10479: revokerole($udom,$uname,$url,$role) : revoke a role for url
1.191 harris41 10480:
10481: =item *
10482:
1.243 albertel 10483: revokecustomrole($udom,$uname,$url,$role) : revoke a custom role
10484:
10485: =back
10486:
10487: =head2 Course Infomation
10488:
10489: =over 4
1.191 harris41 10490:
10491: =item *
10492:
1.631 albertel 10493: coursedescription($courseid) : returns a hash of information about the
10494: specified course id, including all environment settings for the
10495: course, the description of the course will be in the hash under the
10496: key 'description'
1.191 harris41 10497:
10498: =item *
10499:
1.624 albertel 10500: resdata($name,$domain,$type,@which) : request for current parameter
10501: setting for a specific $type, where $type is either 'course' or 'user',
10502: @what should be a list of parameters to ask about. This routine caches
10503: answers for 5 minutes.
1.243 albertel 10504:
1.877 foxr 10505: =item *
10506:
10507: get_courseresdata($courseid, $domain) : dump the entire course resource
10508: data base, returning a hash that is keyed by the resource name and has
10509: values that are the resource value. I believe that the timestamps and
10510: versions are also returned.
10511:
10512:
1.243 albertel 10513: =back
10514:
10515: =head2 Course Modification
10516:
10517: =over 4
1.191 harris41 10518:
10519: =item *
10520:
1.243 albertel 10521: writecoursepref($courseid,%prefs) : write preferences (environment
10522: database) for a course
1.191 harris41 10523:
10524: =item *
10525:
1.1011 raeburn 10526: createcourse($udom,$description,$url,$course_server,$nonstandard,$inst_code,$course_owner,$crstype,$cnum) : make course
10527:
10528: =item *
10529:
1.1038 raeburn 10530: generate_coursenum($udom,$crstype) : get a unique (unused) course number in domain $udom for course type $crstype (Course or Community).
1.243 albertel 10531:
10532: =back
10533:
10534: =head2 Resource Subroutines
10535:
10536: =over 4
1.191 harris41 10537:
10538: =item *
10539:
1.243 albertel 10540: subscribe($fname) : subscribe to a resource, returns URL if possible (probably should use repcopy instead)
1.191 harris41 10541:
10542: =item *
10543:
1.243 albertel 10544: repcopy($filename) : subscribes to the requested file, and attempts to
10545: replicate from the owning library server, Might return
1.607 raeburn 10546: 'unavailable', 'not_found', 'forbidden', 'ok', or
10547: 'bad_request', also attempts to grab the metadata for the
1.243 albertel 10548: resource. Expects the local filesystem pathname
10549: (/home/httpd/html/res/....)
10550:
10551: =back
10552:
10553: =head2 Resource Information
10554:
10555: =over 4
1.191 harris41 10556:
10557: =item *
10558:
1.243 albertel 10559: EXT($varname,$symb,$udom,$uname) : evaluates and returns the value of
10560: a vairety of different possible values, $varname should be a request
10561: string, and the other parameters can be used to specify who and what
10562: one is asking about.
10563:
10564: Possible values for $varname are environment.lastname (or other item
10565: from the envirnment hash), user.name (or someother aspect about the
10566: user), resource.0.maxtries (or some other part and parameter of a
10567: resource)
1.204 albertel 10568:
10569: =item *
10570:
1.243 albertel 10571: directcondval($number) : get current value of a condition; reads from a state
10572: string
1.204 albertel 10573:
10574: =item *
10575:
1.243 albertel 10576: condval($condidx) : value of condition index based on state
1.204 albertel 10577:
10578: =item *
10579:
1.243 albertel 10580: metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
10581: resource's metadata, $what should be either a specific key, or either
10582: 'keys' (to get a list of possible keys) or 'packages' to get a list of
10583: packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
10584:
10585: this function automatically caches all requests
1.191 harris41 10586:
10587: =item *
10588:
1.243 albertel 10589: metadata_query($query,$custom,$customshow) : make a metadata query against the
10590: network of library servers; returns file handle of where SQL and regex results
10591: will be stored for query
1.191 harris41 10592:
10593: =item *
10594:
1.243 albertel 10595: symbread($filename) : return symbolic list entry (filename argument optional);
10596: returns the data handle
1.191 harris41 10597:
10598: =item *
10599:
1.243 albertel 10600: symbverify($symb,$thisfn) : verifies that $symb actually exists and is
1.582 albertel 10601: a possible symb for the URL in $thisfn, and if is an encryypted
10602: resource that the user accessed using /enc/ returns a 1 on success, 0
10603: on failure, user must be in a course, as it assumes the existance of
1.620 albertel 10604: the course initial hash, and uses $env('request.course.id'}
1.243 albertel 10605:
1.191 harris41 10606:
10607: =item *
10608:
1.243 albertel 10609: symbclean($symb) : removes versions numbers from a symb, returns the
10610: cleaned symb
1.191 harris41 10611:
10612: =item *
10613:
1.243 albertel 10614: is_on_map($uri) : checks if the $uri is somewhere on the current
10615: course map, user must be in a course for it to work.
1.191 harris41 10616:
10617: =item *
10618:
1.243 albertel 10619: numval($salt) : return random seed value (addend for rndseed)
1.191 harris41 10620:
10621: =item *
10622:
1.243 albertel 10623: rndseed($symb,$courseid,$udom,$uname) : create a random sum; returns
10624: a random seed, all arguments are optional, if they aren't sent it uses the
10625: environment to derive them. Note: if symb isn't sent and it can't get one
10626: from &symbread it will use the current time as its return value
1.191 harris41 10627:
10628: =item *
10629:
1.243 albertel 10630: ireceipt($funame,$fudom,$fucourseid,$fusymb) : return unique,
10631: unfakeable, receipt
1.191 harris41 10632:
10633: =item *
10634:
1.620 albertel 10635: receipt() : API to ireceipt working off of env values; given out to users
1.191 harris41 10636:
10637: =item *
10638:
1.243 albertel 10639: countacc($url) : count the number of accesses to a given URL
1.191 harris41 10640:
10641: =item *
10642:
1.243 albertel 10643: 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 10644:
10645: =item *
10646:
1.243 albertel 10647: 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 10648:
10649: =item *
10650:
1.243 albertel 10651: expirespread($uname,$udom,$stype,$usymb) : set expire date for spreadsheet
1.191 harris41 10652:
10653: =item *
10654:
1.243 albertel 10655: devalidate($symb) : devalidate temporary spreadsheet calculations,
10656: forcing spreadsheet to reevaluate the resource scores next time.
10657:
10658: =back
10659:
10660: =head2 Storing/Retreiving Data
10661:
10662: =over 4
1.191 harris41 10663:
10664: =item *
10665:
1.243 albertel 10666: store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
10667: for this url; hashref needs to be given and should be a \%hashname; the
10668: remaining args aren't required and if they aren't passed or are '' they will
1.620 albertel 10669: be derived from the env
1.191 harris41 10670:
10671: =item *
10672:
1.243 albertel 10673: cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
10674: uses critical subroutine
1.191 harris41 10675:
10676: =item *
10677:
1.243 albertel 10678: restore($symb,$namespace,$udom,$uname) : returns hash for this symb;
10679: all args are optional
1.191 harris41 10680:
10681: =item *
10682:
1.717 albertel 10683: dumpstore($namespace,$udom,$uname,$regexp,$range) :
10684: dumps the complete (or key matching regexp) namespace into a hash
10685: ($udom, $uname, $regexp, $range are optional) for a namespace that is
10686: normally &store()ed into
10687:
10688: $range should be either an integer '100' (give me the first 100
10689: matching records)
10690: or be two integers sperated by a - with no spaces
10691: '30-50' (give me the 30th through the 50th matching
10692: records)
10693:
10694:
10695: =item *
10696:
10697: putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
10698: replaces a &store() version of data with a replacement set of data
10699: for a particular resource in a namespace passed in the $storehash hash
10700: reference
10701:
10702: =item *
10703:
1.243 albertel 10704: tmpstore($storehash,$symb,$namespace,$udom,$uname) : storage that
10705: works very similar to store/cstore, but all data is stored in a
10706: temporary location and can be reset using tmpreset, $storehash should
10707: be a hash reference, returns nothing on success
1.191 harris41 10708:
10709: =item *
10710:
1.243 albertel 10711: tmprestore($symb,$namespace,$udom,$uname) : storage that works very
10712: similar to restore, but all data is stored in a temporary location and
10713: can be reset using tmpreset. Returns a hash of values on success,
10714: error string otherwise.
1.191 harris41 10715:
10716: =item *
10717:
1.243 albertel 10718: tmpreset($symb,$namespace,$udom,$uname) : temporary storage reset,
10719: deltes all keys for $symb form the temporary storage hash.
1.191 harris41 10720:
10721: =item *
10722:
1.243 albertel 10723: get($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10724: reference filled in from namesp ($udom and $uname are optional)
1.191 harris41 10725:
10726: =item *
10727:
1.243 albertel 10728: del($namespace,$storearr,$udom,$uname) : deletes keys out of array from
10729: namesp ($udom and $uname are optional)
1.191 harris41 10730:
10731: =item *
10732:
1.702 albertel 10733: dump($namespace,$udom,$uname,$regexp,$range) :
1.243 albertel 10734: dumps the complete (or key matching regexp) namespace into a hash
1.702 albertel 10735: ($udom, $uname, $regexp, $range are optional)
1.449 matthew 10736:
1.702 albertel 10737: $range should be either an integer '100' (give me the first 100
10738: matching records)
10739: or be two integers sperated by a - with no spaces
10740: '30-50' (give me the 30th through the 50th matching
10741: records)
1.449 matthew 10742: =item *
10743:
10744: inc($namespace,$store,$udom,$uname) : increments $store in $namespace.
10745: $store can be a scalar, an array reference, or if the amount to be
10746: incremented is > 1, a hash reference.
10747:
10748: ($udom and $uname are optional)
1.191 harris41 10749:
10750: =item *
10751:
1.243 albertel 10752: put($namespace,$storehash,$udom,$uname) : stores hash in namesp
10753: ($udom and $uname are optional)
1.191 harris41 10754:
10755: =item *
10756:
1.243 albertel 10757: cput($namespace,$storehash,$udom,$uname) : critical put
10758: ($udom and $uname are optional)
1.191 harris41 10759:
10760: =item *
10761:
1.748 albertel 10762: newput($namespace,$storehash,$udom,$uname) :
10763:
10764: Attempts to store the items in the $storehash, but only if they don't
10765: currently exist, if this succeeds you can be certain that you have
10766: successfully created a new key value pair in the $namespace db.
10767:
10768:
10769: Args:
10770: $namespace: name of database to store values to
10771: $storehash: hashref to store to the db
10772: $udom: (optional) domain of user containing the db
10773: $uname: (optional) name of user caontaining the db
10774:
10775: Returns:
10776: 'ok' -> succeeded in storing all keys of $storehash
10777: 'key_exists: <key>' -> failed to anything out of $storehash, as at
10778: least <key> already existed in the db (other
10779: requested keys may also already exist)
1.967 bisitz 10780: 'error: <msg>' -> unable to tie the DB or other error occurred
1.748 albertel 10781: 'con_lost' -> unable to contact request server
10782: 'refused' -> action was not allowed by remote machine
10783:
10784:
10785: =item *
10786:
1.243 albertel 10787: eget($namespace,$storearr,$udom,$uname) : returns hash with keys from array
10788: reference filled in from namesp (encrypts the return communication)
10789: ($udom and $uname are optional)
1.191 harris41 10790:
10791: =item *
10792:
1.243 albertel 10793: log($udom,$name,$home,$message) : write to permanent log for user; use
10794: critical subroutine
10795:
1.806 raeburn 10796: =item *
10797:
1.860 raeburn 10798: get_dom($namespace,$storearr,$udom,$uhome) : returns hash with keys from
10799: array reference filled in from namespace found in domain level on either
10800: specified domain server ($uhome) or primary domain server ($udom and $uhome are optional).
1.806 raeburn 10801:
10802: =item *
10803:
1.860 raeburn 10804: put_dom($namespace,$storehash,$udom,$uhome) : stores hash in namespace at
10805: domain level either on specified domain server ($uhome) or primary domain
10806: server ($udom and $uhome are optional)
1.806 raeburn 10807:
1.943 raeburn 10808: =item *
10809:
10810: get_domain_defaults($target_domain) : returns hash with defaults for
10811: authentication and language in the domain. Keys are: auth_def, auth_arg_def,
10812: lang_def; corresponsing values are authentication type (internal, krb4, krb5,
10813: or localauth), initial password or a kerberos realm, language (e.g., en-us).
10814: Values are retrieved from cache (if current), or from domain's configuration.db
10815: (if available), or lastly from values in lonTabs/dns_domain,tab,
10816: or lonTabs/domain.tab.
10817:
10818: %domdefaults = &get_auth_defaults($target_domain);
10819:
1.243 albertel 10820: =back
10821:
10822: =head2 Network Status Functions
10823:
10824: =over 4
1.191 harris41 10825:
10826: =item *
10827:
10828: dirlist($uri) : return directory list based on URI
10829:
10830: =item *
10831:
1.243 albertel 10832: spareserver() : find server with least workload from spare.tab
10833:
1.986 foxr 10834:
10835: =item *
10836:
10837: host_from_dns($dns) : Returns the loncapa hostname corresponding to a DNS name or undef
10838: if there is no corresponding loncapa host.
10839:
1.243 albertel 10840: =back
10841:
1.986 foxr 10842:
1.243 albertel 10843: =head2 Apache Request
10844:
10845: =over 4
1.191 harris41 10846:
10847: =item *
10848:
1.243 albertel 10849: ssi($url,%hash) : server side include, does a complete request cycle on url to
10850: localhost, posts hash
10851:
10852: =back
10853:
10854: =head2 Data to String to Data
10855:
10856: =over 4
1.191 harris41 10857:
10858: =item *
10859:
1.243 albertel 10860: hash2str(%hash) : convert a hash into a string complete with escaping and '='
10861: and '&' separators, supports elements that are arrayrefs and hashrefs
1.191 harris41 10862:
10863: =item *
10864:
1.243 albertel 10865: hashref2str($hashref) : convert a hashref into a string complete with
10866: escaping and '=' and '&' separators, supports elements that are
10867: arrayrefs and hashrefs
1.191 harris41 10868:
10869: =item *
10870:
1.243 albertel 10871: arrayref2str($arrayref) : convert an arrayref into a string complete
10872: with escaping and '&' separators, supports elements that are arrayrefs
10873: and hashrefs
1.191 harris41 10874:
10875: =item *
10876:
1.243 albertel 10877: str2hash($string) : convert string to hash using unescaping and
10878: splitting on '=' and '&', supports elements that are arrayrefs and
10879: hashrefs
1.191 harris41 10880:
10881: =item *
10882:
1.243 albertel 10883: str2array($string) : convert string to hash using unescaping and
10884: splitting on '&', supports elements that are arrayrefs and hashrefs
10885:
10886: =back
10887:
10888: =head2 Logging Routines
10889:
10890: =over 4
10891:
10892: These routines allow one to make log messages in the lonnet.log and
10893: lonnet.perm logfiles.
1.191 harris41 10894:
10895: =item *
10896:
1.243 albertel 10897: logtouch() : make sure the logfile, lonnet.log, exists
1.191 harris41 10898:
10899: =item *
10900:
1.243 albertel 10901: logthis() : append message to the normal lonnet.log file, it gets
10902: preiodically rolled over and deleted.
1.191 harris41 10903:
10904: =item *
10905:
1.243 albertel 10906: logperm() : append a permanent message to lonnet.perm.log, this log
10907: file never gets deleted by any automated portion of the system, only
10908: messages of critical importance should go in here.
10909:
10910: =back
10911:
10912: =head2 General File Helper Routines
10913:
10914: =over 4
1.191 harris41 10915:
10916: =item *
10917:
1.481 raeburn 10918: getfile($file,$caller) : two cases - requests for files in /res or in /uploaded.
10919: (a) files in /uploaded
10920: (i) If a local copy of the file exists -
10921: compares modification date of local copy with last-modified date for
10922: definitive version stored on home server for course. If local copy is
10923: stale, requests a new version from the home server and stores it.
10924: If the original has been removed from the home server, then local copy
10925: is unlinked.
10926: (ii) If local copy does not exist -
10927: requests the file from the home server and stores it.
10928:
10929: If $caller is 'uploadrep':
10930: This indicates a call from lonuploadrep.pm (PerlHeaderParserHandler phase)
10931: for request for files originally uploaded via DOCS.
10932: - returns 'ok' if fresh local copy now available, -1 otherwise.
10933:
10934: Otherwise:
10935: This indicates a call from the content generation phase of the request.
10936: - returns the entire contents of the file or -1.
10937:
10938: (b) files in /res
10939: - returns the entire contents of a file or -1;
10940: it properly subscribes to and replicates the file if neccessary.
1.191 harris41 10941:
1.712 albertel 10942:
10943: =item *
10944:
10945: stat_file($url) : $url is expected to be a /res/ or /uploaded/ style file
10946: reference
10947:
10948: returns either a stat() list of data about the file or an empty list
10949: if the file doesn't exist or couldn't find out about it (connection
10950: problems or user unknown)
10951:
1.191 harris41 10952: =item *
10953:
1.243 albertel 10954: filelocation($dir,$file) : returns file system location of a file
10955: based on URI; meant to be "fairly clean" absolute reference, $dir is a
10956: directory that relative $file lookups are to looked in ($dir of /a/dir
10957: and a file of ../bob will become /a/bob)
1.191 harris41 10958:
10959: =item *
10960:
10961: hreflocation($dir,$file) : returns file system location or a URL; same as
10962: filelocation except for hrefs
10963:
10964: =item *
10965:
10966: declutter() : declutters URLs (remove docroot, beginning slashes, 'res' etc)
10967:
1.243 albertel 10968: =back
10969:
1.608 albertel 10970: =head2 Usererfile file routines (/uploaded*)
10971:
10972: =over 4
10973:
10974: =item *
10975:
10976: userfileupload(): main rotine for putting a file in a user or course's
10977: filespace, arguments are,
10978:
1.620 albertel 10979: formname - required - this is the name of the element in $env where the
1.608 albertel 10980: filename, and the contents of the file to create/modifed exist
1.620 albertel 10981: the filename is in $env{'form.'.$formname.'.filename'} and the
10982: contents of the file is located in $env{'form.'.$formname}
1.608 albertel 10983: coursedoc - if true, store the file in the course of the active role
10984: of the current user
10985: subdir - required - subdirectory to put the file in under ../userfiles/
10986: if undefined, it will be placed in "unknown"
10987:
10988: (This routine calls clean_filename() to remove any dangerous
10989: characters from the filename, and then calls finuserfileupload() to
10990: complete the transaction)
10991:
10992: returns either the url of the uploaded file (/uploaded/....) if successful
10993: and /adm/notfound.html if unsuccessful
10994:
10995: =item *
10996:
10997: clean_filename(): routine for cleaing a filename up for storage in
10998: userfile space, argument is:
10999:
11000: filename - proposed filename
11001:
11002: returns: the new clean filename
11003:
11004: =item *
11005:
11006: finishuserfileupload(): routine that creaes and sends the file to
11007: userspace, probably shouldn't be called directly
11008:
11009: docuname: username or courseid of destination for the file
11010: docudom: domain of user/course of destination for the file
11011: formname: same as for userfileupload()
11012: fname: filename (inculding subdirectories) for the file
11013:
11014: returns either the url of the uploaded file (/uploaded/....) if successful
11015: and /adm/notfound.html if unsuccessful
11016:
11017: =item *
11018:
11019: renameuserfile(): renames an existing userfile to a new name
11020:
11021: Args:
11022: docuname: username or courseid of destination for the file
11023: docudom: domain of user/course of destination for the file
11024: old: current file name (including any subdirs under userfiles)
11025: new: desired file name (including any subdirs under userfiles)
11026:
11027: =item *
11028:
11029: mkdiruserfile(): creates a directory is a userfiles dir
11030:
11031: Args:
11032: docuname: username or courseid of destination for the file
11033: docudom: domain of user/course of destination for the file
11034: dir: dir to create (including any subdirs under userfiles)
11035:
11036: =item *
11037:
11038: removeuserfile(): removes a file that exists in userfiles
11039:
11040: Args:
11041: docuname: username or courseid of destination for the file
11042: docudom: domain of user/course of destination for the file
11043: fname: filname to delete (including any subdirs under userfiles)
11044:
11045: =item *
11046:
11047: removeuploadedurl(): convience function for removeuserfile()
11048:
11049: Args:
11050: url: a full /uploaded/... url to delete
11051:
1.747 albertel 11052: =item *
11053:
11054: get_portfile_permissions():
11055: Args:
11056: domain: domain of user or course contain the portfolio files
11057: user: name of user or num of course contain the portfolio files
11058: Returns:
11059: hashref of a dump of the proper file_permissions.db
11060:
11061:
11062: =item *
11063:
11064: get_access_controls():
11065:
11066: Args:
11067: current_permissions: the hash ref returned from get_portfile_permissions()
11068: group: (optional) the group you want the files associated with
11069: file: (optional) the file you want access info on
11070:
11071: Returns:
1.749 raeburn 11072: a hash (keys are file names) of hashes containing
11073: keys are: path to file/file_name\0uniqueID:scope_end_start (see below)
11074: values are XML containing access control settings (see below)
1.747 albertel 11075:
11076: Internal notes:
11077:
1.749 raeburn 11078: access controls are stored in file_permissions.db as key=value pairs.
11079: key -> path to file/file_name\0uniqueID:scope_end_start
11080: where scope -> public,guest,course,group,domains or users.
11081: end -> UNIX time for end of access (0 -> no end date)
11082: start -> UNIX time for start of access
11083:
11084: value -> XML description of access control
11085: <scope type=""> (type =1 of: public,guest,course,group,domains,users">
11086: <start></start>
11087: <end></end>
11088:
11089: <password></password> for scope type = guest
11090:
11091: <domain></domain> for scope type = course or group
11092: <number></number>
11093: <roles id="">
11094: <role></role>
11095: <access></access>
11096: <section></section>
11097: <group></group>
11098: </roles>
11099:
11100: <dom></dom> for scope type = domains
11101:
11102: <users> for scope type = users
11103: <user>
11104: <uname></uname>
11105: <udom></udom>
11106: </user>
11107: </users>
11108: </scope>
11109:
11110: Access data is also aggregated for each file in an additional key=value pair:
11111: key -> path to file/file_name\0accesscontrol
11112: value -> reference to hash
11113: hash contains key = value pairs
11114: where key = uniqueID:scope_end_start
11115: value = UNIX time record was last updated
11116:
11117: Used to improve speed of look-ups of access controls for each file.
11118:
11119: Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
11120:
11121: modify_access_controls():
11122:
11123: Modifies access controls for a portfolio file
11124: Args
11125: 1. file name
11126: 2. reference to hash of required changes,
11127: 3. domain
11128: 4. username
11129: where domain,username are the domain of the portfolio owner
11130: (either a user or a course)
11131:
11132: Returns:
11133: 1. result of additions or updates ('ok' or 'error', with error message).
11134: 2. result of deletions ('ok' or 'error', with error message).
11135: 3. reference to hash of any new or updated access controls.
11136: 4. reference to hash used to map incoming IDs to uniqueIDs assigned to control.
11137: key = integer (inbound ID)
11138: value = uniqueID
1.747 albertel 11139:
1.608 albertel 11140: =back
11141:
1.243 albertel 11142: =head2 HTTP Helper Routines
11143:
11144: =over 4
11145:
1.191 harris41 11146: =item *
11147:
11148: escape() : unpack non-word characters into CGI-compatible hex codes
11149:
11150: =item *
11151:
11152: unescape() : pack CGI-compatible hex codes into actual non-word ASCII character
11153:
1.243 albertel 11154: =back
11155:
11156: =head1 PRIVATE SUBROUTINES
11157:
11158: =head2 Underlying communication routines (Shouldn't call)
11159:
11160: =over 4
11161:
11162: =item *
11163:
11164: subreply() : tries to pass a message to lonc, returns con_lost if incapable
11165:
11166: =item *
11167:
11168: reply() : uses subreply to send a message to remote machine, logs all failures
11169:
11170: =item *
11171:
11172: critical() : passes a critical message to another server; if cannot
11173: get through then place message in connection buffer directory and
11174: returns con_delayed, if incapable of saving message, returns
11175: con_failed
11176:
11177: =item *
11178:
11179: reconlonc() : tries to reconnect lonc client processes.
11180:
11181: =back
11182:
11183: =head2 Resource Access Logging
11184:
11185: =over 4
11186:
11187: =item *
11188:
11189: flushcourselogs() : flush (save) buffer logs and access logs
11190:
11191: =item *
11192:
11193: courselog($what) : save message for course in hash
11194:
11195: =item *
11196:
11197: courseacclog($what) : save message for course using &courselog(). Perform
11198: special processing for specific resource types (problems, exams, quizzes, etc).
11199:
1.191 harris41 11200: =item *
11201:
11202: goodbye() : flush course logs and log shutting down; it is called in srm.conf
11203: as a PerlChildExitHandler
1.243 albertel 11204:
11205: =back
11206:
11207: =head2 Other
11208:
11209: =over 4
11210:
11211: =item *
11212:
11213: symblist($mapname,%newhash) : update symbolic storage links
1.191 harris41 11214:
11215: =back
11216:
11217: =cut
1.877 foxr 11218:
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